dsa.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 DENX Software Engineering GmbH
 *               Lukasz Majewski <lukma@denx.de>
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_NET_DSA_H_
#define ZEPHYR_INCLUDE_NET_DSA_H_
 
#include <zephyr/device.h>
#include <zephyr/net/net_if.h>
 
#define NET_DSA_PORT_MAX_COUNT 8
#define DSA_STATUS_PERIOD_MS K_MSEC(1000)
 
/*
 * Size of the DSA TAG:
 * - KSZ8794 - 1 byte
 */
#if defined(CONFIG_DSA_KSZ8794) && defined(CONFIG_DSA_KSZ_TAIL_TAGGING)
#define DSA_TAG_SIZE 1
#else
#define DSA_TAG_SIZE 0
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
int dsa_tx(const struct device *dev, struct net_pkt *pkt);
 
typedef enum net_verdict (*dsa_net_recv_cb_t)(struct net_if *iface,
                                              struct net_pkt *pkt);
 
int dsa_register_recv_callback(struct net_if *iface, dsa_net_recv_cb_t cb);
 
struct net_if *dsa_net_recv(struct net_if *iface, struct net_pkt **pkt);
 
typedef int (*dsa_send_t)(const struct device *dev, struct net_pkt *pkt);
 
int dsa_register_master_tx(struct net_if *iface, dsa_send_t fn);
 
bool dsa_is_port_master(struct net_if *iface);
 
struct dsa_context {
        struct net_if *iface_slave[NET_DSA_PORT_MAX_COUNT];
 
        struct net_if *iface_master;
 
        struct dsa_api *dapi;
 
        struct k_work_delayable dsa_work;
 
        uint8_t num_slave_ports;
 
        bool link_up[NET_DSA_PORT_MAX_COUNT];
 
        void *prv_data;
};
 
struct dsa_api {
        struct net_if *(*dsa_get_iface)(struct net_if *iface,
                                        struct net_pkt *pkt);
        /*
         * Callbacks required for DSA switch initialization and configuration.
         *
         * Each switch instance (e.g. two KSZ8794 ICs) would have its own struct
         * dsa_context.
         */
        int (*switch_read)(const struct device *dev, uint16_t reg_addr,
                                uint8_t *value);
        int (*switch_write)(const struct device *dev, uint16_t reg_addr,
                                uint8_t value);
 
        int (*switch_set_mac_table_entry)(const struct device *dev,
                                                const uint8_t *mac,
                                                uint8_t fw_port,
                                                uint16_t tbl_entry_idx,
                                                uint16_t flags);
 
        int (*switch_get_mac_table_entry)(const struct device *dev,
                                                uint8_t *buf,
                                                uint16_t tbl_entry_idx);
 
        /*
         * DSA helper callbacks
         */
        struct net_pkt *(*dsa_xmit_pkt)(struct net_if *iface,
                                        struct net_pkt *pkt);
};
 
struct net_if *dsa_get_slave_port(struct net_if *iface, int slave_num);
 
int dsa_switch_read(struct net_if *iface, uint16_t reg_addr, uint8_t *value);
 
int dsa_switch_write(struct net_if *iface, uint16_t reg_addr, uint8_t value);
 
int dsa_switch_set_mac_table_entry(struct net_if *iface,
                                        const uint8_t *mac,
                                        uint8_t fw_port,
                                        uint16_t tbl_entry_idx,
                                        uint16_t flags);
 
int dsa_switch_get_mac_table_entry(struct net_if *iface,
                                        uint8_t *buf,
                                        uint16_t tbl_entry_idx);
 
struct dsa_slave_config {
        uint8_t mac_addr[6];
};
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_NET_DSA_H_ */