LUFA/Drivers/USB/LowLevel/DevChapter9.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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  *
  33  *  Module for device mode request processing. This module allows for the processing of standard control
  34  *  requests to the default control endpoint while in device mode.
  35  *
  36  *  \see Chapter 9 of the USB 2.0 specification.
  37  */
  38
  39 #ifndef __DEVCHAPTER9_H__
  40 #define __DEVCHAPTER9_H__
  41
  42         /* Includes: */
  43                 #include <avr/io.h>
  44                 #include <avr/pgmspace.h>
  45                 #include <avr/eeprom.h>
  46
  47                 #include "../HighLevel/StdDescriptors.h"
  48                 #include "../HighLevel/Events.h"
  49                 #include "../HighLevel/StdRequestType.h"
  50                 #include "LowLevel.h"
  51
  52         /* Enable C linkage for C++ Compilers: */
  53                 #if defined(__cplusplus)
  54                         extern "C" {
  55                 #endif
  56
  57         /* Public Interface - May be used in end-application: */
  58                 /* Global Variables: */
  59                         /** Indicates the currently set configuration number of the device. USB devices may have several
  60                          *  different configurations which the host can select between; this indicates the currently selected
  61                          *  value, or 0 if no configuration has been selected.
  62                          *
  63                          *  If a device has only one single configuration, the token USE_SINGLE_DEVICE_CONFIGURATION may be
  64                          *  defined in the project makefile and passed to the compiler using the -D switch. This optimize for
  65                          *  a single configuration, saving a small amount of space in the resulting compiled binary.
  66                          *
  67                          *  \note This variable should be treated as read-only in the user application, and never manually
  68                          *        changed in value.
  69                          */
  70                         extern uint8_t USB_ConfigurationNumber;
  71
  72                         /** Indicates if the host is currently allowing the device to issue remote wakeup events. If this
  73                          *  flag is cleared, the device should not issue remote wakeup events to the host.
  74                          *
  75                          *  \note This variable should be treated as read-only in the user application, and never manually
  76                          *        changed in value.
  77                          */
  78                         extern bool USB_RemoteWakeupEnabled;
  79
  80                         /** Indicates if the device is currently being powered by its own power supply, rather than being
  81                          *  powered by the host's USB supply. This flag should remain cleared if the device does not
  82                          *  support self powered mode, as indicated in the device descriptors.
  83                          */
  84                         extern bool USB_CurrentlySelfPowered;
  85
  86                 /* Throwable Events: */
  87                         /** This module raises the USB_UnhandledControlPacket event when a request to the default control
  88                          *  endpoint has been received, but the library does not implement an internal handler for it.
  89                          *
  90                          *  \see Events.h for more information on this event.
  91                          */
  92                         RAISES_EVENT(USB_UnhandledControlPacket);
  93
  94                         /** This module raises the USB_ConfigurationChanged event when the host issues a REQ_SetConfiguration
  95                          *  device request, to change the currently selected configuration number.
  96                          *
  97                          *  \see Events.h for more information on this event.
  98                          */
  99                         RAISES_EVENT(USB_ConfigurationChanged);
 100
 101                         /** This module raises the USB_DeviceEnumerationComplete event when the host has completed its
 102                          *  enumeration of the device (i.e. when a REQ_SetConfiguration request changes the current configuration
 103                          *  number from 0 to a non-zero value).
 104                          *
 105                          *  \see Events.h for more information on this event.
 106                          */
 107                         RAISES_EVENT(USB_DeviceEnumerationComplete);
 108
 109         /* Private Interface - For use in library only: */
 110         #if !defined(__DOXYGEN__)
 111                 #if defined(USE_RAM_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS)
 112                         #error USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive.
 113                 #endif
 114
 115                 /* Function Prototypes: */
 116                         void USB_Device_ProcessControlPacket(void);
 117
 118                         #if defined(INCLUDE_FROM_DEVCHAPTER9_C)
 119                                 static void USB_Device_SetAddress(void);
 120                                 static void USB_Device_SetConfiguration(void);
 121                                 static void USB_Device_GetConfiguration(void);
 122                                 static void USB_Device_GetDescriptor(void);
 123                                 static void USB_Device_GetStatus(const uint8_t bmRequestType);
 124                                 #if !defined(FEATURELESS_CONTROL_ONLY_DEVICE)
 125                                 static void USB_Device_ClearSetFeature(const uint8_t bRequest, const uint8_t bmRequestType);
 126                                 #endif
 127                         #endif
 128         #endif
 129
 130         /* Disable C linkage for C++ Compilers: */
 131                 #if defined(__cplusplus)
 132                         }
 133                 #endif
 134
 135 #endif