[mirror_edk2.git] / MdeModulePkg / Bus / Ata / AtaBusDxe / AtaBus.c

/** @file\r
  This file implements protocol interfaces for ATA bus driver.\r
  \r
  This file implements protocol interfaces: Driver Binding protocol,\r
  Block IO protocol and DiskInfo protocol.\r
    \r
  Copyright (c) 2009 - 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
\r
#include "AtaBus.h"\r
\r
//\r
// ATA Bus Driver Binding Protocol Instance\r
//\r
EFI_DRIVER_BINDING_PROTOCOL gAtaBusDriverBinding = {\r
  AtaBusDriverBindingSupported,\r
  AtaBusDriverBindingStart,\r
  AtaBusDriverBindingStop,\r
  0x10,\r
  NULL,\r
  NULL\r
};\r
\r
//\r
// Template for ATA Child Device.\r
//\r
ATA_DEVICE gAtaDeviceTemplate = {\r
  ATA_DEVICE_SIGNATURE,        // Signature\r
  NULL,                        // Handle\r
  {                            // BlockIo\r
    EFI_BLOCK_IO_PROTOCOL_REVISION,\r
    NULL,\r
    AtaBlockIoReset,\r
    AtaBlockIoReadBlocks,\r
    AtaBlockIoWriteBlocks,\r
    AtaBlockIoFlushBlocks\r
  },\r
  {                            // BlockMedia\r
    0,                         // MediaId\r
    FALSE,                     // RemovableMedia\r
    TRUE,                      // MediaPresent\r
    FALSE,                     // LogicPartition\r
    FALSE,                     // ReadOnly\r
    FALSE,                     // WritingCache\r
    0x200,                     // BlockSize \r
    0,                         // IoAlign\r
    0,                         // LastBlock\r
    0,                         // LowestAlignedLba\r
    1                          // LogicalBlocksPerPhysicalBlock\r
  },\r
  {                            // DiskInfo\r
    EFI_DISK_INFO_IDE_INTERFACE_GUID,\r
    AtaDiskInfoInquiry,\r
    AtaDiskInfoIdentify,\r
    AtaDiskInfoSenseData,\r
    AtaDiskInfoWhichIde\r
  },\r
  NULL,                        // DevicePath\r
  NULL,                        // AtaBusDriverData\r
  0,                           // Port\r
  0,                           // PortMultiplierPort\r
  { 0, },                      // Packet\r
  {{ 0}, },                    // Acb\r
  NULL,                        // Asb\r
  FALSE,                       // UdmaValid\r
  FALSE,                       // Lba48Bit\r
  NULL,                        // IdentifyData\r
  NULL,                        // ControllerNameTable\r
  {L'\0', }                    // ModelName\r
};\r
\r
/**\r
  Allocates an aligned buffer for ATA device.\r
\r
  This function allocates an aligned buffer for the ATA device to perform\r
  ATA pass through operations. The alignment requirement is from ATA pass\r
  through interface.\r
\r
  @param  AtaDevice         The ATA child device involved for the operation.\r
  @param  BufferSize        The request buffer size.\r
\r
  @return A pointer to the aligned buffer or NULL if the allocation fails.\r
\r
**/\r
VOID *\r
AllocateAlignedBuffer (\r
  IN ATA_DEVICE               *AtaDevice,\r
  IN UINTN                    BufferSize\r
  )\r
{\r
  return AllocateAlignedPages (EFI_SIZE_TO_PAGES (BufferSize), AtaDevice->AtaBusDriverData->AtaPassThru->Mode->IoAlign);\r
}\r
\r
/**\r
  Frees an aligned buffer for ATA device.\r
\r
  This function frees an aligned buffer for the ATA device to perform\r
  ATA pass through operations.\r
\r
  @param  Buffer            The aligned buffer to be freed.\r
  @param  BufferSize        The request buffer size.\r
\r
**/\r
VOID\r
FreeAlignedBuffer (\r
  IN VOID                     *Buffer,\r
  IN UINTN                    BufferSize\r
  )\r
{\r
  if (Buffer != NULL) {\r
    FreePages (Buffer, EFI_SIZE_TO_PAGES (BufferSize));\r
  }\r
}\r
\r
\r
/**\r
  Release all the resources allocated for the ATA device.\r
\r
  This function releases all the resources allocated for the ATA device.\r
\r
  @param  AtaDevice         The ATA child device involved for the operation.\r
\r
**/\r
VOID\r
ReleaseAtaResources (\r
  IN ATA_DEVICE  *AtaDevice\r
  )\r
{\r
  FreeUnicodeStringTable (AtaDevice->ControllerNameTable);\r
  FreeAlignedBuffer (AtaDevice->Asb, sizeof (*AtaDevice->Asb));\r
  FreeAlignedBuffer (AtaDevice->IdentifyData, sizeof (*AtaDevice->IdentifyData));\r
  if (AtaDevice->DevicePath != NULL) {\r
    FreePool (AtaDevice->DevicePath);\r
  }\r
  FreePool (AtaDevice);\r
}\r
\r
\r
/**\r
  Registers an ATA device.\r
\r
  This function allocates an ATA device structure for the ATA device specified by\r
  Port and PortMultiplierPort if the ATA device is identified as a valid one. \r
  Then it will create child handle and install Block IO and Disk Info protocol on\r
  it.\r
\r
  @param  AtaBusDriverData      The parent ATA bus driver data structure.\r
  @param  Port                  The port number of the ATA device.\r
  @param  PortMultiplierPort    The port multiplier port number of the ATA device.\r
\r
  @retval EFI_SUCCESS           The ATA device is successfully registered.\r
  @retval EFI_OUT_OF_RESOURCES  There is not enough memory to allocate the ATA device\r
                                and related data structures.\r
  @return Others                Some error occurs when registering the ATA device.\r
**/\r
EFI_STATUS\r
RegisterAtaDevice (\r
  IN OUT ATA_BUS_DRIVER_DATA        *AtaBusDriverData,\r
  IN     UINT16                     Port,\r
  IN     UINT16                     PortMultiplierPort\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  ATA_DEVICE                        *AtaDevice;\r
  EFI_ATA_PASS_THRU_PROTOCOL        *AtaPassThru;\r
  EFI_DEVICE_PATH_PROTOCOL          *NewDevicePathNode;\r
  EFI_DEVICE_PATH_PROTOCOL          *DevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL          *RemainingDevicePath;\r
  EFI_HANDLE                        DeviceHandle;\r
\r
  AtaDevice         = NULL;\r
  NewDevicePathNode = NULL;\r
  DevicePath        = NULL;\r
  RemainingDevicePath = NULL;\r
\r
  //\r
  // Build device path \r
  //\r
  AtaPassThru = AtaBusDriverData->AtaPassThru;\r
  Status = AtaPassThru->BuildDevicePath (AtaPassThru, Port, PortMultiplierPort, &NewDevicePathNode);\r
  if (EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
\r
  DevicePath = AppendDevicePathNode (AtaBusDriverData->ParentDevicePath, NewDevicePathNode);\r
  if (DevicePath == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto Done;\r
  }\r
\r
  DeviceHandle = NULL;\r
  RemainingDevicePath = DevicePath;\r
  Status = gBS->LocateDevicePath (&gEfiDevicePathProtocolGuid, &RemainingDevicePath, &DeviceHandle);\r
  if (!EFI_ERROR (Status) && (DeviceHandle != NULL) && IsDevicePathEnd(RemainingDevicePath)) {\r
    Status = EFI_ALREADY_STARTED;\r
    FreePool (DevicePath);\r
    goto Done;\r
  }\r
\r
  //\r
  // Allocate ATA device from the template.\r
  //\r
  AtaDevice = AllocateCopyPool (sizeof (gAtaDeviceTemplate), &gAtaDeviceTemplate);\r
  if (AtaDevice == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto Done;\r
  }\r
\r
  //\r
  // Initializes ATA device structures and allocates the required buffer.\r
  //\r
  AtaDevice->BlockIo.Media = &AtaDevice->BlockMedia;\r
  AtaDevice->AtaBusDriverData = AtaBusDriverData;\r
  AtaDevice->DevicePath = DevicePath;\r
  AtaDevice->Port = Port;\r
  AtaDevice->PortMultiplierPort = PortMultiplierPort;\r
  AtaDevice->Asb = AllocateAlignedBuffer (AtaDevice, sizeof (*AtaDevice->Asb));\r
  if (AtaDevice->Asb == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto Done;\r
  }\r
  AtaDevice->IdentifyData = AllocateAlignedBuffer (AtaDevice, sizeof (*AtaDevice->IdentifyData));\r
  if (AtaDevice->IdentifyData == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto Done;\r
  }\r
\r
  //\r
  // Try to identify the ATA device via the ATA pass through command. \r
  //\r
  Status = DiscoverAtaDevice (AtaDevice);\r
  if (EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
  \r
  //\r
  // Build controller name for Component Name (2) protocol.\r
  //\r
  Status = AddUnicodeString2 (\r
             "eng",\r
             gAtaBusComponentName.SupportedLanguages,\r
             &AtaDevice->ControllerNameTable,\r
             AtaDevice->ModelName,\r
             TRUE\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
\r
  Status = AddUnicodeString2 (\r
             "en",\r
             gAtaBusComponentName2.SupportedLanguages,\r
             &AtaDevice->ControllerNameTable,\r
             AtaDevice->ModelName,\r
             FALSE\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
\r
  //\r
  // Update to AHCI interface GUID based on device path node. The default one\r
  // is IDE interface GUID copied from template.\r
  //\r
  if (NewDevicePathNode->SubType == MSG_SATA_DP) {\r
    CopyGuid (&AtaDevice->DiskInfo.Interface, &gEfiDiskInfoAhciInterfaceGuid);\r
  }\r
\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &AtaDevice->Handle,\r
                  &gEfiDevicePathProtocolGuid,\r
                  AtaDevice->DevicePath,\r
                  &gEfiBlockIoProtocolGuid,\r
                  &AtaDevice->BlockIo,\r
                  &gEfiDiskInfoProtocolGuid,\r
                  &AtaDevice->DiskInfo,\r
                  NULL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
\r
  gBS->OpenProtocol (\r
         AtaBusDriverData->Controller,\r
         &gEfiAtaPassThruProtocolGuid,\r
         (VOID **) &AtaPassThru,\r
         AtaBusDriverData->DriverBindingHandle,\r
         AtaDevice->Handle,\r
         EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
         );\r
\r
Done:\r
  if (NewDevicePathNode != NULL) {\r
    FreePool (NewDevicePathNode);\r
  }\r
\r
  if (EFI_ERROR (Status) && (AtaDevice != NULL)) {\r
    ReleaseAtaResources (AtaDevice);  \r
    DEBUG ((DEBUG_ERROR | DEBUG_INIT, "Failed to initialize Port %x PortMultiplierPort %x, status = %r\n", Port, PortMultiplierPort, Status));\r
  }\r
  return Status;\r
}\r
\r
\r
/**\r
  Unregisters an ATA device.\r
\r
  This function removes the protocols installed on the controller handle and \r
  frees the resources allocated for the ATA device. \r
\r
  @param  This                  The pointer to EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param  Controller            The controller handle of the ATA device.\r
  @param  Handle                The child handle.\r
\r
  @retval EFI_SUCCESS           The ATA device is successfully unregistered.\r
  @return Others                Some error occurs when unregistering the ATA device.\r
\r
**/\r
EFI_STATUS\r
UnregisterAtaDevice (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL    *This,\r
  IN  EFI_HANDLE                     Controller,\r
  IN  EFI_HANDLE                     Handle\r
  )\r
{\r
  EFI_STATUS                  Status;\r
  EFI_BLOCK_IO_PROTOCOL       *BlockIo;\r
  ATA_DEVICE                  *AtaDevice;\r
  EFI_ATA_PASS_THRU_PROTOCOL  *AtaPassThru;\r
\r
  Status = gBS->OpenProtocol (\r
                  Handle,\r
                  &gEfiBlockIoProtocolGuid,\r
                  (VOID **) &BlockIo,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  AtaDevice = ATA_DEVICE_FROM_BLOCK_IO (BlockIo);\r
\r
  //\r
  // Close the child handle\r
  //\r
  gBS->CloseProtocol (\r
         Controller,\r
         &gEfiAtaPassThruProtocolGuid,\r
         This->DriverBindingHandle,\r
         Handle\r
         );\r
\r
  Status = gBS->UninstallMultipleProtocolInterfaces (\r
                  Handle,\r
                  &gEfiDevicePathProtocolGuid,\r
                  AtaDevice->DevicePath,\r
                  &gEfiBlockIoProtocolGuid,\r
                  &AtaDevice->BlockIo,\r
                  &gEfiDiskInfoProtocolGuid,\r
                  &AtaDevice->DiskInfo,\r
                  NULL\r
                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    gBS->OpenProtocol (\r
          Controller,\r
          &gEfiAtaPassThruProtocolGuid,\r
          (VOID **) &AtaPassThru,\r
          This->DriverBindingHandle,\r
          Handle,\r
          EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
          );\r
    return Status;\r
  }\r
\r
  ReleaseAtaResources (AtaDevice);\r
\r
  return Status;\r
}\r
\r
\r
\r
/**\r
  Tests to see if this driver supports a given controller. If a child device is provided, \r
  it further tests to see if this driver supports creating a handle for the specified child device.\r
\r
  This function checks to see if the driver specified by This supports the device specified by \r
  ControllerHandle. Drivers will typically use the device path attached to \r
  ControllerHandle and/or the services from the bus I/O abstraction attached to \r
  ControllerHandle to determine if the driver supports ControllerHandle. This function \r
  may be called many times during platform initialization. In order to reduce boot times, the tests \r
  performed by this function must be very small, and take as little time as possible to execute. This \r
  function must not change the state of any hardware devices, and this function must be aware that the \r
  device specified by ControllerHandle may already be managed by the same driver or a \r
  different driver. This function must match its calls to AllocatePages() with FreePages(), \r
  AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().  \r
  Since ControllerHandle may have been previously started by the same driver, if a protocol is \r
  already in the opened state, then it must not be closed with CloseProtocol(). This is required \r
  to guarantee the state of ControllerHandle is not modified by this function.\r
\r
  @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle     The handle of the controller to test. This handle \r
                                   must support a protocol interface that supplies \r
                                   an I/O abstraction to the driver.\r
  @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.  This \r
                                   parameter is ignored by device drivers, and is optional for bus \r
                                   drivers. For bus drivers, if this parameter is not NULL, then \r
                                   the bus driver must determine if the bus controller specified \r
                                   by ControllerHandle and the child controller specified \r
                                   by RemainingDevicePath are both supported by this \r
                                   bus driver.\r
\r
  @retval EFI_SUCCESS              The device specified by ControllerHandle and\r
                                   RemainingDevicePath is supported by the driver specified by This.\r
  @retval EFI_ALREADY_STARTED      The device specified by ControllerHandle and\r
                                   RemainingDevicePath is already being managed by the driver\r
                                   specified by This.\r
  @retval EFI_ACCESS_DENIED        The device specified by ControllerHandle and\r
                                   RemainingDevicePath is already being managed by a different\r
                                   driver or an application that requires exclusive access.\r
                                   Currently not implemented.\r
  @retval EFI_UNSUPPORTED          The device specified by ControllerHandle and\r
                                   RemainingDevicePath is not supported by the driver specified by This.\r
**/\r
EFI_STATUS\r
EFIAPI\r
AtaBusDriverBindingSupported (\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_DEVICE_PATH_PROTOCOL          *ParentDevicePath;\r
  EFI_ATA_PASS_THRU_PROTOCOL        *AtaPassThru;\r
  UINT16                            Port;\r
  UINT16                            PortMultiplierPort;\r
 \r
  //\r
  // Test EFI_ATA_PASS_THRU_PROTOCOL on controller handle.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiAtaPassThruProtocolGuid,\r
                  (VOID **) &AtaPassThru,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
\r
  if (Status == EFI_ALREADY_STARTED) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Test RemainingDevicePath is valid or not.\r
  //\r
  if ((RemainingDevicePath != NULL) && !IsDevicePathEnd (RemainingDevicePath)) {\r
    Status = AtaPassThru->GetDevice (AtaPassThru, RemainingDevicePath, &Port, &PortMultiplierPort);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
  }\r
\r
  //\r
  // Close the I/O Abstraction(s) used to perform the supported test\r
  //\r
  gBS->CloseProtocol (\r
        Controller,\r
        &gEfiAtaPassThruProtocolGuid,\r
        This->DriverBindingHandle,\r
        Controller\r
        );\r
\r
  //\r
  // Open the EFI Device Path protocol needed to perform the supported test\r
  //\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiDevicePathProtocolGuid,\r
                  (VOID **) &ParentDevicePath,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  return Status;\r
}\r
\r
\r
/**\r
  Starts a device controller or a bus controller.\r
\r
  The Start() function is designed to be invoked from the EFI boot service ConnectController().\r
  As a result, much of the error checking on the parameters to Start() has been moved into this \r
  common boot service. It is legal to call Start() from other locations, \r
  but the following calling restrictions must be followed or the system behavior will not be deterministic.\r
  1. ControllerHandle must be a valid EFI_HANDLE.\r
  2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned\r
     EFI_DEVICE_PATH_PROTOCOL.\r
  3. Prior to calling Start(), the Supported() function for the driver specified by This must\r
     have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.  \r
\r
  @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle     The handle of the controller to start. This handle \r
                                   must support a protocol interface that supplies \r
                                   an I/O abstraction to the driver.\r
  @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.  This \r
                                   parameter is ignored by device drivers, and is optional for bus \r
                                   drivers. For a bus driver, if this parameter is NULL, then handles \r
                                   for all the children of Controller are created by this driver.  \r
                                   If this parameter is not NULL and the first Device Path Node is \r
                                   not the End of Device Path Node, then only the handle for the \r
                                   child device specified by the first Device Path Node of \r
                                   RemainingDevicePath is created by this driver.\r
                                   If the first Device Path Node of RemainingDevicePath is \r
                                   the End of Device Path Node, no child handle is created by this\r
                                   driver.\r
\r
  @retval EFI_SUCCESS              The device was started.\r
  @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.\r
  @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.\r
  @retval Others                   The driver failded to start the device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AtaBusDriverBindingStart (\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_ATA_PASS_THRU_PROTOCOL        *AtaPassThru;\r
  EFI_DEVICE_PATH_PROTOCOL          *ParentDevicePath;\r
  ATA_BUS_DRIVER_DATA               *AtaBusDriverData;\r
  UINT16                            Port;\r
  UINT16                            PortMultiplierPort;\r
\r
  AtaBusDriverData = NULL;\r
\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiDevicePathProtocolGuid,\r
                  (VOID **) &ParentDevicePath,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiAtaPassThruProtocolGuid,\r
                  (VOID **) &AtaPassThru,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if ((EFI_ERROR (Status)) && (Status != EFI_ALREADY_STARTED)) {\r
    goto ErrorExit;\r
  }\r
\r
  //\r
  // Check EFI_ALREADY_STARTED to reuse the original ATA_BUS_DRIVER_DATA.\r
  //\r
  if (Status != EFI_ALREADY_STARTED) {\r
    AtaBusDriverData = AllocateZeroPool (sizeof (ATA_BUS_DRIVER_DATA));\r
    if (AtaBusDriverData == NULL) {\r
      Status = EFI_OUT_OF_RESOURCES;\r
      goto ErrorExit;\r
    }\r
\r
    AtaBusDriverData->AtaPassThru = AtaPassThru;\r
    AtaBusDriverData->Controller = Controller;\r
    AtaBusDriverData->ParentDevicePath = ParentDevicePath;\r
    AtaBusDriverData->DriverBindingHandle = This->DriverBindingHandle;\r
\r
    Status = gBS->InstallMultipleProtocolInterfaces (\r
                    &Controller,\r
                    &gEfiCallerIdGuid,\r
                    AtaBusDriverData,\r
                    NULL\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      goto ErrorExit;\r
    }\r
\r
  } else {\r
    Status = gBS->OpenProtocol (\r
                    Controller,\r
                    &gEfiCallerIdGuid,\r
                    (VOID **) &AtaBusDriverData,\r
                    This->DriverBindingHandle,\r
                    Controller,\r
                    EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      AtaBusDriverData = NULL;\r
      goto ErrorExit;\r
    }\r
  }\r
\r
  if (RemainingDevicePath == NULL) {\r
    Port = 0xFFFF;\r
    while (TRUE) {\r
      Status = AtaPassThru->GetNextPort (AtaPassThru, &Port);\r
      if (EFI_ERROR (Status)) {\r
        //\r
        // We cannot find more legal port then we are done.\r
        //\r
        break;\r
      }\r
      \r
      PortMultiplierPort = 0xFFFF;\r
      while (TRUE) {\r
        Status = AtaPassThru->GetNextDevice (AtaPassThru, Port, &PortMultiplierPort);\r
        if (EFI_ERROR (Status)) {\r
          //\r
          // We cannot find more legal port multiplier port number for ATA device\r
          // on the port, then we are done.\r
          //\r
          break;\r
        }\r
        RegisterAtaDevice (AtaBusDriverData, Port, PortMultiplierPort);\r
      }\r
    }\r
    Status = EFI_SUCCESS;\r
  } else if (!IsDevicePathEnd (RemainingDevicePath)) {\r
    Status = AtaPassThru->GetDevice (AtaPassThru, RemainingDevicePath, &Port, &PortMultiplierPort);\r
    if (!EFI_ERROR (Status)) {\r
      Status = RegisterAtaDevice (AtaBusDriverData,Port, PortMultiplierPort);\r
    }\r
  }\r
  \r
  return Status;\r
\r
ErrorExit:\r
\r
  if (AtaBusDriverData != NULL) {\r
    gBS->UninstallMultipleProtocolInterfaces (\r
           Controller,\r
           &gEfiCallerIdGuid,\r
           AtaBusDriverData,\r
           NULL\r
           );\r
    FreePool (AtaBusDriverData);\r
  }\r
\r
  gBS->CloseProtocol (\r
        Controller,\r
        &gEfiAtaPassThruProtocolGuid,\r
        This->DriverBindingHandle,\r
        Controller\r
        );\r
\r
  return Status;\r
\r
}\r
\r
\r
/**\r
  Stops a device controller or a bus controller.\r
  \r
  The Stop() function is designed to be invoked from the EFI boot service DisconnectController(). \r
  As a result, much of the error checking on the parameters to Stop() has been moved \r
  into this common boot service. It is legal to call Stop() from other locations, \r
  but the following calling restrictions must be followed or the system behavior will not be deterministic.\r
  1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this\r
     same driver's Start() function.\r
  2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid\r
     EFI_HANDLE. In addition, all of these handles must have been created in this driver's\r
     Start() function, and the Start() function must have called OpenProtocol() on\r
     ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.\r
  \r
  @param[in]  This              A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle  A handle to the device being stopped. The handle must \r
                                support a bus specific I/O protocol for the driver \r
                                to use to stop the device.\r
  @param[in]  NumberOfChildren  The number of child device handles in ChildHandleBuffer.\r
  @param[in]  ChildHandleBuffer An array of child handles to be freed. May be NULL \r
                                if NumberOfChildren is 0.\r
\r
  @retval EFI_SUCCESS           The device was stopped.\r
  @retval EFI_DEVICE_ERROR      The device could not be stopped due to a device error.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AtaBusDriverBindingStop (\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
  BOOLEAN                     AllChildrenStopped;\r
  UINTN                       Index;\r
  ATA_BUS_DRIVER_DATA         *AtaBusDriverData;\r
\r
  if (NumberOfChildren == 0) {\r
    Status = gBS->OpenProtocol (\r
                    Controller,\r
                    &gEfiCallerIdGuid,\r
                    (VOID **) &AtaBusDriverData,\r
                    This->DriverBindingHandle,\r
                    Controller,\r
                    EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                    );\r
    if (!EFI_ERROR (Status)) {\r
      gBS->UninstallMultipleProtocolInterfaces (\r
            Controller,\r
            &gEfiCallerIdGuid,\r
            AtaBusDriverData,\r
            NULL\r
            );\r
      FreePool (AtaBusDriverData);\r
    }\r
\r
    gBS->CloseProtocol (\r
          Controller,\r
          &gEfiAtaPassThruProtocolGuid,\r
          This->DriverBindingHandle,\r
          Controller\r
          );\r
\r
    return EFI_SUCCESS;\r
  }\r
\r
  AllChildrenStopped = TRUE;\r
\r
  for (Index = 0; Index < NumberOfChildren; Index++) {\r
\r
    Status = UnregisterAtaDevice (This, Controller, ChildHandleBuffer[Index]);\r
    if (EFI_ERROR (Status)) {\r
      AllChildrenStopped = FALSE;\r
    }\r
  }\r
\r
  if (!AllChildrenStopped) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Reset the Block Device.\r
\r
  @param  This                 Indicates a pointer to the calling context.\r
  @param  ExtendedVerification Driver may perform diagnostics on reset.\r
\r
  @retval EFI_SUCCESS          The device was reset.\r
  @retval EFI_DEVICE_ERROR     The device is not functioning properly and could\r
                               not be reset.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AtaBlockIoReset (\r
  IN  EFI_BLOCK_IO_PROTOCOL   *This,\r
  IN  BOOLEAN                 ExtendedVerification\r
  )\r
{\r
  EFI_STATUS      Status;\r
  ATA_DEVICE      *AtaDevice;\r
  EFI_TPL         OldTpl;\r
\r
  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
  AtaDevice = ATA_DEVICE_FROM_BLOCK_IO (This);\r
\r
  Status = ResetAtaDevice (AtaDevice);  \r
\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
  }\r
\r
  gBS->RestoreTPL (OldTpl);\r
  return Status;\r
}\r
\r
\r
/**\r
  Read/Write BufferSize bytes from Lba from/into Buffer.\r
\r
  @param  This       Indicates a pointer to the calling context.\r
  @param  MediaId    The media ID that the read/write request is for.\r
  @param  Lba        The starting logical block address to be read/written. The caller is\r
                     responsible for reading/writing to only legitimate locations.\r
  @param  BufferSize Size of Buffer, must be a multiple of device block size.\r
  @param  Buffer     A pointer to the destination/source buffer for the data.\r
  @param  IsWrite    Indicates whether it is a write operation.\r
\r
  @retval EFI_SUCCESS           The data was read/written correctly to the device.\r
  @retval EFI_WRITE_PROTECTED   The device can not be read/written to.\r
  @retval EFI_DEVICE_ERROR      The device reported an error while performing the read/write.\r
  @retval EFI_NO_MEDIA          There is no media in the device.\r
  @retval EFI_MEDIA_CHNAGED     The MediaId does not matched the current device.\r
  @retval EFI_BAD_BUFFER_SIZE   The Buffer was not a multiple of the block size of the device.\r
  @retval EFI_INVALID_PARAMETER The read/write request contains LBAs that are not valid, \r
                                or the buffer is not on proper alignment.\r
\r
**/\r
EFI_STATUS\r
BlockIoReadWrite (\r
  IN  EFI_BLOCK_IO_PROTOCOL   *This,\r
  IN  UINT32                  MediaId,\r
  IN  EFI_LBA                 Lba,\r
  IN  UINTN                   BufferSize,\r
  OUT VOID                    *Buffer,\r
  IN  BOOLEAN                 IsWrite\r
  )\r
{\r
  ATA_DEVICE                        *AtaDevice;\r
  EFI_STATUS                        Status;\r
  EFI_TPL                           OldTpl;\r
  EFI_BLOCK_IO_MEDIA                *Media;\r
  UINTN                             BlockSize;\r
  UINTN                             NumberOfBlocks;\r
  UINTN                             IoAlign;\r
\r
  //\r
  // Check parameters.\r
  //\r
  Media = This->Media;\r
  if (MediaId != Media->MediaId) {\r
    return EFI_MEDIA_CHANGED;\r
  }\r
\r
  if (Buffer == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (BufferSize == 0) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  BlockSize = Media->BlockSize;\r
  if ((BufferSize % BlockSize) != 0) {\r
    return EFI_BAD_BUFFER_SIZE;\r
  }\r
  \r
  NumberOfBlocks  = BufferSize / BlockSize;\r
  if ((Lba + NumberOfBlocks - 1) > Media->LastBlock) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  IoAlign = Media->IoAlign;\r
  if (IoAlign > 0 && (((UINTN) Buffer & (IoAlign - 1)) != 0)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
  AtaDevice = ATA_DEVICE_FROM_BLOCK_IO (This);\r
  \r
  //\r
  // Invoke low level AtaDevice Access Routine.\r
  //\r
  Status = AccessAtaDevice (AtaDevice, Buffer, Lba, NumberOfBlocks, IsWrite);\r
 \r
  gBS->RestoreTPL (OldTpl);\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Read BufferSize bytes from Lba into Buffer.\r
\r
  @param  This       Indicates a pointer to the calling context.\r
  @param  MediaId    Id of the media, changes every time the media is replaced.\r
  @param  Lba        The starting Logical Block Address to read from\r
  @param  BufferSize Size of Buffer, must be a multiple of device block size.\r
  @param  Buffer     A pointer to the destination buffer for the data. The caller is\r
                     responsible for either having implicit or explicit ownership of the buffer.\r
\r
  @retval EFI_SUCCESS           The data was read correctly from the device.\r
  @retval EFI_DEVICE_ERROR      The device reported an error while performing the read.\r
  @retval EFI_NO_MEDIA          There is no media in the device.\r
  @retval EFI_MEDIA_CHANGED     The MediaId does not matched the current device.\r
  @retval EFI_BAD_BUFFER_SIZE   The Buffer was not a multiple of the block size of the device.\r
  @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid, \r
                                or the buffer is not on proper alignment.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AtaBlockIoReadBlocks (\r
  IN  EFI_BLOCK_IO_PROTOCOL   *This,\r
  IN  UINT32                  MediaId,\r
  IN  EFI_LBA                 Lba,\r
  IN  UINTN                   BufferSize,\r
  OUT VOID                    *Buffer\r
  )\r
{\r
  return BlockIoReadWrite (This, MediaId, Lba, BufferSize, Buffer, FALSE);\r
}\r
\r
\r
/**\r
  Write BufferSize bytes from Lba into Buffer.\r
\r
  @param  This       Indicates a pointer to the calling context.\r
  @param  MediaId    The media ID that the write request is for.\r
  @param  Lba        The starting logical block address to be written. The caller is\r
                     responsible for writing to only legitimate locations.\r
  @param  BufferSize Size of Buffer, must be a multiple of device block size.\r
  @param  Buffer     A pointer to the source buffer for the data.\r
\r
  @retval EFI_SUCCESS           The data was written correctly to the device.\r
  @retval EFI_WRITE_PROTECTED   The device can not be written to.\r
  @retval EFI_DEVICE_ERROR      The device reported an error while performing the write.\r
  @retval EFI_NO_MEDIA          There is no media in the device.\r
  @retval EFI_MEDIA_CHNAGED     The MediaId does not matched the current device.\r
  @retval EFI_BAD_BUFFER_SIZE   The Buffer was not a multiple of the block size of the device.\r
  @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid, \r
                                or the buffer is not on proper alignment.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AtaBlockIoWriteBlocks (\r
  IN  EFI_BLOCK_IO_PROTOCOL   *This,\r
  IN  UINT32                  MediaId,\r
  IN  EFI_LBA                 Lba,\r
  IN  UINTN                   BufferSize,\r
  IN  VOID                    *Buffer\r
  )\r
{\r
  return BlockIoReadWrite (This, MediaId, Lba, BufferSize, Buffer, TRUE);\r
}\r
\r
\r
/**\r
  Flush the Block Device.\r
\r
  @param  This              Indicates a pointer to the calling context.\r
\r
  @retval EFI_SUCCESS       All outstanding data was written to the device\r
  @retval EFI_DEVICE_ERROR  The device reported an error while writing back the data\r
  @retval EFI_NO_MEDIA      There is no media in the device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AtaBlockIoFlushBlocks (\r
  IN  EFI_BLOCK_IO_PROTOCOL   *This\r
  )\r
{\r
  //\r
  // return directly\r
  //\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Provides inquiry information for the controller type.\r
  \r
  This function is used by the IDE bus driver to get inquiry data.  Data format\r
  of Identify data is defined by the Interface GUID.\r
\r
  @param[in]      This             Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r
  @param[in, out] InquiryData      Pointer to a buffer for the inquiry data.\r
  @param[in, out] InquiryDataSize  Pointer to the value for the inquiry data size.\r
\r
  @retval EFI_SUCCESS            The command was accepted without any errors.\r
  @retval EFI_NOT_FOUND          Device does not support this data class \r
  @retval EFI_DEVICE_ERROR       Error reading InquiryData from device \r
  @retval EFI_BUFFER_TOO_SMALL   InquiryDataSize not big enough \r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AtaDiskInfoInquiry (\r
  IN     EFI_DISK_INFO_PROTOCOL   *This,\r
  IN OUT VOID                     *InquiryData,\r
  IN OUT UINT32                   *InquiryDataSize\r
  )\r
{\r
  return EFI_NOT_FOUND;\r
}\r
\r
\r
/**\r
  Provides identify information for the controller type.\r
\r
  This function is used by the IDE bus driver to get identify data.  Data format\r
  of Identify data is defined by the Interface GUID.\r
\r
  @param[in]      This              Pointer to the EFI_DISK_INFO_PROTOCOL \r
                                    instance.\r
  @param[in, out] IdentifyData      Pointer to a buffer for the identify data.\r
  @param[in, out] IdentifyDataSize  Pointer to the value for the identify data\r
                                    size.\r
\r
  @retval EFI_SUCCESS            The command was accepted without any errors.\r
  @retval EFI_NOT_FOUND          Device does not support this data class \r
  @retval EFI_DEVICE_ERROR       Error reading IdentifyData from device \r
  @retval EFI_BUFFER_TOO_SMALL   IdentifyDataSize not big enough \r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AtaDiskInfoIdentify (\r
  IN     EFI_DISK_INFO_PROTOCOL   *This,\r
  IN OUT VOID                     *IdentifyData,\r
  IN OUT UINT32                   *IdentifyDataSize\r
  )\r
{\r
  EFI_STATUS                      Status;\r
  ATA_DEVICE                      *AtaDevice;\r
\r
  AtaDevice = ATA_DEVICE_FROM_DISK_INFO (This);\r
\r
  Status = EFI_BUFFER_TOO_SMALL;\r
  if (*IdentifyDataSize >= sizeof (*AtaDevice->IdentifyData)) {\r
    Status = EFI_SUCCESS;\r
    CopyMem (IdentifyData, AtaDevice->IdentifyData, sizeof (*AtaDevice->IdentifyData));\r
  }\r
  *IdentifyDataSize = sizeof (*AtaDevice->IdentifyData);\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Provides sense data information for the controller type.\r
  \r
  This function is used by the IDE bus driver to get sense data. \r
  Data format of Sense data is defined by the Interface GUID.\r
\r
  @param[in]      This             Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r
  @param[in, out] SenseData        Pointer to the SenseData.\r
  @param[in, out] SenseDataSize    Size of SenseData in bytes.\r
  @param[out]     SenseDataNumber  Pointer to the value for the sense data size.\r
\r
  @retval EFI_SUCCESS            The command was accepted without any errors.\r
  @retval EFI_NOT_FOUND          Device does not support this data class.\r
  @retval EFI_DEVICE_ERROR       Error reading SenseData from device.\r
  @retval EFI_BUFFER_TOO_SMALL   SenseDataSize not big enough.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AtaDiskInfoSenseData (\r
  IN     EFI_DISK_INFO_PROTOCOL   *This,\r
  IN OUT VOID                     *SenseData,\r
  IN OUT UINT32                   *SenseDataSize,\r
  OUT    UINT8                    *SenseDataNumber\r
  )\r
{\r
  return EFI_NOT_FOUND;\r
}\r
\r
\r
/**\r
  This function is used by the IDE bus driver to get controller information.\r
\r
  @param[in]  This         Pointer to the EFI_DISK_INFO_PROTOCOL instance. \r
  @param[out] IdeChannel   Pointer to the Ide Channel number.  Primary or secondary.\r
  @param[out] IdeDevice    Pointer to the Ide Device number.  Master or slave.\r
\r
  @retval EFI_SUCCESS       IdeChannel and IdeDevice are valid.\r
  @retval EFI_UNSUPPORTED   This is not an IDE device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AtaDiskInfoWhichIde (\r
  IN  EFI_DISK_INFO_PROTOCOL   *This,\r
  OUT UINT32                   *IdeChannel,\r
  OUT UINT32                   *IdeDevice\r
  )\r
{\r
  ATA_DEVICE                   *AtaDevice;\r
\r
  AtaDevice       = ATA_DEVICE_FROM_DISK_INFO (This);\r
  *IdeChannel     = AtaDevice->Port;\r
  *IdeDevice      = AtaDevice->PortMultiplierPort;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  The user Entry Point for module AtaBus. The user code starts with this function.\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
InitializeAtaBus(\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
             &gAtaBusDriverBinding,\r
             ImageHandle,\r
             &gAtaBusComponentName,\r
             &gAtaBusComponentName2\r
             );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return Status;\r
}\r