[mirror_ubuntu-bionic-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_device_ops {
	struct sk_buff *(*xmit)(struct sk_buff *skb, struct net_device *dev);
	struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev,
			       struct packet_type *pt);
	int (*flow_dissect)(const struct sk_buff *skb, __be16 *proto,
			    int *offset);
};

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;

	/*
	 * 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];
};

/* 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 {
	/* A CPU port is physically connected to a master device.
	 * A user port exposed to userspace has a slave device.
	 */
	union {
		struct net_device *master;
		struct net_device *slave;
	};

	/* CPU port tagging operations used by master or slave devices */
	const struct dsa_device_ops *tag_ops;

	/* Copies for faster access in master receive hot path */
	struct dsa_switch_tree *dst;
	struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev,
			       struct packet_type *pt);

	struct dsa_switch	*ds;
	unsigned int		index;
	const char		*name;
	struct dsa_port		*cpu_dp;
	struct device_node	*dn;
	unsigned int		ageing_time;
	u8			stp_state;
	struct net_device	*bridge_dev;
	struct devlink_port	devlink_port;
	/*
	 * Original copy of the master netdev ethtool_ops
	 */
	const struct ethtool_ops *orig_ethtool_ops;
};

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];

	/*
	 * 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;

	/* Number of switch port queues */
	unsigned int		num_tx_queues;

	/* 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->cpu_port_mask & (1 << 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 const struct dsa_port *dsa_to_port(struct dsa_switch *ds, int p)
{
	return &ds->ports[p];
}

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];
}

typedef int dsa_fdb_dump_cb_t(const unsigned char *addr, u16 vid,
			      bool is_static, void *data);
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);
	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);

	/*
	 * Port's MAC EEE settings
	 */
	int	(*set_mac_eee)(struct dsa_switch *ds, int port,
			       struct ethtool_eee *e);
	int	(*get_mac_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);
	/*
	 * Forwarding database
	 */
	int	(*port_fdb_add)(struct dsa_switch *ds, int port,
				const unsigned char *addr, u16 vid);
	int	(*port_fdb_del)(struct dsa_switch *ds, int port,
				const unsigned char *addr, u16 vid);
	int	(*port_fdb_dump)(struct dsa_switch *ds, int port,
				 dsa_fdb_dump_cb_t *cb, void *data);

	/*
	 * 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);
	/*
	 * 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 netdev_uses_dsa(struct net_device *dev)
{
#if IS_ENABLED(CONFIG_NET_DSA)
	return dev->dsa_ptr && dev->dsa_ptr->rcv;
#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 */

enum dsa_notifier_type {
	DSA_PORT_REGISTER,
	DSA_PORT_UNREGISTER,
};

struct dsa_notifier_info {
	struct net_device *dev;
};

struct dsa_notifier_register_info {
	struct dsa_notifier_info info;	/* must be first */
	struct net_device *master;
	unsigned int port_number;
	unsigned int switch_number;
};

static inline struct net_device *
dsa_notifier_info_to_dev(const struct dsa_notifier_info *info)
{
	return info->dev;
}

#if IS_ENABLED(CONFIG_NET_DSA)
int register_dsa_notifier(struct notifier_block *nb);
int unregister_dsa_notifier(struct notifier_block *nb);
int call_dsa_notifiers(unsigned long val, struct net_device *dev,
		       struct dsa_notifier_info *info);
#else
static inline int register_dsa_notifier(struct notifier_block *nb)
{
	return 0;
}

static inline int unregister_dsa_notifier(struct notifier_block *nb)
{
	return 0;
}

static inline int call_dsa_notifiers(unsigned long val, struct net_device *dev,
				     struct dsa_notifier_info *info)
{
	return NOTIFY_DONE;
}
#endif

/* Broadcom tag specific helpers to insert and extract queue/port number */
#define BRCM_TAG_SET_PORT_QUEUE(p, q)	((p) << 8 | q)
#define BRCM_TAG_GET_PORT(v)		((v) >> 8)
#define BRCM_TAG_GET_QUEUE(v)		((v) & 0xff)

#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
68277a2c JC	104	struct dsa_device_ops {
	105	struct sk_buff (xmit)(struct sk_buff skb, struct net_device dev);
	106	struct sk_buff (rcv)(struct sk_buff skb, struct net_device dev,
89e49506	107	struct packet_type *pt);
598a9680 JC	108	int (flow_dissect)(const struct sk_buff skb, __be16 *proto,
598a9680 JC	109	int *offset);
68277a2c JC	110	};
68277a2c JC	111
cf50dcc2	112	struct dsa_switch_tree {
83c0afae AL	113	struct list_head list;
83c0afae AL	114
f515f192 VD	115	/* Notifier chain for switch-wide events */
	116	struct raw_notifier_head nh;
	117
83c0afae AL	118	/* Tree identifier */
	119	u32 tree;
	120
	121	/* Number of switches attached to this tree */
	122	struct kref refcount;
	123
	124	/* Has this tree been applied to the hardware? */
	125	bool applied;
	126
cf50dcc2 BH	127	/*
	128	* Configuration data for the platform device that owns
	129	* this dsa switch tree instance.
	130	*/
	131	struct dsa_platform_data *pd;
	132
cf50dcc2	133	/*
8b0d3ea5	134	* The switch port to which the CPU is attached.
cf50dcc2	135	*/
8b0d3ea5	136	struct dsa_port *cpu_dp;
cf50dcc2	137
cf50dcc2 BH	138	/*
	139	* Data for the individual switch chips.
	140	*/
	141	struct dsa_switch *ds[DSA_MAX_SWITCHES];
	142	};
	143
f50f2127 FF	144	/* TC matchall action types, only mirroring for now */
	145	enum dsa_port_mall_action_type {
	146	DSA_PORT_MALL_MIRROR,
	147	};
	148
	149	/* TC mirroring entry */
	150	struct dsa_mall_mirror_tc_entry {
	151	u8 to_local_port;
	152	bool ingress;
	153	};
	154
	155	/* TC matchall entry */
	156	struct dsa_mall_tc_entry {
	157	struct list_head list;
	158	unsigned long cookie;
	159	enum dsa_port_mall_action_type type;
	160	union {
	161	struct dsa_mall_mirror_tc_entry mirror;
	162	};
	163	};
	164
	165
c8b09808	166	struct dsa_port {
f8b8b1cd VD	167	/* A CPU port is physically connected to a master device.
	168	* A user port exposed to userspace has a slave device.
	169	*/
	170	union {
	171	struct net_device *master;
	172	struct net_device *slave;
	173	};
	174
15240248 VD	175	/* CPU port tagging operations used by master or slave devices */
	176	const struct dsa_device_ops *tag_ops;
	177
3e41f93b VD	178	/* Copies for faster access in master receive hot path */
	179	struct dsa_switch_tree *dst;
	180	struct sk_buff (rcv)(struct sk_buff skb, struct net_device dev,
	181	struct packet_type *pt);
	182
818be848 VD	183	struct dsa_switch *ds;
818be848 VD	184	unsigned int index;
71e0bbde	185	const char *name;
a29342e7	186	struct dsa_port *cpu_dp;
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;
67dbb9d4 FF	192	/*
	193	* Original copy of the master netdev ethtool_ops
	194	*/
67dbb9d4	195	const struct ethtool_ops *orig_ethtool_ops;
c8b09808 AL	196	};
c8b09808 AL	197
c8f0b869	198	struct dsa_switch {
c33063d6 AL	199	struct device *dev;
c33063d6 AL	200
c8f0b869 BH	201	/*
	202	* Parent switch tree, and switch index.
	203	*/
	204	struct dsa_switch_tree *dst;
	205	int index;
	206
f515f192 VD	207	/* Listener for switch fabric events */
	208	struct notifier_block nb;
	209
7543a6d5 AL	210	/*
	211	* Give the switch driver somewhere to hang its private data
	212	* structure.
	213	*/
	214	void *priv;
	215
c8f0b869 BH	216	/*
	217	* Configuration data for this switch.
	218	*/
ff04955c	219	struct dsa_chip_data *cd;
c8f0b869 BH	220
c8f0b869 BH	221	/*
9d490b4e	222	* The switch operations.
c8f0b869	223	*/
a82f67af	224	const struct dsa_switch_ops *ops;
c8f0b869	225
66472fc0 AL	226	/*
	227	* An array of which element [a] indicates which port on this
	228	* switch should be used to send packets to that are destined
	229	* for switch a. Can be NULL if there is only one switch chip.
	230	*/
	231	s8 rtable[DSA_MAX_SWITCHES];
	232
c8f0b869 BH	233	/*
	234	* Slave mii_bus and devices for the individual ports.
	235	*/
	236	u32 dsa_port_mask;
83c0afae	237	u32 cpu_port_mask;
74c3e2a5	238	u32 enabled_port_mask;
0d8bcdd3	239	u32 phys_mii_mask;
c8f0b869	240	struct mii_bus *slave_mii_bus;
a0c02161	241
0f3da6af VD	242	/* Ageing Time limits in msecs */
	243	unsigned int ageing_time_min;
	244	unsigned int ageing_time_max;
	245
96567d5d AL	246	/* devlink used to represent this switch device */
	247	struct devlink *devlink;
	248
55199df6 FF	249	/* Number of switch port queues */
	250	unsigned int num_tx_queues;
	251
a0c02161 VD	252	/* Dynamically allocated ports, keep last */
	253	size_t num_ports;
	254	struct dsa_port ports[];
c8f0b869 BH	255	};
	256
	257	static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
	258	{
14be36c2	259	return !!(ds->cpu_port_mask & (1 << p));
c8f0b869 BH	260	}
c8f0b869 BH	261
60045cbf AL	262	static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
	263	{
	264	return !!((ds->dsa_port_mask) & (1 << p));
	265	}
	266
6cd456f3 VD	267	static inline bool dsa_is_normal_port(struct dsa_switch *ds, int p)
	268	{
	269	return !dsa_is_cpu_port(ds, p) && !dsa_is_dsa_port(ds, p);
	270	}
	271
c8652c83 VD	272	static inline const struct dsa_port dsa_to_port(struct dsa_switch ds, int p)
	273	{
	274	return &ds->ports[p];
	275	}
	276
c8f0b869 BH	277	static inline u8 dsa_upstream_port(struct dsa_switch *ds)
	278	{
	279	struct dsa_switch_tree *dst = ds->dst;
	280
	281	/*
	282	* If this is the root switch (i.e. the switch that connects
	283	* to the CPU), return the cpu port number on this switch.
	284	* Else return the (DSA) port number that connects to the
	285	* switch that is one hop closer to the cpu.
	286	*/
8b0d3ea5 VD	287	if (dst->cpu_dp->ds == ds)
8b0d3ea5 VD	288	return dst->cpu_dp->index;
c8f0b869	289	else
8b0d3ea5	290	return ds->rtable[dst->cpu_dp->ds->index];
c8f0b869 BH	291	}
c8f0b869 BH	292
2bedde1a AS	293	typedef int dsa_fdb_dump_cb_t(const unsigned char *addr, u16 vid,
2bedde1a AS	294	bool is_static, void *data);
9d490b4e	295	struct dsa_switch_ops {
c8f0b869	296	/*
a6a71f19	297	* Legacy probing.
c8f0b869	298	*/
0209d144 VD	299	const char (probe)(struct device *dsa_dev,
	300	struct device *host_dev, int sw_addr,
	301	void **priv);
7b314362 AL	302
	303	enum dsa_tag_protocol (get_tag_protocol)(struct dsa_switch ds);
	304
c8f0b869	305	int (setup)(struct dsa_switch ds);
6819563e	306	u32 (get_phy_flags)(struct dsa_switch ds, int port);
c8f0b869 BH	307
	308	/*
	309	* Access to the switch's PHY registers.
	310	*/
	311	int (phy_read)(struct dsa_switch ds, int port, int regnum);
	312	int (phy_write)(struct dsa_switch ds, int port,
	313	int regnum, u16 val);
	314
ec9436ba FF	315	/*
	316	* Link state adjustment (called from libphy)
	317	*/
	318	void (adjust_link)(struct dsa_switch ds, int port,
	319	struct phy_device *phydev);
ce31b31c FF	320	void (fixed_link_update)(struct dsa_switch ds, int port,
ce31b31c FF	321	struct fixed_phy_status *st);
ec9436ba	322
c8f0b869 BH	323	/*
	324	* ethtool hardware statistics.
	325	*/
	326	void (get_strings)(struct dsa_switch ds, int port, uint8_t *data);
	327	void (get_ethtool_stats)(struct dsa_switch ds,
	328	int port, uint64_t *data);
	329	int (get_sset_count)(struct dsa_switch ds);
24462549	330
19e57c4e FF	331	/*
	332	* ethtool Wake-on-LAN
	333	*/
	334	void (get_wol)(struct dsa_switch ds, int port,
	335	struct ethtool_wolinfo *w);
	336	int (set_wol)(struct dsa_switch ds, int port,
	337	struct ethtool_wolinfo *w);
	338
24462549 FF	339	/*
	340	* Suspend and resume
	341	*/
	342	int (suspend)(struct dsa_switch ds);
	343	int (resume)(struct dsa_switch ds);
b2f2af21 FF	344
	345	/*
	346	* Port enable/disable
	347	*/
	348	int (port_enable)(struct dsa_switch ds, int port,
	349	struct phy_device *phy);
	350	void (port_disable)(struct dsa_switch ds, int port,
	351	struct phy_device *phy);
7905288f FF	352
7905288f FF	353	/*
08f50061	354	* Port's MAC EEE settings
7905288f	355	*/
08f50061 VD	356	int (set_mac_eee)(struct dsa_switch ds, int port,
	357	struct ethtool_eee *e);
	358	int (get_mac_eee)(struct dsa_switch ds, int port,
	359	struct ethtool_eee *e);
51579c3f	360
6793abb4 GR	361	/* EEPROM access */
	362	int (get_eeprom_len)(struct dsa_switch ds);
	363	int (get_eeprom)(struct dsa_switch ds,
	364	struct ethtool_eeprom eeprom, u8 data);
	365	int (set_eeprom)(struct dsa_switch ds,
	366	struct ethtool_eeprom eeprom, u8 data);
3d762a0f GR	367
	368	/*
	369	* Register access.
	370	*/
	371	int (get_regs_len)(struct dsa_switch ds, int port);
	372	void (get_regs)(struct dsa_switch ds, int port,
	373	struct ethtool_regs regs, void p);
b73adef6 FF	374
	375	/*
	376	* Bridge integration
	377	*/
34a79f63	378	int (set_ageing_time)(struct dsa_switch ds, unsigned int msecs);
71327a4e	379	int (port_bridge_join)(struct dsa_switch ds, int port,
a6692754	380	struct net_device *bridge);
f123f2fb VD	381	void (port_bridge_leave)(struct dsa_switch ds, int port,
f123f2fb VD	382	struct net_device *bridge);
43c44a9f VD	383	void (port_stp_state_set)(struct dsa_switch ds, int port,
43c44a9f VD	384	u8 state);
732f794c	385	void (port_fast_age)(struct dsa_switch ds, int port);
2a778e1b	386
11149536 VD	387	/*
	388	* VLAN support
	389	*/
fb2dabad VD	390	int (port_vlan_filtering)(struct dsa_switch ds, int port,
fb2dabad VD	391	bool vlan_filtering);
76e398a6 VD	392	int (port_vlan_prepare)(struct dsa_switch ds, int port,
	393	const struct switchdev_obj_port_vlan *vlan,
	394	struct switchdev_trans *trans);
4d5770b3	395	void (port_vlan_add)(struct dsa_switch ds, int port,
76e398a6 VD	396	const struct switchdev_obj_port_vlan *vlan,
	397	struct switchdev_trans *trans);
	398	int (port_vlan_del)(struct dsa_switch ds, int port,
	399	const struct switchdev_obj_port_vlan *vlan);
2a778e1b VD	400	/*
	401	* Forwarding database
	402	*/
1b6dd556	403	int (port_fdb_add)(struct dsa_switch ds, int port,
6c2c1dcb	404	const unsigned char *addr, u16 vid);
2a778e1b	405	int (port_fdb_del)(struct dsa_switch ds, int port,
6c2c1dcb	406	const unsigned char *addr, u16 vid);
ea70ba98	407	int (port_fdb_dump)(struct dsa_switch ds, int port,
2bedde1a	408	dsa_fdb_dump_cb_t cb, void data);
8df30255 VD	409
	410	/*
	411	* Multicast database
	412	*/
	413	int (port_mdb_prepare)(struct dsa_switch ds, int port,
	414	const struct switchdev_obj_port_mdb *mdb,
	415	struct switchdev_trans *trans);
	416	void (port_mdb_add)(struct dsa_switch ds, int port,
	417	const struct switchdev_obj_port_mdb *mdb,
	418	struct switchdev_trans *trans);
	419	int (port_mdb_del)(struct dsa_switch ds, int port,
	420	const struct switchdev_obj_port_mdb *mdb);
bf9f2648 FF	421	/*
	422	* RXNFC
	423	*/
	424	int (get_rxnfc)(struct dsa_switch ds, int port,
	425	struct ethtool_rxnfc nfc, u32 rule_locs);
	426	int (set_rxnfc)(struct dsa_switch ds, int port,
	427	struct ethtool_rxnfc *nfc);
f50f2127 FF	428
	429	/*
	430	* TC integration
	431	*/
	432	int (port_mirror_add)(struct dsa_switch ds, int port,
	433	struct dsa_mall_mirror_tc_entry *mirror,
	434	bool ingress);
	435	void (port_mirror_del)(struct dsa_switch ds, int port,
	436	struct dsa_mall_mirror_tc_entry *mirror);
40ef2c93 VD	437
	438	/*
	439	* Cross-chip operations
	440	*/
	441	int (crosschip_bridge_join)(struct dsa_switch ds, int sw_index,
	442	int port, struct net_device *br);
	443	void (crosschip_bridge_leave)(struct dsa_switch ds, int sw_index,
	444	int port, struct net_device *br);
c8f0b869 BH	445	};
c8f0b869 BH	446
ab3d408d FF	447	struct dsa_switch_driver {
ab3d408d FF	448	struct list_head list;
a82f67af	449	const struct dsa_switch_ops *ops;
ab3d408d FF	450	};
ab3d408d FF	451
a6a71f19	452	/* Legacy driver registration */
ab3d408d FF	453	void register_switch_driver(struct dsa_switch_driver *type);
ab3d408d FF	454	void unregister_switch_driver(struct dsa_switch_driver *type);
b4d2394d	455	struct mii_bus dsa_host_dev_to_mii_bus(struct device dev);
a6a71f19	456
14b89f36	457	struct net_device dsa_dev_to_net_device(struct device dev);
c8f0b869	458
73a7ece8	459	/* Keep inline for faster access in hot path */
c6e970a0 AL	460	static inline bool netdev_uses_dsa(struct net_device *dev)
	461	{
	462	#if IS_ENABLED(CONFIG_NET_DSA)
717ffbfb	463	return dev->dsa_ptr && dev->dsa_ptr->rcv;
c6e970a0 AL	464	#endif
	465	return false;
	466	}
	467
a0c02161	468	struct dsa_switch dsa_switch_alloc(struct device dev, size_t n);
83c0afae	469	void dsa_unregister_switch(struct dsa_switch *ds);
23c9ee49	470	int dsa_register_switch(struct dsa_switch *ds);
ea825e70 FF	471	#ifdef CONFIG_PM_SLEEP
	472	int dsa_switch_suspend(struct dsa_switch *ds);
	473	int dsa_switch_resume(struct dsa_switch *ds);
	474	#else
	475	static inline int dsa_switch_suspend(struct dsa_switch *ds)
	476	{
	477	return 0;
	478	}
	479	static inline int dsa_switch_resume(struct dsa_switch *ds)
	480	{
	481	return 0;
	482	}
	483	#endif /* CONFIG_PM_SLEEP */
	484
60724d4b FF	485	enum dsa_notifier_type {
	486	DSA_PORT_REGISTER,
	487	DSA_PORT_UNREGISTER,
	488	};
	489
	490	struct dsa_notifier_info {
	491	struct net_device *dev;
	492	};
	493
	494	struct dsa_notifier_register_info {
	495	struct dsa_notifier_info info; /* must be first */
	496	struct net_device *master;
	497	unsigned int port_number;
	498	unsigned int switch_number;
	499	};
	500
	501	static inline struct net_device *
	502	dsa_notifier_info_to_dev(const struct dsa_notifier_info *info)
	503	{
	504	return info->dev;
	505	}
	506
	507	#if IS_ENABLED(CONFIG_NET_DSA)
	508	int register_dsa_notifier(struct notifier_block *nb);
	509	int unregister_dsa_notifier(struct notifier_block *nb);
	510	int call_dsa_notifiers(unsigned long val, struct net_device *dev,
	511	struct dsa_notifier_info *info);
	512	#else
	513	static inline int register_dsa_notifier(struct notifier_block *nb)
	514	{
	515	return 0;
	516	}
	517
	518	static inline int unregister_dsa_notifier(struct notifier_block *nb)
	519	{
	520	return 0;
	521	}
	522
	523	static inline int call_dsa_notifiers(unsigned long val, struct net_device *dev,
	524	struct dsa_notifier_info *info)
	525	{
	526	return NOTIFY_DONE;
	527	}
	528	#endif
	529
0a5f14ce FF	530	/* Broadcom tag specific helpers to insert and extract queue/port number */
	531	#define BRCM_TAG_SET_PORT_QUEUE(p, q) ((p) << 8 \| q)
	532	#define BRCM_TAG_GET_PORT(v) ((v) >> 8)
	533	#define BRCM_TAG_GET_QUEUE(v) ((v) & 0xff)
	534
91da11f8	535	#endif