LUFA/Drivers/USB/LowLevel/Device.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  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/io.h>
  54                 #include <avr/pgmspace.h>
  55                 #include <avr/eeprom.h>
  56
  57                 #include "../../../Common/Common.h"
  58                 #include "../HighLevel/StdDescriptors.h"
  59                 #include "USBInterrupt.h"
  60                 #include "Endpoint.h"
  61
  62         /* Preprocessor Checks: */
  63                 #if (defined(USE_RAM_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS))
  64                         #error USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive.
  65                 #endif
  66
  67                 #if !defined(__INCLUDE_FROM_USB_DRIVER)
  68                         #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
  69                 #endif
  70
  71         /* Public Interface - May be used in end-application: */
  72                 /* Macros: */
  73                         /** \name USB Device Mode Option Masks */
  74                         //@{
  75                         #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)
  76                                 /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the
  77                                  *  USB interface should be initialized in low speed (1.5Mb/s) mode.
  78                                  *
  79                                  *  \note Low Speed mode is not available on all USB AVR models.
  80                                  *        \n
  81                                  *
  82                                  *  \note Restrictions apply on the number, size and type of endpoints which can be used
  83                                  *        when running in low speed mode - refer to the USB 2.0 specification.
  84                                  */
  85                                 #define USB_DEVICE_OPT_LOWSPEED            (1 << 0)
  86                         #endif
  87
  88                         /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the
  89                          *  USB interface should be initialized in full speed (12Mb/s) mode.
  90                          */
  91                         #define USB_DEVICE_OPT_FULLSPEED               (0 << 0)
  92                         //@}
  93
  94                 /* Function Prototypes: */
  95                         /** Sends a Remote Wakeup request to the host. This signals to the host that the device should
  96                          *  be taken out of suspended mode, and communications should resume.
  97                          *
  98                          *  Typically, this is implemented so that HID devices (mice, keyboards, etc.) can wake up the
  99                          *  host computer when the host has suspended all USB devices to enter a low power state.
 100                          *
 101                          *  \note This macro should only be used if the device has indicated to the host that it
 102                          *        supports the Remote Wakeup feature in the device descriptors, and should only be
 103                          *        issued if the host is currently allowing remote wakeup events from the device (i.e.,
 104                          *        the \ref USB_RemoteWakeupEnabled flag is set). When the \c NO_DEVICE_REMOTE_WAKEUP compile
 105                          *        time option is used, this macro is unavailable.
 106                          *        \n\n
 107                          *
 108                          *  \note The USB clock must be running for this function to operate. If the stack is initialized with
 109                          *        the \ref USB_OPT_MANUAL_PLL option enabled, the user must ensure that the PLL is running
 110                          *        before attempting to call this function.
 111                          *
 112                          *  \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors.
 113                          */
 114                         void USB_Device_SendRemoteWakeup(void);
 115
 116                 /* Type Defines: */
 117                         enum USB_Device_States_t
 118                         {
 119                                 DEVICE_STATE_Unattached                   = 0, /**< Internally implemented by the library. This state indicates
 120                                                                                 *   that the device is not currently connected to a host.
 121                                                                                 */
 122                                 DEVICE_STATE_Powered                      = 1, /**< Internally implemented by the library. This state indicates
 123                                                                                 *   that the device is connected to a host, but enumeration has not
 124                                                                                 *   yet begun.
 125                                                                                 */
 126                                 DEVICE_STATE_Default                      = 2, /**< Internally implemented by the library. This state indicates
 127                                                                                 *   that the device's USB bus has been reset by the host and it is
 128                                                                                 *   now waiting for the host to begin the enumeration process.
 129                                                                                 */
 130                                 DEVICE_STATE_Addressed                    = 3, /**< Internally implemented by the library. This state indicates
 131                                                                                 *   that the device has been addressed by the USB Host, but is not
 132                                                                                 *   yet configured.
 133                                                                                 */
 134                                 DEVICE_STATE_Configured                   = 4, /**< May be implemented by the user project. This state indicates
 135                                                                                 *   that the device has been enumerated by the host and is ready
 136                                                                                 *   for USB communications to begin.
 137                                                                                 */
 138                                 DEVICE_STATE_Suspended                    = 5, /**< May be implemented by the user project. This state indicates
 139                                                                                 *   that the USB bus has been suspended by the host, and the device
 140                                                                                 *   should power down to a minimal power level until the bus is
 141                                                                                 *   resumed.
 142                                                                                 */
 143                         };
 144
 145                 /* Inline Functions: */
 146                         /** Returns the current USB frame number, when in device mode. Every millisecond the USB bus is active (i.e. enumerated to a host)
 147                          *  the frame number is incremented by one.
 148                          */
 149                         static inline uint16_t USB_Device_GetFrameNumber(void)
 150                         {
 151                                 return UDFNUM;
 152                         }
 153
 154                         #if !defined(NO_SOF_EVENTS)
 155                                 /** Enables the device mode Start Of Frame events. When enabled, this causes the
 156                                  *  \ref EVENT_USB_Device_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus,
 157                                  *  at the start of each USB frame when enumerated in device mode.
 158                                  *
 159                                  *  \note Not available when the \c NO_SOF_EVENTS compile time token is defined.
 160                                  */
 161                                 static inline void USB_Device_EnableSOFEvents(void) ATTR_ALWAYS_INLINE;
 162                                 static inline void USB_Device_EnableSOFEvents(void)
 163                                 {
 164                                         USB_INT_Enable(USB_INT_SOFI);
 165                                 }
 166
 167                                 /** Disables the device mode Start Of Frame events. When disabled, this stops the firing of the
 168                                  *  \ref EVENT_USB_Device_StartOfFrame() event when enumerated in device mode.
 169                                  *
 170                                  *  \note Not available when the \c NO_SOF_EVENTS compile time token is defined.
 171                                  */
 172                                 static inline void USB_Device_DisableSOFEvents(void) ATTR_ALWAYS_INLINE;
 173                                 static inline void USB_Device_DisableSOFEvents(void)
 174                                 {
 175                                         USB_INT_Disable(USB_INT_SOFI);
 176                                 }
 177                         #endif
 178
 179                 /* Function Prototypes: */
 180                         /** Function to retrieve a given descriptor's size and memory location from the given descriptor type value,
 181                          *  index and language ID. This function MUST be overridden in the user application (added with full, identical
 182                          *  prototype and name so that the library can call it to retrieve descriptor data.
 183                          *
 184                          *  \param[in] wValue               The type of the descriptor to retrieve in the upper byte, and the index in the
 185                          *                                  lower byte (when more than one descriptor of the given type exists, such as the
 186                          *                                  case of string descriptors). The type may be one of the standard types defined
 187                          *                                  in the DescriptorTypes_t enum, or may be a class-specific descriptor type value.
 188                          *  \param[in] wIndex               The language ID of the string to return if the \c wValue type indicates
 189                          *                                  \ref DTYPE_String, otherwise zero for standard descriptors, or as defined in a
 190                          *                                  class-specific standards.
 191                          *  \param[out] DescriptorAddress   Pointer to the descriptor in memory. This should be set by the routine to
 192                          *                                  the address of the descriptor.
 193                          *  \param[out] MemoryAddressSpace  A value from the \ref USB_DescriptorMemorySpaces_t enum to indicate the memory
 194                          *                                  space in which the descriptor is stored. This parameter does not exist when one
 195                          *                                  of the \c USE_*_DESCRIPTORS compile time options is used.
 196                          *
 197                          *  \note By default, the library expects all descriptors to be located in flash memory via the \c PROGMEM attribute.
 198                          *        If descriptors should be located in RAM or EEPROM instead (to speed up access in the case of RAM, or to
 199                          *        allow the descriptors to be changed dynamically at runtime) either the \c USE_RAM_DESCRIPTORS or the
 200                          *        \c USE_EEPROM_DESCRIPTORS tokens may be defined in the project makefile and passed to the compiler by the -D
 201                          *        switch.
 202                          *
 203                          *  \return Size in bytes of the descriptor if it exists, zero or \ref NO_DESCRIPTOR otherwise.
 204                          */
 205                         uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 206                                                             const uint8_t wIndex,
 207                                                             const void** const DescriptorAddress
 208                         #if !defined(USE_FLASH_DESCRIPTORS) && !defined(USE_EEPROM_DESCRIPTORS) && !defined(USE_RAM_DESCRIPTORS)
 209                                                             , uint8_t* MemoryAddressSpace
 210                         #endif
 211                                                             ) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
 212
 213         /* Private Interface - For use in library only: */
 214         #if !defined(__DOXYGEN__)
 215                 /* Inline Functions: */
 216                         #if (defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR))
 217                         static inline void USB_Device_SetLowSpeed(void) ATTR_ALWAYS_INLINE;
 218                         static inline void USB_Device_SetLowSpeed(void)
 219                         {
 220                                 UDCON |=  (1 << LSM);
 221                         }
 222
 223                         static inline void USB_Device_SetFullSpeed(void) ATTR_ALWAYS_INLINE;
 224                         static inline void USB_Device_SetFullSpeed(void)
 225                         {
 226                                 UDCON &= ~(1 << LSM);
 227                         }
 228                         #endif
 229
 230                         static inline void USB_Device_SetDeviceAddress(const uint8_t Address) ATTR_ALWAYS_INLINE;
 231                         static inline void USB_Device_SetDeviceAddress(const uint8_t Address)
 232                         {
 233                                 UDADDR  = ((UDADDR & (1 << ADDEN)) | (Address & 0x7F));
 234                                 UDADDR |= (1 << ADDEN);
 235                         }
 236
 237                         static inline bool USB_Device_IsAddressSet(void) ATTR_ALWAYS_INLINE;
 238                         static inline bool USB_Device_IsAddressSet(void)
 239                         {
 240                                 return (UDADDR & (1 << ADDEN));
 241                         }
 242         #endif
 243
 244 #endif
 245
 246 /** @} */
 247