mirror of https://github.com/acidanthera/audk.git
FatPkg/EnhancedFatDxe: Add comments for functions
Cc: Ruiyu Ni <ruiyu.ni@intel.com> Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Dandan Bi <dandan.bi@intel.com> Reviewed-by: Ruiyu Ni <ruiyu.ni@intel.com>
This commit is contained in:
Dandan Bi
Ruiyu Ni
parent
cae7420b4b
commit
205cc66377
|
|
@ -14,6 +14,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|||
|
||||
#include "Fat.h"
|
||||
|
||||
/**
|
||||
|
||||
Register Driver Binding protocol for this driver.
|
||||
|
||||
@param ImageHandle - Handle for the image of this driver.
|
||||
@param SystemTable - Pointer to the EFI System Table.
|
||||
|
||||
@retval EFI_SUCCESS - Driver loaded.
|
||||
@return other - Driver not loaded.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
FatEntryPoint (
|
||||
|
|
@ -21,12 +32,36 @@ FatEntryPoint (
|
|||
IN EFI_SYSTEM_TABLE *SystemTable
|
||||
);
|
||||
|
||||
/**
|
||||
|
||||
Unload function for this image. Uninstall DriverBinding protocol.
|
||||
|
||||
@param ImageHandle - Handle for the image of this driver.
|
||||
|
||||
@retval EFI_SUCCESS - Driver unloaded successfully.
|
||||
@return other - Driver can not unloaded.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
FatUnload (
|
||||
IN EFI_HANDLE ImageHandle
|
||||
);
|
||||
|
||||
/**
|
||||
|
||||
Test to see if this driver can add a file system to ControllerHandle.
|
||||
ControllerHandle must support both Disk IO and Block IO protocols.
|
||||
|
||||
@param This - Protocol instance pointer.
|
||||
@param ControllerHandle - Handle of device to test.
|
||||
@param RemainingDevicePath - Not used.
|
||||
|
||||
@retval EFI_SUCCESS - This driver supports this device.
|
||||
@retval EFI_ALREADY_STARTED - This driver is already running on this device.
|
||||
@return other - This driver does not support this device.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
FatDriverBindingSupported (
|
||||
|
|
@ -35,6 +70,22 @@ FatDriverBindingSupported (
|
|||
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
|
||||
);
|
||||
|
||||
/**
|
||||
|
||||
Start this driver on ControllerHandle by opening a Block IO and Disk IO
|
||||
protocol, reading Device Path. Add a Simple File System protocol to
|
||||
ControllerHandle if the media contains a valid file system.
|
||||
|
||||
@param This - Protocol instance pointer.
|
||||
@param ControllerHandle - Handle of device to bind driver to.
|
||||
@param RemainingDevicePath - Not used.
|
||||
|
||||
@retval EFI_SUCCESS - This driver is added to DeviceHandle.
|
||||
@retval EFI_ALREADY_STARTED - This driver is already running on DeviceHandle.
|
||||
@retval EFI_OUT_OF_RESOURCES - Can not allocate the memory.
|
||||
@return other - This driver does not support this device.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
FatDriverBindingStart (
|
||||
|
|
@ -43,6 +94,19 @@ FatDriverBindingStart (
|
|||
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
|
||||
);
|
||||
|
||||
/**
|
||||
|
||||
Stop this driver on ControllerHandle.
|
||||
|
||||
@param This - Protocol instance pointer.
|
||||
@param ControllerHandle - Handle of device to stop driver on.
|
||||
@param NumberOfChildren - Not used.
|
||||
@param ChildHandleBuffer - Not used.
|
||||
|
||||
@retval EFI_SUCCESS - This driver is removed DeviceHandle.
|
||||
@return other - This driver was not removed from this device.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
FatDriverBindingStop (
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
|
|
@ -16,6 +16,18 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|||
|
||||
#include "Fat.h"
|
||||
|
||||
/**
|
||||
|
||||
Get the volume's info into Buffer.
|
||||
|
||||
@param Volume - FAT file system volume.
|
||||
@param BufferSize - Size of Buffer.
|
||||
@param Buffer - Buffer containing volume info.
|
||||
|
||||
@retval EFI_SUCCESS - Get the volume info successfully.
|
||||
@retval EFI_BUFFER_TOO_SMALL - The buffer is too small.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
FatGetVolumeInfo (
|
||||
IN FAT_VOLUME *Volume,
|
||||
|
|
@ -23,6 +35,20 @@ FatGetVolumeInfo (
|
|||
OUT VOID *Buffer
|
||||
);
|
||||
|
||||
/**
|
||||
|
||||
Set the volume's info.
|
||||
|
||||
@param Volume - FAT file system volume.
|
||||
@param BufferSize - Size of Buffer.
|
||||
@param Buffer - Buffer containing the new volume info.
|
||||
|
||||
@retval EFI_SUCCESS - Set the volume info successfully.
|
||||
@retval EFI_BAD_BUFFER_SIZE - The buffer size is error.
|
||||
@retval EFI_WRITE_PROTECTED - The volume is read only.
|
||||
@return other - An error occurred when operation the disk.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
FatSetVolumeInfo (
|
||||
IN FAT_VOLUME *Volume,
|
||||
|
|
@ -30,6 +56,20 @@ FatSetVolumeInfo (
|
|||
IN VOID *Buffer
|
||||
);
|
||||
|
||||
/**
|
||||
|
||||
Set or Get the some types info of the file into Buffer.
|
||||
|
||||
@param IsSet - TRUE:The access is set, else is get
|
||||
@param FHand - The handle of file
|
||||
@param Type - The type of the info
|
||||
@param BufferSize - Size of Buffer
|
||||
@param Buffer - Buffer containing volume info
|
||||
|
||||
@retval EFI_SUCCESS - Get the info successfully
|
||||
@retval EFI_DEVICE_ERROR - Can not find the OFile for the file
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
FatSetOrGetInfo (
|
||||
IN BOOLEAN IsSet,
|
||||
|
|
|
|||
Loading…
Reference in New Issue