net/hsr/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
  63 static 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
  69 static 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
  75 struct hsr_ethhdr {
  76         struct ethhdr   ethhdr;
  77         struct hsr_tag  hsr_tag;
  78 } __packed;
  79
  80 struct hsr_vlan_ethhdr {
  81         struct vlan_ethhdr vlanhdr;
  82         struct hsr_tag  hsr_tag;
  83 } __packed;
  84
  85 struct 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  */
  93 struct hsr_sup_tag {
  94         __be16                          path_and_HSR_ver;
  95         __be16                          sequence_nr;
  96         struct hsr_sup_tlv  tlv;
  97 } __packed;
  98
  99 struct hsr_sup_payload {
 100         unsigned char   macaddress_A[ETH_ALEN];
 101 } __packed;
 102
 103 static 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
 108 static 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
 113 struct hsrv0_ethhdr_sp {
 114         struct ethhdr           ethhdr;
 115         struct hsr_sup_tag      hsr_sup;
 116 } __packed;
 117
 118 struct hsrv1_ethhdr_sp {
 119         struct ethhdr           ethhdr;
 120         struct hsr_tag          hsr;
 121         struct hsr_sup_tag      hsr_sup;
 122 } __packed;
 123
 124 enum hsr_port_type {
 125         HSR_PT_NONE = 0,        /* Must be 0, used by framereg */
 126         HSR_PT_SLAVE_A,
 127         HSR_PT_SLAVE_B,
 128         HSR_PT_INTERLINK,
 129         HSR_PT_MASTER,
 130         HSR_PT_PORTS,   /* This must be the last item in the enum */
 131 };
 132
 133 /* PRP Redunancy Control Trailor (RCT).
 134  * As defined in IEC-62439-4:2012, the PRP RCT is really { sequence Nr,
 135  * Lan indentifier (LanId), LSDU_size and PRP_suffix = 0x88FB }.
 136  *
 137  * Field names as defined in the IEC:2012 standard for PRP.
 138  */
 139 struct prp_rct {
 140         __be16          sequence_nr;
 141         __be16          lan_id_and_LSDU_size;
 142         __be16          PRP_suffix;
 143 } __packed;
 144
 145 static inline u16 get_prp_LSDU_size(struct prp_rct *rct)
 146 {
 147         return ntohs(rct->lan_id_and_LSDU_size) & 0x0FFF;
 148 }
 149
 150 static inline void set_prp_lan_id(struct prp_rct *rct, u16 lan_id)
 151 {
 152         rct->lan_id_and_LSDU_size = htons((ntohs(rct->lan_id_and_LSDU_size) &
 153                                           0x0FFF) | (lan_id << 12));
 154 }
 155 static inline void set_prp_LSDU_size(struct prp_rct *rct, u16 LSDU_size)
 156 {
 157         rct->lan_id_and_LSDU_size = htons((ntohs(rct->lan_id_and_LSDU_size) &
 158                                           0xF000) | (LSDU_size & 0x0FFF));
 159 }
 160
 161 struct hsr_port {
 162         struct list_head        port_list;
 163         struct net_device       *dev;
 164         struct hsr_priv         *hsr;
 165         enum hsr_port_type      type;
 166 };
 167
 168 struct hsr_frame_info;
 169 struct hsr_node;
 170
 171 struct hsr_proto_ops {
 172         /* format and send supervision frame */
 173         void (*send_sv_frame)(struct hsr_port *port, unsigned long *interval,
 174                               const unsigned char addr[ETH_ALEN]);
 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_self_node {
 189         unsigned char   macaddress_A[ETH_ALEN];
 190         unsigned char   macaddress_B[ETH_ALEN];
 191         struct rcu_head rcu_head;
 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        proxy_node_db;  /* RedBox HSR proxy nodes */
 199         struct hsr_self_node    __rcu *self_node;       /* MACs of slaves */
 200         struct timer_list       announce_timer; /* Supervision frame dispatch */
 201         struct timer_list       announce_proxy_timer;
 202         struct timer_list       prune_timer;
 203         struct timer_list       prune_proxy_timer;
 204         int announce_count;
 205         u16 sequence_nr;
 206         u16 sup_sequence_nr;    /* For HSRv1 separate seq_nr for supervision */
 207         enum hsr_version prot_version;  /* Indicate if HSRv0, HSRv1 or PRPv1 */
 208         spinlock_t seqnr_lock;  /* locking for sequence_nr */
 209         spinlock_t list_lock;   /* locking for node list */
 210         struct hsr_proto_ops    *proto_ops;
 211 #define PRP_LAN_ID      0x5     /* 0x1010 for A and 0x1011 for B. Bit 0 is set
 212                                  * based on SLAVE_A or SLAVE_B
 213                                  */
 214         u8 net_id;              /* for PRP, it occupies most significant 3 bits
 215                                  * of lan_id
 216                                  */
 217         bool fwd_offloaded;     /* Forwarding offloaded to HW */
 218         bool redbox;            /* Device supports HSR RedBox */
 219         unsigned char           macaddress_redbox[ETH_ALEN];
 220         unsigned char           sup_multicast_addr[ETH_ALEN] __aligned(sizeof(u16));
 221                                 /* Align to u16 boundary to avoid unaligned access
 222                                  * in ether_addr_equal
 223                                  */
 224 #ifdef  CONFIG_DEBUG_FS
 225         struct dentry *node_tbl_root;
 226 #endif
 227 };
 228
 229 #define hsr_for_each_port(hsr, port) \
 230         list_for_each_entry_rcu((port), &(hsr)->ports, port_list)
 231
 232 struct hsr_port *hsr_port_get_hsr(struct hsr_priv *hsr, enum hsr_port_type pt);
 233
 234 /* Caller must ensure skb is a valid HSR frame */
 235 static inline u16 hsr_get_skb_sequence_nr(struct sk_buff *skb)
 236 {
 237         struct hsr_ethhdr *hsr_ethhdr;
 238
 239         hsr_ethhdr = (struct hsr_ethhdr *)skb_mac_header(skb);
 240         return ntohs(hsr_ethhdr->hsr_tag.sequence_nr);
 241 }
 242
 243 static inline struct prp_rct *skb_get_PRP_rct(struct sk_buff *skb)
 244 {
 245         unsigned char *tail = skb_tail_pointer(skb) - HSR_HLEN;
 246
 247         struct prp_rct *rct = (struct prp_rct *)tail;
 248
 249         if (rct->PRP_suffix == htons(ETH_P_PRP))
 250                 return rct;
 251
 252         return NULL;
 253 }
 254
 255 /* Assume caller has confirmed this skb is PRP suffixed */
 256 static inline u16 prp_get_skb_sequence_nr(struct prp_rct *rct)
 257 {
 258         return ntohs(rct->sequence_nr);
 259 }
 260
 261 /* assume there is a valid rct */
 262 static inline bool prp_check_lsdu_size(struct sk_buff *skb,
 263                                        struct prp_rct *rct,
 264                                        bool is_sup)
 265 {
 266         struct ethhdr *ethhdr;
 267         int expected_lsdu_size;
 268
 269         if (is_sup) {
 270                 expected_lsdu_size = HSR_V1_SUP_LSDUSIZE;
 271         } else {
 272                 ethhdr = (struct ethhdr *)skb_mac_header(skb);
 273                 expected_lsdu_size = skb->len - 14;
 274                 if (ethhdr->h_proto == htons(ETH_P_8021Q))
 275                         expected_lsdu_size -= 4;
 276         }
 277
 278         return (expected_lsdu_size == get_prp_LSDU_size(rct));
 279 }
 280
 281 #if IS_ENABLED(CONFIG_DEBUG_FS)
 282 void hsr_debugfs_rename(struct net_device *dev);
 283 void hsr_debugfs_init(struct hsr_priv *priv, struct net_device *hsr_dev);
 284 void hsr_debugfs_term(struct hsr_priv *priv);
 285 void hsr_debugfs_create_root(void);
 286 void hsr_debugfs_remove_root(void);
 287 #else
 288 static inline void hsr_debugfs_rename(struct net_device *dev)
 289 {
 290 }
 291 static inline void hsr_debugfs_init(struct hsr_priv *priv,
 292                                     struct net_device *hsr_dev)
 293 {}
 294 static inline void hsr_debugfs_term(struct hsr_priv *priv)
 295 {}
 296 static inline void hsr_debugfs_create_root(void)
 297 {}
 298 static inline void hsr_debugfs_remove_root(void)
 299 {}
 300 #endif
 301
 302 #endif /*  __HSR_PRIVATE_H */