-/*++\r
+/** @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
\r
-Copyright (c) 2006, Intel Corporation\r
+Copyright (c) 2006 - 2008, 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
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
-Module Name:\r
-\r
- DiskInfo.h\r
-\r
-Abstract:\r
-\r
- Disk Info protocol is used to export Inquiry Data for a drive.\r
- Its needed to support low level formating of drives in a mannor\r
- thats DOS compatible.\r
-\r
---*/\r
+**/\r
\r
#ifndef __DISK_INFO_H__\r
#define __DISK_INFO_H__\r
//\r
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
+\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
+\r
+**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_DISK_INFO_INQUIRY) (\r
+(EFIAPI *EFI_DISK_INFO_INQUIRY)(\r
IN EFI_DISK_INFO_PROTOCOL * This,\r
IN OUT VOID *InquiryData,\r
- IN OUT UINT32 *IntquiryDataSize\r
- )\r
-/*++\r
+ IN OUT UINT32 *InquiryDataSize\r
+ );\r
\r
- Routine Description:\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
\r
- Arguments:\r
- This - Protocol instance pointer.\r
- InquiryData - Results of Inquiry command to device\r
- InquiryDataSize - Size of InquiryData in bytes.\r
+/**\r
+ Return the results of the Identify command to a drive in IdentifyData.\r
+ Data format of Identify data is defined by the Interface GUID.\r
\r
- Returns:\r
- EFI_SUCCESS - InquiryData valid\r
- EFI_NOT_FOUND - Device does not support this data class\r
- EFI_DEVICE_ERROR - Error reading InquiryData from device\r
- EFI_BUFFER_TOO_SMALL - IntquiryDataSize not big enough\r
+ @param This Protocol instance pointer. \r
+ @param IdentifyData Results of Identify command to device \r
+ @param IdentifyDataSize Size of IdentifyData in bytes. \r
\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
\r
+**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_DISK_INFO_IDENTIFY) (\r
+(EFIAPI *EFI_DISK_INFO_IDENTIFY)(\r
IN EFI_DISK_INFO_PROTOCOL * This,\r
IN OUT VOID *IdentifyData,\r
IN OUT UINT32 *IdentifyDataSize\r
- )\r
-/*++\r
+ );\r
\r
- Routine Description:\r
- Return the results of the Identify command to a drive in IdentifyData.\r
- Data format of Identify data is defined by the Interface GUID.\r
\r
- Arguments:\r
- This - Protocol instance pointer.\r
- IdentifyData - Results of Identify command to device\r
- IdentifyDataSize - Size of IdentifyData in bytes.\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
\r
- Returns:\r
- EFI_SUCCESS - IdentifyData valid\r
- EFI_NOT_FOUND - Device does not support this data class\r
- EFI_DEVICE_ERROR - Error reading IdentifyData from device\r
- EFI_BUFFER_TOO_SMALL - IdentifyDataSize not big enough\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
\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
\r
+**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_DISK_INFO_SENSE_DATA) (\r
+(EFIAPI *EFI_DISK_INFO_SENSE_DATA)(\r
IN EFI_DISK_INFO_PROTOCOL * This,\r
IN OUT VOID *SenseData,\r
IN OUT UINT32 *SenseDataSize,\r
OUT UINT8 *SenseDataNumber\r
- )\r
-/*++\r
+ );\r
\r
- Routine Description:\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
+/**\r
+ Return the IDE device information.\r
\r
- Arguments:\r
- This - Protocol instance pointer.\r
- SenseData - Results of Request Sense command to device\r
- SenseDataSize - Size of SenseData in bytes.\r
- SenseDataNumber - Type of SenseData\r
+ @param This Protocol instance pointer. \r
+ @param IdeChannel Primary or Secondary \r
+ @param IdeDevice Master or Slave \r
\r
- Returns:\r
- EFI_SUCCESS - InquiryData valid\r
- EFI_NOT_FOUND - Device does not support this data class\r
- EFI_DEVICE_ERROR - Error reading InquiryData from device\r
- EFI_BUFFER_TOO_SMALL - SenseDataSize not big enough\r
-\r
---*/\r
-;\r
+ @retval EFI_SUCCESS IdeChannel and IdeDevice are valid \r
+ @retval EFI_UNSUPPORTED This is not an IDE device \r
\r
+**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_DISK_INFO_WHICH_IDE) (\r
+(EFIAPI *EFI_DISK_INFO_WHICH_IDE)(\r
IN EFI_DISK_INFO_PROTOCOL * This,\r
OUT UINT32 *IdeChannel,\r
OUT UINT32 *IdeDevice\r
- )\r
-/*++\r
-\r
- Routine Description:\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
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- IdeChannel - Primary or Secondary\r
- IdeDevice - Master or Slave\r
-\r
- Returns:\r
- EFI_SUCCESS - IdeChannel and IdeDevice are valid\r
- EFI_UNSUPPORTED - This is not an IDE device\r
-\r
---*/\r
-;\r
+ );\r
\r
//\r
// GUIDs for EFI_DISK_INFO_PROTOCOL.Interface. Defines the format of the\r
-// buffers returned by member functions\r
+// buffers returned by member functions.\r
//\r
#define EFI_DISK_INFO_IDE_INTERFACE_GUID \\r
{ \\r
}\r
extern EFI_GUID gEfiDiskInfoUsbInterfaceGuid;\r
\r
+#define EFI_DISK_INFO_AHCI_INTERFACE_GUID \\r
+ { \\r
+ 0x9e498932, 0x4abc, 0x45af, {0xa3, 0x4d, 0x2, 0x47, 0x78, 0x7b, 0xe7, 0xc6} \\r
+ }\r
+extern EFI_GUID gEfiDiskInfoAhciInterfaceGuid;\r
+\r
struct _EFI_DISK_INFO_PROTOCOL {\r
- EFI_GUID Interface;\r
+ EFI_GUID Interface; ///> The format of the buffers returned by member functions.\r
EFI_DISK_INFO_INQUIRY Inquiry;\r
EFI_DISK_INFO_IDENTIFY Identify;\r
EFI_DISK_INFO_SENSE_DATA SenseData;\r
projects / mirror_edk2.git / blobdiff