LPCOpen Platform
LPCOpen Platform for NXP LPC Microcontrollers
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Device_LPC11Uxx.h
Go to the documentation of this file.
1 /*
2  * @brief USB Device definitions for the LPC11Uxx microcontrollers
3  *
4  * @note
5  * Copyright(C) NXP Semiconductors, 2012
6  * All rights reserved.
7  *
8  * @par
9  * Software that is described herein is for illustrative purposes only
10  * which provides customers with programming information regarding the
11  * LPC products. This software is supplied "AS IS" without any warranties of
12  * any kind, and NXP Semiconductors and its licensor disclaim any and
13  * all warranties, express or implied, including all implied warranties of
14  * merchantability, fitness for a particular purpose and non-infringement of
15  * intellectual property rights. NXP Semiconductors assumes no responsibility
16  * or liability for the use of the software, conveys no license or rights under any
17  * patent, copyright, mask work right, or any other intellectual property rights in
18  * or to any products. NXP Semiconductors reserves the right to make changes
19  * in the software without notification. NXP Semiconductors also makes no
20  * representation or warranty that such application will be suitable for the
21  * specified use without further testing or modification.
22  *
23  * @par
24  * Permission to use, copy, modify, and distribute this software and its
25  * documentation is hereby granted, under NXP Semiconductors' and its
26  * licensor's relevant copyrights in the software, without fee, provided that it
27  * is used in conjunction with NXP Semiconductors microcontrollers. This
28  * copyright, permission, and disclaimer notice must appear in all copies of
29  * this code.
30  */
31 
41 #ifndef __USBDEVICE_LPC11UXX_H__
42 #define __USBDEVICE_LPC11UXX_H__
43 
44  #include "../../../../../../Common/Common.h"
45  #include "../../../USBController.h"
46  #include "../../../StdDescriptors.h"
47  #include "../../../USBInterrupt.h"
48  #include "../../../Endpoint.h"
49 
50  #if defined(USB_DEVICE_ROM_DRIVER)
51  #include "../USBRom/usbd_rom_api.h"
52  #endif
53 
54  #if defined(__cplusplus)
55 extern "C" {
56  #endif
57 
58  #if !defined(__INCLUDE_FROM_USB_DRIVER)
59  #error Do not include this file directly. Include lpcroot/libraries/LPCUSBlib/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  #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || \
67  defined(__DOXYGEN__)
68 
69  #define USB_DEVICE_OPT_LOWSPEED (1 << 0)
70  #endif
71 
72  #define USB_DEVICE_OPT_FULLSPEED (0 << 0)
73 
74  #if (!defined(NO_INTERNAL_SERIAL) && \
75  (defined(USB_SERIES_7_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_4_AVR) || \
76  (defined(USB_SERIES_2_AVR) && (!defined(__AVR_AT90USB82__) || defined(__AVR_AT90USB162__))) || \
77  defined(__DOXYGEN__)))
78 
79  #define USE_INTERNAL_SERIAL 0xDC
80 
81  #define INTERNAL_SERIAL_LENGTH_BITS 80
82 
83  #define INTERNAL_SERIAL_START_ADDRESS 0x0E
84  #else
85  #define USE_INTERNAL_SERIAL NO_DESCRIPTOR
86 
87  #define INTERNAL_SERIAL_LENGTH_BITS 0
88  #define INTERNAL_SERIAL_START_ADDRESS 0
89  #endif
90 
92 
95 
96 static inline uint16_t USB_Device_GetFrameNumber(void)
97 {
98  return 0;
99 }
100 
101  #if !defined(NO_SOF_EVENTS)
102 
104 static inline void USB_Device_EnableSOFEvents(void) ATTR_ALWAYS_INLINE;
105 
106 static inline void USB_Device_EnableSOFEvents(void)
107 {}
108 
110 static inline void USB_Device_DisableSOFEvents(void) ATTR_ALWAYS_INLINE;
111 
112 static inline void USB_Device_DisableSOFEvents(void)
113 {}
114 
115  #endif
116 
117  #if !defined(__DOXYGEN__)
118  #if defined(USB_DEVICE_OPT_LOWSPEED)
120 static inline void USB_Device_SetLowSpeed(void) ATTR_ALWAYS_INLINE;
121 
122 static inline void USB_Device_SetLowSpeed(void)
123 {
124  // UDCON |= (1 << LSM);
125 }
126 
128 static inline void USB_Device_SetFullSpeed(void) ATTR_ALWAYS_INLINE;
129 
130 static inline void USB_Device_SetFullSpeed(void)
131 {
132  // UDCON &= ~(1 << LSM);
133 }
134 
135  #endif
136 
138 static inline void USB_Device_SetDeviceAddress(const uint8_t Address) ATTR_ALWAYS_INLINE;
139 
140 static inline void USB_Device_SetDeviceAddress(const uint8_t Address)
141 {
142  HAL_SetDeviceAddress(Address);
143 }
144 
146 static inline bool USB_Device_IsAddressSet(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
147 
148 static inline bool USB_Device_IsAddressSet(void)
149 {
150  return true; /* temporarily */
151 }
152 
153  #if (USE_INTERNAL_SERIAL != NO_DESCRIPTOR)
154 static inline void USB_Device_GetSerialString(uint16_t *const UnicodeString) ATTR_NON_NULL_PTR_ARG(1);
155 
156 static inline void USB_Device_GetSerialString(uint16_t *const UnicodeString)
157 {
158  uint_reg_t CurrentGlobalInt = GetGlobalInterruptMask();
160 
161  uint8_t SigReadAddress = INTERNAL_SERIAL_START_ADDRESS;
162 
163  for (uint8_t SerialCharNum = 0; SerialCharNum < (INTERNAL_SERIAL_LENGTH_BITS / 4); SerialCharNum++) {
164  uint8_t SerialByte = boot_signature_byte_get(SigReadAddress);
165 
166  if (SerialCharNum & 0x01) {
167  SerialByte >>= 4;
168  SigReadAddress++;
169  }
170 
171  SerialByte &= 0x0F;
172 
173  UnicodeString[SerialCharNum] = cpu_to_le16((SerialByte >= 10) ?
174  (('A' - 10) + SerialByte) : ('0' + SerialByte));
175  }
176 
177  SetGlobalInterruptMask(CurrentGlobalInt);
178 }
179 
180  #endif
181 
182  #endif
183 
184  #if defined(__cplusplus)
185 }
186  #endif
187 
188 #endif
189