if module doesn't explicitly depend on specific Pci spec, it should include IndustryS...

[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Pci / IdeBusDxe / IdeBus.h

diff --git a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.h b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.h
index 55f4b72f16856e85ef748e95489d06d7ffabe191..d424eb51eb5bec7981ff82c3052e6e994f9935c5 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.h
+++ b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.h
@@ -39,7 +39,7 @@
 \r
 #include <Guid/EventGroup.h>\r
 \r
 \r
 #include <Guid/EventGroup.h>\r
 \r

-#include <IndustryStandard/Pci22.h>\r
+#include <IndustryStandard/Pci.h>\r

 #include "IdeData.h"\r
 \r
 //\r
 #include "IdeData.h"\r
 \r
 //\r


@@ -60,11 +60,6 @@ extern EFI_DRIVER_DIAGNOSTICS2_PROTOCOL gIDEBusDriverDiagnostics2;
 #define ATA_DEVICE_TYPE     0x00\r
 #define ATAPI_DEVICE_TYPE   0x01\r
 \r
 #define ATA_DEVICE_TYPE     0x00\r
 #define ATAPI_DEVICE_TYPE   0x01\r
 \r

-#define EFI_IOB_ATA_BUS_SMART_ENABLE          (EFI_SUBCLASS_SPECIFIC | 0x00000000)\r
-#define EFI_IOB_ATA_BUS_SMART_DISABLE         (EFI_SUBCLASS_SPECIFIC | 0x00000001)\r
-#define EFI_IOB_ATA_BUS_SMART_OVERTHRESHOLD   (EFI_SUBCLASS_SPECIFIC | 0x00000002)\r
-#define EFI_IOB_ATA_BUS_SMART_UNDERTHRESHOLD  (EFI_SUBCLASS_SPECIFIC | 0x00000003)\r
-\r

 typedef struct {\r
   BOOLEAN HaveScannedDevice[MAX_IDE_DEVICE];\r
   BOOLEAN DeviceFound[MAX_IDE_DEVICE];\r
 typedef struct {\r
   BOOLEAN HaveScannedDevice[MAX_IDE_DEVICE];\r
   BOOLEAN DeviceFound[MAX_IDE_DEVICE];\r


@@ -384,11 +379,11 @@ IDEBlkIoReset (
   );\r
 \r
 /**\r
   );\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
 \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
   @param  BufferSize The size of data to be read\r
   @param  Buffer     Caller supplied buffer to save data\r
 \r


@@ -411,7 +406,7 @@ IDEBlkIoReadBlocks (
 \r
   @param  This       Protocol instance pointer.\r
   @param  MediaId    The media ID of the 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
   @param  BufferSize The size of data to be written\r
   @param  Buffer     Caller supplied buffer to save data\r
 \r


@@ -443,17 +438,17 @@ IDEBlkIoFlushBlocks (
   IN  EFI_BLOCK_IO_PROTOCOL       *This\r
   );\r
 /**\r
   IN  EFI_BLOCK_IO_PROTOCOL       *This\r
   );\r
 /**\r

-  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
+  This function is used by the IDE bus driver to get inquiry data. \r
+  Data format of Identify data is defined by the Interface GUID.\r

 \r
 \r

-  @param  This Protocol instance pointer.\r
-  @param  InquiryData Results of Inquiry command to device\r
-  @param  InquiryDataSize Size of InquiryData in bytes.\r
+  @param  This                  Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r
+  @param  InquiryData           Pointer to a buffer for the inquiry data.\r
+  @param  InquiryDataSize       Pointer to the value for the inquiry data size.\r

 \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           The command was accepted without any errors.\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
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r


@@ -461,21 +456,21 @@ EFIAPI
 IDEDiskInfoInquiry (\r
   IN EFI_DISK_INFO_PROTOCOL       *This,\r
   IN OUT VOID                     *InquiryData,\r
 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
   );\r
 \r
 /**\r

-  Return the results of the Identify command to a drive in IdentifyData.\r
+  This function is used by the IDE bus driver to get identify data. \r

   Data format of Identify data is defined by the Interface GUID.\r
 \r
   Data format of Identify data is defined by the Interface GUID.\r
 \r

-  @param  This Protocol instance pointer.\r
-  @param  IdentifyData Results of Identify command to device\r
-  @param  IdentifyDataSize Size of IdentifyData in bytes.\r
+  @param  This                  Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r
+  @param  IdentifyData          Pointer to a buffer for the identify data.\r
+  @param  IdentifyDataSize      Pointer to the value for the identify data size.\r

 \r
 \r

-  @retval  EFI_SUCCESS IdentifyData valid\r
-  @retval  EFI_NOT_FOUND Device does not support this data class\r
-  @retval  EFI_DEVICE_ERROR Error reading IdentifyData from device\r
-  @retval  EFI_BUFFER_TOO_SMALL IdentifyDataSize not big enough\r
+  @retval EFI_SUCCESS           The command was accepted without any errors.\r
+  @retval EFI_NOT_FOUND         Device does not support this data class \r
+  @retval EFI_DEVICE_ERROR      Error reading IdentifyData from device \r
+  @retval EFI_BUFFER_TOO_SMALL  IdentifyDataSize not big enough \r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r


@@ -487,18 +482,18 @@ IDEDiskInfoIdentify (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Return the results of the Request Sense command to a drive in SenseData.\r
+  This function is used by the IDE bus driver to get sense data. \r

   Data format of Sense data is defined by the Interface GUID.\r
 \r
   Data format of Sense data is defined by the Interface GUID.\r
 \r

-  @param  This Protocol instance pointer.\r
-  @param  SenseData Results of Request Sense command to device\r
-  @param  SenseDataSize Size of SenseData in bytes.\r
-  @param  SenseDataNumber Type of SenseData\r
+  @param  This                  Pointer to the EFI_DISK_INFO_PROTOCOL instance. \r
+  @param  SenseData             Pointer to the SenseData. \r
+  @param  SenseDataSize         Size of SenseData in bytes. \r
+  @param  SenseDataNumber       Pointer to the value for the identify data size.\r

 \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 SenseDataSize not big enough\r
+  @retval EFI_SUCCESS           The command was accepted without any errors.\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  SenseDataSize not big enough \r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r


@@ -511,15 +506,14 @@ IDEDiskInfoSenseData (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Return the results of the Request Sense command to a drive in SenseData.\r
-  Data format of Sense data is defined by the Interface GUID.\r
+  This function is used by the IDE bus driver to get controller information.\r

 \r
 \r

-  @param  This       Protocol instance pointer.\r
-  @param  IdeChannel Primary or Secondary\r
-  @param  IdeDevice  Master or Slave\r
+  @param  This                  Pointer to the EFI_DISK_INFO_PROTOCOL instance. \r
+  @param  IdeChannel            Pointer to the Ide Channel number. Primary or secondary.\r
+  @param  IdeDevice             Pointer to the Ide Device number. Master or slave.\r

 \r
 \r

-  @retval  EFI_SUCCESS     IdeChannel and IdeDevice are valid\r
-  @retval  EFI_UNSUPPORTED This is not an IDE device\r
+  @retval EFI_SUCCESS           IdeChannel and IdeDevice are valid \r
+  @retval EFI_UNSUPPORTED       This is not an IDE device \r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r