1.\" Copyright (c) 2010 Damien Bergamini <damien.bergamini@free.fr>
2.\"
3.\" Permission to use, copy, modify, and distribute this software for any
4.\" purpose with or without fee is hereby granted, provided that the above
5.\" copyright notice and this permission notice appear in all copies.
6.\"
7.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14.\"
| 1.\" Copyright (c) 2010 Damien Bergamini <damien.bergamini@free.fr>
2.\"
3.\" Permission to use, copy, modify, and distribute this software for any
4.\" purpose with or without fee is hereby granted, provided that the above
5.\" copyright notice and this permission notice appear in all copies.
6.\"
7.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14.\"
|
15.\" $FreeBSD: head/share/man/man4/urtwn.4 281919 2015-04-24 05:00:57Z kevlo $
| 15.\" $FreeBSD: head/share/man/man4/urtwn.4 289399 2015-10-16 00:38:05Z bdrewery $
|
16.\"
| 16.\"
|
17.Dd October 24, 2014
| 17.Dd October 15, 2015
|
18.Dt URTWN 4
19.Os
20.Sh NAME
21.Nm urtwn
22.Nd Realtek RTL8188CU/RTL8188RU/RTL8188EU/RTL8192CU USB IEEE 802.11b/g/n wireless network device
23.Sh SYNOPSIS
24To compile this driver into the kernel,
25place the following lines in your
26kernel configuration file:
27.Bd -ragged -offset indent
28.Cd "device ehci"
29.Cd "device uhci"
30.Cd "device ohci"
31.Cd "device usb"
32.Cd "device urtwn"
33.Cd "device wlan"
34.Ed
35.Pp
36Alternatively, to load the driver as a
37module at boot time, place the following line in
38.Xr loader.conf 5 :
39.Bd -literal -offset indent
40if_urtwn_load="YES"
41.Ed
42.Pp
43In both cases, place the following line in
44.Xr loader.conf 5
45to acknowledge the firmware license (see below):
46.Bd -literal -offset indent
47legal.realtek.license_ack=1
48.Ed
49.Sh DESCRIPTION
50The
51.Nm
52driver supports USB 2.0 wireless network devices based on Realtek
53RTL8188CUS, RTL8188CE-VAU, RTL8188EUS, RTL8188RU and RTL8192CU chipsets.
54.Pp
55The RTL8188CUS and RTL8188EUS are highly integrated 802.11n adapters that
56combine a MAC, a 1T1R capable baseband and an RF in a single chip.
57They operate in the 2GHz spectrum only.
58The RTL8188RU is a high-power variant of the RTL8188CUS.
59The RTL8188CE-VAU is a PCI Express Mini Card adapter that attaches
60to the USB interface.
61.Pp
62The RTL8192CU is a highly integrated multiple-in, multiple-out (MIMO)
63802.11n adapter that combines a MAC, a 2T2R capable baseband and an
64RF in a single chip.
65It operates in the 2GHz spectrum only.
66.Pp
67This driver requires the firmware built with the
68.Nm urtwnfw
69module to work.
70For the loaded firmware to be enabled for use the license at
| 18.Dt URTWN 4
19.Os
20.Sh NAME
21.Nm urtwn
22.Nd Realtek RTL8188CU/RTL8188RU/RTL8188EU/RTL8192CU USB IEEE 802.11b/g/n wireless network device
23.Sh SYNOPSIS
24To compile this driver into the kernel,
25place the following lines in your
26kernel configuration file:
27.Bd -ragged -offset indent
28.Cd "device ehci"
29.Cd "device uhci"
30.Cd "device ohci"
31.Cd "device usb"
32.Cd "device urtwn"
33.Cd "device wlan"
34.Ed
35.Pp
36Alternatively, to load the driver as a
37module at boot time, place the following line in
38.Xr loader.conf 5 :
39.Bd -literal -offset indent
40if_urtwn_load="YES"
41.Ed
42.Pp
43In both cases, place the following line in
44.Xr loader.conf 5
45to acknowledge the firmware license (see below):
46.Bd -literal -offset indent
47legal.realtek.license_ack=1
48.Ed
49.Sh DESCRIPTION
50The
51.Nm
52driver supports USB 2.0 wireless network devices based on Realtek
53RTL8188CUS, RTL8188CE-VAU, RTL8188EUS, RTL8188RU and RTL8192CU chipsets.
54.Pp
55The RTL8188CUS and RTL8188EUS are highly integrated 802.11n adapters that
56combine a MAC, a 1T1R capable baseband and an RF in a single chip.
57They operate in the 2GHz spectrum only.
58The RTL8188RU is a high-power variant of the RTL8188CUS.
59The RTL8188CE-VAU is a PCI Express Mini Card adapter that attaches
60to the USB interface.
61.Pp
62The RTL8192CU is a highly integrated multiple-in, multiple-out (MIMO)
63802.11n adapter that combines a MAC, a 2T2R capable baseband and an
64RF in a single chip.
65It operates in the 2GHz spectrum only.
66.Pp
67This driver requires the firmware built with the
68.Nm urtwnfw
69module to work.
70For the loaded firmware to be enabled for use the license at
|
71.Pa /usr/share/doc/legal/realtek
| 71.Pa /usr/share/doc/legal/realtek.LICENSE
|
72must be agreed by adding the following line to
73.Xr loader.conf 5 :
74.Pp
75.Dl "legal.realtek.license_ack=1"
76.Sh FILES
| 72must be agreed by adding the following line to
73.Xr loader.conf 5 :
74.Pp
75.Dl "legal.realtek.license_ack=1"
76.Sh FILES
|
77.Bl -tag -width ".Pa /usr/share/doc/legal/realtek" -compact
78.It Pa /usr/share/doc/legal/realtek
| 77.Bl -tag -width ".Pa /usr/share/doc/legal/realtek.LICENSE" -compact
78.It Pa /usr/share/doc/legal/realtek.LICENSE
|
79.Nm
80firmware license
81.El
82.Sh HARDWARE
83The
84.Nm
85driver supports Realtek RTL8188CU/RTL8188RU/RTL8188EU/RTL8192CU based USB
86IEEE 802.11b/g/n wireless network adapters, including:
87.Pp
88.Bl -tag -width Ds -offset indent -compact
89.It Alfa AWUS036NHR v2
90.It ASUS USB-N10 NANO
91.It Belkin F7D1102 Surf Wireless Micro
92.It D-Link DWA-123 rev D1
93.It D-Link DWA-125 rev D1
94.It D-Link DWA-131
95.It Edimax EW-7811Un
96.It Elecom WDC-150SU2M
97.It Netgear WNA1000M
98.It Realtek RTL8192CU
99.It Realtek RTL8188CUS
100.It TP-LINK TL-WN723N v3
101.It TP-LINK TL-WN725N v2
102.El
103.Sh EXAMPLES
104Join an existing BSS network (i.e., connect to an access point):
105.Bd -literal -offset indent
106ifconfig wlan create wlandev urtwn0 inet 192.168.0.20 \e
107 netmask 0xffffff00
108.Ed
109.Pp
110Join a specific BSS network with network name
111.Dq Li my_net :
112.Pp
113.Dl "ifconfig wlan create wlandev urtwn0 ssid my_net up"
114.Pp
115Join a specific BSS network with 64-bit WEP encryption:
116.Bd -literal -offset indent
117ifconfig wlan create wlandev urtwn0 ssid my_net \e
118 wepmode on wepkey 0x1234567890 weptxkey 1 up
119.Ed
120.Sh DIAGNOSTICS
121.Bl -diag
122.It "urtwn%d: error %d, could not read firmware %s"
123For some reason, the driver was unable to read the microcode file from the
124filesystem.
125The file might be missing or corrupted.
126.It "urtwn%d: device timeout"
127A frame dispatched to the hardware for transmission did not complete in time.
128The driver will reset the hardware.
129This should not happen.
130.El
131.Sh SEE ALSO
132.Xr intro 4 ,
133.Xr netintro 4 ,
134.Xr urtwnfw 4 ,
135.Xr usb 4 ,
136.Xr wlan 4 ,
137.Xr wlan_ccmp 4 ,
138.Xr wlan_tkip 4 ,
139.Xr wlan_wep 4 ,
140.Xr ifconfig 8 ,
141.Xr wpa_supplicant 8
142.Rs
143.%T Realtek
144.%U http://www.realtek.com.tw
145.Re
146.Sh HISTORY
147The
148.Nm
149driver first appeared in
150.Ox 4.9
151and
152.Fx 10.0 .
153.Sh AUTHORS
154The
155.Nm
156driver was written by
157.An Damien Bergamini Aq Mt damien@openbsd.org .
158.Sh CAVEATS
159The
160.Nm
161driver does not support any of the 802.11n capabilities offered by the
162adapters.
| 79.Nm
80firmware license
81.El
82.Sh HARDWARE
83The
84.Nm
85driver supports Realtek RTL8188CU/RTL8188RU/RTL8188EU/RTL8192CU based USB
86IEEE 802.11b/g/n wireless network adapters, including:
87.Pp
88.Bl -tag -width Ds -offset indent -compact
89.It Alfa AWUS036NHR v2
90.It ASUS USB-N10 NANO
91.It Belkin F7D1102 Surf Wireless Micro
92.It D-Link DWA-123 rev D1
93.It D-Link DWA-125 rev D1
94.It D-Link DWA-131
95.It Edimax EW-7811Un
96.It Elecom WDC-150SU2M
97.It Netgear WNA1000M
98.It Realtek RTL8192CU
99.It Realtek RTL8188CUS
100.It TP-LINK TL-WN723N v3
101.It TP-LINK TL-WN725N v2
102.El
103.Sh EXAMPLES
104Join an existing BSS network (i.e., connect to an access point):
105.Bd -literal -offset indent
106ifconfig wlan create wlandev urtwn0 inet 192.168.0.20 \e
107 netmask 0xffffff00
108.Ed
109.Pp
110Join a specific BSS network with network name
111.Dq Li my_net :
112.Pp
113.Dl "ifconfig wlan create wlandev urtwn0 ssid my_net up"
114.Pp
115Join a specific BSS network with 64-bit WEP encryption:
116.Bd -literal -offset indent
117ifconfig wlan create wlandev urtwn0 ssid my_net \e
118 wepmode on wepkey 0x1234567890 weptxkey 1 up
119.Ed
120.Sh DIAGNOSTICS
121.Bl -diag
122.It "urtwn%d: error %d, could not read firmware %s"
123For some reason, the driver was unable to read the microcode file from the
124filesystem.
125The file might be missing or corrupted.
126.It "urtwn%d: device timeout"
127A frame dispatched to the hardware for transmission did not complete in time.
128The driver will reset the hardware.
129This should not happen.
130.El
131.Sh SEE ALSO
132.Xr intro 4 ,
133.Xr netintro 4 ,
134.Xr urtwnfw 4 ,
135.Xr usb 4 ,
136.Xr wlan 4 ,
137.Xr wlan_ccmp 4 ,
138.Xr wlan_tkip 4 ,
139.Xr wlan_wep 4 ,
140.Xr ifconfig 8 ,
141.Xr wpa_supplicant 8
142.Rs
143.%T Realtek
144.%U http://www.realtek.com.tw
145.Re
146.Sh HISTORY
147The
148.Nm
149driver first appeared in
150.Ox 4.9
151and
152.Fx 10.0 .
153.Sh AUTHORS
154The
155.Nm
156driver was written by
157.An Damien Bergamini Aq Mt damien@openbsd.org .
158.Sh CAVEATS
159The
160.Nm
161driver does not support any of the 802.11n capabilities offered by the
162adapters.
|