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