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