[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_BRCM_PREPEND,
	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 */
	unsigned int index;

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

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

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

	enum {
		DSA_PORT_TYPE_UNUSED = 0,
		DSA_PORT_TYPE_CPU,
		DSA_PORT_TYPE_DSA,
		DSA_PORT_TYPE_USER,
	} type;

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

static inline bool dsa_is_unused_port(struct dsa_switch *ds, int p)
{
	return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_UNUSED;
}

static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
{
	return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_CPU;
}

static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
{
	return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_DSA;
}

static inline bool dsa_is_user_port(struct dsa_switch *ds, int p)
{
	return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_USER;
}

static inline u32 dsa_user_ports(struct dsa_switch *ds)
{
	u32 mask = 0;
	int p;

	for (p = 0; p < ds->num_ports; p++)
		if (dsa_is_user_port(ds, p))
			mask |= BIT(p);

	return mask;
}

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

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