AM263Px MCU+ SDK: enet_base.h Source File

| AM263Px MCU+ SDK 26.00.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 #include <include/core/enet_osal.h>
53
54 #ifdef __cplusplus
55 extern "C" {
56 #endif
57
58 /* ========================================================================== */
59 /* Macros */
60 /* ========================================================================== */
61
64 #define ENET_FEAT_ALL (0xFFFFFFFFU)
65
68 #define ENET_FEAT_BASE (0x00000000U)
69
71 #define ENET_FEAT_IS_EN(feats, mask) (((feats) & (mask)) != 0U)
72
74 #define ENET_ERRATA_NONE (0x00000000U)
75
77 #define ENET_ERRATA_IS_ANY(mask) ((mask) != ENET_ERRATA_NONE)
78
80 #define ENET_ERRATA_IS_EN(erratas, mask) (((erratas) & (mask)) != 0U)
81
82 /* ========================================================================== */
83 /* Structures and Enums */
84 /* ========================================================================== */
85
89 typedef struct Enet_Obj_s
90 {
92 EnetPer_Obj *enetPer;
93
95 Enet_Magic magic;
96
98 SemaphoreP_enetOsal * lock;
99 } Enet_Obj;
100
106 typedef struct Enet_Obj_s *Enet_Handle;
107
108 /* ========================================================================== */
109 /* Global Variables Declarations */
110 /* ========================================================================== */
111
112 /* None */
113
114 /* ========================================================================== */
115 /* Function Declarations */
116 /* ========================================================================== */
117
128 static inline EnetPer_Handle Enet_getPerHandle(Enet_Handle hEnet);
129
130 /* ========================================================================== */
131 /* Deprecated Function Declarations */
132 /* ========================================================================== */
133
134 /* None */
135
136 /* ========================================================================== */
137 /* Static Function Definitions */
138 /* ========================================================================== */
139
140 static inline EnetPer_Handle Enet_getPerHandle(Enet_Handle hEnet)
141 {
142 return hEnet->enetPer;
143 }
144
145 #ifdef __cplusplus
146 }
147 #endif
148
149 #endif /* ENET_BASE_H_ */
enet_trace.h
This file contains the type definitions and helper macros for the Enet Trace interface.
SemaphoreP_enetOsal
Semaphore structure.
Definition: enet_osal.h:70
enet_osal.h
This file contains the OSAL API of the Enet driver.
enet_types.h
This file contains the basic types using across the Enet driver.
Enet_Obj::lock
SemaphoreP_enetOsal * lock
Definition: enet_base.h:98
Enet_Magic
Enet_Magic
Enet driver magic value, used to indicate if driver is open or not.
Definition: enet_types.h:238
EnetPer_Obj
Ethernet Peripheral object.
Definition: enet_per.h:568
Enet_getPerHandle
static EnetPer_Handle Enet_getPerHandle(Enet_Handle hEnet)
Get the Enet Peripheral handle associated with Enet driver.
Definition: enet_base.h:140
Enet_Obj
Enet object.
Definition: enet_base.h:90
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:380
Enet_Obj::enetPer
EnetPer_Obj * enetPer
Definition: enet_base.h:92
Enet_Handle
struct Enet_Obj_s * Enet_Handle
Ethernet driver handle.
Definition: enet_base.h:106
Enet_Obj::magic
Enet_Magic magic
Definition: enet_base.h:95