[linux.git] / net / hsr / hsr_device.c

// SPDX-License-Identifier: GPL-2.0
/* Copyright 2011-2014 Autronica Fire and Security AS
 *
 * Author(s):
 *	2011-2014 Arvid Brodin, [email protected]
 * This file contains device methods for creating, using and destroying
 * virtual HSR or PRP 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;

	ASSERT_RTNL();

	hsr_for_each_port(master->hsr, port) {
		if (port->type != HSR_PT_MASTER && is_slave_up(port->dev)) {
			netif_carrier_on(master->dev);
			return true;
		}
	}

	netif_carrier_off(master->dev);

	return false;
}

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;
		mod_timer(&hsr->announce_timer,
			  jiffies + msecs_to_jiffies(HSR_ANNOUNCE_INTERVAL));
	}

	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;
	hsr_for_each_port(hsr, port)
		if (port->type != HSR_PT_MASTER)
			mtu_max = min(port->dev->mtu, mtu_max);

	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;

	hsr = netdev_priv(dev);

	if (new_mtu > hsr_get_max_mtu(hsr)) {
		netdev_info(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';

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

	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 netdev_tx_t 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);
	if (master) {
		skb->dev = master->dev;
		hsr_forward_skb(skb, master);
	} else {
		atomic_long_inc(&dev->tx_dropped);
		dev_kfree_skb_any(skb);
	}
	return NETDEV_TX_OK;
}

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

static struct sk_buff *hsr_init_skb(struct hsr_port *master)
{
	struct hsr_priv *hsr = master->hsr;
	struct sk_buff *skb;
	int hlen, tlen;

	hlen = LL_RESERVED_SPACE(master->dev);
	tlen = master->dev->needed_tailroom;
	/* skb size is same for PRP/HSR frames, only difference
	 * being, for PRP it is a trailer and for HSR it is a
	 * header
	 */
	skb = dev_alloc_skb(sizeof(struct hsr_sup_tag) +
			    sizeof(struct hsr_sup_payload) + hlen + tlen);

	if (!skb)
		return skb;

	skb_reserve(skb, hlen);
	skb->dev = master->dev;
	skb->priority = TC_PRIO_CONTROL;

	if (dev_hard_header(skb, skb->dev, ETH_P_PRP,
			    hsr->sup_multicast_addr,
			    skb->dev->dev_addr, skb->len) <= 0)
		goto out;

	skb_reset_mac_header(skb);
	skb_reset_network_header(skb);
	skb_reset_transport_header(skb);

	return skb;
out:
	kfree_skb(skb);

	return NULL;
}

static void send_hsr_supervision_frame(struct hsr_port *master,
				       unsigned long *interval)
{
	struct hsr_priv *hsr = master->hsr;
	__u8 type = HSR_TLV_LIFE_CHECK;
	struct hsr_sup_payload *hsr_sp;
	struct hsr_sup_tag *hsr_stag;
	unsigned long irqflags;
	struct sk_buff *skb;

	*interval = msecs_to_jiffies(HSR_LIFE_CHECK_INTERVAL);
	if (hsr->announce_count < 3 && hsr->prot_version == 0) {
		type = HSR_TLV_ANNOUNCE;
		*interval = msecs_to_jiffies(HSR_ANNOUNCE_INTERVAL);
		hsr->announce_count++;
	}

	skb = hsr_init_skb(master);
	if (!skb) {
		WARN_ONCE(1, "HSR: Could not send supervision frame\n");
		return;
	}

	hsr_stag = skb_put(skb, sizeof(struct hsr_sup_tag));
	set_hsr_stag_path(hsr_stag, (hsr->prot_version ? 0x0 : 0xf));
	set_hsr_stag_HSR_ver(hsr_stag, hsr->prot_version);

	/* From HSRv1 on we have separate supervision sequence numbers. */
	spin_lock_irqsave(&master->hsr->seqnr_lock, irqflags);
	if (hsr->prot_version > 0) {
		hsr_stag->sequence_nr = htons(hsr->sup_sequence_nr);
		hsr->sup_sequence_nr++;
	} else {
		hsr_stag->sequence_nr = htons(hsr->sequence_nr);
		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 = hsr->prot_version ?
				sizeof(struct hsr_sup_payload) : 12;

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

	if (skb_put_padto(skb, ETH_ZLEN))
		return;

	hsr_forward_skb(skb, master);

	return;
}

static void send_prp_supervision_frame(struct hsr_port *master,
				       unsigned long *interval)
{
	struct hsr_priv *hsr = master->hsr;
	struct hsr_sup_payload *hsr_sp;
	struct hsr_sup_tag *hsr_stag;
	unsigned long irqflags;
	struct sk_buff *skb;

	skb = hsr_init_skb(master);
	if (!skb) {
		WARN_ONCE(1, "PRP: Could not send supervision frame\n");
		return;
	}

	*interval = msecs_to_jiffies(HSR_LIFE_CHECK_INTERVAL);
	hsr_stag = skb_put(skb, sizeof(struct hsr_sup_tag));
	set_hsr_stag_path(hsr_stag, (hsr->prot_version ? 0x0 : 0xf));
	set_hsr_stag_HSR_ver(hsr_stag, (hsr->prot_version ? 1 : 0));

	/* From HSRv1 on we have separate supervision sequence numbers. */
	spin_lock_irqsave(&master->hsr->seqnr_lock, irqflags);
	hsr_stag->sequence_nr = htons(hsr->sup_sequence_nr);
	hsr->sup_sequence_nr++;
	hsr_stag->HSR_TLV_type = PRP_TLV_LIFE_CHECK_DD;
	hsr_stag->HSR_TLV_length = sizeof(struct hsr_sup_payload);

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

	if (skb_put_padto(skb, ETH_ZLEN)) {
		spin_unlock_irqrestore(&master->hsr->seqnr_lock, irqflags);
		return;
	}

	spin_unlock_irqrestore(&master->hsr->seqnr_lock, irqflags);

	hsr_forward_skb(skb, master);
}

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

	hsr = from_timer(hsr, t, announce_timer);

	rcu_read_lock();
	master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
	hsr->proto_ops->send_sv_frame(master, &interval);

	if (is_admin_up(master->dev))
		mod_timer(&hsr->announce_timer, jiffies + interval);

	rcu_read_unlock();
}

void hsr_del_ports(struct hsr_priv *hsr)
{
	struct hsr_port *port;

	port = hsr_port_get_hsr(hsr, HSR_PT_SLAVE_A);
	if (port)
		hsr_del_port(port);

	port = hsr_port_get_hsr(hsr, HSR_PT_SLAVE_B);
	if (port)
		hsr_del_port(port);

	port = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
	if (port)
		hsr_del_port(port);
}

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

static struct hsr_proto_ops hsr_ops = {
	.send_sv_frame = send_hsr_supervision_frame,
	.create_tagged_frame = hsr_create_tagged_frame,
	.get_untagged_frame = hsr_get_untagged_frame,
	.drop_frame = hsr_drop_frame,
	.fill_frame_info = hsr_fill_frame_info,
	.invalid_dan_ingress_frame = hsr_invalid_dan_ingress_frame,
};

static struct hsr_proto_ops prp_ops = {
	.send_sv_frame = send_prp_supervision_frame,
	.create_tagged_frame = prp_create_tagged_frame,
	.get_untagged_frame = prp_get_untagged_frame,
	.drop_frame = prp_drop_frame,
	.fill_frame_info = prp_fill_frame_info,
	.handle_san_frame = prp_handle_san_frame,
	.update_san_info = prp_update_san_info,
};

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->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.
 */
bool is_hsr_master(struct net_device *dev)
{
	return (dev->netdev_ops->ndo_start_xmit == hsr_dev_xmit);
}
EXPORT_SYMBOL(is_hsr_master);

/* 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 netlink_ext_ack *extack)
{
	bool unregister = false;
	struct hsr_priv *hsr;
	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);
	spin_lock_init(&hsr->list_lock);

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

	/* initialize protocol specific functions */
	if (protocol_version == PRP_V1) {
		/* For PRP, lan_id has most significant 3 bits holding
		 * the net_id of PRP_LAN_ID
		 */
		hsr->net_id = PRP_LAN_ID << 1;
		hsr->proto_ops = &prp_ops;
	} else {
		hsr->proto_ops = &hsr_ops;
	}

	/* Make sure we recognize frames from ourselves in hsr_rcv() */
	res = hsr_create_self_node(hsr, 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;

	timer_setup(&hsr->announce_timer, hsr_announce, 0);
	timer_setup(&hsr->prune_timer, hsr_prune_nodes, 0);

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

	hsr->prot_version = protocol_version;

	/* 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, extack);
	if (res)
		goto err_add_master;

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

	unregister = true;

	res = hsr_add_port(hsr, slave[0], HSR_PT_SLAVE_A, extack);
	if (res)
		goto err_unregister;

	res = hsr_add_port(hsr, slave[1], HSR_PT_SLAVE_B, extack);
	if (res)
		goto err_unregister;

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

	return 0;

err_unregister:
	hsr_del_ports(hsr);
err_add_master:
	hsr_del_self_node(hsr);

	if (unregister)
		unregister_netdevice(hsr_dev);
	return res;
}
Commit	Line	Data
0e7623bd	1	// SPDX-License-Identifier: GPL-2.0
70ebe4a4	2	/* Copyright 2011-2014 Autronica Fire and Security AS
f421436a AB	3	*
f421436a AB	4	* Author(s):
70ebe4a4	5	* 2011-2014 Arvid Brodin, [email protected]
f421436a	6	* This file contains device methods for creating, using and destroying
8f4c0e01	7	* virtual HSR or PRP devices.
f421436a AB	8	*/
	9
	10	#include <linux/netdevice.h>
	11	#include <linux/skbuff.h>
	12	#include <linux/etherdevice.h>
f421436a AB	13	#include <linux/rtnetlink.h>
	14	#include <linux/pkt_sched.h>
	15	#include "hsr_device.h"
81ba6afd	16	#include "hsr_slave.h"
f421436a AB	17	#include "hsr_framereg.h"
f421436a AB	18	#include "hsr_main.h"
f266a683	19	#include "hsr_forward.h"
f421436a	20
f421436a AB	21	static bool is_admin_up(struct net_device *dev)
	22	{
	23	return dev && (dev->flags & IFF_UP);
	24	}
	25
	26	static bool is_slave_up(struct net_device *dev)
	27	{
	28	return dev && is_admin_up(dev) && netif_oper_up(dev);
	29	}
	30
	31	static void __hsr_set_operstate(struct net_device *dev, int transition)
	32	{
	33	write_lock_bh(&dev_base_lock);
	34	if (dev->operstate != transition) {
	35	dev->operstate = transition;
	36	write_unlock_bh(&dev_base_lock);
	37	netdev_state_change(dev);
	38	} else {
	39	write_unlock_bh(&dev_base_lock);
	40	}
	41	}
	42
c5a75911	43	static void hsr_set_operstate(struct hsr_port *master, bool has_carrier)
f421436a	44	{
c5a75911 AB	45	if (!is_admin_up(master->dev)) {
c5a75911 AB	46	__hsr_set_operstate(master->dev, IF_OPER_DOWN);
f421436a AB	47	return;
	48	}
	49
e9aae56e	50	if (has_carrier)
c5a75911	51	__hsr_set_operstate(master->dev, IF_OPER_UP);
f421436a	52	else
c5a75911	53	__hsr_set_operstate(master->dev, IF_OPER_LOWERLAYERDOWN);
f421436a AB	54	}
f421436a AB	55
c5a75911	56	static bool hsr_check_carrier(struct hsr_port *master)
f421436a	57	{
c5a75911	58	struct hsr_port *port;
e9aae56e	59
81390d0c	60	ASSERT_RTNL();
c5a75911	61
81390d0c	62	hsr_for_each_port(master->hsr, port) {
5670342c	63	if (port->type != HSR_PT_MASTER && is_slave_up(port->dev)) {
81390d0c TY	64	netif_carrier_on(master->dev);
81390d0c TY	65	return true;
c5a75911	66	}
81390d0c	67	}
e9aae56e	68
81390d0c	69	netif_carrier_off(master->dev);
e9aae56e	70
81390d0c	71	return false;
f421436a AB	72	}
f421436a AB	73
e9aae56e AB	74	static void hsr_check_announce(struct net_device *hsr_dev,
e9aae56e AB	75	unsigned char old_operstate)
f421436a	76	{
70ebe4a4	77	struct hsr_priv *hsr;
f421436a	78
70ebe4a4	79	hsr = netdev_priv(hsr_dev);
f421436a	80
5670342c	81	if (hsr_dev->operstate == IF_OPER_UP && old_operstate != IF_OPER_UP) {
f421436a	82	/* Went up */
70ebe4a4	83	hsr->announce_count = 0;
1e027960 ED	84	mod_timer(&hsr->announce_timer,
1e027960 ED	85	jiffies + msecs_to_jiffies(HSR_ANNOUNCE_INTERVAL));
f421436a AB	86	}
f421436a AB	87
5670342c	88	if (hsr_dev->operstate != IF_OPER_UP && old_operstate == IF_OPER_UP)
f421436a	89	/* Went down */
70ebe4a4	90	del_timer(&hsr->announce_timer);
f421436a AB	91	}
f421436a AB	92
e9aae56e AB	93	void hsr_check_carrier_and_operstate(struct hsr_priv *hsr)
e9aae56e AB	94	{
c5a75911	95	struct hsr_port *master;
e9aae56e AB	96	unsigned char old_operstate;
	97	bool has_carrier;
	98
c5a75911	99	master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
e9aae56e AB	100	/* netif_stacked_transfer_operstate() cannot be used here since
	101	* it doesn't set IF_OPER_LOWERLAYERDOWN (?)
	102	*/
c5a75911 AB	103	old_operstate = master->dev->operstate;
	104	has_carrier = hsr_check_carrier(master);
	105	hsr_set_operstate(master, has_carrier);
	106	hsr_check_announce(master->dev, old_operstate);
e9aae56e AB	107	}
e9aae56e AB	108
70ebe4a4	109	int hsr_get_max_mtu(struct hsr_priv *hsr)
f421436a	110	{
51f3c605	111	unsigned int mtu_max;
c5a75911	112	struct hsr_port *port;
51f3c605 AB	113
51f3c605 AB	114	mtu_max = ETH_DATA_LEN;
c5a75911 AB	115	hsr_for_each_port(hsr, port)
	116	if (port->type != HSR_PT_MASTER)
	117	mtu_max = min(port->dev->mtu, mtu_max);
51f3c605 AB	118
	119	if (mtu_max < HSR_HLEN)
	120	return 0;
70ebe4a4	121	return mtu_max - HSR_HLEN;
f421436a AB	122	}
	123
	124	static int hsr_dev_change_mtu(struct net_device *dev, int new_mtu)
	125	{
70ebe4a4	126	struct hsr_priv *hsr;
f421436a	127
70ebe4a4	128	hsr = netdev_priv(dev);
f421436a	129
70ebe4a4	130	if (new_mtu > hsr_get_max_mtu(hsr)) {
f30e4720	131	netdev_info(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	132	HSR_HLEN);
f421436a AB	133	return -EINVAL;
	134	}
	135
	136	dev->mtu = new_mtu;
	137
	138	return 0;
	139	}
	140
	141	static int hsr_dev_open(struct net_device *dev)
	142	{
70ebe4a4	143	struct hsr_priv *hsr;
c5a75911 AB	144	struct hsr_port *port;
c5a75911 AB	145	char designation;
f421436a	146
70ebe4a4	147	hsr = netdev_priv(dev);
c5a75911	148	designation = '\0';
f421436a	149
c5a75911 AB	150	hsr_for_each_port(hsr, port) {
	151	if (port->type == HSR_PT_MASTER)
	152	continue;
	153	switch (port->type) {
	154	case HSR_PT_SLAVE_A:
	155	designation = 'A';
	156	break;
	157	case HSR_PT_SLAVE_B:
	158	designation = 'B';
	159	break;
	160	default:
	161	designation = '?';
	162	}
	163	if (!is_slave_up(port->dev))
	164	netdev_warn(dev, "Slave %c (%s) is not up; please bring it up to get a fully working HSR network\n",
	165	designation, port->dev->name);
f421436a	166	}
c5a75911 AB	167
	168	if (designation == '\0')
	169	netdev_warn(dev, "No slave devices configured\n");
f421436a AB	170
	171	return 0;
	172	}
	173
	174	static int hsr_dev_close(struct net_device *dev)
	175	{
c5a75911	176	/* Nothing to do here. */
f421436a AB	177	return 0;
	178	}
	179
1cc1eb52 AB	180	static netdev_features_t hsr_features_recompute(struct hsr_priv *hsr,
	181	netdev_features_t features)
	182	{
	183	netdev_features_t mask;
	184	struct hsr_port *port;
	185
	186	mask = features;
	187
	188	/* Mask out all features that, if supported by one device, should be
	189	* enabled for all devices (see NETIF_F_ONE_FOR_ALL).
	190	*
	191	* Anything that's off in mask will not be enabled - so only things
	192	* that were in features originally, and also is in NETIF_F_ONE_FOR_ALL,
	193	* may become enabled.
	194	*/
	195	features &= ~NETIF_F_ONE_FOR_ALL;
	196	hsr_for_each_port(hsr, port)
	197	features = netdev_increment_features(features,
	198	port->dev->features,
	199	mask);
	200
	201	return features;
	202	}
	203
	204	static netdev_features_t hsr_fix_features(struct net_device *dev,
	205	netdev_features_t features)
	206	{
	207	struct hsr_priv *hsr = netdev_priv(dev);
	208
	209	return hsr_features_recompute(hsr, features);
	210	}
	211
42deace2	212	static netdev_tx_t hsr_dev_xmit(struct sk_buff skb, struct net_device dev)
f421436a	213	{
f266a683	214	struct hsr_priv *hsr = netdev_priv(dev);
c5a75911	215	struct hsr_port *master;
f421436a	216
c5a75911	217	master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
df95467b TY	218	if (master) {
	219	skb->dev = master->dev;
	220	hsr_forward_skb(skb, master);
	221	} else {
	222	atomic_long_inc(&dev->tx_dropped);
	223	dev_kfree_skb_any(skb);
	224	}
f421436a AB	225	return NETDEV_TX_OK;
	226	}
	227
f421436a	228	static const struct header_ops hsr_header_ops = {
f266a683	229	.create = eth_header,
f421436a AB	230	.parse = eth_header_parse,
	231	};
	232
78be9217	233	static struct sk_buff hsr_init_skb(struct hsr_port master)
f421436a	234	{
121c33b0	235	struct hsr_priv *hsr = master->hsr;
f421436a AB	236	struct sk_buff *skb;
f421436a AB	237	int hlen, tlen;
f421436a	238
c5a75911 AB	239	hlen = LL_RESERVED_SPACE(master->dev);
c5a75911 AB	240	tlen = master->dev->needed_tailroom;
c643ff03 MK	241	/* skb size is same for PRP/HSR frames, only difference
	242	* being, for PRP it is a trailer and for HSR it is a
	243	* header
	244	*/
78be9217	245	skb = dev_alloc_skb(sizeof(struct hsr_sup_tag) +
0525fc06	246	sizeof(struct hsr_sup_payload) + hlen + tlen);
f421436a	247
05ca6e64	248	if (!skb)
121c33b0	249	return skb;
f421436a	250
f421436a	251	skb_reserve(skb, hlen);
c5a75911	252	skb->dev = master->dev;
f421436a AB	253	skb->priority = TC_PRIO_CONTROL;
f421436a AB	254
78be9217	255	if (dev_hard_header(skb, skb->dev, ETH_P_PRP,
121c33b0	256	hsr->sup_multicast_addr,
f266a683	257	skb->dev->dev_addr, skb->len) <= 0)
f421436a	258	goto out;
121c33b0	259
f266a683	260	skb_reset_mac_header(skb);
3ed0a1d5 TY	261	skb_reset_network_header(skb);
3ed0a1d5 TY	262	skb_reset_transport_header(skb);
f421436a	263
121c33b0 MK	264	return skb;
	265	out:
	266	kfree_skb(skb);
	267
	268	return NULL;
	269	}
	270
	271	static void send_hsr_supervision_frame(struct hsr_port *master,
28e458e0	272	unsigned long *interval)
121c33b0	273	{
28e458e0 MK	274	struct hsr_priv *hsr = master->hsr;
28e458e0 MK	275	__u8 type = HSR_TLV_LIFE_CHECK;
121c33b0 MK	276	struct hsr_sup_payload *hsr_sp;
121c33b0 MK	277	struct hsr_sup_tag *hsr_stag;
121c33b0 MK	278	unsigned long irqflags;
121c33b0 MK	279	struct sk_buff *skb;
28e458e0 MK	280
	281	*interval = msecs_to_jiffies(HSR_LIFE_CHECK_INTERVAL);
	282	if (hsr->announce_count < 3 && hsr->prot_version == 0) {
	283	type = HSR_TLV_ANNOUNCE;
	284	*interval = msecs_to_jiffies(HSR_ANNOUNCE_INTERVAL);
	285	hsr->announce_count++;
	286	}
	287
78be9217	288	skb = hsr_init_skb(master);
121c33b0 MK	289	if (!skb) {
	290	WARN_ONCE(1, "HSR: Could not send supervision frame\n");
	291	return;
	292	}
	293
b952f4df	294	hsr_stag = skb_put(skb, sizeof(struct hsr_sup_tag));
28e458e0 MK	295	set_hsr_stag_path(hsr_stag, (hsr->prot_version ? 0x0 : 0xf));
28e458e0 MK	296	set_hsr_stag_HSR_ver(hsr_stag, hsr->prot_version);
f421436a	297
ee1c2797	298	/* From HSRv1 on we have separate supervision sequence numbers. */
f266a683	299	spin_lock_irqsave(&master->hsr->seqnr_lock, irqflags);
28e458e0 MK	300	if (hsr->prot_version > 0) {
	301	hsr_stag->sequence_nr = htons(hsr->sup_sequence_nr);
	302	hsr->sup_sequence_nr++;
ee1c2797	303	} else {
28e458e0 MK	304	hsr_stag->sequence_nr = htons(hsr->sequence_nr);
28e458e0 MK	305	hsr->sequence_nr++;
ee1c2797	306	}
f266a683	307	spin_unlock_irqrestore(&master->hsr->seqnr_lock, irqflags);
f421436a	308
b1b4aa91	309	hsr_stag->HSR_TLV_type = type;
ee1c2797	310	/* TODO: Why 12 in HSRv0? */
28e458e0 MK	311	hsr_stag->HSR_TLV_length = hsr->prot_version ?
28e458e0 MK	312	sizeof(struct hsr_sup_payload) : 12;
f421436a	313
f421436a	314	/* Payload: MacAddressA */
b952f4df	315	hsr_sp = skb_put(skb, sizeof(struct hsr_sup_payload));
b1b4aa91	316	ether_addr_copy(hsr_sp->macaddress_A, master->dev->dev_addr);
f421436a	317
78be9217	318	if (skb_put_padto(skb, ETH_ZLEN))
414e7d76	319	return;
ee1c2797	320
f266a683	321	hsr_forward_skb(skb, master);
f421436a	322
121c33b0	323	return;
f421436a AB	324	}
f421436a AB	325
c643ff03 MK	326	static void send_prp_supervision_frame(struct hsr_port *master,
	327	unsigned long *interval)
	328	{
	329	struct hsr_priv *hsr = master->hsr;
	330	struct hsr_sup_payload *hsr_sp;
	331	struct hsr_sup_tag *hsr_stag;
	332	unsigned long irqflags;
	333	struct sk_buff *skb;
c643ff03	334
78be9217	335	skb = hsr_init_skb(master);
c643ff03 MK	336	if (!skb) {
	337	WARN_ONCE(1, "PRP: Could not send supervision frame\n");
	338	return;
	339	}
	340
	341	*interval = msecs_to_jiffies(HSR_LIFE_CHECK_INTERVAL);
	342	hsr_stag = skb_put(skb, sizeof(struct hsr_sup_tag));
	343	set_hsr_stag_path(hsr_stag, (hsr->prot_version ? 0x0 : 0xf));
	344	set_hsr_stag_HSR_ver(hsr_stag, (hsr->prot_version ? 1 : 0));
	345
	346	/* From HSRv1 on we have separate supervision sequence numbers. */
	347	spin_lock_irqsave(&master->hsr->seqnr_lock, irqflags);
	348	hsr_stag->sequence_nr = htons(hsr->sup_sequence_nr);
	349	hsr->sup_sequence_nr++;
	350	hsr_stag->HSR_TLV_type = PRP_TLV_LIFE_CHECK_DD;
	351	hsr_stag->HSR_TLV_length = sizeof(struct hsr_sup_payload);
	352
	353	/* Payload: MacAddressA */
	354	hsr_sp = skb_put(skb, sizeof(struct hsr_sup_payload));
	355	ether_addr_copy(hsr_sp->macaddress_A, master->dev->dev_addr);
	356
78be9217	357	if (skb_put_padto(skb, ETH_ZLEN)) {
c643ff03 MK	358	spin_unlock_irqrestore(&master->hsr->seqnr_lock, irqflags);
	359	return;
	360	}
	361
c643ff03 MK	362	spin_unlock_irqrestore(&master->hsr->seqnr_lock, irqflags);
	363
	364	hsr_forward_skb(skb, master);
	365	}
	366
f421436a AB	367	/* Announce (supervision frame) timer function
f421436a AB	368	*/
dda436b7	369	static void hsr_announce(struct timer_list *t)
f421436a	370	{
70ebe4a4	371	struct hsr_priv *hsr;
c5a75911	372	struct hsr_port *master;
1e027960	373	unsigned long interval;
f421436a	374
dda436b7	375	hsr = from_timer(hsr, t, announce_timer);
f266a683 AB	376
f266a683 AB	377	rcu_read_lock();
c5a75911	378	master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
28e458e0	379	hsr->proto_ops->send_sv_frame(master, &interval);
f421436a	380
c5a75911	381	if (is_admin_up(master->dev))
1e027960	382	mod_timer(&hsr->announce_timer, jiffies + interval);
f266a683 AB	383
f266a683 AB	384	rcu_read_unlock();
f421436a AB	385	}
f421436a AB	386
de0083c7	387	void hsr_del_ports(struct hsr_priv *hsr)
e0a4b997 TY	388	{
	389	struct hsr_port *port;
	390
	391	port = hsr_port_get_hsr(hsr, HSR_PT_SLAVE_A);
	392	if (port)
	393	hsr_del_port(port);
	394
	395	port = hsr_port_get_hsr(hsr, HSR_PT_SLAVE_B);
	396	if (port)
	397	hsr_del_port(port);
	398
	399	port = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
	400	if (port)
	401	hsr_del_port(port);
	402	}
	403
f421436a AB	404	static const struct net_device_ops hsr_device_ops = {
	405	.ndo_change_mtu = hsr_dev_change_mtu,
	406	.ndo_open = hsr_dev_open,
	407	.ndo_stop = hsr_dev_close,
	408	.ndo_start_xmit = hsr_dev_xmit,
1cc1eb52	409	.ndo_fix_features = hsr_fix_features,
f421436a AB	410	};
f421436a AB	411
4c3477dc AB	412	static struct device_type hsr_type = {
	413	.name = "hsr",
	414	};
f421436a	415
28e458e0 MK	416	static struct hsr_proto_ops hsr_ops = {
28e458e0 MK	417	.send_sv_frame = send_hsr_supervision_frame,
fa4dc895 MK	418	.create_tagged_frame = hsr_create_tagged_frame,
fa4dc895 MK	419	.get_untagged_frame = hsr_get_untagged_frame,
dcf0cd1c	420	.drop_frame = hsr_drop_frame,
fa4dc895	421	.fill_frame_info = hsr_fill_frame_info,
451d8123	422	.invalid_dan_ingress_frame = hsr_invalid_dan_ingress_frame,
28e458e0 MK	423	};
28e458e0 MK	424
fa4dc895	425	static struct hsr_proto_ops prp_ops = {
c643ff03	426	.send_sv_frame = send_prp_supervision_frame,
451d8123 MK	427	.create_tagged_frame = prp_create_tagged_frame,
	428	.get_untagged_frame = prp_get_untagged_frame,
	429	.drop_frame = prp_drop_frame,
	430	.fill_frame_info = prp_fill_frame_info,
	431	.handle_san_frame = prp_handle_san_frame,
	432	.update_san_info = prp_update_san_info,
c643ff03 MK	433	};
c643ff03 MK	434
f421436a AB	435	void hsr_dev_setup(struct net_device *dev)
f421436a AB	436	{
d4af4c0a	437	eth_hw_addr_random(dev);
f421436a AB	438
f421436a AB	439	ether_setup(dev);
b3e3893e	440	dev->min_mtu = 0;
4c3477dc AB	441	dev->header_ops = &hsr_header_ops;
	442	dev->netdev_ops = &hsr_device_ops;
	443	SET_NETDEV_DEVTYPE(dev, &hsr_type);
9ad09c5c	444	dev->priv_flags \|= IFF_NO_QUEUE;
f421436a	445
cf124db5	446	dev->needs_free_netdev = true;
1cc1eb52 AB	447
	448	dev->hw_features = NETIF_F_SG \| NETIF_F_FRAGLIST \| NETIF_F_HIGHDMA \|
	449	NETIF_F_GSO_MASK \| NETIF_F_HW_CSUM \|
	450	NETIF_F_HW_VLAN_CTAG_TX;
	451
	452	dev->features = dev->hw_features;
	453
	454	/* Prevent recursive tx locking */
	455	dev->features \|= NETIF_F_LLTX;
	456	/* VLAN on top of HSR needs testing and probably some work on
	457	* hsr_header_create() etc.
	458	*/
	459	dev->features \|= NETIF_F_VLAN_CHALLENGED;
4c3477dc AB	460	/* Not sure about this. Taken from bridge code. netdev_features.h says
	461	* it means "Does not change network namespaces".
	462	*/
	463	dev->features \|= NETIF_F_NETNS_LOCAL;
f421436a AB	464	}
f421436a AB	465
f421436a AB	466	/* Return true if dev is a HSR master; return false otherwise.
f421436a AB	467	*/
dcf0cd1c	468	bool is_hsr_master(struct net_device *dev)
f421436a AB	469	{
	470	return (dev->netdev_ops->ndo_start_xmit == hsr_dev_xmit);
	471	}
dcf0cd1c	472	EXPORT_SYMBOL(is_hsr_master);
f421436a	473
f421436a	474	/* Default multicast address for HSR Supervision frames */
e83abe37	475	static const unsigned char def_multicast_addr[ETH_ALEN] __aligned(2) = {
f421436a AB	476	0x01, 0x15, 0x4e, 0x00, 0x01, 0x00
	477	};
	478
	479	int hsr_dev_finalize(struct net_device hsr_dev, struct net_device slave[2],
13eeb5fe TY	480	unsigned char multicast_spec, u8 protocol_version,
13eeb5fe TY	481	struct netlink_ext_ack *extack)
f421436a	482	{
ccfc9df1	483	bool unregister = false;
70ebe4a4	484	struct hsr_priv *hsr;
f421436a AB	485	int res;
f421436a AB	486
70ebe4a4	487	hsr = netdev_priv(hsr_dev);
c5a75911	488	INIT_LIST_HEAD(&hsr->ports);
70ebe4a4 AB	489	INIT_LIST_HEAD(&hsr->node_db);
70ebe4a4 AB	490	INIT_LIST_HEAD(&hsr->self_node_db);
92a35678	491	spin_lock_init(&hsr->list_lock);
51f3c605 AB	492
	493	ether_addr_copy(hsr_dev->dev_addr, slave[0]->dev_addr);
	494
c643ff03	495	/* initialize protocol specific functions */
451d8123 MK	496	if (protocol_version == PRP_V1) {
	497	/* For PRP, lan_id has most significant 3 bits holding
	498	* the net_id of PRP_LAN_ID
	499	*/
	500	hsr->net_id = PRP_LAN_ID << 1;
c643ff03	501	hsr->proto_ops = &prp_ops;
451d8123	502	} else {
c643ff03	503	hsr->proto_ops = &hsr_ops;
451d8123	504	}
c643ff03	505
51f3c605	506	/* Make sure we recognize frames from ourselves in hsr_rcv() */
92a35678	507	res = hsr_create_self_node(hsr, hsr_dev->dev_addr,
51f3c605 AB	508	slave[1]->dev_addr);
	509	if (res < 0)
	510	return res;
	511
70ebe4a4	512	spin_lock_init(&hsr->seqnr_lock);
f421436a	513	/* Overflow soon to find bugs easier: */
f266a683	514	hsr->sequence_nr = HSR_SEQNR_START;
ee1c2797	515	hsr->sup_sequence_nr = HSR_SUP_SEQNR_START;
f421436a	516
dda436b7 KC	517	timer_setup(&hsr->announce_timer, hsr_announce, 0);
dda436b7 KC	518	timer_setup(&hsr->prune_timer, hsr_prune_nodes, 0);
abff7162	519
70ebe4a4 AB	520	ether_addr_copy(hsr->sup_multicast_addr, def_multicast_addr);
70ebe4a4 AB	521	hsr->sup_multicast_addr[ETH_ALEN - 1] = multicast_spec;
f421436a	522
b1b4aa91	523	hsr->prot_version = protocol_version;
ee1c2797	524
f421436a AB	525	/* Make sure the 1st call to netif_carrier_on() gets through */
	526	netif_carrier_off(hsr_dev);
	527
13eeb5fe	528	res = hsr_add_port(hsr, hsr_dev, HSR_PT_MASTER, extack);
f421436a	529	if (res)
1d19e2d5	530	goto err_add_master;
51f3c605	531
c5a75911	532	res = register_netdevice(hsr_dev);
51f3c605	533	if (res)
1d19e2d5	534	goto err_unregister;
c5a75911	535
ccfc9df1 TY	536	unregister = true;
ccfc9df1 TY	537
13eeb5fe	538	res = hsr_add_port(hsr, slave[0], HSR_PT_SLAVE_A, extack);
c5a75911	539	if (res)
ccfc9df1	540	goto err_unregister;
1d19e2d5	541
13eeb5fe	542	res = hsr_add_port(hsr, slave[1], HSR_PT_SLAVE_B, extack);
c5a75911	543	if (res)
ccfc9df1	544	goto err_unregister;
f421436a	545
1d19e2d5	546	hsr_debugfs_init(hsr, hsr_dev);
15db6e0d	547	mod_timer(&hsr->prune_timer, jiffies + msecs_to_jiffies(PRUNE_PERIOD));
abff7162	548
f421436a	549	return 0;
c5a75911	550
1d19e2d5	551	err_unregister:
e0a4b997	552	hsr_del_ports(hsr);
1d19e2d5	553	err_add_master:
92a35678	554	hsr_del_self_node(hsr);
c5a75911	555
ccfc9df1 TY	556	if (unregister)
ccfc9df1 TY	557	unregister_netdevice(hsr_dev);
c5a75911	558	return res;
f421436a	559	}