]>
Commit | Line | Data |
---|---|---|
12e92a23 RJ |
1 | /** @file\r |
2 | Header file for Sata Controller driver.\r | |
3 | \r | |
4 | Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>\r | |
b26f0cf9 | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
12e92a23 RJ |
6 | \r |
7 | **/\r | |
8 | \r | |
9 | #ifndef _SATA_CONTROLLER_H_\r | |
10 | #define _SATA_CONTROLLER_H_\r | |
11 | \r | |
12 | #include <Uefi.h>\r | |
13 | #include <Protocol/ComponentName.h>\r | |
14 | #include <Protocol/DriverBinding.h>\r | |
15 | #include <Protocol/PciIo.h>\r | |
16 | #include <Protocol/IdeControllerInit.h>\r | |
17 | #include <Library/UefiDriverEntryPoint.h>\r | |
18 | #include <Library/DebugLib.h>\r | |
19 | #include <Library/UefiLib.h>\r | |
20 | #include <Library/BaseLib.h>\r | |
21 | #include <Library/BaseMemoryLib.h>\r | |
22 | #include <Library/MemoryAllocationLib.h>\r | |
23 | #include <Library/UefiBootServicesTableLib.h>\r | |
24 | #include <IndustryStandard/Pci.h>\r | |
25 | \r | |
26 | //\r | |
27 | // Global Variables definitions\r | |
28 | //\r | |
29 | extern EFI_DRIVER_BINDING_PROTOCOL gSataControllerDriverBinding;\r | |
30 | extern EFI_COMPONENT_NAME_PROTOCOL gSataControllerComponentName;\r | |
31 | extern EFI_COMPONENT_NAME2_PROTOCOL gSataControllerComponentName2;\r | |
32 | \r | |
33 | #define AHCI_BAR_INDEX 0x05\r | |
34 | #define R_AHCI_CAP 0x0\r | |
35 | #define B_AHCI_CAP_NPS (BIT4 | BIT3 | BIT2 | BIT1 | BIT0) // Number of Ports\r | |
36 | #define B_AHCI_CAP_SPM BIT17 // Supports Port Multiplier\r | |
37 | \r | |
38 | ///\r | |
39 | /// AHCI each channel can have up to 1 device\r | |
40 | ///\r | |
41 | #define AHCI_MAX_DEVICES 0x01\r | |
42 | \r | |
43 | ///\r | |
44 | /// AHCI each channel can have 15 devices in the presence of a multiplier\r | |
45 | ///\r | |
46 | #define AHCI_MULTI_MAX_DEVICES 0x0F\r | |
47 | \r | |
48 | ///\r | |
49 | /// IDE supports 2 channel max\r | |
50 | ///\r | |
51 | #define IDE_MAX_CHANNEL 0x02\r | |
52 | \r | |
53 | ///\r | |
54 | /// IDE supports 2 devices max\r | |
55 | ///\r | |
56 | #define IDE_MAX_DEVICES 0x02\r | |
57 | \r | |
58 | #define SATA_ENUMER_ALL FALSE\r | |
59 | \r | |
60 | //\r | |
61 | // Sata Controller driver private data structure\r | |
62 | //\r | |
63 | \r | |
64 | #define SATA_CONTROLLER_SIGNATURE SIGNATURE_32('S','A','T','A')\r | |
65 | \r | |
66 | typedef struct _EFI_SATA_CONTROLLER_PRIVATE_DATA {\r | |
67 | //\r | |
68 | // Standard signature used to identify Sata Controller private data\r | |
69 | //\r | |
70 | UINT32 Signature;\r | |
71 | \r | |
72 | //\r | |
73 | // Protocol instance of IDE_CONTROLLER_INIT produced by this driver\r | |
74 | //\r | |
75 | EFI_IDE_CONTROLLER_INIT_PROTOCOL IdeInit;\r | |
76 | \r | |
77 | //\r | |
78 | // Copy of protocol pointers used by this driver\r | |
79 | //\r | |
80 | EFI_PCI_IO_PROTOCOL *PciIo;\r | |
81 | \r | |
bcab7141 LE |
82 | //\r |
83 | // Original PCI attributes\r | |
84 | //\r | |
85 | UINT64 OriginalPciAttributes;\r | |
86 | \r | |
12e92a23 RJ |
87 | //\r |
88 | // The number of devices that are supported by this channel\r | |
89 | //\r | |
90 | UINT8 DeviceCount;\r | |
91 | \r | |
92 | //\r | |
93 | // The highest disqulified mode for each attached device,\r | |
94 | // From ATA/ATAPI spec, if a mode is not supported,\r | |
95 | // the modes higher than it is also not supported\r | |
96 | //\r | |
97 | EFI_ATA_COLLECTIVE_MODE *DisqualifiedModes;\r | |
98 | \r | |
99 | //\r | |
100 | // A copy of EFI_IDENTIFY_DATA data for each attached SATA device and its flag\r | |
101 | //\r | |
102 | EFI_IDENTIFY_DATA *IdentifyData;\r | |
103 | BOOLEAN *IdentifyValid;\r | |
104 | } EFI_SATA_CONTROLLER_PRIVATE_DATA;\r | |
105 | \r | |
106 | #define SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS(a) CR(a, EFI_SATA_CONTROLLER_PRIVATE_DATA, IdeInit, SATA_CONTROLLER_SIGNATURE)\r | |
107 | \r | |
108 | //\r | |
109 | // Driver binding functions declaration\r | |
110 | //\r | |
111 | /**\r | |
112 | Supported function of Driver Binding protocol for this driver.\r | |
113 | Test to see if this driver supports ControllerHandle.\r | |
114 | \r | |
115 | @param This Protocol instance pointer.\r | |
116 | @param Controller Handle of device to test.\r | |
117 | @param RemainingDevicePath A pointer to the device path. Should be ignored by\r | |
118 | device driver.\r | |
119 | \r | |
120 | @retval EFI_SUCCESS This driver supports this device.\r | |
121 | @retval EFI_ALREADY_STARTED This driver is already running on this device.\r | |
122 | @retval other This driver does not support this device.\r | |
123 | \r | |
124 | **/\r | |
125 | EFI_STATUS\r | |
126 | EFIAPI\r | |
127 | SataControllerSupported (\r | |
128 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
129 | IN EFI_HANDLE Controller,\r | |
130 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
131 | )\r | |
132 | ;\r | |
133 | \r | |
134 | /**\r | |
4040754d | 135 | This routine is called right after the .Supported() called and\r |
12e92a23 RJ |
136 | Start this driver on ControllerHandle.\r |
137 | \r | |
138 | @param This Protocol instance pointer.\r | |
139 | @param Controller Handle of device to bind driver to.\r | |
140 | @param RemainingDevicePath A pointer to the device path. Should be ignored by\r | |
141 | device driver.\r | |
142 | \r | |
143 | @retval EFI_SUCCESS This driver is added to this device.\r | |
144 | @retval EFI_ALREADY_STARTED This driver is already running on this device.\r | |
145 | @retval other Some error occurs when binding this driver to this device.\r | |
146 | \r | |
147 | **/\r | |
148 | EFI_STATUS\r | |
149 | EFIAPI\r | |
150 | SataControllerStart (\r | |
151 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
152 | IN EFI_HANDLE Controller,\r | |
153 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
154 | )\r | |
155 | ;\r | |
156 | \r | |
157 | /**\r | |
158 | Stop this driver on ControllerHandle.\r | |
159 | \r | |
160 | @param This Protocol instance pointer.\r | |
161 | @param Controller Handle of device to stop driver on.\r | |
162 | @param NumberOfChildren Not used.\r | |
163 | @param ChildHandleBuffer Not used.\r | |
164 | \r | |
165 | @retval EFI_SUCCESS This driver is removed from this device.\r | |
166 | @retval other Some error occurs when removing this driver from this device.\r | |
167 | \r | |
168 | **/\r | |
169 | EFI_STATUS\r | |
170 | EFIAPI\r | |
171 | SataControllerStop (\r | |
172 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
173 | IN EFI_HANDLE Controller,\r | |
174 | IN UINTN NumberOfChildren,\r | |
175 | IN EFI_HANDLE *ChildHandleBuffer\r | |
176 | )\r | |
177 | ;\r | |
178 | \r | |
179 | //\r | |
180 | // IDE controller init functions declaration\r | |
181 | //\r | |
182 | /**\r | |
183 | Returns the information about the specified IDE channel.\r | |
4040754d | 184 | \r |
12e92a23 | 185 | This function can be used to obtain information about a particular IDE channel.\r |
4040754d LL |
186 | The driver entity uses this information during the enumeration process.\r |
187 | \r | |
188 | If Enabled is set to FALSE, the driver entity will not scan the channel. Note\r | |
12e92a23 | 189 | that it will not prevent an operating system driver from scanning the channel.\r |
4040754d LL |
190 | \r |
191 | For most of today's controllers, MaxDevices will either be 1 or 2. For SATA\r | |
192 | controllers, this value will always be 1. SATA configurations can contain SATA\r | |
12e92a23 | 193 | port multipliers. SATA port multipliers behave like SATA bridges and can support\r |
4040754d LL |
194 | up to 16 devices on the other side. If a SATA port out of the IDE controller\r |
195 | is connected to a port multiplier, MaxDevices will be set to the number of SATA\r | |
196 | devices that the port multiplier supports. Because today's port multipliers\r | |
197 | support up to fifteen SATA devices, this number can be as large as fifteen. The IDE\r | |
198 | bus driver is required to scan for the presence of port multipliers behind an SATA\r | |
199 | controller and enumerate up to MaxDevices number of devices behind the port\r | |
200 | multiplier.\r | |
201 | \r | |
202 | In this context, the devices behind a port multiplier constitute a channel.\r | |
203 | \r | |
12e92a23 RJ |
204 | @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r |
205 | @param[in] Channel Zero-based channel number.\r | |
4040754d | 206 | @param[out] Enabled TRUE if this channel is enabled. Disabled channels\r |
12e92a23 RJ |
207 | are not scanned to see if any devices are present.\r |
208 | @param[out] MaxDevices The maximum number of IDE devices that the bus driver\r | |
4040754d LL |
209 | can expect on this channel. For the ATA/ATAPI\r |
210 | specification, version 6, this number will either be\r | |
211 | one or two. For Serial ATA (SATA) configurations with a\r | |
12e92a23 RJ |
212 | port multiplier, this number can be as large as fifteen.\r |
213 | \r | |
214 | @retval EFI_SUCCESS Information was returned without any errors.\r | |
215 | @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r | |
216 | \r | |
217 | **/\r | |
218 | EFI_STATUS\r | |
219 | EFIAPI\r | |
220 | IdeInitGetChannelInfo (\r | |
221 | IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,\r | |
222 | IN UINT8 Channel,\r | |
223 | OUT BOOLEAN *Enabled,\r | |
224 | OUT UINT8 *MaxDevices\r | |
225 | )\r | |
226 | ;\r | |
227 | \r | |
228 | /**\r | |
229 | The notifications from the driver entity that it is about to enter a certain\r | |
230 | phase of the IDE channel enumeration process.\r | |
4040754d LL |
231 | \r |
232 | This function can be used to notify the IDE controller driver to perform\r | |
233 | specific actions, including any chipset-specific initialization, so that the\r | |
234 | chipset is ready to enter the next phase. Seven notification points are defined\r | |
235 | at this time.\r | |
236 | \r | |
237 | More synchronization points may be added as required in the future.\r | |
12e92a23 RJ |
238 | \r |
239 | @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r | |
240 | @param[in] Phase The phase during enumeration.\r | |
241 | @param[in] Channel Zero-based channel number.\r | |
242 | \r | |
243 | @retval EFI_SUCCESS The notification was accepted without any errors.\r | |
244 | @retval EFI_UNSUPPORTED Phase is not supported.\r | |
245 | @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r | |
4040754d LL |
246 | @retval EFI_NOT_READY This phase cannot be entered at this time; for\r |
247 | example, an attempt was made to enter a Phase\r | |
248 | without having entered one or more previous\r | |
12e92a23 RJ |
249 | Phase.\r |
250 | \r | |
251 | **/\r | |
252 | EFI_STATUS\r | |
253 | EFIAPI\r | |
254 | IdeInitNotifyPhase (\r | |
255 | IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,\r | |
256 | IN EFI_IDE_CONTROLLER_ENUM_PHASE Phase,\r | |
257 | IN UINT8 Channel\r | |
258 | )\r | |
259 | ;\r | |
260 | \r | |
261 | /**\r | |
262 | Submits the device information to the IDE controller driver.\r | |
263 | \r | |
4040754d LL |
264 | This function is used by the driver entity to pass detailed information about\r |
265 | a particular device to the IDE controller driver. The driver entity obtains\r | |
12e92a23 | 266 | this information by issuing an ATA or ATAPI IDENTIFY_DEVICE command. IdentifyData\r |
4040754d LL |
267 | is the pointer to the response data buffer. The IdentifyData buffer is owned\r |
268 | by the driver entity, and the IDE controller driver must make a local copy\r | |
269 | of the entire buffer or parts of the buffer as needed. The original IdentifyData\r | |
12e92a23 | 270 | buffer pointer may not be valid when\r |
4040754d | 271 | \r |
12e92a23 RJ |
272 | - EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() or\r |
273 | - EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode() is called at a later point.\r | |
4040754d LL |
274 | \r |
275 | The IDE controller driver may consult various fields of EFI_IDENTIFY_DATA to\r | |
276 | compute the optimum mode for the device. These fields are not limited to the\r | |
277 | timing information. For example, an implementation of the IDE controller driver\r | |
278 | may examine the vendor and type/mode field to match known bad drives.\r | |
279 | \r | |
280 | The driver entity may submit drive information in any order, as long as it\r | |
281 | submits information for all the devices belonging to the enumeration group\r | |
12e92a23 RJ |
282 | before EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() is called for any device\r |
283 | in that enumeration group. If a device is absent, EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData()\r | |
4040754d LL |
284 | should be called with IdentifyData set to NULL. The IDE controller driver may\r |
285 | not have any other mechanism to know whether a device is present or not. Therefore,\r | |
286 | setting IdentifyData to NULL does not constitute an error condition.\r | |
287 | EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() can be called only once for a\r | |
288 | given (Channel, Device) pair.\r | |
289 | \r | |
12e92a23 RJ |
290 | @param[in] This A pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r |
291 | @param[in] Channel Zero-based channel number.\r | |
292 | @param[in] Device Zero-based device number on the Channel.\r | |
293 | @param[in] IdentifyData The device's response to the ATA IDENTIFY_DEVICE command.\r | |
294 | \r | |
295 | @retval EFI_SUCCESS The information was accepted without any errors.\r | |
296 | @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r | |
297 | @retval EFI_INVALID_PARAMETER Device is invalid.\r | |
298 | \r | |
299 | **/\r | |
300 | EFI_STATUS\r | |
301 | EFIAPI\r | |
302 | IdeInitSubmitData (\r | |
303 | IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,\r | |
304 | IN UINT8 Channel,\r | |
305 | IN UINT8 Device,\r | |
306 | IN EFI_IDENTIFY_DATA *IdentifyData\r | |
307 | )\r | |
308 | ;\r | |
309 | \r | |
310 | /**\r | |
311 | Disqualifies specific modes for an IDE device.\r | |
312 | \r | |
4040754d | 313 | This function allows the driver entity or other drivers (such as platform\r |
12e92a23 | 314 | drivers) to reject certain timing modes and request the IDE controller driver\r |
4040754d LL |
315 | to recalculate modes. This function allows the driver entity and the IDE\r |
316 | controller driver to negotiate the timings on a per-device basis. This function\r | |
317 | is useful in the case of drives that lie about their capabilities. An example\r | |
318 | is when the IDE device fails to accept the timing modes that are calculated\r | |
12e92a23 RJ |
319 | by the IDE controller driver based on the response to the Identify Drive command.\r |
320 | \r | |
4040754d LL |
321 | If the driver entity does not want to limit the ATA timing modes and leave that\r |
322 | decision to the IDE controller driver, it can either not call this function for\r | |
323 | the given device or call this function and set the Valid flag to FALSE for all\r | |
12e92a23 | 324 | modes that are listed in EFI_ATA_COLLECTIVE_MODE.\r |
4040754d LL |
325 | \r |
326 | The driver entity may disqualify modes for a device in any order and any number\r | |
12e92a23 | 327 | of times.\r |
4040754d LL |
328 | \r |
329 | This function can be called multiple times to invalidate multiple modes of the\r | |
330 | same type (e.g., Programmed Input/Output [PIO] modes 3 and 4). See the ATA/ATAPI\r | |
331 | specification for more information on PIO modes.\r | |
332 | \r | |
12e92a23 RJ |
333 | For Serial ATA (SATA) controllers, this member function can be used to disqualify\r |
334 | a higher transfer rate mode on a given channel. For example, a platform driver\r | |
4040754d | 335 | may inform the IDE controller driver to not use second-generation (Gen2) speeds\r |
12e92a23 | 336 | for a certain SATA drive.\r |
4040754d | 337 | \r |
12e92a23 RJ |
338 | @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r |
339 | @param[in] Channel The zero-based channel number.\r | |
340 | @param[in] Device The zero-based device number on the Channel.\r | |
341 | @param[in] BadModes The modes that the device does not support and that\r | |
342 | should be disqualified.\r | |
343 | \r | |
344 | @retval EFI_SUCCESS The modes were accepted without any errors.\r | |
345 | @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r | |
346 | @retval EFI_INVALID_PARAMETER Device is invalid.\r | |
347 | @retval EFI_INVALID_PARAMETER IdentifyData is NULL.\r | |
4040754d | 348 | \r |
12e92a23 RJ |
349 | **/\r |
350 | EFI_STATUS\r | |
351 | EFIAPI\r | |
352 | IdeInitDisqualifyMode (\r | |
353 | IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,\r | |
354 | IN UINT8 Channel,\r | |
355 | IN UINT8 Device,\r | |
356 | IN EFI_ATA_COLLECTIVE_MODE *BadModes\r | |
357 | )\r | |
358 | ;\r | |
359 | \r | |
360 | /**\r | |
361 | Returns the information about the optimum modes for the specified IDE device.\r | |
362 | \r | |
363 | This function is used by the driver entity to obtain the optimum ATA modes for\r | |
4040754d | 364 | a specific device. The IDE controller driver takes into account the following\r |
12e92a23 RJ |
365 | while calculating the mode:\r |
366 | - The IdentifyData inputs to EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData()\r | |
367 | - The BadModes inputs to EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode()\r | |
368 | \r | |
4040754d LL |
369 | The driver entity is required to call EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData()\r |
370 | for all the devices that belong to an enumeration group before calling\r | |
371 | EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() for any device in the same group.\r | |
372 | \r | |
373 | The IDE controller driver will use controller- and possibly platform-specific\r | |
374 | algorithms to arrive at SupportedModes. The IDE controller may base its\r | |
375 | decision on user preferences and other considerations as well. This function\r | |
376 | may be called multiple times because the driver entity may renegotiate the mode\r | |
12e92a23 | 377 | with the IDE controller driver using EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode().\r |
4040754d LL |
378 | \r |
379 | The driver entity may collect timing information for various devices in any\r | |
12e92a23 | 380 | order. The driver entity is responsible for making sure that all the dependencies\r |
4040754d LL |
381 | are satisfied. For example, the SupportedModes information for device A that\r |
382 | was previously returned may become stale after a call to\r | |
12e92a23 | 383 | EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode() for device B.\r |
4040754d LL |
384 | \r |
385 | The buffer SupportedModes is allocated by the callee because the caller does\r | |
386 | not necessarily know the size of the buffer. The type EFI_ATA_COLLECTIVE_MODE\r | |
387 | is defined in a way that allows for future extensibility and can be of variable\r | |
388 | length. This memory pool should be deallocated by the caller when it is no\r | |
389 | longer necessary.\r | |
390 | \r | |
391 | The IDE controller driver for a Serial ATA (SATA) controller can use this\r | |
392 | member function to force a lower speed (first-generation [Gen1] speeds on a\r | |
393 | second-generation [Gen2]-capable hardware). The IDE controller driver can\r | |
394 | also allow the driver entity to stay with the speed that has been negotiated\r | |
12e92a23 | 395 | by the physical layer.\r |
4040754d | 396 | \r |
12e92a23 RJ |
397 | @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r |
398 | @param[in] Channel A zero-based channel number.\r | |
399 | @param[in] Device A zero-based device number on the Channel.\r | |
400 | @param[out] SupportedModes The optimum modes for the device.\r | |
401 | \r | |
402 | @retval EFI_SUCCESS SupportedModes was returned.\r | |
403 | @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r | |
4040754d | 404 | @retval EFI_INVALID_PARAMETER Device is invalid.\r |
12e92a23 | 405 | @retval EFI_INVALID_PARAMETER SupportedModes is NULL.\r |
4040754d LL |
406 | @retval EFI_NOT_READY Modes cannot be calculated due to a lack of\r |
407 | data. This error may happen if\r | |
408 | EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData()\r | |
409 | and EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyData()\r | |
410 | were not called for at least one drive in the\r | |
12e92a23 RJ |
411 | same enumeration group.\r |
412 | \r | |
413 | **/\r | |
414 | EFI_STATUS\r | |
415 | EFIAPI\r | |
416 | IdeInitCalculateMode (\r | |
417 | IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,\r | |
418 | IN UINT8 Channel,\r | |
419 | IN UINT8 Device,\r | |
420 | OUT EFI_ATA_COLLECTIVE_MODE **SupportedModes\r | |
421 | )\r | |
422 | ;\r | |
423 | \r | |
424 | /**\r | |
425 | Commands the IDE controller driver to program the IDE controller hardware\r | |
426 | so that the specified device can operate at the specified mode.\r | |
427 | \r | |
4040754d LL |
428 | This function is used by the driver entity to instruct the IDE controller\r |
429 | driver to program the IDE controller hardware to the specified modes. This\r | |
430 | function can be called only once for a particular device. For a Serial ATA\r | |
12e92a23 RJ |
431 | (SATA) Advanced Host Controller Interface (AHCI) controller, no controller-\r |
432 | specific programming may be required.\r | |
433 | \r | |
434 | @param[in] This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r | |
435 | @param[in] Channel Zero-based channel number.\r | |
436 | @param[in] Device Zero-based device number on the Channel.\r | |
437 | @param[in] Modes The modes to set.\r | |
438 | \r | |
439 | @retval EFI_SUCCESS The command was accepted without any errors.\r | |
440 | @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r | |
441 | @retval EFI_INVALID_PARAMETER Device is invalid.\r | |
442 | @retval EFI_NOT_READY Modes cannot be set at this time due to lack of data.\r | |
443 | @retval EFI_DEVICE_ERROR Modes cannot be set due to hardware failure.\r | |
444 | The driver entity should not use this device.\r | |
445 | \r | |
446 | **/\r | |
447 | EFI_STATUS\r | |
448 | EFIAPI\r | |
449 | IdeInitSetTiming (\r | |
450 | IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,\r | |
451 | IN UINT8 Channel,\r | |
452 | IN UINT8 Device,\r | |
453 | IN EFI_ATA_COLLECTIVE_MODE *Modes\r | |
454 | )\r | |
455 | ;\r | |
456 | \r | |
457 | //\r | |
458 | // Forward reference declaration\r | |
459 | //\r | |
460 | /**\r | |
461 | Retrieves a Unicode string that is the user readable name of the UEFI Driver.\r | |
462 | \r | |
463 | @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
464 | @param Language A pointer to a three character ISO 639-2 language identifier.\r | |
465 | This is the language of the driver name that that the caller\r | |
466 | is requesting, and it must match one of the languages specified\r | |
467 | in SupportedLanguages. The number of languages supported by a\r | |
468 | driver is up to the driver writer.\r | |
469 | @param DriverName A pointer to the Unicode string to return. This Unicode string\r | |
470 | is the name of the driver specified by This in the language\r | |
471 | specified by Language.\r | |
472 | \r | |
473 | @retval EFI_SUCCESS The Unicode string for the Driver specified by This\r | |
474 | and the language specified by Language was returned\r | |
475 | in DriverName.\r | |
476 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
477 | @retval EFI_INVALID_PARAMETER DriverName is NULL.\r | |
478 | @retval EFI_UNSUPPORTED The driver specified by This does not support the\r | |
479 | language specified by Language.\r | |
480 | **/\r | |
481 | EFI_STATUS\r | |
482 | EFIAPI\r | |
483 | SataControllerComponentNameGetDriverName (\r | |
484 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r | |
485 | IN CHAR8 *Language,\r | |
486 | OUT CHAR16 **DriverName\r | |
487 | )\r | |
488 | ;\r | |
489 | \r | |
490 | /**\r | |
491 | Retrieves a Unicode string that is the user readable name of the controller\r | |
492 | that is being managed by an UEFI Driver.\r | |
493 | \r | |
494 | @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
495 | @param ControllerHandle The handle of a controller that the driver specified by\r | |
496 | This is managing. This handle specifies the controller\r | |
497 | whose name is to be returned.\r | |
498 | @param OPTIONAL ChildHandle The handle of the child controller to retrieve the name\r | |
499 | of. This is an optional parameter that may be NULL. It\r | |
500 | will be NULL for device drivers. It will also be NULL\r | |
501 | for a bus drivers that wish to retrieve the name of the\r | |
502 | bus controller. It will not be NULL for a bus driver\r | |
503 | that wishes to retrieve the name of a child controller.\r | |
504 | @param Language A pointer to a three character ISO 639-2 language\r | |
505 | identifier. This is the language of the controller name\r | |
506 | that that the caller is requesting, and it must match one\r | |
507 | of the languages specified in SupportedLanguages. The\r | |
508 | number of languages supported by a driver is up to the\r | |
509 | driver writer.\r | |
510 | @param ControllerName A pointer to the Unicode string to return. This Unicode\r | |
511 | string is the name of the controller specified by\r | |
512 | ControllerHandle and ChildHandle in the language\r | |
513 | specified by Language from the point of view of the\r | |
514 | driver specified by This.\r | |
515 | \r | |
516 | @retval EFI_SUCCESS The Unicode string for the user readable name in the\r | |
517 | language specified by Language for the driver\r | |
518 | specified by This was returned in DriverName.\r | |
519 | @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r | |
520 | @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r | |
521 | EFI_HANDLE.\r | |
522 | @retval EFI_INVALID_PARAMETER Language is NULL.\r | |
523 | @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r | |
524 | @retval EFI_UNSUPPORTED The driver specified by This is not currently\r | |
525 | managing the controller specified by\r | |
526 | ControllerHandle and ChildHandle.\r | |
527 | @retval EFI_UNSUPPORTED The driver specified by This does not support the\r | |
528 | language specified by Language.\r | |
529 | **/\r | |
530 | EFI_STATUS\r | |
531 | EFIAPI\r | |
532 | SataControllerComponentNameGetControllerName (\r | |
533 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r | |
534 | IN EFI_HANDLE ControllerHandle,\r | |
535 | IN EFI_HANDLE ChildHandle OPTIONAL,\r | |
536 | IN CHAR8 *Language,\r | |
537 | OUT CHAR16 **ControllerName\r | |
538 | )\r | |
539 | ;\r | |
540 | \r | |
541 | #endif\r |