+++ /dev/null
-/** @file\r
- This driver module produces IDE_CONTROLLER_INIT protocol for Sata Controllers.\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
-#include "SataController.h"\r
-\r
-///\r
-/// EFI_DRIVER_BINDING_PROTOCOL instance\r
-///\r
-EFI_DRIVER_BINDING_PROTOCOL gSataControllerDriverBinding = {\r
- SataControllerSupported,\r
- SataControllerStart,\r
- SataControllerStop,\r
- 0xa,\r
- NULL,\r
- NULL\r
-};\r
-\r
-/**\r
- Read AHCI Operation register.\r
-\r
- @param PciIo The PCI IO protocol instance.\r
- @param Offset The operation register offset.\r
-\r
- @return The register content read.\r
-\r
-**/\r
-UINT32\r
-EFIAPI\r
-AhciReadReg (\r
- IN EFI_PCI_IO_PROTOCOL *PciIo,\r
- IN UINT32 Offset\r
- )\r
-{\r
- UINT32 Data;\r
-\r
- ASSERT (PciIo != NULL);\r
- \r
- Data = 0;\r
-\r
- PciIo->Mem.Read (\r
- PciIo,\r
- EfiPciIoWidthUint32,\r
- AHCI_BAR_INDEX,\r
- (UINT64) Offset,\r
- 1,\r
- &Data\r
- );\r
-\r
- return Data;\r
-}\r
-\r
-/**\r
- Write AHCI Operation register.\r
-\r
- @param PciIo The PCI IO protocol instance.\r
- @param Offset The operation register offset.\r
- @param Data The data used to write down.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-AhciWriteReg (\r
- IN EFI_PCI_IO_PROTOCOL *PciIo,\r
- IN UINT32 Offset,\r
- IN UINT32 Data\r
- )\r
-{\r
- ASSERT (PciIo != NULL);\r
-\r
- PciIo->Mem.Write (\r
- PciIo,\r
- EfiPciIoWidthUint32,\r
- AHCI_BAR_INDEX,\r
- (UINT64) Offset,\r
- 1,\r
- &Data\r
- );\r
-\r
- return;\r
-}\r
-\r
-/**\r
- This function is used to calculate the best PIO mode supported by specific IDE device\r
-\r
- @param IdentifyData The identify data of specific IDE device.\r
- @param DisPioMode Disqualified PIO modes collection.\r
- @param SelectedMode Available PIO modes collection.\r
-\r
- @retval EFI_SUCCESS Best PIO modes are returned.\r
- @retval EFI_UNSUPPORTED The device doesn't support PIO mode,\r
- or all supported modes have been disqualified.\r
-**/\r
-EFI_STATUS\r
-CalculateBestPioMode (\r
- IN EFI_IDENTIFY_DATA *IdentifyData,\r
- IN UINT16 *DisPioMode OPTIONAL,\r
- OUT UINT16 *SelectedMode\r
- )\r
-{\r
- UINT16 PioMode;\r
- UINT16 AdvancedPioMode;\r
- UINT16 Temp;\r
- UINT16 Index;\r
- UINT16 MinimumPioCycleTime;\r
-\r
- Temp = 0xff;\r
-\r
- PioMode = (UINT8) (((ATA5_IDENTIFY_DATA *) (&(IdentifyData->AtaData)))->pio_cycle_timing >> 8);\r
-\r
- //\r
- // See whether Identify Data word 64 - 70 are valid\r
- //\r
- if ((IdentifyData->AtaData.field_validity & 0x02) == 0x02) {\r
-\r
- AdvancedPioMode = IdentifyData->AtaData.advanced_pio_modes;\r
- DEBUG ((EFI_D_INFO, "CalculateBestPioMode: AdvancedPioMode = %x\n", AdvancedPioMode));\r
-\r
- for (Index = 0; Index < 8; Index++) {\r
- if ((AdvancedPioMode & 0x01) != 0) {\r
- Temp = Index;\r
- }\r
-\r
- AdvancedPioMode >>= 1;\r
- }\r
-\r
- //\r
- // If Temp is modified, mean the advanced_pio_modes is not zero;\r
- // if Temp is not modified, mean there is no advanced PIO mode supported,\r
- // the best PIO Mode is the value in pio_cycle_timing.\r
- //\r
- if (Temp != 0xff) {\r
- AdvancedPioMode = (UINT16) (Temp + 3);\r
- } else {\r
- AdvancedPioMode = PioMode;\r
- }\r
-\r
- //\r
- // Limit the PIO mode to at most PIO4.\r
- //\r
- PioMode = (UINT16) MIN (AdvancedPioMode, 4);\r
-\r
- MinimumPioCycleTime = IdentifyData->AtaData.min_pio_cycle_time_with_flow_control;\r
-\r
- if (MinimumPioCycleTime <= 120) {\r
- PioMode = (UINT16) MIN (4, PioMode);\r
- } else if (MinimumPioCycleTime <= 180) {\r
- PioMode = (UINT16) MIN (3, PioMode);\r
- } else if (MinimumPioCycleTime <= 240) {\r
- PioMode = (UINT16) MIN (2, PioMode);\r
- } else {\r
- PioMode = 0;\r
- }\r
-\r
- //\r
- // Degrade the PIO mode if the mode has been disqualified\r
- //\r
- if (DisPioMode != NULL) {\r
- if (*DisPioMode < 2) {\r
- return EFI_UNSUPPORTED; // no mode below ATA_PIO_MODE_BELOW_2\r
- }\r
-\r
- if (PioMode >= *DisPioMode) {\r
- PioMode = (UINT16) (*DisPioMode - 1);\r
- }\r
- }\r
-\r
- if (PioMode < 2) {\r
- *SelectedMode = 1; // ATA_PIO_MODE_BELOW_2;\r
- } else {\r
- *SelectedMode = PioMode; // ATA_PIO_MODE_2 to ATA_PIO_MODE_4;\r
- }\r
-\r
- } else {\r
- //\r
- // Identify Data word 64 - 70 are not valid\r
- // Degrade the PIO mode if the mode has been disqualified\r
- //\r
- if (DisPioMode != NULL) {\r
- if (*DisPioMode < 2) {\r
- return EFI_UNSUPPORTED; // no mode below ATA_PIO_MODE_BELOW_2\r
- }\r
-\r
- if (PioMode == *DisPioMode) {\r
- PioMode--;\r
- }\r
- }\r
-\r
- if (PioMode < 2) {\r
- *SelectedMode = 1; // ATA_PIO_MODE_BELOW_2;\r
- } else {\r
- *SelectedMode = 2; // ATA_PIO_MODE_2;\r
- }\r
-\r
- }\r
-\r
- return EFI_SUCCESS;\r
-}\r
-\r
-/**\r
- This function is used to calculate the best UDMA mode supported by specific IDE device\r
-\r
- @param IdentifyData The identify data of specific IDE device.\r
- @param DisUDmaMode Disqualified UDMA modes collection.\r
- @param SelectedMode Available UDMA modes collection.\r
-\r
- @retval EFI_SUCCESS Best UDMA modes are returned.\r
- @retval EFI_UNSUPPORTED The device doesn't support UDMA mode,\r
- or all supported modes have been disqualified.\r
-**/\r
-EFI_STATUS\r
-CalculateBestUdmaMode (\r
- IN EFI_IDENTIFY_DATA *IdentifyData,\r
- IN UINT16 *DisUDmaMode OPTIONAL,\r
- OUT UINT16 *SelectedMode\r
- )\r
-{\r
- UINT16 TempMode;\r
- UINT16 DeviceUDmaMode;\r
-\r
- DeviceUDmaMode = 0;\r
-\r
- //\r
- // Check whether the WORD 88 (supported UltraDMA by drive) is valid\r
- //\r
- if ((IdentifyData->AtaData.field_validity & 0x04) == 0x00) {\r
- return EFI_UNSUPPORTED;\r
- }\r
-\r
- DeviceUDmaMode = IdentifyData->AtaData.ultra_dma_mode;\r
- DEBUG ((EFI_D_INFO, "CalculateBestUdmaMode: DeviceUDmaMode = %x\n", DeviceUDmaMode));\r
- DeviceUDmaMode &= 0x3f;\r
- TempMode = 0; // initialize it to UDMA-0\r
-\r
- while ((DeviceUDmaMode >>= 1) != 0) {\r
- TempMode++;\r
- }\r
-\r
- //\r
- // Degrade the UDMA mode if the mode has been disqualified\r
- //\r
- if (DisUDmaMode != NULL) {\r
- if (*DisUDmaMode == 0) {\r
- *SelectedMode = 0;\r
- return EFI_UNSUPPORTED; // no mode below ATA_UDMA_MODE_0\r
- }\r
-\r
- if (TempMode >= *DisUDmaMode) {\r
- TempMode = (UINT16) (*DisUDmaMode - 1);\r
- }\r
- }\r
-\r
- //\r
- // Possible returned mode is between ATA_UDMA_MODE_0 and ATA_UDMA_MODE_5\r
- //\r
- *SelectedMode = TempMode;\r
-\r
- return EFI_SUCCESS;\r
-}\r
-\r
-/**\r
- The Entry Point of module. It follows the standard UEFI driver model.\r
-\r
- @param[in] ImageHandle The firmware allocated handle for the EFI image. \r
- @param[in] SystemTable A pointer to the EFI System Table.\r
- \r
- @retval EFI_SUCCESS The entry point is executed successfully.\r
- @retval other Some error occurs when executing this entry point.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-InitializeSataControllerDriver (\r
- IN EFI_HANDLE ImageHandle,\r
- IN EFI_SYSTEM_TABLE *SystemTable\r
- )\r
-{\r
- EFI_STATUS Status;\r
-\r
- //\r
- // Install driver model protocol(s).\r
- //\r
- Status = EfiLibInstallDriverBindingComponentName2 (\r
- ImageHandle,\r
- SystemTable,\r
- &gSataControllerDriverBinding,\r
- ImageHandle,\r
- &gSataControllerComponentName,\r
- &gSataControllerComponentName2\r
- );\r
- ASSERT_EFI_ERROR (Status);\r
-\r
- return Status;\r
-}\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.\r
- it should be ignored by 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
- EFI_STATUS Status;\r
- EFI_PCI_IO_PROTOCOL *PciIo;\r
- PCI_TYPE00 PciData;\r
-\r
- //\r
- // Attempt to open PCI I/O Protocol\r
- //\r
- Status = gBS->OpenProtocol (\r
- Controller,\r
- &gEfiPciIoProtocolGuid,\r
- (VOID **) &PciIo,\r
- This->DriverBindingHandle,\r
- Controller,\r
- EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
- );\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- //\r
- // Now further check the PCI header: Base Class (offset 0x0B) and\r
- // Sub Class (offset 0x0A). This controller should be an SATA controller\r
- //\r
- Status = PciIo->Pci.Read (\r
- PciIo,\r
- EfiPciIoWidthUint8,\r
- PCI_CLASSCODE_OFFSET,\r
- sizeof (PciData.Hdr.ClassCode),\r
- PciData.Hdr.ClassCode\r
- );\r
- if (EFI_ERROR (Status)) {\r
- return EFI_UNSUPPORTED;\r
- }\r
-\r
- if (IS_PCI_IDE (&PciData) || IS_PCI_SATADPA (&PciData)) {\r
- return EFI_SUCCESS;\r
- }\r
-\r
- return EFI_UNSUPPORTED;\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.\r
- it should be ignored by 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
- EFI_STATUS Status;\r
- EFI_PCI_IO_PROTOCOL *PciIo;\r
- PCI_TYPE00 PciData;\r
- EFI_SATA_CONTROLLER_PRIVATE_DATA *SataPrivateData;\r
- UINT32 Data32;\r
- UINTN ChannelDeviceCount;\r
-\r
- DEBUG ((EFI_D_INFO, "SataControllerStart START\n"));\r
-\r
- SataPrivateData = NULL;\r
-\r
- //\r
- // Now test and open PCI I/O Protocol\r
- //\r
- Status = gBS->OpenProtocol (\r
- Controller,\r
- &gEfiPciIoProtocolGuid,\r
- (VOID **) &PciIo,\r
- This->DriverBindingHandle,\r
- Controller,\r
- EFI_OPEN_PROTOCOL_BY_DRIVER\r
- );\r
- if (EFI_ERROR (Status)) {\r
- DEBUG ((EFI_D_ERROR, "SataControllerStart error return status = %r\n", Status));\r
- return Status;\r
- }\r
-\r
- //\r
- // Allocate Sata Private Data structure\r
- //\r
- SataPrivateData = AllocateZeroPool (sizeof (EFI_SATA_CONTROLLER_PRIVATE_DATA));\r
- if (SataPrivateData == NULL) {\r
- Status = EFI_OUT_OF_RESOURCES;\r
- goto Done;\r
- }\r
-\r
- //\r
- // Initialize Sata Private Data\r
- //\r
- SataPrivateData->Signature = SATA_CONTROLLER_SIGNATURE;\r
- SataPrivateData->PciIo = PciIo;\r
- SataPrivateData->IdeInit.GetChannelInfo = IdeInitGetChannelInfo;\r
- SataPrivateData->IdeInit.NotifyPhase = IdeInitNotifyPhase;\r
- SataPrivateData->IdeInit.SubmitData = IdeInitSubmitData;\r
- SataPrivateData->IdeInit.DisqualifyMode = IdeInitDisqualifyMode;\r
- SataPrivateData->IdeInit.CalculateMode = IdeInitCalculateMode;\r
- SataPrivateData->IdeInit.SetTiming = IdeInitSetTiming;\r
- SataPrivateData->IdeInit.EnumAll = SATA_ENUMER_ALL;\r
-\r
- Status = PciIo->Pci.Read (\r
- PciIo,\r
- EfiPciIoWidthUint8,\r
- PCI_CLASSCODE_OFFSET,\r
- sizeof (PciData.Hdr.ClassCode),\r
- PciData.Hdr.ClassCode\r
- );\r
- ASSERT_EFI_ERROR (Status);\r
-\r
- if (IS_PCI_IDE (&PciData)) {\r
- SataPrivateData->IdeInit.ChannelCount = IDE_MAX_CHANNEL;\r
- SataPrivateData->DeviceCount = IDE_MAX_DEVICES;\r
- } else if (IS_PCI_SATADPA (&PciData)) {\r
- //\r
- // Read Host Capability Register(CAP) to get Number of Ports(NPS) and Supports Port Multiplier(SPM)\r
- // NPS is 0's based value indicating the maximum number of ports supported by the HBA silicon.\r
- // A maximum of 32 ports can be supported. A value of '0h', indicating one port, is the minimum requirement.\r
- //\r
- Data32 = AhciReadReg (PciIo, R_AHCI_CAP);\r
- SataPrivateData->IdeInit.ChannelCount = (UINT8) ((Data32 & B_AHCI_CAP_NPS) + 1);\r
- SataPrivateData->DeviceCount = AHCI_MAX_DEVICES;\r
- if ((Data32 & B_AHCI_CAP_SPM) == B_AHCI_CAP_SPM) {\r
- SataPrivateData->DeviceCount = AHCI_MULTI_MAX_DEVICES;\r
- }\r
- }\r
-\r
- ChannelDeviceCount = (UINTN) (SataPrivateData->IdeInit.ChannelCount) * (UINTN) (SataPrivateData->DeviceCount);\r
- SataPrivateData->DisqualifiedModes = AllocateZeroPool ((sizeof (EFI_ATA_COLLECTIVE_MODE)) * ChannelDeviceCount);\r
- if (SataPrivateData->DisqualifiedModes == NULL) {\r
- Status = EFI_OUT_OF_RESOURCES;\r
- goto Done;\r
- }\r
-\r
- SataPrivateData->IdentifyData = AllocateZeroPool ((sizeof (EFI_IDENTIFY_DATA)) * ChannelDeviceCount);\r
- if (SataPrivateData->IdentifyData == NULL) {\r
- Status = EFI_OUT_OF_RESOURCES;\r
- goto Done;\r
- }\r
-\r
- SataPrivateData->IdentifyValid = AllocateZeroPool ((sizeof (BOOLEAN)) * ChannelDeviceCount);\r
- if (SataPrivateData->IdentifyValid == NULL) {\r
- Status = EFI_OUT_OF_RESOURCES;\r
- goto Done;\r
- }\r
-\r
- //\r
- // Install IDE Controller Init Protocol to this instance\r
- //\r
- Status = gBS->InstallMultipleProtocolInterfaces (\r
- &Controller,\r
- &gEfiIdeControllerInitProtocolGuid,\r
- &(SataPrivateData->IdeInit),\r
- NULL\r
- );\r
-\r
-Done:\r
- if (EFI_ERROR (Status)) {\r
-\r
- gBS->CloseProtocol (\r
- Controller,\r
- &gEfiPciIoProtocolGuid,\r
- This->DriverBindingHandle,\r
- Controller\r
- );\r
- if (SataPrivateData != NULL) {\r
- if (SataPrivateData->DisqualifiedModes != NULL) {\r
- FreePool (SataPrivateData->DisqualifiedModes);\r
- }\r
- if (SataPrivateData->IdentifyData != NULL) {\r
- FreePool (SataPrivateData->IdentifyData);\r
- }\r
- if (SataPrivateData->IdentifyValid != NULL) {\r
- FreePool (SataPrivateData->IdentifyValid);\r
- }\r
- FreePool (SataPrivateData);\r
- }\r
- }\r
-\r
- DEBUG ((EFI_D_INFO, "SataControllerStart END status = %r\n", Status));\r
-\r
- return Status;\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
- EFI_STATUS Status;\r
- EFI_IDE_CONTROLLER_INIT_PROTOCOL *IdeInit;\r
- EFI_SATA_CONTROLLER_PRIVATE_DATA *SataPrivateData;\r
-\r
- //\r
- // Open the produced protocol\r
- //\r
- Status = gBS->OpenProtocol (\r
- Controller,\r
- &gEfiIdeControllerInitProtocolGuid,\r
- (VOID **) &IdeInit,\r
- This->DriverBindingHandle,\r
- Controller,\r
- EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
- );\r
- if (EFI_ERROR (Status)) {\r
- return EFI_UNSUPPORTED;\r
- }\r
-\r
- SataPrivateData = SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS (IdeInit);\r
- ASSERT (SataPrivateData != NULL);\r
-\r
- //\r
- // Uninstall the IDE Controller Init Protocol from this instance\r
- //\r
- Status = gBS->UninstallMultipleProtocolInterfaces (\r
- Controller,\r
- &gEfiIdeControllerInitProtocolGuid,\r
- &(SataPrivateData->IdeInit),\r
- NULL\r
- );\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- if (SataPrivateData != NULL) {\r
- if (SataPrivateData->DisqualifiedModes != NULL) {\r
- FreePool (SataPrivateData->DisqualifiedModes);\r
- }\r
- if (SataPrivateData->IdentifyData != NULL) {\r
- FreePool (SataPrivateData->IdentifyData);\r
- }\r
- if (SataPrivateData->IdentifyValid != NULL) {\r
- FreePool (SataPrivateData->IdentifyValid);\r
- }\r
- FreePool (SataPrivateData);\r
- }\r
-\r
- //\r
- // Close protocols opened by Sata Controller driver\r
- //\r
- return gBS->CloseProtocol (\r
- Controller,\r
- &gEfiPciIoProtocolGuid,\r
- This->DriverBindingHandle,\r
- Controller\r
- );\r
-}\r
-\r
-/**\r
- Calculate the flat array subscript of a (Channel, Device) pair.\r
-\r
- @param[in] SataPrivateData The private data structure corresponding to the\r
- SATA controller that attaches the device for\r
- which the flat array subscript is being\r
- calculated.\r
-\r
- @param[in] Channel The channel (ie. port) number on the SATA\r
- controller that the device is attached to.\r
-\r
- @param[in] Device The device number on the channel.\r
-\r
- @return The flat array subscript suitable for indexing DisqualifiedModes,\r
- IdentifyData, and IdentifyValid.\r
-**/\r
-STATIC\r
-UINTN\r
-FlatDeviceIndex (\r
- IN CONST EFI_SATA_CONTROLLER_PRIVATE_DATA *SataPrivateData,\r
- IN UINTN Channel,\r
- IN UINTN Device\r
- )\r
-{\r
- ASSERT (SataPrivateData != NULL);\r
- ASSERT (Channel < SataPrivateData->IdeInit.ChannelCount);\r
- ASSERT (Device < SataPrivateData->DeviceCount);\r
-\r
- return Channel * SataPrivateData->DeviceCount + Device;\r
-}\r
-\r
-//\r
-// Interface functions of IDE_CONTROLLER_INIT protocol\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
- EFI_SATA_CONTROLLER_PRIVATE_DATA *SataPrivateData;\r
- SataPrivateData = SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS (This);\r
- ASSERT (SataPrivateData != NULL);\r
-\r
- if (Channel < This->ChannelCount) {\r
- *Enabled = TRUE;\r
- *MaxDevices = SataPrivateData->DeviceCount;\r
- return EFI_SUCCESS;\r
- }\r
-\r
- *Enabled = FALSE;\r
- return EFI_INVALID_PARAMETER;\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
- return EFI_SUCCESS;\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
- EFI_SATA_CONTROLLER_PRIVATE_DATA *SataPrivateData;\r
- UINTN DeviceIndex;\r
-\r
- SataPrivateData = SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS (This);\r
- ASSERT (SataPrivateData != NULL);\r
-\r
- if ((Channel >= This->ChannelCount) || (Device >= SataPrivateData->DeviceCount)) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- DeviceIndex = FlatDeviceIndex (SataPrivateData, Channel, Device);\r
-\r
- //\r
- // Make a local copy of device's IdentifyData and mark the valid flag\r
- //\r
- if (IdentifyData != NULL) {\r
- CopyMem (\r
- &(SataPrivateData->IdentifyData[DeviceIndex]),\r
- IdentifyData,\r
- sizeof (EFI_IDENTIFY_DATA)\r
- );\r
-\r
- SataPrivateData->IdentifyValid[DeviceIndex] = TRUE;\r
- } else {\r
- SataPrivateData->IdentifyValid[DeviceIndex] = FALSE;\r
- }\r
-\r
- return EFI_SUCCESS;\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
- EFI_SATA_CONTROLLER_PRIVATE_DATA *SataPrivateData;\r
- UINTN DeviceIndex;\r
-\r
- SataPrivateData = SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS (This);\r
- ASSERT (SataPrivateData != NULL);\r
-\r
- if ((Channel >= This->ChannelCount) || (BadModes == NULL) || (Device >= SataPrivateData->DeviceCount)) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- DeviceIndex = FlatDeviceIndex (SataPrivateData, Channel, Device);\r
-\r
- //\r
- // Record the disqualified modes per channel per device. From ATA/ATAPI spec,\r
- // if a mode is not supported, the modes higher than it is also not supported.\r
- //\r
- CopyMem (\r
- &(SataPrivateData->DisqualifiedModes[DeviceIndex]),\r
- BadModes,\r
- sizeof (EFI_ATA_COLLECTIVE_MODE)\r
- );\r
-\r
- return EFI_SUCCESS;\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
- EFI_SATA_CONTROLLER_PRIVATE_DATA *SataPrivateData;\r
- EFI_IDENTIFY_DATA *IdentifyData;\r
- BOOLEAN IdentifyValid;\r
- EFI_ATA_COLLECTIVE_MODE *DisqualifiedModes;\r
- UINT16 SelectedMode;\r
- EFI_STATUS Status;\r
- UINTN DeviceIndex;\r
-\r
- SataPrivateData = SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS (This);\r
- ASSERT (SataPrivateData != NULL);\r
-\r
- if ((Channel >= This->ChannelCount) || (SupportedModes == NULL) || (Device >= SataPrivateData->DeviceCount)) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- *SupportedModes = AllocateZeroPool (sizeof (EFI_ATA_COLLECTIVE_MODE));\r
- if (*SupportedModes == NULL) {\r
- ASSERT (*SupportedModes != NULL);\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
-\r
- DeviceIndex = FlatDeviceIndex (SataPrivateData, Channel, Device);\r
-\r
- IdentifyData = &(SataPrivateData->IdentifyData[DeviceIndex]);\r
- IdentifyValid = SataPrivateData->IdentifyValid[DeviceIndex];\r
- DisqualifiedModes = &(SataPrivateData->DisqualifiedModes[DeviceIndex]);\r
-\r
- //\r
- // Make sure we've got the valid identify data of the device from SubmitData()\r
- //\r
- if (!IdentifyValid) {\r
- FreePool (*SupportedModes);\r
- return EFI_NOT_READY;\r
- }\r
-\r
- Status = CalculateBestPioMode (\r
- IdentifyData,\r
- (DisqualifiedModes->PioMode.Valid ? ((UINT16 *) &(DisqualifiedModes->PioMode.Mode)) : NULL),\r
- &SelectedMode\r
- );\r
- if (!EFI_ERROR (Status)) {\r
- (*SupportedModes)->PioMode.Valid = TRUE;\r
- (*SupportedModes)->PioMode.Mode = SelectedMode;\r
-\r
- } else {\r
- (*SupportedModes)->PioMode.Valid = FALSE;\r
- }\r
- DEBUG ((EFI_D_INFO, "IdeInitCalculateMode: PioMode = %x\n", (*SupportedModes)->PioMode.Mode));\r
-\r
- Status = CalculateBestUdmaMode (\r
- IdentifyData,\r
- (DisqualifiedModes->UdmaMode.Valid ? ((UINT16 *) &(DisqualifiedModes->UdmaMode.Mode)) : NULL),\r
- &SelectedMode\r
- );\r
-\r
- if (!EFI_ERROR (Status)) {\r
- (*SupportedModes)->UdmaMode.Valid = TRUE;\r
- (*SupportedModes)->UdmaMode.Mode = SelectedMode;\r
-\r
- } else {\r
- (*SupportedModes)->UdmaMode.Valid = FALSE;\r
- }\r
- DEBUG ((EFI_D_INFO, "IdeInitCalculateMode: UdmaMode = %x\n", (*SupportedModes)->UdmaMode.Mode));\r
-\r
- //\r
- // The modes other than PIO and UDMA are not supported\r
- //\r
- return EFI_SUCCESS;\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
- return EFI_SUCCESS;\r
-}\r
projects / mirror_edk2.git / blobdiff