+++ /dev/null
-/** @file\r
- Header file for Sata Controller driver.\r
-\r
- Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>\r
- 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
-**/\r
-\r
-#ifndef _SATA_CONTROLLER_H_\r
-#define _SATA_CONTROLLER_H_\r
-\r
-#include <Uefi.h>\r
-#include <Protocol/ComponentName.h>\r
-#include <Protocol/DriverBinding.h>\r
-#include <Protocol/PciIo.h>\r
-#include <Protocol/IdeControllerInit.h>\r
-#include <Library/UefiDriverEntryPoint.h>\r
-#include <Library/DebugLib.h>\r
-#include <Library/UefiLib.h>\r
-#include <Library/BaseLib.h>\r
-#include <Library/BaseMemoryLib.h>\r
-#include <Library/MemoryAllocationLib.h>\r
-#include <Library/UefiBootServicesTableLib.h>\r
-#include <IndustryStandard/Pci.h>\r
-\r
-//\r
-// Global Variables definitions\r
-//\r
-extern EFI_DRIVER_BINDING_PROTOCOL gSataControllerDriverBinding;\r
-extern EFI_COMPONENT_NAME_PROTOCOL gSataControllerComponentName;\r
-extern EFI_COMPONENT_NAME2_PROTOCOL gSataControllerComponentName2;\r
-\r
-#define AHCI_BAR_INDEX 0x05\r
-#define R_AHCI_CAP 0x0\r
-#define B_AHCI_CAP_NPS (BIT4 | BIT3 | BIT2 | BIT1 | BIT0) // Number of Ports\r
-#define B_AHCI_CAP_SPM BIT17 // Supports Port Multiplier\r
-\r
-///\r
-/// AHCI each channel can have up to 1 device\r
-///\r
-#define AHCI_MAX_DEVICES 0x01\r
-\r
-///\r
-/// AHCI each channel can have 15 devices in the presence of a multiplier\r
-///\r
-#define AHCI_MULTI_MAX_DEVICES 0x0F\r
-\r
-///\r
-/// IDE supports 2 channel max\r
-///\r
-#define IDE_MAX_CHANNEL 0x02\r
-\r
-///\r
-/// IDE supports 2 devices max\r
-///\r
-#define IDE_MAX_DEVICES 0x02\r
-\r
-#define SATA_ENUMER_ALL FALSE\r
-\r
-//\r
-// Sata Controller driver private data structure\r
-//\r
-\r
-#define SATA_CONTROLLER_SIGNATURE SIGNATURE_32('S','A','T','A')\r
-\r
-typedef struct _EFI_SATA_CONTROLLER_PRIVATE_DATA {\r
- //\r
- // Standard signature used to identify Sata Controller private data\r
- //\r
- UINT32 Signature;\r
-\r
- //\r
- // Protocol instance of IDE_CONTROLLER_INIT produced by this driver\r
- //\r
- EFI_IDE_CONTROLLER_INIT_PROTOCOL IdeInit;\r
-\r
- //\r
- // Copy of protocol pointers used by this driver\r
- //\r
- EFI_PCI_IO_PROTOCOL *PciIo;\r
-\r
- //\r
- // The number of devices that are supported by this channel\r
- //\r
- UINT8 DeviceCount;\r
-\r
- //\r
- // The highest disqulified mode for each attached device,\r
- // From ATA/ATAPI spec, if a mode is not supported,\r
- // the modes higher than it is also not supported\r
- //\r
- EFI_ATA_COLLECTIVE_MODE *DisqualifiedModes;\r
-\r
- //\r
- // A copy of EFI_IDENTIFY_DATA data for each attached SATA device and its flag\r
- //\r
- EFI_IDENTIFY_DATA *IdentifyData;\r
- BOOLEAN *IdentifyValid;\r
-} EFI_SATA_CONTROLLER_PRIVATE_DATA;\r
-\r
-#define SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS(a) CR(a, EFI_SATA_CONTROLLER_PRIVATE_DATA, IdeInit, SATA_CONTROLLER_SIGNATURE)\r
-\r
-//\r
-// Driver binding functions declaration\r
-//\r
-/**\r
- Supported function of Driver Binding protocol for this driver.\r
- Test to see if this driver supports ControllerHandle.\r
-\r
- @param This Protocol instance pointer.\r
- @param Controller Handle of device to test.\r
- @param RemainingDevicePath A pointer to the device path. Should be ignored by\r
- device driver.\r
-\r
- @retval EFI_SUCCESS This driver supports this device.\r
- @retval EFI_ALREADY_STARTED This driver is already running on this device.\r
- @retval other This driver does not support this device.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-SataControllerSupported (\r
- IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
- IN EFI_HANDLE Controller,\r
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
- )\r
-;\r
-\r
-/**\r
- This routine is called right after the .Supported() called and \r
- Start this driver on ControllerHandle.\r
-\r
- @param This Protocol instance pointer.\r
- @param Controller Handle of device to bind driver to.\r
- @param RemainingDevicePath A pointer to the device path. Should be ignored by\r
- device driver.\r
-\r
- @retval EFI_SUCCESS This driver is added to this device.\r
- @retval EFI_ALREADY_STARTED This driver is already running on this device.\r
- @retval other Some error occurs when binding this driver to this device.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-SataControllerStart (\r
- IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
- IN EFI_HANDLE Controller,\r
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
- )\r
-;\r
-\r
-/**\r
- Stop this driver on ControllerHandle.\r
-\r
- @param This Protocol instance pointer.\r
- @param Controller Handle of device to stop driver on.\r
- @param NumberOfChildren Not used.\r
- @param ChildHandleBuffer Not used.\r
-\r
- @retval EFI_SUCCESS This driver is removed from this device.\r
- @retval other Some error occurs when removing this driver from this device.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-SataControllerStop (\r
- IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
- IN EFI_HANDLE Controller,\r
- IN UINTN NumberOfChildren,\r
- IN EFI_HANDLE *ChildHandleBuffer\r
- )\r
-;\r
-\r
-//\r
-// IDE controller init functions declaration\r
-//\r
-/**\r
- Returns the information about the specified IDE channel.\r
- \r
- This function can be used to obtain information about a particular IDE channel.\r
- The driver entity uses this information during the enumeration process. \r
- \r
- If Enabled is set to FALSE, the driver entity will not scan the channel. Note \r
- that it will not prevent an operating system driver from scanning the channel.\r
- \r
- For most of today's controllers, MaxDevices will either be 1 or 2. For SATA \r
- controllers, this value will always be 1. SATA configurations can contain SATA \r
- port multipliers. SATA port multipliers behave like SATA bridges and can support\r
- up to 16 devices on the other side. If a SATA port out of the IDE controller \r
- is connected to a port multiplier, MaxDevices will be set to the number of SATA \r
- devices that the port multiplier supports. Because today's port multipliers \r
- support up to fifteen SATA devices, this number can be as large as fifteen. The IDE \r
- bus driver is required to scan for the presence of port multipliers behind an SATA \r
- controller and enumerate up to MaxDevices number of devices behind the port \r
- multiplier. \r
- \r
- In this context, the devices behind a port multiplier constitute a channel. \r
- \r
- @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
- @param[in] Channel Zero-based channel number.\r
- @param[out] Enabled TRUE if this channel is enabled. Disabled channels \r
- are not scanned to see if any devices are present.\r
- @param[out] MaxDevices The maximum number of IDE devices that the bus driver\r
- can expect on this channel. For the ATA/ATAPI \r
- specification, version 6, this number will either be \r
- one or two. For Serial ATA (SATA) configurations with a \r
- port multiplier, this number can be as large as fifteen.\r
-\r
- @retval EFI_SUCCESS Information was returned without any errors.\r
- @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-IdeInitGetChannelInfo (\r
- IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,\r
- IN UINT8 Channel,\r
- OUT BOOLEAN *Enabled,\r
- OUT UINT8 *MaxDevices\r
- )\r
-;\r
-\r
-/**\r
- The notifications from the driver entity that it is about to enter a certain\r
- phase of the IDE channel enumeration process.\r
- \r
- This function can be used to notify the IDE controller driver to perform \r
- specific actions, including any chipset-specific initialization, so that the \r
- chipset is ready to enter the next phase. Seven notification points are defined \r
- at this time. \r
- \r
- More synchronization points may be added as required in the future. \r
-\r
- @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
- @param[in] Phase The phase during enumeration.\r
- @param[in] Channel Zero-based channel number.\r
-\r
- @retval EFI_SUCCESS The notification was accepted without any errors.\r
- @retval EFI_UNSUPPORTED Phase is not supported.\r
- @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r
- @retval EFI_NOT_READY This phase cannot be entered at this time; for \r
- example, an attempt was made to enter a Phase \r
- without having entered one or more previous \r
- Phase.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-IdeInitNotifyPhase (\r
- IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,\r
- IN EFI_IDE_CONTROLLER_ENUM_PHASE Phase,\r
- IN UINT8 Channel\r
- )\r
-;\r
-\r
-/**\r
- Submits the device information to the IDE controller driver.\r
-\r
- This function is used by the driver entity to pass detailed information about \r
- a particular device to the IDE controller driver. The driver entity obtains \r
- this information by issuing an ATA or ATAPI IDENTIFY_DEVICE command. IdentifyData\r
- is the pointer to the response data buffer. The IdentifyData buffer is owned \r
- by the driver entity, and the IDE controller driver must make a local copy \r
- of the entire buffer or parts of the buffer as needed. The original IdentifyData \r
- buffer pointer may not be valid when\r
- \r
- - EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() or\r
- - EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode() is called at a later point.\r
- \r
- The IDE controller driver may consult various fields of EFI_IDENTIFY_DATA to \r
- compute the optimum mode for the device. These fields are not limited to the \r
- timing information. For example, an implementation of the IDE controller driver \r
- may examine the vendor and type/mode field to match known bad drives. \r
- \r
- The driver entity may submit drive information in any order, as long as it \r
- submits information for all the devices belonging to the enumeration group \r
- before EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() is called for any device\r
- in that enumeration group. If a device is absent, EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData()\r
- should be called with IdentifyData set to NULL. The IDE controller driver may \r
- not have any other mechanism to know whether a device is present or not. Therefore, \r
- setting IdentifyData to NULL does not constitute an error condition. \r
- EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() can be called only once for a \r
- given (Channel, Device) pair. \r
- \r
- @param[in] This A pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
- @param[in] Channel Zero-based channel number.\r
- @param[in] Device Zero-based device number on the Channel.\r
- @param[in] IdentifyData The device's response to the ATA IDENTIFY_DEVICE command.\r
-\r
- @retval EFI_SUCCESS The information was accepted without any errors.\r
- @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r
- @retval EFI_INVALID_PARAMETER Device is invalid.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-IdeInitSubmitData (\r
- IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,\r
- IN UINT8 Channel,\r
- IN UINT8 Device,\r
- IN EFI_IDENTIFY_DATA *IdentifyData\r
- )\r
-;\r
-\r
-/**\r
- Disqualifies specific modes for an IDE device.\r
-\r
- This function allows the driver entity or other drivers (such as platform \r
- drivers) to reject certain timing modes and request the IDE controller driver\r
- to recalculate modes. This function allows the driver entity and the IDE \r
- controller driver to negotiate the timings on a per-device basis. This function \r
- is useful in the case of drives that lie about their capabilities. An example \r
- is when the IDE device fails to accept the timing modes that are calculated \r
- by the IDE controller driver based on the response to the Identify Drive command.\r
-\r
- If the driver entity does not want to limit the ATA timing modes and leave that \r
- decision to the IDE controller driver, it can either not call this function for \r
- the given device or call this function and set the Valid flag to FALSE for all \r
- modes that are listed in EFI_ATA_COLLECTIVE_MODE.\r
- \r
- The driver entity may disqualify modes for a device in any order and any number \r
- of times.\r
- \r
- This function can be called multiple times to invalidate multiple modes of the \r
- same type (e.g., Programmed Input/Output [PIO] modes 3 and 4). See the ATA/ATAPI \r
- specification for more information on PIO modes. \r
- \r
- For Serial ATA (SATA) controllers, this member function can be used to disqualify\r
- a higher transfer rate mode on a given channel. For example, a platform driver\r
- may inform the IDE controller driver to not use second-generation (Gen2) speeds \r
- for a certain SATA drive.\r
- \r
- @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
- @param[in] Channel The zero-based channel number.\r
- @param[in] Device The zero-based device number on the Channel.\r
- @param[in] BadModes The modes that the device does not support and that\r
- should be disqualified.\r
-\r
- @retval EFI_SUCCESS The modes were accepted without any errors.\r
- @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r
- @retval EFI_INVALID_PARAMETER Device is invalid.\r
- @retval EFI_INVALID_PARAMETER IdentifyData is NULL.\r
- \r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-IdeInitDisqualifyMode (\r
- IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,\r
- IN UINT8 Channel,\r
- IN UINT8 Device,\r
- IN EFI_ATA_COLLECTIVE_MODE *BadModes\r
- )\r
-;\r
-\r
-/**\r
- Returns the information about the optimum modes for the specified IDE device.\r
-\r
- This function is used by the driver entity to obtain the optimum ATA modes for\r
- a specific device. The IDE controller driver takes into account the following \r
- while calculating the mode:\r
- - The IdentifyData inputs to EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData()\r
- - The BadModes inputs to EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode()\r
-\r
- The driver entity is required to call EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() \r
- for all the devices that belong to an enumeration group before calling \r
- EFI_IDE_CONTROLLER_INIT_PROTOCOL.CalculateMode() for any device in the same group. \r
- \r
- The IDE controller driver will use controller- and possibly platform-specific \r
- algorithms to arrive at SupportedModes. The IDE controller may base its \r
- decision on user preferences and other considerations as well. This function \r
- may be called multiple times because the driver entity may renegotiate the mode \r
- with the IDE controller driver using EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode().\r
- \r
- The driver entity may collect timing information for various devices in any \r
- order. The driver entity is responsible for making sure that all the dependencies\r
- are satisfied. For example, the SupportedModes information for device A that \r
- was previously returned may become stale after a call to \r
- EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode() for device B.\r
- \r
- The buffer SupportedModes is allocated by the callee because the caller does \r
- not necessarily know the size of the buffer. The type EFI_ATA_COLLECTIVE_MODE \r
- is defined in a way that allows for future extensibility and can be of variable \r
- length. This memory pool should be deallocated by the caller when it is no \r
- longer necessary. \r
- \r
- The IDE controller driver for a Serial ATA (SATA) controller can use this \r
- member function to force a lower speed (first-generation [Gen1] speeds on a \r
- second-generation [Gen2]-capable hardware). The IDE controller driver can \r
- also allow the driver entity to stay with the speed that has been negotiated \r
- by the physical layer.\r
- \r
- @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
- @param[in] Channel A zero-based channel number.\r
- @param[in] Device A zero-based device number on the Channel.\r
- @param[out] SupportedModes The optimum modes for the device.\r
-\r
- @retval EFI_SUCCESS SupportedModes was returned.\r
- @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r
- @retval EFI_INVALID_PARAMETER Device is invalid. \r
- @retval EFI_INVALID_PARAMETER SupportedModes is NULL.\r
- @retval EFI_NOT_READY Modes cannot be calculated due to a lack of \r
- data. This error may happen if \r
- EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() \r
- and EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyData() \r
- were not called for at least one drive in the \r
- same enumeration group.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-IdeInitCalculateMode (\r
- IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,\r
- IN UINT8 Channel,\r
- IN UINT8 Device,\r
- OUT EFI_ATA_COLLECTIVE_MODE **SupportedModes\r
- )\r
-;\r
-\r
-/**\r
- Commands the IDE controller driver to program the IDE controller hardware\r
- so that the specified device can operate at the specified mode.\r
-\r
- This function is used by the driver entity to instruct the IDE controller \r
- driver to program the IDE controller hardware to the specified modes. This \r
- function can be called only once for a particular device. For a Serial ATA \r
- (SATA) Advanced Host Controller Interface (AHCI) controller, no controller-\r
- specific programming may be required.\r
-\r
- @param[in] This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
- @param[in] Channel Zero-based channel number.\r
- @param[in] Device Zero-based device number on the Channel.\r
- @param[in] Modes The modes to set.\r
-\r
- @retval EFI_SUCCESS The command was accepted without any errors.\r
- @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r
- @retval EFI_INVALID_PARAMETER Device is invalid.\r
- @retval EFI_NOT_READY Modes cannot be set at this time due to lack of data.\r
- @retval EFI_DEVICE_ERROR Modes cannot be set due to hardware failure.\r
- The driver entity should not use this device.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-IdeInitSetTiming (\r
- IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,\r
- IN UINT8 Channel,\r
- IN UINT8 Device,\r
- IN EFI_ATA_COLLECTIVE_MODE *Modes\r
- )\r
-;\r
-\r
-//\r
-// Forward reference declaration\r
-//\r
-/**\r
- Retrieves a Unicode string that is the user readable name of the UEFI Driver.\r
-\r
- @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
- @param Language A pointer to a three character ISO 639-2 language identifier.\r
- This is the language of the driver name that that the caller\r
- is requesting, and it must match one of the languages specified\r
- in SupportedLanguages. The number of languages supported by a\r
- driver is up to the driver writer.\r
- @param DriverName A pointer to the Unicode string to return. This Unicode string\r
- is the name of the driver specified by This in the language\r
- specified by Language.\r
-\r
- @retval EFI_SUCCESS The Unicode string for the Driver specified by This\r
- and the language specified by Language was returned\r
- in DriverName.\r
- @retval EFI_INVALID_PARAMETER Language is NULL.\r
- @retval EFI_INVALID_PARAMETER DriverName is NULL.\r
- @retval EFI_UNSUPPORTED The driver specified by This does not support the\r
- language specified by Language.\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-SataControllerComponentNameGetDriverName (\r
- IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
- IN CHAR8 *Language,\r
- OUT CHAR16 **DriverName\r
- )\r
-;\r
-\r
-/**\r
- Retrieves a Unicode string that is the user readable name of the controller\r
- that is being managed by an UEFI Driver.\r
-\r
- @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
- @param ControllerHandle The handle of a controller that the driver specified by\r
- This is managing. This handle specifies the controller\r
- whose name is to be returned.\r
- @param OPTIONAL ChildHandle The handle of the child controller to retrieve the name\r
- of. This is an optional parameter that may be NULL. It\r
- will be NULL for device drivers. It will also be NULL\r
- for a bus drivers that wish to retrieve the name of the\r
- bus controller. It will not be NULL for a bus driver\r
- that wishes to retrieve the name of a child controller.\r
- @param Language A pointer to a three character ISO 639-2 language\r
- identifier. This is the language of the controller name\r
- that that the caller is requesting, and it must match one\r
- of the languages specified in SupportedLanguages. The\r
- number of languages supported by a driver is up to the\r
- driver writer.\r
- @param ControllerName A pointer to the Unicode string to return. This Unicode\r
- string is the name of the controller specified by\r
- ControllerHandle and ChildHandle in the language\r
- specified by Language from the point of view of the\r
- driver specified by This.\r
-\r
- @retval EFI_SUCCESS The Unicode string for the user readable name in the\r
- language specified by Language for the driver\r
- specified by This was returned in DriverName.\r
- @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
- @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
- EFI_HANDLE.\r
- @retval EFI_INVALID_PARAMETER Language is NULL.\r
- @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
- @retval EFI_UNSUPPORTED The driver specified by This is not currently\r
- managing the controller specified by\r
- ControllerHandle and ChildHandle.\r
- @retval EFI_UNSUPPORTED The driver specified by This does not support the\r
- language specified by Language.\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-SataControllerComponentNameGetControllerName (\r
- IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
- IN EFI_HANDLE ControllerHandle,\r
- IN EFI_HANDLE ChildHandle OPTIONAL,\r
- IN CHAR8 *Language,\r
- OUT CHAR16 **ControllerName\r
- )\r
-;\r
-\r
-#endif\r
projects / mirror_edk2.git / blobdiff