[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_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;

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

	/*
	 * 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 dsa_port		*cpu_dp;
	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;
	/*
	 * Original copy of the master netdev ethtool_ops
	 */
	struct ethtool_ops	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;

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

	/*
	 * 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);
	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 unsigned char *addr, u16 vid);
	void	(*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,
				 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 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 */

#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
73a7ece8	125	/* Copy of tag_ops->rcv for faster access in hot path */
a86d8bec	126	struct sk_buff * (rcv)(struct sk_buff skb,
5075314e AD	127	struct net_device *dev,
	128	struct packet_type *pt,
	129	struct net_device *orig_dev);
cf50dcc2 BH	130
cf50dcc2 BH	131	/*
8b0d3ea5	132	* The switch port to which the CPU is attached.
cf50dcc2	133	*/
8b0d3ea5	134	struct dsa_port *cpu_dp;
cf50dcc2	135
cf50dcc2 BH	136	/*
	137	* Data for the individual switch chips.
	138	*/
	139	struct dsa_switch *ds[DSA_MAX_SWITCHES];
39a7f2a4 AL	140
	141	/*
	142	* Tagging protocol operations for adding and removing an
	143	* encapsulation tag.
	144	*/
	145	const struct dsa_device_ops *tag_ops;
cf50dcc2 BH	146	};
cf50dcc2 BH	147
f50f2127 FF	148	/* TC matchall action types, only mirroring for now */
	149	enum dsa_port_mall_action_type {
	150	DSA_PORT_MALL_MIRROR,
	151	};
	152
	153	/* TC mirroring entry */
	154	struct dsa_mall_mirror_tc_entry {
	155	u8 to_local_port;
	156	bool ingress;
	157	};
	158
	159	/* TC matchall entry */
	160	struct dsa_mall_tc_entry {
	161	struct list_head list;
	162	unsigned long cookie;
	163	enum dsa_port_mall_action_type type;
	164	union {
	165	struct dsa_mall_mirror_tc_entry mirror;
	166	};
	167	};
	168
	169
c8b09808	170	struct dsa_port {
818be848 VD	171	struct dsa_switch *ds;
818be848 VD	172	unsigned int index;
71e0bbde	173	const char *name;
a29342e7	174	struct dsa_port *cpu_dp;
c8b09808	175	struct net_device *netdev;
189b0d93	176	struct device_node *dn;
34a79f63	177	unsigned int ageing_time;
732f794c	178	u8 stp_state;
a5e9a02e	179	struct net_device *bridge_dev;
96567d5d	180	struct devlink_port devlink_port;
67dbb9d4 FF	181	/*
	182	* Original copy of the master netdev ethtool_ops
	183	*/
	184	struct ethtool_ops ethtool_ops;
	185	const struct ethtool_ops *orig_ethtool_ops;
c8b09808 AL	186	};
c8b09808 AL	187
c8f0b869	188	struct dsa_switch {
c33063d6 AL	189	struct device *dev;
c33063d6 AL	190
c8f0b869 BH	191	/*
	192	* Parent switch tree, and switch index.
	193	*/
	194	struct dsa_switch_tree *dst;
	195	int index;
	196
f515f192 VD	197	/* Listener for switch fabric events */
	198	struct notifier_block nb;
	199
7543a6d5 AL	200	/*
	201	* Give the switch driver somewhere to hang its private data
	202	* structure.
	203	*/
	204	void *priv;
	205
c8f0b869 BH	206	/*
	207	* Configuration data for this switch.
	208	*/
ff04955c	209	struct dsa_chip_data *cd;
c8f0b869 BH	210
c8f0b869 BH	211	/*
9d490b4e	212	* The switch operations.
c8f0b869	213	*/
a82f67af	214	const struct dsa_switch_ops *ops;
c8f0b869	215
66472fc0 AL	216	/*
	217	* An array of which element [a] indicates which port on this
	218	* switch should be used to send packets to that are destined
	219	* for switch a. Can be NULL if there is only one switch chip.
	220	*/
	221	s8 rtable[DSA_MAX_SWITCHES];
	222
c8f0b869 BH	223	/*
	224	* Slave mii_bus and devices for the individual ports.
	225	*/
	226	u32 dsa_port_mask;
83c0afae	227	u32 cpu_port_mask;
74c3e2a5	228	u32 enabled_port_mask;
0d8bcdd3	229	u32 phys_mii_mask;
c8f0b869	230	struct mii_bus *slave_mii_bus;
a0c02161	231
0f3da6af VD	232	/* Ageing Time limits in msecs */
	233	unsigned int ageing_time_min;
	234	unsigned int ageing_time_max;
	235
96567d5d AL	236	/* devlink used to represent this switch device */
	237	struct devlink *devlink;
	238
a0c02161 VD	239	/* Dynamically allocated ports, keep last */
	240	size_t num_ports;
	241	struct dsa_port ports[];
c8f0b869 BH	242	};
	243
	244	static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
	245	{
14be36c2	246	return !!(ds->cpu_port_mask & (1 << p));
c8f0b869 BH	247	}
c8f0b869 BH	248
60045cbf AL	249	static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
	250	{
	251	return !!((ds->dsa_port_mask) & (1 << p));
	252	}
	253
6cd456f3 VD	254	static inline bool dsa_is_normal_port(struct dsa_switch *ds, int p)
	255	{
	256	return !dsa_is_cpu_port(ds, p) && !dsa_is_dsa_port(ds, p);
	257	}
	258
c8f0b869 BH	259	static inline u8 dsa_upstream_port(struct dsa_switch *ds)
	260	{
	261	struct dsa_switch_tree *dst = ds->dst;
	262
	263	/*
	264	* If this is the root switch (i.e. the switch that connects
	265	* to the CPU), return the cpu port number on this switch.
	266	* Else return the (DSA) port number that connects to the
	267	* switch that is one hop closer to the cpu.
	268	*/
8b0d3ea5 VD	269	if (dst->cpu_dp->ds == ds)
8b0d3ea5 VD	270	return dst->cpu_dp->index;
c8f0b869	271	else
8b0d3ea5	272	return ds->rtable[dst->cpu_dp->ds->index];
c8f0b869 BH	273	}
c8f0b869 BH	274
9d490b4e	275	struct dsa_switch_ops {
c8f0b869	276	/*
a6a71f19	277	* Legacy probing.
c8f0b869	278	*/
0209d144 VD	279	const char (probe)(struct device *dsa_dev,
	280	struct device *host_dev, int sw_addr,
	281	void **priv);
7b314362 AL	282
	283	enum dsa_tag_protocol (get_tag_protocol)(struct dsa_switch ds);
	284
c8f0b869 BH	285	int (setup)(struct dsa_switch ds);
c8f0b869 BH	286	int (set_addr)(struct dsa_switch ds, u8 *addr);
6819563e	287	u32 (get_phy_flags)(struct dsa_switch ds, int port);
c8f0b869 BH	288
	289	/*
	290	* Access to the switch's PHY registers.
	291	*/
	292	int (phy_read)(struct dsa_switch ds, int port, int regnum);
	293	int (phy_write)(struct dsa_switch ds, int port,
	294	int regnum, u16 val);
	295
ec9436ba FF	296	/*
	297	* Link state adjustment (called from libphy)
	298	*/
	299	void (adjust_link)(struct dsa_switch ds, int port,
	300	struct phy_device *phydev);
ce31b31c FF	301	void (fixed_link_update)(struct dsa_switch ds, int port,
ce31b31c FF	302	struct fixed_phy_status *st);
ec9436ba	303
c8f0b869 BH	304	/*
	305	* ethtool hardware statistics.
	306	*/
	307	void (get_strings)(struct dsa_switch ds, int port, uint8_t *data);
	308	void (get_ethtool_stats)(struct dsa_switch ds,
	309	int port, uint64_t *data);
	310	int (get_sset_count)(struct dsa_switch ds);
24462549	311
19e57c4e FF	312	/*
	313	* ethtool Wake-on-LAN
	314	*/
	315	void (get_wol)(struct dsa_switch ds, int port,
	316	struct ethtool_wolinfo *w);
	317	int (set_wol)(struct dsa_switch ds, int port,
	318	struct ethtool_wolinfo *w);
	319
24462549 FF	320	/*
	321	* Suspend and resume
	322	*/
	323	int (suspend)(struct dsa_switch ds);
	324	int (resume)(struct dsa_switch ds);
b2f2af21 FF	325
	326	/*
	327	* Port enable/disable
	328	*/
	329	int (port_enable)(struct dsa_switch ds, int port,
	330	struct phy_device *phy);
	331	void (port_disable)(struct dsa_switch ds, int port,
	332	struct phy_device *phy);
7905288f FF	333
7905288f FF	334	/*
08f50061	335	* Port's MAC EEE settings
7905288f	336	*/
08f50061 VD	337	int (set_mac_eee)(struct dsa_switch ds, int port,
	338	struct ethtool_eee *e);
	339	int (get_mac_eee)(struct dsa_switch ds, int port,
	340	struct ethtool_eee *e);
51579c3f	341
6793abb4 GR	342	/* EEPROM access */
	343	int (get_eeprom_len)(struct dsa_switch ds);
	344	int (get_eeprom)(struct dsa_switch ds,
	345	struct ethtool_eeprom eeprom, u8 data);
	346	int (set_eeprom)(struct dsa_switch ds,
	347	struct ethtool_eeprom eeprom, u8 data);
3d762a0f GR	348
	349	/*
	350	* Register access.
	351	*/
	352	int (get_regs_len)(struct dsa_switch ds, int port);
	353	void (get_regs)(struct dsa_switch ds, int port,
	354	struct ethtool_regs regs, void p);
b73adef6 FF	355
	356	/*
	357	* Bridge integration
	358	*/
34a79f63	359	int (set_ageing_time)(struct dsa_switch ds, unsigned int msecs);
71327a4e	360	int (port_bridge_join)(struct dsa_switch ds, int port,
a6692754	361	struct net_device *bridge);
f123f2fb VD	362	void (port_bridge_leave)(struct dsa_switch ds, int port,
f123f2fb VD	363	struct net_device *bridge);
43c44a9f VD	364	void (port_stp_state_set)(struct dsa_switch ds, int port,
43c44a9f VD	365	u8 state);
732f794c	366	void (port_fast_age)(struct dsa_switch ds, int port);
2a778e1b	367
11149536 VD	368	/*
	369	* VLAN support
	370	*/
fb2dabad VD	371	int (port_vlan_filtering)(struct dsa_switch ds, int port,
fb2dabad VD	372	bool vlan_filtering);
76e398a6 VD	373	int (port_vlan_prepare)(struct dsa_switch ds, int port,
	374	const struct switchdev_obj_port_vlan *vlan,
	375	struct switchdev_trans *trans);
4d5770b3	376	void (port_vlan_add)(struct dsa_switch ds, int port,
76e398a6 VD	377	const struct switchdev_obj_port_vlan *vlan,
	378	struct switchdev_trans *trans);
	379	int (port_vlan_del)(struct dsa_switch ds, int port,
	380	const struct switchdev_obj_port_vlan *vlan);
65aebfc0 VD	381	int (port_vlan_dump)(struct dsa_switch ds, int port,
65aebfc0 VD	382	struct switchdev_obj_port_vlan *vlan,
438ff537	383	switchdev_obj_dump_cb_t *cb);
11149536	384
2a778e1b VD	385	/*
	386	* Forwarding database
	387	*/
146a3206	388	int (port_fdb_prepare)(struct dsa_switch ds, int port,
6c2c1dcb	389	const unsigned char *addr, u16 vid);
8497aa61	390	void (port_fdb_add)(struct dsa_switch ds, int port,
6c2c1dcb	391	const unsigned char *addr, u16 vid);
2a778e1b	392	int (port_fdb_del)(struct dsa_switch ds, int port,
6c2c1dcb	393	const unsigned char *addr, u16 vid);
ea70ba98 VD	394	int (port_fdb_dump)(struct dsa_switch ds, int port,
ea70ba98 VD	395	struct switchdev_obj_port_fdb *fdb,
438ff537	396	switchdev_obj_dump_cb_t *cb);
8df30255 VD	397
	398	/*
	399	* Multicast database
	400	*/
	401	int (port_mdb_prepare)(struct dsa_switch ds, int port,
	402	const struct switchdev_obj_port_mdb *mdb,
	403	struct switchdev_trans *trans);
	404	void (port_mdb_add)(struct dsa_switch ds, int port,
	405	const struct switchdev_obj_port_mdb *mdb,
	406	struct switchdev_trans *trans);
	407	int (port_mdb_del)(struct dsa_switch ds, int port,
	408	const struct switchdev_obj_port_mdb *mdb);
	409	int (port_mdb_dump)(struct dsa_switch ds, int port,
	410	struct switchdev_obj_port_mdb *mdb,
438ff537	411	switchdev_obj_dump_cb_t *cb);
bf9f2648 FF	412
	413	/*
	414	* RXNFC
	415	*/
	416	int (get_rxnfc)(struct dsa_switch ds, int port,
	417	struct ethtool_rxnfc nfc, u32 rule_locs);
	418	int (set_rxnfc)(struct dsa_switch ds, int port,
	419	struct ethtool_rxnfc *nfc);
f50f2127 FF	420
	421	/*
	422	* TC integration
	423	*/
	424	int (port_mirror_add)(struct dsa_switch ds, int port,
	425	struct dsa_mall_mirror_tc_entry *mirror,
	426	bool ingress);
	427	void (port_mirror_del)(struct dsa_switch ds, int port,
	428	struct dsa_mall_mirror_tc_entry *mirror);
40ef2c93 VD	429
	430	/*
	431	* Cross-chip operations
	432	*/
	433	int (crosschip_bridge_join)(struct dsa_switch ds, int sw_index,
	434	int port, struct net_device *br);
	435	void (crosschip_bridge_leave)(struct dsa_switch ds, int sw_index,
	436	int port, struct net_device *br);
c8f0b869 BH	437	};
c8f0b869 BH	438
ab3d408d FF	439	struct dsa_switch_driver {
ab3d408d FF	440	struct list_head list;
a82f67af	441	const struct dsa_switch_ops *ops;
ab3d408d FF	442	};
ab3d408d FF	443
a6a71f19	444	/* Legacy driver registration */
ab3d408d FF	445	void register_switch_driver(struct dsa_switch_driver *type);
ab3d408d FF	446	void unregister_switch_driver(struct dsa_switch_driver *type);
b4d2394d	447	struct mii_bus dsa_host_dev_to_mii_bus(struct device dev);
a6a71f19	448
14b89f36	449	struct net_device dsa_dev_to_net_device(struct device dev);
c8f0b869	450
73a7ece8	451	/* Keep inline for faster access in hot path */
c6e970a0 AL	452	static inline bool netdev_uses_dsa(struct net_device *dev)
	453	{
	454	#if IS_ENABLED(CONFIG_NET_DSA)
717ffbfb	455	return dev->dsa_ptr && dev->dsa_ptr->rcv;
c6e970a0 AL	456	#endif
	457	return false;
	458	}
	459
a0c02161	460	struct dsa_switch dsa_switch_alloc(struct device dev, size_t n);
83c0afae	461	void dsa_unregister_switch(struct dsa_switch *ds);
23c9ee49	462	int dsa_register_switch(struct dsa_switch *ds);
ea825e70 FF	463	#ifdef CONFIG_PM_SLEEP
	464	int dsa_switch_suspend(struct dsa_switch *ds);
	465	int dsa_switch_resume(struct dsa_switch *ds);
	466	#else
	467	static inline int dsa_switch_suspend(struct dsa_switch *ds)
	468	{
	469	return 0;
	470	}
	471	static inline int dsa_switch_resume(struct dsa_switch *ds)
	472	{
	473	return 0;
	474	}
	475	#endif /* CONFIG_PM_SLEEP */
	476
91da11f8	477	#endif