dsa.h 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_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/of_gpio.h>
20
#include <linux/phy.h>
21
#include <linux/phy_fixed.h>
22
#include <linux/ethtool.h>
23

24 25 26 27 28 29 30
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,
};
31

32 33 34 35 36 37 38
#define DSA_MAX_SWITCHES	4
#define DSA_MAX_PORTS		12

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

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

45 46 47 48 49 50
	/* 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;

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

	/*
	 * An array (with nr_chips elements) 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;
68 69 70 71 72 73 74

	/*
	 * A switch may have a GPIO line tied to its reset pin. Parse
	 * this from the device tree, and use it before performing
	 * switch soft reset.
	 */
	struct gpio_desc *reset;
75
};
76 77 78 79

struct dsa_platform_data {
	/*
	 * Reference to a Linux network interface that connects
80
	 * to the root switch chip of the tree.
81 82
	 */
	struct device	*netdev;
83
	struct net_device *of_netdev;
84 85

	/*
86 87
	 * Info structs describing each of the switch chips
	 * connected via this network interface.
88
	 */
89 90
	int		nr_chips;
	struct dsa_chip_data	*chip;
91 92
};

93
struct packet_type;
94

95 96 97 98 99 100 101 102 103 104 105 106
struct dsa_switch_tree {
	/*
	 * 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;
107 108 109 110
	int			(*rcv)(struct sk_buff *skb,
				       struct net_device *dev,
				       struct packet_type *pt,
				       struct net_device *orig_dev);
111
	enum dsa_tag_protocol	tag_protocol;
112 113 114 115 116 117 118 119 120 121 122 123 124

	/*
	 * 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];
};

125 126 127 128 129 130 131
struct dsa_switch {
	/*
	 * Parent switch tree, and switch index.
	 */
	struct dsa_switch_tree	*dst;
	int			index;

132 133 134 135 136
	/*
	 * Tagging protocol understood by this switch
	 */
	enum dsa_tag_protocol	tag_protocol;

137 138 139 140 141 142 143 144 145 146 147
	/*
	 * Configuration data for this switch.
	 */
	struct dsa_chip_data	*pd;

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

	/*
148
	 * Reference to host device to use.
149
	 */
150
	struct device		*master_dev;
151

152 153 154 155 156 157 158 159
#ifdef CONFIG_NET_DSA_HWMON
	/*
	 * Hardware monitoring information
	 */
	char			hwmon_name[IFNAMSIZ + 8];
	struct device		*hwmon_dev;
#endif

160 161 162 163 164
	/*
	 * Slave mii_bus and devices for the individual ports.
	 */
	u32			dsa_port_mask;
	u32			phys_port_mask;
165
	u32			phys_mii_mask;
166 167 168 169 170 171 172 173 174
	struct mii_bus		*slave_mii_bus;
	struct net_device	*ports[DSA_MAX_PORTS];
};

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

175 176 177 178 179
static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p)
{
	return !!((ds->dsa_port_mask) & (1 << p));
}

180 181 182 183 184
static inline bool dsa_is_port_initialized(struct dsa_switch *ds, int p)
{
	return ds->phys_port_mask & (1 << p) && ds->ports[p];
}

185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
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
		return ds->pd->rtable[dst->cpu_switch];
}

201
struct switchdev_trans;
202
struct switchdev_obj;
203
struct switchdev_obj_port_fdb;
204
struct switchdev_obj_port_vlan;
205

206 207 208
struct dsa_switch_driver {
	struct list_head	list;

209
	enum dsa_tag_protocol	tag_protocol;
210 211 212 213 214
	int			priv_size;

	/*
	 * Probing and setup.
	 */
215 216
	char	*(*probe)(struct device *dsa_dev, struct device *host_dev,
			  int sw_addr);
217 218
	int	(*setup)(struct dsa_switch *ds);
	int	(*set_addr)(struct dsa_switch *ds, u8 *addr);
219
	u32	(*get_phy_flags)(struct dsa_switch *ds, int port);
220 221 222 223 224 225 226 227

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

228 229 230 231 232
	/*
	 * Link state adjustment (called from libphy)
	 */
	void	(*adjust_link)(struct dsa_switch *ds, int port,
				struct phy_device *phydev);
233 234
	void	(*fixed_link_update)(struct dsa_switch *ds, int port,
				struct fixed_phy_status *st);
235

236 237 238 239 240 241 242
	/*
	 * 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);
243

244 245 246 247 248 249 250 251
	/*
	 * 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);

252 253 254 255 256
	/*
	 * Suspend and resume
	 */
	int	(*suspend)(struct dsa_switch *ds);
	int	(*resume)(struct dsa_switch *ds);
257 258 259 260 261 262 263 264

	/*
	 * 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);
265 266 267 268 269 270 271 272 273

	/*
	 * 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);
274 275 276 277 278 279 280 281

#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
282 283 284 285 286 287 288

	/* 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);
289 290 291 292 293 294 295

	/*
	 * 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);
296 297 298 299

	/*
	 * Bridge integration
	 */
300
	int	(*port_bridge_join)(struct dsa_switch *ds, int port,
301
				    struct net_device *bridge);
302
	void	(*port_bridge_leave)(struct dsa_switch *ds, int port);
303 304
	void	(*port_stp_state_set)(struct dsa_switch *ds, int port,
				      u8 state);
305

306 307 308
	/*
	 * VLAN support
	 */
309 310
	int	(*port_vlan_filtering)(struct dsa_switch *ds, int port,
				       bool vlan_filtering);
311 312 313
	int	(*port_vlan_prepare)(struct dsa_switch *ds, int port,
				     const struct switchdev_obj_port_vlan *vlan,
				     struct switchdev_trans *trans);
314
	void	(*port_vlan_add)(struct dsa_switch *ds, int port,
315 316 317 318
				 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);
319 320 321
	int	(*port_vlan_dump)(struct dsa_switch *ds, int port,
				  struct switchdev_obj_port_vlan *vlan,
				  int (*cb)(struct switchdev_obj *obj));
322

323 324 325
	/*
	 * Forwarding database
	 */
326 327 328
	int	(*port_fdb_prepare)(struct dsa_switch *ds, int port,
				    const struct switchdev_obj_port_fdb *fdb,
				    struct switchdev_trans *trans);
329
	void	(*port_fdb_add)(struct dsa_switch *ds, int port,
330 331
				const struct switchdev_obj_port_fdb *fdb,
				struct switchdev_trans *trans);
332
	int	(*port_fdb_del)(struct dsa_switch *ds, int port,
333
				const struct switchdev_obj_port_fdb *fdb);
334 335 336
	int	(*port_fdb_dump)(struct dsa_switch *ds, int port,
				 struct switchdev_obj_port_fdb *fdb,
				 int (*cb)(struct switchdev_obj *obj));
337 338 339 340
};

void register_switch_driver(struct dsa_switch_driver *type);
void unregister_switch_driver(struct dsa_switch_driver *type);
341
struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev);
342

Florian Fainelli's avatar
Florian Fainelli committed
343 344 345 346 347
static inline void *ds_to_priv(struct dsa_switch *ds)
{
	return (void *)(ds + 1);
}

348 349
static inline bool dsa_uses_tagged_protocol(struct dsa_switch_tree *dst)
{
350
	return dst->rcv != NULL;
351
}
352
#endif