Outline ![]()
Files ![]()
loading...
CodeScope![]()
STM32 Libraries and Samples![]()
usbx![]()
common/usbx_host_classes/src/ux_host_class_hid_global_item_parse.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
/**************************************************************************/
/* */
/* Copyright (c) Microsoft Corporation. All rights reserved. */
/* */
/* This software is licensed under the Microsoft Software License */
/* Terms for Microsoft Azure RTOS. Full text of the license can be */
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
/* and in the root directory of this software. */
/* */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** USBX Component */
/** */
/** HID Class */
/** */
/**************************************************************************/
/**************************************************************************/
/* Include necessary system files. */
#define UX_SOURCE_CODE
#include "ux_api.h"
#include "ux_host_class_hid.h"
#include "ux_host_stack.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_host_class_hid_global_item_parse PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function parses a global item from the report descriptor. */
/* */
/* INPUT */
/* */
/* hid Pointer to HID class */
/* item Pointer to item */
/* descriptor Pointer to descriptor */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_host_class_hid_item_data_get Get data item */
/* _ux_utility_memory_copy Copy memory block */
/* */
/* CALLED BY */
/* */
/* HID Class */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */
/* 09-30-2020 Chaoqiong Xiao Modified comment(s), */
/* verified memset and memcpy */
/* cases, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _ux_host_class_hid_global_item_parse(UX_HOST_CLASS_HID *hid, UX_HOST_CLASS_HID_ITEM *item, UCHAR *descriptor)
{
UX_HOST_CLASS_HID_PARSER *hid_parser;
/* Get the temporary parser structure pointer. */
hid_parser = &hid -> ux_host_class_hid_parser;
/* Get the tag of the item structure and process it. */
switch(item -> ux_host_class_hid_item_report_tag)
{
case UX_HOST_CLASS_HID_GLOBAL_TAG_USAGE_PAGE:
/* Usage Page Tag. */
hid_parser -> ux_host_class_hid_parser_global.ux_host_class_hid_global_item_usage_page =
_ux_host_class_hid_item_data_get(descriptor, item);
break;
case UX_HOST_CLASS_HID_GLOBAL_TAG_LOGICAL_MINIMUM:
/* Logical Minimum Tag. */
hid_parser -> ux_host_class_hid_parser_global.ux_host_class_hid_global_item_logical_min =
(SLONG) _ux_host_class_hid_item_data_get(descriptor, item);
break;
case UX_HOST_CLASS_HID_GLOBAL_TAG_LOGICAL_MAXIMUM:
/* Logical Maximum Tag. */
hid_parser -> ux_host_class_hid_parser_global.ux_host_class_hid_global_item_logical_max =
(SLONG) _ux_host_class_hid_item_data_get(descriptor, item);
break;
case UX_HOST_CLASS_HID_GLOBAL_TAG_PHYSICAL_MINIMUM:
/* Physical Minimum Tag. */
hid_parser -> ux_host_class_hid_parser_global.ux_host_class_hid_global_item_physical_min =
(SLONG) _ux_host_class_hid_item_data_get(descriptor, item);
break;
case UX_HOST_CLASS_HID_GLOBAL_TAG_PHYSICAL_MAXIMUM:
/* Physical Maximum Tag. */
hid_parser -> ux_host_class_hid_parser_global.ux_host_class_hid_global_item_physical_max =
(SLONG) _ux_host_class_hid_item_data_get(descriptor, item);
break;
case UX_HOST_CLASS_HID_GLOBAL_TAG_UNIT_EXPONENT:
/* Unit Exponent Tag. */
hid_parser -> ux_host_class_hid_parser_global.ux_host_class_hid_global_item_unit_expo =
_ux_host_class_hid_item_data_get(descriptor, item);
break;
case UX_HOST_CLASS_HID_GLOBAL_TAG_UNIT:
/* Unit tag. */
hid_parser -> ux_host_class_hid_parser_global.ux_host_class_hid_global_item_unit =
_ux_host_class_hid_item_data_get(descriptor, item);
break;
case UX_HOST_CLASS_HID_GLOBAL_TAG_REPORT_SIZE:
/* Report Size tag. */
hid_parser -> ux_host_class_hid_parser_global.ux_host_class_hid_global_item_report_size =
_ux_host_class_hid_item_data_get(descriptor, item);
if (hid_parser -> ux_host_class_hid_parser_global.ux_host_class_hid_global_item_report_size > UX_HOST_CLASS_HID_REPORT_SIZE)
{
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_HOST_CLASS_HID_REPORT_OVERFLOW);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_HOST_CLASS_HID_REPORT_OVERFLOW, hid, 0, 0, UX_TRACE_ERRORS, 0, 0)
return(UX_HOST_CLASS_HID_REPORT_OVERFLOW);
}
break;
case UX_HOST_CLASS_HID_GLOBAL_TAG_REPORT_ID:
/* Report ID tag. */
hid_parser -> ux_host_class_hid_parser_global.ux_host_class_hid_global_item_report_id =
_ux_host_class_hid_item_data_get(descriptor, item);
break;
case UX_HOST_CLASS_HID_GLOBAL_TAG_REPORT_COUNT:
/* Report Count tag. */
hid_parser -> ux_host_class_hid_parser_global.ux_host_class_hid_global_item_report_count =
_ux_host_class_hid_item_data_get(descriptor, item);
if (hid_parser -> ux_host_class_hid_parser_global.ux_host_class_hid_global_item_report_count > UX_HOST_CLASS_HID_USAGES)
{
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_HOST_CLASS_HID_USAGE_OVERFLOW);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_HOST_CLASS_HID_USAGE_OVERFLOW, hid, 0, 0, UX_TRACE_ERRORS, 0, 0)
return(UX_HOST_CLASS_HID_USAGE_OVERFLOW);
}
break;
case UX_HOST_CLASS_HID_GLOBAL_TAG_PUSH:
/* Push tag. */
if (hid_parser -> ux_host_class_hid_parser_number_global >= UX_HOST_CLASS_HID_MAX_GLOBAL)
{
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_HOST_CLASS_HID_PUSH_OVERFLOW);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_HOST_CLASS_HID_PUSH_OVERFLOW, hid, 0, 0, UX_TRACE_ERRORS, 0, 0)
return(UX_HOST_CLASS_HID_PUSH_OVERFLOW);
}
else
_ux_utility_memory_copy(&hid_parser -> ux_host_class_hid_parser_global_pool[hid_parser -> ux_host_class_hid_parser_number_global++],
&hid_parser -> ux_host_class_hid_parser_global, sizeof(UX_HOST_CLASS_HID_GLOBAL_ITEM)); /* Use case of memcpy is verified. */
break;
case UX_HOST_CLASS_HID_GLOBAL_TAG_POP:
/* Pop tag. */
if(hid_parser -> ux_host_class_hid_parser_number_global == 0)
{
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_HOST_CLASS_HID_POP_UNDERFLOW);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_HOST_CLASS_HID_POP_UNDERFLOW, hid, 0, 0, UX_TRACE_ERRORS, 0, 0)
return(UX_HOST_CLASS_HID_POP_UNDERFLOW);
}
else
_ux_utility_memory_copy(&hid_parser -> ux_host_class_hid_parser_global,
&hid_parser -> ux_host_class_hid_parser_global_pool[--hid_parser -> ux_host_class_hid_parser_number_global],
sizeof(UX_HOST_CLASS_HID_GLOBAL_ITEM)); /* Use case of memcpy is verified. */
break;
default:
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_HOST_CLASS_HID_TAG_UNSUPPORTED);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_HOST_CLASS_HID_TAG_UNSUPPORTED, hid, 0, 0, UX_TRACE_ERRORS, 0, 0)
/* This tag was not recognized or is not supported. */
return(UX_HOST_CLASS_HID_TAG_UNSUPPORTED);
}
/* We get here when the tag has been processed successfully. */
return(UX_SUCCESS);
}