summaryrefslogtreecommitdiff
path: root/common/usbx_host_controllers/src/ux_hcd_ehci_request_interrupt_transfer.c
blob: ceb45c556df01ea95a9edaeb648344dd456991c8 (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
/***************************************************************************
 * 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_request_interrupt_transfer             PORTABLE C      */
/*                                                           6.1          */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*     This function performs an interrupt transfer request. An interrupt */
/*     transfer can only be as large as the MaxpacketField in the         */
/*     endpoint descriptor. This was verified at the upper layer and does */
/*     not need to be reverified here.                                    */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    hcd_ehci                              Pointer to EHCI controller    */
/*    transfer_request                      Pointer to transfer request   */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    Completion Status                                                   */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _ux_hcd_ehci_request_transfer_add     Add transfer to ED            */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    EHCI Controller Driver                                              */
/*                                                                        */
/**************************************************************************/
UINT  _ux_hcd_ehci_request_interrupt_transfer(UX_HCD_EHCI *hcd_ehci, UX_TRANSFER *transfer_request)
{

UX_ENDPOINT     *endpoint;
UX_EHCI_ED      *ed;
ULONG           pid;
ULONG           td_component;
UINT            status;


    /* Get the pointer to the endpoint.  */
    endpoint =  (UX_ENDPOINT *) transfer_request -> ux_transfer_request_endpoint;

    /* Now get the physical ED attached to this endpoint.  */
    ed =  endpoint -> ux_endpoint_ed;

    /* The overlay parameters should be reset now.  */
    ed -> ux_ehci_ed_current_td =     UX_NULL;
    ed -> ux_ehci_ed_queue_element =  (UX_EHCI_TD *) UX_EHCI_TD_T;
    ed -> ux_ehci_ed_alternate_td =   (UX_EHCI_TD *) UX_EHCI_QH_T;
    ed -> ux_ehci_ed_state &=         UX_EHCI_QH_TOGGLE;
    ed -> ux_ehci_ed_bp0 =            UX_NULL;
    ed -> ux_ehci_ed_bp1 =            UX_NULL;
    ed -> ux_ehci_ed_bp2 =            UX_NULL;
    ed -> ux_ehci_ed_bp3 =            UX_NULL;
    ed -> ux_ehci_ed_bp4 =            UX_NULL;

    /* Get the correct PID for this transfer.  */
    if ((transfer_request -> ux_transfer_request_type & UX_REQUEST_DIRECTION) == UX_REQUEST_IN)
        pid =  UX_EHCI_PID_IN;
    else
        pid =  UX_EHCI_PID_OUT;

    /* Add this transfer request to the ED.  */
    status =  _ux_hcd_ehci_request_transfer_add(hcd_ehci, ed, 0, pid, 0,
                                            transfer_request -> ux_transfer_request_data_pointer,
                                            transfer_request -> ux_transfer_request_requested_length,
                                            transfer_request);

    /* Ensure we got the TD allocated properly.  */
    if (status == UX_SUCCESS)
    {

        /* Set the IOC bit in the last TD.  */
        ed -> ux_ehci_ed_last_td -> ux_ehci_td_control |=  UX_EHCI_TD_IOC;

        /* Ensure the IOC bit is set before activating the TD. This is necessary
           for some processors that perform writes out of order as an optimization.  */
        UX_DATA_MEMORY_BARRIER

        /* Activate the first TD linked to the ED.  */
        td_component =   (ULONG) ed -> ux_ehci_ed_queue_element;
        td_component &=  ~UX_EHCI_TD_T;
        ed -> ux_ehci_ed_queue_element =  (UX_EHCI_TD *) td_component;

    }

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