ieee80211_mesh.h revision 195813
157109Speter/*-
222514Sdarrenr * Copyright (c) 2009 The FreeBSD Foundation
322514Sdarrenr * All rights reserved.
422514Sdarrenr *
522514Sdarrenr * This software was developed by Rui Paulo under sponsorship from the
631183Speter * FreeBSD Foundation.
737078Speter *
831183Speter * Redistribution and use in source and binary forms, with or without
922514Sdarrenr * modification, are permitted provided that the following conditions
1022514Sdarrenr * are met:
1122514Sdarrenr * 1. Redistributions of source code must retain the above copyright
1222514Sdarrenr *    notice, this list of conditions and the following disclaimer.
1322514Sdarrenr * 2. Redistributions in binary form must reproduce the above copyright
1422514Sdarrenr *    notice, this list of conditions and the following disclaimer in the
1567618Sdarrenr *    documentation and/or other materials provided with the distribution.
1667618Sdarrenr *
1722514Sdarrenr * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1822514Sdarrenr * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1922514Sdarrenr * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
2022514Sdarrenr * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
2122514Sdarrenr * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2222514Sdarrenr * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2367618Sdarrenr * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2467618Sdarrenr * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2567618Sdarrenr * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2667618Sdarrenr * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2767618Sdarrenr * SUCH DAMAGE.
2867618Sdarrenr *
2957109Speter * $FreeBSD: head/sys/net80211/ieee80211_mesh.h 195813 2009-07-21 19:38:22Z sam $
3057109Speter */
3167618Sdarrenr#ifndef _NET80211_IEEE80211_MESH_H_
3222514Sdarrenr#define _NET80211_IEEE80211_MESH_H_
3357109Speter
3457109Speter#define	IEEE80211_MESH_DEFAULT_TTL	31
3557109Speter
3657109Speter/*
3767618Sdarrenr * NB: all structures are__packed  so sizeof works on arm, et. al.
3867618Sdarrenr */
39145519Sdarrenr/*
40145519Sdarrenr * 802.11s Information Elements.
4167618Sdarrenr*/
4222514Sdarrenr/* Mesh Configuration */
4322514Sdarrenrstruct ieee80211_meshconf_ie {
4422514Sdarrenr	uint8_t		conf_ie;	/* IEEE80211_ELEMID_MESHCONF */
4522514Sdarrenr	uint8_t		conf_len;
4622514Sdarrenr	uint8_t		conf_ver;
4722514Sdarrenr	uint8_t		conf_pselid[4];	/* Active Path Sel. Proto. ID */
4822514Sdarrenr	uint8_t		conf_pmetid[4];	/* APS Metric Identifier */
4922514Sdarrenr	uint8_t		conf_ccid[4];	/* Congestion Control Mode ID  */
5022514Sdarrenr	uint8_t		conf_syncid[4];	/* Sync. Protocol ID */
5122514Sdarrenr	uint8_t		conf_authid[4];	/* Auth. Protocol ID */
5222514Sdarrenr	uint8_t		conf_form;	/* Formation Information */
5322514Sdarrenr	uint8_t		conf_cap;
5422514Sdarrenr} __packed;
5522514Sdarrenr
5622514Sdarrenr#define	IEEE80211_MESHCONF_VERSION		1
5722514Sdarrenr/* Null Protocol */
5831183Speter#define	IEEE80211_MESHCONF_NULL_OUI		0x00, 0x0f, 0xac
5957109Speter#define	IEEE80211_MESHCONF_NULL_VALUE		0xff
6031183Speter#define	IEEE80211_MESHCONF_NULL		{ IEEE80211_MESHCONF_NULL_OUI, \
6131183Speter					  IEEE80211_MESHCONF_NULL_VALUE }
6257109Speter/* Hybrid Wireless Mesh Protocol */
63369273Scy#define	IEEE80211_MESHCONF_HWMP_OUI		0x00, 0x0f, 0xac
6457109Speter#define	IEEE80211_MESHCONF_HWMP_VALUE		0x00
6557109Speter#define	IEEE80211_MESHCONF_HWMP		{ IEEE80211_MESHCONF_HWMP_OUI, \
6622514Sdarrenr					  IEEE80211_MESHCONF_HWMP_VALUE }
6731183Speter/* Airtime Link Metric */
6831183Speter#define	IEEE80211_MESHCONF_AIRTIME_OUI		0x00, 0x0f, 0xac
6931183Speter#define	IEEE80211_MESHCONF_AIRTIME_VALUE	0x00
7057109Speter#define	IEEE80211_MESHCONF_AIRTIME	{ IEEE80211_MESHCONF_AIRTIME_OUI, \
7157109Speter					  IEEE80211_MESHCONF_AIRTIME_VALUE }
7231183Speter/* Congestion Control Signaling */
7322514Sdarrenr#define	IEEE80211_MESHCONF_CCSIG_OUI		0x00, 0x0f, 0xac
7422514Sdarrenr#define	IEEE80211_MESHCONF_CCSIG_VALUE		0x00
7522514Sdarrenr#define	IEEE80211_MESHCONF_CCSIG	{ IEEE80211_MESHCONF_CCSIG_OUI,\
7657109Speter					  IEEE80211_MESHCONF_CCSIG_VALUE }
7722514Sdarrenr/* Neighbour Offset */
7822514Sdarrenr#define	IEEE80211_MESHCONF_NEIGHOFF_OUI		0x00, 0x0f, 0xac
7922514Sdarrenr#define	IEEE80211_MESHCONF_NEIGHOFF_VALUE	0x00
8022514Sdarrenr#define	IEEE80211_MESHCONF_NEIGHOFF	{ IEEE80211_MESHCONF_NEIGHOFF_OUI, \
8122514Sdarrenr					  IEEE80211_MESHCONF_NEIGHOFF_VALUE }
8222514Sdarrenr/* Simultaneous Authenticaction of Equals */
8322514Sdarrenr#define	IEEE80211_MESHCONF_SAE_OUI		0x00, 0x0f, 0xac
8422514Sdarrenr#define	IEEE80211_MESHCONF_SAE_VALUE		0x01
85255332Scy#define	IEEE80211_MESHCONF_SAE		{ IEEE80211_MESHCONF_SAE_OUI, \
8622514Sdarrenr					  IEEE80211_MESHCONF_SAE_VALUE }
8722514Sdarrenr#define	IEEE80211_MESHCONF_FORM_MP		0x01 /* Connected to Portal */
88255332Scy#define	IEEE80211_MESHCONF_FORM_NNEIGH_MASK	0x04 /* Number of Neighbours */
8922514Sdarrenr#define	IEEE80211_MESHCONF_CAP_AP	0x01	/* Accepting Peers */
9057109Speter#define	IEEE80211_MESHCONF_CAP_MCCAS	0x02	/* MCCA supported */
9157109Speter#define	IEEE80211_MESHCONF_CAP_MCCAE	0x04	/* MCCA enabled */
9257109Speter#define	IEEE80211_MESHCONF_CAP_FWRD 	0x08	/* forwarding enabled */
93369245Sgit2svn#define	IEEE80211_MESHCONF_CAP_BTR	0x10	/* Beacon Timing Report Enab */
9422514Sdarrenr#define	IEEE80211_MESHCONF_CAP_TBTTA	0x20	/* TBTT Adj. Enabled */
9522514Sdarrenr#define	IEEE80211_MESHCONF_CAP_PSL	0x40	/* Power Save Level */
96369273Scy
9757109Speter/* Mesh Identifier */
98255332Scystruct ieee80211_meshid_ie {
9922514Sdarrenr	uint8_t		id_ie;		/* IEEE80211_ELEMID_MESHID */
10022514Sdarrenr	uint8_t		id_len;
10122514Sdarrenr} __packed;
10222514Sdarrenr
10322514Sdarrenr/* Link Metric Report */
10422514Sdarrenrstruct ieee80211_meshlmetric_ie {
10522514Sdarrenr	uint8_t		lm_ie;	/* IEEE80211_ELEMID_MESHLINK */
10622514Sdarrenr	uint8_t		lm_len;
10722514Sdarrenr	uint32_t	lm_metric;
10822514Sdarrenr#define	IEEE80211_MESHLMETRIC_INITIALVAL	0
10967618Sdarrenr} __packed;
11022514Sdarrenr
11122514Sdarrenr/* Congestion Notification */
11231183Speterstruct ieee80211_meshcngst_ie {
11331183Speter	uint8_t		cngst_ie;	/* IEEE80211_ELEMID_MESHCNGST */
11431183Speter	uint8_t		cngst_len;
11531183Speter	uint16_t	cngst_timer[4];	/* Expiration Timers: AC_BK,
11631183Speter					   AC_BE, AC_VI, AC_VO */
11757109Speter} __packed;
11857109Speter
11931183Speter/* Peer Version */
12031183Speterstruct ieee80211_meshpeerver_ie {
12131183Speter	uint8_t		peerver_ie;	/* IEEE80211_ELEMID_MESHPEERVER */
12257109Speter	uint8_t		peerver_len;
12357109Speter	uint8_t		peerver_proto[4];
124145519Sdarrenr} __packed;
12531183Speter/* Mesh Peering Management Protocol */
12631183Speter#define	IEEE80211_MESHPEERVER_PEER_OUI		0x00, 0x0f, 0xac
12731183Speter#define	IEEE80211_MESHPEERVER_PEER_VALUE	0x2a
12831183Speter#define	IEEE80211_MESHPEERVER_PEER	{ IEEE80211_MESHPEERVER_PEER_OUI, \
12931183Speter					  IEEE80211_MESHPEERVER_PEER_VALUE }
13031183Speter/* Abbreviated Handshake Protocol */
13131183Speter#define	IEEE80211_MESHPEERVER_AH_OUI		0x00, 0x0f, 0xac
13231183Speter#define	IEEE80211_MESHPEERVER_AH_VALUE		0x2b
13331183Speter#define	IEEE80211_MESHPEERVER_AH	{ IEEE80211_MESHPEERVER_AH_OUI, \
13431183Speter					  IEEE80211_MESHPEERVER_AH_VALUE }
13531183Speter
13631183Speter/* Peer Link Management */
13731183Speterstruct ieee80211_meshpeer_ie {
138255332Scy	uint8_t		peer_ie;	/* IEEE80211_ELEMID_MESHPEER */
13922514Sdarrenr	uint8_t		peer_len;
14022514Sdarrenr	uint8_t		peer_subtype;
14122514Sdarrenr	uint16_t	peer_llinkid;	/* Local Link ID */
14222514Sdarrenr	uint16_t	peer_linkid;	/* Peer Link ID */
14322514Sdarrenr	uint16_t	peer_rcode;
14422514Sdarrenr} __packed;
14522514Sdarrenr
14622514Sdarrenrenum {
14722514Sdarrenr	IEEE80211_MESH_PEER_LINK_OPEN		= 0,
14822514Sdarrenr	IEEE80211_MESH_PEER_LINK_CONFIRM	= 1,
14922514Sdarrenr	IEEE80211_MESH_PEER_LINK_CLOSE		= 2,
15022514Sdarrenr	/* values 3-255 are reserved */
15122514Sdarrenr};
15222514Sdarrenr
15322514Sdarrenr#ifdef notyet
15422514Sdarrenr/* Mesh Channel Switch Annoucement */
15522514Sdarrenrstruct ieee80211_meshcsa_ie {
15622514Sdarrenr	uint8_t		csa_ie;		/* IEEE80211_ELEMID_MESHCSA */
15722514Sdarrenr	uint8_t		csa_len;
15822514Sdarrenr	uint8_t		csa_mode;
15957109Speter	uint8_t		csa_newclass;	/* New Regulatory Class */
16057109Speter	uint8_t		csa_newchan;
16157109Speter	uint8_t		csa_precvalue;	/* Precedence Value */
16222514Sdarrenr	uint8_t		csa_count;
16357109Speter} __packed;
16436753Sjkoshy
16522514Sdarrenr/* Mesh TIM */
16622514Sdarrenr/* Equal to the non Mesh version */
16722514Sdarrenr
16822514Sdarrenr/* Mesh Awake Window */
16922514Sdarrenrstruct ieee80211_meshawakew_ie {
17022514Sdarrenr	uint8_t		awakew_ie;		/* IEEE80211_ELEMID_MESHAWAKEW */
17122514Sdarrenr	uint8_t		awakew_len;
17222514Sdarrenr	uint8_t		awakew_windowlen;	/* in TUs */
17331183Speter} __packed;
17431183Speter
17531183Speter/* Mesh Beacon Timing */
17631183Speterstruct ieee80211_meshbeacont_ie {
17722514Sdarrenr	uint8_t		beacont_ie;		/* IEEE80211_ELEMID_MESHBEACONT */
17822514Sdarrenr	uint8_t		beacont_len;
17922514Sdarrenr	struct {
18022514Sdarrenr		uint8_t		mp_aid;		/* Least Octet of AID */
18157109Speter		uint16_t	mp_btime;	/* Beacon Time */
18222514Sdarrenr		uint16_t	mp_bint;	/* Beacon Interval */
18322514Sdarrenr	} __packed mp[1];			/* NB: variable size */
18422514Sdarrenr} __packed;
18522514Sdarrenr#endif
18622514Sdarrenr
18722514Sdarrenr/* Portal (MP) Annoucement */
18822514Sdarrenrstruct ieee80211_meshpann_ie {
18931183Speter	uint8_t		pann_ie;		/* IEEE80211_ELEMID_MESHPANN */
19031183Speter	uint8_t		pann_len;
19131183Speter	uint8_t		pann_flags;
19231183Speter	uint8_t		pann_hopcount;
19331183Speter	uint8_t		pann_ttl;
19431183Speter	uint8_t		pann_addr[IEEE80211_ADDR_LEN];
19531183Speter	uint8_t		pann_seq;		/* PANN Sequence Number */
19657109Speter} __packed;
19757109Speter
19857109Speter/* Root (MP) Annoucement */
19957109Speterstruct ieee80211_meshrann_ie {
20057109Speter	uint8_t		rann_ie;		/* IEEE80211_ELEMID_MESHRANN */
20157109Speter	uint8_t		rann_len;
20222514Sdarrenr	uint8_t		rann_flags;
20322514Sdarrenr#define	IEEE80211_MESHRANN_FLAGS_PR	0x01	/* Portal Role */
20422514Sdarrenr	uint8_t		rann_hopcount;
20522514Sdarrenr	uint8_t		rann_ttl;
20622514Sdarrenr	uint8_t		rann_addr[IEEE80211_ADDR_LEN];
20722514Sdarrenr	uint32_t	rann_seq;		/* HWMP Sequence Number */
20822514Sdarrenr	uint32_t	rann_metric;
20922514Sdarrenr} __packed;
21022514Sdarrenr
21122514Sdarrenr/* Mesh Path Request */
21222514Sdarrenrstruct ieee80211_meshpreq_ie {
21322514Sdarrenr	uint8_t		preq_ie;	/* IEEE80211_ELEMID_MESHPREQ */
21422514Sdarrenr	uint8_t		preq_len;
21522514Sdarrenr	uint8_t		preq_flags;
21622514Sdarrenr#define	IEEE80211_MESHPREQ_FLAGS_PR	0x01	/* Portal Role */
21722514Sdarrenr#define	IEEE80211_MESHPREQ_FLAGS_AM	0x02	/* 0 = ucast / 1 = bcast */
21822514Sdarrenr#define	IEEE80211_MESHPREQ_FLAGS_PP	0x04	/* Proactive PREP */
21922514Sdarrenr#define	IEEE80211_MESHPREQ_FLAGS_AE	0x40	/* Address Extension */
22022514Sdarrenr	uint8_t		preq_hopcount;
22131183Speter	uint8_t		preq_ttl;
22222514Sdarrenr	uint32_t	preq_id;
22357109Speter	uint8_t		preq_origaddr[IEEE80211_ADDR_LEN];
22457109Speter	uint32_t	preq_origseq;	/* HWMP Sequence Number */
22522514Sdarrenr	/* NB: may have Originator Proxied Address */
22622514Sdarrenr	uint32_t	preq_lifetime;
22722514Sdarrenr	uint32_t	preq_metric;
22822514Sdarrenr	uint8_t		preq_tcount;	/* target count */
22922514Sdarrenr	struct {
23022514Sdarrenr		uint8_t		target_flags;
23157109Speter#define	IEEE80211_MESHPREQ_TFLAGS_TO	0x01	/* Target Only */
23257109Speter#define	IEEE80211_MESHPREQ_TFLAGS_RF	0x02	/* Reply and Forward */
23357109Speter#define	IEEE80211_MESHPREQ_TFLAGS_USN	0x04	/* Unknown HWMP seq number */
23457109Speter		uint8_t		target_addr[IEEE80211_ADDR_LEN];
23557109Speter		uint32_t	target_seq;	/* HWMP Sequence Number */
23657109Speter	} __packed preq_targets[1];		/* NB: variable size */
23757109Speter} __packed;
23857109Speter
23957109Speter/* Mesh Path Reply */
24057109Speterstruct ieee80211_meshprep_ie {
24157109Speter	uint8_t		prep_ie;	/* IEEE80211_ELEMID_MESHPREP */
24257109Speter	uint8_t		prep_len;
24357109Speter	uint8_t		prep_flags;
24457109Speter	uint8_t		prep_hopcount;
24537078Speter	uint8_t		prep_ttl;
24637078Speter	uint8_t		prep_targetaddr[IEEE80211_ADDR_LEN];
24737078Speter	uint32_t	prep_targetseq;
24837078Speter	/* NB: May have Target Proxied Address */
24937078Speter	uint32_t	prep_lifetime;
25037078Speter	uint32_t	prep_metric;
25137078Speter	uint8_t		prep_origaddr[IEEE80211_ADDR_LEN];
25237078Speter	uint32_t	prep_origseq;	/* HWMP Sequence Number */
25322514Sdarrenr} __packed;
25437078Speter
255/* Mesh Path Error */
256struct ieee80211_meshperr_ie {
257	uint8_t		perr_ie;	/* IEEE80211_ELEMID_MESHPERR */
258	uint8_t		perr_len;
259	uint8_t		perr_mode;	/* NB: reserved */
260	uint8_t		perr_ndests;	/* Number of Destinations */
261	struct {
262		uint8_t		dest_addr[IEEE80211_ADDR_LEN];
263		uint32_t	dest_seq;	/* HWMP Sequence Number */
264	} __packed perr_dests[1];		/* NB: variable size */
265} __packed;
266
267#ifdef notyet
268/* Mesh Proxy Update */
269struct ieee80211_meshpu_ie {
270	uint8_t		pu_ie;		/* IEEE80211_ELEMID_MESHPU */
271	uint8_t		pu_len;
272	uint8_t		pu_flags;
273#define	IEEE80211_MESHPU_FLAGS_MASK		0x1
274#define	IEEE80211_MESHPU_FLAGS_DEL		0x0
275#define	IEEE80211_MESHPU_FLAGS_ADD		0x1
276	uint8_t		pu_seq;		/* PU Sequence Number */
277	uint8_t		pu_addr[IEEE80211_ADDR_LEN];
278	uint8_t		pu_naddr;	/* Number of Proxied Addresses */
279	/* NB: proxied address follows */
280} __packed;
281
282/* Mesh Proxy Update Confirmation */
283struct ieee80211_meshpuc_ie {
284	uint8_t		puc_ie;		/* IEEE80211_ELEMID_MESHPUC */
285	uint8_t		puc_len;
286	uint8_t		puc_flags;
287	uint8_t		puc_seq;	/* PU Sequence Number */
288	uint8_t		puc_daddr[IEEE80211_ADDR_LEN];
289} __packed;
290#endif
291
292/*
293 * 802.11s Action Frames
294 */
295#define	IEEE80211_ACTION_CAT_MESHPEERING	30	/* XXX Linux */
296#define	IEEE80211_ACTION_CAT_MESHLMETRIC	13
297#define	IEEE80211_ACTION_CAT_MESHPATH		32	/* XXX Linux */
298#define	IEEE80211_ACTION_CAT_INTERWORK		15
299#define	IEEE80211_ACTION_CAT_RESOURCE		16
300#define	IEEE80211_ACTION_CAT_PROXY		17
301
302/*
303 * Mesh Peering Action codes.
304 */
305enum {
306	IEEE80211_ACTION_MESHPEERING_OPEN	= 0,
307	IEEE80211_ACTION_MESHPEERING_CONFIRM	= 1,
308	IEEE80211_ACTION_MESHPEERING_CLOSE	= 2,
309	/* 3-255 reserved */
310};
311
312/*
313 * Mesh Path Selection Action codes.
314 */
315enum {
316	IEEE80211_ACTION_MESHPATH_REQ	= 0,
317	IEEE80211_ACTION_MESHPATH_REP	= 1,
318	IEEE80211_ACTION_MESHPATH_ERR	= 2,
319	IEEE80211_ACTION_MESHPATH_RANN	= 3,
320	/* 4-255 reserved */
321};
322
323/*
324 * Mesh Link Metric Action codes.
325 */
326enum {
327	IEEE80211_ACTION_MESHLMETRIC_REQ = 0,	/* Link Metric Request */
328	IEEE80211_ACTION_MESHLMETRIC_REP = 1,	/* Link Metric Report */
329	/* 2-255 reserved */
330};
331
332/*
333 * Mesh Portal Annoucement Action codes.
334 */
335enum {
336	IEEE80211_ACTION_MESHPANN	= 0,
337	/* 1-255 reserved */
338};
339
340/*
341 * Different mesh control structures based on the AE
342 * (Address Extension) bits.
343 */
344struct ieee80211_meshcntl {
345	uint8_t		mc_flags;	/* Address Extension 00 */
346	uint8_t		mc_ttl;		/* TTL */
347	uint8_t		mc_seq[4];	/* Sequence No. */
348	/* NB: more addresses may follow */
349} __packed;
350
351struct ieee80211_meshcntl_ae01 {
352	uint8_t		mc_flags;	/* Address Extension 01 */
353	uint8_t		mc_ttl;		/* TTL */
354	uint8_t		mc_seq[4];	/* Sequence No. */
355	uint8_t		mc_addr4[IEEE80211_ADDR_LEN];
356} __packed;
357
358struct ieee80211_meshcntl_ae10 {
359	uint8_t		mc_flags;	/* Address Extension 10 */
360	uint8_t		mc_ttl;		/* TTL */
361	uint8_t		mc_seq[4];	/* Sequence No. */
362	uint8_t		mc_addr4[IEEE80211_ADDR_LEN];
363	uint8_t		mc_addr5[IEEE80211_ADDR_LEN];
364} __packed;
365
366struct ieee80211_meshcntl_ae11 {
367	uint8_t		mc_flags;	/* Address Extension 11 */
368	uint8_t		mc_ttl;		/* TTL */
369	uint8_t		mc_seq[4];	/* Sequence No. */
370	uint8_t		mc_addr4[IEEE80211_ADDR_LEN];
371	uint8_t		mc_addr5[IEEE80211_ADDR_LEN];
372	uint8_t		mc_addr6[IEEE80211_ADDR_LEN];
373} __packed;
374
375#ifdef _KERNEL
376MALLOC_DECLARE(M_80211_MESH_RT);
377struct ieee80211_mesh_route {
378	TAILQ_ENTRY(ieee80211_mesh_route)	rt_next;
379	int			rt_crtime;	/* creation time */
380	uint8_t			rt_dest[IEEE80211_ADDR_LEN];
381	uint8_t			rt_nexthop[IEEE80211_ADDR_LEN];
382	uint32_t		rt_metric;	/* path metric */
383	uint16_t		rt_nhops;	/* number of hops */
384	uint16_t		rt_flags;
385#define	IEEE80211_MESHRT_FLAGS_VALID	0x01	/* patch discovery complete */
386#define	IEEE80211_MESHRT_FLAGS_PROXY	0x02	/* proxy entry */
387	uint32_t		rt_lifetime;
388	uint32_t		rt_lastmseq;	/* last seq# seen dest */
389	void			*rt_priv;	/* private data */
390};
391#define	IEEE80211_MESH_ROUTE_PRIV(rt, cast)	((cast *)rt->rt_priv)
392
393#define	IEEE80211_MESH_PROTO_DSZ	12	/* description size */
394/*
395 * Mesh Path Selection Protocol.
396 */
397enum ieee80211_state;
398struct ieee80211_mesh_proto_path {
399	char 		mpp_descr[IEEE80211_MESH_PROTO_DSZ];
400	uint8_t		mpp_ie[4];
401	struct ieee80211_node *
402	    		(*mpp_discover)(struct ieee80211vap *,
403				const uint8_t [IEEE80211_ADDR_LEN],
404				struct mbuf *);
405	void		(*mpp_peerdown)(struct ieee80211_node *);
406	void		(*mpp_vattach)(struct ieee80211vap *);
407	void		(*mpp_vdetach)(struct ieee80211vap *);
408	int		(*mpp_newstate)(struct ieee80211vap *,
409			    enum ieee80211_state, int);
410	const size_t	mpp_privlen;	/* size required in the routing table
411					   for private data */
412	int		mpp_inact;	/* inact. timeout for invalid routes
413					   (ticks) */
414};
415
416/*
417 * Mesh Link Metric Report Protocol.
418 */
419struct ieee80211_mesh_proto_metric {
420	char		mpm_descr[IEEE80211_MESH_PROTO_DSZ];
421	uint8_t		mpm_ie[4];
422	uint32_t	(*mpm_metric)(struct ieee80211_node *);
423};
424
425#ifdef notyet
426/*
427 * Mesh Authentication Protocol.
428 */
429struct ieee80211_mesh_proto_auth {
430	uint8_t		mpa_ie[4];
431};
432
433struct ieee80211_mesh_proto_congestion {
434};
435
436struct ieee80211_mesh_proto_sync {
437};
438#endif
439
440typedef uint32_t ieee80211_mesh_seq;
441#define	IEEE80211_MESH_SEQ_LEQ(a, b)	((int32_t)((a)-(b)) <= 0)
442#define	IEEE80211_MESH_SEQ_GEQ(a, b)	((int32_t)((a)-(b)) >= 0)
443
444struct ieee80211_mesh_state {
445	int				ms_idlen;
446	uint8_t				ms_id[IEEE80211_MESHID_LEN];
447	ieee80211_mesh_seq		ms_seq;	/* seq no for meshcntl */
448	uint16_t			ms_neighbors;
449	uint8_t				ms_ttl;	/* mesh ttl set in packets */
450#define IEEE80211_MESHFLAGS_AP		0x01	/* accept peers */
451#define IEEE80211_MESHFLAGS_PORTAL	0x02	/* mesh portal role */
452#define IEEE80211_MESHFLAGS_FWD		0x04	/* forward packets */
453	uint8_t				ms_flags;
454	struct mtx			ms_rt_lock;
455	struct callout			ms_cleantimer;
456	TAILQ_HEAD(, ieee80211_mesh_route)  ms_routes;
457	struct ieee80211_mesh_proto_metric *ms_pmetric;
458	struct ieee80211_mesh_proto_path   *ms_ppath;
459};
460void		ieee80211_mesh_attach(struct ieee80211com *);
461void		ieee80211_mesh_detach(struct ieee80211com *);
462
463struct ieee80211_mesh_route *
464		ieee80211_mesh_rt_find(struct ieee80211vap *,
465		    const uint8_t [IEEE80211_ADDR_LEN]);
466struct ieee80211_mesh_route *
467                ieee80211_mesh_rt_add(struct ieee80211vap *,
468		    const uint8_t [IEEE80211_ADDR_LEN]);
469void		ieee80211_mesh_rt_del(struct ieee80211vap *,
470		    const uint8_t [IEEE80211_ADDR_LEN]);
471void		ieee80211_mesh_rt_flush(struct ieee80211vap *);
472void		ieee80211_mesh_proxy_check(struct ieee80211vap *,
473		    const uint8_t [IEEE80211_ADDR_LEN]);
474
475int		ieee80211_mesh_register_proto_path(const
476		    struct ieee80211_mesh_proto_path *);
477int		ieee80211_mesh_register_proto_metric(const
478		    struct ieee80211_mesh_proto_metric *);
479
480uint8_t *	ieee80211_add_meshpeerver(uint8_t *, struct ieee80211vap *);
481uint8_t *	ieee80211_add_meshid(uint8_t *, struct ieee80211vap *);
482uint8_t *	ieee80211_add_meshconf(uint8_t *, struct ieee80211vap *);
483uint8_t *	ieee80211_add_meshpeer(uint8_t *, uint8_t, uint16_t, uint16_t,
484		    uint16_t);
485uint8_t *	ieee80211_add_meshlmetric(uint8_t *, uint32_t);
486
487void		ieee80211_mesh_node_init(struct ieee80211vap *,
488		    struct ieee80211_node *);
489void		ieee80211_mesh_node_cleanup(struct ieee80211_node *);
490void		ieee80211_parse_meshid(struct ieee80211_node *,
491		    const uint8_t *);
492struct ieee80211_scanparams;
493void		ieee80211_mesh_init_neighbor(struct ieee80211_node *,
494		   const struct ieee80211_frame *,
495		   const struct ieee80211_scanparams *);
496
497/*
498 * Return non-zero if proxy operation is enabled.
499 */
500static __inline int
501ieee80211_mesh_isproxyena(struct ieee80211vap *vap)
502{
503	struct ieee80211_mesh_state *ms = vap->iv_mesh;
504	return (ms->ms_flags &
505	    (IEEE80211_MESHFLAGS_AP | IEEE80211_MESHFLAGS_PORTAL)) != 0;
506}
507
508/*
509 * Process an outbound frame: if a path is known to the
510 * destination then return a reference to the next hop
511 * for immediate transmission.  Otherwise initiate path
512 * discovery and, if possible queue the packet to be
513 * sent when path discovery completes.
514 */
515static __inline struct ieee80211_node *
516ieee80211_mesh_discover(struct ieee80211vap *vap,
517    const uint8_t dest[IEEE80211_ADDR_LEN], struct mbuf *m)
518{
519	struct ieee80211_mesh_state *ms = vap->iv_mesh;
520	return ms->ms_ppath->mpp_discover(vap, dest, m);
521}
522
523#endif /* _KERNEL */
524#endif /* !_NET80211_IEEE80211_MESH_H_ */
525