dsa.h 13.9 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 105 106
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,
107
			       struct packet_type *pt);
108 109
	int (*flow_dissect)(const struct sk_buff *skb, __be16 *proto,
			    int *offset);
110 111
};

112
struct dsa_switch_tree {
113 114
	struct list_head	list;

V
Vivien Didelot 已提交
115 116 117
	/* Notifier chain for switch-wide events */
	struct raw_notifier_head	nh;

118 119 120 121 122 123 124 125 126
	/* Tree identifier */
	u32 tree;

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

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

127 128 129 130 131 132 133
	/*
	 * Configuration data for the platform device that owns
	 * this dsa switch tree instance.
	 */
	struct dsa_platform_data	*pd;

	/*
134
	 * The switch port to which the CPU is attached.
135
	 */
136
	struct dsa_port		*cpu_dp;
137 138 139 140 141 142 143

	/*
	 * Data for the individual switch chips.
	 */
	struct dsa_switch	*ds[DSA_MAX_SWITCHES];
};

144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
/* 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;
	};
};


166
struct dsa_port {
167 168 169 170 171 172 173 174
	/* 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;
	};

V
Vivien Didelot 已提交
175 176 177
	/* CPU port tagging operations used by master or slave devices */
	const struct dsa_device_ops *tag_ops;

178 179 180 181 182
	/* 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);

V
Vivien Didelot 已提交
183 184 185 186 187 188 189
	enum {
		DSA_PORT_TYPE_UNUSED = 0,
		DSA_PORT_TYPE_CPU,
		DSA_PORT_TYPE_DSA,
		DSA_PORT_TYPE_USER,
	} type;

190 191
	struct dsa_switch	*ds;
	unsigned int		index;
192
	const char		*name;
193
	struct dsa_port		*cpu_dp;
194
	struct device_node	*dn;
195
	unsigned int		ageing_time;
V
Vivien Didelot 已提交
196
	u8			stp_state;
197
	struct net_device	*bridge_dev;
198
	struct devlink_port	devlink_port;
199 200 201 202
	/*
	 * Original copy of the master netdev ethtool_ops
	 */
	const struct ethtool_ops *orig_ethtool_ops;
203 204
};

205
struct dsa_switch {
206 207
	struct device *dev;

208 209 210 211 212 213
	/*
	 * Parent switch tree, and switch index.
	 */
	struct dsa_switch_tree	*dst;
	int			index;

V
Vivien Didelot 已提交
214 215 216
	/* Listener for switch fabric events */
	struct notifier_block	nb;

217 218 219 220 221 222
	/*
	 * Give the switch driver somewhere to hang its private data
	 * structure.
	 */
	void *priv;

223 224 225
	/*
	 * Configuration data for this switch.
	 */
A
Andrew Lunn 已提交
226
	struct dsa_chip_data	*cd;
227 228

	/*
229
	 * The switch operations.
230
	 */
231
	const struct dsa_switch_ops	*ops;
232

233 234 235 236 237 238 239
	/*
	 * 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];

240 241 242
	/*
	 * Slave mii_bus and devices for the individual ports.
	 */
243
	u32			phys_mii_mask;
244
	struct mii_bus		*slave_mii_bus;
245

246 247 248 249
	/* Ageing Time limits in msecs */
	unsigned int ageing_time_min;
	unsigned int ageing_time_max;

250 251 252
	/* devlink used to represent this switch device */
	struct devlink		*devlink;

253 254 255
	/* Number of switch port queues */
	unsigned int		num_tx_queues;

256 257 258
	/* Dynamically allocated ports, keep last */
	size_t num_ports;
	struct dsa_port ports[];
259 260
};

261
static inline const struct dsa_port *dsa_to_port(struct dsa_switch *ds, int p)
262
{
263 264
	return &ds->ports[p];
}
265

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

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

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

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

286 287
static inline u32 dsa_user_ports(struct dsa_switch *ds)
{
288 289
	u32 mask = 0;
	int p;
290

291 292 293 294 295
	for (p = 0; p < ds->num_ports; p++)
		if (dsa_is_user_port(ds, p))
			mask |= BIT(p);

	return mask;
V
Vivien Didelot 已提交
296 297
}

298 299 300 301 302 303 304 305 306 307
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.
	 */
308 309
	if (dst->cpu_dp->ds == ds)
		return dst->cpu_dp->index;
310
	else
311
		return ds->rtable[dst->cpu_dp->ds->index];
312 313
}

314 315
typedef int dsa_fdb_dump_cb_t(const unsigned char *addr, u16 vid,
			      bool is_static, void *data);
316
struct dsa_switch_ops {
317
	/*
V
Vivien Didelot 已提交
318
	 * Legacy probing.
319
	 */
V
Vivien Didelot 已提交
320 321 322
	const char	*(*probe)(struct device *dsa_dev,
				  struct device *host_dev, int sw_addr,
				  void **priv);
323 324 325

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

326
	int	(*setup)(struct dsa_switch *ds);
327
	u32	(*get_phy_flags)(struct dsa_switch *ds, int port);
328 329 330 331 332 333 334 335

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

336 337 338 339 340
	/*
	 * Link state adjustment (called from libphy)
	 */
	void	(*adjust_link)(struct dsa_switch *ds, int port,
				struct phy_device *phydev);
341 342
	void	(*fixed_link_update)(struct dsa_switch *ds, int port,
				struct fixed_phy_status *st);
343

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

352 353 354 355 356 357 358 359
	/*
	 * 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);

360 361 362 363 364
	/*
	 * Suspend and resume
	 */
	int	(*suspend)(struct dsa_switch *ds);
	int	(*resume)(struct dsa_switch *ds);
365 366 367 368 369 370 371 372

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

	/*
V
Vivien Didelot 已提交
375
	 * Port's MAC EEE settings
376
	 */
V
Vivien Didelot 已提交
377 378 379 380
	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);
381

382 383 384 385 386 387
	/* 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);
388 389 390 391 392 393 394

	/*
	 * 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);
395 396 397 398

	/*
	 * Bridge integration
	 */
399
	int	(*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
400
	int	(*port_bridge_join)(struct dsa_switch *ds, int port,
401
				    struct net_device *bridge);
402 403
	void	(*port_bridge_leave)(struct dsa_switch *ds, int port,
				     struct net_device *bridge);
404 405
	void	(*port_stp_state_set)(struct dsa_switch *ds, int port,
				      u8 state);
V
Vivien Didelot 已提交
406
	void	(*port_fast_age)(struct dsa_switch *ds, int port);
407

408 409 410
	/*
	 * VLAN support
	 */
411 412
	int	(*port_vlan_filtering)(struct dsa_switch *ds, int port,
				       bool vlan_filtering);
413 414 415
	int	(*port_vlan_prepare)(struct dsa_switch *ds, int port,
				     const struct switchdev_obj_port_vlan *vlan,
				     struct switchdev_trans *trans);
416
	void	(*port_vlan_add)(struct dsa_switch *ds, int port,
417 418 419 420
				 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);
421 422 423
	/*
	 * Forwarding database
	 */
424
	int	(*port_fdb_add)(struct dsa_switch *ds, int port,
425
				const unsigned char *addr, u16 vid);
426
	int	(*port_fdb_del)(struct dsa_switch *ds, int port,
427
				const unsigned char *addr, u16 vid);
428
	int	(*port_fdb_dump)(struct dsa_switch *ds, int port,
429
				 dsa_fdb_dump_cb_t *cb, void *data);
V
Vivien Didelot 已提交
430 431 432 433 434 435 436 437 438 439 440 441

	/*
	 * 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);
442 443 444 445 446 447 448
	/*
	 * 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);
449 450 451 452 453 454 455 456 457

	/*
	 * 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);
458 459 460 461 462 463 464 465

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

468 469
struct dsa_switch_driver {
	struct list_head	list;
470
	const struct dsa_switch_ops *ops;
471 472
};

V
Vivien Didelot 已提交
473
/* Legacy driver registration */
474 475
void register_switch_driver(struct dsa_switch_driver *type);
void unregister_switch_driver(struct dsa_switch_driver *type);
476
struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev);
V
Vivien Didelot 已提交
477

478
struct net_device *dsa_dev_to_net_device(struct device *dev);
479

480
/* Keep inline for faster access in hot path */
481 482 483
static inline bool netdev_uses_dsa(struct net_device *dev)
{
#if IS_ENABLED(CONFIG_NET_DSA)
484
	return dev->dsa_ptr && dev->dsa_ptr->rcv;
485 486 487 488
#endif
	return false;
}

489
struct dsa_switch *dsa_switch_alloc(struct device *dev, size_t n);
490
void dsa_unregister_switch(struct dsa_switch *ds);
491
int dsa_register_switch(struct dsa_switch *ds);
492 493 494 495 496 497 498 499 500 501 502 503 504 505
#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 */

506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
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

551 552 553 554 555
/* 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)

556
#endif