man pages: add missing commas between subordinate and main clauses

jmc@ dislikes a comma before "then" in a conditional, so leave those
untouched.

ok jmc@

some comma fixes; from varik valefor
(audio.4 tweaked from that submitted)

sort SEE ALSO;

move mixerctl and audioctl man pages to section 8, as these work
against root-only device nodes.

Remove references to the mixer device, rework control device section

Add the missing paragraph to explain that the control device may be
read. Add the missing .Xr to sndioctl and sioctl_open.

ok and tweaks jmc@

Mention ioctls that don't work for the control device.

ok jmc

Use english words instead of file names.

ok jmc

Remove obvious or repeating sentinces.

ok jmc

catch up with the symlink removal of /dev/{audio,mixer};
ok ratchov

cross reference sndio(7) and sndiod(8); from weerd@;
OK ratchov@ jmc@ (who are both busy)

Mention that only superuser may control record.enable knob.

help from and ok schwarze

Document the new "record.enable" mixer knob.

help from and ok schwarze

Remove reference to /dev/sound*. With tweaks from jmc@, thanks.

While /dev/audio is in use, /dev/audioctl has read-only access to
device variables.

Fix typo: replace AUDIO_GETINFO by AUDIO_GETPAR.

Delete unused ioctls and associated macros. Move macros that are still
used internally by low-level drivers from sys/audioio.h to
dev/audio_if.h instead of deleting them.

Add a new AUDIO_GETSTATUS ioctl to get various audio driver variables.
It's intended for use with diagnostic tools (like audioctl) and is of
no use to audio programs.

knock out unused Pp in previous;

Expose new audio ioctls that do one thing only: start and stop DMA,
set and get parameters. This is much simpler.

ok semarie, armani, tweaks from jmc

Add the AUDIO_GETPOS ioctl() to fetch a snapshot of the 4 counters
returned by AUDIO_GETxOFFS and AUDIO_xERROR ioctls.

ok deraadt

Remove sections that describe features we don't support any longer.

espie points out <string.h> is needed for the AUDIO_INITINFO() macro

Dv blah , Dv bleh
is more simply written as
Dv blah , bleh

audio(4) has nothing to do with <string.h>

wording fix; original diff from remco, but i've reworded it to read better
ok ratchov

add two new members to structs audio_encoding and audio_prinfo.
for both structs, the new members are 'bps' and 'msb', which
describe the number of bytes per sample and data alignment in the
sample, respectively. drivers must properly set these fields in
the 'query_encoding', 'set_parameters' and 'get_default_params'
hardware interface methods.

discussed with ratchov, deraadt

sync description of struct audio_prinfo;
reported by frederic, documentation/6179

fix a few typographical errors.

ok jmc@

typo fix - ok jakemsr - and add a comma;

deal with sample precisions that are not a power of 2.

discussed with and ok ratchov; manpage tweak from naddy, thanks

sa_open -> sio_open, after recent changes;

add some audio/libsa cross refs;

First pass at removing clauses 3 and 4 from NetBSD licenses.

Not sure what's more surprising: how long it took for NetBSD to
catch up to the rest of the BSDs (including UCB), or the amount of
code that NetBSD has claimed for itself without attributing to the
actual authors.

OK deraadt@

tweak previous;

explain why, even though we support "sticky" block sizes, setting block
sizes before other parameters can cause problems.

ok ratchov@

allow low level audio drivers to specify a default sample format,
instead of 8-bit mono mulaw @ 8kHz.

this is just the infrastructure; no drivers are specifying a default
yet.

ok ratchov@, deanna@

add audio(4) driver the ability to use different block sizes for play and
record modes. This makes possible to have blocks of the same duration if the
play and record formats are different. The API change is backward
compatible, so it shouldn't be noticed by current audio ports.

ok jakemsr

Remove incomplete device Xr list. The device pages already reference
audio(4), and the bus pages reference the devices, so there's no need
for audio(4) to try to keep up.

Requested by & ok jmc@

add aucat(1) and cdio(1) to SEE ALSO;

add new envy(4) man page

ok jmc@, ok deraadt@

explain that AUDIO_GET[PR]RINFO were added for porting 3rd party
software and should be avoided in new code

suggested by ratchov@, help from jmc@

add two new audio ioctls, AUDIO_GETPRINFO and AUDIO_GETRRINFO, and the
data structure these ioctls use, audio_bufinfo.

these ioctls return information about the play and record buffers
into the audio_bufinfo structure.

these are being added to aid in porting non-native audio applications
and libraries, and to fix issues in our OSS audio emulation. these
ioctls exist only on OpenBSD and should not be used in code intended
for distribution.

ok ratchov

be explicit about configuring audio devices for full-duplex mode.

OK jmc@ (a while back)

implement the output_muted member of audio_info_t as found in original
Sun audio.

input from and ok ratchov

add missing description of AUDIO_PERROR ioctl

reviewed (and corrected) by jakemsr@

revert the change in rev 1.60 of audio.c and the corresponding
documentation change

the audio layer is still too "imperfect" for this change

fixes problems reported aanriot, matthieu and dtucker

requested by deraadt

- enable full-duplex mode by default if a device is opened
read-write and it supports full-duplex operation.
- update documentation to match this behaviour.

see http://marc.info/?l=openbsd-tech&m=118310788926431&w=2 for
more background on this change

"patches look correct to me" marc@

convert to new .Dd format;

Xr azalia (thanks miod)

seek is a count of bytes, not samples

OK millert@

more xr auipx i missed to commit first round

The audio(4) manpage says to use code that looks like
ioctl(fd, AUDIO_INITINFO, &info);
to initialize the audioinfo struct. This does not work as there
is no AUDIO_INITINFO ioctl command. Rather, the structure should be
initialized with something that looks like this:
AUDIO_INITINFO(&info);

From: Chris Kuethe <ckuethe at ualberta dot ca> in PR 3980

- sync to netbsd
- update to reality
- grammar, punctuation, rewording
- since this page describes both the mixer and audio devices,
add mention of the mixer device in relevant places
- use standard conventions for documenting ioctls
- macro and other mdoc fixes
- add some unmentioned audio devices and other cross-refs to
"see also"

help and ok jmc

and add kernel config usage to synopsis (from deraadt)

missing thing from Jared Yanovich;
dhartmeier@ saved me from making a mess of this;

- fix lists/displays
- quote .Cd's
- add/remove .Pp's as necessary
- fix some .Re/.Rs's
- simplify macros

- section reorder
- some macro fixes
- kill whitespace at EOL

AUDIO_ENCODING_* is below, not above the struct description
jason@ ok

mu-law and A-law spelling;
mu-law and u-law are the same, so used mu-law for consistency;

ok jason@

typos;

audio(4): ok naddy@
cardbus(4): ok deraadt@

audio_prinfo.seek is int now; document and sync
ok miod@ millert@

Do not end an enumerations of Xr with a dot, and do not let a dot hide
inside an enumeration as well.

Xr cleanup; seb@todesplanet.de

'SEE ALSO' audit in 'share/man/':
o) sort;
o) "," is separator of entries;
o) don't use "." or "," in the last entry;

millert@ ok

document the ESS Allegro-1 and Maestro-3 driver

fix style in .SYNOPSIS. Spotted by grange@grange.ru

deraadt@ ok

add autri.4, from netbsd

kill BUGS sections that basically say "there might be bugs". Like, WTF?

spelling

A slew of share/ man page fixes; nordin@cse.ogi.edu. These have been sitting
in my INBOX since Nov 6, 2000, probably forgot about them since the tree was
frozen at that time.

Driver for Cirrus Logic CS4281 sound chips. Originally written for NetBSD by
Tatoku Ogaito, banged into shape for OpenBSD by me. Recording has not been
tested yet, but mpg123 works fine. Sound still works after suspend/resume.

XXX: On the IBM ThinkPad X20, must disable pcibios else the cs4281 won't
generate interrupts. Cause yet unknown but probably not the driver's fault.
YMMV on other laptops with this chip.

Preliminary man page for maestro. Link it.
Keep alphabetical order in audio.4 while we're at it :)

move ich to auich at mickey's request

More complete synopsis, ok millert@,aaron@

- Arguments to .Nd should go on the same line as .Nd.
- Standardize Nd format for all Ethernet man pages for easy man -k'ing.

Purely mdoc fixes.

Xr pci audio drivers

xr audio(9)

buffersize -> buffer_size

- remove all trailing whitespace
* except when it is escaped with a `\' at the end of the line
- fix remaining .Nm usage as well
- this is from a patch I received from kwesterback@home.com, who has been
working on some scripts for fixing formatting errors in mdoc'd man pages

Ok, so there could be a cost/benefit debate with this commit, but since I have
the patch we might as well commit it...

more man page repairs; aaron@ug.cs.dal.ca

cross reference audioctl(1) and mixerctl(1), add info about mixer_level_t
which has been missing for all these years. augustss.

.Xr ossaudio 3

update man page to reality, from NetBSD, mostly by Lennart Augustsson
<augustss@cs.chalmers.se>.

fix includes and device names; netbsd pr#2523; jhawk@mit.edu

From NetBSD: merge of 960317

From NetBSD:
Fix typo, from John Kohl. Closes PR 2066.

generic audio man page; from jtk@kolvir.arlington.ma.us; netbsd pr#1752

some comma fixes; from varik valefor
(audio.4 tweaked from that submitted)

sort SEE ALSO;

move mixerctl and audioctl man pages to section 8, as these work
against root-only device nodes.

Remove references to the mixer device, rework control device section

Add the missing paragraph to explain that the control device may be
read. Add the missing .Xr to sndioctl and sioctl_open.

ok and tweaks jmc@

Mention ioctls that don't work for the control device.

ok jmc

Use english words instead of file names.

ok jmc

Remove obvious or repeating sentinces.

ok jmc

catch up with the symlink removal of /dev/{audio,mixer};
ok ratchov

cross reference sndio(7) and sndiod(8); from weerd@;
OK ratchov@ jmc@ (who are both busy)

Mention that only superuser may control record.enable knob.

help from and ok schwarze

Document the new "record.enable" mixer knob.

help from and ok schwarze

Remove reference to /dev/sound*. With tweaks from jmc@, thanks.

While /dev/audio is in use, /dev/audioctl has read-only access to
device variables.

Fix typo: replace AUDIO_GETINFO by AUDIO_GETPAR.

Delete unused ioctls and associated macros. Move macros that are still
used internally by low-level drivers from sys/audioio.h to
dev/audio_if.h instead of deleting them.

Add a new AUDIO_GETSTATUS ioctl to get various audio driver variables.
It's intended for use with diagnostic tools (like audioctl) and is of
no use to audio programs.

knock out unused Pp in previous;

Expose new audio ioctls that do one thing only: start and stop DMA,
set and get parameters. This is much simpler.

ok semarie, armani, tweaks from jmc

Add the AUDIO_GETPOS ioctl() to fetch a snapshot of the 4 counters
returned by AUDIO_GETxOFFS and AUDIO_xERROR ioctls.

ok deraadt

Remove sections that describe features we don't support any longer.

espie points out <string.h> is needed for the AUDIO_INITINFO() macro

Dv blah , Dv bleh
is more simply written as
Dv blah , bleh

audio(4) has nothing to do with <string.h>

wording fix; original diff from remco, but i've reworded it to read better
ok ratchov

add two new members to structs audio_encoding and audio_prinfo.
for both structs, the new members are 'bps' and 'msb', which
describe the number of bytes per sample and data alignment in the
sample, respectively. drivers must properly set these fields in
the 'query_encoding', 'set_parameters' and 'get_default_params'
hardware interface methods.

discussed with ratchov, deraadt

sync description of struct audio_prinfo;
reported by frederic, documentation/6179

fix a few typographical errors.

ok jmc@

typo fix - ok jakemsr - and add a comma;

deal with sample precisions that are not a power of 2.

discussed with and ok ratchov; manpage tweak from naddy, thanks

sa_open -> sio_open, after recent changes;

add some audio/libsa cross refs;

First pass at removing clauses 3 and 4 from NetBSD licenses.

Not sure what's more surprising: how long it took for NetBSD to
catch up to the rest of the BSDs (including UCB), or the amount of
code that NetBSD has claimed for itself without attributing to the
actual authors.

OK deraadt@

tweak previous;

explain why, even though we support "sticky" block sizes, setting block
sizes before other parameters can cause problems.

ok ratchov@

allow low level audio drivers to specify a default sample format,
instead of 8-bit mono mulaw @ 8kHz.

this is just the infrastructure; no drivers are specifying a default
yet.

ok ratchov@, deanna@

add audio(4) driver the ability to use different block sizes for play and
record modes. This makes possible to have blocks of the same duration if the
play and record formats are different. The API change is backward
compatible, so it shouldn't be noticed by current audio ports.

ok jakemsr

Remove incomplete device Xr list. The device pages already reference
audio(4), and the bus pages reference the devices, so there's no need
for audio(4) to try to keep up.

Requested by & ok jmc@

add aucat(1) and cdio(1) to SEE ALSO;

add new envy(4) man page

ok jmc@, ok deraadt@

explain that AUDIO_GET[PR]RINFO were added for porting 3rd party
software and should be avoided in new code

suggested by ratchov@, help from jmc@

add two new audio ioctls, AUDIO_GETPRINFO and AUDIO_GETRRINFO, and the
data structure these ioctls use, audio_bufinfo.

these ioctls return information about the play and record buffers
into the audio_bufinfo structure.

these are being added to aid in porting non-native audio applications
and libraries, and to fix issues in our OSS audio emulation. these
ioctls exist only on OpenBSD and should not be used in code intended
for distribution.

ok ratchov

be explicit about configuring audio devices for full-duplex mode.

OK jmc@ (a while back)

implement the output_muted member of audio_info_t as found in original
Sun audio.

input from and ok ratchov

add missing description of AUDIO_PERROR ioctl

reviewed (and corrected) by jakemsr@

revert the change in rev 1.60 of audio.c and the corresponding
documentation change

the audio layer is still too "imperfect" for this change

fixes problems reported aanriot, matthieu and dtucker

requested by deraadt

- enable full-duplex mode by default if a device is opened
read-write and it supports full-duplex operation.
- update documentation to match this behaviour.

see http://marc.info/?l=openbsd-tech&m=118310788926431&w=2 for
more background on this change

"patches look correct to me" marc@

convert to new .Dd format;

Xr azalia (thanks miod)

seek is a count of bytes, not samples

OK millert@

more xr auipx i missed to commit first round

The audio(4) manpage says to use code that looks like
ioctl(fd, AUDIO_INITINFO, &info);
to initialize the audioinfo struct. This does not work as there
is no AUDIO_INITINFO ioctl command. Rather, the structure should be
initialized with something that looks like this:
AUDIO_INITINFO(&info);

From: Chris Kuethe <ckuethe at ualberta dot ca> in PR 3980

- sync to netbsd
- update to reality
- grammar, punctuation, rewording
- since this page describes both the mixer and audio devices,
add mention of the mixer device in relevant places
- use standard conventions for documenting ioctls
- macro and other mdoc fixes
- add some unmentioned audio devices and other cross-refs to
"see also"

help and ok jmc

and add kernel config usage to synopsis (from deraadt)

missing thing from Jared Yanovich;
dhartmeier@ saved me from making a mess of this;

- fix lists/displays
- quote .Cd's
- add/remove .Pp's as necessary
- fix some .Re/.Rs's
- simplify macros

- section reorder
- some macro fixes
- kill whitespace at EOL

AUDIO_ENCODING_* is below, not above the struct description
jason@ ok

mu-law and A-law spelling;
mu-law and u-law are the same, so used mu-law for consistency;

ok jason@

typos;

audio(4): ok naddy@
cardbus(4): ok deraadt@

audio_prinfo.seek is int now; document and sync
ok miod@ millert@

Do not end an enumerations of Xr with a dot, and do not let a dot hide
inside an enumeration as well.

Xr cleanup; seb@todesplanet.de

'SEE ALSO' audit in 'share/man/':
o) sort;
o) "," is separator of entries;
o) don't use "." or "," in the last entry;

millert@ ok

document the ESS Allegro-1 and Maestro-3 driver

fix style in .SYNOPSIS. Spotted by grange@grange.ru

deraadt@ ok

add autri.4, from netbsd

kill BUGS sections that basically say "there might be bugs". Like, WTF?

spelling

A slew of share/ man page fixes; nordin@cse.ogi.edu. These have been sitting
in my INBOX since Nov 6, 2000, probably forgot about them since the tree was
frozen at that time.

Driver for Cirrus Logic CS4281 sound chips. Originally written for NetBSD by
Tatoku Ogaito, banged into shape for OpenBSD by me. Recording has not been
tested yet, but mpg123 works fine. Sound still works after suspend/resume.

XXX: On the IBM ThinkPad X20, must disable pcibios else the cs4281 won't
generate interrupts. Cause yet unknown but probably not the driver's fault.
YMMV on other laptops with this chip.

Preliminary man page for maestro. Link it.
Keep alphabetical order in audio.4 while we're at it :)

move ich to auich at mickey's request

More complete synopsis, ok millert@,aaron@

- Arguments to .Nd should go on the same line as .Nd.
- Standardize Nd format for all Ethernet man pages for easy man -k'ing.

Purely mdoc fixes.

Xr pci audio drivers

xr audio(9)

buffersize -> buffer_size

- remove all trailing whitespace
* except when it is escaped with a `\' at the end of the line
- fix remaining .Nm usage as well
- this is from a patch I received from kwesterback@home.com, who has been
working on some scripts for fixing formatting errors in mdoc'd man pages

Ok, so there could be a cost/benefit debate with this commit, but since I have
the patch we might as well commit it...

more man page repairs; aaron@ug.cs.dal.ca

cross reference audioctl(1) and mixerctl(1), add info about mixer_level_t
which has been missing for all these years. augustss.

.Xr ossaudio 3

update man page to reality, from NetBSD, mostly by Lennart Augustsson
<augustss@cs.chalmers.se>.

fix includes and device names; netbsd pr#2523; jhawk@mit.edu

From NetBSD: merge of 960317

From NetBSD:
Fix typo, from John Kohl. Closes PR 2066.

generic audio man page; from jtk@kolvir.arlington.ma.us; netbsd pr#1752

sort SEE ALSO;

move mixerctl and audioctl man pages to section 8, as these work
against root-only device nodes.

Remove references to the mixer device, rework control device section

Add the missing paragraph to explain that the control device may be
read. Add the missing .Xr to sndioctl and sioctl_open.

ok and tweaks jmc@

Mention ioctls that don't work for the control device.

ok jmc

Use english words instead of file names.

ok jmc

Remove obvious or repeating sentinces.

ok jmc

catch up with the symlink removal of /dev/{audio,mixer};
ok ratchov

cross reference sndio(7) and sndiod(8); from weerd@;
OK ratchov@ jmc@ (who are both busy)

Mention that only superuser may control record.enable knob.

help from and ok schwarze

Document the new "record.enable" mixer knob.

help from and ok schwarze

Remove reference to /dev/sound*. With tweaks from jmc@, thanks.

While /dev/audio is in use, /dev/audioctl has read-only access to
device variables.

Fix typo: replace AUDIO_GETINFO by AUDIO_GETPAR.

Delete unused ioctls and associated macros. Move macros that are still
used internally by low-level drivers from sys/audioio.h to
dev/audio_if.h instead of deleting them.

Add a new AUDIO_GETSTATUS ioctl to get various audio driver variables.
It's intended for use with diagnostic tools (like audioctl) and is of
no use to audio programs.

knock out unused Pp in previous;

Expose new audio ioctls that do one thing only: start and stop DMA,
set and get parameters. This is much simpler.

ok semarie, armani, tweaks from jmc

Add the AUDIO_GETPOS ioctl() to fetch a snapshot of the 4 counters
returned by AUDIO_GETxOFFS and AUDIO_xERROR ioctls.

ok deraadt

Remove sections that describe features we don't support any longer.

espie points out <string.h> is needed for the AUDIO_INITINFO() macro

Dv blah , Dv bleh
is more simply written as
Dv blah , bleh

audio(4) has nothing to do with <string.h>

wording fix; original diff from remco, but i've reworded it to read better
ok ratchov

add two new members to structs audio_encoding and audio_prinfo.
for both structs, the new members are 'bps' and 'msb', which
describe the number of bytes per sample and data alignment in the
sample, respectively. drivers must properly set these fields in
the 'query_encoding', 'set_parameters' and 'get_default_params'
hardware interface methods.

discussed with ratchov, deraadt

sync description of struct audio_prinfo;
reported by frederic, documentation/6179

fix a few typographical errors.

ok jmc@

typo fix - ok jakemsr - and add a comma;

deal with sample precisions that are not a power of 2.

discussed with and ok ratchov; manpage tweak from naddy, thanks

sa_open -> sio_open, after recent changes;

add some audio/libsa cross refs;

First pass at removing clauses 3 and 4 from NetBSD licenses.

Not sure what's more surprising: how long it took for NetBSD to
catch up to the rest of the BSDs (including UCB), or the amount of
code that NetBSD has claimed for itself without attributing to the
actual authors.

OK deraadt@

tweak previous;

explain why, even though we support "sticky" block sizes, setting block
sizes before other parameters can cause problems.

ok ratchov@

allow low level audio drivers to specify a default sample format,
instead of 8-bit mono mulaw @ 8kHz.

this is just the infrastructure; no drivers are specifying a default
yet.

ok ratchov@, deanna@

add audio(4) driver the ability to use different block sizes for play and
record modes. This makes possible to have blocks of the same duration if the
play and record formats are different. The API change is backward
compatible, so it shouldn't be noticed by current audio ports.

ok jakemsr

Remove incomplete device Xr list. The device pages already reference
audio(4), and the bus pages reference the devices, so there's no need
for audio(4) to try to keep up.

Requested by & ok jmc@

add aucat(1) and cdio(1) to SEE ALSO;

add new envy(4) man page

ok jmc@, ok deraadt@

explain that AUDIO_GET[PR]RINFO were added for porting 3rd party
software and should be avoided in new code

suggested by ratchov@, help from jmc@

add two new audio ioctls, AUDIO_GETPRINFO and AUDIO_GETRRINFO, and the
data structure these ioctls use, audio_bufinfo.

these ioctls return information about the play and record buffers
into the audio_bufinfo structure.

these are being added to aid in porting non-native audio applications
and libraries, and to fix issues in our OSS audio emulation. these
ioctls exist only on OpenBSD and should not be used in code intended
for distribution.

ok ratchov

be explicit about configuring audio devices for full-duplex mode.

OK jmc@ (a while back)

implement the output_muted member of audio_info_t as found in original
Sun audio.

input from and ok ratchov

add missing description of AUDIO_PERROR ioctl

reviewed (and corrected) by jakemsr@

revert the change in rev 1.60 of audio.c and the corresponding
documentation change

the audio layer is still too "imperfect" for this change

fixes problems reported aanriot, matthieu and dtucker

requested by deraadt

- enable full-duplex mode by default if a device is opened
read-write and it supports full-duplex operation.
- update documentation to match this behaviour.

see http://marc.info/?l=openbsd-tech&m=118310788926431&w=2 for
more background on this change

"patches look correct to me" marc@

convert to new .Dd format;

Xr azalia (thanks miod)

seek is a count of bytes, not samples

OK millert@

more xr auipx i missed to commit first round

The audio(4) manpage says to use code that looks like
ioctl(fd, AUDIO_INITINFO, &info);
to initialize the audioinfo struct. This does not work as there
is no AUDIO_INITINFO ioctl command. Rather, the structure should be
initialized with something that looks like this:
AUDIO_INITINFO(&info);

From: Chris Kuethe <ckuethe at ualberta dot ca> in PR 3980

- sync to netbsd
- update to reality
- grammar, punctuation, rewording
- since this page describes both the mixer and audio devices,
add mention of the mixer device in relevant places
- use standard conventions for documenting ioctls
- macro and other mdoc fixes
- add some unmentioned audio devices and other cross-refs to
"see also"

help and ok jmc

and add kernel config usage to synopsis (from deraadt)

missing thing from Jared Yanovich;
dhartmeier@ saved me from making a mess of this;

- fix lists/displays
- quote .Cd's
- add/remove .Pp's as necessary
- fix some .Re/.Rs's
- simplify macros

- section reorder
- some macro fixes
- kill whitespace at EOL

AUDIO_ENCODING_* is below, not above the struct description
jason@ ok

mu-law and A-law spelling;
mu-law and u-law are the same, so used mu-law for consistency;

ok jason@

typos;

audio(4): ok naddy@
cardbus(4): ok deraadt@

audio_prinfo.seek is int now; document and sync
ok miod@ millert@

Do not end an enumerations of Xr with a dot, and do not let a dot hide
inside an enumeration as well.

Xr cleanup; seb@todesplanet.de

'SEE ALSO' audit in 'share/man/':
o) sort;
o) "," is separator of entries;
o) don't use "." or "," in the last entry;

millert@ ok

document the ESS Allegro-1 and Maestro-3 driver

fix style in .SYNOPSIS. Spotted by grange@grange.ru

deraadt@ ok

add autri.4, from netbsd

kill BUGS sections that basically say "there might be bugs". Like, WTF?

spelling

A slew of share/ man page fixes; nordin@cse.ogi.edu. These have been sitting
in my INBOX since Nov 6, 2000, probably forgot about them since the tree was
frozen at that time.

Driver for Cirrus Logic CS4281 sound chips. Originally written for NetBSD by
Tatoku Ogaito, banged into shape for OpenBSD by me. Recording has not been
tested yet, but mpg123 works fine. Sound still works after suspend/resume.

XXX: On the IBM ThinkPad X20, must disable pcibios else the cs4281 won't
generate interrupts. Cause yet unknown but probably not the driver's fault.
YMMV on other laptops with this chip.

Preliminary man page for maestro. Link it.
Keep alphabetical order in audio.4 while we're at it :)

move ich to auich at mickey's request

More complete synopsis, ok millert@,aaron@

- Arguments to .Nd should go on the same line as .Nd.
- Standardize Nd format for all Ethernet man pages for easy man -k'ing.

Purely mdoc fixes.

Xr pci audio drivers

xr audio(9)

buffersize -> buffer_size

- remove all trailing whitespace
* except when it is escaped with a `\' at the end of the line
- fix remaining .Nm usage as well
- this is from a patch I received from kwesterback@home.com, who has been
working on some scripts for fixing formatting errors in mdoc'd man pages

Ok, so there could be a cost/benefit debate with this commit, but since I have
the patch we might as well commit it...

more man page repairs; aaron@ug.cs.dal.ca

cross reference audioctl(1) and mixerctl(1), add info about mixer_level_t
which has been missing for all these years. augustss.

.Xr ossaudio 3

update man page to reality, from NetBSD, mostly by Lennart Augustsson
<augustss@cs.chalmers.se>.

fix includes and device names; netbsd pr#2523; jhawk@mit.edu

From NetBSD: merge of 960317

From NetBSD:
Fix typo, from John Kohl. Closes PR 2066.

generic audio man page; from jtk@kolvir.arlington.ma.us; netbsd pr#1752

Remove references to the mixer device, rework control device section

Add the missing paragraph to explain that the control device may be
read. Add the missing .Xr to sndioctl and sioctl_open.

ok and tweaks jmc@

Mention ioctls that don't work for the control device.

ok jmc

Use english words instead of file names.

ok jmc

Remove obvious or repeating sentinces.

ok jmc

catch up with the symlink removal of /dev/{audio,mixer};
ok ratchov

cross reference sndio(7) and sndiod(8); from weerd@;
OK ratchov@ jmc@ (who are both busy)

Mention that only superuser may control record.enable knob.

help from and ok schwarze

Document the new "record.enable" mixer knob.

help from and ok schwarze

Remove reference to /dev/sound*. With tweaks from jmc@, thanks.

While /dev/audio is in use, /dev/audioctl has read-only access to
device variables.

Fix typo: replace AUDIO_GETINFO by AUDIO_GETPAR.

Delete unused ioctls and associated macros. Move macros that are still
used internally by low-level drivers from sys/audioio.h to
dev/audio_if.h instead of deleting them.

Add a new AUDIO_GETSTATUS ioctl to get various audio driver variables.
It's intended for use with diagnostic tools (like audioctl) and is of
no use to audio programs.

knock out unused Pp in previous;

Expose new audio ioctls that do one thing only: start and stop DMA,
set and get parameters. This is much simpler.

ok semarie, armani, tweaks from jmc

Add the AUDIO_GETPOS ioctl() to fetch a snapshot of the 4 counters
returned by AUDIO_GETxOFFS and AUDIO_xERROR ioctls.

ok deraadt

Remove sections that describe features we don't support any longer.

espie points out <string.h> is needed for the AUDIO_INITINFO() macro

Dv blah , Dv bleh
is more simply written as
Dv blah , bleh

audio(4) has nothing to do with <string.h>

wording fix; original diff from remco, but i've reworded it to read better
ok ratchov

add two new members to structs audio_encoding and audio_prinfo.
for both structs, the new members are 'bps' and 'msb', which
describe the number of bytes per sample and data alignment in the
sample, respectively. drivers must properly set these fields in
the 'query_encoding', 'set_parameters' and 'get_default_params'
hardware interface methods.

discussed with ratchov, deraadt

sync description of struct audio_prinfo;
reported by frederic, documentation/6179

fix a few typographical errors.

ok jmc@

typo fix - ok jakemsr - and add a comma;

deal with sample precisions that are not a power of 2.

discussed with and ok ratchov; manpage tweak from naddy, thanks

sa_open -> sio_open, after recent changes;

add some audio/libsa cross refs;

First pass at removing clauses 3 and 4 from NetBSD licenses.

Not sure what's more surprising: how long it took for NetBSD to
catch up to the rest of the BSDs (including UCB), or the amount of
code that NetBSD has claimed for itself without attributing to the
actual authors.

OK deraadt@

tweak previous;

explain why, even though we support "sticky" block sizes, setting block
sizes before other parameters can cause problems.

ok ratchov@

allow low level audio drivers to specify a default sample format,
instead of 8-bit mono mulaw @ 8kHz.

this is just the infrastructure; no drivers are specifying a default
yet.

ok ratchov@, deanna@

add audio(4) driver the ability to use different block sizes for play and
record modes. This makes possible to have blocks of the same duration if the
play and record formats are different. The API change is backward
compatible, so it shouldn't be noticed by current audio ports.

ok jakemsr

Remove incomplete device Xr list. The device pages already reference
audio(4), and the bus pages reference the devices, so there's no need
for audio(4) to try to keep up.

Requested by & ok jmc@

add aucat(1) and cdio(1) to SEE ALSO;

add new envy(4) man page

ok jmc@, ok deraadt@

explain that AUDIO_GET[PR]RINFO were added for porting 3rd party
software and should be avoided in new code

suggested by ratchov@, help from jmc@

add two new audio ioctls, AUDIO_GETPRINFO and AUDIO_GETRRINFO, and the
data structure these ioctls use, audio_bufinfo.

these ioctls return information about the play and record buffers
into the audio_bufinfo structure.

these are being added to aid in porting non-native audio applications
and libraries, and to fix issues in our OSS audio emulation. these
ioctls exist only on OpenBSD and should not be used in code intended
for distribution.

ok ratchov

be explicit about configuring audio devices for full-duplex mode.

OK jmc@ (a while back)

implement the output_muted member of audio_info_t as found in original
Sun audio.

input from and ok ratchov

add missing description of AUDIO_PERROR ioctl

reviewed (and corrected) by jakemsr@

revert the change in rev 1.60 of audio.c and the corresponding
documentation change

the audio layer is still too "imperfect" for this change

fixes problems reported aanriot, matthieu and dtucker

requested by deraadt

- enable full-duplex mode by default if a device is opened
read-write and it supports full-duplex operation.
- update documentation to match this behaviour.

see http://marc.info/?l=openbsd-tech&m=118310788926431&w=2 for
more background on this change

"patches look correct to me" marc@

convert to new .Dd format;

Xr azalia (thanks miod)

seek is a count of bytes, not samples

OK millert@

more xr auipx i missed to commit first round

The audio(4) manpage says to use code that looks like
ioctl(fd, AUDIO_INITINFO, &info);
to initialize the audioinfo struct. This does not work as there
is no AUDIO_INITINFO ioctl command. Rather, the structure should be
initialized with something that looks like this:
AUDIO_INITINFO(&info);

From: Chris Kuethe <ckuethe at ualberta dot ca> in PR 3980

- sync to netbsd
- update to reality
- grammar, punctuation, rewording
- since this page describes both the mixer and audio devices,
add mention of the mixer device in relevant places
- use standard conventions for documenting ioctls
- macro and other mdoc fixes
- add some unmentioned audio devices and other cross-refs to
"see also"

help and ok jmc

and add kernel config usage to synopsis (from deraadt)

missing thing from Jared Yanovich;
dhartmeier@ saved me from making a mess of this;

- fix lists/displays
- quote .Cd's
- add/remove .Pp's as necessary
- fix some .Re/.Rs's
- simplify macros

- section reorder
- some macro fixes
- kill whitespace at EOL

AUDIO_ENCODING_* is below, not above the struct description
jason@ ok

mu-law and A-law spelling;
mu-law and u-law are the same, so used mu-law for consistency;

ok jason@

typos;

audio(4): ok naddy@
cardbus(4): ok deraadt@

audio_prinfo.seek is int now; document and sync
ok miod@ millert@

Do not end an enumerations of Xr with a dot, and do not let a dot hide
inside an enumeration as well.

Xr cleanup; seb@todesplanet.de

'SEE ALSO' audit in 'share/man/':
o) sort;
o) "," is separator of entries;
o) don't use "." or "," in the last entry;

millert@ ok

document the ESS Allegro-1 and Maestro-3 driver

fix style in .SYNOPSIS. Spotted by grange@grange.ru

deraadt@ ok

add autri.4, from netbsd

kill BUGS sections that basically say "there might be bugs". Like, WTF?

spelling

A slew of share/ man page fixes; nordin@cse.ogi.edu. These have been sitting
in my INBOX since Nov 6, 2000, probably forgot about them since the tree was
frozen at that time.

Driver for Cirrus Logic CS4281 sound chips. Originally written for NetBSD by
Tatoku Ogaito, banged into shape for OpenBSD by me. Recording has not been
tested yet, but mpg123 works fine. Sound still works after suspend/resume.

XXX: On the IBM ThinkPad X20, must disable pcibios else the cs4281 won't
generate interrupts. Cause yet unknown but probably not the driver's fault.
YMMV on other laptops with this chip.

Preliminary man page for maestro. Link it.
Keep alphabetical order in audio.4 while we're at it :)

move ich to auich at mickey's request

More complete synopsis, ok millert@,aaron@

- Arguments to .Nd should go on the same line as .Nd.
- Standardize Nd format for all Ethernet man pages for easy man -k'ing.

Purely mdoc fixes.

Xr pci audio drivers

xr audio(9)

buffersize -> buffer_size

- remove all trailing whitespace
* except when it is escaped with a `\' at the end of the line
- fix remaining .Nm usage as well
- this is from a patch I received from kwesterback@home.com, who has been
working on some scripts for fixing formatting errors in mdoc'd man pages

Ok, so there could be a cost/benefit debate with this commit, but since I have
the patch we might as well commit it...

more man page repairs; aaron@ug.cs.dal.ca

cross reference audioctl(1) and mixerctl(1), add info about mixer_level_t
which has been missing for all these years. augustss.

.Xr ossaudio 3

update man page to reality, from NetBSD, mostly by Lennart Augustsson
<augustss@cs.chalmers.se>.

fix includes and device names; netbsd pr#2523; jhawk@mit.edu

From NetBSD: merge of 960317

From NetBSD:
Fix typo, from John Kohl. Closes PR 2066.

generic audio man page; from jtk@kolvir.arlington.ma.us; netbsd pr#1752

Mention ioctls that don't work for the control device.

ok jmc

Use english words instead of file names.

ok jmc

Remove obvious or repeating sentinces.

ok jmc

catch up with the symlink removal of /dev/{audio,mixer};
ok ratchov

cross reference sndio(7) and sndiod(8); from weerd@;
OK ratchov@ jmc@ (who are both busy)

Mention that only superuser may control record.enable knob.

help from and ok schwarze

Document the new "record.enable" mixer knob.

help from and ok schwarze

Remove reference to /dev/sound*. With tweaks from jmc@, thanks.

While /dev/audio is in use, /dev/audioctl has read-only access to
device variables.

Fix typo: replace AUDIO_GETINFO by AUDIO_GETPAR.

Delete unused ioctls and associated macros. Move macros that are still
used internally by low-level drivers from sys/audioio.h to
dev/audio_if.h instead of deleting them.

Add a new AUDIO_GETSTATUS ioctl to get various audio driver variables.
It's intended for use with diagnostic tools (like audioctl) and is of
no use to audio programs.

knock out unused Pp in previous;

Expose new audio ioctls that do one thing only: start and stop DMA,
set and get parameters. This is much simpler.

ok semarie, armani, tweaks from jmc

Add the AUDIO_GETPOS ioctl() to fetch a snapshot of the 4 counters
returned by AUDIO_GETxOFFS and AUDIO_xERROR ioctls.

ok deraadt

Remove sections that describe features we don't support any longer.

espie points out <string.h> is needed for the AUDIO_INITINFO() macro

Dv blah , Dv bleh
is more simply written as
Dv blah , bleh

audio(4) has nothing to do with <string.h>

wording fix; original diff from remco, but i've reworded it to read better
ok ratchov

add two new members to structs audio_encoding and audio_prinfo.
for both structs, the new members are 'bps' and 'msb', which
describe the number of bytes per sample and data alignment in the
sample, respectively. drivers must properly set these fields in
the 'query_encoding', 'set_parameters' and 'get_default_params'
hardware interface methods.

discussed with ratchov, deraadt

sync description of struct audio_prinfo;
reported by frederic, documentation/6179

fix a few typographical errors.

ok jmc@

typo fix - ok jakemsr - and add a comma;

deal with sample precisions that are not a power of 2.

discussed with and ok ratchov; manpage tweak from naddy, thanks

sa_open -> sio_open, after recent changes;

add some audio/libsa cross refs;

First pass at removing clauses 3 and 4 from NetBSD licenses.

Not sure what's more surprising: how long it took for NetBSD to
catch up to the rest of the BSDs (including UCB), or the amount of
code that NetBSD has claimed for itself without attributing to the
actual authors.

OK deraadt@

tweak previous;

explain why, even though we support "sticky" block sizes, setting block
sizes before other parameters can cause problems.

ok ratchov@

allow low level audio drivers to specify a default sample format,
instead of 8-bit mono mulaw @ 8kHz.

this is just the infrastructure; no drivers are specifying a default
yet.

ok ratchov@, deanna@

add audio(4) driver the ability to use different block sizes for play and
record modes. This makes possible to have blocks of the same duration if the
play and record formats are different. The API change is backward
compatible, so it shouldn't be noticed by current audio ports.

ok jakemsr

Remove incomplete device Xr list. The device pages already reference
audio(4), and the bus pages reference the devices, so there's no need
for audio(4) to try to keep up.

Requested by & ok jmc@

add aucat(1) and cdio(1) to SEE ALSO;

add new envy(4) man page

ok jmc@, ok deraadt@

explain that AUDIO_GET[PR]RINFO were added for porting 3rd party
software and should be avoided in new code

suggested by ratchov@, help from jmc@

add two new audio ioctls, AUDIO_GETPRINFO and AUDIO_GETRRINFO, and the
data structure these ioctls use, audio_bufinfo.

these ioctls return information about the play and record buffers
into the audio_bufinfo structure.

these are being added to aid in porting non-native audio applications
and libraries, and to fix issues in our OSS audio emulation. these
ioctls exist only on OpenBSD and should not be used in code intended
for distribution.

ok ratchov

be explicit about configuring audio devices for full-duplex mode.

OK jmc@ (a while back)

implement the output_muted member of audio_info_t as found in original
Sun audio.

input from and ok ratchov

add missing description of AUDIO_PERROR ioctl

reviewed (and corrected) by jakemsr@

revert the change in rev 1.60 of audio.c and the corresponding
documentation change

the audio layer is still too "imperfect" for this change

fixes problems reported aanriot, matthieu and dtucker

requested by deraadt

- enable full-duplex mode by default if a device is opened
read-write and it supports full-duplex operation.
- update documentation to match this behaviour.

see http://marc.info/?l=openbsd-tech&m=118310788926431&w=2 for
more background on this change

"patches look correct to me" marc@

convert to new .Dd format;

Xr azalia (thanks miod)

seek is a count of bytes, not samples

OK millert@

more xr auipx i missed to commit first round

The audio(4) manpage says to use code that looks like
ioctl(fd, AUDIO_INITINFO, &info);
to initialize the audioinfo struct. This does not work as there
is no AUDIO_INITINFO ioctl command. Rather, the structure should be
initialized with something that looks like this:
AUDIO_INITINFO(&info);

From: Chris Kuethe <ckuethe at ualberta dot ca> in PR 3980

- sync to netbsd
- update to reality
- grammar, punctuation, rewording
- since this page describes both the mixer and audio devices,
add mention of the mixer device in relevant places
- use standard conventions for documenting ioctls
- macro and other mdoc fixes
- add some unmentioned audio devices and other cross-refs to
"see also"

help and ok jmc

and add kernel config usage to synopsis (from deraadt)

missing thing from Jared Yanovich;
dhartmeier@ saved me from making a mess of this;

- fix lists/displays
- quote .Cd's
- add/remove .Pp's as necessary
- fix some .Re/.Rs's
- simplify macros

- section reorder
- some macro fixes
- kill whitespace at EOL

AUDIO_ENCODING_* is below, not above the struct description
jason@ ok

mu-law and A-law spelling;
mu-law and u-law are the same, so used mu-law for consistency;

ok jason@

typos;

audio(4): ok naddy@
cardbus(4): ok deraadt@

audio_prinfo.seek is int now; document and sync
ok miod@ millert@

Do not end an enumerations of Xr with a dot, and do not let a dot hide
inside an enumeration as well.

Xr cleanup; seb@todesplanet.de

'SEE ALSO' audit in 'share/man/':
o) sort;
o) "," is separator of entries;
o) don't use "." or "," in the last entry;

millert@ ok

document the ESS Allegro-1 and Maestro-3 driver

fix style in .SYNOPSIS. Spotted by grange@grange.ru

deraadt@ ok

add autri.4, from netbsd

kill BUGS sections that basically say "there might be bugs". Like, WTF?

spelling

A slew of share/ man page fixes; nordin@cse.ogi.edu. These have been sitting
in my INBOX since Nov 6, 2000, probably forgot about them since the tree was
frozen at that time.

Driver for Cirrus Logic CS4281 sound chips. Originally written for NetBSD by
Tatoku Ogaito, banged into shape for OpenBSD by me. Recording has not been
tested yet, but mpg123 works fine. Sound still works after suspend/resume.

XXX: On the IBM ThinkPad X20, must disable pcibios else the cs4281 won't
generate interrupts. Cause yet unknown but probably not the driver's fault.
YMMV on other laptops with this chip.

Preliminary man page for maestro. Link it.
Keep alphabetical order in audio.4 while we're at it :)

move ich to auich at mickey's request

More complete synopsis, ok millert@,aaron@

- Arguments to .Nd should go on the same line as .Nd.
- Standardize Nd format for all Ethernet man pages for easy man -k'ing.

Purely mdoc fixes.

Xr pci audio drivers

xr audio(9)

buffersize -> buffer_size

- remove all trailing whitespace
* except when it is escaped with a `\' at the end of the line
- fix remaining .Nm usage as well
- this is from a patch I received from kwesterback@home.com, who has been
working on some scripts for fixing formatting errors in mdoc'd man pages

Ok, so there could be a cost/benefit debate with this commit, but since I have
the patch we might as well commit it...

more man page repairs; aaron@ug.cs.dal.ca

cross reference audioctl(1) and mixerctl(1), add info about mixer_level_t
which has been missing for all these years. augustss.

.Xr ossaudio 3

update man page to reality, from NetBSD, mostly by Lennart Augustsson
<augustss@cs.chalmers.se>.

fix includes and device names; netbsd pr#2523; jhawk@mit.edu

From NetBSD: merge of 960317

From NetBSD:
Fix typo, from John Kohl. Closes PR 2066.

generic audio man page; from jtk@kolvir.arlington.ma.us; netbsd pr#1752

Mention that only superuser may control record.enable knob.

help from and ok schwarze

Document the new "record.enable" mixer knob.

help from and ok schwarze

Remove reference to /dev/sound*. With tweaks from jmc@, thanks.

While /dev/audio is in use, /dev/audioctl has read-only access to
device variables.

Fix typo: replace AUDIO_GETINFO by AUDIO_GETPAR.

Delete unused ioctls and associated macros. Move macros that are still
used internally by low-level drivers from sys/audioio.h to
dev/audio_if.h instead of deleting them.

Add a new AUDIO_GETSTATUS ioctl to get various audio driver variables.
It's intended for use with diagnostic tools (like audioctl) and is of
no use to audio programs.

knock out unused Pp in previous;

Expose new audio ioctls that do one thing only: start and stop DMA,
set and get parameters. This is much simpler.

ok semarie, armani, tweaks from jmc

Add the AUDIO_GETPOS ioctl() to fetch a snapshot of the 4 counters
returned by AUDIO_GETxOFFS and AUDIO_xERROR ioctls.

ok deraadt