linux/include/net/switchdev.h
<<
>>
Prefs
   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
  19struct switchdev_trans {
  20        bool ph_prepare;
  21};
  22
  23static inline bool switchdev_trans_ph_prepare(struct switchdev_trans *trans)
  24{
  25        return trans && trans->ph_prepare;
  26}
  27
  28static inline bool switchdev_trans_ph_commit(struct switchdev_trans *trans)
  29{
  30        return trans && !trans->ph_prepare;
  31}
  32
  33enum switchdev_attr_id {
  34        SWITCHDEV_ATTR_ID_UNDEFINED,
  35        SWITCHDEV_ATTR_ID_PORT_STP_STATE,
  36        SWITCHDEV_ATTR_ID_PORT_BRIDGE_FLAGS,
  37        SWITCHDEV_ATTR_ID_PORT_PRE_BRIDGE_FLAGS,
  38        SWITCHDEV_ATTR_ID_PORT_MROUTER,
  39        SWITCHDEV_ATTR_ID_BRIDGE_AGEING_TIME,
  40        SWITCHDEV_ATTR_ID_BRIDGE_VLAN_FILTERING,
  41        SWITCHDEV_ATTR_ID_BRIDGE_MC_DISABLED,
  42        SWITCHDEV_ATTR_ID_BRIDGE_MROUTER,
  43};
  44
  45struct switchdev_attr {
  46        struct net_device *orig_dev;
  47        enum switchdev_attr_id id;
  48        u32 flags;
  49        void *complete_priv;
  50        void (*complete)(struct net_device *dev, int err, void *priv);
  51        union {
  52                u8 stp_state;                           /* PORT_STP_STATE */
  53                unsigned long brport_flags;             /* PORT_{PRE}_BRIDGE_FLAGS */
  54                bool mrouter;                           /* PORT_MROUTER */
  55                clock_t ageing_time;                    /* BRIDGE_AGEING_TIME */
  56                bool vlan_filtering;                    /* BRIDGE_VLAN_FILTERING */
  57                bool mc_disabled;                       /* MC_DISABLED */
  58        } u;
  59};
  60
  61enum switchdev_obj_id {
  62        SWITCHDEV_OBJ_ID_UNDEFINED,
  63        SWITCHDEV_OBJ_ID_PORT_VLAN,
  64        SWITCHDEV_OBJ_ID_PORT_MDB,
  65        SWITCHDEV_OBJ_ID_HOST_MDB,
  66};
  67
  68struct switchdev_obj {
  69        struct net_device *orig_dev;
  70        enum switchdev_obj_id id;
  71        u32 flags;
  72        void *complete_priv;
  73        void (*complete)(struct net_device *dev, int err, void *priv);
  74};
  75
  76/* SWITCHDEV_OBJ_ID_PORT_VLAN */
  77struct switchdev_obj_port_vlan {
  78        struct switchdev_obj obj;
  79        u16 flags;
  80        u16 vid_begin;
  81        u16 vid_end;
  82};
  83
  84#define SWITCHDEV_OBJ_PORT_VLAN(OBJ) \
  85        container_of((OBJ), struct switchdev_obj_port_vlan, obj)
  86
  87/* SWITCHDEV_OBJ_ID_PORT_MDB */
  88struct switchdev_obj_port_mdb {
  89        struct switchdev_obj obj;
  90        unsigned char addr[ETH_ALEN];
  91        u16 vid;
  92};
  93
  94#define SWITCHDEV_OBJ_PORT_MDB(OBJ) \
  95        container_of((OBJ), struct switchdev_obj_port_mdb, obj)
  96
  97typedef int switchdev_obj_dump_cb_t(struct switchdev_obj *obj);
  98
  99enum switchdev_notifier_type {
 100        SWITCHDEV_FDB_ADD_TO_BRIDGE = 1,
 101        SWITCHDEV_FDB_DEL_TO_BRIDGE,
 102        SWITCHDEV_FDB_ADD_TO_DEVICE,
 103        SWITCHDEV_FDB_DEL_TO_DEVICE,
 104        SWITCHDEV_FDB_OFFLOADED,
 105
 106        SWITCHDEV_PORT_OBJ_ADD, /* Blocking. */
 107        SWITCHDEV_PORT_OBJ_DEL, /* Blocking. */
 108        SWITCHDEV_PORT_ATTR_SET, /* May be blocking . */
 109
 110        SWITCHDEV_VXLAN_FDB_ADD_TO_BRIDGE,
 111        SWITCHDEV_VXLAN_FDB_DEL_TO_BRIDGE,
 112        SWITCHDEV_VXLAN_FDB_ADD_TO_DEVICE,
 113        SWITCHDEV_VXLAN_FDB_DEL_TO_DEVICE,
 114        SWITCHDEV_VXLAN_FDB_OFFLOADED,
 115};
 116
 117struct switchdev_notifier_info {
 118        struct net_device *dev;
 119        struct netlink_ext_ack *extack;
 120};
 121
 122struct switchdev_notifier_fdb_info {
 123        struct switchdev_notifier_info info; /* must be first */
 124        const unsigned char *addr;
 125        u16 vid;
 126        u8 added_by_user:1,
 127           offloaded:1;
 128};
 129
 130struct switchdev_notifier_port_obj_info {
 131        struct switchdev_notifier_info info; /* must be first */
 132        const struct switchdev_obj *obj;
 133        struct switchdev_trans *trans;
 134        bool handled;
 135};
 136
 137struct switchdev_notifier_port_attr_info {
 138        struct switchdev_notifier_info info; /* must be first */
 139        const struct switchdev_attr *attr;
 140        struct switchdev_trans *trans;
 141        bool handled;
 142};
 143
 144static inline struct net_device *
 145switchdev_notifier_info_to_dev(const struct switchdev_notifier_info *info)
 146{
 147        return info->dev;
 148}
 149
 150static inline struct netlink_ext_ack *
 151switchdev_notifier_info_to_extack(const struct switchdev_notifier_info *info)
 152{
 153        return info->extack;
 154}
 155
 156#ifdef CONFIG_NET_SWITCHDEV
 157
 158void switchdev_deferred_process(void);
 159int switchdev_port_attr_set(struct net_device *dev,
 160                            const struct switchdev_attr *attr);
 161int switchdev_port_obj_add(struct net_device *dev,
 162                           const struct switchdev_obj *obj,
 163                           struct netlink_ext_ack *extack);
 164int switchdev_port_obj_del(struct net_device *dev,
 165                           const struct switchdev_obj *obj);
 166
 167int register_switchdev_notifier(struct notifier_block *nb);
 168int unregister_switchdev_notifier(struct notifier_block *nb);
 169int call_switchdev_notifiers(unsigned long val, struct net_device *dev,
 170                             struct switchdev_notifier_info *info,
 171                             struct netlink_ext_ack *extack);
 172
 173int register_switchdev_blocking_notifier(struct notifier_block *nb);
 174int unregister_switchdev_blocking_notifier(struct notifier_block *nb);
 175int call_switchdev_blocking_notifiers(unsigned long val, struct net_device *dev,
 176                                      struct switchdev_notifier_info *info,
 177                                      struct netlink_ext_ack *extack);
 178
 179void switchdev_port_fwd_mark_set(struct net_device *dev,
 180                                 struct net_device *group_dev,
 181                                 bool joining);
 182
 183int switchdev_handle_port_obj_add(struct net_device *dev,
 184                        struct switchdev_notifier_port_obj_info *port_obj_info,
 185                        bool (*check_cb)(const struct net_device *dev),
 186                        int (*add_cb)(struct net_device *dev,
 187                                      const struct switchdev_obj *obj,
 188                                      struct switchdev_trans *trans,
 189                                      struct netlink_ext_ack *extack));
 190int switchdev_handle_port_obj_del(struct net_device *dev,
 191                        struct switchdev_notifier_port_obj_info *port_obj_info,
 192                        bool (*check_cb)(const struct net_device *dev),
 193                        int (*del_cb)(struct net_device *dev,
 194                                      const struct switchdev_obj *obj));
 195
 196int switchdev_handle_port_attr_set(struct net_device *dev,
 197                        struct switchdev_notifier_port_attr_info *port_attr_info,
 198                        bool (*check_cb)(const struct net_device *dev),
 199                        int (*set_cb)(struct net_device *dev,
 200                                      const struct switchdev_attr *attr,
 201                                      struct switchdev_trans *trans));
 202#else
 203
 204static inline void switchdev_deferred_process(void)
 205{
 206}
 207
 208static inline int switchdev_port_attr_set(struct net_device *dev,
 209                                          const struct switchdev_attr *attr)
 210{
 211        return -EOPNOTSUPP;
 212}
 213
 214static inline int switchdev_port_obj_add(struct net_device *dev,
 215                                         const struct switchdev_obj *obj,
 216                                         struct netlink_ext_ack *extack)
 217{
 218        return -EOPNOTSUPP;
 219}
 220
 221static inline int switchdev_port_obj_del(struct net_device *dev,
 222                                         const struct switchdev_obj *obj)
 223{
 224        return -EOPNOTSUPP;
 225}
 226
 227static inline int register_switchdev_notifier(struct notifier_block *nb)
 228{
 229        return 0;
 230}
 231
 232static inline int unregister_switchdev_notifier(struct notifier_block *nb)
 233{
 234        return 0;
 235}
 236
 237static inline int call_switchdev_notifiers(unsigned long val,
 238                                           struct net_device *dev,
 239                                           struct switchdev_notifier_info *info,
 240                                           struct netlink_ext_ack *extack)
 241{
 242        return NOTIFY_DONE;
 243}
 244
 245static inline int
 246register_switchdev_blocking_notifier(struct notifier_block *nb)
 247{
 248        return 0;
 249}
 250
 251static inline int
 252unregister_switchdev_blocking_notifier(struct notifier_block *nb)
 253{
 254        return 0;
 255}
 256
 257static inline int
 258call_switchdev_blocking_notifiers(unsigned long val,
 259                                  struct net_device *dev,
 260                                  struct switchdev_notifier_info *info,
 261                                  struct netlink_ext_ack *extack)
 262{
 263        return NOTIFY_DONE;
 264}
 265
 266static inline int
 267switchdev_handle_port_obj_add(struct net_device *dev,
 268                        struct switchdev_notifier_port_obj_info *port_obj_info,
 269                        bool (*check_cb)(const struct net_device *dev),
 270                        int (*add_cb)(struct net_device *dev,
 271                                      const struct switchdev_obj *obj,
 272                                      struct switchdev_trans *trans,
 273                                      struct netlink_ext_ack *extack))
 274{
 275        return 0;
 276}
 277
 278static inline int
 279switchdev_handle_port_obj_del(struct net_device *dev,
 280                        struct switchdev_notifier_port_obj_info *port_obj_info,
 281                        bool (*check_cb)(const struct net_device *dev),
 282                        int (*del_cb)(struct net_device *dev,
 283                                      const struct switchdev_obj *obj))
 284{
 285        return 0;
 286}
 287
 288static inline int
 289switchdev_handle_port_attr_set(struct net_device *dev,
 290                        struct switchdev_notifier_port_attr_info *port_attr_info,
 291                        bool (*check_cb)(const struct net_device *dev),
 292                        int (*set_cb)(struct net_device *dev,
 293                                      const struct switchdev_attr *attr,
 294                                      struct switchdev_trans *trans))
 295{
 296        return 0;
 297}
 298#endif
 299
 300#endif /* _LINUX_SWITCHDEV_H_ */
 301