LPCOpen Platform
LPCOpen Platform for NXP LPC Microcontrollers
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Device_LPC18xx.h
Go to the documentation of this file.
1 /*
2  * @brief USB Device definitions for the LPC18xx 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_LPC18XX_H__
42 #define __USBDEVICE_LPC18XX_H__
43 
44 /* Includes: */
45  #include "../../../../../../Common/Common.h"
46  #include "../../../USBController.h"
47  #include "../../../StdDescriptors.h"
48  #include "../../../USBInterrupt.h"
49  #include "../../../Endpoint.h"
50 
51  #if defined(USB_DEVICE_ROM_DRIVER)
52  #include "../USBRom/usbd_rom_api.h"
53  #endif
54 
55 /* Enable C linkage for C++ Compilers: */
56  #if defined(__cplusplus)
57 extern "C" {
58  #endif
59 
60 /* Preprocessor Checks: */
61  #if !defined(__INCLUDE_FROM_USB_DRIVER)
62  #error Do not include this file directly. Include lpcroot/libraries/LPCUSBlib/Drivers/USB/USB.h instead.
63  #endif
64 
65  #if (defined(USE_RAM_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS))
66  #error USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive.
67  #endif
68 
69 /* Public Interface - May be used in end-application: */
70 /* Macros: */
73  #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || \
74  defined(__DOXYGEN__)
75 
83  #define USB_DEVICE_OPT_LOWSPEED (1 << 0)
84  #endif
85 
89  #define USB_DEVICE_OPT_FULLSPEED (0 << 0)
90 
91 
92  #if (!defined(NO_INTERNAL_SERIAL) && \
93  (defined(USB_SERIES_7_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_4_AVR) || \
94  (defined(USB_SERIES_2_AVR) && (!defined(__AVR_AT90USB82__) || defined(__AVR_AT90USB162__))) || \
95  defined(__DOXYGEN__)))
96 
105  #define USE_INTERNAL_SERIAL 0xDC
106 
110  #define INTERNAL_SERIAL_LENGTH_BITS 80
111 
115  #define INTERNAL_SERIAL_START_ADDRESS 0x0E
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: */
143 void USB_Device_SendRemoteWakeup(void);
144 
145 /* Inline Functions: */
150 
151 static inline uint16_t USB_Device_GetFrameNumber(void)
152 {
153  return USB_REG(USBPortNum)->FRINDEX_D;
154 }
155 
156  #if !defined(NO_SOF_EVENTS)
157 
163 static inline void USB_Device_EnableSOFEvents(void) ATTR_ALWAYS_INLINE;
164 
165 static inline void USB_Device_EnableSOFEvents(void)
166 {}
167 
173 static inline void USB_Device_DisableSOFEvents(void) ATTR_ALWAYS_INLINE;
174 
175 static inline void USB_Device_DisableSOFEvents(void)
176 {}
177 
178  #endif
179 
180 /* Private Interface - For use in library only: */
181  #if !defined(__DOXYGEN__)
182 /* Inline Functions: */
183  #if defined(USB_DEVICE_OPT_LOWSPEED)
184 static inline void USB_Device_SetLowSpeed(void) ATTR_ALWAYS_INLINE;
185 
186 static inline void USB_Device_SetLowSpeed(void)
187 {
188  // UDCON |= (1 << LSM);
189 }
190 
191 static inline void USB_Device_SetFullSpeed(void) ATTR_ALWAYS_INLINE;
192 
193 static inline void USB_Device_SetFullSpeed(void)
194 {
195  // UDCON &= ~(1 << LSM);
196 }
197 
198  #endif
199 
200 static inline void USB_Device_SetDeviceAddress(const uint8_t Address) ATTR_ALWAYS_INLINE;
201 
202 static inline void USB_Device_SetDeviceAddress(const uint8_t Address)
203 {
204  USB_REG(USBPortNum)->DEVICEADDR = USBDEV_ADDR(Address);
205  USB_REG(USBPortNum)->DEVICEADDR |= USBDEV_ADDR_AD;
206 }
207 
208 static inline bool USB_Device_IsAddressSet(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
209 
210 static inline bool USB_Device_IsAddressSet(void)
211 {
212  return true; /* temporarily */
213 }
214 
215  #if (USE_INTERNAL_SERIAL != NO_DESCRIPTOR)
216 static inline void USB_Device_GetSerialString(uint16_t *const UnicodeString) ATTR_NON_NULL_PTR_ARG(1);
217 
218 static inline void USB_Device_GetSerialString(uint16_t *const UnicodeString)
219 {
220  uint_reg_t CurrentGlobalInt = GetGlobalInterruptMask();
222 
223  uint8_t SigReadAddress = INTERNAL_SERIAL_START_ADDRESS;
224 
225  for (uint8_t SerialCharNum = 0; SerialCharNum < (INTERNAL_SERIAL_LENGTH_BITS / 4); SerialCharNum++) {
226  uint8_t SerialByte = boot_signature_byte_get(SigReadAddress);
227 
228  if (SerialCharNum & 0x01) {
229  SerialByte >>= 4;
230  SigReadAddress++;
231  }
232 
233  SerialByte &= 0x0F;
234 
235  UnicodeString[SerialCharNum] = cpu_to_le16((SerialByte >= 10) ?
236  (('A' - 10) + SerialByte) : ('0' + SerialByte));
237  }
238 
239  SetGlobalInterruptMask(CurrentGlobalInt);
240 }
241 
242  #endif
243 
244  #endif
245 
246 /* Disable C linkage for C++ Compilers: */
247  #if defined(__cplusplus)
248 }
249  #endif
250 
251 #endif
252