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