Add the ieee80211(9) API manual pages.
[dragonfly.git] / share / man / man9 / ieee80211_proto.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 .\" $DragonFly: src/share/man/man9/ieee80211_proto.9,v 1.1 2004/07/27 14:50:56 hmp Exp $
29 .\" $Id: ieee80211_proto.9,v 1.2 2004/07/07 12:59:39 ru Exp $
30 .\"
31 .Dd March 2, 2004
32 .Dt IEEE80211_PROTO 9
33 .Os
34 .Sh NAME
35 .Nm ieee80211_proto_attach ,
36 .Nm ieee80211_proto_detach ,
37 .Nm ieee80211_print_essid ,
38 .Nm ieee80211_dump_pkt ,
39 .Nm ieee80211_fix_rate ,
40 .Nm ieee80211_proto
41 .Nd software 802.11 stack protocol helper functions
42 .Sh SYNOPSIS
43 .In net80211/ieee80211_var.h
44 .In net80211/ieee80211_proto.h
45 .Ft void
46 .Fn ieee80211_proto_attach "struct ifnet *ifp"
47 .Ft void
48 .Fn ieee80211_proto_detach "struct ifnet *ifp"
49 .Ft void
50 .Fn ieee80211_print_essid "u_int8_t *essid" "int len"
51 .Ft void
52 .Fn ieee80211_dump_pkt "u_int8_t *buf" "int len" "int rate" "int rssi"
53 .Ft int
54 .Fo ieee80211_fix_rate
55 .Fa "struct ieee80211com *ic" "struct ieee80211_node *ni" "int flags"
56 .Fc
57 .Sh DESCRIPTION
58 These
59 functions are helper functions used throughout the software 802.11 protocol
60 stack.
61 .Sh SEE ALSO
62 .Xr ieee80211 9 ,
63 .Xr ifnet 9
64 .Sh HISTORY
65 The
66 .Nm ieee80211
67 series of functions first appeared in
68 .Nx 1.5 ,
69 and were later ported to
70 .Fx 4.6 .
71 .Sh AUTHORS
72 .An -nosplit
73 This man page was written by
74 .An Bruce M. Simpson Aq bms@FreeBSD.org
75 and
76 .An Darron Broad Aq darron@kewl.org .