/* $Id$ */ /** @file * IdeController.c */ /* * Copyright (C) 2009-2010 Oracle Corporation * * This file is part of VirtualBox Open Source Edition (OSE), as * available from http://www.virtualbox.org. This file is free software; * you can redistribute it and/or modify it under the terms of the GNU * General Public License (GPL) as published by the Free Software * Foundation, in version 2 as it comes in the "COPYING" file of the * VirtualBox OSE distribution. VirtualBox OSE is distributed in the * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind. */ /** @file This driver module produces IDE_CONTROLLER_INIT protocol and will be used by IDE Bus driver to support platform dependent timing information. This driver is responsible for early initialization of IDE controller. Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved.<BR> This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ #include "IdeController.h" #ifndef DEBUG_ALL #define DEBUG_IDE 0 #else #define DEBUG_IDE DEBUG_ALL #endif #if DEBUG_IDE==0 #define DBG(...) #else #define DBG(...) DebugLog(DEBUG_IDE, __VA_ARGS__) #endif #if DEBUG_IDE==0 #define DBG(...) #else #define DBG(...) DebugLog(DEBUG_IDE, __VA_ARGS__) #endif // // EFI_DRIVER_BINDING_PROTOCOL instance // EFI_DRIVER_BINDING_PROTOCOL gIdeControllerDriverBinding = { IdeControllerSupported, IdeControllerStart, IdeControllerStop, 0xa, NULL, NULL }; // // EFI_IDE_CONTROLLER_PROVATE_DATA Template // EFI_IDE_CONTROLLER_INIT_PROTOCOL gEfiIdeControllerInit = { IdeInitGetChannelInfo, IdeInitNotifyPhase, IdeInitSubmitData, IdeInitDisqualifyMode, IdeInitCalculateMode, IdeInitSetTiming, ICH_IDE_ENUMER_ALL, //FALSE ICH_IDE_MAX_CHANNEL //=2 }; // // EFI_ATA_COLLECTIVE_MODE Template // EFI_ATA_COLLECTIVE_MODE gEfiAtaCollectiveModeTemplate = { { TRUE, // PioMode.Valid 0 // PioMode.Mode }, { TRUE, // SingleWordDmaMode.Valid 0 }, { FALSE, // MultiWordDmaMode.Valid 0 }, { TRUE, // UdmaMode.Valid 0 // UdmaMode.Mode } }; static BOOLEAN gfIdeAhciEmulation = FALSE; /** Chipset Ide Driver EntryPoint function. It follows the standard EFI driver model. It's called by StartImage() of DXE Core. @param ImageHandle While the driver image loaded be the ImageLoader(), an image handle is assigned to this driver binary, all activities of the driver is tied to this ImageHandle @param SystemTable A pointer to the system table, for all BS(Boo Services) and RT(Runtime Services) @return EFI_STATUS Status of EfiLibInstallDriverBindingComponentName2(). **/ EFI_STATUS EFIAPI InitializeIdeControllerDriver ( IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable ) /*++ Routine Description: Chipset Ide Driver EntryPoint function. It follows the standard EFI driver model. It's called by StartImage() of DXE Core Arguments: ImageHandle -- While the driver image loaded be the ImageLoader(), an image handle is assigned to this driver binary, all activities of the driver is tied to this ImageHandle *SystemTable -- A pointer to the system table, for all BS(Boo Services) and RT(Runtime Services) Returns: Always call EfiLibInstallDriverBindingProtocol( ) and return the result --*/ { EFI_STATUS Status; // // Install driver model protocol(s). // Status = EfiLibInstallDriverBindingComponentName2 ( ImageHandle, SystemTable, &gIdeControllerDriverBinding, ImageHandle, &gIdeControllerComponentName, &gIdeControllerComponentName2 ); ASSERT_EFI_ERROR (Status); return Status; } EFI_STATUS EFIAPI IdeControllerSupported ( IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath ) /*++ Routine Description: Register Driver Binding protocol for this driver. Arguments: This -- a pointer points to the Binding Protocol instance Controller -- The handle of controller to be tested. *RemainingDevicePath -- A pointer to the device path. Ignored by device driver but used by bus driver Returns: EFI_SUCCESS -- Driver loaded. other -- Driver not loaded. --*/ { EFI_STATUS Status; EFI_PCI_IO_PROTOCOL *PciIo; UINT8 PciClass; UINT8 PciSubClass; // // Attempt to Open PCI I/O Protocol // Status = gBS->OpenProtocol ( Controller, &gEfiPciIoProtocolGuid, (VOID **) &PciIo, This->DriverBindingHandle, Controller, EFI_OPEN_PROTOCOL_BY_DRIVER ); if (EFI_ERROR (Status)) { return Status; } // // Now further check the PCI header: Base class (offset 0x0B) and // Sub Class (offset 0x0A). This controller should be an Ide controller // Status = PciIo->Pci.Read ( PciIo, EfiPciIoWidthUint8, PCI_CLASSCODE_OFFSET + 2, 1, &PciClass ); if (EFI_ERROR (Status)) { goto Done; } Status = PciIo->Pci.Read ( PciIo, EfiPciIoWidthUint8, PCI_CLASSCODE_OFFSET + 1, 1, &PciSubClass ); if (EFI_ERROR (Status)) { goto Done; } // // Examine Ide PCI Configuration table fields // if ((PciClass != PCI_CLASS_MASS_STORAGE) || ((PciSubClass != PCI_CLASS_MASS_STORAGE_IDE) && (PciSubClass != 0x06 /*SATA*/))) { Status = EFI_UNSUPPORTED; } if (PciSubClass == 0x6) gfIdeAhciEmulation = TRUE; Done: gBS->CloseProtocol ( Controller, &gEfiPciIoProtocolGuid, This->DriverBindingHandle, Controller ); return Status; } EFI_STATUS EFIAPI IdeControllerStart ( IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE Controller, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath ) /*++ Routine Description: This routine is called right after the .Supported() called and return EFI_SUCCESS. Notes: The supported protocols are checked but the Protocols are closed. Arguments: This -- a pointer points to the Binding Protocol instance Controller -- The handle of controller to be tested. Parameter passed by the caller *RemainingDevicePath -- A pointer to the device path. Should be ignored by device driver --*/ { EFI_STATUS Status; EFI_PCI_IO_PROTOCOL *PciIo; // // Now test and open the EfiPciIoProtocol // Status = gBS->OpenProtocol ( Controller, &gEfiPciIoProtocolGuid, (VOID **) &PciIo, This->DriverBindingHandle, Controller, EFI_OPEN_PROTOCOL_BY_DRIVER ); // // Status == EFI_SUCCESS - A normal execution flow, SUCCESS and the program proceeds. // Status == ALREADY_STARTED - A non-zero Status code returned. It indicates // that the protocol has been opened and should be treated as a // normal condition and the program proceeds. The Protocol will not // opened 'again' by this call. // Status != ALREADY_STARTED - Error status, terminate program execution // if (EFI_ERROR (Status)) { return Status; } // // Install IDE_CONTROLLER_INIT protocol // return gBS->InstallMultipleProtocolInterfaces ( &Controller, &gEfiIdeControllerInitProtocolGuid, &gEfiIdeControllerInit, NULL ); } EFI_STATUS EFIAPI IdeControllerStop ( IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE Controller, IN UINTN NumberOfChildren, IN EFI_HANDLE *ChildHandleBuffer ) /*++ Routine Description: Stop this driver on Controller Handle. Arguments: This - Protocol instance pointer. Controller - Handle of device to stop driver on NumberOfChildren - Not used ChildHandleBuffer - Not used Returns: EFI_SUCCESS - This driver is removed DeviceHandle other - This driver was not removed from this device --*/ { EFI_STATUS Status; EFI_IDE_CONTROLLER_INIT_PROTOCOL *IdeControllerInit; // // Open the produced protocol // Status = gBS->OpenProtocol ( Controller, &gEfiIdeControllerInitProtocolGuid, (VOID **) &IdeControllerInit, This->DriverBindingHandle, Controller, EFI_OPEN_PROTOCOL_GET_PROTOCOL ); if (EFI_ERROR (Status)) { return EFI_UNSUPPORTED; } // // Make sure the protocol was produced by this driver // if (IdeControllerInit != &gEfiIdeControllerInit) { return EFI_UNSUPPORTED; } // // Uninstall the IDE Controller Init Protocol // Status = gBS->UninstallMultipleProtocolInterfaces ( Controller, &gEfiIdeControllerInitProtocolGuid, &gEfiIdeControllerInit, NULL ); if (EFI_ERROR (Status)) { return Status; } // // Close protocols opened by Ide controller driver // return gBS->CloseProtocol ( Controller, &gEfiPciIoProtocolGuid, This->DriverBindingHandle, Controller ); } // // Interface functions of IDE_CONTROLLER_INIT protocol // EFI_STATUS EFIAPI IdeInitGetChannelInfo ( IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, IN UINT8 Channel, OUT BOOLEAN *Enabled, OUT UINT8 *MaxDevices ) /*++ Routine Description: This function can be used to obtain information about a specified channel. It's usually used by IDE Bus driver during enumeration process. Arguments: This -- the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. Channel -- Channel number (0 based, either 0 or 1) Enabled -- TRUE if the channel is enabled. If the channel is disabled, then it will no be enumerated. MaxDevices -- The Max number of IDE devices that the bus driver can expect on this channel. For ATA/ATAPI, this number is either 1 or 2. Returns: EFI_STATUS --*/ { // // Channel number (0 based, either 0 or 1) // if (Channel < ICH_IDE_MAX_CHANNEL) { *Enabled = TRUE; *MaxDevices = ICH_IDE_MAX_DEVICES; return EFI_SUCCESS; } *Enabled = FALSE; return EFI_INVALID_PARAMETER; } EFI_STATUS EFIAPI IdeInitNotifyPhase ( IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, IN EFI_IDE_CONTROLLER_ENUM_PHASE Phase, IN UINT8 Channel ) /*++ Routine Description: This function is called by IdeBus driver before executing certain actions. This allows IDE Controller Init to prepare for each action. Arguments: This -- the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. Phase -- phase indicator defined by IDE_CONTROLLER_INIT protocol Channel -- Channel number (0 based, either 0 or 1) Returns: --*/ { return EFI_SUCCESS; } EFI_STATUS EFIAPI IdeInitSubmitData ( IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, IN UINT8 Channel, IN UINT8 Device, IN EFI_IDENTIFY_DATA *IdentifyData ) /*++ Routine Description: This function is called by IdeBus driver to submit EFI_IDENTIFY_DATA data structure obtained from IDE deivce. This structure is used to set IDE timing Arguments: This -- the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. Channel -- IDE channel number (0 based, either 0 or 1) Device -- IDE device number IdentifyData -- A pointer to EFI_IDENTIFY_DATA data structure Returns: --*/ { return EFI_SUCCESS; } EFI_STATUS EFIAPI IdeInitDisqualifyMode ( IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, IN UINT8 Channel, IN UINT8 Device, IN EFI_ATA_COLLECTIVE_MODE *BadModes ) /*++ Routine Description: This function is called by IdeBus driver to disqualify unsupported operation mode on specific IDE device Arguments: This -- the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. Channel -- IDE channel number (0 based, either 0 or 1) Device -- IDE device number BadModes -- Operation mode indicator Returns: --*/ { return EFI_SUCCESS; } EFI_STATUS EFIAPI IdeInitCalculateMode ( IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, IN UINT8 Channel, IN UINT8 Device, OUT EFI_ATA_COLLECTIVE_MODE **SupportedModes ) /*++ Routine Description: This function is called by IdeBus driver to calculate the best operation mode supported by specific IDE device Arguments: This -- the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. Channel -- IDE channel number (0 based, either 0 or 1) Device -- IDE device number SupportedModes -- Modes collection supported by IDE device Returns: --*/ { if (Channel >= ICH_IDE_MAX_CHANNEL || Device >= ICH_IDE_MAX_DEVICES) { return EFI_INVALID_PARAMETER; } *SupportedModes = AllocateCopyPool (sizeof (EFI_ATA_COLLECTIVE_MODE), &gEfiAtaCollectiveModeTemplate); if (*SupportedModes == NULL) { return EFI_OUT_OF_RESOURCES; } EFI_ATA_COLLECTIVE_MODE *pSupportedModes = (*SupportedModes); pSupportedModes->PioMode.Mode = 3; /* AtaPioMode4 see VBoxIdeBusDxe/IdeData.h */ if (gfIdeAhciEmulation) { pSupportedModes->UdmaMode.Valid = FALSE; pSupportedModes->MultiWordDmaMode.Valid = FALSE; } DBG(L"supported mode=%d\n", pSupportedModes->PioMode.Mode); return EFI_SUCCESS; } EFI_STATUS EFIAPI IdeInitSetTiming ( IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This, IN UINT8 Channel, IN UINT8 Device, IN EFI_ATA_COLLECTIVE_MODE *Modes ) /*++ Routine Description: This function is called by IdeBus driver to set appropriate timing on IDE controller according supported operation mode Arguments: This -- the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. Channel -- IDE channel number (0 based, either 0 or 1) Device -- IDE device number Returns: --*/ { return EFI_SUCCESS; }