1195618Srpaulo/*-
2195618Srpaulo * Copyright (c) 2009 The FreeBSD Foundation
3195618Srpaulo * All rights reserved.
4195618Srpaulo *
5195618Srpaulo * This software was developed by Rui Paulo under sponsorship from the
6195618Srpaulo * FreeBSD Foundation.
7195618Srpaulo *
8195618Srpaulo * Redistribution and use in source and binary forms, with or without
9195618Srpaulo * modification, are permitted provided that the following conditions
10195618Srpaulo * are met:
11195618Srpaulo * 1. Redistributions of source code must retain the above copyright
12195618Srpaulo *    notice, this list of conditions and the following disclaimer.
13195618Srpaulo * 2. Redistributions in binary form must reproduce the above copyright
14195618Srpaulo *    notice, this list of conditions and the following disclaimer in the
15195618Srpaulo *    documentation and/or other materials provided with the distribution.
16195618Srpaulo *
17195618Srpaulo * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18195618Srpaulo * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19195618Srpaulo * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20195618Srpaulo * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21195618Srpaulo * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22195618Srpaulo * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23195618Srpaulo * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24195618Srpaulo * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25195618Srpaulo * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26195618Srpaulo * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27195618Srpaulo * SUCH DAMAGE.
28195618Srpaulo *
29195618Srpaulo * $FreeBSD$
30195618Srpaulo */
31195618Srpaulo#ifndef _NET80211_IEEE80211_MESH_H_
32195618Srpaulo#define _NET80211_IEEE80211_MESH_H_
33195618Srpaulo
34195618Srpaulo#define	IEEE80211_MESH_DEFAULT_TTL	31
35234876Smonthadar#define	IEEE80211_MESH_MAX_NEIGHBORS	15
36195618Srpaulo
37195618Srpaulo/*
38197413Srpaulo * NB: all structures are __packed  so sizeof works on arm, et. al.
39195618Srpaulo */
40195618Srpaulo/*
41195618Srpaulo * 802.11s Information Elements.
42195618Srpaulo*/
43195618Srpaulo/* Mesh Configuration */
44231576Sadrian#define IEEE80211_MESH_CONF_SZ		(7)
45195618Srpaulostruct ieee80211_meshconf_ie {
46195618Srpaulo	uint8_t		conf_ie;	/* IEEE80211_ELEMID_MESHCONF */
47195618Srpaulo	uint8_t		conf_len;
48197975Srpaulo	uint8_t		conf_pselid;	/* Active Path Sel. Proto. ID */
49197975Srpaulo	uint8_t		conf_pmetid;	/* Active Metric Identifier */
50197975Srpaulo	uint8_t		conf_ccid;	/* Congestion Control Mode ID  */
51197975Srpaulo	uint8_t		conf_syncid;	/* Sync. Protocol ID */
52197975Srpaulo	uint8_t		conf_authid;	/* Auth. Protocol ID */
53195618Srpaulo	uint8_t		conf_form;	/* Formation Information */
54231576Sadrian	uint8_t		conf_cap;
55195618Srpaulo} __packed;
56195618Srpaulo
57195618Srpaulo/* Hybrid Wireless Mesh Protocol */
58231576Sadrianenum {
59231576Sadrian	/* 0 reserved */
60231576Sadrian	IEEE80211_MESHCONF_PATH_HWMP		= 1,
61231576Sadrian	/* 2-254 reserved */
62231576Sadrian	IEEE80211_MESHCONF_PATH_VENDOR		= 255,
63231576Sadrian};
64231576Sadrian
65195618Srpaulo/* Airtime Link Metric */
66231576Sadrianenum {
67231576Sadrian	/* 0 reserved */
68231576Sadrian	IEEE80211_MESHCONF_METRIC_AIRTIME	= 1,
69231576Sadrian	/* 2-254 reserved */
70231576Sadrian	IEEE80211_MESHCONF_METRIC_VENDOR	= 255,
71231576Sadrian};
72231576Sadrian
73197975Srpaulo/* Congestion Control */
74231576Sadrianenum {
75231576Sadrian	IEEE80211_MESHCONF_CC_DISABLED		= 0,
76231576Sadrian	IEEE80211_MESHCONF_CC_SIG		= 1,
77231576Sadrian	/* 2-254 reserved */
78231576Sadrian	IEEE80211_MESHCONF_CC_VENDOR		= 255,
79231576Sadrian};
80231576Sadrian
81195618Srpaulo/* Neighbour Offset */
82231576Sadrianenum {
83231576Sadrian	/* 0 reserved */
84231576Sadrian	IEEE80211_MESHCONF_SYNC_NEIGHOFF	= 1,
85231576Sadrian	/* 2-254 rserved */
86231576Sadrian	IEEE80211_MESHCONF_SYNC_VENDOR		= 255,
87231576Sadrian};
88231576Sadrian
89231576Sadrian/* Authentication Protocol Identifier */
90231576Sadrianenum {
91231576Sadrian
92231576Sadrian	IEEE80211_MESHCONF_AUTH_DISABLED	= 0,
93231576Sadrian	/* Simultaneous Authenticaction of Equals */
94231576Sadrian	IEEE80211_MESHCONF_AUTH_SEA		= 1,
95231576Sadrian	IEEE80211_MESHCONF_AUTH_8021X		= 2, /* IEEE 802.1X */
96231576Sadrian	/* 3-254 reserved */
97231576Sadrian	IEEE80211_MESHCONF_AUTH_VENDOR		= 255,
98231576Sadrian};
99231576Sadrian
100231576Sadrian/* Mesh Formation Info */
101234892Smonthadar#define	IEEE80211_MESHCONF_FORM_GATE	0x01 	/* Connected to Gate */
102231576Sadrian#define	IEEE80211_MESHCONF_FORM_NNEIGH_MASK 0x7E /* Number of Neighbours */
103231576Sadrian#define	IEEE80211_MESHCONF_FORM_SA	0xF0 	/* indicating 802.1X auth */
104231576Sadrian
105231576Sadrian/* Mesh Capability */
106195618Srpaulo#define	IEEE80211_MESHCONF_CAP_AP	0x01	/* Accepting Peers */
107195618Srpaulo#define	IEEE80211_MESHCONF_CAP_MCCAS	0x02	/* MCCA supported */
108195618Srpaulo#define	IEEE80211_MESHCONF_CAP_MCCAE	0x04	/* MCCA enabled */
109195618Srpaulo#define	IEEE80211_MESHCONF_CAP_FWRD 	0x08	/* forwarding enabled */
110195618Srpaulo#define	IEEE80211_MESHCONF_CAP_BTR	0x10	/* Beacon Timing Report Enab */
111231576Sadrian#define	IEEE80211_MESHCONF_CAP_TBTT	0x20	/* TBTT Adjusting  */
112231576Sadrian#define	IEEE80211_MESHCONF_CAP_PSL	0x40	/* Power Save Level */
113231576Sadrian/* 0x80 reserved */
114195618Srpaulo
115195618Srpaulo/* Mesh Identifier */
116195618Srpaulostruct ieee80211_meshid_ie {
117195618Srpaulo	uint8_t		id_ie;		/* IEEE80211_ELEMID_MESHID */
118195618Srpaulo	uint8_t		id_len;
119195618Srpaulo} __packed;
120195618Srpaulo
121195618Srpaulo/* Link Metric Report */
122195618Srpaulostruct ieee80211_meshlmetric_ie {
123232479Sadrian	uint8_t		lm_ie;	/* IEEE80211_ACTION_MESH_LMETRIC */
124195618Srpaulo	uint8_t		lm_len;
125232479Sadrian	uint8_t		lm_flags;
126232479Sadrian#define	IEEE80211_MESH_LMETRIC_FLAGS_REQ	0x01	/* Request */
127232479Sadrian	/*
128232479Sadrian	 * XXX: this field should be variable in size and depend on
129232479Sadrian	 * the active active path selection metric identifier
130232479Sadrian	 */
131195618Srpaulo	uint32_t	lm_metric;
132195618Srpaulo#define	IEEE80211_MESHLMETRIC_INITIALVAL	0
133195618Srpaulo} __packed;
134195618Srpaulo
135195618Srpaulo/* Congestion Notification */
136195618Srpaulostruct ieee80211_meshcngst_ie {
137195618Srpaulo	uint8_t		cngst_ie;	/* IEEE80211_ELEMID_MESHCNGST */
138195618Srpaulo	uint8_t		cngst_len;
139195618Srpaulo	uint16_t	cngst_timer[4];	/* Expiration Timers: AC_BK,
140195618Srpaulo					   AC_BE, AC_VI, AC_VO */
141195618Srpaulo} __packed;
142195618Srpaulo
143195618Srpaulo/* Peer Link Management */
144234875Smonthadar#define IEEE80211_MPM_BASE_SZ	(4)
145234875Smonthadar#define IEEE80211_MPM_MAX_SZ	(8)
146195618Srpaulostruct ieee80211_meshpeer_ie {
147195618Srpaulo	uint8_t		peer_ie;	/* IEEE80211_ELEMID_MESHPEER */
148195618Srpaulo	uint8_t		peer_len;
149234875Smonthadar	uint16_t	peer_proto;	/* Peer Management Protocol */
150195618Srpaulo	uint16_t	peer_llinkid;	/* Local Link ID */
151195618Srpaulo	uint16_t	peer_linkid;	/* Peer Link ID */
152195618Srpaulo	uint16_t	peer_rcode;
153195618Srpaulo} __packed;
154195618Srpaulo
155234875Smonthadar/* Mesh Peering Protocol Identifier field value */
156234875Smonthadarenum {
157234875Smonthadar	IEEE80211_MPPID_MPM		= 0,	/* Mesh peering management */
158234875Smonthadar	IEEE80211_MPPID_AUTH_MPM	= 1,	/* Auth. mesh peering exchange */
159234875Smonthadar	/* 2-65535 reserved */
160234875Smonthadar};
161234875Smonthadar
162195618Srpaulo#ifdef notyet
163195618Srpaulo/* Mesh Channel Switch Annoucement */
164195618Srpaulostruct ieee80211_meshcsa_ie {
165195618Srpaulo	uint8_t		csa_ie;		/* IEEE80211_ELEMID_MESHCSA */
166195618Srpaulo	uint8_t		csa_len;
167195618Srpaulo	uint8_t		csa_mode;
168195618Srpaulo	uint8_t		csa_newclass;	/* New Regulatory Class */
169195618Srpaulo	uint8_t		csa_newchan;
170195618Srpaulo	uint8_t		csa_precvalue;	/* Precedence Value */
171195618Srpaulo	uint8_t		csa_count;
172195618Srpaulo} __packed;
173195618Srpaulo
174195618Srpaulo/* Mesh TIM */
175195618Srpaulo/* Equal to the non Mesh version */
176195618Srpaulo
177195618Srpaulo/* Mesh Awake Window */
178195618Srpaulostruct ieee80211_meshawakew_ie {
179195618Srpaulo	uint8_t		awakew_ie;		/* IEEE80211_ELEMID_MESHAWAKEW */
180195618Srpaulo	uint8_t		awakew_len;
181195618Srpaulo	uint8_t		awakew_windowlen;	/* in TUs */
182195618Srpaulo} __packed;
183195618Srpaulo
184195618Srpaulo/* Mesh Beacon Timing */
185195618Srpaulostruct ieee80211_meshbeacont_ie {
186195618Srpaulo	uint8_t		beacont_ie;		/* IEEE80211_ELEMID_MESHBEACONT */
187195618Srpaulo	uint8_t		beacont_len;
188195618Srpaulo	struct {
189195618Srpaulo		uint8_t		mp_aid;		/* Least Octet of AID */
190195618Srpaulo		uint16_t	mp_btime;	/* Beacon Time */
191195618Srpaulo		uint16_t	mp_bint;	/* Beacon Interval */
192195618Srpaulo	} __packed mp[1];			/* NB: variable size */
193195618Srpaulo} __packed;
194195618Srpaulo#endif
195195618Srpaulo
196234892Smonthadar/* Gate (GANN) Annoucement */
197246501Smonthadar/*
198246501Smonthadar * NB: these macros used for the length in the IEs does not include 2 bytes
199246501Smonthadar * for _ie and _len fields as is defined by the standard.
200246501Smonthadar */
201246501Smonthadar#define	IEEE80211_MESHGANN_BASE_SZ 	(15)
202234892Smonthadarstruct ieee80211_meshgann_ie {
203246501Smonthadar	uint8_t		gann_ie;		/* IEEE80211_ELEMID_MESHGANN */
204246501Smonthadar	uint8_t		gann_len;
205246501Smonthadar	uint8_t		gann_flags;
206246501Smonthadar	uint8_t		gann_hopcount;
207246501Smonthadar	uint8_t		gann_ttl;
208246501Smonthadar	uint8_t		gann_addr[IEEE80211_ADDR_LEN];
209246501Smonthadar	uint32_t	gann_seq;		/* GANN Sequence Number */
210246501Smonthadar	uint16_t	gann_interval;		/* GANN Interval */
211195618Srpaulo} __packed;
212195618Srpaulo
213195618Srpaulo/* Root (MP) Annoucement */
214232625Sadrian#define	IEEE80211_MESHRANN_BASE_SZ 	(21)
215195618Srpaulostruct ieee80211_meshrann_ie {
216195618Srpaulo	uint8_t		rann_ie;		/* IEEE80211_ELEMID_MESHRANN */
217195618Srpaulo	uint8_t		rann_len;
218195618Srpaulo	uint8_t		rann_flags;
219234892Smonthadar#define	IEEE80211_MESHRANN_FLAGS_GATE	0x01	/* Mesh Gate */
220195618Srpaulo	uint8_t		rann_hopcount;
221195618Srpaulo	uint8_t		rann_ttl;
222195618Srpaulo	uint8_t		rann_addr[IEEE80211_ADDR_LEN];
223195618Srpaulo	uint32_t	rann_seq;		/* HWMP Sequence Number */
224232625Sadrian	uint32_t	rann_interval;
225195618Srpaulo	uint32_t	rann_metric;
226195618Srpaulo} __packed;
227195618Srpaulo
228195618Srpaulo/* Mesh Path Request */
229232625Sadrian#define	IEEE80211_MESHPREQ_BASE_SZ 		(26)
230232625Sadrian#define	IEEE80211_MESHPREQ_BASE_SZ_AE 		(32)
231232625Sadrian#define	IEEE80211_MESHPREQ_TRGT_SZ 		(11)
232232625Sadrian#define	IEEE80211_MESHPREQ_TCNT_OFFSET		(27)
233232625Sadrian#define	IEEE80211_MESHPREQ_TCNT_OFFSET_AE	(33)
234195618Srpaulostruct ieee80211_meshpreq_ie {
235195618Srpaulo	uint8_t		preq_ie;	/* IEEE80211_ELEMID_MESHPREQ */
236195618Srpaulo	uint8_t		preq_len;
237195618Srpaulo	uint8_t		preq_flags;
238234892Smonthadar#define	IEEE80211_MESHPREQ_FLAGS_GATE	0x01	/* Mesh Gate */
239234884Smonthadar#define	IEEE80211_MESHPREQ_FLAGS_AM	0x02	/* 0 = bcast / 1 = ucast */
240195618Srpaulo#define	IEEE80211_MESHPREQ_FLAGS_PP	0x04	/* Proactive PREP */
241195618Srpaulo#define	IEEE80211_MESHPREQ_FLAGS_AE	0x40	/* Address Extension */
242195618Srpaulo	uint8_t		preq_hopcount;
243195618Srpaulo	uint8_t		preq_ttl;
244195618Srpaulo	uint32_t	preq_id;
245195618Srpaulo	uint8_t		preq_origaddr[IEEE80211_ADDR_LEN];
246195618Srpaulo	uint32_t	preq_origseq;	/* HWMP Sequence Number */
247232625Sadrian	/* NB: may have Originator External Address */
248232625Sadrian	uint8_t		preq_orig_ext_addr[IEEE80211_ADDR_LEN];
249195618Srpaulo	uint32_t	preq_lifetime;
250195618Srpaulo	uint32_t	preq_metric;
251195618Srpaulo	uint8_t		preq_tcount;	/* target count */
252195618Srpaulo	struct {
253195618Srpaulo		uint8_t		target_flags;
254195618Srpaulo#define	IEEE80211_MESHPREQ_TFLAGS_TO	0x01	/* Target Only */
255195618Srpaulo#define	IEEE80211_MESHPREQ_TFLAGS_USN	0x04	/* Unknown HWMP seq number */
256195618Srpaulo		uint8_t		target_addr[IEEE80211_ADDR_LEN];
257195618Srpaulo		uint32_t	target_seq;	/* HWMP Sequence Number */
258195618Srpaulo	} __packed preq_targets[1];		/* NB: variable size */
259195618Srpaulo} __packed;
260195618Srpaulo
261195618Srpaulo/* Mesh Path Reply */
262232625Sadrian#define	IEEE80211_MESHPREP_BASE_SZ 	(31)
263232625Sadrian#define	IEEE80211_MESHPREP_BASE_SZ_AE 	(37)
264195618Srpaulostruct ieee80211_meshprep_ie {
265195618Srpaulo	uint8_t		prep_ie;	/* IEEE80211_ELEMID_MESHPREP */
266195618Srpaulo	uint8_t		prep_len;
267195618Srpaulo	uint8_t		prep_flags;
268232625Sadrian#define	IEEE80211_MESHPREP_FLAGS_AE	0x40	/* Address Extension */
269195618Srpaulo	uint8_t		prep_hopcount;
270195618Srpaulo	uint8_t		prep_ttl;
271195618Srpaulo	uint8_t		prep_targetaddr[IEEE80211_ADDR_LEN];
272195618Srpaulo	uint32_t	prep_targetseq;
273232625Sadrian	/* NB: May have Target External Address */
274232625Sadrian	uint8_t		prep_target_ext_addr[IEEE80211_ADDR_LEN];
275195618Srpaulo	uint32_t	prep_lifetime;
276195618Srpaulo	uint32_t	prep_metric;
277195618Srpaulo	uint8_t		prep_origaddr[IEEE80211_ADDR_LEN];
278195618Srpaulo	uint32_t	prep_origseq;	/* HWMP Sequence Number */
279195618Srpaulo} __packed;
280195618Srpaulo
281195618Srpaulo/* Mesh Path Error */
282232625Sadrian#define	IEEE80211_MESHPERR_MAXDEST	(19)
283232625Sadrian#define	IEEE80211_MESHPERR_NDEST_OFFSET	(3)
284232625Sadrian#define	IEEE80211_MESHPERR_BASE_SZ 	(2)
285232625Sadrian#define	IEEE80211_MESHPERR_DEST_SZ 	(13)
286232625Sadrian#define	IEEE80211_MESHPERR_DEST_SZ_AE 	(19)
287195618Srpaulostruct ieee80211_meshperr_ie {
288195618Srpaulo	uint8_t		perr_ie;	/* IEEE80211_ELEMID_MESHPERR */
289195618Srpaulo	uint8_t		perr_len;
290197413Srpaulo	uint8_t		perr_ttl;
291195618Srpaulo	uint8_t		perr_ndests;	/* Number of Destinations */
292195618Srpaulo	struct {
293197413Srpaulo		uint8_t		dest_flags;
294232625Sadrian#define	IEEE80211_MESHPERR_DFLAGS_USN	0x01	/* XXX: not part of standard */
295232625Sadrian#define	IEEE80211_MESHPERR_DFLAGS_RC	0x02	/* XXX: not part of standard */
296232625Sadrian#define	IEEE80211_MESHPERR_FLAGS_AE	0x40	/* Address Extension */
297195618Srpaulo		uint8_t		dest_addr[IEEE80211_ADDR_LEN];
298195618Srpaulo		uint32_t	dest_seq;	/* HWMP Sequence Number */
299232625Sadrian		/* NB: May have Destination External Address */
300232625Sadrian		uint8_t		dest_ext_addr[IEEE80211_ADDR_LEN];
301197413Srpaulo		uint16_t	dest_rcode;
302195618Srpaulo	} __packed perr_dests[1];		/* NB: variable size */
303195618Srpaulo} __packed;
304195618Srpaulo
305195618Srpaulo#ifdef notyet
306195618Srpaulo/* Mesh Proxy Update */
307195618Srpaulostruct ieee80211_meshpu_ie {
308195618Srpaulo	uint8_t		pu_ie;		/* IEEE80211_ELEMID_MESHPU */
309195618Srpaulo	uint8_t		pu_len;
310195618Srpaulo	uint8_t		pu_flags;
311195618Srpaulo#define	IEEE80211_MESHPU_FLAGS_MASK		0x1
312195618Srpaulo#define	IEEE80211_MESHPU_FLAGS_DEL		0x0
313195618Srpaulo#define	IEEE80211_MESHPU_FLAGS_ADD		0x1
314195618Srpaulo	uint8_t		pu_seq;		/* PU Sequence Number */
315195618Srpaulo	uint8_t		pu_addr[IEEE80211_ADDR_LEN];
316195618Srpaulo	uint8_t		pu_naddr;	/* Number of Proxied Addresses */
317195618Srpaulo	/* NB: proxied address follows */
318195618Srpaulo} __packed;
319195618Srpaulo
320195618Srpaulo/* Mesh Proxy Update Confirmation */
321195618Srpaulostruct ieee80211_meshpuc_ie {
322195618Srpaulo	uint8_t		puc_ie;		/* IEEE80211_ELEMID_MESHPUC */
323195618Srpaulo	uint8_t		puc_len;
324195618Srpaulo	uint8_t		puc_flags;
325195618Srpaulo	uint8_t		puc_seq;	/* PU Sequence Number */
326195618Srpaulo	uint8_t		puc_daddr[IEEE80211_ADDR_LEN];
327195618Srpaulo} __packed;
328195618Srpaulo#endif
329195618Srpaulo
330195618Srpaulo/*
331195618Srpaulo * 802.11s Action Frames
332234874Smonthadar * XXX: these are wrong, and some of them should be
333234874Smonthadar * under MESH category while PROXY is under MULTIHOP category.
334195618Srpaulo */
335195618Srpaulo#define	IEEE80211_ACTION_CAT_INTERWORK		15
336195618Srpaulo#define	IEEE80211_ACTION_CAT_RESOURCE		16
337195618Srpaulo#define	IEEE80211_ACTION_CAT_PROXY		17
338195618Srpaulo
339195618Srpaulo/*
340195618Srpaulo * Mesh Peering Action codes.
341195618Srpaulo */
342195618Srpauloenum {
343234874Smonthadar	/* 0 reserved */
344234874Smonthadar	IEEE80211_ACTION_MESHPEERING_OPEN	= 1,
345234874Smonthadar	IEEE80211_ACTION_MESHPEERING_CONFIRM	= 2,
346234874Smonthadar	IEEE80211_ACTION_MESHPEERING_CLOSE	= 3,
347234874Smonthadar	/* 4-255 reserved */
348195618Srpaulo};
349195618Srpaulo
350195618Srpaulo/*
351232479Sadrian * Mesh Action code.
352195618Srpaulo */
353195618Srpauloenum {
354232479Sadrian	IEEE80211_ACTION_MESH_LMETRIC	= 0,	/* Mesh Link Metric Report */
355232479Sadrian	IEEE80211_ACTION_MESH_HWMP	= 1,	/* HWMP Mesh Path Selection */
356232479Sadrian	IEEE80211_ACTION_MESH_GANN	= 2,	/* Gate Announcement */
357232479Sadrian	IEEE80211_ACTION_MESH_CC	= 3,	/* Congestion Control */
358232479Sadrian	IEEE80211_ACTION_MESH_MCCA_SREQ	= 4,	/* MCCA Setup Request */
359232479Sadrian	IEEE80211_ACTION_MESH_MCCA_SREP	= 5,	/* MCCA Setup Reply */
360232479Sadrian	IEEE80211_ACTION_MESH_MCCA_AREQ	= 6,	/* MCCA Advertisement Req. */
361232479Sadrian	IEEE80211_ACTION_MESH_MCCA_ADVER =7,	/* MCCA Advertisement */
362232479Sadrian	IEEE80211_ACTION_MESH_MCCA_TRDOWN = 8,	/* MCCA Teardown */
363232479Sadrian	IEEE80211_ACTION_MESH_TBTT_REQ	= 9,	/* TBTT Adjustment Request */
364232479Sadrian	IEEE80211_ACTION_MESH_TBTT_RES	= 10,	/* TBTT Adjustment Response */
365232479Sadrian	/* 11-255 reserved */
366195618Srpaulo};
367195618Srpaulo
368195618Srpaulo/*
369195618Srpaulo * Different mesh control structures based on the AE
370195618Srpaulo * (Address Extension) bits.
371195618Srpaulo */
372195618Srpaulostruct ieee80211_meshcntl {
373195618Srpaulo	uint8_t		mc_flags;	/* Address Extension 00 */
374195618Srpaulo	uint8_t		mc_ttl;		/* TTL */
375195618Srpaulo	uint8_t		mc_seq[4];	/* Sequence No. */
376195618Srpaulo	/* NB: more addresses may follow */
377195618Srpaulo} __packed;
378195618Srpaulo
379195618Srpaulostruct ieee80211_meshcntl_ae01 {
380195618Srpaulo	uint8_t		mc_flags;	/* Address Extension 01 */
381195618Srpaulo	uint8_t		mc_ttl;		/* TTL */
382195618Srpaulo	uint8_t		mc_seq[4];	/* Sequence No. */
383195618Srpaulo	uint8_t		mc_addr4[IEEE80211_ADDR_LEN];
384195618Srpaulo} __packed;
385195618Srpaulo
386195618Srpaulostruct ieee80211_meshcntl_ae10 {
387195618Srpaulo	uint8_t		mc_flags;	/* Address Extension 10 */
388195618Srpaulo	uint8_t		mc_ttl;		/* TTL */
389195618Srpaulo	uint8_t		mc_seq[4];	/* Sequence No. */
390195618Srpaulo	uint8_t		mc_addr5[IEEE80211_ADDR_LEN];
391195618Srpaulo	uint8_t		mc_addr6[IEEE80211_ADDR_LEN];
392195618Srpaulo} __packed;
393195618Srpaulo
394234878Smonthadar#define IEEE80211_MESH_AE_MASK		0x03
395234878Smonthadarenum {
396234878Smonthadar	IEEE80211_MESH_AE_00		= 0,	/* MC has no AE subfield */
397234878Smonthadar	IEEE80211_MESH_AE_01		= 1,	/* MC contain addr4 */
398234878Smonthadar	IEEE80211_MESH_AE_10		= 2,	/* MC contain addr5 & addr6 */
399234878Smonthadar	IEEE80211_MESH_AE_11		= 3,	/* RESERVED */
400234878Smonthadar};
401234878Smonthadar
402195618Srpaulo#ifdef _KERNEL
403232625SadrianMALLOC_DECLARE(M_80211_MESH_PREQ);
404232625SadrianMALLOC_DECLARE(M_80211_MESH_PREP);
405232625SadrianMALLOC_DECLARE(M_80211_MESH_PERR);
406232625Sadrian
407195618SrpauloMALLOC_DECLARE(M_80211_MESH_RT);
408246508SmonthadarMALLOC_DECLARE(M_80211_MESH_GT_RT);
409234877Smonthadar/*
410234877Smonthadar * Basic forwarding information:
411234877Smonthadar * o Destination MAC
412234877Smonthadar * o Next-hop MAC
413234877Smonthadar * o Precursor list (not implemented yet)
414234877Smonthadar * o Path timeout
415234877Smonthadar * The rest is part of the active Mesh path selection protocol.
416234877Smonthadar * XXX: to be moved out later.
417234877Smonthadar */
418195618Srpaulostruct ieee80211_mesh_route {
419195618Srpaulo	TAILQ_ENTRY(ieee80211_mesh_route)	rt_next;
420234894Smonthadar	struct ieee80211vap	*rt_vap;
421234877Smonthadar	struct mtx		rt_lock;	/* fine grained route lock */
422234894Smonthadar	struct callout		rt_discovery;	/* discovery timeout */
423234877Smonthadar	int			rt_updtime;	/* last update time */
424195618Srpaulo	uint8_t			rt_dest[IEEE80211_ADDR_LEN];
425234878Smonthadar	uint8_t			rt_mesh_gate[IEEE80211_ADDR_LEN]; /* meshDA */
426195618Srpaulo	uint8_t			rt_nexthop[IEEE80211_ADDR_LEN];
427195618Srpaulo	uint32_t		rt_metric;	/* path metric */
428195618Srpaulo	uint16_t		rt_nhops;	/* number of hops */
429195784Srpaulo	uint16_t		rt_flags;
430234894Smonthadar#define	IEEE80211_MESHRT_FLAGS_DISCOVER	0x01	/* path discovery */
431234894Smonthadar#define	IEEE80211_MESHRT_FLAGS_VALID	0x02	/* path discovery complete */
432234894Smonthadar#define	IEEE80211_MESHRT_FLAGS_PROXY	0x04	/* proxy entry */
433246501Smonthadar#define	IEEE80211_MESHRT_FLAGS_GATE	0x08	/* mesh gate entry */
434234877Smonthadar	uint32_t		rt_lifetime;	/* route timeout */
435195618Srpaulo	uint32_t		rt_lastmseq;	/* last seq# seen dest */
436234878Smonthadar	uint32_t		rt_ext_seq;	/* proxy seq number */
437195618Srpaulo	void			*rt_priv;	/* private data */
438195618Srpaulo};
439195618Srpaulo#define	IEEE80211_MESH_ROUTE_PRIV(rt, cast)	((cast *)rt->rt_priv)
440195618Srpaulo
441246508Smonthadar/*
442246508Smonthadar * Stored information about known mesh gates.
443246508Smonthadar */
444246508Smonthadarstruct ieee80211_mesh_gate_route {
445246508Smonthadar	TAILQ_ENTRY(ieee80211_mesh_gate_route)	gr_next;
446246508Smonthadar	uint8_t				gr_addr[IEEE80211_ADDR_LEN];
447246508Smonthadar	uint32_t			gr_lastseq;
448246508Smonthadar	struct ieee80211_mesh_route 	*gr_route;
449246508Smonthadar};
450246508Smonthadar
451195618Srpaulo#define	IEEE80211_MESH_PROTO_DSZ	12	/* description size */
452195618Srpaulo/*
453195618Srpaulo * Mesh Path Selection Protocol.
454195618Srpaulo */
455195618Srpauloenum ieee80211_state;
456195618Srpaulostruct ieee80211_mesh_proto_path {
457197975Srpaulo	uint8_t		mpp_active;
458195618Srpaulo	char 		mpp_descr[IEEE80211_MESH_PROTO_DSZ];
459197975Srpaulo	uint8_t		mpp_ie;
460195618Srpaulo	struct ieee80211_node *
461195618Srpaulo	    		(*mpp_discover)(struct ieee80211vap *,
462195618Srpaulo				const uint8_t [IEEE80211_ADDR_LEN],
463195618Srpaulo				struct mbuf *);
464195618Srpaulo	void		(*mpp_peerdown)(struct ieee80211_node *);
465234890Smonthadar	void		(*mpp_senderror)(struct ieee80211vap *,
466234890Smonthadar				const uint8_t [IEEE80211_ADDR_LEN],
467234890Smonthadar				struct ieee80211_mesh_route *, int);
468195618Srpaulo	void		(*mpp_vattach)(struct ieee80211vap *);
469195618Srpaulo	void		(*mpp_vdetach)(struct ieee80211vap *);
470195618Srpaulo	int		(*mpp_newstate)(struct ieee80211vap *,
471195618Srpaulo			    enum ieee80211_state, int);
472195784Srpaulo	const size_t	mpp_privlen;	/* size required in the routing table
473195618Srpaulo					   for private data */
474195813Ssam	int		mpp_inact;	/* inact. timeout for invalid routes
475195813Ssam					   (ticks) */
476195618Srpaulo};
477195618Srpaulo
478195618Srpaulo/*
479195618Srpaulo * Mesh Link Metric Report Protocol.
480195618Srpaulo */
481195618Srpaulostruct ieee80211_mesh_proto_metric {
482197975Srpaulo	uint8_t		mpm_active;
483195618Srpaulo	char		mpm_descr[IEEE80211_MESH_PROTO_DSZ];
484197975Srpaulo	uint8_t		mpm_ie;
485195618Srpaulo	uint32_t	(*mpm_metric)(struct ieee80211_node *);
486195618Srpaulo};
487195618Srpaulo
488195618Srpaulo#ifdef notyet
489195618Srpaulo/*
490195618Srpaulo * Mesh Authentication Protocol.
491195618Srpaulo */
492195618Srpaulostruct ieee80211_mesh_proto_auth {
493195618Srpaulo	uint8_t		mpa_ie[4];
494195618Srpaulo};
495195618Srpaulo
496195618Srpaulostruct ieee80211_mesh_proto_congestion {
497195618Srpaulo};
498195618Srpaulo
499195618Srpaulostruct ieee80211_mesh_proto_sync {
500195618Srpaulo};
501195618Srpaulo#endif
502195618Srpaulo
503195618Srpaulotypedef uint32_t ieee80211_mesh_seq;
504195618Srpaulo#define	IEEE80211_MESH_SEQ_LEQ(a, b)	((int32_t)((a)-(b)) <= 0)
505195618Srpaulo#define	IEEE80211_MESH_SEQ_GEQ(a, b)	((int32_t)((a)-(b)) >= 0)
506195618Srpaulo
507195618Srpaulostruct ieee80211_mesh_state {
508195618Srpaulo	int				ms_idlen;
509195618Srpaulo	uint8_t				ms_id[IEEE80211_MESHID_LEN];
510195618Srpaulo	ieee80211_mesh_seq		ms_seq;	/* seq no for meshcntl */
511195618Srpaulo	uint16_t			ms_neighbors;
512195618Srpaulo	uint8_t				ms_ttl;	/* mesh ttl set in packets */
513195618Srpaulo#define IEEE80211_MESHFLAGS_AP		0x01	/* accept peers */
514234892Smonthadar#define IEEE80211_MESHFLAGS_GATE	0x02	/* mesh gate role */
515195618Srpaulo#define IEEE80211_MESHFLAGS_FWD		0x04	/* forward packets */
516246506Smonthadar#define IEEE80211_MESHFLAGS_ROOT	0x08	/* configured as root */
517195618Srpaulo	uint8_t				ms_flags;
518195618Srpaulo	struct mtx			ms_rt_lock;
519195784Srpaulo	struct callout			ms_cleantimer;
520246506Smonthadar	struct callout			ms_gatetimer;
521246506Smonthadar	ieee80211_mesh_seq		ms_gateseq;
522246508Smonthadar	TAILQ_HEAD(, ieee80211_mesh_gate_route) ms_known_gates;
523195618Srpaulo	TAILQ_HEAD(, ieee80211_mesh_route)  ms_routes;
524195618Srpaulo	struct ieee80211_mesh_proto_metric *ms_pmetric;
525195618Srpaulo	struct ieee80211_mesh_proto_path   *ms_ppath;
526195618Srpaulo};
527195618Srpaulovoid		ieee80211_mesh_attach(struct ieee80211com *);
528195618Srpaulovoid		ieee80211_mesh_detach(struct ieee80211com *);
529195618Srpaulo
530195618Srpaulostruct ieee80211_mesh_route *
531195618Srpaulo		ieee80211_mesh_rt_find(struct ieee80211vap *,
532195618Srpaulo		    const uint8_t [IEEE80211_ADDR_LEN]);
533195618Srpaulostruct ieee80211_mesh_route *
534195618Srpaulo                ieee80211_mesh_rt_add(struct ieee80211vap *,
535195618Srpaulo		    const uint8_t [IEEE80211_ADDR_LEN]);
536195618Srpaulovoid		ieee80211_mesh_rt_del(struct ieee80211vap *,
537195618Srpaulo		    const uint8_t [IEEE80211_ADDR_LEN]);
538195618Srpaulovoid		ieee80211_mesh_rt_flush(struct ieee80211vap *);
539195908Srpaulovoid		ieee80211_mesh_rt_flush_peer(struct ieee80211vap *,
540195908Srpaulo		    const uint8_t [IEEE80211_ADDR_LEN]);
541234877Smonthadarint		ieee80211_mesh_rt_update(struct ieee80211_mesh_route *rt, int);
542195784Srpaulovoid		ieee80211_mesh_proxy_check(struct ieee80211vap *,
543195784Srpaulo		    const uint8_t [IEEE80211_ADDR_LEN]);
544195618Srpaulo
545195618Srpauloint		ieee80211_mesh_register_proto_path(const
546195618Srpaulo		    struct ieee80211_mesh_proto_path *);
547195618Srpauloint		ieee80211_mesh_register_proto_metric(const
548195618Srpaulo		    struct ieee80211_mesh_proto_metric *);
549195618Srpaulo
550195618Srpaulouint8_t *	ieee80211_add_meshid(uint8_t *, struct ieee80211vap *);
551195618Srpaulouint8_t *	ieee80211_add_meshconf(uint8_t *, struct ieee80211vap *);
552195618Srpaulouint8_t *	ieee80211_add_meshpeer(uint8_t *, uint8_t, uint16_t, uint16_t,
553195618Srpaulo		    uint16_t);
554232479Sadrianuint8_t *	ieee80211_add_meshlmetric(uint8_t *, uint8_t, uint32_t);
555246506Smonthadaruint8_t *	ieee80211_add_meshgate(uint8_t *,
556246506Smonthadar		    struct ieee80211_meshgann_ie *);
557195618Srpaulo
558195618Srpaulovoid		ieee80211_mesh_node_init(struct ieee80211vap *,
559195618Srpaulo		    struct ieee80211_node *);
560195618Srpaulovoid		ieee80211_mesh_node_cleanup(struct ieee80211_node *);
561195618Srpaulovoid		ieee80211_parse_meshid(struct ieee80211_node *,
562195618Srpaulo		    const uint8_t *);
563195618Srpaulostruct ieee80211_scanparams;
564195618Srpaulovoid		ieee80211_mesh_init_neighbor(struct ieee80211_node *,
565195618Srpaulo		   const struct ieee80211_frame *,
566195618Srpaulo		   const struct ieee80211_scanparams *);
567198242Srpaulovoid		ieee80211_mesh_update_beacon(struct ieee80211vap *,
568198242Srpaulo		    struct ieee80211_beacon_offsets *);
569246509Smonthadarstruct ieee80211_mesh_gate_route *
570246509Smonthadar		ieee80211_mesh_mark_gate(struct ieee80211vap *,
571246509Smonthadar		    const uint8_t *, struct ieee80211_mesh_route *);
572246510Smonthadarvoid		ieee80211_mesh_forward_to_gates(struct ieee80211vap *,
573246510Smonthadar		    struct ieee80211_mesh_route *);
574246512Smonthadarstruct ieee80211_node *
575246512Smonthadar		ieee80211_mesh_find_txnode(struct ieee80211vap *,
576246512Smonthadar		    const uint8_t [IEEE80211_ADDR_LEN]);
577195618Srpaulo
578195784Srpaulo/*
579195784Srpaulo * Return non-zero if proxy operation is enabled.
580195784Srpaulo */
581195784Srpaulostatic __inline int
582195784Srpauloieee80211_mesh_isproxyena(struct ieee80211vap *vap)
583195784Srpaulo{
584195784Srpaulo	struct ieee80211_mesh_state *ms = vap->iv_mesh;
585195784Srpaulo	return (ms->ms_flags &
586234892Smonthadar	    (IEEE80211_MESHFLAGS_AP | IEEE80211_MESHFLAGS_GATE)) != 0;
587195784Srpaulo}
588195784Srpaulo
589195784Srpaulo/*
590195784Srpaulo * Process an outbound frame: if a path is known to the
591195784Srpaulo * destination then return a reference to the next hop
592195784Srpaulo * for immediate transmission.  Otherwise initiate path
593195784Srpaulo * discovery and, if possible queue the packet to be
594195784Srpaulo * sent when path discovery completes.
595195784Srpaulo */
596195618Srpaulostatic __inline struct ieee80211_node *
597195784Srpauloieee80211_mesh_discover(struct ieee80211vap *vap,
598195618Srpaulo    const uint8_t dest[IEEE80211_ADDR_LEN], struct mbuf *m)
599195618Srpaulo{
600195618Srpaulo	struct ieee80211_mesh_state *ms = vap->iv_mesh;
601195618Srpaulo	return ms->ms_ppath->mpp_discover(vap, dest, m);
602195618Srpaulo}
603195618Srpaulo
604195618Srpaulo#endif /* _KERNEL */
605195618Srpaulo#endif /* !_NET80211_IEEE80211_MESH_H_ */
606