tyler.durden/audk
1
0
Fork 0
mirror of https://github.com/acidanthera/audk.git synced 2025-07-27 07:34:06 +02:00
Code Issues Packages Projects Releases Wiki Activity

Code Scrub:

Browse Source 
The code of MdePkg\Library\UefiScsiLib\ and MdePkg\Library\UefiUsbLib has been checked and modified according to MDE_Library_Spec_0.61h-4.doc.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6561 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
jji4 2008-11-17 11:24:14 +00:00
parent 17f695ed2b
commit d5954c618f
7 changed files with 1298 additions and 850 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

370
MdePkg/Include/Library/UefiScsiLib.h
View File

@ -2,7 +2,7 @@
Provides the functions to submit Scsi commands defined in SCSI-2 specification for scsi device. Provides the functions to submit Scsi commands defined in SCSI-2 specification for scsi device.
Copyright (c) 2006 - 2008, Intel Corporation Copyright (c) 2006 - 2008, Intel Corporation<BR>
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -34,40 +34,70 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
/** /**
Function test the ready status of the SCSI unit. Execute Test Unit Ready SCSI command on a specific SCSI target.
Submit SCSI test unit ready command with SCSI request packet specified by this scsi command, TimeOut
and SenseData, then get the status of the target Scsi unit.
Executes the Test Unit Ready command on the SCSI target specified by ScsiIo.
If Timeout is zero, then this function waits indefinitely for the command to complete.
If Timeout is greater than zero, then the command is executed and will timeout after Timeout 100 ns units.
If ScsiIo is NULL, then ASSERT().
If SenseDataLength is NULL, then ASSERT(). If SenseDataLength is NULL, then ASSERT().
If HostAdapterStatus is NULL, then ASSERT(). If HostAdapterStatus is NULL, then ASSERT().
If TargetStatus is NULL, then ASSERT(). If TargetStatus is NULL, then ASSERT().
@param[in] ScsiIo A pointer to SCSI IO protocol.
@param[in] Timeout The length of timeout period.
@param[in] SenseData A pointer to output sense data.
@param[out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target.
@retval EFI_SUCCESS The status of the unit is tested successfully. @param[in] ScsiIo A pointer to the SCSI I/O Protocol instance
for the specific SCSI target.
@param[in] Timeout The timeout in 100 ns units to use for the execution
of this SCSI Request Packet. A Timeout value of
zero means that this function will wait indefinitely
for the SCSI Request Packet to execute. If Timeout
is greater than zero, then this function will return
EFI_TIMEOUT if the time required to execute the SCSI
Request Packet is greater than Timeout.
@param[in, out] SenseData A pointer to sense data that was generated by
the execution of the SCSI Request Packet. This
buffer must be allocated by the caller.
If SenseDataLength is 0, then this parameter is
optional and may be NULL.
@param[in, out] SenseDataLength On input, a pointer to the length in bytes of
the SenseData buffer. On output, a poiinter to
the number of bytes written to the SenseData buffer.
@param[out] HostAdapterStatus The status of the SCSI Host Controller that produces
the SCSI bus containing the SCSI target specified by
ScsiIo when the SCSI Request Packet was executed.
See the EFI SCSI I/O Protocol in the UEFI Specification
for details on the possible return values.
@param[out] TargetStatus The status returned by the SCSI target specified
by ScsiIo when the SCSI Request Packat was executed
on the SCSI Host Controller. See the EFI SCSI I/O
Protocol in the UEFI Specification for details on
the possible return values.
@retval EFI_SUCCESS The command was executed successfully.
See HostAdapterStatus, TargetStatus, SenseDataLength,
and SenseData in that order for additional status
information.
@retval EFI_NOT_READY The SCSI Request Packet could not be sent because
there are too many SCSI Command Packets already
queued. The SCSI Request Packet was not sent, so
no additional status information is available.
The caller may retry again later.
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send
SCSI Request Packet. See HostAdapterStatus,
TargetStatus, SenseDataLength, and SenseData in that
order for additional status information.
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
is not supported by the SCSI initiator(i.e., SCSI
Host Controller). The SCSI Request Packet was not
sent, so no additional status information is available.
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request
Packet to execute. See HostAdapterStatus, TargetStatus,
SenseDataLength, and SenseData in that order for
additional status information.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
but the entire DataBuffer could not be transferred. but the entire DataBuffer could not be transferred.
The actual number of bytes transferred is returned The actual number of bytes transferred is returned
in InTransferLength. in InTransferLength.
@retval EFI_NOT_READY The SCSI Request Packet could not be sent because
there are too many SCSI Command Packets already
queued.
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send
the SCSI Request Packet.
@retval EFI_INVALID_PARAMETER ScsiIo is NULL.
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
is not supported by the SCSI initiator(i.e., SCSI
Host Controller).
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
Request Packet to execute.
**/ **/
EFI_STATUS EFI_STATUS
@ -75,53 +105,89 @@ EFIAPI
ScsiTestUnitReadyCommand ( ScsiTestUnitReadyCommand (
IN EFI_SCSI_IO_PROTOCOL *ScsiIo, IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
IN UINT64 Timeout, IN UINT64 Timeout,
IN VOID *SenseData, IN OUT VOID *SenseData, OPTIONAL
OUT UINT8 *SenseDataLength, IN OUT UINT8 *SenseDataLength,
OUT UINT8 *HostAdapterStatus, OUT UINT8 *HostAdapterStatus,
OUT UINT8 *TargetStatus OUT UINT8 *TargetStatus
); );
/** /**
Function to submit SCSI inquiry command. Execute Inquiry SCSI command on a specific SCSI target.
Submit SCSI inquiry command with the SCSI request packet specified by this SCSI command and input
parameters, then return the status of Scsi unit execution.
Executes the Inquiry command on the SCSI target specified by ScsiIo.
If Timeout is zero, then this function waits indefinitely for the command to complete.
If Timeout is greater than zero, then the command is executed and will timeout after Timeout 100 ns units.
If ScsiIo is NULL, then ASSERT().
If SenseDataLength is NULL, then ASSERT(). If SenseDataLength is NULL, then ASSERT().
If HostAdapterStatus is NULL, then ASSERT(). If HostAdapterStatus is NULL, then ASSERT().
If TargetStatus is NULL, then ASSERT(). If TargetStatus is NULL, then ASSERT().
If InquiryDataLength is NULL, then ASSERT(). If InquiryDataLength is NULL, then ASSERT().
@param[in] ScsiIo SCSI IO Protocol to use @param[in] ScsiIo A pointer to the SCSI I/O Protocol instance
@param[in] Timeout The length of timeout period. for the specific SCSI target.
@param[in] SenseData A pointer to output sense data. @param[in] Timeout The timeout in 100 ns units to use for the
@param[in, out] SenseDataLength The length of output sense data. execution of this SCSI Request Packet. A Timeout
@param[out] HostAdapterStatus The status of Host Adapter. value of zero means that this function will wait
@param[out] TargetStatus The status of the target. indefinitely for the SCSI Request Packet to execute.
@param[in, out] InquiryDataBuffer A pointer to inquiry data buffer. If Timeout is greater than zero, then this function
@param[in, out] InquiryDataLength The length of inquiry data buffer. will return EFI_TIMEOUT if the time required to
@param[in] EnableVitalProductData Boolean to enable Vital Product Data. execute the SCSI Request Packet is greater than Timeout.
@param[in, out] SenseData A pointer to sense data that was generated
by the execution of the SCSI Request Packet.
This buffer must be allocated by the caller.
If SenseDataLength is 0, then this parameter
is optional and may be NULL.
@param[in, out] SenseDataLength On input, the length in bytes of the SenseData buffer.
On output, the number of bytes written to the SenseData buffer.
@param[out] HostAdapterStatus The status of the SCSI Host Controller that
produces the SCSI bus containing the SCSI
target specified by ScsiIo when the SCSI
Request Packet was executed. See the EFI
SCSI I/O Protocol in the UEFI Specification
for details on the possible return values.
@param[out] TargetStatus The status returned by the SCSI target specified
by ScsiIo when the SCSI Request Packat was
executed on the SCSI Host Controller.
See the EFI SCSI I/O Protocol in the UEFI
Specification for details on the possible
return values.
@param[in, out] InquiryDataBuffer A pointer to inquiry data that was generated
by the execution of the SCSI Request Packet.
This buffer must be allocated by the caller.
If InquiryDataLength is 0, then this parameter
is optional and may be NULL.
@param[in, out] InquiryDataLength On input, a pointer to the length in bytes
of the InquiryDataBuffer buffer.
On output, a pointer to the number of bytes
written to the InquiryDataBuffer buffer.
@param[in] EnableVitalProductData If TRUE, then the supported vital product
data is returned in InquiryDataBuffer.
If FALSE, then the standard inquiry data is
returned in InquiryDataBuffer.
@retval EFI_SUCCESS Command is executed successfully. @retval EFI_SUCCESS The command was executed successfully. See HostAdapterStatus,
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, TargetStatus, SenseDataLength, and SenseData in that order
but the entire DataBuffer could not be transferred. for additional status information.
The actual number of bytes transferred is returned @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire
in TransferLength. InquiryDataBuffer could not be transferred. The actual
@retval EFI_NOT_READY The SCSI Request Packet could not be sent because number of bytes transferred is returned in InquiryDataLength.
there are too many SCSI Command Packets already @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there
queued. are too many SCSI Command Packets already queued.
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send The SCSI Request Packet was not sent, so no additional
the SCSI Request Packet. status information is available. The caller may retry again later.
@retval EFI_INVALID_PARAMETER ScsiIo is NULL. @retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet Request Packet. See HostAdapterStatus, TargetStatus,
is not supported by the SCSI initiator(i.e., SCSI SenseDataLength, and SenseData in that order for additional
Host Controller). status information.
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not
Request Packet to execute. supported by the SCSI initiator(i.e., SCSI Host Controller).
The SCSI Request Packet was not sent, so no additional
status information is available.
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request
Packet to execute. See HostAdapterStatus, TargetStatus,
SenseDataLength, and SenseData in that order for
additional status information.
**/ **/
EFI_STATUS EFI_STATUS
@ -129,58 +195,95 @@ EFIAPI
ScsiInquiryCommand ( ScsiInquiryCommand (
IN EFI_SCSI_IO_PROTOCOL *ScsiIo, IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
IN UINT64 Timeout, IN UINT64 Timeout,
IN VOID *SenseData, IN OUT VOID *SenseData, OPTIONAL
IN OUT UINT8 *SenseDataLength, IN OUT UINT8 *SenseDataLength,
OUT UINT8 *HostAdapterStatus, OUT UINT8 *HostAdapterStatus,
OUT UINT8 *TargetStatus, OUT UINT8 *TargetStatus,
IN OUT VOID *InquiryDataBuffer, IN OUT VOID *InquiryDataBuffer, OPTIONAL
IN OUT UINT32 *InquiryDataLength, IN OUT UINT32 *InquiryDataLength,
IN BOOLEAN EnableVitalProductData IN BOOLEAN EnableVitalProductData
); );
/** /**
Function to submit SCSI mode sense 10 command. Execute Mode Sense(10) SCSI command on a specific SCSI target.
Submit SCSI Mode Sense (10) command with the SCSI request packet specified by this SCSI command and
the input parameters, then return the status of Scsi unit execution.
Executes the SCSI Mode Sense(10) command on the SCSI target specified by ScsiIo.
If Timeout is zero, then this function waits indefinitely for the command to complete.
If Timeout is greater than zero, then the command is executed and will timeout
after Timeout 100 ns units. The DBDField, PageControl, and PageCode parameters
are used to construct the CDB for this SCSI command.
If ScsiIo is NULL, then ASSERT().
If SenseDataLength is NULL, then ASSERT(). If SenseDataLength is NULL, then ASSERT().
If HostAdapterStatus is NULL, then ASSERT(). If HostAdapterStatus is NULL, then ASSERT().
If TargetStatus is NULL, then ASSERT(). If TargetStatus is NULL, then ASSERT().
If DataLength is NULL, then ASSERT(). If DataLength is NULL, then ASSERT().
@param[in] ScsiIo A pointer to SCSI IO protocol.
@param[in] Timeout The length of timeout period.
@param[in] SenseData A pointer to output sense data.
@param[in, out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target.
@param[in] DataBuffer A pointer to input data buffer.
@param[in, out] DataLength The length of input data buffer.
@param[in] DBDField The DBD Field (Optional).
@param[in] PageControl Page Control.
@param[in] PageCode Page code.
@retval EFI_SUCCESS The status of the unit is tested successfully. @param[in] ScsiIo A pointer to the SCSI I/O Protocol instance
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, for the specific SCSI target.
but the entire DataBuffer could not be transferred. @param[in] Timeout The timeout in 100 ns units to use for the
execution of this SCSI Request Packet. A Timeout
value of zero means that this function will wait
indefinitely for the SCSI Request Packet to execute.
If Timeout is greater than zero, then this function
will return EFI_TIMEOUT if the time required to
execute the SCSI Request Packet is greater than Timeout.
@param[in,out] SenseData A pointer to sense data that was generated
by the execution of the SCSI Request Packet.
This buffer must be allocated by the caller.
If SenseDataLength is 0, then this parameter
is optional and may be NULL.
@param[in,out] SenseDataLength On input, the length in bytes of the SenseData buffer.
On output, the number of bytes written to the SenseData buffer.
@param[out] HostAdapterStatus The status of the SCSI Host Controller that
produces the SCSI bus containing the SCSI target
specified by ScsiIo when the SCSI Request Packet
was executed. See the EFI SCSI I/O Protocol in the
UEFI Specification for details on the possible
return values.
@param[out] TargetStatus The status returned by the SCSI target specified
by ScsiIo when the SCSI Request Packat was executed
on the SCSI Host Controller. See the EFI SCSI
I/O Protocol in the UEFI Specification for details
on the possible return values.
@param[in,out] DataBuffer A pointer to data that was generated by the
execution of the SCSI Request Packet. This
buffer must be allocated by the caller. If
DataLength is 0, then this parameter is optional
and may be NULL.
@param[in,out] DataLength On input, a pointer to the length in bytes of
the DataBuffer buffer. On output, a pointer
to the number of bytes written to the DataBuffer
buffer.
@param[in] DBDField Specifies the DBD field of the CDB for this SCSI Command.
@param[in] PageControl Specifies the PC field of the CDB for this SCSI Command.
@param[in] PageCode Specifies the Page Control field of the CDB for this SCSI Command.
@retval EFI_SUCCESS The command was executed successfully.
See HostAdapterStatus, TargetStatus, SenseDataLength,
and SenseData in that order for additional status information.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the
entire DataBuffer could not be transferred.
The actual number of bytes transferred is returned The actual number of bytes transferred is returned
in TransferLength. in DataLength.
@retval EFI_NOT_READY The SCSI Request Packet could not be sent because @retval EFI_NOT_READY The SCSI Request Packet could not be sent because
there are too many SCSI Command Packets already there are too many SCSI Command Packets already queued.
queued. The SCSI Request Packet was not sent, so no additional
status information is available. The caller may retry
again later.
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send @retval EFI_DEVICE_ERROR A device error occurred while attempting to send
the SCSI Request Packet. SCSI Request Packet. See HostAdapterStatus, TargetStatus,
@retval EFI_INVALID_PARAMETER ScsiIo is NULL. SenseDataLength, and SenseData in that order for
additional status information.
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
is not supported by the SCSI initiator(i.e., SCSI is not supported by the SCSI initiator(i.e., SCSI
Host Controller). Host Controller). The SCSI Request Packet was not
sent, so no additional status information is available.
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
Request Packet to execute. Request Packet to execute. See HostAdapterStatus,
TargetStatus, SenseDataLength, and SenseData in that
order for additional status information.
**/ **/
EFI_STATUS EFI_STATUS
@ -188,11 +291,11 @@ EFIAPI
ScsiModeSense10Command ( ScsiModeSense10Command (
IN EFI_SCSI_IO_PROTOCOL *ScsiIo, IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
IN UINT64 Timeout, IN UINT64 Timeout,
IN VOID *SenseData, IN OUT VOID *SenseData, OPTIONAL
IN OUT UINT8 *SenseDataLength, IN OUT UINT8 *SenseDataLength,
OUT UINT8 *HostAdapterStatus, OUT UINT8 *HostAdapterStatus,
OUT UINT8 *TargetStatus, OUT UINT8 *TargetStatus,
IN VOID *DataBuffer, IN OUT VOID *DataBuffer, OPTIONAL
IN OUT UINT32 *DataLength, IN OUT UINT32 *DataLength,
IN UINT8 DBDField, OPTIONAL IN UINT8 DBDField, OPTIONAL
IN UINT8 PageControl, IN UINT8 PageControl,
@ -202,20 +305,19 @@ ScsiModeSense10Command (
/** /**
Function to submit SCSI request sense command. Execute Request Sense SCSI command on a specific SCSI target.
Submit SCSI request sense command with the SCSI requested packet specified by this
SCSI command, TimeOut and SenseData, and then return the status of scsi unit execution.
Executes the Request Sense command on the SCSI target specified by ScsiIo.
If Timeout is zero, then this function waits indefinitely for the command to complete.
If Timeout is greater than zero, then the command is executed and will timeout after Timeout 100 ns units.
If ScsiIo is NULL, then ASSERT().
If SenseDataLength is NULL, then ASSERT(). If SenseDataLength is NULL, then ASSERT().
If HostAdapterStatus is NULL, then ASSERT(). If HostAdapterStatus is NULL, then ASSERT().
If TargetStatus is NULL, then ASSERT(). If TargetStatus is NULL, then ASSERT().
@param[in] ScsiIo A pointer to SCSI IO protocol. @param[in] ScsiIo A pointer to SCSI IO protocol.
@param[in] Timeout The length of timeout period. @param[in] Timeout The length of timeout period.
@param[in] SenseData A pointer to output sense data. @param[in, out] SenseData A pointer to output sense data.
@param[in, out] SenseDataLength The length of output sense data. @param[in, out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter. @param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target. @param[out] TargetStatus The status of the target.
@ -227,7 +329,6 @@ ScsiModeSense10Command (
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by
the SCSI initiator(i.e., SCSI Host Controller) the SCSI initiator(i.e., SCSI Host Controller)
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute. @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
@retval EFI_INVALID_PARAMETER ScsiIo is NULL.
**/ **/
EFI_STATUS EFI_STATUS
@ -235,7 +336,7 @@ EFIAPI
ScsiRequestSenseCommand ( ScsiRequestSenseCommand (
IN EFI_SCSI_IO_PROTOCOL *ScsiIo, IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
IN UINT64 Timeout, IN UINT64 Timeout,
IN VOID *SenseData, IN OUT VOID *SenseData, OPTIONAL
IN OUT UINT8 *SenseDataLength, IN OUT UINT8 *SenseDataLength,
OUT UINT8 *HostAdapterStatus, OUT UINT8 *HostAdapterStatus,
OUT UINT8 *TargetStatus OUT UINT8 *TargetStatus
@ -243,26 +344,25 @@ ScsiRequestSenseCommand (
/** /**
Function to submit read capacity command. Execute Read Capacity SCSI command on a specific SCSI target.
Submit SCSI read capacity command with the SCSI request packet specified by this SCSI
command and the input parameters, and then return the status of Scsi unit execution.
Executes the SCSI Read Capacity command on the SCSI target specified by ScsiIo.
If Timeout is zero, then this function waits indefinitely for the command to complete.
If Timeout is greater than zero, then the command is executed and will timeout after
Timeout 100 ns units. The PMI parameter is used to construct the CDB for this SCSI command.
If ScsiIo is NULL, then ASSERT().
If SenseDataLength is NULL, then ASSERT(). If SenseDataLength is NULL, then ASSERT().
If HostAdapterStatus is NULL, then ASSERT(). If HostAdapterStatus is NULL, then ASSERT().
If TargetStatus is NULL, then ASSERT(). If TargetStatus is NULL, then ASSERT().
If DataLength is NULL, then ASSERT(). If DataLength is NULL, then ASSERT().
@param[in] ScsiIo A pointer to SCSI IO protocol. @param[in] ScsiIo A pointer to SCSI IO protocol.
@param[in] Timeout The length of timeout period. @param[in] Timeout The length of timeout period.
@param[in] SenseData A pointer to output sense data. @param[in, out] SenseData A pointer to output sense data.
@param[in, out] SenseDataLength The length of output sense data. @param[in, out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter. @param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target. @param[out] TargetStatus The status of the target.
@param[out] DataBuffer A pointer to a data buffer. @param[in, out] DataBuffer A pointer to a data buffer.
@param[in, out] DataLength The length of data buffer. @param[in, out] DataLength The length of data buffer.
@param[in] PMI Partial medium indicator. @param[in] PMI Partial medium indicator.
@ -275,7 +375,6 @@ ScsiRequestSenseCommand (
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by
the SCSI initiator(i.e., SCSI Host Controller) the SCSI initiator(i.e., SCSI Host Controller)
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute. @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
@retval EFI_INVALID_PARAMETER ScsiIo is NULL.
**/ **/
EFI_STATUS EFI_STATUS
@ -283,37 +382,38 @@ EFIAPI
ScsiReadCapacityCommand ( ScsiReadCapacityCommand (
IN EFI_SCSI_IO_PROTOCOL *ScsiIo, IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
IN UINT64 Timeout, IN UINT64 Timeout,
IN VOID *SenseData, IN OUT VOID *SenseData, OPTIONAL
IN OUT UINT8 *SenseDataLength, IN OUT UINT8 *SenseDataLength,
OUT UINT8 *HostAdapterStatus, OUT UINT8 *HostAdapterStatus,
OUT UINT8 *TargetStatus, OUT UINT8 *TargetStatus,
OUT VOID *DataBuffer, IN OUT VOID *DataBuffer, OPTIONAL
IN OUT UINT32 *DataLength, IN OUT UINT32 *DataLength,
IN BOOLEAN PMI IN BOOLEAN PMI
); );
/** /**
Function to submit read 10 command. Execute Read(10) SCSI command on a specific SCSI target.
Submit SCSI read (10) command with the SCSI request packet specified by this SCSI command
and the input parameters, and then return the status of Scsi unit execution.
Executes the SCSI Read(10) command on the SCSI target specified by ScsiIo.
If Timeout is zero, then this function waits indefinitely for the command to complete.
If Timeout is greater than zero, then the command is executed and will timeout
after Timeout 100 ns units. The StartLba and SectorSize parameters are used to
construct the CDB for this SCSI command.
If ScsiIo is NULL, then ASSERT().
If SenseDataLength is NULL, then ASSERT(). If SenseDataLength is NULL, then ASSERT().
If HostAdapterStatus is NULL, then ASSERT(). If HostAdapterStatus is NULL, then ASSERT().
If TargetStatus is NULL, then ASSERT(). If TargetStatus is NULL, then ASSERT().
If DataLength is NULL, then ASSERT(). If DataLength is NULL, then ASSERT().
@param[in] ScsiIo A pointer to SCSI IO protocol. @param[in] ScsiIo A pointer to SCSI IO protocol.
@param[in] Timeout The length of timeout period. @param[in] Timeout The length of timeout period.
@param[in] SenseData A pointer to output sense data. @param[in, out] SenseData A pointer to output sense data.
@param[in, out] SenseDataLength The length of output sense data. @param[in, out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter. @param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target. @param[out] TargetStatus The status of the target.
@param[out] DataBuffer Read 10 command data. @param[in, out] DataBuffer Read 10 command data.
@param[in, out] DataLength The length of data buffer. @param[in, out] DataLength The length of data buffer.
@param[in] StartLba The start address of LBA. @param[in] StartLba The start address of LBA.
@param[in] SectorSize The sector size. @param[in] SectorSize The sector size.
@ -327,7 +427,6 @@ ScsiReadCapacityCommand (
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by
the SCSI initiator(i.e., SCSI Host Controller) the SCSI initiator(i.e., SCSI Host Controller)
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute. @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
@retval EFI_INVALID_PARAMETER ScsiIo is NULL.
**/ **/
EFI_STATUS EFI_STATUS
@ -335,11 +434,11 @@ EFIAPI
ScsiRead10Command ( ScsiRead10Command (
IN EFI_SCSI_IO_PROTOCOL *ScsiIo, IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
IN UINT64 Timeout, IN UINT64 Timeout,
IN VOID *SenseData, IN OUT VOID *SenseData, OPTIONAL
IN OUT UINT8 *SenseDataLength, IN OUT UINT8 *SenseDataLength,
OUT UINT8 *HostAdapterStatus, OUT UINT8 *HostAdapterStatus,
OUT UINT8 *TargetStatus, OUT UINT8 *TargetStatus,
OUT VOID *DataBuffer, IN OUT VOID *DataBuffer, OPTIONAL
IN OUT UINT32 *DataLength, IN OUT UINT32 *DataLength,
IN UINT32 StartLba, IN UINT32 StartLba,
IN UINT32 SectorSize IN UINT32 SectorSize
@ -347,26 +446,26 @@ ScsiRead10Command (
/** /**
Function to submit SCSI write 10 command. Execute Write(10) SCSI command on a specific SCSI target.
Submit SCSI write (10) command with the SCSI request packet specified by this SCSI command and the
input parameters, and then return the status of Scsi unit execution.
Executes the SCSI Write(10) command on the SCSI target specified by ScsiIo.
If Timeout is zero, then this function waits indefinitely for the command to complete.
If Timeout is greater than zero, then the command is executed and will timeout after
Timeout 100 ns units. The StartLba and SectorSize parameters are used to construct
the CDB for this SCSI command.
If ScsiIo is NULL, then ASSERT().
If SenseDataLength is NULL, then ASSERT(). If SenseDataLength is NULL, then ASSERT().
If HostAdapterStatus is NULL, then ASSERT(). If HostAdapterStatus is NULL, then ASSERT().
If TargetStatus is NULL, then ASSERT(). If TargetStatus is NULL, then ASSERT().
If DataLength is NULL, then ASSERT(). If DataLength is NULL, then ASSERT().
@param[in] ScsiIo SCSI IO Protocol to use @param[in] ScsiIo SCSI IO Protocol to use
@param[in] Timeout The length of timeout period. @param[in] Timeout The length of timeout period.
@param[in] SenseData A pointer to output sense data. @param[in, out] SenseData A pointer to output sense data.
@param[in, out] SenseDataLength The length of output sense data. @param[in, out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter. @param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target. @param[out] TargetStatus The status of the target.
@param[out] DataBuffer A pointer to a data buffer. @param[in, out] DataBuffer A pointer to a data buffer.
@param[in, out] DataLength The length of data buffer. @param[in, out] DataLength The length of data buffer.
@param[in] StartLba The start address of LBA. @param[in] StartLba The start address of LBA.
@param[in] SectorSize The sector size. @param[in] SectorSize The sector size.
@ -380,7 +479,6 @@ ScsiRead10Command (
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by
the SCSI initiator(i.e., SCSI Host Controller) the SCSI initiator(i.e., SCSI Host Controller)
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute. @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
@retval EFI_INVALID_PARAMETER ScsiIo is NULL.
**/ **/
EFI_STATUS EFI_STATUS
@ -388,11 +486,11 @@ EFIAPI
ScsiWrite10Command ( ScsiWrite10Command (
IN EFI_SCSI_IO_PROTOCOL *ScsiIo, IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
IN UINT64 Timeout, IN UINT64 Timeout,
IN VOID *SenseData, IN OUT VOID *SenseData, OPTIONAL
IN OUT UINT8 *SenseDataLength, IN OUT UINT8 *SenseDataLength,
OUT UINT8 *HostAdapterStatus, OUT UINT8 *HostAdapterStatus,
OUT UINT8 *TargetStatus, OUT UINT8 *TargetStatus,
OUT VOID *DataBuffer, IN OUT VOID *DataBuffer, OPTIONAL
IN OUT UINT32 *DataLength, IN OUT UINT32 *DataLength,
IN UINT32 StartLba, IN UINT32 StartLba,
IN UINT32 SectorSize IN UINT32 SectorSize

447
MdePkg/Include/Library/UefiUsbLib.h
View File

@ -18,6 +18,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#define __USB_DXE_LIB_H__ #define __USB_DXE_LIB_H__
#include <Protocol/UsbIo.h> #include <Protocol/UsbIo.h>
#include <IndustryStandard/Usb.h>
/// ///
/// define the timeout time as 3ms /// define the timeout time as 3ms
@ -25,57 +26,78 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#define TIMEOUT_VALUE 3 * 1000 #define TIMEOUT_VALUE 3 * 1000
/** /**
Get Hid Descriptor. Get the descriptor of the specified USB HID interface.
@param UsbIo A pointer to EFI_USB_IO_PROTOCOL. Submit a USB get HID descriptor request for the USB device specified by UsbIo
@param InterfaceNum Hid interface number. and Interface and return the HID descriptor in HidDescriptor.
@param HidDescriptor Caller allocated buffer to store Usb hid descriptor if If UsbIo is NULL, then ASSERT().
successfully returned. If HidDescriptor is NULL, then ASSERT().
@return Status of getting HID descriptor through USB I/O @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
protocol's UsbControlTransfer(). @param Interface The index of the HID interface on the USB target.
@param HidDescriptor Pointer to the USB HID descriptor that was retrieved from
the specified USB target and interface. Type EFI_USB_HID_DESCRIPTOR
is defined in the MDE Package Industry Standard include file Usb.h.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
UsbGetHidDescriptor ( UsbGetHidDescriptor (
IN EFI_USB_IO_PROTOCOL *UsbIo, IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT8 InterfaceNum, IN UINT8 Interface,
OUT EFI_USB_HID_DESCRIPTOR *HidDescriptor OUT EFI_USB_HID_DESCRIPTOR *HidDescriptor
); );
/** /**
get Report Class descriptor. Get the report descriptor of the specified USB HID interface.
@param UsbIo A pointer to EFI_USB_IO_PROTOCOL. Submit a USB get HID report descriptor request for the USB device specified by
@param InterfaceNum Report interface number. UsbIo and Interface and return the report descriptor in DescriptorBuffer.
@param DescriptorSize Length of DescriptorBuffer. If UsbIo is NULL, then ASSERT().
@param DescriptorBuffer Caller allocated buffer to store Usb report descriptor If DescriptorBuffer is NULL, then ASSERT().
if successfully returned.
@return Status of getting Report Class descriptor through USB @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
I/O protocol's UsbControlTransfer(). @param Interface The index of the report interface on the USB target.
@param DescriptorLength The size, in bytes, of DescriptorBuffer.
@param DescriptorBuffer A pointer to the buffer to store the report class descriptor.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_OUT_OF_RESOURCES The request could not be completed because the
buffer specifed by DescriptorLength and DescriptorBuffer
is not large enough to hold the result of the request.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
UsbGetReportDescriptor ( UsbGetReportDescriptor (
IN EFI_USB_IO_PROTOCOL *UsbIo, IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT8 InterfaceNum, IN UINT8 Interface,
IN UINT16 DescriptorSize, IN UINT16 DescriptorLength,
OUT UINT8 *DescriptorBuffer OUT UINT8 *DescriptorBuffer
); );
/** /**
Get Hid Protocol Request. Get the HID protocol of the specified USB HID interface.
@param UsbIo A pointer to EFI_USB_IO_PROTOCOL. Submit a USB get HID protocol request for the USB device specified by UsbIo
@param Interface Which interface the caller wants to get protocol. and Interface and return the protocol retrieved in Protocol.
@param Protocol Protocol value returned. If UsbIo is NULL, then ASSERT().
If Protocol is NULL, then ASSERT().
@return Status of getting Protocol Request through USB I/O @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
protocol's UsbControlTransfer(). @param Interface The index of the report interface on the USB target.
@param Protocol A pointer to the protocol for the specified USB target.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
**/ **/
EFI_STATUS EFI_STATUS
@ -87,14 +109,19 @@ UsbGetProtocolRequest (
); );
/** /**
Set Hid Protocol Request. Set the HID protocol of the specified USB HID interface.
@param UsbIo A pointer to EFI_USB_IO_PROTOCOL. Submit a USB set HID protocol request for the USB device specified by UsbIo
@param Interface Which interface the caller wants to set protocol. and Interface and set the protocol to the value specified by Protocol.
@param Protocol Protocol value the caller wants to set. If UsbIo is NULL, then ASSERT().
@return Status of setting Protocol Request through USB I/O @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
protocol's UsbControlTransfer(). @param Interface The index of the report interface on the USB target.
@param Protocol The protocol value to set for the specified USB target.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
**/ **/
EFI_STATUS EFI_STATUS
@ -106,15 +133,20 @@ UsbSetProtocolRequest (
); );
/** /**
Set Idel request. Set the idle rate of the specified USB HID report.
@param UsbIo A pointer to EFI_USB_IO_PROTOCOL. Submit a USB set HID report idle request for the USB device specified by UsbIo,
@param Interface Which interface the caller wants to set. Interface, and ReportId, and set the idle rate to the value specified by Duration.
@param ReportId Which report the caller wants to set. If UsbIo is NULL, then ASSERT().
@param Duration Idle rate the caller wants to set.
@return Status of setting IDLE Request through USB I/O @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
protocol's UsbControlTransfer(). @param Interface The index of the report interface on the USB target.
@param ReportId The identifier of the report to retrieve.
@param Duration The idle rate to set for the specified USB target.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
**/ **/
EFI_STATUS EFI_STATUS
@ -127,15 +159,21 @@ UsbSetIdleRequest (
); );
/** /**
Get Idel request. Get the idle rate of the specified USB HID report.
@param UsbIo A pointer to EFI_USB_IO_PROTOCOL. Submit a USB get HID report idle request for the USB device specified by UsbIo,
@param Interface Which interface the caller wants to get. Interface, and ReportId, and return the ide rate in Duration.
@param ReportId Which report the caller wants to get. If UsbIo is NULL, then ASSERT().
@param Duration Idle rate the caller wants to get. If Duration is NULL, then ASSERT().
@return Status of getting IDLE Request through USB I/O @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
protocol's UsbControlTransfer(). @param Interface The index of the report interface on the USB target.
@param ReportId The identifier of the report to retrieve.
@param Duration A pointer to the idle rate retrieved from the specified USB target.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
**/ **/
EFI_STATUS EFI_STATUS
@ -148,17 +186,18 @@ UsbGetIdleRequest (
); );
/** /**
Hid Set Report request. Set the report descriptor of the specified USB HID interface.
@param UsbIo A pointer to EFI_USB_IO_PROTOCOL. @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@param Interface Which interface the caller wants to set. @param Interface The index of the report interface on the USB target.
@param ReportId Which report the caller wants to set. @param ReportId The identifier of the report to retrieve.
@param ReportType Type of report. @param ReportType The type of report to retrieve.
@param ReportLen Length of report descriptor. @param ReportLength The size, in bytes, of Report.
@param Report Report Descriptor buffer. @param Report A pointer to the report descriptor buffer to set.
@return Status of setting Report Request through USB I/O @retval EFI_SUCCESS The request executed successfully.
protocol's UsbControlTransfer(). @retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
**/ **/
EFI_STATUS EFI_STATUS
@ -173,17 +212,27 @@ UsbSetReportRequest (
); );
/** /**
Hid Set Report request. Get the report descriptor of the specified USB HID interface.
@param UsbIo A pointer to EFI_USB_IO_PROTOCOL. Submit a USB get HID report request for the USB device specified by UsbIo,
@param Interface Which interface the caller wants to set. Interface, ReportId, and ReportType, and return the report in the buffer
@param ReportId Which report the caller wants to set. specified by Report.
@param ReportType Type of report. If UsbIo is NULL, then ASSERT().
@param ReportLen Length of report descriptor. If Report is NULL, then ASSERT().
@param Report Caller allocated buffer to store Report Descriptor.
@return Status of getting Report Request through USB I/O @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
protocol's UsbControlTransfer(). @param Interface The index of the report interface on the USB target.
@param ReportId The identifier of the report to retrieve.
@param ReportType The type of report to retrieve.
@param ReportLength The size, in bytes, of Report.
@param Report A pointer to the buffer to store the report descriptor.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_OUT_OF_RESOURCES The request could not be completed because the
buffer specifed by ReportLength and Report is not
large enough to hold the result of the request.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
**/ **/
EFI_STATUS EFI_STATUS
@ -198,18 +247,29 @@ UsbGetReportRequest (
); );
/** /**
Usb Get Descriptor. Get the descriptor of the specified USB device.
@param UsbIo A pointer to EFI_USB_IO_PROTOCOL. Submit a USB get descriptor request for the USB device specified by UsbIo, Value,
@param Value Device Request Value. and Index, and return the descriptor in the buffer specified by Descriptor.
@param Index Device Request Index. The status of the transfer is returned in Status.
@param DescriptorLength Descriptor Length. If UsbIo is NULL, then ASSERT().
@param Descriptor Descriptor buffer to contain result. If Descriptor is NULL, then ASSERT().
@param Status Transfer Status. If Status is NULL, then ASSERT().
@retval EFI_INVALID_PARAMETER Parameter is error. @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@retval EFI_SUCCESS Success. @param Value The device request value.
@retval EFI_TIMEOUT Device has no response. @param Index The device request index.
@param DescriptorLength The size, in bytes, of Descriptor.
@param Descriptor A pointer to the descriptor buffer to get.
@param Status A pointer to the status of the transfer.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_OUT_OF_RESOURCES The request could not be completed because the
buffer specifed by DescriptorLength and Descriptor
is not large enough to hold the result of the request.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error. The transfer
status is returned in Status.
**/ **/
EFI_STATUS EFI_STATUS
@ -224,18 +284,26 @@ UsbGetDescriptor (
); );
/** /**
Usb Set Descriptor. Set the descriptor of the specified USB device.
@param UsbIo A pointer to EFI_USB_IO_PROTOCOL. Submit a USB set descriptor request for the USB device specified by UsbIo,
@param Value Device Request Value. Value, and Index, and set the descriptor using the buffer specified by DesriptorLength
@param Index Device Request Index. and Descriptor. The status of the transfer is returned in Status.
@param DescriptorLength Descriptor Length. If UsbIo is NULL, then ASSERT().
@param Descriptor Descriptor buffer to set. If Descriptor is NULL, then ASSERT().
@param Status Transfer Status. If Status is NULL, then ASSERT().
@retval EFI_INVALID_PARAMETER Parameter is error. @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@retval EFI_SUCCESS Success. @param Value The device request value.
@retval EFI_TIMEOUT Device has no response. @param Index The device request index.
@param DescriptorLength The size, in bytes, of Descriptor.
@param Descriptor A pointer to the descriptor buffer to set.
@param Status A pointer to the status of the transfer.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
The transfer status is returned in Status.
**/ **/
EFI_STATUS EFI_STATUS
@ -250,178 +318,245 @@ UsbSetDescriptor (
); );
/** /**
Usb Get Device Interface. Get the interface setting of the specified USB device.
@param UsbIo A pointer to EFI_USB_IO_PROTOCOL. Submit a USB get interface request for the USB device specified by UsbIo,
@param Index Interface index value. and Interface, and place the result in the buffer specified by AlternateSetting.
@param AltSetting Alternate setting. The status of the transfer is returned in Status.
@param Status Trasnsfer status. If UsbIo is NULL, then ASSERT().
If AlternateSetting is NULL, then ASSERT().
If Status is NULL, then ASSERT().
@retval EFI_INVALID_PARAMETER Parameter is error. @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@retval EFI_SUCCESS Success. @param Interface The interface index value.
@retval EFI_TIMEOUT Device has no response. @param AlternateSetting A pointer to the alternate setting to be retrieved.
@param Status A pointer to the status of the transfer.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
The transfer status is returned in Status.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
UsbGetInterface ( UsbGetInterface (
IN EFI_USB_IO_PROTOCOL *UsbIo, IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT16 Index, IN UINT16 Interface,
OUT UINT8 *AltSetting, OUT UINT8 *AlternateSetting,
OUT UINT32 *Status OUT UINT32 *Status
); );
/** /**
Usb Set Device Interface. Set the interface setting of the specified USB device.
@param UsbIo A pointer to EFI_USB_IO_PROTOCOL. Submit a USB set interface request for the USB device specified by UsbIo, and
@param InterfaceNo Interface Number. Interface, and set the alternate setting to the value specified by AlternateSetting.
@param AltSetting Alternate setting. The status of the transfer is returned in Status.
@param Status Trasnsfer status. If UsbIo is NULL, then ASSERT().
If Status is NULL, then ASSERT().
@retval EFI_INVALID_PARAMETER Parameter is error. @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@retval EFI_SUCCESS Success. @param Interface The interface index value.
@retval EFI_TIMEOUT Device has no response. @param AlternateSetting The alternate setting to be set.
@param Status A pointer to the status of the transfer.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_SUCCESS The request failed due to a device error.
The transfer status is returned in Status.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
UsbSetInterface ( UsbSetInterface (
IN EFI_USB_IO_PROTOCOL *UsbIo, IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT16 InterfaceNo, IN UINT16 Interface,
IN UINT16 AltSetting, IN UINT16 AlternateSetting,
OUT UINT32 *Status OUT UINT32 *Status
); );
/** /**
Usb Get Device Configuration. Get the device configuration.
@param UsbIo A pointer to EFI_USB_IO_PROTOCOL. Submit a USB get configuration request for the USB device specified by UsbIo
@param ConfigValue Config Value. and place the result in the buffer specified by ConfigurationValue. The status
@param Status Transfer Status. of the transfer is returned in Status.
If UsbIo is NULL, then ASSERT().
If ConfigurationValue is NULL, then ASSERT().
If Status is NULL, then ASSERT().
@retval EFI_INVALID_PARAMETER Parameter is error. @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@retval EFI_SUCCESS Success. @param ConfigurationValue A pointer to the device configuration to be retrieved.
@retval EFI_TIMEOUT Device has no response. @param Status A pointer to the status of the transfer.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
The transfer status is returned in Status.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
UsbGetConfiguration ( UsbGetConfiguration (
IN EFI_USB_IO_PROTOCOL *UsbIo, IN EFI_USB_IO_PROTOCOL *UsbIo,
OUT UINT8 *ConfigValue, OUT UINT8 *ConfigurationValue,
OUT UINT32 *Status OUT UINT32 *Status
); );
/** /**
Usb Set Device Configuration. Set the device configuration.
@param UsbIo A pointer to EFI_USB_IO_PROTOCOL. Submit a USB set configuration request for the USB device specified by UsbIo
@param Value Configuration Value to set. and set the device configuration to the value specified by ConfigurationValue.
@param Status Transfer status. The status of the transfer is returned in Status.
If UsbIo is NULL, then ASSERT().
If Status is NULL, then ASSERT().
@retval EFI_INVALID_PARAMETER Parameter is error. @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@retval EFI_SUCCESS Success. @param ConfigurationValue The device configuration value to be set.
@retval EFI_TIMEOUT Device has no response. @param Status A pointer to the status of the transfer.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
The transfer status is returned in Status.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
UsbSetConfiguration ( UsbSetConfiguration (
IN EFI_USB_IO_PROTOCOL *UsbIo, IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT16 Value, IN UINT16 ConfigurationValue,
OUT UINT32 *Status OUT UINT32 *Status
); );
/** /**
Usb Set Device Feature. Set the specified feature of the specified device.
@param UsbIo A pointer to EFI_USB_IO_PROTOCOL. Submit a USB set device feature request for the USB device specified by UsbIo,
@param Recipient Interface/Device/Endpoint. Recipient, and Target to the value specified by Value. The status of the
@param Value Request value. transfer is returned in Status.
@param Target Request Index. If UsbIo is NULL, then ASSERT().
@param Status Transfer status. If Status is NULL, then ASSERT().
@retval EFI_INVALID_PARAMETER Parameter is error. @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@retval EFI_SUCCESS Success. @param Recipient The USB data recipient type (i.e. Device, Interface, Endpoint).
@retval EFI_TIMEOUT Device has no response. Type USB_TYPES_DEFINITION is defined in the MDE Package Industry
Standard include file Usb.h.
@param Value The value of the feature to be set.
@param Target The index of the device to be set.
@param Status A pointer to the status of the transfer.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
The transfer status is returned in Status.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
UsbSetFeature ( UsbSetFeature (
IN EFI_USB_IO_PROTOCOL *UsbIo, IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINTN Recipient, IN USB_TYPES_DEFINITION Recipient,
IN UINT16 Value, IN UINT16 Value,
IN UINT16 Target, IN UINT16 Target,
OUT UINT32 *Status OUT UINT32 *Status
); );
/** /**
Usb Clear Device Feature. Clear the specified feature of the specified device.
@param UsbIo A pointer to EFI_USB_IO_PROTOCOL. Submit a USB clear device feature request for the USB device specified by UsbIo,
@param Recipient Interface/Device/Endpoint. Recipient, and Target to the value specified by Value. The status of the transfer
@param Value Request value. is returned in Status.
@param Target Request Index. If UsbIo is NULL, then ASSERT().
@param Status Transfer status. If Status is NULL, then ASSERT().
@retval EFI_INVALID_PARAMETER Parameter is error. @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@retval EFI_SUCCESS Success. @param Recipient The USB data recipient type (i.e. Device, Interface, Endpoint).
@retval EFI_TIMEOUT Device has no response. Type USB_TYPES_DEFINITION is defined in the MDE Package Industry Standard
include file Usb.h.
@param Value The value of the feature to be cleared.
@param Target The index of the device to be cleared.
@param Status A pointer to the status of the transfer.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
The transfer status is returned in Status.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
UsbClearFeature ( UsbClearFeature (
IN EFI_USB_IO_PROTOCOL *UsbIo, IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINTN Recipient, IN USB_TYPES_DEFINITION Recipient,
IN UINT16 Value, IN UINT16 Value,
IN UINT16 Target, IN UINT16 Target,
OUT UINT32 *Status OUT UINT32 *Status
); );
/** /**
Usb Get Device Status. Get the status of the specified device.
@param UsbIo A pointer to EFI_USB_IO_PROTOCOL. Submit a USB device get status request for the USB device specified by UsbIo,
@param Recipient Interface/Device/Endpoint. Recipient, and Target and place the result in the buffer specified by DeviceStatus.
@param Target Request index. The status of the transfer is returned in Status.
@param DevStatus Device status. If UsbIo is NULL, then ASSERT().
@param Status Transfer status. If DeviceStatus is NULL, then ASSERT().
If Status is NULL, then ASSERT().
@retval EFI_INVALID_PARAMETER Parameter is error. @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@retval EFI_SUCCESS Success. @param Recipient The USB data recipient type (i.e. Device, Interface, Endpoint).
@retval EFI_TIMEOUT Device has no response. Type USB_TYPES_DEFINITION is defined in the MDE Package Industry Standard
include file Usb.h.
@param Target The index of the device to be get the status of.
@param DeviceStatus A pointer to the device status to be retrieved.
@param Status A pointer to the status of the transfer.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
The transfer status is returned in Status.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
UsbGetStatus ( UsbGetStatus (
IN EFI_USB_IO_PROTOCOL *UsbIo, IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINTN Recipient, IN USB_TYPES_DEFINITION Recipient,
IN UINT16 Target, IN UINT16 Target,
OUT UINT16 *DevStatus, OUT UINT16 *DevStatus,
OUT UINT32 *Status OUT UINT32 *Status
); );
/** /**
Clear endpoint stall. Clear halt feature of the specified usb endpoint.
@param UsbIo A pointer to EFI_USB_IO_PROTOCOL. Retrieve the USB endpoint descriptor specified by UsbIo and EndPoint.
@param EndpointNo Endpoint Number. If the USB endpoint descriptor can not be retrieved, then return EFI_NOT_FOUND.
@param Status Transfer Status. If the endpoint descriptor is found, then clear the halt fature of this USB endpoint.
The status of the transfer is returned in Status.
If UsbIo is NULL, then ASSERT().
If Status is NULL, then ASSERT().
@retval EFI_NOT_FOUND Can't find the Endpoint. @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@retval EFI_DEVICE_ERROR Hardware error. @param Endpoint The endpoint address.
@retval EFI_SUCCESS Success. @param Status A pointer to the status of the transfer.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
The transfer status is returned in Status.
@retval EFI_NOT_FOUND The specified USB endpoint descriptor can not be found
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
UsbClearEndpointHalt ( UsbClearEndpointHalt (
IN EFI_USB_IO_PROTOCOL *UsbIo, IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT8 EndpointNo, IN UINT8 Endpoint,
OUT UINT32 *Status OUT UINT32 *Status
); );

406
MdePkg/Library/UefiScsiLib/UefiScsiLib.c
View File

@ -20,6 +20,7 @@
#include <IndustryStandard/Scsi.h> #include <IndustryStandard/Scsi.h>
// //
// Max bytes needed to represent ID of a SCSI device // Max bytes needed to represent ID of a SCSI device
// //
@ -37,41 +38,73 @@
#define EFI_SCSI_OP_LENGTH_SIX 0x6 #define EFI_SCSI_OP_LENGTH_SIX 0x6
#define EFI_SCSI_OP_LENGTH_TEN 0xa #define EFI_SCSI_OP_LENGTH_TEN 0xa
/** /**
Function test the ready status of the SCSI unit. Execute Test Unit Ready SCSI command on a specific SCSI target.
Submit SCSI test unit ready command with SCSI request packet specified by this scsi command, TimeOut
and SenseData, then get the status of the target Scsi unit.
Executes the Test Unit Ready command on the SCSI target specified by ScsiIo.
If Timeout is zero, then this function waits indefinitely for the command to complete.
If Timeout is greater than zero, then the command is executed and will timeout after Timeout 100 ns units.
If ScsiIo is NULL, then ASSERT().
If SenseDataLength is NULL, then ASSERT(). If SenseDataLength is NULL, then ASSERT().
If HostAdapterStatus is NULL, then ASSERT(). If HostAdapterStatus is NULL, then ASSERT().
If TargetStatus is NULL, then ASSERT(). If TargetStatus is NULL, then ASSERT().
@param[in] ScsiIo A pointer to SCSI IO protocol.
@param[in] Timeout The length of timeout period.
@param[in] SenseData A pointer to output sense data.
@param[out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target.
@retval EFI_SUCCESS The status of the unit is tested successfully. @param[in] ScsiIo A pointer to the SCSI I/O Protocol instance
for the specific SCSI target.
@param[in] Timeout The timeout in 100 ns units to use for the execution
of this SCSI Request Packet. A Timeout value of
zero means that this function will wait indefinitely
for the SCSI Request Packet to execute. If Timeout
is greater than zero, then this function will return
EFI_TIMEOUT if the time required to execute the SCSI
Request Packet is greater than Timeout.
@param[in, out] SenseData A pointer to sense data that was generated by
the execution of the SCSI Request Packet. This
buffer must be allocated by the caller.
If SenseDataLength is 0, then this parameter is
optional and may be NULL.
@param[in, out] SenseDataLength On input, a pointer to the length in bytes of
the SenseData buffer. On output, a poiinter to
the number of bytes written to the SenseData buffer.
@param[out] HostAdapterStatus The status of the SCSI Host Controller that produces
the SCSI bus containing the SCSI target specified by
ScsiIo when the SCSI Request Packet was executed.
See the EFI SCSI I/O Protocol in the UEFI Specification
for details on the possible return values.
@param[out] TargetStatus The status returned by the SCSI target specified
by ScsiIo when the SCSI Request Packat was executed
on the SCSI Host Controller. See the EFI SCSI I/O
Protocol in the UEFI Specification for details on
the possible return values.
@retval EFI_SUCCESS The command was executed successfully.
See HostAdapterStatus, TargetStatus, SenseDataLength,
and SenseData in that order for additional status
information.
@retval EFI_NOT_READY The SCSI Request Packet could not be sent because
there are too many SCSI Command Packets already
queued. The SCSI Request Packet was not sent, so
no additional status information is available.
The caller may retry again later.
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send
SCSI Request Packet. See HostAdapterStatus,
TargetStatus, SenseDataLength, and SenseData in that
order for additional status information.
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
is not supported by the SCSI initiator(i.e., SCSI
Host Controller). The SCSI Request Packet was not
sent, so no additional status information is available.
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request
Packet to execute. See HostAdapterStatus, TargetStatus,
SenseDataLength, and SenseData in that order for
additional status information.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
but the entire DataBuffer could not be transferred. but the entire DataBuffer could not be transferred.
The actual number of bytes transferred is returned The actual number of bytes transferred is returned
in InTransferLength. in InTransferLength.
@retval EFI_NOT_READY The SCSI Request Packet could not be sent because
there are too many SCSI Command Packets already
queued.
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send
the SCSI Request Packet.
@retval EFI_INVALID_PARAMETER ScsiIo is NULL.
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
is not supported by the SCSI initiator(i.e., SCSI
Host Controller).
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
Request Packet to execute.
**/ **/
EFI_STATUS EFI_STATUS
@ -79,8 +112,8 @@ EFIAPI
ScsiTestUnitReadyCommand ( ScsiTestUnitReadyCommand (
IN EFI_SCSI_IO_PROTOCOL *ScsiIo, IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
IN UINT64 Timeout, IN UINT64 Timeout,
IN VOID *SenseData, IN OUT VOID *SenseData, OPTIONAL
OUT UINT8 *SenseDataLength, IN OUT UINT8 *SenseDataLength,
OUT UINT8 *HostAdapterStatus, OUT UINT8 *HostAdapterStatus,
OUT UINT8 *TargetStatus OUT UINT8 *TargetStatus
) )
@ -95,10 +128,7 @@ ScsiTestUnitReadyCommand (
ASSERT (SenseDataLength != NULL); ASSERT (SenseDataLength != NULL);
ASSERT (HostAdapterStatus != NULL); ASSERT (HostAdapterStatus != NULL);
ASSERT (TargetStatus != NULL); ASSERT (TargetStatus != NULL);
ASSERT (ScsiIo != NULL);
if (ScsiIo == NULL) {
return EFI_INVALID_PARAMETER;
}
ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET)); ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET));
ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_SIX); ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_SIX);
@ -132,45 +162,81 @@ ScsiTestUnitReadyCommand (
/** /**
Function to submit SCSI inquiry command. Execute Inquiry SCSI command on a specific SCSI target.
Submit SCSI inquiry command with the SCSI request packet specified by this SCSI command and input
parameters, then return the status of Scsi unit execution.
Executes the Inquiry command on the SCSI target specified by ScsiIo.
If Timeout is zero, then this function waits indefinitely for the command to complete.
If Timeout is greater than zero, then the command is executed and will timeout after Timeout 100 ns units.
If ScsiIo is NULL, then ASSERT().
If SenseDataLength is NULL, then ASSERT(). If SenseDataLength is NULL, then ASSERT().
If HostAdapterStatus is NULL, then ASSERT(). If HostAdapterStatus is NULL, then ASSERT().
If TargetStatus is NULL, then ASSERT(). If TargetStatus is NULL, then ASSERT().
If InquiryDataLength is NULL, then ASSERT(). If InquiryDataLength is NULL, then ASSERT().
@param[in] ScsiIo SCSI IO Protocol to use @param[in] ScsiIo A pointer to the SCSI I/O Protocol instance
@param[in] Timeout The length of timeout period. for the specific SCSI target.
@param[in] SenseData A pointer to output sense data. @param[in] Timeout The timeout in 100 ns units to use for the
@param[in, out] SenseDataLength The length of output sense data. execution of this SCSI Request Packet. A Timeout
@param[out] HostAdapterStatus The status of Host Adapter. value of zero means that this function will wait
@param[out] TargetStatus The status of the target. indefinitely for the SCSI Request Packet to execute.
@param[in, out] InquiryDataBuffer A pointer to inquiry data buffer. If Timeout is greater than zero, then this function
@param[in, out] InquiryDataLength The length of inquiry data buffer. will return EFI_TIMEOUT if the time required to
@param[in] EnableVitalProductData Boolean to enable Vital Product Data. execute the SCSI Request Packet is greater than Timeout.
@param[in, out] SenseData A pointer to sense data that was generated
by the execution of the SCSI Request Packet.
This buffer must be allocated by the caller.
If SenseDataLength is 0, then this parameter
is optional and may be NULL.
@param[in, out] SenseDataLength On input, the length in bytes of the SenseData buffer.
On output, the number of bytes written to the SenseData buffer.
@param[out] HostAdapterStatus The status of the SCSI Host Controller that
produces the SCSI bus containing the SCSI
target specified by ScsiIo when the SCSI
Request Packet was executed. See the EFI
SCSI I/O Protocol in the UEFI Specification
for details on the possible return values.
@param[out] TargetStatus The status returned by the SCSI target specified
by ScsiIo when the SCSI Request Packat was
executed on the SCSI Host Controller.
See the EFI SCSI I/O Protocol in the UEFI
Specification for details on the possible
return values.
@param[in, out] InquiryDataBuffer A pointer to inquiry data that was generated
by the execution of the SCSI Request Packet.
This buffer must be allocated by the caller.
If InquiryDataLength is 0, then this parameter
is optional and may be NULL.
@param[in, out] InquiryDataLength On input, a pointer to the length in bytes
of the InquiryDataBuffer buffer.
On output, a pointer to the number of bytes
written to the InquiryDataBuffer buffer.
@param[in] EnableVitalProductData If TRUE, then the supported vital product
data is returned in InquiryDataBuffer.
If FALSE, then the standard inquiry data is
returned in InquiryDataBuffer.
@retval EFI_SUCCESS Command is executed successfully. @retval EFI_SUCCESS The command was executed successfully. See HostAdapterStatus,
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, TargetStatus, SenseDataLength, and SenseData in that order
but the entire DataBuffer could not be transferred. for additional status information.
The actual number of bytes transferred is returned @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire
in TransferLength. InquiryDataBuffer could not be transferred. The actual
@retval EFI_NOT_READY The SCSI Request Packet could not be sent because number of bytes transferred is returned in InquiryDataLength.
there are too many SCSI Command Packets already @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there
queued. are too many SCSI Command Packets already queued.
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send The SCSI Request Packet was not sent, so no additional
the SCSI Request Packet. status information is available. The caller may retry again later.
@retval EFI_INVALID_PARAMETER ScsiIo is NULL. @retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet Request Packet. See HostAdapterStatus, TargetStatus,
is not supported by the SCSI initiator(i.e., SCSI SenseDataLength, and SenseData in that order for additional
Host Controller). status information.
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not
Request Packet to execute. supported by the SCSI initiator(i.e., SCSI Host Controller).
The SCSI Request Packet was not sent, so no additional
status information is available.
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request
Packet to execute. See HostAdapterStatus, TargetStatus,
SenseDataLength, and SenseData in that order for
additional status information.
**/ **/
EFI_STATUS EFI_STATUS
@ -178,11 +244,11 @@ EFIAPI
ScsiInquiryCommand ( ScsiInquiryCommand (
IN EFI_SCSI_IO_PROTOCOL *ScsiIo, IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
IN UINT64 Timeout, IN UINT64 Timeout,
IN VOID *SenseData, IN OUT VOID *SenseData, OPTIONAL
IN OUT UINT8 *SenseDataLength, IN OUT UINT8 *SenseDataLength,
OUT UINT8 *HostAdapterStatus, OUT UINT8 *HostAdapterStatus,
OUT UINT8 *TargetStatus, OUT UINT8 *TargetStatus,
IN OUT VOID *InquiryDataBuffer, IN OUT VOID *InquiryDataBuffer, OPTIONAL
IN OUT UINT32 *InquiryDataLength, IN OUT UINT32 *InquiryDataLength,
IN BOOLEAN EnableVitalProductData IN BOOLEAN EnableVitalProductData
) )
@ -198,10 +264,7 @@ ScsiInquiryCommand (
ASSERT (HostAdapterStatus != NULL); ASSERT (HostAdapterStatus != NULL);
ASSERT (TargetStatus != NULL); ASSERT (TargetStatus != NULL);
ASSERT (InquiryDataLength != NULL); ASSERT (InquiryDataLength != NULL);
ASSERT (ScsiIo != NULL);
if (ScsiIo == NULL) {
return EFI_INVALID_PARAMETER;
}
ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET)); ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET));
ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_SIX); ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_SIX);
@ -242,47 +305,84 @@ ScsiInquiryCommand (
/** /**
Function to submit SCSI mode sense 10 command. Execute Mode Sense(10) SCSI command on a specific SCSI target.
Submit SCSI Mode Sense (10) command with the SCSI request packet specified by this SCSI command and
the input parameters, then return the status of Scsi unit execution.
Executes the SCSI Mode Sense(10) command on the SCSI target specified by ScsiIo.
If Timeout is zero, then this function waits indefinitely for the command to complete.
If Timeout is greater than zero, then the command is executed and will timeout
after Timeout 100 ns units. The DBDField, PageControl, and PageCode parameters
are used to construct the CDB for this SCSI command.
If ScsiIo is NULL, then ASSERT().
If SenseDataLength is NULL, then ASSERT(). If SenseDataLength is NULL, then ASSERT().
If HostAdapterStatus is NULL, then ASSERT(). If HostAdapterStatus is NULL, then ASSERT().
If TargetStatus is NULL, then ASSERT(). If TargetStatus is NULL, then ASSERT().
If DataLength is NULL, then ASSERT(). If DataLength is NULL, then ASSERT().
@param[in] ScsiIo A pointer to SCSI IO protocol.
@param[in] Timeout The length of timeout period.
@param[in] SenseData A pointer to output sense data.
@param[in, out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target.
@param[in] DataBuffer A pointer to input data buffer.
@param[in, out] DataLength The length of input data buffer.
@param[in] DBDField The DBD Field (Optional).
@param[in] PageControl Page Control.
@param[in] PageCode Page code.
@retval EFI_SUCCESS The status of the unit is tested successfully. @param[in] ScsiIo A pointer to the SCSI I/O Protocol instance
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, for the specific SCSI target.
but the entire DataBuffer could not be transferred. @param[in] Timeout The timeout in 100 ns units to use for the
execution of this SCSI Request Packet. A Timeout
value of zero means that this function will wait
indefinitely for the SCSI Request Packet to execute.
If Timeout is greater than zero, then this function
will return EFI_TIMEOUT if the time required to
execute the SCSI Request Packet is greater than Timeout.
@param[in, out] SenseData A pointer to sense data that was generated
by the execution of the SCSI Request Packet.
This buffer must be allocated by the caller.
If SenseDataLength is 0, then this parameter
is optional and may be NULL.
@param[in, out] SenseDataLength On input, the length in bytes of the SenseData buffer.
On output, the number of bytes written to the SenseData buffer.
@param[out] HostAdapterStatus The status of the SCSI Host Controller that
produces the SCSI bus containing the SCSI target
specified by ScsiIo when the SCSI Request Packet
was executed. See the EFI SCSI I/O Protocol in the
UEFI Specification for details on the possible
return values.
@param[out] TargetStatus The status returned by the SCSI target specified
by ScsiIo when the SCSI Request Packat was executed
on the SCSI Host Controller. See the EFI SCSI
I/O Protocol in the UEFI Specification for details
on the possible return values.
@param[in, out] DataBuffer A pointer to data that was generated by the
execution of the SCSI Request Packet. This
buffer must be allocated by the caller. If
DataLength is 0, then this parameter is optional
and may be NULL.
@param[in, out] DataLength On input, a pointer to the length in bytes of
the DataBuffer buffer. On output, a pointer
to the number of bytes written to the DataBuffer
buffer.
@param[in] DBDField Specifies the DBD field of the CDB for this SCSI Command.
@param[in] PageControl Specifies the PC field of the CDB for this SCSI Command.
@param[in] PageCode Specifies the Page Control field of the CDB for this SCSI Command.
@retval EFI_SUCCESS The command was executed successfully.
See HostAdapterStatus, TargetStatus, SenseDataLength,
and SenseData in that order for additional status information.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the
entire DataBuffer could not be transferred.
The actual number of bytes transferred is returned The actual number of bytes transferred is returned
in TransferLength. in DataLength.
@retval EFI_NOT_READY The SCSI Request Packet could not be sent because @retval EFI_NOT_READY The SCSI Request Packet could not be sent because
there are too many SCSI Command Packets already there are too many SCSI Command Packets already queued.
queued. The SCSI Request Packet was not sent, so no additional
status information is available. The caller may retry
again later.
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send @retval EFI_DEVICE_ERROR A device error occurred while attempting to send
the SCSI Request Packet. SCSI Request Packet. See HostAdapterStatus, TargetStatus,
@retval EFI_INVALID_PARAMETER ScsiIo is NULL. SenseDataLength, and SenseData in that order for
additional status information.
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
is not supported by the SCSI initiator(i.e., SCSI is not supported by the SCSI initiator(i.e., SCSI
Host Controller). Host Controller). The SCSI Request Packet was not
sent, so no additional status information is available.
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
Request Packet to execute. Request Packet to execute. See HostAdapterStatus,
TargetStatus, SenseDataLength, and SenseData in that
order for additional status information.
**/ **/
EFI_STATUS EFI_STATUS
@ -290,11 +390,11 @@ EFIAPI
ScsiModeSense10Command ( ScsiModeSense10Command (
IN EFI_SCSI_IO_PROTOCOL *ScsiIo, IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
IN UINT64 Timeout, IN UINT64 Timeout,
IN VOID *SenseData, IN OUT VOID *SenseData, OPTIONAL
IN OUT UINT8 *SenseDataLength, IN OUT UINT8 *SenseDataLength,
OUT UINT8 *HostAdapterStatus, OUT UINT8 *HostAdapterStatus,
OUT UINT8 *TargetStatus, OUT UINT8 *TargetStatus,
IN VOID *DataBuffer, IN OUT VOID *DataBuffer, OPTIONAL
IN OUT UINT32 *DataLength, IN OUT UINT32 *DataLength,
IN UINT8 DBDField, OPTIONAL IN UINT8 DBDField, OPTIONAL
IN UINT8 PageControl, IN UINT8 PageControl,
@ -312,10 +412,7 @@ ScsiModeSense10Command (
ASSERT (HostAdapterStatus != NULL); ASSERT (HostAdapterStatus != NULL);
ASSERT (TargetStatus != NULL); ASSERT (TargetStatus != NULL);
ASSERT (DataLength != NULL); ASSERT (DataLength != NULL);
ASSERT (ScsiIo != NULL);
if (ScsiIo == NULL) {
return EFI_INVALID_PARAMETER;
}
ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET)); ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET));
ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_TEN); ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_TEN);
@ -359,20 +456,19 @@ ScsiModeSense10Command (
/** /**
Function to submit SCSI request sense command. Execute Request Sense SCSI command on a specific SCSI target.
Submit SCSI request sense command with the SCSI requested packet specified by this
SCSI command, TimeOut and SenseData, and then return the status of scsi unit execution.
Executes the Request Sense command on the SCSI target specified by ScsiIo.
If Timeout is zero, then this function waits indefinitely for the command to complete.
If Timeout is greater than zero, then the command is executed and will timeout after Timeout 100 ns units.
If ScsiIo is NULL, then ASSERT().
If SenseDataLength is NULL, then ASSERT(). If SenseDataLength is NULL, then ASSERT().
If HostAdapterStatus is NULL, then ASSERT(). If HostAdapterStatus is NULL, then ASSERT().
If TargetStatus is NULL, then ASSERT(). If TargetStatus is NULL, then ASSERT().
@param[in] ScsiIo A pointer to SCSI IO protocol. @param[in] ScsiIo A pointer to SCSI IO protocol.
@param[in] Timeout The length of timeout period. @param[in] Timeout The length of timeout period.
@param[in] SenseData A pointer to output sense data. @param[in, out] SenseData A pointer to output sense data.
@param[in, out] SenseDataLength The length of output sense data. @param[in, out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter. @param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target. @param[out] TargetStatus The status of the target.
@ -384,7 +480,6 @@ ScsiModeSense10Command (
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by
the SCSI initiator(i.e., SCSI Host Controller) the SCSI initiator(i.e., SCSI Host Controller)
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute. @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
@retval EFI_INVALID_PARAMETER ScsiIo is NULL.
**/ **/
EFI_STATUS EFI_STATUS
@ -392,7 +487,7 @@ EFIAPI
ScsiRequestSenseCommand ( ScsiRequestSenseCommand (
IN EFI_SCSI_IO_PROTOCOL *ScsiIo, IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
IN UINT64 Timeout, IN UINT64 Timeout,
IN VOID *SenseData, IN OUT VOID *SenseData, OPTIONAL
IN OUT UINT8 *SenseDataLength, IN OUT UINT8 *SenseDataLength,
OUT UINT8 *HostAdapterStatus, OUT UINT8 *HostAdapterStatus,
OUT UINT8 *TargetStatus OUT UINT8 *TargetStatus
@ -408,10 +503,7 @@ ScsiRequestSenseCommand (
ASSERT (SenseDataLength != NULL); ASSERT (SenseDataLength != NULL);
ASSERT (HostAdapterStatus != NULL); ASSERT (HostAdapterStatus != NULL);
ASSERT (TargetStatus != NULL); ASSERT (TargetStatus != NULL);
ASSERT (ScsiIo != NULL);
if (ScsiIo == NULL) {
return EFI_INVALID_PARAMETER;
}
ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET)); ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET));
ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_SIX); ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_SIX);
@ -446,26 +538,25 @@ ScsiRequestSenseCommand (
/** /**
Function to submit read capacity command. Execute Read Capacity SCSI command on a specific SCSI target.
Submit SCSI read capacity command with the SCSI request packet specified by this SCSI
command and the input parameters, and then return the status of Scsi unit execution.
Executes the SCSI Read Capacity command on the SCSI target specified by ScsiIo.
If Timeout is zero, then this function waits indefinitely for the command to complete.
If Timeout is greater than zero, then the command is executed and will timeout after
Timeout 100 ns units. The PMI parameter is used to construct the CDB for this SCSI command.
If ScsiIo is NULL, then ASSERT().
If SenseDataLength is NULL, then ASSERT(). If SenseDataLength is NULL, then ASSERT().
If HostAdapterStatus is NULL, then ASSERT(). If HostAdapterStatus is NULL, then ASSERT().
If TargetStatus is NULL, then ASSERT(). If TargetStatus is NULL, then ASSERT().
If DataLength is NULL, then ASSERT(). If DataLength is NULL, then ASSERT().
@param[in] ScsiIo A pointer to SCSI IO protocol. @param[in] ScsiIo A pointer to SCSI IO protocol.
@param[in] Timeout The length of timeout period. @param[in] Timeout The length of timeout period.
@param[in] SenseData A pointer to output sense data. @param[in, out] SenseData A pointer to output sense data.
@param[in, out] SenseDataLength The length of output sense data. @param[in, out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter. @param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target. @param[out] TargetStatus The status of the target.
@param[out] DataBuffer A pointer to a data buffer. @param[in, out] DataBuffer A pointer to a data buffer.
@param[in, out] DataLength The length of data buffer. @param[in, out] DataLength The length of data buffer.
@param[in] PMI Partial medium indicator. @param[in] PMI Partial medium indicator.
@ -478,7 +569,6 @@ ScsiRequestSenseCommand (
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by
the SCSI initiator(i.e., SCSI Host Controller) the SCSI initiator(i.e., SCSI Host Controller)
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute. @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
@retval EFI_INVALID_PARAMETER ScsiIo is NULL.
**/ **/
EFI_STATUS EFI_STATUS
@ -486,11 +576,11 @@ EFIAPI
ScsiReadCapacityCommand ( ScsiReadCapacityCommand (
IN EFI_SCSI_IO_PROTOCOL *ScsiIo, IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
IN UINT64 Timeout, IN UINT64 Timeout,
IN VOID *SenseData, IN OUT VOID *SenseData, OPTIONAL
IN OUT UINT8 *SenseDataLength, IN OUT UINT8 *SenseDataLength,
OUT UINT8 *HostAdapterStatus, OUT UINT8 *HostAdapterStatus,
OUT UINT8 *TargetStatus, OUT UINT8 *TargetStatus,
OUT VOID *DataBuffer, IN OUT VOID *DataBuffer, OPTIONAL
IN OUT UINT32 *DataLength, IN OUT UINT32 *DataLength,
IN BOOLEAN PMI IN BOOLEAN PMI
) )
@ -506,10 +596,7 @@ ScsiReadCapacityCommand (
ASSERT (HostAdapterStatus != NULL); ASSERT (HostAdapterStatus != NULL);
ASSERT (TargetStatus != NULL); ASSERT (TargetStatus != NULL);
ASSERT (DataLength != NULL); ASSERT (DataLength != NULL);
ASSERT (ScsiIo != NULL);
if (ScsiIo == NULL) {
return EFI_INVALID_PARAMETER;
}
ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET)); ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET));
ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_TEN); ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_TEN);
@ -552,26 +639,27 @@ ScsiReadCapacityCommand (
/** /**
Function to submit read 10 command. Execute Read(10) SCSI command on a specific SCSI target.
Submit SCSI read (10) command with the SCSI request packet specified by this SCSI command
and the input parameters, and then return the status of Scsi unit execution.
Executes the SCSI Read(10) command on the SCSI target specified by ScsiIo.
If Timeout is zero, then this function waits indefinitely for the command to complete.
If Timeout is greater than zero, then the command is executed and will timeout
after Timeout 100 ns units. The StartLba and SectorSize parameters are used to
construct the CDB for this SCSI command.
If ScsiIo is NULL, then ASSERT().
If SenseDataLength is NULL, then ASSERT(). If SenseDataLength is NULL, then ASSERT().
If HostAdapterStatus is NULL, then ASSERT(). If HostAdapterStatus is NULL, then ASSERT().
If TargetStatus is NULL, then ASSERT(). If TargetStatus is NULL, then ASSERT().
If DataLength is NULL, then ASSERT(). If DataLength is NULL, then ASSERT().
@param[in] ScsiIo A pointer to SCSI IO protocol. @param[in] ScsiIo A pointer to SCSI IO protocol.
@param[in] Timeout The length of timeout period. @param[in] Timeout The length of timeout period.
@param[in] SenseData A pointer to output sense data. @param[in, out] SenseData A pointer to output sense data.
@param[in, out] SenseDataLength The length of output sense data. @param[in, out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter. @param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target. @param[out] TargetStatus The status of the target.
@param[out] DataBuffer Read 10 command data. @param[in, out] DataBuffer Read 10 command data.
@param[in, out] DataLength The length of data buffer. @param[in, out] DataLength The length of data buffer.
@param[in] StartLba The start address of LBA. @param[in] StartLba The start address of LBA.
@param[in] SectorSize The sector size. @param[in] SectorSize The sector size.
@ -585,7 +673,6 @@ ScsiReadCapacityCommand (
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by
the SCSI initiator(i.e., SCSI Host Controller) the SCSI initiator(i.e., SCSI Host Controller)
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute. @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
@retval EFI_INVALID_PARAMETER ScsiIo is NULL.
**/ **/
EFI_STATUS EFI_STATUS
@ -593,11 +680,11 @@ EFIAPI
ScsiRead10Command ( ScsiRead10Command (
IN EFI_SCSI_IO_PROTOCOL *ScsiIo, IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
IN UINT64 Timeout, IN UINT64 Timeout,
IN VOID *SenseData, IN OUT VOID *SenseData, OPTIONAL
IN OUT UINT8 *SenseDataLength, IN OUT UINT8 *SenseDataLength,
OUT UINT8 *HostAdapterStatus, OUT UINT8 *HostAdapterStatus,
OUT UINT8 *TargetStatus, OUT UINT8 *TargetStatus,
OUT VOID *DataBuffer, IN OUT VOID *DataBuffer, OPTIONAL
IN OUT UINT32 *DataLength, IN OUT UINT32 *DataLength,
IN UINT32 StartLba, IN UINT32 StartLba,
IN UINT32 SectorSize IN UINT32 SectorSize
@ -614,10 +701,7 @@ ScsiRead10Command (
ASSERT (HostAdapterStatus != NULL); ASSERT (HostAdapterStatus != NULL);
ASSERT (TargetStatus != NULL); ASSERT (TargetStatus != NULL);
ASSERT (DataLength != NULL); ASSERT (DataLength != NULL);
ASSERT (ScsiIo != NULL);
if (ScsiIo == NULL) {
return EFI_INVALID_PARAMETER;
}
ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET)); ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET));
ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_TEN); ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_TEN);
@ -658,26 +742,26 @@ ScsiRead10Command (
/** /**
Function to submit SCSI write 10 command. Execute Write(10) SCSI command on a specific SCSI target.
Submit SCSI write (10) command with the SCSI request packet specified by this SCSI command and the
input parameters, and then return the status of Scsi unit execution.
Executes the SCSI Write(10) command on the SCSI target specified by ScsiIo.
If Timeout is zero, then this function waits indefinitely for the command to complete.
If Timeout is greater than zero, then the command is executed and will timeout after
Timeout 100 ns units. The StartLba and SectorSize parameters are used to construct
the CDB for this SCSI command.
If ScsiIo is NULL, then ASSERT().
If SenseDataLength is NULL, then ASSERT(). If SenseDataLength is NULL, then ASSERT().
If HostAdapterStatus is NULL, then ASSERT(). If HostAdapterStatus is NULL, then ASSERT().
If TargetStatus is NULL, then ASSERT(). If TargetStatus is NULL, then ASSERT().
If DataLength is NULL, then ASSERT(). If DataLength is NULL, then ASSERT().
@param[in] ScsiIo SCSI IO Protocol to use @param[in] ScsiIo SCSI IO Protocol to use
@param[in] Timeout The length of timeout period. @param[in] Timeout The length of timeout period.
@param[in] SenseData A pointer to output sense data. @param[in, out] SenseData A pointer to output sense data.
@param[in, out] SenseDataLength The length of output sense data. @param[in, out] SenseDataLength The length of output sense data.
@param[out] HostAdapterStatus The status of Host Adapter. @param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target. @param[out] TargetStatus The status of the target.
@param[out] DataBuffer A pointer to a data buffer. @param[in, out] DataBuffer A pointer to a data buffer.
@param[in, out] DataLength The length of data buffer. @param[in, out] DataLength The length of data buffer.
@param[in] StartLba The start address of LBA. @param[in] StartLba The start address of LBA.
@param[in] SectorSize The sector size. @param[in] SectorSize The sector size.
@ -691,7 +775,6 @@ ScsiRead10Command (
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by
the SCSI initiator(i.e., SCSI Host Controller) the SCSI initiator(i.e., SCSI Host Controller)
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute. @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
@retval EFI_INVALID_PARAMETER ScsiIo is NULL.
**/ **/
EFI_STATUS EFI_STATUS
@ -699,11 +782,11 @@ EFIAPI
ScsiWrite10Command ( ScsiWrite10Command (
IN EFI_SCSI_IO_PROTOCOL *ScsiIo, IN EFI_SCSI_IO_PROTOCOL *ScsiIo,
IN UINT64 Timeout, IN UINT64 Timeout,
IN VOID *SenseData, IN OUT VOID *SenseData, OPTIONAL
IN OUT UINT8 *SenseDataLength, IN OUT UINT8 *SenseDataLength,
OUT UINT8 *HostAdapterStatus, OUT UINT8 *HostAdapterStatus,
OUT UINT8 *TargetStatus, OUT UINT8 *TargetStatus,
OUT VOID *DataBuffer, IN OUT VOID *DataBuffer, OPTIONAL
IN OUT UINT32 *DataLength, IN OUT UINT32 *DataLength,
IN UINT32 StartLba, IN UINT32 StartLba,
IN UINT32 SectorSize IN UINT32 SectorSize
@ -720,10 +803,7 @@ ScsiWrite10Command (
ASSERT (HostAdapterStatus != NULL); ASSERT (HostAdapterStatus != NULL);
ASSERT (TargetStatus != NULL); ASSERT (TargetStatus != NULL);
ASSERT (DataLength != NULL); ASSERT (DataLength != NULL);
ASSERT (ScsiIo != NULL);
if (ScsiIo == NULL) {
return EFI_INVALID_PARAMETER;
}
ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET)); ZeroMem (&CommandPacket, sizeof (EFI_SCSI_IO_SCSI_REQUEST_PACKET));
ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_TEN); ZeroMem (Cdb, EFI_SCSI_OP_LENGTH_TEN);

236
MdePkg/Library/UefiUsbLib/Hid.c
View File

@ -30,22 +30,29 @@
// //
/** /**
Get Hid Descriptor. Get the descriptor of the specified USB HID interface.
@param UsbIo EFI_USB_IO_PROTOCOL. Submit a USB get HID descriptor request for the USB device specified by UsbIo
@param InterfaceNum Hid interface number. and Interface and return the HID descriptor in HidDescriptor.
@param HidDescriptor Caller allocated buffer to store Usb hid descriptor if If UsbIo is NULL, then ASSERT().
successfully returned. If HidDescriptor is NULL, then ASSERT().
@return Status of getting HID descriptor through USB I/O @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
protocol's UsbControlTransfer(). @param Interface The index of the HID interface on the USB target.
@param HidDescriptor Pointer to the USB HID descriptor that was retrieved from
the specified USB target and interface. Type EFI_USB_HID_DESCRIPTOR
is defined in the MDE Package Industry Standard include file Usb.h.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
UsbGetHidDescriptor ( UsbGetHidDescriptor (
IN EFI_USB_IO_PROTOCOL *UsbIo, IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT8 InterfaceNum, IN UINT8 Interface,
OUT EFI_USB_HID_DESCRIPTOR *HidDescriptor OUT EFI_USB_HID_DESCRIPTOR *HidDescriptor
) )
{ {
@ -53,14 +60,13 @@ UsbGetHidDescriptor (
EFI_STATUS Result; EFI_STATUS Result;
EFI_USB_DEVICE_REQUEST Request; EFI_USB_DEVICE_REQUEST Request;
if (UsbIo == NULL) { ASSERT(UsbIo != NULL);
return EFI_INVALID_PARAMETER; ASSERT(HidDescriptor != NULL);
}
Request.RequestType = USB_HID_GET_DESCRIPTOR_REQ_TYPE; Request.RequestType = USB_HID_GET_DESCRIPTOR_REQ_TYPE;
Request.Request = USB_REQ_GET_DESCRIPTOR; Request.Request = USB_REQ_GET_DESCRIPTOR;
Request.Value = (UINT16) (USB_DESC_TYPE_HID << 8); Request.Value = (UINT16) (USB_DESC_TYPE_HID << 8);
Request.Index = InterfaceNum; Request.Index = Interface;
Request.Length = sizeof (EFI_USB_HID_DESCRIPTOR); Request.Length = sizeof (EFI_USB_HID_DESCRIPTOR);
Result = UsbIo->UsbControlTransfer ( Result = UsbIo->UsbControlTransfer (
@ -78,24 +84,32 @@ UsbGetHidDescriptor (
} }
/** /**
Get Report Class descriptor. Get the report descriptor of the specified USB HID interface.
@param UsbIo EFI_USB_IO_PROTOCOL. Submit a USB get HID report descriptor request for the USB device specified by
@param InterfaceNum Report interface number. UsbIo and Interface and return the report descriptor in DescriptorBuffer.
@param DescriptorSize Length of DescriptorBuffer. If UsbIo is NULL, then ASSERT().
@param DescriptorBuffer Caller allocated buffer to store Usb report descriptor If DescriptorBuffer is NULL, then ASSERT().
if successfully returned.
@return Status of getting Report Class descriptor through USB @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
I/O protocol's UsbControlTransfer(). @param Interface The index of the report interface on the USB target.
@param DescriptorLength The size, in bytes, of DescriptorBuffer.
@param DescriptorBuffer A pointer to the buffer to store the report class descriptor.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_OUT_OF_RESOURCES The request could not be completed because the
buffer specifed by DescriptorLength and DescriptorBuffer
is not large enough to hold the result of the request.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
UsbGetReportDescriptor ( UsbGetReportDescriptor (
IN EFI_USB_IO_PROTOCOL *UsbIo, IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT8 InterfaceNum, IN UINT8 Interface,
IN UINT16 DescriptorSize, IN UINT16 DescriptorLength,
OUT UINT8 *DescriptorBuffer OUT UINT8 *DescriptorBuffer
) )
{ {
@ -103,17 +117,17 @@ UsbGetReportDescriptor (
EFI_STATUS Result; EFI_STATUS Result;
EFI_USB_DEVICE_REQUEST Request; EFI_USB_DEVICE_REQUEST Request;
if (UsbIo == NULL) { ASSERT (UsbIo != NULL);
return EFI_INVALID_PARAMETER; ASSERT (DescriptorBuffer != NULL);
}
// //
// Fill Device request packet // Fill Device request packet
// //
Request.RequestType = USB_HID_GET_DESCRIPTOR_REQ_TYPE; Request.RequestType = USB_HID_GET_DESCRIPTOR_REQ_TYPE;
Request.Request = USB_REQ_GET_DESCRIPTOR; Request.Request = USB_REQ_GET_DESCRIPTOR;
Request.Value = (UINT16) (USB_DESC_TYPE_REPORT << 8); Request.Value = (UINT16) (USB_DESC_TYPE_REPORT << 8);
Request.Index = InterfaceNum; Request.Index = Interface;
Request.Length = DescriptorSize; Request.Length = DescriptorLength;
Result = UsbIo->UsbControlTransfer ( Result = UsbIo->UsbControlTransfer (
UsbIo, UsbIo,
@ -121,7 +135,7 @@ UsbGetReportDescriptor (
EfiUsbDataIn, EfiUsbDataIn,
TIMEOUT_VALUE, TIMEOUT_VALUE,
DescriptorBuffer, DescriptorBuffer,
DescriptorSize, DescriptorLength,
&Status &Status
); );
@ -130,14 +144,20 @@ UsbGetReportDescriptor (
} }
/** /**
Get Hid Protocol Request Get the HID protocol of the specified USB HID interface.
@param UsbIo EFI_USB_IO_PROTOCOL. Submit a USB get HID protocol request for the USB device specified by UsbIo
@param Interface Which interface the caller wants to get protocol and Interface and return the protocol retrieved in Protocol.
@param Protocol Protocol value returned. If UsbIo is NULL, then ASSERT().
If Protocol is NULL, then ASSERT().
@return Status of getting Protocol Request through USB I/O @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
protocol's UsbControlTransfer(). @param Interface The index of the report interface on the USB target.
@param Protocol A pointer to the protocol for the specified USB target.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
**/ **/
EFI_STATUS EFI_STATUS
@ -152,9 +172,9 @@ UsbGetProtocolRequest (
EFI_STATUS Result; EFI_STATUS Result;
EFI_USB_DEVICE_REQUEST Request; EFI_USB_DEVICE_REQUEST Request;
if (UsbIo == NULL) { ASSERT (UsbIo != NULL);
return EFI_INVALID_PARAMETER; ASSERT (Protocol != NULL);
}
// //
// Fill Device request packet // Fill Device request packet
// //
@ -180,15 +200,19 @@ UsbGetProtocolRequest (
/** /**
Set Hid Protocol Request. Set the HID protocol of the specified USB HID interface.
@param UsbIo EFI_USB_IO_PROTOCOL. Submit a USB set HID protocol request for the USB device specified by UsbIo
@param Interface Which interface the caller wants to and Interface and set the protocol to the value specified by Protocol.
set protocol. If UsbIo is NULL, then ASSERT().
@param Protocol Protocol value the caller wants to set.
@return Status of setting Protocol Request through USB I/O @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
protocol's UsbControlTransfer(). @param Interface The index of the report interface on the USB target.
@param Protocol The protocol value to set for the specified USB target.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
**/ **/
EFI_STATUS EFI_STATUS
@ -203,9 +227,8 @@ UsbSetProtocolRequest (
EFI_STATUS Result; EFI_STATUS Result;
EFI_USB_DEVICE_REQUEST Request; EFI_USB_DEVICE_REQUEST Request;
if (UsbIo == NULL) { ASSERT (UsbIo != NULL);
return EFI_INVALID_PARAMETER;
}
// //
// Fill Device request packet // Fill Device request packet
// //
@ -229,15 +252,20 @@ UsbSetProtocolRequest (
/** /**
Set Idel request. Set the idle rate of the specified USB HID report.
@param UsbIo EFI_USB_IO_PROTOCOL. Submit a USB set HID report idle request for the USB device specified by UsbIo,
@param Interface Which interface the caller wants to set. Interface, and ReportId, and set the idle rate to the value specified by Duration.
@param ReportId Which report the caller wants to set. If UsbIo is NULL, then ASSERT().
@param Duration Idle rate the caller wants to set.
@return Status of setting IDLE Request through USB I/O @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
protocol's UsbControlTransfer(). @param Interface The index of the report interface on the USB target.
@param ReportId The identifier of the report to retrieve.
@param Duration The idle rate to set for the specified USB target.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
**/ **/
EFI_STATUS EFI_STATUS
@ -253,9 +281,7 @@ UsbSetIdleRequest (
EFI_STATUS Result; EFI_STATUS Result;
EFI_USB_DEVICE_REQUEST Request; EFI_USB_DEVICE_REQUEST Request;
if (UsbIo == NULL) { ASSERT (UsbIo != NULL);
return EFI_INVALID_PARAMETER;
}
// //
// Fill Device request packet // Fill Device request packet
// //
@ -279,15 +305,21 @@ UsbSetIdleRequest (
/** /**
Get Idel request. Get the idle rate of the specified USB HID report.
@param UsbIo EFI_USB_IO_PROTOCOL. Submit a USB get HID report idle request for the USB device specified by UsbIo,
@param Interface Which interface the caller wants to get. Interface, and ReportId, and return the ide rate in Duration.
@param ReportId Which report the caller wants to get. If UsbIo is NULL, then ASSERT().
@param Duration Idle rate the caller wants to get. If Duration is NULL, then ASSERT().
@return Status of getting IDLE Request through USB I/O @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
protocol's UsbControlTransfer(). @param Interface The index of the report interface on the USB target.
@param ReportId The identifier of the report to retrieve.
@param Duration A pointer to the idle rate retrieved from the specified USB target.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
**/ **/
EFI_STATUS EFI_STATUS
@ -303,9 +335,8 @@ UsbGetIdleRequest (
EFI_STATUS Result; EFI_STATUS Result;
EFI_USB_DEVICE_REQUEST Request; EFI_USB_DEVICE_REQUEST Request;
if (UsbIo == NULL) { ASSERT (UsbIo != NULL);
return EFI_INVALID_PARAMETER; ASSERT (Duration != NULL);
}
// //
// Fill Device request packet // Fill Device request packet
// //
@ -331,17 +362,24 @@ UsbGetIdleRequest (
/** /**
Hid Set Report request. Set the report descriptor of the specified USB HID interface.
@param UsbIo EFI_USB_IO_PROTOCOL. Submit a USB set HID report request for the USB device specified by UsbIo,
@param Interface Which interface the caller wants to set. Interface, ReportId, and ReportType, and set the report descriptor using the
@param ReportId Which report the caller wants to set. buffer specified by ReportLength and Report.
@param ReportType Type of report. If UsbIo is NULL, then ASSERT().
@param ReportLen Length of report descriptor. If Report is NULL, then ASSERT().
@param Report Report Descriptor buffer.
@return Status of setting Report Request through USB I/O @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
protocol's UsbControlTransfer(). @param Interface The index of the report interface on the USB target.
@param ReportId The identifier of the report to retrieve.
@param ReportType The type of report to retrieve.
@param ReportLength The size, in bytes, of Report.
@param Report A pointer to the report descriptor buffer to set.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
**/ **/
EFI_STATUS EFI_STATUS
@ -351,7 +389,7 @@ UsbSetReportRequest (
IN UINT8 Interface, IN UINT8 Interface,
IN UINT8 ReportId, IN UINT8 ReportId,
IN UINT8 ReportType, IN UINT8 ReportType,
IN UINT16 ReportLen, IN UINT16 ReportLength,
IN UINT8 *Report IN UINT8 *Report
) )
{ {
@ -359,9 +397,9 @@ UsbSetReportRequest (
EFI_STATUS Result; EFI_STATUS Result;
EFI_USB_DEVICE_REQUEST Request; EFI_USB_DEVICE_REQUEST Request;
if (UsbIo == NULL) { ASSERT (UsbIo != NULL);
return EFI_INVALID_PARAMETER; ASSERT (Report != NULL);
}
// //
// Fill Device request packet // Fill Device request packet
// //
@ -369,7 +407,7 @@ UsbSetReportRequest (
Request.Request = EFI_USB_SET_REPORT_REQUEST; Request.Request = EFI_USB_SET_REPORT_REQUEST;
Request.Value = (UINT16) ((ReportType << 8) | ReportId); Request.Value = (UINT16) ((ReportType << 8) | ReportId);
Request.Index = Interface; Request.Index = Interface;
Request.Length = ReportLen; Request.Length = ReportLength;
Result = UsbIo->UsbControlTransfer ( Result = UsbIo->UsbControlTransfer (
UsbIo, UsbIo,
@ -377,7 +415,7 @@ UsbSetReportRequest (
EfiUsbDataOut, EfiUsbDataOut,
TIMEOUT_VALUE, TIMEOUT_VALUE,
Report, Report,
ReportLen, ReportLength,
&Status &Status
); );
@ -386,17 +424,27 @@ UsbSetReportRequest (
/** /**
Hid Set Report request. Get the report descriptor of the specified USB HID interface.
@param UsbIo EFI_USB_IO_PROTOCOL. Submit a USB get HID report request for the USB device specified by UsbIo,
@param Interface Which interface the caller wants to set. Interface, ReportId, and ReportType, and return the report in the buffer
@param ReportId Which report the caller wants to set. specified by Report.
@param ReportType Type of report. If UsbIo is NULL, then ASSERT().
@param ReportLen Length of report descriptor. If Report is NULL, then ASSERT().
@param Report Caller allocated buffer to store Report Descriptor.
@return Status of getting Report Request through USB I/O @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
protocol's UsbControlTransfer(). @param Interface The index of the report interface on the USB target.
@param ReportId The identifier of the report to retrieve.
@param ReportType The type of report to retrieve.
@param ReportLength The size, in bytes, of Report.
@param Report A pointer to the buffer to store the report descriptor.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_OUT_OF_RESOURCES The request could not be completed because the
buffer specifed by ReportLength and Report is not
large enough to hold the result of the request.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
**/ **/
EFI_STATUS EFI_STATUS
@ -414,9 +462,9 @@ UsbGetReportRequest (
EFI_STATUS Result; EFI_STATUS Result;
EFI_USB_DEVICE_REQUEST Request; EFI_USB_DEVICE_REQUEST Request;
if (UsbIo == NULL) { ASSERT (UsbIo != NULL);
return EFI_INVALID_PARAMETER; ASSERT (Report != NULL);
}
// //
// Fill Device request packet // Fill Device request packet
// //

1
MdePkg/Library/UefiUsbLib/UefiUsbLib.inf
View File

@ -38,5 +38,6 @@
MdePkg/MdePkg.dec MdePkg/MdePkg.dec
[LibraryClasses] [LibraryClasses]
DebugLib
BaseMemoryLib BaseMemoryLib

9
MdePkg/Library/UefiUsbLib/UefiUsbLibInternal.h
View File

@ -13,11 +13,16 @@
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/ **/
#ifndef __UEFI_USB_LIB_INTERNAL_H_ #ifndef _UEFI_USB_LIB_INTERNAL_H_
#define __UEFI_USB_LIB_INTERNAL_H_ #define _UEFI_USB_LIB_INTERNAL_H_
#include <Uefi.h> #include <Uefi.h>
#include <Library/UefiUsbLib.h> #include <Library/UefiUsbLib.h>
#include <Library/BaseMemoryLib.h> #include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <IndustryStandard/Usb.h>
#endif #endif

349
MdePkg/Library/UefiUsbLib/UsbDxeLib.c
View File

@ -19,18 +19,29 @@
/** /**
Usb Get Descriptor. Get the descriptor of the specified USB device.
@param UsbIo EFI_USB_IO_PROTOCOL. Submit a USB get descriptor request for the USB device specified by UsbIo, Value,
@param Value Device Request Value. and Index, and return the descriptor in the buffer specified by Descriptor.
@param Index Device Request Index. The status of the transfer is returned in Status.
@param DescriptorLength Descriptor Length. If UsbIo is NULL, then ASSERT().
@param Descriptor Descriptor buffer to contain result. If Descriptor is NULL, then ASSERT().
@param Status Transfer Status. If Status is NULL, then ASSERT().
@retval EFI_INVALID_PARAMETER Parameter is error. @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@retval EFI_SUCCESS Success. @param Value The device request value.
@retval EFI_TIMEOUT Device has no response. @param Index The device request index.
@param DescriptorLength The size, in bytes, of Descriptor.
@param Descriptor A pointer to the descriptor buffer to get.
@param Status A pointer to the status of the transfer.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_OUT_OF_RESOURCES The request could not be completed because the
buffer specifed by DescriptorLength and Descriptor
is not large enough to hold the result of the request.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error. The transfer
status is returned in Status.
**/ **/
EFI_STATUS EFI_STATUS
@ -46,9 +57,9 @@ UsbGetDescriptor (
{ {
EFI_USB_DEVICE_REQUEST DevReq; EFI_USB_DEVICE_REQUEST DevReq;
if (UsbIo == NULL) { ASSERT (UsbIo != NULL);
return EFI_INVALID_PARAMETER; ASSERT (Descriptor != NULL);
} ASSERT (Status != NULL);
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST)); ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
@ -71,18 +82,26 @@ UsbGetDescriptor (
/** /**
Usb Set Descriptor. Set the descriptor of the specified USB device.
@param UsbIo EFI_USB_IO_PROTOCOL. Submit a USB set descriptor request for the USB device specified by UsbIo,
@param Value Device Request Value. Value, and Index, and set the descriptor using the buffer specified by DesriptorLength
@param Index Device Request Index. and Descriptor. The status of the transfer is returned in Status.
@param DescriptorLength Descriptor Length. If UsbIo is NULL, then ASSERT().
@param Descriptor Descriptor buffer to set. If Descriptor is NULL, then ASSERT().
@param Status Transfer Status. If Status is NULL, then ASSERT().
@retval EFI_INVALID_PARAMETER Parameter is error. @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@retval EFI_SUCCESS Success. @param Value The device request value.
@retval EFI_TIMEOUT Device has no response. @param Index The device request index.
@param DescriptorLength The size, in bytes, of Descriptor.
@param Descriptor A pointer to the descriptor buffer to set.
@param Status A pointer to the status of the transfer.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
The transfer status is returned in Status.
**/ **/
EFI_STATUS EFI_STATUS
@ -98,9 +117,9 @@ UsbSetDescriptor (
{ {
EFI_USB_DEVICE_REQUEST DevReq; EFI_USB_DEVICE_REQUEST DevReq;
if (UsbIo == NULL) { ASSERT (UsbIo != NULL);
return EFI_INVALID_PARAMETER; ASSERT (Descriptor != NULL);
} ASSERT (Status != NULL);
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST)); ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
@ -123,38 +142,46 @@ UsbSetDescriptor (
/** /**
Usb Get Device Interface. Get the interface setting of the specified USB device.
@param UsbIo EFI_USB_IO_PROTOCOL. Submit a USB get interface request for the USB device specified by UsbIo,
@param Index Interface index value. and Interface, and place the result in the buffer specified by AlternateSetting.
@param AltSetting Alternate setting. The status of the transfer is returned in Status.
@param Status Trasnsfer status. If UsbIo is NULL, then ASSERT().
If AlternateSetting is NULL, then ASSERT().
If Status is NULL, then ASSERT().
@retval EFI_INVALID_PARAMETER Parameter is error. @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@retval EFI_SUCCESS Success. @param Interface The interface index value.
@retval EFI_TIMEOUT Device has no response. @param AlternateSetting A pointer to the alternate setting to be retrieved.
@param Status A pointer to the status of the transfer.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
The transfer status is returned in Status.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
UsbGetInterface ( UsbGetInterface (
IN EFI_USB_IO_PROTOCOL *UsbIo, IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT16 Index, IN UINT16 Interface,
OUT UINT8 *AltSetting, OUT UINT8 *AlternateSetting,
OUT UINT32 *Status OUT UINT32 *Status
) )
{ {
EFI_USB_DEVICE_REQUEST DevReq; EFI_USB_DEVICE_REQUEST DevReq;
if (UsbIo == NULL) { ASSERT (UsbIo != NULL);
return EFI_INVALID_PARAMETER; ASSERT (AlternateSetting != NULL);
} ASSERT (Status != NULL);
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST)); ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
DevReq.RequestType = USB_DEV_GET_INTERFACE_REQ_TYPE; DevReq.RequestType = USB_DEV_GET_INTERFACE_REQ_TYPE;
DevReq.Request = USB_REQ_GET_INTERFACE; DevReq.Request = USB_REQ_GET_INTERFACE;
DevReq.Index = Index; DevReq.Index = Interface;
DevReq.Length = 1; DevReq.Length = 1;
return UsbIo->UsbControlTransfer ( return UsbIo->UsbControlTransfer (
@ -162,7 +189,7 @@ UsbGetInterface (
&DevReq, &DevReq,
EfiUsbDataIn, EfiUsbDataIn,
TIMEOUT_VALUE, TIMEOUT_VALUE,
AltSetting, AlternateSetting,
1, 1,
Status Status
); );
@ -170,40 +197,45 @@ UsbGetInterface (
/** /**
Usb Set Device Interface. Set the interface setting of the specified USB device.
@param UsbIo EFI_USB_IO_PROTOCOL. Submit a USB set interface request for the USB device specified by UsbIo, and
@param InterfaceNo Interface Number. Interface, and set the alternate setting to the value specified by AlternateSetting.
@param AltSetting Alternate setting. The status of the transfer is returned in Status.
@param Status Trasnsfer status. If UsbIo is NULL, then ASSERT().
If Status is NULL, then ASSERT().
@retval EFI_INVALID_PARAMETER Parameter is error. @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@retval EFI_SUCCESS Success. @param Interface The interface index value.
@retval EFI_TIMEOUT Device has no response. @param AlternateSetting The alternate setting to be set.
@param Status A pointer to the status of the transfer.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_SUCCESS The request failed due to a device error.
The transfer status is returned in Status.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
UsbSetInterface ( UsbSetInterface (
IN EFI_USB_IO_PROTOCOL *UsbIo, IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT16 InterfaceNo, IN UINT16 Interface,
IN UINT16 AltSetting, IN UINT16 AlternateSetting,
OUT UINT32 *Status OUT UINT32 *Status
) )
{ {
EFI_USB_DEVICE_REQUEST DevReq; EFI_USB_DEVICE_REQUEST DevReq;
if (UsbIo == NULL) { ASSERT (UsbIo != NULL);
return EFI_INVALID_PARAMETER; ASSERT (Status != NULL);
}
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST)); ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
DevReq.RequestType = USB_DEV_SET_INTERFACE_REQ_TYPE; DevReq.RequestType = USB_DEV_SET_INTERFACE_REQ_TYPE;
DevReq.Request = USB_REQ_SET_INTERFACE; DevReq.Request = USB_REQ_SET_INTERFACE;
DevReq.Value = AltSetting; DevReq.Value = AlternateSetting;
DevReq.Index = InterfaceNo; DevReq.Index = Interface;
return UsbIo->UsbControlTransfer ( return UsbIo->UsbControlTransfer (
UsbIo, UsbIo,
@ -218,30 +250,38 @@ UsbSetInterface (
/** /**
Usb Get Device Configuration. Get the device configuration.
@param UsbIo EFI_USB_IO_PROTOCOL. Submit a USB get configuration request for the USB device specified by UsbIo
@param ConfigValue Config Value. and place the result in the buffer specified by ConfigurationValue. The status
@param Status Transfer Status. of the transfer is returned in Status.
If UsbIo is NULL, then ASSERT().
If ConfigurationValue is NULL, then ASSERT().
If Status is NULL, then ASSERT().
@retval EFI_INVALID_PARAMETER Parameter is error. @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@retval EFI_SUCCESS Success. @param ConfigurationValue A pointer to the device configuration to be retrieved.
@retval EFI_TIMEOUT Device has no response. @param Status A pointer to the status of the transfer.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
The transfer status is returned in Status.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
UsbGetConfiguration ( UsbGetConfiguration (
IN EFI_USB_IO_PROTOCOL *UsbIo, IN EFI_USB_IO_PROTOCOL *UsbIo,
OUT UINT8 *ConfigValue, OUT UINT8 *ConfigurationValue,
OUT UINT32 *Status OUT UINT32 *Status
) )
{ {
EFI_USB_DEVICE_REQUEST DevReq; EFI_USB_DEVICE_REQUEST DevReq;
if (UsbIo == NULL) { ASSERT (UsbIo != NULL);
return EFI_INVALID_PARAMETER; ASSERT (ConfigurationValue != NULL);
} ASSERT (Status != NULL);
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST)); ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
@ -254,7 +294,7 @@ UsbGetConfiguration (
&DevReq, &DevReq,
EfiUsbDataIn, EfiUsbDataIn,
TIMEOUT_VALUE, TIMEOUT_VALUE,
ConfigValue, ConfigurationValue,
1, 1,
Status Status
); );
@ -262,36 +302,42 @@ UsbGetConfiguration (
/** /**
Usb Set Device Configuration. Set the device configuration.
@param UsbIo EFI_USB_IO_PROTOCOL. Submit a USB set configuration request for the USB device specified by UsbIo
@param Value Configuration Value to set. and set the device configuration to the value specified by ConfigurationValue.
@param Status Transfer status. The status of the transfer is returned in Status.
If UsbIo is NULL, then ASSERT().
If Status is NULL, then ASSERT().
@retval EFI_INVALID_PARAMETER Parameter is error. @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@retval EFI_SUCCESS Success. @param ConfigurationValue The device configuration value to be set.
@retval EFI_TIMEOUT Device has no response. @param Status A pointer to the status of the transfer.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
The transfer status is returned in Status.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
UsbSetConfiguration ( UsbSetConfiguration (
IN EFI_USB_IO_PROTOCOL *UsbIo, IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT16 Value, IN UINT16 ConfigurationValue,
OUT UINT32 *Status OUT UINT32 *Status
) )
{ {
EFI_USB_DEVICE_REQUEST DevReq; EFI_USB_DEVICE_REQUEST DevReq;
if (UsbIo == NULL) { ASSERT (UsbIo != NULL);
return EFI_INVALID_PARAMETER; ASSERT (Status != NULL);
}
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST)); ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
DevReq.RequestType = USB_DEV_SET_CONFIGURATION_REQ_TYPE; DevReq.RequestType = USB_DEV_SET_CONFIGURATION_REQ_TYPE;
DevReq.Request = USB_REQ_SET_CONFIG; DevReq.Request = USB_REQ_SET_CONFIG;
DevReq.Value = Value; DevReq.Value = ConfigurationValue;
return UsbIo->UsbControlTransfer ( return UsbIo->UsbControlTransfer (
UsbIo, UsbIo,
@ -306,24 +352,33 @@ UsbSetConfiguration (
/** /**
Usb Set Device Feature. Set the specified feature of the specified device.
@param UsbIo EFI_USB_IO_PROTOCOL. Submit a USB set device feature request for the USB device specified by UsbIo,
@param Recipient Interface/Device/Endpoint. Recipient, and Target to the value specified by Value. The status of the
@param Value Request value. transfer is returned in Status.
@param Target Request Index. If UsbIo is NULL, then ASSERT().
@param Status Transfer status. If Status is NULL, then ASSERT().
@retval EFI_INVALID_PARAMETER Parameter is error. @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@retval EFI_SUCCESS Success. @param Recipient The USB data recipient type (i.e. Device, Interface, Endpoint).
@retval EFI_TIMEOUT Device has no response. Type USB_TYPES_DEFINITION is defined in the MDE Package Industry
Standard include file Usb.h.
@param Value The value of the feature to be set.
@param Target The index of the device to be set.
@param Status A pointer to the status of the transfer.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
The transfer status is returned in Status.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
UsbSetFeature ( UsbSetFeature (
IN EFI_USB_IO_PROTOCOL *UsbIo, IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINTN Recipient, IN USB_TYPES_DEFINITION Recipient,
IN UINT16 Value, IN UINT16 Value,
IN UINT16 Target, IN UINT16 Target,
OUT UINT32 *Status OUT UINT32 *Status
@ -331,9 +386,8 @@ UsbSetFeature (
{ {
EFI_USB_DEVICE_REQUEST DevReq; EFI_USB_DEVICE_REQUEST DevReq;
if (UsbIo == NULL) { ASSERT (UsbIo != NULL);
return EFI_INVALID_PARAMETER; ASSERT (Status != NULL);
}
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST)); ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
@ -372,24 +426,33 @@ UsbSetFeature (
/** /**
Usb Clear Device Feature. Clear the specified feature of the specified device.
@param UsbIo EFI_USB_IO_PROTOCOL. Submit a USB clear device feature request for the USB device specified by UsbIo,
@param Recipient Interface/Device/Endpoint. Recipient, and Target to the value specified by Value. The status of the transfer
@param Value Request value. is returned in Status.
@param Target Request Index. If UsbIo is NULL, then ASSERT().
@param Status Transfer status. If Status is NULL, then ASSERT().
@retval EFI_INVALID_PARAMETER Parameter is error. @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@retval EFI_SUCCESS Success. @param Recipient The USB data recipient type (i.e. Device, Interface, Endpoint).
@retval EFI_TIMEOUT Device has no response. Type USB_TYPES_DEFINITION is defined in the MDE Package Industry Standard
include file Usb.h.
@param Value The value of the feature to be cleared.
@param Target The index of the device to be cleared.
@param Status A pointer to the status of the transfer.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
The transfer status is returned in Status.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
UsbClearFeature ( UsbClearFeature (
IN EFI_USB_IO_PROTOCOL *UsbIo, IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINTN Recipient, IN USB_TYPES_DEFINITION Recipient,
IN UINT16 Value, IN UINT16 Value,
IN UINT16 Target, IN UINT16 Target,
OUT UINT32 *Status OUT UINT32 *Status
@ -397,9 +460,9 @@ UsbClearFeature (
{ {
EFI_USB_DEVICE_REQUEST DevReq; EFI_USB_DEVICE_REQUEST DevReq;
if (UsbIo == NULL) { ASSERT (UsbIo != NULL);
return EFI_INVALID_PARAMETER; ASSERT (Status != NULL);
}
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST)); ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
@ -438,34 +501,44 @@ UsbClearFeature (
/** /**
Usb Get Device Status. Get the status of the specified device.
@param UsbIo EFI_USB_IO_PROTOCOL. Submit a USB device get status request for the USB device specified by UsbIo,
@param Recipient Interface/Device/Endpoint. Recipient, and Target and place the result in the buffer specified by DeviceStatus.
@param Target Request index. The status of the transfer is returned in Status.
@param DevStatus Device status. If UsbIo is NULL, then ASSERT().
@param Status Transfer status. If DeviceStatus is NULL, then ASSERT().
If Status is NULL, then ASSERT().
@retval EFI_INVALID_PARAMETER Parameter is error. @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@retval EFI_SUCCESS Success. @param Recipient The USB data recipient type (i.e. Device, Interface, Endpoint).
@retval EFI_TIMEOUT Device has no response. Type USB_TYPES_DEFINITION is defined in the MDE Package Industry Standard
include file Usb.h.
@param Target The index of the device to be get the status of.
@param DeviceStatus A pointer to the device status to be retrieved.
@param Status A pointer to the status of the transfer.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
The transfer status is returned in Status.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
UsbGetStatus ( UsbGetStatus (
IN EFI_USB_IO_PROTOCOL *UsbIo, IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINTN Recipient, IN USB_TYPES_DEFINITION Recipient,
IN UINT16 Target, IN UINT16 Target,
OUT UINT16 *DevStatus, OUT UINT16 *DeviceStatus,
OUT UINT32 *Status OUT UINT32 *Status
) )
{ {
EFI_USB_DEVICE_REQUEST DevReq; EFI_USB_DEVICE_REQUEST DevReq;
if (UsbIo == NULL) { ASSERT (UsbIo != NULL);
return EFI_INVALID_PARAMETER; ASSERT (DeviceStatus != NULL);
} ASSERT (Status != NULL);
ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST)); ZeroMem (&DevReq, sizeof (EFI_USB_DEVICE_REQUEST));
@ -496,7 +569,7 @@ UsbGetStatus (
&DevReq, &DevReq,
EfiUsbDataIn, EfiUsbDataIn,
TIMEOUT_VALUE, TIMEOUT_VALUE,
DevStatus, DeviceStatus,
2, 2,
Status Status
); );
@ -504,22 +577,31 @@ UsbGetStatus (
/** /**
Clear endpoint stall. Clear halt feature of the specified usb endpoint.
@param UsbIo EFI_USB_IO_PROTOCOL. Retrieve the USB endpoint descriptor specified by UsbIo and EndPoint.
@param EndpointNo Endpoint Number. If the USB endpoint descriptor can not be retrieved, then return EFI_NOT_FOUND.
@param Status Transfer Status. If the endpoint descriptor is found, then clear the halt fature of this USB endpoint.
The status of the transfer is returned in Status.
If UsbIo is NULL, then ASSERT().
If Status is NULL, then ASSERT().
@retval EFI_NOT_FOUND Can't find the Endpoint. @param UsbIo A pointer to the USB I/O Protocol instance for the specific USB target.
@retval EFI_DEVICE_ERROR Hardware error. @param Endpoint The endpoint address.
@retval EFI_SUCCESS Success. @param Status A pointer to the status of the transfer.
@retval EFI_SUCCESS The request executed successfully.
@retval EFI_TIMEOUT A timeout occurred executing the request.
@retval EFI_DEVICE_ERROR The request failed due to a device error.
The transfer status is returned in Status.
@retval EFI_NOT_FOUND The specified USB endpoint descriptor can not be found
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
UsbClearEndpointHalt ( UsbClearEndpointHalt (
IN EFI_USB_IO_PROTOCOL *UsbIo, IN EFI_USB_IO_PROTOCOL *UsbIo,
IN UINT8 EndpointNo, IN UINT8 Endpoint,
OUT UINT32 *Status OUT UINT32 *Status
) )
{ {
@ -528,9 +610,8 @@ UsbClearEndpointHalt (
EFI_USB_INTERFACE_DESCRIPTOR InterfaceDescriptor; EFI_USB_INTERFACE_DESCRIPTOR InterfaceDescriptor;
UINT8 Index; UINT8 Index;
if (UsbIo == NULL) { ASSERT (UsbIo != NULL);
return EFI_INVALID_PARAMETER; ASSERT (Status != NULL);
}
ZeroMem (&EndpointDescriptor, sizeof (EFI_USB_ENDPOINT_DESCRIPTOR)); ZeroMem (&EndpointDescriptor, sizeof (EFI_USB_ENDPOINT_DESCRIPTOR));
// //
@ -554,7 +635,7 @@ UsbClearEndpointHalt (
continue; continue;
} }
if (EndpointDescriptor.EndpointAddress == EndpointNo) { if (EndpointDescriptor.EndpointAddress == Endpoint) {
break; break;
} }
} }