2 Header file for Sata Controller driver.
4 Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
9 #ifndef _SATA_CONTROLLER_H_
10 #define _SATA_CONTROLLER_H_
13 #include <Protocol/ComponentName.h>
14 #include <Protocol/DriverBinding.h>
15 #include <Protocol/PciIo.h>
16 #include <Protocol/IdeControllerInit.h>
17 #include <Library/UefiDriverEntryPoint.h>
18 #include <Library/DebugLib.h>
19 #include <Library/UefiLib.h>
20 #include <Library/BaseLib.h>
21 #include <Library/BaseMemoryLib.h>
22 #include <Library/MemoryAllocationLib.h>
23 #include <Library/UefiBootServicesTableLib.h>
24 #include <IndustryStandard/Pci.h>
27 // Global Variables definitions
29 extern EFI_DRIVER_BINDING_PROTOCOL gSataControllerDriverBinding
;
30 extern EFI_COMPONENT_NAME_PROTOCOL gSataControllerComponentName
;
31 extern EFI_COMPONENT_NAME2_PROTOCOL gSataControllerComponentName2
;
33 #define AHCI_BAR_INDEX 0x05
34 #define R_AHCI_CAP 0x0
35 #define B_AHCI_CAP_NPS (BIT4 | BIT3 | BIT2 | BIT1 | BIT0) // Number of Ports
36 #define B_AHCI_CAP_SPM BIT17 // Supports Port Multiplier
39 /// AHCI each channel can have up to 1 device
41 #define AHCI_MAX_DEVICES 0x01
44 /// AHCI each channel can have 15 devices in the presence of a multiplier
46 #define AHCI_MULTI_MAX_DEVICES 0x0F
49 /// IDE supports 2 channel max
51 #define IDE_MAX_CHANNEL 0x02
54 /// IDE supports 2 devices max
56 #define IDE_MAX_DEVICES 0x02
58 #define SATA_ENUMER_ALL FALSE
61 // Sata Controller driver private data structure
64 #define SATA_CONTROLLER_SIGNATURE SIGNATURE_32('S','A','T','A')
66 typedef struct _EFI_SATA_CONTROLLER_PRIVATE_DATA
{
68 // Standard signature used to identify Sata Controller private data
73 // Protocol instance of IDE_CONTROLLER_INIT produced by this driver
75 EFI_IDE_CONTROLLER_INIT_PROTOCOL IdeInit
;
78 // Copy of protocol pointers used by this driver
80 EFI_PCI_IO_PROTOCOL
*PciIo
;
83 // Original PCI attributes
85 UINT64 OriginalPciAttributes
;
88 // The number of devices that are supported by this channel
93 // The highest disqulified mode for each attached device,
94 // From ATA/ATAPI spec, if a mode is not supported,
95 // the modes higher than it is also not supported
97 EFI_ATA_COLLECTIVE_MODE
*DisqualifiedModes
;
100 // A copy of EFI_IDENTIFY_DATA data for each attached SATA device and its flag
102 EFI_IDENTIFY_DATA
*IdentifyData
;
103 BOOLEAN
*IdentifyValid
;
104 } EFI_SATA_CONTROLLER_PRIVATE_DATA
;
106 #define SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS(a) CR(a, EFI_SATA_CONTROLLER_PRIVATE_DATA, IdeInit, SATA_CONTROLLER_SIGNATURE)
109 // Driver binding functions declaration
112 Supported function of Driver Binding protocol for this driver.
113 Test to see if this driver supports ControllerHandle.
115 @param This Protocol instance pointer.
116 @param Controller Handle of device to test.
117 @param RemainingDevicePath A pointer to the device path. Should be ignored by
120 @retval EFI_SUCCESS This driver supports this device.
121 @retval EFI_ALREADY_STARTED This driver is already running on this device.
122 @retval other This driver does not support this device.
127 SataControllerSupported (
128 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
129 IN EFI_HANDLE Controller
,
130 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
135 This routine is called right after the .Supported() called and
136 Start this driver on ControllerHandle.
138 @param This Protocol instance pointer.
139 @param Controller Handle of device to bind driver to.
140 @param RemainingDevicePath A pointer to the device path. Should be ignored by
143 @retval EFI_SUCCESS This driver is added to this device.
144 @retval EFI_ALREADY_STARTED This driver is already running on this device.
145 @retval other Some error occurs when binding this driver to this device.
150 SataControllerStart (
151 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
152 IN EFI_HANDLE Controller
,
153 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
158 Stop this driver on ControllerHandle.
160 @param This Protocol instance pointer.
161 @param Controller Handle of device to stop driver on.
162 @param NumberOfChildren Not used.
163 @param ChildHandleBuffer Not used.
165 @retval EFI_SUCCESS This driver is removed from this device.
166 @retval other Some error occurs when removing this driver from this device.
172 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
173 IN EFI_HANDLE Controller
,
174 IN UINTN NumberOfChildren
,
175 IN EFI_HANDLE
*ChildHandleBuffer
180 // IDE controller init functions declaration
183 Returns the information about the specified IDE channel.
185 This function can be used to obtain information about a particular IDE channel.
186 The driver entity uses this information during the enumeration process.
188 If Enabled is set to FALSE, the driver entity will not scan the channel. Note
189 that it will not prevent an operating system driver from scanning the channel.
191 For most of today's controllers, MaxDevices will either be 1 or 2. For SATA
192 controllers, this value will always be 1. SATA configurations can contain SATA
193 port multipliers. SATA port multipliers behave like SATA bridges and can support
194 up to 16 devices on the other side. If a SATA port out of the IDE controller
195 is connected to a port multiplier, MaxDevices will be set to the number of SATA
196 devices that the port multiplier supports. Because today's port multipliers
197 support up to fifteen SATA devices, this number can be as large as fifteen. The IDE
198 bus driver is required to scan for the presence of port multipliers behind an SATA
199 controller and enumerate up to MaxDevices number of devices behind the port
202 In this context, the devices behind a port multiplier constitute a channel.
204 @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
205 @param[in] Channel Zero-based channel number.
206 @param[out] Enabled TRUE if this channel is enabled. Disabled channels
207 are not scanned to see if any devices are present.
208 @param[out] MaxDevices The maximum number of IDE devices that the bus driver
209 can expect on this channel. For the ATA/ATAPI
210 specification, version 6, this number will either be
211 one or two. For Serial ATA (SATA) configurations with a
212 port multiplier, this number can be as large as fifteen.
214 @retval EFI_SUCCESS Information was returned without any errors.
215 @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).
220 IdeInitGetChannelInfo (
221 IN EFI_IDE_CONTROLLER_INIT_PROTOCOL
*This
,
223 OUT BOOLEAN
*Enabled
,
224 OUT UINT8
*MaxDevices
229 The notifications from the driver entity that it is about to enter a certain
230 phase of the IDE channel enumeration process.
232 This function can be used to notify the IDE controller driver to perform
233 specific actions, including any chipset-specific initialization, so that the
234 chipset is ready to enter the next phase. Seven notification points are defined
237 More synchronization points may be added as required in the future.
239 @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
240 @param[in] Phase The phase during enumeration.
241 @param[in] Channel Zero-based channel number.
243 @retval EFI_SUCCESS The notification was accepted without any errors.
244 @retval EFI_UNSUPPORTED Phase is not supported.
245 @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).
246 @retval EFI_NOT_READY This phase cannot be entered at this time; for
247 example, an attempt was made to enter a Phase
248 without having entered one or more previous
255 IN EFI_IDE_CONTROLLER_INIT_PROTOCOL
*This
,
256 IN EFI_IDE_CONTROLLER_ENUM_PHASE Phase
,
262 Submits the device information to the IDE controller driver.
264 This function is used by the driver entity to pass detailed information about
265 a particular device to the IDE controller driver. The driver entity obtains
266 this information by issuing an ATA or ATAPI IDENTIFY_DEVICE command. IdentifyData
267 is the pointer to the response data buffer. The IdentifyData buffer is owned
268 by the driver entity, and the IDE controller driver must make a local copy
269 of the entire buffer or parts of the buffer as needed. The original IdentifyData
270 buffer pointer may not be valid when
272 - EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() or
273 - EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode() is called at a later point.
275 The IDE controller driver may consult various fields of EFI_IDENTIFY_DATA to
276 compute the optimum mode for the device. These fields are not limited to the
277 timing information. For example, an implementation of the IDE controller driver
278 may examine the vendor and type/mode field to match known bad drives.
280 The driver entity may submit drive information in any order, as long as it
281 submits information for all the devices belonging to the enumeration group
282 before EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() is called for any device
283 in that enumeration group. If a device is absent, EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData()
284 should be called with IdentifyData set to NULL. The IDE controller driver may
285 not have any other mechanism to know whether a device is present or not. Therefore,
286 setting IdentifyData to NULL does not constitute an error condition.
287 EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() can be called only once for a
288 given (Channel, Device) pair.
290 @param[in] This A pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
291 @param[in] Channel Zero-based channel number.
292 @param[in] Device Zero-based device number on the Channel.
293 @param[in] IdentifyData The device's response to the ATA IDENTIFY_DEVICE command.
295 @retval EFI_SUCCESS The information was accepted without any errors.
296 @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).
297 @retval EFI_INVALID_PARAMETER Device is invalid.
303 IN EFI_IDE_CONTROLLER_INIT_PROTOCOL
*This
,
306 IN EFI_IDENTIFY_DATA
*IdentifyData
311 Disqualifies specific modes for an IDE device.
313 This function allows the driver entity or other drivers (such as platform
314 drivers) to reject certain timing modes and request the IDE controller driver
315 to recalculate modes. This function allows the driver entity and the IDE
316 controller driver to negotiate the timings on a per-device basis. This function
317 is useful in the case of drives that lie about their capabilities. An example
318 is when the IDE device fails to accept the timing modes that are calculated
319 by the IDE controller driver based on the response to the Identify Drive command.
321 If the driver entity does not want to limit the ATA timing modes and leave that
322 decision to the IDE controller driver, it can either not call this function for
323 the given device or call this function and set the Valid flag to FALSE for all
324 modes that are listed in EFI_ATA_COLLECTIVE_MODE.
326 The driver entity may disqualify modes for a device in any order and any number
329 This function can be called multiple times to invalidate multiple modes of the
330 same type (e.g., Programmed Input/Output [PIO] modes 3 and 4). See the ATA/ATAPI
331 specification for more information on PIO modes.
333 For Serial ATA (SATA) controllers, this member function can be used to disqualify
334 a higher transfer rate mode on a given channel. For example, a platform driver
335 may inform the IDE controller driver to not use second-generation (Gen2) speeds
336 for a certain SATA drive.
338 @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
339 @param[in] Channel The zero-based channel number.
340 @param[in] Device The zero-based device number on the Channel.
341 @param[in] BadModes The modes that the device does not support and that
342 should be disqualified.
344 @retval EFI_SUCCESS The modes were accepted without any errors.
345 @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).
346 @retval EFI_INVALID_PARAMETER Device is invalid.
347 @retval EFI_INVALID_PARAMETER IdentifyData is NULL.
352 IdeInitDisqualifyMode (
353 IN EFI_IDE_CONTROLLER_INIT_PROTOCOL
*This
,
356 IN EFI_ATA_COLLECTIVE_MODE
*BadModes
361 Returns the information about the optimum modes for the specified IDE device.
363 This function is used by the driver entity to obtain the optimum ATA modes for
364 a specific device. The IDE controller driver takes into account the following
365 while calculating the mode:
366 - The IdentifyData inputs to EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData()
367 - The BadModes inputs to EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode()
369 The driver entity is required to call EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData()
370 for all the devices that belong to an enumeration group before calling
371 EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() for any device in the same group.
373 The IDE controller driver will use controller- and possibly platform-specific
374 algorithms to arrive at SupportedModes. The IDE controller may base its
375 decision on user preferences and other considerations as well. This function
376 may be called multiple times because the driver entity may renegotiate the mode
377 with the IDE controller driver using EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode().
379 The driver entity may collect timing information for various devices in any
380 order. The driver entity is responsible for making sure that all the dependencies
381 are satisfied. For example, the SupportedModes information for device A that
382 was previously returned may become stale after a call to
383 EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode() for device B.
385 The buffer SupportedModes is allocated by the callee because the caller does
386 not necessarily know the size of the buffer. The type EFI_ATA_COLLECTIVE_MODE
387 is defined in a way that allows for future extensibility and can be of variable
388 length. This memory pool should be deallocated by the caller when it is no
391 The IDE controller driver for a Serial ATA (SATA) controller can use this
392 member function to force a lower speed (first-generation [Gen1] speeds on a
393 second-generation [Gen2]-capable hardware). The IDE controller driver can
394 also allow the driver entity to stay with the speed that has been negotiated
395 by the physical layer.
397 @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
398 @param[in] Channel A zero-based channel number.
399 @param[in] Device A zero-based device number on the Channel.
400 @param[out] SupportedModes The optimum modes for the device.
402 @retval EFI_SUCCESS SupportedModes was returned.
403 @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).
404 @retval EFI_INVALID_PARAMETER Device is invalid.
405 @retval EFI_INVALID_PARAMETER SupportedModes is NULL.
406 @retval EFI_NOT_READY Modes cannot be calculated due to a lack of
407 data. This error may happen if
408 EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData()
409 and EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyData()
410 were not called for at least one drive in the
411 same enumeration group.
416 IdeInitCalculateMode (
417 IN EFI_IDE_CONTROLLER_INIT_PROTOCOL
*This
,
420 OUT EFI_ATA_COLLECTIVE_MODE
**SupportedModes
425 Commands the IDE controller driver to program the IDE controller hardware
426 so that the specified device can operate at the specified mode.
428 This function is used by the driver entity to instruct the IDE controller
429 driver to program the IDE controller hardware to the specified modes. This
430 function can be called only once for a particular device. For a Serial ATA
431 (SATA) Advanced Host Controller Interface (AHCI) controller, no controller-
432 specific programming may be required.
434 @param[in] This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
435 @param[in] Channel Zero-based channel number.
436 @param[in] Device Zero-based device number on the Channel.
437 @param[in] Modes The modes to set.
439 @retval EFI_SUCCESS The command was accepted without any errors.
440 @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).
441 @retval EFI_INVALID_PARAMETER Device is invalid.
442 @retval EFI_NOT_READY Modes cannot be set at this time due to lack of data.
443 @retval EFI_DEVICE_ERROR Modes cannot be set due to hardware failure.
444 The driver entity should not use this device.
450 IN EFI_IDE_CONTROLLER_INIT_PROTOCOL
*This
,
453 IN EFI_ATA_COLLECTIVE_MODE
*Modes
458 // Forward reference declaration
461 Retrieves a Unicode string that is the user readable name of the UEFI Driver.
463 @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
464 @param Language A pointer to a three character ISO 639-2 language identifier.
465 This is the language of the driver name that that the caller
466 is requesting, and it must match one of the languages specified
467 in SupportedLanguages. The number of languages supported by a
468 driver is up to the driver writer.
469 @param DriverName A pointer to the Unicode string to return. This Unicode string
470 is the name of the driver specified by This in the language
471 specified by Language.
473 @retval EFI_SUCCESS The Unicode string for the Driver specified by This
474 and the language specified by Language was returned
476 @retval EFI_INVALID_PARAMETER Language is NULL.
477 @retval EFI_INVALID_PARAMETER DriverName is NULL.
478 @retval EFI_UNSUPPORTED The driver specified by This does not support the
479 language specified by Language.
483 SataControllerComponentNameGetDriverName (
484 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
486 OUT CHAR16
**DriverName
491 Retrieves a Unicode string that is the user readable name of the controller
492 that is being managed by an UEFI Driver.
494 @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
495 @param ControllerHandle The handle of a controller that the driver specified by
496 This is managing. This handle specifies the controller
497 whose name is to be returned.
498 @param OPTIONAL ChildHandle The handle of the child controller to retrieve the name
499 of. This is an optional parameter that may be NULL. It
500 will be NULL for device drivers. It will also be NULL
501 for a bus drivers that wish to retrieve the name of the
502 bus controller. It will not be NULL for a bus driver
503 that wishes to retrieve the name of a child controller.
504 @param Language A pointer to a three character ISO 639-2 language
505 identifier. This is the language of the controller name
506 that that the caller is requesting, and it must match one
507 of the languages specified in SupportedLanguages. The
508 number of languages supported by a driver is up to the
510 @param ControllerName A pointer to the Unicode string to return. This Unicode
511 string is the name of the controller specified by
512 ControllerHandle and ChildHandle in the language
513 specified by Language from the point of view of the
514 driver specified by This.
516 @retval EFI_SUCCESS The Unicode string for the user readable name in the
517 language specified by Language for the driver
518 specified by This was returned in DriverName.
519 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
520 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
522 @retval EFI_INVALID_PARAMETER Language is NULL.
523 @retval EFI_INVALID_PARAMETER ControllerName is NULL.
524 @retval EFI_UNSUPPORTED The driver specified by This is not currently
525 managing the controller specified by
526 ControllerHandle and ChildHandle.
527 @retval EFI_UNSUPPORTED The driver specified by This does not support the
528 language specified by Language.
532 SataControllerComponentNameGetControllerName (
533 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
534 IN EFI_HANDLE ControllerHandle
,
535 IN EFI_HANDLE ChildHandle OPTIONAL
,
537 OUT CHAR16
**ControllerName