AM62L FreeRTOS SDK  11.00.00
enet_mod_stats.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) Texas Instruments Incorporated 2020
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the
14  * distribution.
15  *
16  * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
47 #ifndef ENET_MOD_STATS_H_
48 #define ENET_MOD_STATS_H_
49 
50 /* ========================================================================== */
51 /* Include Files */
52 /* ========================================================================== */
53 
54 #include <stdint.h>
55 #include <include/core/enet_mod.h>
56 
57 #ifdef __cplusplus
58 extern "C" {
59 #endif
60 
61 /* ========================================================================== */
62 /* Macros */
63 /* ========================================================================== */
64 
66 #define ENET_STATS_PUBLIC_IOCTL(x) (ENET_IOCTL_TYPE_PUBLIC | \
67  ENET_IOCTL_STATS_BASE | \
68  ENET_IOCTL_MIN(x))
69 
70 /* ========================================================================== */
71 /* Structures and Enums */
72 /* ========================================================================== */
73 
77 typedef enum EnetStats_Ioctl_e
78 {
87 
96 
112 
127 
141 
154 #if ENET_CFG_IS_ON(CPSW_NPAC_PORT)
155 
167  ENET_STATS_IOCTL_GET_NPACPORT_STATS = ENET_STATS_PUBLIC_IOCTL(6U),
168 #endif
170 
171 
172 /* ========================================================================== */
173 /* Global Variables Declarations */
174 /* ========================================================================== */
175 
176 /* None */
177 
178 /* ========================================================================== */
179 /* Function Declarations */
180 /* ========================================================================== */
181 
182 /* None */
183 
184 /* ========================================================================== */
185 /* Deprecated Function Declarations */
186 /* ========================================================================== */
187 
188 /* None */
189 
190 /* ========================================================================== */
191 /* Static Function Definitions */
192 /* ========================================================================== */
193 
194 /* None */
195 
196 #ifdef __cplusplus
197 }
198 #endif
199 
200 #endif /* ENET_MOD_STATS_H_ */
201 
ENET_STATS_IOCTL_GET_VERSION
@ ENET_STATS_IOCTL_GET_VERSION
Get the hardware version of the Stats module.
Definition: enet_mod_stats.h:86
ENET_STATS_IOCTL_PRINT_REGS
@ ENET_STATS_IOCTL_PRINT_REGS
Print Stats registers.
Definition: enet_mod_stats.h:95
ENET_STATS_PUBLIC_IOCTL
#define ENET_STATS_PUBLIC_IOCTL(x)
Helper macro to create IOCTL commands for STATS module.
Definition: enet_mod_stats.h:66
ENET_STATS_IOCTL_RESET_HOSTPORT_STATS
@ ENET_STATS_IOCTL_RESET_HOSTPORT_STATS
Reset host port statistics.
Definition: enet_mod_stats.h:140
ENET_STATS_IOCTL_GET_HOSTPORT_STATS
@ ENET_STATS_IOCTL_GET_HOSTPORT_STATS
Get host port statistics.
Definition: enet_mod_stats.h:111
ENET_STATS_IOCTL_GET_MACPORT_STATS
@ ENET_STATS_IOCTL_GET_MACPORT_STATS
Get MAC port statistics.
Definition: enet_mod_stats.h:126
EnetStats_Ioctl
EnetStats_Ioctl
Statistics IOCTL commands.
Definition: enet_mod_stats.h:78
ENET_STATS_IOCTL_RESET_MACPORT_STATS
@ ENET_STATS_IOCTL_RESET_MACPORT_STATS
Reset MAC port statistics.
Definition: enet_mod_stats.h:153
enet_mod.h
This file contains the type definitions and helper macros for the Enet Module interface.