/***************************************************************************
 * Copyright (c) 2024 Microsoft Corporation
 * Copyright (c) 2025-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
 **************************************************************************/


/**************************************************************************/
/**************************************************************************/
/**                                                                       */
/** NetX Component                                                        */
/**                                                                       */
/**   Internet Protocol (IP)                                              */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/

#define NX_SOURCE_CODE


/* Include necessary system files.  */

#include "nx_api.h"
#include "nx_ip.h"


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _nx_ip_driver_deferred_enable                       PORTABLE C      */
/*                                                           6.4.3        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Yuxin Zhou, Microsoft Corporation                                   */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function enabled the deferred driver packet processing         */
/*    in NetX.  The supplied driver packet handler is called from the     */
/*    IP helper thread to fully process a received driver packet.  The    */
/*    driver's receive packet processing only makes a call to the         */
/*    _nx_ip_driver_deferred_receive processing from the ISR.             */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    ip_ptr                                Pointer to IP control block   */
/*    driver_deferred_packet_handler        Function pointer to driver's  */
/*                                            deferred packet handling    */
/*                                            routine                     */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    None                                                                */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    None                                                                */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Application Driver Initialization                                   */
/*                                                                        */
/**************************************************************************/
VOID  _nx_ip_driver_deferred_enable(NX_IP *ip_ptr, VOID (*driver_deferred_packet_handler)(NX_IP *ip_ptr, NX_PACKET *packet_ptr))
{

#ifdef NX_DRIVER_DEFERRED_PROCESSING
TX_INTERRUPT_SAVE_AREA

    /* Disable interrupts.  */
    TX_DISABLE

    /* Initialize the deferred packet queue to be empty */
    ip_ptr -> nx_ip_driver_deferred_packet_head =  NX_NULL;
    ip_ptr -> nx_ip_driver_deferred_packet_tail =  NX_NULL;

    /* Setup the driver's deferred packet processing routine */
    ip_ptr ->  nx_ip_driver_deferred_packet_handler =  driver_deferred_packet_handler;

    TX_RESTORE
#else
    NX_PARAMETER_NOT_USED(ip_ptr);
    NX_PARAMETER_NOT_USED(driver_deferred_packet_handler);
#endif
}