1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright 2011-2014 Autronica Fire and Security AS
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.
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"
19 #include "hsr_forward.h"
21 static bool is_admin_up(struct net_device *dev)
23 return dev && (dev->flags & IFF_UP);
26 static bool is_slave_up(struct net_device *dev)
28 return dev && is_admin_up(dev) && netif_oper_up(dev);
31 static void __hsr_set_operstate(struct net_device *dev, int transition)
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);
39 write_unlock(&dev_base_lock);
43 static void hsr_set_operstate(struct hsr_port *master, bool has_carrier)
45 if (!is_admin_up(master->dev)) {
46 __hsr_set_operstate(master->dev, IF_OPER_DOWN);
51 __hsr_set_operstate(master->dev, IF_OPER_UP);
53 __hsr_set_operstate(master->dev, IF_OPER_LOWERLAYERDOWN);
56 static bool hsr_check_carrier(struct hsr_port *master)
58 struct hsr_port *port;
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);
69 netif_carrier_off(master->dev);
74 static void hsr_check_announce(struct net_device *hsr_dev,
75 unsigned char old_operstate)
79 hsr = netdev_priv(hsr_dev);
81 if (hsr_dev->operstate == IF_OPER_UP && old_operstate != IF_OPER_UP) {
83 hsr->announce_count = 0;
84 mod_timer(&hsr->announce_timer,
85 jiffies + msecs_to_jiffies(HSR_ANNOUNCE_INTERVAL));
88 if (hsr_dev->operstate != IF_OPER_UP && old_operstate == IF_OPER_UP)
90 del_timer(&hsr->announce_timer);
93 void hsr_check_carrier_and_operstate(struct hsr_priv *hsr)
95 struct hsr_port *master;
96 unsigned char old_operstate;
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 (?)
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);
109 int hsr_get_max_mtu(struct hsr_priv *hsr)
111 unsigned int mtu_max;
112 struct hsr_port *port;
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);
119 if (mtu_max < HSR_HLEN)
121 return mtu_max - HSR_HLEN;
124 static int hsr_dev_change_mtu(struct net_device *dev, int new_mtu)
126 struct hsr_priv *hsr;
128 hsr = netdev_priv(dev);
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",
141 static int hsr_dev_open(struct net_device *dev)
143 struct hsr_priv *hsr;
144 struct hsr_port *port;
147 hsr = netdev_priv(dev);
150 hsr_for_each_port(hsr, port) {
151 if (port->type == HSR_PT_MASTER)
153 switch (port->type) {
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);
168 if (designation == '\0')
169 netdev_warn(dev, "No slave devices configured\n");
174 static int hsr_dev_close(struct net_device *dev)
176 struct hsr_port *port;
177 struct hsr_priv *hsr;
179 hsr = netdev_priv(dev);
180 hsr_for_each_port(hsr, port) {
181 if (port->type == HSR_PT_MASTER)
183 switch (port->type) {
186 dev_uc_unsync(port->dev, dev);
187 dev_mc_unsync(port->dev, dev);
197 static netdev_features_t hsr_features_recompute(struct hsr_priv *hsr,
198 netdev_features_t features)
200 netdev_features_t mask;
201 struct hsr_port *port;
205 /* Mask out all features that, if supported by one device, should be
206 * enabled for all devices (see NETIF_F_ONE_FOR_ALL).
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.
212 features &= ~NETIF_F_ONE_FOR_ALL;
213 hsr_for_each_port(hsr, port)
214 features = netdev_increment_features(features,
221 static netdev_features_t hsr_fix_features(struct net_device *dev,
222 netdev_features_t features)
224 struct hsr_priv *hsr = netdev_priv(dev);
226 return hsr_features_recompute(hsr, features);
229 static netdev_tx_t hsr_dev_xmit(struct sk_buff *skb, struct net_device *dev)
231 struct hsr_priv *hsr = netdev_priv(dev);
232 struct hsr_port *master;
234 master = hsr_port_get_hsr(hsr, HSR_PT_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);
243 dev_core_stats_tx_dropped_inc(dev);
244 dev_kfree_skb_any(skb);
249 static const struct header_ops hsr_header_ops = {
250 .create = eth_header,
251 .parse = eth_header_parse,
254 static struct sk_buff *hsr_init_skb(struct hsr_port *master)
256 struct hsr_priv *hsr = master->hsr;
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
266 skb = dev_alloc_skb(sizeof(struct hsr_sup_tag) +
267 sizeof(struct hsr_sup_payload) + hlen + tlen);
272 skb_reserve(skb, hlen);
273 skb->dev = master->dev;
274 skb->priority = TC_PRIO_CONTROL;
276 if (dev_hard_header(skb, skb->dev, ETH_P_PRP,
277 hsr->sup_multicast_addr,
278 skb->dev->dev_addr, skb->len) <= 0)
281 skb_reset_mac_header(skb);
282 skb_reset_mac_len(skb);
283 skb_reset_network_header(skb);
284 skb_reset_transport_header(skb);
293 static void send_hsr_supervision_frame(struct hsr_port *master,
294 unsigned long *interval)
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;
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++;
309 skb = hsr_init_skb(master);
311 netdev_warn_once(master->dev, "HSR: Could not send supervision frame\n");
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);
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++;
325 hsr_stag->sequence_nr = htons(hsr->sequence_nr);
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;
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);
338 if (skb_put_padto(skb, ETH_ZLEN)) {
339 spin_unlock_bh(&hsr->seqnr_lock);
343 hsr_forward_skb(skb, master);
344 spin_unlock_bh(&hsr->seqnr_lock);
348 static void send_prp_supervision_frame(struct hsr_port *master,
349 unsigned long *interval)
351 struct hsr_priv *hsr = master->hsr;
352 struct hsr_sup_payload *hsr_sp;
353 struct hsr_sup_tag *hsr_stag;
356 skb = hsr_init_skb(master);
358 netdev_warn_once(master->dev, "PRP: Could not send supervision frame\n");
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));
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);
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);
378 if (skb_put_padto(skb, ETH_ZLEN)) {
379 spin_unlock_bh(&hsr->seqnr_lock);
383 hsr_forward_skb(skb, master);
384 spin_unlock_bh(&hsr->seqnr_lock);
387 /* Announce (supervision frame) timer function
389 static void hsr_announce(struct timer_list *t)
391 struct hsr_priv *hsr;
392 struct hsr_port *master;
393 unsigned long interval;
395 hsr = from_timer(hsr, t, announce_timer);
398 master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
399 hsr->proto_ops->send_sv_frame(master, &interval);
401 if (is_admin_up(master->dev))
402 mod_timer(&hsr->announce_timer, jiffies + interval);
407 void hsr_del_ports(struct hsr_priv *hsr)
409 struct hsr_port *port;
411 port = hsr_port_get_hsr(hsr, HSR_PT_SLAVE_A);
415 port = hsr_port_get_hsr(hsr, HSR_PT_SLAVE_B);
419 port = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
424 static void hsr_set_rx_mode(struct net_device *dev)
426 struct hsr_port *port;
427 struct hsr_priv *hsr;
429 hsr = netdev_priv(dev);
431 hsr_for_each_port(hsr, port) {
432 if (port->type == HSR_PT_MASTER)
434 switch (port->type) {
437 dev_mc_sync_multiple(port->dev, dev);
438 dev_uc_sync_multiple(port->dev, dev);
446 static void hsr_change_rx_flags(struct net_device *dev, int change)
448 struct hsr_port *port;
449 struct hsr_priv *hsr;
451 hsr = netdev_priv(dev);
453 hsr_for_each_port(hsr, port) {
454 if (port->type == HSR_PT_MASTER)
456 switch (port->type) {
459 if (change & IFF_ALLMULTI)
460 dev_set_allmulti(port->dev,
462 IFF_ALLMULTI ? 1 : -1);
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,
480 static struct device_type hsr_type = {
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,
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,
503 void hsr_dev_setup(struct net_device *dev)
505 eth_hw_addr_random(dev);
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;
514 dev->needs_free_netdev = true;
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;
520 dev->features = dev->hw_features;
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.
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".
531 dev->features |= NETIF_F_NETNS_LOCAL;
534 /* Return true if dev is a HSR master; return false otherwise.
536 bool is_hsr_master(struct net_device *dev)
538 return (dev->netdev_ops->ndo_start_xmit == hsr_dev_xmit);
540 EXPORT_SYMBOL(is_hsr_master);
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
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)
551 bool unregister = false;
552 struct hsr_priv *hsr;
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);
560 eth_hw_addr_set(hsr_dev, slave[0]->dev_addr);
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
567 hsr->net_id = PRP_LAN_ID << 1;
568 hsr->proto_ops = &prp_ops;
570 hsr->proto_ops = &hsr_ops;
573 /* Make sure we recognize frames from ourselves in hsr_rcv() */
574 res = hsr_create_self_node(hsr, hsr_dev->dev_addr,
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;
584 timer_setup(&hsr->announce_timer, hsr_announce, 0);
585 timer_setup(&hsr->prune_timer, hsr_prune_nodes, 0);
587 ether_addr_copy(hsr->sup_multicast_addr, def_multicast_addr);
588 hsr->sup_multicast_addr[ETH_ALEN - 1] = multicast_spec;
590 hsr->prot_version = protocol_version;
592 /* Make sure the 1st call to netif_carrier_on() gets through */
593 netif_carrier_off(hsr_dev);
595 res = hsr_add_port(hsr, hsr_dev, HSR_PT_MASTER, extack);
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;
604 res = register_netdevice(hsr_dev);
610 res = hsr_add_port(hsr, slave[0], HSR_PT_SLAVE_A, extack);
614 res = hsr_add_port(hsr, slave[1], HSR_PT_SLAVE_B, extack);
618 hsr_debugfs_init(hsr, hsr_dev);
619 mod_timer(&hsr->prune_timer, jiffies + msecs_to_jiffies(PRUNE_PERIOD));
626 hsr_del_self_node(hsr);
629 unregister_netdevice(hsr_dev);