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