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
|
/** @file
Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
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
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef _USB_DEVICE_H_
#define _USB_DEVICE_H_
//
// @USB_DEV_CONFIG_PARAMS: Struct to be filled in with configuration
// parameters and passed to the init routine for device controller
//
typedef struct {
USB_CONTROLLER_ID ControllerId; // Controller ID of the core
UINT32 BaseAddress; // Base address of the controller registers and on-chip memory
UINT32 Flags; // Initialization flags
USB_SPEED Speed; // Desired USB bus Speed
USB_ROLE Role; // Default USB role
} USB_DEV_CONFIG_PARAMS;
//
// @USB_DEV_CORE: Struct used as a handle for all
// hardware-independent APIs
//
typedef struct {
const struct UsbDeviceCoreDriver *CoreDriver;
VOID *ControllerHandle;
} USB_DEV_CORE;
typedef
EFI_STATUS
(EFIAPI *USB_DEVICE_CALLBACK_FUNC) (
IN USB_DEVICE_CALLBACK_PARAM *Param
);
EFI_STATUS
UsbDeviceInit (
IN USB_DEV_CONFIG_PARAMS *ConfigParams,
IN OUT VOID **DevCoreHandle
);
EFI_STATUS
UsbDeviceDeinit (
IN VOID *DevCoreHandle,
IN UINT32 Flags
);
EFI_STATUS
UsbDeviceRegisterCallback (
IN VOID *DevCoreHandle,
IN USB_DEVICE_EVENT_ID EventId,
IN USB_DEVICE_CALLBACK_FUNC CallbackFunc
);
EFI_STATUS
UsbDeviceUnregisterCallback (
IN VOID *DevCoreHandle,
IN USB_DEVICE_EVENT_ID EventId
);
EFI_STATUS
UsbDeviceIsrRoutine (
IN VOID *DevCoreHandle
);
EFI_STATUS
UsbDeviceIsrRoutineTimerBased (
IN VOID *DevCoreHandle
);
EFI_STATUS
UsbXdciDeviceConnect (
IN VOID *DevCoreHandle
);
EFI_STATUS
UsbDeviceDisconnect (
IN VOID *DevCoreHandle
);
EFI_STATUS
UsbDeviceGetSpeed (
IN VOID *DevCoreHandle,
IN USB_SPEED *Speed
);
EFI_STATUS
UsbDeviceSetLinkState (
IN VOID *DevCoreHandle,
IN USB_DEVICE_SS_LINK_STATE State
);
EFI_STATUS
UsbDeviceSetAddress (
IN VOID *DevCoreHandle,
IN UINT32 Address
);
EFI_STATUS
UsbDeviceSetConfiguration (
IN VOID *DevCoreHandle,
IN UINT32 ConfigNum
);
EFI_STATUS
UsbDeviceInitEp (
IN VOID *DevCoreHandle,
IN USB_EP_INFO *EpInfo
);
EFI_STATUS
UsbDeviceEpEnable (
IN VOID *DevCoreHandle,
IN USB_EP_INFO *EpInfo
);
EFI_STATUS
UsbDeviceEpDisable (
IN VOID *DevCoreHandle,
IN USB_EP_INFO *EpInfo
);
EFI_STATUS
UsbDeviceEpStall (
IN VOID *DevCoreHandle,
IN USB_EP_INFO *EpInfo
);
EFI_STATUS
UsbDeviceEpClearStall (
IN VOID *DevCoreHandle,
IN USB_EP_INFO *EpInfo
);
EFI_STATUS
UsbDeviceEpSetNrdy (
IN VOID *DevCoreHandle,
IN USB_EP_INFO *EpInfo
);
EFI_STATUS
UsbDeviceEp0RxSetup (
IN VOID *DevCoreHandle,
IN UINT8 *Buffer
);
EFI_STATUS
UsbDeviceEp0RxStatus (
IN VOID *DevCoreHandle
);
EFI_STATUS
UsbDeviceEp0TxStatus (
IN VOID *DevCoreHandle
);
EFI_STATUS
UsbXdciDeviceEpTxData (
IN VOID *DevCoreHandle,
IN USB_XFER_REQUEST *XferReq
);
EFI_STATUS
UsbXdciDeviceEpRxData (
IN VOID *DevCoreHandle,
IN USB_XFER_REQUEST *XferReq
);
EFI_STATUS
UsbDeviceEpCancelTransfer (
IN VOID *DevCoreHandle,
IN USB_EP_INFO *EpInfo
);
#endif
|
