xref: /freebsd/share/man/man4/urtw.4 (revision 35c0a8c449fd2b7f75029ebed5e10852240f0865)
1.\"-
2.\" SPDX-License-Identifier: BSD-2-Clause
3.\"
4.\" Copyright (c) 2008 Weongyo Jeong
5.\" All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd November 10, 2024
29.Dt URTW 4
30.Os
31.Sh NAME
32.Nm urtw
33.Nd Realtek RTL8187B/L USB IEEE 802.11b/g wireless network driver
34.Sh SYNOPSIS
35To compile this driver into the kernel,
36place the following lines in your kernel configuration file:
37.Bd -ragged -offset indent
38.Cd "device ehci"
39.Cd "device uhci"
40.Cd "device ohci"
41.Cd "device usb"
42.Cd "device urtw"
43.Cd "device wlan"
44.Ed
45.Pp
46Alternatively, to load the driver as a module at boot time,
47place the following line in
48.Xr loader.conf 5 :
49.Bd -literal -offset indent
50if_urtw_load="YES"
51.Ed
52.Sh DESCRIPTION
53The
54.Nm
55driver supports USB 802.11b/g wireless adapters based on the
56Realtek RTL8187B/L.
57.Pp
58.Nm
59supports
60.Cm station
61and
62.Cm monitor
63mode operation.
64Only one virtual interface may be configured at any time.
65.Pp
66For more information on configuring this device, see
67.Xr ifconfig 8 .
68.Sh HARDWARE
69The
70.Nm
71driver supports Realtek RTL8187B/L based wireless network devices, including:
72.Pp
73.Bl -column -offset indent "Shuttle XPC Accessory PN20" "RTL8225" "USB" -compact
74.It Em Card Ta Em Radio Ta Em Bus
75.It Belkin F5D7050E Ta RTL8225 Ta USB
76.It Linksys WUSB54GCv2 Ta RTL8225 Ta USB
77.It Netgear WG111v2 Ta RTL8225 Ta USB
78.It Netgear WG111v3 Ta RTL8225 Ta USB
79.It Safehome WLG-1500SMA5 Ta RTL8225 Ta USB
80.It Shuttle XPC Accessory PN20 Ta RTL8225 Ta USB
81.It Sitecom WL168v1 Ta RTL8225 Ta USB
82.It Sitecom WL168v4 Ta RTL8225 Ta USB
83.It SureCom EP-9001-g(2A) Ta RTL8225 Ta USB
84.It TRENDnet TEW-424UB V3.xR Ta RTL8225 Ta USB
85.El
86.Sh EXAMPLES
87Join an existing BSS network (i.e., connect to an access point):
88.Pp
89.Dl ifconfig wlan create wlandev urtw0 inet 192.0.2.20/24
90.Pp
91Join a specific BSS network with network name
92.Ar my_net :
93.Pp
94.Dl ifconfig wlan create wlandev urtw0 ssid my_net up
95.Pp
96Join a specific BSS network with 64-bit WEP encryption:
97.Bd -literal -offset indent
98ifconfig wlan create wlandev urtw0 ssid my_net \e
99    wepmode on wepkey 0x1234567890 weptxkey 1 up
100.Ed
101.Sh SEE ALSO
102.Xr intro 4 ,
103.Xr netintro 4 ,
104.Xr usb 4 ,
105.Xr wlan 4 ,
106.Xr wlan_ccmp 4 ,
107.Xr wlan_tkip 4 ,
108.Xr wlan_wep 4 ,
109.Xr ifconfig 8 ,
110.Xr wpa_supplicant 8
111.Rs
112.%T Realtek
113.%U https://www.realtek.com
114.Re
115.Sh HISTORY
116The
117.Nm
118device driver first appeared in
119.Fx 8.0 .
120.Sh AUTHORS
121.An -nosplit
122The
123.Nm
124driver was written by
125.An Weongyo Jeong Aq Mt weongyo@FreeBSD.org .
126