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_BRIDGE_FLAGS, 23 SWITCHDEV_ATTR_ID_PORT_PRE_BRIDGE_FLAGS, 24 SWITCHDEV_ATTR_ID_PORT_MROUTER, 25 SWITCHDEV_ATTR_ID_BRIDGE_AGEING_TIME, 26 SWITCHDEV_ATTR_ID_BRIDGE_VLAN_FILTERING, 27 SWITCHDEV_ATTR_ID_BRIDGE_VLAN_PROTOCOL, 28 SWITCHDEV_ATTR_ID_BRIDGE_MC_DISABLED, 29 SWITCHDEV_ATTR_ID_BRIDGE_MROUTER, 30 SWITCHDEV_ATTR_ID_MRP_PORT_ROLE, 31 }; 32 33 struct switchdev_brport_flags { 34 unsigned long val; 35 unsigned long mask; 36 }; 37 38 struct switchdev_attr { 39 struct net_device *orig_dev; 40 enum switchdev_attr_id id; 41 u32 flags; 42 void *complete_priv; 43 void (*complete)(struct net_device *dev, int err, void *priv); 44 union { 45 u8 stp_state; /* PORT_STP_STATE */ 46 struct switchdev_brport_flags brport_flags; /* PORT_BRIDGE_FLAGS */ 47 bool mrouter; /* PORT_MROUTER */ 48 clock_t ageing_time; /* BRIDGE_AGEING_TIME */ 49 bool vlan_filtering; /* BRIDGE_VLAN_FILTERING */ 50 u16 vlan_protocol; /* BRIDGE_VLAN_PROTOCOL */ 51 bool mc_disabled; /* MC_DISABLED */ 52 u8 mrp_port_role; /* MRP_PORT_ROLE */ 53 } u; 54 }; 55 56 enum switchdev_obj_id { 57 SWITCHDEV_OBJ_ID_UNDEFINED, 58 SWITCHDEV_OBJ_ID_PORT_VLAN, 59 SWITCHDEV_OBJ_ID_PORT_MDB, 60 SWITCHDEV_OBJ_ID_HOST_MDB, 61 SWITCHDEV_OBJ_ID_MRP, 62 SWITCHDEV_OBJ_ID_RING_TEST_MRP, 63 SWITCHDEV_OBJ_ID_RING_ROLE_MRP, 64 SWITCHDEV_OBJ_ID_RING_STATE_MRP, 65 SWITCHDEV_OBJ_ID_IN_TEST_MRP, 66 SWITCHDEV_OBJ_ID_IN_ROLE_MRP, 67 SWITCHDEV_OBJ_ID_IN_STATE_MRP, 68 }; 69 70 struct switchdev_obj { 71 struct list_head list; 72 struct net_device *orig_dev; 73 enum switchdev_obj_id id; 74 u32 flags; 75 void *complete_priv; 76 void (*complete)(struct net_device *dev, int err, void *priv); 77 }; 78 79 /* SWITCHDEV_OBJ_ID_PORT_VLAN */ 80 struct switchdev_obj_port_vlan { 81 struct switchdev_obj obj; 82 u16 flags; 83 u16 vid; 84 }; 85 86 #define SWITCHDEV_OBJ_PORT_VLAN(OBJ) \ 87 container_of((OBJ), struct switchdev_obj_port_vlan, obj) 88 89 /* SWITCHDEV_OBJ_ID_PORT_MDB */ 90 struct switchdev_obj_port_mdb { 91 struct switchdev_obj obj; 92 unsigned char addr[ETH_ALEN]; 93 u16 vid; 94 }; 95 96 #define SWITCHDEV_OBJ_PORT_MDB(OBJ) \ 97 container_of((OBJ), struct switchdev_obj_port_mdb, obj) 98 99 100 /* SWITCHDEV_OBJ_ID_MRP */ 101 struct switchdev_obj_mrp { 102 struct switchdev_obj obj; 103 struct net_device *p_port; 104 struct net_device *s_port; 105 u32 ring_id; 106 u16 prio; 107 }; 108 109 #define SWITCHDEV_OBJ_MRP(OBJ) \ 110 container_of((OBJ), struct switchdev_obj_mrp, obj) 111 112 /* SWITCHDEV_OBJ_ID_RING_TEST_MRP */ 113 struct switchdev_obj_ring_test_mrp { 114 struct switchdev_obj obj; 115 /* The value is in us and a value of 0 represents to stop */ 116 u32 interval; 117 u8 max_miss; 118 u32 ring_id; 119 u32 period; 120 bool monitor; 121 }; 122 123 #define SWITCHDEV_OBJ_RING_TEST_MRP(OBJ) \ 124 container_of((OBJ), struct switchdev_obj_ring_test_mrp, obj) 125 126 /* SWICHDEV_OBJ_ID_RING_ROLE_MRP */ 127 struct switchdev_obj_ring_role_mrp { 128 struct switchdev_obj obj; 129 u8 ring_role; 130 u32 ring_id; 131 u8 sw_backup; 132 }; 133 134 #define SWITCHDEV_OBJ_RING_ROLE_MRP(OBJ) \ 135 container_of((OBJ), struct switchdev_obj_ring_role_mrp, obj) 136 137 struct switchdev_obj_ring_state_mrp { 138 struct switchdev_obj obj; 139 u8 ring_state; 140 u32 ring_id; 141 }; 142 143 #define SWITCHDEV_OBJ_RING_STATE_MRP(OBJ) \ 144 container_of((OBJ), struct switchdev_obj_ring_state_mrp, obj) 145 146 /* SWITCHDEV_OBJ_ID_IN_TEST_MRP */ 147 struct switchdev_obj_in_test_mrp { 148 struct switchdev_obj obj; 149 /* The value is in us and a value of 0 represents to stop */ 150 u32 interval; 151 u32 in_id; 152 u32 period; 153 u8 max_miss; 154 }; 155 156 #define SWITCHDEV_OBJ_IN_TEST_MRP(OBJ) \ 157 container_of((OBJ), struct switchdev_obj_in_test_mrp, obj) 158 159 /* SWICHDEV_OBJ_ID_IN_ROLE_MRP */ 160 struct switchdev_obj_in_role_mrp { 161 struct switchdev_obj obj; 162 struct net_device *i_port; 163 u32 ring_id; 164 u16 in_id; 165 u8 in_role; 166 u8 sw_backup; 167 }; 168 169 #define SWITCHDEV_OBJ_IN_ROLE_MRP(OBJ) \ 170 container_of((OBJ), struct switchdev_obj_in_role_mrp, obj) 171 172 struct switchdev_obj_in_state_mrp { 173 struct switchdev_obj obj; 174 u32 in_id; 175 u8 in_state; 176 }; 177 178 #define SWITCHDEV_OBJ_IN_STATE_MRP(OBJ) \ 179 container_of((OBJ), struct switchdev_obj_in_state_mrp, obj) 180 181 typedef int switchdev_obj_dump_cb_t(struct switchdev_obj *obj); 182 183 enum switchdev_notifier_type { 184 SWITCHDEV_FDB_ADD_TO_BRIDGE = 1, 185 SWITCHDEV_FDB_DEL_TO_BRIDGE, 186 SWITCHDEV_FDB_ADD_TO_DEVICE, 187 SWITCHDEV_FDB_DEL_TO_DEVICE, 188 SWITCHDEV_FDB_OFFLOADED, 189 SWITCHDEV_FDB_FLUSH_TO_BRIDGE, 190 191 SWITCHDEV_PORT_OBJ_ADD, /* Blocking. */ 192 SWITCHDEV_PORT_OBJ_DEL, /* Blocking. */ 193 SWITCHDEV_PORT_ATTR_SET, /* May be blocking . */ 194 195 SWITCHDEV_VXLAN_FDB_ADD_TO_BRIDGE, 196 SWITCHDEV_VXLAN_FDB_DEL_TO_BRIDGE, 197 SWITCHDEV_VXLAN_FDB_ADD_TO_DEVICE, 198 SWITCHDEV_VXLAN_FDB_DEL_TO_DEVICE, 199 SWITCHDEV_VXLAN_FDB_OFFLOADED, 200 }; 201 202 struct switchdev_notifier_info { 203 struct net_device *dev; 204 struct netlink_ext_ack *extack; 205 const void *ctx; 206 }; 207 208 struct switchdev_notifier_fdb_info { 209 struct switchdev_notifier_info info; /* must be first */ 210 const unsigned char *addr; 211 u16 vid; 212 u8 added_by_user:1, 213 is_local:1, 214 offloaded:1; 215 }; 216 217 struct switchdev_notifier_port_obj_info { 218 struct switchdev_notifier_info info; /* must be first */ 219 const struct switchdev_obj *obj; 220 bool handled; 221 }; 222 223 struct switchdev_notifier_port_attr_info { 224 struct switchdev_notifier_info info; /* must be first */ 225 const struct switchdev_attr *attr; 226 bool handled; 227 }; 228 229 static inline struct net_device * 230 switchdev_notifier_info_to_dev(const struct switchdev_notifier_info *info) 231 { 232 return info->dev; 233 } 234 235 static inline struct netlink_ext_ack * 236 switchdev_notifier_info_to_extack(const struct switchdev_notifier_info *info) 237 { 238 return info->extack; 239 } 240 241 static inline bool 242 switchdev_fdb_is_dynamically_learned(const struct switchdev_notifier_fdb_info *fdb_info) 243 { 244 return !fdb_info->added_by_user && !fdb_info->is_local; 245 } 246 247 #ifdef CONFIG_NET_SWITCHDEV 248 249 void switchdev_deferred_process(void); 250 int switchdev_port_attr_set(struct net_device *dev, 251 const struct switchdev_attr *attr, 252 struct netlink_ext_ack *extack); 253 int switchdev_port_obj_add(struct net_device *dev, 254 const struct switchdev_obj *obj, 255 struct netlink_ext_ack *extack); 256 int switchdev_port_obj_del(struct net_device *dev, 257 const struct switchdev_obj *obj); 258 259 int register_switchdev_notifier(struct notifier_block *nb); 260 int unregister_switchdev_notifier(struct notifier_block *nb); 261 int call_switchdev_notifiers(unsigned long val, struct net_device *dev, 262 struct switchdev_notifier_info *info, 263 struct netlink_ext_ack *extack); 264 265 int register_switchdev_blocking_notifier(struct notifier_block *nb); 266 int unregister_switchdev_blocking_notifier(struct notifier_block *nb); 267 int call_switchdev_blocking_notifiers(unsigned long val, struct net_device *dev, 268 struct switchdev_notifier_info *info, 269 struct netlink_ext_ack *extack); 270 271 void switchdev_port_fwd_mark_set(struct net_device *dev, 272 struct net_device *group_dev, 273 bool joining); 274 275 int switchdev_handle_fdb_add_to_device(struct net_device *dev, 276 const struct switchdev_notifier_fdb_info *fdb_info, 277 bool (*check_cb)(const struct net_device *dev), 278 bool (*foreign_dev_check_cb)(const struct net_device *dev, 279 const struct net_device *foreign_dev), 280 int (*add_cb)(struct net_device *dev, 281 const struct net_device *orig_dev, const void *ctx, 282 const struct switchdev_notifier_fdb_info *fdb_info), 283 int (*lag_add_cb)(struct net_device *dev, 284 const struct net_device *orig_dev, const void *ctx, 285 const struct switchdev_notifier_fdb_info *fdb_info)); 286 287 int switchdev_handle_fdb_del_to_device(struct net_device *dev, 288 const struct switchdev_notifier_fdb_info *fdb_info, 289 bool (*check_cb)(const struct net_device *dev), 290 bool (*foreign_dev_check_cb)(const struct net_device *dev, 291 const struct net_device *foreign_dev), 292 int (*del_cb)(struct net_device *dev, 293 const struct net_device *orig_dev, const void *ctx, 294 const struct switchdev_notifier_fdb_info *fdb_info), 295 int (*lag_del_cb)(struct net_device *dev, 296 const struct net_device *orig_dev, const void *ctx, 297 const struct switchdev_notifier_fdb_info *fdb_info)); 298 299 int switchdev_handle_port_obj_add(struct net_device *dev, 300 struct switchdev_notifier_port_obj_info *port_obj_info, 301 bool (*check_cb)(const struct net_device *dev), 302 int (*add_cb)(struct net_device *dev, const void *ctx, 303 const struct switchdev_obj *obj, 304 struct netlink_ext_ack *extack)); 305 int switchdev_handle_port_obj_del(struct net_device *dev, 306 struct switchdev_notifier_port_obj_info *port_obj_info, 307 bool (*check_cb)(const struct net_device *dev), 308 int (*del_cb)(struct net_device *dev, const void *ctx, 309 const struct switchdev_obj *obj)); 310 311 int switchdev_handle_port_attr_set(struct net_device *dev, 312 struct switchdev_notifier_port_attr_info *port_attr_info, 313 bool (*check_cb)(const struct net_device *dev), 314 int (*set_cb)(struct net_device *dev, const void *ctx, 315 const struct switchdev_attr *attr, 316 struct netlink_ext_ack *extack)); 317 #else 318 319 static inline void switchdev_deferred_process(void) 320 { 321 } 322 323 static inline int switchdev_port_attr_set(struct net_device *dev, 324 const struct switchdev_attr *attr, 325 struct netlink_ext_ack *extack) 326 { 327 return -EOPNOTSUPP; 328 } 329 330 static inline int switchdev_port_obj_add(struct net_device *dev, 331 const struct switchdev_obj *obj, 332 struct netlink_ext_ack *extack) 333 { 334 return -EOPNOTSUPP; 335 } 336 337 static inline int switchdev_port_obj_del(struct net_device *dev, 338 const struct switchdev_obj *obj) 339 { 340 return -EOPNOTSUPP; 341 } 342 343 static inline int register_switchdev_notifier(struct notifier_block *nb) 344 { 345 return 0; 346 } 347 348 static inline int unregister_switchdev_notifier(struct notifier_block *nb) 349 { 350 return 0; 351 } 352 353 static inline int call_switchdev_notifiers(unsigned long val, 354 struct net_device *dev, 355 struct switchdev_notifier_info *info, 356 struct netlink_ext_ack *extack) 357 { 358 return NOTIFY_DONE; 359 } 360 361 static inline int 362 register_switchdev_blocking_notifier(struct notifier_block *nb) 363 { 364 return 0; 365 } 366 367 static inline int 368 unregister_switchdev_blocking_notifier(struct notifier_block *nb) 369 { 370 return 0; 371 } 372 373 static inline int 374 call_switchdev_blocking_notifiers(unsigned long val, 375 struct net_device *dev, 376 struct switchdev_notifier_info *info, 377 struct netlink_ext_ack *extack) 378 { 379 return NOTIFY_DONE; 380 } 381 382 static inline int 383 switchdev_handle_fdb_add_to_device(struct net_device *dev, 384 const struct switchdev_notifier_fdb_info *fdb_info, 385 bool (*check_cb)(const struct net_device *dev), 386 bool (*foreign_dev_check_cb)(const struct net_device *dev, 387 const struct net_device *foreign_dev), 388 int (*add_cb)(struct net_device *dev, 389 const struct net_device *orig_dev, const void *ctx, 390 const struct switchdev_notifier_fdb_info *fdb_info), 391 int (*lag_add_cb)(struct net_device *dev, 392 const struct net_device *orig_dev, const void *ctx, 393 const struct switchdev_notifier_fdb_info *fdb_info)) 394 { 395 return 0; 396 } 397 398 static inline int 399 switchdev_handle_fdb_del_to_device(struct net_device *dev, 400 const struct switchdev_notifier_fdb_info *fdb_info, 401 bool (*check_cb)(const struct net_device *dev), 402 bool (*foreign_dev_check_cb)(const struct net_device *dev, 403 const struct net_device *foreign_dev), 404 int (*del_cb)(struct net_device *dev, 405 const struct net_device *orig_dev, const void *ctx, 406 const struct switchdev_notifier_fdb_info *fdb_info), 407 int (*lag_del_cb)(struct net_device *dev, 408 const struct net_device *orig_dev, const void *ctx, 409 const struct switchdev_notifier_fdb_info *fdb_info)) 410 { 411 return 0; 412 } 413 414 static inline int 415 switchdev_handle_port_obj_add(struct net_device *dev, 416 struct switchdev_notifier_port_obj_info *port_obj_info, 417 bool (*check_cb)(const struct net_device *dev), 418 int (*add_cb)(struct net_device *dev, const void *ctx, 419 const struct switchdev_obj *obj, 420 struct netlink_ext_ack *extack)) 421 { 422 return 0; 423 } 424 425 static inline int 426 switchdev_handle_port_obj_del(struct net_device *dev, 427 struct switchdev_notifier_port_obj_info *port_obj_info, 428 bool (*check_cb)(const struct net_device *dev), 429 int (*del_cb)(struct net_device *dev, const void *ctx, 430 const struct switchdev_obj *obj)) 431 { 432 return 0; 433 } 434 435 static inline int 436 switchdev_handle_port_attr_set(struct net_device *dev, 437 struct switchdev_notifier_port_attr_info *port_attr_info, 438 bool (*check_cb)(const struct net_device *dev), 439 int (*set_cb)(struct net_device *dev, const void *ctx, 440 const struct switchdev_attr *attr, 441 struct netlink_ext_ack *extack)) 442 { 443 return 0; 444 } 445 #endif 446 447 #endif /* _LINUX_SWITCHDEV_H_ */ 448