/** @file
USB Mass Storage Driver that manages USB Mass Storage Device and produces Block I/O Protocol.
Copyright (c) 2007 - 2011, 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
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 "UsbMass.h"
//
// Array of USB transport interfaces.
//
};
0x11,
NULL,
};
/**
Reset the block device.
This function implements EFI_BLOCK_IO_PROTOCOL.Reset().
It resets the block device hardware.
ExtendedVerification is ignored in this implementation.
@param This Indicates a pointer to the calling context.
@param ExtendedVerification Indicates that the driver may perform a more exhaustive
verification operation of the device during reset.
@retval EFI_SUCCESS The block device was reset.
@retval EFI_DEVICE_ERROR The block device is not functioning correctly and could not be reset.
**/
)
{
//
// Raise TPL to TPL_NOTIFY to serialize all its operations
// to protect shared data structures.
//
return Status;
}
/**
Reads the requested number of blocks from the device.
This function implements EFI_BLOCK_IO_PROTOCOL.ReadBlocks().
It reads the requested number of blocks from the device.
All the blocks are read, or an error is returned.
@param This Indicates a pointer to the calling context.
@param MediaId The media ID that the read request is for.
@param Lba The starting logical block address to read from on the device.
@param BufferSize The size of the Buffer in bytes.
This must be a multiple of the intrinsic block size of the device.
@param Buffer A pointer to the destination buffer for the data. The caller is
responsible for either having implicit or explicit ownership of the buffer.
@retval EFI_SUCCESS The data was read correctly from the device.
@retval EFI_DEVICE_ERROR The device reported an error while attempting to perform the read operation.
@retval EFI_NO_MEDIA There is no media in the device.
@retval EFI_MEDIA_CHANGED The MediaId is not for the current media.
@retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of the intrinsic block size of the device.
@retval EFI_INVALID_PARAMETER The read request contains LBAs that are not valid,
or the buffer is not on proper alignment.
**/
)
{
//
// Raise TPL to TPL_NOTIFY to serialize all its operations
// to protect shared data structures.
//
//
// If it is a removable media, such as CD-Rom or Usb-Floppy,
// Usb-Flash is marked as removable media.
//
if (Media->RemovableMedia) {
goto ON_EXIT;
}
}
if (!(Media->MediaPresent)) {
goto ON_EXIT;
}
goto ON_EXIT;
}
if (BufferSize == 0) {
goto ON_EXIT;
}
goto ON_EXIT;
}
//
// BufferSize must be a multiple of the intrinsic block size of the device.
//
goto ON_EXIT;
}
//
// Make sure the range to read is valid.
//
goto ON_EXIT;
}
} else {
}
}
return Status;
}
/**
Writes a specified number of blocks to the device.
This function implements EFI_BLOCK_IO_PROTOCOL.WriteBlocks().
It writes a specified number of blocks to the device.
All blocks are written, or an error is returned.
@param This Indicates a pointer to the calling context.
@param MediaId The media ID that the write request is for.
@param Lba The starting logical block address to be written.
@param BufferSize The size of the Buffer in bytes.
This must be a multiple of the intrinsic block size of the device.
@param Buffer Pointer to the source buffer for the data.
@retval EFI_SUCCESS The data were written correctly to the device.
@retval EFI_WRITE_PROTECTED The device cannot be written to.
@retval EFI_NO_MEDIA There is no media in the device.
@retval EFI_MEDIA_CHANGED The MediaId is not for the current media.
@retval EFI_DEVICE_ERROR The device reported an error while attempting to perform the write operation.
@retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of the intrinsic
block size of the device.
@retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid,
or the buffer is not on proper alignment.
**/
)
{
//
// Raise TPL to TPL_NOTIFY to serialize all its operations
// to protect shared data structures.
//
//
// If it is a removable media, such as CD-Rom or Usb-Floppy,
// USB Flash is marked as removable media.
//
if (Media->RemovableMedia) {
goto ON_EXIT;
}
}
if (!(Media->MediaPresent)) {
goto ON_EXIT;
}
goto ON_EXIT;
}
if (BufferSize == 0) {
goto ON_EXIT;
}
goto ON_EXIT;
}
//
// BufferSize must be a multiple of the intrinsic block size of the device.
//
goto ON_EXIT;
}
//
// Make sure the range to write is valid.
//
goto ON_EXIT;
}
//
// Try to write the data even the device is marked as ReadOnly,
// and clear the status should the write succeed.
//
} else {
}
}
return Status;
}
/**
Flushes all modified data to a physical block device.
This function implements EFI_BLOCK_IO_PROTOCOL.FlushBlocks().
USB mass storage device doesn't support write cache,
so return EFI_SUCCESS directly.
@param This Indicates a pointer to the calling context.
@retval EFI_SUCCESS All outstanding data were written correctly to the device.
@retval EFI_DEVICE_ERROR The device reported an error while attempting to write data.
@retval EFI_NO_MEDIA There is no media in the device.
**/
)
{
return EFI_SUCCESS;
}
/**
Initialize the media parameter data for EFI_BLOCK_IO_MEDIA of Block I/O Protocol.
@param UsbMass The USB mass storage device
@retval EFI_SUCCESS The media parameters are updated successfully.
@retval Others Failed to get the media parameters.
**/
)
{
//
// Fields of EFI_BLOCK_IO_MEDIA are defined in UEFI 2.0 spec,
// section for Block I/O Protocol.
//
return Status;
}
/**
Initilize the USB Mass Storage transport.
This function tries to find the matching USB Mass Storage transport
protocol for USB device. If found, initializes the matching transport.
@param This The USB mass driver's driver binding.
@param Controller The device to test.
@param Transport The pointer to pointer to USB_MASS_TRANSPORT.
@param Context The parameter for USB_MASS_DEVICE.Context.
@param MaxLun Get the MaxLun if is BOT dev.
@retval EFI_SUCCESS The initialization is successful.
@retval EFI_UNSUPPORTED No matching transport protocol is found.
@retval Others Failed to initialize dev.
**/
)
{
);
return Status;
}
goto ON_EXIT;
}
//
// Traverse the USB_MASS_TRANSPORT arrary and try to find the
// matching transport protocol.
// If not found, return EFI_UNSUPPORTED.
// If found, execute USB_MASS_TRANSPORT.Init() to initialize the transport context.
//
break;
}
}
goto ON_EXIT;
}
//
// For BOT device, try to get its max LUN.
// If max LUN is 0, then it is a non-lun device.
// Otherwise, it is a multi-lun device.
//
}
gBS->CloseProtocol (
);
return Status;
}
/**
Initialize data for device that supports multiple LUNSs.
@param This The Driver Binding Protocol instance.
@param Controller The device to initialize.
@param Transport Pointer to USB_MASS_TRANSPORT.
@param Context Parameter for USB_MASS_DEVICE.Context.
@param DevicePath The remaining device path.
@param MaxLun The max LUN number.
@retval EFI_SUCCESS At least one LUN is initialized successfully.
@retval EFI_OUT_OF_RESOURCES Out of resource while creating device path node.
@retval Other Initialization fails.
**/
)
{
//
// Initialize the media parameter data for EFI_BLOCK_IO_MEDIA of Block I/O Protocol.
//
//
// According to USB Mass Storage Specification for Bootability, only following
// 4 Peripheral Device Types are in spec.
//
DEBUG ((EFI_D_ERROR, "UsbMassInitMultiLun: Found an unsupported peripheral type[%d]\n", UsbMass->Pdt));
goto ON_ERROR;
}
} else if (Status != EFI_NO_MEDIA){
goto ON_ERROR;
}
//
// Create a device path node for device logic unit, and append it.
//
goto ON_ERROR;
}
//
// Create a new handle for each LUN, and install Block I/O Protocol and Device Path Protocol.
//
);
goto ON_ERROR;
}
//
// Open USB I/O Protocol by child to setup a parent-child relationship.
//
);
);
goto ON_ERROR;
}
}
return EFI_SUCCESS;
}
}
gBS->CloseProtocol (
);
}
//
// Return EFI_SUCCESS if at least one LUN is initialized successfully.
//
if (Index > 0) {
return EFI_SUCCESS;
} else {
return Status;
}
}
/**
Initialize data for device that does not support multiple LUNSs.
@param This The Driver Binding Protocol instance.
@param Controller The device to initialize.
@param Transport Pointer to USB_MASS_TRANSPORT.
@param Context Parameter for USB_MASS_DEVICE.Context.
@retval EFI_SUCCESS Initialization succeeds.
@retval Other Initialization fails.
**/
)
{
);
goto ON_ERROR;
}
//
// Initialize the media parameter data for EFI_BLOCK_IO_MEDIA of Block I/O Protocol.
//
//
// According to USB Mass Storage Specification for Bootability, only following
// 4 Peripheral Device Types are in spec.
//
DEBUG ((EFI_D_ERROR, "UsbMassInitNonLun: Found an unsupported peripheral type[%d]\n", UsbMass->Pdt));
goto ON_ERROR;
}
} else if (Status != EFI_NO_MEDIA){
goto ON_ERROR;
}
);
goto ON_ERROR;
}
return EFI_SUCCESS;
}
gBS->CloseProtocol (
);
}
return Status;
}
/**
Check whether the controller is a supported USB mass storage.
@param This The USB mass storage driver binding protocol.
@param Controller The controller handle to check.
@param RemainingDevicePath The remaining device path.
@retval EFI_SUCCESS The driver supports this controller.
@retval other This device isn't supported.
**/
)
{
);
return Status;
}
//
// Get the interface descriptor to check the USB class and find a transport
// protocol handler.
//
goto ON_EXIT;
}
goto ON_EXIT;
}
//
// Traverse the USB_MASS_TRANSPORT arrary and try to find the
// matching transport method.
// If not found, return EFI_UNSUPPORTED.
// If found, execute USB_MASS_TRANSPORT.Init() to initialize the transport context.
//
break;
}
}
gBS->CloseProtocol (
);
return Status;
}
/**
Starts the USB mass storage device with this driver.
This function consumes USB I/O Portocol, intializes USB mass storage device,
installs Block I/O Protocol, and submits Asynchronous Interrupt
Transfer to manage the USB mass storage device.
@param This The USB mass storage driver binding protocol.
@param Controller The USB mass storage device to start on
@param RemainingDevicePath The remaining device path.
@retval EFI_SUCCESS This driver supports this device.
@retval EFI_UNSUPPORTED This driver does not support this device.
@retval EFI_DEVICE_ERROR This driver cannot be started due to device Error.
@retval EFI_OUT_OF_RESOURCES Can't allocate memory resources.
@retval EFI_ALREADY_STARTED This driver has been started.
**/
)
{
MaxLun = 0;
goto Exit;
}
if (MaxLun == 0) {
//
// Initialize data for device that does not support multiple LUNSs.
//
}
} else {
//
// Open device path to prepare for appending Device Logic Unit node.
//
(VOID **) &DevicePath,
);
DEBUG ((EFI_D_ERROR, "USBMassDriverBindingStart: OpenDevicePathProtocol By Driver (%r)\n", Status));
goto Exit;
}
);
gBS->CloseProtocol (
);
goto Exit;
}
//
// Initialize data for device that supports multiple LUNSs.
// EFI_SUCCESS is returned if at least 1 LUN is initialized successfully.
//
gBS->CloseProtocol (
);
gBS->CloseProtocol (
);
DEBUG ((EFI_D_ERROR, "USBMassDriverBindingStart: UsbMassInitMultiLun (%r) with Maxlun=%d\n", Status, MaxLun));
}
}
Exit:
return Status;
}
/**
Stop controlling the device.
@param This The USB mass storage driver binding
@param Controller The device controller controlled by the driver.
@param NumberOfChildren The number of children of this device
@param ChildHandleBuffer The buffer of children handle.
@retval EFI_SUCCESS The driver stopped from controlling the device.
@retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.
@retval EFI_UNSUPPORTED Block I/O Protocol is not installed on Controller.
@retval Others Failed to stop the driver
**/
)
{
//
// This is a bus driver stop function since multi-lun is supported.
// There are three kinds of device handles that might be passed:
// 1st is a handle with USB I/O & Block I/O installed (non-multi-lun)
// 2nd is a handle with Device Path & USB I/O installed (multi-lun root)
// 3rd is a handle with Device Path & USB I/O & Block I/O installed (multi-lun).
//
if (NumberOfChildren == 0) {
//
// A handle without any children, might be 1st and 2nd type.
//
);
//
// This is a 2nd type handle(multi-lun root), it needs to close devicepath
// and usbio protocol.
//
gBS->CloseProtocol (
);
gBS->CloseProtocol (
);
return EFI_SUCCESS;
}
//
// This is a 1st type handle(non-multi-lun), which only needs to uninstall
// Block I/O Protocol, close USB I/O Protocol and free mass device.
//
//
// Uninstall Block I/O protocol from the device handle,
// then call the transport protocol to stop itself.
//
);
return Status;
}
gBS->CloseProtocol (
);
return EFI_SUCCESS;
}
//
// This is a 3rd type handle(multi-lun), which needs uninstall
// Block I/O Protocol and Device Path Protocol, close USB I/O Protocol and
// free mass device for all children.
//
);
DEBUG ((EFI_D_ERROR, "Fail to stop No.%d multi-lun child handle when opening blockio\n", (UINT32)Index));
continue;
}
gBS->CloseProtocol (
);
);
//
// Fail to uninstall Block I/O Protocol and Device Path Protocol, so re-open USB I/O Protocol by child.
//
DEBUG ((EFI_D_ERROR, "Fail to stop No.%d multi-lun child handle when uninstalling blockio and devicepath\n", (UINT32)Index));
gBS->OpenProtocol (
);
} else {
//
// Succeed to stop this multi-lun handle, so go on with next child.
//
}
}
}
if (!AllChildrenStopped) {
return EFI_DEVICE_ERROR;
}
DEBUG ((EFI_D_INFO, "Success to stop all %d multi-lun children handles\n", (UINT32) NumberOfChildren));
return EFI_SUCCESS;
}
/**
Entrypoint of USB Mass Storage Driver.
This function is the entrypoint of USB Mass Storage Driver. It installs Driver Binding
Protocol together with Component Name Protocols.
@param ImageHandle The firmware allocated handle for the EFI image.
@param SystemTable A pointer to the EFI System Table.
@retval EFI_SUCCESS The entry point is executed successfully.
**/
)
{
//
// Install driver binding protocol
//
);
return EFI_SUCCESS;
}