summaryrefslogtreecommitdiff
path: root/common/usbx_host_classes/src/ux_host_class_audio_deactivate.c
blob: 754e8e941e0d52341f292e94aa7327ed6c36a80f (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
/***************************************************************************
 * 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                                                        */
/**                                                                       */
/**   Audio Class                                                         */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/


/* Include necessary system files.  */

#define UX_SOURCE_CODE

#include "ux_api.h"
#include "ux_host_class_audio.h"
#include "ux_host_stack.h"


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _ux_host_class_audio_deactivate                     PORTABLE C      */
/*                                                           6.3.0        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function is called when this instance of the audio has been    */
/*    removed from the bus either directly or indirectly. The iso pipes   */
/*    will be destroyed and the instanced removed.                        */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    command                               Pointer to command            */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    Completion Status                                                   */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _ux_host_stack_class_instance_destroy Destroy class instance        */
/*    _ux_host_stack_endpoint_transfer_abort Abort outstanding transfer   */
/*    _ux_host_mutex_on                     Get mutex                     */
/*    _ux_host_mutex_delete                 Delete mutex                  */
/*    _ux_utility_memory_free               Release memory block          */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Audio Class                                                         */
/*                                                                        */
/**************************************************************************/
UINT  _ux_host_class_audio_deactivate(UX_HOST_CLASS_COMMAND *command)
{

UX_HOST_CLASS_AUDIO     *audio;
#if defined(UX_HOST_CLASS_AUDIO_INTERRUPT_SUPPORT)
UX_HOST_CLASS_AUDIO_AC  *ac;
UINT                    i;
#endif

    /* Get the instance for this class.  */
    audio = (UX_HOST_CLASS_AUDIO *) command -> ux_host_class_command_instance;

#if defined(UX_HOST_CLASS_AUDIO_INTERRUPT_SUPPORT)
    if (_ux_host_class_audio_subclass_get(audio) == UX_HOST_CLASS_AUDIO_SUBCLASS_CONTROL)
    {
        ac = (UX_HOST_CLASS_AUDIO_AC *)audio;

        /* Stop interrupt and free allocated buffer for it.  */
        if (ac -> ux_host_class_audio_interrupt_endpoint)
        {
            _ux_host_stack_endpoint_transfer_abort(ac -> ux_host_class_audio_interrupt_endpoint);
            _ux_utility_memory_free(ac -> ux_host_class_audio_interrupt_endpoint ->
                                    ux_endpoint_transfer_request.ux_transfer_request_data_pointer);
        }

        /* The enumeration thread needs to sleep a while to allow the application or the class that may be using
        endpoints to exit properly.  */
        _ux_host_thread_schedule_other(UX_THREAD_PRIORITY_ENUM);

        /* Clear the links in AS interfaces.  */
        for (i = 0; i < ac -> ux_host_class_audio_as_count; i++)
        {
            if (ac -> ux_host_class_audio_as[i])
                ac -> ux_host_class_audio_as[i] -> ux_host_class_audio_ac = UX_NULL;
        }

        /* Destroy the instance.  */
        _ux_host_stack_class_instance_destroy(audio -> ux_host_class_audio_class, (VOID *) audio);
    }
    else
#endif
    {

        /* The audio is being shut down.  */
        audio -> ux_host_class_audio_state =  UX_HOST_CLASS_INSTANCE_SHUTDOWN;

        /* Protect thread reentry to this instance.  */
        _ux_host_mutex_on(&audio -> ux_host_class_audio_mutex);

        /* We need to abort transactions on the iso pipe.  */
        if (audio -> ux_host_class_audio_isochronous_endpoint)
            _ux_host_stack_endpoint_transfer_abort(audio -> ux_host_class_audio_isochronous_endpoint);
#if defined(UX_HOST_CLASS_AUDIO_FEEDBACK_SUPPORT)
    if (audio -> ux_host_class_audio_feedback_endpoint)
    {
        _ux_host_stack_endpoint_transfer_abort(audio -> ux_host_class_audio_feedback_endpoint);
        _ux_utility_memory_free(audio -> ux_host_class_audio_feedback_endpoint -> ux_endpoint_transfer_request.ux_transfer_request_data_pointer);
    }
#endif

        /* The enumeration thread needs to sleep a while to allow the application or the class that may be using
        endpoints to exit properly.  */
        _ux_host_thread_schedule_other(UX_THREAD_PRIORITY_ENUM);

#if defined(UX_HOST_CLASS_AUDIO_INTERRUPT_SUPPORT)

        /* Clear the links in AC interface.  */
        ac =  audio -> ux_host_class_audio_ac;
        if (ac)
            ac -> ux_host_class_audio_as[audio -> ux_host_class_audio_ac_as] = UX_NULL;
#endif

        /* Destroy the instance.  */
        _ux_host_stack_class_instance_destroy(audio -> ux_host_class_audio_class, (VOID *) audio);

        /* Destroy the semaphore.  */
        _ux_host_mutex_delete(&audio -> ux_host_class_audio_mutex);
    }

    /* Before we free the device resources, we need to inform the application
        that the device is removed.  */
    if (_ux_system_host -> ux_system_host_change_function != UX_NULL)
    {

        /* Inform the application the device is removed.  */
        _ux_system_host -> ux_system_host_change_function(UX_DEVICE_REMOVAL, audio -> ux_host_class_audio_class, (VOID *) audio);
    }

    /* If trace is enabled, insert this event into the trace buffer.  */
    UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_CLASS_AUDIO_DEACTIVATE, audio, 0, 0, 0, UX_TRACE_HOST_CLASS_EVENTS, 0, 0)

    /* If trace is enabled, register this object.  */
    UX_TRACE_OBJECT_UNREGISTER(audio);

    /* Free the audio instance memory.  */
    _ux_utility_memory_free(audio);

    /* Return successful completion.  */
    return(UX_SUCCESS);
}