Code scrub for IdeBusDxe driver

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8663 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/Ata.c b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/Ata.c
index 98d9323ea7541612053318e63f23bb36eb5ebe7a..b627f2541346565c3354f4721212d3116460dd12 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/Ata.c
+++ b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/Ata.c
@@ -1281,7 +1281,7 @@ AtaPioDataInExt (
   return CheckErrorStatus (IdeDev);\r
 }\r
 /**\r
-  Send ATA Ext command into device with NON_DATA protocol\r
+  Send ATA Ext command into device with NON_DATA protocol.\r
 \r
   @param  IdeDev Standard IDE device private data structure\r
   @param  AtaCommand The ATA command to be sent\r
@@ -2027,7 +2027,7 @@ AtaReadSectorsExt (
 \r
   @param IdeBlkIoDevice Indicates the calling context.\r
   @param MediaId        The media id that the read request is for.\r
-  @param LBA            The starting logical block address to read from on the device.\r
+  @param Lba            The starting logical block address to read from on the device.\r
   @param BufferSize     The size of the Buffer in bytes. This must be a  multiple\r
                         of the intrinsic block size of the device.\r
 \r
@@ -2052,7 +2052,7 @@ EFI_STATUS
 AtaBlkIoReadBlocks (\r
   IN IDE_BLK_IO_DEV   *IdeBlkIoDevice,\r
   IN UINT32           MediaId,\r
-  IN EFI_LBA          LBA,\r
+  IN EFI_LBA          Lba,\r
   IN UINTN            BufferSize,\r
   OUT VOID            *Buffer\r
   )\r
@@ -2092,11 +2092,11 @@ AtaBlkIoReadBlocks (
     return EFI_NO_MEDIA;\r
   }\r
 \r
-  if (LBA > Media->LastBlock) {\r
+  if (Lba > Media->LastBlock) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
-  if ((LBA + NumberOfBlocks - 1) > Media->LastBlock) {\r
+  if ((Lba + NumberOfBlocks - 1) > Media->LastBlock) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
@@ -2110,18 +2110,18 @@ AtaBlkIoReadBlocks (
     // For ATA/ATAPI-6 device(capcity > 120GB), use ATA-6 read block mechanism\r
     //\r
     if (IdeBlkIoDevice->UdmaMode.Valid) {\r
-      Status = AtaUdmaReadExt (IdeBlkIoDevice, Buffer, LBA, NumberOfBlocks);\r
+      Status = AtaUdmaReadExt (IdeBlkIoDevice, Buffer, Lba, NumberOfBlocks);\r
     } else {\r
-      Status = AtaReadSectorsExt (IdeBlkIoDevice, Buffer, LBA, NumberOfBlocks);\r
+      Status = AtaReadSectorsExt (IdeBlkIoDevice, Buffer, Lba, NumberOfBlocks);\r
     }\r
   } else {\r
     //\r
     // For ATA-3 compatible device, use ATA-3 read block mechanism\r
     //\r
     if (IdeBlkIoDevice->UdmaMode.Valid) {\r
-      Status = AtaUdmaRead (IdeBlkIoDevice, Buffer, LBA, NumberOfBlocks);\r
+      Status = AtaUdmaRead (IdeBlkIoDevice, Buffer, Lba, NumberOfBlocks);\r
     } else {\r
-      Status = AtaReadSectors (IdeBlkIoDevice, Buffer, LBA, NumberOfBlocks);\r
+      Status = AtaReadSectors (IdeBlkIoDevice, Buffer, Lba, NumberOfBlocks);\r
     }\r
   }\r
 \r
@@ -2419,7 +2419,7 @@ AtaWriteSectorsExt (
 \r
   @param IdeBlkIoDevice  Indicates the calling context.\r
   @param MediaId         The media id that the write request is for.\r
-  @param LBA             The starting logical block address to write onto the device.\r
+  @param Lba             The starting logical block address to write onto the device.\r
   @param BufferSize      The size of the Buffer in bytes. This must be a multiple\r
                          of the intrinsic block size of the device.\r
   @param Buffer          A pointer to the source buffer for the data.The caller\r
@@ -2443,7 +2443,7 @@ EFI_STATUS
 AtaBlkIoWriteBlocks (\r
   IN  IDE_BLK_IO_DEV   *IdeBlkIoDevice,\r
   IN  UINT32           MediaId,\r
-  IN  EFI_LBA          LBA,\r
+  IN  EFI_LBA          Lba,\r
   IN  UINTN            BufferSize,\r
   OUT VOID             *Buffer\r
   )\r
@@ -2479,11 +2479,11 @@ AtaBlkIoWriteBlocks (
     return EFI_BAD_BUFFER_SIZE;\r
   }\r
 \r
-  if (LBA > Media->LastBlock) {\r
+  if (Lba > Media->LastBlock) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
-  if ((LBA + NumberOfBlocks - 1) > Media->LastBlock) {\r
+  if ((Lba + NumberOfBlocks - 1) > Media->LastBlock) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
@@ -2497,18 +2497,18 @@ AtaBlkIoWriteBlocks (
     // For ATA/ATAPI-6 device(capcity > 120GB), use ATA-6 write block mechanism\r
     //\r
     if (IdeBlkIoDevice->UdmaMode.Valid) {\r
-      Status = AtaUdmaWriteExt (IdeBlkIoDevice, Buffer, LBA, NumberOfBlocks);\r
+      Status = AtaUdmaWriteExt (IdeBlkIoDevice, Buffer, Lba, NumberOfBlocks);\r
     } else {\r
-      Status = AtaWriteSectorsExt (IdeBlkIoDevice, Buffer, LBA, NumberOfBlocks);\r
+      Status = AtaWriteSectorsExt (IdeBlkIoDevice, Buffer, Lba, NumberOfBlocks);\r
     }\r
   } else {\r
     //\r
     // For ATA-3 compatible device, use ATA-3 write block mechanism\r
     //\r
     if (IdeBlkIoDevice->UdmaMode.Valid) {\r
-      Status = AtaUdmaWrite (IdeBlkIoDevice, Buffer, LBA, NumberOfBlocks);\r
+      Status = AtaUdmaWrite (IdeBlkIoDevice, Buffer, Lba, NumberOfBlocks);\r
     } else {\r
-      Status = AtaWriteSectors (IdeBlkIoDevice, Buffer, LBA, NumberOfBlocks);\r
+      Status = AtaWriteSectors (IdeBlkIoDevice, Buffer, Lba, NumberOfBlocks);\r
     }\r
   }\r
 \r
@@ -2619,7 +2619,7 @@ AtaNonDataCommandIn (
   }\r
 \r
   //\r
-  // Select device (bit4), set LBA mode(bit6) (use 0xe0 for compatibility)\r
+  // Select device (bit4), set Lba mode(bit6) (use 0xe0 for compatibility)\r
   //\r
   IDEWritePortB (\r
     IdeDev->PciIo,\r

diff --git a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/Atapi.c b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/Atapi.c
index 74b48d1443658609bbd51cfbc53fd7d9144f447c..9c1c3d957789e4d5470f9d70f9d462f7de3b116b 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/Atapi.c
+++ b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/Atapi.c
@@ -1698,7 +1698,7 @@ AtapiSoftReset (
 \r
   @param IdeBlkIoDevice Indicates the calling context.\r
   @param MediaId        The media id that the read request is for.\r
-  @param LBA            The starting logical block address to read from on the device.\r
+  @param Lba            The starting logical block address to read from on the device.\r
   @param BufferSize     The size of the Buffer in bytes. This must be a multiple\r
                         of the intrinsic block size of the device.\r
   @param Buffer         A pointer to the destination buffer for the data. The caller\r
@@ -1718,7 +1718,7 @@ EFI_STATUS
 AtapiBlkIoReadBlocks (\r
   IN IDE_BLK_IO_DEV   *IdeBlkIoDevice,\r
   IN UINT32           MediaId,\r
-  IN EFI_LBA          LBA,\r
+  IN EFI_LBA          Lba,\r
   IN UINTN            BufferSize,\r
   OUT VOID            *Buffer\r
   )\r
@@ -1784,11 +1784,11 @@ AtapiBlkIoReadBlocks (
     return EFI_BAD_BUFFER_SIZE;\r
   }\r
 \r
-  if (LBA > Media->LastBlock) {\r
+  if (Lba > Media->LastBlock) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
-  if ((LBA + NumberOfBlocks - 1) > Media->LastBlock) {\r
+  if ((Lba + NumberOfBlocks - 1) > Media->LastBlock) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
@@ -1800,7 +1800,7 @@ AtapiBlkIoReadBlocks (
   // if all the parameters are valid, then perform read sectors command\r
   // to transfer data from device to host.\r
   //\r
-  Status = AtapiReadSectors (IdeBlkIoDevice, Buffer, LBA, NumberOfBlocks);\r
+  Status = AtapiReadSectors (IdeBlkIoDevice, Buffer, Lba, NumberOfBlocks);\r
   if (EFI_ERROR (Status)) {\r
     return EFI_DEVICE_ERROR;\r
   }\r
@@ -1812,7 +1812,7 @@ AtapiBlkIoReadBlocks (
   //\r
   // save the first block to the cache for performance\r
   //\r
-  if (LBA == 0 && (IdeBlkIoDevice->Cache == NULL)) {\r
+  if (Lba == 0 && (IdeBlkIoDevice->Cache == NULL)) {\r
     IdeBlkIoDevice->Cache = AllocatePool (BlockSize);\r
     if (IdeBlkIoDevice->Cache!= NULL) {\r
       CopyMem ((UINT8 *) IdeBlkIoDevice->Cache, (UINT8 *) Buffer, BlockSize);\r
@@ -1828,7 +1828,7 @@ AtapiBlkIoReadBlocks (
 \r
   @param IdeBlkIoDevice  Indicates the calling context.\r
   @param MediaId         The media id that the write request is for.\r
-  @param LBA             The starting logical block address to write onto the device.\r
+  @param Lba             The starting logical block address to write onto the device.\r
   @param BufferSize      The size of the Buffer in bytes. This must be a multiple\r
                          of the intrinsic block size of the device.\r
   @param Buffer          A pointer to the source buffer for the data. The caller\r
@@ -1850,7 +1850,7 @@ EFI_STATUS
 AtapiBlkIoWriteBlocks (\r
   IN IDE_BLK_IO_DEV   *IdeBlkIoDevice,\r
   IN UINT32           MediaId,\r
-  IN EFI_LBA          LBA,\r
+  IN EFI_LBA          Lba,\r
   IN UINTN            BufferSize,\r
   OUT VOID            *Buffer\r
   )\r
@@ -1862,7 +1862,7 @@ AtapiBlkIoWriteBlocks (
   EFI_STATUS          Status;\r
   BOOLEAN             MediaChange;\r
 \r
-  if (LBA == 0 && IdeBlkIoDevice->Cache != NULL) {\r
+  if (Lba == 0 && IdeBlkIoDevice->Cache != NULL) {\r
     gBS->FreePool (IdeBlkIoDevice->Cache);\r
     IdeBlkIoDevice->Cache = NULL;\r
   }\r
@@ -1883,7 +1883,7 @@ AtapiBlkIoWriteBlocks (
   Status      = AtapiDetectMedia (IdeBlkIoDevice, &MediaChange);\r
   if (EFI_ERROR (Status)) {\r
 \r
-    if (LBA == 0 && IdeBlkIoDevice->Cache != NULL) {\r
+    if (Lba == 0 && IdeBlkIoDevice->Cache != NULL) {\r
       gBS->FreePool (IdeBlkIoDevice->Cache);\r
       IdeBlkIoDevice->Cache = NULL;\r
     }\r
@@ -1899,7 +1899,7 @@ AtapiBlkIoWriteBlocks (
 \r
   if (!(Media->MediaPresent)) {\r
 \r
-    if (LBA == 0 && IdeBlkIoDevice->Cache != NULL) {\r
+    if (Lba == 0 && IdeBlkIoDevice->Cache != NULL) {\r
       gBS->FreePool (IdeBlkIoDevice->Cache);\r
       IdeBlkIoDevice->Cache = NULL;\r
     }\r
@@ -1908,7 +1908,7 @@ AtapiBlkIoWriteBlocks (
 \r
   if ((MediaId != Media->MediaId) || MediaChange) {\r
 \r
-    if (LBA == 0 && IdeBlkIoDevice->Cache != NULL) {\r
+    if (Lba == 0 && IdeBlkIoDevice->Cache != NULL) {\r
       gBS->FreePool (IdeBlkIoDevice->Cache);\r
       IdeBlkIoDevice->Cache = NULL;\r
     }\r
@@ -1923,11 +1923,11 @@ AtapiBlkIoWriteBlocks (
     return EFI_BAD_BUFFER_SIZE;\r
   }\r
 \r
-  if (LBA > Media->LastBlock) {\r
+  if (Lba > Media->LastBlock) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
-  if ((LBA + NumberOfBlocks - 1) > Media->LastBlock) {\r
+  if ((Lba + NumberOfBlocks - 1) > Media->LastBlock) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
@@ -1939,7 +1939,7 @@ AtapiBlkIoWriteBlocks (
   // if all the parameters are valid,\r
   // then perform write sectors command to transfer data from host to device.\r
   //\r
-  Status = AtapiWriteSectors (IdeBlkIoDevice, Buffer, LBA, NumberOfBlocks);\r
+  Status = AtapiWriteSectors (IdeBlkIoDevice, Buffer, Lba, NumberOfBlocks);\r
   if (EFI_ERROR (Status)) {\r
     return EFI_DEVICE_ERROR;\r
   }\r

diff --git a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/Ide.c b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/Ide.c
index fa4d636acb60dfef5128db97eec252b810ecdff8..196f1bd01c3281cca59296b23058daa831031a82 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/Ide.c
+++ b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/Ide.c
@@ -21,12 +21,12 @@ BOOLEAN MasterDeviceExist     = FALSE;
 UINT8   MasterDeviceType      = INVALID_DEVICE_TYPE;\r
 \r
 /**\r
-  read a one-byte data from a IDE port\r
+  read a one-byte data from a IDE port.\r
 \r
   @param  PciIo  The PCI IO protocol instance\r
   @param  Port   the IDE Port number \r
 \r
-  return  the one-byte data read from IDE port\r
+  @return  the one-byte data read from IDE port\r
 **/\r
 UINT8\r
 IDEReadPortB (\r
@@ -109,7 +109,7 @@ IDEReadPortWMultiple (
 }\r
 \r
 /**\r
-  write a 1-byte data to a specific IDE port\r
+  write a 1-byte data to a specific IDE port.\r
 \r
   @param  PciIo  PCI IO protocol instance\r
   @param  Port   The IDE port to be writen\r
@@ -137,7 +137,7 @@ IDEWritePortB (
 }\r
 \r
 /**\r
-  write a 1-word data to a specific IDE port\r
+  write a 1-word data to a specific IDE port.\r
 \r
   @param  PciIo  PCI IO protocol instance\r
   @param  Port   The IDE port to be writen\r
@@ -269,7 +269,11 @@ IDEWritePortWMultiple (
 \r
   @param  PciIo Pointer to the EFI_PCI_IO_PROTOCOL instance\r
   @param  IdeRegsBaseAddr Pointer to IDE_REGISTERS_BASE_ADDR to\r
-  receive IDE IO port registers' base addresses\r
+           receive IDE IO port registers' base addresses\r
+           \r
+  @retval EFI_UNSUPPORTED return this value when the BARs is not IO type\r
+  @retval EFI_SUCCESS     Get the Base address successfully\r
+  @retval other           read the pci configureation data error\r
 \r
 **/\r
 EFI_STATUS\r
@@ -347,6 +351,10 @@ GetIdeRegistersBaseAddr (
   succeess.\r
 \r
   @param  IdeDev The BLK_IO private data which specifies the IDE device\r
+  \r
+  @retval EFI_INVALID_PARAMETER return this value when the channel is invalid\r
+  @retval EFI_SUCCESS           reassign the IDE IO resource successfully\r
+  @retval other                 get the IDE current base address effor\r
 \r
 **/\r
 EFI_STATUS\r
@@ -585,6 +593,9 @@ DetectIDEController (
   Detect if there is disk attached to this port\r
 \r
   @param  IdeDev The BLK_IO private data which specifies the IDE device.\r
+  \r
+  @retval EFI_NOT_FOUND   The device or channel is not found\r
+  @retval EFI_SUCCESS     The device is found\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1007,7 +1018,7 @@ WaitForBSYClear (
 \r
   @param IdeDev               pointer pointing to IDE_BLK_IO_DEV data structure, used to record \r
                               all the information of the IDE device.\r
-  @paramTimeoutInMilliSeconds used to designate the timeout for the DRQ ready.\r
+  @param TimeoutInMilliSeconds used to designate the timeout for the DRQ ready.\r
 \r
   @retval EFI_SUCCESS         BSY bit clear within the time out.\r
   @retval EFI_TIMEOUT         BSY bit not clear within the time out.\r
@@ -1212,7 +1223,7 @@ ReleaseIdeResources (
   return ;\r
 }\r
 /**\r
-  Set the calculated Best transfer mode to a detected device\r
+  Set the calculated Best transfer mode to a detected device.\r
 \r
   @param IdeDev       Standard IDE device private data structure\r
   @param TransferMode The device transfer mode to be set\r
@@ -1250,7 +1261,7 @@ SetDeviceTransferMode (
   return Status;\r
 }\r
 /**\r
-  Set drive parameters for devices not support PACKETS command\r
+  Set drive parameters for devices not support PACKETS command.\r
 \r
   @param IdeDev          Standard IDE device private data structure\r
   @param DriveParameters The device parameters to be set into the disk\r
@@ -1300,7 +1311,7 @@ SetDriveParameters (
 }\r
 \r
 /**\r
-  Enable Interrupt on IDE controller\r
+  Enable Interrupt on IDE controller.\r
 \r
   @param  IdeDev   Standard IDE device private data structure\r
 \r

diff --git a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/Ide.h b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/Ide.h
index b919457bb54e633733defce4cf9e0ac3dbedaec3..6f62ab28d22e4ec913e6fc742236ad7dd3ae263b 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/Ide.h
+++ b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/Ide.h
@@ -25,7 +25,7 @@
 // Helper functions Prototype\r
 //\r
 /**\r
-  read a one-byte data from a IDE port\r
+  read a one-byte data from a IDE port.\r
 \r
   @param  PciIo  The PCI IO protocol instance\r
   @param  Port   the IDE Port number \r
@@ -41,7 +41,7 @@ IDEReadPortB (
 /**\r
   Reads multiple words of data from the IDE data port.\r
   Call the IO abstraction once to do the complete read,\r
-  not one word at a time\r
+  not one word at a time.\r
 \r
   @param  PciIo Pointer to the EFI_PCI_IO instance\r
   @param  Port IO port to read\r
@@ -58,7 +58,7 @@ IDEReadPortWMultiple (
   );\r
 \r
 /**\r
-  write a 1-byte data to a specific IDE port\r
+  write a 1-byte data to a specific IDE port.\r
 \r
   @param  PciIo  PCI IO protocol instance\r
   @param  Port   The IDE port to be writen\r
@@ -72,7 +72,7 @@ IDEWritePortB (
   );\r
 \r
 /**\r
-  write a 1-word data to a specific IDE port\r
+  write a 1-word data to a specific IDE port.\r
 \r
   @param  PciIo  PCI IO protocol instance\r
   @param  Port   The IDE port to be writen\r
@@ -88,7 +88,7 @@ IDEWritePortW (
 /**\r
   Write multiple words of data to the IDE data port.\r
   Call the IO abstraction once to do the complete read,\r
-  not one word at a time\r
+  not one word at a time.\r
 \r
   @param  PciIo Pointer to the EFI_PCI_IO instance\r
   @param  Port IO port to read\r
@@ -152,7 +152,11 @@ IDEWritePortWMultiple (
 \r
   @param  PciIo Pointer to the EFI_PCI_IO_PROTOCOL instance\r
   @param  IdeRegsBaseAddr Pointer to IDE_REGISTERS_BASE_ADDR to\r
-  receive IDE IO port registers' base addresses\r
+          receive IDE IO port registers' base addresses\r
+  \r
+  @retval EFI_UNSUPPORTED return this value when the BARs is not IO type\r
+  @retval EFI_SUCCESS     Get the Base address successfully\r
+  @retval other           read the pci configureation data error\r
 \r
 **/\r
 EFI_STATUS\r
@@ -169,6 +173,10 @@ GetIdeRegistersBaseAddr (
 \r
   @param  IdeDev The BLK_IO private data which specifies the IDE device\r
 \r
+  @retval EFI_INVALID_PARAMETER return this value when the channel is invalid\r
+  @retval EFI_SUCCESS           reassign the IDE IO resource successfully\r
+  @retval other                 get the IDE current base address effor\r
+\r
 **/\r
 EFI_STATUS\r
 ReassignIdeResources (\r
@@ -176,9 +184,12 @@ ReassignIdeResources (
   );\r
 \r
 /**\r
-  Detect if there is disk attached to this port\r
+  Detect if there is disk attached to this port.\r
 \r
   @param  IdeDev The BLK_IO private data which specifies the IDE device.\r
+  \r
+  @retval EFI_NOT_FOUND   The device or channel is not found\r
+  @retval EFI_SUCCESS     The device is found\r
 \r
 **/\r
 EFI_STATUS\r
@@ -317,7 +328,7 @@ WaitForBSYClear (
 \r
   @param IdeDev               pointer pointing to IDE_BLK_IO_DEV data structure, used to record \r
                               all the information of the IDE device.\r
-  @paramTimeoutInMilliSeconds used to designate the timeout for the DRQ ready.\r
+  @param TimeoutInMilliSeconds used to designate the timeout for the DRQ ready.\r
 \r
   @retval EFI_SUCCESS         BSY bit clear within the time out.\r
   @retval EFI_TIMEOUT         BSY bit not clear within the time out.\r
@@ -519,7 +530,7 @@ AtaSoftReset (
 \r
   @param IdeBlkIoDevice Indicates the calling context.\r
   @param MediaId        The media id that the read request is for.\r
-  @param LBA            The starting logical block address to read from on the device.\r
+  @param Lba            The starting logical block address to read from on the device.\r
   @param BufferSize     The size of the Buffer in bytes. This must be a  multiple\r
                         of the intrinsic block size of the device.\r
 \r
@@ -555,7 +566,7 @@ AtaBlkIoReadBlocks (
 \r
   @param IdeBlkIoDevice  Indicates the calling context.\r
   @param MediaId         The media id that the write request is for.\r
-  @param LBA             The starting logical block address to write onto the device.\r
+  @param Lba             The starting logical block address to write onto the device.\r
   @param BufferSize      The size of the Buffer in bytes. This must be a multiple\r
                          of the intrinsic block size of the device.\r
   @param Buffer          A pointer to the source buffer for the data.The caller\r
@@ -649,7 +660,7 @@ AtapiSoftReset (
 \r
   @param IdeBlkIoDevice Indicates the calling context.\r
   @param MediaId        The media id that the read request is for.\r
-  @param LBA            The starting logical block address to read from on the device.\r
+  @param Lba            The starting logical block address to read from on the device.\r
   @param BufferSize     The size of the Buffer in bytes. This must be a multiple\r
                         of the intrinsic block size of the device.\r
   @param Buffer         A pointer to the destination buffer for the data. The caller\r
@@ -680,7 +691,7 @@ AtapiBlkIoReadBlocks (
 \r
   @param IdeBlkIoDevice  Indicates the calling context.\r
   @param MediaId         The media id that the write request is for.\r
-  @param LBA             The starting logical block address to write onto the device.\r
+  @param Lba             The starting logical block address to write onto the device.\r
   @param BufferSize      The size of the Buffer in bytes. This must be a multiple\r
                          of the intrinsic block size of the device.\r
   @param Buffer          A pointer to the source buffer for the data. The caller\r
@@ -731,7 +742,7 @@ SetDeviceTransferMode (
   IN ATA_TRANSFER_MODE    *TransferMode\r
   );\r
 /**\r
-  Send ATA command into device with NON_DATA protocol\r
+  Send ATA command into device with NON_DATA protocol.\r
 \r
   @param  IdeDev Standard IDE device private data structure\r
   @param  AtaCommand The ATA command to be sent\r
@@ -760,14 +771,14 @@ AtaNonDataCommandIn (
   );\r
 \r
 /**\r
-  Send ATA Ext command into device with NON_DATA protocol\r
+  Send ATA Ext command into device with NON_DATA protocol.\r
 \r
   @param  IdeDev Standard IDE device private data structure\r
   @param  AtaCommand The ATA command to be sent\r
   @param  Device The value in Device register\r
   @param  Feature The value in Feature register\r
   @param  SectorCount The value in SectorCount register\r
-  @param  LbaAddress The LBA address in 48-bit mode\r
+  @param  LbaAddress The Lba address in 48-bit mode\r
 \r
   @retval  EFI_SUCCESS Reading succeed\r
   @retval  EFI_ABORTED Command failed\r
@@ -799,7 +810,7 @@ AtaEnableLongPhysicalSector (
   );\r
 \r
 /**\r
-  Set drive parameters for devices not support PACKETS command\r
+  Set drive parameters for devices not support PACKETS command.\r
 \r
   @param IdeDev          Standard IDE device private data structure\r
   @param DriveParameters The device parameters to be set into the disk\r

diff --git a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.c b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.c
index b3434d754e89b5d841833059a1883ebd6be41e85..bf094c0ffbf37d9181cd87080cbcbed1554b4d47 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.c
+++ b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.c
@@ -1087,7 +1087,7 @@ Done:
 \r
   @param  This       Block IO protocol instance pointer.\r
   @param  MediaId    The media ID of the device\r
-  @param  LBA        Starting LBA address to read data\r
+  @param  Lba        Starting LBA address to read data\r
   @param  BufferSize The size of data to be read\r
   @param  Buffer     Caller supplied buffer to save data\r
 \r
@@ -1100,7 +1100,7 @@ EFIAPI
 IDEBlkIoReadBlocks (\r
   IN  EFI_BLOCK_IO_PROTOCOL   *This,\r
   IN  UINT32                  MediaId,\r
-  IN  EFI_LBA                 LBA,\r
+  IN  EFI_LBA                 Lba,\r
   IN  UINTN                   BufferSize,\r
   OUT VOID                    *Buffer\r
   )\r
@@ -1126,7 +1126,7 @@ IDEBlkIoReadBlocks (
     Status = AtaBlkIoReadBlocks (\r
             IdeBlkIoDevice,\r
             MediaId,\r
-            LBA,\r
+            Lba,\r
             BufferSize,\r
             Buffer\r
             );\r
@@ -1144,7 +1144,7 @@ IDEBlkIoReadBlocks (
   Status = AtapiBlkIoReadBlocks (\r
           IdeBlkIoDevice,\r
           MediaId,\r
-          LBA,\r
+          Lba,\r
           BufferSize,\r
           Buffer\r
           );\r
@@ -1156,11 +1156,11 @@ Done:
 }\r
 \r
 /**\r
-  Write data to block io device\r
+  Write data to block io device.\r
 \r
   @param  This       Protocol instance pointer.\r
   @param  MediaId    The media ID of the device\r
-  @param  LBA        Starting LBA address to write data\r
+  @param  Lba        Starting LBA address to write data\r
   @param  BufferSize The size of data to be written\r
   @param  Buffer     Caller supplied buffer to save data\r
 \r
@@ -1173,7 +1173,7 @@ EFIAPI
 IDEBlkIoWriteBlocks (\r
   IN  EFI_BLOCK_IO_PROTOCOL   *This,\r
   IN  UINT32                  MediaId,\r
-  IN  EFI_LBA                 LBA,\r
+  IN  EFI_LBA                 Lba,\r
   IN  UINTN                   BufferSize,\r
   IN  VOID                    *Buffer\r
   )\r
@@ -1199,7 +1199,7 @@ IDEBlkIoWriteBlocks (
     Status = AtaBlkIoWriteBlocks (\r
             IdeBlkIoDevice,\r
             MediaId,\r
-            LBA,\r
+            Lba,\r
             BufferSize,\r
             Buffer\r
             );\r
@@ -1217,7 +1217,7 @@ IDEBlkIoWriteBlocks (
   Status = AtapiBlkIoWriteBlocks (\r
           IdeBlkIoDevice,\r
           MediaId,\r
-          LBA,\r
+          Lba,\r
           BufferSize,\r
           Buffer\r
           );\r
@@ -1250,13 +1250,13 @@ IDEBlkIoFlushBlocks (
   Return the results of the Inquiry command to a drive in InquiryData.\r
   Data format of Inquiry data is defined by the Interface GUID.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  InquiryData Results of Inquiry command to device\r
+  @param  This Protocol   Instance pointer.\r
+  @param  InquiryData     Results of Inquiry command to device\r
   @param  InquiryDataSize Size of InquiryData in bytes.\r
 \r
-  @retval  EFI_SUCCESS InquiryData valid\r
-  @retval  EFI_NOT_FOUND Device does not support this data class\r
-  @retval  EFI_DEVICE_ERROR Error reading InquiryData from device\r
+  @retval  EFI_SUCCESS          InquiryData valid\r
+  @retval  EFI_NOT_FOUND        Device does not support this data class\r
+  @retval  EFI_DEVICE_ERROR     Error reading InquiryData from device\r
   @retval  EFI_BUFFER_TOO_SMALL IntquiryDataSize not big enough\r
 \r
 **/\r

diff --git a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.h b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.h
index 55f4b72f16856e85ef748e95489d06d7ffabe191..502d2dd92c37acd353c8fd4c89529e25094b4117 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.h
+++ b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.h
@@ -384,11 +384,11 @@ IDEBlkIoReset (
   );\r
 \r
 /**\r
-  Read data from a block IO device\r
+  Read data from a block IO device.\r
 \r
   @param  This       Block IO protocol instance pointer.\r
   @param  MediaId    The media ID of the device\r
-  @param  LBA        Starting LBA address to read data\r
+  @param  Lba        Starting LBA address to read data\r
   @param  BufferSize The size of data to be read\r
   @param  Buffer     Caller supplied buffer to save data\r
 \r
@@ -411,7 +411,7 @@ IDEBlkIoReadBlocks (
 \r
   @param  This       Protocol instance pointer.\r
   @param  MediaId    The media ID of the device\r
-  @param  LBA        Starting LBA address to write data\r
+  @param  Lba        Starting LBA address to write data\r
   @param  BufferSize The size of data to be written\r
   @param  Buffer     Caller supplied buffer to save data\r
 \r
@@ -446,14 +446,14 @@ IDEBlkIoFlushBlocks (
   Return the results of the Inquiry command to a drive in InquiryData.\r
   Data format of Inquiry data is defined by the Interface GUID.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  InquiryData Results of Inquiry command to device\r
+  @param  This            Protocol instance pointer.\r
+  @param  InquiryData     Results of Inquiry command to device\r
   @param  InquiryDataSize Size of InquiryData in bytes.\r
 \r
-  @retval  EFI_SUCCESS InquiryData valid\r
-  @retval  EFI_NOT_FOUND Device does not support this data class\r
-  @retval  EFI_DEVICE_ERROR Error reading InquiryData from device\r
-  @retval  EFI_BUFFER_TOO_SMALL IntquiryDataSize not big enough\r
+  @retval  EFI_SUCCESS          InquiryData valid\r
+  @retval  EFI_NOT_FOUND        Device does not support this data class\r
+  @retval  EFI_DEVICE_ERROR     Error reading InquiryData from device\r
+  @retval  EFI_BUFFER_TOO_SMALL InquiryDataSize not big enough\r
 \r
 **/\r
 EFI_STATUS\r
@@ -461,7 +461,7 @@ EFIAPI
 IDEDiskInfoInquiry (\r
   IN EFI_DISK_INFO_PROTOCOL       *This,\r
   IN OUT VOID                     *InquiryData,\r
-  IN OUT UINT32                   *IntquiryDataSize\r
+  IN OUT UINT32                   *InquiryDataSize\r
   );\r
 \r
 /**\r