[deliverable/linux.git] / include / net / dsa.h

/*
 * include/net/dsa.h - Driver for Distributed Switch Architecture switch chips
 * 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 __LINUX_NET_DSA_H
#define __LINUX_NET_DSA_H

#include <linux/if_ether.h>
#include <linux/list.h>
#include <linux/timer.h>
#include <linux/workqueue.h>
#include <linux/of.h>
#include <linux/phy.h>
#include <linux/phy_fixed.h>
#include <linux/ethtool.h>

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

#define DSA_MAX_SWITCHES	4
#define DSA_MAX_PORTS		12

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

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

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

	/*
	 * 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];
	struct device_node *port_dn[DSA_MAX_PORTS];

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

struct dsa_platform_data {
	/*
	 * Reference to a Linux network interface that connects
	 * to the root switch chip of the tree.
	 */
	struct device	*netdev;

	/*
	 * Info structs describing each of the switch chips
	 * connected via this network interface.
	 */
	int		nr_chips;
	struct dsa_chip_data	*chip;
};

struct packet_type;

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;
	int			(*rcv)(struct sk_buff *skb,
				       struct net_device *dev,
				       struct packet_type *pt,
				       struct net_device *orig_dev);
	enum dsa_tag_protocol	tag_protocol;

	/*
	 * The switch and port to which the CPU is attached.
	 */
	s8			cpu_switch;
	s8			cpu_port;

	/*
	 * Link state polling.
	 */
	int			link_poll_needed;
	struct work_struct	link_poll_work;
	struct timer_list	link_poll_timer;

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

struct dsa_switch {
	/*
	 * Parent switch tree, and switch index.
	 */
	struct dsa_switch_tree	*dst;
	int			index;

	/*
	 * Configuration data for this switch.
	 */
	struct dsa_chip_data	*pd;

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

	/*
	 * Reference to host device to use.
	 */
	struct device		*master_dev;

#ifdef CONFIG_NET_DSA_HWMON
	/*
	 * Hardware monitoring information
	 */
	char			hwmon_name[IFNAMSIZ + 8];
	struct device		*hwmon_dev;
#endif

	/*
	 * Slave mii_bus and devices for the individual ports.
	 */
	u32			dsa_port_mask;
	u32			phys_port_mask;
	u32			phys_mii_mask;
	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);
}

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

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

struct dsa_switch_driver {
	struct list_head	list;

	enum dsa_tag_protocol	tag_protocol;
	int			priv_size;

	/*
	 * Probing and setup.
	 */
	char	*(*probe)(struct device *host_dev, int sw_addr);
	int	(*setup)(struct dsa_switch *ds);
	int	(*set_addr)(struct dsa_switch *ds, u8 *addr);
	u32	(*get_phy_flags)(struct dsa_switch *ds, int port);

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

	/*
	 * Link state polling and IRQ handling.
	 */
	void	(*poll_link)(struct dsa_switch *ds);

	/*
	 * Link state adjustment (called from libphy)
	 */
	void	(*adjust_link)(struct dsa_switch *ds, int port,
				struct phy_device *phydev);
	void	(*fixed_link_update)(struct dsa_switch *ds, int port,
				struct fixed_phy_status *st);

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

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

	/*
	 * Suspend and resume
	 */
	int	(*suspend)(struct dsa_switch *ds);
	int	(*resume)(struct dsa_switch *ds);

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

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

#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

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

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

	/*
	 * Bridge integration
	 */
	int	(*port_join_bridge)(struct dsa_switch *ds, int port,
				    u32 br_port_mask);
	int	(*port_leave_bridge)(struct dsa_switch *ds, int port,
				     u32 br_port_mask);
	int	(*port_stp_update)(struct dsa_switch *ds, int port,
				   u8 state);
};

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

static inline void *ds_to_priv(struct dsa_switch *ds)
{
	return (void *)(ds + 1);
}

static inline bool dsa_uses_tagged_protocol(struct dsa_switch_tree *dst)
{
	return dst->rcv != NULL;
}
#endif
Commit	Line	Data
91da11f8 LB	1	/*
91da11f8 LB	2	* include/net/dsa.h - Driver for Distributed Switch Architecture switch chips
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 __LINUX_NET_DSA_H
	12	#define __LINUX_NET_DSA_H
	13
ea1f51be	14	#include <linux/if_ether.h>
c8f0b869	15	#include <linux/list.h>
cf50dcc2 BH	16	#include <linux/timer.h>
cf50dcc2 BH	17	#include <linux/workqueue.h>
fa981d9a	18	#include <linux/of.h>
ec9436ba	19	#include <linux/phy.h>
ce31b31c	20	#include <linux/phy_fixed.h>
a2820543	21	#include <linux/ethtool.h>
cf50dcc2	22
ac7a04c3 FF	23	enum dsa_tag_protocol {
	24	DSA_TAG_PROTO_NONE = 0,
	25	DSA_TAG_PROTO_DSA,
	26	DSA_TAG_PROTO_TRAILER,
	27	DSA_TAG_PROTO_EDSA,
	28	DSA_TAG_PROTO_BRCM,
	29	};
5037d532	30
e84665c9 LB	31	#define DSA_MAX_SWITCHES 4
	32	#define DSA_MAX_PORTS 12
	33
	34	struct dsa_chip_data {
	35	/*
	36	* How to access the switch configuration registers.
	37	*/
b4d2394d	38	struct device *host_dev;
e84665c9 LB	39	int sw_addr;
e84665c9 LB	40
6793abb4 GR	41	/* set to size of eeprom if supported by the switch */
	42	int eeprom_len;
	43
fa981d9a FF	44	/* Device tree node pointer for this specific switch chip
	45	* used during switch setup in case additional properties
	46	* and resources needs to be used
	47	*/
	48	struct device_node *of_node;
	49
e84665c9 LB	50	/*
	51	* The names of the switch's ports. Use "cpu" to
	52	* designate the switch port that the cpu is connected to,
	53	* "dsa" to indicate that this port is a DSA link to
	54	* another switch, NULL to indicate the port is unused,
	55	* or any other string to indicate this is a physical port.
	56	*/
	57	char *port_names[DSA_MAX_PORTS];
bd47497a	58	struct device_node *port_dn[DSA_MAX_PORTS];
e84665c9 LB	59
	60	/*
	61	* An array (with nr_chips elements) of which element [a]
	62	* indicates which port on this switch should be used to
	63	* send packets to that are destined for switch a. Can be
	64	* NULL if there is only one switch chip.
	65	*/
	66	s8 *rtable;
	67	};
91da11f8 LB	68
	69	struct dsa_platform_data {
	70	/*
	71	* Reference to a Linux network interface that connects
e84665c9	72	* to the root switch chip of the tree.
91da11f8 LB	73	*/
	74	struct device *netdev;
	75
	76	/*
e84665c9 LB	77	* Info structs describing each of the switch chips
e84665c9 LB	78	* connected via this network interface.
91da11f8	79	*/
e84665c9 LB	80	int nr_chips;
e84665c9 LB	81	struct dsa_chip_data *chip;
91da11f8 LB	82	};
91da11f8 LB	83
5075314e	84	struct packet_type;
3e8a72d1	85
cf50dcc2 BH	86	struct dsa_switch_tree {
	87	/*
	88	* Configuration data for the platform device that owns
	89	* this dsa switch tree instance.
	90	*/
	91	struct dsa_platform_data *pd;
	92
	93	/*
	94	* Reference to network device to use, and which tagging
	95	* protocol to use.
	96	*/
	97	struct net_device *master_netdev;
5075314e AD	98	int (rcv)(struct sk_buff skb,
	99	struct net_device *dev,
	100	struct packet_type *pt,
	101	struct net_device *orig_dev);
ac7a04c3	102	enum dsa_tag_protocol tag_protocol;
cf50dcc2 BH	103
	104	/*
	105	* The switch and port to which the CPU is attached.
	106	*/
	107	s8 cpu_switch;
	108	s8 cpu_port;
	109
	110	/*
	111	* Link state polling.
	112	*/
	113	int link_poll_needed;
	114	struct work_struct link_poll_work;
	115	struct timer_list link_poll_timer;
	116
	117	/*
	118	* Data for the individual switch chips.
	119	*/
	120	struct dsa_switch *ds[DSA_MAX_SWITCHES];
	121	};
	122
c8f0b869 BH	123	struct dsa_switch {
	124	/*
	125	* Parent switch tree, and switch index.
	126	*/
	127	struct dsa_switch_tree *dst;
	128	int index;
	129
	130	/*
	131	* Configuration data for this switch.
	132	*/
	133	struct dsa_chip_data *pd;
	134
	135	/*
	136	* The used switch driver.
	137	*/
	138	struct dsa_switch_driver *drv;
	139
	140	/*
b4d2394d	141	* Reference to host device to use.
c8f0b869	142	*/
b4d2394d	143	struct device *master_dev;
c8f0b869	144
51579c3f GR	145	#ifdef CONFIG_NET_DSA_HWMON
	146	/*
	147	* Hardware monitoring information
	148	*/
	149	char hwmon_name[IFNAMSIZ + 8];
	150	struct device *hwmon_dev;
	151	#endif
	152
c8f0b869 BH	153	/*
	154	* Slave mii_bus and devices for the individual ports.
	155	*/
	156	u32 dsa_port_mask;
	157	u32 phys_port_mask;
0d8bcdd3	158	u32 phys_mii_mask;
c8f0b869 BH	159	struct mii_bus *slave_mii_bus;
	160	struct net_device *ports[DSA_MAX_PORTS];
	161	};
	162
	163	static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p)
	164	{
	165	return !!(ds->index == ds->dst->cpu_switch && p == ds->dst->cpu_port);
	166	}
	167
d79d2107 GR	168	static inline bool dsa_is_port_initialized(struct dsa_switch *ds, int p)
	169	{
	170	return ds->phys_port_mask & (1 << p) && ds->ports[p];
	171	}
	172
c8f0b869 BH	173	static inline u8 dsa_upstream_port(struct dsa_switch *ds)
	174	{
	175	struct dsa_switch_tree *dst = ds->dst;
	176
	177	/*
	178	* If this is the root switch (i.e. the switch that connects
	179	* to the CPU), return the cpu port number on this switch.
	180	* Else return the (DSA) port number that connects to the
	181	* switch that is one hop closer to the cpu.
	182	*/
	183	if (dst->cpu_switch == ds->index)
	184	return dst->cpu_port;
	185	else
	186	return ds->pd->rtable[dst->cpu_switch];
	187	}
	188
	189	struct dsa_switch_driver {
	190	struct list_head list;
	191
ac7a04c3	192	enum dsa_tag_protocol tag_protocol;
c8f0b869 BH	193	int priv_size;
	194
	195	/*
	196	* Probing and setup.
	197	*/
b4d2394d	198	char (probe)(struct device *host_dev, int sw_addr);
c8f0b869 BH	199	int (setup)(struct dsa_switch ds);
c8f0b869 BH	200	int (set_addr)(struct dsa_switch ds, u8 *addr);
6819563e	201	u32 (get_phy_flags)(struct dsa_switch ds, int port);
c8f0b869 BH	202
	203	/*
	204	* Access to the switch's PHY registers.
	205	*/
	206	int (phy_read)(struct dsa_switch ds, int port, int regnum);
	207	int (phy_write)(struct dsa_switch ds, int port,
	208	int regnum, u16 val);
	209
	210	/*
	211	* Link state polling and IRQ handling.
	212	*/
	213	void (poll_link)(struct dsa_switch ds);
	214
ec9436ba FF	215	/*
	216	* Link state adjustment (called from libphy)
	217	*/
	218	void (adjust_link)(struct dsa_switch ds, int port,
	219	struct phy_device *phydev);
ce31b31c FF	220	void (fixed_link_update)(struct dsa_switch ds, int port,
ce31b31c FF	221	struct fixed_phy_status *st);
ec9436ba	222
c8f0b869 BH	223	/*
	224	* ethtool hardware statistics.
	225	*/
	226	void (get_strings)(struct dsa_switch ds, int port, uint8_t *data);
	227	void (get_ethtool_stats)(struct dsa_switch ds,
	228	int port, uint64_t *data);
	229	int (get_sset_count)(struct dsa_switch ds);
24462549	230
19e57c4e FF	231	/*
	232	* ethtool Wake-on-LAN
	233	*/
	234	void (get_wol)(struct dsa_switch ds, int port,
	235	struct ethtool_wolinfo *w);
	236	int (set_wol)(struct dsa_switch ds, int port,
	237	struct ethtool_wolinfo *w);
	238
24462549 FF	239	/*
	240	* Suspend and resume
	241	*/
	242	int (suspend)(struct dsa_switch ds);
	243	int (resume)(struct dsa_switch ds);
b2f2af21 FF	244
	245	/*
	246	* Port enable/disable
	247	*/
	248	int (port_enable)(struct dsa_switch ds, int port,
	249	struct phy_device *phy);
	250	void (port_disable)(struct dsa_switch ds, int port,
	251	struct phy_device *phy);
7905288f FF	252
	253	/*
	254	* EEE setttings
	255	*/
	256	int (set_eee)(struct dsa_switch ds, int port,
	257	struct phy_device *phydev,
	258	struct ethtool_eee *e);
	259	int (get_eee)(struct dsa_switch ds, int port,
	260	struct ethtool_eee *e);
51579c3f GR	261
	262	#ifdef CONFIG_NET_DSA_HWMON
	263	/* Hardware monitoring */
	264	int (get_temp)(struct dsa_switch ds, int *temp);
	265	int (get_temp_limit)(struct dsa_switch ds, int *temp);
	266	int (set_temp_limit)(struct dsa_switch ds, int temp);
	267	int (get_temp_alarm)(struct dsa_switch ds, bool *alarm);
	268	#endif
6793abb4 GR	269
	270	/* EEPROM access */
	271	int (get_eeprom_len)(struct dsa_switch ds);
	272	int (get_eeprom)(struct dsa_switch ds,
	273	struct ethtool_eeprom eeprom, u8 data);
	274	int (set_eeprom)(struct dsa_switch ds,
	275	struct ethtool_eeprom eeprom, u8 data);
3d762a0f GR	276
	277	/*
	278	* Register access.
	279	*/
	280	int (get_regs_len)(struct dsa_switch ds, int port);
	281	void (get_regs)(struct dsa_switch ds, int port,
	282	struct ethtool_regs regs, void p);
b73adef6 FF	283
	284	/*
	285	* Bridge integration
	286	*/
	287	int (port_join_bridge)(struct dsa_switch ds, int port,
	288	u32 br_port_mask);
	289	int (port_leave_bridge)(struct dsa_switch ds, int port,
	290	u32 br_port_mask);
	291	int (port_stp_update)(struct dsa_switch ds, int port,
	292	u8 state);
c8f0b869 BH	293	};
	294
	295	void register_switch_driver(struct dsa_switch_driver *type);
	296	void unregister_switch_driver(struct dsa_switch_driver *type);
b4d2394d	297	struct mii_bus dsa_host_dev_to_mii_bus(struct device dev);
c8f0b869	298
7fa857ed FF	299	static inline void ds_to_priv(struct dsa_switch ds)
	300	{
	301	return (void *)(ds + 1);
	302	}
	303
5aed85ce FF	304	static inline bool dsa_uses_tagged_protocol(struct dsa_switch_tree *dst)
5aed85ce FF	305	{
5075314e	306	return dst->rcv != NULL;
5aed85ce	307	}
91da11f8	308	#endif