include/net/switchdev.h

   1 /*
   2  * include/net/switchdev.h - Switch device API
   3  * Copyright (c) 2014-2015 Jiri Pirko <jiri@resnulli.us>
   4  * Copyright (c) 2014-2015 Scott Feldman <sfeldma@gmail.com>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  */
  11 #ifndef _LINUX_SWITCHDEV_H_
  12 #define _LINUX_SWITCHDEV_H_
  13
  14 #include <linux/netdevice.h>
  15 #include <linux/notifier.h>
  16 #include <linux/list.h>
  17 #include <net/ip_fib.h>
  18
  19 #define SWITCHDEV_F_NO_RECURSE          BIT(0)
  20 #define SWITCHDEV_F_SKIP_EOPNOTSUPP     BIT(1)
  21 #define SWITCHDEV_F_DEFER               BIT(2)
  22
  23 struct switchdev_trans_item {
  24         struct list_head list;
  25         void *data;
  26         void (*destructor)(const void *data);
  27 };
  28
  29 struct switchdev_trans {
  30         struct list_head item_list;
  31         bool ph_prepare;
  32 };
  33
  34 static inline bool switchdev_trans_ph_prepare(struct switchdev_trans *trans)
  35 {
  36         return trans && trans->ph_prepare;
  37 }
  38
  39 static inline bool switchdev_trans_ph_commit(struct switchdev_trans *trans)
  40 {
  41         return trans && !trans->ph_prepare;
  42 }
  43
  44 enum switchdev_attr_id {
  45         SWITCHDEV_ATTR_ID_UNDEFINED,
  46         SWITCHDEV_ATTR_ID_PORT_PARENT_ID,
  47         SWITCHDEV_ATTR_ID_PORT_STP_STATE,
  48         SWITCHDEV_ATTR_ID_PORT_BRIDGE_FLAGS,
  49         SWITCHDEV_ATTR_ID_BRIDGE_AGEING_TIME,
  50         SWITCHDEV_ATTR_ID_BRIDGE_VLAN_FILTERING,
  51         SWITCHDEV_ATTR_ID_BRIDGE_MC_DISABLED,
  52 };
  53
  54 struct switchdev_attr {
  55         struct net_device *orig_dev;
  56         enum switchdev_attr_id id;
  57         u32 flags;
  58         void *complete_priv;
  59         void (*complete)(struct net_device *dev, int err, void *priv);
  60         union {
  61                 struct netdev_phys_item_id ppid;        /* PORT_PARENT_ID */
  62                 u8 stp_state;                           /* PORT_STP_STATE */
  63                 unsigned long brport_flags;             /* PORT_BRIDGE_FLAGS */
  64                 clock_t ageing_time;                    /* BRIDGE_AGEING_TIME */
  65                 bool vlan_filtering;                    /* BRIDGE_VLAN_FILTERING */
  66                 bool mc_disabled;                       /* MC_DISABLED */
  67         } u;
  68 };
  69
  70 enum switchdev_obj_id {
  71         SWITCHDEV_OBJ_ID_UNDEFINED,
  72         SWITCHDEV_OBJ_ID_PORT_VLAN,
  73         SWITCHDEV_OBJ_ID_PORT_FDB,
  74         SWITCHDEV_OBJ_ID_PORT_MDB,
  75 };
  76
  77 struct switchdev_obj {
  78         struct net_device *orig_dev;
  79         enum switchdev_obj_id id;
  80         u32 flags;
  81         void *complete_priv;
  82         void (*complete)(struct net_device *dev, int err, void *priv);
  83 };
  84
  85 /* SWITCHDEV_OBJ_ID_PORT_VLAN */
  86 struct switchdev_obj_port_vlan {
  87         struct switchdev_obj obj;
  88         u16 flags;
  89         u16 vid_begin;
  90         u16 vid_end;
  91 };
  92
  93 #define SWITCHDEV_OBJ_PORT_VLAN(obj) \
  94         container_of(obj, struct switchdev_obj_port_vlan, obj)
  95
  96 /* SWITCHDEV_OBJ_ID_PORT_FDB */
  97 struct switchdev_obj_port_fdb {
  98         struct switchdev_obj obj;
  99         unsigned char addr[ETH_ALEN];
 100         u16 vid;
 101         u16 ndm_state;
 102 };
 103
 104 #define SWITCHDEV_OBJ_PORT_FDB(obj) \
 105         container_of(obj, struct switchdev_obj_port_fdb, obj)
 106
 107 /* SWITCHDEV_OBJ_ID_PORT_MDB */
 108 struct switchdev_obj_port_mdb {
 109         struct switchdev_obj obj;
 110         unsigned char addr[ETH_ALEN];
 111         u16 vid;
 112 };
 113
 114 #define SWITCHDEV_OBJ_PORT_MDB(obj) \
 115         container_of(obj, struct switchdev_obj_port_mdb, obj)
 116
 117 void switchdev_trans_item_enqueue(struct switchdev_trans *trans,
 118                                   void *data, void (*destructor)(void const *),
 119                                   struct switchdev_trans_item *tritem);
 120 void *switchdev_trans_item_dequeue(struct switchdev_trans *trans);
 121
 122 typedef int switchdev_obj_dump_cb_t(struct switchdev_obj *obj);
 123
 124 /**
 125  * struct switchdev_ops - switchdev operations
 126  *
 127  * @switchdev_port_attr_get: Get a port attribute (see switchdev_attr).
 128  *
 129  * @switchdev_port_attr_set: Set a port attribute (see switchdev_attr).
 130  *
 131  * @switchdev_port_obj_add: Add an object to port (see switchdev_obj_*).
 132  *
 133  * @switchdev_port_obj_del: Delete an object from port (see switchdev_obj_*).
 134  *
 135  * @switchdev_port_obj_dump: Dump port objects (see switchdev_obj_*).
 136  */
 137 struct switchdev_ops {
 138         int     (*switchdev_port_attr_get)(struct net_device *dev,
 139                                            struct switchdev_attr *attr);
 140         int     (*switchdev_port_attr_set)(struct net_device *dev,
 141                                            const struct switchdev_attr *attr,
 142                                            struct switchdev_trans *trans);
 143         int     (*switchdev_port_obj_add)(struct net_device *dev,
 144                                           const struct switchdev_obj *obj,
 145                                           struct switchdev_trans *trans);
 146         int     (*switchdev_port_obj_del)(struct net_device *dev,
 147                                           const struct switchdev_obj *obj);
 148         int     (*switchdev_port_obj_dump)(struct net_device *dev,
 149                                            struct switchdev_obj *obj,
 150                                            switchdev_obj_dump_cb_t *cb);
 151 };
 152
 153 enum switchdev_notifier_type {
 154         SWITCHDEV_FDB_ADD = 1,
 155         SWITCHDEV_FDB_DEL,
 156 };
 157
 158 struct switchdev_notifier_info {
 159         struct net_device *dev;
 160 };
 161
 162 struct switchdev_notifier_fdb_info {
 163         struct switchdev_notifier_info info; /* must be first */
 164         const unsigned char *addr;
 165         u16 vid;
 166 };
 167
 168 static inline struct net_device *
 169 switchdev_notifier_info_to_dev(const struct switchdev_notifier_info *info)
 170 {
 171         return info->dev;
 172 }
 173
 174 #ifdef CONFIG_NET_SWITCHDEV
 175
 176 void switchdev_deferred_process(void);
 177 int switchdev_port_attr_get(struct net_device *dev,
 178                             struct switchdev_attr *attr);
 179 int switchdev_port_attr_set(struct net_device *dev,
 180                             const struct switchdev_attr *attr);
 181 int switchdev_port_obj_add(struct net_device *dev,
 182                            const struct switchdev_obj *obj);
 183 int switchdev_port_obj_del(struct net_device *dev,
 184                            const struct switchdev_obj *obj);
 185 int switchdev_port_obj_dump(struct net_device *dev, struct switchdev_obj *obj,
 186                             switchdev_obj_dump_cb_t *cb);
 187 int register_switchdev_notifier(struct notifier_block *nb);
 188 int unregister_switchdev_notifier(struct notifier_block *nb);
 189 int call_switchdev_notifiers(unsigned long val, struct net_device *dev,
 190                              struct switchdev_notifier_info *info);
 191 int switchdev_port_bridge_getlink(struct sk_buff *skb, u32 pid, u32 seq,
 192                                   struct net_device *dev, u32 filter_mask,
 193                                   int nlflags);
 194 int switchdev_port_bridge_setlink(struct net_device *dev,
 195                                   struct nlmsghdr *nlh, u16 flags);
 196 int switchdev_port_bridge_dellink(struct net_device *dev,
 197                                   struct nlmsghdr *nlh, u16 flags);
 198 int switchdev_port_fdb_add(struct ndmsg *ndm, struct nlattr *tb[],
 199                            struct net_device *dev, const unsigned char *addr,
 200                            u16 vid, u16 nlm_flags);
 201 int switchdev_port_fdb_del(struct ndmsg *ndm, struct nlattr *tb[],
 202                            struct net_device *dev, const unsigned char *addr,
 203                            u16 vid);
 204 int switchdev_port_fdb_dump(struct sk_buff *skb, struct netlink_callback *cb,
 205                             struct net_device *dev,
 206                             struct net_device *filter_dev, int *idx);
 207 void switchdev_port_fwd_mark_set(struct net_device *dev,
 208                                  struct net_device *group_dev,
 209                                  bool joining);
 210
 211 bool switchdev_port_same_parent_id(struct net_device *a,
 212                                    struct net_device *b);
 213 #else
 214
 215 static inline void switchdev_deferred_process(void)
 216 {
 217 }
 218
 219 static inline int switchdev_port_attr_get(struct net_device *dev,
 220                                           struct switchdev_attr *attr)
 221 {
 222         return -EOPNOTSUPP;
 223 }
 224
 225 static inline int switchdev_port_attr_set(struct net_device *dev,
 226                                           const struct switchdev_attr *attr)
 227 {
 228         return -EOPNOTSUPP;
 229 }
 230
 231 static inline int switchdev_port_obj_add(struct net_device *dev,
 232                                          const struct switchdev_obj *obj)
 233 {
 234         return -EOPNOTSUPP;
 235 }
 236
 237 static inline int switchdev_port_obj_del(struct net_device *dev,
 238                                          const struct switchdev_obj *obj)
 239 {
 240         return -EOPNOTSUPP;
 241 }
 242
 243 static inline int switchdev_port_obj_dump(struct net_device *dev,
 244                                           const struct switchdev_obj *obj,
 245                                           switchdev_obj_dump_cb_t *cb)
 246 {
 247         return -EOPNOTSUPP;
 248 }
 249
 250 static inline int register_switchdev_notifier(struct notifier_block *nb)
 251 {
 252         return 0;
 253 }
 254
 255 static inline int unregister_switchdev_notifier(struct notifier_block *nb)
 256 {
 257         return 0;
 258 }
 259
 260 static inline int call_switchdev_notifiers(unsigned long val,
 261                                            struct net_device *dev,
 262                                            struct switchdev_notifier_info *info)
 263 {
 264         return NOTIFY_DONE;
 265 }
 266
 267 static inline int switchdev_port_bridge_getlink(struct sk_buff *skb, u32 pid,
 268                                             u32 seq, struct net_device *dev,
 269                                             u32 filter_mask, int nlflags)
 270 {
 271         return -EOPNOTSUPP;
 272 }
 273
 274 static inline int switchdev_port_bridge_setlink(struct net_device *dev,
 275                                                 struct nlmsghdr *nlh,
 276                                                 u16 flags)
 277 {
 278         return -EOPNOTSUPP;
 279 }
 280
 281 static inline int switchdev_port_bridge_dellink(struct net_device *dev,
 282                                                 struct nlmsghdr *nlh,
 283                                                 u16 flags)
 284 {
 285         return -EOPNOTSUPP;
 286 }
 287
 288 static inline int switchdev_port_fdb_add(struct ndmsg *ndm, struct nlattr *tb[],
 289                                          struct net_device *dev,
 290                                          const unsigned char *addr,
 291                                          u16 vid, u16 nlm_flags)
 292 {
 293         return -EOPNOTSUPP;
 294 }
 295
 296 static inline int switchdev_port_fdb_del(struct ndmsg *ndm, struct nlattr *tb[],
 297                                          struct net_device *dev,
 298                                          const unsigned char *addr, u16 vid)
 299 {
 300         return -EOPNOTSUPP;
 301 }
 302
 303 static inline int switchdev_port_fdb_dump(struct sk_buff *skb,
 304                                           struct netlink_callback *cb,
 305                                           struct net_device *dev,
 306                                           struct net_device *filter_dev,
 307                                           int *idx)
 308 {
 309        return *idx;
 310 }
 311
 312 static inline bool switchdev_port_same_parent_id(struct net_device *a,
 313                                                  struct net_device *b)
 314 {
 315         return false;
 316 }
 317
 318 #endif
 319
 320 #endif /* _LINUX_SWITCHDEV_H_ */