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