Release 4.16 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.h>
#include <linux/if_ether.h>
#include <linux/list.h>
#include <linux/notifier.h>
#include <linux/timer.h>
#include <linux/workqueue.h>
#include <linux/of.h>
#include <linux/ethtool.h>
#include <net/devlink.h>
#include <net/switchdev.h>

struct tc_action;
struct phy_device;
struct fixed_phy_status;


enum dsa_tag_protocol {
	
DSA_TAG_PROTO_NONE = 0,
	
DSA_TAG_PROTO_BRCM,
	
DSA_TAG_PROTO_BRCM_PREPEND,
	
DSA_TAG_PROTO_DSA,
	
DSA_TAG_PROTO_EDSA,
	
DSA_TAG_PROTO_KSZ,
	
DSA_TAG_PROTO_LAN9303,
	
DSA_TAG_PROTO_MTK,
	
DSA_TAG_PROTO_QCA,
	
DSA_TAG_PROTO_TRAILER,
	
DSA_TAG_LAST,		/* MUST BE LAST */
};


#define DSA_MAX_SWITCHES	4

#define DSA_MAX_PORTS		12


#define DSA_RTABLE_NONE		-1


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

	/*
         * Reference to network devices
         */
	
struct device	*netdev[DSA_MAX_PORTS];

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


struct dsa_platform_data {
	/*
         * Reference to a Linux network interface that connects
         * to the root switch chip of the tree.
         */
	
struct device	*netdev;
	
struct net_device *of_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_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,
			       struct packet_type *pt);
	
int (*flow_dissect)(const struct sk_buff *skb, __be16 *proto,
			    int *offset);
};


struct dsa_switch_tree {
	
struct list_head	list;

	/* Notifier chain for switch-wide events */
	
struct raw_notifier_head	nh;

	/* Tree identifier */
	
unsigned int index;

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

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

	/*
         * Configuration data for the platform device that owns
         * this dsa switch tree instance.
         */
	
struct dsa_platform_data	*pd;

	/*
         * The switch port to which the CPU is attached.
         */
	
struct dsa_port		*cpu_dp;

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

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



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

	/* CPU port tagging operations used by master or slave devices */
	
const struct dsa_device_ops *tag_ops;

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

	
enum {
		
DSA_PORT_TYPE_UNUSED = 0,
		
DSA_PORT_TYPE_CPU,
		
DSA_PORT_TYPE_DSA,
		
DSA_PORT_TYPE_USER,
        } 
type;

	
struct dsa_switch	*ds;
	
unsigned int		index;
	
const char		*name;
	
const struct dsa_port	*cpu_dp;
	
struct device_node	*dn;
	
unsigned int		ageing_time;
	
u8			stp_state;
	
struct net_device	*bridge_dev;
	
struct devlink_port	devlink_port;
	/*
         * Original copy of the master netdev ethtool_ops
         */
	
const struct ethtool_ops *orig_ethtool_ops;
};


struct dsa_switch {
	
struct device *dev;

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

	/* Listener for switch fabric events */
	
struct notifier_block	nb;

	/*
         * Give the switch driver somewhere to hang its private data
         * structure.
         */
	
void *priv;

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

	/*
         * The switch operations.
         */
	
const struct dsa_switch_ops	*ops;

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

	/*
         * Slave mii_bus and devices for the individual ports.
         */
	
u32			phys_mii_mask;
	
struct mii_bus		*slave_mii_bus;

	/* Ageing Time limits in msecs */
	
unsigned int ageing_time_min;
	
unsigned int ageing_time_max;

	/* devlink used to represent this switch device */
	
struct devlink		*devlink;

	/* Number of switch port queues */
	
unsigned int		num_tx_queues;

	/* Dynamically allocated ports, keep last */
	
size_t num_ports;
	
struct dsa_port ports[];
};



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

Contributors
Person
Tokens
Prop
Commits
CommitProp
Vivien Didelot
27
100.00%
2
100.00%
Total
27
100.00%
2
100.00%



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

Contributors
Person
Tokens
Prop
Commits
CommitProp
Ben Hutchings
17
62.96%
1
33.33%
Vivien Didelot
10
37.04%
2
66.67%
Total
27
100.00%
3
100.00%



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

Contributors
Person
Tokens
Prop
Commits
CommitProp
Andrew Lunn
18
66.67%
1
50.00%
Vivien Didelot
9
33.33%
1
50.00%
Total
27
100.00%
2
100.00%



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

Contributors
Person
Tokens
Prop
Commits
CommitProp
Vivien Didelot
27
100.00%
3
100.00%
Total
27
100.00%
3
100.00%



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

Contributors
Person
Tokens
Prop
Commits
CommitProp
Vivien Didelot
27
100.00%
2
100.00%
Total
27
100.00%
2
100.00%



static inline u32 dsa_user_ports(struct dsa_switch *ds)
{
	u32 mask = 0;
	int p;

	for (p = 0; p < ds->num_ports; p++)
		if (dsa_is_user_port(ds, p))
			mask |= BIT(p);

	return mask;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Vivien Didelot
54
100.00%
2
100.00%
Total
54
100.00%
2
100.00%

/* Return the local port used to reach an arbitrary switch port */


static inline unsigned int dsa_towards_port(struct dsa_switch *ds, int device,
					    int port)
{
	if (device == ds->index)
		return port;
	else
		return ds->rtable[device];
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Vivien Didelot
39
100.00%
1
100.00%
Total
39
100.00%
1
100.00%

/* Return the local port used to reach the dedicated CPU port */


static inline unsigned int dsa_upstream_port(struct dsa_switch *ds, int port)
{
	const struct dsa_port *dp = dsa_to_port(ds, port);
	const struct dsa_port *cpu_dp = dp->cpu_dp;

	if (!cpu_dp)
		return port;

	return dsa_towards_port(ds, cpu_dp->ds->index, cpu_dp->index);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Vivien Didelot
43
68.25%
4
80.00%
Ben Hutchings
20
31.75%
1
20.00%
Total
63
100.00%
5
100.00%

typedef int dsa_fdb_dump_cb_t(const unsigned char *addr, u16 vid,
			      
bool is_static, void *data);

struct dsa_switch_ops {
#if IS_ENABLED(CONFIG_NET_DSA_LEGACY)
	/*
         * Legacy probing.
         */
	
const char	*(*probe)(struct device *dsa_dev,
				  struct device *host_dev, int sw_addr,
				  void **priv);
#endif

	
enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds,
						  int port);

	
int	(*setup)(struct dsa_switch *ds);
	
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 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);

	/*
         * Port's MAC EEE settings
         */
	
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);

	/* 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	(*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs);
	
int	(*port_bridge_join)(struct dsa_switch *ds, int port,
				    struct net_device *bridge);
	
void	(*port_bridge_leave)(struct dsa_switch *ds, int port,
				     struct net_device *bridge);
	
void	(*port_stp_state_set)(struct dsa_switch *ds, int port,
				      u8 state);
	
void	(*port_fast_age)(struct dsa_switch *ds, int port);

	/*
         * VLAN support
         */
	
int	(*port_vlan_filtering)(struct dsa_switch *ds, int port,
				       bool vlan_filtering);
	
int (*port_vlan_prepare)(struct dsa_switch *ds, int port,
				 const struct switchdev_obj_port_vlan *vlan);
	
void (*port_vlan_add)(struct dsa_switch *ds, int port,
			      const struct switchdev_obj_port_vlan *vlan);
	
int	(*port_vlan_del)(struct dsa_switch *ds, int port,
				 const struct switchdev_obj_port_vlan *vlan);
	/*
         * Forwarding database
         */
	
int	(*port_fdb_add)(struct dsa_switch *ds, int port,
				const unsigned char *addr, u16 vid);
	
int	(*port_fdb_del)(struct dsa_switch *ds, int port,
				const unsigned char *addr, u16 vid);
	
int	(*port_fdb_dump)(struct dsa_switch *ds, int port,
				 dsa_fdb_dump_cb_t *cb, void *data);

	/*
         * Multicast database
         */
	
int (*port_mdb_prepare)(struct dsa_switch *ds, int port,
				const struct switchdev_obj_port_mdb *mdb);
	
void (*port_mdb_add)(struct dsa_switch *ds, int port,
			     const struct switchdev_obj_port_mdb *mdb);
	
int	(*port_mdb_del)(struct dsa_switch *ds, int port,
				const struct switchdev_obj_port_mdb *mdb);
	/*
         * 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);

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

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


struct dsa_switch_driver {
	
struct list_head	list;
	
const struct dsa_switch_ops *ops;
};

#if IS_ENABLED(CONFIG_NET_DSA_LEGACY)
/* Legacy driver registration */
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);

#else


static inline void register_switch_driver(struct dsa_switch_driver *type) { }
Contributors
Person
Tokens
Prop
Commits
CommitProp
Florian Fainelli
11
100.00%
1
100.00%
Total
11
100.00%
1
100.00%



static inline void unregister_switch_driver(struct dsa_switch_driver *type) { }
Contributors
Person
Tokens
Prop
Commits
CommitProp
Florian Fainelli
11
100.00%
1
100.00%
Total
11
100.00%
1
100.00%



static inline struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev)
{
	return NULL;
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
Florian Fainelli
17
100.00%
1
100.00%
Total
17
100.00%
1
100.00%

#endif
struct net_device *dsa_dev_to_net_device(struct device *dev);

/* Keep inline for faster access in hot path */


static inline bool netdev_uses_dsa(struct net_device *dev)
{
#if IS_ENABLED(CONFIG_NET_DSA)
	return dev->dsa_ptr && dev->dsa_ptr->rcv;
#endif
	return false;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Andrew Lunn
30
88.24%
1
50.00%
Vivien Didelot
4
11.76%
1
50.00%
Total
34
100.00%
2
100.00%

struct dsa_switch *dsa_switch_alloc(struct device *dev, size_t n);
void dsa_unregister_switch(struct dsa_switch *ds);
int dsa_register_switch(struct dsa_switch *ds);
#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;
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
Florian Fainelli
15
100.00%
1
100.00%
Total
15
100.00%
1
100.00%



static inline int dsa_switch_resume(struct dsa_switch *ds)
{
	return 0;
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
Florian Fainelli
15
100.00%
1
100.00%
Total
15
100.00%
1
100.00%

#endif /* CONFIG_PM_SLEEP */


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

Contributors
Person
Tokens
Prop
Commits
CommitProp
Florian Fainelli
20
100.00%
1
100.00%
Total
20
100.00%
1
100.00%

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

Contributors
Person
Tokens
Prop
Commits
CommitProp
Florian Fainelli
15
100.00%
1
100.00%
Total
15
100.00%
1
100.00%



static inline int unregister_dsa_notifier(struct notifier_block *nb)
{
	return 0;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Florian Fainelli
15
100.00%
1
100.00%
Total
15
100.00%
1
100.00%



static inline int call_dsa_notifiers(unsigned long val, struct net_device *dev,
				     struct dsa_notifier_info *info)
{
	return NOTIFY_DONE;
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
Florian Fainelli
24
100.00%
1
100.00%
Total
24
100.00%
1
100.00%

#endif

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

#endif
Overall Contributors
Person
Tokens
Prop
Commits
CommitProp
Florian Fainelli
788
36.25%
30
26.55%
Vivien Didelot
665
30.59%
47
41.59%
Ben Hutchings
227
10.44%
2
1.77%
Andrew Lunn
163
7.50%
15
13.27%
Guenter Roeck
128
5.89%
3
2.65%
John Crispin
70
3.22%
3
2.65%
Lennert Buytenhek
61
2.81%
2
1.77%
Arkadi Sharshevsky
37
1.70%
3
2.65%
Alexander Duyck
15
0.69%
2
1.77%
Russell King
9
0.41%
1
0.88%
Axel Lin
3
0.14%
1
0.88%
David S. Miller
3
0.14%
1
0.88%
Sean Wang
2
0.09%
1
0.88%
Woojung Huh
2
0.09%
1
0.88%
Juergen Beisert (or Jourgen Borleis)
1
0.05%
1
0.88%
Total
2174
100.00%
113
100.00%
Directory: include/net

Information contained on this website is for historical information purposes only and does not indicate or represent copyright ownership.