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 8 #ifndef __HSR_PRIVATE_H 9 #define __HSR_PRIVATE_H 10 11 #include <linux/netdevice.h> 12 #include <linux/list.h> 13 14 /* Time constants as specified in the HSR specification (IEC-62439-3 2010) 15 * Table 8. 16 * All values in milliseconds. 17 */ 18 #define HSR_LIFE_CHECK_INTERVAL 2000 /* ms */ 19 #define HSR_NODE_FORGET_TIME 60000 /* ms */ 20 #define HSR_ANNOUNCE_INTERVAL 100 /* ms */ 21 22 /* By how much may slave1 and slave2 timestamps of latest received frame from 23 * each node differ before we notify of communication problem? 24 */ 25 #define MAX_SLAVE_DIFF 3000 /* ms */ 26 #define HSR_SEQNR_START (USHRT_MAX - 1024) 27 #define HSR_SUP_SEQNR_START (HSR_SEQNR_START / 2) 28 29 /* How often shall we check for broken ring and remove node entries older than 30 * HSR_NODE_FORGET_TIME? 31 */ 32 #define PRUNE_PERIOD 3000 /* ms */ 33 34 #define HSR_TLV_ANNOUNCE 22 35 #define HSR_TLV_LIFE_CHECK 23 36 37 /* HSR Tag. 38 * As defined in IEC-62439-3:2010, the HSR tag is really { ethertype = 0x88FB, 39 * path, LSDU_size, sequence Nr }. But we let eth_header() create { h_dest, 40 * h_source, h_proto = 0x88FB }, and add { path, LSDU_size, sequence Nr, 41 * encapsulated protocol } instead. 42 * 43 * Field names as defined in the IEC:2010 standard for HSR. 44 */ 45 struct hsr_tag { 46 __be16 path_and_LSDU_size; 47 __be16 sequence_nr; 48 __be16 encap_proto; 49 } __packed; 50 51 #define HSR_HLEN 6 52 53 #define HSR_V1_SUP_LSDUSIZE 52 54 55 /* The helper functions below assumes that 'path' occupies the 4 most 56 * significant bits of the 16-bit field shared by 'path' and 'LSDU_size' (or 57 * equivalently, the 4 most significant bits of HSR tag byte 14). 58 * 59 * This is unclear in the IEC specification; its definition of MAC addresses 60 * indicates the spec is written with the least significant bit first (to the 61 * left). This, however, would mean that the LSDU field would be split in two 62 * with the path field in-between, which seems strange. I'm guessing the MAC 63 * address definition is in error. 64 */ 65 66 static inline void set_hsr_tag_path(struct hsr_tag *ht, u16 path) 67 { 68 ht->path_and_LSDU_size = 69 htons((ntohs(ht->path_and_LSDU_size) & 0x0FFF) | (path << 12)); 70 } 71 72 static inline void set_hsr_tag_LSDU_size(struct hsr_tag *ht, u16 LSDU_size) 73 { 74 ht->path_and_LSDU_size = htons((ntohs(ht->path_and_LSDU_size) & 75 0xF000) | (LSDU_size & 0x0FFF)); 76 } 77 78 struct hsr_ethhdr { 79 struct ethhdr ethhdr; 80 struct hsr_tag hsr_tag; 81 } __packed; 82 83 /* HSR Supervision Frame data types. 84 * Field names as defined in the IEC:2010 standard for HSR. 85 */ 86 struct hsr_sup_tag { 87 __be16 path_and_HSR_ver; 88 __be16 sequence_nr; 89 __u8 HSR_TLV_type; 90 __u8 HSR_TLV_length; 91 } __packed; 92 93 struct hsr_sup_payload { 94 unsigned char macaddress_A[ETH_ALEN]; 95 } __packed; 96 97 static inline void set_hsr_stag_path(struct hsr_sup_tag *hst, u16 path) 98 { 99 set_hsr_tag_path((struct hsr_tag *)hst, path); 100 } 101 102 static inline void set_hsr_stag_HSR_ver(struct hsr_sup_tag *hst, u16 HSR_ver) 103 { 104 set_hsr_tag_LSDU_size((struct hsr_tag *)hst, HSR_ver); 105 } 106 107 struct hsrv0_ethhdr_sp { 108 struct ethhdr ethhdr; 109 struct hsr_sup_tag hsr_sup; 110 } __packed; 111 112 struct hsrv1_ethhdr_sp { 113 struct ethhdr ethhdr; 114 struct hsr_tag hsr; 115 struct hsr_sup_tag hsr_sup; 116 } __packed; 117 118 enum hsr_port_type { 119 HSR_PT_NONE = 0, /* Must be 0, used by framereg */ 120 HSR_PT_SLAVE_A, 121 HSR_PT_SLAVE_B, 122 HSR_PT_INTERLINK, 123 HSR_PT_MASTER, 124 HSR_PT_PORTS, /* This must be the last item in the enum */ 125 }; 126 127 struct hsr_port { 128 struct list_head port_list; 129 struct net_device *dev; 130 struct hsr_priv *hsr; 131 enum hsr_port_type type; 132 }; 133 134 struct hsr_priv { 135 struct rcu_head rcu_head; 136 struct list_head ports; 137 struct list_head node_db; /* Known HSR nodes */ 138 struct list_head self_node_db; /* MACs of slaves */ 139 struct timer_list announce_timer; /* Supervision frame dispatch */ 140 struct timer_list prune_timer; 141 int announce_count; 142 u16 sequence_nr; 143 u16 sup_sequence_nr; /* For HSRv1 separate seq_nr for supervision */ 144 u8 prot_version; /* Indicate if HSRv0 or HSRv1. */ 145 spinlock_t seqnr_lock; /* locking for sequence_nr */ 146 spinlock_t list_lock; /* locking for node list */ 147 unsigned char sup_multicast_addr[ETH_ALEN]; 148 #ifdef CONFIG_DEBUG_FS 149 struct dentry *node_tbl_root; 150 #endif 151 }; 152 153 #define hsr_for_each_port(hsr, port) \ 154 list_for_each_entry_rcu((port), &(hsr)->ports, port_list) 155 156 struct hsr_port *hsr_port_get_hsr(struct hsr_priv *hsr, enum hsr_port_type pt); 157 158 /* Caller must ensure skb is a valid HSR frame */ 159 static inline u16 hsr_get_skb_sequence_nr(struct sk_buff *skb) 160 { 161 struct hsr_ethhdr *hsr_ethhdr; 162 163 hsr_ethhdr = (struct hsr_ethhdr *)skb_mac_header(skb); 164 return ntohs(hsr_ethhdr->hsr_tag.sequence_nr); 165 } 166 167 #if IS_ENABLED(CONFIG_DEBUG_FS) 168 void hsr_debugfs_rename(struct net_device *dev); 169 void hsr_debugfs_init(struct hsr_priv *priv, struct net_device *hsr_dev); 170 void hsr_debugfs_term(struct hsr_priv *priv); 171 void hsr_debugfs_create_root(void); 172 void hsr_debugfs_remove_root(void); 173 #else 174 static inline void hsr_debugfs_rename(struct net_device *dev) 175 { 176 } 177 static inline void hsr_debugfs_init(struct hsr_priv *priv, 178 struct net_device *hsr_dev) 179 {} 180 static inline void hsr_debugfs_term(struct hsr_priv *priv) 181 {} 182 static inline void hsr_debugfs_create_root(void) 183 {} 184 static inline void hsr_debugfs_remove_root(void) 185 {} 186 #endif 187 188 #endif /* __HSR_PRIVATE_H */ 189