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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
|
//*****************************************************************************
//
// usbhost.h - Host specific definitions for the USB host library.
//
// Copyright (c) 2008-2012 Texas Instruments Incorporated. All rights reserved.
// Software License Agreement
//
// Texas Instruments (TI) is supplying this software for use solely and
// exclusively on TI's microcontroller products. The software is owned by
// TI and/or its suppliers, and is protected under applicable copyright
// laws. You may not combine this software with "viral" open-source
// software in order to form a larger program.
//
// THIS SOFTWARE IS PROVIDED "AS IS" AND WITH ALL FAULTS.
// NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT
// NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. TI SHALL NOT, UNDER ANY
// CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
// DAMAGES, FOR ANY REASON WHATSOEVER.
//
// This is part of revision 9453 of the Stellaris USB Library.
//
//*****************************************************************************
#ifndef __USBHOST_H__
#define __USBHOST_H__
//*****************************************************************************
//
// If building with a C++ compiler, make all of the definitions in this header
// have a C binding.
//
//*****************************************************************************
#ifdef __cplusplus
extern "C"
{
#endif
//*****************************************************************************
//
//! \addtogroup usblib_hcd
//! @{
//
//*****************************************************************************
//*****************************************************************************
//
// This is the type used to identify what the pipe is currently in use for.
//
//*****************************************************************************
#define USBHCD_PIPE_UNUSED 0x00100000
#define USBHCD_PIPE_CONTROL 0x00130000
#define USBHCD_PIPE_BULK_OUT 0x00210000
#define USBHCD_PIPE_BULK_IN 0x00220000
#define USBHCD_PIPE_INTR_OUT 0x00410000
#define USBHCD_PIPE_INTR_IN 0x00420000
#define USBHCD_PIPE_ISOC_OUT 0x00810000
#define USBHCD_PIPE_ISOC_IN 0x00820000
#define USBHCD_PIPE_ISOC_OUT_DMA 0x01810000
#define USBHCD_PIPE_ISOC_IN_DMA 0x01820000
#define USBHCD_PIPE_BULK_OUT_DMA 0x01210000
#define USBHCD_PIPE_BULK_IN_DMA 0x01220000
//*****************************************************************************
//
// These are the defines that are used with USBHCDPowerConfigInit().
//
//*****************************************************************************
#define USBHCD_FAULT_LOW 0x00000010
#define USBHCD_FAULT_HIGH 0x00000030
#define USBHCD_FAULT_VBUS_NONE 0x00000000
#define USBHCD_FAULT_VBUS_TRI 0x00000140
#define USBHCD_FAULT_VBUS_DIS 0x00000400
#define USBHCD_VBUS_MANUAL 0x00000004
#define USBHCD_VBUS_AUTO_LOW 0x00000002
#define USBHCD_VBUS_AUTO_HIGH 0x00000003
#define USBHCD_VBUS_FILTER 0x00010000
//*****************************************************************************
//
//! This macro is used to declare an instance of an Event driver for the USB
//! library.
//!
//! \param VarName is the name of the variable.
//! \param pfnOpen is the callback for the Open call to this driver. This
//! value is currently reserved and should be set to 0.
//! \param pfnClose is the callback for the Close call to this driver. This
//! value is currently reserved and should be set to 0.
//! \param pfnEvent is the callback that will be called for various USB events.
//!
//! The first parameter is the actual name of the variable that will
//! be declared by this macro. The second and third parameter are reserved
//! for future functionality and are unused and should be set to zero. The
//! last parameter is the actual callback function and is specified as
//! a function pointer of the type:
//!
//! void (*pfnEvent)(void *pvData);
//!
//! When the \e pfnEvent function is called the void pointer that is passed in
//! as a parameter should be cast to a pointer to a structure of type
//! tEventInfo. This will contain the event that caused the pfnEvent function
//! to be called.
//
//*****************************************************************************
#define DECLARE_EVENT_DRIVER(VarName, pfnOpen, pfnClose, pfnEvent) \
void IntFn(void *pvData); \
const tUSBHostClassDriver VarName = \
{ \
USB_CLASS_EVENTS, \
0, \
0, \
pfnEvent \
}
//*****************************************************************************
//
// This is the type definition a call back for events on USB Pipes allocated
// by USBHCDPipeAlloc().
//
// \param ulPipe is well the pipe
// \param ulEvent is well the event
//
// longer def thand may need more text in order to be recogized what should
// this really say about ourselves.
//
// \return None.
//
//*****************************************************************************
typedef void (* tHCDPipeCallback)(unsigned long ulPipe,
unsigned long ulEvent);
//*****************************************************************************
//
//! This is the structure that holds all of the information for devices
//! that are enumerated in the system. It is passed in to Open function of
//! USB host class drivers so that they can allocate any endpoints and parse
//! out other information that the device class needs to complete enumeration.
//
//*****************************************************************************
typedef struct
{
//
//! The current device address for this device.
//
unsigned long ulAddress;
//
//! The current interface for this device.
//
unsigned long ulInterface;
//
//! A flag used to determine whether we need to pass an interrupt
//! notification on to this device as a result of endpoint activity.
//
tBoolean bNotifyInt;
//
//! A flag used to record whether this is a low-speed or a full-speed
//! device.
//
tBoolean bLowSpeed;
//
//! A flag indicating whether or not we have read the device's
//! configuration descriptor yet.
//
tBoolean bConfigRead;
//
//! The hub number to which this device is attached.
//
unsigned char ucHub;
//
//! The hub port number to which the device is attached.
//
unsigned char ucHubPort;
//
//! The device descriptor for this device.
//
tDeviceDescriptor DeviceDescriptor;
//
//! A pointer to the configuration descriptor for this device.
//
tConfigDescriptor *pConfigDescriptor;
//
//! The size of the buffer allocated to pConfigDescriptor.
//
unsigned long ulConfigDescriptorSize;
}
tUSBHostDevice;
//*****************************************************************************
//
//! This structure defines a USB host class driver interface, it is parsed to
//! find a USB class driver once a USB device is enumerated.
//
//*****************************************************************************
typedef struct
{
//
//! The interface class that this device class driver supports.
//
unsigned long ulInterfaceClass;
//
//! The function is called when this class of device has been detected.
//
void * (*pfnOpen)(tUSBHostDevice *pDevice);
//
//! The function is called when the device, originally opened with a call
//! to the pfnOpen function, is disconnected.
//
void (*pfnClose)(void *pvInstance);
//
//! This is the optional interrupt handler that will be called when an
//! endpoint associated with this device instance generates an interrupt.
//
void (*pfnIntHandler)(void *pvInstance);
}
tUSBHostClassDriver;
//*****************************************************************************
//
// Close the Doxygen group.
//! @}
//
//*****************************************************************************
//*****************************************************************************
//
// If the g_USBEventDriver is included in the host controller driver list then
// this function must be provided by the application.
//
//*****************************************************************************
void USBHCDEvents(void *pvData);
//*****************************************************************************
//
// Prototypes for the USB Host controller APIs.
//
//*****************************************************************************
extern void USBHCDMain(void);
extern long USBHCDEventEnable(unsigned long ulIndex, void *pvEventDriver,
unsigned long ulEvent);
extern long USBHCDEventDisable(unsigned long ulIndex, void *pvEventDriver,
unsigned long ulEvent);
extern void USBHCDInit(unsigned long ulIndex, void *pData,
unsigned long ulSize);
extern void USBHCDPowerConfigInit(unsigned long ulIndex,
unsigned long ulFlags);
extern unsigned long USBHCDPowerConfigGet(unsigned long ulIndex);
extern unsigned long USBHCDPowerConfigSet(unsigned long ulIndex,
unsigned long ulConfig);
extern unsigned long USBHCDPowerAutomatic(unsigned long ulIndex);
extern void
USBHCDRegisterDrivers(unsigned long ulIndex,
const tUSBHostClassDriver * const *ppHClassDrvrs,
unsigned long ulNumDrivers);
extern void USBHCDTerm(unsigned long ulIndex);
extern void USBHCDSetConfig(unsigned long ulIndex, unsigned long ulDevice,
unsigned long ulConfiguration);
extern void USBHCDSetInterface(unsigned long ulIndex, unsigned long ulDevice,
unsigned long ulInterface,
unsigned ulAltSetting);
extern unsigned long USBHCDHubDeviceConnected(unsigned long ulIndex,
unsigned char ucHub,
unsigned char ucPort,
tBoolean bLowSpeed,
unsigned char *pucConfigPool,
unsigned long ulConfigSize);
extern void USBHCDHubDeviceDisconnected(unsigned long ulIndex,
unsigned long ulDevIndex);
extern void USBHCDSuspend(unsigned long ulIndex);
extern void USBHCDResume(unsigned long ulIndex);
extern void USBHCDReset(unsigned long ulIndex);
extern void USBHCDPipeFree(unsigned long ulPipe);
extern unsigned long USBHCDPipeAlloc(unsigned long ulIndex,
unsigned long ulEndpointType,
tUSBHostDevice *psDevice,
tHCDPipeCallback pCallback);
extern unsigned long USBHCDPipeAllocSize(unsigned long ulIndex,
unsigned long ulEndpointType,
tUSBHostDevice *psDevice,
unsigned long ulFIFOSize,
tHCDPipeCallback pCallback);
extern unsigned long USBHCDPipeConfig(unsigned long ulPipe,
unsigned long ulMaxPayload,
unsigned long ulInterval,
unsigned long ulTargetEndpoint);
extern unsigned long USBHCDPipeStatus(unsigned long ulPipe);
extern unsigned long USBHCDPipeWrite(unsigned long ulPipe,
unsigned char *pData,
unsigned long ulSize);
extern unsigned long USBHCDPipeRead(unsigned long ulPipe, unsigned char *pData,
unsigned long ulSize);
extern unsigned long USBHCDPipeSchedule(unsigned long ulPipe,
unsigned char *pucData,
unsigned long ulSize);
extern void USBHCDPipeDataAck(unsigned long ulPipe);
extern unsigned long USBHCDPipeReadNonBlocking(unsigned long ulPipe,
unsigned char *pucData,
unsigned long ulSize);
extern unsigned long USBHCDControlTransfer(unsigned long ulIndex,
tUSBRequest *pSetupPacket,
tUSBHostDevice *pDevice,
unsigned char *pData,
unsigned long ulSize,
unsigned long ulMaxPacketSize);
extern void USB0HostIntHandler(void);
extern unsigned char USBHCDDevHubPort(unsigned long ulInstance);
extern unsigned char USBHCDDevAddress(unsigned long ulInstance);
extern unsigned char USBHCDDevClass(unsigned long ulInstance,
unsigned long ulInterface);
extern unsigned char USBHCDDevSubClass(unsigned long ulInstance,
unsigned long ulInterface);
extern unsigned char USBHCDDevProtocol(unsigned long ulInstance,
unsigned long ulInterface);
//*****************************************************************************
//
// The host class drivers supported by the USB library.
//
//*****************************************************************************
extern const tUSBHostClassDriver g_USBHostMSCClassDriver;
extern const tUSBHostClassDriver g_USBHIDClassDriver;
extern const tUSBHostClassDriver g_USBHostAudioClassDriver;
#include "usbhostpriv.h"
//*****************************************************************************
//
// Mark the end of the C bindings section for C++ compilers.
//
//*****************************************************************************
#ifdef __cplusplus
}
#endif
#endif // __USBHOST_H__
|
