1 /***************************************************************************
2  * Copyright (c) 2024 Microsoft Corporation
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the MIT License which is available at
6  * https://opensource.org/licenses/MIT.
7  *
8  * SPDX-License-Identifier: MIT
9  **************************************************************************/
10 
11 
12 /**************************************************************************/
13 /**************************************************************************/
14 /**                                                                       */
15 /** NetX Component                                                        */
16 /**                                                                       */
17 /**   Packet Pool Management (Packet)                                     */
18 /**                                                                       */
19 /**************************************************************************/
20 /**************************************************************************/
21 
22 #define NX_SOURCE_CODE
23 
24 
25 /* Include necessary system files.  */
26 
27 #include "nx_api.h"
28 #include "nx_packet.h"
29 
30 #ifdef NX_ENABLE_LOW_WATERMARK
31 /* Bring in externs for caller checking code.  */
32 
33 NX_CALLER_CHECKING_EXTERNS
34 #endif /* NX_ENABLE_LOW_WATERMARK */
35 
36 
37 /**************************************************************************/
38 /*                                                                        */
39 /*  FUNCTION                                               RELEASE        */
40 /*                                                                        */
41 /*    _nxe_packet_pool_low_watermark_set                  PORTABLE C      */
42 /*                                                           6.1          */
43 /*  AUTHOR                                                                */
44 /*                                                                        */
45 /*    Yuxin Zhou, Microsoft Corporation                                   */
46 /*                                                                        */
47 /*  DESCRIPTION                                                           */
48 /*                                                                        */
49 /*    This function checks for errors in the packet pool low watermark set*/
50 /*    function call.                                                      */
51 /*                                                                        */
52 /*  INPUT                                                                 */
53 /*                                                                        */
54 /*    pool_ptr                              Pointer to packet pool        */
55 /*    low_watermark                         Low watermark of packet pool  */
56 /*                                                                        */
57 /*  OUTPUT                                                                */
58 /*                                                                        */
59 /*    status                                Completion status             */
60 /*                                                                        */
61 /*  CALLS                                                                 */
62 /*                                                                        */
63 /*    _nx_packet_pool_low_watermark_set     Actual packet pool low        */
64 /*                                            watermark set function      */
65 /*                                                                        */
66 /*  CALLED BY                                                             */
67 /*                                                                        */
68 /*    Application Code                                                    */
69 /*                                                                        */
70 /*  RELEASE HISTORY                                                       */
71 /*                                                                        */
72 /*    DATE              NAME                      DESCRIPTION             */
73 /*                                                                        */
74 /*  05-19-2020     Yuxin Zhou               Initial Version 6.0           */
75 /*  09-30-2020     Yuxin Zhou               Modified comment(s),          */
76 /*                                            resulting in version 6.1    */
77 /*                                                                        */
78 /**************************************************************************/
_nxe_packet_pool_low_watermark_set(NX_PACKET_POOL * pool_ptr,ULONG low_watermark)79 UINT  _nxe_packet_pool_low_watermark_set(NX_PACKET_POOL *pool_ptr, ULONG low_watermark)
80 {
81 #ifdef NX_ENABLE_LOW_WATERMARK
82 
83 UINT status;
84 
85 
86     /* Check for invalid input pointers.  */
87     if ((pool_ptr == NX_NULL) || (pool_ptr -> nx_packet_pool_id != NX_PACKET_POOL_ID))
88     {
89         return(NX_PTR_ERROR);
90     }
91 
92     /* Check for appropriate caller.  */
93     NX_THREADS_ONLY_CALLER_CHECKING
94 
95     /* Call actual packet pool low watermark set function.  */
96     status =  _nx_packet_pool_low_watermark_set(pool_ptr, low_watermark);
97 
98     /* Return completion status.  */
99     return(status);
100 
101 #else /* !NX_ENABLE_LOW_WATERMARK */
102     NX_PARAMETER_NOT_USED(pool_ptr);
103     NX_PARAMETER_NOT_USED(low_watermark);
104 
105     return(NX_NOT_SUPPORTED);
106 
107 #endif /* NX_ENABLE_LOW_WATERMARK */
108 }
109 
110