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_add 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 network */
53 /* byte order. */
54 /* net_mask Network Mask, in network */
55 /* byte order. */
56 /* next_hop Next Hop address, in network */
57 /* byte order. */
58 /* */
59 /* */
60 /* OUTPUT */
61 /* */
62 /* status Completion status */
63 /* */
64 /* CALLS */
65 /* */
66 /* _nx_ip_staic_route_add Actual IP static route */
67 /* add function. */
68 /* CALLED BY */
69 /* */
70 /* Application */
71 /* */
72 /* NOTE: */
73 /* */
74 /* None */
75 /* */
76 /* RELEASE HISTORY */
77 /* */
78 /* DATE NAME DESCRIPTION */
79 /* */
80 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
81 /* 09-30-2020 Yuxin Zhou Modified comment(s), */
82 /* resulting in version 6.1 */
83 /* */
84 /**************************************************************************/
_nxe_ip_static_route_add(NX_IP * ip_ptr,ULONG network_address,ULONG net_mask,ULONG next_hop)85 UINT _nxe_ip_static_route_add(NX_IP *ip_ptr, ULONG network_address,
86 ULONG net_mask, ULONG next_hop)
87 {
88 #if !defined(NX_DISABLE_IPV4) && defined(NX_ENABLE_IP_STATIC_ROUTING)
89
90 UINT status;
91
92 /* Check for invalid input pointers. */
93 if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID))
94 {
95 return(NX_PTR_ERROR);
96 }
97
98 /* Check for appropriate caller. */
99 NX_INIT_AND_THREADS_CALLER_CHECKING
100
101 /* Call actual IP forwarding disable function. */
102 status = _nx_ip_static_route_add(ip_ptr, network_address, net_mask, next_hop);
103
104 /* Return completion status. */
105 return(status);
106
107 #else /* !NX_DISABLE_IPV4 && NX_ENABLE_IP_STATIC_ROUTING */
108 NX_PARAMETER_NOT_USED(ip_ptr);
109 NX_PARAMETER_NOT_USED(network_address);
110 NX_PARAMETER_NOT_USED(net_mask);
111 NX_PARAMETER_NOT_USED(next_hop);
112
113 return(NX_NOT_SUPPORTED);
114
115 #endif /* !NX_DISABLE_IPV4 && NX_ENABLE_IP_STATIC_ROUTING */
116 }
117
118
