| 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
HIDClassDevice.h
Go to the documentation of this file.
1 /*
2 * @brief Device mode driver for the library USB HID Class driver
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
46 #ifndef _HID_CLASS_DEVICE_H_
47 #define _HID_CLASS_DEVICE_H_
48
49 /* Includes: */
50 #include "../../USB.h"
51 #include "../Common/HIDClassCommon.h"
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_HID_DRIVER)
60 #error Do not include this file directly. Include LPCUSBlib/Drivers/USB.h instead.
61 #endif
62
63 /* Public Interface - May be used in end-application: */
64 /* Type Defines: */
75 typedef struct {
76 const struct {
77 uint8_t InterfaceNumber;
79 uint8_t ReportINEndpointNumber;
80 uint16_t ReportINEndpointSize;
81 bool ReportINEndpointDoubleBank;
83 void *PrevReportINBuffer;
95 uint8_t PrevReportINBufferSize;
101 uint8_t PortNumber;
102 } Config;
106 struct {
107 bool UsingReportProtocol;
108 uint16_t IdleCount;
109 uint16_t IdleMSRemaining;
111 } State;
115 } USB_ClassInfo_HID_Device_t;
116
117 /* Function Prototypes: */
127 bool HID_Device_ConfigureEndpoints(USB_ClassInfo_HID_Device_t *const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
128
136 void HID_Device_ProcessControlRequest(USB_ClassInfo_HID_Device_t *const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
137
145 void HID_Device_USBTask(USB_ClassInfo_HID_Device_t *const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
146
163 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t *const HIDInterfaceInfo,
164 uint8_t *const ReportID,
165 const uint8_t ReportType,
166 void *ReportData,
167 uint16_t *const ReportSize) ATTR_NON_NULL_PTR_ARG(1)
168 ATTR_NON_NULL_PTR_ARG(2) ATTR_NON_NULL_PTR_ARG(4) ATTR_NON_NULL_PTR_ARG(5);
169
183 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t *const HIDInterfaceInfo,
184 const uint8_t ReportID,
185 const uint8_t ReportType,
186 const void *ReportData,
187 const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(4);
188
189 /* Inline Functions: */
198 PRAGMA_ALWAYS_INLINE
199 static inline void HID_Device_MillisecondElapsed(USB_ClassInfo_HID_Device_t *const HIDInterfaceInfo) ATTR_ALWAYS_INLINE
200 ATTR_NON_NULL_PTR_ARG(1);
201 static inline void HID_Device_MillisecondElapsed(USB_ClassInfo_HID_Device_t *const HIDInterfaceInfo)
202 {
203 if (HIDInterfaceInfo->State.IdleMSRemaining) {
204 HIDInterfaceInfo->State.IdleMSRemaining--;
205 }
206 }
207
208 /* Disable C linkage for C++ Compilers: */
209 #if defined(__cplusplus)
210 }
211 #endif
212
213 #endif
214