[deliverable/linux.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 */


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

/* 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 hsr_ethhdr_sp {
	struct ethhdr		ethhdr;
	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 list_head	hsr_list;	/* List of hsr devices */
	struct rcu_head		rcu_head;
	struct list_head	ports;
	struct list_head	node_db;	/* Other 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;
	spinlock_t seqnr_lock;			/* locking for sequence_nr */
	unsigned char		sup_multicast_addr[ETH_ALEN];
};

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

#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 */
	32
	33
	34	/* How often shall we check for broken ring and remove node entries older than
	35	* HSR_NODE_FORGET_TIME?
	36	*/
	37	#define PRUNE_PERIOD 3000 /* ms */
	38
	39
	40	#define HSR_TLV_ANNOUNCE 22
	41	#define HSR_TLV_LIFE_CHECK 23
	42
	43
	44	/* HSR Tag.
	45	* As defined in IEC-62439-3:2010, the HSR tag is really { ethertype = 0x88FB,
	46	* path, LSDU_size, sequence Nr }. But we let eth_header() create { h_dest,
	47	* h_source, h_proto = 0x88FB }, and add { path, LSDU_size, sequence Nr,
	48	* encapsulated protocol } instead.
70ebe4a4 AB	49	*
70ebe4a4 AB	50	* Field names as defined in the IEC:2010 standard for HSR.
f421436a	51	*/
f421436a AB	52	struct hsr_tag {
	53	__be16 path_and_LSDU_size;
	54	__be16 sequence_nr;
	55	__be16 encap_proto;
	56	} __packed;
	57
70ebe4a4	58	#define HSR_HLEN 6
f421436a AB	59
	60	/* The helper functions below assumes that 'path' occupies the 4 most
	61	* significant bits of the 16-bit field shared by 'path' and 'LSDU_size' (or
	62	* equivalently, the 4 most significant bits of HSR tag byte 14).
	63	*
	64	* This is unclear in the IEC specification; its definition of MAC addresses
	65	* indicates the spec is written with the least significant bit first (to the
	66	* left). This, however, would mean that the LSDU field would be split in two
	67	* with the path field in-between, which seems strange. I'm guessing the MAC
	68	* address definition is in error.
	69	*/
	70	static inline u16 get_hsr_tag_path(struct hsr_tag *ht)
	71	{
	72	return ntohs(ht->path_and_LSDU_size) >> 12;
	73	}
	74
	75	static inline u16 get_hsr_tag_LSDU_size(struct hsr_tag *ht)
	76	{
	77	return ntohs(ht->path_and_LSDU_size) & 0x0FFF;
	78	}
	79
	80	static inline void set_hsr_tag_path(struct hsr_tag *ht, u16 path)
	81	{
	82	ht->path_and_LSDU_size = htons(
	83	(ntohs(ht->path_and_LSDU_size) & 0x0FFF) \| (path << 12));
	84	}
	85
	86	static inline void set_hsr_tag_LSDU_size(struct hsr_tag *ht, u16 LSDU_size)
	87	{
	88	ht->path_and_LSDU_size = htons(
	89	(ntohs(ht->path_and_LSDU_size) & 0xF000) \|
	90	(LSDU_size & 0x0FFF));
	91	}
	92
	93	struct hsr_ethhdr {
	94	struct ethhdr ethhdr;
	95	struct hsr_tag hsr_tag;
	96	} __packed;
	97
	98
	99	/* HSR Supervision Frame data types.
	100	* Field names as defined in the IEC:2010 standard for HSR.
	101	*/
	102	struct hsr_sup_tag {
	103	__be16 path_and_HSR_Ver;
	104	__be16 sequence_nr;
	105	__u8 HSR_TLV_Type;
	106	__u8 HSR_TLV_Length;
	107	} __packed;
	108
	109	struct hsr_sup_payload {
	110	unsigned char MacAddressA[ETH_ALEN];
	111	} __packed;
	112
	113	static inline u16 get_hsr_stag_path(struct hsr_sup_tag *hst)
	114	{
	115	return get_hsr_tag_path((struct hsr_tag *) hst);
	116	}
	117
	118	static inline u16 get_hsr_stag_HSR_ver(struct hsr_sup_tag *hst)
	119	{
	120	return get_hsr_tag_LSDU_size((struct hsr_tag *) hst);
	121	}
	122
123	static inline void set_hsr_stag_path(struct hsr_sup_tag *hst, u16 path)
124	{
125	set_hsr_tag_path((struct hsr_tag *) hst, path);
126	}
127
128	static inline void set_hsr_stag_HSR_Ver(struct hsr_sup_tag *hst, u16 HSR_Ver)
129	{
130	set_hsr_tag_LSDU_size((struct hsr_tag *) hst, HSR_Ver);
131	}
132
133	struct hsr_ethhdr_sp {
134	struct ethhdr ethhdr;
135	struct hsr_sup_tag hsr_sup;
136	} __packed;
137
138
c5a75911 AB	139	enum hsr_port_type {
	140	HSR_PT_NONE = 0, /* Must be 0, used by framereg */
	141	HSR_PT_SLAVE_A,
	142	HSR_PT_SLAVE_B,
	143	HSR_PT_INTERLINK,
	144	HSR_PT_MASTER,
	145	HSR_PT_PORTS, /* This must be the last item in the enum */
	146	};
	147
	148	struct hsr_port {
	149	struct list_head port_list;
	150	struct net_device *dev;
	151	struct hsr_priv *hsr;
	152	enum hsr_port_type type;
f421436a	153	};
f421436a AB	154
	155	struct hsr_priv {
	156	struct list_head hsr_list; /* List of hsr devices */
	157	struct rcu_head rcu_head;
c5a75911	158	struct list_head ports;
f421436a AB	159	struct list_head node_db; /* Other HSR nodes */
	160	struct list_head self_node_db; /* MACs of slaves */
	161	struct timer_list announce_timer; /* Supervision frame dispatch */
abff7162	162	struct timer_list prune_timer;
f421436a AB	163	int announce_count;
	164	u16 sequence_nr;
	165	spinlock_t seqnr_lock; /* locking for sequence_nr */
	166	unsigned char sup_multicast_addr[ETH_ALEN];
	167	};
	168
c5a75911	169	struct hsr_port hsr_port_get_hsr(struct hsr_priv hsr, enum hsr_port_type pt);
f421436a	170
70ebe4a4	171	#endif /* __HSR_PRIVATE_H */