common/core/src/ux_host_stack_device_get.c


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

/***************************************************************************
 * 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 Stack                                                          */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/


/* Include necessary system files.  */

#define UX_SOURCE_CODE

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


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _ux_host_stack_device_get                           PORTABLE C      */
/*                                                           6.1          */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function returns a device container based on its index. The    */
/*    device index start with device 0. Note that the index is a ULONG    */
/*    because we could have several controllers and a byte index might    */
/*    not be enough.                                                      */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    device_index                          Index of device               */
/*    device                                Destination for device pointer*/
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    Completion Status                                                   */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    None                                                                */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Application                                                         */
/*    USBX Components                                                     */
/*                                                                        */
/**************************************************************************/
UINT  _ux_host_stack_device_get(ULONG device_index, UX_DEVICE **device)
{

UX_DEVICE   *current_device;
#if UX_MAX_DEVICES > 1
ULONG       current_device_index;
#endif

    /* If trace is enabled, insert this event into the trace buffer.  */
    UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_STACK_DEVICE_GET, device_index, 0, 0, 0, UX_TRACE_HOST_STACK_EVENTS, 0, 0)

    /* Check if the device index is still within the limits.  */
    if (device_index >= UX_SYSTEM_HOST_MAX_DEVICES_GET())
    {

        /* Error trap. */
        _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_ENUMERATOR, UX_DEVICE_HANDLE_UNKNOWN);

        /* If trace is enabled, insert this event into the trace buffer.  */
        UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_DEVICE_HANDLE_UNKNOWN, device, 0, 0, UX_TRACE_ERRORS, 0, 0)

        return(UX_DEVICE_HANDLE_UNKNOWN);
    }

#if UX_MAX_DEVICES > 1

    /* Start with the first device.  */
    current_device =        _ux_system_host -> ux_system_host_device_array;
    current_device_index =  0;

    /* Search the list until the end.  */
    while (current_device_index < _ux_system_host -> ux_system_host_max_devices)
    {

        /* Check to see if this device is existing.  */
        if (current_device -> ux_device_handle != UX_UNUSED)
        {

            /* Have we reached the index we are looking for?  */
            if (device_index == current_device_index)
            {

                /* Yes, return the device pointer.  */
                *device =  current_device;

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

        /* Move to next device index.  */
        current_device_index++;

        /* Move to next device.  */
        current_device++;
    }
#else

    /* Only one device, just check if it's used.  */
    current_device = _ux_system_host -> ux_system_host_device_array;
    if (current_device -> ux_device_handle != UX_UNUSED)
    {
        *device = current_device;
        return(UX_SUCCESS);
    }
#endif

    /* If trace is enabled, insert this event into the trace buffer.  */
    UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_DEVICE_HANDLE_UNKNOWN, device, 0, 0, UX_TRACE_ERRORS, 0, 0)

    /* Return error.  */
    return(UX_DEVICE_HANDLE_UNKNOWN);
}


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _uxe_host_stack_device_get                          PORTABLE C      */
/*                                                           6.3.0        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function checks errors in host stack device get function call. */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    device_index                          Index of device               */
/*    device                                Destination for device pointer*/
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    None                                                                */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _ux_host_stack_device_get             Host stack device get         */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Application                                                         */
/*                                                                        */
/**************************************************************************/
UINT  _uxe_host_stack_device_get(ULONG device_index, UX_DEVICE **device)
{

    /* Sanity check.  */
    if (device == UX_NULL)
        return(UX_INVALID_PARAMETER);

    /* Invoke device get function.  */
    return(_ux_host_stack_device_get(device_index, device));
}