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_get 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 to given buffer. */
45 /* Note high speed data size is 4 and full speed data size is 3 bytes. */
46 /* */
47 /* INPUT */
48 /* */
49 /* audio Pointer to audio class */
50 /* feedback Pointer to buffer to fill */
51 /* packed feedback data */
52 /* */
53 /* OUTPUT */
54 /* */
55 /* Completion Status */
56 /* */
57 /* CALLS */
58 /* */
59 /* */
60 /* CALLED BY */
61 /* */
62 /* Application */
63 /* */
64 /* RELEASE HISTORY */
65 /* */
66 /* DATE NAME DESCRIPTION */
67 /* */
68 /* 07-29-2022 Chaoqiong Xiao Initial Version 6.1.12 */
69 /* */
70 /**************************************************************************/
_ux_host_class_audio_feedback_get(UX_HOST_CLASS_AUDIO * audio,UCHAR * feedback)71 UINT _ux_host_class_audio_feedback_get(UX_HOST_CLASS_AUDIO *audio, UCHAR *feedback)
72 {
73 #if !defined(UX_HOST_CLASS_AUDIO_FEEDBACK_SUPPORT)
74 UX_PARAMETER_NOT_USED(audio);
75 UX_PARAMETER_NOT_USED(feedback);
76 return(UX_FUNCTION_NOT_SUPPORTED);
77 #else
78
79 /* Ensure the instance is valid. */
80 if (_ux_host_stack_class_instance_verify(_ux_system_host_class_audio_name, (VOID *) audio) != UX_SUCCESS)
81 {
82
83 /* Error trap. */
84 _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_HOST_CLASS_INSTANCE_UNKNOWN);
85
86 /* If trace is enabled, insert this event into the trace buffer. */
87 UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_HOST_CLASS_INSTANCE_UNKNOWN, audio, 0, 0, UX_TRACE_ERRORS, 0, 0)
88
89 return(UX_HOST_CLASS_INSTANCE_UNKNOWN);
90 }
91
92 feedback[0] = audio -> ux_host_class_audio_feedback_buffer[0];
93 feedback[1] = audio -> ux_host_class_audio_feedback_buffer[1];
94 feedback[2] = audio -> ux_host_class_audio_feedback_buffer[2];
95 if (_ux_host_class_audio_speed_get(audio) == UX_HIGH_SPEED_DEVICE)
96 feedback[3] = audio -> ux_host_class_audio_feedback_buffer[3];
97 return(UX_SUCCESS);
98 #endif
99 }
100
101
102 /**************************************************************************/
103 /* */
104 /* FUNCTION RELEASE */
105 /* */
106 /* _uxe_host_class_audio_feedback_get PORTABLE C */
107 /* 6.3.0 */
108 /* AUTHOR */
109 /* */
110 /* Chaoqiong Xiao, Microsoft Corporation */
111 /* */
112 /* DESCRIPTION */
113 /* */
114 /* This function checks errors in audio feedback get function call. */
115 /* */
116 /* INPUT */
117 /* */
118 /* audio Pointer to audio class */
119 /* feedback Pointer to buffer to fill */
120 /* packed feedback data */
121 /* */
122 /* OUTPUT */
123 /* */
124 /* Status */
125 /* */
126 /* CALLS */
127 /* */
128 /* _uxe_host_class_audio_feedback_get Get audio feedback */
129 /* */
130 /* CALLED BY */
131 /* */
132 /* Application */
133 /* */
134 /* RELEASE HISTORY */
135 /* */
136 /* DATE NAME DESCRIPTION */
137 /* */
138 /* 10-31-2023 Chaoqiong Xiao Initial Version 6.3.0 */
139 /* */
140 /**************************************************************************/
_uxe_host_class_audio_feedback_get(UX_HOST_CLASS_AUDIO * audio,UCHAR * feedback)141 UINT _uxe_host_class_audio_feedback_get(UX_HOST_CLASS_AUDIO *audio, UCHAR *feedback)
142 {
143
144 /* Sanity checks. */
145 if ((audio == UX_NULL) || (feedback == UX_NULL))
146 return(UX_INVALID_PARAMETER);
147
148 /* Invoke audio feedback get function. */
149 return(_ux_host_class_audio_feedback_get(audio, feedback));
150 }
151
