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 /** */
15 /** USBX Component */
16 /** */
17 /** Audio Class */
18 /** */
19 /**************************************************************************/
20 /**************************************************************************/
21
22
23 /* Include necessary system files. */
24
25 #define UX_SOURCE_CODE
26
27 #include "ux_api.h"
28 #include "ux_host_class_audio.h"
29 #include "ux_host_stack.h"
30
31
32 /**************************************************************************/
33 /* */
34 /* FUNCTION RELEASE */
35 /* */
36 /* _ux_host_class_audio_feedback_set PORTABLE C */
37 /* 6.1.12 */
38 /* AUTHOR */
39 /* */
40 /* Chaoqiong Xiao, Microsoft Corporation */
41 /* */
42 /* DESCRIPTION */
43 /* */
44 /* This function copies packed feedback data from given buffer. */
45 /* Note high speed data size is 4 and full speed data size is 3 bytes. */
46 /* */
47 /* Note if feedback is supported this function can work even there is */
48 /* no interface alternate setting selected. This way the default */
49 /* feedback data can be set before streaming starts. */
50 /* */
51 /* INPUT */
52 /* */
53 /* audio Pointer to audio class */
54 /* feedback Pointer to packed feedback */
55 /* data to copy */
56 /* */
57 /* OUTPUT */
58 /* */
59 /* Completion Status */
60 /* */
61 /* CALLS */
62 /* */
63 /* */
64 /* CALLED BY */
65 /* */
66 /* Application */
67 /* */
68 /* RELEASE HISTORY */
69 /* */
70 /* DATE NAME DESCRIPTION */
71 /* */
72 /* 07-29-2022 Chaoqiong Xiao Initial Version 6.1.12 */
73 /* */
74 /**************************************************************************/
_ux_host_class_audio_feedback_set(UX_HOST_CLASS_AUDIO * audio,UCHAR * feedback)75 UINT _ux_host_class_audio_feedback_set(UX_HOST_CLASS_AUDIO *audio, UCHAR *feedback)
76 {
77 #if !defined(UX_HOST_CLASS_AUDIO_FEEDBACK_SUPPORT)
78 UX_PARAMETER_NOT_USED(audio);
79 UX_PARAMETER_NOT_USED(feedback);
80 return(UX_FUNCTION_NOT_SUPPORTED);
81 #else
82 UX_ENDPOINT *endpoint;
83 UX_TRANSFER *transfer;
84
85 /* Ensure the instance is valid. */
86 if (_ux_host_stack_class_instance_verify(_ux_system_host_class_audio_name, (VOID *) audio) != UX_SUCCESS)
87 {
88
89 /* Error trap. */
90 _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_HOST_CLASS_INSTANCE_UNKNOWN);
91
92 /* If trace is enabled, insert this event into the trace buffer. */
93 UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_HOST_CLASS_INSTANCE_UNKNOWN, audio, 0, 0, UX_TRACE_ERRORS, 0, 0)
94
95 return(UX_HOST_CLASS_INSTANCE_UNKNOWN);
96 }
97
98 audio -> ux_host_class_audio_feedback_buffer[0] = feedback[0];
99 audio -> ux_host_class_audio_feedback_buffer[1] = feedback[1];
100 audio -> ux_host_class_audio_feedback_buffer[2] = feedback[2];
101 if (_ux_host_class_audio_speed_get(audio) == UX_HIGH_SPEED_DEVICE)
102 audio -> ux_host_class_audio_feedback_buffer[3] = feedback[3];
103
104 /* Sync with transfer buffer. */
105 endpoint = audio -> ux_host_class_audio_feedback_endpoint;
106 if (endpoint)
107 {
108 transfer = &endpoint -> ux_endpoint_transfer_request;
109 _ux_utility_memory_copy(transfer -> ux_transfer_request_data_pointer,
110 audio -> ux_host_class_audio_feedback_buffer,
111 sizeof(audio -> ux_host_class_audio_feedback_buffer)); /* Use case of memcpy is verified. */
112 }
113
114 return(UX_SUCCESS);
115 #endif
116 }
117
118
119 /**************************************************************************/
120 /* */
121 /* FUNCTION RELEASE */
122 /* */
123 /* _uxe_host_class_audio_feedback_set PORTABLE C */
124 /* 6.3.0 */
125 /* AUTHOR */
126 /* */
127 /* Chaoqiong Xiao, Microsoft Corporation */
128 /* */
129 /* DESCRIPTION */
130 /* */
131 /* This function checks errors in audio feedback set function call. */
132 /* */
133 /* INPUT */
134 /* */
135 /* audio Pointer to audio class */
136 /* feedback Pointer to buffer to fill */
137 /* packed feedback data */
138 /* */
139 /* OUTPUT */
140 /* */
141 /* Status */
142 /* */
143 /* CALLS */
144 /* */
145 /* _uxe_host_class_audio_feedback_set Set audio feedback */
146 /* */
147 /* CALLED BY */
148 /* */
149 /* Application */
150 /* */
151 /* RELEASE HISTORY */
152 /* */
153 /* DATE NAME DESCRIPTION */
154 /* */
155 /* 10-31-2023 Chaoqiong Xiao Initial Version 6.3.0 */
156 /* */
157 /**************************************************************************/
_uxe_host_class_audio_feedback_set(UX_HOST_CLASS_AUDIO * audio,UCHAR * feedback)158 UINT _uxe_host_class_audio_feedback_set(UX_HOST_CLASS_AUDIO *audio, UCHAR *feedback)
159 {
160
161 /* Sanity checks. */
162 if ((audio == UX_NULL) || (feedback == UX_NULL))
163 return(UX_INVALID_PARAMETER);
164
165 /* Invoke audio feedback set function. */
166 return(_ux_host_class_audio_feedback_set(audio, feedback));
167 }
168
