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