| 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
HostStandardReq.h
Go to the documentation of this file.
1 /*
2 * @brief USB host standard request 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 #ifndef __HOSTSTDREQ_H__
34 #define __HOSTSTDREQ_H__
35
36 /* Includes: */
37 #include "../../../Common/Common.h"
38 #include "USBMode.h"
39 #include "StdRequestType.h"
40 #include "USBController.h"
41
42 /* Enable C linkage for C++ Compilers: */
43 #if defined(__cplusplus)
44 extern "C" {
45 #endif
46
47 /* Preprocessor Checks: */
48 #if !defined(__INCLUDE_FROM_USB_DRIVER)
49 #error Do not include this file directly. Include lpcroot/libraries/LPCUSBlib/Drivers/USB/USB.h instead.
50 #endif
51
52 /* Public Interface - May be used in end-application: */
53 /* Macros: */
54 #if !defined(USB_HOST_TIMEOUT_MS) || defined(__DOXYGEN__)
55
62 #define USB_HOST_TIMEOUT_MS 1000
63 #endif
64
65 /* Enums: */
71 enum USB_Host_SendControlErrorCodes_t
72 {
73 HOST_SENDCONTROL_Successful = 0,
74 HOST_SENDCONTROL_DeviceDisconnected = 1,
77 HOST_SENDCONTROL_PipeError = 2,
78 HOST_SENDCONTROL_SetupStalled = 3,
81 HOST_SENDCONTROL_SoftwareTimeOut = 4,
82 };
83
84 /* Global Variables: */
95 extern uint8_t USB_Host_ConfigurationNumber;
96
97 /* Function Prototypes: */
110 uint8_t USB_Host_SendControlRequest(const uint8_t corenum, void* const BufferPtr);
111
126 uint8_t USB_Host_SetDeviceConfiguration(const uint8_t corenum, const uint8_t ConfigNumber);
127
142 uint8_t USB_Host_GetDeviceDescriptor(const uint8_t corenum, void* const DeviceDescriptorPtr) ATTR_NON_NULL_PTR_ARG(2);
143
160 uint8_t USB_Host_GetDeviceStringDescriptor(const uint8_t corenum,
161 const uint8_t Index,
162 void* const Buffer,
163 const uint8_t BufferLength) ATTR_NON_NULL_PTR_ARG(3);
164
178 uint8_t USB_Host_GetDeviceStatus(const uint8_t corenum, uint8_t* const FeatureStatus) ATTR_NON_NULL_PTR_ARG(2);
179
191 uint8_t USB_Host_ClearEndpointStall(const uint8_t corenum, const uint8_t EndpointAddress);
192
206 uint8_t USB_Host_SetInterfaceAltSetting(const uint8_t corenum,
207 const uint8_t InterfaceIndex,
208 const uint8_t AltSetting);
209
210 /* Private Interface - For use in library only: */
211 #if !defined(__DOXYGEN__)
212 /* Enums: */
213 enum USB_WaitForTypes_t
214 {
215 USB_HOST_WAITFOR_SetupSent,
216 USB_HOST_WAITFOR_InReceived,
217 USB_HOST_WAITFOR_OutReady,
218 };
219
220 /* Function Prototypes: */
221 #if defined(__INCLUDE_FROM_HOSTSTDREQ_C)
222 // static uint8_t USB_Host_WaitForIOS(const uint8_t WaitType); Deprecated
223 #endif
224 #endif
225
226 /* Disable C linkage for C++ Compilers: */
227 #if defined(__cplusplus)
228 }
229 #endif
230
231 #endif
232