xref: /openbsd/share/man/man9/ieee80211_ioctl.9 (revision d415bd75)
1.\"	$OpenBSD: ieee80211_ioctl.9,v 1.5 2013/07/17 20:21:53 schwarze Exp $
2.\"
3.\" Copyright (c) 2004 Bruce M. Simpson <bms@spc.org>
4.\" Copyright (c) 2004 Darron Broad <darron@kewl.org>
5.\" All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\" $FreeBSD: src/share/man/man9/ieee80211_ioctl.9,v 1.2 2004/07/07 12:59:39 ru Exp $
29.\" $Id: ieee80211_ioctl.9,v 1.5 2013/07/17 20:21:53 schwarze Exp $
30.\"
31.Dd $Mdocdate: July 17 2013 $
32.Dt IEEE80211_IOCTL 9
33.Os
34.Sh NAME
35.Nm ieee80211_ioctl
36.Nd 802.11 interface ioctl commands
37.Sh SYNOPSIS
38.In net80211/ieee80211_var.h
39.In net80211/ieee80211_proto.h
40.In net80211/ieee80211_ioctl.h
41.Ft int
42.Fn ieee80211_ioctl "struct ifnet *ifp" "u_long cmd" "caddr_t data"
43.Sh DESCRIPTION
44These
45functions are typically invoked by drivers in response to requests
46for information or to change settings from the userland.
47.Pp
48.\"
49The
50.Fn ieee80211_ioctl
51function provides a default implementation of the
52.Dv SIOCS80211
53and
54.Dv SIOCG80211
55ifioctls commands for 802.11 drivers.
56The call signature is identical to that of the
57.Va if_ioctl
58member found in
59.Vt struct ifnet ,
60however, many drivers store attributes such as
61.Dv IEEE80211_IOC_STATIONNAME
62in the driver's private soft state structure, so driver writers may prefer
63to use this as the catch-all in a switch statement to avoid code duplication.
64.\"
65.Sh SEE ALSO
66.Xr ifconfig 8 ,
67.Xr ieee80211 9
68.Sh HISTORY
69The
70.Nm ieee80211
71series of functions first appeared in
72.Nx 1.5 ,
73and were later ported to
74.Fx 4.6
75and
76.Ox 3.6 .
77.Sh AUTHORS
78.An -nosplit
79This man page was written by
80.An Bruce M. Simpson Aq Mt bms@FreeBSD.org
81and
82.An Darron Broad Aq Mt darron@kewl.org .
83