xref: /freebsd/share/man/man4/rtw88.4 (revision 2008043f386721d58158e37e0d7e50df8095942d)
1.\"-
2.\" Copyright (c) 2022 Bjoern A. Zeeb
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.Dd October 06, 2023
26.Dt RTW88 4
27.Os
28.Sh NAME
29.Nm rtw88
30.Nd Realtek IEEE 802.11n/ac wireless network driver
31.Sh SYNOPSIS
32The driver will auto-load without any user interaction using
33.Xr devmatch 8
34if enabled in
35.Xr rc.conf 5 .
36.Pp
37Only if auto-loading is explicitly disabled, place the following
38lines in
39.Xr rc.conf 5
40to manually load the driver as a module at boot time:
41.Bd -literal -offset indent
42kld_list="${kld_list} if_rtw88"
43.Ed
44.Pp
45It is discouraged to load the driver from
46.Xr loader 8 .
47.Sh DESCRIPTION
48The
49.Nm
50driver is derived from Realtek's Linux rtw88 driver and provides support for
51the following chipsets:
52.Pp
53.Bl -tag -width Ds -offset indent -compact
54.It Realtek 802.11n  wireless 8723de (RTL8723DE)
55.It Realtek 802.11ac wireless 8821ce (RTL8821CE)
56.It Realtek 802.11ac wireless 8822be (RTL8822BE)
57.It Realtek 802.11ac wireless 8822ce (RTL8822CE)
58.El
59.Pp
60This driver requires firmware to be loaded before it will work.
61The package
62.Pa wifi-firmware-rtw88-kmod
63from the
64.Pa ports/net/wifi-firmware-rtw88-kmod
65port needs to be installed before the driver is loaded.
66Otherwise no
67.Xr wlan 4
68interface can be created using
69.Xr ifconfig 8 .
70One can use
71.Xr fwget 8
72to install the correct firmware package.
73.Pp
74The driver uses the
75.\" No LinuxKPI man pages so no .Xr here.
76.Em linuxkpi_wlan
77and
78.Em linuxkpi
79compat framework to bridge between the Linux and
80native
81.Fx
82driver code as well as to the native
83.Xr net80211 4
84wireless stack.
85.Pp
86While
87.Nm
88supports all 802.11 a/b/g/n and ac
89the compatibility code currently only supports 802.11 a/b/g modes.
90Support for 802.11 n/ac is to come.
91.Sh LOADER TUNABLES
92.Bl -tag -width indent
93.It Va compat.linuxkpi.skb.mem_limit
94If you are running a 64bit system with more than 4GB of main memory
95you need to set this tunable to
96.Sy 1
97in
98.Xr loader.conf 5
99and reboot once to make it effective.
100This tunable will work around a problem with DMA and limit allocations
101for network buffer memory to the lower 32bit of physical memory and
102make the driver work.
103.El
104.Sh BUGS
105Certainly.
106.Pp
107Does not seem to work (reliably) on machines with more than 4GB of
108main memory.
109See in the
110.Sx LOADER TUNABLES
111section above.
112.Sh SEE ALSO
113.Xr rtw88fw 4 ,
114.Xr wlan 4 ,
115.Xr fwget 8 ,
116.Xr ifconfig 8 ,
117.Xr wpa_supplicant 8
118.Sh HISTORY
119The
120.Nm
121driver first appeared in
122.Fx 13.2 .
123