From nobody Mon Feb 12 11:08:51 2024 X-Original-To: dev-commits-src-main@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 4TYMCS01mwz59bKK; Mon, 12 Feb 2024 11:08:52 +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 4TYMCR5WHGz4Y0b; Mon, 12 Feb 2024 11:08:51 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1707736131; 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=o8mT/T7bW3CZprL9dBAREb3rTnmHHG5ZtVjMlwTqkPs=; b=MAgt6mFYrT1zx+sQs2I+KcwOhAHMLcwRxZjpY5//UAoliky52nuKp9YMC+2kC2kHdf8iRj 7iN1LtKZ3a2zPGgd2DImY73ZPiZmNFZpznqukAISH59oRkFOU2eU0HkxN39eY9cxFNKuzs 8cJjyplfii9ZxNmM2Cxn0QnH4oa8+DXW8N5pCRtjViK9MhUyS9uekd685Rt3DM78EgREpP JeHV5KSRsb6Kwrp9h/9acW13+IeDRAgddiCIHTnukSlH6kdIsOxLum5AXgypMxhtQ3ieIx VsVgOVADsIgdaeYHdwE/RIw5p4Dv9OopUpUv2prvFq6lCzYRS4dR7d+Hi7XWtw== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1707736131; a=rsa-sha256; cv=none; b=o1zmajYDbSMNcvaVoMQS+1V7Brs6a3/4+jrog+FQ8R0Q6ExVr2EfsrEAu7RHylsaJGsGD/ ESqIrAJV4AUS65yiJj97uiqRiCIjDgQGZBt11KsMQlpLX9q0RA2DnaxG4WC2yaDg7m3c2+ fSEyMSclXigx1leIGu01e2Pi+30PPfikKTwMjGdFzI0ZFQAOqjssM4Ws//HFDjbWLolpjZ rz6NgmJVvLZ/wpEbyb+WCmytSk83BK/tP/NWax8WSfYGoBE9RKMN0hseHFXQGRYUaApST+ Fb2YtGdvxivmLc/dd0L4ya4weyayb2L5qdMxv3yczBQu9RE6hGCbo9hbhVLWBw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1707736131; 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=o8mT/T7bW3CZprL9dBAREb3rTnmHHG5ZtVjMlwTqkPs=; b=Z/F+dGpki0cfhD7LLWe/8tjl5tZCoM8zDCG5QQGS3JxecQ9l0jw5Eri0KfTw5nePSjEjx8 v+UoBNCqX7ZAM4WLhaBwV8Sf1MFtH8Qfp0XAn3895wopMTbI4kNz6OyfPtvxPVPn/Zp2N3 npYOsKMDBawV+ST771vAJ+iXAIt1LH5JMZGYbRy3SNjk2/NMWkAv7MWHaq4g2CnDC+0s/Q 8L+dujg0krCNGUFAEV4kuOd2wyl0CFjtLE+QFK2j33vykUQ1tAXcG8mMLDsLldghRDqk35 zSiOr8L4zgtLz9ed+cCSt7c1lEhMXGORJsJkvT9IuKhLD32dhI6LJOC5WtFw5g== 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 4TYMCR4dPRzP0b; Mon, 12 Feb 2024 11:08:51 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.17.1/8.17.1) with ESMTP id 41CB8piZ041437; Mon, 12 Feb 2024 11:08:51 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 41CB8pau041434; Mon, 12 Feb 2024 11:08:51 GMT (envelope-from git) Date: Mon, 12 Feb 2024 11:08:51 GMT Message-Id: <202402121108.41CB8pau041434@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Christos Margiolis Subject: git: 5960ab73d865 - main - snd_uaudio.4: document sysctls List-Id: Commit messages for the main branch of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-main List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-main@freebsd.org X-BeenThere: dev-commits-src-main@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: christos X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 5960ab73d865b59bfa7d7fd3bd49a6f7d730ef83 Auto-Submitted: auto-generated The branch main has been updated by christos: URL: https://cgit.FreeBSD.org/src/commit/?id=5960ab73d865b59bfa7d7fd3bd49a6f7d730ef83 commit 5960ab73d865b59bfa7d7fd3bd49a6f7d730ef83 Author: Christos Margiolis AuthorDate: 2024-02-12 11:06:00 +0000 Commit: Christos Margiolis CommitDate: 2024-02-12 11:07:51 +0000 snd_uaudio.4: document sysctls Sponsored by: The FreeBSD Foundation MFC after: 2 weeks Reviewed by: dev_submerge.ch Differential Revision: https://reviews.freebsd.org/D43649 --- share/man/man4/snd_uaudio.4 | 81 +++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 78 insertions(+), 3 deletions(-) diff --git a/share/man/man4/snd_uaudio.4 b/share/man/man4/snd_uaudio.4 index 04dc10ccaa25..b6a6c06a2312 100644 --- a/share/man/man4/snd_uaudio.4 +++ b/share/man/man4/snd_uaudio.4 @@ -57,12 +57,88 @@ A USB audio device consists of a number of components: input terminals (e.g.\& USB digital input), output terminals (e.g.\& speakers), and a number of units in between (e.g.\& volume control). .Pp +If the device supports multiple configurations, and there have been no +user-supplied values specified through the +.Xr sysctl 8 +interface, the driver will select the best matching configuration supported by +the device during attach. +"Best" means the configuration with the most channels and highest quality in +sample rate and sample size. +.Pp Refer to the .Ql USB Audio Class Specification for more information. +.Sh SYSCTL VARIABLES +The following settings can be entered at the +.Xr loader 8 +prompt or in +.Xr loader.conf 5 +and can also be changed at runtime with the +.Xr sysctl 8 +command. +For a change to take effect during runtime, the device has to be re-attached. +.Bl -tag -width indent +.It Va hw.usb.uaudio.buffer_ms +Period of audio data processed at once, in milliseconds, from 1 to 8 (default +is 4). +Lower values mean less latency, but this can result in audible gaps due to +frequent CPU wakeups. +.It Va hw.usb.uaudio.default_bits +Preferred sample size in bits, from 0 to 32 (default is 0). +A value of 0 sets the sample size to the maximum supported sample size. +.Pp +Set this to select a smaller sample size if the device supports multiple sample +sizes. +.It Va hw.usb.uaudio.default_channels +Preferred number of sample channels, from 0 to 64 (default is 0). +USB 1.1 devices are limited to 4 channels due to bandwidth constraints, unless +a higher value is explicitly requested. +A value of 0 sets the sample channels to the maximum supported channel number. +.Pp +Set this to select a smaller channel number if the device supports multiple +channel configurations. +.It Va hw.usb.uaudio.default_rate +Preferred sample rate in Hz (default is 0). +If set to 0, the device's highest supported sample rate will be used. +.Pp +Note that if VCHANs are enabled, the sample rate will be overridden by +.Pa dev.pcm.%d.[play|rec].vchanrate +(see +.Xr sound 4 ) , +which can also be used to adjust the sample rate during runtime. +.Pp +If +.Pa hw.usb.uaudio.default_rate +is non-zero, +.Pa dev.pcm.%d.[play|rec].vchanrate +will use it as its maximum allowed value. +.It Va hw.usb.uaudio.handle_hid +Let +.Nm +handle HID volume keys, if any (default is 1). +.Bl -tag -width 2n +.It 0 +Disabled. +.It 1 +Enabled. +.El +.El +.Pp +If +.Xr usb 4 +has been compiled with +.Va USB_DEBUG +on, the following setting is also available: +.Bl -tag -width indent +.It Va hw.usb.uaudio.debug +Debug output level (default is 0). +.El .Sh SEE ALSO .Xr sound 4 , -.Xr usb 4 +.Xr usb 4 , +.Xr loader.conf 5 , +.Xr loader 8 , +.Xr sysctl 8 .Rs .%T "USB Audio Class Specifications" .%U http://www.usb.org/developers/docs/devclass_docs/ @@ -98,8 +174,7 @@ sysctls. .Pp The PCM framework in .Fx -currently doesn't support the full set of USB audio mixer -controls. +currently does not support the full set of USB audio mixer controls. Some mixer controls are only available as .Va dev.pcm.%d.mixer sysctls.