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
|
/***************************************************************************
* Copyright (c) 2025-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 */
/** */
/** Host 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_protocol_get PORTABLE C */
/* */
/* DESCRIPTION */
/* */
/* This function performs a GET_PROTOCOL to the HID device to read */
/* current protocol (BOOT=0 or REPORT=1). */
/* */
/* INPUT */
/* */
/* hid Pointer to HID class */
/* protocol Destination for protocol */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/**************************************************************************/
UINT _ux_host_class_hid_protocol_get(UX_HOST_CLASS_HID *hid, USHORT *protocol)
{
#if defined(UX_HOST_STANDALONE)
UX_INTERRUPT_SAVE_AREA
#endif
UX_ENDPOINT *control_endpoint;
UX_TRANSFER *transfer_request;
UCHAR *protocol_byte;
UINT status;
/* 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)
#if defined(UX_HOST_STANDALONE)
hid -> ux_host_class_hid_status = UX_HOST_CLASS_INSTANCE_UNKNOWN;
#endif
return(UX_HOST_CLASS_INSTANCE_UNKNOWN);
}
/* Initialize output to a known value. */
*protocol = 0;
/* Get the default control endpoint transfer request pointer. */
control_endpoint = &hid -> ux_host_class_hid_device -> ux_device_control_endpoint;
transfer_request = &control_endpoint -> ux_endpoint_transfer_request;
/* Protect thread reentry to this instance. */
#if defined(UX_HOST_STANDALONE)
UX_DISABLE
if (hid -> ux_host_class_hid_flags & UX_HOST_CLASS_HID_FLAG_LOCK)
{
UX_RESTORE
return(UX_BUSY);
}
hid -> ux_host_class_hid_flags |= UX_HOST_CLASS_HID_FLAG_LOCK;
UX_RESTORE
#else
status = _ux_host_semaphore_get(&hid -> ux_host_class_hid_semaphore, UX_WAIT_FOREVER);
if (status != UX_SUCCESS)
return(status);
#endif
/* Need to allocate a cache-safe buffer for the DMA transfer. */
protocol_byte = _ux_utility_memory_allocate(UX_SAFE_ALIGN, UX_CACHE_SAFE_MEMORY, 1);
if (protocol_byte == UX_NULL)
{
/* Unprotect thread reentry to this instance. */
#if defined(UX_HOST_STANDALONE)
_ux_host_class_hid_unlock(hid);
#else
_ux_host_semaphore_put(&hid -> ux_host_class_hid_semaphore);
#endif
return(UX_MEMORY_INSUFFICIENT);
}
/* Protect the control endpoint. It will be unprotected in the transfer request function. */
#if defined(UX_HOST_STANDALONE)
UX_DISABLE
if (hid -> ux_host_class_hid_device -> ux_device_flags & UX_DEVICE_FLAG_LOCK)
{
_ux_utility_memory_free(protocol_byte);
_ux_host_class_hid_unlock(hid);
UX_RESTORE
return(UX_BUSY);
}
hid -> ux_host_class_hid_device -> ux_device_flags |= UX_DEVICE_FLAG_LOCK;
transfer_request -> ux_transfer_request_flags |= UX_TRANSFER_FLAG_AUTO_DEVICE_UNLOCK;
UX_TRANSFER_STATE_RESET(transfer_request);
UX_RESTORE
#else
status = _ux_host_semaphore_get(&hid -> ux_host_class_hid_device -> ux_device_protection_semaphore, UX_WAIT_FOREVER);
if (status != UX_SUCCESS)
{
_ux_utility_memory_free(protocol_byte);
_ux_host_semaphore_put(&hid -> ux_host_class_hid_semaphore);
return(status);
}
#endif
/* Create a transfer request for the GET_PROTOCOL request. */
transfer_request -> ux_transfer_request_data_pointer = protocol_byte;
transfer_request -> ux_transfer_request_requested_length = 1;
transfer_request -> ux_transfer_request_function = UX_HOST_CLASS_HID_GET_PROTOCOL;
transfer_request -> ux_transfer_request_type = UX_REQUEST_IN | UX_REQUEST_TYPE_CLASS | UX_REQUEST_TARGET_INTERFACE;
transfer_request -> ux_transfer_request_value = 0;
transfer_request -> ux_transfer_request_index = hid -> ux_host_class_hid_interface -> ux_interface_descriptor.bInterfaceNumber;
/* Send request to HCD layer. */
status = _ux_host_stack_transfer_request(transfer_request);
#if defined(UX_HOST_STANDALONE)
if (!(transfer_request -> ux_transfer_request_flags & UX_TRANSFER_FLAG_AUTO_WAIT))
{
hid -> ux_host_class_hid_allocated = protocol_byte;
return(status);
}
#endif
/* Check for correct transfer and for the entire protocol byte returned. */
if (status == UX_SUCCESS && transfer_request -> ux_transfer_request_actual_length == 1)
*protocol = (USHORT) *protocol_byte;
/* Free the allocated buffer. */
_ux_utility_memory_free(protocol_byte);
/* Unprotect thread reentry to this instance. */
#if defined(UX_HOST_STANDALONE)
_ux_host_class_hid_unlock(hid);
#else
_ux_host_semaphore_put(&hid -> ux_host_class_hid_semaphore);
#endif
return(status);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _uxe_host_class_hid_protocol_get PORTABLE C */
/* */
/* DESCRIPTION */
/* */
/* This function checks errors in HID protocol get function call. */
/* */
/* INPUT */
/* */
/* hid Pointer to HID class */
/* protocol Destination for protocol */
/* */
/* OUTPUT */
/* */
/* Status */
/* */
/**************************************************************************/
UINT _uxe_host_class_hid_protocol_get(UX_HOST_CLASS_HID *hid, USHORT *protocol)
{
/* Sanity check. */
if (hid == UX_NULL || protocol == UX_NULL)
return(UX_INVALID_PARAMETER);
/* Invoke protocol get function. */
return(_ux_host_class_hid_protocol_get(hid, protocol));
}
|
