Subject: kern/15442: audio(4) manpage fixes.
To: None <gnats-bugs@gnats.netbsd.org>
From: None <svs@ropnet.ru>
List: netbsd-bugs
Date: 01/31/2002 13:48:00
>Number:         15442
>Category:       kern
>Synopsis:       audio(4) manpage fixes.
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    kern-bug-people
>State:          open
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Thu Jan 31 02:49:00 PST 2002
>Closed-Date:
>Last-Modified:
>Originator:     Sergey Svishchev
>Release:        1.5ZA
>Organization:
>Environment:
>Description:
>How-To-Repeat:
Try to grok audio subsystem while trying to make mplayer work with uaudio(4)
device.
>Fix:
RCS file: /cvsroot/sharesrc/share/man/man4/audio.4,v
--- audio.4	2001/10/22 22:23:44	1.43
+++ audio.4	2002/01/30 04:53:10
@@ -161,7 +161,9 @@
 .Pp
 The audio device, like most devices, can be used in
 .Va select ,
-can be set in non-blocking mode and can be set to send a
+can be set in non-blocking mode and can be set (with a
+.Dv FIOASYNC 
+ioctl) to send a
 .Dv SIGIO
 when I/O is possible.
 The mixer device can be set to generate a
@@ -243,7 +245,7 @@
 .It Dv AUDIO_GETIOFFS (audio_offset_t)
 .It Dv AUDIO_GETOOFFS (audio_offset_t)
 This command fetches the current offset in the input(output) buffer where
-the hardware is putting(getting) data.
+the audio hardware's DMA engine will be putting(getting) data.
 It mostly useful when the device
 buffer is available in user space via the
 .Xr mmap 2
@@ -263,7 +265,7 @@
 typedef struct audio_info {
 	struct	audio_prinfo play;   /* info for play (output) side */
 	struct	audio_prinfo record; /* info for record (input) side */
-        u_int	monitor_gain;
+        u_int	monitor_gain;			/* input to output mix */
 	/* BSD extensions */
 	u_int	blocksize;	/* H/W read/write block size */
 	u_int	hiwat;		/* output high water mark */
@@ -337,7 +339,7 @@
 	u_int	sample_rate;	/* sample rate in samples/s */
 	u_int	channels;	/* number of channels, usually 1 or 2 */
 	u_int	precision;	/* number of bits/sample */
-	u_int	encoding;	/* data encoding (AUDIO_ENCODING_* above) */
+	u_int	encoding;	/* data encoding (AUDIO_ENCODING_* below) */
 	u_int	gain;		/* volume level */
 	u_int	port;		/* selected I/O port */
 	u_long	seek;		/* BSD extension */
@@ -528,8 +542,8 @@
 .It Dv AUDIO_MIXER_DEVINFO (mixer_devinfo_t)
 This command is used iteratively to fetch audio mixer device information
 into the input/output mixer_devinfo_t argument.
-To query all the supported encodings, start with an index field of
-0 and continue with successive encodings (1, 2, ...) until the
+To query all the supported devices, start with an index field of
+0 and continue with successive devices (1, 2, ...) until the
 command returns an error.
 .Bd -literal
 typedef struct mixer_devinfo {
@@ -557,6 +571,7 @@
 		struct audio_mixer_value {
 			audio_mixer_name_t units;
 			int num_channels;
+			int delta;
 		} v;
 	} un;
 } mixer_devinfo_t;
@@ -601,7 +616,7 @@
 .Va prev
 may be used by the hardware device driver to provide hints for the next
 and previous devices in a related set (for example, the line in level
-control would have the line in mute as its "next" value).
+control would have the line in mute as its ``next'' value).
 If there is no relevant next or previous value,
 .Dv AUDIO_MIXER_LAST
 is specified.
@@ -650,6 +665,7 @@
 .Xr ym 4
 .br
 For ports using the PCI bus:
+.Xr auich 4 ,
 .Xr auvia 4 ,
 .Xr clcs 4 ,
 .Xr clct 4 ,
@@ -659,11 +675,15 @@
 .Xr esm 4 ,
 .Xr eso 4 ,
 .Xr fms 4 ,
+.Xr neo 4 ,
 .Xr sv 4 ,
 .Xr yds 4
 .br
 For ports using PCMCIA:
 .Xr esl 4
+.br
+For ports using TurboChannel:
+.Xr bba 4
 .br
 For ports using USB:
 .Xr uaudio 4
>Release-Note:
>Audit-Trail:
>Unformatted: