2 Definition for the USB mass storage Bulk-Only Transport protocol,
3 based on the "Universal Serial Bus Mass Storage Class Bulk-Only
4 Transport" Revision 1.0, September 31, 1999.
6 Copyright (c) 2007 - 2010, Intel Corporation
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #ifndef _EFI_USBMASS_BOT_H_
18 #define _EFI_USBMASS_BOT_H_
22 extern USB_MASS_TRANSPORT mUsbBotTransport
;
25 // Usb Bulk-Only class specfic request
27 #define USB_BOT_RESET_REQUEST 0xFF ///< Bulk-Only Mass Storage Reset
28 #define USB_BOT_GETLUN_REQUEST 0xFE ///< Get Max Lun
29 #define USB_BOT_CBW_SIGNATURE 0x43425355 ///< dCBWSignature, tag the packet as CBW
30 #define USB_BOT_CSW_SIGNATURE 0x53425355 ///< dCSWSignature, tag the packet as CSW
31 #define USB_BOT_MAX_LUN 0x0F ///< Lun number is from 0 to 15
32 #define USB_BOT_MAX_CMDLEN 16 ///< Maxium number of command from command set
35 // Usb BOT command block status values
37 #define USB_BOT_COMMAND_OK 0x00 ///< Command passed, good status
38 #define USB_BOT_COMMAND_FAILED 0x01 ///< Command failed
39 #define USB_BOT_COMMAND_ERROR 0x02 ///< Phase error, need to reset the device
42 // Usb Bot retry to get CSW, refers to specification[BOT10-5.3, it says 2 times]
44 #define USB_BOT_RECV_CSW_RETRY 3
47 // Usb Bot wait device reset complete, set by experience
49 #define USB_BOT_RESET_DEVICE_STALL (100 * USB_MASS_1_MILLISECOND)
52 // Usb Bot transport timeout, set by experience
54 #define USB_BOT_SEND_CBW_TIMEOUT (3 * USB_MASS_1_SECOND)
55 #define USB_BOT_RECV_CSW_TIMEOUT (3 * USB_MASS_1_SECOND)
56 #define USB_BOT_RESET_DEVICE_TIMEOUT (3 * USB_MASS_1_SECOND)
60 /// The CBW (Command Block Wrapper) structures used by the USB BOT protocol.
65 UINT32 DataLen
; ///< Length of data between CBW and CSW
66 UINT8 Flag
; ///< Bit 7, 0 ~ Data-Out, 1 ~ Data-In
67 UINT8 Lun
; ///< Lun number. Bits 0~3 are used
68 UINT8 CmdLen
; ///< Length of the command. Bits 0~4 are used
69 UINT8 CmdBlock
[USB_BOT_MAX_CMDLEN
];
73 /// The and CSW (Command Status Wrapper) structures used by the USB BOT protocol.
85 // Put Interface at the first field to make it easy to distinguish BOT/CBI Protocol instance
87 EFI_USB_INTERFACE_DESCRIPTOR Interface
;
88 EFI_USB_ENDPOINT_DESCRIPTOR
*BulkInEndpoint
;
89 EFI_USB_ENDPOINT_DESCRIPTOR
*BulkOutEndpoint
;
91 EFI_USB_IO_PROTOCOL
*UsbIo
;
95 Initializes USB BOT protocol.
97 This function initializes the USB mass storage class BOT protocol.
98 It will save its context which is a USB_BOT_PROTOCOL structure
99 in the Context if Context isn't NULL.
101 @param UsbIo The USB I/O Protocol instance
102 @param Context The buffer to save the context to
104 @retval EFI_SUCCESS The device is successfully initialized.
105 @retval EFI_UNSUPPORTED The transport protocol doesn't support the device.
106 @retval Other The USB BOT initialization fails.
111 IN EFI_USB_IO_PROTOCOL
*UsbIo
,
112 OUT VOID
**Context OPTIONAL
116 Call the USB Mass Storage Class BOT protocol to issue
117 the command/data/status circle to execute the commands.
119 @param Context The context of the BOT protocol, that is,
121 @param Cmd The high level command
122 @param CmdLen The command length
123 @param DataDir The direction of the data transfer
124 @param Data The buffer to hold data
125 @param DataLen The length of the data
126 @param Lun The number of logic unit
127 @param Timeout The time to wait command
128 @param CmdStatus The result of high level command execution
130 @retval EFI_SUCCESS The command is executed successfully.
131 @retval Other Failed to excute command
139 IN EFI_USB_DATA_DIRECTION DataDir
,
144 OUT UINT32
*CmdStatus
148 Reset the USB mass storage device by BOT protocol.
150 @param Context The context of the BOT protocol, that is,
152 @param ExtendedVerification If FALSE, just issue Bulk-Only Mass Storage Reset request.
153 If TRUE, additionally reset parent hub port.
155 @retval EFI_SUCCESS The device is reset.
156 @retval Others Failed to reset the device..
162 IN BOOLEAN ExtendedVerification
166 Get the max LUN (Logical Unit Number) of USB mass storage device.
168 @param Context The context of the BOT protocol, that is, USB_BOT_PROTOCOL
169 @param MaxLun Return pointer to the max number of LUN. (e.g. MaxLun=1 means LUN0 and
172 @retval EFI_SUCCESS Max LUN is got successfully.
173 @retval Others Fail to execute this request.
183 Clean up the resource used by this BOT protocol.
185 @param Context The context of the BOT protocol, that is, USB_BOT_PROTOCOL.
187 @retval EFI_SUCCESS The resource is cleaned up.