protocol/lufa/LUFA-git/LUFA/Drivers/USB/USB.h

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