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