LUFA/Drivers/USB/Core/AVR8/Device_AVR8.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2015.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2015  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 disclaims 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 definitions for the AVR8 microcontrollers.
  33  *  \copydetails Group_Device_AVR8
  34  *
  35  *  \note This file should not be included directly. It is automatically included as needed by the USB driver
  36  *        dispatch header located in LUFA/Drivers/USB/USB.h.
  37  */
  38
  39 /** \ingroup Group_Device
  40  *  \defgroup Group_Device_AVR8 Device Management (AVR8)
  41  *  \brief USB Device definitions for the AVR8 microcontrollers.
  42  *
  43  *  Architecture specific USB Device definitions for the Atmel 8-bit AVR microcontrollers.
  44  *
  45  *  @{
  46  */
  47
  48 #ifndef __USBDEVICE_AVR8_H__
  49 #define __USBDEVICE_AVR8_H__
  50
  51         /* Includes: */
  52                 #include "../../../../Common/Common.h"
  53                 #include "../USBController.h"
  54                 #include "../StdDescriptors.h"
  55                 #include "../USBInterrupt.h"
  56                 #include "../Endpoint.h"
  57
  58         /* Enable C linkage for C++ Compilers: */
  59                 #if defined(__cplusplus)
  60                         extern "C" {
  61                 #endif
  62
  63         /* Preprocessor Checks: */
  64                 #if !defined(__INCLUDE_FROM_USB_DRIVER)
  65                         #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
  66                 #endif
  67
  68                 #if (defined(USE_RAM_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS))
  69                         #error USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive.
  70                 #endif
  71
  72                 #if (defined(USE_FLASH_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS))
  73                         #error USE_FLASH_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive.
  74                 #endif
  75
  76                 #if (defined(USE_FLASH_DESCRIPTORS) && defined(USE_RAM_DESCRIPTORS))
  77                         #error USE_FLASH_DESCRIPTORS and USE_RAM_DESCRIPTORS are mutually exclusive.
  78                 #endif
  79
  80         /* Public Interface - May be used in end-application: */
  81                 /* Macros: */
  82                         /** \name USB Device Mode Option Masks */
  83                         //@{
  84                         #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)
  85                                 /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the
  86                                  *  USB interface should be initialized in low speed (1.5Mb/s) mode.
  87                                  *
  88                                  *  \note Low Speed mode is not available on all USB AVR models.
  89                                  *        \n
  90                                  *
  91                                  *  \note Restrictions apply on the number, size and type of endpoints which can be used
  92                                  *        when running in low speed mode - please refer to the USB 2.0 specification.
  93                                  */
  94                                 #define USB_DEVICE_OPT_LOWSPEED            (1 << 0)
  95                         #endif
  96
  97                         /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the
  98                          *  USB interface should be initialized in full speed (12Mb/s) mode.
  99                          */
 100                         #define USB_DEVICE_OPT_FULLSPEED               (0 << 0)
 101                         //@}
 102
 103                         #if (!defined(NO_INTERNAL_SERIAL) && \
 104                              (defined(USB_SERIES_7_AVR) || defined(USB_SERIES_6_AVR) || \
 105                               defined(USB_SERIES_4_AVR) || defined(USB_SERIES_2_AVR) || \
 106                                   defined(__DOXYGEN__)))
 107                                 /** String descriptor index for the device's unique serial number string descriptor within the device.
 108                                  *  This unique serial number is used by the host to associate resources to the device (such as drivers or COM port
 109                                  *  number allocations) to a device regardless of the port it is plugged in to on the host. Some microcontrollers contain
 110                                  *  a unique serial number internally, and setting the device descriptors serial number string index to this value
 111                                  *  will cause it to use the internal serial number.
 112                                  *
 113                                  *  On unsupported devices, this will evaluate to \ref NO_DESCRIPTOR and so will force the host to create a pseudo-serial
 114                                  *  number for the device.
 115                                  */
 116                                 #define USE_INTERNAL_SERIAL            0xDC
 117
 118                                 /** Length of the device's unique internal serial number, in bits, if present on the selected microcontroller
 119                                  *  model.
 120                                  */
 121                                 #define INTERNAL_SERIAL_LENGTH_BITS    80
 122
 123                                 /** Start address of the internal serial number, in the appropriate address space, if present on the selected microcontroller
 124                                  *  model.
 125                                  */
 126                                 #define INTERNAL_SERIAL_START_ADDRESS  0x0E
 127                         #else
 128                                 #define USE_INTERNAL_SERIAL            NO_DESCRIPTOR
 129
 130                                 #define INTERNAL_SERIAL_LENGTH_BITS    0
 131                                 #define INTERNAL_SERIAL_START_ADDRESS  0
 132                         #endif
 133
 134                 /* Function Prototypes: */
 135                         /** Sends a Remote Wakeup request to the host. This signals to the host that the device should
 136                          *  be taken out of suspended mode, and communications should resume.
 137                          *
 138                          *  Typically, this is implemented so that HID devices (mice, keyboards, etc.) can wake up the
 139                          *  host computer when the host has suspended all USB devices to enter a low power state.
 140                          *
 141                          *  \attention This function should only be used if the device has indicated to the host that it
 142                          *             supports the Remote Wakeup feature in the device descriptors, and should only be
 143                          *             issued if the host is currently allowing remote wakeup events from the device (i.e.,
 144                          *             the \ref USB_Device_RemoteWakeupEnabled flag is set). When the \c NO_DEVICE_REMOTE_WAKEUP
 145                          *             compile time option is used, this function is unavailable.
 146                          *             \n\n
 147                          *
 148                          *  \attention The USB clock must be running for this function to operate. If the stack is initialized with
 149                          *             the \ref USB_OPT_MANUAL_PLL option enabled, the user must ensure that the PLL is running
 150                          *             before attempting to call this function.
 151                          *
 152                          *  \see \ref Group_StdDescriptors for more information on the RMWAKEUP feature and device descriptors.
 153                          */
 154                         void USB_Device_SendRemoteWakeup(void);
 155
 156                 /* Inline Functions: */
 157                         /** Returns the current USB frame number, when in device mode. Every millisecond the USB bus is active (i.e. enumerated to a host)
 158                          *  the frame number is incremented by one.
 159                          *
 160                          *  \return Current USB frame number from the USB controller.
 161                          */
 162                         static inline uint16_t USB_Device_GetFrameNumber(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
 163                         static inline uint16_t USB_Device_GetFrameNumber(void)
 164                         {
 165                                 return UDFNUM;
 166                         }
 167
 168                         #if !defined(NO_SOF_EVENTS)
 169                                 /** Enables the device mode Start Of Frame events. When enabled, this causes the
 170                                  *  \ref EVENT_USB_Device_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus,
 171                                  *  at the start of each USB frame when enumerated in device mode.
 172                                  *
 173                                  *  \note This function is not available when the \c NO_SOF_EVENTS compile time token is defined.
 174                                  */
 175                                 static inline void USB_Device_EnableSOFEvents(void) ATTR_ALWAYS_INLINE;
 176                                 static inline void USB_Device_EnableSOFEvents(void)
 177                                 {
 178                                         USB_INT_Enable(USB_INT_SOFI);
 179                                 }
 180
 181                                 /** Disables the device mode Start Of Frame events. When disabled, this stops the firing of the
 182                                  *  \ref EVENT_USB_Device_StartOfFrame() event when enumerated in device mode.
 183                                  *
 184                                  *  \note This function is not available when the \c NO_SOF_EVENTS compile time token is defined.
 185                                  */
 186                                 static inline void USB_Device_DisableSOFEvents(void) ATTR_ALWAYS_INLINE;
 187                                 static inline void USB_Device_DisableSOFEvents(void)
 188                                 {
 189                                         USB_INT_Disable(USB_INT_SOFI);
 190                                 }
 191                         #endif
 192
 193         /* Private Interface - For use in library only: */
 194         #if !defined(__DOXYGEN__)
 195                 /* Inline Functions: */
 196                         #if defined(USB_DEVICE_OPT_LOWSPEED)
 197                         static inline void USB_Device_SetLowSpeed(void) ATTR_ALWAYS_INLINE;
 198                         static inline void USB_Device_SetLowSpeed(void)
 199                         {
 200                                 UDCON |=  (1 << LSM);
 201                         }
 202
 203                         static inline void USB_Device_SetFullSpeed(void) ATTR_ALWAYS_INLINE;
 204                         static inline void USB_Device_SetFullSpeed(void)
 205                         {
 206                                 UDCON &= ~(1 << LSM);
 207                         }
 208                         #endif
 209
 210                         static inline void USB_Device_SetDeviceAddress(const uint8_t Address) ATTR_ALWAYS_INLINE;
 211                         static inline void USB_Device_SetDeviceAddress(const uint8_t Address)
 212                         {
 213                                 UDADDR = (UDADDR & (1 << ADDEN)) | (Address & 0x7F);
 214                         }
 215
 216                         static inline void USB_Device_EnableDeviceAddress(const uint8_t Address) ATTR_ALWAYS_INLINE;
 217                         static inline void USB_Device_EnableDeviceAddress(const uint8_t Address)
 218                         {
 219                                 (void)Address;
 220
 221                                 UDADDR |= (1 << ADDEN);
 222                         }
 223
 224                         static inline bool USB_Device_IsAddressSet(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
 225                         static inline bool USB_Device_IsAddressSet(void)
 226                         {
 227                                 return (UDADDR & (1 << ADDEN));
 228                         }
 229
 230                         #if (USE_INTERNAL_SERIAL != NO_DESCRIPTOR)
 231                         static inline void USB_Device_GetSerialString(uint16_t* const UnicodeString) ATTR_NON_NULL_PTR_ARG(1);
 232                         static inline void USB_Device_GetSerialString(uint16_t* const UnicodeString)
 233                         {
 234                                 uint_reg_t CurrentGlobalInt = GetGlobalInterruptMask();
 235                                 GlobalInterruptDisable();
 236
 237                                 uint8_t SigReadAddress = INTERNAL_SERIAL_START_ADDRESS;
 238
 239                                 for (uint8_t SerialCharNum = 0; SerialCharNum < (INTERNAL_SERIAL_LENGTH_BITS / 4); SerialCharNum++)
 240                                 {
 241                                         uint8_t SerialByte = boot_signature_byte_get(SigReadAddress);
 242
 243                                         if (SerialCharNum & 0x01)
 244                                         {
 245                                                 SerialByte >>= 4;
 246                                                 SigReadAddress++;
 247                                         }
 248
 249                                         SerialByte &= 0x0F;
 250
 251                                         UnicodeString[SerialCharNum] = cpu_to_le16((SerialByte >= 10) ?
 252                                                                                                                            (('A' - 10) + SerialByte) : ('0' + SerialByte));
 253                                 }
 254
 255                                 SetGlobalInterruptMask(CurrentGlobalInt);
 256                         }
 257                         #endif
 258
 259         #endif
 260
 261         /* Disable C linkage for C++ Compilers: */
 262                 #if defined(__cplusplus)
 263                         }
 264                 #endif
 265
 266 #endif
 267
 268 /** @} */
 269