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 26 /* By how much may slave1 and slave2 timestamps of latest received frame from 27 * each node differ before we notify of communication problem? 28 */ 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) 32 33 /* How often shall we check for broken ring and remove node entries older than 34 * HSR_NODE_FORGET_TIME? 35 */ 36 #define PRUNE_PERIOD 3000 /* ms */ 37 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 44 45 /* HSR Tag. 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. 50 * 51 * Field names as defined in the IEC:2010 standard for HSR. 52 */ 53 struct hsr_tag { 54 __be16 path_and_LSDU_size; 55 __be16 sequence_nr; 56 __be16 encap_proto; 57 } __packed; 58 59 #define HSR_HLEN 6 60 61 #define HSR_V1_SUP_LSDUSIZE 52 62 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). 66 * 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. 72 */ 73 74 static inline void set_hsr_tag_path(struct hsr_tag *ht, u16 path) 75 { 76 ht->path_and_LSDU_size = 77 htons((ntohs(ht->path_and_LSDU_size) & 0x0FFF) | (path << 12)); 78 } 79 80 static inline void set_hsr_tag_LSDU_size(struct hsr_tag *ht, u16 LSDU_size) 81 { 82 ht->path_and_LSDU_size = htons((ntohs(ht->path_and_LSDU_size) & 83 0xF000) | (LSDU_size & 0x0FFF)); 84 } 85 86 struct hsr_ethhdr { 87 struct ethhdr ethhdr; 88 struct hsr_tag hsr_tag; 89 } __packed; 90 91 struct hsr_vlan_ethhdr { 92 struct vlan_ethhdr vlanhdr; 93 struct hsr_tag hsr_tag; 94 } __packed; 95 96 /* HSR/PRP Supervision Frame data types. 97 * Field names as defined in the IEC:2010 standard for HSR. 98 */ 99 struct hsr_sup_tag { 100 __be16 path_and_HSR_ver; 101 __be16 sequence_nr; 102 __u8 HSR_TLV_type; 103 __u8 HSR_TLV_length; 104 } __packed; 105 106 struct hsr_sup_payload { 107 unsigned char macaddress_A[ETH_ALEN]; 108 } __packed; 109 110 static inline void set_hsr_stag_path(struct hsr_sup_tag *hst, u16 path) 111 { 112 set_hsr_tag_path((struct hsr_tag *)hst, path); 113 } 114 115 static inline void set_hsr_stag_HSR_ver(struct hsr_sup_tag *hst, u16 HSR_ver) 116 { 117 set_hsr_tag_LSDU_size((struct hsr_tag *)hst, HSR_ver); 118 } 119 120 struct hsrv0_ethhdr_sp { 121 struct ethhdr ethhdr; 122 struct hsr_sup_tag hsr_sup; 123 } __packed; 124 125 struct hsrv1_ethhdr_sp { 126 struct ethhdr ethhdr; 127 struct hsr_tag hsr; 128 struct hsr_sup_tag hsr_sup; 129 } __packed; 130 131 enum hsr_port_type { 132 HSR_PT_NONE = 0, /* Must be 0, used by framereg */ 133 HSR_PT_SLAVE_A, 134 HSR_PT_SLAVE_B, 135 HSR_PT_INTERLINK, 136 HSR_PT_MASTER, 137 HSR_PT_PORTS, /* This must be the last item in the enum */ 138 }; 139 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 }. 143 * 144 * Field names as defined in the IEC:2012 standard for PRP. 145 */ 146 struct prp_rct { 147 __be16 sequence_nr; 148 __be16 lan_id_and_LSDU_size; 149 __be16 PRP_suffix; 150 } __packed; 151 152 static inline u16 get_prp_LSDU_size(struct prp_rct *rct) 153 { 154 return ntohs(rct->lan_id_and_LSDU_size) & 0x0FFF; 155 } 156 157 static inline void set_prp_lan_id(struct prp_rct *rct, u16 lan_id) 158 { 159 rct->lan_id_and_LSDU_size = htons((ntohs(rct->lan_id_and_LSDU_size) & 160 0x0FFF) | (lan_id << 12)); 161 } 162 static inline void set_prp_LSDU_size(struct prp_rct *rct, u16 LSDU_size) 163 { 164 rct->lan_id_and_LSDU_size = htons((ntohs(rct->lan_id_and_LSDU_size) & 165 0xF000) | (LSDU_size & 0x0FFF)); 166 } 167 168 struct hsr_port { 169 struct list_head port_list; 170 struct net_device *dev; 171 struct hsr_priv *hsr; 172 enum hsr_port_type type; 173 }; 174 175 struct hsr_frame_info; 176 struct hsr_node; 177 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); 192 }; 193 194 struct hsr_priv { 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; 201 int announce_count; 202 u16 sequence_nr; 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 210 */ 211 u8 net_id; /* for PRP, it occupies most significant 3 bits 212 * of lan_id 213 */ 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 217 */ 218 #ifdef CONFIG_DEBUG_FS 219 struct dentry *node_tbl_root; 220 #endif 221 }; 222 223 #define hsr_for_each_port(hsr, port) \ 224 list_for_each_entry_rcu((port), &(hsr)->ports, port_list) 225 226 struct hsr_port *hsr_port_get_hsr(struct hsr_priv *hsr, enum hsr_port_type pt); 227 228 /* Caller must ensure skb is a valid HSR frame */ 229 static inline u16 hsr_get_skb_sequence_nr(struct sk_buff *skb) 230 { 231 struct hsr_ethhdr *hsr_ethhdr; 232 233 hsr_ethhdr = (struct hsr_ethhdr *)skb_mac_header(skb); 234 return ntohs(hsr_ethhdr->hsr_tag.sequence_nr); 235 } 236 237 static inline struct prp_rct *skb_get_PRP_rct(struct sk_buff *skb) 238 { 239 unsigned char *tail = skb_tail_pointer(skb) - HSR_HLEN; 240 241 struct prp_rct *rct = (struct prp_rct *)tail; 242 243 if (rct->PRP_suffix == htons(ETH_P_PRP)) 244 return rct; 245 246 return NULL; 247 } 248 249 /* Assume caller has confirmed this skb is PRP suffixed */ 250 static inline u16 prp_get_skb_sequence_nr(struct prp_rct *rct) 251 { 252 return ntohs(rct->sequence_nr); 253 } 254 255 static inline u16 get_prp_lan_id(struct prp_rct *rct) 256 { 257 return ntohs(rct->lan_id_and_LSDU_size) >> 12; 258 } 259 260 /* assume there is a valid rct */ 261 static inline bool prp_check_lsdu_size(struct sk_buff *skb, 262 struct prp_rct *rct, 263 bool is_sup) 264 { 265 struct ethhdr *ethhdr; 266 int expected_lsdu_size; 267 268 if (is_sup) { 269 expected_lsdu_size = HSR_V1_SUP_LSDUSIZE; 270 } else { 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; 275 } 276 277 return (expected_lsdu_size == get_prp_LSDU_size(rct)); 278 } 279 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); 286 #else 287 static inline void hsr_debugfs_rename(struct net_device *dev) 288 { 289 } 290 static inline void hsr_debugfs_init(struct hsr_priv *priv, 291 struct net_device *hsr_dev) 292 {} 293 static inline void hsr_debugfs_term(struct hsr_priv *priv) 294 {} 295 static inline void hsr_debugfs_create_root(void) 296 {} 297 static inline void hsr_debugfs_remove_root(void) 298 {} 299 #endif 300 301 #endif /* __HSR_PRIVATE_H */ 302