ieee80211_mesh.h revision 234890
1/*-
2 * Copyright (c) 2009 The FreeBSD Foundation
3 * All rights reserved.
4 *
5 * This software was developed by Rui Paulo under sponsorship from the
6 * FreeBSD Foundation.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * $FreeBSD: head/sys/net80211/ieee80211_mesh.h 234890 2012-05-01 16:12:39Z monthadar $
30 */
31#ifndef _NET80211_IEEE80211_MESH_H_
32#define _NET80211_IEEE80211_MESH_H_
33
34#define	IEEE80211_MESH_DEFAULT_TTL	31
35#define	IEEE80211_MESH_MAX_NEIGHBORS	15
36
37/*
38 * NB: all structures are __packed  so sizeof works on arm, et. al.
39 */
40/*
41 * 802.11s Information Elements.
42*/
43/* Mesh Configuration */
44#define IEEE80211_MESH_CONF_SZ		(7)
45struct ieee80211_meshconf_ie {
46	uint8_t		conf_ie;	/* IEEE80211_ELEMID_MESHCONF */
47	uint8_t		conf_len;
48	uint8_t		conf_pselid;	/* Active Path Sel. Proto. ID */
49	uint8_t		conf_pmetid;	/* Active Metric Identifier */
50	uint8_t		conf_ccid;	/* Congestion Control Mode ID  */
51	uint8_t		conf_syncid;	/* Sync. Protocol ID */
52	uint8_t		conf_authid;	/* Auth. Protocol ID */
53	uint8_t		conf_form;	/* Formation Information */
54	uint8_t		conf_cap;
55} __packed;
56
57/* Hybrid Wireless Mesh Protocol */
58enum {
59	/* 0 reserved */
60	IEEE80211_MESHCONF_PATH_HWMP		= 1,
61	/* 2-254 reserved */
62	IEEE80211_MESHCONF_PATH_VENDOR		= 255,
63};
64
65/* Airtime Link Metric */
66enum {
67	/* 0 reserved */
68	IEEE80211_MESHCONF_METRIC_AIRTIME	= 1,
69	/* 2-254 reserved */
70	IEEE80211_MESHCONF_METRIC_VENDOR	= 255,
71};
72
73/* Congestion Control */
74enum {
75	IEEE80211_MESHCONF_CC_DISABLED		= 0,
76	IEEE80211_MESHCONF_CC_SIG		= 1,
77	/* 2-254 reserved */
78	IEEE80211_MESHCONF_CC_VENDOR		= 255,
79};
80
81/* Neighbour Offset */
82enum {
83	/* 0 reserved */
84	IEEE80211_MESHCONF_SYNC_NEIGHOFF	= 1,
85	/* 2-254 rserved */
86	IEEE80211_MESHCONF_SYNC_VENDOR		= 255,
87};
88
89/* Authentication Protocol Identifier */
90enum {
91
92	IEEE80211_MESHCONF_AUTH_DISABLED	= 0,
93	/* Simultaneous Authenticaction of Equals */
94	IEEE80211_MESHCONF_AUTH_SEA		= 1,
95	IEEE80211_MESHCONF_AUTH_8021X		= 2, /* IEEE 802.1X */
96	/* 3-254 reserved */
97	IEEE80211_MESHCONF_AUTH_VENDOR		= 255,
98};
99
100/* Mesh Formation Info */
101#define	IEEE80211_MESHCONF_FORM_MP	0x01 	/* Connected to Portal */
102#define	IEEE80211_MESHCONF_FORM_NNEIGH_MASK 0x7E /* Number of Neighbours */
103#define	IEEE80211_MESHCONF_FORM_SA	0xF0 	/* indicating 802.1X auth */
104
105/* Mesh Capability */
106#define	IEEE80211_MESHCONF_CAP_AP	0x01	/* Accepting Peers */
107#define	IEEE80211_MESHCONF_CAP_MCCAS	0x02	/* MCCA supported */
108#define	IEEE80211_MESHCONF_CAP_MCCAE	0x04	/* MCCA enabled */
109#define	IEEE80211_MESHCONF_CAP_FWRD 	0x08	/* forwarding enabled */
110#define	IEEE80211_MESHCONF_CAP_BTR	0x10	/* Beacon Timing Report Enab */
111#define	IEEE80211_MESHCONF_CAP_TBTT	0x20	/* TBTT Adjusting  */
112#define	IEEE80211_MESHCONF_CAP_PSL	0x40	/* Power Save Level */
113/* 0x80 reserved */
114
115/* Mesh Identifier */
116struct ieee80211_meshid_ie {
117	uint8_t		id_ie;		/* IEEE80211_ELEMID_MESHID */
118	uint8_t		id_len;
119} __packed;
120
121/* Link Metric Report */
122struct ieee80211_meshlmetric_ie {
123	uint8_t		lm_ie;	/* IEEE80211_ACTION_MESH_LMETRIC */
124	uint8_t		lm_len;
125	uint8_t		lm_flags;
126#define	IEEE80211_MESH_LMETRIC_FLAGS_REQ	0x01	/* Request */
127	/*
128	 * XXX: this field should be variable in size and depend on
129	 * the active active path selection metric identifier
130	 */
131	uint32_t	lm_metric;
132#define	IEEE80211_MESHLMETRIC_INITIALVAL	0
133} __packed;
134
135/* Congestion Notification */
136struct ieee80211_meshcngst_ie {
137	uint8_t		cngst_ie;	/* IEEE80211_ELEMID_MESHCNGST */
138	uint8_t		cngst_len;
139	uint16_t	cngst_timer[4];	/* Expiration Timers: AC_BK,
140					   AC_BE, AC_VI, AC_VO */
141} __packed;
142
143/* Peer Link Management */
144#define IEEE80211_MPM_BASE_SZ	(4)
145#define IEEE80211_MPM_MAX_SZ	(8)
146struct ieee80211_meshpeer_ie {
147	uint8_t		peer_ie;	/* IEEE80211_ELEMID_MESHPEER */
148	uint8_t		peer_len;
149	uint16_t	peer_proto;	/* Peer Management Protocol */
150	uint16_t	peer_llinkid;	/* Local Link ID */
151	uint16_t	peer_linkid;	/* Peer Link ID */
152	uint16_t	peer_rcode;
153} __packed;
154
155/* Mesh Peering Protocol Identifier field value */
156enum {
157	IEEE80211_MPPID_MPM		= 0,	/* Mesh peering management */
158	IEEE80211_MPPID_AUTH_MPM	= 1,	/* Auth. mesh peering exchange */
159	/* 2-65535 reserved */
160};
161
162#ifdef notyet
163/* Mesh Channel Switch Annoucement */
164struct ieee80211_meshcsa_ie {
165	uint8_t		csa_ie;		/* IEEE80211_ELEMID_MESHCSA */
166	uint8_t		csa_len;
167	uint8_t		csa_mode;
168	uint8_t		csa_newclass;	/* New Regulatory Class */
169	uint8_t		csa_newchan;
170	uint8_t		csa_precvalue;	/* Precedence Value */
171	uint8_t		csa_count;
172} __packed;
173
174/* Mesh TIM */
175/* Equal to the non Mesh version */
176
177/* Mesh Awake Window */
178struct ieee80211_meshawakew_ie {
179	uint8_t		awakew_ie;		/* IEEE80211_ELEMID_MESHAWAKEW */
180	uint8_t		awakew_len;
181	uint8_t		awakew_windowlen;	/* in TUs */
182} __packed;
183
184/* Mesh Beacon Timing */
185struct ieee80211_meshbeacont_ie {
186	uint8_t		beacont_ie;		/* IEEE80211_ELEMID_MESHBEACONT */
187	uint8_t		beacont_len;
188	struct {
189		uint8_t		mp_aid;		/* Least Octet of AID */
190		uint16_t	mp_btime;	/* Beacon Time */
191		uint16_t	mp_bint;	/* Beacon Interval */
192	} __packed mp[1];			/* NB: variable size */
193} __packed;
194#endif
195
196/* Portal (MP) Annoucement */
197struct ieee80211_meshpann_ie {
198	uint8_t		pann_ie;		/* IEEE80211_ELEMID_MESHPANN */
199	uint8_t		pann_len;
200	uint8_t		pann_flags;
201	uint8_t		pann_hopcount;
202	uint8_t		pann_ttl;
203	uint8_t		pann_addr[IEEE80211_ADDR_LEN];
204	uint8_t		pann_seq;		/* PANN Sequence Number */
205} __packed;
206
207/* Root (MP) Annoucement */
208#define	IEEE80211_MESHRANN_BASE_SZ 	(21)
209struct ieee80211_meshrann_ie {
210	uint8_t		rann_ie;		/* IEEE80211_ELEMID_MESHRANN */
211	uint8_t		rann_len;
212	uint8_t		rann_flags;
213#define	IEEE80211_MESHRANN_FLAGS_PR	0x01	/* Portal Role */
214	uint8_t		rann_hopcount;
215	uint8_t		rann_ttl;
216	uint8_t		rann_addr[IEEE80211_ADDR_LEN];
217	uint32_t	rann_seq;		/* HWMP Sequence Number */
218	uint32_t	rann_interval;
219	uint32_t	rann_metric;
220} __packed;
221
222/* Mesh Path Request */
223#define	IEEE80211_MESHPREQ_BASE_SZ 		(26)
224#define	IEEE80211_MESHPREQ_BASE_SZ_AE 		(32)
225#define	IEEE80211_MESHPREQ_TRGT_SZ 		(11)
226#define	IEEE80211_MESHPREQ_TCNT_OFFSET		(27)
227#define	IEEE80211_MESHPREQ_TCNT_OFFSET_AE	(33)
228struct ieee80211_meshpreq_ie {
229	uint8_t		preq_ie;	/* IEEE80211_ELEMID_MESHPREQ */
230	uint8_t		preq_len;
231	uint8_t		preq_flags;
232#define	IEEE80211_MESHPREQ_FLAGS_PR	0x01	/* Portal Role */
233#define	IEEE80211_MESHPREQ_FLAGS_AM	0x02	/* 0 = bcast / 1 = ucast */
234#define	IEEE80211_MESHPREQ_FLAGS_PP	0x04	/* Proactive PREP */
235#define	IEEE80211_MESHPREQ_FLAGS_AE	0x40	/* Address Extension */
236	uint8_t		preq_hopcount;
237	uint8_t		preq_ttl;
238	uint32_t	preq_id;
239	uint8_t		preq_origaddr[IEEE80211_ADDR_LEN];
240	uint32_t	preq_origseq;	/* HWMP Sequence Number */
241	/* NB: may have Originator External Address */
242	uint8_t		preq_orig_ext_addr[IEEE80211_ADDR_LEN];
243	uint32_t	preq_lifetime;
244	uint32_t	preq_metric;
245	uint8_t		preq_tcount;	/* target count */
246	struct {
247		uint8_t		target_flags;
248#define	IEEE80211_MESHPREQ_TFLAGS_TO	0x01	/* Target Only */
249#define	IEEE80211_MESHPREQ_TFLAGS_USN	0x04	/* Unknown HWMP seq number */
250		uint8_t		target_addr[IEEE80211_ADDR_LEN];
251		uint32_t	target_seq;	/* HWMP Sequence Number */
252	} __packed preq_targets[1];		/* NB: variable size */
253} __packed;
254
255/* Mesh Path Reply */
256#define	IEEE80211_MESHPREP_BASE_SZ 	(31)
257#define	IEEE80211_MESHPREP_BASE_SZ_AE 	(37)
258struct ieee80211_meshprep_ie {
259	uint8_t		prep_ie;	/* IEEE80211_ELEMID_MESHPREP */
260	uint8_t		prep_len;
261	uint8_t		prep_flags;
262#define	IEEE80211_MESHPREP_FLAGS_AE	0x40	/* Address Extension */
263	uint8_t		prep_hopcount;
264	uint8_t		prep_ttl;
265	uint8_t		prep_targetaddr[IEEE80211_ADDR_LEN];
266	uint32_t	prep_targetseq;
267	/* NB: May have Target External Address */
268	uint8_t		prep_target_ext_addr[IEEE80211_ADDR_LEN];
269	uint32_t	prep_lifetime;
270	uint32_t	prep_metric;
271	uint8_t		prep_origaddr[IEEE80211_ADDR_LEN];
272	uint32_t	prep_origseq;	/* HWMP Sequence Number */
273} __packed;
274
275/* Mesh Path Error */
276#define	IEEE80211_MESHPERR_MAXDEST	(19)
277#define	IEEE80211_MESHPERR_NDEST_OFFSET	(3)
278#define	IEEE80211_MESHPERR_BASE_SZ 	(2)
279#define	IEEE80211_MESHPERR_DEST_SZ 	(13)
280#define	IEEE80211_MESHPERR_DEST_SZ_AE 	(19)
281struct ieee80211_meshperr_ie {
282	uint8_t		perr_ie;	/* IEEE80211_ELEMID_MESHPERR */
283	uint8_t		perr_len;
284	uint8_t		perr_ttl;
285	uint8_t		perr_ndests;	/* Number of Destinations */
286	struct {
287		uint8_t		dest_flags;
288#define	IEEE80211_MESHPERR_DFLAGS_USN	0x01	/* XXX: not part of standard */
289#define	IEEE80211_MESHPERR_DFLAGS_RC	0x02	/* XXX: not part of standard */
290#define	IEEE80211_MESHPERR_FLAGS_AE	0x40	/* Address Extension */
291		uint8_t		dest_addr[IEEE80211_ADDR_LEN];
292		uint32_t	dest_seq;	/* HWMP Sequence Number */
293		/* NB: May have Destination External Address */
294		uint8_t		dest_ext_addr[IEEE80211_ADDR_LEN];
295		uint16_t	dest_rcode;
296	} __packed perr_dests[1];		/* NB: variable size */
297} __packed;
298
299#ifdef notyet
300/* Mesh Proxy Update */
301struct ieee80211_meshpu_ie {
302	uint8_t		pu_ie;		/* IEEE80211_ELEMID_MESHPU */
303	uint8_t		pu_len;
304	uint8_t		pu_flags;
305#define	IEEE80211_MESHPU_FLAGS_MASK		0x1
306#define	IEEE80211_MESHPU_FLAGS_DEL		0x0
307#define	IEEE80211_MESHPU_FLAGS_ADD		0x1
308	uint8_t		pu_seq;		/* PU Sequence Number */
309	uint8_t		pu_addr[IEEE80211_ADDR_LEN];
310	uint8_t		pu_naddr;	/* Number of Proxied Addresses */
311	/* NB: proxied address follows */
312} __packed;
313
314/* Mesh Proxy Update Confirmation */
315struct ieee80211_meshpuc_ie {
316	uint8_t		puc_ie;		/* IEEE80211_ELEMID_MESHPUC */
317	uint8_t		puc_len;
318	uint8_t		puc_flags;
319	uint8_t		puc_seq;	/* PU Sequence Number */
320	uint8_t		puc_daddr[IEEE80211_ADDR_LEN];
321} __packed;
322#endif
323
324/*
325 * 802.11s Action Frames
326 * XXX: these are wrong, and some of them should be
327 * under MESH category while PROXY is under MULTIHOP category.
328 */
329#define	IEEE80211_ACTION_CAT_INTERWORK		15
330#define	IEEE80211_ACTION_CAT_RESOURCE		16
331#define	IEEE80211_ACTION_CAT_PROXY		17
332
333/*
334 * Mesh Peering Action codes.
335 */
336enum {
337	/* 0 reserved */
338	IEEE80211_ACTION_MESHPEERING_OPEN	= 1,
339	IEEE80211_ACTION_MESHPEERING_CONFIRM	= 2,
340	IEEE80211_ACTION_MESHPEERING_CLOSE	= 3,
341	/* 4-255 reserved */
342};
343
344/*
345 * Mesh Action code.
346 */
347enum {
348	IEEE80211_ACTION_MESH_LMETRIC	= 0,	/* Mesh Link Metric Report */
349	IEEE80211_ACTION_MESH_HWMP	= 1,	/* HWMP Mesh Path Selection */
350	IEEE80211_ACTION_MESH_GANN	= 2,	/* Gate Announcement */
351	IEEE80211_ACTION_MESH_CC	= 3,	/* Congestion Control */
352	IEEE80211_ACTION_MESH_MCCA_SREQ	= 4,	/* MCCA Setup Request */
353	IEEE80211_ACTION_MESH_MCCA_SREP	= 5,	/* MCCA Setup Reply */
354	IEEE80211_ACTION_MESH_MCCA_AREQ	= 6,	/* MCCA Advertisement Req. */
355	IEEE80211_ACTION_MESH_MCCA_ADVER =7,	/* MCCA Advertisement */
356	IEEE80211_ACTION_MESH_MCCA_TRDOWN = 8,	/* MCCA Teardown */
357	IEEE80211_ACTION_MESH_TBTT_REQ	= 9,	/* TBTT Adjustment Request */
358	IEEE80211_ACTION_MESH_TBTT_RES	= 10,	/* TBTT Adjustment Response */
359	/* 11-255 reserved */
360};
361
362/*
363 * Mesh Portal Annoucement Action codes.
364 */
365enum {
366	IEEE80211_ACTION_MESHPANN	= 0,
367	/* 1-255 reserved */
368};
369
370/*
371 * Different mesh control structures based on the AE
372 * (Address Extension) bits.
373 */
374struct ieee80211_meshcntl {
375	uint8_t		mc_flags;	/* Address Extension 00 */
376	uint8_t		mc_ttl;		/* TTL */
377	uint8_t		mc_seq[4];	/* Sequence No. */
378	/* NB: more addresses may follow */
379} __packed;
380
381struct ieee80211_meshcntl_ae01 {
382	uint8_t		mc_flags;	/* Address Extension 01 */
383	uint8_t		mc_ttl;		/* TTL */
384	uint8_t		mc_seq[4];	/* Sequence No. */
385	uint8_t		mc_addr4[IEEE80211_ADDR_LEN];
386} __packed;
387
388struct ieee80211_meshcntl_ae10 {
389	uint8_t		mc_flags;	/* Address Extension 10 */
390	uint8_t		mc_ttl;		/* TTL */
391	uint8_t		mc_seq[4];	/* Sequence No. */
392	uint8_t		mc_addr5[IEEE80211_ADDR_LEN];
393	uint8_t		mc_addr6[IEEE80211_ADDR_LEN];
394} __packed;
395
396#define IEEE80211_MESH_AE_MASK		0x03
397enum {
398	IEEE80211_MESH_AE_00		= 0,	/* MC has no AE subfield */
399	IEEE80211_MESH_AE_01		= 1,	/* MC contain addr4 */
400	IEEE80211_MESH_AE_10		= 2,	/* MC contain addr5 & addr6 */
401	IEEE80211_MESH_AE_11		= 3,	/* RESERVED */
402};
403
404#ifdef _KERNEL
405MALLOC_DECLARE(M_80211_MESH_PREQ);
406MALLOC_DECLARE(M_80211_MESH_PREP);
407MALLOC_DECLARE(M_80211_MESH_PERR);
408
409MALLOC_DECLARE(M_80211_MESH_RT);
410/*
411 * Basic forwarding information:
412 * o Destination MAC
413 * o Next-hop MAC
414 * o Precursor list (not implemented yet)
415 * o Path timeout
416 * The rest is part of the active Mesh path selection protocol.
417 * XXX: to be moved out later.
418 */
419struct ieee80211_mesh_route {
420	TAILQ_ENTRY(ieee80211_mesh_route)	rt_next;
421	struct mtx		rt_lock;	/* fine grained route lock */
422	int			rt_updtime;	/* last update time */
423	uint8_t			rt_dest[IEEE80211_ADDR_LEN];
424	uint8_t			rt_mesh_gate[IEEE80211_ADDR_LEN]; /* meshDA */
425	uint8_t			rt_nexthop[IEEE80211_ADDR_LEN];
426	uint32_t		rt_metric;	/* path metric */
427	uint16_t		rt_nhops;	/* number of hops */
428	uint16_t		rt_flags;
429#define	IEEE80211_MESHRT_FLAGS_VALID	0x01	/* patch discovery complete */
430#define	IEEE80211_MESHRT_FLAGS_PROXY	0x02	/* proxy entry */
431	uint32_t		rt_lifetime;	/* route timeout */
432	uint32_t		rt_lastmseq;	/* last seq# seen dest */
433	uint32_t		rt_ext_seq;	/* proxy seq number */
434	void			*rt_priv;	/* private data */
435};
436#define	IEEE80211_MESH_ROUTE_PRIV(rt, cast)	((cast *)rt->rt_priv)
437
438#define	IEEE80211_MESH_PROTO_DSZ	12	/* description size */
439/*
440 * Mesh Path Selection Protocol.
441 */
442enum ieee80211_state;
443struct ieee80211_mesh_proto_path {
444	uint8_t		mpp_active;
445	char 		mpp_descr[IEEE80211_MESH_PROTO_DSZ];
446	uint8_t		mpp_ie;
447	struct ieee80211_node *
448	    		(*mpp_discover)(struct ieee80211vap *,
449				const uint8_t [IEEE80211_ADDR_LEN],
450				struct mbuf *);
451	void		(*mpp_peerdown)(struct ieee80211_node *);
452	void		(*mpp_senderror)(struct ieee80211vap *,
453				const uint8_t [IEEE80211_ADDR_LEN],
454				struct ieee80211_mesh_route *, int);
455	void		(*mpp_vattach)(struct ieee80211vap *);
456	void		(*mpp_vdetach)(struct ieee80211vap *);
457	int		(*mpp_newstate)(struct ieee80211vap *,
458			    enum ieee80211_state, int);
459	const size_t	mpp_privlen;	/* size required in the routing table
460					   for private data */
461	int		mpp_inact;	/* inact. timeout for invalid routes
462					   (ticks) */
463};
464
465/*
466 * Mesh Link Metric Report Protocol.
467 */
468struct ieee80211_mesh_proto_metric {
469	uint8_t		mpm_active;
470	char		mpm_descr[IEEE80211_MESH_PROTO_DSZ];
471	uint8_t		mpm_ie;
472	uint32_t	(*mpm_metric)(struct ieee80211_node *);
473};
474
475#ifdef notyet
476/*
477 * Mesh Authentication Protocol.
478 */
479struct ieee80211_mesh_proto_auth {
480	uint8_t		mpa_ie[4];
481};
482
483struct ieee80211_mesh_proto_congestion {
484};
485
486struct ieee80211_mesh_proto_sync {
487};
488#endif
489
490typedef uint32_t ieee80211_mesh_seq;
491#define	IEEE80211_MESH_SEQ_LEQ(a, b)	((int32_t)((a)-(b)) <= 0)
492#define	IEEE80211_MESH_SEQ_GEQ(a, b)	((int32_t)((a)-(b)) >= 0)
493
494struct ieee80211_mesh_state {
495	int				ms_idlen;
496	uint8_t				ms_id[IEEE80211_MESHID_LEN];
497	ieee80211_mesh_seq		ms_seq;	/* seq no for meshcntl */
498	uint16_t			ms_neighbors;
499	uint8_t				ms_ttl;	/* mesh ttl set in packets */
500#define IEEE80211_MESHFLAGS_AP		0x01	/* accept peers */
501#define IEEE80211_MESHFLAGS_PORTAL	0x02	/* mesh portal role */
502#define IEEE80211_MESHFLAGS_FWD		0x04	/* forward packets */
503	uint8_t				ms_flags;
504	struct mtx			ms_rt_lock;
505	struct callout			ms_cleantimer;
506	TAILQ_HEAD(, ieee80211_mesh_route)  ms_routes;
507	struct ieee80211_mesh_proto_metric *ms_pmetric;
508	struct ieee80211_mesh_proto_path   *ms_ppath;
509};
510void		ieee80211_mesh_attach(struct ieee80211com *);
511void		ieee80211_mesh_detach(struct ieee80211com *);
512
513struct ieee80211_mesh_route *
514		ieee80211_mesh_rt_find(struct ieee80211vap *,
515		    const uint8_t [IEEE80211_ADDR_LEN]);
516struct ieee80211_mesh_route *
517                ieee80211_mesh_rt_add(struct ieee80211vap *,
518		    const uint8_t [IEEE80211_ADDR_LEN]);
519void		ieee80211_mesh_rt_del(struct ieee80211vap *,
520		    const uint8_t [IEEE80211_ADDR_LEN]);
521void		ieee80211_mesh_rt_flush(struct ieee80211vap *);
522void		ieee80211_mesh_rt_flush_peer(struct ieee80211vap *,
523		    const uint8_t [IEEE80211_ADDR_LEN]);
524int		ieee80211_mesh_rt_update(struct ieee80211_mesh_route *rt, int);
525void		ieee80211_mesh_proxy_check(struct ieee80211vap *,
526		    const uint8_t [IEEE80211_ADDR_LEN]);
527
528int		ieee80211_mesh_register_proto_path(const
529		    struct ieee80211_mesh_proto_path *);
530int		ieee80211_mesh_register_proto_metric(const
531		    struct ieee80211_mesh_proto_metric *);
532
533uint8_t *	ieee80211_add_meshid(uint8_t *, struct ieee80211vap *);
534uint8_t *	ieee80211_add_meshconf(uint8_t *, struct ieee80211vap *);
535uint8_t *	ieee80211_add_meshpeer(uint8_t *, uint8_t, uint16_t, uint16_t,
536		    uint16_t);
537uint8_t *	ieee80211_add_meshlmetric(uint8_t *, uint8_t, uint32_t);
538
539void		ieee80211_mesh_node_init(struct ieee80211vap *,
540		    struct ieee80211_node *);
541void		ieee80211_mesh_node_cleanup(struct ieee80211_node *);
542void		ieee80211_parse_meshid(struct ieee80211_node *,
543		    const uint8_t *);
544struct ieee80211_scanparams;
545void		ieee80211_mesh_init_neighbor(struct ieee80211_node *,
546		   const struct ieee80211_frame *,
547		   const struct ieee80211_scanparams *);
548void		ieee80211_mesh_update_beacon(struct ieee80211vap *,
549		    struct ieee80211_beacon_offsets *);
550
551/*
552 * Return non-zero if proxy operation is enabled.
553 */
554static __inline int
555ieee80211_mesh_isproxyena(struct ieee80211vap *vap)
556{
557	struct ieee80211_mesh_state *ms = vap->iv_mesh;
558	return (ms->ms_flags &
559	    (IEEE80211_MESHFLAGS_AP | IEEE80211_MESHFLAGS_PORTAL)) != 0;
560}
561
562/*
563 * Process an outbound frame: if a path is known to the
564 * destination then return a reference to the next hop
565 * for immediate transmission.  Otherwise initiate path
566 * discovery and, if possible queue the packet to be
567 * sent when path discovery completes.
568 */
569static __inline struct ieee80211_node *
570ieee80211_mesh_discover(struct ieee80211vap *vap,
571    const uint8_t dest[IEEE80211_ADDR_LEN], struct mbuf *m)
572{
573	struct ieee80211_mesh_state *ms = vap->iv_mesh;
574	return ms->ms_ppath->mpp_discover(vap, dest, m);
575}
576
577#endif /* _KERNEL */
578#endif /* !_NET80211_IEEE80211_MESH_H_ */
579