3 This file contains URB request, each request is warpped in a
4 URB (Usb Request Block).
6 Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
7 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_EHCI_URB_H_
18 #define _EFI_EHCI_URB_H_
21 typedef struct _EHC_QTD EHC_QTD
;
22 typedef struct _EHC_QH EHC_QH
;
23 typedef struct _URB URB
;
26 // Transfer types, used in URB to identify the transfer type
28 #define EHC_CTRL_TRANSFER 0x01
29 #define EHC_BULK_TRANSFER 0x02
30 #define EHC_INT_TRANSFER_SYNC 0x04
31 #define EHC_INT_TRANSFER_ASYNC 0x08
33 #define EHC_QTD_SIG SIGNATURE_32 ('U', 'S', 'B', 'T')
34 #define EHC_QH_SIG SIGNATURE_32 ('U', 'S', 'B', 'H')
35 #define EHC_URB_SIG SIGNATURE_32 ('U', 'S', 'B', 'R')
38 // Hardware related bit definitions
40 #define EHC_TYPE_ITD 0x00
41 #define EHC_TYPE_QH 0x02
42 #define EHC_TYPE_SITD 0x04
43 #define EHC_TYPE_FSTN 0x06
45 #define QH_NAK_RELOAD 3
46 #define QH_HSHBW_MULTI 1
49 #define QTD_PID_OUTPUT 0x00
50 #define QTD_PID_INPUT 0x01
51 #define QTD_PID_SETUP 0x02
53 #define QTD_STAT_DO_OUT 0
54 #define QTD_STAT_DO_SS 0
55 #define QTD_STAT_DO_PING 0x01
56 #define QTD_STAT_DO_CS 0x02
57 #define QTD_STAT_TRANS_ERR 0x08
58 #define QTD_STAT_BABBLE_ERR 0x10
59 #define QTD_STAT_BUFF_ERR 0x20
60 #define QTD_STAT_HALTED 0x40
61 #define QTD_STAT_ACTIVE 0x80
62 #define QTD_STAT_ERR_MASK (QTD_STAT_TRANS_ERR | QTD_STAT_BABBLE_ERR | QTD_STAT_BUFF_ERR)
64 #define QTD_MAX_BUFFER 4
65 #define QTD_BUF_LEN 4096
66 #define QTD_BUF_MASK 0x0FFF
68 #define QH_MICROFRAME_0 0x01
69 #define QH_MICROFRAME_1 0x02
70 #define QH_MICROFRAME_2 0x04
71 #define QH_MICROFRAME_3 0x08
72 #define QH_MICROFRAME_4 0x10
73 #define QH_MICROFRAME_5 0x20
74 #define QH_MICROFRAME_6 0x40
75 #define QH_MICROFRAME_7 0x80
77 #define USB_ERR_SHORT_PACKET 0x200
80 // Fill in the hardware link point: pass in a EHC_QH/QH_HW
81 // pointer to QH_LINK; A EHC_QTD/QTD_HW pointer to QTD_LINK
83 #define QH_LINK(Addr, Type, Term) \
84 ((UINT32) ((EHC_LOW_32BIT (Addr) & 0xFFFFFFE0) | (Type) | ((Term) ? 1 : 0)))
86 #define QTD_LINK(Addr, Term) QH_LINK((Addr), 0, (Term))
89 // The defination of EHCI hardware used data structure for
90 // little endian architecture. The QTD and QH structures
91 // are required to be 32 bytes aligned. Don't add members
92 // to the head of the associated software strucuture.
104 UINT32 TotalBytes
: 15;
105 UINT32 DataToggle
: 1;
114 // Endpoint capabilities/Characteristics DWord 1 and DWord 2
116 UINT32 DeviceAddr
: 7;
121 UINT32 ReclaimHead
: 1;
122 UINT32 MaxPacketLen
: 11;
124 UINT32 NakReload
: 4;
130 UINT32 Multiplier
: 2;
133 // Transaction execution overlay area
144 UINT32 TotalBytes
: 15;
145 UINT32 DataToggle
: 1;
154 // Endpoint address and its capabilities
156 typedef struct _USB_ENDPOINT
{
158 UINT8 EpAddr
; // Endpoint address, no direction encoded in
159 EFI_USB_DATA_DIRECTION Direction
;
164 UINT8 Toggle
; // Data toggle, not used for control transfer
166 UINTN PollRate
; // Polling interval used by EHCI
170 // Software QTD strcture, this is used to manage all the
171 // QTD generated from a URB. Don't add fields before QtdHw.
176 LIST_ENTRY QtdList
; // The list of QTDs to one end point
177 UINT8
*Data
; // Buffer of the original data
178 UINTN DataLen
; // Original amount of data in this QTD
182 // Software QH structure. All three different transaction types
183 // supported by UEFI USB, that is the control/bulk/interrupt
184 // transfers use the queue head and queue token strcuture.
186 // Interrupt QHs are linked to periodic frame list in the reversed
187 // 2^N tree. Each interrupt QH is linked to the list starting at
188 // frame 0. There is a dummy interrupt QH linked to each frame as
189 // a sentinental whose polling interval is 1. Synchronous interrupt
190 // transfer is linked after this dummy QH.
192 // For control/bulk transfer, only synchronous (in the sense of UEFI)
193 // transfer is supported. A dummy QH is linked to EHCI AsyncListAddr
194 // as the reclamation header. New transfer is inserted after this QH.
199 EHC_QH
*NextQh
; // The queue head pointed to by horizontal link
200 LIST_ENTRY Qtds
; // The list of QTDs to this queue head
205 // URB (Usb Request Block) contains information for all kinds of
213 // Transaction information
216 EFI_USB_DEVICE_REQUEST
*Request
; // Control transfer only
217 VOID
*RequestPhy
; // Address of the mapped request
221 VOID
*DataPhy
; // Address of the mapped user data
223 EFI_ASYNC_USB_TRANSFER_CALLBACK Callback
;
232 // Transaction result
235 UINTN Completed
; // completed data length
242 Create a single QTD to hold the data.
244 @param Ehc The EHCI device.
245 @param Data The cpu memory address of current data not associated with a QTD.
246 @param DataPhy The pci bus address of current data not associated with a QTD.
247 @param DataLen The length of the data.
248 @param PktId Packet ID to use in the QTD.
249 @param Toggle Data toggle to use in the QTD.
250 @param MaxPacket Maximu packet length of the endpoint.
252 @return Created QTD or NULL if failed to create one.
269 Allocate and initialize a EHCI queue head.
271 @param Ehci The EHCI device.
272 @param Ep The endpoint to create queue head for.
274 @return Created queue head or NULL if failed to create one.
279 IN USB2_HC_DEV
*Ehci
,
285 Free an allocated URB. It is possible for it to be partially inited.
287 @param Ehc The EHCI device.
288 @param Urb The URB to free.
299 Create a new URB and its associated QTD.
301 @param Ehc The EHCI device.
302 @param DevAddr The device address.
303 @param EpAddr Endpoint addrress & its direction.
304 @param DevSpeed The device speed.
305 @param Toggle Initial data toggle to use.
306 @param MaxPacket The max packet length of the endpoint.
307 @param Hub The transaction translator to use.
308 @param Type The transaction type.
309 @param Request The standard USB request for control transfer.
310 @param Data The user data to transfer.
311 @param DataLen The length of data buffer.
312 @param Callback The function to call when data is transferred.
313 @param Context The context to the callback.
314 @param Interval The interval for interrupt transfer.
316 @return Created URB or NULL.
327 IN EFI_USB2_HC_TRANSACTION_TRANSLATOR
*Hub
,
329 IN EFI_USB_DEVICE_REQUEST
*Request
,
332 IN EFI_ASYNC_USB_TRANSFER_CALLBACK Callback
,