LPCOpen Platform
LPCOpen Platform for NXP LPC Microcontrollers
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
DeviceStandardReq.h
Go to the documentation of this file.
1 /*
2  * @brief USB device 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 
34 
35 #ifndef __DEVICESTDREQ_H__
36 #define __DEVICESTDREQ_H__
37 
38  /* Includes: */
39  #include "../../../Common/Common.h"
40  #include "USBMode.h"
41  #include "StdDescriptors.h"
42  #include "Events.h"
43  #include "StdRequestType.h"
44  #include "USBTask.h"
45  #include "USBController.h"
46 
47  /* Enable C linkage for C++ Compilers: */
48  #if defined(__cplusplus)
49  extern "C" {
50  #endif
51 
52  /* Preprocessor Checks: */
53  #if !defined(__INCLUDE_FROM_USB_DRIVER)
54  #error Do not include this file directly. Include lpcroot/libraries/LPCUSBlib/Drivers/USB/USB.h instead.
55  #endif
56 
57  /* Public Interface - May be used in end-application: */
58  /* Enums: */
59  #if defined(ARCH_HAS_MULTI_ADDRESS_SPACE) || defined(__DOXYGEN__)
60 
67  {
68  #if defined(ARCH_HAS_FLASH_ADDRESS_SPACE) || defined(__DOXYGEN__)
70  #endif
71  #if defined(ARCH_HAS_EEPROM_ADDRESS_SPACE) || defined(__DOXYGEN__)
73  #endif
75  };
76  #endif
77 
78  /* Global Variables: */
88  extern uint8_t USB_Device_ConfigurationNumber;
89 
90  #if !defined(NO_DEVICE_REMOTE_WAKEUP)
91 
105  extern bool USB_Device_RemoteWakeupEnabled;
106  #endif
107 
108  #if !defined(NO_DEVICE_SELF_POWER)
109 
116  #endif
117 
118  /* Private Interface - For use in library only: */
119  #if !defined(__DOXYGEN__)
120  #if defined(USE_RAM_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS)
121  #error USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive.
122  #elif defined(USE_RAM_DESCRIPTORS) && defined(USE_FLASH_DESCRIPTORS)
123  #error USE_RAM_DESCRIPTORS and USE_FLASH_DESCRIPTORS are mutually exclusive.
124  #elif defined(USE_FLASH_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS)
125  #error USE_FLASH_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive.
126  #elif defined(USE_FLASH_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS) && defined(USE_RAM_DESCRIPTORS)
127  #error Only one of the USE_*_DESCRIPTORS modes should be selected.
128  #endif
129 
130  /* Function Prototypes: */
132 
133  #if defined(__INCLUDE_FROM_DEVICESTDREQ_C)
134  static void USB_Device_SetAddress(void);
135  static void USB_Device_SetConfiguration(void);
136  static void USB_Device_GetConfiguration(void);
137  static void USB_Device_GetDescriptor(void);
138  static void USB_Device_GetStatus(void);
139  static void USB_Device_ClearSetFeature(void);
140 
141  #if !defined(NO_INTERNAL_SERIAL) && (USE_INTERNAL_SERIAL != NO_DESCRIPTOR)
142  static void USB_Device_GetInternalSerialDescriptor(void);
143  #endif
144  #endif
145  #endif
146 
147  /* Disable C linkage for C++ Compilers: */
148  #if defined(__cplusplus)
149  }
150  #endif
151 
152 #endif
153