2 * QEMU USB audio device
5 * H. Peter Anvin <hpa@linux.intel.com>
6 * Gerd Hoffmann <kraxel@redhat.com>
8 * lousely based on usb net device code which is:
10 * Copyright (c) 2006 Thomas Sailer
11 * Copyright (c) 2008 Andrzej Zaborowski
13 * Permission is hereby granted, free of charge, to any person obtaining a copy
14 * of this software and associated documentation files (the "Software"), to deal
15 * in the Software without restriction, including without limitation the rights
16 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17 * copies of the Software, and to permit persons to whom the Software is
18 * furnished to do so, subject to the following conditions:
20 * The above copyright notice and this permission notice shall be included in
21 * all copies or substantial portions of the Software.
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
32 #include "qemu-common.h"
34 #include "hw/usb/desc.h"
36 #include "audio/audio.h"
38 #define USBAUDIO_VENDOR_NUM 0x46f4 /* CRC16() of "QEMU" */
39 #define USBAUDIO_PRODUCT_NUM 0x0002
41 #define DEV_CONFIG_VALUE 1 /* The one and only */
43 /* Descriptor subtypes for AC interfaces */
44 #define DST_AC_HEADER 1
45 #define DST_AC_INPUT_TERMINAL 2
46 #define DST_AC_OUTPUT_TERMINAL 3
47 #define DST_AC_FEATURE_UNIT 6
48 /* Descriptor subtypes for AS interfaces */
49 #define DST_AS_GENERAL 1
50 #define DST_AS_FORMAT_TYPE 2
51 /* Descriptor subtypes for endpoints */
52 #define DST_EP_GENERAL 1
54 enum usb_audio_strings
{
60 STRING_USBAUDIO_CONTROL
,
61 STRING_INPUT_TERMINAL
,
63 STRING_OUTPUT_TERMINAL
,
68 static const USBDescStrings usb_audio_stringtable
= {
69 [STRING_MANUFACTURER
] = "QEMU",
70 [STRING_PRODUCT
] = "QEMU USB Audio",
71 [STRING_SERIALNUMBER
] = "1",
72 [STRING_CONFIG
] = "Audio Configuration",
73 [STRING_USBAUDIO_CONTROL
] = "Audio Device",
74 [STRING_INPUT_TERMINAL
] = "Audio Output Pipe",
75 [STRING_FEATURE_UNIT
] = "Audio Output Volume Control",
76 [STRING_OUTPUT_TERMINAL
] = "Audio Output Terminal",
77 [STRING_NULL_STREAM
] = "Audio Output - Disabled",
78 [STRING_REAL_STREAM
] = "Audio Output - 48 kHz Stereo",
81 #define U16(x) ((x) & 0xff), (((x) >> 8) & 0xff)
82 #define U24(x) U16(x), (((x) >> 16) & 0xff)
83 #define U32(x) U24(x), (((x) >> 24) & 0xff)
86 * A Basic Audio Device uses these specific values
88 #define USBAUDIO_PACKET_SIZE 192
89 #define USBAUDIO_SAMPLE_RATE 48000
90 #define USBAUDIO_PACKET_INTERVAL 1
92 static const USBDescIface desc_iface
[] = {
94 .bInterfaceNumber
= 0,
96 .bInterfaceClass
= USB_CLASS_AUDIO
,
97 .bInterfaceSubClass
= USB_SUBCLASS_AUDIO_CONTROL
,
98 .bInterfaceProtocol
= 0x04,
99 .iInterface
= STRING_USBAUDIO_CONTROL
,
101 .descs
= (USBDescOther
[]) {
103 /* Headphone Class-Specific AC Interface Header Descriptor */
104 .data
= (uint8_t[]) {
105 0x09, /* u8 bLength */
106 USB_DT_CS_INTERFACE
, /* u8 bDescriptorType */
107 DST_AC_HEADER
, /* u8 bDescriptorSubtype */
108 U16(0x0100), /* u16 bcdADC */
109 U16(0x2b), /* u16 wTotalLength */
110 0x01, /* u8 bInCollection */
111 0x01, /* u8 baInterfaceNr */
114 /* Generic Stereo Input Terminal ID1 Descriptor */
115 .data
= (uint8_t[]) {
116 0x0c, /* u8 bLength */
117 USB_DT_CS_INTERFACE
, /* u8 bDescriptorType */
118 DST_AC_INPUT_TERMINAL
, /* u8 bDescriptorSubtype */
119 0x01, /* u8 bTerminalID */
120 U16(0x0101), /* u16 wTerminalType */
121 0x00, /* u8 bAssocTerminal */
122 0x02, /* u16 bNrChannels */
123 U16(0x0003), /* u16 wChannelConfig */
124 0x00, /* u8 iChannelNames */
125 STRING_INPUT_TERMINAL
, /* u8 iTerminal */
128 /* Generic Stereo Feature Unit ID2 Descriptor */
129 .data
= (uint8_t[]) {
130 0x0d, /* u8 bLength */
131 USB_DT_CS_INTERFACE
, /* u8 bDescriptorType */
132 DST_AC_FEATURE_UNIT
, /* u8 bDescriptorSubtype */
133 0x02, /* u8 bUnitID */
134 0x01, /* u8 bSourceID */
135 0x02, /* u8 bControlSize */
136 U16(0x0001), /* u16 bmaControls(0) */
137 U16(0x0002), /* u16 bmaControls(1) */
138 U16(0x0002), /* u16 bmaControls(2) */
139 STRING_FEATURE_UNIT
, /* u8 iFeature */
142 /* Headphone Ouptut Terminal ID3 Descriptor */
143 .data
= (uint8_t[]) {
144 0x09, /* u8 bLength */
145 USB_DT_CS_INTERFACE
, /* u8 bDescriptorType */
146 DST_AC_OUTPUT_TERMINAL
, /* u8 bDescriptorSubtype */
147 0x03, /* u8 bUnitID */
148 U16(0x0301), /* u16 wTerminalType (SPK) */
149 0x00, /* u8 bAssocTerminal */
150 0x02, /* u8 bSourceID */
151 STRING_OUTPUT_TERMINAL
, /* u8 iTerminal */
156 .bInterfaceNumber
= 1,
157 .bAlternateSetting
= 0,
159 .bInterfaceClass
= USB_CLASS_AUDIO
,
160 .bInterfaceSubClass
= USB_SUBCLASS_AUDIO_STREAMING
,
161 .iInterface
= STRING_NULL_STREAM
,
163 .bInterfaceNumber
= 1,
164 .bAlternateSetting
= 1,
166 .bInterfaceClass
= USB_CLASS_AUDIO
,
167 .bInterfaceSubClass
= USB_SUBCLASS_AUDIO_STREAMING
,
168 .iInterface
= STRING_REAL_STREAM
,
170 .descs
= (USBDescOther
[]) {
172 /* Headphone Class-specific AS General Interface Descriptor */
173 .data
= (uint8_t[]) {
174 0x07, /* u8 bLength */
175 USB_DT_CS_INTERFACE
, /* u8 bDescriptorType */
176 DST_AS_GENERAL
, /* u8 bDescriptorSubtype */
177 0x01, /* u8 bTerminalLink */
178 0x00, /* u8 bDelay */
179 0x01, 0x00, /* u16 wFormatTag */
182 /* Headphone Type I Format Type Descriptor */
183 .data
= (uint8_t[]) {
184 0x0b, /* u8 bLength */
185 USB_DT_CS_INTERFACE
, /* u8 bDescriptorType */
186 DST_AS_FORMAT_TYPE
, /* u8 bDescriptorSubtype */
187 0x01, /* u8 bFormatType */
188 0x02, /* u8 bNrChannels */
189 0x02, /* u8 bSubFrameSize */
190 0x10, /* u8 bBitResolution */
191 0x01, /* u8 bSamFreqType */
192 U24(USBAUDIO_SAMPLE_RATE
), /* u24 tSamFreq */
196 .eps
= (USBDescEndpoint
[]) {
198 .bEndpointAddress
= USB_DIR_OUT
| 0x01,
199 .bmAttributes
= 0x0d,
200 .wMaxPacketSize
= USBAUDIO_PACKET_SIZE
,
203 /* Stereo Headphone Class-specific
204 AS Audio Data Endpoint Descriptor */
205 .extra
= (uint8_t[]) {
206 0x07, /* u8 bLength */
207 USB_DT_CS_ENDPOINT
, /* u8 bDescriptorType */
208 DST_EP_GENERAL
, /* u8 bDescriptorSubtype */
209 0x00, /* u8 bmAttributes */
210 0x00, /* u8 bLockDelayUnits */
211 U16(0x0000), /* u16 wLockDelay */
218 static const USBDescDevice desc_device
= {
220 .bMaxPacketSize0
= 64,
221 .bNumConfigurations
= 1,
222 .confs
= (USBDescConfig
[]) {
225 .bConfigurationValue
= DEV_CONFIG_VALUE
,
226 .iConfiguration
= STRING_CONFIG
,
227 .bmAttributes
= USB_CFG_ATT_ONE
| USB_CFG_ATT_SELFPOWER
,
229 .nif
= ARRAY_SIZE(desc_iface
),
235 static const USBDesc desc_audio
= {
237 .idVendor
= USBAUDIO_VENDOR_NUM
,
238 .idProduct
= USBAUDIO_PRODUCT_NUM
,
240 .iManufacturer
= STRING_MANUFACTURER
,
241 .iProduct
= STRING_PRODUCT
,
242 .iSerialNumber
= STRING_SERIALNUMBER
,
244 .full
= &desc_device
,
245 .str
= usb_audio_stringtable
,
249 * A USB audio device supports an arbitrary number of alternate
250 * interface settings for each interface. Each corresponds to a block
251 * diagram of parameterized blocks. This can thus refer to things like
252 * number of channels, data rates, or in fact completely different
253 * block diagrams. Alternative setting 0 is always the null block diagram,
254 * which is used by a disabled device.
256 enum usb_audio_altset
{
257 ALTSET_OFF
= 0x00, /* No endpoint */
258 ALTSET_ON
= 0x01, /* Single endpoint */
262 * Class-specific control requests
264 #define CR_SET_CUR 0x01
265 #define CR_GET_CUR 0x81
266 #define CR_SET_MIN 0x02
267 #define CR_GET_MIN 0x82
268 #define CR_SET_MAX 0x03
269 #define CR_GET_MAX 0x83
270 #define CR_SET_RES 0x04
271 #define CR_GET_RES 0x84
272 #define CR_SET_MEM 0x05
273 #define CR_GET_MEM 0x85
274 #define CR_GET_STAT 0xff
277 * Feature Unit Control Selectors
279 #define MUTE_CONTROL 0x01
280 #define VOLUME_CONTROL 0x02
281 #define BASS_CONTROL 0x03
282 #define MID_CONTROL 0x04
283 #define TREBLE_CONTROL 0x05
284 #define GRAPHIC_EQUALIZER_CONTROL 0x06
285 #define AUTOMATIC_GAIN_CONTROL 0x07
286 #define DELAY_CONTROL 0x08
287 #define BASS_BOOST_CONTROL 0x09
288 #define LOUDNESS_CONTROL 0x0a
301 static void streambuf_init(struct streambuf
*buf
, uint32_t size
)
304 buf
->size
= size
- (size
% USBAUDIO_PACKET_SIZE
);
305 buf
->data
= g_malloc(buf
->size
);
310 static void streambuf_fini(struct streambuf
*buf
)
316 static int streambuf_put(struct streambuf
*buf
, USBPacket
*p
)
318 uint32_t free
= buf
->size
- (buf
->prod
- buf
->cons
);
323 assert(free
>= USBAUDIO_PACKET_SIZE
);
324 usb_packet_copy(p
, buf
->data
+ (buf
->prod
% buf
->size
),
325 USBAUDIO_PACKET_SIZE
);
326 buf
->prod
+= USBAUDIO_PACKET_SIZE
;
327 return USBAUDIO_PACKET_SIZE
;
330 static uint8_t *streambuf_get(struct streambuf
*buf
)
332 uint32_t used
= buf
->prod
- buf
->cons
;
338 assert(used
>= USBAUDIO_PACKET_SIZE
);
339 data
= buf
->data
+ (buf
->cons
% buf
->size
);
340 buf
->cons
+= USBAUDIO_PACKET_SIZE
;
344 typedef struct USBAudioState
{
345 /* qemu interfaces */
351 enum usb_audio_altset altset
;
352 struct audsettings as
;
356 struct streambuf buf
;
364 #define TYPE_USB_AUDIO "usb-audio"
365 #define USB_AUDIO(obj) OBJECT_CHECK(USBAudioState, (obj), TYPE_USB_AUDIO)
367 static void output_callback(void *opaque
, int avail
)
369 USBAudioState
*s
= opaque
;
373 if (avail
< USBAUDIO_PACKET_SIZE
) {
376 data
= streambuf_get(&s
->out
.buf
);
380 AUD_write(s
->out
.voice
, data
, USBAUDIO_PACKET_SIZE
);
381 avail
-= USBAUDIO_PACKET_SIZE
;
385 static int usb_audio_set_output_altset(USBAudioState
*s
, int altset
)
389 streambuf_init(&s
->out
.buf
, s
->buffer
);
390 AUD_set_active_out(s
->out
.voice
, false);
393 AUD_set_active_out(s
->out
.voice
, true);
400 fprintf(stderr
, "usb-audio: set interface %d\n", altset
);
402 s
->out
.altset
= altset
;
407 * Note: we arbitrarily map the volume control range onto -inf..+8 dB
409 #define ATTRIB_ID(cs, attrib, idif) \
410 (((cs) << 24) | ((attrib) << 16) | (idif))
412 static int usb_audio_get_control(USBAudioState
*s
, uint8_t attrib
,
413 uint16_t cscn
, uint16_t idif
,
414 int length
, uint8_t *data
)
416 uint8_t cs
= cscn
>> 8;
417 uint8_t cn
= cscn
- 1; /* -1 for the non-present master control */
418 uint32_t aid
= ATTRIB_ID(cs
, attrib
, idif
);
419 int ret
= USB_RET_STALL
;
422 case ATTRIB_ID(MUTE_CONTROL
, CR_GET_CUR
, 0x0200):
423 data
[0] = s
->out
.mute
;
426 case ATTRIB_ID(VOLUME_CONTROL
, CR_GET_CUR
, 0x0200):
428 uint16_t vol
= (s
->out
.vol
[cn
] * 0x8800 + 127) / 255 + 0x8000;
434 case ATTRIB_ID(VOLUME_CONTROL
, CR_GET_MIN
, 0x0200):
441 case ATTRIB_ID(VOLUME_CONTROL
, CR_GET_MAX
, 0x0200):
448 case ATTRIB_ID(VOLUME_CONTROL
, CR_GET_RES
, 0x0200):
459 static int usb_audio_set_control(USBAudioState
*s
, uint8_t attrib
,
460 uint16_t cscn
, uint16_t idif
,
461 int length
, uint8_t *data
)
463 uint8_t cs
= cscn
>> 8;
464 uint8_t cn
= cscn
- 1; /* -1 for the non-present master control */
465 uint32_t aid
= ATTRIB_ID(cs
, attrib
, idif
);
466 int ret
= USB_RET_STALL
;
467 bool set_vol
= false;
470 case ATTRIB_ID(MUTE_CONTROL
, CR_SET_CUR
, 0x0200):
471 s
->out
.mute
= data
[0] & 1;
475 case ATTRIB_ID(VOLUME_CONTROL
, CR_SET_CUR
, 0x0200):
477 uint16_t vol
= data
[0] + (data
[1] << 8);
480 fprintf(stderr
, "usb-audio: vol %04x\n", (uint16_t)vol
);
484 vol
= (vol
* 255 + 0x4400) / 0x8800;
489 s
->out
.vol
[cn
] = vol
;
498 fprintf(stderr
, "usb-audio: mute %d, lvol %3d, rvol %3d\n",
499 s
->out
.mute
, s
->out
.vol
[0], s
->out
.vol
[1]);
501 AUD_set_volume_out(s
->out
.voice
, s
->out
.mute
,
502 s
->out
.vol
[0], s
->out
.vol
[1]);
508 static void usb_audio_handle_control(USBDevice
*dev
, USBPacket
*p
,
509 int request
, int value
, int index
,
510 int length
, uint8_t *data
)
512 USBAudioState
*s
= USB_AUDIO(dev
);
516 fprintf(stderr
, "usb-audio: control transaction: "
517 "request 0x%04x value 0x%04x index 0x%04x length 0x%04x\n",
518 request
, value
, index
, length
);
521 ret
= usb_desc_handle_control(dev
, p
, request
, value
, index
, length
, data
);
527 case ClassInterfaceRequest
| CR_GET_CUR
:
528 case ClassInterfaceRequest
| CR_GET_MIN
:
529 case ClassInterfaceRequest
| CR_GET_MAX
:
530 case ClassInterfaceRequest
| CR_GET_RES
:
531 ret
= usb_audio_get_control(s
, request
& 0xff, value
, index
,
535 fprintf(stderr
, "usb-audio: fail: get control\n");
539 p
->actual_length
= ret
;
542 case ClassInterfaceOutRequest
| CR_SET_CUR
:
543 case ClassInterfaceOutRequest
| CR_SET_MIN
:
544 case ClassInterfaceOutRequest
| CR_SET_MAX
:
545 case ClassInterfaceOutRequest
| CR_SET_RES
:
546 ret
= usb_audio_set_control(s
, request
& 0xff, value
, index
,
550 fprintf(stderr
, "usb-audio: fail: set control\n");
559 fprintf(stderr
, "usb-audio: failed control transaction: "
560 "request 0x%04x value 0x%04x index 0x%04x length 0x%04x\n",
561 request
, value
, index
, length
);
563 p
->status
= USB_RET_STALL
;
568 static void usb_audio_set_interface(USBDevice
*dev
, int iface
,
571 USBAudioState
*s
= USB_AUDIO(dev
);
574 usb_audio_set_output_altset(s
, value
);
578 static void usb_audio_handle_reset(USBDevice
*dev
)
580 USBAudioState
*s
= USB_AUDIO(dev
);
583 fprintf(stderr
, "usb-audio: reset\n");
585 usb_audio_set_output_altset(s
, ALTSET_OFF
);
588 static void usb_audio_handle_dataout(USBAudioState
*s
, USBPacket
*p
)
590 if (s
->out
.altset
== ALTSET_OFF
) {
591 p
->status
= USB_RET_STALL
;
595 streambuf_put(&s
->out
.buf
, p
);
596 if (p
->actual_length
< p
->iov
.size
&& s
->debug
> 1) {
597 fprintf(stderr
, "usb-audio: output overrun (%zd bytes)\n",
598 p
->iov
.size
- p
->actual_length
);
602 static void usb_audio_handle_data(USBDevice
*dev
, USBPacket
*p
)
604 USBAudioState
*s
= (USBAudioState
*) dev
;
606 if (p
->pid
== USB_TOKEN_OUT
&& p
->ep
->nr
== 1) {
607 usb_audio_handle_dataout(s
, p
);
611 p
->status
= USB_RET_STALL
;
613 fprintf(stderr
, "usb-audio: failed data transaction: "
614 "pid 0x%x ep 0x%x len 0x%zx\n",
615 p
->pid
, p
->ep
->nr
, p
->iov
.size
);
619 static void usb_audio_handle_destroy(USBDevice
*dev
)
621 USBAudioState
*s
= USB_AUDIO(dev
);
624 fprintf(stderr
, "usb-audio: destroy\n");
627 usb_audio_set_output_altset(s
, ALTSET_OFF
);
628 AUD_close_out(&s
->card
, s
->out
.voice
);
629 AUD_remove_card(&s
->card
);
631 streambuf_fini(&s
->out
.buf
);
634 static void usb_audio_realize(USBDevice
*dev
, Error
**errp
)
636 USBAudioState
*s
= USB_AUDIO(dev
);
638 usb_desc_create_serial(dev
);
641 AUD_register_card(TYPE_USB_AUDIO
, &s
->card
);
643 s
->out
.altset
= ALTSET_OFF
;
645 s
->out
.vol
[0] = 240; /* 0 dB */
646 s
->out
.vol
[1] = 240; /* 0 dB */
647 s
->out
.as
.freq
= USBAUDIO_SAMPLE_RATE
;
648 s
->out
.as
.nchannels
= 2;
649 s
->out
.as
.fmt
= AUD_FMT_S16
;
650 s
->out
.as
.endianness
= 0;
651 streambuf_init(&s
->out
.buf
, s
->buffer
);
653 s
->out
.voice
= AUD_open_out(&s
->card
, s
->out
.voice
, TYPE_USB_AUDIO
,
654 s
, output_callback
, &s
->out
.as
);
655 AUD_set_volume_out(s
->out
.voice
, s
->out
.mute
, s
->out
.vol
[0], s
->out
.vol
[1]);
656 AUD_set_active_out(s
->out
.voice
, 0);
659 static const VMStateDescription vmstate_usb_audio
= {
660 .name
= TYPE_USB_AUDIO
,
664 static Property usb_audio_properties
[] = {
665 DEFINE_PROP_UINT32("debug", USBAudioState
, debug
, 0),
666 DEFINE_PROP_UINT32("buffer", USBAudioState
, buffer
,
667 8 * USBAUDIO_PACKET_SIZE
),
668 DEFINE_PROP_END_OF_LIST(),
671 static void usb_audio_class_init(ObjectClass
*klass
, void *data
)
673 DeviceClass
*dc
= DEVICE_CLASS(klass
);
674 USBDeviceClass
*k
= USB_DEVICE_CLASS(klass
);
676 dc
->vmsd
= &vmstate_usb_audio
;
677 dc
->props
= usb_audio_properties
;
678 set_bit(DEVICE_CATEGORY_SOUND
, dc
->categories
);
679 k
->product_desc
= "QEMU USB Audio Interface";
680 k
->usb_desc
= &desc_audio
;
681 k
->realize
= usb_audio_realize
;
682 k
->handle_reset
= usb_audio_handle_reset
;
683 k
->handle_control
= usb_audio_handle_control
;
684 k
->handle_data
= usb_audio_handle_data
;
685 k
->handle_destroy
= usb_audio_handle_destroy
;
686 k
->set_interface
= usb_audio_set_interface
;
689 static const TypeInfo usb_audio_info
= {
690 .name
= TYPE_USB_AUDIO
,
691 .parent
= TYPE_USB_DEVICE
,
692 .instance_size
= sizeof(USBAudioState
),
693 .class_init
= usb_audio_class_init
,
696 static void usb_audio_register_types(void)
698 type_register_static(&usb_audio_info
);
699 usb_legacy_register(TYPE_USB_AUDIO
, "audio", NULL
);
702 type_init(usb_audio_register_types
)