--- /dev/null
+/** @file\r
+ UEFI Component Name(2) protocol implementation 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
+#include "SataController.h"\r
+\r
+//\r
+/// EFI Component Name Protocol\r
+///\r
+GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gSataControllerComponentName = {\r
+ SataControllerComponentNameGetDriverName,\r
+ SataControllerComponentNameGetControllerName,\r
+ "eng"\r
+};\r
+\r
+//\r
+/// EFI Component Name 2 Protocol\r
+///\r
+GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gSataControllerComponentName2 = {\r
+ (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) SataControllerComponentNameGetDriverName,\r
+ (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) SataControllerComponentNameGetControllerName,\r
+ "en"\r
+};\r
+\r
+//\r
+/// Driver Name Strings\r
+///\r
+GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mSataControllerDriverNameTable[] = {\r
+ {\r
+ "eng;en",\r
+ (CHAR16 *)L"Sata Controller Init Driver"\r
+ },\r
+ {\r
+ NULL,\r
+ NULL\r
+ }\r
+};\r
+\r
+///\r
+/// Controller Name Strings\r
+///\r
+GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mSataControllerControllerNameTable[] = {\r
+ {\r
+ "eng;en",\r
+ (CHAR16 *)L"Sata Controller"\r
+ },\r
+ {\r
+ NULL,\r
+ NULL\r
+ }\r
+};\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
+ return LookupUnicodeString2 (\r
+ Language,\r
+ This->SupportedLanguages,\r
+ mSataControllerDriverNameTable,\r
+ DriverName,\r
+ (BOOLEAN)(This == &gSataControllerComponentName)\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 ChildHandle OPTIONAL 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
+ EFI_STATUS Status;\r
+\r
+ //\r
+ // Make sure this driver is currently managing ControllHandle\r
+ //\r
+ Status = EfiTestManagedDevice (\r
+ ControllerHandle,\r
+ gSataControllerDriverBinding.DriverBindingHandle,\r
+ &gEfiPciIoProtocolGuid\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ if (ChildHandle != NULL) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+\r
+ return LookupUnicodeString2 (\r
+ Language,\r
+ This->SupportedLanguages,\r
+ mSataControllerControllerNameTable,\r
+ ControllerName,\r
+ (BOOLEAN)(This == &gSataControllerComponentName)\r
+ );\r
+}\r
--- /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->DisqulifiedModes = AllocateZeroPool ((sizeof (EFI_ATA_COLLECTIVE_MODE)) * ChannelDeviceCount);\r
+ if (SataPrivateData->DisqulifiedModes == 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->DisqulifiedModes != NULL) {\r
+ FreePool (SataPrivateData->DisqulifiedModes);\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->DisqulifiedModes != NULL) {\r
+ FreePool (SataPrivateData->DisqulifiedModes);\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
+// Interface functions of IDE_CONTROLLER_INIT protocol\r
+//\r
+/**\r
+ This function can be used to obtain information about a specified channel.\r
+ It's usually used by IDE Bus driver during enumeration process.\r
+\r
+ @param This the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ @param Channel Channel number. Parallel ATA (PATA) controllers can support up to two channels.\r
+ Advanced Host Controller Interface (AHCI) Serial ATA (SATA) controllers\r
+ can support up to 32 channels, each of which can have up to 1 device.\r
+ In the presence of a multiplier, each channel can have 15 devices.\r
+ @param Enabled TRUE if the channel is enabled. If the channel is disabled,\r
+ then it will no be enumerated.\r
+ @param MaxDevices For Parallel ATA (PATA) controllers, this number will either be 1 or 2.\r
+ For Serial ATA (SATA) controllers, it always be 1,\r
+ but with a port multiplier, this number can be as large as 15.\r
+\r
+ @retval EFI_SUCCESS Success to get channel information.\r
+ @retval EFI_INVALID_PARAMETER Invalid channel id.\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
+ This function is called by IdeBus driver before executing certain actions.\r
+ This allows IDE Controller Init to prepare for each action.\r
+\r
+ @param This The EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ @param Phase Phase indicator defined by IDE_CONTROLLER_INIT protocol.\r
+ @param Channel Channel number.\r
+\r
+ @retval EFI_SUCCESS Success operation.\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
+ This function is called by IdeBus driver to submit EFI_IDENTIFY_DATA data structure\r
+ obtained from IDE deivce. This structure is used to set IDE timing.\r
+\r
+ @param This The EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ @param Channel Channel number.\r
+ @param Device Device number.\r
+ @param IdentifyData A pointer to EFI_IDENTIFY_DATA data structure.\r
+\r
+ @retval EFI_SUCCESS The information is accepted without any errors.\r
+ @retval EFI_INVALID_PARAMETER Invalid channel id or device id.\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
+ 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
+ //\r
+ // Make a local copy of device's IdentifyData and mark the valid flag\r
+ //\r
+ if (IdentifyData != NULL) {\r
+ CopyMem (\r
+ &(SataPrivateData->IdentifyData[Channel * Device]),\r
+ IdentifyData,\r
+ sizeof (EFI_IDENTIFY_DATA)\r
+ );\r
+\r
+ SataPrivateData->IdentifyValid[Channel * Device] = TRUE;\r
+ } else {\r
+ SataPrivateData->IdentifyValid[Channel * Device] = FALSE;\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ This function is called by IdeBus driver to disqualify unsupported operation\r
+ mode on specfic IDE device.\r
+\r
+ @param This The EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ @param Channel Channel number.\r
+ @param Device Device number.\r
+ @param 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 Invalid channel id or device id.\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
+ 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
+ //\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->DisqulifiedModes[Channel * Device]),\r
+ BadModes,\r
+ sizeof (EFI_ATA_COLLECTIVE_MODE)\r
+ );\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ This function is called by IdeBus driver to calculate the best operation mode\r
+ supported by specific IDE device.\r
+\r
+ @param This The EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ @param Channel Channel number.\r
+ @param Device Device number.\r
+ @param SupportedModes The optimum modes for the device.\r
+\r
+ @retval EFI_SUCCESS Supported modes are returned.\r
+ @retval EFI_INVALID_PARAMETER Invalid channel id or device id.\r
+ @retval EFI_OUT_OF_RESOURCES Fail to allocate pool.\r
+ @retval EFI_NOT_READY Identify data of the device is not ready.\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 *DisqulifiedModes;\r
+ UINT16 SelectedMode;\r
+ EFI_STATUS Status;\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
+ return EFI_OUT_OF_RESOURCES;\r
+ }\r
+\r
+ IdentifyData = &(SataPrivateData->IdentifyData[Channel * Device]);\r
+ IdentifyValid = SataPrivateData->IdentifyValid[Channel * Device];\r
+ DisqulifiedModes = &(SataPrivateData->DisqulifiedModes[Channel * Device]);\r
+\r
+ //\r
+ // Make sure we've got the valid identify data of the device from SubmitData()\r
+ //\r
+ if (!IdentifyValid) {\r
+ return EFI_NOT_READY;\r
+ }\r
+\r
+ Status = CalculateBestPioMode (\r
+ IdentifyData,\r
+ (DisqulifiedModes->PioMode.Valid ? ((UINT16 *) &(DisqulifiedModes->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
+ (DisqulifiedModes->UdmaMode.Valid ? ((UINT16 *) &(DisqulifiedModes->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
+ This function is called by IdeBus driver to set appropriate timing on IDE\r
+ controller according supported operation mode.\r
+\r
+ @param This The EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ @param Channel Channel number.\r
+ @param Device Device number.\r
+ @param Modes The modes to set.\r
+\r
+ @retval EFI_SUCCESS Sucess operation.\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
--- /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 *DisqulifiedModes;\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
+ This function can be used to obtain information about a specified channel.\r
+ It's usually used by IDE Bus driver during enumeration process.\r
+\r
+ @param This the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ @param Channel Channel number. Parallel ATA (PATA) controllers can support up to two channels.\r
+ Advanced Host Controller Interface (AHCI) Serial ATA (SATA) controllers\r
+ can support up to 32 channels, each of which can have up to one device.\r
+ In the presence of a multiplier, each channel can have 15 devices.\r
+ @param Enabled TRUE if the channel is enabled. If the channel is disabled,\r
+ then it will no be enumerated.\r
+ @param MaxDevices For Parallel ATA (PATA) controllers, this number will either be 1 or 2.\r
+ For Serial ATA (SATA) controllers with a port multiplier, this number can be as large as 15.\r
+\r
+ @retval EFI_SUCCESS Success to get channel information.\r
+ @retval EFI_INVALID_PARAMETER Invalid channel id.\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
+ This function is called by IdeBus driver before executing certain actions.\r
+ This allows IDE Controller Init to prepare for each action.\r
+\r
+ @param This The EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ @param Phase Phase indicator defined by IDE_CONTROLLER_INIT protocol.\r
+ @param Channel Channel number.\r
+\r
+ @retval EFI_SUCCESS Success operation.\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
+ This function is called by IdeBus driver to submit EFI_IDENTIFY_DATA data structure\r
+ obtained from IDE deivce. This structure is used to set IDE timing.\r
+\r
+ @param This The EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ @param Channel Channel number.\r
+ @param Device Device number.\r
+ @param IdentifyData A pointer to EFI_IDENTIFY_DATA data structure.\r
+\r
+ @retval EFI_SUCCESS The information was accepted without any errors.\r
+ @retval EFI_INVALID_PARAMETER Invalid channel id or device id.\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
+ This function is called by IdeBus driver to disqualify unsupported operation\r
+ mode on specfic IDE device.\r
+\r
+ @param This The EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ @param Channel Channel number.\r
+ @param Device Device number.\r
+ @param 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 Invalid channel id or device id.\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
+ This function is called by IdeBus driver to calculate the best operation mode\r
+ supported by specific IDE device.\r
+\r
+ @param This The EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ @param Channel Channel number.\r
+ @param Device Device number.\r
+ @param SupportedModes The optimum modes for the device.\r
+\r
+ @retval EFI_SUCCESS SupportedModes was returned.\r
+ @retval EFI_OUT_OF_RESOURCES Fail to allocate pool.\r
+ @retval EFI_INVALID_PARAMETER Invalid channel id or device id.\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
+ This function is called by IdeBus driver to set appropriate timing on IDE\r
+ controller according supported operation mode.\r
+\r
+ @param This The EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ @param Channel Channel number.\r
+ @param Device Device number.\r
+ @param Modes The modes to set.\r
+\r
+ @retval EFI_SUCCESS Sucess operation.\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 / commitdiff