[mirror_edk2.git] / MdeModulePkg / Bus / Usb / UsbMassStorageDxe / UsbMassImpl.c

/** @file\r
\r
  The implementation of USB mass storage class device driver.\r
  The command set supported is "USB Mass Storage Specification\r
  for Bootability".\r
\r
Copyright (c) 2007 - 2008, Intel Corporation\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
\r
#include "UsbMassImpl.h"\r
\r
USB_MASS_TRANSPORT *mUsbMassTransport[] = {\r
  &mUsbCbi0Transport,\r
  &mUsbCbi1Transport,\r
  &mUsbBotTransport,\r
  NULL\r
};\r
\r
/**\r
  Reset the block device. ExtendedVerification is ignored for this.\r
\r
  @param  This                   The BLOCK IO protocol\r
  @param  ExtendedVerification   Whether to execute extended verification.\r
\r
  @retval EFI_SUCCESS            The device is successfully reseted.\r
  @retval Others                 Failed to reset the device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbMassReset (\r
  IN EFI_BLOCK_IO_PROTOCOL    *This,\r
  IN BOOLEAN                  ExtendedVerification\r
  )\r
{\r
  USB_MASS_DEVICE *UsbMass;\r
  EFI_TPL         OldTpl;\r
  EFI_STATUS      Status;\r
\r
  OldTpl  = gBS->RaiseTPL (USB_MASS_TPL);\r
\r
  UsbMass = USB_MASS_DEVICE_FROM_BLOCKIO (This);\r
  Status  = UsbMass->Transport->Reset (UsbMass->Context, ExtendedVerification);\r
\r
  gBS->RestoreTPL (OldTpl);\r
\r
  return Status;\r
}\r
\r
/**\r
  Read some blocks of data from the block device.\r
\r
  @param  This                   The Block IO protocol\r
  @param  MediaId                The media's ID of the device for current request\r
  @param  Lba                    The start block number\r
  @param  BufferSize             The size of buffer to read data in\r
  @param  Buffer                 The buffer to read data to\r
\r
  @retval EFI_SUCCESS            The data is successfully read\r
  @retval EFI_NO_MEDIA           Media isn't present\r
  @retval EFI_MEDIA_CHANGED      The device media has been changed, that is,\r
                                 MediaId changed\r
  @retval EFI_INVALID_PARAMETER  Some parameters are invalid, such as Buffer is\r
                                 NULL.\r
  @retval EFI_BAD_BUFFER_SIZE    The buffer size isn't a multiple of media's block\r
                                 size,  or overflow the last block number.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbMassReadBlocks (\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
  USB_MASS_DEVICE     *UsbMass;\r
  EFI_BLOCK_IO_MEDIA  *Media;\r
  EFI_STATUS          Status;\r
  EFI_TPL             OldTpl;\r
  UINTN               TotalBlock;\r
\r
  OldTpl  = gBS->RaiseTPL (USB_MASS_TPL);\r
  UsbMass = USB_MASS_DEVICE_FROM_BLOCKIO (This);\r
  Media   = &UsbMass->BlockIoMedia;\r
\r
  //\r
  // First, validate the parameters\r
  //\r
  if ((Buffer == NULL) || (BufferSize == 0)) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto ON_EXIT;\r
  }\r
\r
  //\r
  // If it is a removable media, such as CD-Rom or Usb-Floppy,\r
  // need to detect the media before each rw. While some of\r
  // Usb-Flash is marked as removable media.\r
  //\r
  //\r
  if (Media->RemovableMedia == TRUE) {\r
    Status = UsbBootDetectMedia (UsbMass);\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((EFI_D_ERROR, "UsbMassReadBlocks: UsbBootDetectMedia (%r)\n", Status));\r
      goto ON_EXIT;\r
    }\r
  }\r
\r
  //\r
  // Make sure BlockSize and LBA is consistent with BufferSize\r
  //\r
  if ((BufferSize % Media->BlockSize) != 0) {\r
    Status = EFI_BAD_BUFFER_SIZE;\r
    goto ON_EXIT;\r
  }\r
\r
  TotalBlock = BufferSize / Media->BlockSize;\r
\r
  if (Lba + TotalBlock - 1 > Media->LastBlock) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto ON_EXIT;\r
  }\r
\r
  if (!(Media->MediaPresent)) {\r
    Status = EFI_NO_MEDIA;\r
    goto ON_EXIT;\r
  }\r
\r
  if (MediaId != Media->MediaId) {\r
    Status = EFI_MEDIA_CHANGED;\r
    goto ON_EXIT;\r
  }\r
\r
  Status = UsbBootReadBlocks (UsbMass, (UINT32) Lba, TotalBlock, Buffer);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((EFI_D_ERROR, "UsbMassReadBlocks: UsbBootReadBlocks (%r) -> Reset\n", Status));\r
    UsbMassReset (This, TRUE);\r
  }\r
\r
ON_EXIT:\r
  gBS->RestoreTPL (OldTpl);\r
  return Status;\r
}\r
\r
\r
/**\r
  Write some blocks of data to the block device.\r
\r
  @param  This                   The Block IO protocol\r
  @param  MediaId                The media's ID of the device for current request\r
  @param  Lba                    The start block number\r
  @param  BufferSize             The size of buffer to write data to\r
  @param  Buffer                 The buffer to write data to\r
\r
  @retval EFI_SUCCESS            The data is successfully written\r
  @retval EFI_NO_MEDIA           Media isn't present\r
  @retval EFI_MEDIA_CHANGED      The device media has been changed, that is,\r
                                 MediaId changed\r
  @retval EFI_INVALID_PARAMETER  Some parameters are invalid, such as Buffer is\r
                                 NULL.\r
  @retval EFI_BAD_BUFFER_SIZE    The buffer size isn't a multiple of media's block\r
                                 size,\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbMassWriteBlocks (\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
  USB_MASS_DEVICE     *UsbMass;\r
  EFI_BLOCK_IO_MEDIA  *Media;\r
  EFI_STATUS          Status;\r
  EFI_TPL             OldTpl;\r
  UINTN               TotalBlock;\r
\r
  OldTpl  = gBS->RaiseTPL (USB_MASS_TPL);\r
  UsbMass = USB_MASS_DEVICE_FROM_BLOCKIO (This);\r
  Media   = &UsbMass->BlockIoMedia;\r
\r
  //\r
  // First, validate the parameters\r
  //\r
  if ((Buffer == NULL) || (BufferSize == 0)) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto ON_EXIT;\r
  }\r
\r
  //\r
  // If it is a removable media, such as CD-Rom or Usb-Floppy,\r
  // need to detect the media before each rw. While some of\r
  // Usb-Flash is marked as removable media.\r
  //\r
  //\r
  if (Media->RemovableMedia == TRUE) {\r
    Status = UsbBootDetectMedia (UsbMass);\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((EFI_D_ERROR, "UsbMassWriteBlocks: UsbBootDetectMedia (%r)\n", Status));\r
      goto ON_EXIT;\r
    }\r
  }\r
\r
  //\r
  // Make sure BlockSize and LBA is consistent with BufferSize\r
  //\r
  if ((BufferSize % Media->BlockSize) != 0) {\r
    Status = EFI_BAD_BUFFER_SIZE;\r
    goto ON_EXIT;\r
  }\r
\r
  TotalBlock = BufferSize / Media->BlockSize;\r
\r
  if (Lba + TotalBlock - 1 > Media->LastBlock) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto ON_EXIT;\r
  }\r
\r
  if (!(Media->MediaPresent)) {\r
    Status = EFI_NO_MEDIA;\r
    goto ON_EXIT;\r
  }\r
\r
  if (MediaId != Media->MediaId) {\r
    Status = EFI_MEDIA_CHANGED;\r
    goto ON_EXIT;\r
  }\r
\r
  //\r
  // Try to write the data even the device is marked as ReadOnly,\r
  // and clear the status should the write succeed.\r
  //\r
  Status = UsbBootWriteBlocks (UsbMass, (UINT32) Lba, TotalBlock, Buffer);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((EFI_D_ERROR, "UsbMassWriteBlocks: UsbBootWriteBlocks (%r) -> Reset\n", Status));\r
    UsbMassReset (This, TRUE);\r
  }\r
\r
ON_EXIT:\r
  gBS->RestoreTPL (OldTpl);\r
  return Status;\r
}\r
\r
/**\r
  Flush the cached writes to disks. USB mass storage device doesn't\r
  support write cache, so return EFI_SUCCESS directly.\r
\r
  @param  This                   The BLOCK IO protocol\r
\r
  @retval EFI_SUCCESS            Always returns success\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UsbMassFlushBlocks (\r
  IN EFI_BLOCK_IO_PROTOCOL  *This\r
  )\r
{\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Retrieve the media parameters such as disk geometric for the\r
  device's BLOCK IO protocol.\r
\r
  @param  UsbMass                The USB mass storage device\r
\r
  @retval EFI_SUCCESS            The media parameters is updated successfully.\r
  @retval Others                 Failed to get the media parameters.\r
\r
**/\r
EFI_STATUS\r
UsbMassInitMedia (\r
  IN USB_MASS_DEVICE          *UsbMass\r
  )\r
{\r
  EFI_BLOCK_IO_MEDIA          *Media;\r
  EFI_STATUS                  Status;\r
  UINTN                       Index;\r
\r
  Media = &UsbMass->BlockIoMedia;\r
\r
  //\r
  // Initialize the MediaPrsent/ReadOnly and others to the default.\r
  // We are not forced to get it right at this time, check UEFI2.0\r
  // spec for more information:\r
  //\r
  // MediaPresent: This field shows the media present status as\r
  //               of the most recent ReadBlocks or WriteBlocks call.\r
  //\r
  // ReadOnly    : This field shows the read-only status as of the\r
  //               recent WriteBlocks call.\r
  //\r
  // but remember to update MediaId/MediaPresent/ReadOnly status\r
  // after ReadBlocks and WriteBlocks\r
  //\r
  Media->MediaPresent     = FALSE;\r
  Media->LogicalPartition = FALSE;\r
  Media->ReadOnly         = FALSE;\r
  Media->WriteCaching     = FALSE;\r
  Media->IoAlign          = 0;\r
  Media->MediaId          = 1;\r
\r
  //\r
  // Some device may spend several seconds before it is ready.\r
  // Try several times before giving up. Wait 5s at most.\r
  //\r
  Status = EFI_SUCCESS;\r
\r
  for (Index = 0; Index < USB_BOOT_INIT_MEDIA_RETRY; Index++) {\r
\r
    Status = UsbBootGetParams (UsbMass);\r
    if ((Status != EFI_MEDIA_CHANGED)\r
        && (Status != EFI_NOT_READY)\r
        && (Status != EFI_TIMEOUT)) {\r
      break;\r
    }\r
\r
    Status = UsbBootIsUnitReady (UsbMass);\r
    if (EFI_ERROR (Status)) {\r
      gBS->Stall (USB_BOOT_RETRY_UNIT_READY_STALL * (Index + 1));\r
    }\r
\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Initilize the transport.\r
\r
  @param  This            The USB mass driver's driver binding.\r
  @param  Controller      The device to test.\r
  @param  Transport       The pointer to pointer to USB_MASS_TRANSPORT.\r
  @param  Context         The passing parameter.\r
  @param  MaxLun          Get the MaxLun if is BOT dev.\r
\r
  @retval EFI_SUCCESS     The initialization is successful.\r
  @retval Others          Failed to initialize dev.\r
\r
**/\r
EFI_STATUS\r
UsbMassInitTransport (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN  EFI_HANDLE                   Controller,\r
  OUT USB_MASS_TRANSPORT           **Transport,\r
  OUT VOID                         **Context,\r
  OUT UINT8                        *MaxLun\r
  )\r
{\r
  EFI_USB_IO_PROTOCOL           *UsbIo;\r
  EFI_USB_INTERFACE_DESCRIPTOR  Interface;\r
  UINT8                         Index;\r
  EFI_STATUS                    Status;\r
 \r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiUsbIoProtocolGuid,\r
                  (VOID **) &UsbIo,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((EFI_D_ERROR, "UsbMassInitTransport: OpenUsbIoProtocol By Driver (%r)\n", Status));\r
    return Status;\r
  }\r
  \r
  Status = UsbIo->UsbGetInterfaceDescriptor (UsbIo, &Interface);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((EFI_D_ERROR, "UsbMassInitTransport: UsbIo->UsbGetInterfaceDescriptor (%r)\n", Status));\r
    goto ON_EXIT;\r
  }\r
  \r
  Status = EFI_UNSUPPORTED;\r
\r
  for (Index = 0; mUsbMassTransport[Index] != NULL; Index++) {\r
    *Transport = mUsbMassTransport[Index];\r
\r
    if (Interface.InterfaceProtocol == (*Transport)->Protocol) {\r
      Status  = (*Transport)->Init (UsbIo, Context);\r
      break;\r
    }\r
  }\r
\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((EFI_D_ERROR, "UsbMassInitTransport: Transport->Init (%r)\n", Status));\r
    goto ON_EXIT;\r
  }\r
\r
  //\r
  // For bot device, try to get max lun. \r
  // If maxlun=0, then non-lun device, else multi-lun device.\r
  //\r
  if ((*Transport)->Protocol == USB_MASS_STORE_BOT) {\r
    (*Transport)->GetMaxLun (*Context, MaxLun);\r
    DEBUG ((EFI_D_INFO, "UsbMassInitTransport: GetMaxLun = %d\n", *MaxLun));\r
  }\r
\r
ON_EXIT:\r
  gBS->CloseProtocol (\r
         Controller,\r
         &gEfiUsbIoProtocolGuid,\r
         This->DriverBindingHandle,\r
         Controller\r
         );\r
  return Status;  \r
}\r
\r
/**\r
  Usb mass storage driver initializes multi lun.\r
\r
  @param  This            The USB mass driver's driver binding.\r
  @param  Controller      The device to test.\r
  @param  Transport       The pointer to USB_MASS_TRANSPORT.\r
  @param  Context         The passing parameter.\r
  @param  DevicePath      The remaining device path\r
  @param  MaxLun          The MaxLun number passed.\r
\r
  @retval EFI_SUCCESS     Initialization is success.\r
  @retval Other           Initialization fails.\r
\r
**/\r
EFI_STATUS\r
UsbMassInitMultiLun (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                    Controller,\r
  IN USB_MASS_TRANSPORT            *Transport,\r
  IN VOID                          *Context,\r
  IN EFI_DEVICE_PATH_PROTOCOL      *DevicePath,\r
  IN UINT8                         MaxLun\r
  )\r
{\r
  USB_MASS_DEVICE                  *UsbMass;\r
  EFI_USB_IO_PROTOCOL              *UsbIo;\r
  DEVICE_LOGICAL_UNIT_DEVICE_PATH  LunNode;\r
  UINT8                            Index;\r
  EFI_STATUS                       Status;\r
\r
  ASSERT (MaxLun > 0);\r
\r
  for (Index = 0; Index <= MaxLun; Index++) { \r
\r
    DEBUG ((EFI_D_INFO, "UsbMassInitMultiLun: Start to initialize No.%d logic unit\n", Index));\r
    \r
    UsbIo   = NULL;\r
    UsbMass = AllocateZeroPool (sizeof (USB_MASS_DEVICE));\r
    if (UsbMass == NULL) {\r
      Status = EFI_OUT_OF_RESOURCES;\r
      goto ON_ERROR;\r
    }\r
      \r
    UsbMass->Signature            = USB_MASS_SIGNATURE;\r
    UsbMass->UsbIo                = UsbIo;\r
    UsbMass->BlockIo.Media        = &UsbMass->BlockIoMedia;\r
    UsbMass->BlockIo.Reset        = UsbMassReset;\r
    UsbMass->BlockIo.ReadBlocks   = UsbMassReadBlocks;\r
    UsbMass->BlockIo.WriteBlocks  = UsbMassWriteBlocks;\r
    UsbMass->BlockIo.FlushBlocks  = UsbMassFlushBlocks;\r
    UsbMass->OpticalStorage       = FALSE;\r
    UsbMass->Transport            = Transport;\r
    UsbMass->Context              = Context;\r
    UsbMass->Lun                  = Index;\r
    \r
    //\r
    // Get the storage's parameters, such as last block number.\r
    // then install the BLOCK_IO\r
    //\r
    Status = UsbMassInitMedia (UsbMass);\r
    if (!EFI_ERROR (Status)) {\r
      if ((UsbMass->Pdt != USB_PDT_DIRECT_ACCESS) && \r
           (UsbMass->Pdt != USB_PDT_CDROM) &&\r
           (UsbMass->Pdt != USB_PDT_OPTICAL) && \r
           (UsbMass->Pdt != USB_PDT_SIMPLE_DIRECT)) {\r
        DEBUG ((EFI_D_ERROR, "UsbMassInitMultiLun: Found an unsupported peripheral type[%d]\n", UsbMass->Pdt));\r
        goto ON_ERROR;\r
      }\r
    } else if (Status != EFI_NO_MEDIA){\r
      DEBUG ((EFI_D_ERROR, "UsbMassInitMultiLun: UsbMassInitMedia (%r)\n", Status));\r
      goto ON_ERROR;\r
    }\r
\r
    //\r
    // Create a device path node of device logic unit, and append it \r
    //\r
    LunNode.Header.Type    = MESSAGING_DEVICE_PATH;\r
    LunNode.Header.SubType = MSG_DEVICE_LOGICAL_UNIT_DP;\r
    LunNode.Lun            = UsbMass->Lun;\r
  \r
    SetDevicePathNodeLength (&LunNode.Header, sizeof (LunNode));\r
  \r
    UsbMass->DevicePath = AppendDevicePathNode (DevicePath, &LunNode.Header);\r
  \r
    if (UsbMass->DevicePath == NULL) {\r
      DEBUG ((EFI_D_ERROR, "UsbMassInitMultiLun: failed to create device logic unit device path\n"));\r
  \r
      Status = EFI_OUT_OF_RESOURCES;\r
      goto ON_ERROR;\r
    }\r
\r
    //\r
    // Create a UsbMass handle for each lun, and install blockio and devicepath protocols.\r
    //\r
    Status = gBS->InstallMultipleProtocolInterfaces (\r
                    &UsbMass->Controller,\r
                    &gEfiDevicePathProtocolGuid,\r
                    UsbMass->DevicePath,\r
                    &gEfiBlockIoProtocolGuid,\r
                    &UsbMass->BlockIo,\r
                    NULL\r
                    );\r
    \r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((EFI_D_ERROR, "UsbMassInitMultiLun: InstallMultipleProtocolInterfaces (%r)\n", Status));\r
      goto ON_ERROR;\r
    }\r
\r
    //\r
    // Open UsbIo protocol by child to setup a parent-child relationship.\r
    //\r
    Status = gBS->OpenProtocol (\r
                    Controller,\r
                    &gEfiUsbIoProtocolGuid,\r
                    (VOID **) &UsbIo,\r
                    This->DriverBindingHandle,\r
                    UsbMass->Controller,\r
                    EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
                    );\r
\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((EFI_D_ERROR, "UsbMassInitMultiLun: OpenUsbIoProtocol By Child (%r)\n", Status));\r
      gBS->UninstallMultipleProtocolInterfaces (\r
             &UsbMass->Controller,\r
             &gEfiDevicePathProtocolGuid,\r
             UsbMass->DevicePath,\r
             &gEfiBlockIoProtocolGuid,\r
             &UsbMass->BlockIo,\r
             NULL\r
             );\r
      goto ON_ERROR;\r
    }\r
    \r
    DEBUG ((EFI_D_INFO, "UsbMassInitMultiLun: Success to initialize No.%d logic unit\n", Index));\r
  }\r
  \r
  return EFI_SUCCESS;\r
\r
ON_ERROR:\r
  if (UsbMass->DevicePath != NULL) {\r
    gBS->FreePool (UsbMass->DevicePath);\r
  }\r
  if (UsbMass != NULL) {\r
    gBS->FreePool (UsbMass);\r
  }\r
  if (UsbIo != NULL) {\r
    gBS->CloseProtocol (\r
           Controller,\r
           &gEfiUsbIoProtocolGuid,\r
           This->DriverBindingHandle,\r
           UsbMass->Controller\r
           );\r
  }\r
\r
  //\r
  // If only success to initialize one lun, return success, or else return error\r
  //\r
  if (Index > 0) {\r
    return EFI_SUCCESS; \r
  } else {\r
    return Status;\r
  } \r
}\r
\r
/**\r
  Initialize No/Unsupported LUN device.\r
\r
  @param This             The USB mass driver's driver binding.\r
  @param Controller       The device to test.\r
  @param Transport        The pointer to USB_MASS_TRANSPORT.\r
  @param Context          The passing parameter.\r
\r
  @retval EFI_SUCCESS     Initialization is success.\r
  @retval Other           Initialization fails.\r
\r
**/\r
EFI_STATUS\r
UsbMassInitNonLun (\r
  IN EFI_DRIVER_BINDING_PROTOCOL   *This,\r
  IN EFI_HANDLE                    Controller,\r
  IN USB_MASS_TRANSPORT            *Transport,\r
  IN VOID                          *Context\r
  )\r
{\r
  USB_MASS_DEVICE             *UsbMass;\r
  EFI_USB_IO_PROTOCOL         *UsbIo;\r
  EFI_STATUS                  Status;\r
\r
  UsbIo   = NULL;\r
  UsbMass = AllocateZeroPool (sizeof (USB_MASS_DEVICE));\r
  if (UsbMass == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiUsbIoProtocolGuid,\r
                  (VOID **) &UsbIo,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((EFI_D_ERROR, "UsbMassInitNonLun: OpenUsbIoProtocol By Driver (%r)\n", Status));\r
    goto ON_ERROR;\r
  }\r
  \r
  UsbMass->Signature            = USB_MASS_SIGNATURE;\r
  UsbMass->Controller           = Controller;\r
  UsbMass->UsbIo                = UsbIo;\r
  UsbMass->BlockIo.Media        = &UsbMass->BlockIoMedia;\r
  UsbMass->BlockIo.Reset        = UsbMassReset;\r
  UsbMass->BlockIo.ReadBlocks   = UsbMassReadBlocks;\r
  UsbMass->BlockIo.WriteBlocks  = UsbMassWriteBlocks;\r
  UsbMass->BlockIo.FlushBlocks  = UsbMassFlushBlocks;\r
  UsbMass->OpticalStorage       = FALSE;\r
  UsbMass->Transport            = Transport;\r
  UsbMass->Context              = Context;\r
  \r
  //\r
  // Get the storage's parameters, such as last block number.\r
  // then install the BLOCK_IO\r
  //\r
  Status = UsbMassInitMedia (UsbMass);\r
  if (!EFI_ERROR (Status)) {\r
    if ((UsbMass->Pdt != USB_PDT_DIRECT_ACCESS) && \r
         (UsbMass->Pdt != USB_PDT_CDROM) &&\r
         (UsbMass->Pdt != USB_PDT_OPTICAL) && \r
         (UsbMass->Pdt != USB_PDT_SIMPLE_DIRECT)) {\r
      DEBUG ((EFI_D_ERROR, "UsbMassInitNonLun: Found an unsupported peripheral type[%d]\n", UsbMass->Pdt));\r
      goto ON_ERROR;\r
    }\r
  } else if (Status != EFI_NO_MEDIA){\r
    DEBUG ((EFI_D_ERROR, "UsbMassInitNonLun: UsbMassInitMedia (%r)\n", Status));\r
    goto ON_ERROR;\r
  }\r
    \r
  Status = gBS->InstallProtocolInterface (\r
                  &Controller,\r
                  &gEfiBlockIoProtocolGuid,\r
                  EFI_NATIVE_INTERFACE,\r
                  &UsbMass->BlockIo\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  return EFI_SUCCESS;\r
\r
ON_ERROR:\r
  if (UsbMass != NULL) {\r
    gBS->FreePool (UsbMass);\r
  }\r
  gBS->CloseProtocol (\r
         Controller,\r
         &gEfiUsbIoProtocolGuid,\r
         This->DriverBindingHandle,\r
         Controller\r
         );\r
  return Status;  \r
}\r
\r
\r
/**\r
  Check whether the controller is a supported USB mass storage.\r
\r
  @param  This                   The USB mass driver's driver binding.\r
  @param  Controller             The device to test against.\r
  @param  RemainingDevicePath    The remaining device path\r
\r
  @retval EFI_SUCCESS            This device is a supported USB mass storage.\r
  @retval EFI_UNSUPPORTED        The device isn't supported\r
  @retval Others                 Some error happened.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
USBMassDriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  )\r
{\r
  EFI_USB_IO_PROTOCOL           *UsbIo;\r
  EFI_USB_INTERFACE_DESCRIPTOR  Interface;\r
  USB_MASS_TRANSPORT            *Transport;\r
  EFI_STATUS                    Status;\r
  INTN                          Index;\r
\r
  //\r
  // Check whether the controller support USB_IO\r
  //\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiUsbIoProtocolGuid,\r
                  (VOID **) &UsbIo,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Get the interface to check the USB class and find a transport\r
  // protocol handler.\r
  //\r
  Status = UsbIo->UsbGetInterfaceDescriptor (UsbIo, &Interface);\r
  if (EFI_ERROR (Status)) {\r
    goto ON_EXIT;\r
  }\r
\r
  Status = EFI_UNSUPPORTED;\r
\r
  if (Interface.InterfaceClass != USB_MASS_STORE_CLASS) {\r
    goto ON_EXIT;\r
  }\r
\r
  for (Index = 0; mUsbMassTransport[Index] != NULL; Index++) {\r
    Transport = mUsbMassTransport[Index];\r
    if (Interface.InterfaceProtocol == Transport->Protocol) {\r
      Status = Transport->Init (UsbIo, NULL);\r
      break;\r
    }\r
  }\r
\r
  DEBUG ((EFI_D_INFO, "Found a USB mass store device %r\n", Status));\r
\r
ON_EXIT:\r
  gBS->CloseProtocol (\r
        Controller,\r
        &gEfiUsbIoProtocolGuid,\r
        This->DriverBindingHandle,\r
        Controller\r
        );\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Start the USB mass storage device on the controller. It will\r
  install a BLOCK_IO protocol on the device if everything is OK.\r
\r
  @param  This                   The USB mass storage driver binding.\r
  @param  Controller             The USB mass storage device to start on\r
  @param  RemainingDevicePath    The remaining device path.\r
\r
  @retval EFI_SUCCESS            The driver has started on the device.\r
  @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory\r
  @retval Others                 Failed to start the driver on the device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
USBMassDriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  )\r
{\r
  USB_MASS_TRANSPORT            *Transport;\r
  EFI_DEVICE_PATH_PROTOCOL      *DevicePath;\r
  VOID                          *Context;\r
  UINT8                         MaxLun;\r
  EFI_STATUS                    Status;\r
  \r
  Transport = NULL;\r
  Context   = NULL;\r
  MaxLun    = 0;\r
\r
  //\r
  // Get interface and protocols, initialize transport\r
  //\r
  Status = UsbMassInitTransport (This, Controller, &Transport, &Context, &MaxLun);\r
\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((EFI_D_ERROR, "USBMassDriverBindingStart: UsbMassInitTransport (%r)\n", Status));\r
    return Status;\r
  }\r
  if (MaxLun == 0) {\r
    //\r
    // Initialize No/Unsupported LUN device\r
    //\r
    Status = UsbMassInitNonLun(This, Controller, Transport, Context);\r
    if (EFI_ERROR (Status)) { \r
      DEBUG ((EFI_D_ERROR, "USBMassDriverBindingStart: UsbMassInitNonLun (%r)\n", Status));\r
    }\r
  } else {\r
    //\r
    // Open device path to prepare append Device Logic Unit node.\r
    //\r
    Status = gBS->OpenProtocol (\r
                    Controller,\r
                    &gEfiDevicePathProtocolGuid,\r
                    (VOID **) &DevicePath,\r
                    This->DriverBindingHandle,\r
                    Controller,\r
                    EFI_OPEN_PROTOCOL_BY_DRIVER\r
                    );\r
  \r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((EFI_D_ERROR, "USBMassDriverBindingStart: OpenDevicePathProtocol By Driver (%r)\n", Status));\r
      return Status;\r
    }\r
\r
    //\r
    // Try best to initialize all LUNs, and return success only if one of LUNs successed to initialized.\r
    //\r
    Status = UsbMassInitMultiLun(This, Controller, Transport, Context, DevicePath, MaxLun);\r
    if (EFI_ERROR (Status)) {\r
     gBS->CloseProtocol (\r
            Controller,\r
            &gEfiDevicePathProtocolGuid,\r
            This->DriverBindingHandle,\r
            Controller\r
            );\r
      DEBUG ((EFI_D_ERROR, "USBMassDriverBindingStart: UsbMassInitMultiLun (%r) with Maxlun=%d\n", Status, MaxLun));\r
    }\r
  }\r
  return Status;\r
}\r
\r
\r
/**\r
  Stop controlling the device.\r
\r
  @param  This                   The USB mass storage driver binding\r
  @param  Controller             The device controller controlled by the driver.\r
  @param  NumberOfChildren       The number of children of this device\r
  @param  ChildHandleBuffer      The buffer of children handle.\r
\r
  @retval EFI_SUCCESS            The driver stopped from controlling the device.\r
  @retval Others                 Failed to stop the driver\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
USBMassDriverBindingStop (\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
  USB_MASS_DEVICE       *UsbMass;\r
  EFI_USB_IO_PROTOCOL     *UsbIo;\r
  EFI_BLOCK_IO_PROTOCOL *BlockIo;\r
  UINTN                   Index;\r
  BOOLEAN                 AllChildrenStopped;\r
\r
  //\r
  // This a bus driver stop function since multi-lun supported. There are three \r
  // kinds of device handle might be passed, 1st is a handle with devicepath/\r
  // usbio/blockio installed(non-multi-lun), 2nd is a handle with devicepath/\r
  // usbio installed(multi-lun root), 3rd is a handle with devicepath/blockio\r
  // installed(multi-lun).\r
  //\r
  if (NumberOfChildren == 0) {\r
    //\r
    // A handle without any children, might be 1st and 2nd type.\r
    //\r
    Status = gBS->OpenProtocol (\r
                    Controller,\r
                    &gEfiBlockIoProtocolGuid,\r
                    (VOID **) &BlockIo,\r
                    This->DriverBindingHandle,\r
                    Controller,\r
                    EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                    );\r
  \r
    if (EFI_ERROR(Status)) {\r
      //\r
      // This is a 2nd type handle(multi-lun root), which only needs close \r
      // devicepath protocol.\r
      //\r
      gBS->CloseProtocol (\r
            Controller,\r
            &gEfiDevicePathProtocolGuid,\r
            This->DriverBindingHandle,\r
            Controller\r
            );\r
      DEBUG ((EFI_D_INFO, "Success to stop multi-lun root handle\n"));\r
      return EFI_SUCCESS;\r
    }\r
    \r
    //\r
    // This is a 1st type handle(non-multi-lun), which only needs uninstall\r
    // blockio protocol, close usbio protocol and free mass device.\r
    //\r
    UsbMass = USB_MASS_DEVICE_FROM_BLOCKIO (BlockIo);\r
  \r
    //\r
    // Uninstall Block I/O protocol from the device handle,\r
    // then call the transport protocol to stop itself.\r
    //\r
    Status = gBS->UninstallProtocolInterface (\r
                    Controller,\r
                    &gEfiBlockIoProtocolGuid,\r
                    &UsbMass->BlockIo\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
  \r
    gBS->CloseProtocol (\r
          Controller,\r
          &gEfiUsbIoProtocolGuid,\r
          This->DriverBindingHandle,\r
          Controller\r
          );\r
  \r
    UsbMass->Transport->Fini (UsbMass->Context);\r
    gBS->FreePool (UsbMass);\r
    \r
    DEBUG ((EFI_D_INFO, "Success to stop non-multi-lun root handle\n"));\r
    return EFI_SUCCESS;\r
  } \r
\r
  //\r
  // This is a 3rd type handle(multi-lun), which needs uninstall\r
  // blockio and devicepath protocol, close usbio protocol and \r
  // free mass device.\r
  //\r
  AllChildrenStopped = TRUE;\r
\r
  for (Index = 0; Index < NumberOfChildren; Index++) {\r
\r
    Status = gBS->OpenProtocol (\r
                    ChildHandleBuffer[Index],\r
                    &gEfiBlockIoProtocolGuid,\r
                    (VOID **) &BlockIo,\r
                    This->DriverBindingHandle,\r
                    Controller,\r
                    EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      AllChildrenStopped = FALSE;\r
      DEBUG ((EFI_D_ERROR, "Fail to stop No.%d multi-lun child handle when opening blockio\n", (UINT32)Index));\r
      continue;\r
    }\r
\r
    UsbMass = USB_MASS_DEVICE_FROM_BLOCKIO (BlockIo);\r
\r
    gBS->CloseProtocol (\r
          Controller,\r
          &gEfiUsbIoProtocolGuid,\r
          This->DriverBindingHandle,\r
          ChildHandleBuffer[Index]\r
          );\r
  \r
    Status = gBS->UninstallMultipleProtocolInterfaces (\r
                    ChildHandleBuffer[Index],\r
                    &gEfiDevicePathProtocolGuid,\r
                    UsbMass->DevicePath,\r
                    &gEfiBlockIoProtocolGuid,\r
                    &UsbMass->BlockIo,\r
                    NULL\r
                    );\r
    \r
    if (EFI_ERROR (Status)) {\r
      //\r
      // Fail to uninstall blockio and devicepath protocol, so re-open usbio by child.\r
      //\r
      AllChildrenStopped = FALSE;\r
      DEBUG ((EFI_D_ERROR, "Fail to stop No.%d multi-lun child handle when uninstalling blockio and devicepath\n", (UINT32)Index));\r
      \r
      gBS->OpenProtocol (\r
             Controller,\r
             &gEfiUsbIoProtocolGuid,\r
             (VOID **) &UsbIo,\r
             This->DriverBindingHandle,\r
             ChildHandleBuffer[Index],\r
             EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
             );\r
    } else {\r
      //\r
      // Success to stop this multi-lun handle, so go on next child.\r
      //\r
      if (((Index + 1) == NumberOfChildren) && AllChildrenStopped) {\r
        UsbMass->Transport->Fini (UsbMass->Context);\r
      }\r
      gBS->FreePool (UsbMass);\r
    }\r
  }\r
\r
  if (!AllChildrenStopped) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
  \r
  DEBUG ((EFI_D_INFO, "Success to stop all %d multi-lun children handles\n", (UINT32)NumberOfChildren));\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_DRIVER_BINDING_PROTOCOL gUSBMassDriverBinding = {\r
  USBMassDriverBindingSupported,\r
  USBMassDriverBindingStart,\r
  USBMassDriverBindingStop,\r
  0x11,\r
  NULL,\r
  NULL\r
};\r
\r
/**\r
  The entry point for the driver, which will install the driver binding and\r
  component name protocol.\r
\r
  @param  ImageHandle       The image handle of this driver.\r
  @param  SystemTable       The system table.\r
\r
  @retval EFI_SUCCESS       The protocols are installed OK.\r
  @retval Others            Failed to install protocols.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
USBMassStorageEntryPoint (\r
  IN EFI_HANDLE               ImageHandle,\r
  IN EFI_SYSTEM_TABLE         *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Install driver binding protocol\r
  //\r
  Status = EfiLibInstallDriverBindingComponentName2 (\r
             ImageHandle,\r
             SystemTable,\r
             &gUSBMassDriverBinding,\r
             ImageHandle,\r
             &gUsbMassStorageComponentName,\r
             &gUsbMassStorageComponentName2\r
             );\r
\r
  return Status;\r
}\r