[PATCH] Document how to decode an IOCTL number
[linux-2.6.22.y-op.git] / net / bridge / br_private.h
blob3a534e94c7f3db084e7b501dcf48dfe72038ec28
1 /*
2 * Linux ethernet bridge
4 * Authors:
5 * Lennert Buytenhek <buytenh@gnu.org>
7 * $Id: br_private.h,v 1.7 2001/12/24 00:59:55 davem Exp $
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version
12 * 2 of the License, or (at your option) any later version.
15 #ifndef _BR_PRIVATE_H
16 #define _BR_PRIVATE_H
18 #include <linux/netdevice.h>
19 #include <linux/miscdevice.h>
20 #include <linux/if_bridge.h>
22 #define BR_HASH_BITS 8
23 #define BR_HASH_SIZE (1 << BR_HASH_BITS)
25 #define BR_HOLD_TIME (1*HZ)
27 #define BR_PORT_BITS 10
28 #define BR_MAX_PORTS (1<<BR_PORT_BITS)
30 #define BR_PORT_DEBOUNCE (HZ/10)
32 #define BR_VERSION "2.2"
34 typedef struct bridge_id bridge_id;
35 typedef struct mac_addr mac_addr;
36 typedef __u16 port_id;
38 struct bridge_id
40 unsigned char prio[2];
41 unsigned char addr[6];
44 struct mac_addr
46 unsigned char addr[6];
49 struct net_bridge_fdb_entry
51 struct hlist_node hlist;
52 struct net_bridge_port *dst;
54 struct rcu_head rcu;
55 atomic_t use_count;
56 unsigned long ageing_timer;
57 mac_addr addr;
58 unsigned char is_local;
59 unsigned char is_static;
62 struct net_bridge_port
64 struct net_bridge *br;
65 struct net_device *dev;
66 struct list_head list;
68 /* STP */
69 u8 priority;
70 u8 state;
71 u16 port_no;
72 unsigned char topology_change_ack;
73 unsigned char config_pending;
74 port_id port_id;
75 port_id designated_port;
76 bridge_id designated_root;
77 bridge_id designated_bridge;
78 u32 path_cost;
79 u32 designated_cost;
81 struct timer_list forward_delay_timer;
82 struct timer_list hold_timer;
83 struct timer_list message_age_timer;
84 struct kobject kobj;
85 struct delayed_work carrier_check;
86 struct rcu_head rcu;
89 struct net_bridge
91 spinlock_t lock;
92 struct list_head port_list;
93 struct net_device *dev;
94 struct net_device_stats statistics;
95 spinlock_t hash_lock;
96 struct hlist_head hash[BR_HASH_SIZE];
97 struct list_head age_list;
98 unsigned long feature_mask;
100 /* STP */
101 bridge_id designated_root;
102 bridge_id bridge_id;
103 u32 root_path_cost;
104 unsigned long max_age;
105 unsigned long hello_time;
106 unsigned long forward_delay;
107 unsigned long bridge_max_age;
108 unsigned long ageing_time;
109 unsigned long bridge_hello_time;
110 unsigned long bridge_forward_delay;
112 u8 group_addr[ETH_ALEN];
113 u16 root_port;
114 unsigned char stp_enabled;
115 unsigned char topology_change;
116 unsigned char topology_change_detected;
118 struct timer_list hello_timer;
119 struct timer_list tcn_timer;
120 struct timer_list topology_change_timer;
121 struct timer_list gc_timer;
122 struct kobject ifobj;
125 extern struct notifier_block br_device_notifier;
126 extern const u8 br_group_address[ETH_ALEN];
128 /* called under bridge lock */
129 static inline int br_is_root_bridge(const struct net_bridge *br)
131 return !memcmp(&br->bridge_id, &br->designated_root, 8);
135 /* br_device.c */
136 extern void br_dev_setup(struct net_device *dev);
137 extern int br_dev_xmit(struct sk_buff *skb, struct net_device *dev);
139 /* br_fdb.c */
140 extern void br_fdb_init(void);
141 extern void br_fdb_fini(void);
142 extern void br_fdb_changeaddr(struct net_bridge_port *p,
143 const unsigned char *newaddr);
144 extern void br_fdb_cleanup(unsigned long arg);
145 extern void br_fdb_delete_by_port(struct net_bridge *br,
146 const struct net_bridge_port *p, int do_all);
147 extern struct net_bridge_fdb_entry *__br_fdb_get(struct net_bridge *br,
148 const unsigned char *addr);
149 extern struct net_bridge_fdb_entry *br_fdb_get(struct net_bridge *br,
150 unsigned char *addr);
151 extern void br_fdb_put(struct net_bridge_fdb_entry *ent);
152 extern int br_fdb_fillbuf(struct net_bridge *br, void *buf,
153 unsigned long count, unsigned long off);
154 extern int br_fdb_insert(struct net_bridge *br,
155 struct net_bridge_port *source,
156 const unsigned char *addr);
157 extern void br_fdb_update(struct net_bridge *br,
158 struct net_bridge_port *source,
159 const unsigned char *addr);
161 /* br_forward.c */
162 extern void br_deliver(const struct net_bridge_port *to,
163 struct sk_buff *skb);
164 extern int br_dev_queue_push_xmit(struct sk_buff *skb);
165 extern void br_forward(const struct net_bridge_port *to,
166 struct sk_buff *skb);
167 extern int br_forward_finish(struct sk_buff *skb);
168 extern void br_flood_deliver(struct net_bridge *br,
169 struct sk_buff *skb,
170 int clone);
171 extern void br_flood_forward(struct net_bridge *br,
172 struct sk_buff *skb,
173 int clone);
175 /* br_if.c */
176 extern int br_add_bridge(const char *name);
177 extern int br_del_bridge(const char *name);
178 extern void br_cleanup_bridges(void);
179 extern int br_add_if(struct net_bridge *br,
180 struct net_device *dev);
181 extern int br_del_if(struct net_bridge *br,
182 struct net_device *dev);
183 extern int br_min_mtu(const struct net_bridge *br);
184 extern void br_features_recompute(struct net_bridge *br);
186 /* br_input.c */
187 extern int br_handle_frame_finish(struct sk_buff *skb);
188 extern int br_handle_frame(struct net_bridge_port *p, struct sk_buff **pskb);
190 /* br_ioctl.c */
191 extern int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
192 extern int br_ioctl_deviceless_stub(unsigned int cmd, void __user *arg);
194 /* br_netfilter.c */
195 #ifdef CONFIG_BRIDGE_NETFILTER
196 extern int br_netfilter_init(void);
197 extern void br_netfilter_fini(void);
198 #else
199 #define br_netfilter_init() (0)
200 #define br_netfilter_fini() do { } while(0)
201 #endif
203 /* br_stp.c */
204 extern void br_log_state(const struct net_bridge_port *p);
205 extern struct net_bridge_port *br_get_port(struct net_bridge *br,
206 u16 port_no);
207 extern void br_init_port(struct net_bridge_port *p);
208 extern void br_become_designated_port(struct net_bridge_port *p);
210 /* br_stp_if.c */
211 extern void br_stp_enable_bridge(struct net_bridge *br);
212 extern void br_stp_disable_bridge(struct net_bridge *br);
213 extern void br_stp_enable_port(struct net_bridge_port *p);
214 extern void br_stp_disable_port(struct net_bridge_port *p);
215 extern void br_stp_recalculate_bridge_id(struct net_bridge *br);
216 extern void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
217 extern void br_stp_set_bridge_priority(struct net_bridge *br,
218 u16 newprio);
219 extern void br_stp_set_port_priority(struct net_bridge_port *p,
220 u8 newprio);
221 extern void br_stp_set_path_cost(struct net_bridge_port *p,
222 u32 path_cost);
223 extern ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);
225 /* br_stp_bpdu.c */
226 extern int br_stp_rcv(struct sk_buff *skb, struct net_device *dev,
227 struct packet_type *pt, struct net_device *orig_dev);
229 /* br_stp_timer.c */
230 extern void br_stp_timer_init(struct net_bridge *br);
231 extern void br_stp_port_timer_init(struct net_bridge_port *p);
232 extern unsigned long br_timer_value(const struct timer_list *timer);
234 /* br.c */
235 extern struct net_bridge_fdb_entry *(*br_fdb_get_hook)(struct net_bridge *br,
236 unsigned char *addr);
237 extern void (*br_fdb_put_hook)(struct net_bridge_fdb_entry *ent);
240 /* br_netlink.c */
241 extern void br_netlink_init(void);
242 extern void br_netlink_fini(void);
243 extern void br_ifinfo_notify(int event, struct net_bridge_port *port);
245 #ifdef CONFIG_SYSFS
246 /* br_sysfs_if.c */
247 extern struct sysfs_ops brport_sysfs_ops;
248 extern int br_sysfs_addif(struct net_bridge_port *p);
250 /* br_sysfs_br.c */
251 extern int br_sysfs_addbr(struct net_device *dev);
252 extern void br_sysfs_delbr(struct net_device *dev);
254 #else
256 #define br_sysfs_addif(p) (0)
257 #define br_sysfs_addbr(dev) (0)
258 #define br_sysfs_delbr(dev) do { } while(0)
259 #endif /* CONFIG_SYSFS */
261 #endif