10e7623bdSMurali Karicheri /* SPDX-License-Identifier: GPL-2.0 */
270ebe4a4SArvid Brodin /* Copyright 2011-2014 Autronica Fire and Security AS
3f421436aSArvid Brodin *
4f421436aSArvid Brodin * Author(s):
570ebe4a4SArvid Brodin * 2011-2014 Arvid Brodin, arvid.brodin@alten.se
68f4c0e01SMurali Karicheri *
78f4c0e01SMurali Karicheri * include file for HSR and PRP.
8f421436aSArvid Brodin */
9f421436aSArvid Brodin
1070ebe4a4SArvid Brodin #ifndef __HSR_PRIVATE_H
1170ebe4a4SArvid Brodin #define __HSR_PRIVATE_H
12f421436aSArvid Brodin
13f421436aSArvid Brodin #include <linux/netdevice.h>
14f421436aSArvid Brodin #include <linux/list.h>
15451d8123SMurali Karicheri #include <linux/if_vlan.h>
16dcf0cd1cSGeorge McCollister #include <linux/if_hsr.h>
17f421436aSArvid Brodin
18f421436aSArvid Brodin /* Time constants as specified in the HSR specification (IEC-62439-3 2010)
19f421436aSArvid Brodin * Table 8.
20f421436aSArvid Brodin * All values in milliseconds.
21f421436aSArvid Brodin */
22f421436aSArvid Brodin #define HSR_LIFE_CHECK_INTERVAL 2000 /* ms */
23f421436aSArvid Brodin #define HSR_NODE_FORGET_TIME 60000 /* ms */
24f421436aSArvid Brodin #define HSR_ANNOUNCE_INTERVAL 100 /* ms */
25f1764114SMarco Wenzel #define HSR_ENTRY_FORGET_TIME 400 /* ms */
26f421436aSArvid Brodin
27f421436aSArvid Brodin /* By how much may slave1 and slave2 timestamps of latest received frame from
28f421436aSArvid Brodin * each node differ before we notify of communication problem?
29f421436aSArvid Brodin */
30f421436aSArvid Brodin #define MAX_SLAVE_DIFF 3000 /* ms */
31f266a683SArvid Brodin #define HSR_SEQNR_START (USHRT_MAX - 1024)
32ee1c2797SPeter Heise #define HSR_SUP_SEQNR_START (HSR_SEQNR_START / 2)
33f421436aSArvid Brodin
34f421436aSArvid Brodin /* How often shall we check for broken ring and remove node entries older than
35f421436aSArvid Brodin * HSR_NODE_FORGET_TIME?
36f421436aSArvid Brodin */
37f421436aSArvid Brodin #define PRUNE_PERIOD 3000 /* ms */
38eafaa88bSAndreas Oetken #define HSR_TLV_EOT 0 /* End of TLVs */
39f421436aSArvid Brodin #define HSR_TLV_ANNOUNCE 22
40f421436aSArvid Brodin #define HSR_TLV_LIFE_CHECK 23
41c643ff03SMurali Karicheri /* PRP V1 life check for Duplicate discard */
42c643ff03SMurali Karicheri #define PRP_TLV_LIFE_CHECK_DD 20
43c643ff03SMurali Karicheri /* PRP V1 life check for Duplicate Accept */
44c643ff03SMurali Karicheri #define PRP_TLV_LIFE_CHECK_DA 21
45eafaa88bSAndreas Oetken /* PRP V1 life redundancy box MAC address */
46eafaa88bSAndreas Oetken #define PRP_TLV_REDBOX_MAC 30
47f421436aSArvid Brodin
48ee1c2797SPeter Heise #define HSR_V1_SUP_LSDUSIZE 52
49ee1c2797SPeter Heise
50f421436aSArvid Brodin /* The helper functions below assumes that 'path' occupies the 4 most
51f421436aSArvid Brodin * significant bits of the 16-bit field shared by 'path' and 'LSDU_size' (or
52f421436aSArvid Brodin * equivalently, the 4 most significant bits of HSR tag byte 14).
53f421436aSArvid Brodin *
54f421436aSArvid Brodin * This is unclear in the IEC specification; its definition of MAC addresses
55f421436aSArvid Brodin * indicates the spec is written with the least significant bit first (to the
56f421436aSArvid Brodin * left). This, however, would mean that the LSDU field would be split in two
57f421436aSArvid Brodin * with the path field in-between, which seems strange. I'm guessing the MAC
58f421436aSArvid Brodin * address definition is in error.
59f421436aSArvid Brodin */
60f421436aSArvid Brodin
set_hsr_tag_path(struct hsr_tag * ht,u16 path)61f421436aSArvid Brodin static inline void set_hsr_tag_path(struct hsr_tag *ht, u16 path)
62f421436aSArvid Brodin {
63d595b85aSMurali Karicheri ht->path_and_LSDU_size =
64d595b85aSMurali Karicheri htons((ntohs(ht->path_and_LSDU_size) & 0x0FFF) | (path << 12));
65f421436aSArvid Brodin }
66f421436aSArvid Brodin
set_hsr_tag_LSDU_size(struct hsr_tag * ht,u16 LSDU_size)67f421436aSArvid Brodin static inline void set_hsr_tag_LSDU_size(struct hsr_tag *ht, u16 LSDU_size)
68f421436aSArvid Brodin {
690525fc06SMurali Karicheri ht->path_and_LSDU_size = htons((ntohs(ht->path_and_LSDU_size) &
700525fc06SMurali Karicheri 0xF000) | (LSDU_size & 0x0FFF));
71f421436aSArvid Brodin }
72f421436aSArvid Brodin
73f421436aSArvid Brodin struct hsr_ethhdr {
74f421436aSArvid Brodin struct ethhdr ethhdr;
75f421436aSArvid Brodin struct hsr_tag hsr_tag;
76f421436aSArvid Brodin } __packed;
77f421436aSArvid Brodin
78451d8123SMurali Karicheri struct hsr_vlan_ethhdr {
79451d8123SMurali Karicheri struct vlan_ethhdr vlanhdr;
80451d8123SMurali Karicheri struct hsr_tag hsr_tag;
81451d8123SMurali Karicheri } __packed;
82451d8123SMurali Karicheri
83eafaa88bSAndreas Oetken struct hsr_sup_tlv {
84eafaa88bSAndreas Oetken u8 HSR_TLV_type;
85eafaa88bSAndreas Oetken u8 HSR_TLV_length;
86*fbd825fcSSebastian Andrzej Siewior } __packed;
87eafaa88bSAndreas Oetken
88451d8123SMurali Karicheri /* HSR/PRP Supervision Frame data types.
89f421436aSArvid Brodin * Field names as defined in the IEC:2010 standard for HSR.
90f421436aSArvid Brodin */
91f421436aSArvid Brodin struct hsr_sup_tag {
92b1b4aa91SMurali Karicheri __be16 path_and_HSR_ver;
93f421436aSArvid Brodin __be16 sequence_nr;
94eafaa88bSAndreas Oetken struct hsr_sup_tlv tlv;
95f421436aSArvid Brodin } __packed;
96f421436aSArvid Brodin
97f421436aSArvid Brodin struct hsr_sup_payload {
98b1b4aa91SMurali Karicheri unsigned char macaddress_A[ETH_ALEN];
99f421436aSArvid Brodin } __packed;
100f421436aSArvid Brodin
set_hsr_stag_path(struct hsr_sup_tag * hst,u16 path)101f421436aSArvid Brodin static inline void set_hsr_stag_path(struct hsr_sup_tag *hst, u16 path)
102f421436aSArvid Brodin {
103f421436aSArvid Brodin set_hsr_tag_path((struct hsr_tag *)hst, path);
104f421436aSArvid Brodin }
105f421436aSArvid Brodin
set_hsr_stag_HSR_ver(struct hsr_sup_tag * hst,u16 HSR_ver)106b1b4aa91SMurali Karicheri static inline void set_hsr_stag_HSR_ver(struct hsr_sup_tag *hst, u16 HSR_ver)
107f421436aSArvid Brodin {
108b1b4aa91SMurali Karicheri set_hsr_tag_LSDU_size((struct hsr_tag *)hst, HSR_ver);
109f421436aSArvid Brodin }
110f421436aSArvid Brodin
111ee1c2797SPeter Heise struct hsrv0_ethhdr_sp {
112f421436aSArvid Brodin struct ethhdr ethhdr;
113f421436aSArvid Brodin struct hsr_sup_tag hsr_sup;
114f421436aSArvid Brodin } __packed;
115f421436aSArvid Brodin
116ee1c2797SPeter Heise struct hsrv1_ethhdr_sp {
117ee1c2797SPeter Heise struct ethhdr ethhdr;
118ee1c2797SPeter Heise struct hsr_tag hsr;
119ee1c2797SPeter Heise struct hsr_sup_tag hsr_sup;
120ee1c2797SPeter Heise } __packed;
121ee1c2797SPeter Heise
122c5a75911SArvid Brodin enum hsr_port_type {
123c5a75911SArvid Brodin HSR_PT_NONE = 0, /* Must be 0, used by framereg */
124c5a75911SArvid Brodin HSR_PT_SLAVE_A,
125c5a75911SArvid Brodin HSR_PT_SLAVE_B,
126c5a75911SArvid Brodin HSR_PT_INTERLINK,
127c5a75911SArvid Brodin HSR_PT_MASTER,
128c5a75911SArvid Brodin HSR_PT_PORTS, /* This must be the last item in the enum */
129f421436aSArvid Brodin };
130c5a75911SArvid Brodin
131c643ff03SMurali Karicheri /* PRP Redunancy Control Trailor (RCT).
132c643ff03SMurali Karicheri * As defined in IEC-62439-4:2012, the PRP RCT is really { sequence Nr,
133c643ff03SMurali Karicheri * Lan indentifier (LanId), LSDU_size and PRP_suffix = 0x88FB }.
134c643ff03SMurali Karicheri *
135c643ff03SMurali Karicheri * Field names as defined in the IEC:2012 standard for PRP.
136c643ff03SMurali Karicheri */
137c643ff03SMurali Karicheri struct prp_rct {
138c643ff03SMurali Karicheri __be16 sequence_nr;
139c643ff03SMurali Karicheri __be16 lan_id_and_LSDU_size;
140c643ff03SMurali Karicheri __be16 PRP_suffix;
141c643ff03SMurali Karicheri } __packed;
142c643ff03SMurali Karicheri
get_prp_LSDU_size(struct prp_rct * rct)143451d8123SMurali Karicheri static inline u16 get_prp_LSDU_size(struct prp_rct *rct)
144451d8123SMurali Karicheri {
145451d8123SMurali Karicheri return ntohs(rct->lan_id_and_LSDU_size) & 0x0FFF;
146451d8123SMurali Karicheri }
147451d8123SMurali Karicheri
set_prp_lan_id(struct prp_rct * rct,u16 lan_id)148451d8123SMurali Karicheri static inline void set_prp_lan_id(struct prp_rct *rct, u16 lan_id)
149451d8123SMurali Karicheri {
150451d8123SMurali Karicheri rct->lan_id_and_LSDU_size = htons((ntohs(rct->lan_id_and_LSDU_size) &
151451d8123SMurali Karicheri 0x0FFF) | (lan_id << 12));
152451d8123SMurali Karicheri }
set_prp_LSDU_size(struct prp_rct * rct,u16 LSDU_size)153c643ff03SMurali Karicheri static inline void set_prp_LSDU_size(struct prp_rct *rct, u16 LSDU_size)
154c643ff03SMurali Karicheri {
155c643ff03SMurali Karicheri rct->lan_id_and_LSDU_size = htons((ntohs(rct->lan_id_and_LSDU_size) &
156c643ff03SMurali Karicheri 0xF000) | (LSDU_size & 0x0FFF));
157c643ff03SMurali Karicheri }
158c643ff03SMurali Karicheri
159c5a75911SArvid Brodin struct hsr_port {
160c5a75911SArvid Brodin struct list_head port_list;
161c5a75911SArvid Brodin struct net_device *dev;
162c5a75911SArvid Brodin struct hsr_priv *hsr;
163c5a75911SArvid Brodin enum hsr_port_type type;
164c5a75911SArvid Brodin };
165f421436aSArvid Brodin
166fa4dc895SMurali Karicheri struct hsr_frame_info;
167451d8123SMurali Karicheri struct hsr_node;
168fa4dc895SMurali Karicheri
16928e458e0SMurali Karicheri struct hsr_proto_ops {
17028e458e0SMurali Karicheri /* format and send supervision frame */
17128e458e0SMurali Karicheri void (*send_sv_frame)(struct hsr_port *port, unsigned long *interval);
172451d8123SMurali Karicheri void (*handle_san_frame)(bool san, enum hsr_port_type port,
173451d8123SMurali Karicheri struct hsr_node *node);
174451d8123SMurali Karicheri bool (*drop_frame)(struct hsr_frame_info *frame, struct hsr_port *port);
175fa4dc895SMurali Karicheri struct sk_buff * (*get_untagged_frame)(struct hsr_frame_info *frame,
176fa4dc895SMurali Karicheri struct hsr_port *port);
177fa4dc895SMurali Karicheri struct sk_buff * (*create_tagged_frame)(struct hsr_frame_info *frame,
178fa4dc895SMurali Karicheri struct hsr_port *port);
17948b491a5SGeorge McCollister int (*fill_frame_info)(__be16 proto, struct sk_buff *skb,
180fa4dc895SMurali Karicheri struct hsr_frame_info *frame);
181451d8123SMurali Karicheri bool (*invalid_dan_ingress_frame)(__be16 protocol);
182451d8123SMurali Karicheri void (*update_san_info)(struct hsr_node *node, bool is_sup);
18328e458e0SMurali Karicheri };
18428e458e0SMurali Karicheri
18520d3c1e9SSebastian Andrzej Siewior struct hsr_self_node {
18620d3c1e9SSebastian Andrzej Siewior unsigned char macaddress_A[ETH_ALEN];
18720d3c1e9SSebastian Andrzej Siewior unsigned char macaddress_B[ETH_ALEN];
18820d3c1e9SSebastian Andrzej Siewior struct rcu_head rcu_head;
18920d3c1e9SSebastian Andrzej Siewior };
19020d3c1e9SSebastian Andrzej Siewior
191f421436aSArvid Brodin struct hsr_priv {
192f421436aSArvid Brodin struct rcu_head rcu_head;
193c5a75911SArvid Brodin struct list_head ports;
194e012764cSSebastian Andrzej Siewior struct list_head node_db; /* Known HSR nodes */
19520d3c1e9SSebastian Andrzej Siewior struct hsr_self_node __rcu *self_node; /* MACs of slaves */
196f421436aSArvid Brodin struct timer_list announce_timer; /* Supervision frame dispatch */
197abff7162SArvid Brodin struct timer_list prune_timer;
198f421436aSArvid Brodin int announce_count;
199f421436aSArvid Brodin u16 sequence_nr;
200ee1c2797SPeter Heise u16 sup_sequence_nr; /* For HSRv1 separate seq_nr for supervision */
2018f4c0e01SMurali Karicheri enum hsr_version prot_version; /* Indicate if HSRv0, HSRv1 or PRPv1 */
202f421436aSArvid Brodin spinlock_t seqnr_lock; /* locking for sequence_nr */
20392a35678STaehee Yoo spinlock_t list_lock; /* locking for node list */
20428e458e0SMurali Karicheri struct hsr_proto_ops *proto_ops;
205451d8123SMurali Karicheri #define PRP_LAN_ID 0x5 /* 0x1010 for A and 0x1011 for B. Bit 0 is set
206451d8123SMurali Karicheri * based on SLAVE_A or SLAVE_B
207451d8123SMurali Karicheri */
208451d8123SMurali Karicheri u8 net_id; /* for PRP, it occupies most significant 3 bits
209451d8123SMurali Karicheri * of lan_id
210451d8123SMurali Karicheri */
211e748d0fdSRavi Gunasekaran bool fwd_offloaded; /* Forwarding offloaded to HW */
2126c9f18f2SAndreas Oetken unsigned char sup_multicast_addr[ETH_ALEN] __aligned(sizeof(u16));
2136c9f18f2SAndreas Oetken /* Align to u16 boundary to avoid unaligned access
2146c9f18f2SAndreas Oetken * in ether_addr_equal
2156c9f18f2SAndreas Oetken */
216fc4ecaeeSMurali Karicheri #ifdef CONFIG_DEBUG_FS
217fc4ecaeeSMurali Karicheri struct dentry *node_tbl_root;
218fc4ecaeeSMurali Karicheri #endif
219f421436aSArvid Brodin };
220f421436aSArvid Brodin
221f266a683SArvid Brodin #define hsr_for_each_port(hsr, port) \
222f266a683SArvid Brodin list_for_each_entry_rcu((port), &(hsr)->ports, port_list)
223f266a683SArvid Brodin
224c5a75911SArvid Brodin struct hsr_port *hsr_port_get_hsr(struct hsr_priv *hsr, enum hsr_port_type pt);
225f421436aSArvid Brodin
226f266a683SArvid Brodin /* Caller must ensure skb is a valid HSR frame */
hsr_get_skb_sequence_nr(struct sk_buff * skb)227f266a683SArvid Brodin static inline u16 hsr_get_skb_sequence_nr(struct sk_buff *skb)
228f266a683SArvid Brodin {
229f266a683SArvid Brodin struct hsr_ethhdr *hsr_ethhdr;
230f266a683SArvid Brodin
231f266a683SArvid Brodin hsr_ethhdr = (struct hsr_ethhdr *)skb_mac_header(skb);
232f266a683SArvid Brodin return ntohs(hsr_ethhdr->hsr_tag.sequence_nr);
233f266a683SArvid Brodin }
234f266a683SArvid Brodin
skb_get_PRP_rct(struct sk_buff * skb)235451d8123SMurali Karicheri static inline struct prp_rct *skb_get_PRP_rct(struct sk_buff *skb)
236451d8123SMurali Karicheri {
237451d8123SMurali Karicheri unsigned char *tail = skb_tail_pointer(skb) - HSR_HLEN;
238451d8123SMurali Karicheri
239451d8123SMurali Karicheri struct prp_rct *rct = (struct prp_rct *)tail;
240451d8123SMurali Karicheri
241451d8123SMurali Karicheri if (rct->PRP_suffix == htons(ETH_P_PRP))
242451d8123SMurali Karicheri return rct;
243451d8123SMurali Karicheri
244451d8123SMurali Karicheri return NULL;
245451d8123SMurali Karicheri }
246451d8123SMurali Karicheri
247451d8123SMurali Karicheri /* Assume caller has confirmed this skb is PRP suffixed */
prp_get_skb_sequence_nr(struct prp_rct * rct)248451d8123SMurali Karicheri static inline u16 prp_get_skb_sequence_nr(struct prp_rct *rct)
249451d8123SMurali Karicheri {
250451d8123SMurali Karicheri return ntohs(rct->sequence_nr);
251451d8123SMurali Karicheri }
252451d8123SMurali Karicheri
253451d8123SMurali Karicheri /* assume there is a valid rct */
prp_check_lsdu_size(struct sk_buff * skb,struct prp_rct * rct,bool is_sup)254451d8123SMurali Karicheri static inline bool prp_check_lsdu_size(struct sk_buff *skb,
255451d8123SMurali Karicheri struct prp_rct *rct,
256451d8123SMurali Karicheri bool is_sup)
257451d8123SMurali Karicheri {
258451d8123SMurali Karicheri struct ethhdr *ethhdr;
259451d8123SMurali Karicheri int expected_lsdu_size;
260451d8123SMurali Karicheri
261451d8123SMurali Karicheri if (is_sup) {
262451d8123SMurali Karicheri expected_lsdu_size = HSR_V1_SUP_LSDUSIZE;
263451d8123SMurali Karicheri } else {
264451d8123SMurali Karicheri ethhdr = (struct ethhdr *)skb_mac_header(skb);
265451d8123SMurali Karicheri expected_lsdu_size = skb->len - 14;
266451d8123SMurali Karicheri if (ethhdr->h_proto == htons(ETH_P_8021Q))
267451d8123SMurali Karicheri expected_lsdu_size -= 4;
268451d8123SMurali Karicheri }
269451d8123SMurali Karicheri
270451d8123SMurali Karicheri return (expected_lsdu_size == get_prp_LSDU_size(rct));
271451d8123SMurali Karicheri }
272451d8123SMurali Karicheri
273fc4ecaeeSMurali Karicheri #if IS_ENABLED(CONFIG_DEBUG_FS)
2744c2d5e33STaehee Yoo void hsr_debugfs_rename(struct net_device *dev);
2751d19e2d5STaehee Yoo void hsr_debugfs_init(struct hsr_priv *priv, struct net_device *hsr_dev);
2769c5f8a19SMurali Karicheri void hsr_debugfs_term(struct hsr_priv *priv);
277c6c4ccd7STaehee Yoo void hsr_debugfs_create_root(void);
278c6c4ccd7STaehee Yoo void hsr_debugfs_remove_root(void);
279fc4ecaeeSMurali Karicheri #else
hsr_debugfs_rename(struct net_device * dev)28080892772Sxiaofeng.yan static inline void hsr_debugfs_rename(struct net_device *dev)
2814c2d5e33STaehee Yoo {
2824c2d5e33STaehee Yoo }
hsr_debugfs_init(struct hsr_priv * priv,struct net_device * hsr_dev)2831d19e2d5STaehee Yoo static inline void hsr_debugfs_init(struct hsr_priv *priv,
28432712733SMurali Karicheri struct net_device *hsr_dev)
2851d19e2d5STaehee Yoo {}
hsr_debugfs_term(struct hsr_priv * priv)2869c5f8a19SMurali Karicheri static inline void hsr_debugfs_term(struct hsr_priv *priv)
287fc4ecaeeSMurali Karicheri {}
hsr_debugfs_create_root(void)288c6c4ccd7STaehee Yoo static inline void hsr_debugfs_create_root(void)
289c6c4ccd7STaehee Yoo {}
hsr_debugfs_remove_root(void)290c6c4ccd7STaehee Yoo static inline void hsr_debugfs_remove_root(void)
291c6c4ccd7STaehee Yoo {}
292fc4ecaeeSMurali Karicheri #endif
293fc4ecaeeSMurali Karicheri
29470ebe4a4SArvid Brodin #endif /* __HSR_PRIVATE_H */
295