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
|
/***************************************************************************
* Copyright (c) 2024 Microsoft Corporation
* Copyright (c) 2026-present Eclipse ThreadX contributors
*
* This program and the accompanying materials are made available under the
* terms of the MIT License which is available at
* https://opensource.org/licenses/MIT.
*
* SPDX-License-Identifier: MIT
**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** 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"
#if defined(UX_HOST_STANDALONE)
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_host_class_hid_idle_set_run PORTABLE C */
/* 6.1.10 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function performs a SET_IDLE to the HID device. */
/* */
/* It's for standalone mode. */
/* */
/* INPUT */
/* */
/* hid Pointer to HID class */
/* idle_time Idle time */
/* report_id Report ID */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_host_stack_class_instance_verify Verify instance is valid */
/* _ux_host_stack_transfer_run Process transfer states */
/* */
/* CALLED BY */
/* */
/* HID Class */
/* */
/**************************************************************************/
UINT _ux_host_class_hid_idle_set_run(UX_HOST_CLASS_HID *hid, USHORT idle_time, USHORT report_id)
{
UX_INTERRUPT_SAVE_AREA
UX_DEVICE *device;
UX_ENDPOINT *control_endpoint;
UX_TRANSFER *transfer_request;
UINT status;
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_CLASS_HID_IDLE_SET, hid, 0, 0, 0, UX_TRACE_HOST_CLASS_EVENTS, 0, 0)
/* Ensure the instance is valid. */
if (_ux_host_stack_class_instance_verify(_ux_system_host_class_hid_name, (VOID *) hid) != UX_SUCCESS)
{
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_HOST_CLASS_INSTANCE_UNKNOWN, hid, 0, 0, UX_TRACE_ERRORS, 0, 0)
hid -> ux_host_class_hid_status = UX_HOST_CLASS_INSTANCE_UNKNOWN;
return(UX_STATE_EXIT);
}
/* Get device. */
device = hid -> ux_host_class_hid_device;
/* Sanity check. */
if (device == UX_NULL ||
device -> ux_device_handle != (ULONG)(ALIGN_TYPE)device)
{
hid -> ux_host_class_hid_status = UX_DEVICE_HANDLE_UNKNOWN;
return(UX_STATE_EXIT);
}
/* We need to get the default control endpoint transfer request pointer. */
control_endpoint = &device -> ux_device_control_endpoint;
transfer_request = &control_endpoint -> ux_endpoint_transfer_request;
/* Waiting transfer done. */
if (hid -> ux_host_class_hid_cmd_state == UX_STATE_WAIT)
{
/* Process background tasks. */
_ux_system_tasks_run();
/* Check if transfer is done. */
if (transfer_request -> ux_transfer_request_state < UX_STATE_WAIT)
{
/* Unlock. */
hid -> ux_host_class_hid_flags &= ~UX_HOST_CLASS_HID_FLAG_LOCK;
device -> ux_device_flags &= ~UX_DEVICE_FLAG_LOCK;
/* We are done. */
hid -> ux_host_class_hid_cmd_state = UX_STATE_IDLE;
hid -> ux_host_class_hid_status =
transfer_request -> ux_transfer_request_completion_code;
return(UX_STATE_NEXT);
}
/* Keep waiting. */
return(UX_STATE_WAIT);
}
/* Check state or protection status. */
UX_DISABLE
if ((hid -> ux_host_class_hid_flags & UX_HOST_CLASS_HID_FLAG_LOCK) ||
(device -> ux_device_flags & UX_DEVICE_FLAG_LOCK))
{
/* Locked. */
UX_RESTORE
return(UX_STATE_LOCK);
}
hid -> ux_host_class_hid_flags |= UX_HOST_CLASS_HID_FLAG_LOCK;
device -> ux_device_flags |= UX_DEVICE_FLAG_LOCK;
hid -> ux_host_class_hid_cmd_state = UX_STATE_WAIT;
UX_RESTORE
/* Create a transfer request for the SET_IDLE request. */
transfer_request -> ux_transfer_request_data_pointer = UX_NULL;
transfer_request -> ux_transfer_request_requested_length = 0;
transfer_request -> ux_transfer_request_function = UX_HOST_CLASS_HID_SET_IDLE;
transfer_request -> ux_transfer_request_type = UX_REQUEST_OUT | UX_REQUEST_TYPE_CLASS | UX_REQUEST_TARGET_INTERFACE;
transfer_request -> ux_transfer_request_value = (UINT)((idle_time << 8) | report_id);
transfer_request -> ux_transfer_request_index = hid -> ux_host_class_hid_interface -> ux_interface_descriptor.bInterfaceNumber;
UX_TRANSFER_STATE_RESET(transfer_request);
/* Send request to HCD layer. */
status = _ux_host_stack_transfer_run(transfer_request);
if (status != UX_STATE_WAIT)
{
hid -> ux_host_class_hid_status =
transfer_request -> ux_transfer_request_completion_code;
/* Unlock. */
hid -> ux_host_class_hid_flags &= ~UX_HOST_CLASS_HID_FLAG_LOCK;
device -> ux_device_flags &= ~UX_DEVICE_FLAG_LOCK;
hid -> ux_host_class_hid_cmd_state = (UCHAR)status;
}
/* Return the function status. */
return(status);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _uxe_host_class_hid_idle_set_run PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function checks errors in HID idle set function call. */
/* */
/* INPUT */
/* */
/* hid Pointer to HID class */
/* idle_time Idle time */
/* report_id Report ID */
/* */
/* OUTPUT */
/* */
/* Status */
/* */
/* CALLS */
/* */
/* _ux_host_class_hid_idle_set_run Get idle rate */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/**************************************************************************/
UINT _uxe_host_class_hid_idle_set_run(UX_HOST_CLASS_HID *hid, USHORT idle_time, USHORT report_id)
{
/* Sanity check. */
if (hid == UX_NULL)
return(UX_STATE_ERROR);
/* Invoke idle set function. */
return(_ux_host_class_hid_idle_set_run(hid, idle_time, report_id));
}
#endif
|
