Module Name: src
Committed By: christos
Date: Wed Nov 3 18:57:58 UTC 2010
Modified Files:
src/share/man/man4: Makefile
Added Files:
src/share/man/man4: otus.4
Log Message:
add otus.
To generate a diff of this commit:
cvs rdiff -u -r1.529 -r1.530 src/share/man/man4/Makefile
cvs rdiff -u -r0 -r1.1 src/share/man/man4/otus.4
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/share/man/man4/Makefile
diff -u src/share/man/man4/Makefile:1.529 src/share/man/man4/Makefile:1.530
--- src/share/man/man4/Makefile:1.529 Sun Oct 24 04:57:57 2010
+++ src/share/man/man4/Makefile Wed Nov 3 14:57:57 2010
@@ -1,4 +1,4 @@
-# $NetBSD: Makefile,v 1.529 2010/10/24 08:57:57 jruoho Exp $
+# $NetBSD: Makefile,v 1.530 2010/11/03 18:57:57 christos Exp $
# @(#)Makefile 8.1 (Berkeley) 6/18/93
MAN= aac.4 ac97.4 acardide.4 aceride.4 acphy.4 \
@@ -41,7 +41,7 @@
mtio.4 multicast.4 mvsata.4 \
nadb.4 ne.4 neo.4 netintro.4 nfe.4 nfsmb.4 njata.4 njs.4 \
nsclpcsio.4 nsp.4 nsphy.4 nsphyter.4 ntwoc.4 null.4 nsmb.4 \
- oak.4 oosiop.4 opl.4 options.4 optiide.4 osiop.4 \
+ oak.4 oosiop.4 opl.4 options.4 optiide.4 osiop.4 otus.4 \
pad.4 pas.4 pcdisplay.4 pciide.4 pckbc.4 pckbd.4 pcn.4 pcppi.4 \
pcscp.4 pcweasel.4 pdcide.4 pdcsata.4 piixide.4 piixpcib.4 piixpm.4 \
pim.4 plip.4 pms.4 pmu.4 pnaphy.4 ppbus.4 ppp.4 pppoe.4 pseye.4 \
Added files:
Index: src/share/man/man4/otus.4
diff -u /dev/null src/share/man/man4/otus.4:1.1
--- /dev/null Wed Nov 3 14:57:58 2010
+++ src/share/man/man4/otus.4 Wed Nov 3 14:57:57 2010
@@ -0,0 +1,187 @@
+.\" $NetBSD: otus.4,v 1.1 2010/11/03 18:57:57 christos Exp $
+.\" $OpenBSD: otus.4,v 1.14 2010/08/18 18:49:36 damien Exp $
+.\"
+.\" Copyright (c) 2009 Damien Bergamini <damien.bergam...@free.fr>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd November 1, 2010
+.Dt OTUS 4
+.Os
+.Sh NAME
+.Nm otus
+.Nd Atheros USB IEEE 802.11a/g/n wireless network device
+.Sh SYNOPSIS
+.Cd "otus* at uhub? port ?"
+.Sh DESCRIPTION
+The
+.Nm
+driver supports USB 2.0 wireless network devices based on Atheros
+Communications AR9001U chipset.
+.Pp
+The AR9001U chipset is made of an AR9170 MAC/Baseband
+and an AR9101 (1T2R), AR9102 (2T2R) or AR9104 (dual-band 2T2R)
+Radio.
+.Pp
+These are the modes the
+.Nm
+driver can operate in:
+.Bl -tag -width "IBSS-masterXX"
+.It BSS mode
+Also known as
+.Em infrastructure
+mode, this is used when associating with an access point, through
+which all traffic passes.
+This mode is the default.
+.It monitor mode
+In this mode the driver is able to receive packets without
+associating with an access point.
+This disables the internal receive filter and enables the card to
+capture packets from networks which it wouldn't normally have access to,
+or to scan for access points.
+.El
+.Pp
+The
+.Nm
+driver can be configured to use
+Wired Equivalent Privacy (WEP) or
+Wi-Fi Protected Access (WPA-PSK and WPA2-PSK).
+WPA is the de facto encryption standard for wireless networks.
+It is strongly recommended that WEP
+not be used as the sole mechanism
+to secure wireless communication,
+due to serious weaknesses in it.
+.Pp
+The
+.Nm
+driver can be configured at runtime with
+.Xr ifconfig 8
+or on boot with
+.Xr ifconfig.if 5 .
+.Sh FILES
+The driver needs at least version 1.0 of the following firmware files,
+which are loaded when an interface is attached:
+.Pp
+.Bl -tag -width Ds -offset indent -compact
+.It /etc/firmware/otus-init
+.It /etc/firmware/otus-main
+.El
+.Pp
+Although these firmware files are freely redistributable, their usage
+is restricted.
+A prepackaged version of the firmware, designed to be used with
+.Xr pkg_add 1 ,
+can be found at:
+.Bd -literal -offset 3n
+http://damien.bergamini.free.fr/packages/openbsd/otus-firmware-1.0.tgz
+.Ed
+.Sh HARDWARE
+The following adapters should work:
+.Pp
+.Bl -tag -width Ds -offset indent -compact
+.It Arcadyan WN7512
+.\" .It AVM FRITZ!WLAN USB Stick N
+.It CACE AirPcap \&Nx
+.It D-Link DWA-130 rev \&D1
+.It D-Link DWA-160 rev A1
+.It D-Link DWA-160 rev A2
+.It IO-Data WN-GDN/US2
+.It NEC Aterm WL300NU-G
+.It Netgear WNDA3100
+.It Netgear WN111 v2
+.It Planex GW-US300
+.It TP-Link TL-WN821N
+.It Ubiquiti SR71 USB
+.It Unex DNUA-81
+.It Z-Com UB81
+.It Z-Com UB82
+.It ZyXEL NWD-271N
+.El
+.Sh EXAMPLES
+The following
+.Xr ifconfig.if 5
+example configures otus0 to join whatever network is available on boot,
+using WEP key
+.Dq 0x1deadbeef1 ,
+channel 11, obtaining an IP address using DHCP:
+.Bd -literal -offset indent
+nwkey 0x1deadbeef1 chan 11
+dhcp
+.Ed
+.Pp
+Join an existing BSS network,
+.Dq my_net :
+.Bd -literal -offset indent
+# ifconfig otus0 192.168.1.1 netmask 0xffffff00 nwid my_net
+.Ed
+.Pp
+To use WPA, see
+.Xr wpa_supplicant 8
+and
+.Xr wpa_supplicant.conf 5 .
+.Sh DIAGNOSTICS
+.Bl -diag
+.It "otus%d: error %d, could not read firmware %s"
+For some reason, the driver was unable to read the microcode file from the
+filesystem.
+The file might be missing or corrupted.
+.It "otus%d: device timeout"
+A frame dispatched to the hardware for transmission did not complete in time.
+The driver will reset the hardware.
+This should not happen.
+.El
+.Sh SEE ALSO
+.Xr arp 4 ,
+.Xr ifmedia 4 ,
+.\" .Xr intro 4 ,
+.Xr netintro 4 ,
+.Xr usb 4 ,
+.Xr wpa_supplicant.conf 5 ,
+.Xr ifconfig 8 ,
+.Xr wpa_supplicant 8 ,
+.Pp
+Atheros Communications AR9001U-2NX/AR9001U-2NG/AR9001U-NG:
+.Pa http://www.atheros.com/pt/bulletins/AR9001USBBulletin.pdf
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Ox 4.6 .
+It was ported to
+.Nx
+by Anon Ymous and first appeared in
+.Nx 6.0 .
+.Sh AUTHORS
+The
+.Nm
+driver was written by
+.An Damien Bergamini Aq dam...@openbsd.org
+based on source code licensed under the ISC released in 2008 by Atheros
+Communications for Linux.
+.Sh CAVEATS
+The AVM FRITZ!WLAN USB Stick N adapter is currently not supported.
+.Pp
+The
+.Nm
+driver does not support any of the 802.11n capabilities offered by the
+AR9001U chipset.
+Additional work is required in
+.Xr ieee80211 9
+before those features can be supported.
+.Pp
+The
+.Nm
+driver also does not currently support EDCA as this is missing in the
+.Nx
+network stack.
+The hooks for it are in the driver code.
