1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
|
//****************************************************************************
//****************************************************************************
//** **
//** (C)Copyright 1985-2008, American Megatrends, Inc. **
//** **
//** All Rights Reserved. **
//** **
//** 5555 Oakbrook Pkwy, Norcross, GA 30093 **
//** **
//** Phone (770)-246-8600 **
//** **
//****************************************************************************
//****************************************************************************
//****************************************************************************
// $Header: /Alaska/SOURCE/Modules/USB/ALASKA/RT/uhci.h 11 7/26/13 2:40a Ryanchou $
//
// $Revision: 11 $
//
// $Date: 7/26/13 2:40a $
//****************************************************************************
//****************************************************************************
// Revision History
// ----------------
// $Log: /Alaska/SOURCE/Modules/USB/ALASKA/RT/uhci.h $
//
// 11 7/26/13 2:40a Ryanchou
// [TAG] EIP122142
// [Category] Improvement
// [Description] Improve periodic schedule mechanism
// [Files] ehci.c, ehci.h, ohci.c, ohci.h, uhci.c, uhci.h, usbdef.h,
// amiusbhc.c
//
// 10 1/11/13 4:16a Ryanchou
// [TAG] EIP102491
// [Category] Improvement
// [Description] Synchronized with Aptio V USB module
// [Files] usbport.c, usbsb.c, ehci.c, ehci.h, ohci.c, ohci.h, uhci.h,
// usb.c, usbdef.h, usbhid.c, usbhub.c, usbkbd.c, usbkbd.h, usbmass.c.
// usbms.c, usbpoint.c, xhci.h, usb.sd, amiusbhc.c, componentname.c,
// efiusbkc.c, efiusbmass.c, uhcd.c, uhcd.h, usbbus.c, usbbus.h, usbmisc.c
//
// 9 11/22/12 9:21p Wilsonlee
// [TAG] EIP106887
// [Category] New Feature
// [Description] Support usb S5 wake up function for UHCI.
// [Files] usb.c, uhci.c, uhci.h
//
// 8 5/04/12 6:39a Ryanchou
// [TAG] EIP82875
// [Category] Improvement
// [Description] Support start/stop individual USB host to avoid
// reconnect issues.
// [Files] usbport.c, usbsb.c, amiusb.c, amiusb.h, ehci.c, ohci.c,
// uhci.c, uhci.h, usb.c, usbdef.h, xhci.c, amiusbhc.c, uhcd.c, uhcd.h,
// usbbus.c, usbmisc.c
//
// 7 5/04/12 5:26a Wilsonlee
// [TAG] EIP89307
// [Category] Improvement
// [Description] Modify incorrect #pragma pack directive.
// [Files] amidef.h, amiusb.c, ehci.h, ohci.c, ohci.h, uhci.h, usb.c,
// usbdef.h, xhci.h, efiusbmass.c, uhcd.c, uhcd.h, usbbus.c, usbbus.h,
// UsbIo.h
//
// 6 1/04/10 9:20a Olegi
// EIP32956: Polling rate for the keyboards has been changed from 8 ms to
// 32 ms.
//
// 5 5/16/08 12:01p Olegi
// Compliance with AMI coding standard.
//
// 4 3/20/07 12:20p Olegi
//
// 2 3/20/06 3:37p Olegi
// Version 8.5 - x64 compatible.
//
// 1 3/28/05 6:20p Olegi
//
// 1 3/15/05 9:23a Olegi
// Initial VSS check-in.
//
//****************************************************************************
//<AMI_FHDR_START>
//-----------------------------------------------------------------------------
//
// Name: Uhci.h
//
// Description: AMI USB UHCI header file
//
//-----------------------------------------------------------------------------
//<AMI_FHDR_END>
// Avoid including multiple instance of this file
#ifndef __UHCI_H
#define __UHCI_H
#define UHCI_DATA_AREA_SIZE 0x1000
#define UHCI_FRAME_LIST_SIZE 1024
#define USB_UHCI_REG_LEGSUP 0xC0
//---------------------------------------------------------------------------
// UHCI I/O register read access definitions
//---------------------------------------------------------------------------
// Equates for UHCI I/O mapped registers (offsets from base address)
#define UHCI_COMMAND_REG 0x00
#define UHCI_STATUS_REG 0x02
#define UHCI_INTERRUPT_ENABLE 0x04
#define UHCI_FRAME_NUM 0x06
#define UHCI_FRAME_LIST_BASE 0x08
#define UHCI_SOF_MODIFY 0x0C
#define UHCI_PORT1_CONTROL 0x10
#define UHCI_PORT2_CONTROL 0x12
// Bit definitions for UHCI command register
#define UHC_HOST_CONTROLLER_RUN BIT0
#define UHC_HOST_CONTROLLER_RESET BIT1
#define UHC_GLOBAL_RESET BIT2
#define UHC_ENTER_SUSPEND BIT3
#define UHC_FORCE_RESUME BIT4
#define UHC_CONFIGURE_FLAG BIT6
#define UHC_MAX_PACKET_64_BYTE BIT7
// Bit definitions for UHCI status register
#define UHC_USB_INTERRUPT BIT0
#define UHC_USB_ERROR_INTERRUPT BIT1
#define UHC_RESUME_RECEIVED BIT2
#define UHC_PCI_BUS_ERROR BIT3
#define UHC_HC_PROCESS_ERROR BIT4
#define UHC_HC_HALTED BIT5
// Bit definitions for USB interrupt enable register
#define UHC_TIMEOUT_CRC_ENABLE BIT0
#define UHC_RESUME_ENABLE BIT1
#define UHC_IOC_ENABLE BIT2
#define UHC_SHORT_PACKET_ENABLE BIT3
// Bit definitions for Port Status and Control
#define UHC_CONNECT_STATUS BIT0
#define UHC_CONNECT_STATUS_CHANGE BIT1
#define UHC_PORT_ENABLE BIT2
#define UHC_PORT_ENABLE_CHANGE BIT3
#define UHC_LINE_STATUS 0x30
#define UHC_LINE_STATUS_CHANGE BIT6
#define UHC_LOW_SPEED_ATTACHED BIT8
#define UHC_PORT_RESET BIT9
#define UHC_PORT_SUSPEND BIT12
//---------------------------------------------------------------------------
// UHCI Controller Port 60/64h trapping flags
//---------------------------------------------------------------------------
#define UHCI_TRAP_PORT_60h_READ BIT0
#define UHCI_TRAP_PORT_60h_WRITE BIT1
#define UHCI_TRAP_PORT_64h_READ BIT2
#define UHCI_TRAP_PORT_64h_WRITE BIT3
#define UHCI_SMI_ON_USB_INTERRUPT BIT4
#define UHCI_TRAP_FLAG (UHCI_SMI_ON_USB_INTERRUPT)
//---------------------------------------------------------------------------
// Bit definitions for a generic pointer
//---------------------------------------------------------------------------
#define UHCI_TERMINATE BIT0
#define UHCI_QUEUE_HEAD BIT1
#define UHCI_VERTICAL_FLAG BIT2
#define UHCI_POINTER_MASK 0xFFFFFFF0
//---------------------------------------------------------------------------
// Bit definitions for transfer descriptor control and status
//---------------------------------------------------------------------------
#define UHCI_TD_ACTUAL_LENGTH 0x7FF
#define UHCI_TD_STATUS_FIELD 0xFE0000
#define UHCI_TD_BITSTUFF_ERROR 0x20000
#define UHCI_TD_CRC_TIMEOUT_ERROR 0x40000
#define UHCI_TD_NAK_RECEIVED 0x80000
#define UHCI_TD_BABBLE_DETECTED 0x100000
#define UHCI_TD_DATA_BUFFER_ERROR 0x200000
#define UHCI_TD_STALLED 0x400000
#define UHCI_TD_ACTIVE 0x800000
#define UHCI_TD_INTERRUPT_ON_COMPLETE 0x1000000
#define UHCI_TD_ISOCHRONOUS_SELECT 0x2000000
#define UHCI_TD_LOW_SPEED_DEVICE 0x4000000
#define UHCI_TD_ERROR_COUNTER 0x18000000
#define UHCI_TD_ONE_ERROR 0x8000000
#define UHCI_TD_TWO_ERRORS 0x10000000
#define UHCI_TD_THREE_ERRORS 0x18000000
#define UHCI_TD_SHORT_PACKET_DETECT 0x20000000
//---------------------------------------------------------------------------
// Bit definitions for transfer descriptor token
//---------------------------------------------------------------------------
#define UHCI_TD_PACKET_ID 0xFF
#define UHCI_TD_IN_PACKET 0x69
#define UHCI_TD_OUT_PACKET 0xE1
#define UHCI_TD_SETUP_PACKET 0x2D
#define UHCI_TD_DEVICE_ADDRESS 0x7F00
#define UHCI_TD_ENDPOINT 0x78000
#define UHCI_TD_DATA_TOGGLE 0x80000
#define UHCI_TD_MAX_LENGTH 0xFFE00000
typedef enum {
Control = 1,
Bulk = 0,
Interrupt = 2,
Isochronous = 3
} XFER_TYPE;
#pragma pack(push, 1)
// UHCI TD structure
typedef struct {
UINT32 pLinkPtr;
UINT32 dControlStatus;
UINT32 dToken;
UINT32 pBufferPtr;
// AMI defined fields
UINT32 dCSReload; // Control status reload value
UINT8 bCallBackIndex;
UINT8 bActiveFlag;
UINT16 wReserved;
UINT8 aDataArea[8];
} UHCI_TD;
typedef struct {
UINT32 pLinkPtr;
UINT32 pElementPtr;
UHCI_TD *CurrentTd;
UINT8 DataToggle;
UINT32 BytesTransferred;
BOOLEAN ShortPacketDetected;
XFER_TYPE Type;
UHCI_TD *FirstTd;
UINT8 Interval;
UINT8 CallBackIndex;
BOOLEAN ActiveFlag;
VOID *DevInfoPtr;
UINT8 aReserved[47 - 3 * sizeof(VOID*) - sizeof(XFER_TYPE)];
} UHCI_QH;
#pragma pack(pop)
typedef struct {
UHCI_QH *StaticQh;
UHCI_QH *RootHubQh;
UHCI_QH *RepeatQh;
} UHCI_DESC_PTRS;
#endif // __UHCI_H
//****************************************************************************
//****************************************************************************
//** **
//** (C)Copyright 1985-2008, American Megatrends, Inc. **
//** **
//** All Rights Reserved. **
//** **
//** 5555 Oakbrook Pkwy, Norcross, GA 30093 **
//** **
//** Phone (770)-246-8600 **
//** **
//****************************************************************************
//****************************************************************************
|
