xref: /linux-6.15/include/uapi/linux/if_bridge.h (revision dc642e83)
1 /*
2  *	Linux ethernet bridge
3  *
4  *	Authors:
5  *	Lennert Buytenhek		<[email protected]>
6  *
7  *	This program is free software; you can redistribute it and/or
8  *	modify it under the terms of the GNU General Public License
9  *	as published by the Free Software Foundation; either version
10  *	2 of the License, or (at your option) any later version.
11  */
12 
13 #ifndef _UAPI_LINUX_IF_BRIDGE_H
14 #define _UAPI_LINUX_IF_BRIDGE_H
15 
16 #include <linux/types.h>
17 #include <linux/if_ether.h>
18 #include <linux/in6.h>
19 
20 #define SYSFS_BRIDGE_ATTR	"bridge"
21 #define SYSFS_BRIDGE_FDB	"brforward"
22 #define SYSFS_BRIDGE_PORT_SUBDIR "brif"
23 #define SYSFS_BRIDGE_PORT_ATTR	"brport"
24 #define SYSFS_BRIDGE_PORT_LINK	"bridge"
25 
26 #define BRCTL_VERSION 1
27 
28 #define BRCTL_GET_VERSION 0
29 #define BRCTL_GET_BRIDGES 1
30 #define BRCTL_ADD_BRIDGE 2
31 #define BRCTL_DEL_BRIDGE 3
32 #define BRCTL_ADD_IF 4
33 #define BRCTL_DEL_IF 5
34 #define BRCTL_GET_BRIDGE_INFO 6
35 #define BRCTL_GET_PORT_LIST 7
36 #define BRCTL_SET_BRIDGE_FORWARD_DELAY 8
37 #define BRCTL_SET_BRIDGE_HELLO_TIME 9
38 #define BRCTL_SET_BRIDGE_MAX_AGE 10
39 #define BRCTL_SET_AGEING_TIME 11
40 #define BRCTL_SET_GC_INTERVAL 12
41 #define BRCTL_GET_PORT_INFO 13
42 #define BRCTL_SET_BRIDGE_STP_STATE 14
43 #define BRCTL_SET_BRIDGE_PRIORITY 15
44 #define BRCTL_SET_PORT_PRIORITY 16
45 #define BRCTL_SET_PATH_COST 17
46 #define BRCTL_GET_FDB_ENTRIES 18
47 
48 #define BR_STATE_DISABLED 0
49 #define BR_STATE_LISTENING 1
50 #define BR_STATE_LEARNING 2
51 #define BR_STATE_FORWARDING 3
52 #define BR_STATE_BLOCKING 4
53 
54 struct __bridge_info {
55 	__u64 designated_root;
56 	__u64 bridge_id;
57 	__u32 root_path_cost;
58 	__u32 max_age;
59 	__u32 hello_time;
60 	__u32 forward_delay;
61 	__u32 bridge_max_age;
62 	__u32 bridge_hello_time;
63 	__u32 bridge_forward_delay;
64 	__u8 topology_change;
65 	__u8 topology_change_detected;
66 	__u8 root_port;
67 	__u8 stp_enabled;
68 	__u32 ageing_time;
69 	__u32 gc_interval;
70 	__u32 hello_timer_value;
71 	__u32 tcn_timer_value;
72 	__u32 topology_change_timer_value;
73 	__u32 gc_timer_value;
74 };
75 
76 struct __port_info {
77 	__u64 designated_root;
78 	__u64 designated_bridge;
79 	__u16 port_id;
80 	__u16 designated_port;
81 	__u32 path_cost;
82 	__u32 designated_cost;
83 	__u8 state;
84 	__u8 top_change_ack;
85 	__u8 config_pending;
86 	__u8 unused0;
87 	__u32 message_age_timer_value;
88 	__u32 forward_delay_timer_value;
89 	__u32 hold_timer_value;
90 };
91 
92 struct __fdb_entry {
93 	__u8 mac_addr[ETH_ALEN];
94 	__u8 port_no;
95 	__u8 is_local;
96 	__u32 ageing_timer_value;
97 	__u8 port_hi;
98 	__u8 pad0;
99 	__u16 unused;
100 };
101 
102 /* Bridge Flags */
103 #define BRIDGE_FLAGS_MASTER	1	/* Bridge command to/from master */
104 #define BRIDGE_FLAGS_SELF	2	/* Bridge command to/from lowerdev */
105 
106 #define BRIDGE_MODE_VEB		0	/* Default loopback mode */
107 #define BRIDGE_MODE_VEPA	1	/* 802.1Qbg defined VEPA mode */
108 #define BRIDGE_MODE_UNDEF	0xFFFF  /* mode undefined */
109 
110 /* Bridge management nested attributes
111  * [IFLA_AF_SPEC] = {
112  *     [IFLA_BRIDGE_FLAGS]
113  *     [IFLA_BRIDGE_MODE]
114  *     [IFLA_BRIDGE_VLAN_INFO]
115  * }
116  */
117 enum {
118 	IFLA_BRIDGE_FLAGS,
119 	IFLA_BRIDGE_MODE,
120 	IFLA_BRIDGE_VLAN_INFO,
121 	__IFLA_BRIDGE_MAX,
122 };
123 #define IFLA_BRIDGE_MAX (__IFLA_BRIDGE_MAX - 1)
124 
125 #define BRIDGE_VLAN_INFO_MASTER	(1<<0)	/* Operate on Bridge device as well */
126 #define BRIDGE_VLAN_INFO_PVID	(1<<1)	/* VLAN is PVID, ingress untagged */
127 #define BRIDGE_VLAN_INFO_UNTAGGED	(1<<2)	/* VLAN egresses untagged */
128 #define BRIDGE_VLAN_INFO_RANGE_BEGIN	(1<<3) /* VLAN is start of vlan range */
129 #define BRIDGE_VLAN_INFO_RANGE_END	(1<<4) /* VLAN is end of vlan range */
130 #define BRIDGE_VLAN_INFO_BRENTRY	(1<<5) /* Global bridge VLAN entry */
131 
132 struct bridge_vlan_info {
133 	__u16 flags;
134 	__u16 vid;
135 };
136 
137 /* Bridge multicast database attributes
138  * [MDBA_MDB] = {
139  *     [MDBA_MDB_ENTRY] = {
140  *         [MDBA_MDB_ENTRY_INFO] {
141  *		struct br_mdb_entry
142  *		[MDBA_MDB_EATTR attributes]
143  *         }
144  *     }
145  * }
146  * [MDBA_ROUTER] = {
147  *    [MDBA_ROUTER_PORT] = {
148  *        u32 ifindex
149  *        [MDBA_ROUTER_PATTR attributes]
150  *    }
151  * }
152  */
153 enum {
154 	MDBA_UNSPEC,
155 	MDBA_MDB,
156 	MDBA_ROUTER,
157 	__MDBA_MAX,
158 };
159 #define MDBA_MAX (__MDBA_MAX - 1)
160 
161 enum {
162 	MDBA_MDB_UNSPEC,
163 	MDBA_MDB_ENTRY,
164 	__MDBA_MDB_MAX,
165 };
166 #define MDBA_MDB_MAX (__MDBA_MDB_MAX - 1)
167 
168 enum {
169 	MDBA_MDB_ENTRY_UNSPEC,
170 	MDBA_MDB_ENTRY_INFO,
171 	__MDBA_MDB_ENTRY_MAX,
172 };
173 #define MDBA_MDB_ENTRY_MAX (__MDBA_MDB_ENTRY_MAX - 1)
174 
175 /* per mdb entry additional attributes */
176 enum {
177 	MDBA_MDB_EATTR_UNSPEC,
178 	MDBA_MDB_EATTR_TIMER,
179 	__MDBA_MDB_EATTR_MAX
180 };
181 #define MDBA_MDB_EATTR_MAX (__MDBA_MDB_EATTR_MAX - 1)
182 
183 /* multicast router types */
184 enum {
185 	MDB_RTR_TYPE_DISABLED,
186 	MDB_RTR_TYPE_TEMP_QUERY,
187 	MDB_RTR_TYPE_PERM,
188 	MDB_RTR_TYPE_TEMP
189 };
190 
191 enum {
192 	MDBA_ROUTER_UNSPEC,
193 	MDBA_ROUTER_PORT,
194 	__MDBA_ROUTER_MAX,
195 };
196 #define MDBA_ROUTER_MAX (__MDBA_ROUTER_MAX - 1)
197 
198 /* router port attributes */
199 enum {
200 	MDBA_ROUTER_PATTR_UNSPEC,
201 	MDBA_ROUTER_PATTR_TIMER,
202 	MDBA_ROUTER_PATTR_TYPE,
203 	__MDBA_ROUTER_PATTR_MAX
204 };
205 #define MDBA_ROUTER_PATTR_MAX (__MDBA_ROUTER_PATTR_MAX - 1)
206 
207 struct br_port_msg {
208 	__u8  family;
209 	__u32 ifindex;
210 };
211 
212 struct br_mdb_entry {
213 	__u32 ifindex;
214 #define MDB_TEMPORARY 0
215 #define MDB_PERMANENT 1
216 	__u8 state;
217 #define MDB_FLAGS_OFFLOAD	(1 << 0)
218 	__u8 flags;
219 	__u16 vid;
220 	struct {
221 		union {
222 			__be32	ip4;
223 			struct in6_addr ip6;
224 		} u;
225 		__be16		proto;
226 	} addr;
227 };
228 
229 enum {
230 	MDBA_SET_ENTRY_UNSPEC,
231 	MDBA_SET_ENTRY,
232 	__MDBA_SET_ENTRY_MAX,
233 };
234 #define MDBA_SET_ENTRY_MAX (__MDBA_SET_ENTRY_MAX - 1)
235 
236 #endif /* _UAPI_LINUX_IF_BRIDGE_H */
237