6/share/man/man9/ieee80211_ioctl.9

   1 .\"
   2 .\" Copyright (c) 2004 Bruce M. Simpson <bms@spc.org>
   3 .\" Copyright (c) 2004 Darron Broad <darron@kewl.org>
   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 AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD$
  28 .\" $Id: ieee80211_ioctl.9,v 1.5 2004/03/04 12:33:27 bruce Exp $
  29 .\"
  30 .Dd March 2, 2004
  31 .Dt IEEE80211_IOCTL 9
  32 .Os
  33 .Sh NAME
  34 .Nm ieee80211_cfgget , ieee80211_cfgset , ieee80211_ioctl
  35 .Nd 802.11 interface ioctl commands
  36 .Sh SYNOPSIS
  37 .In net80211/ieee80211_var.h
  38 .In net80211/ieee80211_proto.h
  39 .In net80211/ieee80211_ioctl.h
  40 .Ft int
  41 .Fn ieee80211_cfgget "struct ifnet *ifp" "u_long cmd" "caddr_t data"
  42 .Ft int
  43 .Fn ieee80211_cfgset "struct ifnet *ifp" "u_long cmd" "caddr_t data"
  44 .Ft int
  45 .Fn ieee80211_ioctl "struct ifnet *ifp" "u_long cmd" "caddr_t data"
  46 .Sh DESCRIPTION
  47 These
  48 functions are typically invoked by drivers in response to requests
  49 for information or to change settings from the userland.
  50 .Pp
  51 .\"
  52 The
  53 .Fn ieee80211_cfgget
  54 and
  55 .Fn ieee80211_cfgset
  56 functions implement a legacy interface for getting and setting 802.11
  57 interface attributes respectively.
  58 The interface is compatible with the RIDs implemented by the legacy
  59 .Xr owi 4
  60 driver and used by the
  61 .Xr wicontrol 8
  62 utility.
  63 .Pp
  64 .\"
  65 The
  66 .Fn ieee80211_ioctl
  67 function provides a default implementation of the
  68 .Dv SIOCS80211
  69 and
  70 .Dv SIOCG80211
  71 ifioctls commands for 802.11 drivers.
  72 The call signature is identical to that of the
  73 .Va if_ioctl
  74 member found in
  75 .Vt struct ifnet ,
  76 however, many drivers store attributes such as
  77 .Dv IEEE80211_IOC_STATIONNAME
  78 in the driver's private soft state structure, so driver writers may prefer
  79 to use this as the catch-all in a switch statement to avoid code duplication.
  80 .\"
  81 .Sh SEE ALSO
  82 .Xr owi 4 ,
  83 .Xr ifconfig 8 ,
  84 .Xr wicontrol 8 ,
  85 .Xr ieee80211 9 ,
  86 .Xr ifnet 9
  87 .Sh HISTORY
  88 The
  89 .Nm ieee80211
  90 series of functions first appeared in
  91 .Nx 1.5 ,
  92 and were later ported to
  93 .Fx 4.6 .
  94 .Sh AUTHORS
  95 .An -nosplit
  96 This manual page was written by
  97 .An Bruce M. Simpson Aq bms@FreeBSD.org
  98 and
  99 .An Darron Broad Aq darron@kewl.org .