1 /* 2 * include/net/dsa.h - Driver for Distributed Switch Architecture switch chips 3 * Copyright (c) 2008-2009 Marvell Semiconductor 4 * 5 * This program is free software; you can redistribute it and/or modify 6 * it under the terms of the GNU General Public License as published by 7 * the Free Software Foundation; either version 2 of the License, or 8 * (at your option) any later version. 9 */ 10 11 #ifndef __LINUX_NET_DSA_H 12 #define __LINUX_NET_DSA_H 13 14 #include <linux/if.h> 15 #include <linux/if_ether.h> 16 #include <linux/list.h> 17 #include <linux/notifier.h> 18 #include <linux/timer.h> 19 #include <linux/workqueue.h> 20 #include <linux/of.h> 21 #include <linux/ethtool.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 29 enum dsa_tag_protocol { 30 DSA_TAG_PROTO_NONE = 0, 31 DSA_TAG_PROTO_BRCM, 32 DSA_TAG_PROTO_DSA, 33 DSA_TAG_PROTO_EDSA, 34 DSA_TAG_PROTO_KSZ, 35 DSA_TAG_PROTO_LAN9303, 36 DSA_TAG_PROTO_MTK, 37 DSA_TAG_PROTO_QCA, 38 DSA_TAG_PROTO_TRAILER, 39 DSA_TAG_LAST, /* MUST BE LAST */ 40 }; 41 42 #define DSA_MAX_SWITCHES 4 43 #define DSA_MAX_PORTS 12 44 45 #define DSA_RTABLE_NONE -1 46 47 struct dsa_chip_data { 48 /* 49 * How to access the switch configuration registers. 50 */ 51 struct device *host_dev; 52 int sw_addr; 53 54 /* 55 * Reference to network devices 56 */ 57 struct device *netdev[DSA_MAX_PORTS]; 58 59 /* set to size of eeprom if supported by the switch */ 60 int eeprom_len; 61 62 /* Device tree node pointer for this specific switch chip 63 * used during switch setup in case additional properties 64 * and resources needs to be used 65 */ 66 struct device_node *of_node; 67 68 /* 69 * The names of the switch's ports. Use "cpu" to 70 * designate the switch port that the cpu is connected to, 71 * "dsa" to indicate that this port is a DSA link to 72 * another switch, NULL to indicate the port is unused, 73 * or any other string to indicate this is a physical port. 74 */ 75 char *port_names[DSA_MAX_PORTS]; 76 struct device_node *port_dn[DSA_MAX_PORTS]; 77 78 /* 79 * An array of which element [a] indicates which port on this 80 * switch should be used to send packets to that are destined 81 * for switch a. Can be NULL if there is only one switch chip. 82 */ 83 s8 rtable[DSA_MAX_SWITCHES]; 84 }; 85 86 struct dsa_platform_data { 87 /* 88 * Reference to a Linux network interface that connects 89 * to the root switch chip of the tree. 90 */ 91 struct device *netdev; 92 struct net_device *of_netdev; 93 94 /* 95 * Info structs describing each of the switch chips 96 * connected via this network interface. 97 */ 98 int nr_chips; 99 struct dsa_chip_data *chip; 100 }; 101 102 struct packet_type; 103 104 struct dsa_device_ops { 105 struct sk_buff *(*xmit)(struct sk_buff *skb, struct net_device *dev); 106 struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev, 107 struct packet_type *pt); 108 int (*flow_dissect)(const struct sk_buff *skb, __be16 *proto, 109 int *offset); 110 }; 111 112 struct dsa_switch_tree { 113 struct list_head list; 114 115 /* Notifier chain for switch-wide events */ 116 struct raw_notifier_head nh; 117 118 /* Tree identifier */ 119 u32 tree; 120 121 /* Number of switches attached to this tree */ 122 struct kref refcount; 123 124 /* Has this tree been applied to the hardware? */ 125 bool applied; 126 127 /* 128 * Configuration data for the platform device that owns 129 * this dsa switch tree instance. 130 */ 131 struct dsa_platform_data *pd; 132 133 /* 134 * The switch port to which the CPU is attached. 135 */ 136 struct dsa_port *cpu_dp; 137 138 /* 139 * Data for the individual switch chips. 140 */ 141 struct dsa_switch *ds[DSA_MAX_SWITCHES]; 142 }; 143 144 /* TC matchall action types, only mirroring for now */ 145 enum dsa_port_mall_action_type { 146 DSA_PORT_MALL_MIRROR, 147 }; 148 149 /* TC mirroring entry */ 150 struct dsa_mall_mirror_tc_entry { 151 u8 to_local_port; 152 bool ingress; 153 }; 154 155 /* TC matchall entry */ 156 struct dsa_mall_tc_entry { 157 struct list_head list; 158 unsigned long cookie; 159 enum dsa_port_mall_action_type type; 160 union { 161 struct dsa_mall_mirror_tc_entry mirror; 162 }; 163 }; 164 165 166 struct dsa_port { 167 /* A CPU port is physically connected to a master device. 168 * A user port exposed to userspace has a slave device. 169 */ 170 union { 171 struct net_device *master; 172 struct net_device *slave; 173 }; 174 175 /* CPU port tagging operations used by master or slave devices */ 176 const struct dsa_device_ops *tag_ops; 177 178 /* Copies for faster access in master receive hot path */ 179 struct dsa_switch_tree *dst; 180 struct sk_buff *(*rcv)(struct sk_buff *skb, struct net_device *dev, 181 struct packet_type *pt); 182 183 struct dsa_switch *ds; 184 unsigned int index; 185 const char *name; 186 struct dsa_port *cpu_dp; 187 struct device_node *dn; 188 unsigned int ageing_time; 189 u8 stp_state; 190 struct net_device *bridge_dev; 191 struct devlink_port devlink_port; 192 /* 193 * Original copy of the master netdev ethtool_ops 194 */ 195 const struct ethtool_ops *orig_ethtool_ops; 196 }; 197 198 struct dsa_switch { 199 struct device *dev; 200 201 /* 202 * Parent switch tree, and switch index. 203 */ 204 struct dsa_switch_tree *dst; 205 int index; 206 207 /* Listener for switch fabric events */ 208 struct notifier_block nb; 209 210 /* 211 * Give the switch driver somewhere to hang its private data 212 * structure. 213 */ 214 void *priv; 215 216 /* 217 * Configuration data for this switch. 218 */ 219 struct dsa_chip_data *cd; 220 221 /* 222 * The switch operations. 223 */ 224 const struct dsa_switch_ops *ops; 225 226 /* 227 * An array of which element [a] indicates which port on this 228 * switch should be used to send packets to that are destined 229 * for switch a. Can be NULL if there is only one switch chip. 230 */ 231 s8 rtable[DSA_MAX_SWITCHES]; 232 233 /* 234 * Slave mii_bus and devices for the individual ports. 235 */ 236 u32 dsa_port_mask; 237 u32 cpu_port_mask; 238 u32 enabled_port_mask; 239 u32 phys_mii_mask; 240 struct mii_bus *slave_mii_bus; 241 242 /* Ageing Time limits in msecs */ 243 unsigned int ageing_time_min; 244 unsigned int ageing_time_max; 245 246 /* devlink used to represent this switch device */ 247 struct devlink *devlink; 248 249 /* Number of switch port queues */ 250 unsigned int num_tx_queues; 251 252 /* Dynamically allocated ports, keep last */ 253 size_t num_ports; 254 struct dsa_port ports[]; 255 }; 256 257 static inline bool dsa_is_cpu_port(struct dsa_switch *ds, int p) 258 { 259 return !!(ds->cpu_port_mask & (1 << p)); 260 } 261 262 static inline bool dsa_is_dsa_port(struct dsa_switch *ds, int p) 263 { 264 return !!((ds->dsa_port_mask) & (1 << p)); 265 } 266 267 static inline bool dsa_is_normal_port(struct dsa_switch *ds, int p) 268 { 269 return !dsa_is_cpu_port(ds, p) && !dsa_is_dsa_port(ds, p); 270 } 271 272 static inline const struct dsa_port *dsa_to_port(struct dsa_switch *ds, int p) 273 { 274 return &ds->ports[p]; 275 } 276 277 static inline u8 dsa_upstream_port(struct dsa_switch *ds) 278 { 279 struct dsa_switch_tree *dst = ds->dst; 280 281 /* 282 * If this is the root switch (i.e. the switch that connects 283 * to the CPU), return the cpu port number on this switch. 284 * Else return the (DSA) port number that connects to the 285 * switch that is one hop closer to the cpu. 286 */ 287 if (dst->cpu_dp->ds == ds) 288 return dst->cpu_dp->index; 289 else 290 return ds->rtable[dst->cpu_dp->ds->index]; 291 } 292 293 typedef int dsa_fdb_dump_cb_t(const unsigned char *addr, u16 vid, 294 bool is_static, void *data); 295 struct dsa_switch_ops { 296 /* 297 * Legacy probing. 298 */ 299 const char *(*probe)(struct device *dsa_dev, 300 struct device *host_dev, int sw_addr, 301 void **priv); 302 303 enum dsa_tag_protocol (*get_tag_protocol)(struct dsa_switch *ds); 304 305 int (*setup)(struct dsa_switch *ds); 306 u32 (*get_phy_flags)(struct dsa_switch *ds, int port); 307 308 /* 309 * Access to the switch's PHY registers. 310 */ 311 int (*phy_read)(struct dsa_switch *ds, int port, int regnum); 312 int (*phy_write)(struct dsa_switch *ds, int port, 313 int regnum, u16 val); 314 315 /* 316 * Link state adjustment (called from libphy) 317 */ 318 void (*adjust_link)(struct dsa_switch *ds, int port, 319 struct phy_device *phydev); 320 void (*fixed_link_update)(struct dsa_switch *ds, int port, 321 struct fixed_phy_status *st); 322 323 /* 324 * ethtool hardware statistics. 325 */ 326 void (*get_strings)(struct dsa_switch *ds, int port, uint8_t *data); 327 void (*get_ethtool_stats)(struct dsa_switch *ds, 328 int port, uint64_t *data); 329 int (*get_sset_count)(struct dsa_switch *ds); 330 331 /* 332 * ethtool Wake-on-LAN 333 */ 334 void (*get_wol)(struct dsa_switch *ds, int port, 335 struct ethtool_wolinfo *w); 336 int (*set_wol)(struct dsa_switch *ds, int port, 337 struct ethtool_wolinfo *w); 338 339 /* 340 * Suspend and resume 341 */ 342 int (*suspend)(struct dsa_switch *ds); 343 int (*resume)(struct dsa_switch *ds); 344 345 /* 346 * Port enable/disable 347 */ 348 int (*port_enable)(struct dsa_switch *ds, int port, 349 struct phy_device *phy); 350 void (*port_disable)(struct dsa_switch *ds, int port, 351 struct phy_device *phy); 352 353 /* 354 * Port's MAC EEE settings 355 */ 356 int (*set_mac_eee)(struct dsa_switch *ds, int port, 357 struct ethtool_eee *e); 358 int (*get_mac_eee)(struct dsa_switch *ds, int port, 359 struct ethtool_eee *e); 360 361 /* EEPROM access */ 362 int (*get_eeprom_len)(struct dsa_switch *ds); 363 int (*get_eeprom)(struct dsa_switch *ds, 364 struct ethtool_eeprom *eeprom, u8 *data); 365 int (*set_eeprom)(struct dsa_switch *ds, 366 struct ethtool_eeprom *eeprom, u8 *data); 367 368 /* 369 * Register access. 370 */ 371 int (*get_regs_len)(struct dsa_switch *ds, int port); 372 void (*get_regs)(struct dsa_switch *ds, int port, 373 struct ethtool_regs *regs, void *p); 374 375 /* 376 * Bridge integration 377 */ 378 int (*set_ageing_time)(struct dsa_switch *ds, unsigned int msecs); 379 int (*port_bridge_join)(struct dsa_switch *ds, int port, 380 struct net_device *bridge); 381 void (*port_bridge_leave)(struct dsa_switch *ds, int port, 382 struct net_device *bridge); 383 void (*port_stp_state_set)(struct dsa_switch *ds, int port, 384 u8 state); 385 void (*port_fast_age)(struct dsa_switch *ds, int port); 386 387 /* 388 * VLAN support 389 */ 390 int (*port_vlan_filtering)(struct dsa_switch *ds, int port, 391 bool vlan_filtering); 392 int (*port_vlan_prepare)(struct dsa_switch *ds, int port, 393 const struct switchdev_obj_port_vlan *vlan, 394 struct switchdev_trans *trans); 395 void (*port_vlan_add)(struct dsa_switch *ds, int port, 396 const struct switchdev_obj_port_vlan *vlan, 397 struct switchdev_trans *trans); 398 int (*port_vlan_del)(struct dsa_switch *ds, int port, 399 const struct switchdev_obj_port_vlan *vlan); 400 /* 401 * Forwarding database 402 */ 403 int (*port_fdb_add)(struct dsa_switch *ds, int port, 404 const unsigned char *addr, u16 vid); 405 int (*port_fdb_del)(struct dsa_switch *ds, int port, 406 const unsigned char *addr, u16 vid); 407 int (*port_fdb_dump)(struct dsa_switch *ds, int port, 408 dsa_fdb_dump_cb_t *cb, void *data); 409 410 /* 411 * Multicast database 412 */ 413 int (*port_mdb_prepare)(struct dsa_switch *ds, int port, 414 const struct switchdev_obj_port_mdb *mdb, 415 struct switchdev_trans *trans); 416 void (*port_mdb_add)(struct dsa_switch *ds, int port, 417 const struct switchdev_obj_port_mdb *mdb, 418 struct switchdev_trans *trans); 419 int (*port_mdb_del)(struct dsa_switch *ds, int port, 420 const struct switchdev_obj_port_mdb *mdb); 421 /* 422 * RXNFC 423 */ 424 int (*get_rxnfc)(struct dsa_switch *ds, int port, 425 struct ethtool_rxnfc *nfc, u32 *rule_locs); 426 int (*set_rxnfc)(struct dsa_switch *ds, int port, 427 struct ethtool_rxnfc *nfc); 428 429 /* 430 * TC integration 431 */ 432 int (*port_mirror_add)(struct dsa_switch *ds, int port, 433 struct dsa_mall_mirror_tc_entry *mirror, 434 bool ingress); 435 void (*port_mirror_del)(struct dsa_switch *ds, int port, 436 struct dsa_mall_mirror_tc_entry *mirror); 437 438 /* 439 * Cross-chip operations 440 */ 441 int (*crosschip_bridge_join)(struct dsa_switch *ds, int sw_index, 442 int port, struct net_device *br); 443 void (*crosschip_bridge_leave)(struct dsa_switch *ds, int sw_index, 444 int port, struct net_device *br); 445 }; 446 447 struct dsa_switch_driver { 448 struct list_head list; 449 const struct dsa_switch_ops *ops; 450 }; 451 452 /* Legacy driver registration */ 453 void register_switch_driver(struct dsa_switch_driver *type); 454 void unregister_switch_driver(struct dsa_switch_driver *type); 455 struct mii_bus *dsa_host_dev_to_mii_bus(struct device *dev); 456 457 struct net_device *dsa_dev_to_net_device(struct device *dev); 458 459 /* Keep inline for faster access in hot path */ 460 static inline bool netdev_uses_dsa(struct net_device *dev) 461 { 462 #if IS_ENABLED(CONFIG_NET_DSA) 463 return dev->dsa_ptr && dev->dsa_ptr->rcv; 464 #endif 465 return false; 466 } 467 468 struct dsa_switch *dsa_switch_alloc(struct device *dev, size_t n); 469 void dsa_unregister_switch(struct dsa_switch *ds); 470 int dsa_register_switch(struct dsa_switch *ds); 471 #ifdef CONFIG_PM_SLEEP 472 int dsa_switch_suspend(struct dsa_switch *ds); 473 int dsa_switch_resume(struct dsa_switch *ds); 474 #else 475 static inline int dsa_switch_suspend(struct dsa_switch *ds) 476 { 477 return 0; 478 } 479 static inline int dsa_switch_resume(struct dsa_switch *ds) 480 { 481 return 0; 482 } 483 #endif /* CONFIG_PM_SLEEP */ 484 485 enum dsa_notifier_type { 486 DSA_PORT_REGISTER, 487 DSA_PORT_UNREGISTER, 488 }; 489 490 struct dsa_notifier_info { 491 struct net_device *dev; 492 }; 493 494 struct dsa_notifier_register_info { 495 struct dsa_notifier_info info; /* must be first */ 496 struct net_device *master; 497 unsigned int port_number; 498 unsigned int switch_number; 499 }; 500 501 static inline struct net_device * 502 dsa_notifier_info_to_dev(const struct dsa_notifier_info *info) 503 { 504 return info->dev; 505 } 506 507 #if IS_ENABLED(CONFIG_NET_DSA) 508 int register_dsa_notifier(struct notifier_block *nb); 509 int unregister_dsa_notifier(struct notifier_block *nb); 510 int call_dsa_notifiers(unsigned long val, struct net_device *dev, 511 struct dsa_notifier_info *info); 512 #else 513 static inline int register_dsa_notifier(struct notifier_block *nb) 514 { 515 return 0; 516 } 517 518 static inline int unregister_dsa_notifier(struct notifier_block *nb) 519 { 520 return 0; 521 } 522 523 static inline int call_dsa_notifiers(unsigned long val, struct net_device *dev, 524 struct dsa_notifier_info *info) 525 { 526 return NOTIFY_DONE; 527 } 528 #endif 529 530 /* Broadcom tag specific helpers to insert and extract queue/port number */ 531 #define BRCM_TAG_SET_PORT_QUEUE(p, q) ((p) << 8 | q) 532 #define BRCM_TAG_GET_PORT(v) ((v) >> 8) 533 #define BRCM_TAG_GET_QUEUE(v) ((v) & 0xff) 534 535 #endif 536