1 /* SPDX-License-Identifier: GPL-2.0-or-later */ 2 /* 3 * include/net/dsa.h - Driver for Distributed Switch Architecture switch chips 4 * Copyright (c) 2008-2009 Marvell Semiconductor 5 */ 6 7 #ifndef __LINUX_NET_DSA_H 8 #define __LINUX_NET_DSA_H 9 10 #include <linux/if.h> 11 #include <linux/if_ether.h> 12 #include <linux/list.h> 13 #include <linux/notifier.h> 14 #include <linux/timer.h> 15 #include <linux/workqueue.h> 16 #include <linux/of.h> 17 #include <linux/ethtool.h> 18 #include <linux/net_tstamp.h> 19 #include <linux/phy.h> 20 #include <linux/platform_data/dsa.h> 21 #include <linux/phylink.h> 22 #include <net/devlink.h> 23 #include <net/switchdev.h> 24 25 struct tc_action; 26 struct phy_device; 27 struct fixed_phy_status; 28 struct phylink_link_state; 29 30 #define DSA_TAG_PROTO_NONE_VALUE 0 31 #define DSA_TAG_PROTO_BRCM_VALUE 1 32 #define DSA_TAG_PROTO_BRCM_PREPEND_VALUE 2 33 #define DSA_TAG_PROTO_DSA_VALUE 3 34 #define DSA_TAG_PROTO_EDSA_VALUE 4 35 #define DSA_TAG_PROTO_GSWIP_VALUE 5 36 #define DSA_TAG_PROTO_KSZ9477_VALUE 6 37 #define DSA_TAG_PROTO_KSZ9893_VALUE 7 38 #define DSA_TAG_PROTO_LAN9303_VALUE 8 39 #define DSA_TAG_PROTO_MTK_VALUE 9 40 #define DSA_TAG_PROTO_QCA_VALUE 10 41 #define DSA_TAG_PROTO_TRAILER_VALUE 11 42 #define DSA_TAG_PROTO_8021Q_VALUE 12 43 #define DSA_TAG_PROTO_SJA1105_VALUE 13 44 #define DSA_TAG_PROTO_KSZ8795_VALUE 14 45 #define DSA_TAG_PROTO_OCELOT_VALUE 15 46 #define DSA_TAG_PROTO_AR9331_VALUE 16 47 #define DSA_TAG_PROTO_RTL4_A_VALUE 17 48 #define DSA_TAG_PROTO_HELLCREEK_VALUE 18 49 #define DSA_TAG_PROTO_XRS700X_VALUE 19 50 #define DSA_TAG_PROTO_OCELOT_8021Q_VALUE 20 51 #define DSA_TAG_PROTO_SEVILLE_VALUE 21 52 #define DSA_TAG_PROTO_BRCM_LEGACY_VALUE 22 53 #define DSA_TAG_PROTO_SJA1110_VALUE 23 54 55 enum dsa_tag_protocol { 56 DSA_TAG_PROTO_NONE = DSA_TAG_PROTO_NONE_VALUE, 57 DSA_TAG_PROTO_BRCM = DSA_TAG_PROTO_BRCM_VALUE, 58 DSA_TAG_PROTO_BRCM_LEGACY = DSA_TAG_PROTO_BRCM_LEGACY_VALUE, 59 DSA_TAG_PROTO_BRCM_PREPEND = DSA_TAG_PROTO_BRCM_PREPEND_VALUE, 60 DSA_TAG_PROTO_DSA = DSA_TAG_PROTO_DSA_VALUE, 61 DSA_TAG_PROTO_EDSA = DSA_TAG_PROTO_EDSA_VALUE, 62 DSA_TAG_PROTO_GSWIP = DSA_TAG_PROTO_GSWIP_VALUE, 63 DSA_TAG_PROTO_KSZ9477 = DSA_TAG_PROTO_KSZ9477_VALUE, 64 DSA_TAG_PROTO_KSZ9893 = DSA_TAG_PROTO_KSZ9893_VALUE, 65 DSA_TAG_PROTO_LAN9303 = DSA_TAG_PROTO_LAN9303_VALUE, 66 DSA_TAG_PROTO_MTK = DSA_TAG_PROTO_MTK_VALUE, 67 DSA_TAG_PROTO_QCA = DSA_TAG_PROTO_QCA_VALUE, 68 DSA_TAG_PROTO_TRAILER = DSA_TAG_PROTO_TRAILER_VALUE, 69 DSA_TAG_PROTO_8021Q = DSA_TAG_PROTO_8021Q_VALUE, 70 DSA_TAG_PROTO_SJA1105 = DSA_TAG_PROTO_SJA1105_VALUE, 71 DSA_TAG_PROTO_KSZ8795 = DSA_TAG_PROTO_KSZ8795_VALUE, 72 DSA_TAG_PROTO_OCELOT = DSA_TAG_PROTO_OCELOT_VALUE, 73 DSA_TAG_PROTO_AR9331 = DSA_TAG_PROTO_AR9331_VALUE, 74 DSA_TAG_PROTO_RTL4_A = DSA_TAG_PROTO_RTL4_A_VALUE, 75 DSA_TAG_PROTO_HELLCREEK = DSA_TAG_PROTO_HELLCREEK_VALUE, 76 DSA_TAG_PROTO_XRS700X = DSA_TAG_PROTO_XRS700X_VALUE, 77 DSA_TAG_PROTO_OCELOT_8021Q = DSA_TAG_PROTO_OCELOT_8021Q_VALUE, 78 DSA_TAG_PROTO_SEVILLE = DSA_TAG_PROTO_SEVILLE_VALUE, 79 DSA_TAG_PROTO_SJA1110 = DSA_TAG_PROTO_SJA1110_VALUE, 80 }; 81 82 struct dsa_switch; 83 84 struct dsa_device_ops { 85 struct sk_buff *(*xmit)(struct sk_buff *skb, struct net_device *dev); 86 struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev); 87 void (*flow_dissect)(const struct sk_buff *skb, __be16 *proto, 88 int *offset); 89 unsigned int needed_headroom; 90 unsigned int needed_tailroom; 91 const char *name; 92 enum dsa_tag_protocol proto; 93 /* Some tagging protocols either mangle or shift the destination MAC 94 * address, in which case the DSA master would drop packets on ingress 95 * if what it understands out of the destination MAC address is not in 96 * its RX filter. 97 */ 98 bool promisc_on_master; 99 }; 100 101 /* This structure defines the control interfaces that are overlayed by the 102 * DSA layer on top of the DSA CPU/management net_device instance. This is 103 * used by the core net_device layer while calling various net_device_ops 104 * function pointers. 105 */ 106 struct dsa_netdevice_ops { 107 int (*ndo_eth_ioctl)(struct net_device *dev, struct ifreq *ifr, 108 int cmd); 109 }; 110 111 #define DSA_TAG_DRIVER_ALIAS "dsa_tag-" 112 #define MODULE_ALIAS_DSA_TAG_DRIVER(__proto) \ 113 MODULE_ALIAS(DSA_TAG_DRIVER_ALIAS __stringify(__proto##_VALUE)) 114 115 struct dsa_switch_tree { 116 struct list_head list; 117 118 /* Notifier chain for switch-wide events */ 119 struct raw_notifier_head nh; 120 121 /* Tree identifier */ 122 unsigned int index; 123 124 /* Number of switches attached to this tree */ 125 struct kref refcount; 126 127 /* Has this tree been applied to the hardware? */ 128 bool setup; 129 130 /* Tagging protocol operations */ 131 const struct dsa_device_ops *tag_ops; 132 133 /* Default tagging protocol preferred by the switches in this 134 * tree. 135 */ 136 enum dsa_tag_protocol default_proto; 137 138 /* 139 * Configuration data for the platform device that owns 140 * this dsa switch tree instance. 141 */ 142 struct dsa_platform_data *pd; 143 144 /* List of switch ports */ 145 struct list_head ports; 146 147 /* List of DSA links composing the routing table */ 148 struct list_head rtable; 149 150 /* Maps offloaded LAG netdevs to a zero-based linear ID for 151 * drivers that need it. 152 */ 153 struct net_device **lags; 154 unsigned int lags_len; 155 156 /* Track the largest switch index within a tree */ 157 unsigned int last_switch; 158 }; 159 160 #define dsa_lags_foreach_id(_id, _dst) \ 161 for ((_id) = 0; (_id) < (_dst)->lags_len; (_id)++) \ 162 if ((_dst)->lags[(_id)]) 163 164 #define dsa_lag_foreach_port(_dp, _dst, _lag) \ 165 list_for_each_entry((_dp), &(_dst)->ports, list) \ 166 if ((_dp)->lag_dev == (_lag)) 167 168 #define dsa_hsr_foreach_port(_dp, _ds, _hsr) \ 169 list_for_each_entry((_dp), &(_ds)->dst->ports, list) \ 170 if ((_dp)->ds == (_ds) && (_dp)->hsr_dev == (_hsr)) 171 172 static inline struct net_device *dsa_lag_dev(struct dsa_switch_tree *dst, 173 unsigned int id) 174 { 175 return dst->lags[id]; 176 } 177 178 static inline int dsa_lag_id(struct dsa_switch_tree *dst, 179 struct net_device *lag) 180 { 181 unsigned int id; 182 183 dsa_lags_foreach_id(id, dst) { 184 if (dsa_lag_dev(dst, id) == lag) 185 return id; 186 } 187 188 return -ENODEV; 189 } 190 191 /* TC matchall action types */ 192 enum dsa_port_mall_action_type { 193 DSA_PORT_MALL_MIRROR, 194 DSA_PORT_MALL_POLICER, 195 }; 196 197 /* TC mirroring entry */ 198 struct dsa_mall_mirror_tc_entry { 199 u8 to_local_port; 200 bool ingress; 201 }; 202 203 /* TC port policer entry */ 204 struct dsa_mall_policer_tc_entry { 205 u32 burst; 206 u64 rate_bytes_per_sec; 207 }; 208 209 /* TC matchall entry */ 210 struct dsa_mall_tc_entry { 211 struct list_head list; 212 unsigned long cookie; 213 enum dsa_port_mall_action_type type; 214 union { 215 struct dsa_mall_mirror_tc_entry mirror; 216 struct dsa_mall_policer_tc_entry policer; 217 }; 218 }; 219 220 221 struct dsa_port { 222 /* A CPU port is physically connected to a master device. 223 * A user port exposed to userspace has a slave device. 224 */ 225 union { 226 struct net_device *master; 227 struct net_device *slave; 228 }; 229 230 /* Copy of the tagging protocol operations, for quicker access 231 * in the data path. Valid only for the CPU ports. 232 */ 233 const struct dsa_device_ops *tag_ops; 234 235 /* Copies for faster access in master receive hot path */ 236 struct dsa_switch_tree *dst; 237 struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev); 238 239 enum { 240 DSA_PORT_TYPE_UNUSED = 0, 241 DSA_PORT_TYPE_CPU, 242 DSA_PORT_TYPE_DSA, 243 DSA_PORT_TYPE_USER, 244 } type; 245 246 struct dsa_switch *ds; 247 unsigned int index; 248 const char *name; 249 struct dsa_port *cpu_dp; 250 u8 mac[ETH_ALEN]; 251 struct device_node *dn; 252 unsigned int ageing_time; 253 bool vlan_filtering; 254 /* Managed by DSA on user ports and by drivers on CPU and DSA ports */ 255 bool learning; 256 u8 stp_state; 257 struct net_device *bridge_dev; 258 int bridge_num; 259 struct devlink_port devlink_port; 260 bool devlink_port_setup; 261 struct phylink *pl; 262 struct phylink_config pl_config; 263 struct net_device *lag_dev; 264 bool lag_tx_enabled; 265 struct net_device *hsr_dev; 266 267 struct list_head list; 268 269 /* 270 * Give the switch driver somewhere to hang its per-port private data 271 * structures (accessible from the tagger). 272 */ 273 void *priv; 274 275 /* 276 * Original copy of the master netdev ethtool_ops 277 */ 278 const struct ethtool_ops *orig_ethtool_ops; 279 280 /* 281 * Original copy of the master netdev net_device_ops 282 */ 283 const struct dsa_netdevice_ops *netdev_ops; 284 285 /* List of MAC addresses that must be forwarded on this port. 286 * These are only valid on CPU ports and DSA links. 287 */ 288 struct list_head fdbs; 289 struct list_head mdbs; 290 291 bool setup; 292 }; 293 294 /* TODO: ideally DSA ports would have a single dp->link_dp member, 295 * and no dst->rtable nor this struct dsa_link would be needed, 296 * but this would require some more complex tree walking, 297 * so keep it stupid at the moment and list them all. 298 */ 299 struct dsa_link { 300 struct dsa_port *dp; 301 struct dsa_port *link_dp; 302 struct list_head list; 303 }; 304 305 struct dsa_mac_addr { 306 unsigned char addr[ETH_ALEN]; 307 u16 vid; 308 refcount_t refcount; 309 struct list_head list; 310 }; 311 312 struct dsa_switch { 313 bool setup; 314 315 struct device *dev; 316 317 /* 318 * Parent switch tree, and switch index. 319 */ 320 struct dsa_switch_tree *dst; 321 unsigned int index; 322 323 /* Listener for switch fabric events */ 324 struct notifier_block nb; 325 326 /* 327 * Give the switch driver somewhere to hang its private data 328 * structure. 329 */ 330 void *priv; 331 332 /* 333 * Configuration data for this switch. 334 */ 335 struct dsa_chip_data *cd; 336 337 /* 338 * The switch operations. 339 */ 340 const struct dsa_switch_ops *ops; 341 342 /* 343 * Slave mii_bus and devices for the individual ports. 344 */ 345 u32 phys_mii_mask; 346 struct mii_bus *slave_mii_bus; 347 348 /* Ageing Time limits in msecs */ 349 unsigned int ageing_time_min; 350 unsigned int ageing_time_max; 351 352 /* Storage for drivers using tag_8021q */ 353 struct dsa_8021q_context *tag_8021q_ctx; 354 355 /* devlink used to represent this switch device */ 356 struct devlink *devlink; 357 358 /* Number of switch port queues */ 359 unsigned int num_tx_queues; 360 361 /* Disallow bridge core from requesting different VLAN awareness 362 * settings on ports if not hardware-supported 363 */ 364 bool vlan_filtering_is_global; 365 366 /* Keep VLAN filtering enabled on ports not offloading any upper. */ 367 bool needs_standalone_vlan_filtering; 368 369 /* Pass .port_vlan_add and .port_vlan_del to drivers even for bridges 370 * that have vlan_filtering=0. All drivers should ideally set this (and 371 * then the option would get removed), but it is unknown whether this 372 * would break things or not. 373 */ 374 bool configure_vlan_while_not_filtering; 375 376 /* If the switch driver always programs the CPU port as egress tagged 377 * despite the VLAN configuration indicating otherwise, then setting 378 * @untag_bridge_pvid will force the DSA receive path to pop the bridge's 379 * default_pvid VLAN tagged frames to offer a consistent behavior 380 * between a vlan_filtering=0 and vlan_filtering=1 bridge device. 381 */ 382 bool untag_bridge_pvid; 383 384 /* Let DSA manage the FDB entries towards the CPU, based on the 385 * software bridge database. 386 */ 387 bool assisted_learning_on_cpu_port; 388 389 /* In case vlan_filtering_is_global is set, the VLAN awareness state 390 * should be retrieved from here and not from the per-port settings. 391 */ 392 bool vlan_filtering; 393 394 /* MAC PCS does not provide link state change interrupt, and requires 395 * polling. Flag passed on to PHYLINK. 396 */ 397 bool pcs_poll; 398 399 /* For switches that only have the MRU configurable. To ensure the 400 * configured MTU is not exceeded, normalization of MRU on all bridged 401 * interfaces is needed. 402 */ 403 bool mtu_enforcement_ingress; 404 405 /* Drivers that benefit from having an ID associated with each 406 * offloaded LAG should set this to the maximum number of 407 * supported IDs. DSA will then maintain a mapping of _at 408 * least_ these many IDs, accessible to drivers via 409 * dsa_lag_id(). 410 */ 411 unsigned int num_lag_ids; 412 413 /* Drivers that support bridge forwarding offload should set this to 414 * the maximum number of bridges spanning the same switch tree (or all 415 * trees, in the case of cross-tree bridging support) that can be 416 * offloaded. 417 */ 418 unsigned int num_fwd_offloading_bridges; 419 420 size_t num_ports; 421 }; 422 423 static inline struct dsa_port *dsa_to_port(struct dsa_switch *ds, int p) 424 { 425 struct dsa_switch_tree *dst = ds->dst; 426 struct dsa_port *dp; 427 428 list_for_each_entry(dp, &dst->ports, list) 429 if (dp->ds == ds && dp->index == p) 430 return dp; 431 432 return NULL; 433 } 434 435 static inline bool dsa_port_is_dsa(struct dsa_port *port) 436 { 437 return port->type == DSA_PORT_TYPE_DSA; 438 } 439 440 static inline bool dsa_port_is_cpu(struct dsa_port *port) 441 { 442 return port->type == DSA_PORT_TYPE_CPU; 443 } 444 445 static inline bool dsa_port_is_user(struct dsa_port *dp) 446 { 447 return dp->type == DSA_PORT_TYPE_USER; 448 } 449 450 static inline bool dsa_is_unused_port(struct dsa_switch *ds, int p) 451 { 452 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_UNUSED; 453 } 454 455 static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p) 456 { 457 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_CPU; 458 } 459 460 static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p) 461 { 462 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_DSA; 463 } 464 465 static inline bool dsa_is_user_port(struct dsa_switch *ds, int p) 466 { 467 return dsa_to_port(ds, p)->type == DSA_PORT_TYPE_USER; 468 } 469 470 static inline u32 dsa_user_ports(struct dsa_switch *ds) 471 { 472 u32 mask = 0; 473 int p; 474 475 for (p = 0; p < ds->num_ports; p++) 476 if (dsa_is_user_port(ds, p)) 477 mask |= BIT(p); 478 479 return mask; 480 } 481 482 /* Return the local port used to reach an arbitrary switch device */ 483 static inline unsigned int dsa_routing_port(struct dsa_switch *ds, int device) 484 { 485 struct dsa_switch_tree *dst = ds->dst; 486 struct dsa_link *dl; 487 488 list_for_each_entry(dl, &dst->rtable, list) 489 if (dl->dp->ds == ds && dl->link_dp->ds->index == device) 490 return dl->dp->index; 491 492 return ds->num_ports; 493 } 494 495 /* Return the local port used to reach an arbitrary switch port */ 496 static inline unsigned int dsa_towards_port(struct dsa_switch *ds, int device, 497 int port) 498 { 499 if (device == ds->index) 500 return port; 501 else 502 return dsa_routing_port(ds, device); 503 } 504 505 /* Return the local port used to reach the dedicated CPU port */ 506 static inline unsigned int dsa_upstream_port(struct dsa_switch *ds, int port) 507 { 508 const struct dsa_port *dp = dsa_to_port(ds, port); 509 const struct dsa_port *cpu_dp = dp->cpu_dp; 510 511 if (!cpu_dp) 512 return port; 513 514 return dsa_towards_port(ds, cpu_dp->ds->index, cpu_dp->index); 515 } 516 517 /* Return true if this is the local port used to reach the CPU port */ 518 static inline bool dsa_is_upstream_port(struct dsa_switch *ds, int port) 519 { 520 if (dsa_is_unused_port(ds, port)) 521 return false; 522 523 return port == dsa_upstream_port(ds, port); 524 } 525 526 /* Return true if @upstream_ds is an upstream switch of @downstream_ds, meaning 527 * that the routing port from @downstream_ds to @upstream_ds is also the port 528 * which @downstream_ds uses to reach its dedicated CPU. 529 */ 530 static inline bool dsa_switch_is_upstream_of(struct dsa_switch *upstream_ds, 531 struct dsa_switch *downstream_ds) 532 { 533 int routing_port; 534 535 if (upstream_ds == downstream_ds) 536 return true; 537 538 routing_port = dsa_routing_port(downstream_ds, upstream_ds->index); 539 540 return dsa_is_upstream_port(downstream_ds, routing_port); 541 } 542 543 static inline bool dsa_port_is_vlan_filtering(const struct dsa_port *dp) 544 { 545 const struct dsa_switch *ds = dp->ds; 546 547 if (ds->vlan_filtering_is_global) 548 return ds->vlan_filtering; 549 else 550 return dp->vlan_filtering; 551 } 552 553 static inline 554 struct net_device *dsa_port_to_bridge_port(const struct dsa_port *dp) 555 { 556 if (!dp->bridge_dev) 557 return NULL; 558 559 if (dp->lag_dev) 560 return dp->lag_dev; 561 else if (dp->hsr_dev) 562 return dp->hsr_dev; 563 564 return dp->slave; 565 } 566 567 typedef int dsa_fdb_dump_cb_t(const unsigned char *addr, u16 vid, 568 bool is_static, void *data); 569 struct dsa_switch_ops { 570 /* 571 * Tagging protocol helpers called for the CPU ports and DSA links. 572 * @get_tag_protocol retrieves the initial tagging protocol and is 573 * mandatory. Switches which can operate using multiple tagging 574 * protocols should implement @change_tag_protocol and report in 575 * @get_tag_protocol the tagger in current use. 576 */ 577 enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds, 578 int port, 579 enum dsa_tag_protocol mprot); 580 int (*change_tag_protocol)(struct dsa_switch *ds, int port, 581 enum dsa_tag_protocol proto); 582 583 int (*setup)(struct dsa_switch *ds); 584 void (*teardown)(struct dsa_switch *ds); 585 u32 (*get_phy_flags)(struct dsa_switch *ds, int port); 586 587 /* 588 * Access to the switch's PHY registers. 589 */ 590 int (*phy_read)(struct dsa_switch *ds, int port, int regnum); 591 int (*phy_write)(struct dsa_switch *ds, int port, 592 int regnum, u16 val); 593 594 /* 595 * Link state adjustment (called from libphy) 596 */ 597 void (*adjust_link)(struct dsa_switch *ds, int port, 598 struct phy_device *phydev); 599 void (*fixed_link_update)(struct dsa_switch *ds, int port, 600 struct fixed_phy_status *st); 601 602 /* 603 * PHYLINK integration 604 */ 605 void (*phylink_validate)(struct dsa_switch *ds, int port, 606 unsigned long *supported, 607 struct phylink_link_state *state); 608 int (*phylink_mac_link_state)(struct dsa_switch *ds, int port, 609 struct phylink_link_state *state); 610 void (*phylink_mac_config)(struct dsa_switch *ds, int port, 611 unsigned int mode, 612 const struct phylink_link_state *state); 613 void (*phylink_mac_an_restart)(struct dsa_switch *ds, int port); 614 void (*phylink_mac_link_down)(struct dsa_switch *ds, int port, 615 unsigned int mode, 616 phy_interface_t interface); 617 void (*phylink_mac_link_up)(struct dsa_switch *ds, int port, 618 unsigned int mode, 619 phy_interface_t interface, 620 struct phy_device *phydev, 621 int speed, int duplex, 622 bool tx_pause, bool rx_pause); 623 void (*phylink_fixed_state)(struct dsa_switch *ds, int port, 624 struct phylink_link_state *state); 625 /* 626 * Port statistics counters. 627 */ 628 void (*get_strings)(struct dsa_switch *ds, int port, 629 u32 stringset, uint8_t *data); 630 void (*get_ethtool_stats)(struct dsa_switch *ds, 631 int port, uint64_t *data); 632 int (*get_sset_count)(struct dsa_switch *ds, int port, int sset); 633 void (*get_ethtool_phy_stats)(struct dsa_switch *ds, 634 int port, uint64_t *data); 635 void (*get_stats64)(struct dsa_switch *ds, int port, 636 struct rtnl_link_stats64 *s); 637 void (*self_test)(struct dsa_switch *ds, int port, 638 struct ethtool_test *etest, u64 *data); 639 640 /* 641 * ethtool Wake-on-LAN 642 */ 643 void (*get_wol)(struct dsa_switch *ds, int port, 644 struct ethtool_wolinfo *w); 645 int (*set_wol)(struct dsa_switch *ds, int port, 646 struct ethtool_wolinfo *w); 647 648 /* 649 * ethtool timestamp info 650 */ 651 int (*get_ts_info)(struct dsa_switch *ds, int port, 652 struct ethtool_ts_info *ts); 653 654 /* 655 * Suspend and resume 656 */ 657 int (*suspend)(struct dsa_switch *ds); 658 int (*resume)(struct dsa_switch *ds); 659 660 /* 661 * Port enable/disable 662 */ 663 int (*port_enable)(struct dsa_switch *ds, int port, 664 struct phy_device *phy); 665 void (*port_disable)(struct dsa_switch *ds, int port); 666 667 /* 668 * Port's MAC EEE settings 669 */ 670 int (*set_mac_eee)(struct dsa_switch *ds, int port, 671 struct ethtool_eee *e); 672 int (*get_mac_eee)(struct dsa_switch *ds, int port, 673 struct ethtool_eee *e); 674 675 /* EEPROM access */ 676 int (*get_eeprom_len)(struct dsa_switch *ds); 677 int (*get_eeprom)(struct dsa_switch *ds, 678 struct ethtool_eeprom *eeprom, u8 *data); 679 int (*set_eeprom)(struct dsa_switch *ds, 680 struct ethtool_eeprom *eeprom, u8 *data); 681 682 /* 683 * Register access. 684 */ 685 int (*get_regs_len)(struct dsa_switch *ds, int port); 686 void (*get_regs)(struct dsa_switch *ds, int port, 687 struct ethtool_regs *regs, void *p); 688 689 /* 690 * Upper device tracking. 691 */ 692 int (*port_prechangeupper)(struct dsa_switch *ds, int port, 693 struct netdev_notifier_changeupper_info *info); 694 695 /* 696 * Bridge integration 697 */ 698 int (*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs); 699 int (*port_bridge_join)(struct dsa_switch *ds, int port, 700 struct net_device *bridge); 701 void (*port_bridge_leave)(struct dsa_switch *ds, int port, 702 struct net_device *bridge); 703 /* Called right after .port_bridge_join() */ 704 int (*port_bridge_tx_fwd_offload)(struct dsa_switch *ds, int port, 705 struct net_device *bridge, 706 int bridge_num); 707 /* Called right before .port_bridge_leave() */ 708 void (*port_bridge_tx_fwd_unoffload)(struct dsa_switch *ds, int port, 709 struct net_device *bridge, 710 int bridge_num); 711 void (*port_stp_state_set)(struct dsa_switch *ds, int port, 712 u8 state); 713 void (*port_fast_age)(struct dsa_switch *ds, int port); 714 int (*port_pre_bridge_flags)(struct dsa_switch *ds, int port, 715 struct switchdev_brport_flags flags, 716 struct netlink_ext_ack *extack); 717 int (*port_bridge_flags)(struct dsa_switch *ds, int port, 718 struct switchdev_brport_flags flags, 719 struct netlink_ext_ack *extack); 720 721 /* 722 * VLAN support 723 */ 724 int (*port_vlan_filtering)(struct dsa_switch *ds, int port, 725 bool vlan_filtering, 726 struct netlink_ext_ack *extack); 727 int (*port_vlan_add)(struct dsa_switch *ds, int port, 728 const struct switchdev_obj_port_vlan *vlan, 729 struct netlink_ext_ack *extack); 730 int (*port_vlan_del)(struct dsa_switch *ds, int port, 731 const struct switchdev_obj_port_vlan *vlan); 732 /* 733 * Forwarding database 734 */ 735 int (*port_fdb_add)(struct dsa_switch *ds, int port, 736 const unsigned char *addr, u16 vid); 737 int (*port_fdb_del)(struct dsa_switch *ds, int port, 738 const unsigned char *addr, u16 vid); 739 int (*port_fdb_dump)(struct dsa_switch *ds, int port, 740 dsa_fdb_dump_cb_t *cb, void *data); 741 742 /* 743 * Multicast database 744 */ 745 int (*port_mdb_add)(struct dsa_switch *ds, int port, 746 const struct switchdev_obj_port_mdb *mdb); 747 int (*port_mdb_del)(struct dsa_switch *ds, int port, 748 const struct switchdev_obj_port_mdb *mdb); 749 /* 750 * RXNFC 751 */ 752 int (*get_rxnfc)(struct dsa_switch *ds, int port, 753 struct ethtool_rxnfc *nfc, u32 *rule_locs); 754 int (*set_rxnfc)(struct dsa_switch *ds, int port, 755 struct ethtool_rxnfc *nfc); 756 757 /* 758 * TC integration 759 */ 760 int (*cls_flower_add)(struct dsa_switch *ds, int port, 761 struct flow_cls_offload *cls, bool ingress); 762 int (*cls_flower_del)(struct dsa_switch *ds, int port, 763 struct flow_cls_offload *cls, bool ingress); 764 int (*cls_flower_stats)(struct dsa_switch *ds, int port, 765 struct flow_cls_offload *cls, bool ingress); 766 int (*port_mirror_add)(struct dsa_switch *ds, int port, 767 struct dsa_mall_mirror_tc_entry *mirror, 768 bool ingress); 769 void (*port_mirror_del)(struct dsa_switch *ds, int port, 770 struct dsa_mall_mirror_tc_entry *mirror); 771 int (*port_policer_add)(struct dsa_switch *ds, int port, 772 struct dsa_mall_policer_tc_entry *policer); 773 void (*port_policer_del)(struct dsa_switch *ds, int port); 774 int (*port_setup_tc)(struct dsa_switch *ds, int port, 775 enum tc_setup_type type, void *type_data); 776 777 /* 778 * Cross-chip operations 779 */ 780 int (*crosschip_bridge_join)(struct dsa_switch *ds, int tree_index, 781 int sw_index, int port, 782 struct net_device *br); 783 void (*crosschip_bridge_leave)(struct dsa_switch *ds, int tree_index, 784 int sw_index, int port, 785 struct net_device *br); 786 int (*crosschip_lag_change)(struct dsa_switch *ds, int sw_index, 787 int port); 788 int (*crosschip_lag_join)(struct dsa_switch *ds, int sw_index, 789 int port, struct net_device *lag, 790 struct netdev_lag_upper_info *info); 791 int (*crosschip_lag_leave)(struct dsa_switch *ds, int sw_index, 792 int port, struct net_device *lag); 793 794 /* 795 * PTP functionality 796 */ 797 int (*port_hwtstamp_get)(struct dsa_switch *ds, int port, 798 struct ifreq *ifr); 799 int (*port_hwtstamp_set)(struct dsa_switch *ds, int port, 800 struct ifreq *ifr); 801 void (*port_txtstamp)(struct dsa_switch *ds, int port, 802 struct sk_buff *skb); 803 bool (*port_rxtstamp)(struct dsa_switch *ds, int port, 804 struct sk_buff *skb, unsigned int type); 805 806 /* Devlink parameters, etc */ 807 int (*devlink_param_get)(struct dsa_switch *ds, u32 id, 808 struct devlink_param_gset_ctx *ctx); 809 int (*devlink_param_set)(struct dsa_switch *ds, u32 id, 810 struct devlink_param_gset_ctx *ctx); 811 int (*devlink_info_get)(struct dsa_switch *ds, 812 struct devlink_info_req *req, 813 struct netlink_ext_ack *extack); 814 int (*devlink_sb_pool_get)(struct dsa_switch *ds, 815 unsigned int sb_index, u16 pool_index, 816 struct devlink_sb_pool_info *pool_info); 817 int (*devlink_sb_pool_set)(struct dsa_switch *ds, unsigned int sb_index, 818 u16 pool_index, u32 size, 819 enum devlink_sb_threshold_type threshold_type, 820 struct netlink_ext_ack *extack); 821 int (*devlink_sb_port_pool_get)(struct dsa_switch *ds, int port, 822 unsigned int sb_index, u16 pool_index, 823 u32 *p_threshold); 824 int (*devlink_sb_port_pool_set)(struct dsa_switch *ds, int port, 825 unsigned int sb_index, u16 pool_index, 826 u32 threshold, 827 struct netlink_ext_ack *extack); 828 int (*devlink_sb_tc_pool_bind_get)(struct dsa_switch *ds, int port, 829 unsigned int sb_index, u16 tc_index, 830 enum devlink_sb_pool_type pool_type, 831 u16 *p_pool_index, u32 *p_threshold); 832 int (*devlink_sb_tc_pool_bind_set)(struct dsa_switch *ds, int port, 833 unsigned int sb_index, u16 tc_index, 834 enum devlink_sb_pool_type pool_type, 835 u16 pool_index, u32 threshold, 836 struct netlink_ext_ack *extack); 837 int (*devlink_sb_occ_snapshot)(struct dsa_switch *ds, 838 unsigned int sb_index); 839 int (*devlink_sb_occ_max_clear)(struct dsa_switch *ds, 840 unsigned int sb_index); 841 int (*devlink_sb_occ_port_pool_get)(struct dsa_switch *ds, int port, 842 unsigned int sb_index, u16 pool_index, 843 u32 *p_cur, u32 *p_max); 844 int (*devlink_sb_occ_tc_port_bind_get)(struct dsa_switch *ds, int port, 845 unsigned int sb_index, u16 tc_index, 846 enum devlink_sb_pool_type pool_type, 847 u32 *p_cur, u32 *p_max); 848 849 /* 850 * MTU change functionality. Switches can also adjust their MRU through 851 * this method. By MTU, one understands the SDU (L2 payload) length. 852 * If the switch needs to account for the DSA tag on the CPU port, this 853 * method needs to do so privately. 854 */ 855 int (*port_change_mtu)(struct dsa_switch *ds, int port, 856 int new_mtu); 857 int (*port_max_mtu)(struct dsa_switch *ds, int port); 858 859 /* 860 * LAG integration 861 */ 862 int (*port_lag_change)(struct dsa_switch *ds, int port); 863 int (*port_lag_join)(struct dsa_switch *ds, int port, 864 struct net_device *lag, 865 struct netdev_lag_upper_info *info); 866 int (*port_lag_leave)(struct dsa_switch *ds, int port, 867 struct net_device *lag); 868 869 /* 870 * HSR integration 871 */ 872 int (*port_hsr_join)(struct dsa_switch *ds, int port, 873 struct net_device *hsr); 874 int (*port_hsr_leave)(struct dsa_switch *ds, int port, 875 struct net_device *hsr); 876 877 /* 878 * MRP integration 879 */ 880 int (*port_mrp_add)(struct dsa_switch *ds, int port, 881 const struct switchdev_obj_mrp *mrp); 882 int (*port_mrp_del)(struct dsa_switch *ds, int port, 883 const struct switchdev_obj_mrp *mrp); 884 int (*port_mrp_add_ring_role)(struct dsa_switch *ds, int port, 885 const struct switchdev_obj_ring_role_mrp *mrp); 886 int (*port_mrp_del_ring_role)(struct dsa_switch *ds, int port, 887 const struct switchdev_obj_ring_role_mrp *mrp); 888 889 /* 890 * tag_8021q operations 891 */ 892 int (*tag_8021q_vlan_add)(struct dsa_switch *ds, int port, u16 vid, 893 u16 flags); 894 int (*tag_8021q_vlan_del)(struct dsa_switch *ds, int port, u16 vid); 895 }; 896 897 #define DSA_DEVLINK_PARAM_DRIVER(_id, _name, _type, _cmodes) \ 898 DEVLINK_PARAM_DRIVER(_id, _name, _type, _cmodes, \ 899 dsa_devlink_param_get, dsa_devlink_param_set, NULL) 900 901 int dsa_devlink_param_get(struct devlink *dl, u32 id, 902 struct devlink_param_gset_ctx *ctx); 903 int dsa_devlink_param_set(struct devlink *dl, u32 id, 904 struct devlink_param_gset_ctx *ctx); 905 int dsa_devlink_params_register(struct dsa_switch *ds, 906 const struct devlink_param *params, 907 size_t params_count); 908 void dsa_devlink_params_unregister(struct dsa_switch *ds, 909 const struct devlink_param *params, 910 size_t params_count); 911 int dsa_devlink_resource_register(struct dsa_switch *ds, 912 const char *resource_name, 913 u64 resource_size, 914 u64 resource_id, 915 u64 parent_resource_id, 916 const struct devlink_resource_size_params *size_params); 917 918 void dsa_devlink_resources_unregister(struct dsa_switch *ds); 919 920 void dsa_devlink_resource_occ_get_register(struct dsa_switch *ds, 921 u64 resource_id, 922 devlink_resource_occ_get_t *occ_get, 923 void *occ_get_priv); 924 void dsa_devlink_resource_occ_get_unregister(struct dsa_switch *ds, 925 u64 resource_id); 926 struct devlink_region * 927 dsa_devlink_region_create(struct dsa_switch *ds, 928 const struct devlink_region_ops *ops, 929 u32 region_max_snapshots, u64 region_size); 930 struct devlink_region * 931 dsa_devlink_port_region_create(struct dsa_switch *ds, 932 int port, 933 const struct devlink_port_region_ops *ops, 934 u32 region_max_snapshots, u64 region_size); 935 void dsa_devlink_region_destroy(struct devlink_region *region); 936 937 struct dsa_port *dsa_port_from_netdev(struct net_device *netdev); 938 939 struct dsa_devlink_priv { 940 struct dsa_switch *ds; 941 }; 942 943 static inline struct dsa_switch *dsa_devlink_to_ds(struct devlink *dl) 944 { 945 struct dsa_devlink_priv *dl_priv = devlink_priv(dl); 946 947 return dl_priv->ds; 948 } 949 950 static inline 951 struct dsa_switch *dsa_devlink_port_to_ds(struct devlink_port *port) 952 { 953 struct devlink *dl = port->devlink; 954 struct dsa_devlink_priv *dl_priv = devlink_priv(dl); 955 956 return dl_priv->ds; 957 } 958 959 static inline int dsa_devlink_port_to_port(struct devlink_port *port) 960 { 961 return port->index; 962 } 963 964 struct dsa_switch_driver { 965 struct list_head list; 966 const struct dsa_switch_ops *ops; 967 }; 968 969 struct net_device *dsa_dev_to_net_device(struct device *dev); 970 971 /* Keep inline for faster access in hot path */ 972 static inline bool netdev_uses_dsa(const struct net_device *dev) 973 { 974 #if IS_ENABLED(CONFIG_NET_DSA) 975 return dev->dsa_ptr && dev->dsa_ptr->rcv; 976 #endif 977 return false; 978 } 979 980 /* All DSA tags that push the EtherType to the right (basically all except tail 981 * tags, which don't break dissection) can be treated the same from the 982 * perspective of the flow dissector. 983 * 984 * We need to return: 985 * - offset: the (B - A) difference between: 986 * A. the position of the real EtherType and 987 * B. the current skb->data (aka ETH_HLEN bytes into the frame, aka 2 bytes 988 * after the normal EtherType was supposed to be) 989 * The offset in bytes is exactly equal to the tagger overhead (and half of 990 * that, in __be16 shorts). 991 * 992 * - proto: the value of the real EtherType. 993 */ 994 static inline void dsa_tag_generic_flow_dissect(const struct sk_buff *skb, 995 __be16 *proto, int *offset) 996 { 997 #if IS_ENABLED(CONFIG_NET_DSA) 998 const struct dsa_device_ops *ops = skb->dev->dsa_ptr->tag_ops; 999 int tag_len = ops->needed_headroom; 1000 1001 *offset = tag_len; 1002 *proto = ((__be16 *)skb->data)[(tag_len / 2) - 1]; 1003 #endif 1004 } 1005 1006 #if IS_ENABLED(CONFIG_NET_DSA) 1007 static inline int __dsa_netdevice_ops_check(struct net_device *dev) 1008 { 1009 int err = -EOPNOTSUPP; 1010 1011 if (!dev->dsa_ptr) 1012 return err; 1013 1014 if (!dev->dsa_ptr->netdev_ops) 1015 return err; 1016 1017 return 0; 1018 } 1019 1020 static inline int dsa_ndo_eth_ioctl(struct net_device *dev, struct ifreq *ifr, 1021 int cmd) 1022 { 1023 const struct dsa_netdevice_ops *ops; 1024 int err; 1025 1026 err = __dsa_netdevice_ops_check(dev); 1027 if (err) 1028 return err; 1029 1030 ops = dev->dsa_ptr->netdev_ops; 1031 1032 return ops->ndo_eth_ioctl(dev, ifr, cmd); 1033 } 1034 #else 1035 static inline int dsa_ndo_eth_ioctl(struct net_device *dev, struct ifreq *ifr, 1036 int cmd) 1037 { 1038 return -EOPNOTSUPP; 1039 } 1040 #endif 1041 1042 void dsa_unregister_switch(struct dsa_switch *ds); 1043 int dsa_register_switch(struct dsa_switch *ds); 1044 struct dsa_switch *dsa_switch_find(int tree_index, int sw_index); 1045 #ifdef CONFIG_PM_SLEEP 1046 int dsa_switch_suspend(struct dsa_switch *ds); 1047 int dsa_switch_resume(struct dsa_switch *ds); 1048 #else 1049 static inline int dsa_switch_suspend(struct dsa_switch *ds) 1050 { 1051 return 0; 1052 } 1053 static inline int dsa_switch_resume(struct dsa_switch *ds) 1054 { 1055 return 0; 1056 } 1057 #endif /* CONFIG_PM_SLEEP */ 1058 1059 #if IS_ENABLED(CONFIG_NET_DSA) 1060 bool dsa_slave_dev_check(const struct net_device *dev); 1061 #else 1062 static inline bool dsa_slave_dev_check(const struct net_device *dev) 1063 { 1064 return false; 1065 } 1066 #endif 1067 1068 netdev_tx_t dsa_enqueue_skb(struct sk_buff *skb, struct net_device *dev); 1069 int dsa_port_get_phy_strings(struct dsa_port *dp, uint8_t *data); 1070 int dsa_port_get_ethtool_phy_stats(struct dsa_port *dp, uint64_t *data); 1071 int dsa_port_get_phy_sset_count(struct dsa_port *dp); 1072 void dsa_port_phylink_mac_change(struct dsa_switch *ds, int port, bool up); 1073 1074 struct dsa_tag_driver { 1075 const struct dsa_device_ops *ops; 1076 struct list_head list; 1077 struct module *owner; 1078 }; 1079 1080 void dsa_tag_drivers_register(struct dsa_tag_driver *dsa_tag_driver_array[], 1081 unsigned int count, 1082 struct module *owner); 1083 void dsa_tag_drivers_unregister(struct dsa_tag_driver *dsa_tag_driver_array[], 1084 unsigned int count); 1085 1086 #define dsa_tag_driver_module_drivers(__dsa_tag_drivers_array, __count) \ 1087 static int __init dsa_tag_driver_module_init(void) \ 1088 { \ 1089 dsa_tag_drivers_register(__dsa_tag_drivers_array, __count, \ 1090 THIS_MODULE); \ 1091 return 0; \ 1092 } \ 1093 module_init(dsa_tag_driver_module_init); \ 1094 \ 1095 static void __exit dsa_tag_driver_module_exit(void) \ 1096 { \ 1097 dsa_tag_drivers_unregister(__dsa_tag_drivers_array, __count); \ 1098 } \ 1099 module_exit(dsa_tag_driver_module_exit) 1100 1101 /** 1102 * module_dsa_tag_drivers() - Helper macro for registering DSA tag 1103 * drivers 1104 * @__ops_array: Array of tag driver strucutres 1105 * 1106 * Helper macro for DSA tag drivers which do not do anything special 1107 * in module init/exit. Each module may only use this macro once, and 1108 * calling it replaces module_init() and module_exit(). 1109 */ 1110 #define module_dsa_tag_drivers(__ops_array) \ 1111 dsa_tag_driver_module_drivers(__ops_array, ARRAY_SIZE(__ops_array)) 1112 1113 #define DSA_TAG_DRIVER_NAME(__ops) dsa_tag_driver ## _ ## __ops 1114 1115 /* Create a static structure we can build a linked list of dsa_tag 1116 * drivers 1117 */ 1118 #define DSA_TAG_DRIVER(__ops) \ 1119 static struct dsa_tag_driver DSA_TAG_DRIVER_NAME(__ops) = { \ 1120 .ops = &__ops, \ 1121 } 1122 1123 /** 1124 * module_dsa_tag_driver() - Helper macro for registering a single DSA tag 1125 * driver 1126 * @__ops: Single tag driver structures 1127 * 1128 * Helper macro for DSA tag drivers which do not do anything special 1129 * in module init/exit. Each module may only use this macro once, and 1130 * calling it replaces module_init() and module_exit(). 1131 */ 1132 #define module_dsa_tag_driver(__ops) \ 1133 DSA_TAG_DRIVER(__ops); \ 1134 \ 1135 static struct dsa_tag_driver *dsa_tag_driver_array[] = { \ 1136 &DSA_TAG_DRIVER_NAME(__ops) \ 1137 }; \ 1138 module_dsa_tag_drivers(dsa_tag_driver_array) 1139 #endif 1140 1141