xref: /freebsd/share/man/man4/rtw88.4 (revision 05248206f720394d95c2a7475429311df670a2e9)
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 April 22, 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
45The driver should automatically load any
46.Xr rtw88fw 4
47firmware needed for the particular chipset.
48.Pp
49It is discouraged to load the driver from
50.Xr loader 8 .
51.Sh DESCRIPTION
52The
53.Nm
54driver is derived from Realtek's Linux rtw88 driver and provides support for
55the following chipsets:
56.Pp
57.Bl -tag -width Ds -offset indent -compact
58.It Realtek 802.11n  wireless 8723de (RTL8723DE)
59.It Realtek 802.11ac wireless 8821ce (RTL8821CE)
60.It Realtek 802.11ac wireless 8822be (RTL8822BE)
61.It Realtek 802.11ac wireless 8822ce (RTL8822CE)
62.El
63.Pp
64The driver uses the
65.\" No LinuxKPI man pages so no .Xr here.
66.Em linuxkpi_wlan
67and
68.Em linuxkpi
69compat framework to bridge between the Linux and
70native
71.Fx
72driver code as well as to the native
73.Xr net80211 4
74wireless stack.
75.Pp
76While
77.Nm
78supports all 802.11 a/b/g/n and ac
79the compatibility code currently only supports 802.11 a/b/g modes.
80Support for 802.11 n/ac is to come.
81.Sh LOADER TUNABLES
82.Bl -tag -width indent
83.It Va compat.linuxkpi.skb.mem_limit
84If you are running a 64bit system with more than 4GB of main memory
85you need to set this tunable to
86.Sy 1
87in
88.Xr loader.conf 5
89and reboot once to make it effective.
90This tunable will work around a problem with DMA and limit allocations
91for network buffer memory to the lower 32bit of physical memory and
92make the driver work.
93.El
94.Sh BUGS
95Certainly.
96.Pp
97Does not seem to work (reliably) on machines with more than 4GB of
98main memory.
99See in the
100.Sx LOADER TUNABLES
101section above.
102.Sh SEE ALSO
103.Xr rtw88fw 4 ,
104.Xr wlan 4 ,
105.Xr ifconfig 8 ,
106.Xr wpa_supplicant 8
107.Sh HISTORY
108The
109.Nm
110driver first appeared in
111.Fx 13.2 .
112