Merge commit 'ad3ad82ad2fb99c424a8482bd1908d08b990ccea'
[unleashed.git] / share / man / man7d / usb_as.7d
blob1ab1bdb569b68c588b25becab2f6169f7bace700
1 '\" te
2 .\"  Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
3 .\" 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.
4 .\"  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
5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH USB_AS 7D "May 15, 2009"
7 .SH NAME
8 usb_as \- USB audio streaming driver
9 .SH SYNOPSIS
10 .LP
11 .nf
12 sound@unit-address
13 .fi
15 .SH DESCRIPTION
16 .sp
17 .LP
18 The \fBusb_as\fR driver is a USBA (Solaris USB Architecture) compliant client
19 driver that supports the \fIUSB Audio Class 1.0\fR specification.
20 .sp
21 .LP
22 The \fBusb_as\fR driver processes audio data messages during play and record
23 and sets sample frequency, precision, encoding and other functions on request
24 from the USB audio control driver. See \fBusb_ac\fR(7D).
25 .sp
26 .LP
27 This driver is plumbed under the USB audio control driver and does not directly
28 interface with the user application.
29 .SH FILES
30 .sp
31 .ne 2
32 .na
33 \fB\fB/kernel/drv/usb_as\fR\fR
34 .ad
35 .RS 30n
36 32-bit x86 ELF kernel module
37 .RE
39 .sp
40 .ne 2
41 .na
42 \fB\fB/kernel/drv/amd64/usb_as\fR\fR
43 .ad
44 .RS 30n
45 64-bit x86 ELF kernel module
46 .RE
48 .sp
49 .ne 2
50 .na
51 \fB\fB/kernel/drv/sparcv9/usb_as\fR\fR
52 .ad
53 .RS 30n
54 64-bit SPARC ELF kernel module
55 .RE
57 .SH ATTRIBUTES
58 .sp
59 .LP
60 See \fBattributes\fR(5) for descriptions of the following attributes:
61 .sp
63 .sp
64 .TS
65 box;
66 c | c
67 l | l .
68 ATTRIBUTE TYPE  ATTRIBUTE VALUE
70 Architecture    SPARC, x86, PCI-based systems
72 Stability level         Committed
73 .TE
75 .SH SEE ALSO
76 .sp
77 .LP
78 \fBattributes\fR(5), \fBusba\fR(7D), \fBusb_ac\fR(7D), \fBaudio\fR(7I)
79 .sp
80 .LP
81 \fIWriting Device Drivers\fR
82 .sp
83 .LP
84 \fIUniversal Serial Bus Specification 1.0 and 1.1\fR
85 .sp
86 .LP
87 \fISystem Administration Guide: Basic Administration\fR
88 .SH DIAGNOSTICS
89 .sp
90 .LP
91 In addition to being logged, the following messages can appear on the system
92 console. All messages are formatted in the following manner:
93 .sp
94 .in +2
95 .nf
96 Warning: <device path> (usb_as<instance num>): Error Message...
97 .fi
98 .in -2
99 .sp
103 where \fI<device path>\fR is the physical path to the device in \fB/devices\fR
104 directory.
106 .ne 2
108 \fBNo bandwidth available.\fR
110 .sp .6
111 .RS 4n
112 There is no bandwidth available for the isochronous pipe. As a result, no data
113 is transferred during play and record.
117 .ne 2
119 \fBOperating a full/high speed audio device on a high speed port is not
120 supported.\fR
122 .sp .6
123 .RS 4n
124 The USB software does not currently support full or high speed audio devices
125 connected to an external USB 2.0 hub that is linked to a port of a USB 2.0 host
126 controller. Audio devices must be connected directly to a port of a USB 2.0
127 controller or to any USB 1.1 port.
131 .ne 2
133 \fBCannot access device. Please reconnect <name>.\fR
135 .sp .6
136 .RS 4n
137 There was an error in accessing the device during reconnect. Please reconnect
138 the device.
142 .ne 2
144 \fBDevice is not identical to the previous one on this port. Please disconnect
145 and reconnect.\fR
147 .sp .6
148 .RS 4n
149 A USB audio streaming interface was hot-removed while open. A new device was
150 hot-inserted which is not identical to the original USB audio device. Please
151 disconnect the USB device and reconnect the device to the same port.
154 .SH NOTES
157 The USB audio streaming interface is power managed if the device is idle.