share/man/man4/rtw88.4

   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 .\" $FreeBSD$
  26 .\"
  27 .Dd May 5, 2022
  28 .Dt rtw88 4
  29 .Os
  30 .Sh NAME
  31 .Nm rtw88
  32 .Nd Realtek IEEE 802.11n/ac wireless network driver
  33 .Sh SYNOPSIS
  34 The driver will auto-load without any user interaction using
  35 .Xr devmatch 8
  36 if enabled in
  37 .Xr rc.conf 5 .
  38 .Pp
  39 Only if auto-loading is explicitly disabled, place the following
  40 lines in
  41 .Xr rc.conf 5
  42 to manually load the driver as a module at boot time:
  43 .Bd -literal -offset indent
  44 kld_list="${kld_list} if_rtw88"
  45 .Ed
  46 .Pp
  47 The driver should automatically load any
  48 .Xr rtw88fw 4
  49 firmware needed for the particular chipset.
  50 .Pp
  51 It is discouraged to load the driver from
  52 .Xr loader 8 .
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 driver is derived from Realtek's Linux rtw88 driver and provides support for
  57 the following chipsets:
  58 .Pp
  59 .Bl -tag -width Ds -offset indent -compact
  60 .It Realtek 802.11n  wireless 8723de (RTL8723DE)
  61 .It Realtek 802.11ac wireless 8821ce (RTL8821CE)
  62 .It Realtek 802.11ac wireless 8822be (RTL8822BE)
  63 .It Realtek 802.11ac wireless 8822ce (RTL8822CE)
  64 .El
  65 .Pp
  66 The driver uses the
  67 .\" No LinuxKPI man pages so no .Xr here.
  68 .Em linuxkpi_wlan
  69 and
  70 .Em linuxkpi
  71 compat framework to bridge between the Linux and
  72 native FreeBSD driver code as well as to the native
  73 .Xr net80211 4
  74 wireless stack.
  75 .Pp
  76 While
  77 .Nm
  78 supports all 802.11 a/b/g/n and ac
  79 the compatibility code currently only supports 802.11 a/b/g modes.
  80 Support 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
  84 If you are running a 64bit system with more than 4GB of main mmeory
  85 you need to set this tunable to
  86 .Sy 1
  87 in
  88 .Xr loader.conf 5
  89 and reboot once to make it effective.
  90 This tunable will work around a problem with DMA and limit allocations
  91 for network buffer memory to the lower 32bit of physical memory and
  92 make the driver work.
  93 .El
  94 .Sh BUGS
  95 Certainly.
  96 .Pp
  97 Does not seem to work (reliably) on machines with more than 4GB of
  98 main memory.
  99 See in the
 100 .Sx LOADER TUNABLES
 101 section 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
 108 The
 109 .Nm
 110 driver first appeared in
 111 .Fx 14.0 .