[mirror_ubuntu-artful-kernel.git] / net / hsr / hsr_device.c

/* Copyright 2011-2014 Autronica Fire and Security AS
 *
 * 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.
 *
 * Author(s):
 *	2011-2014 Arvid Brodin, arvid.brodin@alten.se
 *
 * This file contains device methods for creating, using and destroying
 * virtual HSR devices.
 */

#include <linux/netdevice.h>
#include <linux/skbuff.h>
#include <linux/etherdevice.h>
#include <linux/rtnetlink.h>
#include <linux/pkt_sched.h>
#include "hsr_device.h"
#include "hsr_slave.h"
#include "hsr_framereg.h"
#include "hsr_main.h"
#include "hsr_forward.h"


static bool is_admin_up(struct net_device *dev)
{
	return dev && (dev->flags & IFF_UP);
}

static bool is_slave_up(struct net_device *dev)
{
	return dev && is_admin_up(dev) && netif_oper_up(dev);
}

static void __hsr_set_operstate(struct net_device *dev, int transition)
{
	write_lock_bh(&dev_base_lock);
	if (dev->operstate != transition) {
		dev->operstate = transition;
		write_unlock_bh(&dev_base_lock);
		netdev_state_change(dev);
	} else {
		write_unlock_bh(&dev_base_lock);
	}
}

static void hsr_set_operstate(struct hsr_port *master, bool has_carrier)
{
	if (!is_admin_up(master->dev)) {
		__hsr_set_operstate(master->dev, IF_OPER_DOWN);
		return;
	}

	if (has_carrier)
		__hsr_set_operstate(master->dev, IF_OPER_UP);
	else
		__hsr_set_operstate(master->dev, IF_OPER_LOWERLAYERDOWN);
}

static bool hsr_check_carrier(struct hsr_port *master)
{
	struct hsr_port *port;
	bool has_carrier;

	has_carrier = false;

	rcu_read_lock();
	hsr_for_each_port(master->hsr, port)
		if ((port->type != HSR_PT_MASTER) && is_slave_up(port->dev)) {
			has_carrier = true;
			break;
		}
	rcu_read_unlock();

	if (has_carrier)
		netif_carrier_on(master->dev);
	else
		netif_carrier_off(master->dev);

	return has_carrier;
}


static void hsr_check_announce(struct net_device *hsr_dev,
			       unsigned char old_operstate)
{
	struct hsr_priv *hsr;

	hsr = netdev_priv(hsr_dev);

	if ((hsr_dev->operstate == IF_OPER_UP)
			&& (old_operstate != IF_OPER_UP)) {
		/* Went up */
		hsr->announce_count = 0;
		hsr->announce_timer.expires = jiffies +
				msecs_to_jiffies(HSR_ANNOUNCE_INTERVAL);
		add_timer(&hsr->announce_timer);
	}

	if ((hsr_dev->operstate != IF_OPER_UP) && (old_operstate == IF_OPER_UP))
		/* Went down */
		del_timer(&hsr->announce_timer);
}

void hsr_check_carrier_and_operstate(struct hsr_priv *hsr)
{
	struct hsr_port *master;
	unsigned char old_operstate;
	bool has_carrier;

	master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
	/* netif_stacked_transfer_operstate() cannot be used here since
	 * it doesn't set IF_OPER_LOWERLAYERDOWN (?)
	 */
	old_operstate = master->dev->operstate;
	has_carrier = hsr_check_carrier(master);
	hsr_set_operstate(master, has_carrier);
	hsr_check_announce(master->dev, old_operstate);
}

int hsr_get_max_mtu(struct hsr_priv *hsr)
{
	unsigned int mtu_max;
	struct hsr_port *port;

	mtu_max = ETH_DATA_LEN;
	rcu_read_lock();
	hsr_for_each_port(hsr, port)
		if (port->type != HSR_PT_MASTER)
			mtu_max = min(port->dev->mtu, mtu_max);
	rcu_read_unlock();

	if (mtu_max < HSR_HLEN)
		return 0;
	return mtu_max - HSR_HLEN;
}


static int hsr_dev_change_mtu(struct net_device *dev, int new_mtu)
{
	struct hsr_priv *hsr;
	struct hsr_port *master;

	hsr = netdev_priv(dev);
	master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);

	if (new_mtu > hsr_get_max_mtu(hsr)) {
		netdev_info(master->dev, "A HSR master's MTU cannot be greater than the smallest MTU of its slaves minus the HSR Tag length (%d octets).\n",
			    HSR_HLEN);
		return -EINVAL;
	}

	dev->mtu = new_mtu;

	return 0;
}

static int hsr_dev_open(struct net_device *dev)
{
	struct hsr_priv *hsr;
	struct hsr_port *port;
	char designation;

	hsr = netdev_priv(dev);
	designation = '\0';

	rcu_read_lock();
	hsr_for_each_port(hsr, port) {
		if (port->type == HSR_PT_MASTER)
			continue;
		switch (port->type) {
		case HSR_PT_SLAVE_A:
			designation = 'A';
			break;
		case HSR_PT_SLAVE_B:
			designation = 'B';
			break;
		default:
			designation = '?';
		}
		if (!is_slave_up(port->dev))
			netdev_warn(dev, "Slave %c (%s) is not up; please bring it up to get a fully working HSR network\n",
				    designation, port->dev->name);
	}
	rcu_read_unlock();

	if (designation == '\0')
		netdev_warn(dev, "No slave devices configured\n");

	return 0;
}


static int hsr_dev_close(struct net_device *dev)
{
	/* Nothing to do here. */
	return 0;
}


static netdev_features_t hsr_features_recompute(struct hsr_priv *hsr,
						netdev_features_t features)
{
	netdev_features_t mask;
	struct hsr_port *port;

	mask = features;

	/* Mask out all features that, if supported by one device, should be
	 * enabled for all devices (see NETIF_F_ONE_FOR_ALL).
	 *
	 * Anything that's off in mask will not be enabled - so only things
	 * that were in features originally, and also is in NETIF_F_ONE_FOR_ALL,
	 * may become enabled.
	 */
	features &= ~NETIF_F_ONE_FOR_ALL;
	hsr_for_each_port(hsr, port)
		features = netdev_increment_features(features,
						     port->dev->features,
						     mask);

	return features;
}

static netdev_features_t hsr_fix_features(struct net_device *dev,
					  netdev_features_t features)
{
	struct hsr_priv *hsr = netdev_priv(dev);

	return hsr_features_recompute(hsr, features);
}


static int hsr_dev_xmit(struct sk_buff *skb, struct net_device *dev)
{
	struct hsr_priv *hsr = netdev_priv(dev);
	struct hsr_port *master;

	master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
	skb->dev = master->dev;
	hsr_forward_skb(skb, master);

	return NETDEV_TX_OK;
}


static const struct header_ops hsr_header_ops = {
	.create	 = eth_header,
	.parse	 = eth_header_parse,
};

static void send_hsr_supervision_frame(struct hsr_port *master,
		u8 type, u8 hsrVer)
{
	struct sk_buff *skb;
	int hlen, tlen;
	struct hsr_tag *hsr_tag;
	struct hsr_sup_tag *hsr_stag;
	struct hsr_sup_payload *hsr_sp;
	unsigned long irqflags;

	hlen = LL_RESERVED_SPACE(master->dev);
	tlen = master->dev->needed_tailroom;
	skb = dev_alloc_skb(
			sizeof(struct hsr_tag) +
			sizeof(struct hsr_sup_tag) +
			sizeof(struct hsr_sup_payload) + hlen + tlen);

	if (skb == NULL)
		return;

	skb_reserve(skb, hlen);

	skb->dev = master->dev;
	skb->protocol = htons(hsrVer ? ETH_P_HSR : ETH_P_PRP);
	skb->priority = TC_PRIO_CONTROL;

	if (dev_hard_header(skb, skb->dev, (hsrVer ? ETH_P_HSR : ETH_P_PRP),
			    master->hsr->sup_multicast_addr,
			    skb->dev->dev_addr, skb->len) <= 0)
		goto out;
	skb_reset_mac_header(skb);

	if (hsrVer > 0) {
		hsr_tag = (typeof(hsr_tag)) skb_put(skb, sizeof(struct hsr_tag));
		hsr_tag->encap_proto = htons(ETH_P_PRP);
		set_hsr_tag_LSDU_size(hsr_tag, HSR_V1_SUP_LSDUSIZE);
	}

	hsr_stag = (typeof(hsr_stag)) skb_put(skb, sizeof(struct hsr_sup_tag));
	set_hsr_stag_path(hsr_stag, (hsrVer ? 0x0 : 0xf));
	set_hsr_stag_HSR_Ver(hsr_stag, hsrVer);

	/* From HSRv1 on we have separate supervision sequence numbers. */
	spin_lock_irqsave(&master->hsr->seqnr_lock, irqflags);
	if (hsrVer > 0) {
		hsr_stag->sequence_nr = htons(master->hsr->sup_sequence_nr);
		hsr_tag->sequence_nr = htons(master->hsr->sequence_nr);
		master->hsr->sup_sequence_nr++;
		master->hsr->sequence_nr++;
	} else {
		hsr_stag->sequence_nr = htons(master->hsr->sequence_nr);
		master->hsr->sequence_nr++;
	}
	spin_unlock_irqrestore(&master->hsr->seqnr_lock, irqflags);

	hsr_stag->HSR_TLV_Type = type;
	/* TODO: Why 12 in HSRv0? */
	hsr_stag->HSR_TLV_Length = hsrVer ? sizeof(struct hsr_sup_payload) : 12;

	/* Payload: MacAddressA */
	hsr_sp = (typeof(hsr_sp)) skb_put(skb, sizeof(struct hsr_sup_payload));
	ether_addr_copy(hsr_sp->MacAddressA, master->dev->dev_addr);

	skb_put_padto(skb, ETH_ZLEN + HSR_HLEN);

	hsr_forward_skb(skb, master);
	return;

out:
	WARN_ONCE(1, "HSR: Could not send supervision frame\n");
	kfree_skb(skb);
}


/* Announce (supervision frame) timer function
 */
static void hsr_announce(unsigned long data)
{
	struct hsr_priv *hsr;
	struct hsr_port *master;

	hsr = (struct hsr_priv *) data;

	rcu_read_lock();
	master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);

	if (hsr->announce_count < 3 && hsr->protVersion == 0) {
		send_hsr_supervision_frame(master, HSR_TLV_ANNOUNCE,
				hsr->protVersion);
		hsr->announce_count++;

		hsr->announce_timer.expires = jiffies +
				msecs_to_jiffies(HSR_ANNOUNCE_INTERVAL);
	} else {
		send_hsr_supervision_frame(master, HSR_TLV_LIFE_CHECK,
				hsr->protVersion);

		hsr->announce_timer.expires = jiffies +
				msecs_to_jiffies(HSR_LIFE_CHECK_INTERVAL);
	}

	if (is_admin_up(master->dev))
		add_timer(&hsr->announce_timer);

	rcu_read_unlock();
}


/* According to comments in the declaration of struct net_device, this function
 * is "Called from unregister, can be used to call free_netdev". Ok then...
 */
static void hsr_dev_destroy(struct net_device *hsr_dev)
{
	struct hsr_priv *hsr;
	struct hsr_port *port;

	hsr = netdev_priv(hsr_dev);

	rtnl_lock();
	hsr_for_each_port(hsr, port)
		hsr_del_port(port);
	rtnl_unlock();

	del_timer_sync(&hsr->prune_timer);
	del_timer_sync(&hsr->announce_timer);

	synchronize_rcu();
}

static const struct net_device_ops hsr_device_ops = {
	.ndo_change_mtu = hsr_dev_change_mtu,
	.ndo_open = hsr_dev_open,
	.ndo_stop = hsr_dev_close,
	.ndo_start_xmit = hsr_dev_xmit,
	.ndo_fix_features = hsr_fix_features,
};

static struct device_type hsr_type = {
	.name = "hsr",
};

void hsr_dev_setup(struct net_device *dev)
{
	eth_hw_addr_random(dev);

	ether_setup(dev);
	dev->min_mtu = 0;
	dev->header_ops = &hsr_header_ops;
	dev->netdev_ops = &hsr_device_ops;
	SET_NETDEV_DEVTYPE(dev, &hsr_type);
	dev->priv_flags |= IFF_NO_QUEUE;

	dev->needs_free_netdev = true;
	dev->priv_destructor = hsr_dev_destroy;

	dev->hw_features = NETIF_F_SG | NETIF_F_FRAGLIST | NETIF_F_HIGHDMA |
			   NETIF_F_GSO_MASK | NETIF_F_HW_CSUM |
			   NETIF_F_HW_VLAN_CTAG_TX;

	dev->features = dev->hw_features;

	/* Prevent recursive tx locking */
	dev->features |= NETIF_F_LLTX;
	/* VLAN on top of HSR needs testing and probably some work on
	 * hsr_header_create() etc.
	 */
	dev->features |= NETIF_F_VLAN_CHALLENGED;
	/* Not sure about this. Taken from bridge code. netdev_features.h says
	 * it means "Does not change network namespaces".
	 */
	dev->features |= NETIF_F_NETNS_LOCAL;
}


/* Return true if dev is a HSR master; return false otherwise.
 */
inline bool is_hsr_master(struct net_device *dev)
{
	return (dev->netdev_ops->ndo_start_xmit == hsr_dev_xmit);
}

/* Default multicast address for HSR Supervision frames */
static const unsigned char def_multicast_addr[ETH_ALEN] __aligned(2) = {
	0x01, 0x15, 0x4e, 0x00, 0x01, 0x00
};

int hsr_dev_finalize(struct net_device *hsr_dev, struct net_device *slave[2],
		     unsigned char multicast_spec, u8 protocol_version)
{
	struct hsr_priv *hsr;
	struct hsr_port *port;
	int res;

	hsr = netdev_priv(hsr_dev);
	INIT_LIST_HEAD(&hsr->ports);
	INIT_LIST_HEAD(&hsr->node_db);
	INIT_LIST_HEAD(&hsr->self_node_db);

	ether_addr_copy(hsr_dev->dev_addr, slave[0]->dev_addr);

	/* Make sure we recognize frames from ourselves in hsr_rcv() */
	res = hsr_create_self_node(&hsr->self_node_db, hsr_dev->dev_addr,
				   slave[1]->dev_addr);
	if (res < 0)
		return res;

	spin_lock_init(&hsr->seqnr_lock);
	/* Overflow soon to find bugs easier: */
	hsr->sequence_nr = HSR_SEQNR_START;
	hsr->sup_sequence_nr = HSR_SUP_SEQNR_START;

	setup_timer(&hsr->announce_timer, hsr_announce, (unsigned long)hsr);

	setup_timer(&hsr->prune_timer, hsr_prune_nodes, (unsigned long)hsr);

	ether_addr_copy(hsr->sup_multicast_addr, def_multicast_addr);
	hsr->sup_multicast_addr[ETH_ALEN - 1] = multicast_spec;

	hsr->protVersion = protocol_version;

	/* FIXME: should I modify the value of these?
	 *
	 * - hsr_dev->flags - i.e.
	 *			IFF_MASTER/SLAVE?
	 * - hsr_dev->priv_flags - i.e.
	 *			IFF_EBRIDGE?
	 *			IFF_TX_SKB_SHARING?
	 *			IFF_HSR_MASTER/SLAVE?
	 */

	/* Make sure the 1st call to netif_carrier_on() gets through */
	netif_carrier_off(hsr_dev);

	res = hsr_add_port(hsr, hsr_dev, HSR_PT_MASTER);
	if (res)
		return res;

	res = register_netdevice(hsr_dev);
	if (res)
		goto fail;

	res = hsr_add_port(hsr, slave[0], HSR_PT_SLAVE_A);
	if (res)
		goto fail;
	res = hsr_add_port(hsr, slave[1], HSR_PT_SLAVE_B);
	if (res)
		goto fail;

	mod_timer(&hsr->prune_timer, jiffies + msecs_to_jiffies(PRUNE_PERIOD));

	return 0;

fail:
	hsr_for_each_port(hsr, port)
		hsr_del_port(port);

	return res;
}
Commit	Line	Data
70ebe4a4	1	/* Copyright 2011-2014 Autronica Fire and Security AS
f421436a AB	2	*
	3	* This program is free software; you can redistribute it and/or modify it
	4	* under the terms of the GNU General Public License as published by the Free
	5	* Software Foundation; either version 2 of the License, or (at your option)
	6	* any later version.
	7	*
	8	* Author(s):
70ebe4a4	9	* 2011-2014 Arvid Brodin, arvid.brodin@alten.se
f421436a AB	10	*
	11	* This file contains device methods for creating, using and destroying
	12	* virtual HSR devices.
	13	*/
	14
	15	#include <linux/netdevice.h>
	16	#include <linux/skbuff.h>
	17	#include <linux/etherdevice.h>
f421436a AB	18	#include <linux/rtnetlink.h>
	19	#include <linux/pkt_sched.h>
	20	#include "hsr_device.h"
81ba6afd	21	#include "hsr_slave.h"
f421436a AB	22	#include "hsr_framereg.h"
f421436a AB	23	#include "hsr_main.h"
f266a683	24	#include "hsr_forward.h"
f421436a AB	25
	26
	27	static bool is_admin_up(struct net_device *dev)
	28	{
	29	return dev && (dev->flags & IFF_UP);
	30	}
	31
	32	static bool is_slave_up(struct net_device *dev)
	33	{
	34	return dev && is_admin_up(dev) && netif_oper_up(dev);
	35	}
	36
	37	static void __hsr_set_operstate(struct net_device *dev, int transition)
	38	{
	39	write_lock_bh(&dev_base_lock);
	40	if (dev->operstate != transition) {
	41	dev->operstate = transition;
	42	write_unlock_bh(&dev_base_lock);
	43	netdev_state_change(dev);
	44	} else {
	45	write_unlock_bh(&dev_base_lock);
	46	}
	47	}
	48
c5a75911	49	static void hsr_set_operstate(struct hsr_port *master, bool has_carrier)
f421436a	50	{
c5a75911 AB	51	if (!is_admin_up(master->dev)) {
c5a75911 AB	52	__hsr_set_operstate(master->dev, IF_OPER_DOWN);
f421436a AB	53	return;
	54	}
	55
e9aae56e	56	if (has_carrier)
c5a75911	57	__hsr_set_operstate(master->dev, IF_OPER_UP);
f421436a	58	else
c5a75911	59	__hsr_set_operstate(master->dev, IF_OPER_LOWERLAYERDOWN);
f421436a AB	60	}
f421436a AB	61
c5a75911	62	static bool hsr_check_carrier(struct hsr_port *master)
f421436a	63	{
c5a75911	64	struct hsr_port *port;
e9aae56e AB	65	bool has_carrier;
e9aae56e AB	66
c5a75911 AB	67	has_carrier = false;
	68
	69	rcu_read_lock();
	70	hsr_for_each_port(master->hsr, port)
	71	if ((port->type != HSR_PT_MASTER) && is_slave_up(port->dev)) {
	72	has_carrier = true;
	73	break;
	74	}
	75	rcu_read_unlock();
e9aae56e AB	76
e9aae56e AB	77	if (has_carrier)
c5a75911	78	netif_carrier_on(master->dev);
f421436a	79	else
c5a75911	80	netif_carrier_off(master->dev);
e9aae56e AB	81
e9aae56e AB	82	return has_carrier;
f421436a AB	83	}
	84
	85
e9aae56e AB	86	static void hsr_check_announce(struct net_device *hsr_dev,
e9aae56e AB	87	unsigned char old_operstate)
f421436a	88	{
70ebe4a4	89	struct hsr_priv *hsr;
f421436a	90
70ebe4a4	91	hsr = netdev_priv(hsr_dev);
f421436a	92
ee1c2797 PH	93	if ((hsr_dev->operstate == IF_OPER_UP)
ee1c2797 PH	94	&& (old_operstate != IF_OPER_UP)) {
f421436a	95	/* Went up */
70ebe4a4 AB	96	hsr->announce_count = 0;
70ebe4a4 AB	97	hsr->announce_timer.expires = jiffies +
f421436a	98	msecs_to_jiffies(HSR_ANNOUNCE_INTERVAL);
70ebe4a4	99	add_timer(&hsr->announce_timer);
f421436a AB	100	}
	101
	102	if ((hsr_dev->operstate != IF_OPER_UP) && (old_operstate == IF_OPER_UP))
	103	/* Went down */
70ebe4a4	104	del_timer(&hsr->announce_timer);
f421436a AB	105	}
f421436a AB	106
e9aae56e AB	107	void hsr_check_carrier_and_operstate(struct hsr_priv *hsr)
e9aae56e AB	108	{
c5a75911	109	struct hsr_port *master;
e9aae56e AB	110	unsigned char old_operstate;
	111	bool has_carrier;
	112
c5a75911	113	master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
e9aae56e AB	114	/* netif_stacked_transfer_operstate() cannot be used here since
	115	* it doesn't set IF_OPER_LOWERLAYERDOWN (?)
	116	*/
c5a75911 AB	117	old_operstate = master->dev->operstate;
	118	has_carrier = hsr_check_carrier(master);
	119	hsr_set_operstate(master, has_carrier);
	120	hsr_check_announce(master->dev, old_operstate);
e9aae56e AB	121	}
e9aae56e AB	122
70ebe4a4	123	int hsr_get_max_mtu(struct hsr_priv *hsr)
f421436a	124	{
51f3c605	125	unsigned int mtu_max;
c5a75911	126	struct hsr_port *port;
51f3c605 AB	127
	128	mtu_max = ETH_DATA_LEN;
	129	rcu_read_lock();
c5a75911 AB	130	hsr_for_each_port(hsr, port)
	131	if (port->type != HSR_PT_MASTER)
	132	mtu_max = min(port->dev->mtu, mtu_max);
51f3c605 AB	133	rcu_read_unlock();
	134
	135	if (mtu_max < HSR_HLEN)
	136	return 0;
70ebe4a4	137	return mtu_max - HSR_HLEN;
f421436a AB	138	}
f421436a AB	139
51f3c605	140
f421436a AB	141	static int hsr_dev_change_mtu(struct net_device *dev, int new_mtu)
f421436a AB	142	{
70ebe4a4	143	struct hsr_priv *hsr;
c5a75911	144	struct hsr_port *master;
f421436a	145
70ebe4a4	146	hsr = netdev_priv(dev);
c5a75911	147	master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
f421436a	148
70ebe4a4	149	if (new_mtu > hsr_get_max_mtu(hsr)) {
c5a75911	150	netdev_info(master->dev, "A HSR master's MTU cannot be greater than the smallest MTU of its slaves minus the HSR Tag length (%d octets).\n",
70ebe4a4	151	HSR_HLEN);
f421436a AB	152	return -EINVAL;
	153	}
	154
	155	dev->mtu = new_mtu;
	156
	157	return 0;
	158	}
	159
	160	static int hsr_dev_open(struct net_device *dev)
	161	{
70ebe4a4	162	struct hsr_priv *hsr;
c5a75911 AB	163	struct hsr_port *port;
c5a75911 AB	164	char designation;
f421436a	165
70ebe4a4	166	hsr = netdev_priv(dev);
c5a75911	167	designation = '\0';
f421436a	168
c5a75911 AB	169	rcu_read_lock();
	170	hsr_for_each_port(hsr, port) {
	171	if (port->type == HSR_PT_MASTER)
	172	continue;
	173	switch (port->type) {
	174	case HSR_PT_SLAVE_A:
	175	designation = 'A';
	176	break;
	177	case HSR_PT_SLAVE_B:
	178	designation = 'B';
	179	break;
	180	default:
	181	designation = '?';
	182	}
	183	if (!is_slave_up(port->dev))
	184	netdev_warn(dev, "Slave %c (%s) is not up; please bring it up to get a fully working HSR network\n",
	185	designation, port->dev->name);
f421436a	186	}
c5a75911 AB	187	rcu_read_unlock();
	188
	189	if (designation == '\0')
	190	netdev_warn(dev, "No slave devices configured\n");
f421436a AB	191
	192	return 0;
	193	}
	194
c5a75911	195
f421436a AB	196	static int hsr_dev_close(struct net_device *dev)
f421436a AB	197	{
c5a75911	198	/* Nothing to do here. */
f421436a AB	199	return 0;
	200	}
	201
	202
1cc1eb52 AB	203	static netdev_features_t hsr_features_recompute(struct hsr_priv *hsr,
	204	netdev_features_t features)
	205	{
	206	netdev_features_t mask;
	207	struct hsr_port *port;
	208
	209	mask = features;
	210
	211	/* Mask out all features that, if supported by one device, should be
	212	* enabled for all devices (see NETIF_F_ONE_FOR_ALL).
	213	*
	214	* Anything that's off in mask will not be enabled - so only things
	215	* that were in features originally, and also is in NETIF_F_ONE_FOR_ALL,
	216	* may become enabled.
	217	*/
	218	features &= ~NETIF_F_ONE_FOR_ALL;
	219	hsr_for_each_port(hsr, port)
	220	features = netdev_increment_features(features,
	221	port->dev->features,
	222	mask);
	223
	224	return features;
	225	}
	226
	227	static netdev_features_t hsr_fix_features(struct net_device *dev,
	228	netdev_features_t features)
	229	{
	230	struct hsr_priv *hsr = netdev_priv(dev);
	231
	232	return hsr_features_recompute(hsr, features);
	233	}
	234
	235
f421436a AB	236	static int hsr_dev_xmit(struct sk_buff skb, struct net_device dev)
f421436a AB	237	{
f266a683	238	struct hsr_priv *hsr = netdev_priv(dev);
c5a75911	239	struct hsr_port *master;
f421436a	240
c5a75911	241	master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
f266a683 AB	242	skb->dev = master->dev;
f266a683 AB	243	hsr_forward_skb(skb, master);
f421436a AB	244
	245	return NETDEV_TX_OK;
	246	}
	247
	248
f421436a	249	static const struct header_ops hsr_header_ops = {
f266a683	250	.create = eth_header,
f421436a AB	251	.parse = eth_header_parse,
	252	};
	253
ee1c2797 PH	254	static void send_hsr_supervision_frame(struct hsr_port *master,
ee1c2797 PH	255	u8 type, u8 hsrVer)
f421436a	256	{
f421436a AB	257	struct sk_buff *skb;
f421436a AB	258	int hlen, tlen;
ee1c2797	259	struct hsr_tag *hsr_tag;
f421436a AB	260	struct hsr_sup_tag *hsr_stag;
	261	struct hsr_sup_payload *hsr_sp;
	262	unsigned long irqflags;
	263
c5a75911 AB	264	hlen = LL_RESERVED_SPACE(master->dev);
c5a75911 AB	265	tlen = master->dev->needed_tailroom;
ee1c2797 PH	266	skb = dev_alloc_skb(
	267	sizeof(struct hsr_tag) +
	268	sizeof(struct hsr_sup_tag) +
	269	sizeof(struct hsr_sup_payload) + hlen + tlen);
f421436a AB	270
	271	if (skb == NULL)
	272	return;
	273
f421436a AB	274	skb_reserve(skb, hlen);
f421436a AB	275
c5a75911	276	skb->dev = master->dev;
ee1c2797	277	skb->protocol = htons(hsrVer ? ETH_P_HSR : ETH_P_PRP);
f421436a AB	278	skb->priority = TC_PRIO_CONTROL;
f421436a AB	279
ee1c2797	280	if (dev_hard_header(skb, skb->dev, (hsrVer ? ETH_P_HSR : ETH_P_PRP),
f266a683 AB	281	master->hsr->sup_multicast_addr,
f266a683 AB	282	skb->dev->dev_addr, skb->len) <= 0)
f421436a	283	goto out;
f266a683	284	skb_reset_mac_header(skb);
f421436a	285
ee1c2797 PH	286	if (hsrVer > 0) {
	287	hsr_tag = (typeof(hsr_tag)) skb_put(skb, sizeof(struct hsr_tag));
	288	hsr_tag->encap_proto = htons(ETH_P_PRP);
	289	set_hsr_tag_LSDU_size(hsr_tag, HSR_V1_SUP_LSDUSIZE);
	290	}
f421436a	291
ee1c2797 PH	292	hsr_stag = (typeof(hsr_stag)) skb_put(skb, sizeof(struct hsr_sup_tag));
	293	set_hsr_stag_path(hsr_stag, (hsrVer ? 0x0 : 0xf));
	294	set_hsr_stag_HSR_Ver(hsr_stag, hsrVer);
f421436a	295
ee1c2797	296	/* From HSRv1 on we have separate supervision sequence numbers. */
f266a683	297	spin_lock_irqsave(&master->hsr->seqnr_lock, irqflags);
ee1c2797 PH	298	if (hsrVer > 0) {
	299	hsr_stag->sequence_nr = htons(master->hsr->sup_sequence_nr);
	300	hsr_tag->sequence_nr = htons(master->hsr->sequence_nr);
	301	master->hsr->sup_sequence_nr++;
	302	master->hsr->sequence_nr++;
	303	} else {
	304	hsr_stag->sequence_nr = htons(master->hsr->sequence_nr);
	305	master->hsr->sequence_nr++;
	306	}
f266a683	307	spin_unlock_irqrestore(&master->hsr->seqnr_lock, irqflags);
f421436a AB	308
f421436a AB	309	hsr_stag->HSR_TLV_Type = type;
ee1c2797 PH	310	/* TODO: Why 12 in HSRv0? */
ee1c2797 PH	311	hsr_stag->HSR_TLV_Length = hsrVer ? sizeof(struct hsr_sup_payload) : 12;
f421436a	312
f421436a	313	/* Payload: MacAddressA */
ee1c2797	314	hsr_sp = (typeof(hsr_sp)) skb_put(skb, sizeof(struct hsr_sup_payload));
c5a75911	315	ether_addr_copy(hsr_sp->MacAddressA, master->dev->dev_addr);
f421436a	316
ee1c2797 PH	317	skb_put_padto(skb, ETH_ZLEN + HSR_HLEN);
ee1c2797 PH	318
f266a683	319	hsr_forward_skb(skb, master);
f421436a AB	320	return;
	321
	322	out:
3d1a54e8	323	WARN_ONCE(1, "HSR: Could not send supervision frame\n");
f421436a AB	324	kfree_skb(skb);
	325	}
	326
	327
	328	/* Announce (supervision frame) timer function
	329	*/
	330	static void hsr_announce(unsigned long data)
	331	{
70ebe4a4	332	struct hsr_priv *hsr;
c5a75911	333	struct hsr_port *master;
f421436a	334
70ebe4a4	335	hsr = (struct hsr_priv *) data;
f266a683 AB	336
f266a683 AB	337	rcu_read_lock();
c5a75911	338	master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
f421436a	339
ee1c2797 PH	340	if (hsr->announce_count < 3 && hsr->protVersion == 0) {
	341	send_hsr_supervision_frame(master, HSR_TLV_ANNOUNCE,
	342	hsr->protVersion);
70ebe4a4	343	hsr->announce_count++;
f421436a	344
70ebe4a4	345	hsr->announce_timer.expires = jiffies +
f421436a	346	msecs_to_jiffies(HSR_ANNOUNCE_INTERVAL);
ee1c2797 PH	347	} else {
	348	send_hsr_supervision_frame(master, HSR_TLV_LIFE_CHECK,
	349	hsr->protVersion);
	350
70ebe4a4	351	hsr->announce_timer.expires = jiffies +
f421436a	352	msecs_to_jiffies(HSR_LIFE_CHECK_INTERVAL);
ee1c2797	353	}
f421436a	354
c5a75911	355	if (is_admin_up(master->dev))
70ebe4a4	356	add_timer(&hsr->announce_timer);
f266a683 AB	357
f266a683 AB	358	rcu_read_unlock();
f421436a AB	359	}
	360
	361
f421436a AB	362	/* According to comments in the declaration of struct net_device, this function
	363	* is "Called from unregister, can be used to call free_netdev". Ok then...
	364	*/
	365	static void hsr_dev_destroy(struct net_device *hsr_dev)
	366	{
70ebe4a4	367	struct hsr_priv *hsr;
c5a75911	368	struct hsr_port *port;
f421436a	369
70ebe4a4	370	hsr = netdev_priv(hsr_dev);
56b08fdc AB	371
56b08fdc AB	372	rtnl_lock();
c5a75911 AB	373	hsr_for_each_port(hsr, port)
c5a75911 AB	374	hsr_del_port(port);
56b08fdc	375	rtnl_unlock();
f421436a	376
abff7162 AB	377	del_timer_sync(&hsr->prune_timer);
abff7162 AB	378	del_timer_sync(&hsr->announce_timer);
c5a75911 AB	379
c5a75911 AB	380	synchronize_rcu();
f421436a AB	381	}
	382
	383	static const struct net_device_ops hsr_device_ops = {
	384	.ndo_change_mtu = hsr_dev_change_mtu,
	385	.ndo_open = hsr_dev_open,
	386	.ndo_stop = hsr_dev_close,
	387	.ndo_start_xmit = hsr_dev_xmit,
1cc1eb52	388	.ndo_fix_features = hsr_fix_features,
f421436a AB	389	};
f421436a AB	390
4c3477dc AB	391	static struct device_type hsr_type = {
	392	.name = "hsr",
	393	};
f421436a AB	394
	395	void hsr_dev_setup(struct net_device *dev)
	396	{
d4af4c0a	397	eth_hw_addr_random(dev);
f421436a AB	398
f421436a AB	399	ether_setup(dev);
b3e3893e	400	dev->min_mtu = 0;
4c3477dc AB	401	dev->header_ops = &hsr_header_ops;
	402	dev->netdev_ops = &hsr_device_ops;
	403	SET_NETDEV_DEVTYPE(dev, &hsr_type);
9ad09c5c	404	dev->priv_flags \|= IFF_NO_QUEUE;
f421436a	405
cf124db5 DM	406	dev->needs_free_netdev = true;
cf124db5 DM	407	dev->priv_destructor = hsr_dev_destroy;
1cc1eb52 AB	408
	409	dev->hw_features = NETIF_F_SG \| NETIF_F_FRAGLIST \| NETIF_F_HIGHDMA \|
	410	NETIF_F_GSO_MASK \| NETIF_F_HW_CSUM \|
	411	NETIF_F_HW_VLAN_CTAG_TX;
	412
	413	dev->features = dev->hw_features;
	414
	415	/* Prevent recursive tx locking */
	416	dev->features \|= NETIF_F_LLTX;
	417	/* VLAN on top of HSR needs testing and probably some work on
	418	* hsr_header_create() etc.
	419	*/
	420	dev->features \|= NETIF_F_VLAN_CHALLENGED;
4c3477dc AB	421	/* Not sure about this. Taken from bridge code. netdev_features.h says
	422	* it means "Does not change network namespaces".
	423	*/
	424	dev->features \|= NETIF_F_NETNS_LOCAL;
f421436a AB	425	}
	426
	427
	428	/* Return true if dev is a HSR master; return false otherwise.
	429	*/
c5a75911	430	inline bool is_hsr_master(struct net_device *dev)
f421436a AB	431	{
	432	return (dev->netdev_ops->ndo_start_xmit == hsr_dev_xmit);
	433	}
	434
f421436a	435	/* Default multicast address for HSR Supervision frames */
e83abe37	436	static const unsigned char def_multicast_addr[ETH_ALEN] __aligned(2) = {
f421436a AB	437	0x01, 0x15, 0x4e, 0x00, 0x01, 0x00
	438	};
	439
	440	int hsr_dev_finalize(struct net_device hsr_dev, struct net_device slave[2],
ee1c2797	441	unsigned char multicast_spec, u8 protocol_version)
f421436a	442	{
70ebe4a4	443	struct hsr_priv *hsr;
c5a75911	444	struct hsr_port *port;
f421436a AB	445	int res;
f421436a AB	446
70ebe4a4	447	hsr = netdev_priv(hsr_dev);
c5a75911	448	INIT_LIST_HEAD(&hsr->ports);
70ebe4a4 AB	449	INIT_LIST_HEAD(&hsr->node_db);
70ebe4a4 AB	450	INIT_LIST_HEAD(&hsr->self_node_db);
51f3c605 AB	451
	452	ether_addr_copy(hsr_dev->dev_addr, slave[0]->dev_addr);
	453
	454	/* Make sure we recognize frames from ourselves in hsr_rcv() */
	455	res = hsr_create_self_node(&hsr->self_node_db, hsr_dev->dev_addr,
	456	slave[1]->dev_addr);
	457	if (res < 0)
	458	return res;
	459
70ebe4a4	460	spin_lock_init(&hsr->seqnr_lock);
f421436a	461	/* Overflow soon to find bugs easier: */
f266a683	462	hsr->sequence_nr = HSR_SEQNR_START;
ee1c2797	463	hsr->sup_sequence_nr = HSR_SUP_SEQNR_START;
f421436a	464
15db6e0d	465	setup_timer(&hsr->announce_timer, hsr_announce, (unsigned long)hsr);
f421436a	466
15db6e0d	467	setup_timer(&hsr->prune_timer, hsr_prune_nodes, (unsigned long)hsr);
abff7162	468
70ebe4a4 AB	469	ether_addr_copy(hsr->sup_multicast_addr, def_multicast_addr);
70ebe4a4 AB	470	hsr->sup_multicast_addr[ETH_ALEN - 1] = multicast_spec;
f421436a	471
ee1c2797 PH	472	hsr->protVersion = protocol_version;
ee1c2797 PH	473
c5a75911 AB	474	/* FIXME: should I modify the value of these?
	475	*
	476	* - hsr_dev->flags - i.e.
	477	* IFF_MASTER/SLAVE?
	478	* - hsr_dev->priv_flags - i.e.
	479	* IFF_EBRIDGE?
	480	* IFF_TX_SKB_SHARING?
	481	* IFF_HSR_MASTER/SLAVE?
	482	*/
f421436a	483
f421436a AB	484	/* Make sure the 1st call to netif_carrier_on() gets through */
	485	netif_carrier_off(hsr_dev);
	486
c5a75911	487	res = hsr_add_port(hsr, hsr_dev, HSR_PT_MASTER);
f421436a	488	if (res)
51f3c605 AB	489	return res;
51f3c605 AB	490
c5a75911	491	res = register_netdevice(hsr_dev);
51f3c605	492	if (res)
c5a75911 AB	493	goto fail;
	494
	495	res = hsr_add_port(hsr, slave[0], HSR_PT_SLAVE_A);
	496	if (res)
	497	goto fail;
	498	res = hsr_add_port(hsr, slave[1], HSR_PT_SLAVE_B);
	499	if (res)
	500	goto fail;
f421436a	501
15db6e0d	502	mod_timer(&hsr->prune_timer, jiffies + msecs_to_jiffies(PRUNE_PERIOD));
abff7162	503
f421436a	504	return 0;
c5a75911 AB	505
	506	fail:
	507	hsr_for_each_port(hsr, port)
	508	hsr_del_port(port);
	509
	510	return res;
f421436a	511	}