Add comments for IntelFrameworkModulePkg Header file.

[mirror_edk2.git] / IntelFrameworkModulePkg / Include / Protocol / DiskInfo.h

diff --git a/IntelFrameworkModulePkg/Include/Protocol/DiskInfo.h b/IntelFrameworkModulePkg/Include/Protocol/DiskInfo.h
index 8409d988f8b3ef49f64410a93af1e7b20cb8ec85..833072fc894bc323cbbd8372d09ddd065ff1086d 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Protocol/DiskInfo.h
+++ b/IntelFrameworkModulePkg/Include/Protocol/DiskInfo.h
@@ -1,8 +1,8 @@
 /** @file\r
-  Disk Info protocol is used to export Inquiry Data for a drive.\r
-  It supports low level formating of drives in a DOS compatible manner.\r
+  Disk Info protocol Provides the basic interfaces to abstract \r
+  platform information regarding an IDE controller.\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
+Copyright (c) 2006 - 2009, Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -27,14 +27,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 typedef struct _EFI_DISK_INFO_PROTOCOL  EFI_DISK_INFO_PROTOCOL;\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
   @param  This                  Protocol instance pointer. \r
-  @param  InquiryData           Results of Inquiry command to device \r
-  @param  InquiryDataSize       Size of InquiryData in bytes. \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
-  @retval EFI_SUCCESS           InquiryData valid \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
@@ -50,14 +50,14 @@ EFI_STATUS
 \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
   @param  This                  Protocol instance pointer. \r
-  @param  IdentifyData          Results of Identify command to device \r
-  @param  IdentifyDataSize      Size of IdentifyData in bytes. \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
-  @retval EFI_SUCCESS           IdentifyData valid \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
@@ -73,15 +73,15 @@ EFI_STATUS
 \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
   @param  This                  Protocol instance pointer. \r
-  @param  SenseData             Results of Request Sense command to device \r
+  @param  SenseData             Pointer to the SenseData. \r
   @param  SenseDataSize         Size of SenseData in bytes. \r
-  @param  SenseDataNumber       Type of SenseData \r
+  @param  SenseDataNumber       Pointer to the value for the identify data size.\r
 \r
-  @retval EFI_SUCCESS           InquiryData valid \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
@@ -97,11 +97,11 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Return the IDE device information.\r
+  This function is used by the IDE bus driver to get controller information.\r
 \r
   @param  This                  Protocol instance pointer. \r
-  @param  IdeChannel            Primary or Secondary \r
-  @param  IdeDevice             Master or Slave \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
   @retval EFI_SUCCESS           IdeChannel and IdeDevice are valid \r
   @retval EFI_UNSUPPORTED       This is not an IDE device \r
@@ -116,8 +116,7 @@ EFI_STATUS
   );\r
 \r
 //\r
-// GUIDs for EFI_DISK_INFO_PROTOCOL.Interface. Defines the format of the\r
-// buffers returned by member functions.\r
+// GUID of the type of interfaces\r
 //\r
 #define EFI_DISK_INFO_IDE_INTERFACE_GUID \\r
   { \\r
@@ -144,7 +143,10 @@ extern EFI_GUID gEfiDiskInfoUsbInterfaceGuid;
 extern EFI_GUID gEfiDiskInfoAhciInterfaceGuid;\r
 \r
 struct _EFI_DISK_INFO_PROTOCOL {\r
-  EFI_GUID                  Interface;  ///> The format of the buffers returned by member functions.\r
+  ///\r
+  /// A GUID that defines the format of buffers for the other member functions of this protocol.\r
+  ///\r
+  EFI_GUID                  Interface;\r
   EFI_DISK_INFO_INQUIRY     Inquiry;\r
   EFI_DISK_INFO_IDENTIFY    Identify;\r
   EFI_DISK_INFO_SENSE_DATA  SenseData;\r