ieee80211_mesh.h revision 197975
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 197975 2009-10-12 10:08:58Z rpaulo $ 30 */ 31#ifndef _NET80211_IEEE80211_MESH_H_ 32#define _NET80211_IEEE80211_MESH_H_ 33 34#define IEEE80211_MESH_DEFAULT_TTL 31 35 36/* 37 * NB: all structures are __packed so sizeof works on arm, et. al. 38 */ 39/* 40 * 802.11s Information Elements. 41*/ 42/* Mesh Configuration */ 43struct ieee80211_meshconf_ie { 44 uint8_t conf_ie; /* IEEE80211_ELEMID_MESHCONF */ 45 uint8_t conf_len; 46 uint8_t conf_pselid; /* Active Path Sel. Proto. ID */ 47 uint8_t conf_pmetid; /* Active Metric Identifier */ 48 uint8_t conf_ccid; /* Congestion Control Mode ID */ 49 uint8_t conf_syncid; /* Sync. Protocol ID */ 50 uint8_t conf_authid; /* Auth. Protocol ID */ 51 uint8_t conf_form; /* Formation Information */ 52 uint8_t conf_cap; 53} __packed; 54 55/* Hybrid Wireless Mesh Protocol */ 56#define IEEE80211_MESHCONF_PATH_HWMP 0x00 57/* Airtime Link Metric */ 58#define IEEE80211_MESHCONF_METRIC_AIRTIME 0x00 59/* Congestion Control */ 60#define IEEE80211_MESHCONF_CC_DISABLED 0x00 61#define IEEE80211_MESHCONF_CC_SIG 0x01 62/* Neighbour Offset */ 63#define IEEE80211_MESHCONF_SYNC_NEIGHOFF 0x00 64#define IEEE80211_MESHCONF_AUTH_DISABLED 0x00 65/* Simultaneous Authenticaction of Equals */ 66#define IEEE80211_MESHCONF_AUTH_SAE 0x01 67#define IEEE80211_MESHCONF_FORM_MP 0x01 /* Connected to Portal */ 68#define IEEE80211_MESHCONF_FORM_NNEIGH_MASK 0x04 /* Number of Neighbours */ 69#define IEEE80211_MESHCONF_CAP_AP 0x01 /* Accepting Peers */ 70#define IEEE80211_MESHCONF_CAP_MCCAS 0x02 /* MCCA supported */ 71#define IEEE80211_MESHCONF_CAP_MCCAE 0x04 /* MCCA enabled */ 72#define IEEE80211_MESHCONF_CAP_FWRD 0x08 /* forwarding enabled */ 73#define IEEE80211_MESHCONF_CAP_BTR 0x10 /* Beacon Timing Report Enab */ 74#define IEEE80211_MESHCONF_CAP_TBTTA 0x20 /* TBTT Adj. Enabled */ 75#define IEEE80211_MESHCONF_CAP_PSL 0x40 /* Power Save Level */ 76 77/* Mesh Identifier */ 78struct ieee80211_meshid_ie { 79 uint8_t id_ie; /* IEEE80211_ELEMID_MESHID */ 80 uint8_t id_len; 81} __packed; 82 83/* Link Metric Report */ 84struct ieee80211_meshlmetric_ie { 85 uint8_t lm_ie; /* IEEE80211_ELEMID_MESHLINK */ 86 uint8_t lm_len; 87 uint32_t lm_metric; 88#define IEEE80211_MESHLMETRIC_INITIALVAL 0 89} __packed; 90 91/* Congestion Notification */ 92struct ieee80211_meshcngst_ie { 93 uint8_t cngst_ie; /* IEEE80211_ELEMID_MESHCNGST */ 94 uint8_t cngst_len; 95 uint16_t cngst_timer[4]; /* Expiration Timers: AC_BK, 96 AC_BE, AC_VI, AC_VO */ 97} __packed; 98 99/* Peer Link Management */ 100struct ieee80211_meshpeer_ie { 101 uint8_t peer_ie; /* IEEE80211_ELEMID_MESHPEER */ 102 uint8_t peer_len; 103 uint8_t peer_proto[4]; /* Peer Management Protocol */ 104 uint16_t peer_llinkid; /* Local Link ID */ 105 uint16_t peer_linkid; /* Peer Link ID */ 106 uint16_t peer_rcode; 107} __packed; 108 109enum { 110 IEEE80211_MESH_PEER_LINK_OPEN = 0, 111 IEEE80211_MESH_PEER_LINK_CONFIRM = 1, 112 IEEE80211_MESH_PEER_LINK_CLOSE = 2, 113 /* values 3-255 are reserved */ 114}; 115 116/* Mesh Peering Management Protocol */ 117#define IEEE80211_MESH_PEER_PROTO_OUI 0x00, 0x0f, 0xac 118#define IEEE80211_MESH_PEER_PROTO_VALUE 0x2a 119#define IEEE80211_MESH_PEER_PROTO { IEEE80211_MESH_PEER_PROTO_OUI, \ 120 IEEE80211_MESH_PEER_PROTO_VALUE } 121/* Abbreviated Handshake Protocol */ 122#define IEEE80211_MESH_PEER_PROTO_AH_OUI 0x00, 0x0f, 0xac 123#define IEEE80211_MESH_PEER_PROTO_AH_VALUE 0x2b 124#define IEEE80211_MESH_PEER_PROTO_AH { IEEE80211_MESH_PEER_PROTO_AH_OUI, \ 125 IEEE80211_MESH_PEER_PROTO_AH_VALUE } 126#ifdef notyet 127/* Mesh Channel Switch Annoucement */ 128struct ieee80211_meshcsa_ie { 129 uint8_t csa_ie; /* IEEE80211_ELEMID_MESHCSA */ 130 uint8_t csa_len; 131 uint8_t csa_mode; 132 uint8_t csa_newclass; /* New Regulatory Class */ 133 uint8_t csa_newchan; 134 uint8_t csa_precvalue; /* Precedence Value */ 135 uint8_t csa_count; 136} __packed; 137 138/* Mesh TIM */ 139/* Equal to the non Mesh version */ 140 141/* Mesh Awake Window */ 142struct ieee80211_meshawakew_ie { 143 uint8_t awakew_ie; /* IEEE80211_ELEMID_MESHAWAKEW */ 144 uint8_t awakew_len; 145 uint8_t awakew_windowlen; /* in TUs */ 146} __packed; 147 148/* Mesh Beacon Timing */ 149struct ieee80211_meshbeacont_ie { 150 uint8_t beacont_ie; /* IEEE80211_ELEMID_MESHBEACONT */ 151 uint8_t beacont_len; 152 struct { 153 uint8_t mp_aid; /* Least Octet of AID */ 154 uint16_t mp_btime; /* Beacon Time */ 155 uint16_t mp_bint; /* Beacon Interval */ 156 } __packed mp[1]; /* NB: variable size */ 157} __packed; 158#endif 159 160/* Portal (MP) Annoucement */ 161struct ieee80211_meshpann_ie { 162 uint8_t pann_ie; /* IEEE80211_ELEMID_MESHPANN */ 163 uint8_t pann_len; 164 uint8_t pann_flags; 165 uint8_t pann_hopcount; 166 uint8_t pann_ttl; 167 uint8_t pann_addr[IEEE80211_ADDR_LEN]; 168 uint8_t pann_seq; /* PANN Sequence Number */ 169} __packed; 170 171/* Root (MP) Annoucement */ 172struct ieee80211_meshrann_ie { 173 uint8_t rann_ie; /* IEEE80211_ELEMID_MESHRANN */ 174 uint8_t rann_len; 175 uint8_t rann_flags; 176#define IEEE80211_MESHRANN_FLAGS_PR 0x01 /* Portal Role */ 177 uint8_t rann_hopcount; 178 uint8_t rann_ttl; 179 uint8_t rann_addr[IEEE80211_ADDR_LEN]; 180 uint32_t rann_seq; /* HWMP Sequence Number */ 181 uint32_t rann_metric; 182} __packed; 183 184/* Mesh Path Request */ 185struct ieee80211_meshpreq_ie { 186 uint8_t preq_ie; /* IEEE80211_ELEMID_MESHPREQ */ 187 uint8_t preq_len; 188 uint8_t preq_flags; 189#define IEEE80211_MESHPREQ_FLAGS_PR 0x01 /* Portal Role */ 190#define IEEE80211_MESHPREQ_FLAGS_AM 0x02 /* 0 = ucast / 1 = bcast */ 191#define IEEE80211_MESHPREQ_FLAGS_PP 0x04 /* Proactive PREP */ 192#define IEEE80211_MESHPREQ_FLAGS_AE 0x40 /* Address Extension */ 193 uint8_t preq_hopcount; 194 uint8_t preq_ttl; 195 uint32_t preq_id; 196 uint8_t preq_origaddr[IEEE80211_ADDR_LEN]; 197 uint32_t preq_origseq; /* HWMP Sequence Number */ 198 /* NB: may have Originator Proxied Address */ 199 uint32_t preq_lifetime; 200 uint32_t preq_metric; 201 uint8_t preq_tcount; /* target count */ 202 struct { 203 uint8_t target_flags; 204#define IEEE80211_MESHPREQ_TFLAGS_TO 0x01 /* Target Only */ 205#define IEEE80211_MESHPREQ_TFLAGS_RF 0x02 /* Reply and Forward */ 206#define IEEE80211_MESHPREQ_TFLAGS_USN 0x04 /* Unknown HWMP seq number */ 207 uint8_t target_addr[IEEE80211_ADDR_LEN]; 208 uint32_t target_seq; /* HWMP Sequence Number */ 209 } __packed preq_targets[1]; /* NB: variable size */ 210} __packed; 211 212/* Mesh Path Reply */ 213struct ieee80211_meshprep_ie { 214 uint8_t prep_ie; /* IEEE80211_ELEMID_MESHPREP */ 215 uint8_t prep_len; 216 uint8_t prep_flags; 217 uint8_t prep_hopcount; 218 uint8_t prep_ttl; 219 uint8_t prep_targetaddr[IEEE80211_ADDR_LEN]; 220 uint32_t prep_targetseq; 221 /* NB: May have Target Proxied Address */ 222 uint32_t prep_lifetime; 223 uint32_t prep_metric; 224 uint8_t prep_origaddr[IEEE80211_ADDR_LEN]; 225 uint32_t prep_origseq; /* HWMP Sequence Number */ 226} __packed; 227 228/* Mesh Path Error */ 229struct ieee80211_meshperr_ie { 230 uint8_t perr_ie; /* IEEE80211_ELEMID_MESHPERR */ 231 uint8_t perr_len; 232 uint8_t perr_ttl; 233 uint8_t perr_ndests; /* Number of Destinations */ 234 struct { 235 uint8_t dest_flags; 236#define IEEE80211_MESHPERR_DFLAGS_USN 0x01 237#define IEEE80211_MESHPERR_DFLAGS_RC 0x02 238 uint8_t dest_addr[IEEE80211_ADDR_LEN]; 239 uint32_t dest_seq; /* HWMP Sequence Number */ 240 uint16_t dest_rcode; 241 } __packed perr_dests[1]; /* NB: variable size */ 242} __packed; 243 244#ifdef notyet 245/* Mesh Proxy Update */ 246struct ieee80211_meshpu_ie { 247 uint8_t pu_ie; /* IEEE80211_ELEMID_MESHPU */ 248 uint8_t pu_len; 249 uint8_t pu_flags; 250#define IEEE80211_MESHPU_FLAGS_MASK 0x1 251#define IEEE80211_MESHPU_FLAGS_DEL 0x0 252#define IEEE80211_MESHPU_FLAGS_ADD 0x1 253 uint8_t pu_seq; /* PU Sequence Number */ 254 uint8_t pu_addr[IEEE80211_ADDR_LEN]; 255 uint8_t pu_naddr; /* Number of Proxied Addresses */ 256 /* NB: proxied address follows */ 257} __packed; 258 259/* Mesh Proxy Update Confirmation */ 260struct ieee80211_meshpuc_ie { 261 uint8_t puc_ie; /* IEEE80211_ELEMID_MESHPUC */ 262 uint8_t puc_len; 263 uint8_t puc_flags; 264 uint8_t puc_seq; /* PU Sequence Number */ 265 uint8_t puc_daddr[IEEE80211_ADDR_LEN]; 266} __packed; 267#endif 268 269/* 270 * 802.11s Action Frames 271 */ 272#define IEEE80211_ACTION_CAT_MESHPEERING 30 /* XXX Linux */ 273#define IEEE80211_ACTION_CAT_MESHLMETRIC 13 274#define IEEE80211_ACTION_CAT_MESHPATH 32 /* XXX Linux */ 275#define IEEE80211_ACTION_CAT_INTERWORK 15 276#define IEEE80211_ACTION_CAT_RESOURCE 16 277#define IEEE80211_ACTION_CAT_PROXY 17 278 279/* 280 * Mesh Peering Action codes. 281 */ 282enum { 283 IEEE80211_ACTION_MESHPEERING_OPEN = 0, 284 IEEE80211_ACTION_MESHPEERING_CONFIRM = 1, 285 IEEE80211_ACTION_MESHPEERING_CLOSE = 2, 286 /* 3-255 reserved */ 287}; 288 289/* 290 * Mesh Path Selection Action code. 291 */ 292enum { 293 IEEE80211_ACTION_MESHPATH_SEL = 0, 294 /* 1-255 reserved */ 295}; 296 297/* 298 * Mesh Link Metric Action codes. 299 */ 300enum { 301 IEEE80211_ACTION_MESHLMETRIC_REQ = 0, /* Link Metric Request */ 302 IEEE80211_ACTION_MESHLMETRIC_REP = 1, /* Link Metric Report */ 303 /* 2-255 reserved */ 304}; 305 306/* 307 * Mesh Portal Annoucement Action codes. 308 */ 309enum { 310 IEEE80211_ACTION_MESHPANN = 0, 311 /* 1-255 reserved */ 312}; 313 314/* 315 * Different mesh control structures based on the AE 316 * (Address Extension) bits. 317 */ 318struct ieee80211_meshcntl { 319 uint8_t mc_flags; /* Address Extension 00 */ 320 uint8_t mc_ttl; /* TTL */ 321 uint8_t mc_seq[4]; /* Sequence No. */ 322 /* NB: more addresses may follow */ 323} __packed; 324 325struct ieee80211_meshcntl_ae01 { 326 uint8_t mc_flags; /* Address Extension 01 */ 327 uint8_t mc_ttl; /* TTL */ 328 uint8_t mc_seq[4]; /* Sequence No. */ 329 uint8_t mc_addr4[IEEE80211_ADDR_LEN]; 330} __packed; 331 332struct ieee80211_meshcntl_ae10 { 333 uint8_t mc_flags; /* Address Extension 10 */ 334 uint8_t mc_ttl; /* TTL */ 335 uint8_t mc_seq[4]; /* Sequence No. */ 336 uint8_t mc_addr4[IEEE80211_ADDR_LEN]; 337 uint8_t mc_addr5[IEEE80211_ADDR_LEN]; 338} __packed; 339 340struct ieee80211_meshcntl_ae11 { 341 uint8_t mc_flags; /* Address Extension 11 */ 342 uint8_t mc_ttl; /* TTL */ 343 uint8_t mc_seq[4]; /* Sequence No. */ 344 uint8_t mc_addr4[IEEE80211_ADDR_LEN]; 345 uint8_t mc_addr5[IEEE80211_ADDR_LEN]; 346 uint8_t mc_addr6[IEEE80211_ADDR_LEN]; 347} __packed; 348 349#ifdef _KERNEL 350MALLOC_DECLARE(M_80211_MESH_RT); 351struct ieee80211_mesh_route { 352 TAILQ_ENTRY(ieee80211_mesh_route) rt_next; 353 int rt_crtime; /* creation time */ 354 uint8_t rt_dest[IEEE80211_ADDR_LEN]; 355 uint8_t rt_nexthop[IEEE80211_ADDR_LEN]; 356 uint32_t rt_metric; /* path metric */ 357 uint16_t rt_nhops; /* number of hops */ 358 uint16_t rt_flags; 359#define IEEE80211_MESHRT_FLAGS_VALID 0x01 /* patch discovery complete */ 360#define IEEE80211_MESHRT_FLAGS_PROXY 0x02 /* proxy entry */ 361 uint32_t rt_lifetime; 362 uint32_t rt_lastmseq; /* last seq# seen dest */ 363 void *rt_priv; /* private data */ 364}; 365#define IEEE80211_MESH_ROUTE_PRIV(rt, cast) ((cast *)rt->rt_priv) 366 367#define IEEE80211_MESH_PROTO_DSZ 12 /* description size */ 368/* 369 * Mesh Path Selection Protocol. 370 */ 371enum ieee80211_state; 372struct ieee80211_mesh_proto_path { 373 uint8_t mpp_active; 374 char mpp_descr[IEEE80211_MESH_PROTO_DSZ]; 375 uint8_t mpp_ie; 376 struct ieee80211_node * 377 (*mpp_discover)(struct ieee80211vap *, 378 const uint8_t [IEEE80211_ADDR_LEN], 379 struct mbuf *); 380 void (*mpp_peerdown)(struct ieee80211_node *); 381 void (*mpp_vattach)(struct ieee80211vap *); 382 void (*mpp_vdetach)(struct ieee80211vap *); 383 int (*mpp_newstate)(struct ieee80211vap *, 384 enum ieee80211_state, int); 385 const size_t mpp_privlen; /* size required in the routing table 386 for private data */ 387 int mpp_inact; /* inact. timeout for invalid routes 388 (ticks) */ 389}; 390 391/* 392 * Mesh Link Metric Report Protocol. 393 */ 394struct ieee80211_mesh_proto_metric { 395 uint8_t mpm_active; 396 char mpm_descr[IEEE80211_MESH_PROTO_DSZ]; 397 uint8_t mpm_ie; 398 uint32_t (*mpm_metric)(struct ieee80211_node *); 399}; 400 401#ifdef notyet 402/* 403 * Mesh Authentication Protocol. 404 */ 405struct ieee80211_mesh_proto_auth { 406 uint8_t mpa_ie[4]; 407}; 408 409struct ieee80211_mesh_proto_congestion { 410}; 411 412struct ieee80211_mesh_proto_sync { 413}; 414#endif 415 416typedef uint32_t ieee80211_mesh_seq; 417#define IEEE80211_MESH_SEQ_LEQ(a, b) ((int32_t)((a)-(b)) <= 0) 418#define IEEE80211_MESH_SEQ_GEQ(a, b) ((int32_t)((a)-(b)) >= 0) 419 420struct ieee80211_mesh_state { 421 int ms_idlen; 422 uint8_t ms_id[IEEE80211_MESHID_LEN]; 423 ieee80211_mesh_seq ms_seq; /* seq no for meshcntl */ 424 uint16_t ms_neighbors; 425 uint8_t ms_ttl; /* mesh ttl set in packets */ 426#define IEEE80211_MESHFLAGS_AP 0x01 /* accept peers */ 427#define IEEE80211_MESHFLAGS_PORTAL 0x02 /* mesh portal role */ 428#define IEEE80211_MESHFLAGS_FWD 0x04 /* forward packets */ 429 uint8_t ms_flags; 430 struct mtx ms_rt_lock; 431 struct callout ms_cleantimer; 432 TAILQ_HEAD(, ieee80211_mesh_route) ms_routes; 433 struct ieee80211_mesh_proto_metric *ms_pmetric; 434 struct ieee80211_mesh_proto_path *ms_ppath; 435}; 436void ieee80211_mesh_attach(struct ieee80211com *); 437void ieee80211_mesh_detach(struct ieee80211com *); 438 439struct ieee80211_mesh_route * 440 ieee80211_mesh_rt_find(struct ieee80211vap *, 441 const uint8_t [IEEE80211_ADDR_LEN]); 442struct ieee80211_mesh_route * 443 ieee80211_mesh_rt_add(struct ieee80211vap *, 444 const uint8_t [IEEE80211_ADDR_LEN]); 445void ieee80211_mesh_rt_del(struct ieee80211vap *, 446 const uint8_t [IEEE80211_ADDR_LEN]); 447void ieee80211_mesh_rt_flush(struct ieee80211vap *); 448void ieee80211_mesh_rt_flush_peer(struct ieee80211vap *, 449 const uint8_t [IEEE80211_ADDR_LEN]); 450void ieee80211_mesh_proxy_check(struct ieee80211vap *, 451 const uint8_t [IEEE80211_ADDR_LEN]); 452 453int ieee80211_mesh_register_proto_path(const 454 struct ieee80211_mesh_proto_path *); 455int ieee80211_mesh_register_proto_metric(const 456 struct ieee80211_mesh_proto_metric *); 457 458uint8_t * ieee80211_add_meshid(uint8_t *, struct ieee80211vap *); 459uint8_t * ieee80211_add_meshconf(uint8_t *, struct ieee80211vap *); 460uint8_t * ieee80211_add_meshpeer(uint8_t *, uint8_t, uint16_t, uint16_t, 461 uint16_t); 462uint8_t * ieee80211_add_meshlmetric(uint8_t *, uint32_t); 463 464void ieee80211_mesh_node_init(struct ieee80211vap *, 465 struct ieee80211_node *); 466void ieee80211_mesh_node_cleanup(struct ieee80211_node *); 467void ieee80211_parse_meshid(struct ieee80211_node *, 468 const uint8_t *); 469struct ieee80211_scanparams; 470void ieee80211_mesh_init_neighbor(struct ieee80211_node *, 471 const struct ieee80211_frame *, 472 const struct ieee80211_scanparams *); 473 474/* 475 * Return non-zero if proxy operation is enabled. 476 */ 477static __inline int 478ieee80211_mesh_isproxyena(struct ieee80211vap *vap) 479{ 480 struct ieee80211_mesh_state *ms = vap->iv_mesh; 481 return (ms->ms_flags & 482 (IEEE80211_MESHFLAGS_AP | IEEE80211_MESHFLAGS_PORTAL)) != 0; 483} 484 485/* 486 * Process an outbound frame: if a path is known to the 487 * destination then return a reference to the next hop 488 * for immediate transmission. Otherwise initiate path 489 * discovery and, if possible queue the packet to be 490 * sent when path discovery completes. 491 */ 492static __inline struct ieee80211_node * 493ieee80211_mesh_discover(struct ieee80211vap *vap, 494 const uint8_t dest[IEEE80211_ADDR_LEN], struct mbuf *m) 495{ 496 struct ieee80211_mesh_state *ms = vap->iv_mesh; 497 return ms->ms_ppath->mpp_discover(vap, dest, m); 498} 499 500#endif /* _KERNEL */ 501#endif /* !_NET80211_IEEE80211_MESH_H_ */ 502