sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

FatPkg/EnhancedFatDxe: Add comments for functions

Browse Source 
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
2016-12-08 16:01:15 +08:00
committed by Ruiyu Ni
parent cae7420b4b
commit 205cc66377
3 changed files with 908 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
FatPkg/EnhancedFatDxe/Fat.c
View File

@@ -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 (