upstream/opnsense-src
1
0
Fork 0
mirror of https://github.com/opnsense/src.git synced 2026-06-07 07:42:26 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

man.4: Add .Sh HARDWARE for some wireless drivers for release notes

Browse source 
iwlwifi.4 and rtw88.4 did not show up in the hardware list in the
release notes for 13.4.
The doc/website/tools/hardware-notes-processor.rb script parses
the .Sh HARDWARE section to automagically create a note once the
manual page is listed in the website/archetypes/release/hardware.adoc
file.

While here update the other committed man pages not yet connected
to the build.

Reported by:	re (cperciva), grahamperrin
Sponsored by:	The FreeBSD Foundation
MFC after:	3 days
Reviewed by:	concussious.bugzilla_runbox.com (Alexander Ziaee)
Differential Revision: https://reviews.freebsd.org/D46851
This commit is contained in:
Bjoern A. Zeeb 2024-09-30 20:01:23 +00:00
parent 41283b454b
commit 5dbb0b7c19
5 changed files with 87 additions and 72 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
share/man/man4/ath10k.4
View file

@ -1,5 +1,5 @@
.\"-
.\" Copyright (c) 2022 Bjoern A. Zeeb
.\" Copyright (c) 2022-2024 Bjoern A. Zeeb
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
@ -22,7 +22,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd April 22, 2023
.Dd September 30, 2024
.Dt ATH10K 4
.Os
.Sh NAME
@ -47,18 +47,7 @@ It is discouraged to load the driver from
.Sh DESCRIPTION
The
.Nm
driver is derived from Qualcomm Atheros' Linux ath10k driver and
provides support for the following PCI chipsets:
.Pp
.Bl -tag -width Ds -offset indent -compact
.It QCA6174
.It QCA9377
.It QCA9887
.It QCA9888
.It QCA988X
.It QCA9984
.It QCA99X0
.El
driver is derived from Qualcomm Atheros' Linux ath10k driver
.Pp
This driver requires firmware to be loaded before it will work.
The package
@ -87,6 +76,20 @@ While
supports all 802.11 a/b/g/n and ac
the compatibility code currently only supports 802.11 a/b/g modes.
Support for 802.11 n/ac is to come.
.Sh HARDWARE
The
.Nm
driver supports PCIe devices with the following chipsets:
.Pp
.Bl -tag -width Ds -offset indent -compact
.It QCA6174
.It QCA9377
.It QCA9887
.It QCA9888
.It QCA988X
.It QCA9984
.It QCA99X0
.El
.Sh SEE ALSO
.Xr wlan 4 ,
.Xr ifconfig 8 ,

65
share/man/man4/iwlwifi.4
View file

@ -1,5 +1,5 @@
.\"-
.\" Copyright (c) 2021-2023 The FreeBSD Foundation
.\" Copyright (c) 2021-2024 The FreeBSD Foundation
.\"
.\" This documentation was written by Bj\xc3\xb6rn Zeeb under sponsorship from
.\" the FreeBSD Foundation.
@ -25,7 +25,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd September 21, 2023
.Dd September 30, 2024
.Dt IWLWIFI 4
.Os
.Sh NAME
@ -54,10 +54,39 @@ It is discouraged to load the driver from
.Sh DESCRIPTION
The
.Nm
driver is derived from Intel's Linux iwlwifi driver and provides support for
all chipsets supported by the
driver is derived from Intel's Linux iwlwifi driver
.Pp
.Nm
will be a successor to
.Xr iwm 4
and may supersede that driver in the future.
It still complements the
.Xr iwn 4
driver which supports older chipsets.
.Pp
The driver uses the
.\" No LinuxKPI man pages so no .Xr here.
.Em linuxkpi_wlan
and
.Em linuxkpi
compat framework to bridge between the Linux and
native
.Fx
driver code as well as to the native
.Xr net80211 4
wireless stack.
.Pp
While
.Nm
supports all 802.11 a/b/g/n/ac/ax
the compatibility code currently only supports 802.11 a/b/g modes.
Support for 802.11 n/ac is to come. 802.11ax and 6Ghz support are planned.
.Sh HARDWARE
The
.Nm
driver supports PCIe devices from the
.Em mvm
part of that driver.
sub-driver with the following chipsets:
.Pp
.Bl -bullet -compact
.\" ---------------------------------------------------------------------
@ -182,32 +211,6 @@ Intel(R) Wi-Fi 6 AX204 160MHz
Intel(R) TBD Sc device
.\" ---------------------------------------------------------------------
.El
.Pp
.Nm
will be a successor to
.Xr iwm 4
and may supersede that driver in the future.
It still complements the
.Xr iwn 4
driver which supports older chipsets.
.Pp
The driver uses the
.\" No LinuxKPI man pages so no .Xr here.
.Em linuxkpi_wlan
and
.Em linuxkpi
compat framework to bridge between the Linux and
native
.Fx
driver code as well as to the native
.Xr net80211 4
wireless stack.
.Pp
While
.Nm
supports all 802.11 a/b/g/n/ac/ax
the compatibility code currently only supports 802.11 a/b/g modes.
Support for 802.11 n/ac is to come. 802.11ax and 6Ghz support are planned.
.Sh BUGS
Certainly.
.Sh SEE ALSO

19
share/man/man4/mt7915.4
View file

@ -1,5 +1,5 @@
.\"-
.\" Copyright (c) 2023 Bjoern A. Zeeb
.\" Copyright (c) 2023-2024 Bjoern A. Zeeb
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
@ -22,7 +22,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd April 18, 2023
.Dd September 30, 2024
.Dt MT7915 4
.Os
.Sh NAME
@ -50,12 +50,7 @@ It is discouraged to load the driver from
.Sh DESCRIPTION
The
.Nm
driver is derived from MediaTek's Linux mt76 driver and provides support for
the following chipsets:
.Pp
.Bl -tag -width Ds -offset indent -compact
.It MediaTek MT7915E (PCIe)
.El
driver is derived from MediaTek's Linux mt76 driver.
.Pp
This driver requires firmware to be loaded before it will work.
The package
@ -85,6 +80,14 @@ While
supports all 802.11 a/b/g/n/ac and ax
the compatibility code currently only supports 802.11 a/b/g modes.
Support for 802.11 n/ac is to come.
.Sh HARDWARE
The
.Nm
driver supports PCIe devices with the following chipsets:
.Pp
.Bl -tag -width Ds -offset indent -compact
.It MediaTek MT7915E
.El
.Sh BUGS
Certainly.
.Sh SEE ALSO

19
share/man/man4/mt7921.4
View file

@ -1,5 +1,5 @@
.\"-
.\" Copyright (c) 2023 Bjoern A. Zeeb
.\" Copyright (c) 2023-2024 Bjoern A. Zeeb
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
@ -22,7 +22,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd April 18, 2023
.Dd September 30, 2024
.Dt MT7921 4
.Os
.Sh NAME
@ -50,12 +50,7 @@ It is discouraged to load the driver from
.Sh DESCRIPTION
The
.Nm
driver is derived from MediaTek's Linux mt76 driver and provides support for
the following chipsets:
.Pp
.Bl -tag -width Ds -offset indent -compact
.It MediaTek MT7921E (PCIe)
.El
driver is derived from MediaTek's Linux mt76 driver.
.Pp
This driver requires firmware to be loaded before it will work.
The package
@ -85,6 +80,14 @@ While
supports all 802.11 a/b/g/n/ac and ax
the compatibility code currently only supports 802.11 a/b/g modes.
Support for 802.11 n/ac is to come.
.Sh HARDWARE
The
.Nm
driver supports PCIe devices with the following chipsets:
.Pp
.Bl -tag -width Ds -offset indent -compact
.It MediaTek MT7921E
.El
.Sh BUGS
Certainly.
.Sh SEE ALSO

25
share/man/man4/rtw88.4
View file

@ -1,5 +1,5 @@
.\"-
.\" Copyright (c) 2022 Bjoern A. Zeeb
.\" Copyright (c) 2022-2024 Bjoern A. Zeeb
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
@ -22,7 +22,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd October 06, 2023
.Dd September 30, 2024
.Dt RTW88 4
.Os
.Sh NAME
@ -47,15 +47,7 @@ It is discouraged to load the driver from
.Sh DESCRIPTION
The
.Nm
driver is derived from Realtek's Linux rtw88 driver and provides support for
the following chipsets:
.Pp
.Bl -tag -width Ds -offset indent -compact
.It Realtek 802.11n wireless 8723de (RTL8723DE)
.It Realtek 802.11ac wireless 8821ce (RTL8821CE)
.It Realtek 802.11ac wireless 8822be (RTL8822BE)
.It Realtek 802.11ac wireless 8822ce (RTL8822CE)
.El
driver is derived from Realtek's Linux rtw88 driver.
.Pp
This driver requires firmware to be loaded before it will work.
The package
@ -101,6 +93,17 @@ This tunable will work around a problem with DMA and limit allocations
for network buffer memory to the lower 32bit of physical memory and
make the driver work.
.El
.Sh HARDWARE
The
.Nm
driver supports PCIe devices with the following chipsets:
.Pp
.Bl -tag -width Ds -offset indent -compact
.It Realtek 802.11n wireless 8723de (RTL8723DE)
.It Realtek 802.11ac wireless 8821ce (RTL8821CE)
.It Realtek 802.11ac wireless 8822be (RTL8822BE)
.It Realtek 802.11ac wireless 8822ce (RTL8822CE)
.El
.Sh BUGS
Certainly.
.Pp