AM64x MCU+ SDK  08.02.00
enet_mod_fdb.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_FDB_H_
48 #define ENET_MOD_FDB_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_FDB_PUBLIC_IOCTL(x) (ENET_IOCTL_TYPE_PUBLIC | \
67  ENET_IOCTL_FDB_BASE | \
68  ENET_IOCTL_MIN(x))
69 
70 /* ========================================================================== */
71 /* Structures and Enums */
72 /* ========================================================================== */
73 
84 typedef enum EnetFdb_Ioctl_e
85 {
93  ENET_FDB_IOCTL_GET_VERSION = ENET_FDB_PUBLIC_IOCTL(0U),
94 
102  ENET_FDB_IOCTL_PRINT_REGS = ENET_FDB_PUBLIC_IOCTL(1U),
103 } EnetFdb_Ioctl;
104 
105 /* ========================================================================== */
106 /* Global Variables Declarations */
107 /* ========================================================================== */
108 
109 /* None */
110 
111 /* ========================================================================== */
112 /* Function Declarations */
113 /* ========================================================================== */
114 
115 /* None */
116 
117 /* ========================================================================== */
118 /* Deprecated Function Declarations */
119 /* ========================================================================== */
120 
121 /* None */
122 
123 /* ========================================================================== */
124 /* Static Function Definitions */
125 /* ========================================================================== */
126 
127 /* None */
128 
129 #ifdef __cplusplus
130 }
131 #endif
132 
133 #endif /* ENET_MOD_FDB_H_ */
134 
ENET_FDB_IOCTL_GET_VERSION
@ ENET_FDB_IOCTL_GET_VERSION
Get the hardware version of the FDB module.
Definition: enet_mod_fdb.h:93
EnetFdb_Ioctl
EnetFdb_Ioctl
FDB IOCTL commands.
Definition: enet_mod_fdb.h:85
ENET_FDB_IOCTL_PRINT_REGS
@ ENET_FDB_IOCTL_PRINT_REGS
Print FDB registers.
Definition: enet_mod_fdb.h:102
ENET_FDB_PUBLIC_IOCTL
#define ENET_FDB_PUBLIC_IOCTL(x)
Helper macro to create IOCTL commands for FDB module.
Definition: enet_mod_fdb.h:66
enet_mod.h
This file contains the type definitions and helper macros for the Enet Module interface.