LUFA/Drivers/USB/USB.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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  *  including any headers in the USB/LowLevel/ or USB/HighLevel/ subdirectories.
  38  */
  39
  40 /** @defgroup Group_USB USB - 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/LowLevel/DevChapter9.c
  45  *    - LUFA/Drivers/USB/LowLevel/Endpoint.c
  46  *    - LUFA/Drivers/USB/LowLevel/Host.c
  47  *    - LUFA/Drivers/USB/LowLevel/HostChapter9.c
  48  *    - LUFA/Drivers/USB/LowLevel/LowLevel.c
  49  *    - LUFA/Drivers/USB/LowLevel/Pipe.c
  50  *    - LUFA/Drivers/USB/LowLevel/USBInterrupt.c
  51  *    - LUFA/Drivers/USB/HighLevel/ConfigDescriptor.c
  52  *    - LUFA/Drivers/USB/HighLevel/Events.c
  53  *    - LUFA/Drivers/USB/HighLevel/USBTask.c
  54  *
  55  *  \section Module Description
  56  *  Driver and framework for the USB controller hardware on the USB series of AVR microcontrollers. This module
  57  *  consists of many submodules, and is designed to provide an easy way to configure and control USB host, device
  58  *  or OTG mode USB applications.
  59  *
  60  *  The USB stack requires the sole control over the USB controller in the microcontroller only; i.e. it does not
  61  *  require any additional AVR timers, etc. to operate. This ensures that the USB stack requires as few resources
  62  *  as possible.
  63  *
  64  *  The USB stack can be used in Device Mode for connections to USB Hosts (see \ref Group_Device), in Host mode for
  65  *  hosting of other USB devices (see \ref Group_Host), or as a dual role device which can either act as a USB host
  66  *  or device depending on what peripheral is connected (see \ref Group_OTG). Both modes also require a common set
  67  *  of USB management functions found \ref Group_USBManagement.
  68  */
  69
  70 /** \ingroup Group_USB
  71  *  @defgroup Group_USBClassDrivers USB Class Drivers
  72  *
  73  *  Drivers for both host and device mode of the standard USB classes, for rapid application development.
  74  *  Class drivers give a framework which sits on top of the low level library API, allowing for standard
  75  *  USB classes to be implemented in a project with minimal user code. These drivers can be used in
  76  *  conjunction with the library low level APIs to implement interfaces both via the class drivers and via
  77  *  the standard library APIs.
  78  *
  79  *  Multiple device mode class drivers can be used within a project, including multiple instances of the
  80  *  same class driver. In this way, USB Hosts and Devices can be made quickly using the internal class drivers
  81  *  so that more time and effort can be put into the end application instead of the USB protocol.
  82  *
  83  *  The available class drivers and their modes are listed below.
  84  *
  85  *  <table>
  86  *  <tr>
  87  *   <th width="100px">USB Class</th>
  88  *   <th width="90px">Device Mode</th>
  89  *   <th width="90px">Host Mode</th>
  90  *  </tr>
  91  *  <tr>
  92  *   <td>Audio</td>
  93  *   <td bgcolor="#00EE00">Yes</td>
  94  *   <td bgcolor="#EE0000">No</td>
  95  *  </tr>
  96  *  <tr>
  97  *   <td>CDC</td>
  98  *   <td bgcolor="#00EE00">Yes</td>
  99  *   <td bgcolor="#00EE00">Yes</td>
 100  *  </tr>
 101  *  <tr>
 102  *   <td>HID</td>
 103  *   <td bgcolor="#00EE00">Yes</td>
 104  *   <td bgcolor="#00EE00">Yes</td>
 105  *  </tr>
 106  *  <tr>
 107  *   <td>MIDI</td>
 108  *   <td bgcolor="#00EE00">Yes</td>
 109  *   <td bgcolor="#00EE00">Yes</td>
 110  *  </tr>
 111  *  <tr>
 112  *   <td>Mass Storage</td>
 113  *   <td bgcolor="#00EE00">Yes</td>
 114  *   <td bgcolor="#00EE00">Yes</td>
 115  *  </tr>
 116  *  <tr>
 117  *   <td>Printer</td>
 118  *   <td bgcolor="#EE0000">No</td>
 119 *    <td bgcolor="#00EE00">Yes</td>
 120  *  </tr>
 121  *  <tr>
 122  *   <td>RNDIS</td>
 123  *   <td bgcolor="#00EE00">Yes</td>
 124  *   <td bgcolor="#00EE00">Yes</td>
 125  *  </tr>
 126  *  <tr>
 127  *   <td>Still Image</td>
 128  *   <td bgcolor="#EE0000">No</td>
 129  *   <td bgcolor="#00EE00">Yes</td>
 130  *  </tr>
 131  *  </table>
 132  *
 133  *
 134  *  \section Sec_UsingClassDrivers Using the Class Drivers
 135  *  To make the Class drivers easy to integrate into a user application, they all implement a standardized
 136  *  design with similarly named/used function, enums, defines and types. The two different modes are implemented
 137  *  slightly differently, and thus will be explained separately. For information on a specific class driver, read
 138  *  the class driver's module documentation.
 139  *
 140  *  \subsection SSec_ClassDriverDevice Device Mode Class Drivers
 141  *  Implementing a Device Mode Class Driver in a user application requires a number of steps to be followed. Firstly,
 142  *  the module configuration and state structure must be added to the project source. These structures are named in a
 143  *  similar manner between classes, that of <i>USB_ClassInfo_<b>{Class Name}</b>_Device_t</i>, and are used to hold the
 144  *  complete state and configuration for each class instance. Multiple class instances is where the power of the class
 145  *  drivers lie; multiple interfaces of the same class simply require more instances of the Class Driver's ClassInfo
 146  *  structure.
 147  *
 148  *  Inside the ClassInfo structure lies two sections, a <i>Config</i> section, and a <i>State</i> section. The Config
 149  *  section contains the instance's configuration parameters, and <b>must have all fields set by the user application</b>
 150  *  before the class driver is used. Each Device mode Class driver typically contains a set of configuration parameters
 151  *  for the endpoint size/number of the associated logical USB interface, plus any class-specific configuration parameters.
 152  *
 153  *  The <i>State</i> section of the ClassInfo structures are designed to be controlled by the Class Drivers only for
 154  *  maintaining the Class Driver instance's state, and should not normally be set by the user application.
 155  *
 156  *  The following is an example of a properly initialized instance of the Audio Class Driver structure:
 157  *
 158  *  \code
 159  *  USB_ClassInfo_Audio_Device_t My_Audio_Interface =
 160  *  {
 161  *      .Config =
 162  *          {
 163  *              .StreamingInterfaceNumber = 1,
 164  *
 165  *              .DataINEndpointNumber     = 1,
 166  *              .DataINEndpointSize       = 256,
 167  *          },
 168  *  };
 169  *  \endcode
 170  *
 171  *  \note The class driver's configuration parameters should match those used in the device's descriptors that are
 172  *  sent to the host.
 173  *
 174  *  To initialize the Class driver instance, the driver's <i><b>{Class Name}</b>_Device_ConfigureEndpoints()</i> function
 175  *  should be called in response to the \ref EVENT_USB_Device_ConfigurationChanged() event. This function will return a
 176  *  boolean value if the driver sucessfully initialized the instance. Like all the class driver functions, this function
 177  *  takes in the address of the specific instance you wish to initialize - in this manner, multiple seperate instances of
 178  *  the same class type can be initialized like thus:
 179  *
 180  *  \code
 181  *  void EVENT_USB_Device_ConfigurationChanged(void)
 182  *  {
 183  *      LEDs_SetAllLEDs(LEDMASK_USB_READY);
 184  *
 185  *      if (!(Audio_Device_ConfigureEndpoints(&My_Audio_Interface)))
 186  *        LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 187  *  }
 188  *  \endcode
 189  *
 190  *  Once initialized, it is important to maintain the class driver's state by repeatedly calling the Class Driver's
 191  *  <i><b>{Class Name}</b>_Device_USBTask()</i> function in the main program loop. The exact implementation of this
 192  *  function varies between class drivers, and can be used for any internal class driver purpose to maintain each
 193  *  instance. Again, this function uses the address of the instance to operate on, and thus needs to be called for each
 194  *  seperate instance, just like the main USB maintenance routine \ref USB_USBTask():
 195  *
 196  *  \code
 197  *  int main(void)
 198  *  {
 199  *      SetupHardware();
 200  *
 201  *      LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 202  *
 203  *      for (;;)
 204  *      {
 205  *          Create_And_Process_Samples();
 206  *
 207  *          Audio_Device_USBTask(&My_Audio_Interface);
 208  *          USB_USBTask();
 209  *      }
 210  *  }
 211  *  \endcode
 212  *
 213  *  The final standardized Device Class Driver function is the Control Request handler function
 214  *  <i><b>{Class Name}</b>_Device_ProcessControlRequest()</i>, which should be called when the
 215  *  \ref EVENT_USB_Device_UnhandledControlRequest() event fires. This function should also be
 216  *  called for each class driver instance, using the address of the instance to operate on as
 217  *  the function's parameter. The request handler will abort if it is determined that the current
 218  *  request is not targeted at the given class driver instance, thus these methods can safely be
 219  *  called one-after-another in the event handler with no form of error checking:
 220  *
 221  *  \code
 222  *  void EVENT_USB_Device_UnhandledControlRequest(void)
 223  *  {
 224  *      Audio_Device_ProcessControlRequest(&My_Audio_Interface);
 225  *  }
 226  *  \endcode
 227  *
 228  *  Each class driver may also define a set of callback functions (which are prefixed by "CALLBACK_"
 229  *  in the function's name) which <b>must</b> also be added to the user application - refer to each
 230  *  individual class driver's documentation for mandatory callbacks. In addition, each class driver may
 231  *  also define a set of events (identifiable by their prefix of "EVENT_" in the function's name), which
 232  *  the user application <b>may</b> choose to implement, or ignore if not needed.
 233  *
 234  *  The individual Device Mode Class Driver documentation contains more information on the non-standardized,
 235  *  class-specific functions which the user application can then use on the driver instances, such as data
 236  *  read and write routines. See each driver's individual documentation for more information on the
 237  *  class-specific functions.
 238  *
 239  *  \subsection SSec_ClassDriverHost Host Mode Class Drivers
 240  *  Implementing a Host Mode Class Driver in a user application requires a number of steps to be followed. Firstly,
 241  *  the module configuration and state structure must be added to the project source. These structures are named in a
 242  *  similar manner between classes, that of <i>USB_ClassInfo_<b>{Class Name}</b>_Host_t</i>, and are used to hold the
 243  *  complete state and configuration for each class instance. Multiple class instances is where the power of the class
 244  *  drivers lie; multiple interfaces of the same class simply require more instances of the Class Driver's ClassInfo
 245  *  structure.
 246  *
 247  *  Inside the ClassInfo structure lies two sections, a <i>Config</i> section, and a <i>State</i> section. The Config
 248  *  section contains the instance's configuration parameters, and <b>must have all fields set by the user application</b>
 249  *  before the class driver is used. Each Device mode Class driver typically contains a set of configuration parameters
 250  *  for the endpoint size/number of the associated logical USB interface, plus any class-specific configuration parameters.
 251  *
 252  *  The <i>State</i> section of the ClassInfo structures are designed to be controlled by the Class Drivers only for
 253  *  maintaining the Class Driver instance's state, and should not normally be set by the user application.
 254  *
 255  *  The following is an example of a properly initialized instance of the MIDI Class Driver structure:
 256  *
 257  *  \code
 258  *  USB_ClassInfo_MIDI_Host_t My_MIDI_Interface =
 259  *  {
 260  *      .Config =
 261  *          {
 262  *              .DataINPipeNumber       = 1,
 263  *              .DataINPipeDoubleBank   = false,
 264  *
 265  *              .DataOUTPipeNumber      = 2,
 266  *              .DataOUTPipeDoubleBank  = false,
 267  *          },
 268  *  };
 269  *  \endcode
 270  *
 271  *  To initialize the Class driver instance, the driver's <i><b>{Class Name}</b>_Host_ConfigurePipes()</i> function
 272  *  should be called in response to the host state machine entering the \ref HOST_STATE_Addressed state. This function
 273  *  will return an error code from the class driver's <i><b>{Class Name}</b>_EnumerationFailure_ErrorCodes_t</i> enum
 274  *  to indicate if the driver sucessfully initialized the instance and bound it to an interface in the attached device.
 275  *  Like all the class driver functions, this function takes in the address of the specific instance you wish to initialize
 276  *  - in this manner, multiple seperate instances of the same class type can be initialized. A fragment of a Class Driver
 277  *  based Host mode application may look like the following:
 278  *
 279  *  \code
 280  *      switch (USB_HostState)
 281  *      {
 282  *          case HOST_STATE_Addressed:
 283  *              LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 284  *
 285  *              uint16_t ConfigDescriptorSize;
 286  *              uint8_t  ConfigDescriptorData[512];
 287  *
 288  *              if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
 289  *                                                     sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
 290  *              {
 291  *                  LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 292  *                  USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 293  *                  break;
 294  *              }
 295  *
 296  *              if (MIDI_Host_ConfigurePipes(&My_MIDI_Interface,
 297  *                                           ConfigDescriptorSize, ConfigDescriptorData) != MIDI_ENUMERROR_NoError)
 298  *              {
 299  *                  LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 300  *                  USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 301  *                  break;
 302  *              }
 303  *
 304  *              // Other state handler code here
 305  *  \endcode
 306  *
 307  *  Note that the function also required the device's configuration descriptor so that it can determine which interface
 308  *  in the device to bind to - this can be retrieved as shown in the above fragment using the
 309  *  \ref USB_Host_GetDeviceConfigDescriptor() function. If the device does not implement the interface the class driver
 310  *  is looking for, if all the matching interfaces are already bound to class driver instances or if an error occurs while
 311  *  binding to a device interface (for example, a device endpoint bank larger that the maximum supported bank size is used)
 312  *  the configuration will fail.
 313  *
 314  *  Once initialized, it is important to maintain the class driver's state by repeatedly calling the Class Driver's
 315  *  <i><b>{Class Name}</b>_Host_USBTask()</i> function in the main program loop. The exact implementation of this
 316  *  function varies between class drivers, and can be used for any internal class driver purpose to maintain each
 317  *  instance. Again, this function uses the address of the instance to operate on, and thus needs to be called for each
 318  *  seperate instance, just like the main USB maintenance routine \ref USB_USBTask():
 319  *
 320  *  \code
 321  *  int main(void)
 322  *  {
 323  *      SetupHardware();
 324  *
 325  *      LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 326  *
 327  *      for (;;)
 328  *      {
 329  *          switch (USB_HostState)
 330  *          {
 331  *             // Host state machine handling here
 332  *          }
 333  *
 334  *          MIDI_Host_USBTask(&My_Audio_Interface);
 335  *          USB_USBTask();
 336  *      }
 337  *  }
 338  *  \endcode
 339  *
 340  *  Each class driver may also define a set of callback functions (which are prefixed by "CALLBACK_"
 341  *  in the function's name) which <b>must</b> also be added to the user application - refer to each
 342  *  individual class driver's documentation for mandatory callbacks. In addition, each class driver may
 343  *  also define a set of events (identifiable by their prefix of "EVENT_" in the function's name), which
 344  *  the user application <b>may</b> choose to implement, or ignore if not needed.
 345  *
 346  *  The individual Host Mode Class Driver documentation contains more information on the non-standardized,
 347  *  class-specific functions which the user application can then use on the driver instances, such as data
 348  *  read and write routines. See each driver's individual documentation for more information on the
 349  *  class-specific functions.
 350  */
 351
 352 #ifndef __USB_H__
 353 #define __USB_H__
 354
 355         /* Macros: */
 356                 #if !defined(__DOXYGEN__)
 357                         #define __INCLUDE_FROM_USB_DRIVER
 358                 #endif
 359
 360         /* Includes: */
 361                 #include "HighLevel/USBMode.h"
 362
 363         /* Preprocessor Checks: */
 364                 #if (!defined(USB_SERIES_2_AVR) && !defined(USB_SERIES_4_AVR) && \
 365                      !defined(USB_SERIES_6_AVR) && !defined(USB_SERIES_7_AVR))
 366                         #error The currently selected AVR model is not supported under the USB component of the LUFA library.
 367                 #endif
 368
 369         /* Includes: */
 370                 #include "HighLevel/USBTask.h"
 371                 #include "HighLevel/Events.h"
 372                 #include "HighLevel/StdDescriptors.h"
 373                 #include "HighLevel/ConfigDescriptor.h"
 374
 375                 #include "LowLevel/LowLevel.h"
 376                 #include "LowLevel/USBInterrupt.h"
 377
 378                 #if defined(USB_CAN_BE_HOST) || defined(__DOXYGEN__)
 379                         #include "LowLevel/Host.h"
 380                         #include "LowLevel/HostChapter9.h"
 381                         #include "LowLevel/Pipe.h"
 382                 #endif
 383
 384                 #if defined(USB_CAN_BE_DEVICE) || defined(__DOXYGEN__)
 385                         #include "LowLevel/Device.h"
 386                         #include "LowLevel/DevChapter9.h"
 387                         #include "LowLevel/Endpoint.h"
 388                 #endif
 389
 390                 #if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__)
 391                         #include "LowLevel/OTG.h"
 392                 #endif
 393
 394 #endif
 395