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