Differential D26884 Diff 85901 share/man/man4/sndstat.4

Changeset View

Standalone View

share/man/man4/sndstat.4

This file was added.

				.\"
				.\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD
				.\"
				.\" This software was developed by Ka Ho Ng
				.\" under sponsorship from the FreeBSD Foundation.
				.\"
				.\" Copyright (c) 2020 The FreeBSD Foundation
				.\"
				.\" 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$
				.\"
				.\" Note: The date here should be updated whenever a non-trivial
				.\" change is made to the manual page.
				.Dd December 7, 2020
				.Dt SNDSTAT 4
				.Os
				.Sh NAME
				.Nm sndstat
				.Nd "nvlist-based PCM audio device enumeration interface"
				.Sh SYNOPSIS
				To compile the driver into the kernel,
				place the following lines in the
				kernel configuration file:
				.Bd -ragged -offset indent
				.Cd "device sound"
				.Ed
				.Sh DESCRIPTION
				The ioctl interface provided by
				.Pa /dev/sndstat
				device allows callers to enumeration PCM audio devices available for use.
				.Sh IOCTLS
				For all ioctls requiring data exchange between the subsystem and callers,
				the following structures are used to describe a serialized nvlist:
				.Bd -literal -offset indent
				struct sndstat_nvlbuf_arg {
				size_t nbytes;
				void *buf;
				};
				.Ed
				.Pp
				Here is an example of an nvlist, with explanations of the common fields:
				.Bd -literal -offset indent
				dsps (NVLIST ARRAY): 1
				from_user (BOOL): FALSE
				nameunit (STRING): [pcm0]
				devnode (STRING): [dsp0]
				desc (STRING): [Generic (0x8086) (Analog Line-out)]
				pchan (NUMBER): 1 (1) (0x1)
				rchan (NUMBER): 0 (0) (0x0)
				pminrate (NUMBER): 48000 (48000) (0xbb80)
				pmaxrate (NUMBER): 48000 (48000) (0xbb80)
				pfmts (NUMBER): 2097168 (2097168) (0x200010)
				provider_info (NVLIST):
				unit (NUMBER): 0 (0) (0x0)
				bitperfect (BOOL): FALSE
				pvchan (NUMBER): 1 (1) (0x1)
				rvchan (NUMBER): 0 (0) (0x0)
				provider (STRING): [sound(4)]
				,
				.Ed
				.Bl -tag -width ".Dv provider_info"
				.It Dv from_user
				Whether the PCM audio device node is created by in-kernel audio subsystem or
				userspace providers.
				.It Dv nameunit
				The device identification in the form of subsystem plus a unit number.
				.It Dv devnode
				The PCM audio device node relative path in devfs.
				.It Dv desc
				The descripton of the PCM audio device.
				.It Dv pchan
				The number of playback channels supported by hardware.
				This can be 0 if this PCM audio device does not support playback at all.
				.It Dv rchan
				The number of recording channels supported by hardware.
				This can be 0 if this PCM audio device does not support recording at all.
				.It Dv pminrate
				The minimum supported playback direction sampling rate.
				Only exists if pchan is greater than 0.
				.It Dv pmaxrate
				The maximum supported playback direction sampling rate.
				Only exists if pchan is greater than 0.
				.It Dv pfmts
				The supported playback direction sample format.
				Only exists if pchan is greater than 0.
				.It Dv rminrate
				The minimum supported recording direction sampling rate.
				Only exists if rchan is greater than 0.
				.It Dv rmaxrate
				The maximum supported recording direction sampling rate.
				Only exists if rchan is greater than 0.
				.It Dv rfmts
				The supported playback recording sample format.
				Only exists if rchan is greater than 0.
				.It Dv provider_info
				Provider-specific fields.
				This field may not exist if the PCM audio device is not provided by in-kernel
				interface.
				This field will not exist if the provider field is an empty string.
				.It Dv provider
				A string specifying the provider of the PCm audio device.
				.El
				.Pp
				The following ioctls are providede for use:
				.Bl -tag -width ".Dv SNDSTAT_FLUSH_USER_DEVS"
				.It Dv SNDSTAT_REFRESH_DEVS
				Drop any previously fetched PCM audio devices list snapshots.
				This ioctl takes no arguments.
				.It Dv SNDSTAT_GET_DEVS
				Generate and/or return PCM audio devices list snapshots to callers.
				This ioctl takes a pointer to
				.Fa struct sndstat_nvlbuf_arg
				as the first and the only argument.
				Callers need to provide a sufficiently large buffer to hold a serialized
				nvlist.
				If there is no existing PCM audio device list snapshot available in the
				internal structure of the opened sndstat.
				.Fa fd ,
				a new PCM audio device list snapshot will be automatically generated.
				Callers have to set
				.Fa nbytes
				to either 0 or the size of buffer provided.
				In case
				.Fa nbytes
				is 0, the buffer size required to hold a serialized nvlist
				stream of current snapshot will be returned in
				.Fa nbytes ,
				and
				.Fa buf
				will be ignored.
				Otherwise, if the buffer is not sufficiently large,
				the ioctl returns success, and
				.Fa nbytes
				will be set to 0.
				If the buffer provided is sufficiently large,
				.Fa nbytes
				will be set to the size of the serialized nvlist written to the provided buffer.
				Once a PCM audio device list snapshot is returned to user-space successfully,
				the snapshot stored in the subsystem's internal structure of the given
				.Fa fd
				will be freed.
				.It Dv SNDSTAT_ADD_USER_DEVS
				Add a list of PCM audio devices provided by callers to
				.Pa /dev/sndstat
				device.
				This ioctl takes a pointer to
				.Fa struct sndstat_nvlbuf_arg
				as the first and the only argument.
				Callers have to provide a buffer holding a serialized nvlist.
				.Fa nbytes
				should be set to the length in bytes of the serialized nvlist.
				.Fa buf
				should be pointed to a buffer storing the serialized nvlist.
				Userspace-backed PCM audio device nodes should be listed inside the serialized
				nvlist.
				.It Dv SNDSTAT_FLUSH_USER_DEVS
				Flush any PCM audio devices previously added by callers.
				This ioctl takes no arguments.
				.El
				.Sh FILES
				.Bl -tag -width ".Pa /dev/sndstat" -compact
				.It Pa /dev/sndstat
				.El
				.Sh EXAMPLES
				The following code enumerates all available PCM audio devices:
				.Bd -literal -offset indent
				#include <sys/types.h>
				#include <err.h>
				#include <fcntl.h>
				#include <stdio.h>
				#include <stdlib.h>
				#include <sys/nv.h>
				#include <sys/sndstat.h>
				#include <sysexits.h>
				#include <unistd.h>

				int
				main()
				{
				int fd;
				struct sndstat_nvlbuf_arg arg;
				const nvlist_t * const *di;
				size_t i, nitems;
				nvlist_t *nvl;

				/* Open sndstat node in read-only first */
				fd = open("/dev/sndstat", O_RDONLY);

				if (ioctl(fd, SNDSTAT_REFRESH_DEVS, NULL))
				err(1, "ioctl(fd, SNDSTAT_REFRESH_DEVS, NULL)");

				/* Get the size of snapshot, when nbytes = 0 */
				arg.nbytes = 0;
				arg.buf = NULL;
				if (ioctl(fd, SNDSTAT_GET_DEVS, &arg))
				err(1, "ioctl(fd, SNDSTAT_GET_DEVS, &arg)");

				/* Get snapshot data */
				arg.buf = malloc(arg.nbytes);
				if (arg.buf == NULL)
				err(EX_OSERR, "malloc");
				if (ioctl(fd, SNDSTAT_GET_DEVS, &arg))
				err(1, "ioctl(fd, SNDSTAT_GET_DEVS, &arg)");

				/* Deserialize the nvlist stream */
				nvl = nvlist_unpack(arg.buf, arg.nbytes, 0);
				free(arg.buf);

				/* Get DSPs array */
				di = nvlist_get_nvlist_array(nvl, SNDSTAT_LABEL_DSPS, &nitems);
				for (i = 0; i < nitems; i++) {
				const char nameunit, devnode, *desc;

				/*
				* Examine each device nvlist item
				*/

				nameunit = nvlist_get_string(di[i], SNDSTAT_LABEL_NAMEUNIT);
				devnode = nvlist_get_string(di[i], SNDSTAT_LABEL_DEVNODE);
				desc = nvlist_get_string(di[i], SNDSTAT_LABEL_DESC);
				printf("Name unit: `%s`, Device node: `%s`, Description: `%s`\n",
				nameunit, devnode, desc);
				}

				nvlist_destroy(nvl);
				return (0);
				}
				.Ed
				.Sh SEE ALSO
				.Xr sound 4 ,
				.Xr nv 9
				.Sh HISTORY
				The nvlist-based ioctls support for
				.Nm
				device first appeared in
				.Fx 13.0 .
				.Sh AUTHORS
				This manual page was written by
				.An Ka Ho Ng Aq Mt khng@FreeBSD.org .