diff options
Diffstat (limited to 'share/man/man4/acx.4')
| -rw-r--r-- | share/man/man4/acx.4 | 318 |
1 files changed, 318 insertions, 0 deletions
diff --git a/share/man/man4/acx.4 b/share/man/man4/acx.4 new file mode 100644 index 00000000000..c03635c37e5 --- /dev/null +++ b/share/man/man4/acx.4 @@ -0,0 +1,318 @@ +.\" $OpenBSD: acx.4,v 1.1 2006/08/03 08:45:06 deraadt Exp $ +.\" +.\" Copyright (c) 2006 Theo de Raadt. +.\" Copyright (c) 2006 The DragonFly Project. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in +.\" the documentation and/or other materials provided with the +.\" distribution. +.\" 3. Neither the name of The DragonFly Project nor the names of its +.\" contributors may be used to endorse or promote products derived +.\" from this software without specific, prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, +.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED +.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT +.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd March 24, 2006 +.Os +.Dt ACX 4 +.Sh NAME +.Nm acx +.Nd Texas Instruments ACX100/ACX111 IEEE 802.11b/g adapters +.Sh SYNOPSIS +.Cd "acx* at cardbus?" +.Cd "acx* at pci?" +.Sh DESCRIPTION +The +.Nm +driver provides support for Texas Instruments ACX100 or ACX111 +based PCI/Cardbus network adapters. +.Pp +The ACX100A and ACX100B are the first generation 802.11b devices +from Texas Instruments. +The ACX111 is the second generation device which supports 802.11b/g. +.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 IBSS mode +.\" Also known as +.\" .Em IEEE ad-hoc +.\" mode or +.\" .Em peer-to-peer +.\" mode. +.\" This is the standardized method of operating without an access point. +.\" Stations associate with a service set. +.\" However, actual connections between stations are peer-to-peer. +.\" .It Host AP +.\" In this mode the driver acts as an access point (base station) +.\" for other cards. +.\" .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 +.Nm +supports software WEP. +Wired Equivalent Privacy (WEP) is the de facto encryption standard +for wireless networks. +It can be typically configured in one of three modes: +no encryption; 40-bit encryption; or 104-bit encryption. +Unfortunately, due to serious weaknesses in WEP protocol +it is strongly recommended that it not be used as the +sole mechanism to secure wireless communication. +WEP is not enabled by default. +.Pp +The transmit speed is user-selectable or can be adapted automatically by the +driver depending on the received signal strength and on the number of hardware +transmission retries. +See +.Xr rssadapt 9 +for more information. +.Sh CONFIGURATION +The +.Nm +driver can be configured at runtime with +.Xr ifconfig 8 +or on boot with +.Xr hostname.if 5 +using the following parameters: +.Bl -tag -width Ds +.It Cm bssid Ar bssid +Set the desired BSSID. +.It Fl bssid +Unset the desired BSSID. +The interface will automatically select a BSSID in this mode, which is +the default. +.It Cm chan Ar n +Set the channel (radio frequency) to be used by the driver based on +the given channel ID +.Ar n . +.It Fl chan +Unset the desired channel to be used by the driver. +The driver will automatically select a channel in this mode, which is +the default. +.It Cm media Ar media +The +.Nm +driver supports the following +.Ar media +types: +.Pp +.Bl -tag -width autoselect -compact +.It Cm autoselect +Enable autoselection of the media type and options. +.It Cm DS1 +Set 802.11b DS 1Mbps operation. +.It Cm DS2 +Set 802.11b DS 2Mbps operation. +.It Cm DS5 +Set 802.11b DS 5.5Mbps operation. +.It Cm DS11 +Set 802.11b DS 11Mbps operation. +.It Cm OFDM6 +Set 802.11a/g OFDM 6Mbps operation. +.It Cm OFDM9 +Set 802.11a/g OFDM 9Mbps operation. +.It Cm OFDM12 +Set 802.11a/g OFDM 12Mbps operation. +.It Cm OFDM18 +Set 802.11a/g OFDM 18Mbps operation. +.It Cm OFDM24 +Set 802.11a/g OFDM 24Mbps operation. +.It Cm OFDM36 +Set 802.11a/g OFDM 36Mbps operation. +.It Cm OFDM48 +Set 802.11a/g OFDM 48Mbps operation. +.It Cm OFDM54 +Set 802.11a/g OFDM 54Mbps operation. +.El +.It Cm mediaopt Ar opts +The +.Nm +driver supports the following media options: +.Pp +.Bl -tag -width monitor -compact +.It Cm hostap +Select Host AP operation. +.It Cm ibss +Select IBSS operation. +.It Cm monitor +Select monitor mode. +.El +.It Fl mediaopt Ar opts +Disable the specified media options on the driver and return it to the +default mode of operation (BSS). +.It Cm mode Ar mode +The +.Nm +driver supports the following modes: +.Pp +.Bl -tag -width 11b -compact +.It Cm 11a +Force 802.11a operation. +.It Cm 11b +Force 802.11b operation. +.It Cm 11g +Force 802.11g operation. +.El +.It Cm nwid Ar id +Set the network ID. +The +.Ar id +can either be any text string up to 32 characters in length, +or a series of hexadecimal digits up to 64 digits. +An empty +.Ar id +string allows the interface to connect to any available access points. +By default the +.Nm +driver uses an empty string. +Note that network ID is synonymous with Extended Service Set ID (ESSID). +.It Cm nwkey Ar key +Enable WEP encryption using the specified +.Ar key . +The +.Ar key +can either be a string, a series of hexadecimal digits (preceded by +.Sq 0x ) , +or a set of keys of the form +.Dq n:k1,k2,k3,k4 , +where +.Sq n +specifies which of the keys will be used for transmitted packets, +and the four keys, +.Dq k1 +through +.Dq k4 , +are configured as WEP keys. +If a set of keys is specified, a comma +.Pq Sq \&, +within the key must be escaped with a backslash. +Note that if multiple keys are used, their order must be the same within +the network. +.Nm +is capable of using both 40-bit (5 characters or 10 hexadecimal digits) +or 104-bit (13 characters or 26 hexadecimal digits) keys. +.It Fl nwkey +Disable WEP encryption. +This is the default mode of operation. +.El +.Pp +.Sh FILES +The driver needs a set of firmware files which are loaded when +an interface is brought up: +.Pp +.Bl -tag -width Ds -offset indent -compact +.It Pa /etc/firmware/tiacx100 +.It Pa /etc/firmware/tiacx100e0D +.It Pa /etc/firmware/tiacx100r11 +.It Pa /etc/firmware/tiacx111 +.El +.Pp +This firmware files are not free because Texas Instruments refuses +to grant distribution rights, in fact, they have rebuffed thousands +of attempts to start a dialogue on this issue. +As a result, even though +.Ox +includes the driver, the firmware file cannot be included and +users have to download this file on their own. +.Pp +A prepackaged version of the firmware, designed to be used with +.Xr pkg_add 1 , +can be found at: +.Pp +.Pa http://damien.bergamini.free.fr/packages/openbsd/acx-firmware-1.0.tgz +.Sh HARDWARE +The following Cardbus ACX100 cards are known to work: +.Pp +.Bd -filled +D-Link DWL-650+, +Engenic ERG WL-003 +.Ed +.Pp +The following Cardbus ACX111 cards are known to work: +.Pp +.Bd -filled +D-Link DWL-G630+, +D-Link DWL-G650+, +Hamlet HNWP254, +Linksys WPC54Gv2, +Zyxel G-160, +USR USR5410, +Microcom Travelcard WiFi 11g +.Ed +.Pp +The following PCI ACX100 cards are known to work: +.Pp +.Bd -filled +D-Link DWL-520+ +.Ed +.Pp +The following PCI ACX111 cards are known to work: +.Pp +.Bd -filled +D-Link DWL-G520+, +Hawking HWP54G, +Netgear WG311v2, +Tornado/ADT 211g, +USR USR5416, +Zyxel G-360 EE +.Ed +.Sh SEE ALSO +.Xr arp 4 , +.Xr cardbus 4 , +.Xr pci 4 , +.Xr ifmedia 4 , +.Xr intro 4 , +.Xr netintro 4 , +.Xr hostname.if 5 , +.Xr hostapd 8 , +.Xr ifconfig 8 +.Sh HISTORY +The +.Nm +driver first appeared in +.Ox 4.0 . +.Sh AUTHORS +.An -nosplit +The +.Nm +driver was written by +.An Sepherosa Ziehau . +The manual page was written by +.An Sascha Wildner . +Both are based on the +.Pa http://wlan.kewl.org +project team's original code. +.Pp +The hardware specification was reverse engineered by the good folks at +.Pa http://acx100.sourceforge.net . +Without them this driver would not have been possible. |