[mirror_ubuntu-jammy-kernel.git] / net / dsa / dsa_priv.h

/*
 * net/dsa/dsa_priv.h - Hardware switch handling
 * 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 __DSA_PRIV_H
#define __DSA_PRIV_H

#include <linux/phy.h>
#include <linux/netdevice.h>
#include <linux/netpoll.h>
#include <net/dsa.h>

enum {
	DSA_NOTIFIER_AGEING_TIME,
	DSA_NOTIFIER_BRIDGE_JOIN,
	DSA_NOTIFIER_BRIDGE_LEAVE,
	DSA_NOTIFIER_FDB_ADD,
	DSA_NOTIFIER_FDB_DEL,
	DSA_NOTIFIER_MDB_ADD,
	DSA_NOTIFIER_MDB_DEL,
	DSA_NOTIFIER_VLAN_ADD,
	DSA_NOTIFIER_VLAN_DEL,
};

/* DSA_NOTIFIER_AGEING_TIME */
struct dsa_notifier_ageing_time_info {
	struct switchdev_trans *trans;
	unsigned int ageing_time;
};

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

/* DSA_NOTIFIER_FDB_* */
struct dsa_notifier_fdb_info {
	int sw_index;
	int port;
	const unsigned char *addr;
	u16 vid;
};

/* DSA_NOTIFIER_MDB_* */
struct dsa_notifier_mdb_info {
	const struct switchdev_obj_port_mdb *mdb;
	struct switchdev_trans *trans;
	int sw_index;
	int port;
};

/* DSA_NOTIFIER_VLAN_* */
struct dsa_notifier_vlan_info {
	const struct switchdev_obj_port_vlan *vlan;
	struct switchdev_trans *trans;
	int sw_index;
	int port;
};

struct dsa_slave_priv {
	/* Copy of CPU port xmit for faster access in slave transmit hot path */
	struct sk_buff *	(*xmit)(struct sk_buff *skb,
					struct net_device *dev);

	struct pcpu_sw_netstats	*stats64;

	/* DSA port data, such as switch, port index, etc. */
	struct dsa_port		*dp;

#ifdef CONFIG_NET_POLL_CONTROLLER
	struct netpoll		*netpoll;
#endif

	/* TC context */
	struct list_head	mall_tc_list;
};

/* dsa.c */
const struct dsa_device_ops *dsa_resolve_tag_protocol(int tag_protocol);
bool dsa_schedule_work(struct work_struct *work);
const char *dsa_tag_protocol_to_str(const struct dsa_device_ops *ops);

/* legacy.c */
#if IS_ENABLED(CONFIG_NET_DSA_LEGACY)
int dsa_legacy_register(void);
void dsa_legacy_unregister(void);
#else
static inline int dsa_legacy_register(void)
{
	return 0;
}

static inline void dsa_legacy_unregister(void) { }
#endif
int dsa_legacy_fdb_add(struct ndmsg *ndm, struct nlattr *tb[],
		       struct net_device *dev,
		       const unsigned char *addr, u16 vid,
		       u16 flags);
int dsa_legacy_fdb_del(struct ndmsg *ndm, struct nlattr *tb[],
		       struct net_device *dev,
		       const unsigned char *addr, u16 vid);

/* master.c */
int dsa_master_setup(struct net_device *dev, struct dsa_port *cpu_dp);
void dsa_master_teardown(struct net_device *dev);

static inline struct net_device *dsa_master_find_slave(struct net_device *dev,
						       int device, int port)
{
	struct dsa_port *cpu_dp = dev->dsa_ptr;
	struct dsa_switch_tree *dst = cpu_dp->dst;
	struct dsa_switch *ds;
	struct dsa_port *slave_port;

	if (device < 0 || device >= DSA_MAX_SWITCHES)
		return NULL;

	ds = dst->ds[device];
	if (!ds)
		return NULL;

	if (port < 0 || port >= ds->num_ports)
		return NULL;

	slave_port = &ds->ports[port];

	if (unlikely(slave_port->type != DSA_PORT_TYPE_USER))
		return NULL;

	return slave_port->slave;
}

/* port.c */
int dsa_port_set_state(struct dsa_port *dp, u8 state,
		       struct switchdev_trans *trans);
int dsa_port_enable(struct dsa_port *dp, struct phy_device *phy);
void dsa_port_disable(struct dsa_port *dp, struct phy_device *phy);
int dsa_port_bridge_join(struct dsa_port *dp, struct net_device *br);
void dsa_port_bridge_leave(struct dsa_port *dp, struct net_device *br);
int dsa_port_vlan_filtering(struct dsa_port *dp, bool vlan_filtering,
			    struct switchdev_trans *trans);
int dsa_port_ageing_time(struct dsa_port *dp, clock_t ageing_clock,
			 struct switchdev_trans *trans);
int dsa_port_fdb_add(struct dsa_port *dp, const unsigned char *addr,
		     u16 vid);
int dsa_port_fdb_del(struct dsa_port *dp, const unsigned char *addr,
		     u16 vid);
int dsa_port_fdb_dump(struct dsa_port *dp, dsa_fdb_dump_cb_t *cb, void *data);
int dsa_port_mdb_add(const struct dsa_port *dp,
		     const struct switchdev_obj_port_mdb *mdb,
		     struct switchdev_trans *trans);
int dsa_port_mdb_del(const struct dsa_port *dp,
		     const struct switchdev_obj_port_mdb *mdb);
int dsa_port_vlan_add(struct dsa_port *dp,
		      const struct switchdev_obj_port_vlan *vlan,
		      struct switchdev_trans *trans);
int dsa_port_vlan_del(struct dsa_port *dp,
		      const struct switchdev_obj_port_vlan *vlan);
int dsa_port_link_register_of(struct dsa_port *dp);
void dsa_port_link_unregister_of(struct dsa_port *dp);

/* slave.c */
extern const struct dsa_device_ops notag_netdev_ops;
void dsa_slave_mii_bus_init(struct dsa_switch *ds);
int dsa_slave_create(struct dsa_port *dp);
void dsa_slave_destroy(struct net_device *slave_dev);
int dsa_slave_suspend(struct net_device *slave_dev);
int dsa_slave_resume(struct net_device *slave_dev);
int dsa_slave_register_notifier(void);
void dsa_slave_unregister_notifier(void);

static inline struct dsa_port *dsa_slave_to_port(const struct net_device *dev)
{
	struct dsa_slave_priv *p = netdev_priv(dev);

	return p->dp;
}

static inline struct net_device *
dsa_slave_to_master(const struct net_device *dev)
{
	struct dsa_port *dp = dsa_slave_to_port(dev);

	return dp->cpu_dp->master;
}

/* switch.c */
int dsa_switch_register_notifier(struct dsa_switch *ds);
void dsa_switch_unregister_notifier(struct dsa_switch *ds);

/* tag_brcm.c */
extern const struct dsa_device_ops brcm_netdev_ops;
extern const struct dsa_device_ops brcm_prepend_netdev_ops;

/* tag_dsa.c */
extern const struct dsa_device_ops dsa_netdev_ops;

/* tag_edsa.c */
extern const struct dsa_device_ops edsa_netdev_ops;

/* tag_ksz.c */
extern const struct dsa_device_ops ksz_netdev_ops;

/* tag_lan9303.c */
extern const struct dsa_device_ops lan9303_netdev_ops;

/* tag_mtk.c */
extern const struct dsa_device_ops mtk_netdev_ops;

/* tag_qca.c */
extern const struct dsa_device_ops qca_netdev_ops;

/* tag_trailer.c */
extern const struct dsa_device_ops trailer_netdev_ops;

#endif
Commit	Line	Data
91da11f8 LB	1	/*
91da11f8 LB	2	* net/dsa/dsa_priv.h - Hardware switch handling
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 __DSA_PRIV_H
	12	#define __DSA_PRIV_H
	13
91da11f8	14	#include <linux/phy.h>
5075314e	15	#include <linux/netdevice.h>
04ff53f9	16	#include <linux/netpoll.h>
ea5dd34b	17	#include <net/dsa.h>
5075314e	18
52c96f9d	19	enum {
1faabf74	20	DSA_NOTIFIER_AGEING_TIME,
52c96f9d VD	21	DSA_NOTIFIER_BRIDGE_JOIN,
52c96f9d VD	22	DSA_NOTIFIER_BRIDGE_LEAVE,
685fb6a4 VD	23	DSA_NOTIFIER_FDB_ADD,
685fb6a4 VD	24	DSA_NOTIFIER_FDB_DEL,
8ae5bcdc VD	25	DSA_NOTIFIER_MDB_ADD,
8ae5bcdc VD	26	DSA_NOTIFIER_MDB_DEL,
d0c627b8 VD	27	DSA_NOTIFIER_VLAN_ADD,
d0c627b8 VD	28	DSA_NOTIFIER_VLAN_DEL,
52c96f9d VD	29	};
52c96f9d VD	30
1faabf74 VD	31	/* DSA_NOTIFIER_AGEING_TIME */
	32	struct dsa_notifier_ageing_time_info {
	33	struct switchdev_trans *trans;
	34	unsigned int ageing_time;
1faabf74 VD	35	};
1faabf74 VD	36
52c96f9d VD	37	/* DSA_NOTIFIER_BRIDGE_* */
	38	struct dsa_notifier_bridge_info {
	39	struct net_device *br;
	40	int sw_index;
	41	int port;
	42	};
	43
685fb6a4 VD	44	/* DSA_NOTIFIER_FDB_* */
685fb6a4 VD	45	struct dsa_notifier_fdb_info {
685fb6a4 VD	46	int sw_index;
685fb6a4 VD	47	int port;
2acf4e6a AS	48	const unsigned char *addr;
2acf4e6a AS	49	u16 vid;
685fb6a4 VD	50	};
685fb6a4 VD	51
8ae5bcdc VD	52	/* DSA_NOTIFIER_MDB_* */
	53	struct dsa_notifier_mdb_info {
	54	const struct switchdev_obj_port_mdb *mdb;
	55	struct switchdev_trans *trans;
	56	int sw_index;
	57	int port;
	58	};
	59
d0c627b8 VD	60	/* DSA_NOTIFIER_VLAN_* */
	61	struct dsa_notifier_vlan_info {
	62	const struct switchdev_obj_port_vlan *vlan;
	63	struct switchdev_trans *trans;
	64	int sw_index;
	65	int port;
	66	};
	67
91da11f8	68	struct dsa_slave_priv {
15240248	69	/* Copy of CPU port xmit for faster access in slave transmit hot path */
4ed70ce9	70	struct sk_buff * (xmit)(struct sk_buff skb,
5075314e	71	struct net_device *dev);
e84665c9	72
5f6b4e14	73	struct pcpu_sw_netstats *stats64;
f613ed66	74
afdcf151 VD	75	/* DSA port data, such as switch, port index, etc. */
afdcf151 VD	76	struct dsa_port *dp;
e84665c9	77
04ff53f9 FF	78	#ifdef CONFIG_NET_POLL_CONTROLLER
	79	struct netpoll *netpoll;
	80	#endif
f50f2127 FF	81
	82	/* TC context */
	83	struct list_head mall_tc_list;
91da11f8 LB	84	};
91da11f8 LB	85
91da11f8	86	/* dsa.c */
39a7f2a4	87	const struct dsa_device_ops *dsa_resolve_tag_protocol(int tag_protocol);
c9eb3e0f	88	bool dsa_schedule_work(struct work_struct *work);
98cdb480	89	const char dsa_tag_protocol_to_str(const struct dsa_device_ops ops);
91da11f8	90
a6a71f19	91	/* legacy.c */
2a93c1a3	92	#if IS_ENABLED(CONFIG_NET_DSA_LEGACY)
a6a71f19 VD	93	int dsa_legacy_register(void);
a6a71f19 VD	94	void dsa_legacy_unregister(void);
2a93c1a3 FF	95	#else
	96	static inline int dsa_legacy_register(void)
	97	{
21602e1a	98	return 0;
2a93c1a3 FF	99	}
	100
	101	static inline void dsa_legacy_unregister(void) { }
	102	#endif
37b8da1a AS	103	int dsa_legacy_fdb_add(struct ndmsg ndm, struct nlattr tb[],
	104	struct net_device *dev,
	105	const unsigned char *addr, u16 vid,
	106	u16 flags);
	107	int dsa_legacy_fdb_del(struct ndmsg ndm, struct nlattr tb[],
	108	struct net_device *dev,
	109	const unsigned char *addr, u16 vid);
a6a71f19	110
f2f23566	111	/* master.c */
17a22fcf VD	112	int dsa_master_setup(struct net_device dev, struct dsa_port cpu_dp);
17a22fcf VD	113	void dsa_master_teardown(struct net_device *dev);
f2f23566	114
2231c43b VD	115	static inline struct net_device dsa_master_find_slave(struct net_device dev,
2231c43b VD	116	int device, int port)
3775b1b7	117	{
2f657a60 VD	118	struct dsa_port *cpu_dp = dev->dsa_ptr;
2f657a60 VD	119	struct dsa_switch_tree *dst = cpu_dp->dst;
3775b1b7	120	struct dsa_switch *ds;
fc5f3376	121	struct dsa_port *slave_port;
3775b1b7 VD	122
	123	if (device < 0 \|\| device >= DSA_MAX_SWITCHES)
	124	return NULL;
	125
	126	ds = dst->ds[device];
	127	if (!ds)
	128	return NULL;
	129
	130	if (port < 0 \|\| port >= ds->num_ports)
	131	return NULL;
	132
fc5f3376 AL	133	slave_port = &ds->ports[port];
	134
	135	if (unlikely(slave_port->type != DSA_PORT_TYPE_USER))
	136	return NULL;
	137
	138	return slave_port->slave;
3775b1b7 VD	139	}
3775b1b7 VD	140
a40c175b VD	141	/* port.c */
	142	int dsa_port_set_state(struct dsa_port *dp, u8 state,
	143	struct switchdev_trans *trans);
fb8a6a2b VD	144	int dsa_port_enable(struct dsa_port dp, struct phy_device phy);
fb8a6a2b VD	145	void dsa_port_disable(struct dsa_port dp, struct phy_device phy);
cfbed329 VD	146	int dsa_port_bridge_join(struct dsa_port dp, struct net_device br);
cfbed329 VD	147	void dsa_port_bridge_leave(struct dsa_port dp, struct net_device br);
4d61d304 VD	148	int dsa_port_vlan_filtering(struct dsa_port *dp, bool vlan_filtering,
4d61d304 VD	149	struct switchdev_trans *trans);
d87bd94e VD	150	int dsa_port_ageing_time(struct dsa_port *dp, clock_t ageing_clock,
d87bd94e VD	151	struct switchdev_trans *trans);
2acf4e6a AS	152	int dsa_port_fdb_add(struct dsa_port dp, const unsigned char addr,
	153	u16 vid);
	154	int dsa_port_fdb_del(struct dsa_port dp, const unsigned char addr,
	155	u16 vid);
de40fc5d	156	int dsa_port_fdb_dump(struct dsa_port dp, dsa_fdb_dump_cb_t cb, void *data);
bb9f6031	157	int dsa_port_mdb_add(const struct dsa_port *dp,
3a9afea3 VD	158	const struct switchdev_obj_port_mdb *mdb,
3a9afea3 VD	159	struct switchdev_trans *trans);
bb9f6031	160	int dsa_port_mdb_del(const struct dsa_port *dp,
3a9afea3	161	const struct switchdev_obj_port_mdb *mdb);
076e7133 VD	162	int dsa_port_vlan_add(struct dsa_port *dp,
	163	const struct switchdev_obj_port_vlan *vlan,
	164	struct switchdev_trans *trans);
	165	int dsa_port_vlan_del(struct dsa_port *dp,
	166	const struct switchdev_obj_port_vlan *vlan);
33615367 SR	167	int dsa_port_link_register_of(struct dsa_port *dp);
33615367 SR	168	void dsa_port_link_unregister_of(struct dsa_port *dp);
57ab1ca2	169
91da11f8	170	/* slave.c */
5075314e	171	extern const struct dsa_device_ops notag_netdev_ops;
91da11f8	172	void dsa_slave_mii_bus_init(struct dsa_switch *ds);
951259aa	173	int dsa_slave_create(struct dsa_port *dp);
cda5c15b	174	void dsa_slave_destroy(struct net_device *slave_dev);
24462549 FF	175	int dsa_slave_suspend(struct net_device *slave_dev);
24462549 FF	176	int dsa_slave_resume(struct net_device *slave_dev);
88e4f0ca VD	177	int dsa_slave_register_notifier(void);
88e4f0ca VD	178	void dsa_slave_unregister_notifier(void);
91da11f8	179
d945097b VD	180	static inline struct dsa_port dsa_slave_to_port(const struct net_device dev)
	181	{
	182	struct dsa_slave_priv *p = netdev_priv(dev);
	183
	184	return p->dp;
	185	}
	186
d0006b00 VD	187	static inline struct net_device *
	188	dsa_slave_to_master(const struct net_device *dev)
	189	{
	190	struct dsa_port *dp = dsa_slave_to_port(dev);
	191
f8b8b1cd	192	return dp->cpu_dp->master;
d0006b00 VD	193	}
d0006b00 VD	194
f515f192 VD	195	/* switch.c */
	196	int dsa_switch_register_notifier(struct dsa_switch *ds);
	197	void dsa_switch_unregister_notifier(struct dsa_switch *ds);
	198
eb7b7211 AL	199	/* tag_brcm.c */
eb7b7211 AL	200	extern const struct dsa_device_ops brcm_netdev_ops;
b74b70c4	201	extern const struct dsa_device_ops brcm_prepend_netdev_ops;
eb7b7211	202
cf85d08f	203	/* tag_dsa.c */
3e8a72d1	204	extern const struct dsa_device_ops dsa_netdev_ops;
cf85d08f	205
91da11f8	206	/* tag_edsa.c */
3e8a72d1	207	extern const struct dsa_device_ops edsa_netdev_ops;
91da11f8	208
8b8010fb WH	209	/* tag_ksz.c */
	210	extern const struct dsa_device_ops ksz_netdev_ops;
	211
eb7b7211 AL	212	/* tag_lan9303.c */
eb7b7211 AL	213	extern const struct dsa_device_ops lan9303_netdev_ops;
396138f0	214
eb7b7211 AL	215	/* tag_mtk.c */
eb7b7211 AL	216	extern const struct dsa_device_ops mtk_netdev_ops;
5037d532	217
cafdc45c JC	218	/* tag_qca.c */
cafdc45c JC	219	extern const struct dsa_device_ops qca_netdev_ops;
91da11f8	220
eb7b7211 AL	221	/* tag_trailer.c */
eb7b7211 AL	222	extern const struct dsa_device_ops trailer_netdev_ops;
e8fe177a	223
91da11f8	224	#endif