[mirror_ubuntu-focal-kernel.git] / include / net / dsa.h

/*
 * include/net/dsa.h - Driver for Distributed Switch Architecture switch chips
 * Copyright (c) 2008-2009 Marvell Semiconductor
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 */

#ifndef __LINUX_NET_DSA_H
#define __LINUX_NET_DSA_H

#include <linux/if.h>
#include <linux/if_ether.h>
#include <linux/list.h>
#include <linux/notifier.h>
#include <linux/timer.h>
#include <linux/workqueue.h>
#include <linux/of.h>
#include <linux/ethtool.h>
#include <net/devlink.h>
#include <net/switchdev.h>

struct tc_action;
struct phy_device;
struct fixed_phy_status;

enum dsa_tag_protocol {
	DSA_TAG_PROTO_NONE = 0,
	DSA_TAG_PROTO_BRCM,
	DSA_TAG_PROTO_DSA,
	DSA_TAG_PROTO_EDSA,
	DSA_TAG_PROTO_KSZ,
	DSA_TAG_PROTO_LAN9303,
	DSA_TAG_PROTO_MTK,
	DSA_TAG_PROTO_QCA,
	DSA_TAG_PROTO_TRAILER,
	DSA_TAG_LAST,		/* MUST BE LAST */
};

#define DSA_MAX_SWITCHES	4
#define DSA_MAX_PORTS		12

#define DSA_RTABLE_NONE		-1

struct dsa_chip_data {
	/*
	 * How to access the switch configuration registers.
	 */
	struct device	*host_dev;
	int		sw_addr;

	/*
	 * Reference to network devices
	 */
	struct device	*netdev[DSA_MAX_PORTS];

	/* set to size of eeprom if supported by the switch */
	int		eeprom_len;

	/* Device tree node pointer for this specific switch chip
	 * used during switch setup in case additional properties
	 * and resources needs to be used
	 */
	struct device_node *of_node;

	/*
	 * The names of the switch's ports.  Use "cpu" to
	 * designate the switch port that the cpu is connected to,
	 * "dsa" to indicate that this port is a DSA link to
	 * another switch, NULL to indicate the port is unused,
	 * or any other string to indicate this is a physical port.
	 */
	char		*port_names[DSA_MAX_PORTS];
	struct device_node *port_dn[DSA_MAX_PORTS];

	/*
	 * An array of which element [a] indicates which port on this
	 * switch should be used to send packets to that are destined
	 * for switch a. Can be NULL if there is only one switch chip.
	 */
	s8		rtable[DSA_MAX_SWITCHES];
};

struct dsa_platform_data {
	/*
	 * Reference to a Linux network interface that connects
	 * to the root switch chip of the tree.
	 */
	struct device	*netdev;
	struct net_device *of_netdev;

	/*
	 * Info structs describing each of the switch chips
	 * connected via this network interface.
	 */
	int		nr_chips;
	struct dsa_chip_data	*chip;
};

struct packet_type;

struct dsa_switch_tree {
	struct list_head	list;

	/* Notifier chain for switch-wide events */
	struct raw_notifier_head	nh;

	/* Tree identifier */
	u32 tree;

	/* Number of switches attached to this tree */
	struct kref refcount;

	/* Has this tree been applied to the hardware? */
	bool applied;

	/*
	 * Configuration data for the platform device that owns
	 * this dsa switch tree instance.
	 */
	struct dsa_platform_data	*pd;

	/*
	 * Reference to network device to use, and which tagging
	 * protocol to use.
	 */
	struct net_device	*master_netdev;

	/* Copy of tag_ops->rcv for faster access in hot path */
	struct sk_buff *	(*rcv)(struct sk_buff *skb,
				       struct net_device *dev,
				       struct packet_type *pt,
				       struct net_device *orig_dev);

	/*
	 * Original copy of the master netdev ethtool_ops
	 */
	struct ethtool_ops	master_ethtool_ops;
	const struct ethtool_ops *master_orig_ethtool_ops;

	/*
	 * The switch port to which the CPU is attached.
	 */
	struct dsa_port		*cpu_dp;

	/*
	 * Data for the individual switch chips.
	 */
	struct dsa_switch	*ds[DSA_MAX_SWITCHES];

	/*
	 * Tagging protocol operations for adding and removing an
	 * encapsulation tag.
	 */
	const struct dsa_device_ops *tag_ops;
};

/* TC matchall action types, only mirroring for now */
enum dsa_port_mall_action_type {
	DSA_PORT_MALL_MIRROR,
};

/* TC mirroring entry */
struct dsa_mall_mirror_tc_entry {
	u8 to_local_port;
	bool ingress;
};

/* TC matchall entry */
struct dsa_mall_tc_entry {
	struct list_head list;
	unsigned long cookie;
	enum dsa_port_mall_action_type type;
	union {
		struct dsa_mall_mirror_tc_entry mirror;
	};
};


struct dsa_port {
	struct dsa_switch	*ds;
	unsigned int		index;
	const char		*name;
	struct net_device	*netdev;
	struct device_node	*dn;
	unsigned int		ageing_time;
	u8			stp_state;
	struct net_device	*bridge_dev;
	struct devlink_port	devlink_port;
};

struct dsa_switch {
	struct device *dev;

	/*
	 * Parent switch tree, and switch index.
	 */
	struct dsa_switch_tree	*dst;
	int			index;

	/* Listener for switch fabric events */
	struct notifier_block	nb;

	/*
	 * Give the switch driver somewhere to hang its private data
	 * structure.
	 */
	void *priv;

	/*
	 * Configuration data for this switch.
	 */
	struct dsa_chip_data	*cd;

	/*
	 * The switch operations.
	 */
	const struct dsa_switch_ops	*ops;

	/*
	 * An array of which element [a] indicates which port on this
	 * switch should be used to send packets to that are destined
	 * for switch a. Can be NULL if there is only one switch chip.
	 */
	s8		rtable[DSA_MAX_SWITCHES];

	/*
	 * The lower device this switch uses to talk to the host
	 */
	struct net_device *master_netdev;

	/*
	 * Slave mii_bus and devices for the individual ports.
	 */
	u32			dsa_port_mask;
	u32			cpu_port_mask;
	u32			enabled_port_mask;
	u32			phys_mii_mask;
	struct mii_bus		*slave_mii_bus;

	/* Ageing Time limits in msecs */
	unsigned int ageing_time_min;
	unsigned int ageing_time_max;

	/* devlink used to represent this switch device */
	struct devlink		*devlink;

	/* Dynamically allocated ports, keep last */
	size_t num_ports;
	struct dsa_port ports[];
};

static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
{
	return ds->dst->cpu_dp == &ds->ports[p];
}

static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
{
	return !!((ds->dsa_port_mask) & (1 << p));
}

static inline bool dsa_is_normal_port(struct dsa_switch *ds, int p)
{
	return !dsa_is_cpu_port(ds, p) && !dsa_is_dsa_port(ds, p);
}

static inline bool dsa_is_port_initialized(struct dsa_switch *ds, int p)
{
	return ds->enabled_port_mask & (1 << p) && ds->ports[p].netdev;
}

static inline u8 dsa_upstream_port(struct dsa_switch *ds)
{
	struct dsa_switch_tree *dst = ds->dst;

	/*
	 * If this is the root switch (i.e. the switch that connects
	 * to the CPU), return the cpu port number on this switch.
	 * Else return the (DSA) port number that connects to the
	 * switch that is one hop closer to the cpu.
	 */
	if (dst->cpu_dp->ds == ds)
		return dst->cpu_dp->index;
	else
		return ds->rtable[dst->cpu_dp->ds->index];
}

struct dsa_switch_ops {
	/*
	 * Legacy probing.
	 */
	const char	*(*probe)(struct device *dsa_dev,
				  struct device *host_dev, int sw_addr,
				  void **priv);

	enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds);

	int	(*setup)(struct dsa_switch *ds);
	int	(*set_addr)(struct dsa_switch *ds, u8 *addr);
	u32	(*get_phy_flags)(struct dsa_switch *ds, int port);

	/*
	 * Access to the switch's PHY registers.
	 */
	int	(*phy_read)(struct dsa_switch *ds, int port, int regnum);
	int	(*phy_write)(struct dsa_switch *ds, int port,
			     int regnum, u16 val);

	/*
	 * Link state adjustment (called from libphy)
	 */
	void	(*adjust_link)(struct dsa_switch *ds, int port,
				struct phy_device *phydev);
	void	(*fixed_link_update)(struct dsa_switch *ds, int port,
				struct fixed_phy_status *st);

	/*
	 * ethtool hardware statistics.
	 */
	void	(*get_strings)(struct dsa_switch *ds, int port, uint8_t *data);
	void	(*get_ethtool_stats)(struct dsa_switch *ds,
				     int port, uint64_t *data);
	int	(*get_sset_count)(struct dsa_switch *ds);

	/*
	 * ethtool Wake-on-LAN
	 */
	void	(*get_wol)(struct dsa_switch *ds, int port,
			   struct ethtool_wolinfo *w);
	int	(*set_wol)(struct dsa_switch *ds, int port,
			   struct ethtool_wolinfo *w);

	/*
	 * Suspend and resume
	 */
	int	(*suspend)(struct dsa_switch *ds);
	int	(*resume)(struct dsa_switch *ds);

	/*
	 * Port enable/disable
	 */
	int	(*port_enable)(struct dsa_switch *ds, int port,
			       struct phy_device *phy);
	void	(*port_disable)(struct dsa_switch *ds, int port,
				struct phy_device *phy);

	/*
	 * EEE setttings
	 */
	int	(*set_eee)(struct dsa_switch *ds, int port,
			   struct phy_device *phydev,
			   struct ethtool_eee *e);
	int	(*get_eee)(struct dsa_switch *ds, int port,
			   struct ethtool_eee *e);

	/* EEPROM access */
	int	(*get_eeprom_len)(struct dsa_switch *ds);
	int	(*get_eeprom)(struct dsa_switch *ds,
			      struct ethtool_eeprom *eeprom, u8 *data);
	int	(*set_eeprom)(struct dsa_switch *ds,
			      struct ethtool_eeprom *eeprom, u8 *data);

	/*
	 * Register access.
	 */
	int	(*get_regs_len)(struct dsa_switch *ds, int port);
	void	(*get_regs)(struct dsa_switch *ds, int port,
			    struct ethtool_regs *regs, void *p);

	/*
	 * Bridge integration
	 */
	int	(*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
	int	(*port_bridge_join)(struct dsa_switch *ds, int port,
				    struct net_device *bridge);
	void	(*port_bridge_leave)(struct dsa_switch *ds, int port,
				     struct net_device *bridge);
	void	(*port_stp_state_set)(struct dsa_switch *ds, int port,
				      u8 state);
	void	(*port_fast_age)(struct dsa_switch *ds, int port);

	/*
	 * VLAN support
	 */
	int	(*port_vlan_filtering)(struct dsa_switch *ds, int port,
				       bool vlan_filtering);
	int	(*port_vlan_prepare)(struct dsa_switch *ds, int port,
				     const struct switchdev_obj_port_vlan *vlan,
				     struct switchdev_trans *trans);
	void	(*port_vlan_add)(struct dsa_switch *ds, int port,
				 const struct switchdev_obj_port_vlan *vlan,
				 struct switchdev_trans *trans);
	int	(*port_vlan_del)(struct dsa_switch *ds, int port,
				 const struct switchdev_obj_port_vlan *vlan);
	int	(*port_vlan_dump)(struct dsa_switch *ds, int port,
				  struct switchdev_obj_port_vlan *vlan,
				  switchdev_obj_dump_cb_t *cb);

	/*
	 * Forwarding database
	 */
	int	(*port_fdb_prepare)(struct dsa_switch *ds, int port,
				    const struct switchdev_obj_port_fdb *fdb,
				    struct switchdev_trans *trans);
	void	(*port_fdb_add)(struct dsa_switch *ds, int port,
				const struct switchdev_obj_port_fdb *fdb,
				struct switchdev_trans *trans);
	int	(*port_fdb_del)(struct dsa_switch *ds, int port,
				const struct switchdev_obj_port_fdb *fdb);
	int	(*port_fdb_dump)(struct dsa_switch *ds, int port,
				 struct switchdev_obj_port_fdb *fdb,
				  switchdev_obj_dump_cb_t *cb);

	/*
	 * Multicast database
	 */
	int	(*port_mdb_prepare)(struct dsa_switch *ds, int port,
				    const struct switchdev_obj_port_mdb *mdb,
				    struct switchdev_trans *trans);
	void	(*port_mdb_add)(struct dsa_switch *ds, int port,
				const struct switchdev_obj_port_mdb *mdb,
				struct switchdev_trans *trans);
	int	(*port_mdb_del)(struct dsa_switch *ds, int port,
				const struct switchdev_obj_port_mdb *mdb);
	int	(*port_mdb_dump)(struct dsa_switch *ds, int port,
				 struct switchdev_obj_port_mdb *mdb,
				  switchdev_obj_dump_cb_t *cb);

	/*
	 * RXNFC
	 */
	int	(*get_rxnfc)(struct dsa_switch *ds, int port,
			     struct ethtool_rxnfc *nfc, u32 *rule_locs);
	int	(*set_rxnfc)(struct dsa_switch *ds, int port,
			     struct ethtool_rxnfc *nfc);

	/*
	 * TC integration
	 */
	int	(*port_mirror_add)(struct dsa_switch *ds, int port,
				   struct dsa_mall_mirror_tc_entry *mirror,
				   bool ingress);
	void	(*port_mirror_del)(struct dsa_switch *ds, int port,
				   struct dsa_mall_mirror_tc_entry *mirror);

	/*
	 * Cross-chip operations
	 */
	int	(*crosschip_bridge_join)(struct dsa_switch *ds, int sw_index,
					 int port, struct net_device *br);
	void	(*crosschip_bridge_leave)(struct dsa_switch *ds, int sw_index,
					  int port, struct net_device *br);
};

struct dsa_switch_driver {
	struct list_head	list;
	const struct dsa_switch_ops *ops;
};

/* Legacy driver registration */
void register_switch_driver(struct dsa_switch_driver *type);
void unregister_switch_driver(struct dsa_switch_driver *type);
struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev);

struct net_device *dsa_dev_to_net_device(struct device *dev);

/* Keep inline for faster access in hot path */
static inline bool dsa_uses_tagged_protocol(struct dsa_switch_tree *dst)
{
	return dst->rcv != NULL;
}

static inline bool netdev_uses_dsa(struct net_device *dev)
{
#if IS_ENABLED(CONFIG_NET_DSA)
	if (dev->dsa_ptr != NULL)
		return dsa_uses_tagged_protocol(dev->dsa_ptr);
#endif
	return false;
}

struct dsa_switch *dsa_switch_alloc(struct device *dev, size_t n);
void dsa_unregister_switch(struct dsa_switch *ds);
int dsa_register_switch(struct dsa_switch *ds);
#ifdef CONFIG_PM_SLEEP
int dsa_switch_suspend(struct dsa_switch *ds);
int dsa_switch_resume(struct dsa_switch *ds);
#else
static inline int dsa_switch_suspend(struct dsa_switch *ds)
{
	return 0;
}
static inline int dsa_switch_resume(struct dsa_switch *ds)
{
	return 0;
}
#endif /* CONFIG_PM_SLEEP */

#endif
Commit	Line	Data
91da11f8 LB	1	/*
91da11f8 LB	2	* include/net/dsa.h - Driver for Distributed Switch Architecture switch chips
e84665c9	3	* Copyright (c) 2008-2009 Marvell Semiconductor
91da11f8 LB	4	*
	5	* This program is free software; you can redistribute it and/or modify
	6	* it under the terms of the GNU General Public License as published by
	7	* the Free Software Foundation; either version 2 of the License, or
	8	* (at your option) any later version.
	9	*/
	10
	11	#ifndef __LINUX_NET_DSA_H
	12	#define __LINUX_NET_DSA_H
	13
4d56a29f	14	#include <linux/if.h>
ea1f51be	15	#include <linux/if_ether.h>
c8f0b869	16	#include <linux/list.h>
f515f192	17	#include <linux/notifier.h>
cf50dcc2 BH	18	#include <linux/timer.h>
cf50dcc2 BH	19	#include <linux/workqueue.h>
fa981d9a	20	#include <linux/of.h>
a2820543	21	#include <linux/ethtool.h>
96567d5d	22	#include <net/devlink.h>
f0c24ccf	23	#include <net/switchdev.h>
cf50dcc2	24
f50f2127	25	struct tc_action;
4d56a29f RK	26	struct phy_device;
4d56a29f RK	27	struct fixed_phy_status;
f50f2127	28
ac7a04c3 FF	29	enum dsa_tag_protocol {
ac7a04c3 FF	30	DSA_TAG_PROTO_NONE = 0,
eb7b7211	31	DSA_TAG_PROTO_BRCM,
ac7a04c3	32	DSA_TAG_PROTO_DSA,
ac7a04c3	33	DSA_TAG_PROTO_EDSA,
8b8010fb	34	DSA_TAG_PROTO_KSZ,
e8fe177a	35	DSA_TAG_PROTO_LAN9303,
eb7b7211 AL	36	DSA_TAG_PROTO_MTK,
	37	DSA_TAG_PROTO_QCA,
	38	DSA_TAG_PROTO_TRAILER,
39a7f2a4	39	DSA_TAG_LAST, /* MUST BE LAST */
ac7a04c3	40	};
5037d532	41
e84665c9 LB	42	#define DSA_MAX_SWITCHES 4
	43	#define DSA_MAX_PORTS 12
	44
d390238c VD	45	#define DSA_RTABLE_NONE -1
d390238c VD	46
e84665c9 LB	47	struct dsa_chip_data {
	48	/*
	49	* How to access the switch configuration registers.
	50	*/
b4d2394d	51	struct device *host_dev;
e84665c9 LB	52	int sw_addr;
e84665c9 LB	53
71e0bbde FF	54	/*
	55	* Reference to network devices
	56	*/
	57	struct device *netdev[DSA_MAX_PORTS];
	58
6793abb4 GR	59	/* set to size of eeprom if supported by the switch */
	60	int eeprom_len;
	61
fa981d9a FF	62	/* Device tree node pointer for this specific switch chip
	63	* used during switch setup in case additional properties
	64	* and resources needs to be used
	65	*/
	66	struct device_node *of_node;
	67
e84665c9 LB	68	/*
	69	* The names of the switch's ports. Use "cpu" to
	70	* designate the switch port that the cpu is connected to,
	71	* "dsa" to indicate that this port is a DSA link to
	72	* another switch, NULL to indicate the port is unused,
	73	* or any other string to indicate this is a physical port.
	74	*/
	75	char *port_names[DSA_MAX_PORTS];
bd47497a	76	struct device_node *port_dn[DSA_MAX_PORTS];
e84665c9 LB	77
e84665c9 LB	78	/*
4a7704ff AL	79	* An array of which element [a] indicates which port on this
	80	* switch should be used to send packets to that are destined
	81	* for switch a. Can be NULL if there is only one switch chip.
e84665c9	82	*/
4a7704ff	83	s8 rtable[DSA_MAX_SWITCHES];
e84665c9	84	};
91da11f8 LB	85
	86	struct dsa_platform_data {
	87	/*
	88	* Reference to a Linux network interface that connects
e84665c9	89	* to the root switch chip of the tree.
91da11f8 LB	90	*/
91da11f8 LB	91	struct device *netdev;
769a0202	92	struct net_device *of_netdev;
91da11f8 LB	93
91da11f8 LB	94	/*
e84665c9 LB	95	* Info structs describing each of the switch chips
e84665c9 LB	96	* connected via this network interface.
91da11f8	97	*/
e84665c9 LB	98	int nr_chips;
e84665c9 LB	99	struct dsa_chip_data *chip;
91da11f8 LB	100	};
91da11f8 LB	101
5075314e	102	struct packet_type;
3e8a72d1	103
cf50dcc2	104	struct dsa_switch_tree {
83c0afae AL	105	struct list_head list;
83c0afae AL	106
f515f192 VD	107	/* Notifier chain for switch-wide events */
	108	struct raw_notifier_head nh;
	109
83c0afae AL	110	/* Tree identifier */
	111	u32 tree;
	112
	113	/* Number of switches attached to this tree */
	114	struct kref refcount;
	115
	116	/* Has this tree been applied to the hardware? */
	117	bool applied;
	118
cf50dcc2 BH	119	/*
	120	* Configuration data for the platform device that owns
	121	* this dsa switch tree instance.
	122	*/
	123	struct dsa_platform_data *pd;
	124
	125	/*
	126	* Reference to network device to use, and which tagging
	127	* protocol to use.
	128	*/
	129	struct net_device *master_netdev;
73a7ece8 VD	130
73a7ece8 VD	131	/* Copy of tag_ops->rcv for faster access in hot path */
a86d8bec	132	struct sk_buff * (rcv)(struct sk_buff skb,
5075314e AD	133	struct net_device *dev,
	134	struct packet_type *pt,
	135	struct net_device *orig_dev);
cf50dcc2	136
badf3ada FF	137	/*
	138	* Original copy of the master netdev ethtool_ops
	139	*/
	140	struct ethtool_ops master_ethtool_ops;
0c73c523	141	const struct ethtool_ops *master_orig_ethtool_ops;
badf3ada	142
cf50dcc2	143	/*
8b0d3ea5	144	* The switch port to which the CPU is attached.
cf50dcc2	145	*/
8b0d3ea5	146	struct dsa_port *cpu_dp;
cf50dcc2	147
cf50dcc2 BH	148	/*
	149	* Data for the individual switch chips.
	150	*/
	151	struct dsa_switch *ds[DSA_MAX_SWITCHES];
39a7f2a4 AL	152
	153	/*
	154	* Tagging protocol operations for adding and removing an
	155	* encapsulation tag.
	156	*/
	157	const struct dsa_device_ops *tag_ops;
cf50dcc2 BH	158	};
cf50dcc2 BH	159
f50f2127 FF	160	/* TC matchall action types, only mirroring for now */
	161	enum dsa_port_mall_action_type {
	162	DSA_PORT_MALL_MIRROR,
	163	};
	164
	165	/* TC mirroring entry */
	166	struct dsa_mall_mirror_tc_entry {
	167	u8 to_local_port;
	168	bool ingress;
	169	};
	170
	171	/* TC matchall entry */
	172	struct dsa_mall_tc_entry {
	173	struct list_head list;
	174	unsigned long cookie;
	175	enum dsa_port_mall_action_type type;
	176	union {
	177	struct dsa_mall_mirror_tc_entry mirror;
	178	};
	179	};
	180
	181
c8b09808	182	struct dsa_port {
818be848 VD	183	struct dsa_switch *ds;
818be848 VD	184	unsigned int index;
71e0bbde	185	const char *name;
c8b09808	186	struct net_device *netdev;
189b0d93	187	struct device_node *dn;
34a79f63	188	unsigned int ageing_time;
732f794c	189	u8 stp_state;
a5e9a02e	190	struct net_device *bridge_dev;
96567d5d	191	struct devlink_port devlink_port;
c8b09808 AL	192	};
c8b09808 AL	193
c8f0b869	194	struct dsa_switch {
c33063d6 AL	195	struct device *dev;
c33063d6 AL	196
c8f0b869 BH	197	/*
	198	* Parent switch tree, and switch index.
	199	*/
	200	struct dsa_switch_tree *dst;
	201	int index;
	202
f515f192 VD	203	/* Listener for switch fabric events */
	204	struct notifier_block nb;
	205
7543a6d5 AL	206	/*
	207	* Give the switch driver somewhere to hang its private data
	208	* structure.
	209	*/
	210	void *priv;
	211
c8f0b869 BH	212	/*
	213	* Configuration data for this switch.
	214	*/
ff04955c	215	struct dsa_chip_data *cd;
c8f0b869 BH	216
c8f0b869 BH	217	/*
9d490b4e	218	* The switch operations.
c8f0b869	219	*/
a82f67af	220	const struct dsa_switch_ops *ops;
c8f0b869	221
66472fc0 AL	222	/*
	223	* An array of which element [a] indicates which port on this
	224	* switch should be used to send packets to that are destined
	225	* for switch a. Can be NULL if there is only one switch chip.
	226	*/
	227	s8 rtable[DSA_MAX_SWITCHES];
	228
83c0afae AL	229	/*
	230	* The lower device this switch uses to talk to the host
	231	*/
	232	struct net_device *master_netdev;
	233
c8f0b869 BH	234	/*
	235	* Slave mii_bus and devices for the individual ports.
	236	*/
	237	u32 dsa_port_mask;
83c0afae	238	u32 cpu_port_mask;
74c3e2a5	239	u32 enabled_port_mask;
0d8bcdd3	240	u32 phys_mii_mask;
c8f0b869	241	struct mii_bus *slave_mii_bus;
a0c02161	242
0f3da6af VD	243	/* Ageing Time limits in msecs */
	244	unsigned int ageing_time_min;
	245	unsigned int ageing_time_max;
	246
96567d5d AL	247	/* devlink used to represent this switch device */
	248	struct devlink *devlink;
	249
a0c02161 VD	250	/* Dynamically allocated ports, keep last */
	251	size_t num_ports;
	252	struct dsa_port ports[];
c8f0b869 BH	253	};
	254
	255	static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
	256	{
8b0d3ea5	257	return ds->dst->cpu_dp == &ds->ports[p];
c8f0b869 BH	258	}
c8f0b869 BH	259
60045cbf AL	260	static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
	261	{
	262	return !!((ds->dsa_port_mask) & (1 << p));
	263	}
	264
6cd456f3 VD	265	static inline bool dsa_is_normal_port(struct dsa_switch *ds, int p)
	266	{
	267	return !dsa_is_cpu_port(ds, p) && !dsa_is_dsa_port(ds, p);
	268	}
	269
d79d2107 GR	270	static inline bool dsa_is_port_initialized(struct dsa_switch *ds, int p)
d79d2107 GR	271	{
c8b09808	272	return ds->enabled_port_mask & (1 << p) && ds->ports[p].netdev;
d79d2107 GR	273	}
d79d2107 GR	274
c8f0b869 BH	275	static inline u8 dsa_upstream_port(struct dsa_switch *ds)
	276	{
	277	struct dsa_switch_tree *dst = ds->dst;
	278
	279	/*
	280	* If this is the root switch (i.e. the switch that connects
	281	* to the CPU), return the cpu port number on this switch.
	282	* Else return the (DSA) port number that connects to the
	283	* switch that is one hop closer to the cpu.
	284	*/
8b0d3ea5 VD	285	if (dst->cpu_dp->ds == ds)
8b0d3ea5 VD	286	return dst->cpu_dp->index;
c8f0b869	287	else
8b0d3ea5	288	return ds->rtable[dst->cpu_dp->ds->index];
c8f0b869 BH	289	}
c8f0b869 BH	290
9d490b4e	291	struct dsa_switch_ops {
c8f0b869	292	/*
a6a71f19	293	* Legacy probing.
c8f0b869	294	*/
0209d144 VD	295	const char (probe)(struct device *dsa_dev,
	296	struct device *host_dev, int sw_addr,
	297	void **priv);
7b314362 AL	298
	299	enum dsa_tag_protocol (get_tag_protocol)(struct dsa_switch ds);
	300
c8f0b869 BH	301	int (setup)(struct dsa_switch ds);
c8f0b869 BH	302	int (set_addr)(struct dsa_switch ds, u8 *addr);
6819563e	303	u32 (get_phy_flags)(struct dsa_switch ds, int port);
c8f0b869 BH	304
	305	/*
	306	* Access to the switch's PHY registers.
	307	*/
	308	int (phy_read)(struct dsa_switch ds, int port, int regnum);
	309	int (phy_write)(struct dsa_switch ds, int port,
	310	int regnum, u16 val);
	311
ec9436ba FF	312	/*
	313	* Link state adjustment (called from libphy)
	314	*/
	315	void (adjust_link)(struct dsa_switch ds, int port,
	316	struct phy_device *phydev);
ce31b31c FF	317	void (fixed_link_update)(struct dsa_switch ds, int port,
ce31b31c FF	318	struct fixed_phy_status *st);
ec9436ba	319
c8f0b869 BH	320	/*
	321	* ethtool hardware statistics.
	322	*/
	323	void (get_strings)(struct dsa_switch ds, int port, uint8_t *data);
	324	void (get_ethtool_stats)(struct dsa_switch ds,
	325	int port, uint64_t *data);
	326	int (get_sset_count)(struct dsa_switch ds);
24462549	327
19e57c4e FF	328	/*
	329	* ethtool Wake-on-LAN
	330	*/
	331	void (get_wol)(struct dsa_switch ds, int port,
	332	struct ethtool_wolinfo *w);
	333	int (set_wol)(struct dsa_switch ds, int port,
	334	struct ethtool_wolinfo *w);
	335
24462549 FF	336	/*
	337	* Suspend and resume
	338	*/
	339	int (suspend)(struct dsa_switch ds);
	340	int (resume)(struct dsa_switch ds);
b2f2af21 FF	341
	342	/*
	343	* Port enable/disable
	344	*/
	345	int (port_enable)(struct dsa_switch ds, int port,
	346	struct phy_device *phy);
	347	void (port_disable)(struct dsa_switch ds, int port,
	348	struct phy_device *phy);
7905288f FF	349
	350	/*
	351	* EEE setttings
	352	*/
	353	int (set_eee)(struct dsa_switch ds, int port,
	354	struct phy_device *phydev,
	355	struct ethtool_eee *e);
	356	int (get_eee)(struct dsa_switch ds, int port,
	357	struct ethtool_eee *e);
51579c3f	358
6793abb4 GR	359	/* EEPROM access */
	360	int (get_eeprom_len)(struct dsa_switch ds);
	361	int (get_eeprom)(struct dsa_switch ds,
	362	struct ethtool_eeprom eeprom, u8 data);
	363	int (set_eeprom)(struct dsa_switch ds,
	364	struct ethtool_eeprom eeprom, u8 data);
3d762a0f GR	365
	366	/*
	367	* Register access.
	368	*/
	369	int (get_regs_len)(struct dsa_switch ds, int port);
	370	void (get_regs)(struct dsa_switch ds, int port,
	371	struct ethtool_regs regs, void p);
b73adef6 FF	372
	373	/*
	374	* Bridge integration
	375	*/
34a79f63	376	int (set_ageing_time)(struct dsa_switch ds, unsigned int msecs);
71327a4e	377	int (port_bridge_join)(struct dsa_switch ds, int port,
a6692754	378	struct net_device *bridge);
f123f2fb VD	379	void (port_bridge_leave)(struct dsa_switch ds, int port,
f123f2fb VD	380	struct net_device *bridge);
43c44a9f VD	381	void (port_stp_state_set)(struct dsa_switch ds, int port,
43c44a9f VD	382	u8 state);
732f794c	383	void (port_fast_age)(struct dsa_switch ds, int port);
2a778e1b	384
11149536 VD	385	/*
	386	* VLAN support
	387	*/
fb2dabad VD	388	int (port_vlan_filtering)(struct dsa_switch ds, int port,
fb2dabad VD	389	bool vlan_filtering);
76e398a6 VD	390	int (port_vlan_prepare)(struct dsa_switch ds, int port,
	391	const struct switchdev_obj_port_vlan *vlan,
	392	struct switchdev_trans *trans);
4d5770b3	393	void (port_vlan_add)(struct dsa_switch ds, int port,
76e398a6 VD	394	const struct switchdev_obj_port_vlan *vlan,
	395	struct switchdev_trans *trans);
	396	int (port_vlan_del)(struct dsa_switch ds, int port,
	397	const struct switchdev_obj_port_vlan *vlan);
65aebfc0 VD	398	int (port_vlan_dump)(struct dsa_switch ds, int port,
65aebfc0 VD	399	struct switchdev_obj_port_vlan *vlan,
438ff537	400	switchdev_obj_dump_cb_t *cb);
11149536	401
2a778e1b VD	402	/*
	403	* Forwarding database
	404	*/
146a3206 VD	405	int (port_fdb_prepare)(struct dsa_switch ds, int port,
	406	const struct switchdev_obj_port_fdb *fdb,
	407	struct switchdev_trans *trans);
8497aa61	408	void (port_fdb_add)(struct dsa_switch ds, int port,
1f36faf2 VD	409	const struct switchdev_obj_port_fdb *fdb,
1f36faf2 VD	410	struct switchdev_trans *trans);
2a778e1b	411	int (port_fdb_del)(struct dsa_switch ds, int port,
8057b3e7	412	const struct switchdev_obj_port_fdb *fdb);
ea70ba98 VD	413	int (port_fdb_dump)(struct dsa_switch ds, int port,
ea70ba98 VD	414	struct switchdev_obj_port_fdb *fdb,
438ff537	415	switchdev_obj_dump_cb_t *cb);
8df30255 VD	416
	417	/*
	418	* Multicast database
	419	*/
	420	int (port_mdb_prepare)(struct dsa_switch ds, int port,
	421	const struct switchdev_obj_port_mdb *mdb,
	422	struct switchdev_trans *trans);
	423	void (port_mdb_add)(struct dsa_switch ds, int port,
	424	const struct switchdev_obj_port_mdb *mdb,
	425	struct switchdev_trans *trans);
	426	int (port_mdb_del)(struct dsa_switch ds, int port,
	427	const struct switchdev_obj_port_mdb *mdb);
	428	int (port_mdb_dump)(struct dsa_switch ds, int port,
	429	struct switchdev_obj_port_mdb *mdb,
438ff537	430	switchdev_obj_dump_cb_t *cb);
bf9f2648 FF	431
	432	/*
	433	* RXNFC
	434	*/
	435	int (get_rxnfc)(struct dsa_switch ds, int port,
	436	struct ethtool_rxnfc nfc, u32 rule_locs);
	437	int (set_rxnfc)(struct dsa_switch ds, int port,
	438	struct ethtool_rxnfc *nfc);
f50f2127 FF	439
	440	/*
	441	* TC integration
	442	*/
	443	int (port_mirror_add)(struct dsa_switch ds, int port,
	444	struct dsa_mall_mirror_tc_entry *mirror,
	445	bool ingress);
	446	void (port_mirror_del)(struct dsa_switch ds, int port,
	447	struct dsa_mall_mirror_tc_entry *mirror);
40ef2c93 VD	448
	449	/*
	450	* Cross-chip operations
	451	*/
	452	int (crosschip_bridge_join)(struct dsa_switch ds, int sw_index,
	453	int port, struct net_device *br);
	454	void (crosschip_bridge_leave)(struct dsa_switch ds, int sw_index,
	455	int port, struct net_device *br);
c8f0b869 BH	456	};
c8f0b869 BH	457
ab3d408d FF	458	struct dsa_switch_driver {
ab3d408d FF	459	struct list_head list;
a82f67af	460	const struct dsa_switch_ops *ops;
ab3d408d FF	461	};
ab3d408d FF	462
a6a71f19	463	/* Legacy driver registration */
ab3d408d FF	464	void register_switch_driver(struct dsa_switch_driver *type);
ab3d408d FF	465	void unregister_switch_driver(struct dsa_switch_driver *type);
b4d2394d	466	struct mii_bus dsa_host_dev_to_mii_bus(struct device dev);
a6a71f19	467
14b89f36	468	struct net_device dsa_dev_to_net_device(struct device dev);
c8f0b869	469
73a7ece8	470	/* Keep inline for faster access in hot path */
5aed85ce FF	471	static inline bool dsa_uses_tagged_protocol(struct dsa_switch_tree *dst)
5aed85ce FF	472	{
5075314e	473	return dst->rcv != NULL;
5aed85ce	474	}
83c0afae	475
c6e970a0 AL	476	static inline bool netdev_uses_dsa(struct net_device *dev)
	477	{
	478	#if IS_ENABLED(CONFIG_NET_DSA)
	479	if (dev->dsa_ptr != NULL)
	480	return dsa_uses_tagged_protocol(dev->dsa_ptr);
	481	#endif
	482	return false;
	483	}
	484
a0c02161	485	struct dsa_switch dsa_switch_alloc(struct device dev, size_t n);
83c0afae	486	void dsa_unregister_switch(struct dsa_switch *ds);
23c9ee49	487	int dsa_register_switch(struct dsa_switch *ds);
ea825e70 FF	488	#ifdef CONFIG_PM_SLEEP
	489	int dsa_switch_suspend(struct dsa_switch *ds);
	490	int dsa_switch_resume(struct dsa_switch *ds);
	491	#else
	492	static inline int dsa_switch_suspend(struct dsa_switch *ds)
	493	{
	494	return 0;
	495	}
	496	static inline int dsa_switch_resume(struct dsa_switch *ds)
	497	{
	498	return 0;
	499	}
	500	#endif /* CONFIG_PM_SLEEP */
	501
91da11f8	502	#endif