Statistics
| Branch: | Tag: | Revision:

root / LUFA / Drivers / USB / USB.h @ 978b99e5

History | View | Annotate | Download (19 KB)

1
/*
2
             LUFA Library
3
     Copyright (C) Dean Camera, 2011.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
*/
8

    
9
/*
10
  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
  Permission to use, copy, modify, distribute, and sell this
13
  software and its documentation for any purpose is hereby granted
14
  without fee, provided that the above copyright notice appear in
15
  all copies and that both that the copyright notice and this
16
  permission notice and warranty disclaimer appear in supporting
17
  documentation, and that the name of the author not be used in
18
  advertising or publicity pertaining to distribution of the
19
  software without specific, written prior permission.
20

21
  The author disclaim all warranties with regard to this
22
  software, including all implied warranties of merchantability
23
  and fitness.  In no event shall the author be liable for any
24
  special, indirect or consequential damages or any damages
25
  whatsoever resulting from loss of use, data or profits, whether
26
  in an action of contract, negligence or other tortious action,
27
  arising out of or in connection with the use or performance of
28
  this software.
29
*/
30

    
31
/** \file
32
 *  \brief Master include file for the library USB functionality.
33
 *
34
 *  Master include file for the library USB functionality.
35
 *
36
 *  This file should be included in all user projects making use of the USB portions of the library, instead of
37
 *  the individual USB driver submodule headers.
38
 */
39

    
40
/** \defgroup Group_USB USB Core - LUFA/Drivers/USB/USB.h
41
 *
42
 *  \section Sec_Dependencies Module Source Dependencies
43
 *  The following files must be built with any user project that uses this module:
44
 *    - LUFA/Drivers/USB/Core/ConfigDescriptor.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
45
 *    - LUFA/Drivers/USB/Core/DeviceStandardReq.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
46
 *    - LUFA/Drivers/USB/Core/Events.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
47
 *    - LUFA/Drivers/USB/Core/HostStandardReq.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
48
 *    - LUFA/Drivers/USB/Core/USBTask.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
49
 *    - LUFA/Drivers/USB/Core/<i>ARCH</i>/Device_<i>ARCH</i>.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
50
 *    - LUFA/Drivers/USB/Core/<i>ARCH</i>/Endpoint_<i>ARCH</i>.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
51
 *    - LUFA/Drivers/USB/Core/<i>ARCH</i>/EndpointStream_<i>ARCH</i>.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
52
 *    - LUFA/Drivers/USB/Core/<i>ARCH</i>/Host_<i>ARCH</i>.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
53
 *    - LUFA/Drivers/USB/Core/<i>ARCH</i>/Pipe_<i>ARCH</i>.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
54
 *    - LUFA/Drivers/USB/Core/<i>ARCH</i>/PipeStream_<i>ARCH</i>.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
55
 *    - LUFA/Drivers/USB/Core/<i>ARCH</i>/USBController_<i>ARCH</i>.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
56
 *    - LUFA/Drivers/USB/Core/<i>ARCH</i>/USBInterrupt_<i>ARCH</i>.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
57
 *    - LUFA/Drivers/USB/Class/Common/HIDParser.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
58
 *
59
 *  \section Sec_ModDescription Module Description
60
 *  Driver and framework for the USB controller of the selected architecture and microcontroller model. This module
61
 *  consists of many submodules, and is designed to provide an easy way to configure and control USB host, device
62
 *  or OTG mode USB applications.
63
 *
64
 *  The USB stack requires the sole control over the USB controller in the microcontroller only; i.e. it does not
65
 *  require any additional timers or other peripherals to operate. This ensures that the USB stack requires as few
66
 *  resources as possible.
67
 *
68
 *  The USB stack can be used in Device Mode for connections to USB Hosts (see \ref Group_Device), in Host mode for
69
 *  hosting of other USB devices (see \ref Group_Host), or as a dual role device which can either act as a USB host
70
 *  or device depending on what peripheral is connected (see \ref Group_OTG). Both modes also require a common set
71
 *  of USB management functions found \ref Group_USBManagement.
72
 */
73

    
74
/** \defgroup Group_USBClassDrivers USB Class Drivers
75
 *
76
 *  Drivers for both host and device mode of the standard USB classes, for rapid application development.
77
 *  Class drivers give a framework which sits on top of the low level library API, allowing for standard
78
 *  USB classes to be implemented in a project with minimal user code. These drivers can be used in
79
 *  conjunction with the library low level APIs to implement interfaces both via the class drivers and via
80
 *  the standard library APIs.
81
 *
82
 *  Multiple device mode class drivers can be used within a project, including multiple instances of the
83
 *  same class driver. In this way, USB Hosts and Devices can be made quickly using the internal class drivers
84
 *  so that more time and effort can be put into the end application instead of the USB protocol.
85
 *
86
 *  The available class drivers and their modes are listed below.
87
 *
88
 *  <table>
89
 *  <tr>
90
 *   <th width="100px">USB Class</th>
91
 *   <th width="90px">Device Mode</th>
92
 *   <th width="90px">Host Mode</th>
93
 *  </tr>
94
 *  <tr>
95
 *   <td>Audio</td>
96
 *   <td bgcolor="#00EE00">Yes</td>
97
 *   <td bgcolor="#00EE00">Yes</td>
98
 *  </tr>
99
 *  <tr>
100
 *   <td>CDC</td>
101
 *   <td bgcolor="#00EE00">Yes</td>
102
 *   <td bgcolor="#00EE00">Yes</td>
103
 *  </tr>
104
 *  <tr>
105
 *   <td>HID</td>
106
 *   <td bgcolor="#00EE00">Yes</td>
107
 *   <td bgcolor="#00EE00">Yes</td>
108
 *  </tr>
109
 *  <tr>
110
 *   <td>MIDI</td>
111
 *   <td bgcolor="#00EE00">Yes</td>
112
 *   <td bgcolor="#00EE00">Yes</td>
113
 *  </tr>
114
 *  <tr>
115
 *   <td>Mass Storage</td>
116
 *   <td bgcolor="#00EE00">Yes</td>
117
 *   <td bgcolor="#00EE00">Yes</td>
118
 *  </tr>
119
 *  <tr>
120
 *   <td>Printer</td>
121
 *   <td bgcolor="#EE0000">No</td>
122
*    <td bgcolor="#00EE00">Yes</td>
123
 *  </tr>
124
 *  <tr>
125
 *   <td>RNDIS</td>
126
 *   <td bgcolor="#00EE00">Yes</td>
127
 *   <td bgcolor="#00EE00">Yes</td>
128
 *  </tr>
129
 *  <tr>
130
 *   <td>Still Image</td>
131
 *   <td bgcolor="#EE0000">No</td>
132
 *   <td bgcolor="#00EE00">Yes</td>
133
 *  </tr>
134
 *  </table>
135
 *
136
 *
137
 *  \section Sec_UsingClassDrivers Using the Class Drivers
138
 *  To make the Class drivers easy to integrate into a user application, they all implement a standardized
139
 *  design with similarly named/used function, enums, defines and types. The two different modes are implemented
140
 *  slightly differently, and thus will be explained separately. For information on a specific class driver, read
141
 *  the class driver's module documentation.
142
 *
143
 *  \subsection Sec_ClassDriverDevice Device Mode Class Drivers
144
 *  Implementing a Device Mode Class Driver in a user application requires a number of steps to be followed. Firstly,
145
 *  the module configuration and state structure must be added to the project source. These structures are named in a
146
 *  similar manner between classes, that of <tt>USB_ClassInfo_<i>{Class Name}</i>_Device_t</tt>, and are used to hold the
147
 *  complete state and configuration for each class instance. Multiple class instances is where the power of the class
148
 *  drivers lie; multiple interfaces of the same class simply require more instances of the Class Driver's \c USB_ClassInfo_*
149
 *  structure.
150
 *
151
 *  Inside the ClassInfo structure lies two sections, a \c Config section, and a \c State section. The \c Config
152
 *  section contains the instance's configuration parameters, and <b>must have all fields set by the user application</b>
153
 *  before the class driver is used. Each Device mode Class driver typically contains a set of configuration parameters
154
 *  for the endpoint size/number of the associated logical USB interface, plus any class-specific configuration parameters.
155
 *
156
 *  The \c State section of the \c USB_ClassInfo_* structures are designed to be controlled by the Class Drivers only for
157
 *  maintaining the Class Driver instance's state, and should not normally be set by the user application.
158
 *
159
 *  The following is an example of a properly initialized instance of the Audio Class Driver structure:
160
 *
161
 *  \code
162
 *  USB_ClassInfo_Audio_Device_t My_Audio_Interface =
163
 *  {
164
 *      .Config =
165
 *          {
166
 *              .StreamingInterfaceNumber = 1,
167
 *
168
 *              .DataINEndpointNumber     = 1,
169
 *              .DataINEndpointSize       = 256,
170
 *          },
171
 *  };
172
 *  \endcode
173
 *
174
 *  \note The class driver's configuration parameters should match those used in the device's descriptors that are
175
 *  sent to the host.
176
 *
177
 *  To initialize the Class driver instance, the driver's <tt><i>{Class Name}</i>_Device_ConfigureEndpoints()</tt> function
178
 *  should be called in response to the \ref EVENT_USB_Device_ConfigurationChanged() event. This function will return a
179
 *  boolean true value if the driver successfully initialized the instance. Like all the class driver functions, this function
180
 *  takes in the address of the specific instance you wish to initialize - in this manner, multiple separate instances of
181
 *  the same class type can be initialized like this:
182
 *
183
 *  \code
184
 *  void EVENT_USB_Device_ConfigurationChanged(void)
185
 *  {
186
 *          LEDs_SetAllLEDs(LEDMASK_USB_READY);
187
 *
188
 *          if (!(Audio_Device_ConfigureEndpoints(&My_Audio_Interface)))
189
 *            LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
190
 *  }
191
 *  \endcode
192
 *
193
 *  Once initialized, it is important to maintain the class driver's state by repeatedly calling the Class Driver's
194
 *  <tt><i>{Class Name}</i>_Device_USBTask()</tt> function in the main program loop. The exact implementation of this
195
 *  function varies between class drivers, and can be used for any internal class driver purpose to maintain each
196
 *  instance. Again, this function uses the address of the instance to operate on, and thus needs to be called for each
197
 *  separate instance, just like the main USB maintenance routine \ref USB_USBTask():
198
 *
199
 *  \code
200
 *  int main(void)
201
 *  {
202
 *      SetupHardware();
203
 *
204
 *      LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
205
 *
206
 *      for (;;)
207
 *      {
208
 *          Create_And_Process_Samples();
209
 *
210
 *          Audio_Device_USBTask(&My_Audio_Interface);
211
 *          USB_USBTask();
212
 *      }
213
 *  }
214
 *  \endcode
215
 *
216
 *  The final standardized Device Class Driver function is the Control Request handler function
217
 *  <tt><i>{Class Name}</i>_Device_ProcessControlRequest()</tt>, which should be called when the
218
 *  \ref EVENT_USB_Device_ControlRequest() event fires. This function should also be called for
219
 *  each class driver instance, using the address of the instance to operate on as the function's
220
 *  parameter. The request handler will abort if it is determined that the current request is not
221
 *  targeted at the given class driver instance, thus these methods can safely be called
222
 *  one-after-another in the event handler with no form of error checking:
223
 *
224
 *  \code
225
 *  void EVENT_USB_Device_ControlRequest(void)
226
 *  {
227
 *      Audio_Device_ProcessControlRequest(&My_Audio_Interface);
228
 *  }
229
 *  \endcode
230
 *
231
 *  Each class driver may also define a set of callback functions (which are prefixed by \c CALLBACK_*
232
 *  in the function's name) which <b>must</b> also be added to the user application - refer to each
233
 *  individual class driver's documentation for mandatory callbacks. In addition, each class driver may
234
 *  also define a set of events (identifiable by their prefix of \c EVENT_* in the function's name), which
235
 *  the user application <b>may</b> choose to implement, or ignore if not needed.
236
 *
237
 *  The individual Device Mode Class Driver documentation contains more information on the non-standardized,
238
 *  class-specific functions which the user application can then use on the driver instances, such as data
239
 *  read and write routines. See each driver's individual documentation for more information on the
240
 *  class-specific functions.
241
 *
242
 *  \subsection Sec_ClassDriverHost Host Mode Class Drivers
243
 *  Implementing a Host Mode Class Driver in a user application requires a number of steps to be followed. Firstly,
244
 *  the module configuration and state structure must be added to the project source. These structures are named in a
245
 *  similar manner between classes, that of <tt>USB_ClassInfo_<b>{Class Name}</b>_Host_t</tt>, and are used to hold the
246
 *  complete state and configuration for each class instance. Multiple class instances is where the power of the class
247
 *  drivers lie; multiple interfaces of the same class simply require more instances of the Class Driver's \c USB_ClassInfo_*
248
 *  structure.
249
 *
250
 *  Inside the \c USB_ClassInfo_* structure lies two sections, a \c Config section, and a \c State section. The \c Config
251
 *  section contains the instance's configuration parameters, and <b>must have all fields set by the user application</b>
252
 *  before the class driver is used. Each Device mode Class driver typically contains a set of configuration parameters
253
 *  for the endpoint size/number of the associated logical USB interface, plus any class-specific configuration parameters.
254
 *
255
 *  The \c State section of the \c USB_ClassInfo_* structures are designed to be controlled by the Class Drivers only for
256
 *  maintaining the Class Driver instance's state, and should not normally be set by the user application.
257
 *
258
 *  The following is an example of a properly initialized instance of the MIDI Class Driver structure:
259
 *
260
 *  \code
261
 *  USB_ClassInfo_MIDI_Host_t My_MIDI_Interface =
262
 *  {
263
 *      .Config =
264
 *          {
265
 *              .DataINPipeNumber       = 1,
266
 *              .DataINPipeDoubleBank   = false,
267
 *
268
 *              .DataOUTPipeNumber      = 2,
269
 *              .DataOUTPipeDoubleBank  = false,
270
 *          },
271
 *  };
272
 *  \endcode
273
 *
274
 *  To initialize the Class driver instance, the driver's <tt><b>{Class Name}</b>_Host_ConfigurePipes()</tt> function
275
 *  should be called in response to the host state machine entering the \ref HOST_STATE_Addressed state. This function
276
 *  will return an error code from the class driver's <tt><b>{Class Name}</b>_EnumerationFailure_ErrorCodes_t</tt> enum
277
 *  to indicate if the driver successfully initialized the instance and bound it to an interface in the attached device.
278
 *  Like all the class driver functions, this function takes in the address of the specific instance you wish to initialize -
279
 *  in this manner, multiple separate instances of the same class type can be initialized. A fragment of a Class Driver
280
 *  based Host mode application may look like the following:
281
 *
282
 *  \code
283
 *      switch (USB_HostState)
284
 *      {
285
 *          case HOST_STATE_Addressed:
286
 *              LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
287
 *
288
 *              uint16_t ConfigDescriptorSize;
289
 *              uint8_t  ConfigDescriptorData[512];
290
 *
291
 *              if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
292
 *                                                     sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
293
 *              {
294
 *                  LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
295
 *                  USB_HostState = HOST_STATE_WaitForDeviceRemoval;
296
 *                  break;
297
 *              }
298
 *
299
 *              if (MIDI_Host_ConfigurePipes(&My_MIDI_Interface,
300
 *                                           ConfigDescriptorSize, ConfigDescriptorData) != MIDI_ENUMERROR_NoError)
301
 *              {
302
 *                  LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
303
 *                  USB_HostState = HOST_STATE_WaitForDeviceRemoval;
304
 *                  break;
305
 *              }
306
 *
307
 *              // Other state handler code here
308
 *  \endcode
309
 *
310
 *  Note that the function also required the device's configuration descriptor so that it can determine which interface
311
 *  in the device to bind to - this can be retrieved as shown in the above fragment using the
312
 *  \ref USB_Host_GetDeviceConfigDescriptor() function. If the device does not implement the interface the class driver
313
 *  is looking for, if all the matching interfaces are already bound to class driver instances or if an error occurs while
314
 *  binding to a device interface (for example, a device endpoint bank larger that the maximum supported bank size is used)
315
 *  the configuration will fail.
316
 *
317
 *  Once initialized, it is important to maintain the class driver's state by repeatedly calling the Class Driver's
318
 *  <tt><b>{Class Name}</b>_Host_USBTask()</tt> function in the main program loop. The exact implementation of this
319
 *  function varies between class drivers, and can be used for any internal class driver purpose to maintain each
320
 *  instance. Again, this function uses the address of the instance to operate on, and thus needs to be called for each
321
 *  separate instance, just like the main USB maintenance routine \ref USB_USBTask():
322
 *
323
 *  \code
324
 *  int main(void)
325
 *  {
326
 *      SetupHardware();
327
 *
328
 *      LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
329
 *
330
 *      for (;;)
331
 *      {
332
 *          switch (USB_HostState)
333
 *          {
334
 *             // Host state machine handling here
335
 *          }
336
 *
337
 *          MIDI_Host_USBTask(&My_Audio_Interface);
338
 *          USB_USBTask();
339
 *      }
340
 *  }
341
 *  \endcode
342
 *
343
 *  Each class driver may also define a set of callback functions (which are prefixed by \c CALLBACK_*
344
 *  in the function's name) which <b>must</b> also be added to the user application - refer to each
345
 *  individual class driver's documentation for mandatory callbacks. In addition, each class driver may
346
 *  also define a set of events (identifiable by their prefix of \c EVENT_* in the function's name), which
347
 *  the user application <b>may</b> choose to implement, or ignore if not needed.
348
 *
349
 *  The individual Host Mode Class Driver documentation contains more information on the non-standardized,
350
 *  class-specific functions which the user application can then use on the driver instances, such as data
351
 *  read and write routines. See each driver's individual documentation for more information on the
352
 *  class-specific functions.
353
 */
354

    
355
#ifndef __USB_H__
356
#define __USB_H__
357

    
358
        /* Macros: */
359
                #define __INCLUDE_FROM_USB_DRIVER
360

    
361
        /* Includes: */
362
                #include "../../Common/Common.h"
363
                #include "Core/USBMode.h"
364

    
365
        /* Includes: */
366
                #include "Core/USBTask.h"
367
                #include "Core/Events.h"
368
                #include "Core/StdDescriptors.h"
369
                #include "Core/ConfigDescriptor.h"
370
                #include "Core/USBController.h"
371
                #include "Core/USBInterrupt.h"
372

    
373
                #if defined(USB_CAN_BE_HOST) || defined(__DOXYGEN__)
374
                        #include "Core/Host.h"
375
                        #include "Core/Pipe.h"
376
                        #include "Core/HostStandardReq.h"
377
                        #include "Core/PipeStream.h"
378
                #endif
379

    
380
                #if defined(USB_CAN_BE_DEVICE) || defined(__DOXYGEN__)
381
                        #include "Core/Device.h"
382
                        #include "Core/Endpoint.h"
383
                        #include "Core/DeviceStandardReq.h"
384
                        #include "Core/EndpointStream.h"
385
                #endif
386

    
387
                #if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__)
388
                        #include "Core/OTG.h"
389
                #endif
390
                
391
                #include "Class/Audio.h"
392
                #include "Class/CDC.h"
393
                #include "Class/HID.h"
394
                #include "Class/MassStorage.h"
395
                #include "Class/MIDI.h"
396
                #include "Class/Printer.h"
397
                #include "Class/RNDIS.h"
398
                #include "Class/StillImage.h"
399

    
400
#endif
401