ieee80211_mesh.h revision 234876
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 234876 2012-05-01 15:42:41Z monthadar $ 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 */ 101231576Sadrian#define IEEE80211_MESHCONF_FORM_MP 0x01 /* Connected to Portal */ 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 196195618Srpaulo/* Portal (MP) Annoucement */ 197195618Srpaulostruct ieee80211_meshpann_ie { 198195618Srpaulo uint8_t pann_ie; /* IEEE80211_ELEMID_MESHPANN */ 199195618Srpaulo uint8_t pann_len; 200195618Srpaulo uint8_t pann_flags; 201195618Srpaulo uint8_t pann_hopcount; 202195618Srpaulo uint8_t pann_ttl; 203195618Srpaulo uint8_t pann_addr[IEEE80211_ADDR_LEN]; 204195618Srpaulo uint8_t pann_seq; /* PANN Sequence Number */ 205195618Srpaulo} __packed; 206195618Srpaulo 207195618Srpaulo/* Root (MP) Annoucement */ 208232625Sadrian#define IEEE80211_MESHRANN_BASE_SZ (21) 209195618Srpaulostruct ieee80211_meshrann_ie { 210195618Srpaulo uint8_t rann_ie; /* IEEE80211_ELEMID_MESHRANN */ 211195618Srpaulo uint8_t rann_len; 212195618Srpaulo uint8_t rann_flags; 213195618Srpaulo#define IEEE80211_MESHRANN_FLAGS_PR 0x01 /* Portal Role */ 214195618Srpaulo uint8_t rann_hopcount; 215195618Srpaulo uint8_t rann_ttl; 216195618Srpaulo uint8_t rann_addr[IEEE80211_ADDR_LEN]; 217195618Srpaulo uint32_t rann_seq; /* HWMP Sequence Number */ 218232625Sadrian uint32_t rann_interval; 219195618Srpaulo uint32_t rann_metric; 220195618Srpaulo} __packed; 221195618Srpaulo 222195618Srpaulo/* Mesh Path Request */ 223232625Sadrian#define IEEE80211_MESHPREQ_BASE_SZ (26) 224232625Sadrian#define IEEE80211_MESHPREQ_BASE_SZ_AE (32) 225232625Sadrian#define IEEE80211_MESHPREQ_TRGT_SZ (11) 226232625Sadrian#define IEEE80211_MESHPREQ_TCNT_OFFSET (27) 227232625Sadrian#define IEEE80211_MESHPREQ_TCNT_OFFSET_AE (33) 228195618Srpaulostruct ieee80211_meshpreq_ie { 229195618Srpaulo uint8_t preq_ie; /* IEEE80211_ELEMID_MESHPREQ */ 230195618Srpaulo uint8_t preq_len; 231195618Srpaulo uint8_t preq_flags; 232195618Srpaulo#define IEEE80211_MESHPREQ_FLAGS_PR 0x01 /* Portal Role */ 233195618Srpaulo#define IEEE80211_MESHPREQ_FLAGS_AM 0x02 /* 0 = ucast / 1 = bcast */ 234195618Srpaulo#define IEEE80211_MESHPREQ_FLAGS_PP 0x04 /* Proactive PREP */ 235195618Srpaulo#define IEEE80211_MESHPREQ_FLAGS_AE 0x40 /* Address Extension */ 236195618Srpaulo uint8_t preq_hopcount; 237195618Srpaulo uint8_t preq_ttl; 238195618Srpaulo uint32_t preq_id; 239195618Srpaulo uint8_t preq_origaddr[IEEE80211_ADDR_LEN]; 240195618Srpaulo uint32_t preq_origseq; /* HWMP Sequence Number */ 241232625Sadrian /* NB: may have Originator External Address */ 242232625Sadrian uint8_t preq_orig_ext_addr[IEEE80211_ADDR_LEN]; 243195618Srpaulo uint32_t preq_lifetime; 244195618Srpaulo uint32_t preq_metric; 245195618Srpaulo uint8_t preq_tcount; /* target count */ 246195618Srpaulo struct { 247195618Srpaulo uint8_t target_flags; 248195618Srpaulo#define IEEE80211_MESHPREQ_TFLAGS_TO 0x01 /* Target Only */ 249195618Srpaulo#define IEEE80211_MESHPREQ_TFLAGS_RF 0x02 /* Reply and Forward */ 250195618Srpaulo#define IEEE80211_MESHPREQ_TFLAGS_USN 0x04 /* Unknown HWMP seq number */ 251195618Srpaulo uint8_t target_addr[IEEE80211_ADDR_LEN]; 252195618Srpaulo uint32_t target_seq; /* HWMP Sequence Number */ 253195618Srpaulo } __packed preq_targets[1]; /* NB: variable size */ 254195618Srpaulo} __packed; 255195618Srpaulo 256195618Srpaulo/* Mesh Path Reply */ 257232625Sadrian#define IEEE80211_MESHPREP_BASE_SZ (31) 258232625Sadrian#define IEEE80211_MESHPREP_BASE_SZ_AE (37) 259195618Srpaulostruct ieee80211_meshprep_ie { 260195618Srpaulo uint8_t prep_ie; /* IEEE80211_ELEMID_MESHPREP */ 261195618Srpaulo uint8_t prep_len; 262195618Srpaulo uint8_t prep_flags; 263232625Sadrian#define IEEE80211_MESHPREP_FLAGS_AE 0x40 /* Address Extension */ 264195618Srpaulo uint8_t prep_hopcount; 265195618Srpaulo uint8_t prep_ttl; 266195618Srpaulo uint8_t prep_targetaddr[IEEE80211_ADDR_LEN]; 267195618Srpaulo uint32_t prep_targetseq; 268232625Sadrian /* NB: May have Target External Address */ 269232625Sadrian uint8_t prep_target_ext_addr[IEEE80211_ADDR_LEN]; 270195618Srpaulo uint32_t prep_lifetime; 271195618Srpaulo uint32_t prep_metric; 272195618Srpaulo uint8_t prep_origaddr[IEEE80211_ADDR_LEN]; 273195618Srpaulo uint32_t prep_origseq; /* HWMP Sequence Number */ 274195618Srpaulo} __packed; 275195618Srpaulo 276195618Srpaulo/* Mesh Path Error */ 277232625Sadrian#define IEEE80211_MESHPERR_MAXDEST (19) 278232625Sadrian#define IEEE80211_MESHPERR_NDEST_OFFSET (3) 279232625Sadrian#define IEEE80211_MESHPERR_BASE_SZ (2) 280232625Sadrian#define IEEE80211_MESHPERR_DEST_SZ (13) 281232625Sadrian#define IEEE80211_MESHPERR_DEST_SZ_AE (19) 282195618Srpaulostruct ieee80211_meshperr_ie { 283195618Srpaulo uint8_t perr_ie; /* IEEE80211_ELEMID_MESHPERR */ 284195618Srpaulo uint8_t perr_len; 285197413Srpaulo uint8_t perr_ttl; 286195618Srpaulo uint8_t perr_ndests; /* Number of Destinations */ 287195618Srpaulo struct { 288197413Srpaulo uint8_t dest_flags; 289232625Sadrian#define IEEE80211_MESHPERR_DFLAGS_USN 0x01 /* XXX: not part of standard */ 290232625Sadrian#define IEEE80211_MESHPERR_DFLAGS_RC 0x02 /* XXX: not part of standard */ 291232625Sadrian#define IEEE80211_MESHPERR_FLAGS_AE 0x40 /* Address Extension */ 292195618Srpaulo uint8_t dest_addr[IEEE80211_ADDR_LEN]; 293195618Srpaulo uint32_t dest_seq; /* HWMP Sequence Number */ 294232625Sadrian /* NB: May have Destination External Address */ 295232625Sadrian uint8_t dest_ext_addr[IEEE80211_ADDR_LEN]; 296197413Srpaulo uint16_t dest_rcode; 297195618Srpaulo } __packed perr_dests[1]; /* NB: variable size */ 298195618Srpaulo} __packed; 299195618Srpaulo 300195618Srpaulo#ifdef notyet 301195618Srpaulo/* Mesh Proxy Update */ 302195618Srpaulostruct ieee80211_meshpu_ie { 303195618Srpaulo uint8_t pu_ie; /* IEEE80211_ELEMID_MESHPU */ 304195618Srpaulo uint8_t pu_len; 305195618Srpaulo uint8_t pu_flags; 306195618Srpaulo#define IEEE80211_MESHPU_FLAGS_MASK 0x1 307195618Srpaulo#define IEEE80211_MESHPU_FLAGS_DEL 0x0 308195618Srpaulo#define IEEE80211_MESHPU_FLAGS_ADD 0x1 309195618Srpaulo uint8_t pu_seq; /* PU Sequence Number */ 310195618Srpaulo uint8_t pu_addr[IEEE80211_ADDR_LEN]; 311195618Srpaulo uint8_t pu_naddr; /* Number of Proxied Addresses */ 312195618Srpaulo /* NB: proxied address follows */ 313195618Srpaulo} __packed; 314195618Srpaulo 315195618Srpaulo/* Mesh Proxy Update Confirmation */ 316195618Srpaulostruct ieee80211_meshpuc_ie { 317195618Srpaulo uint8_t puc_ie; /* IEEE80211_ELEMID_MESHPUC */ 318195618Srpaulo uint8_t puc_len; 319195618Srpaulo uint8_t puc_flags; 320195618Srpaulo uint8_t puc_seq; /* PU Sequence Number */ 321195618Srpaulo uint8_t puc_daddr[IEEE80211_ADDR_LEN]; 322195618Srpaulo} __packed; 323195618Srpaulo#endif 324195618Srpaulo 325195618Srpaulo/* 326195618Srpaulo * 802.11s Action Frames 327234874Smonthadar * XXX: these are wrong, and some of them should be 328234874Smonthadar * under MESH category while PROXY is under MULTIHOP category. 329195618Srpaulo */ 330195618Srpaulo#define IEEE80211_ACTION_CAT_INTERWORK 15 331195618Srpaulo#define IEEE80211_ACTION_CAT_RESOURCE 16 332195618Srpaulo#define IEEE80211_ACTION_CAT_PROXY 17 333195618Srpaulo 334195618Srpaulo/* 335195618Srpaulo * Mesh Peering Action codes. 336195618Srpaulo */ 337195618Srpauloenum { 338234874Smonthadar /* 0 reserved */ 339234874Smonthadar IEEE80211_ACTION_MESHPEERING_OPEN = 1, 340234874Smonthadar IEEE80211_ACTION_MESHPEERING_CONFIRM = 2, 341234874Smonthadar IEEE80211_ACTION_MESHPEERING_CLOSE = 3, 342234874Smonthadar /* 4-255 reserved */ 343195618Srpaulo}; 344195618Srpaulo 345195618Srpaulo/* 346232479Sadrian * Mesh Action code. 347195618Srpaulo */ 348195618Srpauloenum { 349232479Sadrian IEEE80211_ACTION_MESH_LMETRIC = 0, /* Mesh Link Metric Report */ 350232479Sadrian IEEE80211_ACTION_MESH_HWMP = 1, /* HWMP Mesh Path Selection */ 351232479Sadrian IEEE80211_ACTION_MESH_GANN = 2, /* Gate Announcement */ 352232479Sadrian IEEE80211_ACTION_MESH_CC = 3, /* Congestion Control */ 353232479Sadrian IEEE80211_ACTION_MESH_MCCA_SREQ = 4, /* MCCA Setup Request */ 354232479Sadrian IEEE80211_ACTION_MESH_MCCA_SREP = 5, /* MCCA Setup Reply */ 355232479Sadrian IEEE80211_ACTION_MESH_MCCA_AREQ = 6, /* MCCA Advertisement Req. */ 356232479Sadrian IEEE80211_ACTION_MESH_MCCA_ADVER =7, /* MCCA Advertisement */ 357232479Sadrian IEEE80211_ACTION_MESH_MCCA_TRDOWN = 8, /* MCCA Teardown */ 358232479Sadrian IEEE80211_ACTION_MESH_TBTT_REQ = 9, /* TBTT Adjustment Request */ 359232479Sadrian IEEE80211_ACTION_MESH_TBTT_RES = 10, /* TBTT Adjustment Response */ 360232479Sadrian /* 11-255 reserved */ 361195618Srpaulo}; 362195618Srpaulo 363195618Srpaulo/* 364195618Srpaulo * Mesh Portal Annoucement Action codes. 365195618Srpaulo */ 366195618Srpauloenum { 367195618Srpaulo IEEE80211_ACTION_MESHPANN = 0, 368195618Srpaulo /* 1-255 reserved */ 369195618Srpaulo}; 370195618Srpaulo 371195618Srpaulo/* 372195618Srpaulo * Different mesh control structures based on the AE 373195618Srpaulo * (Address Extension) bits. 374195618Srpaulo */ 375195618Srpaulostruct ieee80211_meshcntl { 376195618Srpaulo uint8_t mc_flags; /* Address Extension 00 */ 377195618Srpaulo uint8_t mc_ttl; /* TTL */ 378195618Srpaulo uint8_t mc_seq[4]; /* Sequence No. */ 379195618Srpaulo /* NB: more addresses may follow */ 380195618Srpaulo} __packed; 381195618Srpaulo 382195618Srpaulostruct ieee80211_meshcntl_ae01 { 383195618Srpaulo uint8_t mc_flags; /* Address Extension 01 */ 384195618Srpaulo uint8_t mc_ttl; /* TTL */ 385195618Srpaulo uint8_t mc_seq[4]; /* Sequence No. */ 386195618Srpaulo uint8_t mc_addr4[IEEE80211_ADDR_LEN]; 387195618Srpaulo} __packed; 388195618Srpaulo 389195618Srpaulostruct ieee80211_meshcntl_ae10 { 390195618Srpaulo uint8_t mc_flags; /* Address Extension 10 */ 391195618Srpaulo uint8_t mc_ttl; /* TTL */ 392195618Srpaulo uint8_t mc_seq[4]; /* Sequence No. */ 393195784Srpaulo uint8_t mc_addr4[IEEE80211_ADDR_LEN]; 394195618Srpaulo uint8_t mc_addr5[IEEE80211_ADDR_LEN]; 395195618Srpaulo} __packed; 396195618Srpaulo 397195618Srpaulostruct ieee80211_meshcntl_ae11 { 398195618Srpaulo uint8_t mc_flags; /* Address Extension 11 */ 399195618Srpaulo uint8_t mc_ttl; /* TTL */ 400195618Srpaulo uint8_t mc_seq[4]; /* Sequence No. */ 401195618Srpaulo uint8_t mc_addr4[IEEE80211_ADDR_LEN]; 402195618Srpaulo uint8_t mc_addr5[IEEE80211_ADDR_LEN]; 403195618Srpaulo uint8_t mc_addr6[IEEE80211_ADDR_LEN]; 404195618Srpaulo} __packed; 405195618Srpaulo 406195618Srpaulo#ifdef _KERNEL 407232625SadrianMALLOC_DECLARE(M_80211_MESH_PREQ); 408232625SadrianMALLOC_DECLARE(M_80211_MESH_PREP); 409232625SadrianMALLOC_DECLARE(M_80211_MESH_PERR); 410232625Sadrian 411195618SrpauloMALLOC_DECLARE(M_80211_MESH_RT); 412195618Srpaulostruct ieee80211_mesh_route { 413195618Srpaulo TAILQ_ENTRY(ieee80211_mesh_route) rt_next; 414195813Ssam int rt_crtime; /* creation time */ 415195618Srpaulo uint8_t rt_dest[IEEE80211_ADDR_LEN]; 416195618Srpaulo uint8_t rt_nexthop[IEEE80211_ADDR_LEN]; 417195618Srpaulo uint32_t rt_metric; /* path metric */ 418195618Srpaulo uint16_t rt_nhops; /* number of hops */ 419195784Srpaulo uint16_t rt_flags; 420195784Srpaulo#define IEEE80211_MESHRT_FLAGS_VALID 0x01 /* patch discovery complete */ 421195784Srpaulo#define IEEE80211_MESHRT_FLAGS_PROXY 0x02 /* proxy entry */ 422195618Srpaulo uint32_t rt_lifetime; 423195618Srpaulo uint32_t rt_lastmseq; /* last seq# seen dest */ 424195618Srpaulo void *rt_priv; /* private data */ 425195618Srpaulo}; 426195618Srpaulo#define IEEE80211_MESH_ROUTE_PRIV(rt, cast) ((cast *)rt->rt_priv) 427195618Srpaulo 428195618Srpaulo#define IEEE80211_MESH_PROTO_DSZ 12 /* description size */ 429195618Srpaulo/* 430195618Srpaulo * Mesh Path Selection Protocol. 431195618Srpaulo */ 432195618Srpauloenum ieee80211_state; 433195618Srpaulostruct ieee80211_mesh_proto_path { 434197975Srpaulo uint8_t mpp_active; 435195618Srpaulo char mpp_descr[IEEE80211_MESH_PROTO_DSZ]; 436197975Srpaulo uint8_t mpp_ie; 437195618Srpaulo struct ieee80211_node * 438195618Srpaulo (*mpp_discover)(struct ieee80211vap *, 439195618Srpaulo const uint8_t [IEEE80211_ADDR_LEN], 440195618Srpaulo struct mbuf *); 441195618Srpaulo void (*mpp_peerdown)(struct ieee80211_node *); 442195618Srpaulo void (*mpp_vattach)(struct ieee80211vap *); 443195618Srpaulo void (*mpp_vdetach)(struct ieee80211vap *); 444195618Srpaulo int (*mpp_newstate)(struct ieee80211vap *, 445195618Srpaulo enum ieee80211_state, int); 446195784Srpaulo const size_t mpp_privlen; /* size required in the routing table 447195618Srpaulo for private data */ 448195813Ssam int mpp_inact; /* inact. timeout for invalid routes 449195813Ssam (ticks) */ 450195618Srpaulo}; 451195618Srpaulo 452195618Srpaulo/* 453195618Srpaulo * Mesh Link Metric Report Protocol. 454195618Srpaulo */ 455195618Srpaulostruct ieee80211_mesh_proto_metric { 456197975Srpaulo uint8_t mpm_active; 457195618Srpaulo char mpm_descr[IEEE80211_MESH_PROTO_DSZ]; 458197975Srpaulo uint8_t mpm_ie; 459195618Srpaulo uint32_t (*mpm_metric)(struct ieee80211_node *); 460195618Srpaulo}; 461195618Srpaulo 462195618Srpaulo#ifdef notyet 463195618Srpaulo/* 464195618Srpaulo * Mesh Authentication Protocol. 465195618Srpaulo */ 466195618Srpaulostruct ieee80211_mesh_proto_auth { 467195618Srpaulo uint8_t mpa_ie[4]; 468195618Srpaulo}; 469195618Srpaulo 470195618Srpaulostruct ieee80211_mesh_proto_congestion { 471195618Srpaulo}; 472195618Srpaulo 473195618Srpaulostruct ieee80211_mesh_proto_sync { 474195618Srpaulo}; 475195618Srpaulo#endif 476195618Srpaulo 477195618Srpaulotypedef uint32_t ieee80211_mesh_seq; 478195618Srpaulo#define IEEE80211_MESH_SEQ_LEQ(a, b) ((int32_t)((a)-(b)) <= 0) 479195618Srpaulo#define IEEE80211_MESH_SEQ_GEQ(a, b) ((int32_t)((a)-(b)) >= 0) 480195618Srpaulo 481195618Srpaulostruct ieee80211_mesh_state { 482195618Srpaulo int ms_idlen; 483195618Srpaulo uint8_t ms_id[IEEE80211_MESHID_LEN]; 484195618Srpaulo ieee80211_mesh_seq ms_seq; /* seq no for meshcntl */ 485195618Srpaulo uint16_t ms_neighbors; 486195618Srpaulo uint8_t ms_ttl; /* mesh ttl set in packets */ 487195618Srpaulo#define IEEE80211_MESHFLAGS_AP 0x01 /* accept peers */ 488195618Srpaulo#define IEEE80211_MESHFLAGS_PORTAL 0x02 /* mesh portal role */ 489195618Srpaulo#define IEEE80211_MESHFLAGS_FWD 0x04 /* forward packets */ 490195618Srpaulo uint8_t ms_flags; 491195618Srpaulo struct mtx ms_rt_lock; 492195784Srpaulo struct callout ms_cleantimer; 493195618Srpaulo TAILQ_HEAD(, ieee80211_mesh_route) ms_routes; 494195618Srpaulo struct ieee80211_mesh_proto_metric *ms_pmetric; 495195618Srpaulo struct ieee80211_mesh_proto_path *ms_ppath; 496195618Srpaulo}; 497195618Srpaulovoid ieee80211_mesh_attach(struct ieee80211com *); 498195618Srpaulovoid ieee80211_mesh_detach(struct ieee80211com *); 499195618Srpaulo 500195618Srpaulostruct ieee80211_mesh_route * 501195618Srpaulo ieee80211_mesh_rt_find(struct ieee80211vap *, 502195618Srpaulo const uint8_t [IEEE80211_ADDR_LEN]); 503195618Srpaulostruct ieee80211_mesh_route * 504195618Srpaulo ieee80211_mesh_rt_add(struct ieee80211vap *, 505195618Srpaulo const uint8_t [IEEE80211_ADDR_LEN]); 506195618Srpaulovoid ieee80211_mesh_rt_del(struct ieee80211vap *, 507195618Srpaulo const uint8_t [IEEE80211_ADDR_LEN]); 508195618Srpaulovoid ieee80211_mesh_rt_flush(struct ieee80211vap *); 509195908Srpaulovoid ieee80211_mesh_rt_flush_peer(struct ieee80211vap *, 510195908Srpaulo const uint8_t [IEEE80211_ADDR_LEN]); 511195784Srpaulovoid ieee80211_mesh_proxy_check(struct ieee80211vap *, 512195784Srpaulo const uint8_t [IEEE80211_ADDR_LEN]); 513195618Srpaulo 514195618Srpauloint ieee80211_mesh_register_proto_path(const 515195618Srpaulo struct ieee80211_mesh_proto_path *); 516195618Srpauloint ieee80211_mesh_register_proto_metric(const 517195618Srpaulo struct ieee80211_mesh_proto_metric *); 518195618Srpaulo 519195618Srpaulouint8_t * ieee80211_add_meshid(uint8_t *, struct ieee80211vap *); 520195618Srpaulouint8_t * ieee80211_add_meshconf(uint8_t *, struct ieee80211vap *); 521195618Srpaulouint8_t * ieee80211_add_meshpeer(uint8_t *, uint8_t, uint16_t, uint16_t, 522195618Srpaulo uint16_t); 523232479Sadrianuint8_t * ieee80211_add_meshlmetric(uint8_t *, uint8_t, uint32_t); 524195618Srpaulo 525195618Srpaulovoid ieee80211_mesh_node_init(struct ieee80211vap *, 526195618Srpaulo struct ieee80211_node *); 527195618Srpaulovoid ieee80211_mesh_node_cleanup(struct ieee80211_node *); 528195618Srpaulovoid ieee80211_parse_meshid(struct ieee80211_node *, 529195618Srpaulo const uint8_t *); 530195618Srpaulostruct ieee80211_scanparams; 531195618Srpaulovoid ieee80211_mesh_init_neighbor(struct ieee80211_node *, 532195618Srpaulo const struct ieee80211_frame *, 533195618Srpaulo const struct ieee80211_scanparams *); 534198242Srpaulovoid ieee80211_mesh_update_beacon(struct ieee80211vap *, 535198242Srpaulo struct ieee80211_beacon_offsets *); 536195618Srpaulo 537195784Srpaulo/* 538195784Srpaulo * Return non-zero if proxy operation is enabled. 539195784Srpaulo */ 540195784Srpaulostatic __inline int 541195784Srpauloieee80211_mesh_isproxyena(struct ieee80211vap *vap) 542195784Srpaulo{ 543195784Srpaulo struct ieee80211_mesh_state *ms = vap->iv_mesh; 544195784Srpaulo return (ms->ms_flags & 545195784Srpaulo (IEEE80211_MESHFLAGS_AP | IEEE80211_MESHFLAGS_PORTAL)) != 0; 546195784Srpaulo} 547195784Srpaulo 548195784Srpaulo/* 549195784Srpaulo * Process an outbound frame: if a path is known to the 550195784Srpaulo * destination then return a reference to the next hop 551195784Srpaulo * for immediate transmission. Otherwise initiate path 552195784Srpaulo * discovery and, if possible queue the packet to be 553195784Srpaulo * sent when path discovery completes. 554195784Srpaulo */ 555195618Srpaulostatic __inline struct ieee80211_node * 556195784Srpauloieee80211_mesh_discover(struct ieee80211vap *vap, 557195618Srpaulo const uint8_t dest[IEEE80211_ADDR_LEN], struct mbuf *m) 558195618Srpaulo{ 559195618Srpaulo struct ieee80211_mesh_state *ms = vap->iv_mesh; 560195618Srpaulo return ms->ms_ppath->mpp_discover(vap, dest, m); 561195618Srpaulo} 562195618Srpaulo 563195618Srpaulo#endif /* _KERNEL */ 564195618Srpaulo#endif /* !_NET80211_IEEE80211_MESH_H_ */ 565