summaryrefslogtreecommitdiff
path: root/common/core/src/ux_device_class_dpump_activate.c
blob: e39c7ebae50a1e6201c6f86aab39d8e310ae21af (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
/***************************************************************************
 * 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 Data Pump Class                                              */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/

#define UX_SOURCE_CODE


/* Include necessary system files.  */

#include "ux_api.h"
#include "ux_device_class_dpump.h"


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _ux_device_class_dpump_activate                     PORTABLE C      */
/*                                                           6.3.0        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function activates the USB dpump device.                       */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    command                                 Pointer to dpump command    */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    Completion Status                                                   */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    None                                                                */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Device Data Pump Class                                              */
/*                                                                        */
/**************************************************************************/
UINT  _ux_device_class_dpump_activate(UX_SLAVE_CLASS_COMMAND *command)
{

UX_SLAVE_INTERFACE                      *interface_ptr;
UX_SLAVE_CLASS_DPUMP                    *dpump;
UX_SLAVE_CLASS                          *class_ptr;
UX_SLAVE_ENDPOINT                       *endpoint;

    /* Get the class container.  */
    class_ptr =  command -> ux_slave_class_command_class_ptr;

    /* Store the class instance in the container.  */
    dpump = (UX_SLAVE_CLASS_DPUMP *) class_ptr -> ux_slave_class_instance;

    /* Get the interface that owns this instance.  */
    interface_ptr =  (UX_SLAVE_INTERFACE  *) command -> ux_slave_class_command_interface;

    /* Store the class instance into the interface.  */
    interface_ptr -> ux_slave_interface_class_instance =  (VOID *)dpump;

    /* Now the opposite, store the interface in the class instance.  */
    dpump -> ux_slave_class_dpump_interface =  interface_ptr;

    /* Locate the endpoints.  Interrupt for Control and Bulk in/out for Data.  */
    endpoint =  interface_ptr -> ux_slave_interface_first_endpoint;

    /* Parse all endpoints.  */
    while (endpoint != UX_NULL)
    {

        /* Check the endpoint direction, and type.  */
        if ((endpoint -> ux_slave_endpoint_descriptor.bEndpointAddress & UX_ENDPOINT_DIRECTION) == UX_ENDPOINT_IN)
        {

            /* Look at type.  */
            if ((endpoint -> ux_slave_endpoint_descriptor.bmAttributes & UX_MASK_ENDPOINT_TYPE) == UX_BULK_ENDPOINT)
            {

                /* We have found the bulk in endpoint, save it.  */
                dpump -> ux_slave_class_dpump_bulkin_endpoint =  endpoint;
#if UX_DEVICE_ENDPOINT_BUFFER_OWNER == 1
                endpoint -> ux_slave_endpoint_transfer_request.
                        ux_slave_transfer_request_data_pointer =
                                UX_DEVICE_CLASS_DPUMP_WRITE_BUFFER(dpump);
#endif
            }
        }
        else
        {
            /* Look at type for out endpoint.  */
            if ((endpoint -> ux_slave_endpoint_descriptor.bmAttributes & UX_MASK_ENDPOINT_TYPE) == UX_BULK_ENDPOINT)
            {

                /* We have found the bulk out endpoint, save it.  */
                dpump -> ux_slave_class_dpump_bulkout_endpoint =  endpoint;
#if UX_DEVICE_ENDPOINT_BUFFER_OWNER == 1
                endpoint -> ux_slave_endpoint_transfer_request.
                        ux_slave_transfer_request_data_pointer =
                                UX_DEVICE_CLASS_DPUMP_READ_BUFFER(dpump);
#endif
            }
        }

        /* Next endpoint.  */
        endpoint =  endpoint -> ux_slave_endpoint_next_endpoint;
    }

#if defined(UX_DEVICE_STANDALONE)

    /* Reset read/write states.  */
    dpump -> ux_device_class_dpump_read_state = 0;
    dpump -> ux_device_class_dpump_write_state = 0;
#endif

    /* If there is a activate function call it.  */
    if (dpump -> ux_slave_class_dpump_parameter.ux_slave_class_dpump_instance_activate != UX_NULL)
    {

        /* Invoke the application.  */
        dpump -> ux_slave_class_dpump_parameter.ux_slave_class_dpump_instance_activate(dpump);
    }

    /* If trace is enabled, insert this event into the trace buffer.  */
    UX_TRACE_IN_LINE_INSERT(UX_TRACE_DEVICE_CLASS_DPUMP_ACTIVATE, dpump, 0, 0, 0, UX_TRACE_DEVICE_CLASS_EVENTS, 0, 0)

    /* If trace is enabled, register this object.  */
    UX_TRACE_OBJECT_REGISTER(UX_TRACE_DEVICE_OBJECT_TYPE_INTERFACE, dpump, 0, 0, 0)

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