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
|
/***************************************************************************
* 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 */
/** */
/** 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_activate PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function activates an instance of a HID device. */
/* */
/* INPUT */
/* */
/* command Pointer to hid command */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_device_thread_resume Resume thread */
/* */
/* CALLED BY */
/* */
/* USBX Source Code */
/* */
/**************************************************************************/
UINT _ux_device_class_hid_activate(UX_SLAVE_CLASS_COMMAND *command)
{
UX_SLAVE_INTERFACE *interface_ptr;
UX_SLAVE_CLASS *class_ptr;
UX_SLAVE_CLASS_HID *hid;
UX_SLAVE_ENDPOINT *endpoint_interrupt;
UX_SLAVE_ENDPOINT *endpoint_in = UX_NULL;
#if defined(UX_DEVICE_CLASS_HID_INTERRUPT_OUT_SUPPORT)
UX_SLAVE_ENDPOINT *endpoint_out = UX_NULL;
UCHAR *pos;
#endif
/* Get the class container. */
class_ptr = command -> ux_slave_class_command_class_ptr;
/* Get the class instance in the container. */
hid = (UX_SLAVE_CLASS_HID *) class_ptr -> ux_slave_class_instance;
/* Get the interface that owns this instance. */
interface_ptr = (UX_SLAVE_INTERFACE *) command -> ux_slave_class_command_interface;
/* Store the class instance into the interface. */
interface_ptr -> ux_slave_interface_class_instance = (VOID *)hid;
/* Now the opposite, store the interface in the class instance. */
hid -> ux_slave_class_hid_interface = interface_ptr;
/* Locate the endpoints. */
endpoint_interrupt = interface_ptr -> ux_slave_interface_first_endpoint;
/* Check if interrupt IN endpoint exists. */
while (endpoint_interrupt != UX_NULL)
{
if ((endpoint_interrupt -> ux_slave_endpoint_descriptor.bmAttributes &
UX_MASK_ENDPOINT_TYPE) == UX_INTERRUPT_ENDPOINT)
{
if ((endpoint_interrupt -> ux_slave_endpoint_descriptor.bEndpointAddress &
UX_ENDPOINT_DIRECTION) == UX_ENDPOINT_IN)
{
/* It's interrupt IN endpoint we need. */
endpoint_in = endpoint_interrupt;
#if defined(UX_DEVICE_CLASS_HID_OWN_ENDPOINT_BUFFER)
/* Set endpoint buffer owner to class instance. */
endpoint_in -> ux_slave_endpoint_transfer_request.
ux_slave_transfer_request_data_pointer =
UX_DEVICE_CLASS_HID_INTERRUPTIN_BUFFER(hid);
#endif
#if defined(UX_DEVICE_CLASS_HID_INTERRUPT_OUT_SUPPORT)
if (endpoint_out != UX_NULL)
#endif
break;
}
#if defined(UX_DEVICE_CLASS_HID_INTERRUPT_OUT_SUPPORT)
else
{
/* It's optional interrupt OUT endpoint. */
endpoint_out = endpoint_interrupt;
#if defined(UX_DEVICE_CLASS_HID_OWN_ENDPOINT_BUFFER)
/* Set endpoint buffer owner to class instance. */
endpoint_out -> ux_slave_endpoint_transfer_request.
ux_slave_transfer_request_data_pointer =
UX_DEVICE_CLASS_HID_INTERRUPTOUT_BUFFER(hid);
#endif
if (endpoint_in != UX_NULL)
break;
}
#endif
}
/* Try next endpoint. */
endpoint_interrupt = endpoint_interrupt -> ux_slave_endpoint_next_endpoint;
}
/* Check if we found right endpoint. */
if (endpoint_in == UX_NULL)
return (UX_ERROR);
/* Validate event buffer size (fits largest transfer payload size). */
UX_ASSERT(UX_DEVICE_CLASS_HID_EVENT_BUFFER_LENGTH >=
endpoint_in -> ux_slave_endpoint_transfer_request.
ux_slave_transfer_request_transfer_length);
/* Default HID protocol is report protocol. */
hid -> ux_device_class_hid_protocol = UX_DEVICE_CLASS_HID_PROTOCOL_REPORT;
/* Save the endpoints in the hid instance. */
hid -> ux_device_class_hid_interrupt_endpoint = endpoint_in;
#if defined(UX_DEVICE_CLASS_HID_INTERRUPT_OUT_SUPPORT)
/* Save endpoint OUT. */
hid -> ux_device_class_hid_read_endpoint = endpoint_out;
/* Resume receiver thread/task (if present). */
if (hid -> ux_device_class_hid_receiver && endpoint_out)
{
/* Reset events. */
hid -> ux_device_class_hid_receiver -> ux_device_class_hid_receiver_event_save_pos =
hid -> ux_device_class_hid_receiver -> ux_device_class_hid_receiver_events;
hid -> ux_device_class_hid_receiver -> ux_device_class_hid_receiver_event_read_pos =
hid -> ux_device_class_hid_receiver -> ux_device_class_hid_receiver_events;
for (pos = (UCHAR*)hid -> ux_device_class_hid_receiver -> ux_device_class_hid_receiver_events;
pos < (UCHAR*)hid -> ux_device_class_hid_receiver -> ux_device_class_hid_receiver_events_end;
pos += UX_DEVICE_CLASS_HID_RECEIVED_QUEUE_ITEM_SIZE(hid -> ux_device_class_hid_receiver))
{
((UX_DEVICE_CLASS_HID_RECEIVED_EVENT*)pos) -> ux_device_class_hid_received_event_length = 0;
}
#if !defined(UX_DEVICE_STANDALONE)
/* Resume thread. */
_ux_utility_thread_resume(&hid -> ux_device_class_hid_receiver -> ux_device_class_hid_receiver_thread);
#else
/* Setup read state for receiver. */
hid -> ux_device_class_hid_read_state = UX_DEVICE_CLASS_HID_RECEIVER_START;
#endif
}
#endif
#if !defined(UX_DEVICE_STANDALONE)
/* Resume thread. */
_ux_device_thread_resume(&class_ptr -> ux_slave_class_thread);
#else
/* Reset event buffered for background transfer. */
_ux_utility_memory_set((VOID *)&hid -> ux_device_class_hid_event, 0,
sizeof(UX_DEVICE_CLASS_HID_EVENT)); /* Use case of memset is verified. */
hid -> ux_device_class_hid_event.ux_device_class_hid_event_length =
endpoint_in -> ux_slave_endpoint_transfer_request.
ux_slave_transfer_request_transfer_length;
/* Reset event sending state. */
hid -> ux_device_class_hid_event_state = UX_STATE_RESET;
#endif
/* If there is a activate function call it. */
if (hid -> ux_slave_class_hid_instance_activate != UX_NULL)
{
/* Invoke the application. */
hid -> ux_slave_class_hid_instance_activate(hid);
}
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_DEVICE_CLASS_HID_ACTIVATE, hid, 0, 0, 0, UX_TRACE_DEVICE_CLASS_EVENTS, 0, 0)
/* If trace is enabled, register this object. */
UX_TRACE_OBJECT_REGISTER(UX_TRACE_DEVICE_OBJECT_TYPE_INTERFACE, hid, 0, 0, 0)
/* Return completion status. */
return(UX_SUCCESS);
}
|
