hsr_main.h 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305
  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. #ifndef __HSR_PRIVATE_H
  10. #define __HSR_PRIVATE_H
  11. #include <linux/netdevice.h>
  12. #include <linux/list.h>
  13. #include <linux/if_vlan.h>
  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. #define HSR_ENTRY_FORGET_TIME 400 /* ms */
  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. /* How often shall we check for broken ring and remove node entries older than
  29. * HSR_NODE_FORGET_TIME?
  30. */
  31. #define PRUNE_PERIOD 3000 /* ms */
  32. #define HSR_TLV_ANNOUNCE 22
  33. #define HSR_TLV_LIFE_CHECK 23
  34. /* PRP V1 life check for Duplicate discard */
  35. #define PRP_TLV_LIFE_CHECK_DD 20
  36. /* PRP V1 life check for Duplicate Accept */
  37. #define PRP_TLV_LIFE_CHECK_DA 21
  38. /* HSR Tag.
  39. * As defined in IEC-62439-3:2010, the HSR tag is really { ethertype = 0x88FB,
  40. * path, LSDU_size, sequence Nr }. But we let eth_header() create { h_dest,
  41. * h_source, h_proto = 0x88FB }, and add { path, LSDU_size, sequence Nr,
  42. * encapsulated protocol } instead.
  43. *
  44. * Field names as defined in the IEC:2010 standard for HSR.
  45. */
  46. struct hsr_tag {
  47. __be16 path_and_LSDU_size;
  48. __be16 sequence_nr;
  49. __be16 encap_proto;
  50. } __packed;
  51. #define HSR_HLEN 6
  52. #define HSR_V1_SUP_LSDUSIZE 52
  53. /* The helper functions below assumes that 'path' occupies the 4 most
  54. * significant bits of the 16-bit field shared by 'path' and 'LSDU_size' (or
  55. * equivalently, the 4 most significant bits of HSR tag byte 14).
  56. *
  57. * This is unclear in the IEC specification; its definition of MAC addresses
  58. * indicates the spec is written with the least significant bit first (to the
  59. * left). This, however, would mean that the LSDU field would be split in two
  60. * with the path field in-between, which seems strange. I'm guessing the MAC
  61. * address definition is in error.
  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. static inline void set_hsr_tag_LSDU_size(struct hsr_tag *ht, u16 LSDU_size)
  69. {
  70. ht->path_and_LSDU_size = htons((ntohs(ht->path_and_LSDU_size) &
  71. 0xF000) | (LSDU_size & 0x0FFF));
  72. }
  73. struct hsr_ethhdr {
  74. struct ethhdr ethhdr;
  75. struct hsr_tag hsr_tag;
  76. } __packed;
  77. struct hsr_vlan_ethhdr {
  78. struct vlan_ethhdr vlanhdr;
  79. struct hsr_tag hsr_tag;
  80. } __packed;
  81. /* HSR/PRP Supervision Frame data types.
  82. * Field names as defined in the IEC:2010 standard for HSR.
  83. */
  84. struct hsr_sup_tag {
  85. __be16 path_and_HSR_ver;
  86. __be16 sequence_nr;
  87. __u8 HSR_TLV_type;
  88. __u8 HSR_TLV_length;
  89. } __packed;
  90. struct hsr_sup_payload {
  91. unsigned char macaddress_A[ETH_ALEN];
  92. } __packed;
  93. static inline void set_hsr_stag_path(struct hsr_sup_tag *hst, u16 path)
  94. {
  95. set_hsr_tag_path((struct hsr_tag *)hst, path);
  96. }
  97. static inline void set_hsr_stag_HSR_ver(struct hsr_sup_tag *hst, u16 HSR_ver)
  98. {
  99. set_hsr_tag_LSDU_size((struct hsr_tag *)hst, HSR_ver);
  100. }
  101. struct hsrv0_ethhdr_sp {
  102. struct ethhdr ethhdr;
  103. struct hsr_sup_tag hsr_sup;
  104. } __packed;
  105. struct hsrv1_ethhdr_sp {
  106. struct ethhdr ethhdr;
  107. struct hsr_tag hsr;
  108. struct hsr_sup_tag hsr_sup;
  109. } __packed;
  110. enum hsr_port_type {
  111. HSR_PT_NONE = 0, /* Must be 0, used by framereg */
  112. HSR_PT_SLAVE_A,
  113. HSR_PT_SLAVE_B,
  114. HSR_PT_INTERLINK,
  115. HSR_PT_MASTER,
  116. HSR_PT_PORTS, /* This must be the last item in the enum */
  117. };
  118. /* PRP Redunancy Control Trailor (RCT).
  119. * As defined in IEC-62439-4:2012, the PRP RCT is really { sequence Nr,
  120. * Lan indentifier (LanId), LSDU_size and PRP_suffix = 0x88FB }.
  121. *
  122. * Field names as defined in the IEC:2012 standard for PRP.
  123. */
  124. struct prp_rct {
  125. __be16 sequence_nr;
  126. __be16 lan_id_and_LSDU_size;
  127. __be16 PRP_suffix;
  128. } __packed;
  129. static inline u16 get_prp_LSDU_size(struct prp_rct *rct)
  130. {
  131. return ntohs(rct->lan_id_and_LSDU_size) & 0x0FFF;
  132. }
  133. static inline void set_prp_lan_id(struct prp_rct *rct, u16 lan_id)
  134. {
  135. rct->lan_id_and_LSDU_size = htons((ntohs(rct->lan_id_and_LSDU_size) &
  136. 0x0FFF) | (lan_id << 12));
  137. }
  138. static inline void set_prp_LSDU_size(struct prp_rct *rct, u16 LSDU_size)
  139. {
  140. rct->lan_id_and_LSDU_size = htons((ntohs(rct->lan_id_and_LSDU_size) &
  141. 0xF000) | (LSDU_size & 0x0FFF));
  142. }
  143. struct hsr_port {
  144. struct list_head port_list;
  145. struct net_device *dev;
  146. struct hsr_priv *hsr;
  147. enum hsr_port_type type;
  148. };
  149. /* used by driver internally to differentiate various protocols */
  150. enum hsr_version {
  151. HSR_V0 = 0,
  152. HSR_V1,
  153. PRP_V1,
  154. };
  155. struct hsr_frame_info;
  156. struct hsr_node;
  157. struct hsr_proto_ops {
  158. /* format and send supervision frame */
  159. void (*send_sv_frame)(struct hsr_port *port, unsigned long *interval);
  160. void (*handle_san_frame)(bool san, enum hsr_port_type port,
  161. struct hsr_node *node);
  162. bool (*drop_frame)(struct hsr_frame_info *frame, struct hsr_port *port);
  163. struct sk_buff * (*get_untagged_frame)(struct hsr_frame_info *frame,
  164. struct hsr_port *port);
  165. struct sk_buff * (*create_tagged_frame)(struct hsr_frame_info *frame,
  166. struct hsr_port *port);
  167. int (*fill_frame_info)(__be16 proto, struct sk_buff *skb,
  168. struct hsr_frame_info *frame);
  169. bool (*invalid_dan_ingress_frame)(__be16 protocol);
  170. void (*update_san_info)(struct hsr_node *node, bool is_sup);
  171. };
  172. struct hsr_priv {
  173. struct rcu_head rcu_head;
  174. struct list_head ports;
  175. struct list_head node_db; /* Known HSR nodes */
  176. struct list_head self_node_db; /* MACs of slaves */
  177. struct timer_list announce_timer; /* Supervision frame dispatch */
  178. struct timer_list prune_timer;
  179. int announce_count;
  180. u16 sequence_nr;
  181. u16 sup_sequence_nr; /* For HSRv1 separate seq_nr for supervision */
  182. enum hsr_version prot_version; /* Indicate if HSRv0, HSRv1 or PRPv1 */
  183. spinlock_t seqnr_lock; /* locking for sequence_nr */
  184. spinlock_t list_lock; /* locking for node list */
  185. struct hsr_proto_ops *proto_ops;
  186. #define PRP_LAN_ID 0x5 /* 0x1010 for A and 0x1011 for B. Bit 0 is set
  187. * based on SLAVE_A or SLAVE_B
  188. */
  189. u8 net_id; /* for PRP, it occupies most significant 3 bits
  190. * of lan_id
  191. */
  192. unsigned char sup_multicast_addr[ETH_ALEN];
  193. #ifdef CONFIG_DEBUG_FS
  194. struct dentry *node_tbl_root;
  195. #endif
  196. };
  197. #define hsr_for_each_port(hsr, port) \
  198. list_for_each_entry_rcu((port), &(hsr)->ports, port_list)
  199. struct hsr_port *hsr_port_get_hsr(struct hsr_priv *hsr, enum hsr_port_type pt);
  200. /* Caller must ensure skb is a valid HSR frame */
  201. static inline u16 hsr_get_skb_sequence_nr(struct sk_buff *skb)
  202. {
  203. struct hsr_ethhdr *hsr_ethhdr;
  204. hsr_ethhdr = (struct hsr_ethhdr *)skb_mac_header(skb);
  205. return ntohs(hsr_ethhdr->hsr_tag.sequence_nr);
  206. }
  207. static inline struct prp_rct *skb_get_PRP_rct(struct sk_buff *skb)
  208. {
  209. unsigned char *tail = skb_tail_pointer(skb) - HSR_HLEN;
  210. struct prp_rct *rct = (struct prp_rct *)tail;
  211. if (rct->PRP_suffix == htons(ETH_P_PRP))
  212. return rct;
  213. return NULL;
  214. }
  215. /* Assume caller has confirmed this skb is PRP suffixed */
  216. static inline u16 prp_get_skb_sequence_nr(struct prp_rct *rct)
  217. {
  218. return ntohs(rct->sequence_nr);
  219. }
  220. static inline u16 get_prp_lan_id(struct prp_rct *rct)
  221. {
  222. return ntohs(rct->lan_id_and_LSDU_size) >> 12;
  223. }
  224. /* assume there is a valid rct */
  225. static inline bool prp_check_lsdu_size(struct sk_buff *skb,
  226. struct prp_rct *rct,
  227. bool is_sup)
  228. {
  229. struct ethhdr *ethhdr;
  230. int expected_lsdu_size;
  231. if (is_sup) {
  232. expected_lsdu_size = HSR_V1_SUP_LSDUSIZE;
  233. } else {
  234. ethhdr = (struct ethhdr *)skb_mac_header(skb);
  235. expected_lsdu_size = skb->len - 14;
  236. if (ethhdr->h_proto == htons(ETH_P_8021Q))
  237. expected_lsdu_size -= 4;
  238. }
  239. return (expected_lsdu_size == get_prp_LSDU_size(rct));
  240. }
  241. #if IS_ENABLED(CONFIG_DEBUG_FS)
  242. void hsr_debugfs_rename(struct net_device *dev);
  243. void hsr_debugfs_init(struct hsr_priv *priv, struct net_device *hsr_dev);
  244. void hsr_debugfs_term(struct hsr_priv *priv);
  245. void hsr_debugfs_create_root(void);
  246. void hsr_debugfs_remove_root(void);
  247. #else
  248. static inline void hsr_debugfs_rename(struct net_device *dev)
  249. {
  250. }
  251. static inline void hsr_debugfs_init(struct hsr_priv *priv,
  252. struct net_device *hsr_dev)
  253. {}
  254. static inline void hsr_debugfs_term(struct hsr_priv *priv)
  255. {}
  256. static inline void hsr_debugfs_create_root(void)
  257. {}
  258. static inline void hsr_debugfs_remove_root(void)
  259. {}
  260. #endif
  261. #endif /* __HSR_PRIVATE_H */