1 /* Copyright 2011-2014 Autronica Fire and Security AS
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)
9 * 2011-2014 Arvid Brodin, arvid.brodin@alten.se
12 #ifndef __HSR_PRIVATE_H
13 #define __HSR_PRIVATE_H
15 #include <linux/netdevice.h>
16 #include <linux/list.h>
19 /* Time constants as specified in the HSR specification (IEC-62439-3 2010)
21 * All values in milliseconds.
23 #define HSR_LIFE_CHECK_INTERVAL 2000 /* ms */
24 #define HSR_NODE_FORGET_TIME 60000 /* ms */
25 #define HSR_ANNOUNCE_INTERVAL 100 /* ms */
28 /* By how much may slave1 and slave2 timestamps of latest received frame from
29 * each node differ before we notify of communication problem?
31 #define MAX_SLAVE_DIFF 3000 /* ms */
34 /* How often shall we check for broken ring and remove node entries older than
35 * HSR_NODE_FORGET_TIME?
37 #define PRUNE_PERIOD 3000 /* ms */
40 #define HSR_TLV_ANNOUNCE 22
41 #define HSR_TLV_LIFE_CHECK 23
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.
50 * Field names as defined in the IEC:2010 standard for HSR.
53 __be16 path_and_LSDU_size;
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).
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.
70 static inline u16 get_hsr_tag_path(struct hsr_tag *ht)
72 return ntohs(ht->path_and_LSDU_size) >> 12;
75 static inline u16 get_hsr_tag_LSDU_size(struct hsr_tag *ht)
77 return ntohs(ht->path_and_LSDU_size) & 0x0FFF;
80 static inline void set_hsr_tag_path(struct hsr_tag *ht, u16 path)
82 ht->path_and_LSDU_size = htons(
83 (ntohs(ht->path_and_LSDU_size) & 0x0FFF) | (path << 12));
86 static inline void set_hsr_tag_LSDU_size(struct hsr_tag *ht, u16 LSDU_size)
88 ht->path_and_LSDU_size = htons(
89 (ntohs(ht->path_and_LSDU_size) & 0xF000) |
90 (LSDU_size & 0x0FFF));
95 struct hsr_tag hsr_tag;
99 /* HSR Supervision Frame data types.
100 * Field names as defined in the IEC:2010 standard for HSR.
103 __be16 path_and_HSR_Ver;
109 struct hsr_sup_payload {
110 unsigned char MacAddressA[ETH_ALEN];
113 static inline u16 get_hsr_stag_path(struct hsr_sup_tag *hst)
115 return get_hsr_tag_path((struct hsr_tag *) hst);
118 static inline u16 get_hsr_stag_HSR_ver(struct hsr_sup_tag *hst)
120 return get_hsr_tag_LSDU_size((struct hsr_tag *) hst);
123 static inline void set_hsr_stag_path(struct hsr_sup_tag *hst, u16 path)
125 set_hsr_tag_path((struct hsr_tag *) hst, path);
128 static inline void set_hsr_stag_HSR_Ver(struct hsr_sup_tag *hst, u16 HSR_Ver)
130 set_hsr_tag_LSDU_size((struct hsr_tag *) hst, HSR_Ver);
133 struct hsr_ethhdr_sp {
134 struct ethhdr ethhdr;
135 struct hsr_sup_tag hsr_sup;
140 HSR_PT_NONE = 0, /* Must be 0, used by framereg */
145 HSR_PT_PORTS, /* This must be the last item in the enum */
149 struct list_head port_list;
150 struct net_device *dev;
151 struct hsr_priv *hsr;
152 enum hsr_port_type type;
156 struct list_head hsr_list; /* List of hsr devices */
157 struct rcu_head rcu_head;
158 struct list_head ports;
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 */
162 struct timer_list prune_timer;
165 spinlock_t seqnr_lock; /* locking for sequence_nr */
166 unsigned char sup_multicast_addr[ETH_ALEN];
169 struct hsr_port *hsr_port_get_hsr(struct hsr_priv *hsr, enum hsr_port_type pt);
171 #endif /* __HSR_PRIVATE_H */