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 #if !defined(NX_DISABLE_IPV4) && defined(NX_ENABLE_IP_STATIC_ROUTING)
31 /* Bring in externs for caller checking code. */
32 NX_CALLER_CHECKING_EXTERNS
33 #endif /* !NX_DISABLE_IPV4 && NX_ENABLE_IP_STATIC_ROUTING */
34
35 /**************************************************************************/
36 /* */
37 /* FUNCTION RELEASE */
38 /* */
39 /* _nxe_ip_static_route_delete PORTABLE C */
40 /* 6.1 */
41 /* AUTHOR */
42 /* */
43 /* Yuxin Zhou, Microsoft Corporation */
44 /* */
45 /* DESCRIPTION */
46 /* */
47 /* This function deltes static routing entry from the routing table. */
48 /* */
49 /* INPUT */
50 /* */
51 /* ip_ptr Pointer to IP instance */
52 /* network_address network address, in host */
53 /* byte order. */
54 /* net_mask Network Mask, in host byte */
55 /* order. */
56 /* */
57 /* */
58 /* OUTPUT */
59 /* */
60 /* status Completion status */
61 /* */
62 /* CALLS */
63 /* */
64 /* _nx_ip_staic_route_delete Acutal IP static routing */
65 /* table delete function. */
66 /* CALLED BY */
67 /* */
68 /* Application */
69 /* */
70 /* NOTE: */
71 /* */
72 /* None */
73 /* */
74 /* RELEASE HISTORY */
75 /* */
76 /* DATE NAME DESCRIPTION */
77 /* */
78 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
79 /* 09-30-2020 Yuxin Zhou Modified comment(s), */
80 /* resulting in version 6.1 */
81 /* */
82 /**************************************************************************/
_nxe_ip_static_route_delete(NX_IP * ip_ptr,ULONG network_address,ULONG net_mask)83 UINT _nxe_ip_static_route_delete(NX_IP *ip_ptr, ULONG network_address, ULONG net_mask)
84 {
85 #if !defined(NX_DISABLE_IPV4) && defined(NX_ENABLE_IP_STATIC_ROUTING)
86
87 UINT status;
88
89 /* Check for invalid input pointers. */
90 if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID))
91 {
92 return(NX_PTR_ERROR);
93 }
94
95 /* Check for appropriate caller. */
96 NX_INIT_AND_THREADS_CALLER_CHECKING
97
98 /* Call actual IP forwarding disable function. */
99 status = _nx_ip_static_route_delete(ip_ptr, network_address, net_mask);
100
101 /* Return completion status. */
102 return(status);
103
104
105 #else /* !NX_DISABLE_IPV4 && NX_ENABLE_IP_STATIC_ROUTING */
106 NX_PARAMETER_NOT_USED(ip_ptr);
107 NX_PARAMETER_NOT_USED(network_address);
108 NX_PARAMETER_NOT_USED(net_mask);
109
110 return(NX_NOT_SUPPORTED);
111
112 #endif /* !NX_DISABLE_IPV4 && NX_ENABLE_IP_STATIC_ROUTING */
113 }
114
115
