LUFA/Drivers/USB/Core/UC3/Device_UC3.h

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