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