xref: /freebsd/share/man/man4/ath10k.4 (revision 090e9752d7291db0c251a5576892e3bbbaea2479)
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 April 22, 2023
28.Dt ATH10K 4
29.Os
30.Sh NAME
31.Nm ath10k
32.Nd Qualcomm Atheros IEEE 802.11ac wireless network driver
33.Sh SYNOPSIS
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_ath10k"
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 Qualcomm Atheros' Linux ath10k driver and
53provides support for the following PCI chipsets:
54.Pp
55.Bl -tag -width Ds -offset indent -compact
56.It QCA6174
57.It QCA9377
58.It QCA9887
59.It QCA9888
60.It QCA988X
61.It QCA9984
62.It QCA99X0
63.El
64.Pp
65.Pp
66This driver requires firmware to be loaded before it will work.
67The package
68.Pa wifi-firmware-ath10k-kmod
69from the
70.Pa ports/net/wifi-firmware-ath10k-kmod
71port needs to be installed before the driver is loaded.
72Otherwise no
73.Xr wlan 4
74interface can be created using
75.Xr ifconfig 8 .
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 BUGS
94Certainly.
95.Sh SEE ALSO
96.Xr wlan 4 ,
97.Xr ifconfig 8 ,
98.Xr wpa_supplicant 8
99.Sh HISTORY
100The
101.Nm
102driver first appeared in
103.Fx 14.0 .
104