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