summaryrefslogtreecommitdiff
path: root/ChvRefCodePkg/Include/Library/UsbDeviceModeLib.h
blob: 3bb4849ff5f6d5fe44298bb0ce6e097b73a938d2 (plain)
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
/** @file

  Copyright (c) 2009 - 2015, 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 __BASE_USBDEVICEMODE_LIB_H__
#define __BASE_USBDEVICEMODE_LIB_H__

#pragma pack(1)
typedef struct {
    UINT8  bLength;
    UINT8  bDescriptorType;
    UINT8  bMaxBurst;
    UINT8  bmAttributes;
    UINT16 wBytesPerInterval;
} endpointCompanionDescriptor;
#pragma pack()

#pragma pack(1)
typedef struct {
    UINT8  bLength;
    UINT8  bDescriptorType;
    UINT8  bEndpointAddress;
    UINT8  bmAttributes;
    UINT16 wMaxPacketSize;
    UINT8  bInterval;
} endpointDescriptor;
#pragma pack()

typedef struct {
    endpointDescriptor          *pEpDesc;
    endpointCompanionDescriptor *pEpCompDesc;
} USB_DEV_EP_INFO;    //usbdEpInfo;

typedef struct {
    VOID        *pBuf;
    UINT32    dataLen;
} USBD_IO_INFO;

typedef struct {
    USBD_IO_INFO     ioInfo;
    USB_DEV_EP_INFO  epInfo;
} USBD_IO_REQ;

/**
**/
UINTN
EFIAPI
usbdInitDCI (
  VOID
  );

/**
  @todo    add description

**/
BOOLEAN
EFIAPI
fbInit (
  OUT  VOID  *pParams
  );

/**
  @todo    add description

**/
BOOLEAN
EFIAPI
fbDeinit (
  VOID
  );

/**
  @todo    add description
**/
BOOLEAN
EFIAPI
fbStart (
  VOID
  );

/**
  @todo    add description
**/
BOOLEAN
EFIAPI
fbStop (
  VOID
  );

/**
  @todo    add description
**/
BOOLEAN
EFIAPI
usbdSetMmioBar (
  UINT32 mmioBar
  );

/**
  @todo    add description
**/
BOOLEAN
EFIAPI
udciDeinit (
  VOID    *pUdciHndl,
  UINT32  flags
  );

/**
  @todo    add description
**/
BOOLEAN
EFIAPI
udciIsr (
  VOID    *pUdciHndl
  );

/**
  @todo    add description
**/
BOOLEAN
EFIAPI
udciConnect (
  VOID    *pUdciHndl
  );

/**
  @todo    add description
**/
BOOLEAN
EFIAPI
udciDisconnect (
  VOID    *pUdciHndl
  );

/**
  @todo    add description
**/
BOOLEAN
EFIAPI
udciSetAddress (
  VOID    *pUdciHndl,
  UINT8   address
  );

/**
  @todo    add description
**/
BOOLEAN
EFIAPI
udciInitEp (
  VOID            *pUdciHndl,
  USB_DEV_EP_INFO *pEpInfo
  );


/**
  @todo    add description
**/
BOOLEAN
EFIAPI
udciEnableEp (
  VOID            *pUdciHndl,
  USB_DEV_EP_INFO *pEpInfo
  );

/**
  @todo    add description
**/
BOOLEAN
EFIAPI
udciDisableEp (
  VOID            *pUdciHndl,
  USB_DEV_EP_INFO *pEpInfo
  );

/**
  @todo    add description
**/
BOOLEAN
EFIAPI
udciStallEp (
  VOID            *pUdciHndl,
  USB_DEV_EP_INFO *pEpInfo
  );

/**
  @todo    add description
**/
BOOLEAN
EFIAPI
udciClearStallEp (
  VOID            *pUdciHndl,
  USB_DEV_EP_INFO *pEpInfo
  );


/**
  @todo    add description
**/
BOOLEAN
EFIAPI
udciEp0TxStatus (
  VOID            *pUdciHndl
  );

/**
  @todo    add description
**/
BOOLEAN
EFIAPI
udciEpTxData (
  VOID        *pUdciHndl,
  USBD_IO_REQ *pIoReq
  );

/**
  @todo    add description
**/
BOOLEAN
EFIAPI
udciEpRxData (
  VOID        *pUdciHndl,
  USBD_IO_REQ *pIoReq
  );

/**
  @todo    add description
**/
BOOLEAN
EFIAPI
udciRegisterCallbacks (
  VOID            *pUdciHndl
  );


#endif //