Root/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 */
33enum {
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 */
61enum {
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 */
77enum 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 */
86enum {
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
97struct switch_dev;
98struct switch_op;
99struct switch_val;
100struct switch_attr;
101struct switch_attrlist;
102
103int register_switch(struct switch_dev *dev, struct net_device *netdev);
104void unregister_switch(struct switch_dev *dev);
105
106/**
107 * struct switch_attrlist - attribute list
108 *
109 * @n_attr: number of attributes
110 * @attr: pointer to the attributes array
111 */
112struct switch_attrlist {
113    int n_attr;
114    const struct switch_attr *attr;
115};
116
117/**
118 * struct switch_dev_ops - switch driver operations
119 *
120 * @attr_global: global switch attribute list
121 * @attr_port: port attribute list
122 * @attr_vlan: vlan attribute list
123 *
124 * Callbacks:
125 *
126 * @get_vlan_ports: read the port list of a VLAN
127 * @set_vlan_ports: set the port list of a VLAN
128 *
129 * @get_port_pvid: get the primary VLAN ID of a port
130 * @set_port_pvid: set the primary VLAN ID of a port
131 *
132 * @apply_config: apply all changed settings to the switch
133 * @reset_switch: resetting the switch
134 */
135struct switch_dev_ops {
136    struct switch_attrlist attr_global, attr_port, attr_vlan;
137
138    int (*get_vlan_ports)(struct switch_dev *dev, struct switch_val *val);
139    int (*set_vlan_ports)(struct switch_dev *dev, struct switch_val *val);
140
141    int (*get_port_pvid)(struct switch_dev *dev, int port, int *val);
142    int (*set_port_pvid)(struct switch_dev *dev, int port, int val);
143
144    int (*apply_config)(struct switch_dev *dev);
145    int (*reset_switch)(struct switch_dev *dev);
146};
147
148struct switch_dev {
149    const struct switch_dev_ops *ops;
150    /* will be automatically filled */
151    char devname[IFNAMSIZ];
152
153    const char *name;
154    /* NB: either alias or netdev must be set */
155    const char *alias;
156    struct net_device *netdev;
157
158    int ports;
159    int vlans;
160    int cpu_port;
161
162    /* the following fields are internal for swconfig */
163    int id;
164    struct list_head dev_list;
165    unsigned long def_global, def_port, def_vlan;
166
167    spinlock_t lock;
168    struct switch_port *portbuf;
169};
170
171struct switch_port {
172    u32 id;
173    u32 flags;
174};
175
176struct switch_val {
177    const struct switch_attr *attr;
178    int port_vlan;
179    int len;
180    union {
181        const char *s;
182        u32 i;
183        struct switch_port *ports;
184    } value;
185};
186
187struct switch_attr {
188    int disabled;
189    int type;
190    const char *name;
191    const char *description;
192
193    int (*set)(struct switch_dev *dev, const struct switch_attr *attr, struct switch_val *val);
194    int (*get)(struct switch_dev *dev, const struct switch_attr *attr, struct switch_val *val);
195
196    /* for driver internal use */
197    int id;
198    int ofs;
199    int max;
200};
201
202#endif
203
204#endif
205

Archive Download this file



interactive