AM64x MCU+ SDK  08.02.00
enet_base.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 
40 #ifndef ENET_BASE_H_
41 #define ENET_BASE_H_
42 
43 /* ========================================================================== */
44 /* Include Files */
45 /* ========================================================================== */
46 
47 #include <stdint.h>
48 #include <string.h>
49 #include <include/core/enet_types.h>
50 #include <include/core/enet_per.h>
51 #include <include/core/enet_trace.h>
52 
53 #ifdef __cplusplus
54 extern "C" {
55 #endif
56 
57 /* ========================================================================== */
58 /* Macros */
59 /* ========================================================================== */
60 
63 #define ENET_FEAT_ALL (0xFFFFFFFFU)
64 
67 #define ENET_FEAT_BASE (0x00000000U)
68 
70 #define ENET_FEAT_IS_EN(feats, mask) (((feats) & (mask)) != 0U)
71 
73 #define ENET_ERRATA_NONE (0x00000000U)
74 
76 #define ENET_ERRATA_IS_ANY(mask) ((mask) != ENET_ERRATA_NONE)
77 
79 #define ENET_ERRATA_IS_EN(erratas, mask) (((erratas) & (mask)) != 0U)
80 
81 /* ========================================================================== */
82 /* Structures and Enums */
83 /* ========================================================================== */
84 
88 typedef struct Enet_Obj_s
89 {
91  EnetPer_Obj *enetPer;
92 
94  Enet_Magic magic;
95 
97  void *lock;
98 } Enet_Obj;
99 
105 typedef struct Enet_Obj_s *Enet_Handle;
106 
107 /* ========================================================================== */
108 /* Global Variables Declarations */
109 /* ========================================================================== */
110 
111 /* None */
112 
113 /* ========================================================================== */
114 /* Function Declarations */
115 /* ========================================================================== */
116 
127 static inline EnetPer_Handle Enet_getPerHandle(Enet_Handle hEnet);
128 
129 /* ========================================================================== */
130 /* Deprecated Function Declarations */
131 /* ========================================================================== */
132 
133 /* None */
134 
135 /* ========================================================================== */
136 /* Static Function Definitions */
137 /* ========================================================================== */
138 
139 static inline EnetPer_Handle Enet_getPerHandle(Enet_Handle hEnet)
140 {
141  return hEnet->enetPer;
142 }
143 
144 #ifdef __cplusplus
145 }
146 #endif
147 
148 #endif /* ENET_BASE_H_ */
enet_trace.h
This file contains the type definitions and helper macros for the Enet Trace interface.
enet_types.h
This file contains the basic types using across the Enet driver.
Enet_Magic
Enet_Magic
Enet driver magic value, used to indicate if driver is open or not.
Definition: enet_types.h:232
EnetPer_Obj
Ethernet Peripheral object.
Definition: enet_per.h:462
Enet_getPerHandle
static EnetPer_Handle Enet_getPerHandle(Enet_Handle hEnet)
Get the Enet Peripheral handle associated with Enet driver.
Definition: enet_base.h:139
Enet_Obj
Enet object.
Definition: enet_base.h:89
enet_per.h
This file contains the type definitions and helper macros for the Enet Peripheral interface.
EnetPer_Handle
struct EnetPer_Obj_s * EnetPer_Handle
Ethernet Peripheral handle.
Definition: enet_per.h:299
Enet_Obj::lock
void * lock
Definition: enet_base.h:97
Enet_Obj::enetPer
EnetPer_Obj * enetPer
Definition: enet_base.h:91
Enet_Handle
struct Enet_Obj_s * Enet_Handle
Ethernet driver handle.
Definition: enet_base.h:105
Enet_Obj::magic
Enet_Magic magic
Definition: enet_base.h:94