Outline ![]()
Files ![]()
loading...
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
/**************************************************************************/
/* */
/* 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 */
/** */
/** Host Stack */
/** */
/**************************************************************************/
/**************************************************************************/
/* Include necessary system files. */
#define UX_SOURCE_CODE
#include "ux_api.h"
#include "ux_host_stack.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_host_stack_class_register PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function registers a USB class to the USB stack. The Class */
/* must specify an entry point for the USB stack to send commands */
/* such as: */
/* */
/* UX_HOST_CLASS_COMMAND_QUERY */
/* UX_HOST_CLASS_COMMAND_ACTIVATE */
/* UX_HOST_CLASS_COMMAND_DESTROY */
/* */
/* Note: The C string of class_name must be NULL-terminated and the */
/* length of it (without the NULL-terminator itself) must be no larger */
/* than UX_MAX_CLASS_NAME_LENGTH. */
/* */
/* INPUT */
/* */
/* class_name Name of class */
/* class_entry_function Entry function of the class */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_utility_string_length_check Check C string and return */
/* length if null-terminated */
/* _ux_utility_memory_copy Copy memory block */
/* */
/* CALLED BY */
/* */
/* Application */
/* USBX Components */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */
/* 09-30-2020 Chaoqiong Xiao Modified comment(s), */
/* optimized based on compile */
/* definitions, verified */
/* memset and memcpy cases, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _ux_host_stack_class_register(UCHAR *class_name,
UINT (*class_entry_function)(struct UX_HOST_CLASS_COMMAND_STRUCT *))
{
UX_HOST_CLASS *class_inst;
#if !defined(UX_NAME_REFERENCED_BY_POINTER)
UINT status;
UINT class_name_length = 0;
#endif
#if UX_MAX_CLASS_DRIVER > 1
ULONG class_index;
#endif
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_STACK_CLASS_REGISTER, class_name, class_entry_function, 0, 0, UX_TRACE_HOST_STACK_EVENTS, 0, 0)
#if !defined(UX_NAME_REFERENCED_BY_POINTER)
/* Get the length of the class name (exclude null-terminator). */
status = _ux_utility_string_length_check(class_name, &class_name_length, UX_MAX_CLASS_NAME_LENGTH);
if (status)
return(status);
#endif
/* Get first class. */
class_inst = _ux_system_host -> ux_system_host_class_array;
#if UX_MAX_CLASS_DRIVER > 1
/* We need to parse the class table to find an empty spot. */
for (class_index = 0; class_index < _ux_system_host -> ux_system_host_max_class; class_index++)
{
#endif
/* Check if this class is already used. */
if (class_inst -> ux_host_class_status == UX_UNUSED)
{
#if defined(UX_NAME_REFERENCED_BY_POINTER)
class_inst -> ux_host_class_name = (const UCHAR *) class_name;
#else
/* We have found a free container for the class. Copy the name (with null-terminator). */
_ux_utility_memory_copy(class_inst -> ux_host_class_name, class_name, class_name_length + 1); /* Use case of memcpy is verified. */
#endif
/* Memorize the entry function of this class. */
class_inst -> ux_host_class_entry_function = class_entry_function;
/* Mark it as used. */
class_inst -> ux_host_class_status = UX_USED;
/* Return successful completion. */
return(UX_SUCCESS);
}
/* Do a sanity check to make sure the class is not already installed by
mistake. To verify this, we simple check for the class entry point. */
else
{
/* Check for an already installed class entry function. */
if(class_inst -> ux_host_class_entry_function == class_entry_function)
{
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_INIT, UX_HOST_CLASS_ALREADY_INSTALLED);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_HOST_CLASS_ALREADY_INSTALLED, class_name, 0, 0, UX_TRACE_ERRORS, 0, 0)
/* Yes, return an error. */
return(UX_HOST_CLASS_ALREADY_INSTALLED);
}
}
#if UX_MAX_CLASS_DRIVER > 1
/* Move to the next class. */
class_inst ++;
}
#endif
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_MEMORY_ARRAY_FULL, class_name, 0, 0, UX_TRACE_ERRORS, 0, 0)
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_INIT, UX_MEMORY_ARRAY_FULL);
/* No more entries in the class table. */
return(UX_MEMORY_ARRAY_FULL);
}