LUFA/Drivers/USB/Core/AVR8/Device_AVR8.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 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 "../StdDescriptors.h"
  54                 #include "../USBInterrupt.h"
  55                 #include "../Endpoint.h"
  56
  57         /* Preprocessor Checks: */
  58                 #if !defined(__INCLUDE_FROM_USB_DRIVER)
  59                         #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
  60                 #endif
  61
  62                 #if (defined(USE_RAM_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS))
  63                         #error USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive.
  64                 #endif
  65
  66         /* Public Interface - May be used in end-application: */
  67                 /* Macros: */
  68                         /** \name USB Device Mode Option Masks */
  69                         //@{
  70                         #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)
  71                                 /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the
  72                                  *  USB interface should be initialized in low speed (1.5Mb/s) mode.
  73                                  *
  74                                  *  \note Low Speed mode is not available on all USB AVR models.
  75                                  *        \n
  76                                  *
  77                                  *  \note Restrictions apply on the number, size and type of endpoints which can be used
  78                                  *        when running in low speed mode - refer to the USB 2.0 specification.
  79                                  */
  80                                 #define USB_DEVICE_OPT_LOWSPEED            (1 << 0)
  81                         #endif
  82
  83                         /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the
  84                          *  USB interface should be initialized in full speed (12Mb/s) mode.
  85                          */
  86                         #define USB_DEVICE_OPT_FULLSPEED               (0 << 0)
  87                         //@}
  88
  89                         #if (!defined(NO_INTERNAL_SERIAL) && \
  90                              (defined(USB_SERIES_7_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_4_AVR) || \
  91                               (defined(USB_SERIES_2_AVR) && (!defined(__AVR_AT90USB82__) || defined(__AVR_AT90USB162__))) || \
  92                                   defined(__DOXYGEN__)))
  93                                 /** String descriptor index for the device's unique serial number string descriptor within the device.
  94                                  *  This unique serial number is used by the host to associate resources to the device (such as drivers or COM port
  95                                  *  number allocations) to a device regardless of the port it is plugged in to on the host. Some microcontrollers contain
  96                                  *  a unique serial number internally, and setting the device descriptors serial number string index to this value
  97                                  *  will cause it to use the internal serial number.
  98                                  *
  99                                  *  On unsupported devices, this will evaluate to \ref NO_DESCRIPTOR and so will force the host to create a pseudo-serial
 100                                  *  number for the device.
 101                                  */
 102                                 #define USE_INTERNAL_SERIAL            0xDC
 103
 104                                 /** Length of the device's unique internal serial number, in bits, if present on the selected microcontroller
 105                                  *  model.
 106                                  */
 107                                 #define INTERNAL_SERIAL_LENGTH_BITS    80
 108
 109                                 /** Start address of the internal serial number, in the appropriate address space, if present on the selected microcontroller
 110                                  *  model.
 111                                  */
 112                                 #define INTERNAL_SERIAL_START_ADDRESS  0x0E
 113                         #else
 114                                 #define USE_INTERNAL_SERIAL            NO_DESCRIPTOR
 115
 116                                 #define INTERNAL_SERIAL_LENGTH_BITS    0
 117                                 #define INTERNAL_SERIAL_START_ADDRESS  0
 118                         #endif
 119
 120                 /* Function Prototypes: */
 121                         /** Sends a Remote Wakeup request to the host. This signals to the host that the device should
 122                          *  be taken out of suspended mode, and communications should resume.
 123                          *
 124                          *  Typically, this is implemented so that HID devices (mice, keyboards, etc.) can wake up the
 125                          *  host computer when the host has suspended all USB devices to enter a low power state.
 126                          *
 127                          *  \note This macro should only be used if the device has indicated to the host that it
 128                          *        supports the Remote Wakeup feature in the device descriptors, and should only be
 129                          *        issued if the host is currently allowing remote wakeup events from the device (i.e.,
 130                          *        the \ref USB_RemoteWakeupEnabled flag is set). When the \c NO_DEVICE_REMOTE_WAKEUP compile
 131                          *        time option is used, this macro is unavailable.
 132                          *        \n\n
 133                          *
 134                          *  \note The USB clock must be running for this function to operate. If the stack is initialized with
 135                          *        the \ref USB_OPT_MANUAL_PLL option enabled, the user must ensure that the PLL is running
 136                          *        before attempting to call this function.
 137                          *
 138                          *  \see \ref Group_StdDescriptors for more information on the RMWAKEUP feature and device descriptors.
 139                          */
 140                         void USB_Device_SendRemoteWakeup(void);
 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) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
 147                         static inline uint16_t USB_Device_GetFrameNumber(void)
 148                         {
 149                                 return UDFNUM;
 150                         }
 151
 152                         #if !defined(NO_SOF_EVENTS)
 153                                 /** Enables the device mode Start Of Frame events. When enabled, this causes the
 154                                  *  \ref EVENT_USB_Device_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus,
 155                                  *  at the start of each USB frame when enumerated in device mode.
 156                                  *
 157                                  *  \note Not available when the \c NO_SOF_EVENTS compile time token is defined.
 158                                  */
 159                                 static inline void USB_Device_EnableSOFEvents(void) ATTR_ALWAYS_INLINE;
 160                                 static inline void USB_Device_EnableSOFEvents(void)
 161                                 {
 162                                         USB_INT_Enable(USB_INT_SOFI);
 163                                 }
 164
 165                                 /** Disables the device mode Start Of Frame events. When disabled, this stops the firing of the
 166                                  *  \ref EVENT_USB_Device_StartOfFrame() event when enumerated in device mode.
 167                                  *
 168                                  *  \note Not available when the \c NO_SOF_EVENTS compile time token is defined.
 169                                  */
 170                                 static inline void USB_Device_DisableSOFEvents(void) ATTR_ALWAYS_INLINE;
 171                                 static inline void USB_Device_DisableSOFEvents(void)
 172                                 {
 173                                         USB_INT_Disable(USB_INT_SOFI);
 174                                 }
 175                         #endif
 176
 177         /* Private Interface - For use in library only: */
 178         #if !defined(__DOXYGEN__)
 179                 /* Inline Functions: */
 180                         #if (defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR))
 181                         static inline void USB_Device_SetLowSpeed(void) ATTR_ALWAYS_INLINE;
 182                         static inline void USB_Device_SetLowSpeed(void)
 183                         {
 184                                 UDCON |=  (1 << LSM);
 185                         }
 186
 187                         static inline void USB_Device_SetFullSpeed(void) ATTR_ALWAYS_INLINE;
 188                         static inline void USB_Device_SetFullSpeed(void)
 189                         {
 190                                 UDCON &= ~(1 << LSM);
 191                         }
 192                         #endif
 193
 194                         static inline void USB_Device_SetDeviceAddress(const uint8_t Address) ATTR_ALWAYS_INLINE;
 195                         static inline void USB_Device_SetDeviceAddress(const uint8_t Address)
 196                         {
 197                                 UDADDR  = ((UDADDR & (1 << ADDEN)) | (Address & 0x7F));
 198                                 UDADDR |= (1 << ADDEN);
 199                         }
 200
 201                         static inline bool USB_Device_IsAddressSet(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
 202                         static inline bool USB_Device_IsAddressSet(void)
 203                         {
 204                                 return (UDADDR & (1 << ADDEN));
 205                         }
 206
 207                         #if (USE_INTERNAL_SERIAL != NO_DESCRIPTOR)
 208                         static inline void USB_Device_GetSerialString(uint16_t* const UnicodeString)
 209                         {
 210                                 uint_reg_t CurrentGlobalInt = GetGlobalInterruptMask();
 211                                 GlobalInterruptDisable();
 212
 213                                 uint8_t SigReadAddress = INTERNAL_SERIAL_START_ADDRESS;
 214
 215                                 for (uint8_t SerialCharNum = 0; SerialCharNum < (INTERNAL_SERIAL_LENGTH_BITS / 4); SerialCharNum++)
 216                                 {
 217                                         uint8_t SerialByte = boot_signature_byte_get(SigReadAddress);
 218
 219                                         if (SerialCharNum & 0x01)
 220                                         {
 221                                                 SerialByte >>= 4;
 222                                                 SigReadAddress++;
 223                                         }
 224
 225                                         SerialByte &= 0x0F;
 226
 227                                         UnicodeString[SerialCharNum] = cpu_to_le16((SerialByte >= 10) ?
 228                                                                                                                            (('A' - 10) + SerialByte) : ('0' + SerialByte));
 229                                 }
 230
 231                                 SetGlobalInterruptMask(CurrentGlobalInt);
 232                         }
 233                         #endif
 234
 235         #endif
 236
 237 #endif
 238
 239 /** @} */
 240