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