LUFA/Drivers/USB/Core/UC3B/Device_UC3B.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 UC3B microcontrollers.
  33  *  \copydetails Group_Device_UC3B
  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_UC3B Device Management (UC3B)
  41  *  \brief USB Device definitions for the AVR32 UC3B microcontrollers.
  42  *
  43  *  Architecture specific USB Device definitions for the Atmel 32-bit UC3B AVR microcontrollers.
  44  *
  45  *  @{
  46  */
  47
  48 #ifndef __USBDEVICE_UC3B_H__
  49 #define __USBDEVICE_UC3B_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         /* Public Interface - May be used in end-application: */
  63                 /* Macros: */
  64                         /** \name USB Device Mode Option Masks */
  65                         //@{
  66                         #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)
  67                                 /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the
  68                                  *  USB interface should be initialized in low speed (1.5Mb/s) mode.
  69                                  *
  70                                  *  \note Low Speed mode is not available on all USB AVR models.
  71                                  *        \n
  72                                  *
  73                                  *  \note Restrictions apply on the number, size and type of endpoints which can be used
  74                                  *        when running in low speed mode - refer to the USB 2.0 specification.
  75                                  */
  76                                 #define USB_DEVICE_OPT_LOWSPEED            (1 << 0)
  77                         #endif
  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(__AVR_AT90USB647__) || defined(__AVR_AT90USB1287__) || \
  87                               defined(__AVR_ATmega32U6__) || defined(__AVR_AT90USB646__)  || defined(__AVR_AT90USB1286__) ||  \
  88                               defined(__AVR_ATmega32U2__) || defined(__AVR_ATmega16U2__)  || defined(__AVR_ATmega8U2__)))
  89                                 /** String descriptor index for the device's unique serial number string descriptor within the device.
  90                                  *  This unique serial number is used by the host to associate resources to the device (such as drivers or COM port
  91                                  *  number allocations) to a device regardless of the port it is plugged in to on the host. Some USB AVRs contain
  92                                  *  a unique serial number internally, and setting the device descriptors serial number string index to this value
  93                                  *  will cause it to use the internal serial number.
  94                                  *
  95                                  *  On unsupported devices, this will evaluate to NO_DESCRIPTOR and so will force the host to create a pseudo-serial
  96                                  *  number for the device.
  97                                  */
  98                                 #define USE_INTERNAL_SERIAL           0xDC
  99                         #else
 100                                 #define USE_INTERNAL_SERIAL           NO_DESCRIPTOR
 101                         #endif
 102
 103                 /* Function Prototypes: */
 104                         /** Sends a Remote Wakeup request to the host. This signals to the host that the device should
 105                          *  be taken out of suspended mode, and communications should resume.
 106                          *
 107                          *  Typically, this is implemented so that HID devices (mice, keyboards, etc.) can wake up the
 108                          *  host computer when the host has suspended all USB devices to enter a low power state.
 109                          *
 110                          *  \note This macro should only be used if the device has indicated to the host that it
 111                          *        supports the Remote Wakeup feature in the device descriptors, and should only be
 112                          *        issued if the host is currently allowing remote wakeup events from the device (i.e.,
 113                          *        the \ref USB_RemoteWakeupEnabled flag is set). When the \c NO_DEVICE_REMOTE_WAKEUP compile
 114                          *        time option is used, this macro is unavailable.
 115                          *        \n\n
 116                          *
 117                          *  \note The USB clock must be running for this function to operate. If the stack is initialized with
 118                          *        the \ref USB_OPT_MANUAL_PLL option enabled, the user must ensure that the PLL is running
 119                          *        before attempting to call this function.
 120                          *
 121                          *  \see \ref Group_StdDescriptors for more information on the RMWAKEUP feature and device descriptors.
 122                          */
 123                         void USB_Device_SendRemoteWakeup(void);
 124
 125                 /* Type Defines: */
 126                         enum USB_Device_States_t
 127                         {
 128                                 DEVICE_STATE_Unattached                   = 0, /**< Internally implemented by the library. This state indicates
 129                                                                                 *   that the device is not currently connected to a host.
 130                                                                                 */
 131                                 DEVICE_STATE_Powered                      = 1, /**< Internally implemented by the library. This state indicates
 132                                                                                 *   that the device is connected to a host, but enumeration has not
 133                                                                                 *   yet begun.
 134                                                                                 */
 135                                 DEVICE_STATE_Default                      = 2, /**< Internally implemented by the library. This state indicates
 136                                                                                 *   that the device's USB bus has been reset by the host and it is
 137                                                                                 *   now waiting for the host to begin the enumeration process.
 138                                                                                 */
 139                                 DEVICE_STATE_Addressed                    = 3, /**< Internally implemented by the library. This state indicates
 140                                                                                 *   that the device has been addressed by the USB Host, but is not
 141                                                                                 *   yet configured.
 142                                                                                 */
 143                                 DEVICE_STATE_Configured                   = 4, /**< May be implemented by the user project. This state indicates
 144                                                                                 *   that the device has been enumerated by the host and is ready
 145                                                                                 *   for USB communications to begin.
 146                                                                                 */
 147                                 DEVICE_STATE_Suspended                    = 5, /**< May be implemented by the user project. This state indicates
 148                                                                                 *   that the USB bus has been suspended by the host, and the device
 149                                                                                 *   should power down to a minimal power level until the bus is
 150                                                                                 *   resumed.
 151                                                                                 */
 152                         };
 153
 154                 /* Inline Functions: */
 155                         /** Returns the current USB frame number, when in device mode. Every millisecond the USB bus is active (i.e. enumerated to a host)
 156                          *  the frame number is incremented by one.
 157                          */
 158                         static inline uint16_t USB_Device_GetFrameNumber(void)
 159                         {
 160                                 return AVR32_USBB.UDFNUM.fnum;
 161                         }
 162
 163                         #if !defined(NO_SOF_EVENTS)
 164                                 /** Enables the device mode Start Of Frame events. When enabled, this causes the
 165                                  *  \ref EVENT_USB_Device_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus,
 166                                  *  at the start of each USB frame 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_EnableSOFEvents(void) ATTR_ALWAYS_INLINE;
 171                                 static inline void USB_Device_EnableSOFEvents(void)
 172                                 {
 173                                         USB_INT_Enable(USB_INT_SOFI);
 174                                 }
 175
 176                                 /** Disables the device mode Start Of Frame events. When disabled, this stops the firing of the
 177                                  *  \ref EVENT_USB_Device_StartOfFrame() event when enumerated in device mode.
 178                                  *
 179                                  *  \note Not available when the \c NO_SOF_EVENTS compile time token is defined.
 180                                  */
 181                                 static inline void USB_Device_DisableSOFEvents(void) ATTR_ALWAYS_INLINE;
 182                                 static inline void USB_Device_DisableSOFEvents(void)
 183                                 {
 184                                         USB_INT_Disable(USB_INT_SOFI);
 185                                 }
 186                         #endif
 187
 188         /* Private Interface - For use in library only: */
 189         #if !defined(__DOXYGEN__)
 190                 /* Inline Functions: */
 191                         #if (defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR))
 192                         static inline void USB_Device_SetLowSpeed(void) ATTR_ALWAYS_INLINE;
 193                         static inline void USB_Device_SetLowSpeed(void)
 194                         {
 195                                 AVR32_USBB.UDCON.ls = true;
 196                         }
 197
 198                         static inline void USB_Device_SetFullSpeed(void) ATTR_ALWAYS_INLINE;
 199                         static inline void USB_Device_SetFullSpeed(void)
 200                         {
 201                                 AVR32_USBB.UDCON.ls = false;
 202                         }
 203                         #endif
 204
 205                         static inline void USB_Device_SetDeviceAddress(const uint8_t Address) ATTR_ALWAYS_INLINE;
 206                         static inline void USB_Device_SetDeviceAddress(const uint8_t Address)
 207                         {
 208                                 AVR32_USBB.udcon       = (AVR32_USBB.udcon & ~AVR32_USBB_UADD_MASK) | Address;
 209                                 AVR32_USBB.UDCON.adden = true;
 210                         }
 211
 212                         static inline bool USB_Device_IsAddressSet(void) ATTR_ALWAYS_INLINE;
 213                         static inline bool USB_Device_IsAddressSet(void)
 214                         {
 215                                 return AVR32_USBB.UDCON.adden;
 216                         }
 217         #endif
 218
 219 #endif
 220
 221 /** @} */
 222