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_arp.h"
30 #include "nx_ip.h"
31 
32 /* Bring in externs for caller checking code.  */
33 NX_CALLER_CHECKING_EXTERNS
34 
35 /**************************************************************************/
36 /*                                                                        */
37 /*  FUNCTION                                               RELEASE        */
38 /*                                                                        */
39 /*    _nxe_arp_entry_delete                               PORTABLE C      */
40 /*                                                           6.1          */
41 /*  AUTHOR                                                                */
42 /*                                                                        */
43 /*    Yuxin Zhou, Microsoft Corporation                                   */
44 /*                                                                        */
45 /*  DESCRIPTION                                                           */
46 /*                                                                        */
47 /*    This function performs error checking for the ARP entry delete      */
48 /*    service.                                                            */
49 /*                                                                        */
50 /*  INPUT                                                                 */
51 /*                                                                        */
52 /*    ip_ptr                                IP instance pointer           */
53 /*    ip_address                            IP Address to search for      */
54 /*                                                                        */
55 /*  OUTPUT                                                                */
56 /*                                                                        */
57 /*    status                                Completion status             */
58 /*                                                                        */
59 /*  CALLS                                                                 */
60 /*                                                                        */
61 /*    _nx_arp_entry_delet                   Actual ARP delete service     */
62 /*                                                                        */
63 /*  CALLED BY                                                             */
64 /*                                                                        */
65 /*    Application Code                                                    */
66 /*                                                                        */
67 /*  RELEASE HISTORY                                                       */
68 /*                                                                        */
69 /*    DATE              NAME                      DESCRIPTION             */
70 /*                                                                        */
71 /*  05-19-2020     Yuxin Zhou               Initial Version 6.0           */
72 /*  09-30-2020     Yuxin Zhou               Modified comment(s),          */
73 /*                                            resulting in version 6.1    */
74 /*                                                                        */
75 /**************************************************************************/
_nxe_arp_entry_delete(NX_IP * ip_ptr,ULONG ip_address)76 UINT  _nxe_arp_entry_delete(NX_IP *ip_ptr, ULONG ip_address)
77 {
78 
79 #ifndef NX_DISABLE_IPV4
80 UINT status;
81 
82     /* Check for invalid IP pointer. */
83     if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID))
84     {
85 
86         return(NX_PTR_ERROR);
87     }
88 
89     /* Check for invalid IP address. */
90     if (ip_address == 0x0)
91     {
92 
93         return(NX_IP_ADDRESS_ERROR);
94     }
95 
96     NX_INIT_AND_THREADS_CALLER_CHECKING
97 
98     /* Call the actual service. */
99     status = _nx_arp_entry_delete(ip_ptr, ip_address);
100 
101     return(status);
102 #else /* NX_DISABLE_IPV4  */
103     NX_PARAMETER_NOT_USED(ip_ptr);
104     NX_PARAMETER_NOT_USED(ip_address);
105 
106     return(NX_NOT_SUPPORTED);
107 #endif /* !NX_DISABLE_IPV4  */
108 }
109 
110