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