diff options
| author | Damien Bergamini <damien@cvs.openbsd.org> | 2007-11-17 14:05:02 +0000 |
|---|---|---|
| committer | Damien Bergamini <damien@cvs.openbsd.org> | 2007-11-17 14:05:02 +0000 |
| commit | 855a872ce51c59a06a43fd42ff15601c72f10c91 (patch) | |
| tree | 002af56dd22b3321c73809c161b903741cf7d397 /share | |
| parent | 264951a0fbefcbfd21f7e25b3678c3b9324b1c40 (diff) | |
make it clear in the code and in the man page that the rate2plcp and
plcp2rate functions use plcp codes in most-significant-bit-first format
(R4-R1).
some drivers like wpi(4) and iwn(4) want plcp codes in lsb-first format
so they can't use those functions.
also the IEEE standard uses R1-R4 notation so this can be a bit confusing
for those refering to it.
use u_int8_t for plcp code and rate instead of int.
Diffstat (limited to 'share')
| -rw-r--r-- | share/man/man9/ieee80211.9 | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/share/man/man9/ieee80211.9 b/share/man/man9/ieee80211.9 index 53fb26fa480..14032f00871 100644 --- a/share/man/man9/ieee80211.9 +++ b/share/man/man9/ieee80211.9 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ieee80211.9,v 1.10 2007/11/14 11:16:27 mglocker Exp $ +.\" $OpenBSD: ieee80211.9,v 1.11 2007/11/17 14:05:01 damien Exp $ .\" .\" Copyright (c) 2004 Bruce M. Simpson <bms@spc.org> .\" Copyright (c) 2004 Darron Broad <darron@kewl.org> @@ -26,9 +26,9 @@ .\" SUCH DAMAGE. .\" .\" $FreeBSD: src/share/man/man9/ieee80211.9,v 1.3 2004/07/07 12:59:39 ru Exp $ -.\" $Id: ieee80211.9,v 1.10 2007/11/14 11:16:27 mglocker Exp $ +.\" $Id: ieee80211.9,v 1.11 2007/11/17 14:05:01 damien Exp $ .\" -.Dd $Mdocdate: November 14 2007 $ +.Dd $Mdocdate: November 17 2007 $ .Dt IEEE80211 9 .Os .Sh NAME @@ -77,10 +77,10 @@ .Fc .Ft int .Fn ieee80211_media2rate "int mword" -.Ft int -.Fn ieee80211_rate2plcp "int rate" "enum ieee80211_phymode mode" -.Ft int -.Fn ieee80211_plcp2rate "int plcp" "enum ieee80211_phymode mode" +.Ft u_int8_t +.Fn ieee80211_rate2plcp "u_int8_t rate" "enum ieee80211_phymode mode" +.Ft u_int8_t +.Fn ieee80211_plcp2rate "u_int8_t plcp" "enum ieee80211_phymode mode" .Sh DESCRIPTION The .Nm ieee80211 @@ -250,13 +250,13 @@ function converts the bit rate .Fa rate (measured in units of 0.5Mbps) to a .Vt plcp -signal. +signal (in msb-first R4-R1 format). The .Fn ieee80211_plcp2rate function performs the reverse of this conversion, returning the bit rate (in 0.5Mbps units) corresponding to a .Vt plcp -signal. +signal (in msb-first R4-R1 format). .\" .Sh SEE ALSO .Xr ifmedia 4 , |