target/linux/generic/files/include/linux/switch.h

   1 /*
   2  * switch.h: Switch configuration API
   3  *
   4  * Copyright (C) 2008 Felix Fietkau <nbd@openwrt.org>
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  */
  16
  17 #ifndef __LINUX_SWITCH_H
  18 #define __LINUX_SWITCH_H
  19
  20 #include <linux/types.h>
  21 #include <linux/netdevice.h>
  22 #include <linux/netlink.h>
  23 #include <linux/genetlink.h>
  24 #ifndef __KERNEL__
  25 #include <netlink/netlink.h>
  26 #include <netlink/genl/genl.h>
  27 #include <netlink/genl/ctrl.h>
  28 #else
  29 #include <net/genetlink.h>
  30 #endif
  31
  32 /* main attributes */
  33 enum {
  34         SWITCH_ATTR_UNSPEC,
  35         /* global */
  36         SWITCH_ATTR_TYPE,
  37         /* device */
  38         SWITCH_ATTR_ID,
  39         SWITCH_ATTR_DEV_NAME,
  40         SWITCH_ATTR_ALIAS,
  41         SWITCH_ATTR_NAME,
  42         SWITCH_ATTR_VLANS,
  43         SWITCH_ATTR_PORTS,
  44         SWITCH_ATTR_CPU_PORT,
  45         /* attributes */
  46         SWITCH_ATTR_OP_ID,
  47         SWITCH_ATTR_OP_TYPE,
  48         SWITCH_ATTR_OP_NAME,
  49         SWITCH_ATTR_OP_PORT,
  50         SWITCH_ATTR_OP_VLAN,
  51         SWITCH_ATTR_OP_VALUE_INT,
  52         SWITCH_ATTR_OP_VALUE_STR,
  53         SWITCH_ATTR_OP_VALUE_PORTS,
  54         SWITCH_ATTR_OP_DESCRIPTION,
  55         /* port lists */
  56         SWITCH_ATTR_PORT,
  57         SWITCH_ATTR_MAX
  58 };
  59
  60 /* commands */
  61 enum {
  62         SWITCH_CMD_UNSPEC,
  63         SWITCH_CMD_GET_SWITCH,
  64         SWITCH_CMD_NEW_ATTR,
  65         SWITCH_CMD_LIST_GLOBAL,
  66         SWITCH_CMD_GET_GLOBAL,
  67         SWITCH_CMD_SET_GLOBAL,
  68         SWITCH_CMD_LIST_PORT,
  69         SWITCH_CMD_GET_PORT,
  70         SWITCH_CMD_SET_PORT,
  71         SWITCH_CMD_LIST_VLAN,
  72         SWITCH_CMD_GET_VLAN,
  73         SWITCH_CMD_SET_VLAN
  74 };
  75
  76 /* data types */
  77 enum switch_val_type {
  78         SWITCH_TYPE_UNSPEC,
  79         SWITCH_TYPE_INT,
  80         SWITCH_TYPE_STRING,
  81         SWITCH_TYPE_PORTS,
  82         SWITCH_TYPE_NOVAL,
  83 };
  84
  85 /* port nested attributes */
  86 enum {
  87         SWITCH_PORT_UNSPEC,
  88         SWITCH_PORT_ID,
  89         SWITCH_PORT_FLAG_TAGGED,
  90         SWITCH_PORT_ATTR_MAX
  91 };
  92
  93 #define SWITCH_ATTR_DEFAULTS_OFFSET     0x1000
  94
  95 #ifdef __KERNEL__
  96
  97 struct switch_dev;
  98 struct switch_op;
  99 struct switch_val;
 100 struct switch_attr;
 101 struct switch_attrlist;
 102 struct switch_led_trigger;
 103
 104 int register_switch(struct switch_dev *dev, struct net_device *netdev);
 105 void unregister_switch(struct switch_dev *dev);
 106
 107 /**
 108  * struct switch_attrlist - attribute list
 109  *
 110  * @n_attr: number of attributes
 111  * @attr: pointer to the attributes array
 112  */
 113 struct switch_attrlist {
 114         int n_attr;
 115         const struct switch_attr *attr;
 116 };
 117
 118 enum switch_port_speed {
 119         SWITCH_PORT_SPEED_UNKNOWN = 0,
 120         SWITCH_PORT_SPEED_10 = 10,
 121         SWITCH_PORT_SPEED_100 = 100,
 122         SWITCH_PORT_SPEED_1000 = 1000,
 123 };
 124
 125 struct switch_port_link {
 126         bool link;
 127         bool duplex;
 128         bool aneg;
 129         bool tx_flow;
 130         bool rx_flow;
 131         enum switch_port_speed speed;
 132 };
 133
 134 struct switch_port_stats {
 135         unsigned long tx_bytes;
 136         unsigned long rx_bytes;
 137 };
 138
 139 /**
 140  * struct switch_dev_ops - switch driver operations
 141  *
 142  * @attr_global: global switch attribute list
 143  * @attr_port: port attribute list
 144  * @attr_vlan: vlan attribute list
 145  *
 146  * Callbacks:
 147  *
 148  * @get_vlan_ports: read the port list of a VLAN
 149  * @set_vlan_ports: set the port list of a VLAN
 150  *
 151  * @get_port_pvid: get the primary VLAN ID of a port
 152  * @set_port_pvid: set the primary VLAN ID of a port
 153  *
 154  * @apply_config: apply all changed settings to the switch
 155  * @reset_switch: resetting the switch
 156  */
 157 struct switch_dev_ops {
 158         struct switch_attrlist attr_global, attr_port, attr_vlan;
 159
 160         int (*get_vlan_ports)(struct switch_dev *dev, struct switch_val *val);
 161         int (*set_vlan_ports)(struct switch_dev *dev, struct switch_val *val);
 162
 163         int (*get_port_pvid)(struct switch_dev *dev, int port, int *val);
 164         int (*set_port_pvid)(struct switch_dev *dev, int port, int val);
 165
 166         int (*apply_config)(struct switch_dev *dev);
 167         int (*reset_switch)(struct switch_dev *dev);
 168
 169         int (*get_port_link)(struct switch_dev *dev, int port,
 170                              struct switch_port_link *link);
 171         int (*get_port_stats)(struct switch_dev *dev, int port,
 172                               struct switch_port_stats *stats);
 173 };
 174
 175 struct switch_dev {
 176         const struct switch_dev_ops *ops;
 177         /* will be automatically filled */
 178         char devname[IFNAMSIZ];
 179
 180         const char *name;
 181         /* NB: either alias or netdev must be set */
 182         const char *alias;
 183         struct net_device *netdev;
 184
 185         int ports;
 186         int vlans;
 187         int cpu_port;
 188
 189         /* the following fields are internal for swconfig */
 190         int id;
 191         struct list_head dev_list;
 192         unsigned long def_global, def_port, def_vlan;
 193
 194         spinlock_t lock;
 195         struct switch_port *portbuf;
 196
 197         char buf[128];
 198
 199 #ifdef CONFIG_SWCONFIG_LEDS
 200         struct switch_led_trigger *led_trigger;
 201 #endif
 202 };
 203
 204 struct switch_port {
 205         u32 id;
 206         u32 flags;
 207 };
 208
 209 struct switch_val {
 210         const struct switch_attr *attr;
 211         int port_vlan;
 212         int len;
 213         union {
 214                 const char *s;
 215                 u32 i;
 216                 struct switch_port *ports;
 217         } value;
 218 };
 219
 220 struct switch_attr {
 221         int disabled;
 222         int type;
 223         const char *name;
 224         const char *description;
 225
 226         int (*set)(struct switch_dev *dev, const struct switch_attr *attr, struct switch_val *val);
 227         int (*get)(struct switch_dev *dev, const struct switch_attr *attr, struct switch_val *val);
 228
 229         /* for driver internal use */
 230         int id;
 231         int ofs;
 232         int max;
 233 };
 234
 235 #endif
 236
 237 #endif