UsbBotPeim.c revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
/** @file
Copyright (c) 2006 - 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
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 "UsbBotPeim.h"
#include "BotPeim.h"
//
// Global function
//
};
};
};
/**
Detect whether the removable media is present and whether it has changed.
@param[in] PeiServices General-purpose services that are available to every
PEIM.
@param[in] PeiBotDev Indicates the PEI_BOT_DEVICE instance.
@retval EFI_SUCCESS The media status is successfully checked.
@retval Other Failed to detect media.
**/
);
/**
Initializes the Usb Bot.
@param FileHandle Handle of the file being invoked.
@param PeiServices Describes the list of possible PEI Services.
@retval EFI_SUCCESS Usb bot driver is successfully initialized.
@retval EFI_OUT_OF_RESOURCES Can't initialize the driver.
**/
)
{
//
// Shadow this PEIM to run from memory
//
return EFI_SUCCESS;
}
//
// locate all usb io PPIs
//
);
break;
}
}
//
// Register a notify function
//
return PeiServicesNotifyPpi (&mNotifyList);
}
/**
UsbIo installation notification function.
This function finds out all the current USB IO PPIs in the system and add them
into private data.
@param PeiServices Indirect reference to the PEI Services Table.
@param NotifyDesc Address of the notification descriptor data structure.
@param InvokePpi Address of the PPI that was invoked.
@retval EFI_SUCCESS The function completes successfully.
**/
)
{
return EFI_SUCCESS;
}
/**
Initialize the usb bot device.
@param[in] PeiServices General-purpose services that are available to every
PEIM.
@param[in] UsbIoPpi Indicates the PEI_USB_IO_PPI instance.
@retval EFI_SUCCESS The usb bot device is initialized successfully.
@retval Other Failed to initialize media.
**/
)
{
//
// Check its interface
//
);
return Status;
}
//
// Check if it is the BOT device we support
//
return EFI_NOT_FOUND;
}
);
return Status;
}
//
// Default value
//
//
//
);
return Status;
}
} else {
}
}
CopyMem (
&(PeiBotDevice->BlkIoPpi),
sizeof (EFI_PEI_RECOVERY_BLOCK_IO_PPI)
);
CopyMem (
&(PeiBotDevice->BlkIoPpiList),
&mPpiList,
sizeof (EFI_PEI_PPI_DESCRIPTOR)
);
return Status;
}
1,
);
return Status;
}
return Status;
}
return EFI_SUCCESS;
}
/**
Gets the count of block I/O devices that one specific block driver detects.
This function is used for getting the count of block I/O devices that one
specific block driver detects. To the PEI ATAPI driver, it returns the number
of all the detected ATAPI devices it detects during the enumeration process.
To the PEI legacy floppy driver, it returns the number of all the legacy
devices it finds during its enumeration process. If no device is detected,
then the function will return zero.
@param[in] PeiServices General-purpose services that are available
to every PEIM.
@param[in] This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI
instance.
@param[out] NumberBlockDevices The number of block I/O devices discovered.
@retval EFI_SUCCESS Operation performed successfully.
**/
)
{
//
// For Usb devices, this value should be always 1
//
*NumberBlockDevices = 1;
return EFI_SUCCESS;
}
/**
Gets a block device's media information.
This function will provide the caller with the specified block device's media
information. If the media changes, calling this function will update the media
information accordingly.
@param[in] PeiServices General-purpose services that are available to every
PEIM
@param[in] This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
@param[in] DeviceIndex Specifies the block device to which the function wants
to talk. Because the driver that implements Block I/O
PPIs will manage multiple block devices, the PPIs that
want to talk to a single device must specify the
device index that was assigned during the enumeration
process. This index is a number from one to
NumberBlockDevices.
@param[out] MediaInfo The media information of the specified block media.
The caller is responsible for the ownership of this
data structure.
@retval EFI_SUCCESS Media information about the specified block device
was obtained successfully.
@retval EFI_DEVICE_ERROR Cannot get the media information due to a hardware
error.
**/
)
{
//
// First test unit ready
//
);
);
return EFI_DEVICE_ERROR;
}
CopyMem (
sizeof (EFI_PEI_BLOCK_IO_MEDIA)
);
return EFI_SUCCESS;
}
/**
Reads the requested number of blocks from the specified block device.
The function reads the requested number of blocks from the device. All the
blocks are read, or an error is returned. If there is no media in the device,
the function returns EFI_NO_MEDIA.
@param[in] PeiServices General-purpose services that are available to
every PEIM.
@param[in] This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.
@param[in] DeviceIndex Specifies the block device to which the function wants
to talk. Because the driver that implements Block I/O
PPIs will manage multiple block devices, the PPIs that
want to talk to a single device must specify the device
index that was assigned during the enumeration process.
This index is a number from one to NumberBlockDevices.
@param[in] StartLBA The starting logical block address (LBA) to read from
on the device
@param[in] BufferSize The size of the Buffer in bytes. This number must be
a multiple of the intrinsic block size of the device.
@param[out] Buffer A pointer to the destination buffer for the data.
The caller is responsible for the 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_INVALID_PARAMETER The read request contains LBAs that are not
valid, or the buffer is not properly aligned.
@retval EFI_NO_MEDIA There is no media in the device.
@retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of
the intrinsic block size of the device.
**/
)
{
//
// Check parameters
//
return EFI_INVALID_PARAMETER;
}
if (BufferSize == 0) {
return EFI_SUCCESS;
}
return EFI_NO_MEDIA;
}
if (BufferSize % BlockSize != 0) {
}
}
if (Status == EFI_SUCCESS) {
);
if (Status == EFI_SUCCESS) {
Status = PeiUsbRead10 (
1
);
}
} else {
//
// To generate sense data for DetectMedia use.
//
);
}
//
// if any error encountered, detect what happened to the media and
// update the media info accordingly.
//
);
if (Status != EFI_SUCCESS) {
return EFI_DEVICE_ERROR;
}
return EFI_NO_MEDIA;
}
return EFI_BAD_BUFFER_SIZE;
}
return EFI_INVALID_PARAMETER;
}
return EFI_INVALID_PARAMETER;
}
Status = PeiUsbRead10 (
);
switch (Status) {
case EFI_SUCCESS:
return EFI_SUCCESS;
default:
return EFI_DEVICE_ERROR;
}
} else {
StartLBA += 1;
NumberOfBlocks -= 1;
if (NumberOfBlocks == 0) {
return EFI_SUCCESS;
}
Status = PeiUsbRead10 (
);
switch (Status) {
case EFI_SUCCESS:
return EFI_SUCCESS;
default:
return EFI_DEVICE_ERROR;
}
}
}
/**
Detect whether the removable media is present and whether it has changed.
@param[in] PeiServices General-purpose services that are available to every
PEIM.
@param[in] PeiBotDev Indicates the PEI_BOT_DEVICE instance.
@retval EFI_SUCCESS The media status is successfully checked.
@retval Other Failed to detect media.
**/
)
{
//
// if there is no media present,or media not changed,
// the request sense command will detect faster than read capacity command.
// read capacity command can be bypassed, thus improve performance.
//
SenseCounts = 0;
1,
);
return Status;
}
);
if (Status == EFI_SUCCESS) {
//
// No Media
//
} else {
//
// Media Changed
//
}
//
// Media Error
//
//
// if media error encountered, make it look like no media present.
//
}
}
}
if (NeedReadCapacity) {
//
// Retry at most 4 times to detect media info
//
switch (PeiBotDev->DeviceType) {
case USBCDROM:
);
break;
case USBFLOPPY2:
);
//
// retry the ReadCapacity command
//
}
break;
case USBFLOPPY:
);
//
// retry the ReadFormatCapacity command
//
break;
default:
return EFI_INVALID_PARAMETER;
}
SenseCounts = 0;
if (Status == EFI_SUCCESS) {
break;
}
);
//
// If Request Sense data failed,retry.
//
if (EFI_ERROR (FloppyStatus)) {
continue;
}
//
// No Media
//
break;
}
//
// if media error encountered, make it look like no media present.
//
break;
}
}
//
// ENDFOR
//
// tell whether the readcapacity process is successful or not
// ("Status" variable record the latest status returned
// by ReadCapacity )
//
if (Status != EFI_SUCCESS) {
return EFI_DEVICE_ERROR;
}
}
return EFI_SUCCESS;
}