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
|
//*****************************************************************************
//
// usbdevice.h - types and definitions used during USB enumeration.
//
// 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 __USBDEVICE_H__
#define __USBDEVICE_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 device_api
//! @{
//
//*****************************************************************************
//*****************************************************************************
//
//! The maximum number of independent interfaces that any single device
//! implementation can support. Independent interfaces means interface
//! descriptors with different bInterfaceNumber values - several interface
//! descriptors offering different alternative settings but the same interface
//! number count as a single interface.
//
//*****************************************************************************
#define USB_MAX_INTERFACES_PER_DEVICE 8
#include "./usbdevicepriv.h"
//*****************************************************************************
//
// Close the Doxygen group.
//! @}
//
//*****************************************************************************
//*****************************************************************************
//
//! This structure is passed to the USB library on a call to USBDCDInit and
//! provides the library with information about the device that the
//! application is implementing. It contains functions pointers for the
//! various USB event handlers and pointers to each of the standard device
//! descriptors.
//
//*****************************************************************************
struct tDeviceInfo
{
//
//! A pointer to a structure containing pointers to event handler functions
//! provided by the client to support the operation of this device.
//
tCustomHandlers sCallbacks;
//
//! A pointer to the device descriptor for this device.
//
const unsigned char *pDeviceDescriptor;
//
//! A pointer to an array of configuration descriptor pointers. Each entry
//! in the array corresponds to one configuration that the device may be set
//! to use by the USB host. The number of entries in the array must
//! match the bNumConfigurations value in the device descriptor
//! array, pDeviceDescriptor.
//
const tConfigHeader * const *ppConfigDescriptors;
//
//! A pointer to the string descriptor array for this device. This array
//! must be arranged as follows:
//!
//! - [0] - Standard descriptor containing supported language codes.
//! - [1] - String 1 for the first language listed in descriptor 0.
//! - [2] - String 2 for the first language listed in descriptor 0.
//! - ...
//! - [n] - String n for the first language listed in descriptor 0.
//! - [n+1] - String 1 for the second language listed in descriptor 0.
//! - ...
//! - [2n] - String n for the second language listed in descriptor 0.
//! - [2n+1]- String 1 for the third language listed in descriptor 0.
//! - ...
//! - [3n] - String n for the third language listed in descriptor 0.
//!
//! and so on.
//
const unsigned char * const *ppStringDescriptors;
//
//! The total number of descriptors provided in the ppStringDescriptors
//! array.
//
unsigned long ulNumStringDescriptors;
//
//! A structure defining how the USB controller FIFO is to be partitioned
//! between the various endpoints. This member can be set to point to
//! g_sUSBDefaultFIFOConfig if the default FIFO configuration is acceptable
//! This configuration sets each endpoint FIFO to be single buffered and
//! sized to hold the maximum packet size for the endpoint.
//
const tFIFOConfig *psFIFOConfig;
//
//! This value will be passed back to all call back functions so that
//! they have access to individual instance data based on the this pointer.
//
void *pvInstance;
//
//! The generic device instance data for this device. This will be set
//! by the call to DCDInit() which is usually made when the applicaiton
//! calls the class specific initialization function.
//
tDeviceInstance *psDevice;
};
//*****************************************************************************
//
// The default USB endpoint FIFO configuration structure. This structure
// contains definitions to set all USB FIFOs into single buffered mode with
// no DMA use. Each endpoint's FIFO is sized to hold the largest maximum
// packet size for any interface alternate setting in the current config
// descriptor. A pointer to this structure may be passed in the psFIFOConfig
// field of the tDeviceInfo structure passed to USBCDCInit if the application
// does not require any special handling of the USB controller FIFO.
//
//*****************************************************************************
extern const tFIFOConfig g_sUSBDefaultFIFOConfig;
//*****************************************************************************
//
// Public APIs offered by the USB library device control driver.
//
//*****************************************************************************
extern void USBDCDInit(unsigned long ulIndex, tDeviceInfo *psDevice);
extern void USBDCDTerm(unsigned long ulIndex);
extern void USBDCDStallEP0(unsigned long ulIndex);
extern void USBDCDRequestDataEP0(unsigned long ulIndex, unsigned char *pucData,
unsigned long ulSize);
extern void USBDCDSendDataEP0(unsigned long ulIndex, unsigned char *pucData,
unsigned long ulSize);
extern void USBDCDSetDefaultConfiguration(unsigned long ulIndex,
unsigned long ulDefaultConfig);
extern unsigned long USBDCDConfigDescGetSize(const tConfigHeader *psConfig);
extern unsigned long USBDCDConfigDescGetNum(const tConfigHeader *psConfig,
unsigned long ulType);
extern tDescriptorHeader *USBDCDConfigDescGet(const tConfigHeader *psConfig,
unsigned long ulType,
unsigned long ulIndex,
unsigned long *pulSection);
extern unsigned long
USBDCDConfigGetNumAlternateInterfaces(const tConfigHeader *psConfig,
unsigned char ucInterfaceNumber);
extern tInterfaceDescriptor *
USBDCDConfigGetInterface(const tConfigHeader *psConfig,
unsigned long ulIndex, unsigned long ulAltCfg,
unsigned long *pulSection);
extern tEndpointDescriptor *
USBDCDConfigGetInterfaceEndpoint(const tConfigHeader *psConfig,
unsigned long ulInterfaceNumber,
unsigned long ulAltCfg,
unsigned long ulIndex);
extern void USBDCDPowerStatusSet(unsigned long ulIndex, unsigned char ucPower);
extern tBoolean USBDCDRemoteWakeupRequest(unsigned long ulIndex);
//*****************************************************************************
//
// Early releases of the USB library had the following function named
// incorrectly. This macro ensures that any code which used the previous name
// will still operate as expected.
//
//*****************************************************************************
#ifndef DEPRECATED
#define USBCDCConfigGetInterfaceEndpoint(a, b, c, d) \
USBDCDConfigGetInterfaceEndpoint((a), (b), (c), (d))
#endif
//*****************************************************************************
//
// Device mode interrupt handler for controller index 0.
//
//*****************************************************************************
extern void USB0DeviceIntHandler(void);
//*****************************************************************************
//
// Mark the end of the C bindings section for C++ compilers.
//
//*****************************************************************************
#ifdef __cplusplus
}
#endif
#endif // __USBENUM_H__
|
