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