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