/***************************************************************************
 * 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_transfer_request                     PORTABLE C      */
/*                                                           6.1.10       */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function performs a USB transaction. On entry the transfer     */
/*    request gives the endpoint pipe selected for this transaction and   */
/*    the parameters associated with the transfer (data payload, length   */
/*    of transaction)                                                     */
/*                                                                        */
/*    For Control pipe, the transaction is blocking and will only return  */
/*    when the 3 phases of the control transfer have been completed or if */
/*    there is a previous error. For other pipes, the USB stack will      */
/*    schedule the transaction on the USB but will not wait for its       */
/*    completion. Each request for non blocking pipes has to specify a    */
/*    completion routine.                                                 */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    transfer_request                      Transfer request structure    */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    Completion Status                     If UX_SUCCESS, transfer was   */
/*                                            successfully started        */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    HCD Entry Function                                                  */
/*    _ux_utility_semaphore_put             Put semaphore                 */
/*    _ux_utility_semaphore_get             Get semaphore                 */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Application                                                         */
/*    USBX Components                                                     */
/*                                                                        */
/**************************************************************************/
UINT  _ux_host_stack_transfer_request(UX_TRANSFER *transfer_request)
{
#if defined(UX_HOST_STANDALONE)
UINT        status;

    UX_TRANSFER_STATE_RESET(transfer_request);
    _ux_host_stack_transfer_run(transfer_request);
    if ((transfer_request -> ux_transfer_request_flags & UX_TRANSFER_FLAG_AUTO_WAIT))
    {
        while(1)
        {

            /* Allow tasks running during waiting.  */
            _ux_system_host_tasks_run();

            if (transfer_request -> ux_transfer_request_state <= UX_STATE_NEXT)
                break;
        }
        status = transfer_request -> ux_transfer_request_completion_code;
    }
    else
    {

        /* In this mode, transfer pending is a success started case.  */
        if (transfer_request -> ux_transfer_request_completion_code == UX_TRANSFER_STATUS_PENDING)
            status = UX_SUCCESS;
        else
            status = transfer_request -> ux_transfer_request_completion_code;
    }

    /* Return transfer completion status.  */
    return(status);
#else
UX_INTERRUPT_SAVE_AREA

UX_ENDPOINT     *endpoint;
UX_DEVICE       *device;
UX_HCD          *hcd;
UINT            status;


    /* Get the endpoint container from the transfer_request */
    endpoint =  transfer_request -> ux_transfer_request_endpoint;

    /* Get the device container from the endpoint.  */
    device =  endpoint -> ux_endpoint_device;

    /* Ensure we are not preempted by the enum thread while we check the device
       state and set the transfer status.  */
    UX_DISABLE

    /* We can only transfer when the device is ATTACHED, ADDRESSED OR CONFIGURED.  */
    if ((device -> ux_device_state == UX_DEVICE_ATTACHED) || (device -> ux_device_state == UX_DEVICE_ADDRESSED)
            || (device -> ux_device_state == UX_DEVICE_CONFIGURED))
    {

        /* Set the transfer to pending.  */
        transfer_request -> ux_transfer_request_completion_code =  UX_TRANSFER_STATUS_PENDING;
#if !defined(UX_HOST_STANDALONE)
        /* Save the thread making this transfer. If we're under interrupt, this
           will be null.  */
        transfer_request -> ux_transfer_request_thread_pending =  _ux_utility_thread_identify();
#endif
    }
    else
    {

        /* The device is in an invalid state. Restore interrupts and return error.  */
        UX_RESTORE

        /* Check if this is endpoint 0.  */
        if ((endpoint -> ux_endpoint_descriptor.bEndpointAddress & (UINT)~UX_ENDPOINT_DIRECTION) == 0)
        {

            /* Check if the class has already protected it.  */
            if (!_ux_host_semaphore_waiting(&device -> ux_device_protection_semaphore))
            {

                /* Class is using endpoint 0. Unprotect semaphore.  */
                _ux_host_semaphore_put(&device -> ux_device_protection_semaphore);
            }
        }

        return(UX_TRANSFER_NOT_READY);
    }

    /* Restore interrupts.  */
    UX_RESTORE

    /* If trace is enabled, insert this event into the trace buffer.  */
    UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_STACK_TRANSFER_REQUEST, device, endpoint, transfer_request, 0, UX_TRACE_HOST_STACK_EVENTS, 0, 0)

    /* With the device we have the pointer to the HCD.  */
    hcd = UX_DEVICE_HCD_GET(device);

    /* If this is endpoint 0, we protect the endpoint from a possible re-entry.  */
    if ((endpoint -> ux_endpoint_descriptor.bEndpointAddress & (UINT)~UX_ENDPOINT_DIRECTION) == 0)
    {

        /* Check if the class has already protected it.  */
        if (_ux_host_semaphore_waiting(&device -> ux_device_protection_semaphore))
        {

            /* We are using endpoint 0. Protect with semaphore.  */
            status =  _ux_host_semaphore_get(&device -> ux_device_protection_semaphore, UX_WAIT_FOREVER);

            /* Check for status.  */
            if (status != UX_SUCCESS)

                /* Something went wrong. */
                return(status);
        }
    }

    /* Send the command to the controller.  */
    status =  hcd -> ux_hcd_entry_function(hcd, UX_HCD_TRANSFER_REQUEST, transfer_request);

    /* If this is endpoint 0, we unprotect the endpoint. */
    if ((endpoint -> ux_endpoint_descriptor.bEndpointAddress & (UINT)~UX_ENDPOINT_DIRECTION) == 0)

        /* We are using endpoint 0. Unprotect with semaphore.  */
        _ux_host_semaphore_put(&device -> ux_device_protection_semaphore);

    /* And return the status.  */
    return(status);
#endif
}


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _uxe_host_stack_transfer_request                    PORTABLE C      */
/*                                                           6.3.0        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function checks errors in host stack transfer function call.   */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    transfer_request                      Pointer to transfer           */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    None                                                                */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _ux_host_stack_transfer_request       Issue a transfer request      */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Application                                                         */
/*                                                                        */
/**************************************************************************/
UINT  _uxe_host_stack_transfer_request(UX_TRANSFER *transfer_request)
{

    /* Sanity checks.  */
    if (transfer_request == UX_NULL)
        return(UX_INVALID_PARAMETER);
    if (transfer_request -> ux_transfer_request_endpoint == UX_NULL)
        return(UX_ENDPOINT_HANDLE_UNKNOWN);
    if (transfer_request -> ux_transfer_request_endpoint -> ux_endpoint_device == UX_NULL)
        return(UX_DEVICE_HANDLE_UNKNOWN);
    if (UX_DEVICE_HCD_GET(transfer_request -> ux_transfer_request_endpoint -> ux_endpoint_device) == UX_NULL)
        return(UX_INVALID_PARAMETER);

    /* Invoke transfer request function.  */
    return(_ux_host_stack_transfer_request(transfer_request));
}
