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 /* Bring in externs for caller checking code. */
31
32 NX_CALLER_CHECKING_EXTERNS
33
34 /**************************************************************************/
35 /* */
36 /* FUNCTION RELEASE */
37 /* */
38 /* _nxe_ip_forwarding_enable PORTABLE C */
39 /* 6.1 */
40 /* AUTHOR */
41 /* */
42 /* Yuxin Zhou, Microsoft Corporation */
43 /* */
44 /* DESCRIPTION */
45 /* */
46 /* This function checks for errors in the IP forwarding enable */
47 /* function call. */
48 /* */
49 /* INPUT */
50 /* */
51 /* ip_ptr Pointer to IP instance */
52 /* */
53 /* OUTPUT */
54 /* */
55 /* status Completion status */
56 /* */
57 /* CALLS */
58 /* */
59 /* _nx_ip_forwarding_enable Actual IP forwarding enable */
60 /* function */
61 /* */
62 /* CALLED BY */
63 /* */
64 /* Application */
65 /* */
66 /* RELEASE HISTORY */
67 /* */
68 /* DATE NAME DESCRIPTION */
69 /* */
70 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
71 /* 09-30-2020 Yuxin Zhou Modified comment(s), */
72 /* resulting in version 6.1 */
73 /* */
74 /**************************************************************************/
_nxe_ip_forwarding_enable(NX_IP * ip_ptr)75 UINT _nxe_ip_forwarding_enable(NX_IP *ip_ptr)
76 {
77
78 #ifndef NX_DISABLE_IPV4
79 UINT status;
80
81
82 /* Check for invalid input pointers. */
83 if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID))
84 {
85 return(NX_PTR_ERROR);
86 }
87
88 /* Check for appropriate caller. */
89 NX_NOT_ISR_CALLER_CHECKING
90
91 /* Call actual IP forwarding enable function. */
92 status = _nx_ip_forwarding_enable(ip_ptr);
93
94 /* Return completion status. */
95 return(status);
96 #else
97 NX_PARAMETER_NOT_USED(ip_ptr);
98
99 return(NX_NOT_SUPPORTED);
100 #endif /* !NX_DISABLE_IPV4 */
101 }
102
103
