Loading...
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
21static bool is_admin_up(struct net_device *dev)
22{
23 return dev && (dev->flags & IFF_UP);
24}
25
26static bool is_slave_up(struct net_device *dev)
27{
28 return dev && is_admin_up(dev) && netif_oper_up(dev);
29}
30
31static void __hsr_set_operstate(struct net_device *dev, int transition)
32{
33 write_lock_bh(&dev_base_lock);
34 if (dev->operstate != transition) {
35 dev->operstate = transition;
36 write_unlock_bh(&dev_base_lock);
37 netdev_state_change(dev);
38 } else {
39 write_unlock_bh(&dev_base_lock);
40 }
41}
42
43static 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
56static 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
74static 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
93void 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
109int 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
124static 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
141static 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
174static int hsr_dev_close(struct net_device *dev)
175{
176 /* Nothing to do here. */
177 return 0;
178}
179
180static netdev_features_t hsr_features_recompute(struct hsr_priv *hsr,
181 netdev_features_t features)
182{
183 netdev_features_t mask;
184 struct hsr_port *port;
185
186 mask = features;
187
188 /* Mask out all features that, if supported by one device, should be
189 * enabled for all devices (see NETIF_F_ONE_FOR_ALL).
190 *
191 * Anything that's off in mask will not be enabled - so only things
192 * that were in features originally, and also is in NETIF_F_ONE_FOR_ALL,
193 * may become enabled.
194 */
195 features &= ~NETIF_F_ONE_FOR_ALL;
196 hsr_for_each_port(hsr, port)
197 features = netdev_increment_features(features,
198 port->dev->features,
199 mask);
200
201 return features;
202}
203
204static netdev_features_t hsr_fix_features(struct net_device *dev,
205 netdev_features_t features)
206{
207 struct hsr_priv *hsr = netdev_priv(dev);
208
209 return hsr_features_recompute(hsr, features);
210}
211
212static netdev_tx_t hsr_dev_xmit(struct sk_buff *skb, struct net_device *dev)
213{
214 struct hsr_priv *hsr = netdev_priv(dev);
215 struct hsr_port *master;
216
217 master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
218 if (master) {
219 skb->dev = master->dev;
220 skb_reset_mac_header(skb);
221 skb_reset_mac_len(skb);
222 hsr_forward_skb(skb, master);
223 } else {
224 atomic_long_inc(&dev->tx_dropped);
225 dev_kfree_skb_any(skb);
226 }
227 return NETDEV_TX_OK;
228}
229
230static const struct header_ops hsr_header_ops = {
231 .create = eth_header,
232 .parse = eth_header_parse,
233};
234
235static struct sk_buff *hsr_init_skb(struct hsr_port *master)
236{
237 struct hsr_priv *hsr = master->hsr;
238 struct sk_buff *skb;
239 int hlen, tlen;
240
241 hlen = LL_RESERVED_SPACE(master->dev);
242 tlen = master->dev->needed_tailroom;
243 /* skb size is same for PRP/HSR frames, only difference
244 * being, for PRP it is a trailer and for HSR it is a
245 * header
246 */
247 skb = dev_alloc_skb(sizeof(struct hsr_sup_tag) +
248 sizeof(struct hsr_sup_payload) + hlen + tlen);
249
250 if (!skb)
251 return skb;
252
253 skb_reserve(skb, hlen);
254 skb->dev = master->dev;
255 skb->priority = TC_PRIO_CONTROL;
256
257 if (dev_hard_header(skb, skb->dev, ETH_P_PRP,
258 hsr->sup_multicast_addr,
259 skb->dev->dev_addr, skb->len) <= 0)
260 goto out;
261
262 skb_reset_mac_header(skb);
263 skb_reset_mac_len(skb);
264 skb_reset_network_header(skb);
265 skb_reset_transport_header(skb);
266
267 return skb;
268out:
269 kfree_skb(skb);
270
271 return NULL;
272}
273
274static void send_hsr_supervision_frame(struct hsr_port *master,
275 unsigned long *interval)
276{
277 struct hsr_priv *hsr = master->hsr;
278 __u8 type = HSR_TLV_LIFE_CHECK;
279 struct hsr_sup_payload *hsr_sp;
280 struct hsr_sup_tag *hsr_stag;
281 unsigned long irqflags;
282 struct sk_buff *skb;
283
284 *interval = msecs_to_jiffies(HSR_LIFE_CHECK_INTERVAL);
285 if (hsr->announce_count < 3 && hsr->prot_version == 0) {
286 type = HSR_TLV_ANNOUNCE;
287 *interval = msecs_to_jiffies(HSR_ANNOUNCE_INTERVAL);
288 hsr->announce_count++;
289 }
290
291 skb = hsr_init_skb(master);
292 if (!skb) {
293 WARN_ONCE(1, "HSR: Could not send supervision frame\n");
294 return;
295 }
296
297 hsr_stag = skb_put(skb, sizeof(struct hsr_sup_tag));
298 set_hsr_stag_path(hsr_stag, (hsr->prot_version ? 0x0 : 0xf));
299 set_hsr_stag_HSR_ver(hsr_stag, hsr->prot_version);
300
301 /* From HSRv1 on we have separate supervision sequence numbers. */
302 spin_lock_irqsave(&master->hsr->seqnr_lock, irqflags);
303 if (hsr->prot_version > 0) {
304 hsr_stag->sequence_nr = htons(hsr->sup_sequence_nr);
305 hsr->sup_sequence_nr++;
306 } else {
307 hsr_stag->sequence_nr = htons(hsr->sequence_nr);
308 hsr->sequence_nr++;
309 }
310 spin_unlock_irqrestore(&master->hsr->seqnr_lock, irqflags);
311
312 hsr_stag->HSR_TLV_type = type;
313 /* TODO: Why 12 in HSRv0? */
314 hsr_stag->HSR_TLV_length = hsr->prot_version ?
315 sizeof(struct hsr_sup_payload) : 12;
316
317 /* Payload: MacAddressA */
318 hsr_sp = skb_put(skb, sizeof(struct hsr_sup_payload));
319 ether_addr_copy(hsr_sp->macaddress_A, master->dev->dev_addr);
320
321 if (skb_put_padto(skb, ETH_ZLEN))
322 return;
323
324 hsr_forward_skb(skb, master);
325
326 return;
327}
328
329static void send_prp_supervision_frame(struct hsr_port *master,
330 unsigned long *interval)
331{
332 struct hsr_priv *hsr = master->hsr;
333 struct hsr_sup_payload *hsr_sp;
334 struct hsr_sup_tag *hsr_stag;
335 unsigned long irqflags;
336 struct sk_buff *skb;
337
338 skb = hsr_init_skb(master);
339 if (!skb) {
340 WARN_ONCE(1, "PRP: Could not send supervision frame\n");
341 return;
342 }
343
344 *interval = msecs_to_jiffies(HSR_LIFE_CHECK_INTERVAL);
345 hsr_stag = skb_put(skb, sizeof(struct hsr_sup_tag));
346 set_hsr_stag_path(hsr_stag, (hsr->prot_version ? 0x0 : 0xf));
347 set_hsr_stag_HSR_ver(hsr_stag, (hsr->prot_version ? 1 : 0));
348
349 /* From HSRv1 on we have separate supervision sequence numbers. */
350 spin_lock_irqsave(&master->hsr->seqnr_lock, irqflags);
351 hsr_stag->sequence_nr = htons(hsr->sup_sequence_nr);
352 hsr->sup_sequence_nr++;
353 hsr_stag->HSR_TLV_type = PRP_TLV_LIFE_CHECK_DD;
354 hsr_stag->HSR_TLV_length = sizeof(struct hsr_sup_payload);
355
356 /* Payload: MacAddressA */
357 hsr_sp = skb_put(skb, sizeof(struct hsr_sup_payload));
358 ether_addr_copy(hsr_sp->macaddress_A, master->dev->dev_addr);
359
360 if (skb_put_padto(skb, ETH_ZLEN)) {
361 spin_unlock_irqrestore(&master->hsr->seqnr_lock, irqflags);
362 return;
363 }
364
365 spin_unlock_irqrestore(&master->hsr->seqnr_lock, irqflags);
366
367 hsr_forward_skb(skb, master);
368}
369
370/* Announce (supervision frame) timer function
371 */
372static void hsr_announce(struct timer_list *t)
373{
374 struct hsr_priv *hsr;
375 struct hsr_port *master;
376 unsigned long interval;
377
378 hsr = from_timer(hsr, t, announce_timer);
379
380 rcu_read_lock();
381 master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
382 hsr->proto_ops->send_sv_frame(master, &interval);
383
384 if (is_admin_up(master->dev))
385 mod_timer(&hsr->announce_timer, jiffies + interval);
386
387 rcu_read_unlock();
388}
389
390void hsr_del_ports(struct hsr_priv *hsr)
391{
392 struct hsr_port *port;
393
394 port = hsr_port_get_hsr(hsr, HSR_PT_SLAVE_A);
395 if (port)
396 hsr_del_port(port);
397
398 port = hsr_port_get_hsr(hsr, HSR_PT_SLAVE_B);
399 if (port)
400 hsr_del_port(port);
401
402 port = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
403 if (port)
404 hsr_del_port(port);
405}
406
407static const struct net_device_ops hsr_device_ops = {
408 .ndo_change_mtu = hsr_dev_change_mtu,
409 .ndo_open = hsr_dev_open,
410 .ndo_stop = hsr_dev_close,
411 .ndo_start_xmit = hsr_dev_xmit,
412 .ndo_fix_features = hsr_fix_features,
413};
414
415static struct device_type hsr_type = {
416 .name = "hsr",
417};
418
419static struct hsr_proto_ops hsr_ops = {
420 .send_sv_frame = send_hsr_supervision_frame,
421 .create_tagged_frame = hsr_create_tagged_frame,
422 .get_untagged_frame = hsr_get_untagged_frame,
423 .drop_frame = hsr_drop_frame,
424 .fill_frame_info = hsr_fill_frame_info,
425 .invalid_dan_ingress_frame = hsr_invalid_dan_ingress_frame,
426};
427
428static struct hsr_proto_ops prp_ops = {
429 .send_sv_frame = send_prp_supervision_frame,
430 .create_tagged_frame = prp_create_tagged_frame,
431 .get_untagged_frame = prp_get_untagged_frame,
432 .drop_frame = prp_drop_frame,
433 .fill_frame_info = prp_fill_frame_info,
434 .handle_san_frame = prp_handle_san_frame,
435 .update_san_info = prp_update_san_info,
436};
437
438void hsr_dev_setup(struct net_device *dev)
439{
440 eth_hw_addr_random(dev);
441
442 ether_setup(dev);
443 dev->min_mtu = 0;
444 dev->header_ops = &hsr_header_ops;
445 dev->netdev_ops = &hsr_device_ops;
446 SET_NETDEV_DEVTYPE(dev, &hsr_type);
447 dev->priv_flags |= IFF_NO_QUEUE;
448
449 dev->needs_free_netdev = true;
450
451 dev->hw_features = NETIF_F_SG | NETIF_F_FRAGLIST | NETIF_F_HIGHDMA |
452 NETIF_F_GSO_MASK | NETIF_F_HW_CSUM |
453 NETIF_F_HW_VLAN_CTAG_TX;
454
455 dev->features = dev->hw_features;
456
457 /* Prevent recursive tx locking */
458 dev->features |= NETIF_F_LLTX;
459 /* VLAN on top of HSR needs testing and probably some work on
460 * hsr_header_create() etc.
461 */
462 dev->features |= NETIF_F_VLAN_CHALLENGED;
463 /* Not sure about this. Taken from bridge code. netdev_features.h says
464 * it means "Does not change network namespaces".
465 */
466 dev->features |= NETIF_F_NETNS_LOCAL;
467}
468
469/* Return true if dev is a HSR master; return false otherwise.
470 */
471bool is_hsr_master(struct net_device *dev)
472{
473 return (dev->netdev_ops->ndo_start_xmit == hsr_dev_xmit);
474}
475EXPORT_SYMBOL(is_hsr_master);
476
477/* Default multicast address for HSR Supervision frames */
478static const unsigned char def_multicast_addr[ETH_ALEN] __aligned(2) = {
479 0x01, 0x15, 0x4e, 0x00, 0x01, 0x00
480};
481
482int hsr_dev_finalize(struct net_device *hsr_dev, struct net_device *slave[2],
483 unsigned char multicast_spec, u8 protocol_version,
484 struct netlink_ext_ack *extack)
485{
486 bool unregister = false;
487 struct hsr_priv *hsr;
488 int res;
489
490 hsr = netdev_priv(hsr_dev);
491 INIT_LIST_HEAD(&hsr->ports);
492 INIT_LIST_HEAD(&hsr->node_db);
493 INIT_LIST_HEAD(&hsr->self_node_db);
494 spin_lock_init(&hsr->list_lock);
495
496 ether_addr_copy(hsr_dev->dev_addr, slave[0]->dev_addr);
497
498 /* initialize protocol specific functions */
499 if (protocol_version == PRP_V1) {
500 /* For PRP, lan_id has most significant 3 bits holding
501 * the net_id of PRP_LAN_ID
502 */
503 hsr->net_id = PRP_LAN_ID << 1;
504 hsr->proto_ops = &prp_ops;
505 } else {
506 hsr->proto_ops = &hsr_ops;
507 }
508
509 /* Make sure we recognize frames from ourselves in hsr_rcv() */
510 res = hsr_create_self_node(hsr, hsr_dev->dev_addr,
511 slave[1]->dev_addr);
512 if (res < 0)
513 return res;
514
515 spin_lock_init(&hsr->seqnr_lock);
516 /* Overflow soon to find bugs easier: */
517 hsr->sequence_nr = HSR_SEQNR_START;
518 hsr->sup_sequence_nr = HSR_SUP_SEQNR_START;
519
520 timer_setup(&hsr->announce_timer, hsr_announce, 0);
521 timer_setup(&hsr->prune_timer, hsr_prune_nodes, 0);
522
523 ether_addr_copy(hsr->sup_multicast_addr, def_multicast_addr);
524 hsr->sup_multicast_addr[ETH_ALEN - 1] = multicast_spec;
525
526 hsr->prot_version = protocol_version;
527
528 /* Make sure the 1st call to netif_carrier_on() gets through */
529 netif_carrier_off(hsr_dev);
530
531 res = hsr_add_port(hsr, hsr_dev, HSR_PT_MASTER, extack);
532 if (res)
533 goto err_add_master;
534
535 res = register_netdevice(hsr_dev);
536 if (res)
537 goto err_unregister;
538
539 unregister = true;
540
541 res = hsr_add_port(hsr, slave[0], HSR_PT_SLAVE_A, extack);
542 if (res)
543 goto err_unregister;
544
545 res = hsr_add_port(hsr, slave[1], HSR_PT_SLAVE_B, extack);
546 if (res)
547 goto err_unregister;
548
549 hsr_debugfs_init(hsr, hsr_dev);
550 mod_timer(&hsr->prune_timer, jiffies + msecs_to_jiffies(PRUNE_PERIOD));
551
552 return 0;
553
554err_unregister:
555 hsr_del_ports(hsr);
556err_add_master:
557 hsr_del_self_node(hsr);
558
559 if (unregister)
560 unregister_netdevice(hsr_dev);
561 return res;
562}
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
21static bool is_admin_up(struct net_device *dev)
22{
23 return dev && (dev->flags & IFF_UP);
24}
25
26static bool is_slave_up(struct net_device *dev)
27{
28 return dev && is_admin_up(dev) && netif_oper_up(dev);
29}
30
31static void hsr_set_operstate(struct hsr_port *master, bool has_carrier)
32{
33 struct net_device *dev = master->dev;
34
35 if (!is_admin_up(dev)) {
36 netdev_set_operstate(dev, IF_OPER_DOWN);
37 return;
38 }
39
40 if (has_carrier)
41 netdev_set_operstate(dev, IF_OPER_UP);
42 else
43 netdev_set_operstate(dev, IF_OPER_LOWERLAYERDOWN);
44}
45
46static bool hsr_check_carrier(struct hsr_port *master)
47{
48 struct hsr_port *port;
49
50 ASSERT_RTNL();
51
52 hsr_for_each_port(master->hsr, port) {
53 if (port->type != HSR_PT_MASTER && is_slave_up(port->dev)) {
54 netif_carrier_on(master->dev);
55 return true;
56 }
57 }
58
59 netif_carrier_off(master->dev);
60
61 return false;
62}
63
64static void hsr_check_announce(struct net_device *hsr_dev)
65{
66 struct hsr_priv *hsr;
67
68 hsr = netdev_priv(hsr_dev);
69 if (netif_running(hsr_dev) && netif_oper_up(hsr_dev)) {
70 /* Enable announce timer and start sending supervisory frames */
71 if (!timer_pending(&hsr->announce_timer)) {
72 hsr->announce_count = 0;
73 mod_timer(&hsr->announce_timer, jiffies +
74 msecs_to_jiffies(HSR_ANNOUNCE_INTERVAL));
75 }
76
77 if (hsr->redbox && !timer_pending(&hsr->announce_proxy_timer))
78 mod_timer(&hsr->announce_proxy_timer, jiffies +
79 msecs_to_jiffies(HSR_ANNOUNCE_INTERVAL) / 2);
80 } else {
81 /* Deactivate the announce timer */
82 timer_delete(&hsr->announce_timer);
83 if (hsr->redbox)
84 timer_delete(&hsr->announce_proxy_timer);
85 }
86}
87
88void hsr_check_carrier_and_operstate(struct hsr_priv *hsr)
89{
90 struct hsr_port *master;
91 bool has_carrier;
92
93 master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
94 /* netif_stacked_transfer_operstate() cannot be used here since
95 * it doesn't set IF_OPER_LOWERLAYERDOWN (?)
96 */
97 has_carrier = hsr_check_carrier(master);
98 hsr_set_operstate(master, has_carrier);
99 hsr_check_announce(master->dev);
100}
101
102int hsr_get_max_mtu(struct hsr_priv *hsr)
103{
104 unsigned int mtu_max;
105 struct hsr_port *port;
106
107 mtu_max = ETH_DATA_LEN;
108 hsr_for_each_port(hsr, port)
109 if (port->type != HSR_PT_MASTER)
110 mtu_max = min(port->dev->mtu, mtu_max);
111
112 if (mtu_max < HSR_HLEN)
113 return 0;
114 return mtu_max - HSR_HLEN;
115}
116
117static int hsr_dev_change_mtu(struct net_device *dev, int new_mtu)
118{
119 struct hsr_priv *hsr;
120
121 hsr = netdev_priv(dev);
122
123 if (new_mtu > hsr_get_max_mtu(hsr)) {
124 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",
125 HSR_HLEN);
126 return -EINVAL;
127 }
128
129 WRITE_ONCE(dev->mtu, new_mtu);
130
131 return 0;
132}
133
134static int hsr_dev_open(struct net_device *dev)
135{
136 struct hsr_priv *hsr;
137 struct hsr_port *port;
138 const char *designation = NULL;
139
140 hsr = netdev_priv(dev);
141
142 hsr_for_each_port(hsr, port) {
143 if (port->type == HSR_PT_MASTER)
144 continue;
145 switch (port->type) {
146 case HSR_PT_SLAVE_A:
147 designation = "Slave A";
148 break;
149 case HSR_PT_SLAVE_B:
150 designation = "Slave B";
151 break;
152 case HSR_PT_INTERLINK:
153 designation = "Interlink";
154 break;
155 default:
156 designation = "Unknown";
157 }
158 if (!is_slave_up(port->dev))
159 netdev_warn(dev, "%s (%s) is not up; please bring it up to get a fully working HSR network\n",
160 designation, port->dev->name);
161 }
162
163 if (!designation)
164 netdev_warn(dev, "No slave devices configured\n");
165
166 return 0;
167}
168
169static int hsr_dev_close(struct net_device *dev)
170{
171 struct hsr_port *port;
172 struct hsr_priv *hsr;
173
174 hsr = netdev_priv(dev);
175 hsr_for_each_port(hsr, port) {
176 if (port->type == HSR_PT_MASTER)
177 continue;
178 switch (port->type) {
179 case HSR_PT_SLAVE_A:
180 case HSR_PT_SLAVE_B:
181 dev_uc_unsync(port->dev, dev);
182 dev_mc_unsync(port->dev, dev);
183 break;
184 default:
185 break;
186 }
187 }
188
189 return 0;
190}
191
192static netdev_features_t hsr_features_recompute(struct hsr_priv *hsr,
193 netdev_features_t features)
194{
195 netdev_features_t mask;
196 struct hsr_port *port;
197
198 mask = features;
199
200 /* Mask out all features that, if supported by one device, should be
201 * enabled for all devices (see NETIF_F_ONE_FOR_ALL).
202 *
203 * Anything that's off in mask will not be enabled - so only things
204 * that were in features originally, and also is in NETIF_F_ONE_FOR_ALL,
205 * may become enabled.
206 */
207 features &= ~NETIF_F_ONE_FOR_ALL;
208 hsr_for_each_port(hsr, port)
209 features = netdev_increment_features(features,
210 port->dev->features,
211 mask);
212
213 return features;
214}
215
216static netdev_features_t hsr_fix_features(struct net_device *dev,
217 netdev_features_t features)
218{
219 struct hsr_priv *hsr = netdev_priv(dev);
220
221 return hsr_features_recompute(hsr, features);
222}
223
224static netdev_tx_t hsr_dev_xmit(struct sk_buff *skb, struct net_device *dev)
225{
226 struct hsr_priv *hsr = netdev_priv(dev);
227 struct hsr_port *master;
228
229 master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
230 if (master) {
231 skb->dev = master->dev;
232 skb_reset_mac_header(skb);
233 skb_reset_mac_len(skb);
234 spin_lock_bh(&hsr->seqnr_lock);
235 hsr_forward_skb(skb, master);
236 spin_unlock_bh(&hsr->seqnr_lock);
237 } else {
238 dev_core_stats_tx_dropped_inc(dev);
239 dev_kfree_skb_any(skb);
240 }
241 return NETDEV_TX_OK;
242}
243
244static const struct header_ops hsr_header_ops = {
245 .create = eth_header,
246 .parse = eth_header_parse,
247};
248
249static struct sk_buff *hsr_init_skb(struct hsr_port *master, int extra)
250{
251 struct hsr_priv *hsr = master->hsr;
252 struct sk_buff *skb;
253 int hlen, tlen;
254 int len;
255
256 hlen = LL_RESERVED_SPACE(master->dev);
257 tlen = master->dev->needed_tailroom;
258 len = sizeof(struct hsr_sup_tag) + sizeof(struct hsr_sup_payload);
259 /* skb size is same for PRP/HSR frames, only difference
260 * being, for PRP it is a trailer and for HSR it is a
261 * header.
262 * RedBox might use @extra more bytes.
263 */
264 skb = dev_alloc_skb(len + extra + hlen + tlen);
265
266 if (!skb)
267 return skb;
268
269 skb_reserve(skb, hlen);
270 skb->dev = master->dev;
271 skb->priority = TC_PRIO_CONTROL;
272
273 skb_reset_network_header(skb);
274 skb_reset_transport_header(skb);
275 if (dev_hard_header(skb, skb->dev, ETH_P_PRP,
276 hsr->sup_multicast_addr,
277 skb->dev->dev_addr, skb->len) <= 0)
278 goto out;
279
280 skb_reset_mac_header(skb);
281 skb_reset_mac_len(skb);
282
283 return skb;
284out:
285 kfree_skb(skb);
286
287 return NULL;
288}
289
290static void send_hsr_supervision_frame(struct hsr_port *port,
291 unsigned long *interval,
292 const unsigned char *addr)
293{
294 struct hsr_priv *hsr = port->hsr;
295 __u8 type = HSR_TLV_LIFE_CHECK;
296 struct hsr_sup_payload *hsr_sp;
297 struct hsr_sup_tlv *hsr_stlv;
298 struct hsr_sup_tag *hsr_stag;
299 struct sk_buff *skb;
300 int extra = 0;
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 if (hsr->redbox)
310 extra = sizeof(struct hsr_sup_tlv) +
311 sizeof(struct hsr_sup_payload);
312
313 skb = hsr_init_skb(port, extra);
314 if (!skb) {
315 netdev_warn_once(port->dev, "HSR: Could not send supervision frame\n");
316 return;
317 }
318
319 hsr_stag = skb_put(skb, sizeof(struct hsr_sup_tag));
320 set_hsr_stag_path(hsr_stag, (hsr->prot_version ? 0x0 : 0xf));
321 set_hsr_stag_HSR_ver(hsr_stag, hsr->prot_version);
322
323 /* From HSRv1 on we have separate supervision sequence numbers. */
324 spin_lock_bh(&hsr->seqnr_lock);
325 if (hsr->prot_version > 0) {
326 hsr_stag->sequence_nr = htons(hsr->sup_sequence_nr);
327 hsr->sup_sequence_nr++;
328 } else {
329 hsr_stag->sequence_nr = htons(hsr->sequence_nr);
330 hsr->sequence_nr++;
331 }
332
333 hsr_stag->tlv.HSR_TLV_type = type;
334 /* TODO: Why 12 in HSRv0? */
335 hsr_stag->tlv.HSR_TLV_length = hsr->prot_version ?
336 sizeof(struct hsr_sup_payload) : 12;
337
338 /* Payload: MacAddressA / SAN MAC from ProxyNodeTable */
339 hsr_sp = skb_put(skb, sizeof(struct hsr_sup_payload));
340 ether_addr_copy(hsr_sp->macaddress_A, addr);
341
342 if (hsr->redbox &&
343 hsr_is_node_in_db(&hsr->proxy_node_db, addr)) {
344 hsr_stlv = skb_put(skb, sizeof(struct hsr_sup_tlv));
345 hsr_stlv->HSR_TLV_type = PRP_TLV_REDBOX_MAC;
346 hsr_stlv->HSR_TLV_length = sizeof(struct hsr_sup_payload);
347
348 /* Payload: MacAddressRedBox */
349 hsr_sp = skb_put(skb, sizeof(struct hsr_sup_payload));
350 ether_addr_copy(hsr_sp->macaddress_A, hsr->macaddress_redbox);
351 }
352
353 if (skb_put_padto(skb, ETH_ZLEN)) {
354 spin_unlock_bh(&hsr->seqnr_lock);
355 return;
356 }
357
358 hsr_forward_skb(skb, port);
359 spin_unlock_bh(&hsr->seqnr_lock);
360 return;
361}
362
363static void send_prp_supervision_frame(struct hsr_port *master,
364 unsigned long *interval,
365 const unsigned char *addr)
366{
367 struct hsr_priv *hsr = master->hsr;
368 struct hsr_sup_payload *hsr_sp;
369 struct hsr_sup_tag *hsr_stag;
370 struct sk_buff *skb;
371
372 skb = hsr_init_skb(master, 0);
373 if (!skb) {
374 netdev_warn_once(master->dev, "PRP: Could not send supervision frame\n");
375 return;
376 }
377
378 *interval = msecs_to_jiffies(HSR_LIFE_CHECK_INTERVAL);
379 hsr_stag = skb_put(skb, sizeof(struct hsr_sup_tag));
380 set_hsr_stag_path(hsr_stag, (hsr->prot_version ? 0x0 : 0xf));
381 set_hsr_stag_HSR_ver(hsr_stag, (hsr->prot_version ? 1 : 0));
382
383 /* From HSRv1 on we have separate supervision sequence numbers. */
384 spin_lock_bh(&hsr->seqnr_lock);
385 hsr_stag->sequence_nr = htons(hsr->sup_sequence_nr);
386 hsr->sup_sequence_nr++;
387 hsr_stag->tlv.HSR_TLV_type = PRP_TLV_LIFE_CHECK_DD;
388 hsr_stag->tlv.HSR_TLV_length = sizeof(struct hsr_sup_payload);
389
390 /* Payload: MacAddressA */
391 hsr_sp = skb_put(skb, sizeof(struct hsr_sup_payload));
392 ether_addr_copy(hsr_sp->macaddress_A, master->dev->dev_addr);
393
394 if (skb_put_padto(skb, ETH_ZLEN)) {
395 spin_unlock_bh(&hsr->seqnr_lock);
396 return;
397 }
398
399 hsr_forward_skb(skb, master);
400 spin_unlock_bh(&hsr->seqnr_lock);
401}
402
403/* Announce (supervision frame) timer function
404 */
405static void hsr_announce(struct timer_list *t)
406{
407 struct hsr_priv *hsr;
408 struct hsr_port *master;
409 unsigned long interval;
410
411 hsr = from_timer(hsr, t, announce_timer);
412
413 rcu_read_lock();
414 master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
415 hsr->proto_ops->send_sv_frame(master, &interval, master->dev->dev_addr);
416
417 if (is_admin_up(master->dev))
418 mod_timer(&hsr->announce_timer, jiffies + interval);
419
420 rcu_read_unlock();
421}
422
423/* Announce (supervision frame) timer function for RedBox
424 */
425static void hsr_proxy_announce(struct timer_list *t)
426{
427 struct hsr_priv *hsr = from_timer(hsr, t, announce_proxy_timer);
428 struct hsr_port *interlink;
429 unsigned long interval = 0;
430 struct hsr_node *node;
431
432 rcu_read_lock();
433 /* RedBOX sends supervisory frames to HSR network with MAC addresses
434 * of SAN nodes stored in ProxyNodeTable.
435 */
436 interlink = hsr_port_get_hsr(hsr, HSR_PT_INTERLINK);
437 if (!interlink)
438 goto done;
439
440 list_for_each_entry_rcu(node, &hsr->proxy_node_db, mac_list) {
441 if (hsr_addr_is_redbox(hsr, node->macaddress_A))
442 continue;
443 hsr->proto_ops->send_sv_frame(interlink, &interval,
444 node->macaddress_A);
445 }
446
447 if (is_admin_up(interlink->dev)) {
448 if (!interval)
449 interval = msecs_to_jiffies(HSR_ANNOUNCE_INTERVAL);
450
451 mod_timer(&hsr->announce_proxy_timer, jiffies + interval);
452 }
453
454done:
455 rcu_read_unlock();
456}
457
458void hsr_del_ports(struct hsr_priv *hsr)
459{
460 struct hsr_port *port;
461
462 port = hsr_port_get_hsr(hsr, HSR_PT_SLAVE_A);
463 if (port)
464 hsr_del_port(port);
465
466 port = hsr_port_get_hsr(hsr, HSR_PT_SLAVE_B);
467 if (port)
468 hsr_del_port(port);
469
470 port = hsr_port_get_hsr(hsr, HSR_PT_INTERLINK);
471 if (port)
472 hsr_del_port(port);
473
474 port = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
475 if (port)
476 hsr_del_port(port);
477}
478
479static void hsr_set_rx_mode(struct net_device *dev)
480{
481 struct hsr_port *port;
482 struct hsr_priv *hsr;
483
484 hsr = netdev_priv(dev);
485
486 hsr_for_each_port(hsr, port) {
487 if (port->type == HSR_PT_MASTER)
488 continue;
489 switch (port->type) {
490 case HSR_PT_SLAVE_A:
491 case HSR_PT_SLAVE_B:
492 dev_mc_sync_multiple(port->dev, dev);
493 dev_uc_sync_multiple(port->dev, dev);
494 break;
495 default:
496 break;
497 }
498 }
499}
500
501static void hsr_change_rx_flags(struct net_device *dev, int change)
502{
503 struct hsr_port *port;
504 struct hsr_priv *hsr;
505
506 hsr = netdev_priv(dev);
507
508 hsr_for_each_port(hsr, port) {
509 if (port->type == HSR_PT_MASTER)
510 continue;
511 switch (port->type) {
512 case HSR_PT_SLAVE_A:
513 case HSR_PT_SLAVE_B:
514 if (change & IFF_ALLMULTI)
515 dev_set_allmulti(port->dev,
516 dev->flags &
517 IFF_ALLMULTI ? 1 : -1);
518 break;
519 default:
520 break;
521 }
522 }
523}
524
525static int hsr_ndo_vlan_rx_add_vid(struct net_device *dev,
526 __be16 proto, u16 vid)
527{
528 bool is_slave_a_added = false;
529 bool is_slave_b_added = false;
530 struct hsr_port *port;
531 struct hsr_priv *hsr;
532 int ret = 0;
533
534 hsr = netdev_priv(dev);
535
536 hsr_for_each_port(hsr, port) {
537 if (port->type == HSR_PT_MASTER ||
538 port->type == HSR_PT_INTERLINK)
539 continue;
540
541 ret = vlan_vid_add(port->dev, proto, vid);
542 switch (port->type) {
543 case HSR_PT_SLAVE_A:
544 if (ret) {
545 /* clean up Slave-B */
546 netdev_err(dev, "add vid failed for Slave-A\n");
547 if (is_slave_b_added)
548 vlan_vid_del(port->dev, proto, vid);
549 return ret;
550 }
551
552 is_slave_a_added = true;
553 break;
554
555 case HSR_PT_SLAVE_B:
556 if (ret) {
557 /* clean up Slave-A */
558 netdev_err(dev, "add vid failed for Slave-B\n");
559 if (is_slave_a_added)
560 vlan_vid_del(port->dev, proto, vid);
561 return ret;
562 }
563
564 is_slave_b_added = true;
565 break;
566 default:
567 break;
568 }
569 }
570
571 return 0;
572}
573
574static int hsr_ndo_vlan_rx_kill_vid(struct net_device *dev,
575 __be16 proto, u16 vid)
576{
577 struct hsr_port *port;
578 struct hsr_priv *hsr;
579
580 hsr = netdev_priv(dev);
581
582 hsr_for_each_port(hsr, port) {
583 switch (port->type) {
584 case HSR_PT_SLAVE_A:
585 case HSR_PT_SLAVE_B:
586 vlan_vid_del(port->dev, proto, vid);
587 break;
588 default:
589 break;
590 }
591 }
592
593 return 0;
594}
595
596static const struct net_device_ops hsr_device_ops = {
597 .ndo_change_mtu = hsr_dev_change_mtu,
598 .ndo_open = hsr_dev_open,
599 .ndo_stop = hsr_dev_close,
600 .ndo_start_xmit = hsr_dev_xmit,
601 .ndo_change_rx_flags = hsr_change_rx_flags,
602 .ndo_fix_features = hsr_fix_features,
603 .ndo_set_rx_mode = hsr_set_rx_mode,
604 .ndo_vlan_rx_add_vid = hsr_ndo_vlan_rx_add_vid,
605 .ndo_vlan_rx_kill_vid = hsr_ndo_vlan_rx_kill_vid,
606};
607
608static const struct device_type hsr_type = {
609 .name = "hsr",
610};
611
612static struct hsr_proto_ops hsr_ops = {
613 .send_sv_frame = send_hsr_supervision_frame,
614 .create_tagged_frame = hsr_create_tagged_frame,
615 .get_untagged_frame = hsr_get_untagged_frame,
616 .drop_frame = hsr_drop_frame,
617 .fill_frame_info = hsr_fill_frame_info,
618 .invalid_dan_ingress_frame = hsr_invalid_dan_ingress_frame,
619};
620
621static struct hsr_proto_ops prp_ops = {
622 .send_sv_frame = send_prp_supervision_frame,
623 .create_tagged_frame = prp_create_tagged_frame,
624 .get_untagged_frame = prp_get_untagged_frame,
625 .drop_frame = prp_drop_frame,
626 .fill_frame_info = prp_fill_frame_info,
627 .handle_san_frame = prp_handle_san_frame,
628 .update_san_info = prp_update_san_info,
629};
630
631void hsr_dev_setup(struct net_device *dev)
632{
633 eth_hw_addr_random(dev);
634
635 ether_setup(dev);
636 dev->min_mtu = 0;
637 dev->header_ops = &hsr_header_ops;
638 dev->netdev_ops = &hsr_device_ops;
639 SET_NETDEV_DEVTYPE(dev, &hsr_type);
640 dev->priv_flags |= IFF_NO_QUEUE | IFF_DISABLE_NETPOLL;
641 /* Prevent recursive tx locking */
642 dev->lltx = true;
643 /* Not sure about this. Taken from bridge code. netdevice.h says
644 * it means "Does not change network namespaces".
645 */
646 dev->netns_local = true;
647
648 dev->needs_free_netdev = true;
649
650 dev->hw_features = NETIF_F_SG | NETIF_F_FRAGLIST | NETIF_F_HIGHDMA |
651 NETIF_F_GSO_MASK | NETIF_F_HW_CSUM |
652 NETIF_F_HW_VLAN_CTAG_TX |
653 NETIF_F_HW_VLAN_CTAG_FILTER;
654
655 dev->features = dev->hw_features;
656}
657
658/* Return true if dev is a HSR master; return false otherwise.
659 */
660bool is_hsr_master(struct net_device *dev)
661{
662 return (dev->netdev_ops->ndo_start_xmit == hsr_dev_xmit);
663}
664EXPORT_SYMBOL(is_hsr_master);
665
666/* Default multicast address for HSR Supervision frames */
667static const unsigned char def_multicast_addr[ETH_ALEN] __aligned(2) = {
668 0x01, 0x15, 0x4e, 0x00, 0x01, 0x00
669};
670
671int hsr_dev_finalize(struct net_device *hsr_dev, struct net_device *slave[2],
672 struct net_device *interlink, unsigned char multicast_spec,
673 u8 protocol_version, struct netlink_ext_ack *extack)
674{
675 bool unregister = false;
676 struct hsr_priv *hsr;
677 int res;
678
679 hsr = netdev_priv(hsr_dev);
680 INIT_LIST_HEAD(&hsr->ports);
681 INIT_LIST_HEAD(&hsr->node_db);
682 INIT_LIST_HEAD(&hsr->proxy_node_db);
683 spin_lock_init(&hsr->list_lock);
684
685 eth_hw_addr_set(hsr_dev, slave[0]->dev_addr);
686
687 /* initialize protocol specific functions */
688 if (protocol_version == PRP_V1) {
689 /* For PRP, lan_id has most significant 3 bits holding
690 * the net_id of PRP_LAN_ID
691 */
692 hsr->net_id = PRP_LAN_ID << 1;
693 hsr->proto_ops = &prp_ops;
694 } else {
695 hsr->proto_ops = &hsr_ops;
696 }
697
698 /* Make sure we recognize frames from ourselves in hsr_rcv() */
699 res = hsr_create_self_node(hsr, hsr_dev->dev_addr,
700 slave[1]->dev_addr);
701 if (res < 0)
702 return res;
703
704 spin_lock_init(&hsr->seqnr_lock);
705 /* Overflow soon to find bugs easier: */
706 hsr->sequence_nr = HSR_SEQNR_START;
707 hsr->sup_sequence_nr = HSR_SUP_SEQNR_START;
708
709 timer_setup(&hsr->announce_timer, hsr_announce, 0);
710 timer_setup(&hsr->prune_timer, hsr_prune_nodes, 0);
711 timer_setup(&hsr->prune_proxy_timer, hsr_prune_proxy_nodes, 0);
712 timer_setup(&hsr->announce_proxy_timer, hsr_proxy_announce, 0);
713
714 ether_addr_copy(hsr->sup_multicast_addr, def_multicast_addr);
715 hsr->sup_multicast_addr[ETH_ALEN - 1] = multicast_spec;
716
717 hsr->prot_version = protocol_version;
718
719 /* Make sure the 1st call to netif_carrier_on() gets through */
720 netif_carrier_off(hsr_dev);
721
722 res = hsr_add_port(hsr, hsr_dev, HSR_PT_MASTER, extack);
723 if (res)
724 goto err_add_master;
725
726 /* HSR forwarding offload supported in lower device? */
727 if ((slave[0]->features & NETIF_F_HW_HSR_FWD) &&
728 (slave[1]->features & NETIF_F_HW_HSR_FWD))
729 hsr->fwd_offloaded = true;
730
731 if ((slave[0]->features & NETIF_F_HW_VLAN_CTAG_FILTER) &&
732 (slave[1]->features & NETIF_F_HW_VLAN_CTAG_FILTER))
733 hsr_dev->features |= NETIF_F_HW_VLAN_CTAG_FILTER;
734
735 res = register_netdevice(hsr_dev);
736 if (res)
737 goto err_unregister;
738
739 unregister = true;
740
741 res = hsr_add_port(hsr, slave[0], HSR_PT_SLAVE_A, extack);
742 if (res)
743 goto err_unregister;
744
745 res = hsr_add_port(hsr, slave[1], HSR_PT_SLAVE_B, extack);
746 if (res)
747 goto err_unregister;
748
749 if (interlink) {
750 res = hsr_add_port(hsr, interlink, HSR_PT_INTERLINK, extack);
751 if (res)
752 goto err_unregister;
753
754 hsr->redbox = true;
755 ether_addr_copy(hsr->macaddress_redbox, interlink->dev_addr);
756 mod_timer(&hsr->prune_proxy_timer,
757 jiffies + msecs_to_jiffies(PRUNE_PROXY_PERIOD));
758 }
759
760 hsr_debugfs_init(hsr, hsr_dev);
761 mod_timer(&hsr->prune_timer, jiffies + msecs_to_jiffies(PRUNE_PERIOD));
762
763 return 0;
764
765err_unregister:
766 hsr_del_ports(hsr);
767err_add_master:
768 hsr_del_self_node(hsr);
769
770 if (unregister)
771 unregister_netdevice(hsr_dev);
772 return res;
773}