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