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
/**************************************************************************/
/* */
/* 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 */
/** */
/** Device Stack */
/** */
/**************************************************************************/
/**************************************************************************/
#define UX_SOURCE_CODE
/* Include necessary system files. */
#include "ux_api.h"
#include "ux_device_stack.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_device_stack_class_unregister PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function unregisters a slave class to the slave stack. */
/* */
/* 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_function_entry Class entry function */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_utility_string_length_check Check C string and return */
/* its length if null-terminated */
/* _ux_utility_memory_compare Memory compare */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/* 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, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _ux_device_stack_class_unregister(UCHAR *class_name,
UINT (*class_entry_function)(struct UX_SLAVE_CLASS_COMMAND_STRUCT *))
{
UX_SLAVE_CLASS *class_inst;
UINT status;
UX_SLAVE_CLASS_COMMAND command;
#if !defined(UX_NAME_REFERENCED_BY_POINTER)
UINT class_name_length = 0;
#endif
#if UX_MAX_SLAVE_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_DEVICE_STACK_CLASS_UNREGISTER, class_name, 0, 0, 0, UX_TRACE_DEVICE_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
class_inst = _ux_system_slave -> ux_system_slave_class_array;
#if UX_MAX_SLAVE_CLASS_DRIVER > 1
/* We need to parse the class table to find the right class. */
for (class_index = 0; class_index < _ux_system_slave -> ux_system_slave_max_class; class_index++)
{
#endif
/* Check if this class is the right one. */
if (class_inst -> ux_slave_class_status == UX_USED)
{
/* We have found a used container with a class. Compare the name (include null-terminator). */
if (ux_utility_name_match(class_inst -> ux_slave_class_name, class_name, class_name_length + 1))
{
/* Build all the fields of the Class Command to uninitialize the class. */
command.ux_slave_class_command_request = UX_SLAVE_CLASS_COMMAND_UNINITIALIZE;
command.ux_slave_class_command_class_ptr = class_inst;
/* Call the class uninitialization routine. */
status = class_entry_function(&command);
/* Check the status. */
if (status != UX_SUCCESS)
return(status);
/* Make this class unused now. */
class_inst -> ux_slave_class_status = UX_UNUSED;
/* Erase the instance of the class. */
class_inst -> ux_slave_class_instance = UX_NULL;
/* Return successful completion. */
return(UX_SUCCESS);
}
}
#if UX_MAX_SLAVE_CLASS_DRIVER > 1
/* Move to the next class. */
class_inst ++;
}
#endif
/* No class match. */
return(UX_NO_CLASS_MATCH);
}