drivers/net/ethernet/ti/icssg/icssg_prueth.h - linux - Git at Google

 /* SPDX-License-Identifier: GPL-2.0 */
 /* Texas Instruments ICSSG Ethernet driver
  *
  * Copyright (C) 2018-2022 Texas Instruments Incorporated - https://www.ti.com/
  *
  */

 #ifndef __NET_TI_ICSSG_PRUETH_H
 #define __NET_TI_ICSSG_PRUETH_H

 #include <linux/etherdevice.h>
 #include <linux/genalloc.h>
 #include <linux/if_vlan.h>
 #include <linux/interrupt.h>
 #include <linux/kernel.h>
 #include <linux/mfd/syscon.h>
 #include <linux/module.h>
 #include <linux/mutex.h>
 #include <linux/net_tstamp.h>
 #include <linux/of.h>
 #include <linux/of_irq.h>
 #include <linux/of_mdio.h>
 #include <linux/of_net.h>
 #include <linux/of_platform.h>
 #include <linux/phy.h>
 #include <linux/remoteproc/pruss.h>
 #include <linux/pruss_driver.h>
 #include <linux/ptp_clock_kernel.h>
 #include <linux/remoteproc.h>

 #include <linux/dma-mapping.h>
 #include <linux/dma/ti-cppi5.h>
 #include <linux/dma/k3-udma-glue.h>

 #include <net/devlink.h>

 #include "icssg_config.h"
 #include "icss_iep.h"
 #include "icssg_switch_map.h"

 #define PRUETH_MAX_MTU          (2000 - ETH_HLEN - ETH_FCS_LEN)
 #define PRUETH_MIN_PKT_SIZE     (VLAN_ETH_ZLEN)
 #define PRUETH_MAX_PKT_SIZE     (PRUETH_MAX_MTU + ETH_HLEN + ETH_FCS_LEN)

 #define ICSS_SLICE0	0
 #define ICSS_SLICE1	1

 #define ICSS_FW_PRU	0
 #define ICSS_FW_RTU	1

 #define ICSSG_MAX_RFLOWS	8	/* per slice */

 #define ICSSG_NUM_PA_STATS	4
 #define ICSSG_NUM_MIIG_STATS	60
 /* Number of ICSSG related stats */
 #define ICSSG_NUM_STATS (ICSSG_NUM_MIIG_STATS + ICSSG_NUM_PA_STATS)
 #define ICSSG_NUM_STANDARD_STATS 31
 #define ICSSG_NUM_ETHTOOL_STATS (ICSSG_NUM_STATS - ICSSG_NUM_STANDARD_STATS)

 #define IEP_DEFAULT_CYCLE_TIME_NS	1000000	/* 1 ms */

 #define PRUETH_UNDIRECTED_PKT_DST_TAG	0
 #define PRUETH_UNDIRECTED_PKT_TAG_INS	BIT(30)

 /* Firmware status codes */
 #define ICSS_HS_FW_READY 0x55555555
 #define ICSS_HS_FW_DEAD 0xDEAD0000	/* lower 16 bits contain error code */

 /* Firmware command codes */
 #define ICSS_HS_CMD_BUSY 0x40000000
 #define ICSS_HS_CMD_DONE 0x80000000
 #define ICSS_HS_CMD_CANCEL 0x10000000

 /* Firmware commands */
 #define ICSS_CMD_SPAD 0x20
 #define ICSS_CMD_RXTX 0x10
 #define ICSS_CMD_ADD_FDB 0x1
 #define ICSS_CMD_DEL_FDB 0x2
 #define ICSS_CMD_SET_RUN 0x4
 #define ICSS_CMD_GET_FDB_SLOT 0x5
 #define ICSS_CMD_ENABLE_VLAN 0x5
 #define ICSS_CMD_DISABLE_VLAN 0x6
 #define ICSS_CMD_ADD_FILTER 0x7
 #define ICSS_CMD_ADD_MAC 0x8

 /* In switch mode there are 3 real ports i.e. 3 mac addrs.
  * however Linux sees only the host side port. The other 2 ports
  * are the switch ports.
  * In emac mode there are 2 real ports i.e. 2 mac addrs.
  * Linux sees both the ports.
  */
 enum prueth_port {
 	PRUETH_PORT_HOST = 0,	/* host side port */
 	PRUETH_PORT_MII0,	/* physical port RG/SG MII 0 */
 	PRUETH_PORT_MII1,	/* physical port RG/SG MII 1 */
 	PRUETH_PORT_INVALID,	/* Invalid prueth port */
 };

 enum prueth_mac {
 	PRUETH_MAC0 = 0,
 	PRUETH_MAC1,
 	PRUETH_NUM_MACS,
 	PRUETH_MAC_INVALID,
 };

 struct prueth_tx_chn {
 	struct device *dma_dev;
 	struct napi_struct napi_tx;
 	struct k3_cppi_desc_pool *desc_pool;
 	struct k3_udma_glue_tx_channel *tx_chn;
 	struct prueth_emac *emac;
 	u32 id;
 	u32 descs_num;
 	unsigned int irq;
 	char name[32];
 	struct hrtimer tx_hrtimer;
 	unsigned long tx_pace_timeout_ns;
 };

 struct prueth_rx_chn {
 	struct device *dev;
 	struct device *dma_dev;
 	struct k3_cppi_desc_pool *desc_pool;
 	struct k3_udma_glue_rx_channel *rx_chn;
 	u32 descs_num;
 	unsigned int irq[ICSSG_MAX_RFLOWS];	/* separate irq per flow */
 	char name[32];
 };

 /* There are 4 Tx DMA channels, but the highest priority is CH3 (thread 3)
  * and lower three are lower priority channels or threads.
  */
 #define PRUETH_MAX_TX_QUEUES	4

 #define PRUETH_MAX_TX_TS_REQUESTS	50 /* Max simultaneous TX_TS requests */

 /* Minimum coalesce time in usecs for both Tx and Rx */
 #define ICSSG_MIN_COALESCE_USECS 20

 /* data for each emac port */
 struct prueth_emac {
 	bool is_sr1;
 	bool fw_running;
 	struct prueth *prueth;
 	struct net_device *ndev;
 	u8 mac_addr[6];
 	struct napi_struct napi_rx;
 	u32 msg_enable;

 	int link;
 	int speed;
 	int duplex;

 	const char *phy_id;
 	struct device_node *phy_node;
 	phy_interface_t phy_if;
 	enum prueth_port port_id;
 	struct icss_iep *iep;
 	unsigned int rx_ts_enabled : 1;
 	unsigned int tx_ts_enabled : 1;
 	unsigned int half_duplex : 1;

 	/* DMA related */
 	struct prueth_tx_chn tx_chns[PRUETH_MAX_TX_QUEUES];
 	struct completion tdown_complete;
 	atomic_t tdown_cnt;
 	struct prueth_rx_chn rx_chns;
 	int rx_flow_id_base;
 	int tx_ch_num;

 	/* SR1.0 Management channel */
 	struct prueth_rx_chn rx_mgm_chn;
 	int rx_mgm_flow_id_base;

 	spinlock_t lock;	/* serialize access */

 	/* TX HW Timestamping */
 	/* TX TS cookie will be index to the tx_ts_skb array */
 	struct sk_buff *tx_ts_skb[PRUETH_MAX_TX_TS_REQUESTS];
 	atomic_t tx_ts_pending;
 	int tx_ts_irq;

 	u8 cmd_seq;
 	/* shutdown related */
 	__le32 cmd_data[4];
 	struct completion cmd_complete;
 	/* Mutex to serialize access to firmware command interface */
 	struct mutex cmd_lock;
 	struct work_struct rx_mode_work;
 	struct workqueue_struct	*cmd_wq;

 	struct pruss_mem_region dram;

 	bool offload_fwd_mark;
 	int port_vlan;

 	struct delayed_work stats_work;
 	u64 stats[ICSSG_NUM_MIIG_STATS];
 	u64 pa_stats[ICSSG_NUM_PA_STATS];

 	/* RX IRQ Coalescing Related */
 	struct hrtimer rx_hrtimer;
 	unsigned long rx_pace_timeout_ns;
 };

 /**
  * struct prueth_pdata - PRUeth platform data
  * @fdqring_mode: Free desc queue mode
  * @quirk_10m_link_issue: 10M link detect errata
  * @switch_mode: switch firmware support
  */
 struct prueth_pdata {
 	enum k3_ring_mode fdqring_mode;
 	u32	quirk_10m_link_issue:1;
 	u32	switch_mode:1;
 };

 struct icssg_firmwares {
 	char *pru;
 	char *rtu;
 	char *txpru;
 };

 /**
  * struct prueth - PRUeth structure
  * @dev: device
  * @pruss: pruss handle
  * @pru: rproc instances of PRUs
  * @rtu: rproc instances of RTUs
  * @txpru: rproc instances of TX_PRUs
  * @shram: PRUSS shared RAM region
  * @sram_pool: MSMC RAM pool for buffers
  * @msmcram: MSMC RAM region
  * @eth_node: DT node for the port
  * @emac: private EMAC data structure
  * @registered_netdevs: list of registered netdevs
  * @miig_rt: regmap to mii_g_rt block
  * @mii_rt: regmap to mii_rt block
  * @pa_stats: regmap to pa_stats block
  * @pru_id: ID for each of the PRUs
  * @pdev: pointer to ICSSG platform device
  * @pdata: pointer to platform data for ICSSG driver
  * @icssg_hwcmdseq: seq counter or HWQ messages
  * @emacs_initialized: num of EMACs/ext ports that are up/running
  * @iep0: pointer to IEP0 device
  * @iep1: pointer to IEP1 device
  * @vlan_tbl: VLAN-FID table pointer
  * @hw_bridge_dev: pointer to HW bridge net device
  * @hsr_dev: pointer to the HSR net device
  * @br_members: bitmask of bridge member ports
  * @hsr_members: bitmask of hsr member ports
  * @prueth_netdevice_nb: netdevice notifier block
  * @prueth_switchdev_nb: switchdev notifier block
  * @prueth_switchdev_bl_nb: switchdev blocking notifier block
  * @is_switch_mode: flag to indicate if device is in Switch mode
  * @is_hsr_offload_mode: flag to indicate if device is in hsr offload mode
  * @is_switchmode_supported: indicates platform support for switch mode
  * @switch_id: ID for mapping switch ports to bridge
  * @default_vlan: Default VLAN for host
  */
 struct prueth {
 	struct device *dev;
 	struct pruss *pruss;
 	struct rproc *pru[PRUSS_NUM_PRUS];
 	struct rproc *rtu[PRUSS_NUM_PRUS];
 	struct rproc *txpru[PRUSS_NUM_PRUS];
 	struct pruss_mem_region shram;
 	struct gen_pool *sram_pool;
 	struct pruss_mem_region msmcram;

 	struct device_node *eth_node[PRUETH_NUM_MACS];
 	struct prueth_emac *emac[PRUETH_NUM_MACS];
 	struct net_device *registered_netdevs[PRUETH_NUM_MACS];
 	struct regmap *miig_rt;
 	struct regmap *mii_rt;
 	struct regmap *pa_stats;

 	enum pruss_pru_id pru_id[PRUSS_NUM_PRUS];
 	struct platform_device *pdev;
 	struct prueth_pdata pdata;
 	u8 icssg_hwcmdseq;
 	int emacs_initialized;
 	struct icss_iep *iep0;
 	struct icss_iep *iep1;
 	struct prueth_vlan_tbl *vlan_tbl;

 	struct net_device *hw_bridge_dev;
 	struct net_device *hsr_dev;
 	u8 br_members;
 	u8 hsr_members;
 	struct notifier_block prueth_netdevice_nb;
 	struct notifier_block prueth_switchdev_nb;
 	struct notifier_block prueth_switchdev_bl_nb;
 	bool is_switch_mode;
 	bool is_hsr_offload_mode;
 	bool is_switchmode_supported;
 	unsigned char switch_id[MAX_PHYS_ITEM_ID_LEN];
 	int default_vlan;
 	/** @vtbl_lock: Lock for vtbl in shared memory */
 	spinlock_t vtbl_lock;
 };

 struct emac_tx_ts_response {
 	u32 reserved[2];
 	u32 cookie;
 	u32 lo_ts;
 	u32 hi_ts;
 };

 struct emac_tx_ts_response_sr1 {
 	__le32 lo_ts;
 	__le32 hi_ts;
 	__le32 reserved;
 	__le32 cookie;
 };

 /* get PRUSS SLICE number from prueth_emac */
 static inline int prueth_emac_slice(struct prueth_emac *emac)
 {
 	switch (emac->port_id) {
 	case PRUETH_PORT_MII0:
 		return ICSS_SLICE0;
 	case PRUETH_PORT_MII1:
 		return ICSS_SLICE1;
 	default:
 		return -EINVAL;
 	}
 }

 extern const struct ethtool_ops icssg_ethtool_ops;
 extern const struct dev_pm_ops prueth_dev_pm_ops;

 /* Classifier helpers */
 void icssg_class_set_mac_addr(struct regmap *miig_rt, int slice, u8 *mac);
 void icssg_class_set_host_mac_addr(struct regmap *miig_rt, const u8 *mac);
 void icssg_class_disable(struct regmap *miig_rt, int slice);
 void icssg_class_default(struct regmap *miig_rt, int slice, bool allmulti,
 			 bool is_sr1);
 void icssg_class_promiscuous_sr1(struct regmap *miig_rt, int slice);
 void icssg_class_add_mcast_sr1(struct regmap *miig_rt, int slice,
 			       struct net_device *ndev);
 void icssg_ft1_set_mac_addr(struct regmap *miig_rt, int slice, u8 *mac_addr);

 /* config helpers */
 void icssg_config_ipg(struct prueth_emac *emac);
 int icssg_config(struct prueth *prueth, struct prueth_emac *emac,
 		 int slice);
 int icssg_set_port_state(struct prueth_emac *emac,
 			 enum icssg_port_state_cmd state);
 void icssg_config_set_speed(struct prueth_emac *emac);
 void icssg_config_half_duplex(struct prueth_emac *emac);

 /* Buffer queue helpers */
 int icssg_queue_pop(struct prueth *prueth, u8 queue);
 void icssg_queue_push(struct prueth *prueth, int queue, u16 addr);
 u32 icssg_queue_level(struct prueth *prueth, int queue);

 int icssg_send_fdb_msg(struct prueth_emac *emac, struct mgmt_cmd *cmd,
 		       struct mgmt_cmd_rsp *rsp);
 int icssg_fdb_add_del(struct prueth_emac *emac,  const unsigned char *addr,
 		      u8 vid, u8 fid_c2, bool add);
 int icssg_fdb_lookup(struct prueth_emac *emac, const unsigned char *addr,
 		     u8 vid);
 void icssg_vtbl_modify(struct prueth_emac *emac, u8 vid, u8 port_mask,
 		       u8 untag_mask, bool add);
 u16 icssg_get_pvid(struct prueth_emac *emac);
 void icssg_set_pvid(struct prueth *prueth, u8 vid, u8 port);
 #define prueth_napi_to_tx_chn(pnapi) \
 	container_of(pnapi, struct prueth_tx_chn, napi_tx)

 void icssg_stats_work_handler(struct work_struct *work);
 void emac_update_hardware_stats(struct prueth_emac *emac);
 int emac_get_stat_by_name(struct prueth_emac *emac, char *stat_name);

 /* Common functions */
 void prueth_cleanup_rx_chns(struct prueth_emac *emac,
 			    struct prueth_rx_chn *rx_chn,
 			    int max_rflows);
 void prueth_cleanup_tx_chns(struct prueth_emac *emac);
 void prueth_ndev_del_tx_napi(struct prueth_emac *emac, int num);
 void prueth_xmit_free(struct prueth_tx_chn *tx_chn,
 		      struct cppi5_host_desc_t *desc);
 int emac_tx_complete_packets(struct prueth_emac *emac, int chn,
 			     int budget, bool *tdown);
 int prueth_ndev_add_tx_napi(struct prueth_emac *emac);
 int prueth_init_tx_chns(struct prueth_emac *emac);
 int prueth_init_rx_chns(struct prueth_emac *emac,
 			struct prueth_rx_chn *rx_chn,
 			char *name, u32 max_rflows,
 			u32 max_desc_num);
 int prueth_dma_rx_push(struct prueth_emac *emac,
 		       struct sk_buff *skb,
 		       struct prueth_rx_chn *rx_chn);
 void emac_rx_timestamp(struct prueth_emac *emac,
 		       struct sk_buff *skb, u32 *psdata);
 enum netdev_tx icssg_ndo_start_xmit(struct sk_buff *skb, struct net_device *ndev);
 irqreturn_t prueth_rx_irq(int irq, void *dev_id);
 void prueth_emac_stop(struct prueth_emac *emac);
 void prueth_cleanup_tx_ts(struct prueth_emac *emac);
 int icssg_napi_rx_poll(struct napi_struct *napi_rx, int budget);
 int prueth_prepare_rx_chan(struct prueth_emac *emac,
 			   struct prueth_rx_chn *chn,
 			   int buf_size);
 void prueth_reset_tx_chan(struct prueth_emac *emac, int ch_num,
 			  bool free_skb);
 void prueth_reset_rx_chan(struct prueth_rx_chn *chn,
 			  int num_flows, bool disable);
 void icssg_ndo_tx_timeout(struct net_device *ndev, unsigned int txqueue);
 int icssg_ndo_ioctl(struct net_device *ndev, struct ifreq *ifr, int cmd);
 void icssg_ndo_get_stats64(struct net_device *ndev,
 			   struct rtnl_link_stats64 *stats);
 int icssg_ndo_get_phys_port_name(struct net_device *ndev, char *name,
 				 size_t len);
 int prueth_node_port(struct device_node *eth_node);
 int prueth_node_mac(struct device_node *eth_node);
 void prueth_netdev_exit(struct prueth *prueth,
 			struct device_node *eth_node);
 int prueth_get_cores(struct prueth *prueth, int slice, bool is_sr1);
 void prueth_put_cores(struct prueth *prueth, int slice);

 /* Revision specific helper */
 u64 icssg_ts_to_ns(u32 hi_sw, u32 hi, u32 lo, u32 cycle_time_ns);

 #endif /* __NET_TI_ICSSG_PRUETH_H */
	/* SPDX-License-Identifier: GPL-2.0 */
	/* Texas Instruments ICSSG Ethernet driver
	*
	* Copyright (C) 2018-2022 Texas Instruments Incorporated - https://www.ti.com/
	*
	*/

	#ifndef __NET_TI_ICSSG_PRUETH_H
	#define __NET_TI_ICSSG_PRUETH_H

	#include <linux/etherdevice.h>
	#include <linux/genalloc.h>
	#include <linux/if_vlan.h>
	#include <linux/interrupt.h>
	#include <linux/kernel.h>
	#include <linux/mfd/syscon.h>
	#include <linux/module.h>
	#include <linux/mutex.h>
	#include <linux/net_tstamp.h>
	#include <linux/of.h>
	#include <linux/of_irq.h>
	#include <linux/of_mdio.h>
	#include <linux/of_net.h>
	#include <linux/of_platform.h>
	#include <linux/phy.h>
	#include <linux/remoteproc/pruss.h>
	#include <linux/pruss_driver.h>
	#include <linux/ptp_clock_kernel.h>
	#include <linux/remoteproc.h>

	#include <linux/dma-mapping.h>
	#include <linux/dma/ti-cppi5.h>
	#include <linux/dma/k3-udma-glue.h>

	#include <net/devlink.h>

	#include "icssg_config.h"
	#include "icss_iep.h"
	#include "icssg_switch_map.h"

	#define PRUETH_MAX_MTU (2000 - ETH_HLEN - ETH_FCS_LEN)
	#define PRUETH_MIN_PKT_SIZE (VLAN_ETH_ZLEN)
	#define PRUETH_MAX_PKT_SIZE (PRUETH_MAX_MTU + ETH_HLEN + ETH_FCS_LEN)

	#define ICSS_SLICE0 0
	#define ICSS_SLICE1 1

	#define ICSS_FW_PRU 0
	#define ICSS_FW_RTU 1

	#define ICSSG_MAX_RFLOWS 8 /* per slice */

	#define ICSSG_NUM_PA_STATS 4
	#define ICSSG_NUM_MIIG_STATS 60
	/* Number of ICSSG related stats */
	#define ICSSG_NUM_STATS (ICSSG_NUM_MIIG_STATS + ICSSG_NUM_PA_STATS)
	#define ICSSG_NUM_STANDARD_STATS 31
	#define ICSSG_NUM_ETHTOOL_STATS (ICSSG_NUM_STATS - ICSSG_NUM_STANDARD_STATS)

	#define IEP_DEFAULT_CYCLE_TIME_NS 1000000 /* 1 ms */

	#define PRUETH_UNDIRECTED_PKT_DST_TAG 0
	#define PRUETH_UNDIRECTED_PKT_TAG_INS BIT(30)

	/* Firmware status codes */
	#define ICSS_HS_FW_READY 0x55555555
	#define ICSS_HS_FW_DEAD 0xDEAD0000 /* lower 16 bits contain error code */

	/* Firmware command codes */
	#define ICSS_HS_CMD_BUSY 0x40000000
	#define ICSS_HS_CMD_DONE 0x80000000
	#define ICSS_HS_CMD_CANCEL 0x10000000

	/* Firmware commands */
	#define ICSS_CMD_SPAD 0x20
	#define ICSS_CMD_RXTX 0x10
	#define ICSS_CMD_ADD_FDB 0x1
	#define ICSS_CMD_DEL_FDB 0x2
	#define ICSS_CMD_SET_RUN 0x4
	#define ICSS_CMD_GET_FDB_SLOT 0x5
	#define ICSS_CMD_ENABLE_VLAN 0x5
	#define ICSS_CMD_DISABLE_VLAN 0x6
	#define ICSS_CMD_ADD_FILTER 0x7
	#define ICSS_CMD_ADD_MAC 0x8

	/* In switch mode there are 3 real ports i.e. 3 mac addrs.
	* however Linux sees only the host side port. The other 2 ports
	* are the switch ports.
	* In emac mode there are 2 real ports i.e. 2 mac addrs.
	* Linux sees both the ports.
	*/
	enum prueth_port {
	PRUETH_PORT_HOST = 0, /* host side port */
	PRUETH_PORT_MII0, /* physical port RG/SG MII 0 */
	PRUETH_PORT_MII1, /* physical port RG/SG MII 1 */
	PRUETH_PORT_INVALID, /* Invalid prueth port */
	};

	enum prueth_mac {
	PRUETH_MAC0 = 0,
	PRUETH_MAC1,
	PRUETH_NUM_MACS,
	PRUETH_MAC_INVALID,
	};

	struct prueth_tx_chn {
	struct device *dma_dev;
	struct napi_struct napi_tx;
	struct k3_cppi_desc_pool *desc_pool;
	struct k3_udma_glue_tx_channel *tx_chn;
	struct prueth_emac *emac;
	u32 id;
	u32 descs_num;
	unsigned int irq;
	char name[32];
	struct hrtimer tx_hrtimer;
	unsigned long tx_pace_timeout_ns;
	};

	struct prueth_rx_chn {
	struct device *dev;
	struct device *dma_dev;
	struct k3_cppi_desc_pool *desc_pool;
	struct k3_udma_glue_rx_channel *rx_chn;
	u32 descs_num;
	unsigned int irq[ICSSG_MAX_RFLOWS]; /* separate irq per flow */
	char name[32];
	};

	/* There are 4 Tx DMA channels, but the highest priority is CH3 (thread 3)
	* and lower three are lower priority channels or threads.
	*/
	#define PRUETH_MAX_TX_QUEUES 4

	#define PRUETH_MAX_TX_TS_REQUESTS 50 /* Max simultaneous TX_TS requests */

	/* Minimum coalesce time in usecs for both Tx and Rx */
	#define ICSSG_MIN_COALESCE_USECS 20

	/* data for each emac port */
	struct prueth_emac {
	bool is_sr1;
	bool fw_running;
	struct prueth *prueth;
	struct net_device *ndev;
	u8 mac_addr[6];
	struct napi_struct napi_rx;
	u32 msg_enable;

	int link;
	int speed;
	int duplex;

	const char *phy_id;
	struct device_node *phy_node;
	phy_interface_t phy_if;
	enum prueth_port port_id;
	struct icss_iep *iep;
	unsigned int rx_ts_enabled : 1;
	unsigned int tx_ts_enabled : 1;
	unsigned int half_duplex : 1;

	/* DMA related */
	struct prueth_tx_chn tx_chns[PRUETH_MAX_TX_QUEUES];
	struct completion tdown_complete;
	atomic_t tdown_cnt;
	struct prueth_rx_chn rx_chns;
	int rx_flow_id_base;
	int tx_ch_num;

	/* SR1.0 Management channel */
	struct prueth_rx_chn rx_mgm_chn;
	int rx_mgm_flow_id_base;

	spinlock_t lock; /* serialize access */

	/* TX HW Timestamping */
	/* TX TS cookie will be index to the tx_ts_skb array */
	struct sk_buff *tx_ts_skb[PRUETH_MAX_TX_TS_REQUESTS];
	atomic_t tx_ts_pending;
	int tx_ts_irq;

	u8 cmd_seq;
	/* shutdown related */
	__le32 cmd_data[4];
	struct completion cmd_complete;
	/* Mutex to serialize access to firmware command interface */
	struct mutex cmd_lock;
	struct work_struct rx_mode_work;
	struct workqueue_struct *cmd_wq;

	struct pruss_mem_region dram;

	bool offload_fwd_mark;
	int port_vlan;

	struct delayed_work stats_work;
	u64 stats[ICSSG_NUM_MIIG_STATS];
	u64 pa_stats[ICSSG_NUM_PA_STATS];

	/* RX IRQ Coalescing Related */
	struct hrtimer rx_hrtimer;
	unsigned long rx_pace_timeout_ns;
	};

	/**
	* struct prueth_pdata - PRUeth platform data
	* @fdqring_mode: Free desc queue mode
	* @quirk_10m_link_issue: 10M link detect errata
	* @switch_mode: switch firmware support
	*/
	struct prueth_pdata {
	enum k3_ring_mode fdqring_mode;
	u32 quirk_10m_link_issue:1;
	u32 switch_mode:1;
	};

	struct icssg_firmwares {
	char *pru;
	char *rtu;
	char *txpru;
	};

	/**
	* struct prueth - PRUeth structure
	* @dev: device
	* @pruss: pruss handle
	* @pru: rproc instances of PRUs
	* @rtu: rproc instances of RTUs
	* @txpru: rproc instances of TX_PRUs
	* @shram: PRUSS shared RAM region
	* @sram_pool: MSMC RAM pool for buffers
	* @msmcram: MSMC RAM region
	* @eth_node: DT node for the port
	* @emac: private EMAC data structure
	* @registered_netdevs: list of registered netdevs
	* @miig_rt: regmap to mii_g_rt block
	* @mii_rt: regmap to mii_rt block
	* @pa_stats: regmap to pa_stats block
	* @pru_id: ID for each of the PRUs
	* @pdev: pointer to ICSSG platform device
	* @pdata: pointer to platform data for ICSSG driver
	* @icssg_hwcmdseq: seq counter or HWQ messages
	* @emacs_initialized: num of EMACs/ext ports that are up/running
	* @iep0: pointer to IEP0 device
	* @iep1: pointer to IEP1 device
	* @vlan_tbl: VLAN-FID table pointer
	* @hw_bridge_dev: pointer to HW bridge net device
	* @hsr_dev: pointer to the HSR net device
	* @br_members: bitmask of bridge member ports
	* @hsr_members: bitmask of hsr member ports
	* @prueth_netdevice_nb: netdevice notifier block
	* @prueth_switchdev_nb: switchdev notifier block
	* @prueth_switchdev_bl_nb: switchdev blocking notifier block
	* @is_switch_mode: flag to indicate if device is in Switch mode
	* @is_hsr_offload_mode: flag to indicate if device is in hsr offload mode
	* @is_switchmode_supported: indicates platform support for switch mode
	* @switch_id: ID for mapping switch ports to bridge
	* @default_vlan: Default VLAN for host
	*/
	struct prueth {
	struct device *dev;
	struct pruss *pruss;
	struct rproc *pru[PRUSS_NUM_PRUS];
	struct rproc *rtu[PRUSS_NUM_PRUS];
	struct rproc *txpru[PRUSS_NUM_PRUS];
	struct pruss_mem_region shram;
	struct gen_pool *sram_pool;
	struct pruss_mem_region msmcram;

	struct device_node *eth_node[PRUETH_NUM_MACS];
	struct prueth_emac *emac[PRUETH_NUM_MACS];
	struct net_device *registered_netdevs[PRUETH_NUM_MACS];
	struct regmap *miig_rt;
	struct regmap *mii_rt;
	struct regmap *pa_stats;

	enum pruss_pru_id pru_id[PRUSS_NUM_PRUS];
	struct platform_device *pdev;
	struct prueth_pdata pdata;
	u8 icssg_hwcmdseq;
	int emacs_initialized;
	struct icss_iep *iep0;
	struct icss_iep *iep1;
	struct prueth_vlan_tbl *vlan_tbl;

	struct net_device *hw_bridge_dev;
	struct net_device *hsr_dev;
	u8 br_members;
	u8 hsr_members;
	struct notifier_block prueth_netdevice_nb;
	struct notifier_block prueth_switchdev_nb;
	struct notifier_block prueth_switchdev_bl_nb;
	bool is_switch_mode;
	bool is_hsr_offload_mode;
	bool is_switchmode_supported;
	unsigned char switch_id[MAX_PHYS_ITEM_ID_LEN];
	int default_vlan;
	/** @vtbl_lock: Lock for vtbl in shared memory */
	spinlock_t vtbl_lock;
	};

	struct emac_tx_ts_response {
	u32 reserved[2];
	u32 cookie;
	u32 lo_ts;
	u32 hi_ts;
	};

	struct emac_tx_ts_response_sr1 {
	__le32 lo_ts;
	__le32 hi_ts;
	__le32 reserved;
	__le32 cookie;
	};

	/* get PRUSS SLICE number from prueth_emac */
	static inline int prueth_emac_slice(struct prueth_emac *emac)
	{
	switch (emac->port_id) {
	case PRUETH_PORT_MII0:
	return ICSS_SLICE0;
	case PRUETH_PORT_MII1:
	return ICSS_SLICE1;
	default:
	return -EINVAL;
	}
	}

	extern const struct ethtool_ops icssg_ethtool_ops;
	extern const struct dev_pm_ops prueth_dev_pm_ops;

	/* Classifier helpers */
	void icssg_class_set_mac_addr(struct regmap miig_rt, int slice, u8 mac);
	void icssg_class_set_host_mac_addr(struct regmap miig_rt, const u8 mac);
	void icssg_class_disable(struct regmap *miig_rt, int slice);
	void icssg_class_default(struct regmap *miig_rt, int slice, bool allmulti,
	bool is_sr1);
	void icssg_class_promiscuous_sr1(struct regmap *miig_rt, int slice);
	void icssg_class_add_mcast_sr1(struct regmap *miig_rt, int slice,
	struct net_device *ndev);
	void icssg_ft1_set_mac_addr(struct regmap miig_rt, int slice, u8 mac_addr);

	/* config helpers */
	void icssg_config_ipg(struct prueth_emac *emac);
	int icssg_config(struct prueth prueth, struct prueth_emac emac,
	int slice);
	int icssg_set_port_state(struct prueth_emac *emac,
	enum icssg_port_state_cmd state);
	void icssg_config_set_speed(struct prueth_emac *emac);
	void icssg_config_half_duplex(struct prueth_emac *emac);

	/* Buffer queue helpers */
	int icssg_queue_pop(struct prueth *prueth, u8 queue);
	void icssg_queue_push(struct prueth *prueth, int queue, u16 addr);
	u32 icssg_queue_level(struct prueth *prueth, int queue);

	int icssg_send_fdb_msg(struct prueth_emac emac, struct mgmt_cmd cmd,
	struct mgmt_cmd_rsp *rsp);
	int icssg_fdb_add_del(struct prueth_emac emac, const unsigned char addr,
	u8 vid, u8 fid_c2, bool add);
	int icssg_fdb_lookup(struct prueth_emac emac, const unsigned char addr,
	u8 vid);
	void icssg_vtbl_modify(struct prueth_emac *emac, u8 vid, u8 port_mask,
	u8 untag_mask, bool add);
	u16 icssg_get_pvid(struct prueth_emac *emac);
	void icssg_set_pvid(struct prueth *prueth, u8 vid, u8 port);
	#define prueth_napi_to_tx_chn(pnapi) \
	container_of(pnapi, struct prueth_tx_chn, napi_tx)

	void icssg_stats_work_handler(struct work_struct *work);
	void emac_update_hardware_stats(struct prueth_emac *emac);
	int emac_get_stat_by_name(struct prueth_emac emac, char stat_name);

	/* Common functions */
	void prueth_cleanup_rx_chns(struct prueth_emac *emac,
	struct prueth_rx_chn *rx_chn,
	int max_rflows);
	void prueth_cleanup_tx_chns(struct prueth_emac *emac);
	void prueth_ndev_del_tx_napi(struct prueth_emac *emac, int num);
	void prueth_xmit_free(struct prueth_tx_chn *tx_chn,
	struct cppi5_host_desc_t *desc);
	int emac_tx_complete_packets(struct prueth_emac *emac, int chn,
	int budget, bool *tdown);
	int prueth_ndev_add_tx_napi(struct prueth_emac *emac);
	int prueth_init_tx_chns(struct prueth_emac *emac);
	int prueth_init_rx_chns(struct prueth_emac *emac,
	struct prueth_rx_chn *rx_chn,
	char *name, u32 max_rflows,
	u32 max_desc_num);
	int prueth_dma_rx_push(struct prueth_emac *emac,
	struct sk_buff *skb,
	struct prueth_rx_chn *rx_chn);
	void emac_rx_timestamp(struct prueth_emac *emac,
	struct sk_buff skb, u32 psdata);
	enum netdev_tx icssg_ndo_start_xmit(struct sk_buff skb, struct net_device ndev);
	irqreturn_t prueth_rx_irq(int irq, void *dev_id);
	void prueth_emac_stop(struct prueth_emac *emac);
	void prueth_cleanup_tx_ts(struct prueth_emac *emac);
	int icssg_napi_rx_poll(struct napi_struct *napi_rx, int budget);
	int prueth_prepare_rx_chan(struct prueth_emac *emac,
	struct prueth_rx_chn *chn,
	int buf_size);
	void prueth_reset_tx_chan(struct prueth_emac *emac, int ch_num,
	bool free_skb);
	void prueth_reset_rx_chan(struct prueth_rx_chn *chn,
	int num_flows, bool disable);
	void icssg_ndo_tx_timeout(struct net_device *ndev, unsigned int txqueue);
	int icssg_ndo_ioctl(struct net_device ndev, struct ifreq ifr, int cmd);
	void icssg_ndo_get_stats64(struct net_device *ndev,
	struct rtnl_link_stats64 *stats);
	int icssg_ndo_get_phys_port_name(struct net_device ndev, char name,
	size_t len);
	int prueth_node_port(struct device_node *eth_node);
	int prueth_node_mac(struct device_node *eth_node);
	void prueth_netdev_exit(struct prueth *prueth,
	struct device_node *eth_node);
	int prueth_get_cores(struct prueth *prueth, int slice, bool is_sr1);
	void prueth_put_cores(struct prueth *prueth, int slice);

	/* Revision specific helper */
	u64 icssg_ts_to_ns(u32 hi_sw, u32 hi, u32 lo, u32 cycle_time_ns);

	#endif /* __NET_TI_ICSSG_PRUETH_H */