VSF Documented
eth.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Copyright(C)2009-2022 by VSF Team *
3 * *
4 * Licensed under the Apache License, Version 2.0 (the "License"); *
5 * you may not use this file except in compliance with the License. *
6 * You may obtain a copy of the License at *
7 * *
8 * http://www.apache.org/licenses/LICENSE-2.0 *
9 * *
10 * Unless required by applicable law or agreed to in writing, software *
11 * distributed under the License is distributed on an "AS IS" BASIS, *
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
13 * See the License for the specific language governing permissions and *
14 * limitations under the License. *
15 * *
16 ****************************************************************************/
17
18#ifndef __HAL_DRIVER_${SERIES/ETH_IP}_ETH_H__
19#define __HAL_DRIVER_${SERIES/ETH_IP}_ETH_H__
20
21/*============================ INCLUDES ======================================*/
22
23#include "hal/vsf_hal_cfg.h"
24
25#if VSF_HAL_USE_ETH == ENABLED
26
27// HW/IPCore
32// HW/IPCore end
33
34#include "../../__device.h"
35
36/*\note Refer to template/README.md for usage cases.
37 * For peripheral drivers, blackbox mode is recommended but not required, reimplementation part MUST be open.
38 * For IPCore drivers, class structure, MULTI_CLASS configuration, reimplementation and class APIs should be open to user.
39 * For emulated drivers, **** No reimplementation ****.
40 */
41
42/*\note Includes CAN ONLY be put here. */
43/*\note If current header is for a peripheral driver(hw driver), and inherit from an IPCore driver, include IPCore header here. */
44
45// IPCore
46#if defined(__VSF_HAL_${ETH_IP}_ETH_CLASS_IMPLEMENT)
47# define __VSF_CLASS_IMPLEMENT__
48#elif defined(__VSF_HAL_${ETH_IP}_ETH_CLASS_INHERIT__)
49# define __VSF_CLASS_INHERIT__
50#endif
51
52#include "utilities/ooc_class.h"
53// IPCore end
54
55#ifdef __cplusplus
56extern "C" {
57#endif
58
59/*============================ ETHROS ========================================*/
60
61/*\note VSF_${ETH_IP}_ETH_CFG_MULTI_CLASS should be implemented for IP drives and open to user,
62 * while VSF_HW_ETH_CFG_MULTI_CLASS should be in eth.c.
63 */
64
65// IPCore
66#ifndef VSF_${ETH_IP}_ETH_CFG_MULTI_CLASS
67# define VSF_${ETH_IP}_ETH_CFG_MULTI_CLASS VSF_ETH_CFG_MULTI_CLASS
68#endif
69// IPCore end
70
71// HW
72/*\note hw ETH driver can reimplement following types:
73 * To enable reimplementation, please enable ethro below:
74 * VSF_ETH_CFG_REIMPLEMENT_TYPE_PHY_MODE for vsf_eth_mode_t
75 * VSF_ETH_CFG_REIMPLEMENT_TYPE_MODE for vsf_eth_mode_t
76 * VSF_ETH_CFG_REIMPLEMENT_TYPE_IRQ_MASK for vsf_eth_irq_mask_t
77 * VSF_ETH_CFG_REIMPLEMENT_TYPE_CTRL for vsf_eth_ctrl_t
78 * VSF_ETH_CFG_REIMPLEMENT_TYPE_CFG for vsf_eth_cfg_t
79 * VSF_ETH_CFG_REIMPLEMENT_TYPE_STATUS for vsf_eth_status_t
80 * VSF_ETH_CFG_REIMPLEMENT_TYPE_CAPABILITY for vsf_eth_capability_t
81 * VSF_ETH_CFG_REIMPLEMENT_TYPE_BUF_MODE for vsf_eth_buf_mode_t
82 * VSF_ETH_CFG_REIMPLEMENT_TYPE_BUF_DESC for vsf_eth_buf_desc_t
83 * VSF_ETH_CFG_REIMPLEMENT_TYPE_SEND_BUF_DESC for vsf_eth_send_buf_desc_t
84 * VSF_ETH_CFG_REIMPLEMENT_TYPE_RECV_BUF_DESC for vsf_eth_recv_buf_desc_t
85 * VSF_ETH_CFG_REIMPLEMENT_TYPE_SG_BUF_DESC for vsf_eth_sg_buf_desc_t
86 * Reimplementation is used for optimization hw/IPCore drivers, reimplement the bit mask according to hw registers.
87 * *** DO NOT reimplement these in emulated drivers. ***
88 */
89
90#define VSF_ETH_CFG_REIMPLEMENT_TYPE_PHY_MODE ENABLED
91#define VSF_ETH_CFG_REIMPLEMENT_TYPE_MODE ENABLED
92#define VSF_ETH_CFG_REIMPLEMENT_TYPE_IRQ_MASK ENABLED
93#define VSF_ETH_CFG_REIMPLEMENT_TYPE_CTRL ENABLED
94#define VSF_ETH_CFG_REIMPLEMENT_TYPE_CFG ENABLED
95#define VSF_ETH_CFG_REIMPLEMENT_TYPE_STATUS ENABLED
96#define VSF_ETH_CFG_REIMPLEMENT_TYPE_CAPABILITY ENABLED
97#define VSF_ETH_CFG_REIMPLEMENT_TYPE_BUF_MODE ENABLED
98#define VSF_ETH_CFG_REIMPLEMENT_TYPE_BUF_DESC ENABLED
99#define VSF_ETH_CFG_REIMPLEMENT_TYPE_SEND_BUF_DESC ENABLED
100#define VSF_ETH_CFG_REIMPLEMENT_TYPE_RECV_BUF_DESC ENABLED
101#define VSF_ETH_CFG_REIMPLEMENT_TYPE_SG_BUF_DESC ENABLED
102// HW end
103
104/*============================ ETHROFIED FUNCTIONS ===========================*/
105/*============================ TYPES =========================================*/
106
107// IPCore
108vsf_class(vsf_${eth_ip}_eth_t) {
109#if VSF_${ETH_IP}_CFG_MULTI_CLASS == ENABLED
110 public_member(
111 vsf_eth_t vsf_eth;
112 )
113#endif
114
115/*\note You can add more member in vsf_${eth_ip}_eth_t instance.
116 * For members accessible from child, put in protected_member.
117 * Else, put in private_member.
118 */
119
120 protected_member(
121 vsf_${eth_ip}_eth_reg_t *reg;
124};
125// IPCore end
126
127// HW/IPCore, not for emulated drivers
128#if VSF_ETH_CFG_REIMPLEMENT_TYPE_PHY_MODE == ENABLED
129typedef enum vsf_eth_phy_mode_t {
133
136
137 // Add more vendor-specific modes here
139#endif
140
141#if VSF_ETH_CFG_REIMPLEMENT_TYPE_MODE == ENABLED
142typedef enum vsf_eth_mode_t {
145
146 // Add more vendor-specific modes here
148#endif
149
150#if VSF_ETH_CFG_REIMPLEMENT_TYPE_IRQ_MASK == ENABLED
151typedef enum vsf_eth_irq_mask_t {
159
160 // Add more vendor-specific interrupt masks here
162#endif
163
164#if VSF_ETH_CFG_REIMPLEMENT_TYPE_CTRL == ENABLED
165typedef enum vsf_eth_ctrl_t {
167
168 // Add more vendor-specific control commands here
170#endif
171
172#if VSF_ETH_CFG_REIMPLEMENT_TYPE_CFG == ENABLED
173typedef struct vsf_eth_t vsf_eth_t;
174typedef void vsf_eth_isr_handler_t(void *target_ptr, vsf_eth_t *eth_ptr,
176typedef struct vsf_eth_isr_t {
178 void *target_ptr;
181typedef struct vsf_eth_cfg_t {
187#endif
188
189#if VSF_ETH_CFG_REIMPLEMENT_TYPE_STATUS == ENABLED
190typedef struct vsf_eth_status_t {
191 union {
194 struct {
197 };
198 };
200#endif
201
202#if VSF_ETH_CFG_REIMPLEMENT_TYPE_CAPABILITY == ENABLED
203typedef struct vsf_eth_capability_t {
204#if VSF_ETH_CFG_INHERIT_HAL_CAPABILITY == ENABLED
206#endif
207
208 vsf_eth_mode_t support_modes;
211
212 union {
214 struct {
217 };
218 };
219
220 // Add more vendor-specific capabilities here
222#endif
223
224#if VSF_ETH_CFG_REIMPLEMENT_TYPE_BUF_MODE == ENABLED
225typedef enum vsf_eth_buf_mode_t {
228
229 // Add more vendor-specific buffer modes here
231#endif
232
233#if VSF_ETH_CFG_REIMPLEMENT_TYPE_BUF_DESC == ENABLED
234typedef struct vsf_eth_buf_desc_t {
236 void *payload;
239#endif
240
241#if VSF_ETH_CFG_REIMPLEMENT_TYPE_SEND_BUF_DESC == ENABLED
243#endif
244
245#if VSF_ETH_CFG_REIMPLEMENT_TYPE_RECV_BUF_DESC == ENABLED
247#endif
248
249#if VSF_ETH_CFG_REIMPLEMENT_TYPE_SG_SEND_BUF == DISABLED
251#endif
252
253#if VSF_ETH_CFG_REIMPLEMENT_TYPE_SG_RECV_BUF == DISABLED
255#endif
256// HW/IPCore end
257
258
259/*============================ INCLUDES ======================================*/
260
261// IPCore
262/*\note Extern APIs for ip core diriver.
263 * There is no requirement about how APIs of IPCore drivers should be implemented.
264 * Just consider the simplicity for actual peripheral drivers.
265 */
266// IPCore end
267
268#ifdef __cplusplus
269}
270#endif
271
272// IPCore
273#undef __VSF_HAL_${ETH_IP}_ETH_CLASS_IMPLEMENT
274#undef __VSF_HAL_${ETH_IP}_ETH_CLASS_INHERIT__
275// IPCore end
276
277#endif // VSF_HAL_USE_ETH
278#endif // __HAL_DRIVER_${SERIES/ETH_IP}_ETH_H__
279/* EOF */
Definition adc.h:94
vsf_arch_prio_t
Definition cortex_a_generic.h:88
vsf_eth_buf_desc_t vsf_eth_recv_buf_desc_t
Definition eth.h:246
vsf_eth_irq_mask_t
Definition eth.h:151
@ VSF_ETH_IRQ_MASK_ERROR
Definition eth.h:157
@ VSF_ETH_IRQ_MASK_RX_AVAILABLE
Definition eth.h:152
@ VSF_ETH_IRQ_MASK_PHY_LINK_CHANGE
Definition eth.h:156
@ VSF_ETH_IRQ_MASK_SG_TX_COMPLETE
Definition eth.h:155
@ VSF_ETH_IRQ_MASK_SG_RX_AVAILABLE
Definition eth.h:154
@ VSF_ETH_IRQ_MASK_OVERFLOW
Definition eth.h:158
@ VSF_ETH_IRQ_MASK_TX_COMPLETE
Definition eth.h:153
vsf_eth_ctrl_t
Definition eth.h:165
@ VSF_ETH_CTRL_GET_MAC_ADDRESS
Definition eth.h:166
vsf_eth_buf_mode_t
Definition eth.h:225
@ VSF_ETH_BUF_MODE_TX_CHECKSUM_OFFLOAD
Definition eth.h:226
@ VSF_ETH_BUF_MODE_RX_CHECKSUM_OFFLOAD
Definition eth.h:227
vsf_eth_isr_t isr
Definition eth.h:123
vsf_eth_mode_t
Definition eth.h:142
@ VSF_ETH_MODE_TX_CHECKSUM_OFFLOAD
Definition eth.h:143
@ VSF_ETH_MODE_RX_CHECKSUM_OFFLOAD
Definition eth.h:144
vsf_eth_phy_mode_t
Definition eth.h:129
@ VSF_ETH_PHY_MODE_SPEED_1000M
Definition eth.h:132
@ VSF_ETH_PHY_MODE_SPEED_100M
Definition eth.h:131
@ VSF_ETH_PHY_MODE_SPEED_10M
Definition eth.h:130
@ VSF_ETH_PHY_MODE_DUPLEX_HALF
Definition eth.h:134
@ VSF_ETH_PHY_MODE_DUPLEX_FULL
Definition eth.h:135
class vsf_$ * reg
vsf_eth_buf_desc_t vsf_eth_send_sg_buf_desc_t
Definition eth.h:250
vsf_eth_buf_desc_t vsf_eth_send_buf_desc_t
Definition eth.h:242
vsf_eth_buf_desc_t vsf_eth_recv_sg_buf_desc_t
Definition eth.h:254
void vsf_eth_isr_handler_t(void *target_ptr, vsf_eth_t *eth_ptr, vsf_eth_irq_mask_t irq_mask)
Definition eth.h:174
#define vsf_class(__name)
Definition ooc_class.h:48
const i_spi_t vsf_spi_irq_mask_t irq_mask
Definition spi_interface.h:38
unsigned uint32_t
Definition stdint.h:9
unsigned char uint8_t
Definition stdint.h:5
Definition vsf_template_eth.h:636
void * payload
Definition vsf_template_eth.h:638
vsf_eth_buf_mode_t mode
Definition vsf_template_eth.h:637
uint32_t size
Definition eth.h:237
Predefined VSF ETH capability that can be reimplemented in specific hal drivers. The vsf_eth_capabili...
Definition vsf_template_eth.h:596
uint32_t is_send_buf_releasable_immediately
Definition vsf_template_eth.h:613
uint32_t is_sg_send_buf_releasable_immediately
Definition vsf_template_eth.h:620
inherit(vsf_peripheral_capability_t) vsf_eth_mode_t support_modes
vsf_eth_phy_mode_t support_phy_modes
Supported PHY modes, refer to vsf_eth_phy_mode_t.
Definition vsf_template_eth.h:602
uint32_t value
Definition vsf_template_eth.h:606
vsf_eth_irq_mask_t support_irq_mask
Supported IRQ masks, refer to vsf_eth_irq_mask_t.
Definition vsf_template_eth.h:603
ETH configuration structure.
Definition vsf_template_eth.h:556
uint8_t mac_address[6]
MAC address, 6 bytes.
Definition vsf_template_eth.h:559
vsf_eth_phy_mode_t phy_mode
PHY mode, refer to vsf_eth_phy_mode_t.
Definition vsf_template_eth.h:558
vsf_eth_isr_t isr
ETH interrupt configuration, refer to vsf_eth_isr_t.
Definition vsf_template_eth.h:560
vsf_eth_mode_t mode
ETH mode, refer to vsf_eth_mode_t.
Definition vsf_template_eth.h:557
ETH interrupt configuration structure.
Definition vsf_template_eth.h:543
vsf_eth_isr_handler_t * handler_fn
Interrupt handler function pointer.
Definition vsf_template_eth.h:544
void * target_ptr
User-defined target pointer.
Definition vsf_template_eth.h:545
vsf_arch_prio_t prio
Interrupt priority.
Definition vsf_template_eth.h:546
ETH status information structure Contains the current status of ETH operations and FIFO thresholds.
Definition vsf_template_eth.h:573
uint32_t is_tx_ready
TX is ready to accept data.
Definition vsf_template_eth.h:579
uint32_t is_rx_available
RX data is available.
Definition vsf_template_eth.h:578
ETH instance structure, used for ETH Multi Class support, not needed in non Multi Class mode.
Definition vsf_template_eth.h:711
Definition vsf_template_hal_driver.h:203
Definition vsf_template_hal_driver.h:196
vk_av_control_value_t value
Definition vsf_audio.h:171
vsf_eth_irq_mask_t
Definition vsf_template_eth.h:497
vsf_eth_ctrl_t
Definition vsf_template_eth.h:668
vsf_eth_buf_mode_t
Definition vsf_template_eth.h:627
vsf_eth_mode_t
Predefined VSF ETH modes that can be reimplemented in specific HAL drivers.The following modes must b...
Definition vsf_template_eth.h:378
vsf_eth_phy_mode_t
Predefined VSF ETH modes that can be reimplemented in specific HAL drivers.The following modes must b...
Definition vsf_template_eth.h:319
Generated from commit: vsfteam/vsf@e0b5993