summaryrefslogtreecommitdiff
path: root/common/usbx_host_classes/src/ux_host_class_swar_activate.c
blob: 282a5aa9f9bd32cc948afec41c60c8322e1adf38 (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
/***************************************************************************
 * 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                                                        */
/**                                                                       */
/**   Host Sierra Wireless AR module class                                */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/


/* Include necessary system files.  */

#define UX_SOURCE_CODE

#include "ux_api.h"
#include "ux_host_class_swar.h"
#include "ux_host_stack.h"


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _ux_host_class_swar_activate                        PORTABLE C      */
/*                                                           6.1.10       */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function calls the USBX stack to activate the class.           */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    command                               Dpump class command pointer   */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    Completion Status                                                   */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _ux_host_class_swar_configure           Configure swar class        */
/*    _ux_host_class_swar_endpoints_get       Get endpoints of swar       */
/*    _ux_host_stack_class_instance_create    Create class instance       */
/*    _ux_host_stack_class_instance_destroy   Destroy the class instance  */
/*    _ux_utility_memory_allocate             Allocate memory block       */
/*    _ux_utility_memory_free                 Free memory block           */
/*    _ux_host_semaphore_create               Create swar semaphore       */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    _ux_host_class_swar_entry            Entry of swar class            */
/*                                                                        */
/**************************************************************************/
UINT  _ux_host_class_swar_activate(UX_HOST_CLASS_COMMAND *command)
{

UX_DEVICE                           *device;
UX_HOST_CLASS_SWAR                  *swar;
UINT                                status;


    /* The Sierra Wireless class is always activated by the device descriptor. */
    device =  (UX_DEVICE *) command -> ux_host_class_command_container;

    /* Obtain memory for this class instance.  */
    swar =  _ux_utility_memory_allocate(UX_NO_ALIGN, UX_REGULAR_MEMORY, sizeof(UX_HOST_CLASS_SWAR));
    if (swar == UX_NULL)
        return(UX_MEMORY_INSUFFICIENT);

    /* Store the class container into this instance.  */
    swar -> ux_host_class_swar_class =  command -> ux_host_class_command_class_ptr;

    /* Store the device container into the swar class instance.  */
    swar -> ux_host_class_swar_device =  device;

    /* Store the instance in the device container, this is for the USBX stack
       when it needs to invoke the class for deactivation.  */
    device -> ux_device_class_instance =  (VOID *) swar;

    /* Create this class instance.  */
    _ux_host_stack_class_instance_create(swar -> ux_host_class_swar_class, (VOID *) swar);

    /* Configure the swar.  */
    status =  _ux_host_class_swar_configure(swar);

    /* Get the swar endpoint(s). We will need to search for Bulk Out and Bulk In endpoints on interface .  */
    if (status == UX_SUCCESS)
        status =  _ux_host_class_swar_endpoints_get(swar);

    /* Create the semaphore to protect 2 threads from accessing the same swar instance.  */
    if (status == UX_SUCCESS)
    {
        status =  _ux_host_semaphore_create(&swar -> ux_host_class_swar_semaphore, "ux_host_class_swar_semaphore", 1);
        if (status != UX_SUCCESS)
            status = UX_SEMAPHORE_ERROR;
    }

    /* Success things.  */
    if (status == UX_SUCCESS)
    {

        /* Mark the swar as live now.  */
        swar -> ux_host_class_swar_state =  UX_HOST_CLASS_INSTANCE_LIVE;

        /* If all is fine and the device is mounted, we may need to inform the application
        if a function has been programmed in the system structure.  */
        if (_ux_system_host -> ux_system_host_change_function != UX_NULL)
        {

            /* Call system change function.  */
            _ux_system_host ->  ux_system_host_change_function(UX_DEVICE_INSERTION, swar -> ux_host_class_swar_class, (VOID *) swar);
        }

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

        /* If trace is enabled, register this object.  */
        UX_TRACE_OBJECT_REGISTER(UX_TRACE_HOST_OBJECT_TYPE_INTERFACE, swar, 0, 0, 0)

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

    /* There was a problem during the configuration, so free the resources.  */
    /* The last resource, semaphore is not created or created error, no need to free.  */
    _ux_host_stack_class_instance_destroy(swar -> ux_host_class_swar_class, (VOID *) swar);
    device -> ux_device_class_instance = UX_NULL;
    _ux_utility_memory_free(swar);

    /* Return completion status.  */
    return(status);
}