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