summaryrefslogtreecommitdiff
path: root/common/src/nxe_ip_info_get.c
blob: 88c14b76642bf218b0711b70b682fda516b41e1b (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
/***************************************************************************
 * 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                                                        */
/**                                                                       */
/**   Internet Protocol (IP)                                              */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/

#define NX_SOURCE_CODE


/* Include necessary system files.  */

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

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

/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _nxe_ip_info_get                                    PORTABLE C      */
/*                                                           6.4.3        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Yuxin Zhou, Microsoft Corporation                                   */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function checks for errors in the IP information get           */
/*    function call.                                                      */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    ip_ptr                                Pointer to IP instance        */
/*    ip_total_packets_sent                 Destination for number of     */
/*                                            packets sent                */
/*    ip_total_bytes_sent                   Destination for number of     */
/*                                            bytes sent                  */
/*    ip_total_packets_received             Destination for number of     */
/*                                            packets received            */
/*    ip_total_bytes_received               Destination for number of     */
/*                                            bytes received              */
/*    ip_invalid_packets                    Destination for number of     */
/*                                            invalid packets             */
/*    ip_receive_packets_dropped            Destination for number of     */
/*                                            packets dropped             */
/*    ip_receive_checksum_errors            Destination for number of     */
/*                                            checksum errors             */
/*    ip_send_packets_dropped               Destination for number of     */
/*                                            send packets dropped        */
/*    ip_total_fragments_sent               Destination for number of     */
/*                                            fragments sent              */
/*    ip_total_fragments_received           Destination for number of     */
/*                                            fragments received          */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    status                                Completion status             */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _nx_ip_info_get                       Actual IP information get     */
/*                                            function                    */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Application                                                         */
/*                                                                        */
/**************************************************************************/
UINT  _nxe_ip_info_get(NX_IP *ip_ptr, ULONG *ip_total_packets_sent, ULONG *ip_total_bytes_sent,
                       ULONG *ip_total_packets_received, ULONG *ip_total_bytes_received,
                       ULONG *ip_invalid_packets, ULONG *ip_receive_packets_dropped,
                       ULONG *ip_receive_checksum_errors, ULONG *ip_send_packets_dropped,
                       ULONG *ip_total_fragments_sent, ULONG *ip_total_fragments_received)
{

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 for appropriate caller.  */
    NX_INIT_AND_THREADS_CALLER_CHECKING

    /* Call actual IP information get function.  */
    status =  _nx_ip_info_get(ip_ptr, ip_total_packets_sent, ip_total_bytes_sent, ip_total_packets_received,
                              ip_total_bytes_received, ip_invalid_packets, ip_receive_packets_dropped,
                              ip_receive_checksum_errors, ip_send_packets_dropped,
                              ip_total_fragments_sent, ip_total_fragments_received);

    /* Return completion status.  */
    return(status);
}