xref: /freebsd/share/man/man4/ath10k.4 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
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 ATH10K 4
27.Os
28.Sh NAME
29.Nm ath10k
30.Nd Qualcomm Atheros IEEE 802.11ac 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_ath10k"
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 Qualcomm Atheros' Linux ath10k driver and
51provides support for the following PCI chipsets:
52.Pp
53.Bl -tag -width Ds -offset indent -compact
54.It QCA6174
55.It QCA9377
56.It QCA9887
57.It QCA9888
58.It QCA988X
59.It QCA9984
60.It QCA99X0
61.El
62.Pp
63This driver requires firmware to be loaded before it will work.
64The package
65.Pa wifi-firmware-ath10k-kmod
66from the
67.Pa ports/net/wifi-firmware-ath10k-kmod
68port needs to be installed before the driver is loaded.
69Otherwise no
70.Xr wlan 4
71interface can be created using
72.Xr ifconfig 8 .
73The driver uses the
74.\" No LinuxKPI man pages so no .Xr here.
75.Em linuxkpi_wlan
76and
77.Em linuxkpi
78compat framework to bridge between the Linux and
79native
80.Fx
81driver code as well as to the native
82.Xr net80211 4
83wireless stack.
84.Pp
85While
86.Nm
87supports all 802.11 a/b/g/n and ac
88the compatibility code currently only supports 802.11 a/b/g modes.
89Support for 802.11 n/ac is to come.
90.Sh SEE ALSO
91.Xr wlan 4 ,
92.Xr ifconfig 8 ,
93.Xr wpa_supplicant 8
94.Sh HISTORY
95The
96.Nm
97driver first appeared in
98.Fx 14.0 .
99.Sh BUGS
100Certainly.
101