xref: /freebsd/share/man/man4/mwl.4 (revision 830940567b49bb0c08dfaed40418999e76616909)
1.\"-
2.\" Copyright (c) 2009 Sam Leffler, Errno Consulting
3.\" All rights reserved.
4.\""
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer,
10.\"    without modification.
11.\" 2. Redistributions in binary form must reproduce at minimum a disclaimer
12.\"    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
13.\"    redistribution must be conditioned upon including a substantially
14.\"    similar Disclaimer requirement for further binary redistribution.
15.\"
16.\" NO WARRANTY
17.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19.\" LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
20.\" AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21.\" THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
22.\" OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
25.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
27.\" THE POSSIBILITY OF SUCH DAMAGES.
28.\"
29.\" $FreeBSD$
30.\"/
31.Dd July 8, 2009
32.Dt MWL 4
33.Os
34.Sh NAME
35.Nm mwl
36.Nd "Marvell 88W8363 IEEE 802.11n wireless network driver"
37.Sh SYNOPSIS
38To compile this driver into the kernel,
39place the following lines in your
40kernel configuration file:
41.Bd -ragged -offset indent
42.Cd "device mwl"
43.Cd "device mwlfw"
44.Cd "device wlan"
45.Cd "device firmware"
46.Ed
47.Pp
48Alternatively, to load the driver as a
49module at boot time, place the following line in
50.Xr loader.conf 5 :
51.Bd -literal -offset indent
52if_mwl_load="YES"
53.Ed
54.Sh DESCRIPTION
55The
56.Nm
57driver provides support for IEEE 802.11n wireless network adapters based on
58Marvell 88W8363 parts.
59PCI and/or CardBus interfaces are supported.
60.Pp
61This driver requires the firmware built with the
62.Nm mwlfw
63module to work.
64Normally this module is loaded on demand by the driver but it may
65also be compiled into the kernel.
66.Pp
67Supported features include 802.11n, power management, BSS, MBSS,
68and host-based access point operation modes.
69All host/device interaction is via DMA.
70.Pp
71The
72.Nm
73driver encapsulates IP and ARP traffic as 802.11 frames, however
74it can receive either 802.11 or 802.3 frames.
75Devices support 802.11n, 802.11a, 802.11g, and 802.11b operation with
76transmit speeds appropriate to each.
77The actual transmit speed used is dependent on signal quality and the
78.Dq "rate control"
79algorithm implemented in the firmware.
80All chips have hardware support for WEP,
81AES-CCM, TKIP, and Michael cryptographic operations.
82.Pp
83The driver supports
84.Cm station ,
85.Cm hostap ,
86.Cm mesh ,
87and
88.Cm wds
89mode operation.
90Multiple
91.Cm hostap
92virtual interfaces may be configured for simultaneous use.
93When multiple interfaces are configured each may have a separate
94mac address that is formed by setting the U/L bits in the mac
95address assigned to the underlying device.
96Any number of
97.Cm wds
98virtual interfaces may be configured together with
99.Cm hostap
100interfaces.
101Multiple
102.Cm station
103interfaces may be operated together with
104.Cm hostap
105interfaces to construct a wireless repeater device.
106For more information on configuring this device, see
107.Xr ifconfig 8 .
108.Pp
109Devices supported by the
110.Nm
111driver come in either Cardbus or mini-PCI packages.
112Wireless cards in Cardbus slots may be inserted and ejected on the fly.
113.Sh EXAMPLES
114Join an existing BSS network (ie: connect to an access point):
115.Pp
116.Bd -literal -offset indent
117ifconfig wlan create wlandev mwl0 inet 192.168.0.20 \e
118	netmask 0xffffff00"
119.Ed
120.Pp
121Join a specific BSS network with network name
122.Dq Li my_net :
123.Pp
124.Bd -literal -offset indent
125ifconfig wlan create wlandev mwl0 inet 192.168.0.20 \e
126	netmask 0xffffff00 ssid my_net"
127.Ed
128.Pp
129Join a specific BSS network with WEP encryption:
130.Bd -literal -offset indent
131ifconfig wlan0 create wlandev mwl0
132ifconfig wlan0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
133	wepmode on wepkey 0x8736639624
134.Ed
135.Pp
136Create an 802.11g host-based access point:
137.Bd -literal -offset indent
138ifconfig wlan0 create wlandev mwl0 wlanmode hostap
139ifconfig wlan0 inet 192.168.0.10 netmask 0xffffff00 ssid my_ap \e
140	mode 11g
141.Ed
142.Pp
143Create an 802.11a mesh station:
144.Bd -literal -offset indent
145ifconfig wlan0 create wlandev mwl0 wlanmode mesh
146ifconfig wlan0 meshid my_mesh mode 11a inet 192.168.0.10/24
147.Ed
148.Pp
149Create two virtual 802.11a host-based access points, one with
150with WEP enabled and one with no security, and bridge them to
151the fxp0 (wired) device:
152.Bd -literal -offset indent
153ifconfig wlan0 create wlandev mwl0 wlanmode hostap \e
154	ssid paying-customers wepmode on wepkey 0x1234567890 \e
155	mode 11a up
156ifconfig wlan1 create wlandev mwl0 wlanmode hostap bssid \e
157	ssid freeloaders up
158ifconfig bridge0 create addm wlan0 addm wlan1 addm fxp0 up
159.Ed
160.Sh DIAGNOSTICS
161.Bl -diag
162.It "mwl%d: unable to setup builtin firmware"
163There was a problem downloading and/or setting up the firmware.
164The device is not usable.
165.It "mwl%d: failed to setup descriptors: %d"
166There was a problem setting up the DMA data structures.
167This typically is caused by not being able to allocate contiguous memory.
168.It "mwl%d: transmit timeout"
169A frame dispatched to the hardware for transmission did not complete in time.
170This should not happen.
171.It "mwl%d: device not present"
172A cardbus device was ejected while active; the request to the firmware
173was not completed.
174.El
175.Sh SEE ALSO
176.Xr cardbus 4 ,
177.Xr intro 4 ,
178.Xr mwlfw 4 ,
179.Xr pci 4 ,
180.Xr wlan 4 ,
181.Xr wlan_ccmp 4 ,
182.Xr wlan_tkip 4 ,
183.Xr wlan_wep 4 ,
184.Xr wlan_xauth 4 ,
185.Xr hostapd 8 ,
186.Xr ifconfig 8 ,
187.Xr wpa_supplicant 8
188.Sh HISTORY
189The
190.Nm
191device driver first appeared in
192.Fx 8.0 .
193.Sh BUGS
194The driver does not support power-save operation in station mode;
195consequently power use is suboptimal (e.g. on a laptop).
196