1 /* SPDX-License-Identifier: GPL-2.0-or-later */ 2 /* 3 * include/net/switchdev.h - Switch device API 4 * Copyright (c) 2014-2015 Jiri Pirko <jiri@resnulli.us> 5 * Copyright (c) 2014-2015 Scott Feldman <sfeldma@gmail.com> 6 */ 7 #ifndef _LINUX_SWITCHDEV_H_ 8 #define _LINUX_SWITCHDEV_H_ 9 10 #include <linux/netdevice.h> 11 #include <linux/notifier.h> 12 #include <linux/list.h> 13 #include <net/ip_fib.h> 14 15 #define SWITCHDEV_F_NO_RECURSE BIT(0) 16 #define SWITCHDEV_F_SKIP_EOPNOTSUPP BIT(1) 17 #define SWITCHDEV_F_DEFER BIT(2) 18 19 enum switchdev_attr_id { 20 SWITCHDEV_ATTR_ID_UNDEFINED, 21 SWITCHDEV_ATTR_ID_PORT_STP_STATE, 22 SWITCHDEV_ATTR_ID_PORT_MST_STATE, 23 SWITCHDEV_ATTR_ID_PORT_BRIDGE_FLAGS, 24 SWITCHDEV_ATTR_ID_PORT_PRE_BRIDGE_FLAGS, 25 SWITCHDEV_ATTR_ID_PORT_MROUTER, 26 SWITCHDEV_ATTR_ID_BRIDGE_AGEING_TIME, 27 SWITCHDEV_ATTR_ID_BRIDGE_VLAN_FILTERING, 28 SWITCHDEV_ATTR_ID_BRIDGE_VLAN_PROTOCOL, 29 SWITCHDEV_ATTR_ID_BRIDGE_MC_DISABLED, 30 SWITCHDEV_ATTR_ID_BRIDGE_MROUTER, 31 SWITCHDEV_ATTR_ID_BRIDGE_MST, 32 SWITCHDEV_ATTR_ID_MRP_PORT_ROLE, 33 SWITCHDEV_ATTR_ID_VLAN_MSTI, 34 }; 35 36 struct switchdev_mst_state { 37 u16 msti; 38 u8 state; 39 }; 40 41 struct switchdev_brport_flags { 42 unsigned long val; 43 unsigned long mask; 44 }; 45 46 struct switchdev_vlan_msti { 47 u16 vid; 48 u16 msti; 49 }; 50 51 struct switchdev_attr { 52 struct net_device *orig_dev; 53 enum switchdev_attr_id id; 54 u32 flags; 55 void *complete_priv; 56 void (*complete)(struct net_device *dev, int err, void *priv); 57 union { 58 u8 stp_state; /* PORT_STP_STATE */ 59 struct switchdev_mst_state mst_state; /* PORT_MST_STATE */ 60 struct switchdev_brport_flags brport_flags; /* PORT_BRIDGE_FLAGS */ 61 bool mrouter; /* PORT_MROUTER */ 62 clock_t ageing_time; /* BRIDGE_AGEING_TIME */ 63 bool vlan_filtering; /* BRIDGE_VLAN_FILTERING */ 64 u16 vlan_protocol; /* BRIDGE_VLAN_PROTOCOL */ 65 bool mst; /* BRIDGE_MST */ 66 bool mc_disabled; /* MC_DISABLED */ 67 u8 mrp_port_role; /* MRP_PORT_ROLE */ 68 struct switchdev_vlan_msti vlan_msti; /* VLAN_MSTI */ 69 } u; 70 }; 71 72 enum switchdev_obj_id { 73 SWITCHDEV_OBJ_ID_UNDEFINED, 74 SWITCHDEV_OBJ_ID_PORT_VLAN, 75 SWITCHDEV_OBJ_ID_PORT_MDB, 76 SWITCHDEV_OBJ_ID_HOST_MDB, 77 SWITCHDEV_OBJ_ID_MRP, 78 SWITCHDEV_OBJ_ID_RING_TEST_MRP, 79 SWITCHDEV_OBJ_ID_RING_ROLE_MRP, 80 SWITCHDEV_OBJ_ID_RING_STATE_MRP, 81 SWITCHDEV_OBJ_ID_IN_TEST_MRP, 82 SWITCHDEV_OBJ_ID_IN_ROLE_MRP, 83 SWITCHDEV_OBJ_ID_IN_STATE_MRP, 84 }; 85 86 struct switchdev_obj { 87 struct list_head list; 88 struct net_device *orig_dev; 89 enum switchdev_obj_id id; 90 u32 flags; 91 void *complete_priv; 92 void (*complete)(struct net_device *dev, int err, void *priv); 93 }; 94 95 /* SWITCHDEV_OBJ_ID_PORT_VLAN */ 96 struct switchdev_obj_port_vlan { 97 struct switchdev_obj obj; 98 u16 flags; 99 u16 vid; 100 /* If set, the notifier signifies a change of one of the following 101 * flags for a VLAN that already exists: 102 * - BRIDGE_VLAN_INFO_PVID 103 * - BRIDGE_VLAN_INFO_UNTAGGED 104 * Entries with BRIDGE_VLAN_INFO_BRENTRY unset are not notified at all. 105 */ 106 bool changed; 107 }; 108 109 #define SWITCHDEV_OBJ_PORT_VLAN(OBJ) \ 110 container_of((OBJ), struct switchdev_obj_port_vlan, obj) 111 112 /* SWITCHDEV_OBJ_ID_PORT_MDB */ 113 struct switchdev_obj_port_mdb { 114 struct switchdev_obj obj; 115 unsigned char addr[ETH_ALEN]; 116 u16 vid; 117 }; 118 119 #define SWITCHDEV_OBJ_PORT_MDB(OBJ) \ 120 container_of((OBJ), struct switchdev_obj_port_mdb, obj) 121 122 123 /* SWITCHDEV_OBJ_ID_MRP */ 124 struct switchdev_obj_mrp { 125 struct switchdev_obj obj; 126 struct net_device *p_port; 127 struct net_device *s_port; 128 u32 ring_id; 129 u16 prio; 130 }; 131 132 #define SWITCHDEV_OBJ_MRP(OBJ) \ 133 container_of((OBJ), struct switchdev_obj_mrp, obj) 134 135 /* SWITCHDEV_OBJ_ID_RING_TEST_MRP */ 136 struct switchdev_obj_ring_test_mrp { 137 struct switchdev_obj obj; 138 /* The value is in us and a value of 0 represents to stop */ 139 u32 interval; 140 u8 max_miss; 141 u32 ring_id; 142 u32 period; 143 bool monitor; 144 }; 145 146 #define SWITCHDEV_OBJ_RING_TEST_MRP(OBJ) \ 147 container_of((OBJ), struct switchdev_obj_ring_test_mrp, obj) 148 149 /* SWICHDEV_OBJ_ID_RING_ROLE_MRP */ 150 struct switchdev_obj_ring_role_mrp { 151 struct switchdev_obj obj; 152 u8 ring_role; 153 u32 ring_id; 154 u8 sw_backup; 155 }; 156 157 #define SWITCHDEV_OBJ_RING_ROLE_MRP(OBJ) \ 158 container_of((OBJ), struct switchdev_obj_ring_role_mrp, obj) 159 160 struct switchdev_obj_ring_state_mrp { 161 struct switchdev_obj obj; 162 u8 ring_state; 163 u32 ring_id; 164 }; 165 166 #define SWITCHDEV_OBJ_RING_STATE_MRP(OBJ) \ 167 container_of((OBJ), struct switchdev_obj_ring_state_mrp, obj) 168 169 /* SWITCHDEV_OBJ_ID_IN_TEST_MRP */ 170 struct switchdev_obj_in_test_mrp { 171 struct switchdev_obj obj; 172 /* The value is in us and a value of 0 represents to stop */ 173 u32 interval; 174 u32 in_id; 175 u32 period; 176 u8 max_miss; 177 }; 178 179 #define SWITCHDEV_OBJ_IN_TEST_MRP(OBJ) \ 180 container_of((OBJ), struct switchdev_obj_in_test_mrp, obj) 181 182 /* SWICHDEV_OBJ_ID_IN_ROLE_MRP */ 183 struct switchdev_obj_in_role_mrp { 184 struct switchdev_obj obj; 185 struct net_device *i_port; 186 u32 ring_id; 187 u16 in_id; 188 u8 in_role; 189 u8 sw_backup; 190 }; 191 192 #define SWITCHDEV_OBJ_IN_ROLE_MRP(OBJ) \ 193 container_of((OBJ), struct switchdev_obj_in_role_mrp, obj) 194 195 struct switchdev_obj_in_state_mrp { 196 struct switchdev_obj obj; 197 u32 in_id; 198 u8 in_state; 199 }; 200 201 #define SWITCHDEV_OBJ_IN_STATE_MRP(OBJ) \ 202 container_of((OBJ), struct switchdev_obj_in_state_mrp, obj) 203 204 typedef int switchdev_obj_dump_cb_t(struct switchdev_obj *obj); 205 206 struct switchdev_brport { 207 struct net_device *dev; 208 const void *ctx; 209 struct notifier_block *atomic_nb; 210 struct notifier_block *blocking_nb; 211 bool tx_fwd_offload; 212 }; 213 214 enum switchdev_notifier_type { 215 SWITCHDEV_FDB_ADD_TO_BRIDGE = 1, 216 SWITCHDEV_FDB_DEL_TO_BRIDGE, 217 SWITCHDEV_FDB_ADD_TO_DEVICE, 218 SWITCHDEV_FDB_DEL_TO_DEVICE, 219 SWITCHDEV_FDB_OFFLOADED, 220 SWITCHDEV_FDB_FLUSH_TO_BRIDGE, 221 222 SWITCHDEV_PORT_OBJ_ADD, /* Blocking. */ 223 SWITCHDEV_PORT_OBJ_DEL, /* Blocking. */ 224 SWITCHDEV_PORT_ATTR_SET, /* May be blocking . */ 225 226 SWITCHDEV_VXLAN_FDB_ADD_TO_BRIDGE, 227 SWITCHDEV_VXLAN_FDB_DEL_TO_BRIDGE, 228 SWITCHDEV_VXLAN_FDB_ADD_TO_DEVICE, 229 SWITCHDEV_VXLAN_FDB_DEL_TO_DEVICE, 230 SWITCHDEV_VXLAN_FDB_OFFLOADED, 231 232 SWITCHDEV_BRPORT_OFFLOADED, 233 SWITCHDEV_BRPORT_UNOFFLOADED, 234 SWITCHDEV_BRPORT_REPLAY, 235 }; 236 237 struct switchdev_notifier_info { 238 struct net_device *dev; 239 struct netlink_ext_ack *extack; 240 const void *ctx; 241 }; 242 243 /* Remember to update br_switchdev_fdb_populate() when adding 244 * new members to this structure 245 */ 246 struct switchdev_notifier_fdb_info { 247 struct switchdev_notifier_info info; /* must be first */ 248 const unsigned char *addr; 249 u16 vid; 250 u8 added_by_user:1, 251 is_local:1, 252 locked:1, 253 offloaded:1; 254 }; 255 256 struct switchdev_notifier_port_obj_info { 257 struct switchdev_notifier_info info; /* must be first */ 258 const struct switchdev_obj *obj; 259 bool handled; 260 }; 261 262 struct switchdev_notifier_port_attr_info { 263 struct switchdev_notifier_info info; /* must be first */ 264 const struct switchdev_attr *attr; 265 bool handled; 266 }; 267 268 struct switchdev_notifier_brport_info { 269 struct switchdev_notifier_info info; /* must be first */ 270 const struct switchdev_brport brport; 271 }; 272 273 static inline struct net_device * 274 switchdev_notifier_info_to_dev(const struct switchdev_notifier_info *info) 275 { 276 return info->dev; 277 } 278 279 static inline struct netlink_ext_ack * 280 switchdev_notifier_info_to_extack(const struct switchdev_notifier_info *info) 281 { 282 return info->extack; 283 } 284 285 static inline bool 286 switchdev_fdb_is_dynamically_learned(const struct switchdev_notifier_fdb_info *fdb_info) 287 { 288 return !fdb_info->added_by_user && !fdb_info->is_local; 289 } 290 291 #ifdef CONFIG_NET_SWITCHDEV 292 293 int switchdev_bridge_port_offload(struct net_device *brport_dev, 294 struct net_device *dev, const void *ctx, 295 struct notifier_block *atomic_nb, 296 struct notifier_block *blocking_nb, 297 bool tx_fwd_offload, 298 struct netlink_ext_ack *extack); 299 void switchdev_bridge_port_unoffload(struct net_device *brport_dev, 300 const void *ctx, 301 struct notifier_block *atomic_nb, 302 struct notifier_block *blocking_nb); 303 int switchdev_bridge_port_replay(struct net_device *brport_dev, 304 struct net_device *dev, const void *ctx, 305 struct notifier_block *atomic_nb, 306 struct notifier_block *blocking_nb, 307 struct netlink_ext_ack *extack); 308 309 void switchdev_deferred_process(void); 310 int switchdev_port_attr_set(struct net_device *dev, 311 const struct switchdev_attr *attr, 312 struct netlink_ext_ack *extack); 313 int switchdev_port_obj_add(struct net_device *dev, 314 const struct switchdev_obj *obj, 315 struct netlink_ext_ack *extack); 316 int switchdev_port_obj_del(struct net_device *dev, 317 const struct switchdev_obj *obj); 318 319 int register_switchdev_notifier(struct notifier_block *nb); 320 int unregister_switchdev_notifier(struct notifier_block *nb); 321 int call_switchdev_notifiers(unsigned long val, struct net_device *dev, 322 struct switchdev_notifier_info *info, 323 struct netlink_ext_ack *extack); 324 325 int register_switchdev_blocking_notifier(struct notifier_block *nb); 326 int unregister_switchdev_blocking_notifier(struct notifier_block *nb); 327 int call_switchdev_blocking_notifiers(unsigned long val, struct net_device *dev, 328 struct switchdev_notifier_info *info, 329 struct netlink_ext_ack *extack); 330 331 void switchdev_port_fwd_mark_set(struct net_device *dev, 332 struct net_device *group_dev, 333 bool joining); 334 335 int switchdev_handle_fdb_event_to_device(struct net_device *dev, unsigned long event, 336 const struct switchdev_notifier_fdb_info *fdb_info, 337 bool (*check_cb)(const struct net_device *dev), 338 bool (*foreign_dev_check_cb)(const struct net_device *dev, 339 const struct net_device *foreign_dev), 340 int (*mod_cb)(struct net_device *dev, struct net_device *orig_dev, 341 unsigned long event, const void *ctx, 342 const struct switchdev_notifier_fdb_info *fdb_info)); 343 344 int switchdev_handle_port_obj_add(struct net_device *dev, 345 struct switchdev_notifier_port_obj_info *port_obj_info, 346 bool (*check_cb)(const struct net_device *dev), 347 int (*add_cb)(struct net_device *dev, const void *ctx, 348 const struct switchdev_obj *obj, 349 struct netlink_ext_ack *extack)); 350 int switchdev_handle_port_obj_add_foreign(struct net_device *dev, 351 struct switchdev_notifier_port_obj_info *port_obj_info, 352 bool (*check_cb)(const struct net_device *dev), 353 bool (*foreign_dev_check_cb)(const struct net_device *dev, 354 const struct net_device *foreign_dev), 355 int (*add_cb)(struct net_device *dev, const void *ctx, 356 const struct switchdev_obj *obj, 357 struct netlink_ext_ack *extack)); 358 int switchdev_handle_port_obj_del(struct net_device *dev, 359 struct switchdev_notifier_port_obj_info *port_obj_info, 360 bool (*check_cb)(const struct net_device *dev), 361 int (*del_cb)(struct net_device *dev, const void *ctx, 362 const struct switchdev_obj *obj)); 363 int switchdev_handle_port_obj_del_foreign(struct net_device *dev, 364 struct switchdev_notifier_port_obj_info *port_obj_info, 365 bool (*check_cb)(const struct net_device *dev), 366 bool (*foreign_dev_check_cb)(const struct net_device *dev, 367 const struct net_device *foreign_dev), 368 int (*del_cb)(struct net_device *dev, const void *ctx, 369 const struct switchdev_obj *obj)); 370 371 int switchdev_handle_port_attr_set(struct net_device *dev, 372 struct switchdev_notifier_port_attr_info *port_attr_info, 373 bool (*check_cb)(const struct net_device *dev), 374 int (*set_cb)(struct net_device *dev, const void *ctx, 375 const struct switchdev_attr *attr, 376 struct netlink_ext_ack *extack)); 377 #else 378 379 static inline int 380 switchdev_bridge_port_offload(struct net_device *brport_dev, 381 struct net_device *dev, const void *ctx, 382 struct notifier_block *atomic_nb, 383 struct notifier_block *blocking_nb, 384 bool tx_fwd_offload, 385 struct netlink_ext_ack *extack) 386 { 387 return -EOPNOTSUPP; 388 } 389 390 static inline void 391 switchdev_bridge_port_unoffload(struct net_device *brport_dev, 392 const void *ctx, 393 struct notifier_block *atomic_nb, 394 struct notifier_block *blocking_nb) 395 { 396 } 397 398 static inline void switchdev_deferred_process(void) 399 { 400 } 401 402 static inline int switchdev_port_attr_set(struct net_device *dev, 403 const struct switchdev_attr *attr, 404 struct netlink_ext_ack *extack) 405 { 406 return -EOPNOTSUPP; 407 } 408 409 static inline int switchdev_port_obj_add(struct net_device *dev, 410 const struct switchdev_obj *obj, 411 struct netlink_ext_ack *extack) 412 { 413 return -EOPNOTSUPP; 414 } 415 416 static inline int switchdev_port_obj_del(struct net_device *dev, 417 const struct switchdev_obj *obj) 418 { 419 return -EOPNOTSUPP; 420 } 421 422 static inline int register_switchdev_notifier(struct notifier_block *nb) 423 { 424 return 0; 425 } 426 427 static inline int unregister_switchdev_notifier(struct notifier_block *nb) 428 { 429 return 0; 430 } 431 432 static inline int call_switchdev_notifiers(unsigned long val, 433 struct net_device *dev, 434 struct switchdev_notifier_info *info, 435 struct netlink_ext_ack *extack) 436 { 437 return NOTIFY_DONE; 438 } 439 440 static inline int 441 register_switchdev_blocking_notifier(struct notifier_block *nb) 442 { 443 return 0; 444 } 445 446 static inline int 447 unregister_switchdev_blocking_notifier(struct notifier_block *nb) 448 { 449 return 0; 450 } 451 452 static inline int 453 call_switchdev_blocking_notifiers(unsigned long val, 454 struct net_device *dev, 455 struct switchdev_notifier_info *info, 456 struct netlink_ext_ack *extack) 457 { 458 return NOTIFY_DONE; 459 } 460 461 static inline int 462 switchdev_handle_fdb_event_to_device(struct net_device *dev, unsigned long event, 463 const struct switchdev_notifier_fdb_info *fdb_info, 464 bool (*check_cb)(const struct net_device *dev), 465 bool (*foreign_dev_check_cb)(const struct net_device *dev, 466 const struct net_device *foreign_dev), 467 int (*mod_cb)(struct net_device *dev, struct net_device *orig_dev, 468 unsigned long event, const void *ctx, 469 const struct switchdev_notifier_fdb_info *fdb_info)) 470 { 471 return 0; 472 } 473 474 static inline int 475 switchdev_handle_port_obj_add(struct net_device *dev, 476 struct switchdev_notifier_port_obj_info *port_obj_info, 477 bool (*check_cb)(const struct net_device *dev), 478 int (*add_cb)(struct net_device *dev, const void *ctx, 479 const struct switchdev_obj *obj, 480 struct netlink_ext_ack *extack)) 481 { 482 return 0; 483 } 484 485 static inline int switchdev_handle_port_obj_add_foreign(struct net_device *dev, 486 struct switchdev_notifier_port_obj_info *port_obj_info, 487 bool (*check_cb)(const struct net_device *dev), 488 bool (*foreign_dev_check_cb)(const struct net_device *dev, 489 const struct net_device *foreign_dev), 490 int (*add_cb)(struct net_device *dev, const void *ctx, 491 const struct switchdev_obj *obj, 492 struct netlink_ext_ack *extack)) 493 { 494 return 0; 495 } 496 497 static inline int 498 switchdev_handle_port_obj_del(struct net_device *dev, 499 struct switchdev_notifier_port_obj_info *port_obj_info, 500 bool (*check_cb)(const struct net_device *dev), 501 int (*del_cb)(struct net_device *dev, const void *ctx, 502 const struct switchdev_obj *obj)) 503 { 504 return 0; 505 } 506 507 static inline int 508 switchdev_handle_port_obj_del_foreign(struct net_device *dev, 509 struct switchdev_notifier_port_obj_info *port_obj_info, 510 bool (*check_cb)(const struct net_device *dev), 511 bool (*foreign_dev_check_cb)(const struct net_device *dev, 512 const struct net_device *foreign_dev), 513 int (*del_cb)(struct net_device *dev, const void *ctx, 514 const struct switchdev_obj *obj)) 515 { 516 return 0; 517 } 518 519 static inline int 520 switchdev_handle_port_attr_set(struct net_device *dev, 521 struct switchdev_notifier_port_attr_info *port_attr_info, 522 bool (*check_cb)(const struct net_device *dev), 523 int (*set_cb)(struct net_device *dev, const void *ctx, 524 const struct switchdev_attr *attr, 525 struct netlink_ext_ack *extack)) 526 { 527 return 0; 528 } 529 #endif 530 531 #endif /* _LINUX_SWITCHDEV_H_ */ 532