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 /**   Internet Protocol (IP)                                              */
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_ip.h"
29 
30 
31 /* Bring in externs for caller checking code.  */
32 
33 NX_CALLER_CHECKING_EXTERNS
34 
35 /**************************************************************************/
36 /*                                                                        */
37 /*  FUNCTION                                               RELEASE        */
38 /*                                                                        */
39 /*    _nxe_ip_gateway_address_set                         PORTABLE C      */
40 /*                                                           6.1          */
41 /*  AUTHOR                                                                */
42 /*                                                                        */
43 /*    Yuxin Zhou, Microsoft Corporation                                   */
44 /*                                                                        */
45 /*  DESCRIPTION                                                           */
46 /*                                                                        */
47 /*    This function checks for errors in the IP gateway address set       */
48 /*    function call.                                                      */
49 /*                                                                        */
50 /*  INPUT                                                                 */
51 /*                                                                        */
52 /*    ip_ptr                                IP control block pointer      */
53 /*    ip_address                            Gateway IP address            */
54 /*                                                                        */
55 /*  OUTPUT                                                                */
56 /*                                                                        */
57 /*    status                                Completion status             */
58 /*                                                                        */
59 /*  CALLS                                                                 */
60 /*                                                                        */
61 /*    _nx_ip_gateway_address_set            Actual IP gateway address     */
62 /*                                            set function call           */
63 /*                                                                        */
64 /*  CALLED BY                                                             */
65 /*                                                                        */
66 /*    Application Code                                                    */
67 /*                                                                        */
68 /*  RELEASE HISTORY                                                       */
69 /*                                                                        */
70 /*    DATE              NAME                      DESCRIPTION             */
71 /*                                                                        */
72 /*  05-19-2020     Yuxin Zhou               Initial Version 6.0           */
73 /*  09-30-2020     Yuxin Zhou               Modified comment(s),          */
74 /*                                            resulting in version 6.1    */
75 /*                                                                        */
76 /**************************************************************************/
_nxe_ip_gateway_address_set(NX_IP * ip_ptr,ULONG ip_address)77 UINT  _nxe_ip_gateway_address_set(NX_IP *ip_ptr, ULONG ip_address)
78 {
79 
80 #ifndef NX_DISABLE_IPV4
81 UINT status;
82 
83     /* Check for invalid input pointers.  */
84     if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID))
85     {
86         return(NX_PTR_ERROR);
87     }
88 
89     /* Determine if this is a valid gateway address.  */
90     /*lint -e{835} -e{845} suppress operating on zero. */
91     if (ip_address == IP_ADDRESS(0, 0, 0, 0))
92     {
93         return(NX_IP_ADDRESS_ERROR);
94     }
95 
96     /* Check for appropriate caller.  */
97     NX_INIT_AND_THREADS_CALLER_CHECKING
98 
99     /* Call actual IP gateway address set function.  */
100     status =  _nx_ip_gateway_address_set(ip_ptr, ip_address);
101 
102     /* Return completion status.  */
103     return(status);
104 #else /* NX_DISABLE_IPV4  */
105     NX_PARAMETER_NOT_USED(ip_ptr);
106     NX_PARAMETER_NOT_USED(ip_address);
107 
108     return(NX_NOT_SUPPORTED);
109 #endif /* !NX_DISABLE_IPV4  */
110 }
111 
112