/**************************************************************************/ /* */ /* Copyright (c) Microsoft Corporation. All rights reserved. */ /* */ /* This software is licensed under the Microsoft Software License */ /* Terms for Microsoft Azure RTOS. Full text of the license can be */ /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ /* and in the root directory of this software. */ /* */ /**************************************************************************/ /**************************************************************************/ /**************************************************************************/ /** */ /** NetX Component */ /** */ /** Packet Pool Management (Packet) */ /** */ /**************************************************************************/ /**************************************************************************/ #define NX_SOURCE_CODE /* Include necessary system files. */ #include "nx_api.h" #include "nx_packet.h" #ifdef NX_ENABLE_LOW_WATERMARK /* Bring in externs for caller checking code. */ NX_CALLER_CHECKING_EXTERNS #endif /* NX_ENABLE_LOW_WATERMARK */ /**************************************************************************/ /* */ /* FUNCTION RELEASE */ /* */ /* _nxe_packet_pool_low_watermark_set PORTABLE C */ /* 6.1 */ /* AUTHOR */ /* */ /* Yuxin Zhou, Microsoft Corporation */ /* */ /* DESCRIPTION */ /* */ /* This function checks for errors in the packet pool low watermark set*/ /* function call. */ /* */ /* INPUT */ /* */ /* pool_ptr Pointer to packet pool */ /* low_watermark Low watermark of packet pool */ /* */ /* OUTPUT */ /* */ /* status Completion status */ /* */ /* CALLS */ /* */ /* _nx_packet_pool_low_watermark_set Actual packet pool low */ /* watermark set function */ /* */ /* CALLED BY */ /* */ /* Application Code */ /* */ /* RELEASE HISTORY */ /* */ /* DATE NAME DESCRIPTION */ /* */ /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */ /* 09-30-2020 Yuxin Zhou Modified comment(s), */ /* resulting in version 6.1 */ /* */ /**************************************************************************/ UINT _nxe_packet_pool_low_watermark_set(NX_PACKET_POOL *pool_ptr, ULONG low_watermark) { #ifdef NX_ENABLE_LOW_WATERMARK UINT status; /* Check for invalid input pointers. */ if ((pool_ptr == NX_NULL) || (pool_ptr -> nx_packet_pool_id != NX_PACKET_POOL_ID)) { return(NX_PTR_ERROR); } /* Check for appropriate caller. */ NX_THREADS_ONLY_CALLER_CHECKING /* Call actual packet pool low watermark set function. */ status = _nx_packet_pool_low_watermark_set(pool_ptr, low_watermark); /* Return completion status. */ return(status); #else /* !NX_ENABLE_LOW_WATERMARK */ NX_PARAMETER_NOT_USED(pool_ptr); NX_PARAMETER_NOT_USED(low_watermark); return(NX_NOT_SUPPORTED); #endif /* NX_ENABLE_LOW_WATERMARK */ }