summaryrefslogtreecommitdiff
path: root/common/usbx_device_classes/src/ux_device_class_audio_interrupt_task_function.c
blob: 0415e777e20cd0b0fbbc275221925541711777de (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
/***************************************************************************
 * 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"

#if defined(UX_DEVICE_STANDALONE) && defined(UX_DEVICE_CLASS_AUDIO_INTERRUPT_SUPPORT)
/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _ux_device_class_audio_interrupt_task_function      PORTABLE C      */
/*                                                           6.3.0        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Yajun Xia, Microsoft Corporation                                    */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function is task of INTERRUPT IN from the Audio class.         */
/*                                                                        */
/*    It's for standalone mode.                                           */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    audio                                 Address of audio instance     */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    State machine Status to check                                       */
/*    UX_STATE_EXIT                         Abnormal, to reset state      */
/*    UX_STATE_IDLE                         No interrupt transfer running */
/*    UX_STATE_WAIT                         Keep running, waiting         */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _ux_system_error_handler              System error trap             */
/*    _ux_utility_memory_copy               Copy memory                   */
/*    _ux_device_stack_transfer_run         Run Transfer state machine    */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Audio Class (task)                                                  */
/*                                                                        */
/**************************************************************************/
UINT _ux_device_class_audio_interrupt_task_function(UX_DEVICE_CLASS_AUDIO *audio)
{

UINT                            status;
UX_SLAVE_DEVICE                 *device;
UX_SLAVE_ENDPOINT               *endpoint;
UX_SLAVE_TRANSFER               *transfer;
UCHAR                           *buff;


    /* Get stack device instance.  */
    device = audio -> ux_device_class_audio_device;

    /* Check if the device is configured.  */
    if (device -> ux_slave_device_state != UX_DEVICE_CONFIGURED)
    {

        /* Error trap. */
        _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_CONFIGURATION_HANDLE_UNKNOWN);

        audio -> ux_device_class_audio_interrupt_task_state = UX_STATE_EXIT;
        return(UX_STATE_EXIT);
    }

    /* Get endpoint instance.  */
    endpoint = audio -> ux_device_class_audio_interrupt;

    /* Endpoint not available, maybe it's alternate setting 0,
       or not exist in framework (accepted use case).  */
    if (endpoint == UX_NULL)
    {
        audio -> ux_device_class_audio_interrupt_task_state = UX_STATE_RESET;
        return(UX_STATE_IDLE);
    }

    /* No packet in queue */
    if (audio -> ux_device_class_audio_status_queued == 0)
    {
        audio -> ux_device_class_audio_interrupt_task_state = UX_STATE_RESET;
        audio -> ux_device_class_audio_interrupt_task_status = UX_TRANSFER_NOT_READY;
        return(UX_STATE_EXIT);
    }

    /* Get transfer instance.  */
    transfer = &endpoint -> ux_slave_endpoint_transfer_request;

    /* Handle state cases.  */
    switch(audio -> ux_device_class_audio_interrupt_task_state)
    {
    case UX_STATE_RESET:
        audio -> ux_device_class_audio_interrupt_task_state = UX_DEVICE_CLASS_AUDIO_INTERRUPT_START;
        audio -> ux_device_class_audio_interrupt_task_status = UX_TRANSFER_NO_ANSWER;

    /* Fall through.  */
    case UX_DEVICE_CLASS_AUDIO_INTERRUPT_START:
        if (audio -> ux_device_class_audio_status_size > transfer -> ux_slave_transfer_request_transfer_length)
        {

            /* Error trap. */
            _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_TRANSFER_ERROR);

            audio -> ux_device_class_audio_interrupt_task_state = UX_STATE_RESET;
            audio -> ux_device_class_audio_interrupt_task_status = UX_ERROR;
            return(UX_STATE_EXIT);
        }

        _ux_utility_memory_copy(transfer -> ux_slave_transfer_request_data_pointer,
                                audio -> ux_device_class_audio_status_tail, audio -> ux_device_class_audio_status_size); /* Use case of memcpy is verified. */

        audio -> ux_device_class_audio_interrupt_task_state = UX_DEVICE_CLASS_AUDIO_INTERRUPT_WAIT;

    /* Fall through.  */
    case UX_DEVICE_CLASS_AUDIO_INTERRUPT_WAIT:

        /* Start frame transfer anyway.  */
        status = _ux_device_stack_transfer_run(transfer, audio -> ux_device_class_audio_status_size,
                                                audio -> ux_device_class_audio_status_size);

        /* Any error or success case.  */
        if (status < UX_STATE_NEXT)
        {

            /* Error notification!  */
            _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_TRANSFER_ERROR);

            audio -> ux_device_class_audio_interrupt_task_state = UX_STATE_RESET;
            audio -> ux_device_class_audio_interrupt_task_status =
                    transfer -> ux_slave_transfer_request_completion_code;
            return(UX_STATE_EXIT);
        }

        /* Success case.  */
        if (status == UX_STATE_NEXT)
        {
            buff = audio -> ux_device_class_audio_status_tail;
            buff += audio -> ux_device_class_audio_status_size;

            if (buff >= (audio -> ux_device_class_audio_status_queue + audio -> ux_device_class_audio_status_queue_bytes))
                buff = audio -> ux_device_class_audio_status_queue;

            audio -> ux_device_class_audio_status_tail = buff;
            audio -> ux_device_class_audio_status_queued -= audio -> ux_device_class_audio_status_size;
            audio -> ux_device_class_audio_interrupt_task_state = UX_DEVICE_CLASS_AUDIO_INTERRUPT_START;
            audio -> ux_device_class_audio_interrupt_task_status =
                    transfer -> ux_slave_transfer_request_completion_code;
        }

        /* Keep waiting.  */
        return(UX_STATE_WAIT);

    default: /* Error.  */
        audio -> ux_device_class_audio_interrupt_task_state = UX_STATE_RESET;
        audio -> ux_device_class_audio_interrupt_task_status = UX_INVALID_STATE;
        break;
    }

    /* Error case.  */
    return(UX_STATE_EXIT);
}
#endif