dsa.h 9.88 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_ether.h>
15
#include <linux/list.h>
16 17
#include <linux/timer.h>
#include <linux/workqueue.h>
18
#include <linux/of.h>
19
#include <linux/phy.h>
20
#include <linux/phy_fixed.h>
21
#include <linux/ethtool.h>
22

23 24 25 26 27 28
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,
29
	DSA_TAG_LAST,		/* MUST BE LAST */
30
};
31

32 33 34
#define DSA_MAX_SWITCHES	4
#define DSA_MAX_PORTS		12

35 36
#define DSA_RTABLE_NONE		-1

37 38 39 40
struct dsa_chip_data {
	/*
	 * How to access the switch configuration registers.
	 */
41
	struct device	*host_dev;
42 43
	int		sw_addr;

44 45 46
	/* set to size of eeprom if supported by the switch */
	int		eeprom_len;

47 48 49 50 51 52
	/* 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;

53 54 55 56 57 58 59 60
	/*
	 * 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];
61
	struct device_node *port_dn[DSA_MAX_PORTS];
62 63

	/*
64 65 66
	 * 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.
67
	 */
68
	s8		rtable[DSA_MAX_SWITCHES];
69
};
70 71 72 73

struct dsa_platform_data {
	/*
	 * Reference to a Linux network interface that connects
74
	 * to the root switch chip of the tree.
75 76
	 */
	struct device	*netdev;
77
	struct net_device *of_netdev;
78 79

	/*
80 81
	 * Info structs describing each of the switch chips
	 * connected via this network interface.
82
	 */
83 84
	int		nr_chips;
	struct dsa_chip_data	*chip;
85 86
};

87
struct packet_type;
88

89
struct dsa_switch_tree {
90 91 92 93 94 95 96 97 98 99 100
	struct list_head	list;

	/* Tree identifier */
	u32 tree;

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

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

101 102 103 104 105 106 107 108 109 110 111
	/*
	 * 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;
112 113 114 115
	int			(*rcv)(struct sk_buff *skb,
				       struct net_device *dev,
				       struct packet_type *pt,
				       struct net_device *orig_dev);
116

117 118 119 120
	/*
	 * Original copy of the master netdev ethtool_ops
	 */
	struct ethtool_ops	master_ethtool_ops;
121
	const struct ethtool_ops *master_orig_ethtool_ops;
122

123 124 125 126 127 128 129 130 131 132
	/*
	 * The switch and port to which the CPU is attached.
	 */
	s8			cpu_switch;
	s8			cpu_port;

	/*
	 * Data for the individual switch chips.
	 */
	struct dsa_switch	*ds[DSA_MAX_SWITCHES];
133 134 135 136 137 138

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

141 142
struct dsa_port {
	struct net_device	*netdev;
143
	struct device_node	*dn;
144
	unsigned int		ageing_time;
145 146
};

147
struct dsa_switch {
148 149
	struct device *dev;

150 151 152 153 154 155
	/*
	 * Parent switch tree, and switch index.
	 */
	struct dsa_switch_tree	*dst;
	int			index;

156 157 158 159 160 161
	/*
	 * Give the switch driver somewhere to hang its private data
	 * structure.
	 */
	void *priv;

162 163 164
	/*
	 * Configuration data for this switch.
	 */
165
	struct dsa_chip_data	*cd;
166 167 168 169 170 171

	/*
	 * The used switch driver.
	 */
	struct dsa_switch_driver	*drv;

172 173 174 175 176 177 178
	/*
	 * 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];

179 180 181 182 183 184 185 186
#ifdef CONFIG_NET_DSA_HWMON
	/*
	 * Hardware monitoring information
	 */
	char			hwmon_name[IFNAMSIZ + 8];
	struct device		*hwmon_dev;
#endif

187 188 189 190 191
	/*
	 * The lower device this switch uses to talk to the host
	 */
	struct net_device *master_netdev;

192 193 194 195
	/*
	 * Slave mii_bus and devices for the individual ports.
	 */
	u32			dsa_port_mask;
196
	u32			cpu_port_mask;
197
	u32			enabled_port_mask;
198
	u32			phys_mii_mask;
199
	struct dsa_port		ports[DSA_MAX_PORTS];
200 201 202 203 204 205 206 207
	struct mii_bus		*slave_mii_bus;
};

static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
{
	return !!(ds->index == ds->dst->cpu_switch && p == ds->dst->cpu_port);
}

208 209 210 211 212
static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
{
	return !!((ds->dsa_port_mask) & (1 << p));
}

213 214
static inline bool dsa_is_port_initialized(struct dsa_switch *ds, int p)
{
215
	return ds->enabled_port_mask & (1 << p) && ds->ports[p].netdev;
216 217
}

218 219 220 221 222 223 224 225 226 227 228 229 230
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->index)
		return dst->cpu_port;
	else
231
		return ds->rtable[dst->cpu_switch];
232 233
}

234
struct switchdev_trans;
235
struct switchdev_obj;
236
struct switchdev_obj_port_fdb;
237
struct switchdev_obj_port_vlan;
238

239 240 241
struct dsa_switch_driver {
	struct list_head	list;

242
	enum dsa_tag_protocol	tag_protocol;
243 244 245 246

	/*
	 * Probing and setup.
	 */
247 248 249
	const char	*(*probe)(struct device *dsa_dev,
				  struct device *host_dev, int sw_addr,
				  void **priv);
250 251
	int	(*setup)(struct dsa_switch *ds);
	int	(*set_addr)(struct dsa_switch *ds, u8 *addr);
252
	u32	(*get_phy_flags)(struct dsa_switch *ds, int port);
253 254 255 256 257 258 259 260

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

261 262 263 264 265
	/*
	 * Link state adjustment (called from libphy)
	 */
	void	(*adjust_link)(struct dsa_switch *ds, int port,
				struct phy_device *phydev);
266 267
	void	(*fixed_link_update)(struct dsa_switch *ds, int port,
				struct fixed_phy_status *st);
268

269 270 271 272 273 274 275
	/*
	 * 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);
276

277 278 279 280 281 282 283 284
	/*
	 * 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);

285 286 287 288 289
	/*
	 * Suspend and resume
	 */
	int	(*suspend)(struct dsa_switch *ds);
	int	(*resume)(struct dsa_switch *ds);
290 291 292 293 294 295 296 297

	/*
	 * 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);
298 299 300 301 302 303 304 305 306

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

#ifdef CONFIG_NET_DSA_HWMON
	/* Hardware monitoring */
	int	(*get_temp)(struct dsa_switch *ds, int *temp);
	int	(*get_temp_limit)(struct dsa_switch *ds, int *temp);
	int	(*set_temp_limit)(struct dsa_switch *ds, int temp);
	int	(*get_temp_alarm)(struct dsa_switch *ds, bool *alarm);
#endif
315 316 317 318 319 320 321

	/* 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);
322 323 324 325 326 327 328

	/*
	 * 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);
329 330 331 332

	/*
	 * Bridge integration
	 */
333
	int	(*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
334
	int	(*port_bridge_join)(struct dsa_switch *ds, int port,
335
				    struct net_device *bridge);
336
	void	(*port_bridge_leave)(struct dsa_switch *ds, int port);
337 338
	void	(*port_stp_state_set)(struct dsa_switch *ds, int port,
				      u8 state);
339

340 341 342
	/*
	 * VLAN support
	 */
343 344
	int	(*port_vlan_filtering)(struct dsa_switch *ds, int port,
				       bool vlan_filtering);
345 346 347
	int	(*port_vlan_prepare)(struct dsa_switch *ds, int port,
				     const struct switchdev_obj_port_vlan *vlan,
				     struct switchdev_trans *trans);
348
	void	(*port_vlan_add)(struct dsa_switch *ds, int port,
349 350 351 352
				 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);
353 354 355
	int	(*port_vlan_dump)(struct dsa_switch *ds, int port,
				  struct switchdev_obj_port_vlan *vlan,
				  int (*cb)(struct switchdev_obj *obj));
356

357 358 359
	/*
	 * Forwarding database
	 */
360 361 362
	int	(*port_fdb_prepare)(struct dsa_switch *ds, int port,
				    const struct switchdev_obj_port_fdb *fdb,
				    struct switchdev_trans *trans);
363
	void	(*port_fdb_add)(struct dsa_switch *ds, int port,
364 365
				const struct switchdev_obj_port_fdb *fdb,
				struct switchdev_trans *trans);
366
	int	(*port_fdb_del)(struct dsa_switch *ds, int port,
367
				const struct switchdev_obj_port_fdb *fdb);
368 369 370
	int	(*port_fdb_dump)(struct dsa_switch *ds, int port,
				 struct switchdev_obj_port_fdb *fdb,
				 int (*cb)(struct switchdev_obj *obj));
371 372 373 374
};

void register_switch_driver(struct dsa_switch_driver *type);
void unregister_switch_driver(struct dsa_switch_driver *type);
375
struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev);
376

377 378
static inline void *ds_to_priv(struct dsa_switch *ds)
{
379
	return ds->priv;
380 381
}

382 383
static inline bool dsa_uses_tagged_protocol(struct dsa_switch_tree *dst)
{
384
	return dst->rcv != NULL;
385
}
386 387 388

void dsa_unregister_switch(struct dsa_switch *ds);
int dsa_register_switch(struct dsa_switch *ds, struct device_node *np);
389
#endif