share/man/man9/ieee80211_bmiss.9

   1 .\"
   2 .\" Copyright (c) 2009 Sam Leffler, Errno Consulting
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/share/man/man9/ieee80211_bmiss.9,v 1.2 2009/09/18 00:33:47 brueffer Exp $
  27 .\"
  28 .Dd April 28, 2010
  29 .Dt IEEE80211_BMISS 9
  30 .Os
  31 .Sh NAME
  32 .Nm ieee80211_bmiss
  33 .Nd 802.11 beacon miss support
  34 .Sh SYNOPSIS
  35 .In net/if.h
  36 .In net/if_media.h
  37 .In netproto/802_11/ieee80211_var.h
  38 .Pp
  39 .Ft void
  40 .Fn ieee80211_beacon_miss "struct ieee80211com *"
  41 .Sh DESCRIPTION
  42 The
  43 .Nm net80211
  44 software layer provides a support framework for drivers that includes
  45 handling beacon miss events in station mode.
  46 Drivers can dispatch beacon miss events that are recognized in hardware or
  47 .Nm net80211
  48 can detect beacon miss if the driver dispatches received beacon frames
  49 through the normal receive path.
  50 Software beacon miss support is especially useful when multiple vaps
  51 are operating and any hardware beacon miss support is not available
  52 (e.g. operating as an access point together with one or more station
  53 mode vaps).
  54 .Pp
  55 Drivers should dispatch beacon miss events recognized in the driver with
  56 .Fn ieee80211_beacon_miss .
  57 This causes some number of ProbeRequest frames to be sent to the
  58 access point to check if the association is still alive.
  59 If no response is received and roaming mode is set to
  60 .Dv IEEE80211_ROAMING_AUTO
  61 then
  62 .Nm net80211
  63 will try to re-associate and if that fails
  64 trigger a scan to look for the access point or another suitable AP.
  65 When the
  66 .Nm net80211
  67 state machine is being operated manually, e.g. by
  68 .Xr wpa_supplicant 8 ,
  69 then applications are notified of the state change and are responsible
  70 for handling the work of scanning for a new access point.
  71 The number of beacon miss events (without a ProbeResponse) is user
  72 settable with the
  73 .Dv IEEE80211_IOC_BMISSTHRESHOLD
  74 request.
  75 .Pp
  76 Software beacon miss detection is enabled per-vap by setting the
  77 .Dv IEEE80211_FEXT_SWBMISS
  78 flag.
  79 Typically this is done when a vap is setup
  80 when the
  81 .Dv IEEE80211_CLONE_NOBEACONS
  82 option is supplied to the clone operation.
  83 But drivers may also force this when they know they need help detecting
  84 beacon miss.
  85 When beacon miss is detected in software the event is dispatched without
  86 driver involvement.
  87 Note that software beacon miss handling is not limited to station mode;
  88 it can be used in any operating mode where beacons from a peer station
  89 are received.
  90 .Sh SEE ALSO
  91 .Xr wpa_supplicant 8 ,
  92 .Xr ieee80211 9 ,
  93 .Xr ieee80211_vap 9