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
|
/***************************************************************************
* 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_event_set PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function sends an event to the hid class. It is processed */
/* asynchronously by the interrupt thread. */
/* */
/* INPUT */
/* */
/* hid Address of hid class */
/* event Pointer of the event */
/* */
/* OUTPUT */
/* */
/* status UX_SUCCESS if there is an */
/* event */
/* CALLS */
/* */
/* _ux_utility_memory_copy Copy memory */
/* _ux_device_event_flags_set Set event flags */
/* */
/* CALLED BY */
/* */
/* ThreadX */
/* */
/**************************************************************************/
UINT _ux_device_class_hid_event_set(UX_SLAVE_CLASS_HID *hid,
UX_SLAVE_CLASS_HID_EVENT *hid_event)
{
UX_DEVICE_CLASS_HID_EVENT *current_hid_event;
UX_DEVICE_CLASS_HID_EVENT *next_hid_event;
UCHAR *next_position;
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_DEVICE_CLASS_HID_EVENT_SET, hid, hid_event, 0, 0, UX_TRACE_DEVICE_CLASS_EVENTS, 0, 0)
/* Current position of the head. */
current_hid_event = hid -> ux_device_class_hid_event_array_head;
/* If the pointer is NULL, the round robin buffer has not been activated. */
if (current_hid_event == UX_NULL)
return (UX_ERROR);
/* Calculate the next position. */
next_position = (UCHAR *)current_hid_event + UX_DEVICE_CLASS_HID_EVENT_QUEUE_ITEM_SIZE(hid);
if (next_position >= (UCHAR *)hid -> ux_device_class_hid_event_array_end)
next_position = (UCHAR *)hid -> ux_device_class_hid_event_array;
next_hid_event = (UX_DEVICE_CLASS_HID_EVENT *)next_position;
/* Any place left for this event ? */
if (next_hid_event == hid -> ux_device_class_hid_event_array_tail)
return (UX_ERROR);
/* There is an event to report, get the current pointer to the event. */
current_hid_event = hid -> ux_device_class_hid_event_array_head;
/* Update the head. */
hid -> ux_device_class_hid_event_array_head = next_hid_event;
/* Check if this event has a report ID. */
if (hid -> ux_device_class_hid_report_id == UX_TRUE)
{
/* Yes, there's a report ID. Check to see if our event buffer can also
fit the extra byte. */
if (hid_event -> ux_device_class_hid_event_length + 1 > UX_DEVICE_CLASS_HID_EVENT_MAX_LENGTH(hid))
{
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_MEMORY_INSUFFICIENT);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_MEMORY_INSUFFICIENT, 0, 0, 0, UX_TRACE_ERRORS, 0, 0)
/* Return overflow error. */
return(UX_MEMORY_INSUFFICIENT);
}
/* Store the report ID. */
*UX_DEVICE_CLASS_HID_EVENT_BUFFER(current_hid_event) = (UCHAR)(hid_event -> ux_device_class_hid_event_report_id);
/* Store the data itself. */
_ux_utility_memory_copy(UX_DEVICE_CLASS_HID_EVENT_BUFFER(current_hid_event) + 1,
hid_event -> ux_device_class_hid_event_buffer,
hid_event -> ux_device_class_hid_event_length); /* Use case of memcpy is verified. */
/* fill in the event structure from the user. */
current_hid_event -> ux_device_class_hid_event_length = hid_event -> ux_device_class_hid_event_length + 1;
}
else
{
/* No report ID to consider. */
/* Store copy of data so application can free event there (easier use). */
_ux_utility_memory_copy(UX_DEVICE_CLASS_HID_EVENT_BUFFER(current_hid_event),
hid_event -> ux_device_class_hid_event_buffer,
hid_event -> ux_device_class_hid_event_length); /* Use case of memcpy is verified. */
/* fill in the event structure from the user. */
current_hid_event -> ux_device_class_hid_event_length = hid_event -> ux_device_class_hid_event_length;
}
#if defined(UX_DEVICE_STANDALONE)
/* Set state machine to start sending if no transfer on going. */
if (hid -> ux_device_class_hid_event_state != UX_STATE_WAIT &&
hid -> ux_device_class_hid_event_state != UX_STATE_EXIT)
hid -> ux_device_class_hid_event_state = UX_STATE_RESET;
#else
/* Set an event to wake up the interrupt thread. */
_ux_device_event_flags_set(&hid -> ux_device_class_hid_event_flags_group, UX_DEVICE_CLASS_HID_NEW_EVENT, UX_OR);
#endif
/* Return event status to the user. */
return(UX_SUCCESS);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _uxe_device_class_hid_event_set PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function checks errors in HID event set function call. */
/* */
/* INPUT */
/* */
/* hid Pointer to hid instance */
/* hid_event Pointer to hid event */
/* */
/* OUTPUT */
/* */
/* None */
/* */
/* CALLS */
/* */
/* _ux_device_class_hid_event_set Set an HID event */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/**************************************************************************/
UINT _uxe_device_class_hid_event_set(UX_SLAVE_CLASS_HID *hid,
UX_SLAVE_CLASS_HID_EVENT *hid_event)
{
/* Sanity checks. */
if ((hid == UX_NULL) || (hid_event == UX_NULL))
return(UX_INVALID_PARAMETER);
/* Invoke function to get event. */
return(_ux_device_class_hid_event_set(hid, hid_event));
}
|
