summaryrefslogtreecommitdiff
path: root/common/usbx_device_classes/src/ux_device_class_audio_interrupt_send.c
blob: 2d0d7ddf88c104db855298fb4af65a50f4e13454 (plain)
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
/***************************************************************************
 * Copyright (c) 2024 Microsoft Corporation
 * Copyright (c) 2026-present Eclipse ThreadX contributors
 *
 * This program and the accompanying materials are made available under the
 * terms of the MIT License which is available at
 * https://opensource.org/licenses/MIT.
 *
 * SPDX-License-Identifier: MIT
 **************************************************************************/

/**************************************************************************/
/**************************************************************************/
/**                                                                       */
/** USBX Component                                                        */
/**                                                                       */
/**   Device Audio Class                                                  */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/

#define UX_SOURCE_CODE


/* Include necessary system files.  */

#include "ux_api.h"
#include "ux_device_class_audio.h"
#include "ux_device_stack.h"


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _ux_device_class_audio_interrupt_send               PORTABLE C      */
/*                                                           6.2.0        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function queues audio interrupt data.                          */
/*                                                                        */
/*    Note the interrupt data size is predefined on initialization:       */
/*    - for Audio 1.0 interrupt status word is 2 bytes                    */
/*    - for Audio 2.0 interrupt data message is 6 bytes                   */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    audio                                 Address of audio instance     */
/*    int_data                              Interrupt data (2 or 6 bytes) */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    None                                                                */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Application                                                         */
/*                                                                        */
/**************************************************************************/
UINT    _ux_device_class_audio_interrupt_send(UX_DEVICE_CLASS_AUDIO *audio, UCHAR *int_data)
{
#if !defined(UX_DEVICE_CLASS_AUDIO_INTERRUPT_SUPPORT)
    UX_PARAMETER_NOT_USED(audio);
    UX_PARAMETER_NOT_USED(int_data);
    return(UX_FUNCTION_NOT_SUPPORTED);
#else

UX_SLAVE_DEVICE             *device;
UX_SLAVE_ENDPOINT           *endpoint;
UCHAR                       *buff, *end;
ULONG                       size;
ULONG                       i;

    /* Get the pointer to the device.  */
    device =  &_ux_system_slave -> ux_system_slave_device;

    /* As long as the device is in the CONFIGURED state.  */
    if (device -> ux_slave_device_state != UX_DEVICE_CONFIGURED)
    {

        /* Cannot proceed with command, the interface is down.  */
        return(UX_CONFIGURATION_HANDLE_UNKNOWN);
    }

    /* Check if endpoint is available.  */
    endpoint = audio -> ux_device_class_audio_interrupt;
    if (endpoint == UX_NULL)
        return(UX_FUNCTION_NOT_SUPPORTED);

    /* Get interrupt data size.  */
    size = audio -> ux_device_class_audio_status_size;

    /* Protect queue status.  */
    _ux_device_mutex_on(&audio -> ux_device_class_audio_status_mutex);

    /* Check if data exist.  */
    buff = audio -> ux_device_class_audio_status_tail;
    end = audio -> ux_device_class_audio_status_queue + audio -> ux_device_class_audio_status_queue_bytes;
    for (i = 0; i < audio -> ux_device_class_audio_status_queued; i += size)
    {

        /* Check if data match.  */
        if (_ux_utility_memory_compare(buff, int_data, size) == UX_SUCCESS)
        {

            /* Already queued.  */
            _ux_device_mutex_off(&audio -> ux_device_class_audio_status_mutex);
            return(UX_SUCCESS);
        }

        /* Next saved data.  */
        buff += size;
        if (buff >= end)
            buff = audio -> ux_device_class_audio_status_queue;
    }

    /* No data match before buff achieve head.  */
    UX_ASSERT(buff == audio -> ux_device_class_audio_status_head);

    /* If no free space, return busy (pending).  */
    if (audio -> ux_device_class_audio_status_queued >=
        audio -> ux_device_class_audio_status_queue_bytes)
    {

        /* No queue space, pending.  */
        _ux_device_mutex_off(&audio -> ux_device_class_audio_status_mutex);
        return(UX_BUSY);
    }

    /* Copy data to head.  */
    _ux_utility_memory_copy(buff, int_data, size); /* Use case of memcpy is verified. */

    /* Move head.  */
    buff += size;
    if (buff >= end)
        buff = audio -> ux_device_class_audio_status_queue;
    audio -> ux_device_class_audio_status_head = buff;

    /* Add to queued bytes.  */
    audio -> ux_device_class_audio_status_queued += size;

    /* Unprotect queue status.  */
    _ux_device_mutex_off(&audio -> ux_device_class_audio_status_mutex);

    /* Notify status thread to issue interrupt request.  */
    _ux_device_semaphore_put(&audio -> ux_device_class_audio_status_semaphore);

    /* Resume interrupt thread.  */
    _ux_device_thread_resume(&audio -> ux_device_class_audio_class -> ux_slave_class_thread);

    /* Return success.  */
    return(UX_SUCCESS);
#endif
}


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _uxe_device_class_audio_interrupt_send              PORTABLE C      */
/*                                                           6.2.1        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function checks errors in queuing audio interrupt data         */
/*    function call.                                                      */
/*                                                                        */
/*    Note the interrupt data size is predefined and not checked:         */
/*    - for Audio 1.0 interrupt status word is 2 bytes                    */
/*    - for Audio 2.0 interrupt data message is 6 bytes                   */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    audio                                 Address of audio instance     */
/*    int_data                              Interrupt data (2 or 6 bytes) */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    None                                                                */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _ux_device_class_audio_interrupt_send Queue interrupt data to send  */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Application                                                         */
/*                                                                        */
/**************************************************************************/
UINT    _uxe_device_class_audio_interrupt_send(UX_DEVICE_CLASS_AUDIO *audio, UCHAR *int_data)
{

    /* Sanity check.  */
    if (audio == UX_NULL || int_data == UX_NULL)
        return(UX_INVALID_PARAMETER);

    /* Send interrupt data.  */
    return(_ux_device_class_audio_interrupt_send(audio, int_data));
}