[mirror_ubuntu-zesty-kernel.git] / net / hsr / hsr_main.h

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

#ifndef __HSR_PRIVATE_H
#define __HSR_PRIVATE_H

#include <linux/netdevice.h>
#include <linux/list.h>


/* Time constants as specified in the HSR specification (IEC-62439-3 2010)
 * Table 8.
 * All values in milliseconds.
 */
#define HSR_LIFE_CHECK_INTERVAL		 2000 /* ms */
#define HSR_NODE_FORGET_TIME		60000 /* ms */
#define HSR_ANNOUNCE_INTERVAL		  100 /* ms */


/* By how much may slave1 and slave2 timestamps of latest received frame from
 * each node differ before we notify of communication problem?
 */
#define MAX_SLAVE_DIFF			 3000 /* ms */
#define HSR_SEQNR_START			(USHRT_MAX - 1024)
#define HSR_SUP_SEQNR_START		(HSR_SEQNR_START / 2)


/* How often shall we check for broken ring and remove node entries older than
 * HSR_NODE_FORGET_TIME?
 */
#define PRUNE_PERIOD			 3000 /* ms */


#define HSR_TLV_ANNOUNCE		   22
#define HSR_TLV_LIFE_CHECK		   23


/* HSR Tag.
 * As defined in IEC-62439-3:2010, the HSR tag is really { ethertype = 0x88FB,
 * path, LSDU_size, sequence Nr }. But we let eth_header() create { h_dest,
 * h_source, h_proto = 0x88FB }, and add { path, LSDU_size, sequence Nr,
 * encapsulated protocol } instead.
 *
 * Field names as defined in the IEC:2010 standard for HSR.
 */
struct hsr_tag {
	__be16		path_and_LSDU_size;
	__be16		sequence_nr;
	__be16		encap_proto;
} __packed;

#define HSR_HLEN	6

#define HSR_V1_SUP_LSDUSIZE		52

/* The helper functions below assumes that 'path' occupies the 4 most
 * significant bits of the 16-bit field shared by 'path' and 'LSDU_size' (or
 * equivalently, the 4 most significant bits of HSR tag byte 14).
 *
 * This is unclear in the IEC specification; its definition of MAC addresses
 * indicates the spec is written with the least significant bit first (to the
 * left). This, however, would mean that the LSDU field would be split in two
 * with the path field in-between, which seems strange. I'm guessing the MAC
 * address definition is in error.
 */
static inline u16 get_hsr_tag_path(struct hsr_tag *ht)
{
	return ntohs(ht->path_and_LSDU_size) >> 12;
}

static inline u16 get_hsr_tag_LSDU_size(struct hsr_tag *ht)
{
	return ntohs(ht->path_and_LSDU_size) & 0x0FFF;
}

static inline void set_hsr_tag_path(struct hsr_tag *ht, u16 path)
{
	ht->path_and_LSDU_size = htons(
			(ntohs(ht->path_and_LSDU_size) & 0x0FFF) | (path << 12));
}

static inline void set_hsr_tag_LSDU_size(struct hsr_tag *ht, u16 LSDU_size)
{
	ht->path_and_LSDU_size = htons(
			(ntohs(ht->path_and_LSDU_size) & 0xF000) |
			(LSDU_size & 0x0FFF));
}

struct hsr_ethhdr {
	struct ethhdr	ethhdr;
	struct hsr_tag	hsr_tag;
} __packed;


/* HSR Supervision Frame data types.
 * Field names as defined in the IEC:2010 standard for HSR.
 */
struct hsr_sup_tag {
	__be16		path_and_HSR_Ver;
	__be16		sequence_nr;
	__u8		HSR_TLV_Type;
	__u8		HSR_TLV_Length;
} __packed;

struct hsr_sup_payload {
	unsigned char	MacAddressA[ETH_ALEN];
} __packed;

static inline u16 get_hsr_stag_path(struct hsr_sup_tag *hst)
{
	return get_hsr_tag_path((struct hsr_tag *) hst);
}

static inline u16 get_hsr_stag_HSR_ver(struct hsr_sup_tag *hst)
{
	return get_hsr_tag_LSDU_size((struct hsr_tag *) hst);
}

static inline void set_hsr_stag_path(struct hsr_sup_tag *hst, u16 path)
{
	set_hsr_tag_path((struct hsr_tag *) hst, path);
}

static inline void set_hsr_stag_HSR_Ver(struct hsr_sup_tag *hst, u16 HSR_Ver)
{
	set_hsr_tag_LSDU_size((struct hsr_tag *) hst, HSR_Ver);
}

struct hsrv0_ethhdr_sp {
	struct ethhdr		ethhdr;
	struct hsr_sup_tag	hsr_sup;
} __packed;

struct hsrv1_ethhdr_sp {
	struct ethhdr		ethhdr;
	struct hsr_tag		hsr;
	struct hsr_sup_tag	hsr_sup;
} __packed;


enum hsr_port_type {
	HSR_PT_NONE = 0,	/* Must be 0, used by framereg */
	HSR_PT_SLAVE_A,
	HSR_PT_SLAVE_B,
	HSR_PT_INTERLINK,
	HSR_PT_MASTER,
	HSR_PT_PORTS,	/* This must be the last item in the enum */
};

struct hsr_port {
	struct list_head	port_list;
	struct net_device	*dev;
	struct hsr_priv		*hsr;
	enum hsr_port_type	type;
};

struct hsr_priv {
	struct rcu_head		rcu_head;
	struct list_head	ports;
	struct list_head	node_db;	/* Known HSR nodes */
	struct list_head	self_node_db;	/* MACs of slaves */
	struct timer_list	announce_timer;	/* Supervision frame dispatch */
	struct timer_list	prune_timer;
	int announce_count;
	u16 sequence_nr;
	u16 sup_sequence_nr;			/* For HSRv1 separate seq_nr for supervision */
	u8 protVersion;					/* Indicate if HSRv0 or HSRv1. */
	spinlock_t seqnr_lock;			/* locking for sequence_nr */
	unsigned char		sup_multicast_addr[ETH_ALEN];
};

#define hsr_for_each_port(hsr, port) \
	list_for_each_entry_rcu((port), &(hsr)->ports, port_list)

struct hsr_port *hsr_port_get_hsr(struct hsr_priv *hsr, enum hsr_port_type pt);

/* Caller must ensure skb is a valid HSR frame */
static inline u16 hsr_get_skb_sequence_nr(struct sk_buff *skb)
{
	struct hsr_ethhdr *hsr_ethhdr;

	hsr_ethhdr = (struct hsr_ethhdr *) skb_mac_header(skb);
	return ntohs(hsr_ethhdr->hsr_tag.sequence_nr);
}

#endif /*  __HSR_PRIVATE_H */
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	*/
f421436a AB	11
70ebe4a4 AB	12	#ifndef __HSR_PRIVATE_H
70ebe4a4 AB	13	#define __HSR_PRIVATE_H
f421436a AB	14
	15	#include <linux/netdevice.h>
	16	#include <linux/list.h>
	17
	18
	19	/* Time constants as specified in the HSR specification (IEC-62439-3 2010)
	20	* Table 8.
	21	* All values in milliseconds.
	22	*/
	23	#define HSR_LIFE_CHECK_INTERVAL 2000 /* ms */
	24	#define HSR_NODE_FORGET_TIME 60000 /* ms */
	25	#define HSR_ANNOUNCE_INTERVAL 100 /* ms */
	26
	27
	28	/* By how much may slave1 and slave2 timestamps of latest received frame from
	29	* each node differ before we notify of communication problem?
	30	*/
	31	#define MAX_SLAVE_DIFF 3000 /* ms */
f266a683	32	#define HSR_SEQNR_START (USHRT_MAX - 1024)
ee1c2797	33	#define HSR_SUP_SEQNR_START (HSR_SEQNR_START / 2)
f421436a AB	34
	35
	36	/* How often shall we check for broken ring and remove node entries older than
	37	* HSR_NODE_FORGET_TIME?
	38	*/
	39	#define PRUNE_PERIOD 3000 /* ms */
	40
	41
	42	#define HSR_TLV_ANNOUNCE 22
	43	#define HSR_TLV_LIFE_CHECK 23
	44
	45
	46	/* HSR Tag.
	47	* As defined in IEC-62439-3:2010, the HSR tag is really { ethertype = 0x88FB,
	48	* path, LSDU_size, sequence Nr }. But we let eth_header() create { h_dest,
	49	* h_source, h_proto = 0x88FB }, and add { path, LSDU_size, sequence Nr,
	50	* encapsulated protocol } instead.
70ebe4a4 AB	51	*
70ebe4a4 AB	52	* Field names as defined in the IEC:2010 standard for HSR.
f421436a	53	*/
f421436a AB	54	struct hsr_tag {
	55	__be16 path_and_LSDU_size;
	56	__be16 sequence_nr;
	57	__be16 encap_proto;
	58	} __packed;
	59
70ebe4a4	60	#define HSR_HLEN 6
f421436a	61
ee1c2797 PH	62	#define HSR_V1_SUP_LSDUSIZE 52
ee1c2797 PH	63
f421436a AB	64	/* The helper functions below assumes that 'path' occupies the 4 most
	65	* significant bits of the 16-bit field shared by 'path' and 'LSDU_size' (or
	66	* equivalently, the 4 most significant bits of HSR tag byte 14).
	67	*
	68	* This is unclear in the IEC specification; its definition of MAC addresses
	69	* indicates the spec is written with the least significant bit first (to the
	70	* left). This, however, would mean that the LSDU field would be split in two
	71	* with the path field in-between, which seems strange. I'm guessing the MAC
	72	* address definition is in error.
	73	*/
	74	static inline u16 get_hsr_tag_path(struct hsr_tag *ht)
	75	{
	76	return ntohs(ht->path_and_LSDU_size) >> 12;
	77	}
	78
	79	static inline u16 get_hsr_tag_LSDU_size(struct hsr_tag *ht)
	80	{
	81	return ntohs(ht->path_and_LSDU_size) & 0x0FFF;
	82	}
	83
	84	static inline void set_hsr_tag_path(struct hsr_tag *ht, u16 path)
	85	{
	86	ht->path_and_LSDU_size = htons(
	87	(ntohs(ht->path_and_LSDU_size) & 0x0FFF) \| (path << 12));
	88	}
	89
	90	static inline void set_hsr_tag_LSDU_size(struct hsr_tag *ht, u16 LSDU_size)
	91	{
	92	ht->path_and_LSDU_size = htons(
	93	(ntohs(ht->path_and_LSDU_size) & 0xF000) \|
	94	(LSDU_size & 0x0FFF));
	95	}
	96
	97	struct hsr_ethhdr {
	98	struct ethhdr ethhdr;
	99	struct hsr_tag hsr_tag;
	100	} __packed;
	101
	102
	103	/* HSR Supervision Frame data types.
	104	* Field names as defined in the IEC:2010 standard for HSR.
	105	*/
	106	struct hsr_sup_tag {
	107	__be16 path_and_HSR_Ver;
	108	__be16 sequence_nr;
	109	__u8 HSR_TLV_Type;
	110	__u8 HSR_TLV_Length;
	111	} __packed;
	112
	113	struct hsr_sup_payload {
	114	unsigned char MacAddressA[ETH_ALEN];
	115	} __packed;
	116
	117	static inline u16 get_hsr_stag_path(struct hsr_sup_tag *hst)
	118	{
	119	return get_hsr_tag_path((struct hsr_tag *) hst);
	120	}
	121
	122	static inline u16 get_hsr_stag_HSR_ver(struct hsr_sup_tag *hst)
	123	{
	124	return get_hsr_tag_LSDU_size((struct hsr_tag *) hst);
	125	}
	126
	127	static inline void set_hsr_stag_path(struct hsr_sup_tag *hst, u16 path)
128	{
129	set_hsr_tag_path((struct hsr_tag *) hst, path);
130	}
131
132	static inline void set_hsr_stag_HSR_Ver(struct hsr_sup_tag *hst, u16 HSR_Ver)
133	{
134	set_hsr_tag_LSDU_size((struct hsr_tag *) hst, HSR_Ver);
135	}
136
ee1c2797 PH	137	struct hsrv0_ethhdr_sp {
	138	struct ethhdr ethhdr;
	139	struct hsr_sup_tag hsr_sup;
	140	} __packed;
	141
	142	struct hsrv1_ethhdr_sp {
f421436a	143	struct ethhdr ethhdr;
ee1c2797	144	struct hsr_tag hsr;
f421436a AB	145	struct hsr_sup_tag hsr_sup;
	146	} __packed;
	147
	148
c5a75911 AB	149	enum hsr_port_type {
	150	HSR_PT_NONE = 0, /* Must be 0, used by framereg */
	151	HSR_PT_SLAVE_A,
	152	HSR_PT_SLAVE_B,
	153	HSR_PT_INTERLINK,
	154	HSR_PT_MASTER,
	155	HSR_PT_PORTS, /* This must be the last item in the enum */
	156	};
	157
	158	struct hsr_port {
	159	struct list_head port_list;
	160	struct net_device *dev;
	161	struct hsr_priv *hsr;
	162	enum hsr_port_type type;
f421436a	163	};
f421436a AB	164
f421436a AB	165	struct hsr_priv {
f421436a	166	struct rcu_head rcu_head;
c5a75911	167	struct list_head ports;
f266a683	168	struct list_head node_db; /* Known HSR nodes */
f421436a AB	169	struct list_head self_node_db; /* MACs of slaves */
f421436a AB	170	struct timer_list announce_timer; /* Supervision frame dispatch */
abff7162	171	struct timer_list prune_timer;
f421436a AB	172	int announce_count;
f421436a AB	173	u16 sequence_nr;
ee1c2797 PH	174	u16 sup_sequence_nr; /* For HSRv1 separate seq_nr for supervision */
ee1c2797 PH	175	u8 protVersion; /* Indicate if HSRv0 or HSRv1. */
f421436a AB	176	spinlock_t seqnr_lock; /* locking for sequence_nr */
	177	unsigned char sup_multicast_addr[ETH_ALEN];
	178	};
	179
f266a683 AB	180	#define hsr_for_each_port(hsr, port) \
	181	list_for_each_entry_rcu((port), &(hsr)->ports, port_list)
	182
c5a75911	183	struct hsr_port hsr_port_get_hsr(struct hsr_priv hsr, enum hsr_port_type pt);
f421436a	184
f266a683 AB	185	/* Caller must ensure skb is a valid HSR frame */
	186	static inline u16 hsr_get_skb_sequence_nr(struct sk_buff *skb)
	187	{
	188	struct hsr_ethhdr *hsr_ethhdr;
	189
	190	hsr_ethhdr = (struct hsr_ethhdr *) skb_mac_header(skb);
	191	return ntohs(hsr_ethhdr->hsr_tag.sequence_nr);
	192	}
	193
70ebe4a4	194	#endif /* __HSR_PRIVATE_H */