summaryrefslogtreecommitdiff
path: root/common/src/nxe_arp_info_get.c
blob: 6a2944c46fa57a2889f5385fe1b0538217e068ff (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/***************************************************************************
 * Copyright (c) 2024 Microsoft Corporation
 * Copyright (c) 2025-present Eclipse ThreadX Contributors
 *
 * This program and the accompanying materials are made available under the
 * terms of the MIT License which is available at
 * https://opensource.org/licenses/MIT.
 *
 * SPDX-License-Identifier: MIT
 **************************************************************************/


/**************************************************************************/
/**************************************************************************/
/**                                                                       */
/** NetX Component                                                        */
/**                                                                       */
/**   Address Resolution Protocol (ARP)                                   */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/

#define NX_SOURCE_CODE


/* Include necessary system files.  */

#include "nx_api.h"
#include "nx_ip.h"
#include "nx_arp.h"


/* Bring in externs for caller checking code.  */

NX_CALLER_CHECKING_EXTERNS


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _nxe_arp_info_get                                   PORTABLE C      */
/*                                                           6.4.3        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Yuxin Zhou, Microsoft Corporation                                   */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function checks for errors in the ARP information get          */
/*    function call.                                                      */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    ip_ptr                                IP instance pointer           */
/*    arp_requests_sent                     Destination for number of ARP */
/*                                            requests sent               */
/*    arp_requests_received                 Destination for number of ARP */
/*                                            requests received           */
/*    arp_responses_sent                    Destination for number of ARP */
/*                                            responses sent              */
/*    arp_responses_received                Destination for number of ARP */
/*                                            responses received          */
/*    arp_dynamic_entries                   Destination for number of ARP */
/*                                            dynamic entries             */
/*    arp_static_entries                    Destination for number of ARP */
/*                                            static entries              */
/*    arp_aged_entries                      Destination for number of ARP */
/*                                            aged entries                */
/*    arp_invalid_messages                  Destination for number of ARP */
/*                                            invalid messages            */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    status                                Completion status             */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _nx_arp_info_get                      Actual ARP information get    */
/*                                            function                    */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Application Code                                                    */
/*                                                                        */
/**************************************************************************/
UINT  _nxe_arp_info_get(NX_IP *ip_ptr, ULONG *arp_requests_sent, ULONG *arp_requests_received,
                        ULONG *arp_responses_sent, ULONG *arp_responses_received,
                        ULONG *arp_dynamic_entries, ULONG *arp_static_entries,
                        ULONG *arp_aged_entries, ULONG *arp_invalid_messages)
{

#ifndef NX_DISABLE_IPV4
UINT status;


    /* Check for invalid input pointers.  */
    if ((ip_ptr == NX_NULL) || (ip_ptr -> nx_ip_id != NX_IP_ID))
    {
        return(NX_PTR_ERROR);
    }

    /* Check to see if ARP is enabled.  */
    if (!ip_ptr -> nx_ip_arp_allocate)
    {
        return(NX_NOT_ENABLED);
    }

    /* Check for appropriate caller.  */
    NX_THREADS_ONLY_CALLER_CHECKING

    /* Call actual ARP information get function.  */
    status =  _nx_arp_info_get(ip_ptr, arp_requests_sent, arp_requests_received,
                               arp_responses_sent, arp_responses_received,
                               arp_dynamic_entries, arp_static_entries,
                               arp_aged_entries, arp_invalid_messages);

    /* Return completion status.  */
    return(status);
#else /* NX_DISABLE_IPV4  */
    NX_PARAMETER_NOT_USED(ip_ptr);
    NX_PARAMETER_NOT_USED(arp_requests_sent);
    NX_PARAMETER_NOT_USED(arp_requests_received);
    NX_PARAMETER_NOT_USED(arp_responses_sent);
    NX_PARAMETER_NOT_USED(arp_responses_received);
    NX_PARAMETER_NOT_USED(arp_dynamic_entries);
    NX_PARAMETER_NOT_USED(arp_static_entries);
    NX_PARAMETER_NOT_USED(arp_aged_entries);
    NX_PARAMETER_NOT_USED(arp_invalid_messages);

    return(NX_NOT_SUPPORTED);
#endif /* !NX_DISABLE_IPV4  */
}