From 7ffba875a0c7cf118aef7a2c9bfd00c3935e230a Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sat, 19 Mar 2011 16:59:43 -0700 Subject: [PATCH] 820 audioemu10k(7D) manual page needed 809 need a new audioctl(1) 838 MHIOC_CLEAR is implemented now 839 Prototype updates for 2011. 840 Need audiocmihd(7d) man page Reviewed by: Rich Lowe Reviewed by: Kartik Mistry Reviewed by: Jason King Reviewed by: Albert Lee Approved by: Rich Lowe --- usr/src/man/man1/Makefile | 1 + usr/src/man/man1/audioctl.1 | 177 ++++++++++++++++++++++ usr/src/man/man7d/Makefile | 2 + usr/src/man/man7d/audiocmihd.7d | 66 ++++++++ usr/src/man/man7d/audioemu10k.7d | 69 +++++++++ usr/src/man/man7i/mhd.7i | 3 +- usr/src/pkg/manifests/audio-audio-utilities.mf | 2 + usr/src/pkg/manifests/driver-audio-audiocmihd.mf | 5 +- usr/src/pkg/manifests/driver-audio-audioemu10k.mf | 7 + usr/src/prototypes/prototype.Makefile | 2 +- usr/src/prototypes/prototype.c | 2 +- usr/src/prototypes/prototype.csh | 2 +- usr/src/prototypes/prototype.h | 2 +- usr/src/prototypes/prototype.java | 2 +- usr/src/prototypes/prototype.ksh | 2 +- usr/src/prototypes/prototype.man | 3 +- usr/src/prototypes/prototype.mapfile-vers | 2 +- usr/src/prototypes/prototype.pl | 2 +- usr/src/prototypes/prototype.py | 2 +- usr/src/prototypes/prototype.s | 2 +- usr/src/prototypes/prototype.sh | 2 +- 21 files changed, 342 insertions(+), 15 deletions(-) create mode 100644 usr/src/man/man1/audioctl.1 create mode 100644 usr/src/man/man7d/audiocmihd.7d create mode 100644 usr/src/man/man7d/audioemu10k.7d diff --git a/usr/src/man/man1/Makefile b/usr/src/man/man1/Makefile index 53c33b678a..a4175a084c 100644 --- a/usr/src/man/man1/Makefile +++ b/usr/src/man/man1/Makefile @@ -31,6 +31,7 @@ MANFILES= acctcom.1 \ atq.1 \ atrm.1 \ audioconvert.1 \ + audioctl.1 \ audioplay.1 \ audiorecord.1 \ audiotest.1 \ diff --git a/usr/src/man/man1/audioctl.1 b/usr/src/man/man1/audioctl.1 new file mode 100644 index 0000000000..b8a9d23490 --- /dev/null +++ b/usr/src/man/man1/audioctl.1 @@ -0,0 +1,177 @@ +'\" t +.\" +.\" This file and its contents are supplied under the terms of the +.\" Common Development and Distribution License ("CDDL"), version 1.0. +.\" You may only use this file in accordance with the terms of version +.\" 1.0 of the CDDL. +.\" +.\" A full copy of the text of the CDDL should have accompanied this +.\" source. A copy of the CDDL is also available via the Internet at +.\" http://www.illumos.org/license/CDDL. +.\" +.\" +.\" Copyright 2011 Nexenta Systems, Inc. All rights reserved. +.\" +.TH audioctl 1 "18 Mar 2011" "SunOS 5.11" "User Commands" +.SH NAME +audioctl - audio device control command line interface +.SH SYNOPSIS +.LP +.nf +\fBaudioctl\fR \fBlist-devices\fR +.fi + +.LP +.nf +\fBaudioctl\fR \fBshow-device\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR] +.fi + +.LP +.nf +\fBaudioctl\fR \fBshow-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fB] [\fIcontrol\fR ...] +.fi + +.LP +.nf +\fBaudioctl\fR \fBset-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fB] \fIcontrol\fR \fIvalue\fR +.fi + +.LP +.nf +\fBaudioctl\fR \fBsave-controls\fR [\fB-d\fR \fIdevice\fB] [\fB-f\fR] \fIfile\fR +.fi + +.LP +.nf +\fBaudioctl\fR \fBload-controls\fR [\fB-d\fR \fIdevice\fB] \fIfile\fR +.fi + +.SH DESCRIPTION +The \fBaudioctl\fP command is used to control various settings and features +of audio devices, including mixer settings such as playback volume and +record gain. +.LP + +.SH SUBCOMMANDS +The \fRaudioctl\fB command supports the following subcommands. +.sp +.ne 2 +.mk +.na +\fBlist-devices\fR +.ad +.sp .6 +.RS 4n +List all the audio devices on the system. +.RE + +.sp +.ne 2 +.mk +.na +\fBshow-device\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR] [\fBcontrol\fR ... ] +.ad +.sp .6 +.RS 4n +Display an informational overview of \fIdevice\fR (or the default device if +not specified). If the \fB-v\fR option is specified, then more detail +will be displayed. +.RE + +.sp +.ne 2 +.mk +.na +\fBshow-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR] +.ad +.sp .6 +.RS 4n +Display the control settings for one or more \fIcontrols\fR of a +\fIdevice\fR (or the default device if not specified). If no \fIcontrol\fR is +specified, then the settings for all controls will be displayed. If +the \fB-v\fR option is specified, then more detail will be displayed. +.RE + +.sp +.ne 2 +.mk +.na +\fBset-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fB] \fIcontrol\fR \fIvalue\fR +.ad +.sp .6 +.RS 4n +Set the control settings for a \fIcontrol\fR of a \fIdevice\fR (or the +default device if not specified) to \fIvalue\fR. If the \fB-v\fR +option is specified, then more verbose output be displayed. +.RE + +.sp +.ne 2 +.mk +.na +\fBsave-controls\fR [\fB-f\fR] [\fB-d\fR \fIdevice\fB] \fIfile\fR +.ad +.sp .6 +.RS 4n +Save all control settings of the \fIdevice\fR (or the default device if not +specified) to the named \fIfile\fR. This subcommand will not replace +or modify an existing file unless \fB-f\fR (force) is specified. +.RE + +.sp +.ne 2 +.mk +.na +\fBload-controls\fR [\fB-d\fR \fIdevice\fB] \fIfile\fR +.ad +.sp .6 +.RS 4n +Load previously saved control settings from a \fIfile\fR +into a \fIdevice\fR (or all audio devices if not +specified). +.RE + +.SH ENVIRONMENT VARIABLES +.sp +.sp +.ne 2 +.mk +.na +\fB\fBAUDIODEV\fR\fR +.ad +.RS 12n +.rt +The full path name of the default audio device to use if on +is not specified on the command line. If this variable is not set, +\fB/dev/audio\fR is used. +.RE + + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilitySee below. +.TE +.LP +The \fBaudioctl\fR command and its subcommands are Committed. The +names of controls, their values, and device names are Uncommitted. +The display output is intended for human consumption, and is Not An +Interface. The format of the state files used by the +\fBsave-controls\fR and \fBload-controls\fR subcommands is Committed +Private. +.LP + +.SH SEE ALSO +\fBaudioplay\fR(1), \fBaudiorecord\fR(1), \fBdsp\fR(7I), +\fBmixer\fR(7I), \fBattributes\fR(5) diff --git a/usr/src/man/man7d/Makefile b/usr/src/man/man7d/Makefile index a3eb855c6c..b32a22ef5c 100644 --- a/usr/src/man/man7d/Makefile +++ b/usr/src/man/man7d/Makefile @@ -195,6 +195,8 @@ i386_MANFILES = ahci.7d \ atu.7d \ audio810.7d \ audiocmi.7d \ + audiocmihd.7d \ + audioemu10k.7d \ audiohd.7d \ audioixp.7d \ audiosolo.7d \ diff --git a/usr/src/man/man7d/audiocmihd.7d b/usr/src/man/man7d/audiocmihd.7d new file mode 100644 index 0000000000..19b4b78db5 --- /dev/null +++ b/usr/src/man/man7d/audiocmihd.7d @@ -0,0 +1,66 @@ +'\" t +.\" This file and its contents are supplied under the terms of the +.\" Common Development and Distribution License ("CDDL"), version 1.0. +.\" You may only use this file in accordance with the terms of version +.\" 1.0 of the CDDL. +.\" +.\" A full copy of the text of the CDDL should have accompanied this +.\" source. A copy of the CDDL is also available via the Internet at +.\" http://www.illumos.org/license/CDDL. +.\" +.\" +.\" Copyright 2011 Nexenta Systems, Inc. All rights reserved. +.\" +.TH audiocmihd 7D "18 Mar 2011" "SunOS 5.11" "Devices" +.SH NAME +audiocmihd \- CMI8788 HD audio driver +.SH DESCRIPTION +.sp +.LP +The \fBaudiocmihd\fR driver provides support for audio devices based on +the CMedia 8788 and similar parts. Most often these are seen in +devices sold under the Asus Xonar brand. +.SH FILES +.sp +.ne 2 +.mk +.na +\fB/kernel/drv/audiocmihd\fR +.ad +.sp .6 +.RS 4n +32-bit kernel module +.RE + +.sp +.ne 2 +.mk +.na +\fB/kernel/drv/amd64/audiocmihd\fR +.ad +.sp .6 +.RS 4n +64-bit kernel module +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(0i) |cw(5.5i) +lw(0i) |lw(5.5i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Architecturex86 +.TE + +.SH SEE ALSO +.sp +.LP +\fBattributes\fR(5), \fBaudio\fR(7I), \fBdsp\fR(7I), \fBmixer\fR(7I) diff --git a/usr/src/man/man7d/audioemu10k.7d b/usr/src/man/man7d/audioemu10k.7d new file mode 100644 index 0000000000..2c5fd0cbcd --- /dev/null +++ b/usr/src/man/man7d/audioemu10k.7d @@ -0,0 +1,69 @@ +'\" t +.\" This file and its contents are supplied under the terms of the +.\" Common Development and Distribution License ("CDDL"), version 1.0. +.\" You may only use this file in accordance with the terms of version +.\" 1.0 of the CDDL. +.\" +.\" A full copy of the text of the CDDL should have accompanied this +.\" source. A copy of the CDDL is also available via the Internet at +.\" http://www.illumos.org/license/CDDL. +.\" +.\" +.\" Copyright 2011 Nexenta Systems, Inc. All rights reserved. +.\" +.TH audioemu10k 7D "18 Mar 2011" "SunOS 5.11" "Devices" +.SH NAME +audioemu10k \- EMU10K audio driver +.SH DESCRIPTION +.sp +.LP +The \fBaudioemu10\fR driver provides support for audio devices based on +the Creative EMU10K1 and EMU10K2 chips. Most often these are seen in +devices sold under the Audigy or Sound Blaster Live! brand names. +.LP +The \fBaudioemu10k\fR driver provides support for surround sound and +SPDIF features on devices with such capabilities. +.SH FILES +.sp +.ne 2 +.mk +.na +\fB/kernel/drv/audioemu10k\fR +.ad +.sp .6 +.RS 4n +32-bit kernel module +.RE + +.sp +.ne 2 +.mk +.na +\fB/kernel/drv/amd64/audioemu10k\fR +.ad +.sp .6 +.RS 4n +64-bit kernel module +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(0i) |cw(5.5i) +lw(0i) |lw(5.5i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Architecturex86 +.TE + +.SH SEE ALSO +.sp +.LP +\fBattributes\fR(5), \fBaudio\fR(7I), \fBdsp\fR(7I), \fBmixer\fR(7I) diff --git a/usr/src/man/man7i/mhd.7i b/usr/src/man/man7i/mhd.7i index d2a4a01a1f..fc990cd6bb 100644 --- a/usr/src/man/man7i/mhd.7i +++ b/usr/src/man/man7i/mhd.7i @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH mhd 7i "1 Sep 2005" "SunOS 5.11" "Ioctl Requests" +.TH mhd 7i "18 Mar 2011" "SunOS 5.11" "Ioctl Requests" .SH NAME mhd \- multihost disk control operations .SH SYNOPSIS @@ -292,7 +292,6 @@ implemented). Issues the SCSI-3 command Persistent Reserve Out Clear. The input parameter \fIr\fR is the reservation key of the caller, which should have been already registered with the device, by an earlier call to \fBMHIOCGRP_REGISTER\fR. -(Note: This command is not implemented). .RE .sp diff --git a/usr/src/pkg/manifests/audio-audio-utilities.mf b/usr/src/pkg/manifests/audio-audio-utilities.mf index 76a572ce0e..a731e2ff45 100644 --- a/usr/src/pkg/manifests/audio-audio-utilities.mf +++ b/usr/src/pkg/manifests/audio-audio-utilities.mf @@ -21,6 +21,7 @@ # # Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved. +# Copyright 2011 Nexenta Systems, Inc. All rights reserved. # set name=pkg.fmri value=pkg:/audio/audio-utilities@$(PKGVERS) @@ -37,6 +38,7 @@ file path=usr/bin/audioplay mode=0555 file path=usr/bin/audiorecord mode=0555 file path=usr/bin/audiotest mode=0555 file path=usr/share/man/man1/audioconvert.1 +file path=usr/share/man/man1/audioctl.1 file path=usr/share/man/man1/audioplay.1 file path=usr/share/man/man1/audiorecord.1 file path=usr/share/man/man1/audiotest.1 diff --git a/usr/src/pkg/manifests/driver-audio-audiocmihd.mf b/usr/src/pkg/manifests/driver-audio-audiocmihd.mf index 27e0b23557..63d701f49f 100644 --- a/usr/src/pkg/manifests/driver-audio-audiocmihd.mf +++ b/usr/src/pkg/manifests/driver-audio-audiocmihd.mf @@ -41,7 +41,10 @@ set name=variant.arch value=i386 dir path=kernel group=sys dir path=kernel/drv group=sys dir path=kernel/drv/$(ARCH64) group=sys +dir path=usr/share/man +dir path=usr/share/man/man7d driver name=audiocmihd alias=pci13f6,8788 file path=kernel/drv/$(ARCH64)/audiocmihd group=sys -file path=kernel/drv/audiocmihd group=sys +$(i386_ONLY)file path=kernel/drv/audiocmihd group=sys +file path=usr/share/man/man7d/audiocmihd.7d license lic_CDDL license=lic_CDDL diff --git a/usr/src/pkg/manifests/driver-audio-audioemu10k.mf b/usr/src/pkg/manifests/driver-audio-audioemu10k.mf index 85474680b4..3587a868f8 100644 --- a/usr/src/pkg/manifests/driver-audio-audioemu10k.mf +++ b/usr/src/pkg/manifests/driver-audio-audioemu10k.mf @@ -24,6 +24,10 @@ # # +# Copyright 2011 Nexenta Systems, Inc. +# + +# # The default for payload-bearing actions in this package is to appear in the # global zone only. See the include file for greater detail, as well as # information about overriding the defaults. @@ -37,12 +41,15 @@ set name=variant.arch value=i386 dir path=kernel group=sys dir path=kernel/drv group=sys dir path=kernel/drv/$(ARCH64) group=sys +dir path=usr/share/man +dir path=usr/share/man/man7d driver name=audioemu10k \ alias=pci1102,2 \ alias=pci1102,4 \ alias=pci1102,8 file path=kernel/drv/$(ARCH64)/audioemu10k group=sys file path=kernel/drv/audioemu10k group=sys +file path=usr/share/man/man7d/audioemu10k.7d legacy pkg=SUNWaudioemu10k \ desc="SunOS audio device driver for Creative EMU10K" \ name="Creative EMU10K Audio Driver" diff --git a/usr/src/prototypes/prototype.Makefile b/usr/src/prototypes/prototype.Makefile index 07207161b6..9539bab329 100644 --- a/usr/src/prototypes/prototype.Makefile +++ b/usr/src/prototypes/prototype.Makefile @@ -10,6 +10,6 @@ # # -# Copyright 2010 . All rights reserved. +# Copyright 2011 . All rights reserved. # diff --git a/usr/src/prototypes/prototype.c b/usr/src/prototypes/prototype.c index b913a6a169..5154139aba 100644 --- a/usr/src/prototypes/prototype.c +++ b/usr/src/prototypes/prototype.c @@ -10,7 +10,7 @@ */ /* - * Copyright 2010 . All rights reserved. + * Copyright 2011 . All rights reserved. */ /* diff --git a/usr/src/prototypes/prototype.csh b/usr/src/prototypes/prototype.csh index 0f9b35fd1b..f1a7fc2ad9 100644 --- a/usr/src/prototypes/prototype.csh +++ b/usr/src/prototypes/prototype.csh @@ -12,6 +12,6 @@ # # -# Copyright 2010 . All rights reserved. +# Copyright 2011 . All rights reserved. # diff --git a/usr/src/prototypes/prototype.h b/usr/src/prototypes/prototype.h index 6558477d3c..16016b2a5d 100644 --- a/usr/src/prototypes/prototype.h +++ b/usr/src/prototypes/prototype.h @@ -10,7 +10,7 @@ */ /* - * Copyright 2010 . All rights reserved. + * Copyright 2011 . All rights reserved. */ #ifndef _PROTOTYPE_H diff --git a/usr/src/prototypes/prototype.java b/usr/src/prototypes/prototype.java index 9ca0033695..4673163b91 100644 --- a/usr/src/prototypes/prototype.java +++ b/usr/src/prototypes/prototype.java @@ -10,7 +10,7 @@ */ /* - * Copyright 2010 . All rights reserved. + * Copyright 2011 . All rights reserved. */ /* diff --git a/usr/src/prototypes/prototype.ksh b/usr/src/prototypes/prototype.ksh index 6ef1969616..4f211f4466 100644 --- a/usr/src/prototypes/prototype.ksh +++ b/usr/src/prototypes/prototype.ksh @@ -12,6 +12,6 @@ # # -# Copyright 2010 . All rights reserved. +# Copyright 2011 . All rights reserved. # diff --git a/usr/src/prototypes/prototype.man b/usr/src/prototypes/prototype.man index 6a6ac51136..b9b3db4423 100644 --- a/usr/src/prototypes/prototype.man +++ b/usr/src/prototypes/prototype.man @@ -1,3 +1,4 @@ +'\" t .\" .\" This file and its contents are supplied under the terms of the .\" Common Development and Distribution License ("CDDL"), version 1.0. @@ -9,5 +10,5 @@ .\" http://www.illumos.org/license/CDDL. .\" .\" -.\" Copyright 2010 . All rights reserved. +.\" Copyright 2011 . All rights reserved. .\" diff --git a/usr/src/prototypes/prototype.mapfile-vers b/usr/src/prototypes/prototype.mapfile-vers index e6f1d6b84a..3f44813564 100644 --- a/usr/src/prototypes/prototype.mapfile-vers +++ b/usr/src/prototypes/prototype.mapfile-vers @@ -10,7 +10,7 @@ # # -# Copyright 2010 . All rights reserved. +# Copyright 2011 . All rights reserved. # # diff --git a/usr/src/prototypes/prototype.pl b/usr/src/prototypes/prototype.pl index c9a428af42..92ef47f3c1 100644 --- a/usr/src/prototypes/prototype.pl +++ b/usr/src/prototypes/prototype.pl @@ -11,7 +11,7 @@ # # -# Copyright 2010 . All rights reserved. +# Copyright 2011 . All rights reserved. # # diff --git a/usr/src/prototypes/prototype.py b/usr/src/prototypes/prototype.py index 518d8b6370..17edc4d88d 100644 --- a/usr/src/prototypes/prototype.py +++ b/usr/src/prototypes/prototype.py @@ -11,7 +11,7 @@ # # -# Copyright 2010 . All rights reserved. +# Copyright 2011 . All rights reserved. # # diff --git a/usr/src/prototypes/prototype.s b/usr/src/prototypes/prototype.s index 7a279c47fb..81feaf7682 100644 --- a/usr/src/prototypes/prototype.s +++ b/usr/src/prototypes/prototype.s @@ -10,7 +10,7 @@ */ /* - * Copyright 2010 . All rights reserved. + * Copyright 2011 . All rights reserved. */ .file "prototype.s" diff --git a/usr/src/prototypes/prototype.sh b/usr/src/prototypes/prototype.sh index 9d214a11f6..0b054bcb4d 100644 --- a/usr/src/prototypes/prototype.sh +++ b/usr/src/prototypes/prototype.sh @@ -12,6 +12,6 @@ # # -# Copyright 2010 . All rights reserved. +# Copyright 2011 . All rights reserved. # -- 2.11.4.GIT