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