/***************************************************************************
 * 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_initialize                   PORTABLE C      */
/*                                                           6.3.0        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function initializes the USB dpump device.                     */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    command                                 Pointer to dpump command    */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    Completion Status                                                   */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _ux_utility_memory_allocate             Allocate memory             */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Device Data Pump Class                                              */
/*                                                                        */
/**************************************************************************/
UINT  _ux_device_class_dpump_initialize(UX_SLAVE_CLASS_COMMAND *command)
{

UX_SLAVE_CLASS_DPUMP                    *dpump;
UX_SLAVE_CLASS                          *class_ptr;
UX_SLAVE_CLASS_DPUMP_PARAMETER          *dpump_parameter;

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

    /* Create an instance of the device dpump class.  */
    dpump =  _ux_utility_memory_allocate(UX_NO_ALIGN, UX_REGULAR_MEMORY, sizeof(UX_SLAVE_CLASS_DPUMP));

    /* Check for successful allocation.  */
    if (dpump == UX_NULL)
        return(UX_MEMORY_INSUFFICIENT);

    /* Save the address of the DPUMP instance inside the DPUMP container.  */
    class_ptr -> ux_slave_class_instance = (VOID *) dpump;

#if UX_DEVICE_ENDPOINT_BUFFER_OWNER == 1
    UX_ASSERT(!UX_DEVICE_CLASS_DPUMP_ENDPOINT_BUFFER_SIZE_CALC_OVERFLOW);
    dpump -> ux_device_class_dpump_endpoint_buffer = _ux_utility_memory_allocate(
                                UX_NO_ALIGN, UX_CACHE_SAFE_MEMORY,
                                UX_DEVICE_CLASS_DPUMP_ENDPOINT_BUFFER_SIZE);
    if (dpump -> ux_device_class_dpump_endpoint_buffer == UX_NULL)
    {
        _ux_utility_memory_free(dpump);
        return(UX_MEMORY_INSUFFICIENT);
    }
#endif

    /* Get the pointer to the application parameters for the cdc class.  */
    dpump_parameter =  command -> ux_slave_class_command_parameter;

    /* Store the start and stop signals if needed by the application.  */
    dpump -> ux_slave_class_dpump_parameter.ux_slave_class_dpump_instance_activate = dpump_parameter -> ux_slave_class_dpump_instance_activate;
    dpump -> ux_slave_class_dpump_parameter.ux_slave_class_dpump_instance_deactivate = dpump_parameter -> ux_slave_class_dpump_instance_deactivate;

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