]>
Commit | Line | Data |
---|---|---|
1e22c4d9 | 1 | /** @file\r |
2 | Provides the basic interfaces to abstract platform information regarding an \r | |
3 | IDE controller. \r | |
4 | \r | |
52306166 | 5 | Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r |
9df063a0 | 6 | This program and the accompanying materials\r |
1e22c4d9 | 7 | are licensed and made available under the terms and conditions of the BSD License\r |
8 | which accompanies this distribution. The full text of the license may be found at\r | |
9 | http://opensource.org/licenses/bsd-license.php\r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
13 | \r | |
14 | @par Revision Reference:\r | |
15 | This Protocol is defined in UEFI Platform Initialization Specification 1.2 \r | |
16 | Volume 5: Standards\r | |
17 | \r | |
18 | **/\r | |
19 | \r | |
20 | #ifndef __DISK_INFO_H__\r | |
21 | #define __DISK_INFO_H__\r | |
22 | \r | |
23 | ///\r | |
24 | /// Global ID for EFI_DISK_INFO_PROTOCOL\r | |
25 | ///\r | |
26 | #define EFI_DISK_INFO_PROTOCOL_GUID \\r | |
27 | { \\r | |
28 | 0xd432a67f, 0x14dc, 0x484b, {0xb3, 0xbb, 0x3f, 0x2, 0x91, 0x84, 0x93, 0x27 } \\r | |
29 | }\r | |
30 | \r | |
31 | ///\r | |
32 | /// Forward declaration for EFI_DISK_INFO_PROTOCOL\r | |
33 | ///\r | |
34 | typedef struct _EFI_DISK_INFO_PROTOCOL EFI_DISK_INFO_PROTOCOL;\r | |
35 | \r | |
36 | ///\r | |
37 | /// Global ID for an IDE interface. Used to fill in EFI_DISK_INFO_PROTOCOL.Interface\r | |
38 | ///\r | |
39 | #define EFI_DISK_INFO_IDE_INTERFACE_GUID \\r | |
40 | { \\r | |
41 | 0x5e948fe3, 0x26d3, 0x42b5, {0xaf, 0x17, 0x61, 0x2, 0x87, 0x18, 0x8d, 0xec } \\r | |
42 | }\r | |
43 | \r | |
44 | ///\r | |
45 | /// Global ID for a SCSI interface. Used to fill in EFI_DISK_INFO_PROTOCOL.Interface\r | |
46 | ///\r | |
47 | #define EFI_DISK_INFO_SCSI_INTERFACE_GUID \\r | |
48 | { \\r | |
49 | 0x8f74baa, 0xea36, 0x41d9, {0x95, 0x21, 0x21, 0xa7, 0xf, 0x87, 0x80, 0xbc } \\r | |
50 | }\r | |
51 | \r | |
52 | ///\r | |
53 | /// Global ID for a USB interface. Used to fill in EFI_DISK_INFO_PROTOCOL.Interface\r | |
54 | ///\r | |
55 | #define EFI_DISK_INFO_USB_INTERFACE_GUID \\r | |
56 | { \\r | |
57 | 0xcb871572, 0xc11a, 0x47b5, {0xb4, 0x92, 0x67, 0x5e, 0xaf, 0xa7, 0x77, 0x27 } \\r | |
58 | }\r | |
59 | \r | |
60 | ///\r | |
61 | /// Global ID for an AHCI interface. Used to fill in EFI_DISK_INFO_PROTOCOL.Interface\r | |
62 | ///\r | |
63 | #define EFI_DISK_INFO_AHCI_INTERFACE_GUID \\r | |
64 | { \\r | |
17625930 FT |
65 | 0x9e498932, 0x4abc, 0x45af, {0xa3, 0x4d, 0x2, 0x47, 0x78, 0x7b, 0xe7, 0xc6 } \\r |
66 | }\r | |
67 | \r | |
68 | ///\r | |
69 | /// Global ID for a NVME interface. Used to fill in EFI_DISK_INFO_PROTOCOL.Interface\r | |
70 | ///\r | |
71 | #define EFI_DISK_INFO_NVME_INTERFACE_GUID \\r | |
72 | { \\r | |
73 | 0x3ab14680, 0x5d3f, 0x4a4d, {0xbc, 0xdc, 0xcc, 0x38, 0x0, 0x18, 0xc7, 0xf7 } \\r | |
1e22c4d9 | 74 | }\r |
75 | \r | |
52306166 FT |
76 | ///\r |
77 | /// Global ID for a UFS interface. Used to fill in EFI_DISK_INFO_PROTOCOL.Interface\r | |
78 | ///\r | |
79 | #define EFI_DISK_INFO_UFS_INTERFACE_GUID \\r | |
80 | { \\r | |
81 | 0x4b3029cc, 0x6b98, 0x47fb, { 0xbc, 0x96, 0x76, 0xdc, 0xb8, 0x4, 0x41, 0xf0 } \\r | |
82 | }\r | |
83 | \r | |
1e22c4d9 | 84 | /**\r |
85 | Provides inquiry information for the controller type.\r | |
86 | \r | |
87 | This function is used by the IDE bus driver to get inquiry data. Data format\r | |
88 | of Identify data is defined by the Interface GUID.\r | |
89 | \r | |
90 | @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r | |
91 | @param[in,out] InquiryData Pointer to a buffer for the inquiry data.\r | |
92 | @param[in,out] InquiryDataSize Pointer to the value for the inquiry data size.\r | |
93 | \r | |
94 | @retval EFI_SUCCESS The command was accepted without any errors.\r | |
95 | @retval EFI_NOT_FOUND Device does not support this data class \r | |
96 | @retval EFI_DEVICE_ERROR Error reading InquiryData from device \r | |
97 | @retval EFI_BUFFER_TOO_SMALL InquiryDataSize not big enough \r | |
98 | \r | |
99 | **/\r | |
100 | typedef\r | |
101 | EFI_STATUS\r | |
102 | (EFIAPI *EFI_DISK_INFO_INQUIRY)(\r | |
103 | IN EFI_DISK_INFO_PROTOCOL *This,\r | |
104 | IN OUT VOID *InquiryData,\r | |
105 | IN OUT UINT32 *InquiryDataSize\r | |
106 | );\r | |
107 | \r | |
108 | /**\r | |
109 | Provides identify information for the controller type.\r | |
110 | \r | |
111 | This function is used by the IDE bus driver to get identify data. Data format\r | |
112 | of Identify data is defined by the Interface GUID.\r | |
113 | \r | |
114 | @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL \r | |
115 | instance.\r | |
116 | @param[in,out] IdentifyData Pointer to a buffer for the identify data.\r | |
117 | @param[in,out] IdentifyDataSize Pointer to the value for the identify data\r | |
118 | size.\r | |
119 | \r | |
120 | @retval EFI_SUCCESS The command was accepted without any errors.\r | |
121 | @retval EFI_NOT_FOUND Device does not support this data class \r | |
122 | @retval EFI_DEVICE_ERROR Error reading IdentifyData from device \r | |
123 | @retval EFI_BUFFER_TOO_SMALL IdentifyDataSize not big enough \r | |
124 | \r | |
125 | **/\r | |
126 | typedef\r | |
127 | EFI_STATUS\r | |
128 | (EFIAPI *EFI_DISK_INFO_IDENTIFY)(\r | |
129 | IN EFI_DISK_INFO_PROTOCOL *This,\r | |
130 | IN OUT VOID *IdentifyData,\r | |
131 | IN OUT UINT32 *IdentifyDataSize\r | |
132 | );\r | |
133 | \r | |
134 | /**\r | |
135 | Provides sense data information for the controller type.\r | |
136 | \r | |
137 | This function is used by the IDE bus driver to get sense data. \r | |
138 | Data format of Sense data is defined by the Interface GUID.\r | |
139 | \r | |
140 | @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r | |
141 | @param[in,out] SenseData Pointer to the SenseData.\r | |
142 | @param[in,out] SenseDataSize Size of SenseData in bytes.\r | |
143 | @param[out] SenseDataNumber Pointer to the value for the sense data size.\r | |
144 | \r | |
145 | @retval EFI_SUCCESS The command was accepted without any errors.\r | |
146 | @retval EFI_NOT_FOUND Device does not support this data class.\r | |
147 | @retval EFI_DEVICE_ERROR Error reading SenseData from device.\r | |
148 | @retval EFI_BUFFER_TOO_SMALL SenseDataSize not big enough.\r | |
149 | \r | |
150 | **/\r | |
151 | typedef\r | |
152 | EFI_STATUS\r | |
153 | (EFIAPI *EFI_DISK_INFO_SENSE_DATA)(\r | |
154 | IN EFI_DISK_INFO_PROTOCOL *This,\r | |
155 | IN OUT VOID *SenseData,\r | |
156 | IN OUT UINT32 *SenseDataSize,\r | |
157 | OUT UINT8 *SenseDataNumber\r | |
158 | );\r | |
159 | \r | |
160 | /**\r | |
161 | This function is used by the IDE bus driver to get controller information.\r | |
162 | \r | |
163 | @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance. \r | |
164 | @param[out] IdeChannel Pointer to the Ide Channel number. Primary or secondary.\r | |
165 | @param[out] IdeDevice Pointer to the Ide Device number. Master or slave.\r | |
166 | \r | |
167 | @retval EFI_SUCCESS IdeChannel and IdeDevice are valid.\r | |
168 | @retval EFI_UNSUPPORTED This is not an IDE device.\r | |
169 | \r | |
170 | **/\r | |
171 | typedef\r | |
172 | EFI_STATUS\r | |
173 | (EFIAPI *EFI_DISK_INFO_WHICH_IDE)(\r | |
174 | IN EFI_DISK_INFO_PROTOCOL *This,\r | |
175 | OUT UINT32 *IdeChannel,\r | |
176 | OUT UINT32 *IdeDevice\r | |
177 | );\r | |
178 | \r | |
179 | ///\r | |
180 | /// The EFI_DISK_INFO_PROTOCOL provides controller specific information.\r | |
181 | ///\r | |
182 | struct _EFI_DISK_INFO_PROTOCOL {\r | |
183 | ///\r | |
184 | /// A GUID that defines the format of buffers for the other member functions \r | |
185 | /// of this protocol.\r | |
186 | ///\r | |
187 | EFI_GUID Interface;\r | |
188 | ///\r | |
189 | /// Return the results of the Inquiry command to a drive in InquiryData. Data\r | |
190 | /// format of Inquiry data is defined by the Interface GUID.\r | |
191 | ///\r | |
192 | EFI_DISK_INFO_INQUIRY Inquiry;\r | |
193 | ///\r | |
194 | /// Return the results of the Identify command to a drive in IdentifyData. Data\r | |
195 | /// format of Identify data is defined by the Interface GUID.\r | |
196 | ///\r | |
197 | EFI_DISK_INFO_IDENTIFY Identify;\r | |
198 | ///\r | |
199 | /// Return the results of the Request Sense command to a drive in SenseData. Data\r | |
200 | /// format of Sense data is defined by the Interface GUID.\r | |
201 | ///\r | |
202 | EFI_DISK_INFO_SENSE_DATA SenseData;\r | |
203 | ///\r | |
204 | /// Specific controller. \r | |
205 | ///\r | |
206 | EFI_DISK_INFO_WHICH_IDE WhichIde;\r | |
207 | };\r | |
208 | \r | |
209 | extern EFI_GUID gEfiDiskInfoProtocolGuid;\r | |
210 | \r | |
211 | extern EFI_GUID gEfiDiskInfoIdeInterfaceGuid;\r | |
212 | extern EFI_GUID gEfiDiskInfoScsiInterfaceGuid;\r | |
213 | extern EFI_GUID gEfiDiskInfoUsbInterfaceGuid;\r | |
214 | extern EFI_GUID gEfiDiskInfoAhciInterfaceGuid;\r | |
4990d1c0 | 215 | extern EFI_GUID gEfiDiskInfoNvmeInterfaceGuid;\r |
52306166 | 216 | extern EFI_GUID gEfiDiskInfoUfsInterfaceGuid;\r |
1e22c4d9 | 217 | \r |
218 | #endif\r |