AM261x MCU+ SDK: enet_mod_stats.h Source File

| AM261x MCU+ SDK 26.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_types.h>
56 #include <include/core/enet_ioctl.h>
57
58 #ifdef __cplusplus
59 extern "C" {
60 #endif
61
62 /* ========================================================================== */
63 /* Macros */
64 /* ========================================================================== */
65
67 #define ENET_STATS_PUBLIC_IOCTL(x) (ENET_IOCTL_TYPE_PUBLIC | \
68 ENET_IOCTL_STATS_BASE | \
69 ENET_IOCTL_MIN(x))
70
71 /* ========================================================================== */
72 /* Structures and Enums */
73 /* ========================================================================== */
74
78 typedef enum EnetStats_Ioctl_e
79 {
87 ENET_STATS_IOCTL_GET_VERSION = ENET_STATS_PUBLIC_IOCTL(0U),
88
96 ENET_STATS_IOCTL_PRINT_REGS = ENET_STATS_PUBLIC_IOCTL(1U),
97
112 ENET_STATS_IOCTL_GET_HOSTPORT_STATS = ENET_STATS_PUBLIC_IOCTL(2U),
113
127 ENET_STATS_IOCTL_GET_MACPORT_STATS = ENET_STATS_PUBLIC_IOCTL(3U),
128
141 ENET_STATS_IOCTL_RESET_HOSTPORT_STATS = ENET_STATS_PUBLIC_IOCTL(4U),
142
154 ENET_STATS_IOCTL_RESET_MACPORT_STATS = ENET_STATS_PUBLIC_IOCTL(5U),
155 } EnetStats_Ioctl;
156
157
158 /* ========================================================================== */
159 /* Global Variables Declarations */
160 /* ========================================================================== */
161
162 /* None */
163
164 /* ========================================================================== */
165 /* Function Declarations */
166 /* ========================================================================== */
167
168 /* None */
169
170 /* ========================================================================== */
171 /* Deprecated Function Declarations */
172 /* ========================================================================== */
173
174 /* None */
175
176 /* ========================================================================== */
177 /* Static Function Definitions */
178 /* ========================================================================== */
179
180 /* None */
181
182 #ifdef __cplusplus
183 }
184 #endif
185
186 #endif /* ENET_MOD_STATS_H_ */
187
ENET_STATS_IOCTL_GET_VERSION
@ ENET_STATS_IOCTL_GET_VERSION
Get the hardware version of the Stats module.
Definition: enet_mod_stats.h:87
ENET_STATS_IOCTL_PRINT_REGS
@ ENET_STATS_IOCTL_PRINT_REGS
Print Stats registers.
Definition: enet_mod_stats.h:96
ENET_STATS_PUBLIC_IOCTL
#define ENET_STATS_PUBLIC_IOCTL(x)
Helper macro to create IOCTL commands for STATS module.
Definition: enet_mod_stats.h:67
ENET_STATS_IOCTL_RESET_HOSTPORT_STATS
@ ENET_STATS_IOCTL_RESET_HOSTPORT_STATS
Reset host port statistics.
Definition: enet_mod_stats.h:141
enet_types.h
This file contains the basic types using across the Enet driver.
ENET_STATS_IOCTL_GET_HOSTPORT_STATS
@ ENET_STATS_IOCTL_GET_HOSTPORT_STATS
Get host port statistics.
Definition: enet_mod_stats.h:112
ENET_STATS_IOCTL_GET_MACPORT_STATS
@ ENET_STATS_IOCTL_GET_MACPORT_STATS
Get MAC port statistics.
Definition: enet_mod_stats.h:127
enet_ioctl.h
This file contains the type definitions and helper macros for the Enet IOCTL interface.
EnetStats_Ioctl
EnetStats_Ioctl
Statistics IOCTL commands.
Definition: enet_mod_stats.h:79
ENET_STATS_IOCTL_RESET_MACPORT_STATS
@ ENET_STATS_IOCTL_RESET_MACPORT_STATS
Reset MAC port statistics.
Definition: enet_mod_stats.h:154