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 /**************************************************************************/
33 /* */
34 /* FUNCTION RELEASE */
35 /* */
36 /* _nx_ip_gateway_address_clear PORTABLE C */
37 /* 6.1 */
38 /* AUTHOR */
39 /* */
40 /* Yuxin Zhou, Microsoft Corporation */
41 /* */
42 /* DESCRIPTION */
43 /* */
44 /* This function clears the IPv4 gateway address. */
45 /* */
46 /* INPUT */
47 /* */
48 /* ip_ptr IP control block pointer */
49 /* */
50 /* OUTPUT */
51 /* */
52 /* status Completion status */
53 /* */
54 /* CALLS */
55 /* */
56 /* tx_mutex_get Obtain protection mutex */
57 /* tx_mutex_put Release protection mutex */
58 /* */
59 /* CALLED BY */
60 /* */
61 /* Application Code */
62 /* */
63 /* RELEASE HISTORY */
64 /* */
65 /* DATE NAME DESCRIPTION */
66 /* */
67 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
68 /* 09-30-2020 Yuxin Zhou Modified comment(s), */
69 /* resulting in version 6.1 */
70 /* */
71 /**************************************************************************/
_nx_ip_gateway_address_clear(NX_IP * ip_ptr)72 UINT _nx_ip_gateway_address_clear(NX_IP *ip_ptr)
73 {
74
75 #ifndef NX_DISABLE_IPV4
76 TX_INTERRUPT_SAVE_AREA
77
78
79 /* If trace is enabled, insert this event into the trace buffer. */
80 NX_TRACE_IN_LINE_INSERT(NX_TRACE_IP_GATEWAY_ADDRESS_SET, ip_ptr, 0, 0, 0, NX_TRACE_IP_EVENTS, 0, 0);
81
82 /* Obtain the IP internal mutex so the Gateway IP address can be cleared. */
83 tx_mutex_get(&(ip_ptr -> nx_ip_protection), TX_WAIT_FOREVER);
84
85 /* Disable interrupts. */
86 TX_DISABLE
87
88 /* Clear the Gateway IP address. */
89 ip_ptr -> nx_ip_gateway_address = 0;
90
91 ip_ptr -> nx_ip_gateway_interface = NX_NULL;
92
93 /* Restore interrupts. */
94 TX_RESTORE
95
96 /* Release the protection mutex. */
97 tx_mutex_put(&(ip_ptr -> nx_ip_protection));
98
99 /* Return completion status. */
100 return(NX_SUCCESS);
101 #else /* NX_DISABLE_IPV4 */
102 NX_PARAMETER_NOT_USED(ip_ptr);
103
104 return(NX_NOT_SUPPORTED);
105 #endif /* !NX_DISABLE_IPV4 */
106 }
107
108
