dsa_core.h

Go to the documentation of this file.

/*
 * Copyright 2025 NXP
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_NET_DSA_CORE_H_
#define ZEPHYR_INCLUDE_NET_DSA_CORE_H_
 
#include <errno.h>
#include <zephyr/device.h>
#include <zephyr/devicetree.h>
#include <zephyr/net/net_if.h>
#include <zephyr/net/phy.h>
#include <zephyr/net/ethernet.h>
 
#if defined(CONFIG_DSA_PORT_MAX_COUNT)
#define DSA_PORT_MAX_COUNT CONFIG_DSA_PORT_MAX_COUNT
#else
#define DSA_PORT_MAX_COUNT 0
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define DSA_PORT_INST_INIT(port, n, cfg)                                                           \
        NET_DEVICE_INIT_INSTANCE(CONCAT(dsa_, n, port), DEVICE_DT_NAME(port), DT_REG_ADDR(port),   \
                                 dsa_port_initialize, NULL, &dsa_switch_context_##n, cfg,          \
                                 CONFIG_ETH_INIT_PRIORITY, &dsa_eth_api, ETHERNET_L2,              \
                                 NET_L2_GET_CTX_TYPE(ETHERNET_L2), NET_ETH_MTU);
 
#define DSA_SWITCH_INST_INIT(n, _dapi, data, fn)                                                   \
        struct dsa_switch_context dsa_switch_context_##n = {                                       \
                .dapi = _dapi,                                                                     \
                .prv_data = data,                                                                  \
                .init_ports = 0,                                                                   \
                .num_ports = DT_INST_CHILD_NUM_STATUS_OKAY(n),                                     \
        };                                                                                         \
        DT_INST_FOREACH_CHILD_STATUS_OKAY_VARGS(n, fn, n);
 
struct dsa_switch_context {
        struct net_if *iface_user[DSA_PORT_MAX_COUNT];
 
        struct net_if *iface_conduit;
 
        struct dsa_api *dapi;
 
        void *prv_data;
 
        uint8_t num_ports;
 
        uint8_t init_ports;
 
        void *tagger_data;
};
 
struct dsa_api {
        struct net_if *(*recv)(struct net_if *iface, struct net_pkt *pkt);
 
        struct net_pkt *(*xmit)(struct net_if *iface, struct net_pkt *pkt);
 
        int (*port_init)(const struct device *dev);
 
        void (*port_phylink_change)(const struct device *dev, struct phy_link_state *state,
                                    void *user_data);
 
        void (*port_generate_random_mac)(uint8_t *mac_addr);
 
#if defined(CONFIG_NET_L2_PTP) || defined(__DOXYGEN__)
        int (*port_txtstamp)(const struct device *dev, struct net_pkt *pkt);
#endif
        int (*switch_setup)(const struct dsa_switch_context *dsa_switch_ctx);
 
        int (*connect_tag_protocol)(struct dsa_switch_context *dsa_switch_ctx, int tag_proto);
};
 
struct dsa_port_config {
        uint8_t mac_addr[6];
        const bool use_random_mac_addr;
        const int port_idx;
        const struct device *phy_dev;
        const char *phy_mode;
        const int tag_proto;
        const struct device *ethernet_connection;
#if defined(CONFIG_NET_L2_PTP) || defined(__DOXYGEN__)
        const struct device *ptp_clock;
#endif
        void *prv_config;
};
 
/*
 * DSA port init
 *
 * Returns:
 *  - 0 if ok, < 0 if error
 */
int dsa_port_initialize(const struct device *dev);
 
/*
 * DSA transmit function
 *
 * param dev: Port device to transmit
 * param pkt: Network packet
 *
 * Returns:
 *  - 0 if ok, < 0 if error
 */
int dsa_xmit(const struct device *dev, struct net_pkt *pkt);
 
/*
 * DSA receive function
 *
 * param iface: Interface of conduit port
 * param pkt: Network packet
 *
 * Returns:
 *  - Interface to redirect
 */
struct net_if *dsa_recv(struct net_if *iface, struct net_pkt *pkt);
 
/*
 * DSA ethernet init function to handle flags
 *
 * param iface: Interface of port
 *
 * Returns:
 *  - 0 if ok, < 0 if error
 */
int dsa_eth_init(struct net_if *iface);
 
/* Ethernet APIs definition for switch ports */
extern const struct ethernet_api dsa_eth_api;
 
struct net_if *dsa_user_get_iface(struct net_if *iface, int port_idx);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_NET_DSA_CORE_H_ */