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                 #include <avr/boot.h>
  39
  40                 #include "../HighLevel/StdDescriptors.h"
  41                 #include "../HighLevel/Events.h"
  42                 #include "../HighLevel/StdRequestType.h"
  43                 #include "../HighLevel/USBTask.h"
  44                 #include "LowLevel.h"
  45
  46         /* Enable C linkage for C++ Compilers: */
  47                 #if defined(__cplusplus)
  48                         extern "C" {
  49                 #endif
  50
  51         /* Public Interface - May be used in end-application: */
  52                 /* Macros: */
  53                         #if defined(USE_SINGLE_DEVICE_CONFIGURATION)
  54                                 #define FIXED_NUM_CONFIGURATIONS           1
  55                         #endif
  56
  57                 /* Enums: */
  58                         #if !defined(USE_FLASH_DESCRIPTORS) && !defined(USE_EEPROM_DESCRIPTORS) && !defined(USE_RAM_DESCRIPTORS)
  59                                 /** Enum for the possible descriptor memory spaces, for the MemoryAddressSpace of the
  60                                  *  \ref CALLBACK_USB_GetDescriptor() function. This can be used when none of the USE_*_DESCRIPTORS
  61                                  *  compile time options are used, to indicate in which memory space the descriptor is stored.
  62                                  *
  63                                  *  \ingroup Group_Device
  64                                  */
  65                                 enum USB_DescriptorMemorySpaces_t
  66                                 {
  67                                         MEMSPACE_FLASH    = 0, /**< Indicates the requested descriptor is located in FLASH memory */
  68                                         MEMSPACE_EEPROM   = 1, /**< Indicates the requested descriptor is located in EEPROM memory */
  69                                         MEMSPACE_RAM      = 2, /**< Indicates the requested descriptor is located in RAM memory */
  70                                 };
  71                         #endif
  72
  73                 /* Global Variables: */
  74                         /** Indicates the currently set configuration number of the device. USB devices may have several
  75                          *  different configurations which the host can select between; this indicates the currently selected
  76                          *  value, or 0 if no configuration has been selected.
  77                          *
  78                          *  \note This variable should be treated as read-only in the user application, and never manually
  79                          *        changed in value.
  80                          *
  81                          *  \ingroup Group_Device
  82                          */
  83                         extern uint8_t USB_ConfigurationNumber;
  84
  85                         /** Indicates if the host is currently allowing the device to issue remote wakeup events. If this
  86                          *  flag is cleared, the device should not issue remote wakeup events to the host.
  87                          *
  88                          *  \note This variable should be treated as read-only in the user application, and never manually
  89                          *        changed in value.
  90                          *
  91                          *  \ingroup Group_Device
  92                          */
  93                         extern bool USB_RemoteWakeupEnabled;
  94
  95                         /** Indicates if the device is currently being powered by its own power supply, rather than being
  96                          *  powered by the host's USB supply. This flag should remain cleared if the device does not
  97                          *  support self powered mode, as indicated in the device descriptors.
  98                          *
  99                          *  \ingroup Group_Device
 100                          */
 101                         extern bool USB_CurrentlySelfPowered;
 102
 103         /* Private Interface - For use in library only: */
 104         #if !defined(__DOXYGEN__)
 105                 #if defined(USE_RAM_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS)
 106                         #error USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive.
 107                 #elif defined(USE_RAM_DESCRIPTORS) && defined(USE_FLASH_DESCRIPTORS)
 108                         #error USE_RAM_DESCRIPTORS and USE_FLASH_DESCRIPTORS are mutually exclusive.
 109                 #elif defined(USE_FLASH_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS)
 110                         #error USE_FLASH_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive.
 111                 #elif defined(USE_FLASH_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS) && defined(USE_RAM_DESCRIPTORS)
 112                         #error Only one of the USE_*_DESCRIPTORS modes should be selected.
 113                 #endif
 114
 115                 /* Function Prototypes: */
 116                         void USB_Device_ProcessControlRequest(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(void);
 124                                 static void USB_Device_ClearSetFeature(void);
 125
 126                                 #if !defined(NO_INTERNAL_SERIAL) && (defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR))
 127                                         static char USB_Device_NibbleToASCII(uint8_t Nibble) ATTR_ALWAYS_INLINE;
 128                                         static void USB_Device_GetInternalSerialDescriptor(void);
 129                                 #endif
 130                         #endif
 131         #endif
 132
 133         /* Disable C linkage for C++ Compilers: */
 134                 #if defined(__cplusplus)
 135                         }
 136                 #endif
 137
 138 #endif