📄 usbmassstoragehelper.c
字号:
/*++
Copyright (c) 1999 - 2002 Intel Corporation. All rights reserved
This software and associated documentation (if any) is furnished
under a license and may only be used or copied in accordance
with the terms of the license. Except as permitted by such
license, no part of this software or documentation may be
reproduced, stored in a retrieval system, or transmitted in any
form or by any means without the express written consent of
Intel Corporation.
Module Name:
UsbMassStorageHelper.c
Abstract:
Helper functions for USB Mass Storage Driver
Revision History
--*/
#include "UsbMassStorageHelper.h"
STATIC
BOOLEAN
IsNoMedia(
IN REQUEST_SENSE_DATA *SenseData,
IN UINTN SenseCounts
);
STATIC
BOOLEAN
IsMediaError(
IN REQUEST_SENSE_DATA *SenseData,
IN UINTN SenseCounts
);
STATIC
BOOLEAN
IsMediaChange(
IN REQUEST_SENSE_DATA *SenseData,
IN UINTN SenseCounts
);
STATIC
BOOLEAN
IsDriveReady(
IN REQUEST_SENSE_DATA *SenseData,
IN UINTN SenseCounts,
OUT BOOLEAN *NeedRetry
);
STATIC
BOOLEAN
IsMediaWriteProtected(
IN REQUEST_SENSE_DATA *SenseData,
IN UINTN SenseCounts
);
STATIC
BOOLEAN
IsLogicalUnitCommunicationOverRun (
IN REQUEST_SENSE_DATA *SenseData,
IN UINTN SenseCounts
);
EFI_STATUS
USBFloppyPacketCommand(
USB_FLOPPY_DEV *UsbFloppyDevice,
VOID *Command,
UINT8 CommandSize,
VOID *DataBuffer,
UINT32 BufferLength,
EFI_USB_DATA_DIRECTION Direction,
UINT16 TimeOutInMilliSeconds
)
/*++
Routine Description:
Sends Packet Command to USB Floppy Drive.
Arguments:
UsbFloppyDevice: The USB_FLOPPY_DEV instance.
Command: A pointer to the command packet.
CommandSize: Indicates the size of the command packet.
DataBuffer: A pointer to the buffer for the data transfer
after the command packet.
BufferLength: Indicates the size of the Data Buffer.
Returns:
--*/
{
EFI_USB_ATAPI_PROTOCOL *UsbAtapiInterface;
EFI_STATUS Status;
UsbAtapiInterface = UsbFloppyDevice->AtapiProtocol;
//
// Directly calling EFI_USB_ATAPI_PROTOCOL.UsbAtapiPacketCmd()
// to perform the command request.
//
Status = UsbAtapiInterface->UsbAtapiPacketCmd (
UsbAtapiInterface,
Command,
CommandSize,
DataBuffer,
BufferLength,
Direction,
TimeOutInMilliSeconds
);
return Status;
}
EFI_STATUS
USBFloppyIdentify (
IN USB_FLOPPY_DEV *UsbFloppyDevice
)
/*++
Routine Description:
Retrieves device information to tell the device type.
Arguments:
UsbFloppyDevice: The USB_FLOPPY_DEV instance.
Returns:
--*/
{
EFI_STATUS Status ;
USB_INQUIRY_DATA *Idata;
BOOLEAN MediaChange;
//
// Send Inquiry Packet Command to get INQUIRY data.
//
Status = USBFloppyInquiry(UsbFloppyDevice,&Idata);
if (EFI_ERROR(Status)) {
return EFI_DEVICE_ERROR;
}
//
// Get media removable info from INQUIRY data.
//
UsbFloppyDevice->BlkIo.Media->RemovableMedia =
(UINT8)((Idata->RMB & 0x80) == 0x80);
//
// Identify device type via INQUIRY data.
//
switch ((Idata->peripheral_type) & 0x1f)
{
case 0x00: // Floppy
UsbFloppyDevice->DeviceType = USBFLOPPY;
UsbFloppyDevice->BlkIo.Media->MediaId = 0 ;
UsbFloppyDevice->BlkIo.Media->MediaPresent = FALSE; // Give initial value
UsbFloppyDevice->BlkIo.Media->LastBlock = 0 ;
UsbFloppyDevice->BlkIo.Media->BlockSize = 0x200;
break;
case 0x05: // CD-ROM
UsbFloppyDevice->DeviceType = USBCDROM;
UsbFloppyDevice->BlkIo.Media->MediaId = 0 ;
UsbFloppyDevice->BlkIo.Media->MediaPresent = FALSE; // Give initial value
UsbFloppyDevice->BlkIo.Media->LastBlock = 0 ;
UsbFloppyDevice->BlkIo.Media->BlockSize = 0x800;
UsbFloppyDevice->BlkIo.Media->ReadOnly = TRUE;
break;
default:
gBS->FreePool (Idata);
return EFI_DEVICE_ERROR;
}
//
// Initialize some device specific data.
//
UsbFloppyDevice->SenseDataNumber = 6; // original sense data numbers
if (UsbFloppyDevice->SenseData != NULL) {
gBS->FreePool (UsbFloppyDevice->SenseData);
UsbFloppyDevice->SenseData = NULL;
}
Status = gBS->AllocatePool(
EfiBootServicesData,
UsbFloppyDevice->SenseDataNumber * sizeof(REQUEST_SENSE_DATA),
&UsbFloppyDevice->SenseData
);
if(EFI_ERROR(Status)) {
gBS->FreePool (Idata);
return EFI_DEVICE_ERROR ;
}
//
// Get media information.
//
UsbFloppyDetectMedia(UsbFloppyDevice,&MediaChange);
gBS->FreePool (Idata);
return EFI_SUCCESS;
}
EFI_STATUS
USBFloppyInquiry(
IN USB_FLOPPY_DEV *UsbFloppyDevice,
OUT USB_INQUIRY_DATA **Idata
)
/*++
Routine Description:
Send Inquiry Packet Command to device and retrieve Inquiry Data.
Arguments:
UsbFloppyDevice: The USB_FLOPPY_DEV instance.
Idata: A pointer pointing to the address of
Inquiry Data.
Returns:
--*/
{
ATAPI_PACKET_COMMAND Packet;
EFI_STATUS Status;
EFI_USB_ATAPI_PROTOCOL *UsbAtapiInterface;
UsbAtapiInterface = UsbFloppyDevice->AtapiProtocol;
//
// prepare command packet for the Inquiry Packet Command.
//
EfiZeroMem(&Packet, sizeof(ATAPI_PACKET_COMMAND));
Packet.Inquiry.opcode = INQUIRY;
Packet.Inquiry.page_code = 0;
Packet.Inquiry.allocation_length = sizeof(USB_INQUIRY_DATA);
Status = gBS->AllocatePool(EfiBootServicesData,
sizeof(USB_INQUIRY_DATA),
Idata
);
if (EFI_ERROR(Status)) {
return EFI_DEVICE_ERROR ;
}
EfiZeroMem (*Idata,sizeof (USB_INQUIRY_DATA));
//
// Send command packet and retrieve requested Inquiry Data.
//
Status = USBFloppyPacketCommand (UsbFloppyDevice,
&Packet,
sizeof(ATAPI_PACKET_COMMAND),
(VOID *)(*Idata),
sizeof(USB_INQUIRY_DATA),
EfiUsbDataIn,
USBFLPTIMEOUT * 3
);
if (EFI_ERROR(Status)) {
return EFI_DEVICE_ERROR;
}
return EFI_SUCCESS;
}
EFI_STATUS
USBFloppyRead10(
IN USB_FLOPPY_DEV *UsbFloppyDevice,
IN VOID *Buffer,
IN EFI_LBA Lba,
IN UINTN NumberOfBlocks
)
/*++
Routine Description:
Sends Read10 Packet Command to device to perform data transfer
from device to host.
Arguments:
UsbFloppyDevice: The USB_FLOPPY_DEV instance.
Buffer: A pointer to the destination buffer for the data.
The caller is responsible for either having implicit
or explicit ownership of the buffer.
Lba: The starting logical block address to read from
on the device.
NumberOfBlocks: Indicates the number of blocks that the read
operation requests.
Returns:
--*/
{
ATAPI_PACKET_COMMAND Packet;
READ10_CMD *Read10Packet;
UINT16 MaxBlock ;
UINT16 BlocksRemaining;
UINT16 SectorCount;
UINT32 Lba32;
UINT32 BlockSize, ByteCount;
VOID *ptrBuffer;
EFI_STATUS Status;
UINT16 TimeOut;
EFI_USB_ATAPI_PROTOCOL *UsbAtapiInterface;
UINTN SenseCounts;
UsbAtapiInterface = UsbFloppyDevice->AtapiProtocol;
//
// prepare command packet for the Inquiry Packet Command.
//
EfiZeroMem(&Packet, sizeof(ATAPI_PACKET_COMMAND));
Read10Packet = &Packet.Read10;
Lba32 = (UINT32)Lba;
ptrBuffer = Buffer;
BlockSize = UsbFloppyDevice->BlkIo.Media->BlockSize;
MaxBlock = (UINT16)(65536 / BlockSize);
BlocksRemaining = (UINT16)NumberOfBlocks;
Status = EFI_SUCCESS;
while (BlocksRemaining > 0) {
if (BlocksRemaining <= MaxBlock) {
SectorCount = BlocksRemaining ;
} else {
SectorCount = MaxBlock ;
}
//
// fill the Packet data structure
//
Read10Packet->opcode = READ_10;
//
// Lba0 ~ Lba3 specify the start logical block address of the data transfer.
// Lba0 is MSB, Lba3 is LSB
//
Read10Packet->Lba3 = (UINT8)(Lba32 & 0xff);
Read10Packet->Lba2 = (UINT8)(Lba32 >> 8);
Read10Packet->Lba1 = (UINT8)(Lba32 >> 16);
Read10Packet->Lba0 = (UINT8)(Lba32 >> 24);
//
// TranLen0 ~ TranLen1 specify the transfer length in block unit.
// TranLen0 is MSB, TranLen is LSB
//
Read10Packet->TranLen1 = (UINT8)(SectorCount & 0xff);
Read10Packet->TranLen0 = (UINT8)(SectorCount >> 8);
ByteCount = SectorCount * BlockSize;
TimeOut = (UINT16)(SectorCount * USBFLPTIMEOUT);
Status = USBFloppyPacketCommand(
UsbFloppyDevice,
&Packet,
sizeof(ATAPI_PACKET_COMMAND),
(VOID *)ptrBuffer,
ByteCount,
EfiUsbDataIn,
TimeOut
);
if (EFI_ERROR(Status)) {
Status = UsbFloppyRequestSense (UsbFloppyDevice,&SenseCounts);
if (!EFI_ERROR(Status)) {
if (IsLogicalUnitCommunicationOverRun (
UsbFloppyDevice->SenseData,
SenseCounts)) {
Lba32 = (UINT32)Lba;
ptrBuffer = Buffer;
BlocksRemaining = (UINT16)NumberOfBlocks;
MaxBlock = (UINT16)(MaxBlock / 4);
if (MaxBlock < 1) {
MaxBlock = 1;
}
continue;
}
} else {
return EFI_DEVICE_ERROR;
}
//
// retry read10 command
//
Status = USBFloppyPacketCommand(
UsbFloppyDevice,
&Packet,
sizeof(ATAPI_PACKET_COMMAND),
(VOID *)ptrBuffer,
ByteCount,
EfiUsbDataIn,
TimeOut
);
if (EFI_ERROR(Status)) {
return EFI_DEVICE_ERROR;
}
}
Lba32 += SectorCount;
ptrBuffer = (UINT8 *)ptrBuffer + SectorCount * BlockSize ;
BlocksRemaining = (UINT16)(BlocksRemaining - SectorCount);
}
return Status;
}
EFI_STATUS
USBFloppyReadCapacity (
IN USB_FLOPPY_DEV *UsbFloppyDevice
)
/*++
Routine Description:
Retrieves media capacity information via
sending Read Capacity Packet Command.
Arguments:
UsbFloppyDevice: The USB_FLOPPY_DEV instance.
Returns:
--*/
{
//
// status returned by Read Capacity Packet Command
//
EFI_STATUS Status;
ATAPI_PACKET_COMMAND Packet;
EFI_USB_ATAPI_PROTOCOL *UsbAtapiInterface;
//
// used for capacity data returned from Usb Floppy
//
READ_CAPACITY_DATA Data ;
EfiZeroMem(&Data,sizeof(Data));
UsbAtapiInterface = UsbFloppyDevice->AtapiProtocol;
EfiZeroMem (&Packet, sizeof(ATAPI_PACKET_COMMAND));
Packet.Inquiry.opcode = READ_CAPACITY;
Status = USBFloppyPacketCommand (UsbFloppyDevice,
&Packet,
sizeof(ATAPI_PACKET_COMMAND),
(VOID *)&Data,
sizeof(READ_CAPACITY_DATA),
EfiUsbDataIn,
USBFLPTIMEOUT
) ;
if(EFI_ERROR(Status)) {
return EFI_DEVICE_ERROR;
}
UsbFloppyDevice->BlkIo.Media->LastBlock = (Data.LastLba3 << 24) |
(Data.LastLba2 << 16) |
(Data.LastLba1 << 8) |
Data.LastLba0;
UsbFloppyDevice->BlkIo.Media->MediaPresent = TRUE;
UsbFloppyDevice->BlkIo.Media->BlockSize = 0x800 ;
return EFI_SUCCESS ;
}
EFI_STATUS
USBFloppyReadFormatCapacity (
IN USB_FLOPPY_DEV *UsbFloppyDevice
)
/*++
Routine Description:
Retrieves media capacity information via sending Read Format
Capacity Packet Command.
Arguments:
UsbFloppyDevice: The USB_FLOPPY_DEV instance.
Returns:
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -