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
  18 #define SWITCHDEV_F_NO_RECURSE          BIT(0)
  19
  20 struct switchdev_trans_item {
  21         struct list_head list;
  22         void *data;
  23         void (*destructor)(const void *data);
  24 };
  25
  26 struct switchdev_trans {
  27         struct list_head item_list;
  28         bool ph_prepare;
  29 };
  30
  31 static inline bool switchdev_trans_ph_prepare(struct switchdev_trans *trans)
  32 {
  33         return trans && trans->ph_prepare;
  34 }
  35
  36 static inline bool switchdev_trans_ph_commit(struct switchdev_trans *trans)
  37 {
  38         return trans && !trans->ph_prepare;
  39 }
  40
  41 enum switchdev_attr_id {
  42         SWITCHDEV_ATTR_ID_UNDEFINED,
  43         SWITCHDEV_ATTR_ID_PORT_PARENT_ID,
  44         SWITCHDEV_ATTR_ID_PORT_STP_STATE,
  45         SWITCHDEV_ATTR_ID_PORT_BRIDGE_FLAGS,
  46         SWITCHDEV_ATTR_ID_BRIDGE_AGEING_TIME,
  47 };
  48
  49 struct switchdev_attr {
  50         enum switchdev_attr_id id;
  51         u32 flags;
  52         union {
  53                 struct netdev_phys_item_id ppid;        /* PORT_PARENT_ID */
  54                 u8 stp_state;                           /* PORT_STP_STATE */
  55                 unsigned long brport_flags;             /* PORT_BRIDGE_FLAGS */
  56                 u32 ageing_time;                        /* BRIDGE_AGEING_TIME */
  57         } u;
  58 };
  59
  60 struct fib_info;
  61
  62 enum switchdev_obj_id {
  63         SWITCHDEV_OBJ_ID_UNDEFINED,
  64         SWITCHDEV_OBJ_ID_PORT_VLAN,
  65         SWITCHDEV_OBJ_ID_IPV4_FIB,
  66         SWITCHDEV_OBJ_ID_PORT_FDB,
  67 };
  68
  69 struct switchdev_obj {
  70         enum switchdev_obj_id id;
  71 };
  72
  73 /* SWITCHDEV_OBJ_ID_PORT_VLAN */
  74 struct switchdev_obj_port_vlan {
  75         struct switchdev_obj obj;
  76         u16 flags;
  77         u16 vid_begin;
  78         u16 vid_end;
  79 };
  80
  81 #define SWITCHDEV_OBJ_PORT_VLAN(obj) \
  82         container_of(obj, struct switchdev_obj_port_vlan, obj)
  83
  84 /* SWITCHDEV_OBJ_ID_IPV4_FIB */
  85 struct switchdev_obj_ipv4_fib {
  86         struct switchdev_obj obj;
  87         u32 dst;
  88         int dst_len;
  89         struct fib_info *fi;
  90         u8 tos;
  91         u8 type;
  92         u32 nlflags;
  93         u32 tb_id;
  94 };
  95
  96 #define SWITCHDEV_OBJ_IPV4_FIB(obj) \
  97         container_of(obj, struct switchdev_obj_ipv4_fib, obj)
  98
  99 /* SWITCHDEV_OBJ_ID_PORT_FDB */
 100 struct switchdev_obj_port_fdb {
 101         struct switchdev_obj obj;
 102         const unsigned char *addr;
 103         u16 vid;
 104         u16 ndm_state;
 105 };
 106
 107 #define SWITCHDEV_OBJ_PORT_FDB(obj) \
 108         container_of(obj, struct switchdev_obj_port_fdb, obj)
 109
 110 void switchdev_trans_item_enqueue(struct switchdev_trans *trans,
 111                                   void *data, void (*destructor)(void const *),
 112                                   struct switchdev_trans_item *tritem);
 113 void *switchdev_trans_item_dequeue(struct switchdev_trans *trans);
 114
 115 typedef int switchdev_obj_dump_cb_t(struct switchdev_obj *obj);
 116
 117 /**
 118  * struct switchdev_ops - switchdev operations
 119  *
 120  * @switchdev_port_attr_get: Get a port attribute (see switchdev_attr).
 121  *
 122  * @switchdev_port_attr_set: Set a port attribute (see switchdev_attr).
 123  *
 124  * @switchdev_port_obj_add: Add an object to port (see switchdev_obj_*).
 125  *
 126  * @switchdev_port_obj_del: Delete an object from port (see switchdev_obj_*).
 127  *
 128  * @switchdev_port_obj_dump: Dump port objects (see switchdev_obj_*).
 129  */
 130 struct switchdev_ops {
 131         int     (*switchdev_port_attr_get)(struct net_device *dev,
 132                                            struct switchdev_attr *attr);
 133         int     (*switchdev_port_attr_set)(struct net_device *dev,
 134                                            struct switchdev_attr *attr,
 135                                            struct switchdev_trans *trans);
 136         int     (*switchdev_port_obj_add)(struct net_device *dev,
 137                                           const struct switchdev_obj *obj,
 138                                           struct switchdev_trans *trans);
 139         int     (*switchdev_port_obj_del)(struct net_device *dev,
 140                                           const struct switchdev_obj *obj);
 141         int     (*switchdev_port_obj_dump)(struct net_device *dev,
 142                                            struct switchdev_obj *obj,
 143                                            switchdev_obj_dump_cb_t *cb);
 144 };
 145
 146 enum switchdev_notifier_type {
 147         SWITCHDEV_FDB_ADD = 1,
 148         SWITCHDEV_FDB_DEL,
 149 };
 150
 151 struct switchdev_notifier_info {
 152         struct net_device *dev;
 153 };
 154
 155 struct switchdev_notifier_fdb_info {
 156         struct switchdev_notifier_info info; /* must be first */
 157         const unsigned char *addr;
 158         u16 vid;
 159 };
 160
 161 static inline struct net_device *
 162 switchdev_notifier_info_to_dev(const struct switchdev_notifier_info *info)
 163 {
 164         return info->dev;
 165 }
 166
 167 #ifdef CONFIG_NET_SWITCHDEV
 168
 169 int switchdev_port_attr_get(struct net_device *dev,
 170                             struct switchdev_attr *attr);
 171 int switchdev_port_attr_set(struct net_device *dev,
 172                             struct switchdev_attr *attr);
 173 int switchdev_port_obj_add(struct net_device *dev,
 174                            const struct switchdev_obj *obj);
 175 int switchdev_port_obj_del(struct net_device *dev,
 176                            const struct switchdev_obj *obj);
 177 int switchdev_port_obj_dump(struct net_device *dev, struct switchdev_obj *obj,
 178                             switchdev_obj_dump_cb_t *cb);
 179 int register_switchdev_notifier(struct notifier_block *nb);
 180 int unregister_switchdev_notifier(struct notifier_block *nb);
 181 int call_switchdev_notifiers(unsigned long val, struct net_device *dev,
 182                              struct switchdev_notifier_info *info);
 183 int switchdev_port_bridge_getlink(struct sk_buff *skb, u32 pid, u32 seq,
 184                                   struct net_device *dev, u32 filter_mask,
 185                                   int nlflags);
 186 int switchdev_port_bridge_setlink(struct net_device *dev,
 187                                   struct nlmsghdr *nlh, u16 flags);
 188 int switchdev_port_bridge_dellink(struct net_device *dev,
 189                                   struct nlmsghdr *nlh, u16 flags);
 190 int switchdev_fib_ipv4_add(u32 dst, int dst_len, struct fib_info *fi,
 191                            u8 tos, u8 type, u32 nlflags, u32 tb_id);
 192 int switchdev_fib_ipv4_del(u32 dst, int dst_len, struct fib_info *fi,
 193                            u8 tos, u8 type, u32 tb_id);
 194 void switchdev_fib_ipv4_abort(struct fib_info *fi);
 195 int switchdev_port_fdb_add(struct ndmsg *ndm, struct nlattr *tb[],
 196                            struct net_device *dev, const unsigned char *addr,
 197                            u16 vid, u16 nlm_flags);
 198 int switchdev_port_fdb_del(struct ndmsg *ndm, struct nlattr *tb[],
 199                            struct net_device *dev, const unsigned char *addr,
 200                            u16 vid);
 201 int switchdev_port_fdb_dump(struct sk_buff *skb, struct netlink_callback *cb,
 202                             struct net_device *dev,
 203                             struct net_device *filter_dev, int idx);
 204 void switchdev_port_fwd_mark_set(struct net_device *dev,
 205                                  struct net_device *group_dev,
 206                                  bool joining);
 207
 208 #else
 209
 210 static inline int switchdev_port_attr_get(struct net_device *dev,
 211                                           struct switchdev_attr *attr)
 212 {
 213         return -EOPNOTSUPP;
 214 }
 215
 216 static inline int switchdev_port_attr_set(struct net_device *dev,
 217                                           struct switchdev_attr *attr)
 218 {
 219         return -EOPNOTSUPP;
 220 }
 221
 222 static inline int switchdev_port_obj_add(struct net_device *dev,
 223                                          const struct switchdev_obj *obj)
 224 {
 225         return -EOPNOTSUPP;
 226 }
 227
 228 static inline int switchdev_port_obj_del(struct net_device *dev,
 229                                          const struct switchdev_obj *obj)
 230 {
 231         return -EOPNOTSUPP;
 232 }
 233
 234 static inline int switchdev_port_obj_dump(struct net_device *dev,
 235                                           const struct switchdev_obj *obj,
 236                                           switchdev_obj_dump_cb_t *cb)
 237 {
 238         return -EOPNOTSUPP;
 239 }
 240
 241 static inline int register_switchdev_notifier(struct notifier_block *nb)
 242 {
 243         return 0;
 244 }
 245
 246 static inline int unregister_switchdev_notifier(struct notifier_block *nb)
 247 {
 248         return 0;
 249 }
 250
 251 static inline int call_switchdev_notifiers(unsigned long val,
 252                                            struct net_device *dev,
 253                                            struct switchdev_notifier_info *info)
 254 {
 255         return NOTIFY_DONE;
 256 }
 257
 258 static inline int switchdev_port_bridge_getlink(struct sk_buff *skb, u32 pid,
 259                                             u32 seq, struct net_device *dev,
 260                                             u32 filter_mask, int nlflags)
 261 {
 262         return -EOPNOTSUPP;
 263 }
 264
 265 static inline int switchdev_port_bridge_setlink(struct net_device *dev,
 266                                                 struct nlmsghdr *nlh,
 267                                                 u16 flags)
 268 {
 269         return -EOPNOTSUPP;
 270 }
 271
 272 static inline int switchdev_port_bridge_dellink(struct net_device *dev,
 273                                                 struct nlmsghdr *nlh,
 274                                                 u16 flags)
 275 {
 276         return -EOPNOTSUPP;
 277 }
 278
 279 static inline int switchdev_fib_ipv4_add(u32 dst, int dst_len,
 280                                          struct fib_info *fi,
 281                                          u8 tos, u8 type,
 282                                          u32 nlflags, u32 tb_id)
 283 {
 284         return 0;
 285 }
 286
 287 static inline int switchdev_fib_ipv4_del(u32 dst, int dst_len,
 288                                          struct fib_info *fi,
 289                                          u8 tos, u8 type, u32 tb_id)
 290 {
 291         return 0;
 292 }
 293
 294 static inline void switchdev_fib_ipv4_abort(struct fib_info *fi)
 295 {
 296 }
 297
 298 static inline int switchdev_port_fdb_add(struct ndmsg *ndm, struct nlattr *tb[],
 299                                          struct net_device *dev,
 300                                          const unsigned char *addr,
 301                                          u16 vid, u16 nlm_flags)
 302 {
 303         return -EOPNOTSUPP;
 304 }
 305
 306 static inline int switchdev_port_fdb_del(struct ndmsg *ndm, struct nlattr *tb[],
 307                                          struct net_device *dev,
 308                                          const unsigned char *addr, u16 vid)
 309 {
 310         return -EOPNOTSUPP;
 311 }
 312
 313 static inline int switchdev_port_fdb_dump(struct sk_buff *skb,
 314                                           struct netlink_callback *cb,
 315                                           struct net_device *dev,
 316                                           struct net_device *filter_dev,
 317                                           int idx)
 318 {
 319         return -EOPNOTSUPP;
 320 }
 321
 322 static inline void switchdev_port_fwd_mark_set(struct net_device *dev,
 323                                                struct net_device *group_dev,
 324                                                bool joining)
 325 {
 326 }
 327
 328 #endif
 329
 330 #endif /* _LINUX_SWITCHDEV_H_ */