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

struct tc_action;
struct phy_device;
struct fixed_phy_status;

enum dsa_tag_protocol {
	DSA_TAG_PROTO_NONE = 0,
	DSA_TAG_PROTO_DSA,
	DSA_TAG_PROTO_TRAILER,
	DSA_TAG_PROTO_EDSA,
	DSA_TAG_PROTO_BRCM,
	DSA_TAG_PROTO_QCA,
	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;
	int			(*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 and port to which the CPU is attached.
	 */
	struct dsa_switch	*cpu_switch;
	s8			cpu_port;

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

	/* 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 == ds->dst->cpu_switch && p == ds->dst->cpu_port);
}

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_switch == ds)
		return dst->cpu_port;
	else
		return ds->rtable[dst->cpu_switch->index];
}

struct switchdev_trans;
struct switchdev_obj;
struct switchdev_obj_port_fdb;
struct switchdev_obj_port_mdb;
struct switchdev_obj_port_vlan;

#define DSA_NOTIFIER_BRIDGE_JOIN		1
#define DSA_NOTIFIER_BRIDGE_LEAVE		2

/* DSA_NOTIFIER_BRIDGE_* */
struct dsa_notifier_bridge_info {
	struct net_device *br;
	int sw_index;
	int port;
};

struct dsa_switch_ops {
	/*
	 * Probing and setup.
	 */
	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,
				  int (*cb)(struct switchdev_obj *obj));

	/*
	 * 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,
				 int (*cb)(struct switchdev_obj *obj));

	/*
	 * 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,
				 int (*cb)(struct switchdev_obj *obj));

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

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

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

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