Mention branches and keyring.
[releases.git] / hsr / hsr_device.c
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  * This file contains device methods for creating, using and destroying
7  * virtual HSR or PRP devices.
8  */
9
10 #include <linux/netdevice.h>
11 #include <linux/skbuff.h>
12 #include <linux/etherdevice.h>
13 #include <linux/rtnetlink.h>
14 #include <linux/pkt_sched.h>
15 #include "hsr_device.h"
16 #include "hsr_slave.h"
17 #include "hsr_framereg.h"
18 #include "hsr_main.h"
19 #include "hsr_forward.h"
20
21 static bool is_admin_up(struct net_device *dev)
22 {
23         return dev && (dev->flags & IFF_UP);
24 }
25
26 static bool is_slave_up(struct net_device *dev)
27 {
28         return dev && is_admin_up(dev) && netif_oper_up(dev);
29 }
30
31 static void __hsr_set_operstate(struct net_device *dev, int transition)
32 {
33         write_lock(&dev_base_lock);
34         if (dev->operstate != transition) {
35                 dev->operstate = transition;
36                 write_unlock(&dev_base_lock);
37                 netdev_state_change(dev);
38         } else {
39                 write_unlock(&dev_base_lock);
40         }
41 }
42
43 static void hsr_set_operstate(struct hsr_port *master, bool has_carrier)
44 {
45         if (!is_admin_up(master->dev)) {
46                 __hsr_set_operstate(master->dev, IF_OPER_DOWN);
47                 return;
48         }
49
50         if (has_carrier)
51                 __hsr_set_operstate(master->dev, IF_OPER_UP);
52         else
53                 __hsr_set_operstate(master->dev, IF_OPER_LOWERLAYERDOWN);
54 }
55
56 static bool hsr_check_carrier(struct hsr_port *master)
57 {
58         struct hsr_port *port;
59
60         ASSERT_RTNL();
61
62         hsr_for_each_port(master->hsr, port) {
63                 if (port->type != HSR_PT_MASTER && is_slave_up(port->dev)) {
64                         netif_carrier_on(master->dev);
65                         return true;
66                 }
67         }
68
69         netif_carrier_off(master->dev);
70
71         return false;
72 }
73
74 static void hsr_check_announce(struct net_device *hsr_dev,
75                                unsigned char old_operstate)
76 {
77         struct hsr_priv *hsr;
78
79         hsr = netdev_priv(hsr_dev);
80
81         if (hsr_dev->operstate == IF_OPER_UP && old_operstate != IF_OPER_UP) {
82                 /* Went up */
83                 hsr->announce_count = 0;
84                 mod_timer(&hsr->announce_timer,
85                           jiffies + msecs_to_jiffies(HSR_ANNOUNCE_INTERVAL));
86         }
87
88         if (hsr_dev->operstate != IF_OPER_UP && old_operstate == IF_OPER_UP)
89                 /* Went down */
90                 del_timer(&hsr->announce_timer);
91 }
92
93 void hsr_check_carrier_and_operstate(struct hsr_priv *hsr)
94 {
95         struct hsr_port *master;
96         unsigned char old_operstate;
97         bool has_carrier;
98
99         master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
100         /* netif_stacked_transfer_operstate() cannot be used here since
101          * it doesn't set IF_OPER_LOWERLAYERDOWN (?)
102          */
103         old_operstate = master->dev->operstate;
104         has_carrier = hsr_check_carrier(master);
105         hsr_set_operstate(master, has_carrier);
106         hsr_check_announce(master->dev, old_operstate);
107 }
108
109 int hsr_get_max_mtu(struct hsr_priv *hsr)
110 {
111         unsigned int mtu_max;
112         struct hsr_port *port;
113
114         mtu_max = ETH_DATA_LEN;
115         hsr_for_each_port(hsr, port)
116                 if (port->type != HSR_PT_MASTER)
117                         mtu_max = min(port->dev->mtu, mtu_max);
118
119         if (mtu_max < HSR_HLEN)
120                 return 0;
121         return mtu_max - HSR_HLEN;
122 }
123
124 static int hsr_dev_change_mtu(struct net_device *dev, int new_mtu)
125 {
126         struct hsr_priv *hsr;
127
128         hsr = netdev_priv(dev);
129
130         if (new_mtu > hsr_get_max_mtu(hsr)) {
131                 netdev_info(dev, "A HSR master's MTU cannot be greater than the smallest MTU of its slaves minus the HSR Tag length (%d octets).\n",
132                             HSR_HLEN);
133                 return -EINVAL;
134         }
135
136         dev->mtu = new_mtu;
137
138         return 0;
139 }
140
141 static int hsr_dev_open(struct net_device *dev)
142 {
143         struct hsr_priv *hsr;
144         struct hsr_port *port;
145         char designation;
146
147         hsr = netdev_priv(dev);
148         designation = '\0';
149
150         hsr_for_each_port(hsr, port) {
151                 if (port->type == HSR_PT_MASTER)
152                         continue;
153                 switch (port->type) {
154                 case HSR_PT_SLAVE_A:
155                         designation = 'A';
156                         break;
157                 case HSR_PT_SLAVE_B:
158                         designation = 'B';
159                         break;
160                 default:
161                         designation = '?';
162                 }
163                 if (!is_slave_up(port->dev))
164                         netdev_warn(dev, "Slave %c (%s) is not up; please bring it up to get a fully working HSR network\n",
165                                     designation, port->dev->name);
166         }
167
168         if (designation == '\0')
169                 netdev_warn(dev, "No slave devices configured\n");
170
171         return 0;
172 }
173
174 static int hsr_dev_close(struct net_device *dev)
175 {
176         struct hsr_port *port;
177         struct hsr_priv *hsr;
178
179         hsr = netdev_priv(dev);
180         hsr_for_each_port(hsr, port) {
181                 if (port->type == HSR_PT_MASTER)
182                         continue;
183                 switch (port->type) {
184                 case HSR_PT_SLAVE_A:
185                 case HSR_PT_SLAVE_B:
186                         dev_uc_unsync(port->dev, dev);
187                         dev_mc_unsync(port->dev, dev);
188                         break;
189                 default:
190                         break;
191                 }
192         }
193
194         return 0;
195 }
196
197 static netdev_features_t hsr_features_recompute(struct hsr_priv *hsr,
198                                                 netdev_features_t features)
199 {
200         netdev_features_t mask;
201         struct hsr_port *port;
202
203         mask = features;
204
205         /* Mask out all features that, if supported by one device, should be
206          * enabled for all devices (see NETIF_F_ONE_FOR_ALL).
207          *
208          * Anything that's off in mask will not be enabled - so only things
209          * that were in features originally, and also is in NETIF_F_ONE_FOR_ALL,
210          * may become enabled.
211          */
212         features &= ~NETIF_F_ONE_FOR_ALL;
213         hsr_for_each_port(hsr, port)
214                 features = netdev_increment_features(features,
215                                                      port->dev->features,
216                                                      mask);
217
218         return features;
219 }
220
221 static netdev_features_t hsr_fix_features(struct net_device *dev,
222                                           netdev_features_t features)
223 {
224         struct hsr_priv *hsr = netdev_priv(dev);
225
226         return hsr_features_recompute(hsr, features);
227 }
228
229 static netdev_tx_t hsr_dev_xmit(struct sk_buff *skb, struct net_device *dev)
230 {
231         struct hsr_priv *hsr = netdev_priv(dev);
232         struct hsr_port *master;
233
234         master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
235         if (master) {
236                 skb->dev = master->dev;
237                 skb_reset_mac_header(skb);
238                 skb_reset_mac_len(skb);
239                 spin_lock_bh(&hsr->seqnr_lock);
240                 hsr_forward_skb(skb, master);
241                 spin_unlock_bh(&hsr->seqnr_lock);
242         } else {
243                 dev_core_stats_tx_dropped_inc(dev);
244                 dev_kfree_skb_any(skb);
245         }
246         return NETDEV_TX_OK;
247 }
248
249 static const struct header_ops hsr_header_ops = {
250         .create  = eth_header,
251         .parse   = eth_header_parse,
252 };
253
254 static struct sk_buff *hsr_init_skb(struct hsr_port *master)
255 {
256         struct hsr_priv *hsr = master->hsr;
257         struct sk_buff *skb;
258         int hlen, tlen;
259
260         hlen = LL_RESERVED_SPACE(master->dev);
261         tlen = master->dev->needed_tailroom;
262         /* skb size is same for PRP/HSR frames, only difference
263          * being, for PRP it is a trailer and for HSR it is a
264          * header
265          */
266         skb = dev_alloc_skb(sizeof(struct hsr_sup_tag) +
267                             sizeof(struct hsr_sup_payload) + hlen + tlen);
268
269         if (!skb)
270                 return skb;
271
272         skb_reserve(skb, hlen);
273         skb->dev = master->dev;
274         skb->priority = TC_PRIO_CONTROL;
275
276         if (dev_hard_header(skb, skb->dev, ETH_P_PRP,
277                             hsr->sup_multicast_addr,
278                             skb->dev->dev_addr, skb->len) <= 0)
279                 goto out;
280
281         skb_reset_mac_header(skb);
282         skb_reset_mac_len(skb);
283         skb_reset_network_header(skb);
284         skb_reset_transport_header(skb);
285
286         return skb;
287 out:
288         kfree_skb(skb);
289
290         return NULL;
291 }
292
293 static void send_hsr_supervision_frame(struct hsr_port *master,
294                                        unsigned long *interval)
295 {
296         struct hsr_priv *hsr = master->hsr;
297         __u8 type = HSR_TLV_LIFE_CHECK;
298         struct hsr_sup_payload *hsr_sp;
299         struct hsr_sup_tag *hsr_stag;
300         struct sk_buff *skb;
301
302         *interval = msecs_to_jiffies(HSR_LIFE_CHECK_INTERVAL);
303         if (hsr->announce_count < 3 && hsr->prot_version == 0) {
304                 type = HSR_TLV_ANNOUNCE;
305                 *interval = msecs_to_jiffies(HSR_ANNOUNCE_INTERVAL);
306                 hsr->announce_count++;
307         }
308
309         skb = hsr_init_skb(master);
310         if (!skb) {
311                 netdev_warn_once(master->dev, "HSR: Could not send supervision frame\n");
312                 return;
313         }
314
315         hsr_stag = skb_put(skb, sizeof(struct hsr_sup_tag));
316         set_hsr_stag_path(hsr_stag, (hsr->prot_version ? 0x0 : 0xf));
317         set_hsr_stag_HSR_ver(hsr_stag, hsr->prot_version);
318
319         /* From HSRv1 on we have separate supervision sequence numbers. */
320         spin_lock_bh(&hsr->seqnr_lock);
321         if (hsr->prot_version > 0) {
322                 hsr_stag->sequence_nr = htons(hsr->sup_sequence_nr);
323                 hsr->sup_sequence_nr++;
324         } else {
325                 hsr_stag->sequence_nr = htons(hsr->sequence_nr);
326                 hsr->sequence_nr++;
327         }
328
329         hsr_stag->tlv.HSR_TLV_type = type;
330         /* TODO: Why 12 in HSRv0? */
331         hsr_stag->tlv.HSR_TLV_length = hsr->prot_version ?
332                                 sizeof(struct hsr_sup_payload) : 12;
333
334         /* Payload: MacAddressA */
335         hsr_sp = skb_put(skb, sizeof(struct hsr_sup_payload));
336         ether_addr_copy(hsr_sp->macaddress_A, master->dev->dev_addr);
337
338         if (skb_put_padto(skb, ETH_ZLEN)) {
339                 spin_unlock_bh(&hsr->seqnr_lock);
340                 return;
341         }
342
343         hsr_forward_skb(skb, master);
344         spin_unlock_bh(&hsr->seqnr_lock);
345         return;
346 }
347
348 static void send_prp_supervision_frame(struct hsr_port *master,
349                                        unsigned long *interval)
350 {
351         struct hsr_priv *hsr = master->hsr;
352         struct hsr_sup_payload *hsr_sp;
353         struct hsr_sup_tag *hsr_stag;
354         struct sk_buff *skb;
355
356         skb = hsr_init_skb(master);
357         if (!skb) {
358                 netdev_warn_once(master->dev, "PRP: Could not send supervision frame\n");
359                 return;
360         }
361
362         *interval = msecs_to_jiffies(HSR_LIFE_CHECK_INTERVAL);
363         hsr_stag = skb_put(skb, sizeof(struct hsr_sup_tag));
364         set_hsr_stag_path(hsr_stag, (hsr->prot_version ? 0x0 : 0xf));
365         set_hsr_stag_HSR_ver(hsr_stag, (hsr->prot_version ? 1 : 0));
366
367         /* From HSRv1 on we have separate supervision sequence numbers. */
368         spin_lock_bh(&hsr->seqnr_lock);
369         hsr_stag->sequence_nr = htons(hsr->sup_sequence_nr);
370         hsr->sup_sequence_nr++;
371         hsr_stag->tlv.HSR_TLV_type = PRP_TLV_LIFE_CHECK_DD;
372         hsr_stag->tlv.HSR_TLV_length = sizeof(struct hsr_sup_payload);
373
374         /* Payload: MacAddressA */
375         hsr_sp = skb_put(skb, sizeof(struct hsr_sup_payload));
376         ether_addr_copy(hsr_sp->macaddress_A, master->dev->dev_addr);
377
378         if (skb_put_padto(skb, ETH_ZLEN)) {
379                 spin_unlock_bh(&hsr->seqnr_lock);
380                 return;
381         }
382
383         hsr_forward_skb(skb, master);
384         spin_unlock_bh(&hsr->seqnr_lock);
385 }
386
387 /* Announce (supervision frame) timer function
388  */
389 static void hsr_announce(struct timer_list *t)
390 {
391         struct hsr_priv *hsr;
392         struct hsr_port *master;
393         unsigned long interval;
394
395         hsr = from_timer(hsr, t, announce_timer);
396
397         rcu_read_lock();
398         master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
399         hsr->proto_ops->send_sv_frame(master, &interval);
400
401         if (is_admin_up(master->dev))
402                 mod_timer(&hsr->announce_timer, jiffies + interval);
403
404         rcu_read_unlock();
405 }
406
407 void hsr_del_ports(struct hsr_priv *hsr)
408 {
409         struct hsr_port *port;
410
411         port = hsr_port_get_hsr(hsr, HSR_PT_SLAVE_A);
412         if (port)
413                 hsr_del_port(port);
414
415         port = hsr_port_get_hsr(hsr, HSR_PT_SLAVE_B);
416         if (port)
417                 hsr_del_port(port);
418
419         port = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
420         if (port)
421                 hsr_del_port(port);
422 }
423
424 static void hsr_set_rx_mode(struct net_device *dev)
425 {
426         struct hsr_port *port;
427         struct hsr_priv *hsr;
428
429         hsr = netdev_priv(dev);
430
431         hsr_for_each_port(hsr, port) {
432                 if (port->type == HSR_PT_MASTER)
433                         continue;
434                 switch (port->type) {
435                 case HSR_PT_SLAVE_A:
436                 case HSR_PT_SLAVE_B:
437                         dev_mc_sync_multiple(port->dev, dev);
438                         dev_uc_sync_multiple(port->dev, dev);
439                         break;
440                 default:
441                         break;
442                 }
443         }
444 }
445
446 static void hsr_change_rx_flags(struct net_device *dev, int change)
447 {
448         struct hsr_port *port;
449         struct hsr_priv *hsr;
450
451         hsr = netdev_priv(dev);
452
453         hsr_for_each_port(hsr, port) {
454                 if (port->type == HSR_PT_MASTER)
455                         continue;
456                 switch (port->type) {
457                 case HSR_PT_SLAVE_A:
458                 case HSR_PT_SLAVE_B:
459                         if (change & IFF_ALLMULTI)
460                                 dev_set_allmulti(port->dev,
461                                                  dev->flags &
462                                                  IFF_ALLMULTI ? 1 : -1);
463                         break;
464                 default:
465                         break;
466                 }
467         }
468 }
469
470 static const struct net_device_ops hsr_device_ops = {
471         .ndo_change_mtu = hsr_dev_change_mtu,
472         .ndo_open = hsr_dev_open,
473         .ndo_stop = hsr_dev_close,
474         .ndo_start_xmit = hsr_dev_xmit,
475         .ndo_change_rx_flags = hsr_change_rx_flags,
476         .ndo_fix_features = hsr_fix_features,
477         .ndo_set_rx_mode = hsr_set_rx_mode,
478 };
479
480 static struct device_type hsr_type = {
481         .name = "hsr",
482 };
483
484 static struct hsr_proto_ops hsr_ops = {
485         .send_sv_frame = send_hsr_supervision_frame,
486         .create_tagged_frame = hsr_create_tagged_frame,
487         .get_untagged_frame = hsr_get_untagged_frame,
488         .drop_frame = hsr_drop_frame,
489         .fill_frame_info = hsr_fill_frame_info,
490         .invalid_dan_ingress_frame = hsr_invalid_dan_ingress_frame,
491 };
492
493 static struct hsr_proto_ops prp_ops = {
494         .send_sv_frame = send_prp_supervision_frame,
495         .create_tagged_frame = prp_create_tagged_frame,
496         .get_untagged_frame = prp_get_untagged_frame,
497         .drop_frame = prp_drop_frame,
498         .fill_frame_info = prp_fill_frame_info,
499         .handle_san_frame = prp_handle_san_frame,
500         .update_san_info = prp_update_san_info,
501 };
502
503 void hsr_dev_setup(struct net_device *dev)
504 {
505         eth_hw_addr_random(dev);
506
507         ether_setup(dev);
508         dev->min_mtu = 0;
509         dev->header_ops = &hsr_header_ops;
510         dev->netdev_ops = &hsr_device_ops;
511         SET_NETDEV_DEVTYPE(dev, &hsr_type);
512         dev->priv_flags |= IFF_NO_QUEUE | IFF_DISABLE_NETPOLL;
513
514         dev->needs_free_netdev = true;
515
516         dev->hw_features = NETIF_F_SG | NETIF_F_FRAGLIST | NETIF_F_HIGHDMA |
517                            NETIF_F_GSO_MASK | NETIF_F_HW_CSUM |
518                            NETIF_F_HW_VLAN_CTAG_TX;
519
520         dev->features = dev->hw_features;
521
522         /* Prevent recursive tx locking */
523         dev->features |= NETIF_F_LLTX;
524         /* VLAN on top of HSR needs testing and probably some work on
525          * hsr_header_create() etc.
526          */
527         dev->features |= NETIF_F_VLAN_CHALLENGED;
528         /* Not sure about this. Taken from bridge code. netdev_features.h says
529          * it means "Does not change network namespaces".
530          */
531         dev->features |= NETIF_F_NETNS_LOCAL;
532 }
533
534 /* Return true if dev is a HSR master; return false otherwise.
535  */
536 bool is_hsr_master(struct net_device *dev)
537 {
538         return (dev->netdev_ops->ndo_start_xmit == hsr_dev_xmit);
539 }
540 EXPORT_SYMBOL(is_hsr_master);
541
542 /* Default multicast address for HSR Supervision frames */
543 static const unsigned char def_multicast_addr[ETH_ALEN] __aligned(2) = {
544         0x01, 0x15, 0x4e, 0x00, 0x01, 0x00
545 };
546
547 int hsr_dev_finalize(struct net_device *hsr_dev, struct net_device *slave[2],
548                      unsigned char multicast_spec, u8 protocol_version,
549                      struct netlink_ext_ack *extack)
550 {
551         bool unregister = false;
552         struct hsr_priv *hsr;
553         int res;
554
555         hsr = netdev_priv(hsr_dev);
556         INIT_LIST_HEAD(&hsr->ports);
557         INIT_LIST_HEAD(&hsr->node_db);
558         spin_lock_init(&hsr->list_lock);
559
560         eth_hw_addr_set(hsr_dev, slave[0]->dev_addr);
561
562         /* initialize protocol specific functions */
563         if (protocol_version == PRP_V1) {
564                 /* For PRP, lan_id has most significant 3 bits holding
565                  * the net_id of PRP_LAN_ID
566                  */
567                 hsr->net_id = PRP_LAN_ID << 1;
568                 hsr->proto_ops = &prp_ops;
569         } else {
570                 hsr->proto_ops = &hsr_ops;
571         }
572
573         /* Make sure we recognize frames from ourselves in hsr_rcv() */
574         res = hsr_create_self_node(hsr, hsr_dev->dev_addr,
575                                    slave[1]->dev_addr);
576         if (res < 0)
577                 return res;
578
579         spin_lock_init(&hsr->seqnr_lock);
580         /* Overflow soon to find bugs easier: */
581         hsr->sequence_nr = HSR_SEQNR_START;
582         hsr->sup_sequence_nr = HSR_SUP_SEQNR_START;
583
584         timer_setup(&hsr->announce_timer, hsr_announce, 0);
585         timer_setup(&hsr->prune_timer, hsr_prune_nodes, 0);
586
587         ether_addr_copy(hsr->sup_multicast_addr, def_multicast_addr);
588         hsr->sup_multicast_addr[ETH_ALEN - 1] = multicast_spec;
589
590         hsr->prot_version = protocol_version;
591
592         /* Make sure the 1st call to netif_carrier_on() gets through */
593         netif_carrier_off(hsr_dev);
594
595         res = hsr_add_port(hsr, hsr_dev, HSR_PT_MASTER, extack);
596         if (res)
597                 goto err_add_master;
598
599         /* HSR forwarding offload supported in lower device? */
600         if ((slave[0]->features & NETIF_F_HW_HSR_FWD) &&
601             (slave[1]->features & NETIF_F_HW_HSR_FWD))
602                 hsr->fwd_offloaded = true;
603
604         res = register_netdevice(hsr_dev);
605         if (res)
606                 goto err_unregister;
607
608         unregister = true;
609
610         res = hsr_add_port(hsr, slave[0], HSR_PT_SLAVE_A, extack);
611         if (res)
612                 goto err_unregister;
613
614         res = hsr_add_port(hsr, slave[1], HSR_PT_SLAVE_B, extack);
615         if (res)
616                 goto err_unregister;
617
618         hsr_debugfs_init(hsr, hsr_dev);
619         mod_timer(&hsr->prune_timer, jiffies + msecs_to_jiffies(PRUNE_PERIOD));
620
621         return 0;
622
623 err_unregister:
624         hsr_del_ports(hsr);
625 err_add_master:
626         hsr_del_self_node(hsr);
627
628         if (unregister)
629                 unregister_netdevice(hsr_dev);
630         return res;
631 }