| LPCOpen Platform v1.03 LPCOpen Platform for NXP LPC Microcontrollers

- Main Page
- Modules
- Data Structures
- Files
- Related Pages

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
USBTask.h
Go to the documentation of this file.
1 /*
2 * @brief Main USB service task management
3 *
4 * @note
5 * Copyright(C) NXP Semiconductors, 2012
6 * Copyright(C) Dean Camera, 2011, 2012
7 * All rights reserved.
8 *
9 * @par
10 * Software that is described herein is for illustrative purposes only
11 * which provides customers with programming information regarding the
12 * LPC products. This software is supplied "AS IS" without any warranties of
13 * any kind, and NXP Semiconductors and its licensor disclaim any and
14 * all warranties, express or implied, including all implied warranties of
15 * merchantability, fitness for a particular purpose and non-infringement of
16 * intellectual property rights. NXP Semiconductors assumes no responsibility
17 * or liability for the use of the software, conveys no license or rights under any
18 * patent, copyright, mask work right, or any other intellectual property rights in
19 * or to any products. NXP Semiconductors reserves the right to make changes
20 * in the software without notification. NXP Semiconductors also makes no
21 * representation or warranty that such application will be suitable for the
22 * specified use without further testing or modification.
23 *
24 * @par
25 * Permission to use, copy, modify, and distribute this software and its
26 * documentation is hereby granted, under NXP Semiconductors' and its
27 * licensor's relevant copyrights in the software, without fee, provided that it
28 * is used in conjunction with NXP Semiconductors microcontrollers. This
29 * copyright, permission, and disclaimer notice must appear in all copies of
30 * this code.
31 */
32
33
34 #ifndef __USBTASK_H__
35 #define __USBTASK_H__
36
37 /* Includes: */
38 #include "../../../Common/Common.h"
39 #include "USBMode.h"
40 #include "USBController.h"
41 #include "Events.h"
42 #include "StdRequestType.h"
43 #include "StdDescriptors.h"
44
45 #if defined(USB_CAN_BE_DEVICE)
46 #include "DeviceStandardReq.h"
47 #endif
48
49 #if defined(USB_CAN_BE_HOST)
50 #include "HostStandardReq.h"
51 #endif
52
53 /* Enable C linkage for C++ Compilers: */
54 #if defined(__cplusplus)
55 extern "C" {
56 #endif
57
58 /* Preprocessor Checks: */
59 #if !defined(__INCLUDE_FROM_USB_DRIVER)
60 #error Do not include this file directly. Include lpcroot/libraries/LPCUSBlib/Drivers/USB/USB.h instead.
61 #endif
62
63 /* Public Interface - May be used in end-application: */
64 /* Global Variables: */
74 extern volatile bool USB_IsInitialized;
75
84 extern USB_Request_Header_t USB_ControlRequest;
85
86 #if defined(USB_CAN_BE_HOST) || defined(__DOXYGEN__)
87 #if !defined(HOST_STATE_AS_GPIOR) || defined(__DOXYGEN__)
88
106 extern volatile uint8_t USB_HostState[MAX_USB_CORE];
107 #else
108 #define _GET_HOST_GPIOR_NAME2(y) GPIOR ## y
109 #define _GET_HOST_GPIOR_NAME(x) _GET_HOST_GPIOR_NAME2(x)
110 #define USB_HostState _GET_HOST_GPIOR_NAME(HOST_STATE_AS_GPIOR)
111 #endif
112 #endif
113
114 #if defined(USB_CAN_BE_DEVICE) || defined(__DOXYGEN__)
115 #if !defined(DEVICE_STATE_AS_GPIOR) || defined(__DOXYGEN__)
116
139 extern volatile uint8_t USB_DeviceState[];
140 #else
141 #define _GET_DEVICE_GPIOR_NAME2(y) GPIOR ## y
142 #define _GET_DEVICE_GPIOR_NAME(x) _GET_DEVICE_GPIOR_NAME2(x)
143 #define USB_DeviceState[0] _GET_DEVICE_GPIOR_NAME(DEVICE_STATE_AS_GPIOR)
144 #define USB_DeviceState[1] _GET_DEVICE_GPIOR_NAME(DEVICE_STATE_AS_GPIOR)
145 #endif
146 #endif
147
148 /* Function Prototypes: */
171 void USB_USBTask(uint8_t corenum, uint8_t mode);
172
173 /* Private Interface - For use in library only: */
174 #if !defined(__DOXYGEN__)
175 /* Function Prototypes: */
176 #if defined(__INCLUDE_FROM_USBTASK_C)
177 #if defined(USB_CAN_BE_HOST)
178 static void USB_HostTask(uint8_t corenum);
179 #endif
180
181 #if defined(USB_CAN_BE_DEVICE)
182 static void USB_DeviceTask(uint8_t corenum);
183 #endif
184 #endif
185
186 /* Macros: */
187 #define HOST_TASK_NONBLOCK_WAIT(CoreID, Duration, NextState) MACROS{ USB_HostState[(CoreID)] = HOST_STATE_WaitForDevice; \
188 WaitMSRemaining = (Duration); \
189 PostWaitState = (NextState); }MACROE
190 #endif
191
192 /* Disable C linkage for C++ Compilers: */
193 #if defined(__cplusplus)
194 }
195 #endif
196
197 #endif
198