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 /**************************************************************************/
32 /* */
33 /* FUNCTION RELEASE */
34 /* */
35 /* _nx_ip_forwarding_disable PORTABLE C */
36 /* 6.1 */
37 /* AUTHOR */
38 /* */
39 /* Yuxin Zhou, Microsoft Corporation */
40 /* */
41 /* DESCRIPTION */
42 /* */
43 /* This function disables the IP forwarding by clearing the forward */
44 /* processing function pointer in the specified IP instance. */
45 /* */
46 /* INPUT */
47 /* */
48 /* ip_ptr Pointer to IP instance */
49 /* */
50 /* OUTPUT */
51 /* */
52 /* status Completion status */
53 /* */
54 /* CALLS */
55 /* */
56 /* None */
57 /* */
58 /* CALLED BY */
59 /* */
60 /* Application */
61 /* */
62 /* RELEASE HISTORY */
63 /* */
64 /* DATE NAME DESCRIPTION */
65 /* */
66 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
67 /* 09-30-2020 Yuxin Zhou Modified comment(s), */
68 /* resulting in version 6.1 */
69 /* */
70 /**************************************************************************/
_nx_ip_forwarding_disable(NX_IP * ip_ptr)71 UINT _nx_ip_forwarding_disable(NX_IP *ip_ptr)
72 {
73
74 #ifndef NX_DISABLE_IPV4
75 TX_INTERRUPT_SAVE_AREA
76
77
78 /* If trace is enabled, insert this event into the trace buffer. */
79 NX_TRACE_IN_LINE_INSERT(NX_TRACE_IP_FORWARDING_DISABLE, ip_ptr, 0, 0, 0, NX_TRACE_IP_EVENTS, 0, 0);
80
81 /* Disable interrupts temporarily. */
82 TX_DISABLE
83
84 /* Clear the IP forwarding processing routine pointer. */
85 ip_ptr -> nx_ip_forward_packet_process = NX_NULL;
86
87 /* Restore interrupts. */
88 TX_RESTORE
89
90 /* Return success to the caller. */
91 return(NX_SUCCESS);
92 #else
93 NX_PARAMETER_NOT_USED(ip_ptr);
94
95 return(NX_NOT_SUPPORTED);
96 #endif /* !NX_DISABLE_IPV4 */
97 }
98
99
