1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright 2011-2014 Autronica Fire and Security AS
5 * 2011-2014 Arvid Brodin, arvid.brodin@alten.se
7 * include file for HSR and PRP.
10 #ifndef __HSR_PRIVATE_H
11 #define __HSR_PRIVATE_H
13 #include <linux/netdevice.h>
14 #include <linux/list.h>
15 #include <linux/if_vlan.h>
16 #include <linux/if_hsr.h>
18 /* Time constants as specified in the HSR specification (IEC-62439-3 2010)
20 * All values in milliseconds.
22 #define HSR_LIFE_CHECK_INTERVAL 2000 /* ms */
23 #define HSR_NODE_FORGET_TIME 60000 /* ms */
24 #define HSR_ANNOUNCE_INTERVAL 100 /* ms */
26 /* By how much may slave1 and slave2 timestamps of latest received frame from
27 * each node differ before we notify of communication problem?
29 #define MAX_SLAVE_DIFF 3000 /* ms */
30 #define HSR_SEQNR_START (USHRT_MAX - 1024)
31 #define HSR_SUP_SEQNR_START (HSR_SEQNR_START / 2)
33 /* How often shall we check for broken ring and remove node entries older than
34 * HSR_NODE_FORGET_TIME?
36 #define PRUNE_PERIOD 3000 /* ms */
38 #define HSR_TLV_ANNOUNCE 22
39 #define HSR_TLV_LIFE_CHECK 23
40 /* PRP V1 life check for Duplicate discard */
41 #define PRP_TLV_LIFE_CHECK_DD 20
42 /* PRP V1 life check for Duplicate Accept */
43 #define PRP_TLV_LIFE_CHECK_DA 21
46 * As defined in IEC-62439-3:2010, the HSR tag is really { ethertype = 0x88FB,
47 * path, LSDU_size, sequence Nr }. But we let eth_header() create { h_dest,
48 * h_source, h_proto = 0x88FB }, and add { path, LSDU_size, sequence Nr,
49 * encapsulated protocol } instead.
51 * Field names as defined in the IEC:2010 standard for HSR.
54 __be16 path_and_LSDU_size;
61 #define HSR_V1_SUP_LSDUSIZE 52
63 /* The helper functions below assumes that 'path' occupies the 4 most
64 * significant bits of the 16-bit field shared by 'path' and 'LSDU_size' (or
65 * equivalently, the 4 most significant bits of HSR tag byte 14).
67 * This is unclear in the IEC specification; its definition of MAC addresses
68 * indicates the spec is written with the least significant bit first (to the
69 * left). This, however, would mean that the LSDU field would be split in two
70 * with the path field in-between, which seems strange. I'm guessing the MAC
71 * address definition is in error.
74 static inline void set_hsr_tag_path(struct hsr_tag *ht, u16 path)
76 ht->path_and_LSDU_size =
77 htons((ntohs(ht->path_and_LSDU_size) & 0x0FFF) | (path << 12));
80 static inline void set_hsr_tag_LSDU_size(struct hsr_tag *ht, u16 LSDU_size)
82 ht->path_and_LSDU_size = htons((ntohs(ht->path_and_LSDU_size) &
83 0xF000) | (LSDU_size & 0x0FFF));
88 struct hsr_tag hsr_tag;
91 struct hsr_vlan_ethhdr {
92 struct vlan_ethhdr vlanhdr;
93 struct hsr_tag hsr_tag;
96 /* HSR/PRP Supervision Frame data types.
97 * Field names as defined in the IEC:2010 standard for HSR.
100 __be16 path_and_HSR_ver;
106 struct hsr_sup_payload {
107 unsigned char macaddress_A[ETH_ALEN];
110 static inline void set_hsr_stag_path(struct hsr_sup_tag *hst, u16 path)
112 set_hsr_tag_path((struct hsr_tag *)hst, path);
115 static inline void set_hsr_stag_HSR_ver(struct hsr_sup_tag *hst, u16 HSR_ver)
117 set_hsr_tag_LSDU_size((struct hsr_tag *)hst, HSR_ver);
120 struct hsrv0_ethhdr_sp {
121 struct ethhdr ethhdr;
122 struct hsr_sup_tag hsr_sup;
125 struct hsrv1_ethhdr_sp {
126 struct ethhdr ethhdr;
128 struct hsr_sup_tag hsr_sup;
132 HSR_PT_NONE = 0, /* Must be 0, used by framereg */
137 HSR_PT_PORTS, /* This must be the last item in the enum */
140 /* PRP Redunancy Control Trailor (RCT).
141 * As defined in IEC-62439-4:2012, the PRP RCT is really { sequence Nr,
142 * Lan indentifier (LanId), LSDU_size and PRP_suffix = 0x88FB }.
144 * Field names as defined in the IEC:2012 standard for PRP.
148 __be16 lan_id_and_LSDU_size;
152 static inline u16 get_prp_LSDU_size(struct prp_rct *rct)
154 return ntohs(rct->lan_id_and_LSDU_size) & 0x0FFF;
157 static inline void set_prp_lan_id(struct prp_rct *rct, u16 lan_id)
159 rct->lan_id_and_LSDU_size = htons((ntohs(rct->lan_id_and_LSDU_size) &
160 0x0FFF) | (lan_id << 12));
162 static inline void set_prp_LSDU_size(struct prp_rct *rct, u16 LSDU_size)
164 rct->lan_id_and_LSDU_size = htons((ntohs(rct->lan_id_and_LSDU_size) &
165 0xF000) | (LSDU_size & 0x0FFF));
169 struct list_head port_list;
170 struct net_device *dev;
171 struct hsr_priv *hsr;
172 enum hsr_port_type type;
175 struct hsr_frame_info;
178 struct hsr_proto_ops {
179 /* format and send supervision frame */
180 void (*send_sv_frame)(struct hsr_port *port, unsigned long *interval);
181 void (*handle_san_frame)(bool san, enum hsr_port_type port,
182 struct hsr_node *node);
183 bool (*drop_frame)(struct hsr_frame_info *frame, struct hsr_port *port);
184 struct sk_buff * (*get_untagged_frame)(struct hsr_frame_info *frame,
185 struct hsr_port *port);
186 struct sk_buff * (*create_tagged_frame)(struct hsr_frame_info *frame,
187 struct hsr_port *port);
188 void (*fill_frame_info)(__be16 proto, struct sk_buff *skb,
189 struct hsr_frame_info *frame);
190 bool (*invalid_dan_ingress_frame)(__be16 protocol);
191 void (*update_san_info)(struct hsr_node *node, bool is_sup);
195 struct rcu_head rcu_head;
196 struct list_head ports;
197 struct list_head node_db; /* Known HSR nodes */
198 struct list_head self_node_db; /* MACs of slaves */
199 struct timer_list announce_timer; /* Supervision frame dispatch */
200 struct timer_list prune_timer;
203 u16 sup_sequence_nr; /* For HSRv1 separate seq_nr for supervision */
204 enum hsr_version prot_version; /* Indicate if HSRv0, HSRv1 or PRPv1 */
205 spinlock_t seqnr_lock; /* locking for sequence_nr */
206 spinlock_t list_lock; /* locking for node list */
207 struct hsr_proto_ops *proto_ops;
208 #define PRP_LAN_ID 0x5 /* 0x1010 for A and 0x1011 for B. Bit 0 is set
209 * based on SLAVE_A or SLAVE_B
211 u8 net_id; /* for PRP, it occupies most significant 3 bits
214 unsigned char sup_multicast_addr[ETH_ALEN] __aligned(sizeof(u16));
215 /* Align to u16 boundary to avoid unaligned access
216 * in ether_addr_equal
218 #ifdef CONFIG_DEBUG_FS
219 struct dentry *node_tbl_root;
223 #define hsr_for_each_port(hsr, port) \
224 list_for_each_entry_rcu((port), &(hsr)->ports, port_list)
226 struct hsr_port *hsr_port_get_hsr(struct hsr_priv *hsr, enum hsr_port_type pt);
228 /* Caller must ensure skb is a valid HSR frame */
229 static inline u16 hsr_get_skb_sequence_nr(struct sk_buff *skb)
231 struct hsr_ethhdr *hsr_ethhdr;
233 hsr_ethhdr = (struct hsr_ethhdr *)skb_mac_header(skb);
234 return ntohs(hsr_ethhdr->hsr_tag.sequence_nr);
237 static inline struct prp_rct *skb_get_PRP_rct(struct sk_buff *skb)
239 unsigned char *tail = skb_tail_pointer(skb) - HSR_HLEN;
241 struct prp_rct *rct = (struct prp_rct *)tail;
243 if (rct->PRP_suffix == htons(ETH_P_PRP))
249 /* Assume caller has confirmed this skb is PRP suffixed */
250 static inline u16 prp_get_skb_sequence_nr(struct prp_rct *rct)
252 return ntohs(rct->sequence_nr);
255 static inline u16 get_prp_lan_id(struct prp_rct *rct)
257 return ntohs(rct->lan_id_and_LSDU_size) >> 12;
260 /* assume there is a valid rct */
261 static inline bool prp_check_lsdu_size(struct sk_buff *skb,
265 struct ethhdr *ethhdr;
266 int expected_lsdu_size;
269 expected_lsdu_size = HSR_V1_SUP_LSDUSIZE;
271 ethhdr = (struct ethhdr *)skb_mac_header(skb);
272 expected_lsdu_size = skb->len - 14;
273 if (ethhdr->h_proto == htons(ETH_P_8021Q))
274 expected_lsdu_size -= 4;
277 return (expected_lsdu_size == get_prp_LSDU_size(rct));
280 #if IS_ENABLED(CONFIG_DEBUG_FS)
281 void hsr_debugfs_rename(struct net_device *dev);
282 void hsr_debugfs_init(struct hsr_priv *priv, struct net_device *hsr_dev);
283 void hsr_debugfs_term(struct hsr_priv *priv);
284 void hsr_debugfs_create_root(void);
285 void hsr_debugfs_remove_root(void);
287 static inline void hsr_debugfs_rename(struct net_device *dev)
290 static inline void hsr_debugfs_init(struct hsr_priv *priv,
291 struct net_device *hsr_dev)
293 static inline void hsr_debugfs_term(struct hsr_priv *priv)
295 static inline void hsr_debugfs_create_root(void)
297 static inline void hsr_debugfs_remove_root(void)
301 #endif /* __HSR_PRIVATE_H */