2 .\" Copyright (c) 2004 Bruce M. Simpson <bms@spc.org>
3 .\" Copyright (c) 2004 Darron Broad <darron@kewl.org>
4 .\" All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
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.
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
28 .\" $DragonFly: src/share/man/man9/ieee80211.9,v 1.1 2004/07/27 14:50:56 hmp Exp $
29 .\" $Id: ieee80211.9,v 1.3 2004/07/07 12:59:39 ru Exp $
35 .Nm ieee80211_ifattach , ieee80211_ifdetach ,
36 .Nm ieee80211_mhz2ieee , ieee80211_chan2ieee , ieee80211_ieee2mhz ,
37 .Nm ieee80211_media_init , ieee80211_media_change , ieee80211_media_status ,
38 .Nm ieee80211_watchdog ,
39 .Nm ieee80211_setmode , ieee80211_chan2mode ,
40 .Nm ieee80211_rate2media , ieee80211_media2rate
41 .Nd core 802.11 network stack functions
43 .In net80211/ieee80211_var.h
44 .In net80211/ieee80211_proto.h
46 .Fn ieee80211_ifattach "struct ifnet *ifp"
48 .Fn ieee80211_ifdetach "struct ifnet *ifp"
50 .Fn ieee80211_mhz2ieee "u_int freq" "u_int flags"
52 .Fn ieee80211_chan2ieee "struct ieee80211com *ic" "struct ieee80211_channel *c"
54 .Fn ieee80211_ieee2mhz "u_int chan" "u_int flags"
56 .Fo ieee80211_media_init
57 .Fa "struct ifnet *ifp" "ifm_change_cb_t media_change"
58 .Fa "ifm_stat_cb_t media_stat"
61 .Fn ieee80211_media_change "struct ifnet *ifp"
63 .Fn ieee80211_media_status "struct ifnet *ifp" "struct ifmediareq *imr"
65 .Fn ieee80211_watchdog "struct ifnet *ifp"
67 .Fn ieee80211_setmode "struct ieee80211com *ic" "enum ieee80211_phymode mode"
68 .Ft enum ieee80211_phymode
69 .Fo ieee80211_chan2mode
70 .Fa "struct ieee80211com *ic" "struct ieee80211_channel *chan"
73 .Fo ieee80211_rate2media
74 .Fa "struct ieee80211com *ic" "int rate" "enum ieee80211_phymode mode"
77 .Fn ieee80211_media2rate "int mword"
81 collection of functions are used to manage wireless network interfaces in the
82 system which use the system's software 802.11 network stack.
83 Most of these functions require that attachment to the stack is performed
85 Several utility functions are also provided; these are safe to call from
86 any driver without prior initialization.
90 .Fn ieee80211_ifattach
91 function attaches the network interface
93 to the 802.11 network stack layer.
94 This function must be called before using any of the
96 functions which need to store driver state across invocations;
99 instance pointed to by
101 MUST be an instance of
102 .Vt struct ieee80211com ,
103 with various fields initialized to tell
105 about its capabilities.
106 This function performs Ethernet and BPF attachment (by calling
110 on behalf of the caller.
111 It also implements the
117 .Fn ieee80211_ifdetach
120 structures associated with the driver, and performs Ethernet and BPF
121 detachment on behalf of the caller.
125 .Fn ieee80211_mhz2ieee
126 utility function converts the frequency
128 (specified in MHz) to an IEEE 802.11 channel number.
131 argument is a hint which specifies whether the frequency is in
133 .Pq Vt IEEE80211_CHAN_2GHZ
135 .Pq Vt IEEE80211_CHAN_5GHZ ;
136 appropriate clipping of the result is then performed.
140 .Fn ieee80211_chan2ieee
141 function converts the channel specified in
143 to an IEEE channel number for the driver
145 If the conversion would be invalid, an error message is printed to the
147 This function REQUIRES that the driver is hooked up to the
153 .Fn ieee80211_ieee2mhz
154 utility function converts the IEEE channel number
156 to a frequency (in MHz).
159 argument is a hint which specifies whether the frequency is in
161 .Pq Vt IEEE80211_CHAN_2GHZ
163 .Pq Vt IEEE80211_CHAN_5GHZ ;
164 appropriate clipping of the result is then performed.
168 .Fn ieee80211_media_init
169 function initializes media data structures used by the
171 interface, for the driver
173 It must be called by the driver after calling
175 and before calling most
182 arguments specify helper functions which will be invoked by the
184 framework when the user changes or queries media options,
185 using a command such as
190 .Fn ieee80211_media_status
192 .Fn ieee80211_media_change
193 functions are device-independent handlers for
195 commands and are not intended to be called directly.
199 .Fn ieee80211_watchdog
200 function is intended to be called from a driver's
203 It is used to perform periodic cleanup of state within the software 802.11
204 stack, as well as timing out scans.
208 .Fn ieee80211_setmode
209 function is called from within the 802.11 stack to change the mode
210 of the driver's PHY; it is not intended to be called directly.
214 .Fn ieee80211_chan2mode
215 function returns the PHY mode required for use with the channel
219 This is typically used when selecting a rate set, to be advertised in
220 beacons, for example.
224 .Fn ieee80211_rate2media
225 function converts the bit rate
227 (measured in units of 0.5Mbps) to an
229 sub-type, for the device
234 .Fn ieee80211_media2rate
235 performs the reverse of this conversion, returning the bit rate (in 0.5Mbps
236 units) corresponding to an
241 .Xr ieee80211_crypto 9 ,
242 .Xr ieee80211_input 9 ,
243 .Xr ieee80211_ioctl 9 ,
244 .Xr ieee80211_node 9 ,
245 .Xr ieee80211_output 9 ,
246 .Xr ieee80211_proto 9 ,
247 .Xr ieee80211_radiotap 9 ,
252 series of functions first appeared in
254 and were later ported to
258 This man page was written by
259 .An Bruce M. Simpson Aq bms@FreeBSD.org
261 .An Darron Broad Aq darron@kewl.org .