-/*++\r
+/** @file\r
+ Fat File System driver routines that support EFI driver model.\r
\r
Copyright (c) 2005 - 2014, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials are licensed and made available\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
-\r
-Module Name:\r
-\r
- Fat.c\r
-\r
-Abstract:\r
-\r
- Fat File System driver routines that support EFI driver model\r
-\r
---*/\r
+**/\r
\r
#include "Fat.h"\r
\r
NULL\r
};\r
\r
+/**\r
+\r
+ Register Driver Binding protocol for this driver.\r
+\r
+ @param ImageHandle - Handle for the image of this driver.\r
+ @param SystemTable - Pointer to the EFI System Table.\r
+\r
+ @retval EFI_SUCCESS - Driver loaded.\r
+ @return other - Driver not loaded.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
FatEntryPoint (\r
IN EFI_HANDLE ImageHandle,\r
IN EFI_SYSTEM_TABLE *SystemTable\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Register Driver Binding protocol for this driver.\r
-\r
-Arguments:\r
-\r
- ImageHandle - Handle for the image of this driver.\r
- SystemTable - Pointer to the EFI System Table.\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - Driver loaded.\r
- other - Driver not loaded.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
\r
return Status;\r
}\r
\r
-EFI_STATUS\r
-EFIAPI\r
-FatUnload (\r
- IN EFI_HANDLE ImageHandle\r
- )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
\r
Unload function for this image. Uninstall DriverBinding protocol.\r
\r
-Arguments:\r
+ @param ImageHandle - Handle for the image of this driver.\r
\r
- ImageHandle - Handle for the image of this driver.\r
+ @retval EFI_SUCCESS - Driver unloaded successfully.\r
+ @return other - Driver can not unloaded.\r
\r
-Returns:\r
-\r
- EFI_SUCCESS - Driver unloaded successfully.\r
- other - Driver can not unloaded.\r
-\r
---*/\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+FatUnload (\r
+ IN EFI_HANDLE ImageHandle\r
+ )\r
{\r
EFI_STATUS Status;\r
EFI_HANDLE *DeviceHandleBuffer;\r
return Status;\r
}\r
\r
+/**\r
+\r
+ Test to see if this driver can add a file system to ControllerHandle.\r
+ ControllerHandle must support both Disk IO and Block IO protocols.\r
+\r
+ @param This - Protocol instance pointer.\r
+ @param ControllerHandle - Handle of device to test.\r
+ @param RemainingDevicePath - Not used.\r
+\r
+ @retval EFI_SUCCESS - This driver supports this device.\r
+ @retval EFI_ALREADY_STARTED - This driver is already running on this device.\r
+ @return other - This driver does not support this device.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
FatDriverBindingSupported (\r
IN EFI_HANDLE ControllerHandle,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Test to see if this driver can add a file system to ControllerHandle.\r
- ControllerHandle must support both Disk IO and Block IO protocols.\r
-\r
-Arguments:\r
-\r
- This - Protocol instance pointer.\r
- ControllerHandle - Handle of device to test.\r
- RemainingDevicePath - Not used.\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - This driver supports this device.\r
- EFI_ALREADY_STARTED - This driver is already running on this device.\r
- other - This driver does not support this device.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_DISK_IO_PROTOCOL *DiskIo;\r
return Status;\r
}\r
\r
-EFI_STATUS\r
-EFIAPI\r
-FatDriverBindingStart (\r
- IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
- IN EFI_HANDLE ControllerHandle,\r
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
- )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
\r
Start this driver on ControllerHandle by opening a Block IO and Disk IO\r
protocol, reading Device Path. Add a Simple File System protocol to\r
ControllerHandle if the media contains a valid file system.\r
\r
-Arguments:\r
-\r
- This - Protocol instance pointer.\r
- ControllerHandle - Handle of device to bind driver to.\r
- RemainingDevicePath - Not used.\r
+ @param This - Protocol instance pointer.\r
+ @param ControllerHandle - Handle of device to bind driver to.\r
+ @param RemainingDevicePath - Not used.\r
\r
-Returns:\r
+ @retval EFI_SUCCESS - This driver is added to DeviceHandle.\r
+ @retval EFI_ALREADY_STARTED - This driver is already running on DeviceHandle.\r
+ @retval EFI_OUT_OF_RESOURCES - Can not allocate the memory.\r
+ @return other - This driver does not support this device.\r
\r
- EFI_SUCCESS - This driver is added to DeviceHandle.\r
- EFI_ALREADY_STARTED - This driver is already running on DeviceHandle.\r
- EFI_OUT_OF_RESOURCES - Can not allocate the memory.\r
- other - This driver does not support this device.\r
-\r
---*/\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+FatDriverBindingStart (\r
+ IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
+ IN EFI_HANDLE ControllerHandle,\r
+ IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
+ )\r
{\r
EFI_STATUS Status;\r
EFI_BLOCK_IO_PROTOCOL *BlockIo;\r
return Status;\r
}\r
\r
+/**\r
+\r
+ Stop this driver on ControllerHandle.\r
+\r
+ @param This - Protocol instance pointer.\r
+ @param ControllerHandle - Handle of device to stop driver on.\r
+ @param NumberOfChildren - Not used.\r
+ @param ChildHandleBuffer - Not used.\r
+\r
+ @retval EFI_SUCCESS - This driver is removed DeviceHandle.\r
+ @return other - This driver was not removed from this device.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
FatDriverBindingStop (\r
IN UINTN NumberOfChildren,\r
IN EFI_HANDLE *ChildHandleBuffer\r
)\r
-/*++\r
-\r
-Routine Description:\r
- Stop this driver on ControllerHandle.\r
-\r
-Arguments:\r
- This - Protocol instance pointer.\r
- ControllerHandle - Handle of device to stop driver on.\r
- NumberOfChildren - Not used.\r
- ChildHandleBuffer - Not used.\r
-\r
-Returns:\r
- EFI_SUCCESS - This driver is removed DeviceHandle.\r
- other - This driver was not removed from this device.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *FileSystem;\r
projects / mirror_edk2.git / blobdiff