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 }; 235 236 struct switchdev_notifier_info { 237 struct net_device *dev; 238 struct netlink_ext_ack *extack; 239 const void *ctx; 240 }; 241 242 /* Remember to update br_switchdev_fdb_populate() when adding 243 * new members to this structure 244 */ 245 struct switchdev_notifier_fdb_info { 246 struct switchdev_notifier_info info; /* must be first */ 247 const unsigned char *addr; 248 u16 vid; 249 u8 added_by_user:1, 250 is_local:1, 251 offloaded:1; 252 }; 253 254 struct switchdev_notifier_port_obj_info { 255 struct switchdev_notifier_info info; /* must be first */ 256 const struct switchdev_obj *obj; 257 bool handled; 258 }; 259 260 struct switchdev_notifier_port_attr_info { 261 struct switchdev_notifier_info info; /* must be first */ 262 const struct switchdev_attr *attr; 263 bool handled; 264 }; 265 266 struct switchdev_notifier_brport_info { 267 struct switchdev_notifier_info info; /* must be first */ 268 const struct switchdev_brport brport; 269 }; 270 271 static inline struct net_device * 272 switchdev_notifier_info_to_dev(const struct switchdev_notifier_info *info) 273 { 274 return info->dev; 275 } 276 277 static inline struct netlink_ext_ack * 278 switchdev_notifier_info_to_extack(const struct switchdev_notifier_info *info) 279 { 280 return info->extack; 281 } 282 283 static inline bool 284 switchdev_fdb_is_dynamically_learned(const struct switchdev_notifier_fdb_info *fdb_info) 285 { 286 return !fdb_info->added_by_user && !fdb_info->is_local; 287 } 288 289 #ifdef CONFIG_NET_SWITCHDEV 290 291 int switchdev_bridge_port_offload(struct net_device *brport_dev, 292 struct net_device *dev, const void *ctx, 293 struct notifier_block *atomic_nb, 294 struct notifier_block *blocking_nb, 295 bool tx_fwd_offload, 296 struct netlink_ext_ack *extack); 297 void switchdev_bridge_port_unoffload(struct net_device *brport_dev, 298 const void *ctx, 299 struct notifier_block *atomic_nb, 300 struct notifier_block *blocking_nb); 301 302 void switchdev_deferred_process(void); 303 int switchdev_port_attr_set(struct net_device *dev, 304 const struct switchdev_attr *attr, 305 struct netlink_ext_ack *extack); 306 int switchdev_port_obj_add(struct net_device *dev, 307 const struct switchdev_obj *obj, 308 struct netlink_ext_ack *extack); 309 int switchdev_port_obj_del(struct net_device *dev, 310 const struct switchdev_obj *obj); 311 312 int register_switchdev_notifier(struct notifier_block *nb); 313 int unregister_switchdev_notifier(struct notifier_block *nb); 314 int call_switchdev_notifiers(unsigned long val, struct net_device *dev, 315 struct switchdev_notifier_info *info, 316 struct netlink_ext_ack *extack); 317 318 int register_switchdev_blocking_notifier(struct notifier_block *nb); 319 int unregister_switchdev_blocking_notifier(struct notifier_block *nb); 320 int call_switchdev_blocking_notifiers(unsigned long val, struct net_device *dev, 321 struct switchdev_notifier_info *info, 322 struct netlink_ext_ack *extack); 323 324 void switchdev_port_fwd_mark_set(struct net_device *dev, 325 struct net_device *group_dev, 326 bool joining); 327 328 int switchdev_handle_fdb_event_to_device(struct net_device *dev, unsigned long event, 329 const struct switchdev_notifier_fdb_info *fdb_info, 330 bool (*check_cb)(const struct net_device *dev), 331 bool (*foreign_dev_check_cb)(const struct net_device *dev, 332 const struct net_device *foreign_dev), 333 int (*mod_cb)(struct net_device *dev, struct net_device *orig_dev, 334 unsigned long event, const void *ctx, 335 const struct switchdev_notifier_fdb_info *fdb_info)); 336 337 int switchdev_handle_port_obj_add(struct net_device *dev, 338 struct switchdev_notifier_port_obj_info *port_obj_info, 339 bool (*check_cb)(const struct net_device *dev), 340 int (*add_cb)(struct net_device *dev, const void *ctx, 341 const struct switchdev_obj *obj, 342 struct netlink_ext_ack *extack)); 343 int switchdev_handle_port_obj_add_foreign(struct net_device *dev, 344 struct switchdev_notifier_port_obj_info *port_obj_info, 345 bool (*check_cb)(const struct net_device *dev), 346 bool (*foreign_dev_check_cb)(const struct net_device *dev, 347 const struct net_device *foreign_dev), 348 int (*add_cb)(struct net_device *dev, const void *ctx, 349 const struct switchdev_obj *obj, 350 struct netlink_ext_ack *extack)); 351 int switchdev_handle_port_obj_del(struct net_device *dev, 352 struct switchdev_notifier_port_obj_info *port_obj_info, 353 bool (*check_cb)(const struct net_device *dev), 354 int (*del_cb)(struct net_device *dev, const void *ctx, 355 const struct switchdev_obj *obj)); 356 int switchdev_handle_port_obj_del_foreign(struct net_device *dev, 357 struct switchdev_notifier_port_obj_info *port_obj_info, 358 bool (*check_cb)(const struct net_device *dev), 359 bool (*foreign_dev_check_cb)(const struct net_device *dev, 360 const struct net_device *foreign_dev), 361 int (*del_cb)(struct net_device *dev, const void *ctx, 362 const struct switchdev_obj *obj)); 363 364 int switchdev_handle_port_attr_set(struct net_device *dev, 365 struct switchdev_notifier_port_attr_info *port_attr_info, 366 bool (*check_cb)(const struct net_device *dev), 367 int (*set_cb)(struct net_device *dev, const void *ctx, 368 const struct switchdev_attr *attr, 369 struct netlink_ext_ack *extack)); 370 #else 371 372 static inline int 373 switchdev_bridge_port_offload(struct net_device *brport_dev, 374 struct net_device *dev, const void *ctx, 375 struct notifier_block *atomic_nb, 376 struct notifier_block *blocking_nb, 377 bool tx_fwd_offload, 378 struct netlink_ext_ack *extack) 379 { 380 return -EOPNOTSUPP; 381 } 382 383 static inline void 384 switchdev_bridge_port_unoffload(struct net_device *brport_dev, 385 const void *ctx, 386 struct notifier_block *atomic_nb, 387 struct notifier_block *blocking_nb) 388 { 389 } 390 391 static inline void switchdev_deferred_process(void) 392 { 393 } 394 395 static inline int switchdev_port_attr_set(struct net_device *dev, 396 const struct switchdev_attr *attr, 397 struct netlink_ext_ack *extack) 398 { 399 return -EOPNOTSUPP; 400 } 401 402 static inline int switchdev_port_obj_add(struct net_device *dev, 403 const struct switchdev_obj *obj, 404 struct netlink_ext_ack *extack) 405 { 406 return -EOPNOTSUPP; 407 } 408 409 static inline int switchdev_port_obj_del(struct net_device *dev, 410 const struct switchdev_obj *obj) 411 { 412 return -EOPNOTSUPP; 413 } 414 415 static inline int register_switchdev_notifier(struct notifier_block *nb) 416 { 417 return 0; 418 } 419 420 static inline int unregister_switchdev_notifier(struct notifier_block *nb) 421 { 422 return 0; 423 } 424 425 static inline int call_switchdev_notifiers(unsigned long val, 426 struct net_device *dev, 427 struct switchdev_notifier_info *info, 428 struct netlink_ext_ack *extack) 429 { 430 return NOTIFY_DONE; 431 } 432 433 static inline int 434 register_switchdev_blocking_notifier(struct notifier_block *nb) 435 { 436 return 0; 437 } 438 439 static inline int 440 unregister_switchdev_blocking_notifier(struct notifier_block *nb) 441 { 442 return 0; 443 } 444 445 static inline int 446 call_switchdev_blocking_notifiers(unsigned long val, 447 struct net_device *dev, 448 struct switchdev_notifier_info *info, 449 struct netlink_ext_ack *extack) 450 { 451 return NOTIFY_DONE; 452 } 453 454 static inline int 455 switchdev_handle_fdb_event_to_device(struct net_device *dev, unsigned long event, 456 const struct switchdev_notifier_fdb_info *fdb_info, 457 bool (*check_cb)(const struct net_device *dev), 458 bool (*foreign_dev_check_cb)(const struct net_device *dev, 459 const struct net_device *foreign_dev), 460 int (*mod_cb)(struct net_device *dev, struct net_device *orig_dev, 461 unsigned long event, const void *ctx, 462 const struct switchdev_notifier_fdb_info *fdb_info)) 463 { 464 return 0; 465 } 466 467 static inline int 468 switchdev_handle_port_obj_add(struct net_device *dev, 469 struct switchdev_notifier_port_obj_info *port_obj_info, 470 bool (*check_cb)(const struct net_device *dev), 471 int (*add_cb)(struct net_device *dev, const void *ctx, 472 const struct switchdev_obj *obj, 473 struct netlink_ext_ack *extack)) 474 { 475 return 0; 476 } 477 478 static inline int switchdev_handle_port_obj_add_foreign(struct net_device *dev, 479 struct switchdev_notifier_port_obj_info *port_obj_info, 480 bool (*check_cb)(const struct net_device *dev), 481 bool (*foreign_dev_check_cb)(const struct net_device *dev, 482 const struct net_device *foreign_dev), 483 int (*add_cb)(struct net_device *dev, const void *ctx, 484 const struct switchdev_obj *obj, 485 struct netlink_ext_ack *extack)) 486 { 487 return 0; 488 } 489 490 static inline int 491 switchdev_handle_port_obj_del(struct net_device *dev, 492 struct switchdev_notifier_port_obj_info *port_obj_info, 493 bool (*check_cb)(const struct net_device *dev), 494 int (*del_cb)(struct net_device *dev, const void *ctx, 495 const struct switchdev_obj *obj)) 496 { 497 return 0; 498 } 499 500 static inline int 501 switchdev_handle_port_obj_del_foreign(struct net_device *dev, 502 struct switchdev_notifier_port_obj_info *port_obj_info, 503 bool (*check_cb)(const struct net_device *dev), 504 bool (*foreign_dev_check_cb)(const struct net_device *dev, 505 const struct net_device *foreign_dev), 506 int (*del_cb)(struct net_device *dev, const void *ctx, 507 const struct switchdev_obj *obj)) 508 { 509 return 0; 510 } 511 512 static inline int 513 switchdev_handle_port_attr_set(struct net_device *dev, 514 struct switchdev_notifier_port_attr_info *port_attr_info, 515 bool (*check_cb)(const struct net_device *dev), 516 int (*set_cb)(struct net_device *dev, const void *ctx, 517 const struct switchdev_attr *attr, 518 struct netlink_ext_ack *extack)) 519 { 520 return 0; 521 } 522 #endif 523 524 #endif /* _LINUX_SWITCHDEV_H_ */ 525