From nobody Sun Apr 23 21:31:45 2023 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4Q4M0L2LTnz46VmD; Sun, 23 Apr 2023 21:31:46 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4Q4M0K6V3Zz3DXn; Sun, 23 Apr 2023 21:31:45 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1682285506; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=FzQCxjdobbAWBKkVj9FczsQi/locth2QgECqnQHwxaM=; b=mDp12CrYa+isw18nEKkS1xm4EuSIzVkMMmeUCfK4Re9v6Lj0MknZulcUQcNWj8ey3JzMFr H1loqf5h+bwVvVMrNTRd+4wpLcVV083Qjk77cUzq0Wb19pX+83DllzrIQbUMTS4RSCxQxy dEFuYNQhaAL4OLo1rWpIHPQ17e8Xvo3MGrCNVafoXc9NLcBGgQe3pBZe1XnNUaSmbPCEaT c8JSvLuVsRPKtFHh8I3yKEK4QShpCRpyCP/pWm1EBbTTREiZti0JP+JjcW5r77NVwNtLmg og3As5iC1Dn2/wpVDReQtC6BUL9H/09T1x0cm0cjnQZzPHUuJCWVCurGaK4hdg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1682285506; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=FzQCxjdobbAWBKkVj9FczsQi/locth2QgECqnQHwxaM=; b=mYRodL5P+2f13cV3KvtZNCYefpqpXIVVrR97ejfRJA9CUZtrJf5zNf3YqZNL/rKqPbpjZ1 8QYv9+WYi3whK8KImbY/mAbK1h/ORVthCgRW5AOa5Zni0QQfmNMajtn5EkiEhgI58QyyAw 3ygEJ0wMySckTI9lfpoG0wq2YMMD39D7R3ARPEAl1D46h9nrzSSEHE/sj/KbjkmKwjsbha ZNnz8ApfQNOxrEipmTvk/nNRtZ4yC1wW4BTfDGXzfA3HCCfseNuZ/Kzt2af6+b5sWehMTF 4ERbIL+nFHe2Nwc2pSF260wTiW8BQ+JT1DppWAgSSO4oNE2UIy5exqZpBpa+bA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1682285506; a=rsa-sha256; cv=none; b=IhwxxEhHSkM69va1td0lvUeyL7LEWAeoCTjj10LET1qs7jhO5Wl7lcmhdebA6Bcva90Ypv a85Y7OussbYzETK0f/W4CtN7wokqGtNLCbd2wMv4igg0S7jJNEHx2KaT4yZTvk9FLbOqPl NTZO7ZPryt2vlBMdAS2vUmj2S+OPDFsr5D0XEJ/wdnB6ATaasU0ffLDcXb2LA0Ha1kaUTw xsmKDp2KMVklZDqFOac876L1bRdnrQAPNzPYNnW12qyn+emOH2Oep+/tVuhTV3C+2Lw0fk eO6kCdT2to/nVH21go4FQqeWEZdKR2ZwhZQo5zV4DuFoVgrEuHOAXi9EKDWvDw== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4Q4M0K3HFtz10FJ; Sun, 23 Apr 2023 21:31:45 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 33NLVj37084626; Sun, 23 Apr 2023 21:31:45 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 33NLVjAN084625; Sun, 23 Apr 2023 21:31:45 GMT (envelope-from git) Date: Sun, 23 Apr 2023 21:31:45 GMT Message-Id: <202304232131.33NLVjAN084625@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: "Bjoern A. Zeeb" Subject: git: e51be73a60d2 - main - ath10k: add man page List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-all@freebsd.org X-BeenThere: dev-commits-src-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: bz X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: e51be73a60d21b766662b6951660090154063c4b Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by bz: URL: https://cgit.FreeBSD.org/src/commit/?id=e51be73a60d21b766662b6951660090154063c4b commit e51be73a60d21b766662b6951660090154063c4b Author: Bjoern A. Zeeb AuthorDate: 2023-04-23 21:22:01 +0000 Commit: Bjoern A. Zeeb CommitDate: 2023-04-23 21:31:08 +0000 ath10k: add man page Add initial man page for ath10k.4. MFC after: 2 months --- share/man/man4/ath10k.4 | 103 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 103 insertions(+) diff --git a/share/man/man4/ath10k.4 b/share/man/man4/ath10k.4 new file mode 100644 index 000000000000..a88a460c811b --- /dev/null +++ b/share/man/man4/ath10k.4 @@ -0,0 +1,103 @@ +.\"- +.\" Copyright (c) 2022 Bjoern A. Zeeb +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd April 22, 2023 +.Dt ATH10K 4 +.Os +.Sh NAME +.Nm ath10k +.Nd Qualcomm Atheros IEEE 802.11ac wireless network driver +.Sh SYNOPSIS +The driver will auto-load without any user interaction using +.Xr devmatch 8 +if enabled in +.Xr rc.conf 5 . +.Pp +Only if auto-loading is explicitly disabled, place the following +lines in +.Xr rc.conf 5 +to manually load the driver as a module at boot time: +.Bd -literal -offset indent +kld_list="${kld_list} if_ath10k" +.Ed +.Pp +It is discouraged to load the driver from +.Xr loader 8 . +.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 +.Pp +.Pp +This driver requires firmware to be loaded before it will work. +The package +.Pa wifi-firmware-ath10k-kmod +from the +.Pa ports/net/wifi-firmware-ath10k-kmod +port needs to be installed before the driver is loaded. +Otherwise no +.Xr wlan 4 +interface can be created using +.Xr ifconfig 8 . +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 and ac +the compatibility code currently only supports 802.11 a/b/g modes. +Support for 802.11 n/ac is to come. +.Sh BUGS +Certainly. +.Sh SEE ALSO +.Xr wlan 4 , +.Xr ifconfig 8 , +.Xr wpa_supplicant 8 +.Sh HISTORY +The +.Nm +driver first appeared in +.Fx 14.0 .