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 #ifndef _LINUX_SWITCH_H
  17 #define _LINUX_SWITCH_H
  18
  19 #include <net/genetlink.h>
  20 #include <uapi/linux/switch.h>
  21
  22 struct switch_dev;
  23 struct switch_op;
  24 struct switch_val;
  25 struct switch_attr;
  26 struct switch_attrlist;
  27 struct switch_led_trigger;
  28
  29 int register_switch(struct switch_dev *dev, struct net_device *netdev);
  30 void unregister_switch(struct switch_dev *dev);
  31
  32 /**
  33  * struct switch_attrlist - attribute list
  34  *
  35  * @n_attr: number of attributes
  36  * @attr: pointer to the attributes array
  37  */
  38 struct switch_attrlist {
  39         int n_attr;
  40         const struct switch_attr *attr;
  41 };
  42
  43 enum switch_port_speed {
  44         SWITCH_PORT_SPEED_UNKNOWN = 0,
  45         SWITCH_PORT_SPEED_10 = 10,
  46         SWITCH_PORT_SPEED_100 = 100,
  47         SWITCH_PORT_SPEED_1000 = 1000,
  48 };
  49
  50 struct switch_port_link {
  51         bool link;
  52         bool duplex;
  53         bool aneg;
  54         bool tx_flow;
  55         bool rx_flow;
  56         enum switch_port_speed speed;
  57 };
  58
  59 struct switch_port_stats {
  60         unsigned long tx_bytes;
  61         unsigned long rx_bytes;
  62 };
  63
  64 /**
  65  * struct switch_dev_ops - switch driver operations
  66  *
  67  * @attr_global: global switch attribute list
  68  * @attr_port: port attribute list
  69  * @attr_vlan: vlan attribute list
  70  *
  71  * Callbacks:
  72  *
  73  * @get_vlan_ports: read the port list of a VLAN
  74  * @set_vlan_ports: set the port list of a VLAN
  75  *
  76  * @get_port_pvid: get the primary VLAN ID of a port
  77  * @set_port_pvid: set the primary VLAN ID of a port
  78  *
  79  * @apply_config: apply all changed settings to the switch
  80  * @reset_switch: resetting the switch
  81  */
  82 struct switch_dev_ops {
  83         struct switch_attrlist attr_global, attr_port, attr_vlan;
  84
  85         int (*get_vlan_ports)(struct switch_dev *dev, struct switch_val *val);
  86         int (*set_vlan_ports)(struct switch_dev *dev, struct switch_val *val);
  87
  88         int (*get_port_pvid)(struct switch_dev *dev, int port, int *val);
  89         int (*set_port_pvid)(struct switch_dev *dev, int port, int val);
  90
  91         int (*apply_config)(struct switch_dev *dev);
  92         int (*reset_switch)(struct switch_dev *dev);
  93
  94         int (*get_port_link)(struct switch_dev *dev, int port,
  95                              struct switch_port_link *link);
  96         int (*get_port_stats)(struct switch_dev *dev, int port,
  97                               struct switch_port_stats *stats);
  98 };
  99
 100 struct switch_dev {
 101         struct device_node *of_node;
 102         const struct switch_dev_ops *ops;
 103         /* will be automatically filled */
 104         char devname[IFNAMSIZ];
 105
 106         const char *name;
 107         /* NB: either alias or netdev must be set */
 108         const char *alias;
 109         struct net_device *netdev;
 110
 111         int ports;
 112         int vlans;
 113         int cpu_port;
 114
 115         /* the following fields are internal for swconfig */
 116         int id;
 117         struct list_head dev_list;
 118         unsigned long def_global, def_port, def_vlan;
 119
 120         struct mutex sw_mutex;
 121         struct switch_port *portbuf;
 122         struct switch_portmap *portmap;
 123
 124         char buf[128];
 125
 126 #ifdef CONFIG_SWCONFIG_LEDS
 127         struct switch_led_trigger *led_trigger;
 128 #endif
 129 };
 130
 131 struct switch_port {
 132         u32 id;
 133         u32 flags;
 134 };
 135
 136 struct switch_portmap {
 137         u32 virt;
 138         const char *s;
 139 };
 140
 141 struct switch_val {
 142         const struct switch_attr *attr;
 143         int port_vlan;
 144         int len;
 145         union {
 146                 const char *s;
 147                 u32 i;
 148                 struct switch_port *ports;
 149         } value;
 150 };
 151
 152 struct switch_attr {
 153         int disabled;
 154         int type;
 155         const char *name;
 156         const char *description;
 157
 158         int (*set)(struct switch_dev *dev, const struct switch_attr *attr, struct switch_val *val);
 159         int (*get)(struct switch_dev *dev, const struct switch_attr *attr, struct switch_val *val);
 160
 161         /* for driver internal use */
 162         int id;
 163         int ofs;
 164         int max;
 165 };
 166
 167 #endif /* _LINUX_SWITCH_H */