hsr_main.h

  1/* SPDX-License-Identifier: GPL-2.0 */
  2/* Copyright 2011-2014 Autronica Fire and Security AS
  3 *
  4 * Author(s):
  5 *	2011-2014 Arvid Brodin, arvid.brodin@alten.se
  6 *
  7 * include file for HSR and PRP.
  8 */
  9
 10#ifndef __HSR_PRIVATE_H
 11#define __HSR_PRIVATE_H
 12
 13#include <linux/netdevice.h>
 14#include <linux/list.h>
 15#include <linux/if_vlan.h>
 16#include <linux/if_hsr.h>
 17
 18/* Time constants as specified in the HSR specification (IEC-62439-3 2010)
 19 * Table 8.
 20 * All values in milliseconds.
 21 */
 22#define HSR_LIFE_CHECK_INTERVAL		 2000 /* ms */
 23#define HSR_NODE_FORGET_TIME		60000 /* ms */
 24#define HSR_PROXY_NODE_FORGET_TIME	60000 /* ms */
 25#define HSR_ANNOUNCE_INTERVAL		  100 /* ms */
 26#define HSR_ENTRY_FORGET_TIME		  400 /* ms */
 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#define HSR_SEQNR_START			(USHRT_MAX - 1024)
 33#define HSR_SUP_SEQNR_START		(HSR_SEQNR_START / 2)
 34
 35/* How often shall we check for broken ring and remove node entries older than
 36 * HSR_NODE_FORGET_TIME?
 37 */
 38#define PRUNE_PERIOD			 3000 /* ms */
 39#define PRUNE_PROXY_PERIOD		 3000 /* ms */
 40#define HSR_TLV_EOT				   0  /* End of TLVs */
 41#define HSR_TLV_ANNOUNCE		   22
 42#define HSR_TLV_LIFE_CHECK		   23
 43/* PRP V1 life check for Duplicate discard */
 44#define PRP_TLV_LIFE_CHECK_DD		   20
 45/* PRP V1 life check for Duplicate Accept */
 46#define PRP_TLV_LIFE_CHECK_DA		   21
 47/* PRP V1 life redundancy box MAC address */
 48#define PRP_TLV_REDBOX_MAC		   30
 49
 50#define HSR_V1_SUP_LSDUSIZE		52
 51
 52/* The helper functions below assumes that 'path' occupies the 4 most
 53 * significant bits of the 16-bit field shared by 'path' and 'LSDU_size' (or
 54 * equivalently, the 4 most significant bits of HSR tag byte 14).
 55 *
 56 * This is unclear in the IEC specification; its definition of MAC addresses
 57 * indicates the spec is written with the least significant bit first (to the
 58 * left). This, however, would mean that the LSDU field would be split in two
 59 * with the path field in-between, which seems strange. I'm guessing the MAC
 60 * address definition is in error.
 61 */
 62
 63static inline void set_hsr_tag_path(struct hsr_tag *ht, u16 path)
 64{
 65	ht->path_and_LSDU_size =
 66		htons((ntohs(ht->path_and_LSDU_size) & 0x0FFF) | (path << 12));
 67}
 68
 69static inline void set_hsr_tag_LSDU_size(struct hsr_tag *ht, u16 LSDU_size)
 70{
 71	ht->path_and_LSDU_size = htons((ntohs(ht->path_and_LSDU_size) &
 72				       0xF000) | (LSDU_size & 0x0FFF));
 73}
 74
 75struct hsr_ethhdr {
 76	struct ethhdr	ethhdr;
 77	struct hsr_tag	hsr_tag;
 78} __packed;
 79
 80struct hsr_vlan_ethhdr {
 81	struct vlan_ethhdr vlanhdr;
 82	struct hsr_tag	hsr_tag;
 83} __packed;
 84
 85struct hsr_sup_tlv {
 86	u8		HSR_TLV_type;
 87	u8		HSR_TLV_length;
 88} __packed;
 89
 90/* HSR/PRP Supervision Frame data types.
 91 * Field names as defined in the IEC:2010 standard for HSR.
 92 */
 93struct hsr_sup_tag {
 94	__be16				path_and_HSR_ver;
 95	__be16				sequence_nr;
 96	struct hsr_sup_tlv  tlv;
 97} __packed;
 98
 99struct hsr_sup_payload {
100	unsigned char	macaddress_A[ETH_ALEN];
101} __packed;
102
103static inline void set_hsr_stag_path(struct hsr_sup_tag *hst, u16 path)
104{
105	set_hsr_tag_path((struct hsr_tag *)hst, path);
106}
107
108static inline void set_hsr_stag_HSR_ver(struct hsr_sup_tag *hst, u16 HSR_ver)
109{
110	set_hsr_tag_LSDU_size((struct hsr_tag *)hst, HSR_ver);
111}
112
113struct hsrv0_ethhdr_sp {
114	struct ethhdr		ethhdr;
115	struct hsr_sup_tag	hsr_sup;
116} __packed;
117
118struct hsrv1_ethhdr_sp {
119	struct ethhdr		ethhdr;
120	struct hsr_tag		hsr;
121	struct hsr_sup_tag	hsr_sup;
122} __packed;
123
124/* PRP Redunancy Control Trailor (RCT).
125 * As defined in IEC-62439-4:2012, the PRP RCT is really { sequence Nr,
126 * Lan indentifier (LanId), LSDU_size and PRP_suffix = 0x88FB }.
127 *
128 * Field names as defined in the IEC:2012 standard for PRP.
129 */
130struct prp_rct {
131	__be16          sequence_nr;
132	__be16          lan_id_and_LSDU_size;
133	__be16          PRP_suffix;
134} __packed;
135
136static inline u16 get_prp_LSDU_size(struct prp_rct *rct)
137{
138	return ntohs(rct->lan_id_and_LSDU_size) & 0x0FFF;
139}
140
141static inline void set_prp_lan_id(struct prp_rct *rct, u16 lan_id)
142{
143	rct->lan_id_and_LSDU_size = htons((ntohs(rct->lan_id_and_LSDU_size) &
144					  0x0FFF) | (lan_id << 12));
145}
146static inline void set_prp_LSDU_size(struct prp_rct *rct, u16 LSDU_size)
147{
148	rct->lan_id_and_LSDU_size = htons((ntohs(rct->lan_id_and_LSDU_size) &
149					  0xF000) | (LSDU_size & 0x0FFF));
150}
151
152struct hsr_port {
153	struct list_head	port_list;
154	struct net_device	*dev;
155	struct hsr_priv		*hsr;
156	enum hsr_port_type	type;
157	struct rcu_head		rcu;
158	unsigned char		original_macaddress[ETH_ALEN];
159};
160
161struct hsr_frame_info;
162struct hsr_node;
163
164struct hsr_proto_ops {
165	/* format and send supervision frame */
166	void (*send_sv_frame)(struct hsr_port *port, unsigned long *interval,
167			      const unsigned char addr[ETH_ALEN]);
168	void (*handle_san_frame)(bool san, enum hsr_port_type port,
169				 struct hsr_node *node);
170	bool (*drop_frame)(struct hsr_frame_info *frame, struct hsr_port *port);
171	struct sk_buff * (*get_untagged_frame)(struct hsr_frame_info *frame,
172					       struct hsr_port *port);
173	struct sk_buff * (*create_tagged_frame)(struct hsr_frame_info *frame,
174						struct hsr_port *port);
175	int (*fill_frame_info)(__be16 proto, struct sk_buff *skb,
176			       struct hsr_frame_info *frame);
177	bool (*invalid_dan_ingress_frame)(__be16 protocol);
178	void (*update_san_info)(struct hsr_node *node, bool is_sup);
179	int (*register_frame_out)(struct hsr_port *port,
180				  struct hsr_frame_info *frame);
181};
182
183struct hsr_self_node {
184	unsigned char	macaddress_A[ETH_ALEN];
185	unsigned char	macaddress_B[ETH_ALEN];
186	struct rcu_head	rcu_head;
187};
188
189struct hsr_priv {
190	struct rcu_head		rcu_head;
191	struct list_head	ports;
192	struct list_head	node_db;	/* Known HSR nodes */
193	struct list_head	proxy_node_db;	/* RedBox HSR proxy nodes */
194	struct hsr_self_node	__rcu *self_node;	/* MACs of slaves */
195	struct timer_list	announce_timer;	/* Supervision frame dispatch */
196	struct timer_list	announce_proxy_timer;
197	struct timer_list	prune_timer;
198	struct timer_list	prune_proxy_timer;
199	int announce_count;
200	u16 sequence_nr;
201	u16 sup_sequence_nr;	/* For HSRv1 separate seq_nr for supervision */
202	enum hsr_version prot_version;	/* Indicate if HSRv0, HSRv1 or PRPv1 */
203	spinlock_t seqnr_lock;	/* locking for sequence_nr */
204	spinlock_t list_lock;	/* locking for node list */
205	struct hsr_proto_ops	*proto_ops;
206#define PRP_LAN_ID	0x5     /* 0x1010 for A and 0x1011 for B. Bit 0 is set
207				 * based on SLAVE_A or SLAVE_B
208				 */
209	u8 net_id;		/* for PRP, it occupies most significant 3 bits
210				 * of lan_id
211				 */
212	bool fwd_offloaded;	/* Forwarding offloaded to HW */
213	bool redbox;            /* Device supports HSR RedBox */
214	unsigned char		macaddress_redbox[ETH_ALEN];
215	unsigned char		sup_multicast_addr[ETH_ALEN] __aligned(sizeof(u16));
216				/* Align to u16 boundary to avoid unaligned access
217				 * in ether_addr_equal
218				 */
219#ifdef	CONFIG_DEBUG_FS
220	struct dentry *node_tbl_root;
221#endif
222};
223
224#define hsr_for_each_port(hsr, port) \
225	list_for_each_entry_rcu((port), &(hsr)->ports, port_list)
226
227#define hsr_for_each_port_rtnl(hsr, port) \
228	list_for_each_entry_rcu((port), &(hsr)->ports, port_list, lockdep_rtnl_is_held())
229
230struct hsr_port *hsr_port_get_hsr(struct hsr_priv *hsr, enum hsr_port_type pt);
231
232/* Caller must ensure skb is a valid HSR frame */
233static inline u16 hsr_get_skb_sequence_nr(struct sk_buff *skb)
234{
235	struct hsr_ethhdr *hsr_ethhdr;
236
237	hsr_ethhdr = (struct hsr_ethhdr *)skb_mac_header(skb);
238	return ntohs(hsr_ethhdr->hsr_tag.sequence_nr);
239}
240
241static inline struct prp_rct *skb_get_PRP_rct(struct sk_buff *skb)
242{
243	unsigned char *tail = skb_tail_pointer(skb) - HSR_HLEN;
244
245	struct prp_rct *rct = (struct prp_rct *)tail;
246
247	if (rct->PRP_suffix == htons(ETH_P_PRP))
248		return rct;
249
250	return NULL;
251}
252
253/* Assume caller has confirmed this skb is PRP suffixed */
254static inline u16 prp_get_skb_sequence_nr(struct prp_rct *rct)
255{
256	return ntohs(rct->sequence_nr);
257}
258
259/* assume there is a valid rct */
260static inline bool prp_check_lsdu_size(struct sk_buff *skb,
261				       struct prp_rct *rct,
262				       bool is_sup)
263{
264	struct ethhdr *ethhdr;
265	int expected_lsdu_size;
266
267	if (is_sup) {
268		expected_lsdu_size = HSR_V1_SUP_LSDUSIZE;
269	} else {
270		ethhdr = (struct ethhdr *)skb_mac_header(skb);
271		expected_lsdu_size = skb->len - 14;
272		if (ethhdr->h_proto == htons(ETH_P_8021Q))
273			expected_lsdu_size -= 4;
274	}
275
276	return (expected_lsdu_size == get_prp_LSDU_size(rct));
277}
278
279#if IS_ENABLED(CONFIG_DEBUG_FS)
280void hsr_debugfs_rename(struct net_device *dev);
281void hsr_debugfs_init(struct hsr_priv *priv, struct net_device *hsr_dev);
282void hsr_debugfs_term(struct hsr_priv *priv);
283void hsr_debugfs_create_root(void);
284void hsr_debugfs_remove_root(void);
285#else
286static inline void hsr_debugfs_rename(struct net_device *dev)
287{
288}
289static inline void hsr_debugfs_init(struct hsr_priv *priv,
290				    struct net_device *hsr_dev)
291{}
292static inline void hsr_debugfs_term(struct hsr_priv *priv)
293{}
294static inline void hsr_debugfs_create_root(void)
295{}
296static inline void hsr_debugfs_remove_root(void)
297{}
298#endif
299
300#endif /*  __HSR_PRIVATE_H */