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