The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/net80211/ieee80211_proto.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    1 /*-
    2  * Copyright (c) 2001 Atsushi Onoe
    3  * Copyright (c) 2002-2007 Sam Leffler, Errno Consulting
    4  * All rights reserved.
    5  *
    6  * Redistribution and use in source and binary forms, with or without
    7  * modification, are permitted provided that the following conditions
    8  * are met:
    9  * 1. Redistributions of source code must retain the above copyright
   10  *    notice, this list of conditions and the following disclaimer.
   11  * 2. Redistributions in binary form must reproduce the above copyright
   12  *    notice, this list of conditions and the following disclaimer in the
   13  *    documentation and/or other materials provided with the distribution.
   14  *
   15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
   16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
   18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
   19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
   20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
   22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
   24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   25  *
   26  * $FreeBSD$
   27  */
   28 #ifndef _NET80211_IEEE80211_PROTO_H_
   29 #define _NET80211_IEEE80211_PROTO_H_
   30 
   31 /*
   32  * 802.11 protocol implementation definitions.
   33  */
   34 
   35 enum ieee80211_state {
   36         IEEE80211_S_INIT        = 0,    /* default state */
   37         IEEE80211_S_SCAN        = 1,    /* scanning */
   38         IEEE80211_S_AUTH        = 2,    /* try to authenticate */
   39         IEEE80211_S_ASSOC       = 3,    /* try to assoc */
   40         IEEE80211_S_CAC         = 4,    /* doing channel availability check */
   41         IEEE80211_S_RUN         = 5,    /* operational (e.g. associated) */
   42         IEEE80211_S_CSA         = 6,    /* channel switch announce pending */
   43         IEEE80211_S_SLEEP       = 7,    /* power save */
   44 };
   45 #define IEEE80211_S_MAX         (IEEE80211_S_SLEEP+1)
   46 
   47 #define IEEE80211_SEND_MGMT(_ic,_ni,_type,_arg) \
   48         ((*(_ic)->ic_send_mgmt)(_ic, _ni, _type, _arg))
   49 
   50 /*
   51  * The formation of some management frames requires guidance to
   52  * deal with legacy clients.  When the client is identified as
   53  * "legacy 11b" this parameter can be passed in the arg param of a
   54  * IEEE80211_SEND_MGMT call.
   55  */
   56 #define IEEE80211_SEND_LEGACY_11B       0x1     /* legacy 11b client */
   57 #define IEEE80211_SEND_LEGACY_11        0x2     /* other legacy client */
   58 #define IEEE80211_SEND_LEGACY           0x3     /* any legacy client */
   59 
   60 extern  const char *ieee80211_mgt_subtype_name[];
   61 extern  const char *ieee80211_phymode_name[];
   62 
   63 void    ieee80211_proto_attach(struct ieee80211com *);
   64 void    ieee80211_proto_detach(struct ieee80211com *);
   65 
   66 struct ieee80211_node;
   67 int     ieee80211_input(struct ieee80211com *, struct mbuf *,
   68                 struct ieee80211_node *, int, int, uint32_t);
   69 void    ieee80211_deliver_data(struct ieee80211com *,
   70                 struct ieee80211_node *, struct mbuf *);
   71 struct mbuf *ieee80211_decap1(struct mbuf *, int *);
   72 int     ieee80211_setup_rates(struct ieee80211_node *ni,
   73                 const uint8_t *rates, const uint8_t *xrates, int flags);
   74 void    ieee80211_saveie(uint8_t **, const uint8_t *);
   75 void    ieee80211_saveath(struct ieee80211_node *, uint8_t *);
   76 void    ieee80211_recv_mgmt(struct ieee80211com *, struct mbuf *,
   77                 struct ieee80211_node *, int, int, int, uint32_t);
   78 int     ieee80211_mgmt_output(struct ieee80211com *, struct ieee80211_node *,
   79                 struct mbuf *, int type);
   80 struct ieee80211_bpf_params;
   81 int     ieee80211_raw_xmit(struct ieee80211_node *, struct mbuf *,
   82                 const struct ieee80211_bpf_params *);
   83 int     ieee80211_output(struct ifnet *, struct mbuf *,
   84                 struct sockaddr *, struct rtentry *);
   85 int     ieee80211_send_nulldata(struct ieee80211_node *);
   86 int     ieee80211_send_mgmt(struct ieee80211com *, struct ieee80211_node *,
   87                 int, int);
   88 int     ieee80211_send_probereq(struct ieee80211_node *ni,
   89                 const uint8_t sa[IEEE80211_ADDR_LEN],
   90                 const uint8_t da[IEEE80211_ADDR_LEN],
   91                 const uint8_t bssid[IEEE80211_ADDR_LEN],
   92                 const uint8_t *ssid, size_t ssidlen,
   93                 const void *optie, size_t optielen);
   94 int     ieee80211_classify(struct ieee80211com *, struct mbuf *,
   95                 struct ieee80211_node *);
   96 struct mbuf *ieee80211_encap(struct ieee80211com *, struct mbuf *,
   97                 struct ieee80211_node *);
   98 
   99 void    ieee80211_reset_erp(struct ieee80211com *);
  100 void    ieee80211_set_shortslottime(struct ieee80211com *, int onoff);
  101 int     ieee80211_iserp_rateset(struct ieee80211com *,
  102                 struct ieee80211_rateset *);
  103 void    ieee80211_set11gbasicrates(struct ieee80211_rateset *,
  104                 enum ieee80211_phymode);
  105 
  106 /*
  107  * Return the size of the 802.11 header for a management or data frame.
  108  */
  109 static __inline int
  110 ieee80211_hdrsize(const void *data)
  111 {
  112         const struct ieee80211_frame *wh = data;
  113         int size = sizeof(struct ieee80211_frame);
  114 
  115         /* NB: we don't handle control frames */
  116         KASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL,
  117                 ("%s: control frame", __func__));
  118         if ((wh->i_fc[1] & IEEE80211_FC1_DIR_MASK) == IEEE80211_FC1_DIR_DSTODS)
  119                 size += IEEE80211_ADDR_LEN;
  120         if (IEEE80211_QOS_HAS_SEQ(wh))
  121                 size += sizeof(uint16_t);
  122         return size;
  123 }
  124 
  125 /*
  126  * Like ieee80211_hdrsize, but handles any type of frame.
  127  */
  128 static __inline int
  129 ieee80211_anyhdrsize(const void *data)
  130 {
  131         const struct ieee80211_frame *wh = data;
  132 
  133         if ((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) == IEEE80211_FC0_TYPE_CTL) {
  134                 switch (wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) {
  135                 case IEEE80211_FC0_SUBTYPE_CTS:
  136                 case IEEE80211_FC0_SUBTYPE_ACK:
  137                         return sizeof(struct ieee80211_frame_ack);
  138                 case IEEE80211_FC0_SUBTYPE_BAR:
  139                         return sizeof(struct ieee80211_frame_bar);
  140                 }
  141                 return sizeof(struct ieee80211_frame_min);
  142         } else
  143                 return ieee80211_hdrsize(data);
  144 }
  145 
  146 /*
  147  * Template for an in-kernel authenticator.  Authenticators
  148  * register with the protocol code and are typically loaded
  149  * as separate modules as needed.
  150  */
  151 struct ieee80211_authenticator {
  152         const char *ia_name;            /* printable name */
  153         int     (*ia_attach)(struct ieee80211com *);
  154         void    (*ia_detach)(struct ieee80211com *);
  155         void    (*ia_node_join)(struct ieee80211com *,
  156                                 struct ieee80211_node *);
  157         void    (*ia_node_leave)(struct ieee80211com *,
  158                                 struct ieee80211_node *);
  159 };
  160 void    ieee80211_authenticator_register(int type,
  161                 const struct ieee80211_authenticator *);
  162 void    ieee80211_authenticator_unregister(int type);
  163 const struct ieee80211_authenticator *ieee80211_authenticator_get(int auth);
  164 
  165 struct ieee80211req;
  166 /*
  167  * Template for an MAC ACL policy module.  Such modules
  168  * register with the protocol code and are passed the sender's
  169  * address of each received frame for validation.
  170  */
  171 struct ieee80211_aclator {
  172         const char *iac_name;           /* printable name */
  173         int     (*iac_attach)(struct ieee80211com *);
  174         void    (*iac_detach)(struct ieee80211com *);
  175         int     (*iac_check)(struct ieee80211com *,
  176                         const uint8_t mac[IEEE80211_ADDR_LEN]);
  177         int     (*iac_add)(struct ieee80211com *,
  178                         const uint8_t mac[IEEE80211_ADDR_LEN]);
  179         int     (*iac_remove)(struct ieee80211com *,
  180                         const uint8_t mac[IEEE80211_ADDR_LEN]);
  181         int     (*iac_flush)(struct ieee80211com *);
  182         int     (*iac_setpolicy)(struct ieee80211com *, int);
  183         int     (*iac_getpolicy)(struct ieee80211com *);
  184         int     (*iac_setioctl)(struct ieee80211com *, struct ieee80211req *);
  185         int     (*iac_getioctl)(struct ieee80211com *, struct ieee80211req *);
  186 };
  187 void    ieee80211_aclator_register(const struct ieee80211_aclator *);
  188 void    ieee80211_aclator_unregister(const struct ieee80211_aclator *);
  189 const struct ieee80211_aclator *ieee80211_aclator_get(const char *name);
  190 
  191 /* flags for ieee80211_fix_rate() */
  192 #define IEEE80211_F_DOSORT      0x00000001      /* sort rate list */
  193 #define IEEE80211_F_DOFRATE     0x00000002      /* use fixed rate */
  194 #define IEEE80211_F_DONEGO      0x00000004      /* calc negotiated rate */
  195 #define IEEE80211_F_DODEL       0x00000008      /* delete ignore rate */
  196 #define IEEE80211_F_DOBRS       0x00000010      /* check basic rate set */
  197 #define IEEE80211_F_JOIN        0x00000020      /* sta joining our bss */
  198 int     ieee80211_fix_rate(struct ieee80211_node *,
  199                 struct ieee80211_rateset *, int);
  200 
  201 /*
  202  * WME/WMM support.
  203  */
  204 struct wmeParams {
  205         uint8_t         wmep_acm;
  206         uint8_t         wmep_aifsn;
  207         uint8_t         wmep_logcwmin;          /* log2(cwmin) */
  208         uint8_t         wmep_logcwmax;          /* log2(cwmax) */
  209         uint8_t         wmep_txopLimit;
  210         uint8_t         wmep_noackPolicy;       /* 0 (ack), 1 (no ack) */
  211 };
  212 #define IEEE80211_TXOP_TO_US(_txop)     ((_txop)<<5)
  213 #define IEEE80211_US_TO_TXOP(_us)       ((_us)>>5)
  214 
  215 struct chanAccParams {
  216         uint8_t         cap_info;               /* version of the current set */
  217         struct wmeParams cap_wmeParams[WME_NUM_AC];
  218 };
  219 
  220 struct ieee80211_wme_state {
  221         u_int   wme_flags;
  222 #define WME_F_AGGRMODE  0x00000001      /* STATUS: WME agressive mode */
  223         u_int   wme_hipri_traffic;      /* VI/VO frames in beacon interval */
  224         u_int   wme_hipri_switch_thresh;/* agressive mode switch thresh */
  225         u_int   wme_hipri_switch_hysteresis;/* agressive mode switch hysteresis */
  226 
  227         struct wmeParams wme_params[4];         /* from assoc resp for each AC*/
  228         struct chanAccParams wme_wmeChanParams; /* WME params applied to self */
  229         struct chanAccParams wme_wmeBssChanParams;/* WME params bcast to stations */
  230         struct chanAccParams wme_chanParams;    /* params applied to self */
  231         struct chanAccParams wme_bssChanParams; /* params bcast to stations */
  232 
  233         int     (*wme_update)(struct ieee80211com *);
  234 };
  235 
  236 void    ieee80211_wme_initparams(struct ieee80211com *);
  237 void    ieee80211_wme_updateparams(struct ieee80211com *);
  238 void    ieee80211_wme_updateparams_locked(struct ieee80211com *);
  239 
  240 #define ieee80211_new_state(_ic, _nstate, _arg) \
  241         (((_ic)->ic_newstate)((_ic), (_nstate), (_arg)))
  242 int     ieee80211_init(struct ieee80211com *, int forcescan);
  243 void    ieee80211_dturbo_switch(struct ieee80211com *, int newflags);
  244 void    ieee80211_beacon_miss(struct ieee80211com *);
  245 void    ieee80211_print_essid(const uint8_t *, int);
  246 void    ieee80211_dump_pkt(struct ieee80211com *,
  247                 const uint8_t *, int, int, int);
  248 
  249 extern  const char *ieee80211_opmode_name[];
  250 extern  const char *ieee80211_state_name[IEEE80211_S_MAX];
  251 extern  const char *ieee80211_wme_acnames[];
  252 
  253 /*
  254  * Beacon frames constructed by ieee80211_beacon_alloc
  255  * have the following structure filled in so drivers
  256  * can update the frame later w/ minimal overhead.
  257  */
  258 struct ieee80211_beacon_offsets {
  259         uint8_t         bo_flags[4];    /* update/state flags */
  260         uint16_t        *bo_caps;       /* capabilities */
  261         uint8_t         *bo_cfp;        /* start of CFParms element */
  262         uint8_t         *bo_tim;        /* start of atim/dtim */
  263         uint8_t         *bo_wme;        /* start of WME parameters */
  264         uint8_t         *bo_tim_trailer;/* start of fixed-size trailer */
  265         uint16_t        bo_tim_len;     /* atim/dtim length in bytes */
  266         uint16_t        bo_tim_trailer_len;/* tim trailer length in bytes */
  267         uint8_t         *bo_erp;        /* start of ERP element */
  268         uint8_t         *bo_htinfo;     /* start of HT info element */
  269         uint8_t         *bo_appie;      /* start of AppIE element */
  270         uint16_t        bo_appie_len;   /* AppIE length in bytes */
  271         uint16_t        bo_csa_trailer_len;;
  272         uint8_t         *bo_csa;        /* start of CSA element */
  273 };
  274 struct mbuf *ieee80211_beacon_alloc(struct ieee80211_node *,
  275                 struct ieee80211_beacon_offsets *);
  276 
  277 /*
  278  * Beacon frame updates are signaled through calls to ic_update_beacon
  279  * with one of the IEEE80211_BEACON_* tokens defined below.  For devices
  280  * that construct beacon frames on the host this can trigger a rebuild
  281  * or defer the processing.  For devices that offload beacon frame
  282  * handling this callback can be used to signal a rebuild.  The bo_flags
  283  * array in the ieee80211_beacon_offsets structure is intended to record
  284  * deferred processing requirements; ieee80211_beacon_update uses the
  285  * state to optimize work.  Since this structure is owned by the driver
  286  * and not visible to the 802.11 layer drivers must supply an ic_update_beacon
  287  * callback that marks the flag bits and schedules (as necessary) an update.
  288  */
  289 enum {
  290         IEEE80211_BEACON_CAPS   = 0,    /* capabilities */
  291         IEEE80211_BEACON_TIM    = 1,    /* DTIM/ATIM */
  292         IEEE80211_BEACON_WME    = 2,
  293         IEEE80211_BEACON_ERP    = 3,    /* Extended Rate Phy */
  294         IEEE80211_BEACON_HTINFO = 4,    /* HT Information */
  295         IEEE80211_BEACON_APPIE  = 5,    /* Application IE's */
  296         IEEE80211_BEACON_CFP    = 6,    /* CFParms */
  297         IEEE80211_BEACON_CSA    = 7,    /* Channel Switch Announcement */
  298 };
  299 int     ieee80211_beacon_update(struct ieee80211_node *,
  300                 struct ieee80211_beacon_offsets *, struct mbuf *, int mcast);
  301 
  302 /*
  303  * Notification methods called from the 802.11 state machine.
  304  * Note that while these are defined here, their implementation
  305  * is OS-specific.
  306  */
  307 void    ieee80211_notify_node_join(struct ieee80211com *,
  308                 struct ieee80211_node *, int newassoc);
  309 void    ieee80211_notify_node_leave(struct ieee80211com *,
  310                 struct ieee80211_node *);
  311 void    ieee80211_notify_scan_done(struct ieee80211com *);
  312 #endif /* _NET80211_IEEE80211_PROTO_H_ */

Cache object: 0a8981baa9cccdf0c2bca0d219807f45


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.