1 /**************************************************************************/
2 /* */
3 /* Copyright (c) Microsoft Corporation. All rights reserved. */
4 /* */
5 /* This software is licensed under the Microsoft Software License */
6 /* Terms for Microsoft Azure RTOS. Full text of the license can be */
7 /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
8 /* and in the root directory of this software. */
9 /* */
10 /**************************************************************************/
11
12
13 /**************************************************************************/
14 /**************************************************************************/
15 /** */
16 /** NetX Component */
17 /** */
18 /** Internet Protocol (IP) */
19 /** */
20 /**************************************************************************/
21 /**************************************************************************/
22
23 #define NX_SOURCE_CODE
24
25
26 /* Include necessary system files. */
27
28 #include "nx_api.h"
29 #include "nx_ip.h"
30
31
32 /* Bring in externs for caller checking code. */
33
34 NX_CALLER_CHECKING_EXTERNS
35
36 /**************************************************************************/
37 /* */
38 /* FUNCTION RELEASE */
39 /* */
40 /* _nxe_ip_gateway_address_clear PORTABLE C */
41 /* 6.1 */
42 /* AUTHOR */
43 /* */
44 /* Yuxin Zhou, Microsoft Corporation */
45 /* */
46 /* DESCRIPTION */
47 /* */
48 /* This function checks for errors in the IP gateway address clear */
49 /* function call. */
50 /* */
51 /* INPUT */
52 /* */
53 /* ip_ptr IP control block pointer */
54 /* */
55 /* OUTPUT */
56 /* */
57 /* status Completion status */
58 /* */
59 /* CALLS */
60 /* */
61 /* _nx_ip_gateway_address_clear Actual IP gateway address */
62 /* clear 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_clear(NX_IP * ip_ptr)77 UINT _nxe_ip_gateway_address_clear(NX_IP *ip_ptr)
78 {
79
80 #ifndef NX_DISABLE_IPV4
81 UINT status;
82
83
84 /* Check for invalid input pointers. */
85 if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID))
86 {
87 return(NX_PTR_ERROR);
88 }
89
90 /* Check for appropriate caller. */
91 NX_INIT_AND_THREADS_CALLER_CHECKING
92
93 /* Call actual IP gateway address clear function. */
94 status = _nx_ip_gateway_address_clear(ip_ptr);
95
96 /* Return completion status. */
97 return(status);
98 #else /* NX_DISABLE_IPV4 */
99 NX_PARAMETER_NOT_USED(ip_ptr);
100
101 return(NX_NOT_SUPPORTED);
102 #endif /* !NX_DISABLE_IPV4 */
103 }
104
105
