+/*++\r
+\r
+Copyright (c) 2006 - 2007 Intel Corporation. All rights reserved\r
+All rights reserved. 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
+Module Name:\r
+\r
+ IdeController.c\r
+\r
+Abstract:\r
+ \r
+ This driver module produces IDE_CONTROLLER_INIT protocol and will be used by \r
+ IDE Bus driver to support platform dependent timing information. This driver\r
+ is responsible for early initialization of IDE controller.\r
+\r
+Revision History\r
+--*/\r
+\r
+#include "IdeController.h"\r
+#include "IdeData.h"\r
+\r
+//\r
+// IDE Controller Init Guid\r
+//\r
+EFI_GUID\r
+ gIdeControllerDriverGuid = { 0x91e365e9, 0xe0c0, 0x4647, 0xb0, 0xeb, 0xf6, 0x78, 0xf6, 0x21, 0xf8, 0x8d };\r
+\r
+//\r
+// EFI_DRIVER_BINDING_PROTOCOL instance\r
+//\r
+EFI_DRIVER_BINDING_PROTOCOL gIdeControllerDriverBinding = {\r
+ IdeControllerSupported,\r
+ IdeControllerStart,\r
+ IdeControllerStop,\r
+ 0xa,\r
+ NULL,\r
+ NULL\r
+};\r
+\r
+//\r
+// Internal function definitions\r
+//\r
+EFI_STATUS\r
+EnableNativeIdeDecode (\r
+ IN EFI_PCI_IO_PROTOCOL *PciIo\r
+ );\r
+\r
+EFI_STATUS\r
+EnableLegacyIdeDecode (\r
+ EFI_EVENT Event,\r
+ VOID *Context\r
+ );\r
+\r
+EFI_STATUS\r
+IdeDetectCableType (\r
+ IN UINT8 Channel,\r
+ IN UINT8 Device,\r
+ IN EFI_PCI_IO_PROTOCOL *PciIo,\r
+ IN EFI_IDENTIFY_DATA *IdentifyData\r
+ );\r
+\r
+EFI_STATUS\r
+AdjustUdmaModeByCableType (\r
+ IN UINT8 Channel,\r
+ IN UINT8 Device,\r
+ IN EFI_PCI_IO_PROTOCOL *PciIo,\r
+ IN OUT EFI_ATA_COLLECTIVE_MODE *Modes\r
+ );\r
+\r
+EFI_STATUS\r
+CalculateBestPioMode (\r
+ IN EFI_IDENTIFY_DATA * IdentifyData,\r
+ IN UINT16 *DisPioMode OPTIONAL,\r
+ OUT UINT16 *SelectedMode\r
+ );\r
+\r
+EFI_STATUS\r
+CalculateBestUdmaMode (\r
+ IN EFI_IDENTIFY_DATA * IdentifyData,\r
+ IN UINT16 *DisUDmaMode OPTIONAL,\r
+ OUT UINT16 *SelectedMode\r
+ );\r
+\r
+EFI_STATUS\r
+IdeInitSetUdmaTiming (\r
+ IN UINT8 Channel,\r
+ IN UINT8 Device,\r
+ IN EFI_PCI_IO_PROTOCOL *PciIo,\r
+ IN EFI_ATA_COLLECTIVE_MODE *Modes\r
+ );\r
+\r
+EFI_STATUS\r
+IdeInitSetPioTiming (\r
+ IN UINT8 Channel,\r
+ IN UINT8 Device,\r
+ IN EFI_PCI_IO_PROTOCOL *PciIo,\r
+ IN EFI_IDENTIFY_DATA *IdentifyData,\r
+ IN EFI_ATA_COLLECTIVE_MODE *Modes\r
+ );\r
+\r
+//\r
+// *************************************\r
+// IdeController Driver Entry Point\r
+// *************************************\r
+//\r
+EFI_STATUS\r
+EFIAPI\r
+InitializeIdeControllerDriver (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ )\r
+/*++\r
+ Routine Description:\r
+ \r
+ Chipset Ide Driver EntryPoint function. It follows the standard EFI driver \r
+ model. It's called by StartImage() of DXE Core\r
+ \r
+ Argments:\r
+ \r
+ ImageHnadle -- While the driver image loaded be the ImageLoader(), \r
+ an image handle is assigned to this driver binary, \r
+ all activities of the driver is tied to this ImageHandle\r
+ *SystemTable -- A pointer to the system table, for all BS(Boo Services) and\r
+ RT(Runtime Services)\r
+\r
+ Retruns:\r
+ \r
+ Always call EfiLibInstallDriverBindingProtocol( ) and retrun the result\r
+\r
+--*/\r
+{\r
+\r
+ return EfiLibInstallDriverBindingComponentName2 (\r
+ ImageHandle,\r
+ SystemTable,\r
+ &gIdeControllerDriverBinding,\r
+ ImageHandle,\r
+ &gIdeControllerName,\r
+ &gIdeControllerName2\r
+ );\r
+}\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+IdeControllerSupported (\r
+ IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
+ IN EFI_HANDLE Controller,\r
+ IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
+ )\r
+/*++\r
+\r
+ Routine Description:\r
+ \r
+ Register Driver Binding protocol for this driver.\r
+ \r
+ Arguments:\r
+ \r
+ This -- a pointer points to the Binding Protocol instance\r
+ Controller -- The handle of controller to be tested. \r
+ *RemainingDevicePath -- A pointer to the device path. Ignored by device\r
+ driver but used by bus driver\r
+\r
+ Returns:\r
+\r
+ EFI_SUCCESS -- Driver loaded.\r
+ other -- Driver not loaded.\r
+--*/\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath;\r
+ EFI_PCI_IO_PROTOCOL *PciIo;\r
+ PCI_TYPE00 PciData;\r
+\r
+ //\r
+ // Ide Controller is a device driver, and should ingore the\r
+ // "RemainingDevicePath" according to EFI spec\r
+ //\r
+ Status = gBS->OpenProtocol (\r
+ Controller,\r
+ &gEfiDevicePathProtocolGuid,\r
+ (VOID *) &ParentDevicePath,\r
+ This->DriverBindingHandle,\r
+ Controller,\r
+ EFI_OPEN_PROTOCOL_BY_DRIVER\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ //\r
+ // EFI_ALREADY_STARTED is also an error\r
+ //\r
+ return Status;\r
+ }\r
+ //\r
+ // Close the protocol because we don't use it here\r
+ //\r
+ gBS->CloseProtocol (\r
+ Controller,\r
+ &gEfiDevicePathProtocolGuid,\r
+ This->DriverBindingHandle,\r
+ Controller\r
+ );\r
+\r
+ //\r
+ // Now test the EfiPciIoProtocol\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
+ return Status;\r
+ }\r
+ //\r
+ // Now further check the PCI header: Base class (offset 0x0B) and\r
+ // Sub Class (offset 0x0A). This controller should be an Ide controller\r
+ //\r
+ Status = PciIo->Pci.Read (\r
+ PciIo,\r
+ EfiPciIoWidthUint8,\r
+ 0,\r
+ sizeof (PciData),\r
+ &PciData\r
+ );\r
+\r
+ if (EFI_ERROR (Status)) {\r
+ gBS->CloseProtocol (\r
+ Controller,\r
+ &gEfiPciIoProtocolGuid,\r
+ This->DriverBindingHandle,\r
+ Controller\r
+ );\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+ //\r
+ // Examine Ide PCI Configuration table fields\r
+ //\r
+ if ((PciData.Hdr.ClassCode[2] != PCI_CLASS_MASS_STORAGE) ||\r
+ (PciData.Hdr.ClassCode[1] != PCI_SUB_CLASS_IDE)\r
+ ) {\r
+\r
+ Status = EFI_UNSUPPORTED;\r
+ }\r
+\r
+ gBS->CloseProtocol (\r
+ Controller,\r
+ &gEfiPciIoProtocolGuid,\r
+ This->DriverBindingHandle,\r
+ Controller\r
+ );\r
+\r
+ return Status;\r
+}\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+IdeControllerStart (\r
+ IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
+ IN EFI_HANDLE Controller,\r
+ IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
+ )\r
+/*++\r
+\r
+ Routine Description:\r
+ \r
+ This routine is called right after the .Supported() called and return \r
+ EFI_SUCCESS. Notes: The supported protocols are checked but the Protocols\r
+ are closed.\r
+\r
+ Arguments:\r
+ \r
+ This -- a pointer points to the Binding Protocol instance\r
+ Controller -- The handle of controller to be tested. Parameter\r
+ passed by the caller\r
+ *RemainingDevicePath -- A pointer to the device path. Should be ignored by\r
+ device driver\r
+--*/\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_PCI_IO_PROTOCOL *PciIo;\r
+ EFI_IDE_CONTROLLER_PRIVATE_DATA *IdePrivateData;\r
+\r
+ //\r
+ // Now test and open the EfiPciIoProtocol\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
+\r
+ //\r
+ // Status == 0 - A normal execution flow, SUCCESS and the program proceeds.\r
+ // Status == ALREADY_STARTED - A non-zero Status code returned. It indicates\r
+ // that the protocol has been opened and should be treated as a\r
+ // normal condition and the program proceeds. The Protocol will not\r
+ // opened 'again' by this call.\r
+ // Status != ALREADY_STARTED - Error status, terminate program execution\r
+ //\r
+ if (EFI_ERROR (Status)) {\r
+ //\r
+ // EFI_ALREADY_STARTED is also an error\r
+ //\r
+ return Status;\r
+ }\r
+ //\r
+ // Allocate Ide private data structure\r
+ //\r
+ Status = gBS->AllocatePool (\r
+ EfiBootServicesData,\r
+ sizeof (EFI_IDE_CONTROLLER_PRIVATE_DATA),\r
+ (VOID **) &IdePrivateData\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return EFI_OUT_OF_RESOURCES;\r
+ }\r
+ //\r
+ // Initialize Ide controller private data\r
+ //\r
+ ZeroMem (IdePrivateData, sizeof (EFI_IDE_CONTROLLER_PRIVATE_DATA));\r
+ IdePrivateData->Signature = IDE_CONTROLLER_SIGNATURE;\r
+ IdePrivateData->PciIo = PciIo;\r
+ IdePrivateData->IdeInit.GetChannelInfo = IdeInitGetChannelInfo;\r
+ IdePrivateData->IdeInit.NotifyPhase = IdeInitNotifyPhase;\r
+ IdePrivateData->IdeInit.SubmitData = IdeInitSubmitData;\r
+ IdePrivateData->IdeInit.DisqualifyMode = IdeInitDisqualifyMode;\r
+ IdePrivateData->IdeInit.CalculateMode = IdeInitCalculateMode;\r
+ IdePrivateData->IdeInit.SetTiming = IdeInitSetTiming;\r
+ IdePrivateData->IdeInit.EnumAll = ICH_IDE_ENUMER_ALL;\r
+ IdePrivateData->IdeInit.ChannelCount = ICH_IDE_MAX_CHANNEL;\r
+\r
+ //\r
+ // Install IDE_CONTROLLER_INIT protocol & private data to this instance\r
+ //\r
+ Status = gBS->InstallMultipleProtocolInterfaces (\r
+ &Controller,\r
+ &gIdeControllerDriverGuid,\r
+ IdePrivateData,\r
+ &gEfiIdeControllerInitProtocolGuid,\r
+ &(IdePrivateData->IdeInit),\r
+ NULL\r
+ );\r
+\r
+ return Status;\r
+}\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+IdeControllerStop (\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
+ Routine Description:\r
+ Stop this driver on Controller Handle. \r
+\r
+ Arguments:\r
+ This - Protocol instance pointer.\r
+ Controller - Handle of device to stop driver on \r
+ NumberOfChildren - Not used\r
+ ChildHandleBuffer - Not used\r
+\r
+ Returns:\r
+ EFI_SUCCESS - This driver is removed DeviceHandle\r
+ other - This driver was not removed from this device\r
+ \r
+--*/\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_IDE_CONTROLLER_PRIVATE_DATA *IdePrivateData;\r
+\r
+ //\r
+ // Get private data\r
+ //\r
+ Status = gBS->OpenProtocol (\r
+ Controller,\r
+ &gIdeControllerDriverGuid,\r
+ (VOID **) &IdePrivateData,\r
+ This->DriverBindingHandle,\r
+ Controller,\r
+ EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ //\r
+ // Close protocols opened by Ide controller driver\r
+ //\r
+ Status = gBS->CloseProtocol (\r
+ Controller,\r
+ &gEfiPciIoProtocolGuid,\r
+ This->DriverBindingHandle,\r
+ Controller\r
+ );\r
+\r
+ gBS->UninstallMultipleProtocolInterfaces (\r
+ Controller,\r
+ &gIdeControllerDriverGuid,\r
+ IdePrivateData,\r
+ &gEfiIdeControllerInitProtocolGuid,\r
+ &(IdePrivateData->IdeInit),\r
+ NULL\r
+ );\r
+\r
+ gBS->FreePool (IdePrivateData);\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+//\r
+// Interface functions of IDE_CONTROLLER_INIT protocol\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
+Routine Description:\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
+Arguments:\r
+\r
+ This -- the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ Channel -- Channel number (0 based, either 0 or 1)\r
+ Enabled -- TRUE if the channel is enabled. If the channel is disabled, \r
+ then it will no be enumerated.\r
+ MaxDevices -- The Max number of IDE devices that the bus driver can expect\r
+ on this channel. For ATA/ATAPI, this number is either 1 or 2.\r
+\r
+Returns:\r
+ EFI_STATUS \r
+\r
+--*/\r
+{\r
+ //\r
+ // Channel number (0 based, either 0 or 1)\r
+ //\r
+ if (Channel < ICH_IDE_MAX_CHANNEL) {\r
+ *Enabled = TRUE;\r
+ *MaxDevices = ICH_IDE_MAX_DEVICES;\r
+ return EFI_SUCCESS;\r
+ }\r
+\r
+ *Enabled = FALSE;\r
+ return EFI_INVALID_PARAMETER;\r
+}\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
+Routine Description:\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
+Arguments:\r
+\r
+ This -- the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ Phase -- phase indicator defined by IDE_CONTROLLER_INIT protocol\r
+ Channel -- Channel number (0 based, either 0 or 1)\r
+\r
+Returns:\r
+ \r
+--*/\r
+{\r
+ return EFI_SUCCESS;\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
+Routine Description:\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
+Arguments:\r
+\r
+ This -- the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ Channel -- IDE channel number (0 based, either 0 or 1)\r
+ Device -- IDE device number\r
+ IdentifyData -- A pointer to EFI_IDENTIFY_DATA data structure\r
+\r
+Returns:\r
+ \r
+--*/\r
+{\r
+ return EFI_SUCCESS;\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
+Routine Description:\r
+\r
+ This function is called by IdeBus driver to disqualify unsupported operation\r
+ mode on specfic IDE device\r
+\r
+Arguments:\r
+\r
+ This -- the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ Channel -- IDE channel number (0 based, either 0 or 1)\r
+ Device -- IDE device number\r
+ BadModes -- Operation mode indicator\r
+\r
+Returns:\r
+ \r
+--*/\r
+{\r
+ return EFI_SUCCESS;\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
+Routine Description:\r
+\r
+ This function is called by IdeBus driver to calculate the best operation mode\r
+ supported by specific IDE device\r
+\r
+Arguments:\r
+\r
+ This -- the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ Channel -- IDE channel number (0 based, either 0 or 1)\r
+ Device -- IDE device number\r
+ SupportedModes -- Modes collection supported by IDE device\r
+\r
+Returns:\r
+ \r
+--*/\r
+{\r
+ if (Channel >= ICH_IDE_MAX_CHANNEL || Device >= ICH_IDE_MAX_DEVICES) {\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
+ //\r
+ // In EoE enviroment, when nothing is known about the platform hardware,\r
+ // just set the mode to lowest PIO mode for compatibility.\r
+ //\r
+ (*SupportedModes)->PioMode.Valid = TRUE;\r
+ (*SupportedModes)->PioMode.Mode = AtaPioModeBelow2;\r
+ (*SupportedModes)->UdmaMode.Valid = FALSE;\r
+ (*SupportedModes)->SingleWordDmaMode.Valid = FALSE;\r
+ (*SupportedModes)->MultiWordDmaMode.Valid = FALSE;\r
+\r
+ return EFI_SUCCESS;\r
+}\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
+Routine Description:\r
+\r
+ This function is called by IdeBus driver to set appropriate timing on IDE\r
+ controller according supported operation mode\r
+\r
+Arguments:\r
+\r
+ This -- the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ Channel -- IDE channel number (0 based, either 0 or 1)\r
+ Device -- IDE device number\r
+\r
+Returns:\r
+ \r
+--*/\r
+{\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+\r
projects / mirror_edk2.git / commitdiff