--- /dev/null
+/** @file\r
+ Provides the basic interfaces to abstract platform information regarding an \r
+ IDE controller. \r
+\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
+ http://opensource.org/licenses/bsd-license.php\r
+\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
+ @par Revision Reference:\r
+ This Protocol is defined in UEFI Platform Initialization Specification 1.2 \r
+ Volume 5: Standards\r
+ \r
+**/\r
+\r
+#ifndef __DISK_INFO_H__\r
+#define __DISK_INFO_H__\r
+\r
+///\r
+/// Global ID for EFI_DISK_INFO_PROTOCOL\r
+///\r
+#define EFI_DISK_INFO_PROTOCOL_GUID \\r
+ { \\r
+ 0xd432a67f, 0x14dc, 0x484b, {0xb3, 0xbb, 0x3f, 0x2, 0x91, 0x84, 0x93, 0x27 } \\r
+ }\r
+\r
+///\r
+/// Forward declaration for EFI_DISK_INFO_PROTOCOL\r
+///\r
+typedef struct _EFI_DISK_INFO_PROTOCOL EFI_DISK_INFO_PROTOCOL;\r
+\r
+///\r
+/// Global ID for an IDE interface. Used to fill in EFI_DISK_INFO_PROTOCOL.Interface\r
+///\r
+#define EFI_DISK_INFO_IDE_INTERFACE_GUID \\r
+ { \\r
+ 0x5e948fe3, 0x26d3, 0x42b5, {0xaf, 0x17, 0x61, 0x2, 0x87, 0x18, 0x8d, 0xec } \\r
+ }\r
+\r
+///\r
+/// Global ID for a SCSI interface. Used to fill in EFI_DISK_INFO_PROTOCOL.Interface\r
+///\r
+#define EFI_DISK_INFO_SCSI_INTERFACE_GUID \\r
+ { \\r
+ 0x8f74baa, 0xea36, 0x41d9, {0x95, 0x21, 0x21, 0xa7, 0xf, 0x87, 0x80, 0xbc } \\r
+ }\r
+\r
+///\r
+/// Global ID for a USB interface. Used to fill in EFI_DISK_INFO_PROTOCOL.Interface\r
+///\r
+#define EFI_DISK_INFO_USB_INTERFACE_GUID \\r
+ { \\r
+ 0xcb871572, 0xc11a, 0x47b5, {0xb4, 0x92, 0x67, 0x5e, 0xaf, 0xa7, 0x77, 0x27 } \\r
+ }\r
+\r
+///\r
+/// Global ID for an AHCI interface. Used to fill in EFI_DISK_INFO_PROTOCOL.Interface\r
+///\r
+#define EFI_DISK_INFO_AHCI_INTERFACE_GUID \\r
+ { \\r
+ 0x9e498932, 0x4abc, 0x45af, {0xa3, 0x4d, 0x2, 0x47, 0x78, 0x7b, 0xe7, 0xc6} \\r
+ }\r
+\r
+/**\r
+ Provides inquiry information for the controller type.\r
+ \r
+ This function is used by the IDE bus driver to get inquiry data. Data format\r
+ of Identify data is defined by the Interface GUID.\r
+\r
+ @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r
+ @param[in,out] InquiryData Pointer to a buffer for the inquiry data.\r
+ @param[in,out] InquiryDataSize Pointer to the value for the inquiry data size.\r
+\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 InquiryDataSize not big enough \r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_DISK_INFO_INQUIRY)(\r
+ IN EFI_DISK_INFO_PROTOCOL *This,\r
+ IN OUT VOID *InquiryData,\r
+ IN OUT UINT32 *InquiryDataSize\r
+ );\r
+\r
+/**\r
+ Provides identify information for the controller type.\r
+\r
+ This function is used by the IDE bus driver to get identify data. Data format\r
+ of Identify data is defined by the Interface GUID.\r
+\r
+ @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL \r
+ instance.\r
+ @param[in,out] IdentifyData Pointer to a buffer for the identify data.\r
+ @param[in,out] IdentifyDataSize Pointer to the value for the identify data\r
+ size.\r
+\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
+typedef\r
+EFI_STATUS\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
+ Provides sense data information for the controller type.\r
+ \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[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r
+ @param[in,out] SenseData Pointer to the SenseData.\r
+ @param[in,out] SenseDataSize Size of SenseData in bytes.\r
+ @param[out] SenseDataNumber Pointer to the value for the sense data size.\r
+\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 SenseData 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
+ IN EFI_DISK_INFO_PROTOCOL *This,\r
+ IN OUT VOID *SenseData,\r
+ IN OUT UINT32 *SenseDataSize,\r
+ OUT UINT8 *SenseDataNumber\r
+ );\r
+\r
+/**\r
+ This function is used by the IDE bus driver to get controller information.\r
+\r
+ @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance. \r
+ @param[out] IdeChannel Pointer to the Ide Channel number. Primary or secondary.\r
+ @param[out] 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
+\r
+**/\r
+typedef\r
+EFI_STATUS\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
+/// The EFI_DISK_INFO_PROTOCOL provides controller specific information.\r
+///\r
+struct _EFI_DISK_INFO_PROTOCOL {\r
+ ///\r
+ /// A GUID that defines the format of buffers for the other member functions \r
+ /// of this protocol.\r
+ ///\r
+ EFI_GUID Interface;\r
+ ///\r
+ /// Return the results of the Inquiry command to a drive in InquiryData. Data\r
+ /// format of Inquiry data is defined by the Interface GUID.\r
+ ///\r
+ EFI_DISK_INFO_INQUIRY Inquiry;\r
+ ///\r
+ /// Return the results of the Identify command to a drive in IdentifyData. Data\r
+ /// format of Identify data is defined by the Interface GUID.\r
+ ///\r
+ EFI_DISK_INFO_IDENTIFY Identify;\r
+ ///\r
+ /// Return the results of the Request Sense command to a drive in SenseData. Data\r
+ /// format of Sense data is defined by the Interface GUID.\r
+ ///\r
+ EFI_DISK_INFO_SENSE_DATA SenseData;\r
+ ///\r
+ /// Specific controller. \r
+ ///\r
+ EFI_DISK_INFO_WHICH_IDE WhichIde;\r
+};\r
+\r
+extern EFI_GUID gEfiDiskInfoProtocolGuid;\r
+\r
+extern EFI_GUID gEfiDiskInfoIdeInterfaceGuid;\r
+extern EFI_GUID gEfiDiskInfoScsiInterfaceGuid;\r
+extern EFI_GUID gEfiDiskInfoUsbInterfaceGuid;\r
+extern EFI_GUID gEfiDiskInfoAhciInterfaceGuid;\r
+\r
+#endif\r
projects / mirror_edk2.git / blobdiff