Outline ![]()
Files ![]()
loading...
CodeScope![]()
STM32 Libraries and Samples![]()
usbx![]()
common/usbx_device_classes/src/ux_device_class_hid_control_request.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
/**************************************************************************/
/* */
/* 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 */
/** */
/** Device HID Class */
/** */
/**************************************************************************/
/**************************************************************************/
#define UX_SOURCE_CODE
/* Include necessary system files. */
#include "ux_api.h"
#include "ux_device_class_hid.h"
#include "ux_device_stack.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_device_class_hid_control_request PORTABLE C */
/* 6.1.10 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function manages the based sent by the host on the control */
/* endpoints with a CLASS or VENDOR SPECIFIC type. */
/* */
/* INPUT */
/* */
/* hid Pointer to hid class */
/* */
/* OUTPUT */
/* */
/* None */
/* */
/* CALLS */
/* */
/* _ux_device_stack_transfer_request Transfer request */
/* _ux_device_class_hid_report_get Process Get_Report request */
/* _ux_device_class_hid_report_set Process Set_Report request */
/* _ux_device_class_hid_descriptor_send Send requested descriptor */
/* */
/* 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), */
/* prefixed UX to MS_TO_TICK, */
/* used UX prefix to refer to */
/* TX symbols instead of using */
/* them directly, */
/* resulting in version 6.1 */
/* 11-09-2020 Chaoqiong Xiao Modified comment(s), */
/* fixed compile warnings 64b, */
/* resulting in version 6.1.2 */
/* 12-31-2020 Chaoqiong Xiao Modified comment(s), */
/* added Get/Set Protocol */
/* request support, */
/* resulting in version 6.1.3 */
/* 01-31-2022 Chaoqiong Xiao Modified comment(s), */
/* added standalone support, */
/* resulting in version 6.1.10 */
/* */
/**************************************************************************/
UINT _ux_device_class_hid_control_request(UX_SLAVE_CLASS_COMMAND *command)
{
UX_SLAVE_TRANSFER *transfer_request;
UX_SLAVE_DEVICE *device;
UX_SLAVE_CLASS *class;
ULONG request;
ULONG request_value;
ULONG request_index;
ULONG request_length;
ULONG descriptor_type;
UCHAR duration;
UX_SLAVE_CLASS_HID *hid;
/* Get the pointer to the device. */
device = &_ux_system_slave -> ux_system_slave_device;
/* Get the pointer to the transfer request associated with the control endpoint. */
transfer_request = &device -> ux_slave_device_control_endpoint.ux_slave_endpoint_transfer_request;
/* Extract all necessary fields of the request. */
request = *(transfer_request -> ux_slave_transfer_request_setup + UX_SETUP_REQUEST);
request_value = _ux_utility_short_get(transfer_request -> ux_slave_transfer_request_setup + UX_SETUP_VALUE);
request_index = _ux_utility_short_get(transfer_request -> ux_slave_transfer_request_setup + UX_SETUP_INDEX);
request_length = _ux_utility_short_get(transfer_request -> ux_slave_transfer_request_setup + UX_SETUP_LENGTH);
/* Duration - upper byte of wValue. */
duration = *(transfer_request -> ux_slave_transfer_request_setup + UX_SETUP_VALUE + 1);
/* Get the class container. */
class = command -> ux_slave_class_command_class_ptr;
/* Get the storage instance from this class container. */
hid = (UX_SLAVE_CLASS_HID *) class -> ux_slave_class_instance;
/* Here we proceed only the standard request we know of at the device level. */
switch (request)
{
case UX_DEVICE_CLASS_HID_COMMAND_GET_REPORT:
/* Send the requested report to the host. */
_ux_device_class_hid_report_get(hid, request_value, request_index, request_length);
break;
case UX_DEVICE_CLASS_HID_COMMAND_SET_REPORT:
/* Extract the descriptor type. */
descriptor_type = (request_value & 0xff00) >> 8;
/* Get the requested report from the host. */
_ux_device_class_hid_report_set(hid, descriptor_type, request_index, request_length);
break;
case UX_GET_DESCRIPTOR:
/* Send the requested descriptor to the host. */
_ux_device_class_hid_descriptor_send(hid, request_value, request_index, request_length);
break;
case UX_DEVICE_CLASS_HID_COMMAND_GET_IDLE:
case UX_DEVICE_CLASS_HID_COMMAND_SET_IDLE:
/* Ignore Report ID for now. */
if (request == UX_DEVICE_CLASS_HID_COMMAND_GET_IDLE)
{
/* Send the idle rate. */
*transfer_request -> ux_slave_transfer_request_data_pointer = (UCHAR)hid -> ux_device_class_hid_event_idle_rate;
_ux_device_stack_transfer_request(transfer_request, 1, request_length);
}
else
{
/* Accept the idle rate if it changes. */
if ((UCHAR)hid -> ux_device_class_hid_event_idle_rate != duration)
{
hid -> ux_device_class_hid_event_idle_rate = duration;
if (duration == 0)
{
/* No need to repeat last report, no timeout. */
hid -> ux_device_class_hid_event_wait_timeout = UX_WAIT_FOREVER;
}
else
{
/* Calculate the timeout value. Weighted as 4ms. */
hid -> ux_device_class_hid_event_wait_timeout = (ULONG)UX_MS_TO_TICK((ULONG)duration << 2u);
/* Be sure to have a timeout that is not zero. */
if (hid -> ux_device_class_hid_event_wait_timeout == 0)
hid -> ux_device_class_hid_event_wait_timeout ++;
#if defined(UX_DEVICE_STANDALONE)
/* Restart event checking if no transfer in progress. */
if (hid -> ux_device_class_hid_event_state != UX_STATE_WAIT)
hid -> ux_device_class_hid_event_state = UX_STATE_RESET;
#else
/* Set an event to wake up the interrupt thread. */
_ux_utility_event_flags_set(&hid -> ux_device_class_hid_event_flags_group, UX_DEVICE_CLASS_HID_NEW_IDLE_RATE, UX_OR);
#endif
}
}
}
break;
case UX_DEVICE_CLASS_HID_COMMAND_GET_PROTOCOL:
/* Send the protocol. */
*transfer_request -> ux_slave_transfer_request_data_pointer = (UCHAR)hid -> ux_device_class_hid_protocol;
_ux_device_stack_transfer_request(transfer_request, 1, request_length);
break;
case UX_DEVICE_CLASS_HID_COMMAND_SET_PROTOCOL:
/* Accept the protocol. */
hid -> ux_device_class_hid_protocol = request_value;
break;
default:
/* Unknown function. It's not handled. */
return(UX_ERROR);
}
/* It's handled. */
return(UX_SUCCESS);
}