xref: /freebsd/share/man/man4/rtw88.4 (revision 90aac0d83bc9645f51ef0c2aeae6f9c0540bb031)
1.\"-
2.\" Copyright (c) 2022-2023 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 September 5, 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
32.Sy The driver is temporary disconnected from the build.
33.Pp
34The driver will auto-load without any user interaction using
35.Xr devmatch 8
36if enabled in
37.Xr rc.conf 5 .
38.Pp
39Only if auto-loading is explicitly disabled, place the following
40lines in
41.Xr rc.conf 5
42to manually load the driver as a module at boot time:
43.Bd -literal -offset indent
44kld_list="${kld_list} if_rtw88"
45.Ed
46.Pp
47It is discouraged to load the driver from
48.Xr loader 8 .
49.Sh DESCRIPTION
50The
51.Nm
52driver is derived from Realtek's Linux rtw88 driver and provides support for
53the following chipsets:
54.Pp
55.Bl -tag -width Ds -offset indent -compact
56.It Realtek 802.11n  wireless 8723de (RTL8723DE)
57.It Realtek 802.11ac wireless 8821ce (RTL8821CE)
58.It Realtek 802.11ac wireless 8822be (RTL8822BE)
59.It Realtek 802.11ac wireless 8822ce (RTL8822CE)
60.El
61.Pp
62This driver requires firmware to be loaded before it will work.
63The package
64.Pa wifi-firmware-rtw88-kmod
65from the
66.Pa ports/net/wifi-firmware-rtw88-kmod
67port needs to be installed before the driver is loaded.
68Otherwise no
69.Xr wlan 4
70interface can be created using
71.Xr ifconfig 8 .
72One can use
73.Xr fwget 8
74to install the correct firmware package.
75.Pp
76The driver uses the
77.\" No LinuxKPI man pages so no .Xr here.
78.Em linuxkpi_wlan
79and
80.Em linuxkpi
81compat framework to bridge between the Linux and
82native
83.Fx
84driver code as well as to the native
85.Xr net80211 4
86wireless stack.
87.Pp
88While
89.Nm
90supports all 802.11 a/b/g/n and ac
91the compatibility code currently only supports 802.11 a/b/g modes.
92Support for 802.11 n/ac is to come.
93.Sh LOADER TUNABLES
94.Bl -tag -width indent
95.It Va compat.linuxkpi.skb.mem_limit
96If you are running a 64bit system with more than 4GB of main memory
97you need to set this tunable to
98.Sy 1
99in
100.Xr loader.conf 5
101and reboot once to make it effective.
102This tunable will work around a problem with DMA and limit allocations
103for network buffer memory to the lower 32bit of physical memory and
104make the driver work.
105.El
106.Sh BUGS
107Certainly.
108.Pp
109Does not seem to work (reliably) on machines with more than 4GB of
110main memory.
111See in the
112.Sx LOADER TUNABLES
113section above.
114.Sh SEE ALSO
115.Xr rtw88fw 4 ,
116.Xr wlan 4 ,
117.Xr fwget 8 ,
118.Xr ifconfig 8 ,
119.Xr wpa_supplicant 8
120.Sh HISTORY
121The
122.Nm
123driver first appeared in
124.Fx 13.2 .
125