VSF Documented
vsf_template_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 __VSF_TEMPLATE_ETH_H__
19#define __VSF_TEMPLATE_ETH_H__
20
21/*============================ INCLUDES ======================================*/
22
24#include "hal/arch/vsf_arch.h"
25
26#ifdef __cplusplus
27extern "C" {
28#endif
29
30/*============================ ETHROS ========================================*/
31
39#ifndef VSF_ETH_CFG_MULTI_CLASS
40# define VSF_ETH_CFG_MULTI_CLASS ENABLED
41#endif
42#ifndef VSF_ETH_CFG_MULTI_PHY_CLASS
43# define VSF_ETH_CFG_MULTI_PHY_CLASS ENABLED
44#endif
45
46#if defined(VSF_HW_ETH_COUNT) && !defined(VSF_HW_ETH_MASK)
54# define VSF_HW_ETH_MASK VSF_HAL_COUNT_TO_MASK(VSF_HW_ETH_COUNT)
55#endif
56
57#if defined(VSF_HW_ETH_MASK) && !defined(VSF_HW_ETH_COUNT)
65# define VSF_HW_ETH_COUNT VSF_HAL_MASK_TO_COUNT(VSF_HW_ETH_MASK)
66#endif
67
89#ifndef VSF_ETH_CFG_PREFIX
90# if (VSF_ETH_CFG_MULTI_CLASS == DISABLED) && defined(VSF_HW_ETH_COUNT) && (VSF_HW_ETH_COUNT != 0)
91# define VSF_ETH_CFG_PREFIX vsf_hw
92# else
93# define VSF_ETH_CFG_PREFIX vsf
94# endif
95#endif
96
107#ifndef VSF_ETH_CFG_FUNCTION_RENAME
108# define VSF_ETH_CFG_FUNCTION_RENAME ENABLED
109#endif
110
120#ifndef VSF_ETH_CFG_REIMPLEMENT_TYPE_PHY_MODE
121# define VSF_ETH_CFG_REIMPLEMENT_TYPE_PHY_MODE DISABLED
122#endif
123
133#ifndef VSF_ETH_CFG_REIMPLEMENT_TYPE_MODE
134# define VSF_ETH_CFG_REIMPLEMENT_TYPE_MODE DISABLED
135#endif
136
149#if VSF_ETH_CFG_REIMPLEMENT_TYPE_CFG == DISABLED
150# define VSF_ETH_CFG_REIMPLEMENT_TYPE_CFG DISABLED
151#endif
152
161#ifndef VSF_ETH_CFG_REIMPLEMENT_TYPE_STATUS
162# define VSF_ETH_CFG_REIMPLEMENT_TYPE_STATUS DISABLED
163#endif
164
177#if VSF_ETH_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED
178# define VSF_ETH_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED
179#endif
180
191#if VSF_ETH_CFG_REIMPLEMENT_TYPE_BUF_MODE == DISABLED
192# define VSF_ETH_CFG_REIMPLEMENT_TYPE_BUF_MODE DISABLED
193#endif
194
195#if VSF_ETH_CFG_REIMPLEMENT_TYPE_BUF_DESC == DISABLED
196# define VSF_ETH_CFG_REIMPLEMENT_TYPE_BUF_DESC DISABLED
197#endif
198
199#if VSF_ETH_CFG_REIMPLEMENT_TYPE_SEND_BUF_DESC == DISABLED
200# define VSF_ETH_CFG_REIMPLEMENT_TYPE_SEND_BUF_DESC DISABLED
201#endif
202
203#if VSF_ETH_CFG_REIMPLEMENT_TYPE_RECV_BUF_DESC == DISABLED
204# define VSF_ETH_CFG_REIMPLEMENT_TYPE_RECV_BUF_DESC DISABLED
205#endif
206
216#if VSF_ETH_CFG_REIMPLEMENT_TYPE_SG_BUF_DESC == DISABLED
217# define VSF_ETH_CFG_REIMPLEMENT_TYPE_SG_BUF_DESC DISABLED
218#endif
219
220
230#if VSF_ETH_CFG_REIMPLEMENT_TYPE_IRQ_MASK == DISABLED
231# define VSF_ETH_CFG_REIMPLEMENT_TYPE_IRQ_MASK DISABLED
232#endif
233
244#ifndef VSF_ETH_CFG_INHERIT_HAL_CAPABILITY
245# define VSF_ETH_CFG_INHERIT_HAL_CAPABILITY ENABLED
246#endif
247
248/*============================ ETHROFIED FUNCTIONS ===========================*/
249
259#define VSF_ETH_APIS(__prefix_name) \
260 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, eth, init, VSF_MCONNECT(__prefix_name, _t) *eth_ptr, vsf_eth_cfg_t *cfg_ptr) \
261 __VSF_HAL_TEMPLATE_API(__prefix_name, void, eth, fini, VSF_MCONNECT(__prefix_name, _t) *eth_ptr) \
262 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, eth, get_configuration, VSF_MCONNECT(__prefix_name, _t) *eth_ptr, vsf_eth_cfg_t *cfg_ptr) \
263 __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t, eth, enable, VSF_MCONNECT(__prefix_name, _t) *eth_ptr) \
264 __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t, eth, disable, VSF_MCONNECT(__prefix_name, _t) *eth_ptr) \
265 __VSF_HAL_TEMPLATE_API(__prefix_name, void, eth, irq_enable, VSF_MCONNECT(__prefix_name, _t) *eth_ptr, vsf_eth_irq_mask_t irq_mask) \
266 __VSF_HAL_TEMPLATE_API(__prefix_name, void, eth, irq_disable, VSF_MCONNECT(__prefix_name, _t) *eth_ptr, vsf_eth_irq_mask_t irq_mask) \
267 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, eth, send_request, VSF_MCONNECT(__prefix_name, _t) *eth_ptr, vsf_eth_send_buf_desc_t *buf_ptr) \
268 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, eth, recv_request, VSF_MCONNECT(__prefix_name, _t) *eth_ptr, vsf_eth_recv_buf_desc_t *buf_ptr) \
269 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, eth, send_sg_request, VSF_MCONNECT(__prefix_name, _t) *eth_ptr, vsf_eth_send_sg_buf_desc_t *buf_ptr, uint32_t sg_count) \
270 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, eth, recv_sg_request, VSF_MCONNECT(__prefix_name, _t) *eth_ptr, vsf_eth_recv_sg_buf_desc_t *buf_ptr, uint32_t sg_count) \
271 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, eth, ctrl, VSF_MCONNECT(__prefix_name, _t) *eth_ptr, vsf_eth_ctrl_t ctrl, void *param) \
272 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_eth_status_t, eth, status, VSF_MCONNECT(__prefix_name, _t) *eth_ptr) \
273 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_eth_capability_t, eth, capability, VSF_MCONNECT(__prefix_name, _t) *eth_ptr) \
274 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, eth, phy_set_mode, VSF_MCONNECT(__prefix_name, _t) *eth_ptr, vsf_eth_phy_mode_t phy_mode) \
275 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, eth, phy_get_link_status, VSF_MCONNECT(__prefix_name, _t) *eth_ptr, vsf_eth_phy_mode_t *phy_mode_ptr) \
276 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, eth, phy_read_reg, VSF_MCONNECT(__prefix_name, _t) *eth_ptr, uint16_t reg_addr, uint32_t *value_ptr) \
277 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, eth, phy_write_reg, VSF_MCONNECT(__prefix_name, _t) *eth_ptr, uint16_t reg_addr, uint32_t value)
278
279
280/*============================ TYPES =========================================*/
281
282
283
284#if VSF_ETH_CFG_REIMPLEMENT_TYPE_PHY_MODE == DISABLED
320typedef enum vsf_eth_phy_mode_t {
327
330
332
335 //VSF_ETH_PHY_MODE_LINK_DOWN = 1 << 6,
337#endif
338
339
346enum {
347#ifndef VSF_ETH_PHY_MODE_SPEED_MASK
349#endif
350
351#ifndef VSF_ETH_PHY_MODE_DUPLEX_MASK
353#endif
354
355#ifndef VSF_ETH_PHY_MODE_ALL_BITS_MASK
357#endif
358};
359
360#if VSF_ETH_CFG_REIMPLEMENT_TYPE_MODE == DISABLED
379typedef enum vsf_eth_mode_t {
382
383 /* The following modes are optional and can be enabled by removing the comments.
384 * These modes depend on hardware support and might not be available on all hardware.
385 */
386
387 /* Address Filtering Options
388 * ------------------------- */
389 /*
390 // \~english Enable filtering of unicast frames not addressed to this station
391 // \~chinese 启用单播帧过滤,丢弃不是发往本站的单播帧
392 VSF_ETH_MODE_UNICAST_FILTER = 1 << 7,
393
394 // \~english Enable filtering of multicast frames according to a filter table
395 // \~chinese 启用多播帧过滤,根据过滤表过滤多播帧
396 VSF_ETH_MODE_MULTICAST_FILTER = 1 << 8,
397
398 // \~english Enable filtering of broadcast frames
399 // \~chinese 启用广播帧过滤,可选择是否接收广播帧
400 VSF_ETH_MODE_BROADCAST_FILTER = 1 << 9,
401 */
402
403 /* VLAN Support Options
404 * --------------------
405 * VLAN (Virtual LAN) allows network segmentation at Layer 2
406 */
407 /*
408 // \~english Enable adding VLAN tags to outgoing frames
409 // \~chinese 启用VLAN标签,向外发送的帧添加VLAN标签
410 VSF_ETH_MODE_VLAN_TAGGING = 1 << 10,
411
412 // \~english Enable filtering frames based on VLAN ID
413 // \~chinese 启用VLAN标签过滤,根据VLAN ID过滤接收的帧
414 VSF_ETH_MODE_VLAN_FILTERING = 1 << 11,
415
416 // \~english Remove VLAN tags from received frames before passing to upper layer
417 // \~chinese 启用VLAN标签剥离,在传递给上层前移除接收帧中的VLAN标签
418 VSF_ETH_MODE_VLAN_STRIPPING = 1 << 12,
419
420 // \~english Insert VLAN tags into outgoing frames that don't have them
421 // \~chinese 启用VLAN标签插入,向没有VLAN标签的外发帧插入标签
422 VSF_ETH_MODE_VLAN_INSERTION = 1 << 13,
423 */
424
425 /* Special Frame Handling
426 * --------------------- */
427 /*
428 // \~english Support for frames larger than 1518 bytes (up to 9000 bytes typically)
429 // \~chinese 支持巨型帧,允许处理大于1518字节的帧(通常最大可达9000字节)
430 VSF_ETH_MODE_JUMBO_FRAME = 1 << 14,
431
432 // \~english Support IEEE 802.3x flow control mechanism to prevent buffer overflow
433 // \~chinese 支持IEEE 802.3x流控制机制,防止缓冲区溢出
434 VSF_ETH_MODE_FLOW_CONTROL = 1 << 15,
435
436 // \~english Support for pause frames which temporarily pause transmission
437 // \~chinese 支持暂停帧,可临时暂停传输以控制数据流
438 VSF_ETH_MODE_PAUSE_FRAME = 1 << 16,
439 */
440
441 /* QoS and Traffic Management
442 * ------------------------- */
443 /*
444 // \~english Support for multiple priority queues for traffic handling
445 // \~chinese 支持优先级队列,根据优先级处理不同流量
446 VSF_ETH_MODE_PRIORITY_QUEUE = 1 << 17,
447
448 // \~english Quality of Service support for traffic differentiation
449 // \~chinese 服务质量支持,区分处理不同类型的流量
450 VSF_ETH_MODE_QOS = 1 << 18,
451 */
452
453 /* Time Synchronization
454 * ------------------- */
455 /*
456 // \~english Support for Precision Time Protocol timestamp for accurate timing
457 // \~chinese 支持精确时间协议时间戳,用于精确计时
458 VSF_ETH_MODE_PTP_TIMESTAMP = 1 << 19,
459 */
460
461 /* Advanced Hardware Acceleration
462 * ----------------------------- */
463 /*
464 // \~english TCP Segmentation Offload - hardware handles TCP segmentation
465 // \~chinese TCP分段卸载 - 硬件处理TCP分段,减轻CPU负担
466 VSF_ETH_MODE_TCP_SEGMENTATION = 1 << 20,
467
468 // \~english Large Receive Offload - hardware combines received TCP segments
469 // \~chinese 大型接收卸载 - 硬件合并接收到的TCP分段,减少处理开销
470 VSF_ETH_MODE_LARGE_RECEIVE = 1 << 21,
471 */
472
473 /* These are examples of how to implement optional features.
474 * Hardware drivers can define and implement these as needed.
475 * For each enabled feature, corresponding MASK definitions should be added.
476 */
478#endif
479
486enum {
487#ifndef VSF_ETH_MODE_OFFLOAD_MASK
489#endif
490
491#ifndef VSF_ETH_MODE_ALL_BITS_MASK
493#endif
494};
495
496
497#if VSF_ETH_CFG_REIMPLEMENT_TYPE_IRQ_MASK == DISABLED
498typedef enum vsf_eth_irq_mask_t {
501
504
506
509#endif
510
511enum {
512#ifndef VSF_ETH_IRQ_MASK_ALL
518#endif
519};
520
521
522#if VSF_ETH_CFG_REIMPLEMENT_TYPE_CFG == DISABLED
527typedef struct vsf_eth_t vsf_eth_t;
528
537typedef void vsf_eth_isr_handler_t(void *target_ptr, vsf_eth_t *eth_ptr,
539
544typedef struct vsf_eth_isr_t {
549
557typedef struct vsf_eth_cfg_t {
563#endif
564
573#if VSF_ETH_CFG_REIMPLEMENT_TYPE_STATUS == DISABLED
574typedef struct vsf_eth_status_t {
575 union {
578 struct {
581 };
582 };
584#endif
585
586#if VSF_ETH_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED
597typedef struct vsf_eth_capability_t {
598#if VSF_ETH_CFG_INHERIT_HAL_CAPABILITY == ENABLED
600#endif
601
602 vsf_eth_mode_t support_modes;
605
606 union {
608 struct {
615
622 };
623 };
625#endif
626
627#if VSF_ETH_CFG_REIMPLEMENT_TYPE_BUF_MODE == DISABLED
628typedef enum vsf_eth_buf_mode_t {
631
632 // TODO: Add more modes as needed
634#endif
635
636#if VSF_ETH_CFG_REIMPLEMENT_TYPE_BUF_DESC == DISABLED
637typedef struct vsf_eth_buf_desc_t {
639 void *payload;
640 size_t len;
642#endif
643
644#if VSF_ETH_CFG_REIMPLEMENT_TYPE_SEND_BUF_DESC == DISABLED
648#endif
649
650#if VSF_ETH_CFG_REIMPLEMENT_TYPE_RECV_BUF_DESC == DISABLED
654#endif
655
656#if VSF_ETH_CFG_REIMPLEMENT_TYPE_SG_SEND_BUF == DISABLED
660#endif
661
662#if VSF_ETH_CFG_REIMPLEMENT_TYPE_SG_RECV_BUF == DISABLED
666#endif
667
668#if VSF_ETH_CFG_REIMPLEMENT_TYPE_CTRL == DISABLED
669typedef enum vsf_eth_ctrl_t {
671
672 /* IEEE 802.3 Clause 45 Configuration Commands */
673 /*
674 VSF_ETH_CTRL_PHY_C45_READ_REG, //!< \~english Read PHY register using Clause 45 access (vsf_eth_phy_c45_reg_access_t *) \~chinese 使用 Clause 45 访问方式读取 PHY 寄存器 (vsf_eth_phy_c45_reg_access_t *)
675 VSF_ETH_CTRL_PHY_C45_WRITE_REG, //!< \~english Write PHY register using Clause 45 access (vsf_eth_phy_c45_reg_access_t *) \~chinese 使用 Clause 45 访问方式写入 PHY 寄存器 (vsf_eth_phy_c45_reg_access_t *)
676 */
677
678 /* PLCA (Physical Layer Collision Avoidance) Configuration Commands - For 10BASE-T1S Ethernet */
679 /*
680 VSF_ETH_CTRL_PHY_PLCA_ENABLE, //!< \~english Enable PLCA operation (bool) \~chinese 启用 PLCA 操作 (bool)
681 VSF_ETH_CTRL_PHY_PLCA_GET_STATUS, //!< \~english Get PLCA status (bool *) \~chinese 获取 PLCA 状态 (bool *)
682 VSF_ETH_CTRL_PHY_PLCA_SET_NODE_ID, //!< \~english Set PLCA node ID (uint8_t) \~chinese 设置 PLCA 节点 ID (uint8_t)
683 VSF_ETH_CTRL_PHY_PLCA_SET_NODE_COUNT, //!< \~english Set PLCA node count (uint8_t) \~chinese 设置 PLCA 节点数量 (uint8_t)
684 VSF_ETH_CTRL_PHY_PLCA_SET_BURST_COUNT, //!< \~english Set PLCA burst count (uint8_t) \~chinese 设置 PLCA 突发计数 (uint8_t)
685 VSF_ETH_CTRL_PHY_PLCA_SET_BURST_TIMER, //!< \~english Set PLCA burst timer (uint8_t) \~chinese 设置 PLCA 突发计时器 (uint8_t)
686 */
687
688 // TODO: Add more control commands as needed
690#endif
691
697typedef struct vsf_eth_op_t {
699#undef __VSF_HAL_TEMPLATE_API
700#define __VSF_HAL_TEMPLATE_API VSF_HAL_TEMPLATE_API_FP
702
703 VSF_ETH_APIS(vsf_eth)
705
706
707#if VSF_ETH_CFG_MULTI_CLASS == ENABLED
712struct vsf_eth_t {
714};
715#endif
716
717/*============================ PROTOTYPES ====================================*/
718
738extern vsf_err_t vsf_eth_init(vsf_eth_t *eth_ptr, vsf_eth_cfg_t *cfg_ptr);
739
751extern void vsf_eth_fini(vsf_eth_t *eth_ptr);
752
771
783extern fsm_rt_t vsf_eth_enable(vsf_eth_t *eth_ptr);
784
796extern fsm_rt_t vsf_eth_disable(vsf_eth_t *eth_ptr);
797
811extern void vsf_eth_isr_enable(vsf_eth_t *eth_ptr, vsf_eth_irq_mask_t isr_mask);
812
826extern void vsf_eth_isr_disable(vsf_eth_t *eth_ptr, vsf_eth_irq_mask_t isr_mask);
827
840
853
872
891
892
913
932
950extern vsf_err_t vsf_eth_ctrl(vsf_eth_t *eth_ptr, vsf_eth_ctrl_t ctrl, void *param);
951
967extern vsf_err_t vsf_eth_phy_read_reg(vsf_eth_t *eth_ptr, uint16_t reg_addr, uint32_t *value_ptr);
968
985
1014
1015/*============================ ETHROFIED FUNCTIONS ===========================*/
1016
1018#if VSF_ETH_CFG_FUNCTION_RENAME == ENABLED
1019# define __vsf_eth_t VSF_MCONNECT(VSF_ETH_CFG_PREFIX, _eth_t)
1020# define vsf_eth_init(__ETH, ...) VSF_MCONNECT(VSF_ETH_CFG_PREFIX, _eth_init)((__vsf_eth_t *)(__ETH), ##__VA_ARGS__)
1021# define vsf_eth_fini(__ETH) VSF_MCONNECT(VSF_ETH_CFG_PREFIX, _eth_fini)((__vsf_eth_t *)(__ETH))
1022# define vsf_eth_get_configuration(__ETH, ...) VSF_MCONNECT(VSF_ETH_CFG_PREFIX, _eth_get_configuration)((__vsf_eth_t *)(__ETH), ##__VA_ARGS__)
1023# define vsf_eth_enable(__ETH) VSF_MCONNECT(VSF_ETH_CFG_PREFIX, _eth_enable)((__vsf_eth_t *)(__ETH))
1024# define vsf_eth_disable(__ETH) VSF_MCONNECT(VSF_ETH_CFG_PREFIX, _eth_disable)((__vsf_eth_t *)(__ETH))
1025# define vsf_eth_status(__ETH) VSF_MCONNECT(VSF_ETH_CFG_PREFIX, _eth_status)((__vsf_eth_t *)(__ETH))
1026# define vsf_eth_capability(__ETH) VSF_MCONNECT(VSF_ETH_CFG_PREFIX, _eth_capability)((__vsf_eth_t *)(__ETH))
1027# define vsf_eth_send_request(__ETH, ...) VSF_MCONNECT(VSF_ETH_CFG_PREFIX, _eth_send_request)((__vsf_eth_t *)(__ETH), ##__VA_ARGS__)
1028# define vsf_eth_send_sg_request(__ETH, ...) VSF_MCONNECT(VSF_ETH_CFG_PREFIX, _eth_send_sg_request)((__vsf_eth_t *)(__ETH), ##__VA_ARGS__)
1029# define vsf_eth_recv_request(__ETH, ...) VSF_MCONNECT(VSF_ETH_CFG_PREFIX, _eth_recv_request)((__vsf_eth_t *)(__ETH), ##__VA_ARGS__)
1030# define vsf_eth_recv_sg_request(__ETH, ...) VSF_MCONNECT(VSF_ETH_CFG_PREFIX, _eth_recv_sg_request)((__vsf_eth_t *)(__ETH), ##__VA_ARGS__)
1031# define vsf_eth_ctrl(__ETH, ...) VSF_MCONNECT(VSF_ETH_CFG_PREFIX, _eth_ctrl)((__vsf_eth_t *)(__ETH), ##__VA_ARGS__)
1032# define vsf_eth_phy_read_reg(__ETH, ...) VSF_MCONNECT(VSF_ETH_CFG_PREFIX, _eth_phy_read_reg)((__vsf_eth_t *)(__ETH), ##__VA_ARGS__)
1033# define vsf_eth_phy_write_reg(__ETH, ...) VSF_MCONNECT(VSF_ETH_CFG_PREFIX, _eth_phy_write_reg)((__vsf_eth_t *)(__ETH), ##__VA_ARGS__)
1034# define vsf_eth_phy_set_mode(__ETH, ...) VSF_MCONNECT(VSF_ETH_CFG_PREFIX, _eth_phy_set_mode)((__vsf_eth_t *)(__ETH), ##__VA_ARGS__)
1035# define vsf_eth_phy_get_link_status(__ETH, ...) VSF_MCONNECT(VSF_ETH_CFG_PREFIX, _eth_phy_get_link_status)((__vsf_eth_t *)(__ETH), ##__VA_ARGS__)
1036#endif
1038
1039#ifdef __cplusplus
1040}
1041#endif
1042
1043#endif /*__VSF_TEMPLATE_ETH_H__*/
vsf_err_t
Definition __type.h:42
vsf_arch_prio_t
Definition cortex_a_generic.h:88
vsf_eth_irq_mask_t
Definition eth.h:149
vsf_eth_buf_mode_t
Definition eth.h:223
vsf_eth_mode_t
Definition eth.h:140
vsf_eth_phy_mode_t
Definition eth.h:127
void vsf_eth_isr_handler_t(void *target_ptr, vsf_eth_t *eth_ptr, vsf_eth_irq_mask_t irq_mask)
Definition eth.h:172
const i_spi_t vsf_spi_irq_mask_t irq_mask
Definition spi_interface.h:38
unsigned short uint16_t
Definition stdint.h:7
unsigned uint32_t
Definition stdint.h:9
unsigned char uint8_t
Definition stdint.h:5
Definition vsf_template_eth.h:637
void * payload
Definition vsf_template_eth.h:639
vsf_eth_buf_mode_t mode
Definition vsf_template_eth.h:638
size_t len
Definition vsf_template_eth.h:640
Predefined VSF ETH capability that can be reimplemented in specific hal drivers. The vsf_eth_capabili...
Definition vsf_template_eth.h:597
uint32_t is_send_buf_releasable_immediately
Definition vsf_template_eth.h:614
uint32_t is_sg_send_buf_releasable_immediately
Definition vsf_template_eth.h:621
inherit(vsf_peripheral_capability_t) vsf_eth_mode_t support_modes
Supported modes, refer to vsf_eth_mode_t.
vsf_eth_phy_mode_t support_phy_modes
Supported PHY modes, refer to vsf_eth_phy_mode_t.
Definition vsf_template_eth.h:603
uint32_t value
Definition vsf_template_eth.h:607
vsf_eth_irq_mask_t support_irq_mask
Supported IRQ masks, refer to vsf_eth_irq_mask_t.
Definition vsf_template_eth.h:604
ETH configuration structure.
Definition vsf_template_eth.h:557
uint8_t mac_address[6]
MAC address, 6 bytes.
Definition vsf_template_eth.h:560
vsf_eth_phy_mode_t phy_mode
PHY mode, refer to vsf_eth_phy_mode_t.
Definition vsf_template_eth.h:559
vsf_eth_isr_t isr
ETH interrupt configuration, refer to vsf_eth_isr_t.
Definition vsf_template_eth.h:561
vsf_eth_mode_t mode
ETH mode, refer to vsf_eth_mode_t.
Definition vsf_template_eth.h:558
ETH interrupt configuration structure.
Definition vsf_template_eth.h:544
vsf_eth_isr_handler_t * handler_fn
Interrupt handler function pointer.
Definition vsf_template_eth.h:545
void * target_ptr
User-defined target pointer.
Definition vsf_template_eth.h:546
vsf_arch_prio_t prio
Interrupt priority.
Definition vsf_template_eth.h:547
ETH operation function pointer type, used for ETH Multi Class support.
Definition vsf_template_eth.h:697
ETH status information structure Contains the current status of ETH operations and FIFO thresholds.
Definition vsf_template_eth.h:574
uint32_t is_tx_ready
TX is ready to accept data.
Definition vsf_template_eth.h:580
uint32_t is_rx_available
RX data is available.
Definition vsf_template_eth.h:579
ETH instance structure, used for ETH Multi Class support, not needed in non Multi Class mode.
Definition vsf_template_eth.h:712
const vsf_eth_op_t * op
Definition vsf_template_eth.h:713
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
fsm_rt_t
Definition vsf_fsm.h:315
vsf_err_t vsf_eth_init(vsf_eth_t *eth_ptr, vsf_eth_cfg_t *cfg_ptr)
Initialize a ETH instance.
Definition eth_common.c:38
vsf_err_t vsf_eth_recv_sg_request(vsf_eth_t *eth_ptr, vsf_eth_recv_sg_buf_desc_t *sg_ptr, uint32_t sg_count)
Receive data using scatter-gather buffers from ETH instance.
Definition eth_common.c:129
void vsf_eth_fini(vsf_eth_t *eth_ptr)
Finalize a ETH instance.
Definition eth_common.c:47
#define VSF_ETH_APIS(__prefix_name)
ETH API template, used to generate ETH type, specific prefix function declarations,...
Definition vsf_template_eth.h:259
@ VSF_ETH_PHY_MODE_SPEED_MASK
Definition vsf_template_eth.h:348
@ VSF_ETH_PHY_MODE_ALL_BITS_MASK
Definition vsf_template_eth.h:356
@ VSF_ETH_PHY_MODE_DUPLEX_MASK
Definition vsf_template_eth.h:352
vsf_eth_buf_desc_t vsf_eth_recv_buf_desc_t
Definition vsf_template_eth.h:653
void vsf_eth_isr_disable(vsf_eth_t *eth_ptr, vsf_eth_irq_mask_t isr_mask)
Disable ETH instance interrupt.
vsf_eth_irq_mask_t
Definition vsf_template_eth.h:498
@ VSF_ETH_IRQ_MASK_ERROR
Error interrupt mask.
Definition vsf_template_eth.h:507
@ VSF_ETH_IRQ_MASK_RX_AVAILABLE
RX data available interrupt mask.
Definition vsf_template_eth.h:499
@ VSF_ETH_IRQ_MASK_PHY_LINK_CHANGE
PHY link change interrupt mask.
Definition vsf_template_eth.h:505
@ VSF_ETH_IRQ_MASK_SG_TX_COMPLETE
Scatter-gather TX complete interrupt mask.
Definition vsf_template_eth.h:503
@ VSF_ETH_IRQ_MASK_SG_RX_AVAILABLE
Scatter-gather RX available interrupt mask.
Definition vsf_template_eth.h:502
@ VSF_ETH_IRQ_MASK_TX_COMPLETE
TX complete interrupt mask.
Definition vsf_template_eth.h:500
struct vsf_eth_cfg_t vsf_eth_cfg_t
ETH configuration structure.
fsm_rt_t vsf_eth_enable(vsf_eth_t *eth_ptr)
Enable a ETH instance.
Definition eth_common.c:66
struct vsf_eth_status_t vsf_eth_status_t
ETH status information structure Contains the current status of ETH operations and FIFO thresholds.
vsf_err_t vsf_eth_send_request(vsf_eth_t *eth_ptr, vsf_eth_send_buf_desc_t *buf_ptr)
Send a buffer over ETH instance.
Definition eth_common.c:102
fsm_rt_t vsf_eth_disable(vsf_eth_t *eth_ptr)
Disable a ETH instance.
Definition eth_common.c:75
vsf_err_t vsf_eth_get_configuration(vsf_eth_t *eth_ptr, vsf_eth_cfg_t *cfg_ptr)
Get current configuration of an ETH instance.
Definition eth_common.c:56
vsf_err_t vsf_eth_ctrl(vsf_eth_t *eth_ptr, vsf_eth_ctrl_t ctrl, void *param)
Control ETH instance.
Definition eth_common.c:138
vsf_eth_ctrl_t
Definition vsf_template_eth.h:669
@ VSF_ETH_CTRL_GET_MAC_ADDRESS
Get MAC address (uint8_t *)
Definition vsf_template_eth.h:670
vsf_eth_buf_mode_t
Definition vsf_template_eth.h:628
@ VSF_ETH_BUF_MODE_TX_CHECKSUM_OFFLOAD
TX checksum offload mode.
Definition vsf_template_eth.h:629
@ VSF_ETH_BUF_MODE_RX_CHECKSUM_OFFLOAD
RX checksum offload mode.
Definition vsf_template_eth.h:630
vsf_err_t vsf_eth_phy_write_reg(vsf_eth_t *eth_ptr, uint16_t reg_addr, uint32_t value)
Write a value to a PHY register.
struct vsf_eth_buf_desc_t vsf_eth_buf_desc_t
vsf_eth_capability_t vsf_eth_capability(vsf_eth_t *eth_ptr)
Get the capability of ETH instance.
Definition eth_common.c:156
vsf_err_t vsf_eth_recv_request(vsf_eth_t *eth_ptr, vsf_eth_recv_buf_desc_t *buf_ptr)
Receive a buffer from ETH instance.
Definition eth_common.c:111
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:379
@ VSF_ETH_MODE_TX_CHECKSUM_OFFLOAD
TX checksum offload mode.
Definition vsf_template_eth.h:380
@ VSF_ETH_MODE_RX_CHECKSUM_OFFLOAD
RX checksum offload mode.
Definition vsf_template_eth.h:381
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:320
@ VSF_ETH_PHY_MODE_LINK_UP
Link up mode.
Definition vsf_template_eth.h:331
@ VSF_ETH_PHY_MODE_SPEED_1000M
1000M speed mode
Definition vsf_template_eth.h:326
@ VSF_ETH_PHY_MODE_SPEED_100M
100M speed mode
Definition vsf_template_eth.h:325
@ VSF_ETH_PHY_MODE_SPEED_10M
10M speed mode
Definition vsf_template_eth.h:324
@ VSF_ETH_PHY_MODE_DUPLEX_HALF
Half duplex mode.
Definition vsf_template_eth.h:328
@ VSF_ETH_PHY_MODE_DUPLEX_FULL
Full duplex mode.
Definition vsf_template_eth.h:329
@ VSF_ETH_IRQ_MASK_ALL
Definition vsf_template_eth.h:513
vsf_err_t vsf_eth_send_sg_request(vsf_eth_t *eth_ptr, vsf_eth_send_sg_buf_desc_t *sg_ptr, uint32_t sg_count)
Send a scatter-gather buffer over ETH instance.
Definition eth_common.c:120
vsf_err_t vsf_eth_phy_set_mode(vsf_eth_t *eth_ptr, vsf_eth_phy_mode_t mode)
Configure the PHY operating mode.
vsf_eth_buf_desc_t vsf_eth_send_sg_buf_desc_t
Definition vsf_template_eth.h:659
@ VSF_ETH_MODE_OFFLOAD_MASK
Definition vsf_template_eth.h:488
@ VSF_ETH_MODE_ALL_BITS_MASK
Definition vsf_template_eth.h:492
vsf_eth_buf_desc_t vsf_eth_send_buf_desc_t
Definition vsf_template_eth.h:647
struct vsf_eth_capability_t vsf_eth_capability_t
Predefined VSF ETH capability that can be reimplemented in specific hal drivers. The vsf_eth_capabili...
vsf_err_t vsf_eth_phy_read_reg(vsf_eth_t *eth_ptr, uint16_t reg_addr, uint32_t *value_ptr)
Read a PHY register.
vsf_err_t vsf_eth_phy_get_link_status(vsf_eth_t *eth_ptr, vsf_eth_phy_mode_t *phy_mode_ptr)
Get the current link status of the PHY.
vsf_eth_buf_desc_t vsf_eth_recv_sg_buf_desc_t
Definition vsf_template_eth.h:665
void vsf_eth_isr_handler_t(void *target_ptr, vsf_eth_t *eth_ptr, vsf_eth_irq_mask_t irq_mask)
ETH interrupt handler type declaration.
Definition vsf_template_eth.h:537
void vsf_eth_isr_enable(vsf_eth_t *eth_ptr, vsf_eth_irq_mask_t isr_mask)
Enable ETH instance interrupt.
struct vsf_eth_isr_t vsf_eth_isr_t
ETH interrupt configuration structure.
vsf_eth_status_t vsf_eth_status(vsf_eth_t *eth_ptr)
Get the status of ETH instance.
Definition eth_common.c:147
Generated from commit: vsfteam/vsf@74aa6ce