summaryrefslogtreecommitdiff
path: root/common/usbx_host_controllers/src/ux_hcd_ehci_entry.c
blob: f25a48292069db1151ac3623fd96a04fbeb7b310 (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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
/***************************************************************************
 * 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                                                        */
/**                                                                       */
/**   EHCI Controller Driver                                              */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/


/* Include necessary system files.  */

#define UX_SOURCE_CODE

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


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _ux_hcd_ehci_entry                                  PORTABLE C      */
/*                                                           6.1          */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function dispatch the HCD function internally to the EHCI      */
/*    controller.                                                         */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    HCD                                   Pointer to HCD                */
/*    function                              Requested function            */
/*    parameter                             Pointer to parameter(s)       */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    Completion Status                                                   */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _ux_hcd_ehci_asynchronous_endpoint_create     Create endpoint       */
/*    _ux_hcd_ehci_asynchronous_endpoint_destroy    Destroy endpoint      */
/*    _ux_hcd_ehci_controller_disable               Disable controller    */
/*    _ux_hcd_ehci_done_queue_process               Process done queue    */
/*    _ux_hcd_ehci_endpoint_reset                   Reset endpoint        */
/*    _ux_hcd_ehci_frame_number_get                 Get frame number      */
/*    _ux_hcd_ehci_frame_number_set                 Set frame number      */
/*    _ux_hcd_ehci_interrupt_endpoint_create        Endpoint create       */
/*    _ux_hcd_ehci_interrupt_endpoint_destroy       Endpoint destroy      */
/*    _ux_hcd_ehci_isochronous_endpoint_create      Endpoint create       */
/*    _ux_hcd_ehci_isochronous_endpoint_destroy     Endpoint destroy      */
/*    _ux_hcd_ehci_port_disable                     Disable port          */
/*    _ux_hcd_ehci_port_reset                       Reset port            */
/*    _ux_hcd_ehci_port_resume                      Resume port           */
/*    _ux_hcd_ehci_port_status_get                  Get port status       */
/*    _ux_hcd_ehci_port_suspend                     Suspend port          */
/*    _ux_hcd_ehci_power_down_port                  Power down port       */
/*    _ux_hcd_ehci_power_on_port                    Power on port         */
/*    _ux_hcd_ehci_request_transfer                 Request transfer      */
/*    _ux_hcd_ehci_transfer_abort                   Abort transfer        */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    EHCI Controller Driver                                              */
/*                                                                        */
/**************************************************************************/
UINT  _ux_hcd_ehci_entry(UX_HCD *hcd, UINT function, VOID *parameter)
{

UINT            status;
UX_HCD_EHCI     *hcd_ehci;


    /* Check the status of the controller.  */
    if (hcd -> ux_hcd_status == UX_UNUSED)
    {

        /* Error trap. */
        _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_HCD, UX_CONTROLLER_UNKNOWN);

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

        return(UX_CONTROLLER_UNKNOWN);
    }

    /* Get the pointer to the EHCI HCD.  */
    hcd_ehci =  (UX_HCD_EHCI *) hcd -> ux_hcd_controller_hardware;

    /* Look at the function and route it.  */
    switch(function)
    {

    case UX_HCD_DISABLE_CONTROLLER:

        status =  _ux_hcd_ehci_controller_disable(hcd_ehci);
        break;


    case UX_HCD_GET_PORT_STATUS:
        status =  _ux_hcd_ehci_port_status_get(hcd_ehci, (ULONG) parameter);
        break;


    case UX_HCD_ENABLE_PORT:

        status =  UX_SUCCESS;
        break;


    case UX_HCD_DISABLE_PORT:

        status =  _ux_hcd_ehci_port_disable(hcd_ehci, (ULONG) parameter);
        break;


    case UX_HCD_POWER_ON_PORT:

        status =  _ux_hcd_ehci_power_on_port(hcd_ehci, (ULONG) parameter);
        break;


    case UX_HCD_POWER_DOWN_PORT:

        status =  _ux_hcd_ehci_power_down_port(hcd_ehci, (ULONG) parameter);
        break;


    case UX_HCD_SUSPEND_PORT:
        status =  _ux_hcd_ehci_port_suspend(hcd_ehci, (ULONG) parameter);
        break;


    case UX_HCD_RESUME_PORT:

        status =  _ux_hcd_ehci_port_resume(hcd_ehci, (UINT) parameter);
        break;


    case UX_HCD_RESET_PORT:

        status =  _ux_hcd_ehci_port_reset(hcd_ehci, (ULONG) parameter);
        break;


    case UX_HCD_GET_FRAME_NUMBER:

        status =  _ux_hcd_ehci_frame_number_get(hcd_ehci, (ULONG *) parameter);
        break;


    case UX_HCD_SET_FRAME_NUMBER:

        _ux_hcd_ehci_frame_number_set(hcd_ehci, (ULONG) parameter);
        status =  UX_SUCCESS;
        break;


    case UX_HCD_TRANSFER_REQUEST:

        status =  _ux_hcd_ehci_request_transfer(hcd_ehci, (UX_TRANSFER *) parameter);
        break;


    case UX_HCD_TRANSFER_ABORT:

        status =  _ux_hcd_ehci_transfer_abort(hcd_ehci, (UX_TRANSFER *) parameter);
        break;


    case UX_HCD_CREATE_ENDPOINT:

        switch ((((UX_ENDPOINT*) parameter) -> ux_endpoint_descriptor.bmAttributes) & UX_MASK_ENDPOINT_TYPE)
        {

        case UX_CONTROL_ENDPOINT:
        case UX_BULK_ENDPOINT:
            status =  _ux_hcd_ehci_asynchronous_endpoint_create(hcd_ehci, (UX_ENDPOINT*) parameter);
            break;

        case UX_INTERRUPT_ENDPOINT:
            status =  _ux_hcd_ehci_interrupt_endpoint_create(hcd_ehci, (UX_ENDPOINT*) parameter);
            break;

        case UX_ISOCHRONOUS_ENDPOINT:
            status =  _ux_hcd_ehci_isochronous_endpoint_create(hcd_ehci, (UX_ENDPOINT*) parameter);
            break;

        }
        break;


    case UX_HCD_DESTROY_ENDPOINT:

        switch ((((UX_ENDPOINT*) parameter) -> ux_endpoint_descriptor.bmAttributes) & UX_MASK_ENDPOINT_TYPE)
        {

        case UX_CONTROL_ENDPOINT:
        case UX_BULK_ENDPOINT:
            status =  _ux_hcd_ehci_asynchronous_endpoint_destroy(hcd_ehci, (UX_ENDPOINT*) parameter);
            break;

        case UX_INTERRUPT_ENDPOINT:
            status =  _ux_hcd_ehci_interrupt_endpoint_destroy(hcd_ehci, (UX_ENDPOINT*) parameter);
            break;

        case UX_ISOCHRONOUS_ENDPOINT:
            status =  _ux_hcd_ehci_isochronous_endpoint_destroy(hcd_ehci, (UX_ENDPOINT*) parameter);
            break;

        }
        break;


    case UX_HCD_RESET_ENDPOINT:

        status =  _ux_hcd_ehci_endpoint_reset(hcd_ehci, (UX_ENDPOINT*) parameter);
        break;


    case UX_HCD_PROCESS_DONE_QUEUE:

        _ux_hcd_ehci_done_queue_process(hcd_ehci);
        status =  UX_SUCCESS;
        break;


    default:

        /* Error trap. */
        _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_HCD, UX_FUNCTION_NOT_SUPPORTED);

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

        status =  UX_FUNCTION_NOT_SUPPORTED;
        break;
    }

    /* Return status to caller.  */
    return(status);
}