1 /***************************************************************************
2 * Copyright (c) 2024 Microsoft Corporation
3 *
4 * This program and the accompanying materials are made available under the
5 * terms of the MIT License which is available at
6 * https://opensource.org/licenses/MIT.
7 *
8 * SPDX-License-Identifier: MIT
9 **************************************************************************/
10
11 /**************************************************************************/
12 /**************************************************************************/
13 /** */
14 /** USBX Component */
15 /** */
16 /** Device Audio Class */
17 /** */
18 /**************************************************************************/
19 /**************************************************************************/
20
21 #define UX_SOURCE_CODE
22
23
24 /* Include necessary system files. */
25
26 #include "ux_api.h"
27 #include "ux_device_class_audio.h"
28 #include "ux_device_stack.h"
29
30
31 /**************************************************************************/
32 /* */
33 /* FUNCTION RELEASE */
34 /* */
35 /* _ux_device_class_audio_uninitialize PORTABLE C */
36 /* 6.3.0 */
37 /* AUTHOR */
38 /* */
39 /* Chaoqiong Xiao, Microsoft Corporation */
40 /* */
41 /* DESCRIPTION */
42 /* */
43 /* This function uninitialize the Audio class. */
44 /* */
45 /* INPUT */
46 /* */
47 /* command Pointer to a class command */
48 /* */
49 /* OUTPUT */
50 /* */
51 /* Completion Status */
52 /* */
53 /* CALLS */
54 /* */
55 /* _ux_device_thread_delete Delete thread used */
56 /* _ux_utility_memory_free Free used local memory */
57 /* */
58 /* CALLED BY */
59 /* */
60 /* Device Audio Class */
61 /* */
62 /* RELEASE HISTORY */
63 /* */
64 /* DATE NAME DESCRIPTION */
65 /* */
66 /* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */
67 /* 09-30-2020 Chaoqiong Xiao Modified comment(s), */
68 /* resulting in version 6.1 */
69 /* 01-31-2022 Chaoqiong Xiao Modified comment(s), */
70 /* refined macros names, */
71 /* added feedback support, */
72 /* fixed stream uninitialize, */
73 /* resulting in version 6.1.10 */
74 /* 04-25-2022 Chaoqiong Xiao Modified comment(s), */
75 /* fixed standalone compile, */
76 /* resulting in version 6.1.11 */
77 /* 10-31-2023 Chaoqiong Xiao Modified comment(s), */
78 /* added a new mode to manage */
79 /* endpoint buffer in classes */
80 /* with zero copy enabled, */
81 /* resulting in version 6.3.0 */
82 /* */
83 /**************************************************************************/
_ux_device_class_audio_uninitialize(UX_SLAVE_CLASS_COMMAND * command)84 UINT _ux_device_class_audio_uninitialize(UX_SLAVE_CLASS_COMMAND *command)
85 {
86
87 UX_DEVICE_CLASS_AUDIO *audio;
88 UX_DEVICE_CLASS_AUDIO_STREAM *stream;
89 UX_SLAVE_CLASS *audio_class;
90 ULONG i;
91
92
93 /* Get the class container. */
94 audio_class = command -> ux_slave_class_command_class_ptr;
95
96 /* Get the class instance in the container. */
97 audio = (UX_DEVICE_CLASS_AUDIO *) audio_class -> ux_slave_class_instance;
98
99 /* Sanity check. */
100 if (audio != UX_NULL)
101 {
102
103 /* Free the stream resources. */
104 stream = (UX_DEVICE_CLASS_AUDIO_STREAM *)((UCHAR *)audio + sizeof(UX_DEVICE_CLASS_AUDIO));
105 for (i = 0; i < audio -> ux_device_class_audio_streams_nb; i ++)
106 {
107 #if !defined(UX_DEVICE_STANDALONE)
108 _ux_device_thread_delete(&stream -> ux_device_class_audio_stream_thread);
109 #if defined(UX_DEVICE_CLASS_AUDIO_FEEDBACK_SUPPORT)
110 if (stream -> ux_device_class_audio_stream_feedback_thread_stack)
111 {
112 _ux_device_thread_delete(&stream -> ux_device_class_audio_stream_feedback_thread);
113 _ux_utility_memory_free(stream -> ux_device_class_audio_stream_feedback_thread_stack);
114 }
115 #endif
116 _ux_utility_memory_free(stream -> ux_device_class_audio_stream_thread_stack);
117 #endif
118 _ux_utility_memory_free(stream -> ux_device_class_audio_stream_buffer);
119
120 #if UX_DEVICE_ENDPOINT_BUFFER_OWNER == 1
121 #if defined(UX_DEVICE_CLASS_AUDIO_FEEDBACK_SUPPORT)
122 _ux_utility_memory_free(stream -> ux_device_class_audio_stream_feedback_buffer);
123 #endif
124 #endif
125
126 /* Next stream instance. */
127 stream ++;
128 }
129
130 #if defined(UX_DEVICE_CLASS_AUDIO_INTERRUPT_SUPPORT)
131 #if UX_DEVICE_ENDPOINT_BUFFER_OWNER == 1
132 _ux_utility_memory_free(audio -> ux_device_class_audio_interrupt_buffer);
133 #endif
134 #if !defined(UX_DEVICE_STANDALONE)
135 _ux_device_thread_delete(&audio_class -> ux_slave_class_thread);
136 _ux_utility_memory_free(audio_class -> ux_slave_class_thread_stack);
137
138 _ux_device_semaphore_delete(&audio -> ux_device_class_audio_status_semaphore);
139 _ux_device_mutex_delete(&audio -> ux_device_class_audio_status_mutex);
140 #else
141 #endif
142 #endif
143
144 /* Free the audio instance with controls and streams. */
145 _ux_utility_memory_free(audio);
146 }
147
148 /* Return completion status. */
149 return(UX_SUCCESS);
150 }
151
