LPCOpen Platform
LPCOpen Platform for NXP LPC Microcontrollers
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Device_LPC17xx.h
Go to the documentation of this file.
1 /*
2  * @brief USB Device definitions for the LPC17xx 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_LPC17XX_H__
42 #define __USBDEVICE_LPC17XX_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(__cplusplus)
51 extern "C" {
52  #endif
53 
54  #if !defined(__INCLUDE_FROM_USB_DRIVER)
55  #error Do not include this file directly. Include lpcroot/libraries/LPCUSBlib/Drivers/USB/USB.h instead.
56  #endif
57 
58  #if (defined(USE_RAM_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS))
59  #error USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive.
60  #endif
61 
62  #if defined(__DOXYGEN__)
63  #define USB_DEVICE_OPT_LOWSPEED (1 << 0)
64  #endif
65 
66  #define USB_DEVICE_OPT_FULLSPEED (0 << 0)
67 
68  #if (!defined(NO_INTERNAL_SERIAL) && \
69  (defined(__DOXYGEN__)) )
70  #define USE_INTERNAL_SERIAL 0xDC
71 
72  #define INTERNAL_SERIAL_LENGTH_BITS 80
73 
74  #define INTERNAL_SERIAL_START_ADDRESS 0x0E
75  #else
76  #define USE_INTERNAL_SERIAL NO_DESCRIPTOR
77 
78  #define INTERNAL_SERIAL_LENGTH_BITS 0
79  #define INTERNAL_SERIAL_START_ADDRESS 0
80  #endif
81 
83 
85 
86 static inline uint16_t USB_Device_GetFrameNumber(void)
87 {
88  uint32_t val;
89 
90  SIE_WriteCommamd(CMD_RD_FRAME);
92  val = val | (SIE_ReadCommandData(DAT_RD_FRAME) << 8);
93 
94  return val;
95 }
96 
97  #if !defined(NO_SOF_EVENTS)
98 static inline void USB_Device_EnableSOFEvents(void) ATTR_ALWAYS_INLINE;
99 
100 static inline void USB_Device_EnableSOFEvents(void)
101 {}
102 
103 static inline void USB_Device_DisableSOFEvents(void) ATTR_ALWAYS_INLINE;
104 
105 static inline void USB_Device_DisableSOFEvents(void)
106 {}
107 
108  #endif
109 
110  #if !defined(__DOXYGEN__)
111  #if defined(USB_DEVICE_OPT_LOWSPEED)
112 static inline void USB_Device_SetLowSpeed(void) ATTR_ALWAYS_INLINE;
113 
114 static inline void USB_Device_SetLowSpeed(void)
115 {}
116 
117 static inline void USB_Device_SetFullSpeed(void) ATTR_ALWAYS_INLINE;
118 
119 static inline void USB_Device_SetFullSpeed(void)
120 {}
121 
122  #endif
123 
124 static inline void USB_Device_SetDeviceAddress(const uint8_t Address) ATTR_ALWAYS_INLINE;
125 
126 static inline void USB_Device_SetDeviceAddress(const uint8_t Address)
127 {
128  SIE_WriteCommandData(CMD_SET_ADDR, DAT_WR_BYTE(DEV_EN | Address)); /* Don't wait for next */
129  SIE_WriteCommandData(CMD_SET_ADDR, DAT_WR_BYTE(DEV_EN | Address)); /* Setup Status Phase */
130 }
131 
132 static inline bool USB_Device_IsAddressSet(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
133 
134 static inline bool USB_Device_IsAddressSet(void)
135 {
136  return true; /* TODO temporarily */
137 }
138 
139  #if (USE_INTERNAL_SERIAL != NO_DESCRIPTOR)
140 static inline void USB_Device_GetSerialString(uint16_t *const UnicodeString) ATTR_NON_NULL_PTR_ARG(1);
141 
142 static inline void USB_Device_GetSerialString(uint16_t *const UnicodeString)
143 {
144  uint_reg_t CurrentGlobalInt = GetGlobalInterruptMask();
146 
147  uint8_t SigReadAddress = INTERNAL_SERIAL_START_ADDRESS;
148 
149  for (uint8_t SerialCharNum = 0; SerialCharNum < (INTERNAL_SERIAL_LENGTH_BITS / 4); SerialCharNum++) {
150  uint8_t SerialByte = boot_signature_byte_get(SigReadAddress);
151 
152  if (SerialCharNum & 0x01) {
153  SerialByte >>= 4;
154  SigReadAddress++;
155  }
156 
157  SerialByte &= 0x0F;
158 
159  UnicodeString[SerialCharNum] = cpu_to_le16((SerialByte >= 10) ?
160  (('A' - 10) + SerialByte) : ('0' + SerialByte));
161  }
162 
163  SetGlobalInterruptMask(CurrentGlobalInt);
164 }
165 
166  #endif
167 
168  #endif
169 
170  #if defined(__cplusplus)
171 }
172  #endif
173 
174 #endif
175