dsa.h 11.8 KB
Newer Older
1 2
/*
 * include/net/dsa.h - Driver for Distributed Switch Architecture switch chips
3
 * Copyright (c) 2008-2009 Marvell Semiconductor
4 5 6 7 8 9 10 11 12 13
 *
 * 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

14
#include <linux/if.h>
15
#include <linux/if_ether.h>
16
#include <linux/list.h>
V
Vivien Didelot 已提交
17
#include <linux/notifier.h>
18 19
#include <linux/timer.h>
#include <linux/workqueue.h>
20
#include <linux/of.h>
21
#include <linux/ethtool.h>
22
#include <net/devlink.h>
23
#include <net/switchdev.h>
24

25
struct tc_action;
26 27
struct phy_device;
struct fixed_phy_status;
28

29 30
enum dsa_tag_protocol {
	DSA_TAG_PROTO_NONE = 0,
31
	DSA_TAG_PROTO_BRCM,
32 33
	DSA_TAG_PROTO_DSA,
	DSA_TAG_PROTO_EDSA,
34
	DSA_TAG_PROTO_KSZ,
35
	DSA_TAG_PROTO_LAN9303,
36 37 38
	DSA_TAG_PROTO_MTK,
	DSA_TAG_PROTO_QCA,
	DSA_TAG_PROTO_TRAILER,
39
	DSA_TAG_LAST,		/* MUST BE LAST */
40
};
41

42 43 44
#define DSA_MAX_SWITCHES	4
#define DSA_MAX_PORTS		12

45 46
#define DSA_RTABLE_NONE		-1

47 48 49 50
struct dsa_chip_data {
	/*
	 * How to access the switch configuration registers.
	 */
51
	struct device	*host_dev;
52 53
	int		sw_addr;

54 55 56 57 58
	/*
	 * Reference to network devices
	 */
	struct device	*netdev[DSA_MAX_PORTS];

59 60 61
	/* set to size of eeprom if supported by the switch */
	int		eeprom_len;

62 63 64 65 66 67
	/* 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;

68 69 70 71 72 73 74 75
	/*
	 * 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];
76
	struct device_node *port_dn[DSA_MAX_PORTS];
77 78

	/*
79 80 81
	 * 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.
82
	 */
83
	s8		rtable[DSA_MAX_SWITCHES];
84
};
85 86 87 88

struct dsa_platform_data {
	/*
	 * Reference to a Linux network interface that connects
89
	 * to the root switch chip of the tree.
90 91
	 */
	struct device	*netdev;
92
	struct net_device *of_netdev;
93 94

	/*
95 96
	 * Info structs describing each of the switch chips
	 * connected via this network interface.
97
	 */
98 99
	int		nr_chips;
	struct dsa_chip_data	*chip;
100 101
};

102
struct packet_type;
103

104
struct dsa_switch_tree {
105 106
	struct list_head	list;

V
Vivien Didelot 已提交
107 108 109
	/* Notifier chain for switch-wide events */
	struct raw_notifier_head	nh;

110 111 112 113 114 115 116 117 118
	/* Tree identifier */
	u32 tree;

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

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

119 120 121 122 123 124
	/*
	 * Configuration data for the platform device that owns
	 * this dsa switch tree instance.
	 */
	struct dsa_platform_data	*pd;

125
	/* Copy of tag_ops->rcv for faster access in hot path */
126
	struct sk_buff *	(*rcv)(struct sk_buff *skb,
127 128 129
				       struct net_device *dev,
				       struct packet_type *pt,
				       struct net_device *orig_dev);
130 131

	/*
132
	 * The switch port to which the CPU is attached.
133
	 */
134
	struct dsa_port		*cpu_dp;
135 136 137 138 139

	/*
	 * Data for the individual switch chips.
	 */
	struct dsa_switch	*ds[DSA_MAX_SWITCHES];
140 141 142 143 144 145

	/*
	 * Tagging protocol operations for adding and removing an
	 * encapsulation tag.
	 */
	const struct dsa_device_ops *tag_ops;
146 147
};

148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
/* 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;
	};
};


170
struct dsa_port {
171 172
	struct dsa_switch	*ds;
	unsigned int		index;
173
	const char		*name;
174
	struct dsa_port		*cpu_dp;
175
	struct net_device	*netdev;
176
	struct device_node	*dn;
177
	unsigned int		ageing_time;
V
Vivien Didelot 已提交
178
	u8			stp_state;
179
	struct net_device	*bridge_dev;
180
	struct devlink_port	devlink_port;
181 182 183 184 185
	/*
	 * Original copy of the master netdev ethtool_ops
	 */
	struct ethtool_ops	ethtool_ops;
	const struct ethtool_ops *orig_ethtool_ops;
186 187
};

188
struct dsa_switch {
189 190
	struct device *dev;

191 192 193 194 195 196
	/*
	 * Parent switch tree, and switch index.
	 */
	struct dsa_switch_tree	*dst;
	int			index;

V
Vivien Didelot 已提交
197 198 199
	/* Listener for switch fabric events */
	struct notifier_block	nb;

200 201 202 203 204 205
	/*
	 * Give the switch driver somewhere to hang its private data
	 * structure.
	 */
	void *priv;

206 207 208
	/*
	 * Configuration data for this switch.
	 */
A
Andrew Lunn 已提交
209
	struct dsa_chip_data	*cd;
210 211

	/*
212
	 * The switch operations.
213
	 */
214
	const struct dsa_switch_ops	*ops;
215

216 217 218 219 220 221 222
	/*
	 * 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];

223 224 225 226
	/*
	 * Slave mii_bus and devices for the individual ports.
	 */
	u32			dsa_port_mask;
227
	u32			cpu_port_mask;
228
	u32			enabled_port_mask;
229
	u32			phys_mii_mask;
230
	struct mii_bus		*slave_mii_bus;
231

232 233 234 235
	/* Ageing Time limits in msecs */
	unsigned int ageing_time_min;
	unsigned int ageing_time_max;

236 237 238
	/* devlink used to represent this switch device */
	struct devlink		*devlink;

239 240 241
	/* Dynamically allocated ports, keep last */
	size_t num_ports;
	struct dsa_port ports[];
242 243 244 245
};

static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
{
246
	return !!(ds->cpu_port_mask & (1 << p));
247 248
}

249 250 251 252 253
static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
{
	return !!((ds->dsa_port_mask) & (1 << p));
}

254 255 256 257 258
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);
}

259 260 261 262 263 264 265 266 267 268
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.
	 */
269 270
	if (dst->cpu_dp->ds == ds)
		return dst->cpu_dp->index;
271
	else
272
		return ds->rtable[dst->cpu_dp->ds->index];
273 274
}

275 276
typedef int dsa_fdb_dump_cb_t(const unsigned char *addr, u16 vid,
			      bool is_static, void *data);
277
struct dsa_switch_ops {
278
	/*
V
Vivien Didelot 已提交
279
	 * Legacy probing.
280
	 */
V
Vivien Didelot 已提交
281 282 283
	const char	*(*probe)(struct device *dsa_dev,
				  struct device *host_dev, int sw_addr,
				  void **priv);
284 285 286

	enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds);

287 288
	int	(*setup)(struct dsa_switch *ds);
	int	(*set_addr)(struct dsa_switch *ds, u8 *addr);
289
	u32	(*get_phy_flags)(struct dsa_switch *ds, int port);
290 291 292 293 294 295 296 297

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

298 299 300 301 302
	/*
	 * Link state adjustment (called from libphy)
	 */
	void	(*adjust_link)(struct dsa_switch *ds, int port,
				struct phy_device *phydev);
303 304
	void	(*fixed_link_update)(struct dsa_switch *ds, int port,
				struct fixed_phy_status *st);
305

306 307 308 309 310 311 312
	/*
	 * 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);
313

314 315 316 317 318 319 320 321
	/*
	 * 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);

322 323 324 325 326
	/*
	 * Suspend and resume
	 */
	int	(*suspend)(struct dsa_switch *ds);
	int	(*resume)(struct dsa_switch *ds);
327 328 329 330 331 332 333 334

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

	/*
V
Vivien Didelot 已提交
337
	 * Port's MAC EEE settings
338
	 */
V
Vivien Didelot 已提交
339 340 341 342
	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);
343

344 345 346 347 348 349
	/* 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);
350 351 352 353 354 355 356

	/*
	 * 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);
357 358 359 360

	/*
	 * Bridge integration
	 */
361
	int	(*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
362
	int	(*port_bridge_join)(struct dsa_switch *ds, int port,
363
				    struct net_device *bridge);
364 365
	void	(*port_bridge_leave)(struct dsa_switch *ds, int port,
				     struct net_device *bridge);
366 367
	void	(*port_stp_state_set)(struct dsa_switch *ds, int port,
				      u8 state);
V
Vivien Didelot 已提交
368
	void	(*port_fast_age)(struct dsa_switch *ds, int port);
369

370 371 372
	/*
	 * VLAN support
	 */
373 374
	int	(*port_vlan_filtering)(struct dsa_switch *ds, int port,
				       bool vlan_filtering);
375 376 377
	int	(*port_vlan_prepare)(struct dsa_switch *ds, int port,
				     const struct switchdev_obj_port_vlan *vlan,
				     struct switchdev_trans *trans);
378
	void	(*port_vlan_add)(struct dsa_switch *ds, int port,
379 380 381 382
				 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);
383 384 385
	/*
	 * Forwarding database
	 */
386
	int	(*port_fdb_add)(struct dsa_switch *ds, int port,
387
				const unsigned char *addr, u16 vid);
388
	int	(*port_fdb_del)(struct dsa_switch *ds, int port,
389
				const unsigned char *addr, u16 vid);
390
	int	(*port_fdb_dump)(struct dsa_switch *ds, int port,
391
				 dsa_fdb_dump_cb_t *cb, void *data);
V
Vivien Didelot 已提交
392 393 394 395 396 397 398 399 400 401 402 403

	/*
	 * 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);
404 405 406 407 408 409 410
	/*
	 * 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);
411 412 413 414 415 416 417 418 419

	/*
	 * 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);
420 421 422 423 424 425 426 427

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

430 431
struct dsa_switch_driver {
	struct list_head	list;
432
	const struct dsa_switch_ops *ops;
433 434
};

V
Vivien Didelot 已提交
435
/* Legacy driver registration */
436 437
void register_switch_driver(struct dsa_switch_driver *type);
void unregister_switch_driver(struct dsa_switch_driver *type);
438
struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev);
V
Vivien Didelot 已提交
439

440
struct net_device *dsa_dev_to_net_device(struct device *dev);
441

442
/* Keep inline for faster access in hot path */
443 444 445
static inline bool netdev_uses_dsa(struct net_device *dev)
{
#if IS_ENABLED(CONFIG_NET_DSA)
446
	return dev->dsa_ptr && dev->dsa_ptr->rcv;
447 448 449 450
#endif
	return false;
}

451
struct dsa_switch *dsa_switch_alloc(struct device *dev, size_t n);
452
void dsa_unregister_switch(struct dsa_switch *ds);
453
int dsa_register_switch(struct dsa_switch *ds);
454 455 456 457 458 459 460 461 462 463 464 465 466 467
#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 */

468
#endif