Statistics
| Branch: | Tag: | Revision:

root / LUFA / Drivers / USB / Core / XMEGA / Device_XMEGA.h @ 978b99e5

History | View | Annotate | Download (9.28 KB)

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 AVR XMEGA microcontrollers.
33
 *  \copydetails Group_Device_XMEGA
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_XMEGA Device Management (XMEGA)
41
 *  \brief USB Device definitions for the AVR XMEGA microcontrollers.
42
 *
43
 *  Architecture specific USB Device definitions for the Atmel AVR XMEGA microcontrollers.
44
 *
45
 *  @{
46
 */
47

    
48
#ifndef __USBDEVICE_XMEGA_H__
49
#define __USBDEVICE_XMEGA_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
        /* Public Interface - May be used in end-application: */
73
                /* Macros: */
74
                        /** \name USB Device Mode Option Masks */
75
                        //@{
76
                        /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the
77
                         *  USB interface should be initialized in low speed (1.5Mb/s) mode.
78
                         *
79
                         *  \note Low Speed mode is not available on all USB AVR models.
80
                         *        \n
81
                         *
82
                         *  \note Restrictions apply on the number, size and type of endpoints which can be used
83
                         *        when running in low speed mode - refer to the USB 2.0 specification.
84
                         */
85
                        #define USB_DEVICE_OPT_LOWSPEED        (1 << 0)
86

    
87
                        /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the
88
                         *  USB interface should be initialized in full speed (12Mb/s) mode.
89
                         */
90
                        #define USB_DEVICE_OPT_FULLSPEED       (0 << 0)
91
                        //@}
92
                        
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    (8 * (1 + (offsetof(NVM_PROD_SIGNATURES_t, COORDY1) - offsetof(NVM_PROD_SIGNATURES_t, LOTNUM0))))
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  offsetof(NVM_PROD_SIGNATURES_t, LOTNUM0)
113
                        
114
                /* Function Prototypes: */
115
                        /** Sends a Remote Wakeup request to the host. This signals to the host that the device should
116
                         *  be taken out of suspended mode, and communications should resume.
117
                         *
118
                         *  Typically, this is implemented so that HID devices (mice, keyboards, etc.) can wake up the
119
                         *  host computer when the host has suspended all USB devices to enter a low power state.
120
                         *
121
                         *  \note This macro should only be used if the device has indicated to the host that it
122
                         *        supports the Remote Wakeup feature in the device descriptors, and should only be
123
                         *        issued if the host is currently allowing remote wakeup events from the device (i.e.,
124
                         *        the \ref USB_Device_RemoteWakeupEnabled flag is set). When the \c NO_DEVICE_REMOTE_WAKEUP
125
                         *        compile time option is used, this macro is unavailable.
126
                         *        \n\n
127
                         *
128
                         *  \note The USB clock must be running for this function to operate. If the stack is initialized with
129
                         *        the \ref USB_OPT_MANUAL_PLL option enabled, the user must ensure that the PLL is running
130
                         *        before attempting to call this function.
131
                         *
132
                         *  \see \ref Group_StdDescriptors for more information on the RMWAKEUP feature and device descriptors.
133
                         */
134
                        void USB_Device_SendRemoteWakeup(void);
135

    
136
                /* Inline Functions: */
137
                        /** Returns the current USB frame number, when in device mode. Every millisecond the USB bus is active (i.e. enumerated to a host)
138
                         *  the frame number is incremented by one.
139
                         *
140
                         *  \return Current USB frame number from the USB controller.
141
                         */
142
                        static inline uint16_t USB_Device_GetFrameNumber(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
143
                        static inline uint16_t USB_Device_GetFrameNumber(void)
144
                        {
145
                                return (((uint16_t)USB_EndpointTable.FRAMENUMH << 8) | USB_EndpointTable.FRAMENUML);
146
                        }
147

    
148
                        #if !defined(NO_SOF_EVENTS)
149
                        /** Enables the device mode Start Of Frame events. When enabled, this causes the
150
                         *  \ref EVENT_USB_Device_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus,
151
                         *  at the start of each USB frame when enumerated in device mode.
152
                         *
153
                         *  \note Not available when the \c NO_SOF_EVENTS compile time token is defined.
154
                         */
155
                        static inline void USB_Device_EnableSOFEvents(void) ATTR_ALWAYS_INLINE;
156
                        static inline void USB_Device_EnableSOFEvents(void)
157
                        {
158
                                USB.INTCTRLA |=  USB_SOFIE_bm;
159
                        }
160

    
161
                        /** Disables the device mode Start Of Frame events. When disabled, this stops the firing of the
162
                         *  \ref EVENT_USB_Device_StartOfFrame() event when enumerated in device mode.
163
                         *
164
                         *  \note Not available when the \c NO_SOF_EVENTS compile time token is defined.
165
                         */
166
                        static inline void USB_Device_DisableSOFEvents(void) ATTR_ALWAYS_INLINE;
167
                        static inline void USB_Device_DisableSOFEvents(void)
168
                        {
169
                                USB.INTCTRLA &= ~USB_SOFIE_bm;
170
                        }
171
                        #endif
172

    
173
        /* Private Interface - For use in library only: */
174
        #if !defined(__DOXYGEN__)
175
                /* Inline Functions: */
176
                        static inline void USB_Device_SetLowSpeed(void) ATTR_ALWAYS_INLINE;
177
                        static inline void USB_Device_SetLowSpeed(void)
178
                        {
179
                                USB.CTRLA &= ~USB_SPEED_bm;
180
                        }
181

    
182
                        static inline void USB_Device_SetFullSpeed(void) ATTR_ALWAYS_INLINE;
183
                        static inline void USB_Device_SetFullSpeed(void)
184
                        {
185
                                USB.CTRLA |=  USB_SPEED_bm;
186
                        }
187

    
188
                        static inline void USB_Device_SetDeviceAddress(const uint8_t Address) ATTR_ALWAYS_INLINE;
189
                        static inline void USB_Device_SetDeviceAddress(const uint8_t Address)
190
                        {
191
                                USB.ADDR = Address;
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 ((USB.ADDR != 0) ? true : false);
198
                        }
199
                
200
                        static inline void USB_Device_GetSerialString(uint16_t* const UnicodeString) ATTR_NON_NULL_PTR_ARG(1);
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 = INTERNAL_SERIAL_START_ADDRESS;
207

    
208
                                for (uint8_t SerialCharNum = 0; SerialCharNum < (INTERNAL_SERIAL_LENGTH_BITS / 4); SerialCharNum++)
209
                                {                                        
210
                                        uint8_t SerialByte;
211

    
212
                                        NVM.CMD    = NVM_CMD_READ_CALIB_ROW_gc;
213
                                        SerialByte = pgm_read_byte(SigReadAddress);
214

    
215
                                        if (SerialCharNum & 0x01)
216
                                        {
217
                                                SerialByte >>= 4;
218
                                                SigReadAddress++;
219
                                        }
220

    
221
                                        SerialByte &= 0x0F;
222

    
223
                                        UnicodeString[SerialCharNum] = cpu_to_le16((SerialByte >= 10) ?
224
                                                                                                                           (('A' - 10) + SerialByte) : ('0' + SerialByte));
225
                                }
226
                                
227
                                SetGlobalInterruptMask(CurrentGlobalInt);
228
                        }
229

    
230
        #endif
231

    
232
        /* Disable C linkage for C++ Compilers: */
233
                #if defined(__cplusplus)
234
                        }
235
                #endif
236

    
237
#endif
238

    
239
/** @} */
240