summaryrefslogtreecommitdiff
path: root/common/usbx_host_classes/src/ux_host_class_hub_deactivate.c
blob: faa23325a49c541926779dd852dd68125bef4faf (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
/***************************************************************************
 * 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                                                        */
/**                                                                       */
/**   HUB Class                                                           */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/


/* Include necessary system files.  */

#define UX_SOURCE_CODE

#include "ux_api.h"
#include "ux_host_class_hub.h"
#include "ux_host_stack.h"


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _ux_host_class_hub_deactivate                       PORTABLE C      */
/*                                                           6.3.0        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function is called when this instance of the HUB has been      */
/*    removed from the bus either directly or indirectly. The interrupt   */
/*    pipe will be destroyed and the instance removed.                    */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    command                               Pointer to class command      */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    Completion Status                                                   */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _ux_host_stack_class_instance_destroy Destroy class instance        */
/*    _ux_host_stack_device_remove          Remove device                 */
/*    _ux_host_stack_endpoint_transfer_abort                              */
/*                                          Abort transfer                */
/*    _ux_utility_memory_free               Release memory block          */
/*    _ux_host_semaphore_get                Get semaphore                 */
/*    _ux_host_semaphore_put                Release semaphore             */
/*    _ux_utility_thread_schedule_other     Schedule other threads        */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    HUB Class                                                           */
/*                                                                        */
/**************************************************************************/
UINT  _ux_host_class_hub_deactivate(UX_HOST_CLASS_COMMAND *command)
{

UX_HOST_CLASS_HUB       *hub;
UX_HCD                  *hcd;
UX_TRANSFER             *transfer_request = UX_NULL;
UINT                    port_index;


    /* Get the instance to the class.  */
    hub =  (UX_HOST_CLASS_HUB *) command -> ux_host_class_command_instance;

    /* Get the HCD used by this instance.  */
    hcd = UX_DEVICE_HCD_GET(hub -> ux_host_class_hub_device);

    /* The HUB is being shut down.  */
    hub -> ux_host_class_hub_state =  UX_HOST_CLASS_INSTANCE_SHUTDOWN;

    /* We need to abort transactions on the interrupt pipe.  */
#if defined(UX_HOST_STANDALONE)
    if (hub -> ux_host_class_hub_interrupt_endpoint)
#endif
    {
        _ux_host_stack_endpoint_transfer_abort(hub -> ux_host_class_hub_interrupt_endpoint);

        /* If the Hub class instance has a interrupt pipe with a data payload associated with it
           it must be freed.  First get the transfer request. */
        transfer_request =  &hub -> ux_host_class_hub_interrupt_endpoint -> ux_endpoint_transfer_request;
    }

    /* Each device which is downstream on the HUB ports must be removed.  */
    for (port_index = 1; port_index <= hub -> ux_host_class_hub_descriptor.bNbPorts; port_index++)
    {

        /* Is there a device on this port?  */
        if (hub -> ux_host_class_hub_port_state & (1UL << port_index))
        {

            /* The stack will remove the device and its resources.  */
            _ux_host_stack_device_remove(hcd, hub -> ux_host_class_hub_device, port_index);
        }
    }


    /* 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);

    /* Then de allocate the memory.  */
#if defined(UX_HOST_STANDALONE)
    if (transfer_request)
#endif
    _ux_utility_memory_free(transfer_request -> ux_transfer_request_data_pointer);

#if defined(UX_HOST_STANDALONE)
    if (hub -> ux_host_class_hub_allocated)
    {
        _ux_utility_memory_free(hub -> ux_host_class_hub_allocated);
    }
#endif

    /* Destroy the instance.  */
    _ux_host_stack_class_instance_destroy(hub -> ux_host_class_hub_class, (VOID *) hub);

    /* 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, hub -> ux_host_class_hub_class, (VOID *) hub);
    }

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

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

#if defined(UX_HOST_STANDALONE)

    /* Unlink from device class instance.  */
    hub -> ux_host_class_hub_device -> ux_device_class_instance =  (VOID *) hub;
#endif

    /* Free the memory block used by the class.  */
    _ux_utility_memory_free(hub);

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