LUFA/Drivers/USB/LowLevel/Device.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 /** \ingroup Group_USB
  32  *  @defgroup Group_Device Device Management
  33  *
  34  *  USB Device mode related macros and enums. This module contains macros and enums which are used when
  35  *  the USB controller is initialized in device mode.
  36  *
  37  *  @{
  38  */
  39
  40 #ifndef __USBDEVICE_H__
  41 #define __USBDEVICE_H__
  42
  43         /* Includes: */
  44                 #include <avr/pgmspace.h>
  45                 #include <avr/eeprom.h>
  46
  47                 #include "../../../Common/Common.h"
  48                 #include "../HighLevel/StdDescriptors.h"
  49                 #include "Endpoint.h"
  50
  51         /* Preprocessor Checks: */
  52                 #if (defined(USE_RAM_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS))
  53                         #error USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive.
  54                 #endif
  55
  56                 #if !defined(__INCLUDE_FROM_USB_DRIVER)
  57                         #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
  58                 #endif
  59
  60         /* Public Interface - May be used in end-application: */
  61                 /* Macros: */
  62                         #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)
  63                                 /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the
  64                                  *  USB interface should be initialized in low speed (1.5Mb/s) mode.
  65                                  *
  66                                  *  \note Low Speed mode is not available on all USB AVR models.
  67                                  *
  68                                  *  \note Restrictions apply on the number, size and type of endpoints which can be used
  69                                  *        when running in low speed mode -- refer to the USB 2.0 standard.
  70                                  */
  71                                 #define USB_DEVICE_OPT_LOWSPEED            (1 << 0)
  72                         #endif
  73
  74                         /** Mask for the Options parameter of the USB_Init() function. This indicates that the
  75                          *  USB interface should be initialized in full speed (12Mb/s) mode.
  76                          */
  77                         #define USB_DEVICE_OPT_FULLSPEED               (0 << 0)
  78
  79                 /* Pseudo-Function Macros: */
  80                         #if defined(__DOXYGEN__)
  81                                 /** Sends a Remote Wakeup request to the host. This signals to the host that the device should
  82                                  *  be taken out of suspended mode, and communications should resume.
  83                                  *
  84                                  *  Typically, this is implemented so that HID devices (mice, keyboards, etc.) can wake up the
  85                                  *  host computer when the host has suspended all USB devices to enter a low power state.
  86                                  *
  87                                  *  \note This macro should only be used if the device has indicated to the host that it
  88                                  *        supports the Remote Wakeup feature in the device descriptors, and should only be
  89                                  *        issued if the host is currently allowing remote wakeup events from the device (i.e.,
  90                                  *        the \ref USB_RemoteWakeupEnabled flag is set). When the NO_DEVICE_REMOTE_WAKEUP compile
  91                                  *        time option is used, this macro is unavailable.
  92                                  *
  93                                  *  \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors.
  94                                  */
  95                                 static inline void USB_Device_SendRemoteWakeup(void);
  96
  97                                 /** Indicates if a Remote Wakeup request is being sent to the host. This returns true if a
  98                                  *  remote wakeup is currently being sent, false otherwise.
  99                                  *
 100                                  *  This can be used in conjunction with the \ref USB_Device_IsUSBSuspended() macro to determine if
 101                                  *  a sent RMWAKEUP request was accepted or rejected by the host.
 102                                  *
 103                                  *  \note This macro should only be used if the device has indicated to the host that it
 104                                  *        supports the Remote Wakeup feature in the device descriptors. When the NO_DEVICE_REMOTE_WAKEUP
 105                                  *        compile time option is used, this macro is unavailable.
 106                                  *
 107                                  *  \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors.
 108                                  *
 109                                  *  \return Boolean true if no Remote Wakeup request is currently being sent, false otherwise
 110                                  */
 111                                 static inline bool USB_Device_IsRemoteWakeupSent(void);
 112
 113                                 /** Indicates if the device is currently suspended by the host. Whilst suspended, the device is
 114                                  *  to enter a low power state until resumed by the host. No USB traffic to or from the device
 115                                  *  can occur (except for Remote Wakeup requests) during suspension by the host.
 116                                  *
 117                                  *  \return Boolean true if the USB communications have been suspended by the host, false otherwise.
 118                                  */
 119                                 static inline bool USB_Device_IsUSBSuspended(void);
 120
 121                                 /** Enables the device mode Start Of Frame events. When enabled, this causes the
 122                                  *  \ref EVENT_USB_Device_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus,
 123                                  *  at the start of each USB frame when enumerated in device mode.
 124                                  */
 125                                 static inline bool USB_Device_EnableSOFEvents(void);
 126
 127                                 /** Disables the device mode Start Of Frame events. When disabled, this stop the firing of the
 128                                  *  \ref EVENT_USB_Device_StartOfFrame() event when enumerated in device mode.
 129                                  */
 130                                 static inline bool USB_Device_DisableSOFEvents(void);
 131                         #else
 132                                 #if !defined(NO_DEVICE_REMOTE_WAKEUP)
 133                                         #define USB_Device_SendRemoteWakeup()   MACROS{ UDCON |= (1 << RMWKUP); }MACROE
 134
 135                                         #define USB_Device_IsRemoteWakeupSent()       ((UDCON &  (1 << RMWKUP)) ? false : true)
 136                                 #endif
 137
 138                                 #define USB_Device_IsUSBSuspended()           ((UDINT &  (1 << SUSPI)) ? true : false)
 139
 140                                 #define USB_Device_EnableSOFEvents()    MACROS{ USB_INT_Enable(USB_INT_SOFI); }MACROE
 141
 142                                 #define USB_Device_DisableSOFEvents()   MACROS{ USB_INT_Disable(USB_INT_SOFI); }MACROE
 143                         #endif
 144
 145                 /* Type Defines: */
 146                         enum USB_Device_States_t
 147                         {
 148                                 DEVICE_STATE_Unattached                   = 0, /**< Internally implemented by the library. This state indicates
 149                                                                                 *   that the device is not currently connected to a host.
 150                                                                                 */
 151                                 DEVICE_STATE_Powered                      = 1, /**< Internally implemented by the library. This state indicates
 152                                                                                 *   that the device is connected to a host, but enumeration has not
 153                                                                                 *   yet begun.
 154                                                                                 */
 155                                 DEVICE_STATE_Default                      = 2, /**< Internally implemented by the library. This state indicates
 156                                                                                 *   that the device's USB bus has been reset by the host and it is
 157                                                                                 *   now waiting for the host to begin the enumeration process.
 158                                                                                 */
 159                                 DEVICE_STATE_Addressed                    = 3, /**< Internally implemented by the library. This state indicates
 160                                                                                 *   that the device has been addressed by the USB Host, but is not
 161                                                                                 *   yet configured.
 162                                                                                 */
 163                                 DEVICE_STATE_Configured                   = 4, /**< May be implemented by the user project. This state indicates
 164                                                                                 *   that the device has been enumerated by the host and is ready
 165                                                                                 *   for USB communications to begin.
 166                                                                                 */
 167                                 DEVICE_STATE_Suspended                    = 5, /**< May be implemented by the user project. This state indicates
 168                                                                                 *   that the USB bus has been suspended by the host, and the device
 169                                                                                 *   should power down to a minimal power level until the bus is
 170                                                                                 *   resumed.
 171                                                                                 */
 172                         };
 173
 174                 /* Function Prototypes: */
 175                         /** Function to retrieve a given descriptor's size and memory location from the given descriptor type value,
 176                          *  index and language ID. This function MUST be overridden in the user application (added with full, identical
 177                          *  prototype and name so that the library can call it to retrieve descriptor data.
 178                          *
 179                          *  \param[in] wValue  The type of the descriptor to retrieve in the upper byte, and the index in the
 180                          *                     lower byte (when more than one descriptor of the given type exists, such as the
 181                          *                     case of string descriptors). The type may be one of the standard types defined
 182                          *                     in the DescriptorTypes_t enum, or may be a class-specific descriptor type value.
 183                          *  \param[in] wIndex  The language ID of the string to return if the wValue type indicates DTYPE_String,
 184                          *                     otherwise zero for standard descriptors, or as defined in a class-specific
 185                          *                     standards.
 186                          *  \param[out] DescriptorAddress  Pointer to the descriptor in memory. This should be set by the routine to
 187                          *                                 the address of the descriptor.
 188                          *  \param[out] MemoryAddressSpace A value from the \ref USB_DescriptorMemorySpaces_t enum to indicate the memory
 189                          *                                 space in which the descriptor is stored. This parameter does not exist when one
 190                          *                                 of the USE_*_DESCRIPTORS compile time options is used.
 191                          *
 192                          *  \note By default, the library expects all descriptors to be located in flash memory via the PROGMEM attribute.
 193                          *        If descriptors should be located in RAM or EEPROM instead (to speed up access in the case of RAM, or to
 194                          *        allow the descriptors to be changed dynamically at runtime) either the USE_RAM_DESCRIPTORS or the
 195                          *        USE_EEPROM_DESCRIPTORS tokens may be defined in the project makefile and passed to the compiler by the -D
 196                          *        switch.
 197                          *
 198                          *  \return Size in bytes of the descriptor if it exists, zero or \ref NO_DESCRIPTOR otherwise
 199                          */
 200                         uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress
 201                         #if !defined(USE_FLASH_DESCRIPTORS) && !defined(USE_EEPROM_DESCRIPTORS) && !defined(USE_RAM_DESCRIPTORS)
 202                                                             , uint8_t* MemoryAddressSpace
 203                         #endif
 204                                                             )
 205                                                                                     ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
 206
 207         /* Private Interface - For use in library only: */
 208         #if !defined(__DOXYGEN__)
 209                 /* Macros: */
 210                         #define USB_Device_SetLowSpeed()        MACROS{ UDCON |=  (1 << LSM);   }MACROE
 211                         #define USB_Device_SetFullSpeed()       MACROS{ UDCON &= ~(1 << LSM);   }MACROE
 212         #endif
 213
 214 #endif
 215
 216 /** @} */