ieee80211_mesh.h revision 197413
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: head/sys/net80211/ieee80211_mesh.h 197413 2009-09-22 18:18:14Z rpaulo $
30195618Srpaulo */
31195618Srpaulo#ifndef _NET80211_IEEE80211_MESH_H_
32195618Srpaulo#define _NET80211_IEEE80211_MESH_H_
33195618Srpaulo
34195618Srpaulo#define	IEEE80211_MESH_DEFAULT_TTL	31
35195618Srpaulo
36195618Srpaulo/*
37197413Srpaulo * NB: all structures are __packed  so sizeof works on arm, et. al.
38195618Srpaulo */
39195618Srpaulo/*
40195618Srpaulo * 802.11s Information Elements.
41195618Srpaulo*/
42195618Srpaulo/* Mesh Configuration */
43195618Srpaulostruct ieee80211_meshconf_ie {
44195618Srpaulo	uint8_t		conf_ie;	/* IEEE80211_ELEMID_MESHCONF */
45195618Srpaulo	uint8_t		conf_len;
46195618Srpaulo	uint8_t		conf_ver;
47195618Srpaulo	uint8_t		conf_pselid[4];	/* Active Path Sel. Proto. ID */
48195618Srpaulo	uint8_t		conf_pmetid[4];	/* APS Metric Identifier */
49195618Srpaulo	uint8_t		conf_ccid[4];	/* Congestion Control Mode ID  */
50195618Srpaulo	uint8_t		conf_syncid[4];	/* Sync. Protocol ID */
51195618Srpaulo	uint8_t		conf_authid[4];	/* Auth. Protocol ID */
52195618Srpaulo	uint8_t		conf_form;	/* Formation Information */
53195618Srpaulo	uint8_t		conf_cap;
54195618Srpaulo} __packed;
55195618Srpaulo
56195618Srpaulo#define	IEEE80211_MESHCONF_VERSION		1
57195618Srpaulo/* Null Protocol */
58195618Srpaulo#define	IEEE80211_MESHCONF_NULL_OUI		0x00, 0x0f, 0xac
59195618Srpaulo#define	IEEE80211_MESHCONF_NULL_VALUE		0xff
60195618Srpaulo#define	IEEE80211_MESHCONF_NULL		{ IEEE80211_MESHCONF_NULL_OUI, \
61195618Srpaulo					  IEEE80211_MESHCONF_NULL_VALUE }
62195618Srpaulo/* Hybrid Wireless Mesh Protocol */
63195618Srpaulo#define	IEEE80211_MESHCONF_HWMP_OUI		0x00, 0x0f, 0xac
64195618Srpaulo#define	IEEE80211_MESHCONF_HWMP_VALUE		0x00
65195618Srpaulo#define	IEEE80211_MESHCONF_HWMP		{ IEEE80211_MESHCONF_HWMP_OUI, \
66195618Srpaulo					  IEEE80211_MESHCONF_HWMP_VALUE }
67195618Srpaulo/* Airtime Link Metric */
68195618Srpaulo#define	IEEE80211_MESHCONF_AIRTIME_OUI		0x00, 0x0f, 0xac
69195618Srpaulo#define	IEEE80211_MESHCONF_AIRTIME_VALUE	0x00
70195618Srpaulo#define	IEEE80211_MESHCONF_AIRTIME	{ IEEE80211_MESHCONF_AIRTIME_OUI, \
71195618Srpaulo					  IEEE80211_MESHCONF_AIRTIME_VALUE }
72195618Srpaulo/* Congestion Control Signaling */
73195618Srpaulo#define	IEEE80211_MESHCONF_CCSIG_OUI		0x00, 0x0f, 0xac
74195618Srpaulo#define	IEEE80211_MESHCONF_CCSIG_VALUE		0x00
75195618Srpaulo#define	IEEE80211_MESHCONF_CCSIG	{ IEEE80211_MESHCONF_CCSIG_OUI,\
76195618Srpaulo					  IEEE80211_MESHCONF_CCSIG_VALUE }
77195618Srpaulo/* Neighbour Offset */
78195618Srpaulo#define	IEEE80211_MESHCONF_NEIGHOFF_OUI		0x00, 0x0f, 0xac
79195618Srpaulo#define	IEEE80211_MESHCONF_NEIGHOFF_VALUE	0x00
80195618Srpaulo#define	IEEE80211_MESHCONF_NEIGHOFF	{ IEEE80211_MESHCONF_NEIGHOFF_OUI, \
81195618Srpaulo					  IEEE80211_MESHCONF_NEIGHOFF_VALUE }
82195618Srpaulo/* Simultaneous Authenticaction of Equals */
83195618Srpaulo#define	IEEE80211_MESHCONF_SAE_OUI		0x00, 0x0f, 0xac
84195618Srpaulo#define	IEEE80211_MESHCONF_SAE_VALUE		0x01
85195618Srpaulo#define	IEEE80211_MESHCONF_SAE		{ IEEE80211_MESHCONF_SAE_OUI, \
86195618Srpaulo					  IEEE80211_MESHCONF_SAE_VALUE }
87195618Srpaulo#define	IEEE80211_MESHCONF_FORM_MP		0x01 /* Connected to Portal */
88195618Srpaulo#define	IEEE80211_MESHCONF_FORM_NNEIGH_MASK	0x04 /* Number of Neighbours */
89195618Srpaulo#define	IEEE80211_MESHCONF_CAP_AP	0x01	/* Accepting Peers */
90195618Srpaulo#define	IEEE80211_MESHCONF_CAP_MCCAS	0x02	/* MCCA supported */
91195618Srpaulo#define	IEEE80211_MESHCONF_CAP_MCCAE	0x04	/* MCCA enabled */
92195618Srpaulo#define	IEEE80211_MESHCONF_CAP_FWRD 	0x08	/* forwarding enabled */
93195618Srpaulo#define	IEEE80211_MESHCONF_CAP_BTR	0x10	/* Beacon Timing Report Enab */
94195618Srpaulo#define	IEEE80211_MESHCONF_CAP_TBTTA	0x20	/* TBTT Adj. Enabled */
95195618Srpaulo#define	IEEE80211_MESHCONF_CAP_PSL	0x40	/* Power Save Level */
96195618Srpaulo
97195618Srpaulo/* Mesh Identifier */
98195618Srpaulostruct ieee80211_meshid_ie {
99195618Srpaulo	uint8_t		id_ie;		/* IEEE80211_ELEMID_MESHID */
100195618Srpaulo	uint8_t		id_len;
101195618Srpaulo} __packed;
102195618Srpaulo
103195618Srpaulo/* Link Metric Report */
104195618Srpaulostruct ieee80211_meshlmetric_ie {
105195618Srpaulo	uint8_t		lm_ie;	/* IEEE80211_ELEMID_MESHLINK */
106195618Srpaulo	uint8_t		lm_len;
107195618Srpaulo	uint32_t	lm_metric;
108195618Srpaulo#define	IEEE80211_MESHLMETRIC_INITIALVAL	0
109195618Srpaulo} __packed;
110195618Srpaulo
111195618Srpaulo/* Congestion Notification */
112195618Srpaulostruct ieee80211_meshcngst_ie {
113195618Srpaulo	uint8_t		cngst_ie;	/* IEEE80211_ELEMID_MESHCNGST */
114195618Srpaulo	uint8_t		cngst_len;
115195618Srpaulo	uint16_t	cngst_timer[4];	/* Expiration Timers: AC_BK,
116195618Srpaulo					   AC_BE, AC_VI, AC_VO */
117195618Srpaulo} __packed;
118195618Srpaulo
119195618Srpaulo/* Peer Link Management */
120195618Srpaulostruct ieee80211_meshpeer_ie {
121195618Srpaulo	uint8_t		peer_ie;	/* IEEE80211_ELEMID_MESHPEER */
122195618Srpaulo	uint8_t		peer_len;
123197413Srpaulo	uint8_t		peer_proto[4];	/* Peer Management Protocol */
124195618Srpaulo	uint16_t	peer_llinkid;	/* Local Link ID */
125195618Srpaulo	uint16_t	peer_linkid;	/* Peer Link ID */
126195618Srpaulo	uint16_t	peer_rcode;
127195618Srpaulo} __packed;
128195618Srpaulo
129195618Srpauloenum {
130195618Srpaulo	IEEE80211_MESH_PEER_LINK_OPEN		= 0,
131195618Srpaulo	IEEE80211_MESH_PEER_LINK_CONFIRM	= 1,
132195618Srpaulo	IEEE80211_MESH_PEER_LINK_CLOSE		= 2,
133195618Srpaulo	/* values 3-255 are reserved */
134195618Srpaulo};
135195618Srpaulo
136197413Srpaulo/* Mesh Peering Management Protocol */
137197413Srpaulo#define	IEEE80211_MESH_PEER_PROTO_OUI		0x00, 0x0f, 0xac
138197413Srpaulo#define	IEEE80211_MESH_PEER_PROTO_VALUE		0x2a
139197413Srpaulo#define	IEEE80211_MESH_PEER_PROTO	{ IEEE80211_MESH_PEER_PROTO_OUI, \
140197413Srpaulo					  IEEE80211_MESH_PEER_PROTO_VALUE }
141197413Srpaulo/* Abbreviated Handshake Protocol */
142197413Srpaulo#define	IEEE80211_MESH_PEER_PROTO_AH_OUI	0x00, 0x0f, 0xac
143197413Srpaulo#define	IEEE80211_MESH_PEER_PROTO_AH_VALUE	0x2b
144197413Srpaulo#define	IEEE80211_MESH_PEER_PROTO_AH	{ IEEE80211_MESH_PEER_PROTO_AH_OUI, \
145197413Srpaulo					  IEEE80211_MESH_PEER_PROTO_AH_VALUE }
146195618Srpaulo#ifdef notyet
147195618Srpaulo/* Mesh Channel Switch Annoucement */
148195618Srpaulostruct ieee80211_meshcsa_ie {
149195618Srpaulo	uint8_t		csa_ie;		/* IEEE80211_ELEMID_MESHCSA */
150195618Srpaulo	uint8_t		csa_len;
151195618Srpaulo	uint8_t		csa_mode;
152195618Srpaulo	uint8_t		csa_newclass;	/* New Regulatory Class */
153195618Srpaulo	uint8_t		csa_newchan;
154195618Srpaulo	uint8_t		csa_precvalue;	/* Precedence Value */
155195618Srpaulo	uint8_t		csa_count;
156195618Srpaulo} __packed;
157195618Srpaulo
158195618Srpaulo/* Mesh TIM */
159195618Srpaulo/* Equal to the non Mesh version */
160195618Srpaulo
161195618Srpaulo/* Mesh Awake Window */
162195618Srpaulostruct ieee80211_meshawakew_ie {
163195618Srpaulo	uint8_t		awakew_ie;		/* IEEE80211_ELEMID_MESHAWAKEW */
164195618Srpaulo	uint8_t		awakew_len;
165195618Srpaulo	uint8_t		awakew_windowlen;	/* in TUs */
166195618Srpaulo} __packed;
167195618Srpaulo
168195618Srpaulo/* Mesh Beacon Timing */
169195618Srpaulostruct ieee80211_meshbeacont_ie {
170195618Srpaulo	uint8_t		beacont_ie;		/* IEEE80211_ELEMID_MESHBEACONT */
171195618Srpaulo	uint8_t		beacont_len;
172195618Srpaulo	struct {
173195618Srpaulo		uint8_t		mp_aid;		/* Least Octet of AID */
174195618Srpaulo		uint16_t	mp_btime;	/* Beacon Time */
175195618Srpaulo		uint16_t	mp_bint;	/* Beacon Interval */
176195618Srpaulo	} __packed mp[1];			/* NB: variable size */
177195618Srpaulo} __packed;
178195618Srpaulo#endif
179195618Srpaulo
180195618Srpaulo/* Portal (MP) Annoucement */
181195618Srpaulostruct ieee80211_meshpann_ie {
182195618Srpaulo	uint8_t		pann_ie;		/* IEEE80211_ELEMID_MESHPANN */
183195618Srpaulo	uint8_t		pann_len;
184195618Srpaulo	uint8_t		pann_flags;
185195618Srpaulo	uint8_t		pann_hopcount;
186195618Srpaulo	uint8_t		pann_ttl;
187195618Srpaulo	uint8_t		pann_addr[IEEE80211_ADDR_LEN];
188195618Srpaulo	uint8_t		pann_seq;		/* PANN Sequence Number */
189195618Srpaulo} __packed;
190195618Srpaulo
191195618Srpaulo/* Root (MP) Annoucement */
192195618Srpaulostruct ieee80211_meshrann_ie {
193195618Srpaulo	uint8_t		rann_ie;		/* IEEE80211_ELEMID_MESHRANN */
194195618Srpaulo	uint8_t		rann_len;
195195618Srpaulo	uint8_t		rann_flags;
196195618Srpaulo#define	IEEE80211_MESHRANN_FLAGS_PR	0x01	/* Portal Role */
197195618Srpaulo	uint8_t		rann_hopcount;
198195618Srpaulo	uint8_t		rann_ttl;
199195618Srpaulo	uint8_t		rann_addr[IEEE80211_ADDR_LEN];
200195618Srpaulo	uint32_t	rann_seq;		/* HWMP Sequence Number */
201195618Srpaulo	uint32_t	rann_metric;
202195618Srpaulo} __packed;
203195618Srpaulo
204195618Srpaulo/* Mesh Path Request */
205195618Srpaulostruct ieee80211_meshpreq_ie {
206195618Srpaulo	uint8_t		preq_ie;	/* IEEE80211_ELEMID_MESHPREQ */
207195618Srpaulo	uint8_t		preq_len;
208195618Srpaulo	uint8_t		preq_flags;
209195618Srpaulo#define	IEEE80211_MESHPREQ_FLAGS_PR	0x01	/* Portal Role */
210195618Srpaulo#define	IEEE80211_MESHPREQ_FLAGS_AM	0x02	/* 0 = ucast / 1 = bcast */
211195618Srpaulo#define	IEEE80211_MESHPREQ_FLAGS_PP	0x04	/* Proactive PREP */
212195618Srpaulo#define	IEEE80211_MESHPREQ_FLAGS_AE	0x40	/* Address Extension */
213195618Srpaulo	uint8_t		preq_hopcount;
214195618Srpaulo	uint8_t		preq_ttl;
215195618Srpaulo	uint32_t	preq_id;
216195618Srpaulo	uint8_t		preq_origaddr[IEEE80211_ADDR_LEN];
217195618Srpaulo	uint32_t	preq_origseq;	/* HWMP Sequence Number */
218195618Srpaulo	/* NB: may have Originator Proxied Address */
219195618Srpaulo	uint32_t	preq_lifetime;
220195618Srpaulo	uint32_t	preq_metric;
221195618Srpaulo	uint8_t		preq_tcount;	/* target count */
222195618Srpaulo	struct {
223195618Srpaulo		uint8_t		target_flags;
224195618Srpaulo#define	IEEE80211_MESHPREQ_TFLAGS_TO	0x01	/* Target Only */
225195618Srpaulo#define	IEEE80211_MESHPREQ_TFLAGS_RF	0x02	/* Reply and Forward */
226195618Srpaulo#define	IEEE80211_MESHPREQ_TFLAGS_USN	0x04	/* Unknown HWMP seq number */
227195618Srpaulo		uint8_t		target_addr[IEEE80211_ADDR_LEN];
228195618Srpaulo		uint32_t	target_seq;	/* HWMP Sequence Number */
229195618Srpaulo	} __packed preq_targets[1];		/* NB: variable size */
230195618Srpaulo} __packed;
231195618Srpaulo
232195618Srpaulo/* Mesh Path Reply */
233195618Srpaulostruct ieee80211_meshprep_ie {
234195618Srpaulo	uint8_t		prep_ie;	/* IEEE80211_ELEMID_MESHPREP */
235195618Srpaulo	uint8_t		prep_len;
236195618Srpaulo	uint8_t		prep_flags;
237195618Srpaulo	uint8_t		prep_hopcount;
238195618Srpaulo	uint8_t		prep_ttl;
239195618Srpaulo	uint8_t		prep_targetaddr[IEEE80211_ADDR_LEN];
240195618Srpaulo	uint32_t	prep_targetseq;
241195618Srpaulo	/* NB: May have Target Proxied Address */
242195618Srpaulo	uint32_t	prep_lifetime;
243195618Srpaulo	uint32_t	prep_metric;
244195618Srpaulo	uint8_t		prep_origaddr[IEEE80211_ADDR_LEN];
245195618Srpaulo	uint32_t	prep_origseq;	/* HWMP Sequence Number */
246195618Srpaulo} __packed;
247195618Srpaulo
248195618Srpaulo/* Mesh Path Error */
249195618Srpaulostruct ieee80211_meshperr_ie {
250195618Srpaulo	uint8_t		perr_ie;	/* IEEE80211_ELEMID_MESHPERR */
251195618Srpaulo	uint8_t		perr_len;
252197413Srpaulo	uint8_t		perr_ttl;
253195618Srpaulo	uint8_t		perr_ndests;	/* Number of Destinations */
254195618Srpaulo	struct {
255197413Srpaulo		uint8_t		dest_flags;
256197413Srpaulo#define	IEEE80211_MESHPERR_DFLAGS_USN	0x01
257197413Srpaulo#define	IEEE80211_MESHPERR_DFLAGS_RC	0x02
258195618Srpaulo		uint8_t		dest_addr[IEEE80211_ADDR_LEN];
259195618Srpaulo		uint32_t	dest_seq;	/* HWMP Sequence Number */
260197413Srpaulo		uint16_t	dest_rcode;
261195618Srpaulo	} __packed perr_dests[1];		/* NB: variable size */
262195618Srpaulo} __packed;
263195618Srpaulo
264195618Srpaulo#ifdef notyet
265195618Srpaulo/* Mesh Proxy Update */
266195618Srpaulostruct ieee80211_meshpu_ie {
267195618Srpaulo	uint8_t		pu_ie;		/* IEEE80211_ELEMID_MESHPU */
268195618Srpaulo	uint8_t		pu_len;
269195618Srpaulo	uint8_t		pu_flags;
270195618Srpaulo#define	IEEE80211_MESHPU_FLAGS_MASK		0x1
271195618Srpaulo#define	IEEE80211_MESHPU_FLAGS_DEL		0x0
272195618Srpaulo#define	IEEE80211_MESHPU_FLAGS_ADD		0x1
273195618Srpaulo	uint8_t		pu_seq;		/* PU Sequence Number */
274195618Srpaulo	uint8_t		pu_addr[IEEE80211_ADDR_LEN];
275195618Srpaulo	uint8_t		pu_naddr;	/* Number of Proxied Addresses */
276195618Srpaulo	/* NB: proxied address follows */
277195618Srpaulo} __packed;
278195618Srpaulo
279195618Srpaulo/* Mesh Proxy Update Confirmation */
280195618Srpaulostruct ieee80211_meshpuc_ie {
281195618Srpaulo	uint8_t		puc_ie;		/* IEEE80211_ELEMID_MESHPUC */
282195618Srpaulo	uint8_t		puc_len;
283195618Srpaulo	uint8_t		puc_flags;
284195618Srpaulo	uint8_t		puc_seq;	/* PU Sequence Number */
285195618Srpaulo	uint8_t		puc_daddr[IEEE80211_ADDR_LEN];
286195618Srpaulo} __packed;
287195618Srpaulo#endif
288195618Srpaulo
289195618Srpaulo/*
290195618Srpaulo * 802.11s Action Frames
291195618Srpaulo */
292195618Srpaulo#define	IEEE80211_ACTION_CAT_MESHPEERING	30	/* XXX Linux */
293195618Srpaulo#define	IEEE80211_ACTION_CAT_MESHLMETRIC	13
294195618Srpaulo#define	IEEE80211_ACTION_CAT_MESHPATH		32	/* XXX Linux */
295195618Srpaulo#define	IEEE80211_ACTION_CAT_INTERWORK		15
296195618Srpaulo#define	IEEE80211_ACTION_CAT_RESOURCE		16
297195618Srpaulo#define	IEEE80211_ACTION_CAT_PROXY		17
298195618Srpaulo
299195618Srpaulo/*
300195618Srpaulo * Mesh Peering Action codes.
301195618Srpaulo */
302195618Srpauloenum {
303195618Srpaulo	IEEE80211_ACTION_MESHPEERING_OPEN	= 0,
304195618Srpaulo	IEEE80211_ACTION_MESHPEERING_CONFIRM	= 1,
305195618Srpaulo	IEEE80211_ACTION_MESHPEERING_CLOSE	= 2,
306195618Srpaulo	/* 3-255 reserved */
307195618Srpaulo};
308195618Srpaulo
309195618Srpaulo/*
310197413Srpaulo * Mesh Path Selection Action code.
311195618Srpaulo */
312195618Srpauloenum {
313197413Srpaulo	IEEE80211_ACTION_MESHPATH_SEL	= 0,
314197413Srpaulo	/* 1-255 reserved */
315195618Srpaulo};
316195618Srpaulo
317195618Srpaulo/*
318195618Srpaulo * Mesh Link Metric Action codes.
319195618Srpaulo */
320195618Srpauloenum {
321195618Srpaulo	IEEE80211_ACTION_MESHLMETRIC_REQ = 0,	/* Link Metric Request */
322195618Srpaulo	IEEE80211_ACTION_MESHLMETRIC_REP = 1,	/* Link Metric Report */
323195618Srpaulo	/* 2-255 reserved */
324195618Srpaulo};
325195618Srpaulo
326195618Srpaulo/*
327195618Srpaulo * Mesh Portal Annoucement Action codes.
328195618Srpaulo */
329195618Srpauloenum {
330195618Srpaulo	IEEE80211_ACTION_MESHPANN	= 0,
331195618Srpaulo	/* 1-255 reserved */
332195618Srpaulo};
333195618Srpaulo
334195618Srpaulo/*
335195618Srpaulo * Different mesh control structures based on the AE
336195618Srpaulo * (Address Extension) bits.
337195618Srpaulo */
338195618Srpaulostruct ieee80211_meshcntl {
339195618Srpaulo	uint8_t		mc_flags;	/* Address Extension 00 */
340195618Srpaulo	uint8_t		mc_ttl;		/* TTL */
341195618Srpaulo	uint8_t		mc_seq[4];	/* Sequence No. */
342195618Srpaulo	/* NB: more addresses may follow */
343195618Srpaulo} __packed;
344195618Srpaulo
345195618Srpaulostruct ieee80211_meshcntl_ae01 {
346195618Srpaulo	uint8_t		mc_flags;	/* Address Extension 01 */
347195618Srpaulo	uint8_t		mc_ttl;		/* TTL */
348195618Srpaulo	uint8_t		mc_seq[4];	/* Sequence No. */
349195618Srpaulo	uint8_t		mc_addr4[IEEE80211_ADDR_LEN];
350195618Srpaulo} __packed;
351195618Srpaulo
352195618Srpaulostruct ieee80211_meshcntl_ae10 {
353195618Srpaulo	uint8_t		mc_flags;	/* Address Extension 10 */
354195618Srpaulo	uint8_t		mc_ttl;		/* TTL */
355195618Srpaulo	uint8_t		mc_seq[4];	/* Sequence No. */
356195784Srpaulo	uint8_t		mc_addr4[IEEE80211_ADDR_LEN];
357195618Srpaulo	uint8_t		mc_addr5[IEEE80211_ADDR_LEN];
358195618Srpaulo} __packed;
359195618Srpaulo
360195618Srpaulostruct ieee80211_meshcntl_ae11 {
361195618Srpaulo	uint8_t		mc_flags;	/* Address Extension 11 */
362195618Srpaulo	uint8_t		mc_ttl;		/* TTL */
363195618Srpaulo	uint8_t		mc_seq[4];	/* Sequence No. */
364195618Srpaulo	uint8_t		mc_addr4[IEEE80211_ADDR_LEN];
365195618Srpaulo	uint8_t		mc_addr5[IEEE80211_ADDR_LEN];
366195618Srpaulo	uint8_t		mc_addr6[IEEE80211_ADDR_LEN];
367195618Srpaulo} __packed;
368195618Srpaulo
369195618Srpaulo#ifdef _KERNEL
370195618SrpauloMALLOC_DECLARE(M_80211_MESH_RT);
371195618Srpaulostruct ieee80211_mesh_route {
372195618Srpaulo	TAILQ_ENTRY(ieee80211_mesh_route)	rt_next;
373195813Ssam	int			rt_crtime;	/* creation time */
374195618Srpaulo	uint8_t			rt_dest[IEEE80211_ADDR_LEN];
375195618Srpaulo	uint8_t			rt_nexthop[IEEE80211_ADDR_LEN];
376195618Srpaulo	uint32_t		rt_metric;	/* path metric */
377195618Srpaulo	uint16_t		rt_nhops;	/* number of hops */
378195784Srpaulo	uint16_t		rt_flags;
379195784Srpaulo#define	IEEE80211_MESHRT_FLAGS_VALID	0x01	/* patch discovery complete */
380195784Srpaulo#define	IEEE80211_MESHRT_FLAGS_PROXY	0x02	/* proxy entry */
381195618Srpaulo	uint32_t		rt_lifetime;
382195618Srpaulo	uint32_t		rt_lastmseq;	/* last seq# seen dest */
383195618Srpaulo	void			*rt_priv;	/* private data */
384195618Srpaulo};
385195618Srpaulo#define	IEEE80211_MESH_ROUTE_PRIV(rt, cast)	((cast *)rt->rt_priv)
386195618Srpaulo
387195618Srpaulo#define	IEEE80211_MESH_PROTO_DSZ	12	/* description size */
388195618Srpaulo/*
389195618Srpaulo * Mesh Path Selection Protocol.
390195618Srpaulo */
391195618Srpauloenum ieee80211_state;
392195618Srpaulostruct ieee80211_mesh_proto_path {
393195618Srpaulo	char 		mpp_descr[IEEE80211_MESH_PROTO_DSZ];
394195618Srpaulo	uint8_t		mpp_ie[4];
395195618Srpaulo	struct ieee80211_node *
396195618Srpaulo	    		(*mpp_discover)(struct ieee80211vap *,
397195618Srpaulo				const uint8_t [IEEE80211_ADDR_LEN],
398195618Srpaulo				struct mbuf *);
399195618Srpaulo	void		(*mpp_peerdown)(struct ieee80211_node *);
400195618Srpaulo	void		(*mpp_vattach)(struct ieee80211vap *);
401195618Srpaulo	void		(*mpp_vdetach)(struct ieee80211vap *);
402195618Srpaulo	int		(*mpp_newstate)(struct ieee80211vap *,
403195618Srpaulo			    enum ieee80211_state, int);
404195784Srpaulo	const size_t	mpp_privlen;	/* size required in the routing table
405195618Srpaulo					   for private data */
406195813Ssam	int		mpp_inact;	/* inact. timeout for invalid routes
407195813Ssam					   (ticks) */
408195618Srpaulo};
409195618Srpaulo
410195618Srpaulo/*
411195618Srpaulo * Mesh Link Metric Report Protocol.
412195618Srpaulo */
413195618Srpaulostruct ieee80211_mesh_proto_metric {
414195618Srpaulo	char		mpm_descr[IEEE80211_MESH_PROTO_DSZ];
415195618Srpaulo	uint8_t		mpm_ie[4];
416195618Srpaulo	uint32_t	(*mpm_metric)(struct ieee80211_node *);
417195618Srpaulo};
418195618Srpaulo
419195618Srpaulo#ifdef notyet
420195618Srpaulo/*
421195618Srpaulo * Mesh Authentication Protocol.
422195618Srpaulo */
423195618Srpaulostruct ieee80211_mesh_proto_auth {
424195618Srpaulo	uint8_t		mpa_ie[4];
425195618Srpaulo};
426195618Srpaulo
427195618Srpaulostruct ieee80211_mesh_proto_congestion {
428195618Srpaulo};
429195618Srpaulo
430195618Srpaulostruct ieee80211_mesh_proto_sync {
431195618Srpaulo};
432195618Srpaulo#endif
433195618Srpaulo
434195618Srpaulotypedef uint32_t ieee80211_mesh_seq;
435195618Srpaulo#define	IEEE80211_MESH_SEQ_LEQ(a, b)	((int32_t)((a)-(b)) <= 0)
436195618Srpaulo#define	IEEE80211_MESH_SEQ_GEQ(a, b)	((int32_t)((a)-(b)) >= 0)
437195618Srpaulo
438195618Srpaulostruct ieee80211_mesh_state {
439195618Srpaulo	int				ms_idlen;
440195618Srpaulo	uint8_t				ms_id[IEEE80211_MESHID_LEN];
441195618Srpaulo	ieee80211_mesh_seq		ms_seq;	/* seq no for meshcntl */
442195618Srpaulo	uint16_t			ms_neighbors;
443195618Srpaulo	uint8_t				ms_ttl;	/* mesh ttl set in packets */
444195618Srpaulo#define IEEE80211_MESHFLAGS_AP		0x01	/* accept peers */
445195618Srpaulo#define IEEE80211_MESHFLAGS_PORTAL	0x02	/* mesh portal role */
446195618Srpaulo#define IEEE80211_MESHFLAGS_FWD		0x04	/* forward packets */
447195618Srpaulo	uint8_t				ms_flags;
448195618Srpaulo	struct mtx			ms_rt_lock;
449195784Srpaulo	struct callout			ms_cleantimer;
450195618Srpaulo	TAILQ_HEAD(, ieee80211_mesh_route)  ms_routes;
451195618Srpaulo	struct ieee80211_mesh_proto_metric *ms_pmetric;
452195618Srpaulo	struct ieee80211_mesh_proto_path   *ms_ppath;
453195618Srpaulo};
454195618Srpaulovoid		ieee80211_mesh_attach(struct ieee80211com *);
455195618Srpaulovoid		ieee80211_mesh_detach(struct ieee80211com *);
456195618Srpaulo
457195618Srpaulostruct ieee80211_mesh_route *
458195618Srpaulo		ieee80211_mesh_rt_find(struct ieee80211vap *,
459195618Srpaulo		    const uint8_t [IEEE80211_ADDR_LEN]);
460195618Srpaulostruct ieee80211_mesh_route *
461195618Srpaulo                ieee80211_mesh_rt_add(struct ieee80211vap *,
462195618Srpaulo		    const uint8_t [IEEE80211_ADDR_LEN]);
463195618Srpaulovoid		ieee80211_mesh_rt_del(struct ieee80211vap *,
464195618Srpaulo		    const uint8_t [IEEE80211_ADDR_LEN]);
465195618Srpaulovoid		ieee80211_mesh_rt_flush(struct ieee80211vap *);
466195908Srpaulovoid		ieee80211_mesh_rt_flush_peer(struct ieee80211vap *,
467195908Srpaulo		    const uint8_t [IEEE80211_ADDR_LEN]);
468195784Srpaulovoid		ieee80211_mesh_proxy_check(struct ieee80211vap *,
469195784Srpaulo		    const uint8_t [IEEE80211_ADDR_LEN]);
470195618Srpaulo
471195618Srpauloint		ieee80211_mesh_register_proto_path(const
472195618Srpaulo		    struct ieee80211_mesh_proto_path *);
473195618Srpauloint		ieee80211_mesh_register_proto_metric(const
474195618Srpaulo		    struct ieee80211_mesh_proto_metric *);
475195618Srpaulo
476195618Srpaulouint8_t *	ieee80211_add_meshid(uint8_t *, struct ieee80211vap *);
477195618Srpaulouint8_t *	ieee80211_add_meshconf(uint8_t *, struct ieee80211vap *);
478195618Srpaulouint8_t *	ieee80211_add_meshpeer(uint8_t *, uint8_t, uint16_t, uint16_t,
479195618Srpaulo		    uint16_t);
480195618Srpaulouint8_t *	ieee80211_add_meshlmetric(uint8_t *, uint32_t);
481195618Srpaulo
482195618Srpaulovoid		ieee80211_mesh_node_init(struct ieee80211vap *,
483195618Srpaulo		    struct ieee80211_node *);
484195618Srpaulovoid		ieee80211_mesh_node_cleanup(struct ieee80211_node *);
485195618Srpaulovoid		ieee80211_parse_meshid(struct ieee80211_node *,
486195618Srpaulo		    const uint8_t *);
487195618Srpaulostruct ieee80211_scanparams;
488195618Srpaulovoid		ieee80211_mesh_init_neighbor(struct ieee80211_node *,
489195618Srpaulo		   const struct ieee80211_frame *,
490195618Srpaulo		   const struct ieee80211_scanparams *);
491195618Srpaulo
492195784Srpaulo/*
493195784Srpaulo * Return non-zero if proxy operation is enabled.
494195784Srpaulo */
495195784Srpaulostatic __inline int
496195784Srpauloieee80211_mesh_isproxyena(struct ieee80211vap *vap)
497195784Srpaulo{
498195784Srpaulo	struct ieee80211_mesh_state *ms = vap->iv_mesh;
499195784Srpaulo	return (ms->ms_flags &
500195784Srpaulo	    (IEEE80211_MESHFLAGS_AP | IEEE80211_MESHFLAGS_PORTAL)) != 0;
501195784Srpaulo}
502195784Srpaulo
503195784Srpaulo/*
504195784Srpaulo * Process an outbound frame: if a path is known to the
505195784Srpaulo * destination then return a reference to the next hop
506195784Srpaulo * for immediate transmission.  Otherwise initiate path
507195784Srpaulo * discovery and, if possible queue the packet to be
508195784Srpaulo * sent when path discovery completes.
509195784Srpaulo */
510195618Srpaulostatic __inline struct ieee80211_node *
511195784Srpauloieee80211_mesh_discover(struct ieee80211vap *vap,
512195618Srpaulo    const uint8_t dest[IEEE80211_ADDR_LEN], struct mbuf *m)
513195618Srpaulo{
514195618Srpaulo	struct ieee80211_mesh_state *ms = vap->iv_mesh;
515195618Srpaulo	return ms->ms_ppath->mpp_discover(vap, dest, m);
516195618Srpaulo}
517195618Srpaulo
518195618Srpaulo#endif /* _KERNEL */
519195618Srpaulo#endif /* !_NET80211_IEEE80211_MESH_H_ */
520