1 /* $NetBSD: uaudio.c,v 1.91 2004/11/05 17:46:14 kent Exp $ */
5 * Copyright (c) 1999 The NetBSD Foundation, Inc.
8 * This code is derived from software contributed to The NetBSD Foundation
9 * by Lennart Augustsson (lennart@augustsson.net) at
10 * Carlstedt Research & Technology.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
21 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
23 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
25 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
38 * USB audio specs: http://www.usb.org/developers/devclass_docs/audio10.pdf
39 * http://www.usb.org/developers/devclass_docs/frmts10.pdf
40 * http://www.usb.org/developers/devclass_docs/termt10.pdf
45 * $NetBSD: uaudio.c,v 1.94 2005/01/15 15:19:53 kent Exp $
46 * $NetBSD: uaudio.c,v 1.95 2005/01/16 06:02:19 dsainty Exp $
47 * $NetBSD: uaudio.c,v 1.96 2005/01/16 12:46:00 kent Exp $
48 * $NetBSD: uaudio.c,v 1.97 2005/02/24 08:19:38 martin Exp $
51 #include <sys/stdint.h>
52 #include <sys/stddef.h>
53 #include <sys/param.h>
54 #include <sys/queue.h>
55 #include <sys/types.h>
56 #include <sys/systm.h>
57 #include <sys/kernel.h>
59 #include <sys/module.h>
61 #include <sys/mutex.h>
62 #include <sys/condvar.h>
63 #include <sys/sysctl.h>
65 #include <sys/unistd.h>
66 #include <sys/callout.h>
67 #include <sys/malloc.h>
71 #include <dev/usb/usb.h>
72 #include <dev/usb/usbdi.h>
73 #include <dev/usb/usbdi_util.h>
74 #include <dev/usb/usbhid.h>
75 #include <dev/usb/usb_request.h>
76 #include <dev/usb/usb_process.h>
78 #define USB_DEBUG_VAR uaudio_debug
79 #include <dev/usb/usb_debug.h>
81 #include <dev/usb/quirk/usb_quirk.h>
83 #include <sys/reboot.h> /* for bootverbose */
85 #ifdef HAVE_KERNEL_OPTION_HEADERS
89 #include <dev/sound/pcm/sound.h>
90 #include <dev/sound/usb/uaudioreg.h>
91 #include <dev/sound/usb/uaudio.h>
92 #include <dev/sound/chip.h>
93 #include "feeder_if.h"
95 static int uaudio_default_rate = 0; /* use rate list */
96 static int uaudio_default_bits = 32;
97 static int uaudio_default_channels = 0; /* use default */
98 static int uaudio_buffer_ms = 8;
101 static int uaudio_debug;
103 static SYSCTL_NODE(_hw_usb, OID_AUTO, uaudio, CTLFLAG_RW, 0, "USB uaudio");
105 SYSCTL_INT(_hw_usb_uaudio, OID_AUTO, debug, CTLFLAG_RW,
106 &uaudio_debug, 0, "uaudio debug level");
108 TUNABLE_INT("hw.usb.uaudio.default_rate", &uaudio_default_rate);
109 SYSCTL_INT(_hw_usb_uaudio, OID_AUTO, default_rate, CTLFLAG_RW,
110 &uaudio_default_rate, 0, "uaudio default sample rate");
112 TUNABLE_INT("hw.usb.uaudio.default_bits", &uaudio_default_bits);
113 SYSCTL_INT(_hw_usb_uaudio, OID_AUTO, default_bits, CTLFLAG_RW,
114 &uaudio_default_bits, 0, "uaudio default sample bits");
116 TUNABLE_INT("hw.usb.uaudio.default_channels", &uaudio_default_channels);
117 SYSCTL_INT(_hw_usb_uaudio, OID_AUTO, default_channels, CTLFLAG_RW,
118 &uaudio_default_channels, 0, "uaudio default sample channels");
121 uaudio_buffer_ms_sysctl(SYSCTL_HANDLER_ARGS)
125 val = uaudio_buffer_ms;
126 err = sysctl_handle_int(oidp, &val, 0, req);
128 if (err != 0 || req->newptr == NULL || val == uaudio_buffer_ms)
136 uaudio_buffer_ms = val;
140 SYSCTL_PROC(_hw_usb_uaudio, OID_AUTO, buffer_ms, CTLTYPE_INT | CTLFLAG_RWTUN,
141 0, sizeof(int), uaudio_buffer_ms_sysctl, "I",
142 "uaudio buffering delay from 2ms to 8ms");
144 #define uaudio_debug 0
147 #define UAUDIO_NFRAMES 64 /* must be factor of 8 due HS-USB */
148 #define UAUDIO_NCHANBUFS 2 /* number of outstanding request */
149 #define UAUDIO_RECURSE_LIMIT 255 /* rounds */
150 #define UAUDIO_CHANNELS_MAX MIN(64, AFMT_CHANNEL_MAX)
151 #define UAUDIO_MATRIX_MAX 8 /* channels */
153 #define MAKE_WORD(h,l) (((h) << 8) | (l))
154 #define BIT_TEST(bm,bno) (((bm)[(bno) / 8] >> (7 - ((bno) % 8))) & 1)
155 #define UAUDIO_MAX_CHAN(x) (x)
156 #define MIX(sc) ((sc)->sc_mixer_node)
159 const struct usb_audio_streaming_interface_descriptor *v1;
160 const struct usb_audio20_streaming_interface_descriptor *v2;
164 const struct usb_audio_streaming_type1_descriptor *v1;
165 const struct usb_audio20_streaming_type1_descriptor *v2;
169 const struct usb_audio_streaming_endpoint_descriptor *v1;
170 const struct usb_audio20_streaming_endpoint_descriptor *v2;
173 struct uaudio_mixer_node {
178 #define MIX_MAX_CHAN 16
179 int32_t wValue[MIX_MAX_CHAN]; /* using nchan */
183 int wData[MIX_MAX_CHAN]; /* using nchan */
186 uint8_t update[(MIX_MAX_CHAN + 7) / 8];
190 #define MIX_SIGNED_16 2
191 #define MIX_UNSIGNED_16 3
192 #define MIX_SIGNED_8 4
193 #define MIX_SELECTOR 5
194 #define MIX_UNKNOWN 6
195 #define MIX_SIZE(n) ((((n) == MIX_SIGNED_16) || \
196 ((n) == MIX_UNSIGNED_16)) ? 2 : 1)
197 #define MIX_UNSIGNED(n) ((n) == MIX_UNSIGNED_16)
199 #define MAX_SELECTOR_INPUT_PIN 256
200 uint8_t slctrtype[MAX_SELECTOR_INPUT_PIN];
206 struct uaudio_mixer_node *next;
209 struct uaudio_configure_msg {
210 struct usb_proc_msg hdr;
211 struct uaudio_softc *sc;
214 #define CHAN_MAX_ALT 24
216 struct uaudio_chan_alt {
217 union uaudio_asf1d p_asf1d;
218 union uaudio_sed p_sed;
219 const usb_endpoint_descriptor_audio_t *p_ed1;
220 const struct uaudio_format *p_fmt;
221 const struct usb_config *usb_cfg;
222 uint32_t sample_rate; /* in Hz */
223 uint16_t sample_size;
225 uint8_t iface_alt_index;
230 struct pcmchan_caps pcm_cap; /* capabilities */
231 struct uaudio_chan_alt usb_alt[CHAN_MAX_ALT];
232 struct snd_dbuf *pcm_buf;
233 struct mtx *pcm_mtx; /* lock protecting this structure */
234 struct uaudio_softc *priv_sc;
235 struct pcm_channel *pcm_ch;
236 struct usb_xfer *xfer[UAUDIO_NCHANBUFS + 1];
238 uint8_t *buf; /* pointer to buffer */
239 uint8_t *start; /* upper layer buffer start */
240 uint8_t *end; /* upper layer buffer end */
241 uint8_t *cur; /* current position in upper layer
244 uint32_t intr_frames; /* in units */
245 uint32_t frames_per_second;
247 uint32_t sample_curr;
254 uint32_t pcm_format[2];
256 uint16_t bytes_per_frame[2];
258 uint32_t intr_counter;
264 #define CHAN_OP_NONE 0
265 #define CHAN_OP_START 1
266 #define CHAN_OP_STOP 2
267 #define CHAN_OP_DRAIN 3
270 #define UMIDI_EMB_JACK_MAX 16 /* units */
271 #define UMIDI_TX_FRAMES 256 /* units */
272 #define UMIDI_TX_BUFFER (UMIDI_TX_FRAMES * 4) /* bytes */
280 struct umidi_sub_chan {
281 struct usb_fifo_sc fifo;
286 #define UMIDI_ST_UNKNOWN 0 /* scan for command */
287 #define UMIDI_ST_1PARAM 1
288 #define UMIDI_ST_2PARAM_1 2
289 #define UMIDI_ST_2PARAM_2 3
290 #define UMIDI_ST_SYSEX_0 4
291 #define UMIDI_ST_SYSEX_1 5
292 #define UMIDI_ST_SYSEX_2 6
295 uint8_t write_open:1;
301 struct umidi_sub_chan sub[UMIDI_EMB_JACK_MAX];
304 struct usb_xfer *xfer[UMIDI_N_TRANSFER];
307 uint8_t iface_alt_index;
309 uint8_t read_open_refcount;
310 uint8_t write_open_refcount;
313 uint8_t max_emb_jack;
315 uint8_t single_command;
318 struct uaudio_search_result {
319 uint8_t bit_input[(256 + 7) / 8];
320 uint8_t bit_output[(256 + 7) / 8];
321 uint8_t recurse_level;
327 UAUDIO_HID_RX_TRANSFER,
328 UAUDIO_HID_N_TRANSFER,
332 struct usb_xfer *xfer[UAUDIO_HID_N_TRANSFER];
333 struct hid_location volume_up_loc;
334 struct hid_location volume_down_loc;
335 struct hid_location mute_loc;
337 #define UAUDIO_HID_VALID 0x0001
338 #define UAUDIO_HID_HAS_ID 0x0002
339 #define UAUDIO_HID_HAS_VOLUME_UP 0x0004
340 #define UAUDIO_HID_HAS_VOLUME_DOWN 0x0008
341 #define UAUDIO_HID_HAS_MUTE 0x0010
343 uint8_t volume_up_id;
344 uint8_t volume_down_id;
348 #define UAUDIO_SPDIF_OUT 0x01 /* Enable S/PDIF output */
349 #define UAUDIO_SPDIF_OUT_48K 0x02 /* Out sample rate = 48K */
350 #define UAUDIO_SPDIF_OUT_96K 0x04 /* Out sample rate = 96K */
351 #define UAUDIO_SPDIF_IN_MIX 0x10 /* Input mix enable */
353 struct uaudio_softc {
354 struct sbuf sc_sndstat;
355 struct sndcard_func sc_sndcard_func;
356 struct uaudio_chan sc_rec_chan;
357 struct uaudio_chan sc_play_chan;
358 struct umidi_chan sc_midi_chan;
359 struct uaudio_hid sc_hid;
360 struct uaudio_search_result sc_mixer_clocks;
361 struct uaudio_mixer_node sc_mixer_node;
362 struct uaudio_configure_msg sc_config_msg[2];
364 struct mtx *sc_mixer_lock;
365 struct snd_mixer *sc_mixer_dev;
366 struct usb_device *sc_udev;
367 struct usb_xfer *sc_mixer_xfer[1];
368 struct uaudio_mixer_node *sc_mixer_root;
369 struct uaudio_mixer_node *sc_mixer_curr;
370 int (*sc_set_spdif_fn) (struct uaudio_softc *, int);
372 uint32_t sc_mix_info;
373 uint32_t sc_recsrc_info;
375 uint16_t sc_audio_rev;
376 uint16_t sc_mixer_count;
378 uint8_t sc_sndstat_valid;
379 uint8_t sc_mixer_iface_index;
380 uint8_t sc_mixer_iface_no;
381 uint8_t sc_mixer_chan;
382 uint8_t sc_pcm_registered:1;
383 uint8_t sc_mixer_init:1;
384 uint8_t sc_uq_audio_swap_lr:1;
385 uint8_t sc_uq_au_inp_async:1;
386 uint8_t sc_uq_au_no_xu:1;
387 uint8_t sc_uq_bad_adc:1;
388 uint8_t sc_uq_au_vendor_class:1;
389 uint8_t sc_pcm_bitperfect:1;
392 struct uaudio_terminal_node {
394 const struct usb_descriptor *desc;
395 const struct usb_audio_input_terminal *it_v1;
396 const struct usb_audio_output_terminal *ot_v1;
397 const struct usb_audio_mixer_unit_0 *mu_v1;
398 const struct usb_audio_selector_unit *su_v1;
399 const struct usb_audio_feature_unit *fu_v1;
400 const struct usb_audio_processing_unit_0 *pu_v1;
401 const struct usb_audio_extension_unit_0 *eu_v1;
402 const struct usb_audio20_clock_source_unit *csrc_v2;
403 const struct usb_audio20_clock_selector_unit_0 *csel_v2;
404 const struct usb_audio20_clock_multiplier_unit *cmul_v2;
405 const struct usb_audio20_input_terminal *it_v2;
406 const struct usb_audio20_output_terminal *ot_v2;
407 const struct usb_audio20_mixer_unit_0 *mu_v2;
408 const struct usb_audio20_selector_unit *su_v2;
409 const struct usb_audio20_feature_unit *fu_v2;
410 const struct usb_audio20_sample_rate_unit *ru_v2;
411 const struct usb_audio20_processing_unit_0 *pu_v2;
412 const struct usb_audio20_extension_unit_0 *eu_v2;
413 const struct usb_audio20_effect_unit *ef_v2;
415 struct uaudio_search_result usr;
416 struct uaudio_terminal_node *root;
419 struct uaudio_format {
422 uint32_t freebsd_fmt;
423 const char *description;
426 static const struct uaudio_format uaudio10_formats[] = {
428 {UA_FMT_PCM8, 8, AFMT_U8, "8-bit U-LE PCM"},
429 {UA_FMT_PCM8, 16, AFMT_U16_LE, "16-bit U-LE PCM"},
430 {UA_FMT_PCM8, 24, AFMT_U24_LE, "24-bit U-LE PCM"},
431 {UA_FMT_PCM8, 32, AFMT_U32_LE, "32-bit U-LE PCM"},
433 {UA_FMT_PCM, 8, AFMT_S8, "8-bit S-LE PCM"},
434 {UA_FMT_PCM, 16, AFMT_S16_LE, "16-bit S-LE PCM"},
435 {UA_FMT_PCM, 24, AFMT_S24_LE, "24-bit S-LE PCM"},
436 {UA_FMT_PCM, 32, AFMT_S32_LE, "32-bit S-LE PCM"},
438 {UA_FMT_ALAW, 8, AFMT_A_LAW, "8-bit A-Law"},
439 {UA_FMT_MULAW, 8, AFMT_MU_LAW, "8-bit mu-Law"},
444 static const struct uaudio_format uaudio20_formats[] = {
446 {UA20_FMT_PCM, 8, AFMT_S8, "8-bit S-LE PCM"},
447 {UA20_FMT_PCM, 16, AFMT_S16_LE, "16-bit S-LE PCM"},
448 {UA20_FMT_PCM, 24, AFMT_S24_LE, "24-bit S-LE PCM"},
449 {UA20_FMT_PCM, 32, AFMT_S32_LE, "32-bit S-LE PCM"},
451 {UA20_FMT_PCM8, 8, AFMT_U8, "8-bit U-LE PCM"},
452 {UA20_FMT_PCM8, 16, AFMT_U16_LE, "16-bit U-LE PCM"},
453 {UA20_FMT_PCM8, 24, AFMT_U24_LE, "24-bit U-LE PCM"},
454 {UA20_FMT_PCM8, 32, AFMT_U32_LE, "32-bit U-LE PCM"},
456 {UA20_FMT_ALAW, 8, AFMT_A_LAW, "8-bit A-Law"},
457 {UA20_FMT_MULAW, 8, AFMT_MU_LAW, "8-bit mu-Law"},
466 #define UAC_NCLASSES 4
469 static const char *uac_names[] = {
470 "outputs", "inputs", "equalization", "record"
477 static device_probe_t uaudio_probe;
478 static device_attach_t uaudio_attach;
479 static device_detach_t uaudio_detach;
481 static usb_callback_t uaudio_chan_play_callback;
482 static usb_callback_t uaudio_chan_play_sync_callback;
483 static usb_callback_t uaudio_chan_record_callback;
484 static usb_callback_t uaudio_chan_record_sync_callback;
485 static usb_callback_t uaudio_mixer_write_cfg_callback;
486 static usb_callback_t umidi_bulk_read_callback;
487 static usb_callback_t umidi_bulk_write_callback;
488 static usb_callback_t uaudio_hid_rx_callback;
490 static usb_proc_callback_t uaudio_configure_msg;
492 /* ==== USB mixer ==== */
494 static int uaudio_mixer_sysctl_handler(SYSCTL_HANDLER_ARGS);
495 static void uaudio_mixer_ctl_free(struct uaudio_softc *);
496 static void uaudio_mixer_register_sysctl(struct uaudio_softc *, device_t);
497 static void uaudio_mixer_reload_all(struct uaudio_softc *);
498 static void uaudio_mixer_controls_create_ftu(struct uaudio_softc *);
500 /* ==== USB audio v1.0 ==== */
502 static void uaudio_mixer_add_mixer(struct uaudio_softc *,
503 const struct uaudio_terminal_node *, int);
504 static void uaudio_mixer_add_selector(struct uaudio_softc *,
505 const struct uaudio_terminal_node *, int);
506 static uint32_t uaudio_mixer_feature_get_bmaControls(
507 const struct usb_audio_feature_unit *, uint8_t);
508 static void uaudio_mixer_add_feature(struct uaudio_softc *,
509 const struct uaudio_terminal_node *, int);
510 static void uaudio_mixer_add_processing_updown(struct uaudio_softc *,
511 const struct uaudio_terminal_node *, int);
512 static void uaudio_mixer_add_processing(struct uaudio_softc *,
513 const struct uaudio_terminal_node *, int);
514 static void uaudio_mixer_add_extension(struct uaudio_softc *,
515 const struct uaudio_terminal_node *, int);
516 static struct usb_audio_cluster uaudio_mixer_get_cluster(uint8_t,
517 const struct uaudio_terminal_node *);
518 static uint16_t uaudio_mixer_determine_class(const struct uaudio_terminal_node *,
519 struct uaudio_mixer_node *);
520 static uint16_t uaudio_mixer_feature_name(const struct uaudio_terminal_node *,
521 struct uaudio_mixer_node *);
522 static void uaudio_mixer_find_inputs_sub(struct uaudio_terminal_node *,
523 const uint8_t *, uint8_t, struct uaudio_search_result *);
524 static const void *uaudio_mixer_verify_desc(const void *, uint32_t);
525 static usb_error_t uaudio_set_speed(struct usb_device *, uint8_t, uint32_t);
526 static int uaudio_mixer_get(struct usb_device *, uint16_t, uint8_t,
527 struct uaudio_mixer_node *);
529 /* ==== USB audio v2.0 ==== */
531 static void uaudio20_mixer_add_mixer(struct uaudio_softc *,
532 const struct uaudio_terminal_node *, int);
533 static void uaudio20_mixer_add_selector(struct uaudio_softc *,
534 const struct uaudio_terminal_node *, int);
535 static void uaudio20_mixer_add_feature(struct uaudio_softc *,
536 const struct uaudio_terminal_node *, int);
537 static struct usb_audio20_cluster uaudio20_mixer_get_cluster(uint8_t,
538 const struct uaudio_terminal_node *);
539 static uint16_t uaudio20_mixer_determine_class(const struct uaudio_terminal_node *,
540 struct uaudio_mixer_node *);
541 static uint16_t uaudio20_mixer_feature_name(const struct uaudio_terminal_node *,
542 struct uaudio_mixer_node *);
543 static void uaudio20_mixer_find_inputs_sub(struct uaudio_terminal_node *,
544 const uint8_t *, uint8_t, struct uaudio_search_result *);
545 static const void *uaudio20_mixer_verify_desc(const void *, uint32_t);
546 static usb_error_t uaudio20_set_speed(struct usb_device *, uint8_t,
549 /* USB audio v1.0 and v2.0 */
551 static void uaudio_chan_fill_info_sub(struct uaudio_softc *,
552 struct usb_device *, uint32_t, uint8_t, uint8_t);
553 static void uaudio_chan_fill_info(struct uaudio_softc *,
554 struct usb_device *);
555 static void uaudio_mixer_add_ctl_sub(struct uaudio_softc *,
556 struct uaudio_mixer_node *);
557 static void uaudio_mixer_add_ctl(struct uaudio_softc *,
558 struct uaudio_mixer_node *);
559 static void uaudio_mixer_fill_info(struct uaudio_softc *,
560 struct usb_device *, void *);
561 static int uaudio_mixer_signext(uint8_t, int);
562 static void uaudio_mixer_init(struct uaudio_softc *);
563 static const struct uaudio_terminal_node *uaudio_mixer_get_input(
564 const struct uaudio_terminal_node *, uint8_t);
565 static const struct uaudio_terminal_node *uaudio_mixer_get_output(
566 const struct uaudio_terminal_node *, uint8_t);
567 static void uaudio_mixer_find_outputs_sub(struct uaudio_terminal_node *,
568 uint8_t, uint8_t, struct uaudio_search_result *);
569 static uint8_t umidi_convert_to_usb(struct umidi_sub_chan *, uint8_t, uint8_t);
570 static struct umidi_sub_chan *umidi_sub_by_fifo(struct usb_fifo *);
571 static void umidi_start_read(struct usb_fifo *);
572 static void umidi_stop_read(struct usb_fifo *);
573 static void umidi_start_write(struct usb_fifo *);
574 static void umidi_stop_write(struct usb_fifo *);
575 static int umidi_open(struct usb_fifo *, int);
576 static int umidi_ioctl(struct usb_fifo *, u_long cmd, void *, int);
577 static void umidi_close(struct usb_fifo *, int);
578 static void umidi_init(device_t dev);
579 static int umidi_probe(device_t dev);
580 static int umidi_detach(device_t dev);
581 static int uaudio_hid_probe(struct uaudio_softc *sc,
582 struct usb_attach_arg *uaa);
583 static void uaudio_hid_detach(struct uaudio_softc *sc);
586 static void uaudio_chan_dump_ep_desc(
587 const usb_endpoint_descriptor_audio_t *);
590 static const struct usb_config
591 uaudio_cfg_record[UAUDIO_NCHANBUFS + 1] = {
593 .type = UE_ISOCHRONOUS,
594 .endpoint = UE_ADDR_ANY,
595 .direction = UE_DIR_IN,
596 .bufsize = 0, /* use "wMaxPacketSize * frames" */
597 .frames = UAUDIO_NFRAMES,
598 .flags = {.short_xfer_ok = 1,},
599 .callback = &uaudio_chan_record_callback,
603 .type = UE_ISOCHRONOUS,
604 .endpoint = UE_ADDR_ANY,
605 .direction = UE_DIR_IN,
606 .bufsize = 0, /* use "wMaxPacketSize * frames" */
607 .frames = UAUDIO_NFRAMES,
608 .flags = {.short_xfer_ok = 1,},
609 .callback = &uaudio_chan_record_callback,
613 .type = UE_ISOCHRONOUS,
614 .endpoint = UE_ADDR_ANY,
615 .direction = UE_DIR_OUT,
616 .bufsize = 0, /* use "wMaxPacketSize * frames" */
618 .flags = {.no_pipe_ok = 1,.short_xfer_ok = 1,},
619 .callback = &uaudio_chan_record_sync_callback,
623 static const struct usb_config
624 uaudio_cfg_play[UAUDIO_NCHANBUFS + 1] = {
626 .type = UE_ISOCHRONOUS,
627 .endpoint = UE_ADDR_ANY,
628 .direction = UE_DIR_OUT,
629 .bufsize = 0, /* use "wMaxPacketSize * frames" */
630 .frames = UAUDIO_NFRAMES,
631 .flags = {.short_xfer_ok = 1,},
632 .callback = &uaudio_chan_play_callback,
636 .type = UE_ISOCHRONOUS,
637 .endpoint = UE_ADDR_ANY,
638 .direction = UE_DIR_OUT,
639 .bufsize = 0, /* use "wMaxPacketSize * frames" */
640 .frames = UAUDIO_NFRAMES,
641 .flags = {.short_xfer_ok = 1,},
642 .callback = &uaudio_chan_play_callback,
646 .type = UE_ISOCHRONOUS,
647 .endpoint = UE_ADDR_ANY,
648 .direction = UE_DIR_IN,
649 .bufsize = 0, /* use "wMaxPacketSize * frames" */
651 .flags = {.no_pipe_ok = 1,.short_xfer_ok = 1,},
652 .callback = &uaudio_chan_play_sync_callback,
656 static const struct usb_config
657 uaudio_mixer_config[1] = {
660 .endpoint = 0x00, /* Control pipe */
661 .direction = UE_DIR_ANY,
662 .bufsize = (sizeof(struct usb_device_request) + 4),
663 .callback = &uaudio_mixer_write_cfg_callback,
664 .timeout = 1000, /* 1 second */
669 uint8_t umidi_cmd_to_len[16] = {
670 [0x0] = 0, /* reserved */
671 [0x1] = 0, /* reserved */
672 [0x2] = 2, /* bytes */
673 [0x3] = 3, /* bytes */
674 [0x4] = 3, /* bytes */
675 [0x5] = 1, /* bytes */
676 [0x6] = 2, /* bytes */
677 [0x7] = 3, /* bytes */
678 [0x8] = 3, /* bytes */
679 [0x9] = 3, /* bytes */
680 [0xA] = 3, /* bytes */
681 [0xB] = 3, /* bytes */
682 [0xC] = 2, /* bytes */
683 [0xD] = 2, /* bytes */
684 [0xE] = 3, /* bytes */
685 [0xF] = 1, /* bytes */
688 static const struct usb_config
689 umidi_config[UMIDI_N_TRANSFER] = {
690 [UMIDI_TX_TRANSFER] = {
692 .endpoint = UE_ADDR_ANY,
693 .direction = UE_DIR_OUT,
694 .bufsize = UMIDI_TX_BUFFER,
695 .flags = {.no_pipe_ok = 1},
696 .callback = &umidi_bulk_write_callback,
699 [UMIDI_RX_TRANSFER] = {
701 .endpoint = UE_ADDR_ANY,
702 .direction = UE_DIR_IN,
703 .bufsize = 4, /* bytes */
704 .flags = {.short_xfer_ok = 1,.proxy_buffer = 1,.no_pipe_ok = 1},
705 .callback = &umidi_bulk_read_callback,
709 static const struct usb_config
710 uaudio_hid_config[UAUDIO_HID_N_TRANSFER] = {
711 [UAUDIO_HID_RX_TRANSFER] = {
712 .type = UE_INTERRUPT,
713 .endpoint = UE_ADDR_ANY,
714 .direction = UE_DIR_IN,
715 .bufsize = 0, /* use wMaxPacketSize */
716 .flags = {.short_xfer_ok = 1,},
717 .callback = &uaudio_hid_rx_callback,
721 static devclass_t uaudio_devclass;
723 static device_method_t uaudio_methods[] = {
724 DEVMETHOD(device_probe, uaudio_probe),
725 DEVMETHOD(device_attach, uaudio_attach),
726 DEVMETHOD(device_detach, uaudio_detach),
727 DEVMETHOD(device_suspend, bus_generic_suspend),
728 DEVMETHOD(device_resume, bus_generic_resume),
729 DEVMETHOD(device_shutdown, bus_generic_shutdown),
734 static driver_t uaudio_driver = {
736 .methods = uaudio_methods,
737 .size = sizeof(struct uaudio_softc),
740 /* The following table is derived from Linux's quirks-table.h */
741 static const STRUCT_USB_HOST_ID uaudio_vendor_midi[] = {
742 { USB_VPI(USB_VENDOR_YAMAHA, 0x1000, 0) }, /* UX256 */
743 { USB_VPI(USB_VENDOR_YAMAHA, 0x1001, 0) }, /* MU1000 */
744 { USB_VPI(USB_VENDOR_YAMAHA, 0x1002, 0) }, /* MU2000 */
745 { USB_VPI(USB_VENDOR_YAMAHA, 0x1003, 0) }, /* MU500 */
746 { USB_VPI(USB_VENDOR_YAMAHA, 0x1004, 3) }, /* UW500 */
747 { USB_VPI(USB_VENDOR_YAMAHA, 0x1005, 0) }, /* MOTIF6 */
748 { USB_VPI(USB_VENDOR_YAMAHA, 0x1006, 0) }, /* MOTIF7 */
749 { USB_VPI(USB_VENDOR_YAMAHA, 0x1007, 0) }, /* MOTIF8 */
750 { USB_VPI(USB_VENDOR_YAMAHA, 0x1008, 0) }, /* UX96 */
751 { USB_VPI(USB_VENDOR_YAMAHA, 0x1009, 0) }, /* UX16 */
752 { USB_VPI(USB_VENDOR_YAMAHA, 0x100a, 3) }, /* EOS BX */
753 { USB_VPI(USB_VENDOR_YAMAHA, 0x100c, 0) }, /* UC-MX */
754 { USB_VPI(USB_VENDOR_YAMAHA, 0x100d, 0) }, /* UC-KX */
755 { USB_VPI(USB_VENDOR_YAMAHA, 0x100e, 0) }, /* S08 */
756 { USB_VPI(USB_VENDOR_YAMAHA, 0x100f, 0) }, /* CLP-150 */
757 { USB_VPI(USB_VENDOR_YAMAHA, 0x1010, 0) }, /* CLP-170 */
758 { USB_VPI(USB_VENDOR_YAMAHA, 0x1011, 0) }, /* P-250 */
759 { USB_VPI(USB_VENDOR_YAMAHA, 0x1012, 0) }, /* TYROS */
760 { USB_VPI(USB_VENDOR_YAMAHA, 0x1013, 0) }, /* PF-500 */
761 { USB_VPI(USB_VENDOR_YAMAHA, 0x1014, 0) }, /* S90 */
762 { USB_VPI(USB_VENDOR_YAMAHA, 0x1015, 0) }, /* MOTIF-R */
763 { USB_VPI(USB_VENDOR_YAMAHA, 0x1016, 0) }, /* MDP-5 */
764 { USB_VPI(USB_VENDOR_YAMAHA, 0x1017, 0) }, /* CVP-204 */
765 { USB_VPI(USB_VENDOR_YAMAHA, 0x1018, 0) }, /* CVP-206 */
766 { USB_VPI(USB_VENDOR_YAMAHA, 0x1019, 0) }, /* CVP-208 */
767 { USB_VPI(USB_VENDOR_YAMAHA, 0x101a, 0) }, /* CVP-210 */
768 { USB_VPI(USB_VENDOR_YAMAHA, 0x101b, 0) }, /* PSR-1100 */
769 { USB_VPI(USB_VENDOR_YAMAHA, 0x101c, 0) }, /* PSR-2100 */
770 { USB_VPI(USB_VENDOR_YAMAHA, 0x101d, 0) }, /* CLP-175 */
771 { USB_VPI(USB_VENDOR_YAMAHA, 0x101e, 0) }, /* PSR-K1 */
772 { USB_VPI(USB_VENDOR_YAMAHA, 0x101f, 0) }, /* EZ-J24 */
773 { USB_VPI(USB_VENDOR_YAMAHA, 0x1020, 0) }, /* EZ-250i */
774 { USB_VPI(USB_VENDOR_YAMAHA, 0x1021, 0) }, /* MOTIF ES 6 */
775 { USB_VPI(USB_VENDOR_YAMAHA, 0x1022, 0) }, /* MOTIF ES 7 */
776 { USB_VPI(USB_VENDOR_YAMAHA, 0x1023, 0) }, /* MOTIF ES 8 */
777 { USB_VPI(USB_VENDOR_YAMAHA, 0x1024, 0) }, /* CVP-301 */
778 { USB_VPI(USB_VENDOR_YAMAHA, 0x1025, 0) }, /* CVP-303 */
779 { USB_VPI(USB_VENDOR_YAMAHA, 0x1026, 0) }, /* CVP-305 */
780 { USB_VPI(USB_VENDOR_YAMAHA, 0x1027, 0) }, /* CVP-307 */
781 { USB_VPI(USB_VENDOR_YAMAHA, 0x1028, 0) }, /* CVP-309 */
782 { USB_VPI(USB_VENDOR_YAMAHA, 0x1029, 0) }, /* CVP-309GP */
783 { USB_VPI(USB_VENDOR_YAMAHA, 0x102a, 0) }, /* PSR-1500 */
784 { USB_VPI(USB_VENDOR_YAMAHA, 0x102b, 0) }, /* PSR-3000 */
785 { USB_VPI(USB_VENDOR_YAMAHA, 0x102e, 0) }, /* ELS-01/01C */
786 { USB_VPI(USB_VENDOR_YAMAHA, 0x1030, 0) }, /* PSR-295/293 */
787 { USB_VPI(USB_VENDOR_YAMAHA, 0x1031, 0) }, /* DGX-205/203 */
788 { USB_VPI(USB_VENDOR_YAMAHA, 0x1032, 0) }, /* DGX-305 */
789 { USB_VPI(USB_VENDOR_YAMAHA, 0x1033, 0) }, /* DGX-505 */
790 { USB_VPI(USB_VENDOR_YAMAHA, 0x1034, 0) }, /* NULL */
791 { USB_VPI(USB_VENDOR_YAMAHA, 0x1035, 0) }, /* NULL */
792 { USB_VPI(USB_VENDOR_YAMAHA, 0x1036, 0) }, /* NULL */
793 { USB_VPI(USB_VENDOR_YAMAHA, 0x1037, 0) }, /* NULL */
794 { USB_VPI(USB_VENDOR_YAMAHA, 0x1038, 0) }, /* NULL */
795 { USB_VPI(USB_VENDOR_YAMAHA, 0x1039, 0) }, /* NULL */
796 { USB_VPI(USB_VENDOR_YAMAHA, 0x103a, 0) }, /* NULL */
797 { USB_VPI(USB_VENDOR_YAMAHA, 0x103b, 0) }, /* NULL */
798 { USB_VPI(USB_VENDOR_YAMAHA, 0x103c, 0) }, /* NULL */
799 { USB_VPI(USB_VENDOR_YAMAHA, 0x103d, 0) }, /* NULL */
800 { USB_VPI(USB_VENDOR_YAMAHA, 0x103e, 0) }, /* NULL */
801 { USB_VPI(USB_VENDOR_YAMAHA, 0x103f, 0) }, /* NULL */
802 { USB_VPI(USB_VENDOR_YAMAHA, 0x1040, 0) }, /* NULL */
803 { USB_VPI(USB_VENDOR_YAMAHA, 0x1041, 0) }, /* NULL */
804 { USB_VPI(USB_VENDOR_YAMAHA, 0x1042, 0) }, /* NULL */
805 { USB_VPI(USB_VENDOR_YAMAHA, 0x1043, 0) }, /* NULL */
806 { USB_VPI(USB_VENDOR_YAMAHA, 0x1044, 0) }, /* NULL */
807 { USB_VPI(USB_VENDOR_YAMAHA, 0x1045, 0) }, /* NULL */
808 { USB_VPI(USB_VENDOR_YAMAHA, 0x104e, 0) }, /* NULL */
809 { USB_VPI(USB_VENDOR_YAMAHA, 0x104f, 0) }, /* NULL */
810 { USB_VPI(USB_VENDOR_YAMAHA, 0x1050, 0) }, /* NULL */
811 { USB_VPI(USB_VENDOR_YAMAHA, 0x1051, 0) }, /* NULL */
812 { USB_VPI(USB_VENDOR_YAMAHA, 0x1052, 0) }, /* NULL */
813 { USB_VPI(USB_VENDOR_YAMAHA, 0x1053, 0) }, /* NULL */
814 { USB_VPI(USB_VENDOR_YAMAHA, 0x1054, 0) }, /* NULL */
815 { USB_VPI(USB_VENDOR_YAMAHA, 0x1055, 0) }, /* NULL */
816 { USB_VPI(USB_VENDOR_YAMAHA, 0x1056, 0) }, /* NULL */
817 { USB_VPI(USB_VENDOR_YAMAHA, 0x1057, 0) }, /* NULL */
818 { USB_VPI(USB_VENDOR_YAMAHA, 0x1058, 0) }, /* NULL */
819 { USB_VPI(USB_VENDOR_YAMAHA, 0x1059, 0) }, /* NULL */
820 { USB_VPI(USB_VENDOR_YAMAHA, 0x105a, 0) }, /* NULL */
821 { USB_VPI(USB_VENDOR_YAMAHA, 0x105b, 0) }, /* NULL */
822 { USB_VPI(USB_VENDOR_YAMAHA, 0x105c, 0) }, /* NULL */
823 { USB_VPI(USB_VENDOR_YAMAHA, 0x105d, 0) }, /* NULL */
824 { USB_VPI(USB_VENDOR_YAMAHA, 0x1503, 3) }, /* MOX6/MOX8 */
825 { USB_VPI(USB_VENDOR_YAMAHA, 0x2000, 0) }, /* DGP-7 */
826 { USB_VPI(USB_VENDOR_YAMAHA, 0x2001, 0) }, /* DGP-5 */
827 { USB_VPI(USB_VENDOR_YAMAHA, 0x2002, 0) }, /* NULL */
828 { USB_VPI(USB_VENDOR_YAMAHA, 0x2003, 0) }, /* NULL */
829 { USB_VPI(USB_VENDOR_YAMAHA, 0x5000, 0) }, /* CS1D */
830 { USB_VPI(USB_VENDOR_YAMAHA, 0x5001, 0) }, /* DSP1D */
831 { USB_VPI(USB_VENDOR_YAMAHA, 0x5002, 0) }, /* DME32 */
832 { USB_VPI(USB_VENDOR_YAMAHA, 0x5003, 0) }, /* DM2000 */
833 { USB_VPI(USB_VENDOR_YAMAHA, 0x5004, 0) }, /* 02R96 */
834 { USB_VPI(USB_VENDOR_YAMAHA, 0x5005, 0) }, /* ACU16-C */
835 { USB_VPI(USB_VENDOR_YAMAHA, 0x5006, 0) }, /* NHB32-C */
836 { USB_VPI(USB_VENDOR_YAMAHA, 0x5007, 0) }, /* DM1000 */
837 { USB_VPI(USB_VENDOR_YAMAHA, 0x5008, 0) }, /* 01V96 */
838 { USB_VPI(USB_VENDOR_YAMAHA, 0x5009, 0) }, /* SPX2000 */
839 { USB_VPI(USB_VENDOR_YAMAHA, 0x500a, 0) }, /* PM5D */
840 { USB_VPI(USB_VENDOR_YAMAHA, 0x500b, 0) }, /* DME64N */
841 { USB_VPI(USB_VENDOR_YAMAHA, 0x500c, 0) }, /* DME24N */
842 { USB_VPI(USB_VENDOR_YAMAHA, 0x500d, 0) }, /* NULL */
843 { USB_VPI(USB_VENDOR_YAMAHA, 0x500e, 0) }, /* NULL */
844 { USB_VPI(USB_VENDOR_YAMAHA, 0x500f, 0) }, /* NULL */
845 { USB_VPI(USB_VENDOR_YAMAHA, 0x7000, 0) }, /* DTX */
846 { USB_VPI(USB_VENDOR_YAMAHA, 0x7010, 0) }, /* UB99 */
849 static const STRUCT_USB_HOST_ID __used uaudio_devs[] = {
850 /* Generic USB audio class match */
851 {USB_IFACE_CLASS(UICLASS_AUDIO),
852 USB_IFACE_SUBCLASS(UISUBCLASS_AUDIOCONTROL),},
853 /* Generic USB MIDI class match */
854 {USB_IFACE_CLASS(UICLASS_AUDIO),
855 USB_IFACE_SUBCLASS(UISUBCLASS_MIDISTREAM),},
859 uaudio_probe(device_t dev)
861 struct usb_attach_arg *uaa = device_get_ivars(dev);
863 if (uaa->usb_mode != USB_MODE_HOST)
866 /* lookup non-standard device(s) */
868 if (usbd_lookup_id_by_uaa(uaudio_vendor_midi,
869 sizeof(uaudio_vendor_midi), uaa) == 0) {
870 return (BUS_PROBE_SPECIFIC);
873 if (uaa->info.bInterfaceClass != UICLASS_AUDIO) {
874 if (uaa->info.bInterfaceClass != UICLASS_VENDOR ||
875 usb_test_quirk(uaa, UQ_AU_VENDOR_CLASS) == 0)
879 /* check for AUDIO control interface */
881 if (uaa->info.bInterfaceSubClass == UISUBCLASS_AUDIOCONTROL) {
882 if (usb_test_quirk(uaa, UQ_BAD_AUDIO))
885 return (BUS_PROBE_GENERIC);
888 /* check for MIDI stream */
890 if (uaa->info.bInterfaceSubClass == UISUBCLASS_MIDISTREAM) {
891 if (usb_test_quirk(uaa, UQ_BAD_MIDI))
894 return (BUS_PROBE_GENERIC);
900 * Set Cmedia CM6206 S/PDIF settings
901 * Source: CM6206 Datasheet v2.3.
904 uaudio_set_spdif_cm6206(struct uaudio_softc *sc, int flags)
906 uint8_t cmd[2][4] = {
907 {0x20, 0x20, 0x00, 0},
908 {0x20, 0x30, 0x02, 1}
912 if (flags & UAUDIO_SPDIF_OUT)
917 if (flags & UAUDIO_SPDIF_OUT_96K)
918 cmd[0][1] = 0x60; /* 96K: 3'b110 */
920 if (flags & UAUDIO_SPDIF_IN_MIX)
921 cmd[1][1] = 0x03; /* SPDIFMIX */
923 for (i = 0; i < 2; i++) {
924 if (usbd_req_set_report(sc->sc_udev, NULL,
925 cmd[i], sizeof(cmd[0]),
926 sc->sc_mixer_iface_index, UHID_OUTPUT_REPORT, 0) != 0) {
934 uaudio_set_spdif_dummy(struct uaudio_softc *sc, int flags)
940 uaudio_attach(device_t dev)
942 struct usb_attach_arg *uaa = device_get_ivars(dev);
943 struct uaudio_softc *sc = device_get_softc(dev);
944 struct usb_interface_descriptor *id;
948 sc->sc_play_chan.priv_sc = sc;
949 sc->sc_rec_chan.priv_sc = sc;
950 sc->sc_udev = uaa->device;
951 sc->sc_mixer_iface_index = uaa->info.bIfaceIndex;
952 sc->sc_mixer_iface_no = uaa->info.bIfaceNum;
953 sc->sc_config_msg[0].hdr.pm_callback = &uaudio_configure_msg;
954 sc->sc_config_msg[0].sc = sc;
955 sc->sc_config_msg[1].hdr.pm_callback = &uaudio_configure_msg;
956 sc->sc_config_msg[1].sc = sc;
958 if (usb_test_quirk(uaa, UQ_AUDIO_SWAP_LR))
959 sc->sc_uq_audio_swap_lr = 1;
961 if (usb_test_quirk(uaa, UQ_AU_INP_ASYNC))
962 sc->sc_uq_au_inp_async = 1;
964 if (usb_test_quirk(uaa, UQ_AU_NO_XU))
965 sc->sc_uq_au_no_xu = 1;
967 if (usb_test_quirk(uaa, UQ_BAD_ADC))
968 sc->sc_uq_bad_adc = 1;
970 if (usb_test_quirk(uaa, UQ_AU_VENDOR_CLASS))
971 sc->sc_uq_au_vendor_class = 1;
973 /* set S/PDIF function */
974 if (usb_test_quirk(uaa, UQ_AU_SET_SPDIF_CM6206))
975 sc->sc_set_spdif_fn = uaudio_set_spdif_cm6206;
977 sc->sc_set_spdif_fn = uaudio_set_spdif_dummy;
981 device_set_usb_desc(dev);
983 id = usbd_get_interface_descriptor(uaa->iface);
985 /* must fill mixer info before channel info */
986 uaudio_mixer_fill_info(sc, uaa->device, id);
988 /* fill channel info */
989 uaudio_chan_fill_info(sc, uaa->device);
991 DPRINTF("audio rev %d.%02x\n",
992 sc->sc_audio_rev >> 8,
993 sc->sc_audio_rev & 0xff);
995 if (sc->sc_mixer_count == 0) {
996 if (uaa->info.idVendor == USB_VENDOR_MAUDIO &&
997 (uaa->info.idProduct == USB_PRODUCT_MAUDIO_FASTTRACKULTRA ||
998 uaa->info.idProduct == USB_PRODUCT_MAUDIO_FASTTRACKULTRA8R)) {
999 DPRINTF("Generating mixer descriptors\n");
1000 uaudio_mixer_controls_create_ftu(sc);
1004 DPRINTF("%d mixer controls\n",
1005 sc->sc_mixer_count);
1007 if (sc->sc_play_chan.num_alt > 0) {
1011 * Need to set a default alternate interface, else
1012 * some USB audio devices might go into an infinte
1013 * re-enumeration loop:
1015 err = usbd_set_alt_interface_index(sc->sc_udev,
1016 sc->sc_play_chan.usb_alt[0].iface_index,
1017 sc->sc_play_chan.usb_alt[0].iface_alt_index);
1019 DPRINTF("setting of alternate index failed: %s!\n",
1022 for (x = 0; x != sc->sc_play_chan.num_alt; x++) {
1023 device_printf(dev, "Play: %d Hz, %d ch, %s format, "
1025 sc->sc_play_chan.usb_alt[x].sample_rate,
1026 sc->sc_play_chan.usb_alt[x].channels,
1027 sc->sc_play_chan.usb_alt[x].p_fmt->description);
1030 device_printf(dev, "No playback.\n");
1033 if (sc->sc_rec_chan.num_alt > 0) {
1037 * Need to set a default alternate interface, else
1038 * some USB audio devices might go into an infinte
1039 * re-enumeration loop:
1041 err = usbd_set_alt_interface_index(sc->sc_udev,
1042 sc->sc_rec_chan.usb_alt[0].iface_index,
1043 sc->sc_rec_chan.usb_alt[0].iface_alt_index);
1045 DPRINTF("setting of alternate index failed: %s!\n",
1048 for (x = 0; x != sc->sc_rec_chan.num_alt; x++) {
1049 device_printf(dev, "Record: %d Hz, %d ch, %s format, "
1051 sc->sc_rec_chan.usb_alt[x].sample_rate,
1052 sc->sc_rec_chan.usb_alt[x].channels,
1053 sc->sc_rec_chan.usb_alt[x].p_fmt->description);
1056 device_printf(dev, "No recording.\n");
1059 if (sc->sc_midi_chan.valid == 0) {
1060 if (usbd_lookup_id_by_uaa(uaudio_vendor_midi,
1061 sizeof(uaudio_vendor_midi), uaa) == 0) {
1062 sc->sc_midi_chan.iface_index =
1063 (uint8_t)uaa->driver_info;
1064 sc->sc_midi_chan.iface_alt_index = 0;
1065 sc->sc_midi_chan.valid = 1;
1069 if (sc->sc_midi_chan.valid) {
1071 if (umidi_probe(dev)) {
1074 device_printf(dev, "MIDI sequencer.\n");
1076 device_printf(dev, "No MIDI sequencer.\n");
1079 DPRINTF("doing child attach\n");
1081 /* attach the children */
1083 sc->sc_sndcard_func.func = SCF_PCM;
1086 * Only attach a PCM device if we have a playback, recording
1087 * or mixer device present:
1089 if (sc->sc_play_chan.num_alt > 0 ||
1090 sc->sc_rec_chan.num_alt > 0 ||
1092 child = device_add_child(dev, "pcm", -1);
1094 if (child == NULL) {
1095 DPRINTF("out of memory\n");
1098 device_set_ivars(child, &sc->sc_sndcard_func);
1101 if (bus_generic_attach(dev)) {
1102 DPRINTF("child attach failed\n");
1106 if (uaudio_hid_probe(sc, uaa) == 0) {
1107 device_printf(dev, "HID volume keys found.\n");
1109 device_printf(dev, "No HID volume keys found.\n");
1112 /* reload all mixer settings */
1113 uaudio_mixer_reload_all(sc);
1115 /* enable S/PDIF output, if any */
1116 if (sc->sc_set_spdif_fn(sc,
1117 UAUDIO_SPDIF_OUT | UAUDIO_SPDIF_OUT_48K) != 0) {
1118 device_printf(dev, "Failed to enable S/PDIF at 48K\n");
1120 return (0); /* success */
1128 uaudio_pcm_setflags(device_t dev, uint32_t flags)
1130 pcm_setflags(dev, pcm_getflags(dev) | flags);
1134 uaudio_attach_sub(device_t dev, kobj_class_t mixer_class, kobj_class_t chan_class)
1136 struct uaudio_softc *sc = device_get_softc(device_get_parent(dev));
1137 char status[SND_STATUSLEN];
1139 uaudio_mixer_init(sc);
1141 if (sc->sc_uq_audio_swap_lr) {
1142 DPRINTF("hardware has swapped left and right\n");
1143 /* uaudio_pcm_setflags(dev, SD_F_PSWAPLR); */
1145 if (!(sc->sc_mix_info & SOUND_MASK_PCM)) {
1147 DPRINTF("emulating master volume\n");
1150 * Emulate missing pcm mixer controller
1151 * through FEEDER_VOLUME
1153 uaudio_pcm_setflags(dev, SD_F_SOFTPCMVOL);
1155 if (sc->sc_pcm_bitperfect) {
1156 DPRINTF("device needs bitperfect by default\n");
1157 uaudio_pcm_setflags(dev, SD_F_BITPERFECT);
1159 if (mixer_init(dev, mixer_class, sc))
1161 sc->sc_mixer_init = 1;
1163 mixer_hwvol_init(dev);
1165 snprintf(status, sizeof(status), "at ? %s", PCM_KLDSTRING(snd_uaudio));
1167 if (pcm_register(dev, sc,
1168 (sc->sc_play_chan.num_alt > 0) ? 1 : 0,
1169 (sc->sc_rec_chan.num_alt > 0) ? 1 : 0)) {
1173 uaudio_pcm_setflags(dev, SD_F_MPSAFE);
1174 sc->sc_pcm_registered = 1;
1176 if (sc->sc_play_chan.num_alt > 0) {
1177 pcm_addchan(dev, PCMDIR_PLAY, chan_class, sc);
1179 if (sc->sc_rec_chan.num_alt > 0) {
1180 pcm_addchan(dev, PCMDIR_REC, chan_class, sc);
1182 pcm_setstatus(dev, status);
1184 uaudio_mixer_register_sysctl(sc, dev);
1186 SYSCTL_ADD_INT(device_get_sysctl_ctx(dev),
1187 SYSCTL_CHILDREN(device_get_sysctl_tree(dev)), OID_AUTO,
1188 "feedback_rate", CTLFLAG_RD, &sc->sc_play_chan.feedback_rate,
1189 0, "Feedback sample rate in Hz");
1191 return (0); /* success */
1194 uaudio_detach_sub(dev);
1199 uaudio_detach_sub(device_t dev)
1201 struct uaudio_softc *sc = device_get_softc(device_get_parent(dev));
1204 /* disable S/PDIF output, if any */
1205 (void) sc->sc_set_spdif_fn(sc, 0);
1208 if (sc->sc_pcm_registered) {
1209 error = pcm_unregister(dev);
1211 if (sc->sc_mixer_init) {
1212 error = mixer_uninit(dev);
1217 device_printf(dev, "Waiting for sound application to exit!\n");
1218 usb_pause_mtx(NULL, 2 * hz);
1219 goto repeat; /* try again */
1221 return (0); /* success */
1225 uaudio_detach(device_t dev)
1227 struct uaudio_softc *sc = device_get_softc(dev);
1230 * Stop USB transfers early so that any audio applications
1231 * will time out and close opened /dev/dspX.Y device(s), if
1234 usb_proc_explore_lock(sc->sc_udev);
1235 sc->sc_play_chan.operation = CHAN_OP_DRAIN;
1236 sc->sc_rec_chan.operation = CHAN_OP_DRAIN;
1237 usb_proc_explore_mwait(sc->sc_udev,
1238 &sc->sc_config_msg[0], &sc->sc_config_msg[1]);
1239 usb_proc_explore_unlock(sc->sc_udev);
1241 usbd_transfer_unsetup(sc->sc_play_chan.xfer, UAUDIO_NCHANBUFS + 1);
1242 usbd_transfer_unsetup(sc->sc_rec_chan.xfer, UAUDIO_NCHANBUFS + 1);
1244 uaudio_hid_detach(sc);
1246 if (bus_generic_detach(dev) != 0) {
1247 DPRINTF("detach failed!\n");
1249 sbuf_delete(&sc->sc_sndstat);
1250 sc->sc_sndstat_valid = 0;
1254 /* free mixer data */
1256 uaudio_mixer_ctl_free(sc);
1262 uaudio_get_buffer_size(struct uaudio_chan *ch, uint8_t alt)
1264 struct uaudio_chan_alt *chan_alt = &ch->usb_alt[alt];
1265 /* We use 2 times 8ms of buffer */
1266 uint32_t buf_size = (((chan_alt->sample_rate * (UAUDIO_NFRAMES / 8)) +
1267 1000 - 1) / 1000) * chan_alt->sample_size;
1272 uaudio_configure_msg_sub(struct uaudio_softc *sc,
1273 struct uaudio_chan *chan, int dir)
1275 struct uaudio_chan_alt *chan_alt;
1284 if (chan->num_alt <= 0)
1289 usb_proc_explore_lock(sc->sc_udev);
1290 operation = chan->operation;
1291 chan->operation = CHAN_OP_NONE;
1292 usb_proc_explore_unlock(sc->sc_udev);
1294 mtx_lock(chan->pcm_mtx);
1295 if (chan->cur_alt != chan->set_alt)
1296 set_alt = chan->set_alt;
1298 set_alt = CHAN_MAX_ALT;
1299 mtx_unlock(chan->pcm_mtx);
1301 if (set_alt >= chan->num_alt)
1304 chan_alt = chan->usb_alt + set_alt;
1306 usbd_transfer_unsetup(chan->xfer, UAUDIO_NCHANBUFS + 1);
1308 err = usbd_set_alt_interface_index(sc->sc_udev,
1309 chan_alt->iface_index, chan_alt->iface_alt_index);
1311 DPRINTF("setting of alternate index failed: %s!\n",
1317 * Only set the sample rate if the channel reports that it
1318 * supports the frequency control.
1321 if (sc->sc_audio_rev >= UAUDIO_VERSION_30) {
1323 } else if (sc->sc_audio_rev >= UAUDIO_VERSION_20) {
1326 for (x = 0; x != 256; x++) {
1327 if (dir == PCMDIR_PLAY) {
1328 if (!(sc->sc_mixer_clocks.bit_output[x / 8] &
1333 if (!(sc->sc_mixer_clocks.bit_input[x / 8] &
1339 if (uaudio20_set_speed(sc->sc_udev,
1340 sc->sc_mixer_iface_no, x, chan_alt->sample_rate)) {
1342 * If the endpoint is adaptive setting
1343 * the speed may fail.
1345 DPRINTF("setting of sample rate failed! "
1346 "(continuing anyway)\n");
1349 } else if (chan_alt->p_sed.v1->bmAttributes & UA_SED_FREQ_CONTROL) {
1350 if (uaudio_set_speed(sc->sc_udev,
1351 chan_alt->p_ed1->bEndpointAddress, chan_alt->sample_rate)) {
1353 * If the endpoint is adaptive setting the
1356 DPRINTF("setting of sample rate failed! "
1357 "(continuing anyway)\n");
1360 if (usbd_transfer_setup(sc->sc_udev, &chan_alt->iface_index, chan->xfer,
1361 chan_alt->usb_cfg, UAUDIO_NCHANBUFS + 1, chan, chan->pcm_mtx)) {
1362 DPRINTF("could not allocate USB transfers!\n");
1366 fps = usbd_get_isoc_fps(sc->sc_udev);
1369 /* FULL speed USB */
1370 frames = uaudio_buffer_ms;
1372 /* HIGH speed USB */
1373 frames = uaudio_buffer_ms * 8;
1376 fps_shift = usbd_xfer_get_fps_shift(chan->xfer[0]);
1378 /* down shift number of frames per second, if any */
1380 frames >>= fps_shift;
1382 /* bytes per frame should not be zero */
1383 chan->bytes_per_frame[0] =
1384 ((chan_alt->sample_rate / fps) * chan_alt->sample_size);
1385 chan->bytes_per_frame[1] =
1386 (((chan_alt->sample_rate + fps - 1) / fps) * chan_alt->sample_size);
1388 /* setup data rate dithering, if any */
1389 chan->frames_per_second = fps;
1390 chan->sample_rem = chan_alt->sample_rate % fps;
1391 chan->sample_curr = 0;
1393 /* compute required buffer size */
1394 buf_size = (chan->bytes_per_frame[1] * frames);
1396 if (buf_size > (chan->end - chan->start)) {
1397 DPRINTF("buffer size is too big\n");
1401 chan->intr_frames = frames;
1403 DPRINTF("fps=%d sample_rem=%d\n", (int)fps, (int)chan->sample_rem);
1405 if (chan->intr_frames == 0) {
1406 DPRINTF("frame shift is too high!\n");
1410 mtx_lock(chan->pcm_mtx);
1411 chan->cur_alt = set_alt;
1412 mtx_unlock(chan->pcm_mtx);
1415 #if (UAUDIO_NCHANBUFS != 2)
1416 #error "please update code"
1418 switch (operation) {
1420 mtx_lock(chan->pcm_mtx);
1421 usbd_transfer_start(chan->xfer[0]);
1422 usbd_transfer_start(chan->xfer[1]);
1423 mtx_unlock(chan->pcm_mtx);
1426 mtx_lock(chan->pcm_mtx);
1427 usbd_transfer_stop(chan->xfer[0]);
1428 usbd_transfer_stop(chan->xfer[1]);
1429 mtx_unlock(chan->pcm_mtx);
1437 usbd_transfer_unsetup(chan->xfer, UAUDIO_NCHANBUFS + 1);
1439 mtx_lock(chan->pcm_mtx);
1440 chan->cur_alt = CHAN_MAX_ALT;
1441 mtx_unlock(chan->pcm_mtx);
1445 uaudio_configure_msg(struct usb_proc_msg *pm)
1447 struct uaudio_softc *sc = ((struct uaudio_configure_msg *)pm)->sc;
1449 usb_proc_explore_unlock(sc->sc_udev);
1450 uaudio_configure_msg_sub(sc, &sc->sc_play_chan, PCMDIR_PLAY);
1451 uaudio_configure_msg_sub(sc, &sc->sc_rec_chan, PCMDIR_REC);
1452 usb_proc_explore_lock(sc->sc_udev);
1455 /*========================================================================*
1456 * AS - Audio Stream - routines
1457 *========================================================================*/
1461 uaudio_chan_dump_ep_desc(const usb_endpoint_descriptor_audio_t *ed)
1464 DPRINTF("endpoint=%p bLength=%d bDescriptorType=%d \n"
1465 "bEndpointAddress=%d bmAttributes=0x%x \n"
1466 "wMaxPacketSize=%d bInterval=%d \n"
1467 "bRefresh=%d bSynchAddress=%d\n",
1468 ed, ed->bLength, ed->bDescriptorType,
1469 ed->bEndpointAddress, ed->bmAttributes,
1470 UGETW(ed->wMaxPacketSize), ed->bInterval,
1471 UEP_HAS_REFRESH(ed) ? ed->bRefresh : 0,
1472 UEP_HAS_SYNCADDR(ed) ? ed->bSynchAddress : 0);
1479 * The following is a workaround for broken no-name USB audio devices
1480 * sold by dealextreme called "3D sound". The problem is that the
1481 * manufacturer computed wMaxPacketSize is too small to hold the
1482 * actual data sent. In other words the device sometimes sends more
1483 * data than it actually reports it can send in a single isochronous
1487 uaudio_record_fix_fs(usb_endpoint_descriptor_audio_t *ep,
1488 uint32_t xps, uint32_t add)
1492 mps = UGETW(ep->wMaxPacketSize);
1495 * If the device indicates it can send more data than what the
1496 * sample rate indicates, we apply the workaround.
1500 /* allow additional data */
1503 /* check against the maximum USB 1.x length */
1507 /* check if we should do an update */
1509 /* simply update the wMaxPacketSize field */
1510 USETW(ep->wMaxPacketSize, xps);
1511 DPRINTF("Workaround: Updated wMaxPacketSize "
1512 "from %d to %d bytes.\n",
1513 (int)mps, (int)xps);
1519 uaudio20_check_rate(struct usb_device *udev, uint8_t iface_no,
1520 uint8_t clockid, uint32_t rate)
1522 struct usb_device_request req;
1524 #define UAUDIO20_MAX_RATES 32 /* we support at maxium 32 rates */
1525 uint8_t data[2 + UAUDIO20_MAX_RATES * 12];
1530 DPRINTFN(6, "ifaceno=%d clockid=%d rate=%u\n",
1531 iface_no, clockid, rate);
1533 req.bmRequestType = UT_READ_CLASS_INTERFACE;
1534 req.bRequest = UA20_CS_RANGE;
1535 USETW2(req.wValue, UA20_CS_SAM_FREQ_CONTROL, 0);
1536 USETW2(req.wIndex, clockid, iface_no);
1538 * Assume there is at least one rate to begin with, else some
1539 * devices might refuse to return the USB descriptor:
1541 USETW(req.wLength, (2 + 1 * 12));
1543 error = usbd_do_request_flags(udev, NULL, &req, data,
1544 USB_SHORT_XFER_OK, &actlen, USB_DEFAULT_TIMEOUT);
1546 if (error != 0 || actlen < 2) {
1548 * Likely the descriptor doesn't fit into the supplied
1549 * buffer. Try using a larger buffer and see if that
1552 rates = MIN(UAUDIO20_MAX_RATES, (255 - 2) / 12);
1553 error = USB_ERR_INVAL;
1555 rates = UGETW(data);
1557 if (rates > UAUDIO20_MAX_RATES) {
1558 DPRINTF("Too many rates truncating to %d\n", UAUDIO20_MAX_RATES);
1559 rates = UAUDIO20_MAX_RATES;
1560 error = USB_ERR_INVAL;
1561 } else if (rates > 1) {
1562 DPRINTF("Need to read full rate descriptor\n");
1563 error = USB_ERR_INVAL;
1569 * Try to read full rate descriptor.
1571 actlen = (2 + rates * 12);
1573 USETW(req.wLength, actlen);
1575 error = usbd_do_request_flags(udev, NULL, &req, data,
1576 USB_SHORT_XFER_OK, &actlen, USB_DEFAULT_TIMEOUT);
1578 if (error != 0 || actlen < 2)
1579 return (USB_ERR_INVAL);
1581 rates = UGETW(data);
1584 actlen = (actlen - 2) / 12;
1586 if (rates > actlen) {
1587 DPRINTF("Too many rates truncating to %d\n", actlen);
1591 for (x = 0; x != rates; x++) {
1592 uint32_t min = UGETDW(data + 2 + (12 * x));
1593 uint32_t max = UGETDW(data + 6 + (12 * x));
1594 uint32_t res = UGETDW(data + 10 + (12 * x));
1597 DPRINTF("Zero residue\n");
1602 DPRINTF("Swapped max and min\n");
1609 if (rate >= min && rate <= max &&
1610 (((rate - min) % res) == 0)) {
1614 return (USB_ERR_INVAL);
1618 uaudio_chan_fill_info_sub(struct uaudio_softc *sc, struct usb_device *udev,
1619 uint32_t rate, uint8_t channels, uint8_t bit_resolution)
1621 struct usb_descriptor *desc = NULL;
1622 union uaudio_asid asid = { NULL };
1623 union uaudio_asf1d asf1d = { NULL };
1624 union uaudio_sed sed = { NULL };
1625 struct usb_midi_streaming_endpoint_descriptor *msid = NULL;
1626 usb_endpoint_descriptor_audio_t *ed1 = NULL;
1627 const struct usb_audio_control_descriptor *acdp = NULL;
1628 struct usb_config_descriptor *cd = usbd_get_config_descriptor(udev);
1629 struct usb_interface_descriptor *id;
1630 const struct uaudio_format *p_fmt = NULL;
1631 struct uaudio_chan *chan;
1632 struct uaudio_chan_alt *chan_alt;
1634 uint16_t curidx = 0xFFFF;
1635 uint16_t lastidx = 0xFFFF;
1636 uint16_t alt_index = 0;
1637 uint16_t audio_rev = 0;
1641 uint8_t bBitResolution;
1642 uint8_t audio_if = 0;
1643 uint8_t midi_if = 0;
1644 uint8_t uma_if_class;
1646 while ((desc = usb_desc_foreach(cd, desc))) {
1648 if ((desc->bDescriptorType == UDESC_INTERFACE) &&
1649 (desc->bLength >= sizeof(*id))) {
1653 if (id->bInterfaceNumber != lastidx) {
1654 lastidx = id->bInterfaceNumber;
1662 if ((!(sc->sc_hid.flags & UAUDIO_HID_VALID)) &&
1663 (id->bInterfaceClass == UICLASS_HID) &&
1664 (id->bInterfaceSubClass == 0) &&
1665 (id->bInterfaceProtocol == 0) &&
1667 usbd_get_iface(udev, curidx) != NULL) {
1668 DPRINTF("Found HID interface at %d\n",
1670 sc->sc_hid.flags |= UAUDIO_HID_VALID;
1671 sc->sc_hid.iface_index = curidx;
1675 ((id->bInterfaceClass == UICLASS_AUDIO) ||
1676 ((id->bInterfaceClass == UICLASS_VENDOR) &&
1677 (sc->sc_uq_au_vendor_class != 0)));
1679 if ((uma_if_class != 0) &&
1680 (id->bInterfaceSubClass == UISUBCLASS_AUDIOSTREAM)) {
1686 if ((uma_if_class != 0) &&
1687 (id->bInterfaceSubClass == UISUBCLASS_MIDISTREAM)) {
1690 * XXX could allow multiple MIDI interfaces
1694 if ((sc->sc_midi_chan.valid == 0) &&
1695 (usbd_get_iface(udev, curidx) != NULL)) {
1696 sc->sc_midi_chan.iface_index = curidx;
1697 sc->sc_midi_chan.iface_alt_index = alt_index;
1698 sc->sc_midi_chan.valid = 1;
1709 * There can only be one USB audio instance
1710 * per USB device. Grab all USB audio
1711 * interfaces on this USB device so that we
1712 * don't attach USB audio twice:
1714 if (alt_index == 0 && curidx != sc->sc_mixer_iface_index &&
1715 (id->bInterfaceClass == UICLASS_AUDIO || audio_if != 0 ||
1717 usbd_set_parent_iface(sc->sc_udev, curidx,
1718 sc->sc_mixer_iface_index);
1722 if (audio_if == 0) {
1724 if ((acdp == NULL) &&
1725 (desc->bDescriptorType == UDESC_CS_INTERFACE) &&
1726 (desc->bDescriptorSubtype == UDESCSUB_AC_HEADER) &&
1727 (desc->bLength >= sizeof(*acdp))) {
1728 acdp = (void *)desc;
1729 audio_rev = UGETW(acdp->bcdADC);
1732 msid = (void *)desc;
1734 /* get the maximum number of embedded jacks in use, if any */
1735 if (msid->bLength >= sizeof(*msid) &&
1736 msid->bDescriptorType == UDESC_CS_ENDPOINT &&
1737 msid->bDescriptorSubtype == MS_GENERAL &&
1738 msid->bNumEmbMIDIJack > sc->sc_midi_chan.max_emb_jack) {
1739 sc->sc_midi_chan.max_emb_jack = msid->bNumEmbMIDIJack;
1743 * Don't collect any USB audio descriptors if
1744 * this is not an USB audio stream interface.
1749 if ((acdp != NULL || sc->sc_uq_au_vendor_class != 0) &&
1750 (desc->bDescriptorType == UDESC_CS_INTERFACE) &&
1751 (desc->bDescriptorSubtype == AS_GENERAL) &&
1752 (asid.v1 == NULL)) {
1753 if (audio_rev >= UAUDIO_VERSION_30) {
1755 } else if (audio_rev >= UAUDIO_VERSION_20) {
1756 if (desc->bLength >= sizeof(*asid.v2)) {
1757 asid.v2 = (void *)desc;
1760 if (desc->bLength >= sizeof(*asid.v1)) {
1761 asid.v1 = (void *)desc;
1765 if ((acdp != NULL || sc->sc_uq_au_vendor_class != 0) &&
1766 (desc->bDescriptorType == UDESC_CS_INTERFACE) &&
1767 (desc->bDescriptorSubtype == FORMAT_TYPE) &&
1768 (asf1d.v1 == NULL)) {
1769 if (audio_rev >= UAUDIO_VERSION_30) {
1771 } else if (audio_rev >= UAUDIO_VERSION_20) {
1772 if (desc->bLength >= sizeof(*asf1d.v2))
1773 asf1d.v2 = (void *)desc;
1775 if (desc->bLength >= sizeof(*asf1d.v1)) {
1776 asf1d.v1 = (void *)desc;
1778 if (asf1d.v1->bFormatType != FORMAT_TYPE_I) {
1779 DPRINTFN(11, "ignored bFormatType = %d\n",
1780 asf1d.v1->bFormatType);
1784 if (desc->bLength < (sizeof(*asf1d.v1) +
1785 ((asf1d.v1->bSamFreqType == 0) ? 6 :
1786 (asf1d.v1->bSamFreqType * 3)))) {
1787 DPRINTFN(11, "invalid descriptor, "
1795 if ((desc->bDescriptorType == UDESC_ENDPOINT) &&
1796 (desc->bLength >= UEP_MINSIZE) &&
1799 if (UE_GET_XFERTYPE(ed1->bmAttributes) != UE_ISOCHRONOUS) {
1804 if ((acdp != NULL || sc->sc_uq_au_vendor_class != 0) &&
1805 (desc->bDescriptorType == UDESC_CS_ENDPOINT) &&
1806 (desc->bDescriptorSubtype == AS_GENERAL) &&
1808 if (audio_rev >= UAUDIO_VERSION_30) {
1810 } else if (audio_rev >= UAUDIO_VERSION_20) {
1811 if (desc->bLength >= sizeof(*sed.v2))
1812 sed.v2 = (void *)desc;
1814 if (desc->bLength >= sizeof(*sed.v1))
1815 sed.v1 = (void *)desc;
1818 if (asid.v1 == NULL || asf1d.v1 == NULL ||
1819 ed1 == NULL || sed.v1 == NULL) {
1820 /* need more descriptors */
1824 ep_dir = UE_GET_DIR(ed1->bEndpointAddress);
1826 /* We ignore sync endpoint information until further. */
1828 if (audio_rev >= UAUDIO_VERSION_30) {
1830 } else if (audio_rev >= UAUDIO_VERSION_20) {
1834 dwFormat = UGETDW(asid.v2->bmFormats);
1835 bChannels = asid.v2->bNrChannels;
1836 bBitResolution = asf1d.v2->bSubslotSize * 8;
1838 if ((bChannels != channels) ||
1839 (bBitResolution != bit_resolution)) {
1840 DPRINTF("Wrong number of channels\n");
1844 for (p_fmt = uaudio20_formats;
1845 p_fmt->wFormat != 0; p_fmt++) {
1846 if ((p_fmt->wFormat & dwFormat) &&
1847 (p_fmt->bPrecision == bBitResolution))
1851 if (p_fmt->wFormat == 0) {
1852 DPRINTF("Unsupported audio format\n");
1856 for (x = 0; x != 256; x++) {
1857 if (ep_dir == UE_DIR_OUT) {
1858 if (!(sc->sc_mixer_clocks.bit_output[x / 8] &
1863 if (!(sc->sc_mixer_clocks.bit_input[x / 8] &
1869 DPRINTF("Checking clock ID=%d\n", x);
1871 if (uaudio20_check_rate(udev,
1872 sc->sc_mixer_iface_no, x, rate)) {
1873 DPRINTF("Unsupported sampling "
1874 "rate, id=%d\n", x);
1881 wFormat = UGETW(asid.v1->wFormatTag);
1882 bChannels = UAUDIO_MAX_CHAN(asf1d.v1->bNrChannels);
1883 bBitResolution = asf1d.v1->bSubFrameSize * 8;
1885 if (asf1d.v1->bSamFreqType == 0) {
1886 DPRINTFN(16, "Sample rate: %d-%dHz\n",
1887 UA_SAMP_LO(asf1d.v1),
1888 UA_SAMP_HI(asf1d.v1));
1890 if ((rate >= UA_SAMP_LO(asf1d.v1)) &&
1891 (rate <= UA_SAMP_HI(asf1d.v1)))
1895 for (x = 0; x < asf1d.v1->bSamFreqType; x++) {
1896 DPRINTFN(16, "Sample rate = %dHz\n",
1897 UA_GETSAMP(asf1d.v1, x));
1899 if (rate == UA_GETSAMP(asf1d.v1, x))
1906 for (p_fmt = uaudio10_formats;
1907 p_fmt->wFormat != 0; p_fmt++) {
1908 if ((p_fmt->wFormat == wFormat) &&
1909 (p_fmt->bPrecision == bBitResolution))
1912 if (p_fmt->wFormat == 0) {
1913 DPRINTF("Unsupported audio format\n");
1917 if ((bChannels != channels) ||
1918 (bBitResolution != bit_resolution)) {
1919 DPRINTF("Wrong number of channels\n");
1924 chan = (ep_dir == UE_DIR_IN) ?
1925 &sc->sc_rec_chan : &sc->sc_play_chan;
1927 if (usbd_get_iface(udev, curidx) == NULL) {
1928 DPRINTF("Interface is not valid\n");
1931 if (chan->num_alt == CHAN_MAX_ALT) {
1932 DPRINTF("Too many alternate settings\n");
1936 chan->cur_alt = CHAN_MAX_ALT;
1938 chan_alt = &chan->usb_alt[chan->num_alt++];
1941 uaudio_chan_dump_ep_desc(ed1);
1943 DPRINTF("Sample rate = %dHz, channels = %d, "
1944 "bits = %d, format = %s\n", rate, channels,
1945 bit_resolution, p_fmt->description);
1947 chan_alt->sample_rate = rate;
1948 chan_alt->p_asf1d = asf1d;
1949 chan_alt->p_ed1 = ed1;
1950 chan_alt->p_fmt = p_fmt;
1951 chan_alt->p_sed = sed;
1952 chan_alt->iface_index = curidx;
1953 chan_alt->iface_alt_index = alt_index;
1955 if (ep_dir == UE_DIR_IN)
1956 chan_alt->usb_cfg = uaudio_cfg_record;
1958 chan_alt->usb_cfg = uaudio_cfg_play;
1960 chan_alt->sample_size = (UAUDIO_MAX_CHAN(channels) *
1961 p_fmt->bPrecision) / 8;
1962 chan_alt->channels = channels;
1964 if (ep_dir == UE_DIR_IN &&
1965 usbd_get_speed(udev) == USB_SPEED_FULL) {
1966 uaudio_record_fix_fs(ed1,
1967 chan_alt->sample_size * (rate / 1000),
1968 chan_alt->sample_size * (rate / 4000));
1971 /* setup play/record format */
1973 format = chan_alt->p_fmt->freebsd_fmt;
1975 /* get default SND_FORMAT() */
1976 format = SND_FORMAT(format, chan_alt->channels, 0);
1978 switch (chan_alt->channels) {
1982 /* mono and stereo */
1985 /* surround and more */
1986 temp_fmt = feeder_matrix_default_format(format);
1987 /* if multichannel, then format can be zero */
1993 /* check if format is not supported */
1995 DPRINTF("The selected audio format is not supported\n");
1999 if (chan->num_alt > 1) {
2000 /* we only accumulate one format at different sample rates */
2001 if (chan->pcm_format[0] != format) {
2002 DPRINTF("Multiple formats is not supported\n");
2006 /* ignore if duplicate sample rate entry */
2007 if (rate == chan->usb_alt[chan->num_alt - 2].sample_rate) {
2008 DPRINTF("Duplicate sample rate detected\n");
2013 chan->pcm_cap.fmtlist = chan->pcm_format;
2014 chan->pcm_cap.fmtlist[0] = format;
2016 /* check if device needs bitperfect */
2017 if (chan_alt->channels > UAUDIO_MATRIX_MAX)
2018 sc->sc_pcm_bitperfect = 1;
2020 if (rate < chan->pcm_cap.minspeed || chan->pcm_cap.minspeed == 0)
2021 chan->pcm_cap.minspeed = rate;
2022 if (rate > chan->pcm_cap.maxspeed || chan->pcm_cap.maxspeed == 0)
2023 chan->pcm_cap.maxspeed = rate;
2025 if (sc->sc_sndstat_valid != 0) {
2026 sbuf_printf(&sc->sc_sndstat, "\n\t"
2027 "mode %d.%d:(%s) %dch, %dbit, %s, %dHz",
2029 (ep_dir == UE_DIR_IN) ? "input" : "output",
2030 channels, p_fmt->bPrecision,
2031 p_fmt->description, rate);
2040 /* This structure defines all the supported rates. */
2042 static const uint32_t uaudio_rate_list[CHAN_MAX_ALT] = {
2067 uaudio_chan_fill_info(struct uaudio_softc *sc, struct usb_device *udev)
2069 uint32_t rate = uaudio_default_rate;
2071 uint8_t bits = uaudio_default_bits;
2073 uint8_t channels = uaudio_default_channels;
2077 if ((bits == 0) || (bits > 32)) {
2078 /* set a valid value */
2081 if (channels == 0) {
2082 switch (usbd_get_speed(udev)) {
2084 case USB_SPEED_FULL:
2086 * Due to high bandwidth usage and problems
2087 * with HIGH-speed split transactions we
2088 * disable surround setups on FULL-speed USB
2094 channels = UAUDIO_CHANNELS_MAX;
2097 } else if (channels > UAUDIO_CHANNELS_MAX)
2098 channels = UAUDIO_CHANNELS_MAX;
2100 if (sbuf_new(&sc->sc_sndstat, NULL, 4096, SBUF_AUTOEXTEND))
2101 sc->sc_sndstat_valid = 1;
2103 /* try to search for a valid config */
2105 for (x = channels; x; x--) {
2106 for (y = bits; y; y -= 8) {
2108 /* try user defined rate, if any */
2110 uaudio_chan_fill_info_sub(sc, udev, rate, x, y);
2112 /* try find a matching rate, if any */
2113 for (z = 0; uaudio_rate_list[z]; z++)
2114 uaudio_chan_fill_info_sub(sc, udev, uaudio_rate_list[z], x, y);
2117 if (sc->sc_sndstat_valid)
2118 sbuf_finish(&sc->sc_sndstat);
2122 uaudio_chan_play_sync_callback(struct usb_xfer *xfer, usb_error_t error)
2124 struct uaudio_chan *ch = usbd_xfer_softc(xfer);
2125 struct usb_page_cache *pc;
2126 uint64_t sample_rate;
2133 usbd_xfer_status(xfer, &actlen, NULL, NULL, &nframes);
2135 switch (USB_GET_STATE(xfer)) {
2136 case USB_ST_TRANSFERRED:
2138 DPRINTFN(6, "transferred %d bytes\n", actlen);
2142 len = usbd_xfer_frame_len(xfer, 0);
2145 if (len > sizeof(buf))
2148 memset(buf, 0, sizeof(buf));
2150 pc = usbd_xfer_get_frame(xfer, 0);
2151 usbd_copy_out(pc, 0, buf, len);
2155 DPRINTF("Value = 0x%08x\n", (int)temp);
2157 /* auto-detect SYNC format */
2162 /* check for no data */
2169 sample_rate = ch->usb_alt[ch->cur_alt].sample_rate;
2172 while (temp < (sample_rate - (sample_rate / 4)))
2175 while (temp > (sample_rate + (sample_rate / 2)))
2178 DPRINTF("Comparing %d Hz :: %d Hz\n",
2179 (int)temp, (int)sample_rate);
2182 * Use feedback value as fallback when there is no
2183 * recording channel:
2185 if (ch->priv_sc->sc_rec_chan.num_alt == 0) {
2186 int32_t jitter_max = howmany(sample_rate, 16000);
2189 * Range check the jitter values to avoid
2190 * bogus sample rate adjustments. The expected
2191 * deviation should not be more than 1Hz per
2192 * second. The USB v2.0 specification also
2193 * mandates this requirement. Refer to chapter
2194 * 5.12.4.2 about feedback.
2196 ch->jitter_curr = temp - sample_rate;
2197 if (ch->jitter_curr > jitter_max)
2198 ch->jitter_curr = jitter_max;
2199 else if (ch->jitter_curr < -jitter_max)
2200 ch->jitter_curr = -jitter_max;
2202 ch->feedback_rate = temp;
2207 * Check if the recording stream can be used as a
2208 * source of jitter information to save some
2209 * isochronous bandwidth:
2211 if (ch->priv_sc->sc_rec_chan.num_alt != 0 &&
2214 usbd_xfer_set_frames(xfer, 1);
2215 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_framelen(xfer));
2216 usbd_transfer_submit(xfer);
2219 default: /* Error */
2225 uaudio_chan_is_async(struct uaudio_chan *ch, uint8_t alt)
2227 uint8_t attr = ch->usb_alt[alt].p_ed1->bmAttributes;
2228 return (UE_GET_ISO_TYPE(attr) == UE_ISO_ASYNC);
2232 uaudio_chan_play_callback(struct usb_xfer *xfer, usb_error_t error)
2234 struct uaudio_chan *ch = usbd_xfer_softc(xfer);
2235 struct uaudio_chan *ch_rec;
2236 struct usb_page_cache *pc;
2239 uint32_t blockcount;
2246 if (ch->running == 0 || ch->start == ch->end) {
2247 DPRINTF("not running or no buffer!\n");
2251 /* check if there is a record channel */
2252 if (ch->priv_sc->sc_rec_chan.num_alt > 0)
2253 ch_rec = &ch->priv_sc->sc_rec_chan;
2257 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL);
2259 switch (USB_GET_STATE(xfer)) {
2262 if (ch_rec != NULL) {
2263 /* reset receive jitter counters */
2264 mtx_lock(ch_rec->pcm_mtx);
2265 ch_rec->jitter_curr = 0;
2266 ch_rec->jitter_rem = 0;
2267 mtx_unlock(ch_rec->pcm_mtx);
2270 /* reset transmit jitter counters */
2271 ch->jitter_curr = 0;
2275 case USB_ST_TRANSFERRED:
2276 if (actlen < sumlen) {
2277 DPRINTF("short transfer, "
2278 "%d of %d bytes\n", actlen, sumlen);
2280 chn_intr(ch->pcm_ch);
2283 * Check for asynchronous playback endpoint and that
2284 * the playback endpoint is properly configured:
2286 if (ch_rec != NULL &&
2287 uaudio_chan_is_async(ch, ch->cur_alt) != 0) {
2288 mtx_lock(ch_rec->pcm_mtx);
2289 if (ch_rec->cur_alt < ch_rec->num_alt) {
2293 /* translate receive jitter into transmit jitter */
2294 tx_jitter = ch->usb_alt[ch->cur_alt].sample_rate;
2295 tx_jitter = (tx_jitter * ch_rec->jitter_curr) +
2298 /* reset receive jitter counters */
2299 ch_rec->jitter_curr = 0;
2300 ch_rec->jitter_rem = 0;
2302 /* compute exact number of transmit jitter samples */
2303 rx_rate = ch_rec->usb_alt[ch_rec->cur_alt].sample_rate;
2304 ch->jitter_curr += tx_jitter / rx_rate;
2305 ch->jitter_rem = tx_jitter % rx_rate;
2307 mtx_unlock(ch_rec->pcm_mtx);
2310 /* start the SYNC transfer one time per second, if any */
2311 ch->intr_counter += ch->intr_frames;
2312 if (ch->intr_counter >= ch->frames_per_second) {
2313 ch->intr_counter -= ch->frames_per_second;
2314 usbd_transfer_start(ch->xfer[UAUDIO_NCHANBUFS]);
2317 mfl = usbd_xfer_max_framelen(xfer);
2319 if (ch->bytes_per_frame[1] > mfl) {
2320 DPRINTF("bytes per transfer, %d, "
2321 "exceeds maximum, %d!\n",
2322 ch->bytes_per_frame[1],
2327 blockcount = ch->intr_frames;
2329 /* setup number of frames */
2330 usbd_xfer_set_frames(xfer, blockcount);
2332 /* get sample size */
2333 sample_size = ch->usb_alt[ch->cur_alt].sample_size;
2335 /* reset total length */
2338 /* setup frame lengths */
2339 for (n = 0; n != blockcount; n++) {
2342 ch->sample_curr += ch->sample_rem;
2343 if (ch->sample_curr >= ch->frames_per_second) {
2344 ch->sample_curr -= ch->frames_per_second;
2345 frame_len = ch->bytes_per_frame[1];
2347 frame_len = ch->bytes_per_frame[0];
2350 /* handle free running clock case */
2351 if (ch->jitter_curr > 0 &&
2352 (frame_len + sample_size) <= mfl) {
2353 DPRINTFN(6, "sending one sample more\n");
2355 frame_len += sample_size;
2356 } else if (ch->jitter_curr < 0 &&
2357 frame_len >= sample_size) {
2358 DPRINTFN(6, "sending one sample less\n");
2360 frame_len -= sample_size;
2362 usbd_xfer_set_frame_len(xfer, n, frame_len);
2366 DPRINTFN(6, "transferring %d bytes\n", total);
2370 pc = usbd_xfer_get_frame(xfer, 0);
2373 n = (ch->end - ch->cur);
2377 usbd_copy_in(pc, offset, ch->cur, n);
2383 if (ch->cur >= ch->end)
2384 ch->cur = ch->start;
2386 usbd_transfer_submit(xfer);
2389 default: /* Error */
2390 if (error != USB_ERR_CANCELLED)
2397 uaudio_chan_record_sync_callback(struct usb_xfer *xfer, usb_error_t error)
2403 uaudio_chan_record_callback(struct usb_xfer *xfer, usb_error_t error)
2405 struct uaudio_chan *ch = usbd_xfer_softc(xfer);
2406 struct usb_page_cache *pc;
2417 if (ch->start == ch->end) {
2418 DPRINTF("no buffer!\n");
2422 usbd_xfer_status(xfer, &actlen, NULL, NULL, &nframes);
2423 mfl = usbd_xfer_max_framelen(xfer);
2425 switch (USB_GET_STATE(xfer)) {
2426 case USB_ST_TRANSFERRED:
2429 pc = usbd_xfer_get_frame(xfer, 0);
2431 /* try to compute the number of expected bytes */
2432 ch->sample_curr += (ch->sample_rem * ch->intr_frames);
2434 /* compute number of expected bytes */
2435 expected_bytes = (ch->intr_frames * ch->bytes_per_frame[0]) +
2436 ((ch->sample_curr / ch->frames_per_second) *
2437 (ch->bytes_per_frame[1] - ch->bytes_per_frame[0]));
2439 /* keep remainder */
2440 ch->sample_curr %= ch->frames_per_second;
2442 /* get current sample size */
2443 sample_size = ch->usb_alt[ch->cur_alt].sample_size;
2445 for (n = 0; n != nframes; n++) {
2446 uint32_t offset1 = offset0;
2448 len = usbd_xfer_frame_len(xfer, n);
2450 /* make sure we only receive complete samples */
2451 len = len - (len % sample_size);
2453 /* subtract bytes received from expected payload */
2454 expected_bytes -= len;
2456 /* don't receive data when not ready */
2457 if (ch->running == 0 || ch->cur_alt != ch->set_alt)
2460 /* fill ring buffer with samples, if any */
2463 m = (ch->end - ch->cur);
2468 usbd_copy_out(pc, offset1, ch->cur, m);
2474 if (ch->cur >= ch->end)
2475 ch->cur = ch->start;
2481 /* update current jitter */
2482 ch->jitter_curr -= (expected_bytes / sample_size);
2484 /* don't allow a huge amount of jitter to accumulate */
2485 nframes = 2 * ch->intr_frames;
2487 /* range check current jitter */
2488 if (ch->jitter_curr < -nframes)
2489 ch->jitter_curr = -nframes;
2490 else if (ch->jitter_curr > nframes)
2491 ch->jitter_curr = nframes;
2493 DPRINTFN(6, "transferred %d bytes, jitter %d samples\n",
2494 actlen, ch->jitter_curr);
2496 if (ch->running != 0)
2497 chn_intr(ch->pcm_ch);
2501 nframes = ch->intr_frames;
2503 usbd_xfer_set_frames(xfer, nframes);
2504 for (n = 0; n != nframes; n++)
2505 usbd_xfer_set_frame_len(xfer, n, mfl);
2507 usbd_transfer_submit(xfer);
2510 default: /* Error */
2511 if (error != USB_ERR_CANCELLED)
2518 uaudio_chan_init(struct uaudio_softc *sc, struct snd_dbuf *b,
2519 struct pcm_channel *c, int dir)
2521 struct uaudio_chan *ch = ((dir == PCMDIR_PLAY) ?
2522 &sc->sc_play_chan : &sc->sc_rec_chan);
2526 /* store mutex and PCM channel */
2529 ch->pcm_mtx = c->lock;
2531 /* compute worst case buffer */
2534 for (x = 0; x != ch->num_alt; x++) {
2535 uint32_t temp = uaudio_get_buffer_size(ch, x);
2536 if (temp > buf_size)
2540 /* allow double buffering */
2543 DPRINTF("Worst case buffer is %d bytes\n", (int)buf_size);
2545 ch->buf = malloc(buf_size, M_DEVBUF, M_WAITOK | M_ZERO);
2546 if (ch->buf == NULL)
2548 if (sndbuf_setup(b, ch->buf, buf_size) != 0)
2551 ch->start = ch->buf;
2552 ch->end = ch->buf + buf_size;
2555 ch->max_buf = buf_size;
2557 if (ch->pcm_mtx == NULL) {
2558 DPRINTF("ERROR: PCM channels does not have a mutex!\n");
2564 uaudio_chan_free(ch);
2569 uaudio_chan_free(struct uaudio_chan *ch)
2571 if (ch->buf != NULL) {
2572 free(ch->buf, M_DEVBUF);
2575 usbd_transfer_unsetup(ch->xfer, UAUDIO_NCHANBUFS + 1);
2583 uaudio_chan_set_param_blocksize(struct uaudio_chan *ch, uint32_t blocksize)
2585 uint32_t temp = 2 * uaudio_get_buffer_size(ch, ch->set_alt);
2586 sndbuf_setup(ch->pcm_buf, ch->buf, temp);
2591 uaudio_chan_set_param_fragments(struct uaudio_chan *ch, uint32_t blocksize,
2592 uint32_t blockcount)
2598 uaudio_chan_set_param_speed(struct uaudio_chan *ch, uint32_t speed)
2600 struct uaudio_softc *sc;
2605 for (x = 0; x < ch->num_alt; x++) {
2606 if (ch->usb_alt[x].sample_rate < speed) {
2607 /* sample rate is too low */
2615 usb_proc_explore_lock(sc->sc_udev);
2617 usb_proc_explore_unlock(sc->sc_udev);
2619 DPRINTF("Selecting alt %d\n", (int)x);
2621 return (ch->usb_alt[x].sample_rate);
2625 uaudio_chan_getptr(struct uaudio_chan *ch)
2627 return (ch->cur - ch->start);
2630 struct pcmchan_caps *
2631 uaudio_chan_getcaps(struct uaudio_chan *ch)
2633 return (&ch->pcm_cap);
2636 static struct pcmchan_matrix uaudio_chan_matrix_swap_2_0 = {
2637 .id = SND_CHN_MATRIX_DRV,
2643 .type = SND_CHN_T_FR,
2645 SND_CHN_T_MASK_FR | SND_CHN_T_MASK_FC |
2646 SND_CHN_T_MASK_LF | SND_CHN_T_MASK_BR |
2647 SND_CHN_T_MASK_BC | SND_CHN_T_MASK_SR
2651 .type = SND_CHN_T_FL,
2653 SND_CHN_T_MASK_FL | SND_CHN_T_MASK_FC |
2654 SND_CHN_T_MASK_LF | SND_CHN_T_MASK_BL |
2655 SND_CHN_T_MASK_BC | SND_CHN_T_MASK_SL
2658 .type = SND_CHN_T_MAX,
2662 .mask = SND_CHN_T_MASK_FR | SND_CHN_T_MASK_FL,
2663 .offset = { 1, 0, -1, -1, -1, -1, -1, -1, -1,
2664 -1, -1, -1, -1, -1, -1, -1, -1, -1 }
2667 struct pcmchan_matrix *
2668 uaudio_chan_getmatrix(struct uaudio_chan *ch, uint32_t format)
2670 struct uaudio_softc *sc;
2674 if (sc != NULL && sc->sc_uq_audio_swap_lr != 0 &&
2675 AFMT_CHANNEL(format) == 2)
2676 return (&uaudio_chan_matrix_swap_2_0);
2678 return (feeder_matrix_format_map(format));
2682 uaudio_chan_set_param_format(struct uaudio_chan *ch, uint32_t format)
2684 DPRINTF("Selecting format 0x%08x\n", (unsigned int)format);
2689 uaudio_chan_start_sub(struct uaudio_chan *ch)
2691 struct uaudio_softc *sc = ch->priv_sc;
2694 if (ch->operation != CHAN_OP_DRAIN) {
2695 if (ch->cur_alt == ch->set_alt &&
2696 ch->operation == CHAN_OP_NONE &&
2697 mtx_owned(ch->pcm_mtx) != 0) {
2698 /* save doing the explore task */
2701 ch->operation = CHAN_OP_START;
2702 (void)usb_proc_explore_msignal(sc->sc_udev,
2703 &sc->sc_config_msg[0], &sc->sc_config_msg[1]);
2707 usbd_transfer_start(ch->xfer[0]);
2708 usbd_transfer_start(ch->xfer[1]);
2713 uaudio_chan_need_both(struct uaudio_softc *sc)
2715 return (sc->sc_play_chan.num_alt > 0 &&
2716 sc->sc_play_chan.running != 0 &&
2717 uaudio_chan_is_async(&sc->sc_play_chan,
2718 sc->sc_play_chan.set_alt) != 0 &&
2719 sc->sc_rec_chan.num_alt > 0 &&
2720 sc->sc_rec_chan.running == 0);
2724 uaudio_chan_need_none(struct uaudio_softc *sc)
2726 return (sc->sc_play_chan.num_alt > 0 &&
2727 sc->sc_play_chan.running == 0 &&
2728 sc->sc_rec_chan.num_alt > 0 &&
2729 sc->sc_rec_chan.running == 0);
2733 uaudio_chan_start(struct uaudio_chan *ch)
2735 struct uaudio_softc *sc = ch->priv_sc;
2737 /* make operation atomic */
2738 usb_proc_explore_lock(sc->sc_udev);
2740 /* check if not running */
2741 if (ch->running == 0) {
2744 /* get current buffer size */
2745 temp = 2 * uaudio_get_buffer_size(ch, ch->set_alt);
2747 /* set running flag */
2750 /* ensure the hardware buffer is reset */
2751 ch->start = ch->buf;
2752 ch->end = ch->buf + temp;
2755 if (uaudio_chan_need_both(sc)) {
2757 * Start both endpoints because of need for
2758 * jitter information:
2760 uaudio_chan_start_sub(&sc->sc_rec_chan);
2761 uaudio_chan_start_sub(&sc->sc_play_chan);
2763 uaudio_chan_start_sub(ch);
2767 /* exit atomic operation */
2768 usb_proc_explore_unlock(sc->sc_udev);
2772 uaudio_chan_stop_sub(struct uaudio_chan *ch)
2774 struct uaudio_softc *sc = ch->priv_sc;
2777 if (ch->operation != CHAN_OP_DRAIN) {
2778 if (ch->cur_alt == ch->set_alt &&
2779 ch->operation == CHAN_OP_NONE &&
2780 mtx_owned(ch->pcm_mtx) != 0) {
2781 /* save doing the explore task */
2784 ch->operation = CHAN_OP_STOP;
2785 (void)usb_proc_explore_msignal(sc->sc_udev,
2786 &sc->sc_config_msg[0], &sc->sc_config_msg[1]);
2790 usbd_transfer_stop(ch->xfer[0]);
2791 usbd_transfer_stop(ch->xfer[1]);
2796 uaudio_chan_stop(struct uaudio_chan *ch)
2798 struct uaudio_softc *sc = ch->priv_sc;
2800 /* make operation atomic */
2801 usb_proc_explore_lock(sc->sc_udev);
2803 /* check if running */
2804 if (ch->running != 0) {
2805 /* clear running flag */
2808 if (uaudio_chan_need_both(sc)) {
2810 * Leave the endpoints running because we need
2811 * information about jitter!
2813 } else if (uaudio_chan_need_none(sc)) {
2815 * Stop both endpoints in case the one was used for
2816 * jitter information:
2818 uaudio_chan_stop_sub(&sc->sc_rec_chan);
2819 uaudio_chan_stop_sub(&sc->sc_play_chan);
2821 uaudio_chan_stop_sub(ch);
2825 /* exit atomic operation */
2826 usb_proc_explore_unlock(sc->sc_udev);
2829 /*========================================================================*
2830 * AC - Audio Controller - routines
2831 *========================================================================*/
2834 uaudio_mixer_sysctl_handler(SYSCTL_HANDLER_ARGS)
2836 struct uaudio_softc *sc;
2837 struct uaudio_mixer_node *pmc;
2843 sc = (struct uaudio_softc *)oidp->oid_arg1;
2844 hint = oidp->oid_arg2;
2846 if (sc->sc_mixer_lock == NULL)
2849 /* lookup mixer node */
2851 mtx_lock(sc->sc_mixer_lock);
2852 for (pmc = sc->sc_mixer_root; pmc != NULL; pmc = pmc->next) {
2853 for (chan = 0; chan != (int)pmc->nchan; chan++) {
2854 if (pmc->wValue[chan] != -1 &&
2855 pmc->wValue[chan] == hint) {
2856 temp = pmc->wData[chan];
2862 mtx_unlock(sc->sc_mixer_lock);
2864 error = sysctl_handle_int(oidp, &temp, 0, req);
2865 if (error != 0 || req->newptr == NULL)
2868 /* update mixer value */
2870 mtx_lock(sc->sc_mixer_lock);
2872 temp >= pmc->minval &&
2873 temp <= pmc->maxval) {
2875 pmc->wData[chan] = temp;
2876 pmc->update[(chan / 8)] |= (1 << (chan % 8));
2878 /* start the transfer, if not already started */
2879 usbd_transfer_start(sc->sc_mixer_xfer[0]);
2881 mtx_unlock(sc->sc_mixer_lock);
2887 uaudio_mixer_ctl_free(struct uaudio_softc *sc)
2889 struct uaudio_mixer_node *p_mc;
2891 while ((p_mc = sc->sc_mixer_root) != NULL) {
2892 sc->sc_mixer_root = p_mc->next;
2893 free(p_mc, M_USBDEV);
2898 uaudio_mixer_register_sysctl(struct uaudio_softc *sc, device_t dev)
2900 struct uaudio_mixer_node *pmc;
2901 struct sysctl_oid *mixer_tree;
2902 struct sysctl_oid *control_tree;
2907 mixer_tree = SYSCTL_ADD_NODE(device_get_sysctl_ctx(dev),
2908 SYSCTL_CHILDREN(device_get_sysctl_tree(dev)), OID_AUTO, "mixer",
2909 CTLFLAG_RD, NULL, "");
2911 if (mixer_tree == NULL)
2914 for (n = 0, pmc = sc->sc_mixer_root; pmc != NULL;
2915 pmc = pmc->next, n++) {
2917 for (chan = 0; chan < pmc->nchan; chan++) {
2919 if (pmc->nchan > 1) {
2920 snprintf(buf, sizeof(buf), "%s_%d_%d",
2921 pmc->name, n, chan);
2923 snprintf(buf, sizeof(buf), "%s_%d",
2927 control_tree = SYSCTL_ADD_NODE(device_get_sysctl_ctx(dev),
2928 SYSCTL_CHILDREN(mixer_tree), OID_AUTO, buf,
2929 CTLFLAG_RD, NULL, "Mixer control nodes");
2931 if (control_tree == NULL)
2934 SYSCTL_ADD_PROC(device_get_sysctl_ctx(dev),
2935 SYSCTL_CHILDREN(control_tree),
2936 OID_AUTO, "val", CTLTYPE_INT | CTLFLAG_RW, sc,
2938 uaudio_mixer_sysctl_handler, "I", "Current value");
2940 SYSCTL_ADD_INT(device_get_sysctl_ctx(dev),
2941 SYSCTL_CHILDREN(control_tree),
2942 OID_AUTO, "min", CTLFLAG_RD, 0, pmc->minval,
2945 SYSCTL_ADD_INT(device_get_sysctl_ctx(dev),
2946 SYSCTL_CHILDREN(control_tree),
2947 OID_AUTO, "max", CTLFLAG_RD, 0, pmc->maxval,
2950 SYSCTL_ADD_STRING(device_get_sysctl_ctx(dev),
2951 SYSCTL_CHILDREN(control_tree),
2952 OID_AUTO, "desc", CTLFLAG_RD, pmc->desc, 0,
2958 /* M-Audio FastTrack Ultra Mixer Description */
2959 /* Origin: Linux USB Audio driver */
2961 uaudio_mixer_controls_create_ftu(struct uaudio_softc *sc)
2966 memset(&MIX(sc), 0, sizeof(MIX(sc)));
2967 MIX(sc).wIndex = MAKE_WORD(6, sc->sc_mixer_iface_no);
2968 MIX(sc).wValue[0] = MAKE_WORD(8, 0);
2969 MIX(sc).class = UAC_OUTPUT;
2970 MIX(sc).type = MIX_UNSIGNED_16;
2971 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
2972 MIX(sc).name = "effect";
2977 MIX(sc).update[0] = 1;
2978 strlcpy(MIX(sc).desc, "Room1,2,3,Hall1,2,Plate,Delay,Echo", sizeof(MIX(sc).desc));
2979 uaudio_mixer_add_ctl_sub(sc, &MIX(sc));
2981 memset(&MIX(sc), 0, sizeof(MIX(sc)));
2982 MIX(sc).wIndex = MAKE_WORD(5, sc->sc_mixer_iface_no);
2984 for (chx = 0; chx != 8; chx++) {
2985 for (chy = 0; chy != 8; chy++) {
2987 MIX(sc).wValue[0] = MAKE_WORD(chx + 1, chy + 1);
2988 MIX(sc).type = MIX_SIGNED_16;
2989 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
2990 MIX(sc).name = "mix_rec";
2992 MIX(sc).update[0] = 1;
2993 MIX(sc).val_default = 0;
2994 snprintf(MIX(sc).desc, sizeof(MIX(sc).desc),
2995 "AIn%d - Out%d Record Volume", chy + 1, chx + 1);
2997 uaudio_mixer_add_ctl(sc, &MIX(sc));
2999 MIX(sc).wValue[0] = MAKE_WORD(chx + 1, chy + 1 + 8);
3000 MIX(sc).type = MIX_SIGNED_16;
3001 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3002 MIX(sc).name = "mix_play";
3004 MIX(sc).update[0] = 1;
3005 MIX(sc).val_default = (chx == chy) ? 2 : 0;
3006 snprintf(MIX(sc).desc, sizeof(MIX(sc).desc),
3007 "DIn%d - Out%d Playback Volume", chy + 1, chx + 1);
3009 uaudio_mixer_add_ctl(sc, &MIX(sc));
3013 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3014 MIX(sc).wIndex = MAKE_WORD(6, sc->sc_mixer_iface_no);
3015 MIX(sc).wValue[0] = MAKE_WORD(2, 0);
3016 MIX(sc).class = UAC_OUTPUT;
3017 MIX(sc).type = MIX_SIGNED_8;
3018 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3019 MIX(sc).name = "effect_vol";
3021 MIX(sc).update[0] = 1;
3023 MIX(sc).maxval = 0x7f;
3026 MIX(sc).update[0] = 1;
3027 strlcpy(MIX(sc).desc, "Effect Volume", sizeof(MIX(sc).desc));
3028 uaudio_mixer_add_ctl_sub(sc, &MIX(sc));
3030 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3031 MIX(sc).wIndex = MAKE_WORD(6, sc->sc_mixer_iface_no);
3032 MIX(sc).wValue[0] = MAKE_WORD(3, 0);
3033 MIX(sc).class = UAC_OUTPUT;
3034 MIX(sc).type = MIX_SIGNED_16;
3035 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3036 MIX(sc).name = "effect_dur";
3038 MIX(sc).update[0] = 1;
3040 MIX(sc).maxval = 0x7f00;
3041 MIX(sc).mul = 0x7f00;
3043 MIX(sc).update[0] = 1;
3044 strlcpy(MIX(sc).desc, "Effect Duration", sizeof(MIX(sc).desc));
3045 uaudio_mixer_add_ctl_sub(sc, &MIX(sc));
3047 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3048 MIX(sc).wIndex = MAKE_WORD(6, sc->sc_mixer_iface_no);
3049 MIX(sc).wValue[0] = MAKE_WORD(4, 0);
3050 MIX(sc).class = UAC_OUTPUT;
3051 MIX(sc).type = MIX_SIGNED_8;
3052 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3053 MIX(sc).name = "effect_fb";
3055 MIX(sc).update[0] = 1;
3057 MIX(sc).maxval = 0x7f;
3060 MIX(sc).update[0] = 1;
3061 strlcpy(MIX(sc).desc, "Effect Feedback Volume", sizeof(MIX(sc).desc));
3062 uaudio_mixer_add_ctl_sub(sc, &MIX(sc));
3064 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3065 MIX(sc).wIndex = MAKE_WORD(7, sc->sc_mixer_iface_no);
3066 for (chy = 0; chy != 4; chy++) {
3068 MIX(sc).wValue[0] = MAKE_WORD(7, chy + 1);
3069 MIX(sc).type = MIX_SIGNED_16;
3070 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3071 MIX(sc).name = "effect_ret";
3073 MIX(sc).update[0] = 1;
3074 snprintf(MIX(sc).desc, sizeof(MIX(sc).desc),
3075 "Effect Return %d Volume", chy + 1);
3077 uaudio_mixer_add_ctl(sc, &MIX(sc));
3080 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3081 MIX(sc).wIndex = MAKE_WORD(5, sc->sc_mixer_iface_no);
3083 for (chy = 0; chy != 8; chy++) {
3084 MIX(sc).wValue[0] = MAKE_WORD(9, chy + 1);
3085 MIX(sc).type = MIX_SIGNED_16;
3086 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3087 MIX(sc).name = "effect_send";
3089 MIX(sc).update[0] = 1;
3090 snprintf(MIX(sc).desc, sizeof(MIX(sc).desc),
3091 "Effect Send AIn%d Volume", chy + 1);
3093 uaudio_mixer_add_ctl(sc, &MIX(sc));
3095 MIX(sc).wValue[0] = MAKE_WORD(9, chy + 1 + 8);
3096 MIX(sc).type = MIX_SIGNED_16;
3097 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3098 MIX(sc).name = "effect_send";
3100 MIX(sc).update[0] = 1;
3101 snprintf(MIX(sc).desc, sizeof(MIX(sc).desc),
3102 "Effect Send DIn%d Volume", chy + 1);
3104 uaudio_mixer_add_ctl(sc, &MIX(sc));
3109 uaudio_mixer_reload_all(struct uaudio_softc *sc)
3111 struct uaudio_mixer_node *pmc;
3114 if (sc->sc_mixer_lock == NULL)
3117 mtx_lock(sc->sc_mixer_lock);
3118 for (pmc = sc->sc_mixer_root; pmc != NULL; pmc = pmc->next) {
3119 /* use reset defaults for non-oss controlled settings */
3120 if (pmc->ctl == SOUND_MIXER_NRDEVICES)
3122 for (chan = 0; chan < pmc->nchan; chan++)
3123 pmc->update[chan / 8] |= (1 << (chan % 8));
3125 usbd_transfer_start(sc->sc_mixer_xfer[0]);
3127 /* start HID volume keys, if any */
3128 usbd_transfer_start(sc->sc_hid.xfer[0]);
3129 mtx_unlock(sc->sc_mixer_lock);
3133 uaudio_mixer_add_ctl_sub(struct uaudio_softc *sc, struct uaudio_mixer_node *mc)
3135 struct uaudio_mixer_node *p_mc_new =
3136 malloc(sizeof(*p_mc_new), M_USBDEV, M_WAITOK);
3139 if (p_mc_new != NULL) {
3140 memcpy(p_mc_new, mc, sizeof(*p_mc_new));
3141 p_mc_new->next = sc->sc_mixer_root;
3142 sc->sc_mixer_root = p_mc_new;
3143 sc->sc_mixer_count++;
3145 /* set default value for all channels */
3146 for (ch = 0; ch < p_mc_new->nchan; ch++) {
3147 switch (p_mc_new->val_default) {
3150 p_mc_new->wData[ch] = (p_mc_new->maxval + p_mc_new->minval) / 2;
3154 p_mc_new->wData[ch] = p_mc_new->maxval;
3158 p_mc_new->wData[ch] = p_mc_new->minval;
3163 DPRINTF("out of memory\n");
3168 uaudio_mixer_add_ctl(struct uaudio_softc *sc, struct uaudio_mixer_node *mc)
3172 if (mc->class < UAC_NCLASSES) {
3173 DPRINTF("adding %s.%d\n",
3174 uac_names[mc->class], mc->ctl);
3176 DPRINTF("adding %d\n", mc->ctl);
3179 if (mc->type == MIX_ON_OFF) {
3182 } else if (mc->type == MIX_SELECTOR) {
3185 /* determine min and max values */
3187 mc->minval = uaudio_mixer_get(sc->sc_udev,
3188 sc->sc_audio_rev, GET_MIN, mc);
3189 mc->maxval = uaudio_mixer_get(sc->sc_udev,
3190 sc->sc_audio_rev, GET_MAX, mc);
3192 /* check if max and min was swapped */
3194 if (mc->maxval < mc->minval) {
3196 mc->maxval = mc->minval;
3200 /* compute value range */
3201 mc->mul = mc->maxval - mc->minval;
3205 /* compute value alignment */
3206 res = uaudio_mixer_get(sc->sc_udev,
3207 sc->sc_audio_rev, GET_RES, mc);
3209 DPRINTF("Resolution = %d\n", (int)res);
3212 uaudio_mixer_add_ctl_sub(sc, mc);
3215 if (uaudio_debug > 2) {
3218 for (i = 0; i < mc->nchan; i++) {
3219 DPRINTF("[mix] wValue=%04x\n", mc->wValue[0]);
3221 DPRINTF("[mix] wIndex=%04x type=%d ctl='%d' "
3223 mc->wIndex, mc->type, mc->ctl,
3224 mc->minval, mc->maxval);
3230 uaudio_mixer_add_mixer(struct uaudio_softc *sc,
3231 const struct uaudio_terminal_node *iot, int id)
3233 const struct usb_audio_mixer_unit_0 *d0 = iot[id].u.mu_v1;
3234 const struct usb_audio_mixer_unit_1 *d1;
3236 uint32_t bno; /* bit number */
3237 uint32_t p; /* bit number accumulator */
3238 uint32_t mo; /* matching outputs */
3239 uint32_t mc; /* matching channels */
3240 uint32_t ichs; /* input channels */
3241 uint32_t ochs; /* output channels */
3243 uint32_t chs; /* channels */
3247 DPRINTFN(3, "bUnitId=%d bNrInPins=%d\n",
3248 d0->bUnitId, d0->bNrInPins);
3250 /* compute the number of input channels */
3253 for (i = 0; i < d0->bNrInPins; i++) {
3254 ichs += uaudio_mixer_get_cluster(
3255 d0->baSourceId[i], iot).bNrChannels;
3258 d1 = (const void *)(d0->baSourceId + d0->bNrInPins);
3260 /* and the number of output channels */
3262 ochs = d1->bNrChannels;
3264 DPRINTFN(3, "ichs=%d ochs=%d\n", ichs, ochs);
3266 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3268 MIX(sc).wIndex = MAKE_WORD(d0->bUnitId, sc->sc_mixer_iface_no);
3269 uaudio_mixer_determine_class(&iot[id], &MIX(sc));
3270 MIX(sc).type = MIX_SIGNED_16;
3272 if (uaudio_mixer_verify_desc(d0, ((ichs * ochs) + 7) / 8) == NULL)
3275 for (p = i = 0; i < d0->bNrInPins; i++) {
3276 chs = uaudio_mixer_get_cluster(
3277 d0->baSourceId[i], iot).bNrChannels;
3279 for (c = 0; c < chs; c++) {
3281 for (o = 0; o < ochs; o++) {
3282 bno = ((p + c) * ochs) + o;
3283 if (BIT_TEST(d1->bmControls, bno))
3289 if ((mc == chs) && (chs <= MIX_MAX_CHAN)) {
3291 /* repeat bit-scan */
3294 for (c = 0; c < chs; c++) {
3295 for (o = 0; o < ochs; o++) {
3296 bno = ((p + c) * ochs) + o;
3297 if (BIT_TEST(d1->bmControls, bno))
3298 MIX(sc).wValue[mc++] = MAKE_WORD(p + c + 1, o + 1);
3301 MIX(sc).nchan = chs;
3302 uaudio_mixer_add_ctl(sc, &MIX(sc));
3309 uaudio20_mixer_add_mixer(struct uaudio_softc *sc,
3310 const struct uaudio_terminal_node *iot, int id)
3312 const struct usb_audio20_mixer_unit_0 *d0 = iot[id].u.mu_v2;
3313 const struct usb_audio20_mixer_unit_1 *d1;
3315 uint32_t bno; /* bit number */
3316 uint32_t p; /* bit number accumulator */
3317 uint32_t mo; /* matching outputs */
3318 uint32_t mc; /* matching channels */
3319 uint32_t ichs; /* input channels */
3320 uint32_t ochs; /* output channels */
3322 uint32_t chs; /* channels */
3326 DPRINTFN(3, "bUnitId=%d bNrInPins=%d\n",
3327 d0->bUnitId, d0->bNrInPins);
3329 /* compute the number of input channels */
3332 for (i = 0; i < d0->bNrInPins; i++) {
3333 ichs += uaudio20_mixer_get_cluster(
3334 d0->baSourceId[i], iot).bNrChannels;
3337 d1 = (const void *)(d0->baSourceId + d0->bNrInPins);
3339 /* and the number of output channels */
3341 ochs = d1->bNrChannels;
3343 DPRINTFN(3, "ichs=%d ochs=%d\n", ichs, ochs);
3345 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3347 MIX(sc).wIndex = MAKE_WORD(d0->bUnitId, sc->sc_mixer_iface_no);
3348 uaudio20_mixer_determine_class(&iot[id], &MIX(sc));
3349 MIX(sc).type = MIX_SIGNED_16;
3351 if (uaudio20_mixer_verify_desc(d0, ((ichs * ochs) + 7) / 8) == NULL)
3354 for (p = i = 0; i < d0->bNrInPins; i++) {
3355 chs = uaudio20_mixer_get_cluster(
3356 d0->baSourceId[i], iot).bNrChannels;
3358 for (c = 0; c < chs; c++) {
3360 for (o = 0; o < ochs; o++) {
3361 bno = ((p + c) * ochs) + o;
3362 if (BIT_TEST(d1->bmControls, bno))
3368 if ((mc == chs) && (chs <= MIX_MAX_CHAN)) {
3370 /* repeat bit-scan */
3373 for (c = 0; c < chs; c++) {
3374 for (o = 0; o < ochs; o++) {
3375 bno = ((p + c) * ochs) + o;
3376 if (BIT_TEST(d1->bmControls, bno))
3377 MIX(sc).wValue[mc++] = MAKE_WORD(p + c + 1, o + 1);
3380 MIX(sc).nchan = chs;
3381 uaudio_mixer_add_ctl(sc, &MIX(sc));
3388 uaudio_mixer_add_selector(struct uaudio_softc *sc,
3389 const struct uaudio_terminal_node *iot, int id)
3391 const struct usb_audio_selector_unit *d = iot[id].u.su_v1;
3394 DPRINTFN(3, "bUnitId=%d bNrInPins=%d\n",
3395 d->bUnitId, d->bNrInPins);
3397 if (d->bNrInPins == 0)
3400 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3402 MIX(sc).wIndex = MAKE_WORD(d->bUnitId, sc->sc_mixer_iface_no);
3403 MIX(sc).wValue[0] = MAKE_WORD(0, 0);
3404 uaudio_mixer_determine_class(&iot[id], &MIX(sc));
3406 MIX(sc).type = MIX_SELECTOR;
3407 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3409 MIX(sc).maxval = d->bNrInPins;
3410 MIX(sc).name = "selector";
3412 i = d->baSourceId[d->bNrInPins];
3414 usbd_req_get_string_any(sc->sc_udev, NULL,
3415 MIX(sc).desc, sizeof(MIX(sc).desc), i) != 0) {
3416 MIX(sc).desc[0] = 0;
3419 if (MIX(sc).maxval > MAX_SELECTOR_INPUT_PIN) {
3420 MIX(sc).maxval = MAX_SELECTOR_INPUT_PIN;
3422 MIX(sc).mul = (MIX(sc).maxval - MIX(sc).minval);
3423 for (i = 0; i < MAX_SELECTOR_INPUT_PIN; i++) {
3424 MIX(sc).slctrtype[i] = SOUND_MIXER_NRDEVICES;
3427 for (i = 0; i < MIX(sc).maxval; i++) {
3428 MIX(sc).slctrtype[i] = uaudio_mixer_feature_name(
3429 &iot[d->baSourceId[i]], &MIX(sc));
3432 MIX(sc).class = 0; /* not used */
3434 uaudio_mixer_add_ctl(sc, &MIX(sc));
3438 uaudio20_mixer_add_selector(struct uaudio_softc *sc,
3439 const struct uaudio_terminal_node *iot, int id)
3441 const struct usb_audio20_selector_unit *d = iot[id].u.su_v2;
3444 DPRINTFN(3, "bUnitId=%d bNrInPins=%d\n",
3445 d->bUnitId, d->bNrInPins);
3447 if (d->bNrInPins == 0)
3450 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3452 MIX(sc).wIndex = MAKE_WORD(d->bUnitId, sc->sc_mixer_iface_no);
3453 MIX(sc).wValue[0] = MAKE_WORD(0, 0);
3454 uaudio20_mixer_determine_class(&iot[id], &MIX(sc));
3456 MIX(sc).type = MIX_SELECTOR;
3457 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3459 MIX(sc).maxval = d->bNrInPins;
3460 MIX(sc).name = "selector";
3462 i = d->baSourceId[d->bNrInPins];
3464 usbd_req_get_string_any(sc->sc_udev, NULL,
3465 MIX(sc).desc, sizeof(MIX(sc).desc), i) != 0) {
3466 MIX(sc).desc[0] = 0;
3469 if (MIX(sc).maxval > MAX_SELECTOR_INPUT_PIN)
3470 MIX(sc).maxval = MAX_SELECTOR_INPUT_PIN;
3472 MIX(sc).mul = (MIX(sc).maxval - MIX(sc).minval);
3473 for (i = 0; i < MAX_SELECTOR_INPUT_PIN; i++)
3474 MIX(sc).slctrtype[i] = SOUND_MIXER_NRDEVICES;
3476 for (i = 0; i < MIX(sc).maxval; i++) {
3477 MIX(sc).slctrtype[i] = uaudio20_mixer_feature_name(
3478 &iot[d->baSourceId[i]], &MIX(sc));
3481 MIX(sc).class = 0; /* not used */
3483 uaudio_mixer_add_ctl(sc, &MIX(sc));
3487 uaudio_mixer_feature_get_bmaControls(const struct usb_audio_feature_unit *d,
3491 uint32_t offset = (i * d->bControlSize);
3493 if (d->bControlSize > 0) {
3494 temp |= d->bmaControls[offset];
3495 if (d->bControlSize > 1) {
3496 temp |= d->bmaControls[offset + 1] << 8;
3497 if (d->bControlSize > 2) {
3498 temp |= d->bmaControls[offset + 2] << 16;
3499 if (d->bControlSize > 3) {
3500 temp |= d->bmaControls[offset + 3] << 24;
3509 uaudio_mixer_add_feature(struct uaudio_softc *sc,
3510 const struct uaudio_terminal_node *iot, int id)
3512 const struct usb_audio_feature_unit *d = iot[id].u.fu_v1;
3516 uint16_t mixernumber;
3522 if (d->bControlSize == 0)
3525 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3527 nchan = (d->bLength - 7) / d->bControlSize;
3528 mmask = uaudio_mixer_feature_get_bmaControls(d, 0);
3534 /* figure out what we can control */
3536 for (chan = 1; chan < nchan; chan++) {
3537 DPRINTFN(10, "chan=%d mask=%x\n",
3538 chan, uaudio_mixer_feature_get_bmaControls(d, chan));
3540 cmask |= uaudio_mixer_feature_get_bmaControls(d, chan);
3543 if (nchan > MIX_MAX_CHAN) {
3544 nchan = MIX_MAX_CHAN;
3546 MIX(sc).wIndex = MAKE_WORD(d->bUnitId, sc->sc_mixer_iface_no);
3548 i = d->bmaControls[d->bControlSize];
3550 usbd_req_get_string_any(sc->sc_udev, NULL,
3551 MIX(sc).desc, sizeof(MIX(sc).desc), i) != 0) {
3552 MIX(sc).desc[0] = 0;
3555 for (ctl = 1; ctl <= LOUDNESS_CONTROL; ctl++) {
3557 fumask = FU_MASK(ctl);
3559 DPRINTFN(5, "ctl=%d fumask=0x%04x\n",
3562 if (mmask & fumask) {
3564 MIX(sc).wValue[0] = MAKE_WORD(ctl, 0);
3565 } else if (cmask & fumask) {
3566 MIX(sc).nchan = nchan - 1;
3567 for (i = 1; i < nchan; i++) {
3568 if (uaudio_mixer_feature_get_bmaControls(d, i) & fumask)
3569 MIX(sc).wValue[i - 1] = MAKE_WORD(ctl, i);
3571 MIX(sc).wValue[i - 1] = -1;
3577 mixernumber = uaudio_mixer_feature_name(&iot[id], &MIX(sc));
3581 MIX(sc).type = MIX_ON_OFF;
3582 MIX(sc).ctl = SOUND_MIXER_MUTE;
3583 MIX(sc).name = "mute";
3586 case VOLUME_CONTROL:
3587 MIX(sc).type = MIX_SIGNED_16;
3588 MIX(sc).ctl = mixernumber;
3589 MIX(sc).name = "vol";
3593 MIX(sc).type = MIX_SIGNED_8;
3594 MIX(sc).ctl = SOUND_MIXER_BASS;
3595 MIX(sc).name = "bass";
3599 MIX(sc).type = MIX_SIGNED_8;
3600 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3601 MIX(sc).name = "mid";
3604 case TREBLE_CONTROL:
3605 MIX(sc).type = MIX_SIGNED_8;
3606 MIX(sc).ctl = SOUND_MIXER_TREBLE;
3607 MIX(sc).name = "treble";
3610 case GRAPHIC_EQUALIZER_CONTROL:
3611 continue; /* XXX don't add anything */
3614 MIX(sc).type = MIX_ON_OFF;
3615 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3616 MIX(sc).name = "agc";
3620 MIX(sc).type = MIX_UNSIGNED_16;
3621 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3622 MIX(sc).name = "delay";
3625 case BASS_BOOST_CONTROL:
3626 MIX(sc).type = MIX_ON_OFF;
3627 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3628 MIX(sc).name = "boost";
3631 case LOUDNESS_CONTROL:
3632 MIX(sc).type = MIX_ON_OFF;
3633 MIX(sc).ctl = SOUND_MIXER_LOUD; /* Is this correct ? */
3634 MIX(sc).name = "loudness";
3638 MIX(sc).type = MIX_UNKNOWN;
3642 if (MIX(sc).type != MIX_UNKNOWN)
3643 uaudio_mixer_add_ctl(sc, &MIX(sc));
3648 uaudio20_mixer_add_feature(struct uaudio_softc *sc,
3649 const struct uaudio_terminal_node *iot, int id)
3651 const struct usb_audio20_feature_unit *d = iot[id].u.fu_v2;
3655 uint16_t mixernumber;
3661 if (UGETDW(d->bmaControls[0]) == 0)
3664 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3666 nchan = (d->bLength - 6) / 4;
3667 mmask = UGETDW(d->bmaControls[0]);
3673 /* figure out what we can control */
3675 for (chan = 1; chan < nchan; chan++)
3676 cmask |= UGETDW(d->bmaControls[chan]);
3678 if (nchan > MIX_MAX_CHAN)
3679 nchan = MIX_MAX_CHAN;
3681 MIX(sc).wIndex = MAKE_WORD(d->bUnitId, sc->sc_mixer_iface_no);
3683 i = d->bmaControls[nchan][0];
3685 usbd_req_get_string_any(sc->sc_udev, NULL,
3686 MIX(sc).desc, sizeof(MIX(sc).desc), i) != 0) {
3687 MIX(sc).desc[0] = 0;
3690 for (ctl = 3; ctl != 0; ctl <<= 2) {
3692 mixernumber = uaudio20_mixer_feature_name(&iot[id], &MIX(sc));
3696 MIX(sc).type = MIX_ON_OFF;
3697 MIX(sc).ctl = SOUND_MIXER_MUTE;
3698 MIX(sc).name = "mute";
3699 what = MUTE_CONTROL;
3702 MIX(sc).type = MIX_SIGNED_16;
3703 MIX(sc).ctl = mixernumber;
3704 MIX(sc).name = "vol";
3705 what = VOLUME_CONTROL;
3708 MIX(sc).type = MIX_SIGNED_8;
3709 MIX(sc).ctl = SOUND_MIXER_BASS;
3710 MIX(sc).name = "bass";
3711 what = BASS_CONTROL;
3714 MIX(sc).type = MIX_SIGNED_8;
3715 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3716 MIX(sc).name = "mid";
3720 MIX(sc).type = MIX_SIGNED_8;
3721 MIX(sc).ctl = SOUND_MIXER_TREBLE;
3722 MIX(sc).name = "treble";
3723 what = TREBLE_CONTROL;
3726 MIX(sc).type = MIX_ON_OFF;
3727 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3728 MIX(sc).name = "agc";
3732 MIX(sc).type = MIX_UNSIGNED_16;
3733 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3734 MIX(sc).name = "delay";
3735 what = DELAY_CONTROL;
3738 MIX(sc).type = MIX_ON_OFF;
3739 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3740 MIX(sc).name = "boost";
3741 what = BASS_BOOST_CONTROL;
3744 MIX(sc).type = MIX_ON_OFF;
3745 MIX(sc).ctl = SOUND_MIXER_LOUD; /* Is this correct ? */
3746 MIX(sc).name = "loudness";
3747 what = LOUDNESS_CONTROL;
3750 MIX(sc).type = MIX_SIGNED_16;
3751 MIX(sc).ctl = mixernumber;
3752 MIX(sc).name = "igain";
3753 what = INPUT_GAIN_CONTROL;
3756 MIX(sc).type = MIX_SIGNED_16;
3757 MIX(sc).ctl = mixernumber;
3758 MIX(sc).name = "igainpad";
3759 what = INPUT_GAIN_PAD_CONTROL;
3765 if ((mmask & ctl) == ctl) {
3767 MIX(sc).wValue[0] = MAKE_WORD(what, 0);
3768 } else if ((cmask & ctl) == ctl) {
3769 MIX(sc).nchan = nchan - 1;
3770 for (i = 1; i < nchan; i++) {
3771 if ((UGETDW(d->bmaControls[i]) & ctl) == ctl)
3772 MIX(sc).wValue[i - 1] = MAKE_WORD(what, i);
3774 MIX(sc).wValue[i - 1] = -1;
3780 if (MIX(sc).type != MIX_UNKNOWN)
3781 uaudio_mixer_add_ctl(sc, &MIX(sc));
3786 uaudio_mixer_add_processing_updown(struct uaudio_softc *sc,
3787 const struct uaudio_terminal_node *iot, int id)
3789 const struct usb_audio_processing_unit_0 *d0 = iot[id].u.pu_v1;
3790 const struct usb_audio_processing_unit_1 *d1 =
3791 (const void *)(d0->baSourceId + d0->bNrInPins);
3792 const struct usb_audio_processing_unit_updown *ud =
3793 (const void *)(d1->bmControls + d1->bControlSize);
3796 if (uaudio_mixer_verify_desc(d0, sizeof(*ud)) == NULL) {
3799 if (uaudio_mixer_verify_desc(d0, sizeof(*ud) + (2 * ud->bNrModes))
3803 DPRINTFN(3, "bUnitId=%d bNrModes=%d\n",
3804 d0->bUnitId, ud->bNrModes);
3806 if (!(d1->bmControls[0] & UA_PROC_MASK(UD_MODE_SELECT_CONTROL))) {
3807 DPRINTF("no mode select\n");
3810 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3812 MIX(sc).wIndex = MAKE_WORD(d0->bUnitId, sc->sc_mixer_iface_no);
3814 MIX(sc).wValue[0] = MAKE_WORD(UD_MODE_SELECT_CONTROL, 0);
3815 uaudio_mixer_determine_class(&iot[id], &MIX(sc));
3816 MIX(sc).type = MIX_ON_OFF; /* XXX */
3818 for (i = 0; i < ud->bNrModes; i++) {
3819 DPRINTFN(3, "i=%d bm=0x%x\n", i, UGETW(ud->waModes[i]));
3823 uaudio_mixer_add_ctl(sc, &MIX(sc));
3827 uaudio_mixer_add_processing(struct uaudio_softc *sc,
3828 const struct uaudio_terminal_node *iot, int id)
3830 const struct usb_audio_processing_unit_0 *d0 = iot[id].u.pu_v1;
3831 const struct usb_audio_processing_unit_1 *d1 =
3832 (const void *)(d0->baSourceId + d0->bNrInPins);
3835 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3837 ptype = UGETW(d0->wProcessType);
3839 DPRINTFN(3, "wProcessType=%d bUnitId=%d "
3840 "bNrInPins=%d\n", ptype, d0->bUnitId, d0->bNrInPins);
3842 if (d1->bControlSize == 0) {
3845 if (d1->bmControls[0] & UA_PROC_ENABLE_MASK) {
3846 MIX(sc).wIndex = MAKE_WORD(d0->bUnitId, sc->sc_mixer_iface_no);
3848 MIX(sc).wValue[0] = MAKE_WORD(XX_ENABLE_CONTROL, 0);
3849 uaudio_mixer_determine_class(&iot[id], &MIX(sc));
3850 MIX(sc).type = MIX_ON_OFF;
3851 uaudio_mixer_add_ctl(sc, &MIX(sc));
3854 case UPDOWNMIX_PROCESS:
3855 uaudio_mixer_add_processing_updown(sc, iot, id);
3858 case DOLBY_PROLOGIC_PROCESS:
3859 case P3D_STEREO_EXTENDER_PROCESS:
3860 case REVERBATION_PROCESS:
3861 case CHORUS_PROCESS:
3862 case DYN_RANGE_COMP_PROCESS:
3864 DPRINTF("unit %d, type=%d is not implemented\n",
3865 d0->bUnitId, ptype);
3871 uaudio_mixer_add_extension(struct uaudio_softc *sc,
3872 const struct uaudio_terminal_node *iot, int id)
3874 const struct usb_audio_extension_unit_0 *d0 = iot[id].u.eu_v1;
3875 const struct usb_audio_extension_unit_1 *d1 =
3876 (const void *)(d0->baSourceId + d0->bNrInPins);
3878 DPRINTFN(3, "bUnitId=%d bNrInPins=%d\n",
3879 d0->bUnitId, d0->bNrInPins);
3881 if (sc->sc_uq_au_no_xu) {
3884 if (d1->bControlSize == 0) {
3887 if (d1->bmControls[0] & UA_EXT_ENABLE_MASK) {
3889 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3891 MIX(sc).wIndex = MAKE_WORD(d0->bUnitId, sc->sc_mixer_iface_no);
3893 MIX(sc).wValue[0] = MAKE_WORD(UA_EXT_ENABLE, 0);
3894 uaudio_mixer_determine_class(&iot[id], &MIX(sc));
3895 MIX(sc).type = MIX_ON_OFF;
3897 uaudio_mixer_add_ctl(sc, &MIX(sc));
3902 uaudio_mixer_verify_desc(const void *arg, uint32_t len)
3904 const struct usb_audio_mixer_unit_1 *d1;
3905 const struct usb_audio_extension_unit_1 *e1;
3906 const struct usb_audio_processing_unit_1 *u1;
3909 const struct usb_descriptor *desc;
3910 const struct usb_audio_input_terminal *it;
3911 const struct usb_audio_output_terminal *ot;
3912 const struct usb_audio_mixer_unit_0 *mu;
3913 const struct usb_audio_selector_unit *su;
3914 const struct usb_audio_feature_unit *fu;
3915 const struct usb_audio_processing_unit_0 *pu;
3916 const struct usb_audio_extension_unit_0 *eu;
3921 if (u.desc == NULL) {
3924 if (u.desc->bDescriptorType != UDESC_CS_INTERFACE) {
3927 switch (u.desc->bDescriptorSubtype) {
3928 case UDESCSUB_AC_INPUT:
3929 len += sizeof(*u.it);
3932 case UDESCSUB_AC_OUTPUT:
3933 len += sizeof(*u.ot);
3936 case UDESCSUB_AC_MIXER:
3937 len += sizeof(*u.mu);
3939 if (u.desc->bLength < len) {
3942 len += u.mu->bNrInPins;
3944 if (u.desc->bLength < len) {
3947 d1 = (const void *)(u.mu->baSourceId + u.mu->bNrInPins);
3952 case UDESCSUB_AC_SELECTOR:
3953 len += sizeof(*u.su);
3955 if (u.desc->bLength < len) {
3958 len += u.su->bNrInPins + 1;
3961 case UDESCSUB_AC_FEATURE:
3962 len += sizeof(*u.fu) + 1;
3964 if (u.desc->bLength < len)
3967 len += u.fu->bControlSize;
3970 case UDESCSUB_AC_PROCESSING:
3971 len += sizeof(*u.pu);
3973 if (u.desc->bLength < len) {
3976 len += u.pu->bNrInPins;
3978 if (u.desc->bLength < len) {
3981 u1 = (const void *)(u.pu->baSourceId + u.pu->bNrInPins);
3985 if (u.desc->bLength < len) {
3988 len += u1->bControlSize;
3992 case UDESCSUB_AC_EXTENSION:
3993 len += sizeof(*u.eu);
3995 if (u.desc->bLength < len) {
3998 len += u.eu->bNrInPins;
4000 if (u.desc->bLength < len) {
4003 e1 = (const void *)(u.eu->baSourceId + u.eu->bNrInPins);
4007 if (u.desc->bLength < len) {
4010 len += e1->bControlSize;
4017 if (u.desc->bLength < len) {
4024 DPRINTF("invalid descriptor, type=%d, "
4025 "sub_type=%d, len=%d of %d bytes\n",
4026 u.desc->bDescriptorType,
4027 u.desc->bDescriptorSubtype,
4028 u.desc->bLength, len);
4034 uaudio20_mixer_verify_desc(const void *arg, uint32_t len)
4036 const struct usb_audio20_mixer_unit_1 *d1;
4037 const struct usb_audio20_extension_unit_1 *e1;
4038 const struct usb_audio20_processing_unit_1 *u1;
4039 const struct usb_audio20_clock_selector_unit_1 *c1;
4042 const struct usb_descriptor *desc;
4043 const struct usb_audio20_clock_source_unit *csrc;
4044 const struct usb_audio20_clock_selector_unit_0 *csel;
4045 const struct usb_audio20_clock_multiplier_unit *cmul;
4046 const struct usb_audio20_input_terminal *it;
4047 const struct usb_audio20_output_terminal *ot;
4048 const struct usb_audio20_mixer_unit_0 *mu;
4049 const struct usb_audio20_selector_unit *su;
4050 const struct usb_audio20_feature_unit *fu;
4051 const struct usb_audio20_sample_rate_unit *ru;
4052 const struct usb_audio20_processing_unit_0 *pu;
4053 const struct usb_audio20_extension_unit_0 *eu;
4054 const struct usb_audio20_effect_unit *ef;
4062 if (u.desc->bDescriptorType != UDESC_CS_INTERFACE)
4065 switch (u.desc->bDescriptorSubtype) {
4066 case UDESCSUB_AC_INPUT:
4067 len += sizeof(*u.it);
4070 case UDESCSUB_AC_OUTPUT:
4071 len += sizeof(*u.ot);
4074 case UDESCSUB_AC_MIXER:
4075 len += sizeof(*u.mu);
4077 if (u.desc->bLength < len)
4079 len += u.mu->bNrInPins;
4081 if (u.desc->bLength < len)
4084 d1 = (const void *)(u.mu->baSourceId + u.mu->bNrInPins);
4086 len += sizeof(*d1) + d1->bNrChannels;
4089 case UDESCSUB_AC_SELECTOR:
4090 len += sizeof(*u.su);
4092 if (u.desc->bLength < len)
4095 len += u.su->bNrInPins + 1;
4098 case UDESCSUB_AC_FEATURE:
4099 len += sizeof(*u.fu) + 1;
4102 case UDESCSUB_AC_EFFECT:
4103 len += sizeof(*u.ef) + 4;
4106 case UDESCSUB_AC_PROCESSING_V2:
4107 len += sizeof(*u.pu);
4109 if (u.desc->bLength < len)
4112 len += u.pu->bNrInPins;
4114 if (u.desc->bLength < len)
4117 u1 = (const void *)(u.pu->baSourceId + u.pu->bNrInPins);
4122 case UDESCSUB_AC_EXTENSION_V2:
4123 len += sizeof(*u.eu);
4125 if (u.desc->bLength < len)
4128 len += u.eu->bNrInPins;
4130 if (u.desc->bLength < len)
4133 e1 = (const void *)(u.eu->baSourceId + u.eu->bNrInPins);
4138 case UDESCSUB_AC_CLOCK_SRC:
4139 len += sizeof(*u.csrc);
4142 case UDESCSUB_AC_CLOCK_SEL:
4143 len += sizeof(*u.csel);
4145 if (u.desc->bLength < len)
4148 len += u.csel->bNrInPins;
4150 if (u.desc->bLength < len)
4153 c1 = (const void *)(u.csel->baCSourceId + u.csel->bNrInPins);
4158 case UDESCSUB_AC_CLOCK_MUL:
4159 len += sizeof(*u.cmul);
4162 case UDESCSUB_AC_SAMPLE_RT:
4163 len += sizeof(*u.ru);
4170 if (u.desc->bLength < len)
4177 DPRINTF("invalid descriptor, type=%d, "
4178 "sub_type=%d, len=%d of %d bytes\n",
4179 u.desc->bDescriptorType,
4180 u.desc->bDescriptorSubtype,
4181 u.desc->bLength, len);
4186 static struct usb_audio_cluster
4187 uaudio_mixer_get_cluster(uint8_t id, const struct uaudio_terminal_node *iot)
4189 struct usb_audio_cluster r;
4190 const struct usb_descriptor *dp;
4193 for (i = 0; i < UAUDIO_RECURSE_LIMIT; i++) { /* avoid infinite loops */
4194 dp = iot[id].u.desc;
4198 switch (dp->bDescriptorSubtype) {
4199 case UDESCSUB_AC_INPUT:
4200 r.bNrChannels = iot[id].u.it_v1->bNrChannels;
4201 r.wChannelConfig[0] = iot[id].u.it_v1->wChannelConfig[0];
4202 r.wChannelConfig[1] = iot[id].u.it_v1->wChannelConfig[1];
4203 r.iChannelNames = iot[id].u.it_v1->iChannelNames;
4206 case UDESCSUB_AC_OUTPUT:
4207 id = iot[id].u.ot_v1->bSourceId;
4210 case UDESCSUB_AC_MIXER:
4211 r = *(const struct usb_audio_cluster *)
4212 &iot[id].u.mu_v1->baSourceId[
4213 iot[id].u.mu_v1->bNrInPins];
4216 case UDESCSUB_AC_SELECTOR:
4217 if (iot[id].u.su_v1->bNrInPins > 0) {
4218 /* XXX This is not really right */
4219 id = iot[id].u.su_v1->baSourceId[0];
4223 case UDESCSUB_AC_FEATURE:
4224 id = iot[id].u.fu_v1->bSourceId;
4227 case UDESCSUB_AC_PROCESSING:
4228 r = *((const struct usb_audio_cluster *)
4229 &iot[id].u.pu_v1->baSourceId[
4230 iot[id].u.pu_v1->bNrInPins]);
4233 case UDESCSUB_AC_EXTENSION:
4234 r = *((const struct usb_audio_cluster *)
4235 &iot[id].u.eu_v1->baSourceId[
4236 iot[id].u.eu_v1->bNrInPins]);
4244 DPRINTF("bad data\n");
4245 memset(&r, 0, sizeof(r));
4250 static struct usb_audio20_cluster
4251 uaudio20_mixer_get_cluster(uint8_t id, const struct uaudio_terminal_node *iot)
4253 struct usb_audio20_cluster r;
4254 const struct usb_descriptor *dp;
4257 for (i = 0; i < UAUDIO_RECURSE_LIMIT; i++) { /* avoid infinite loops */
4258 dp = iot[id].u.desc;
4262 switch (dp->bDescriptorSubtype) {
4263 case UDESCSUB_AC_INPUT:
4264 r.bNrChannels = iot[id].u.it_v2->bNrChannels;
4265 r.bmChannelConfig[0] = iot[id].u.it_v2->bmChannelConfig[0];
4266 r.bmChannelConfig[1] = iot[id].u.it_v2->bmChannelConfig[1];
4267 r.bmChannelConfig[2] = iot[id].u.it_v2->bmChannelConfig[2];
4268 r.bmChannelConfig[3] = iot[id].u.it_v2->bmChannelConfig[3];
4269 r.iChannelNames = iot[id].u.it_v2->iTerminal;
4272 case UDESCSUB_AC_OUTPUT:
4273 id = iot[id].u.ot_v2->bSourceId;
4276 case UDESCSUB_AC_MIXER:
4277 r = *(const struct usb_audio20_cluster *)
4278 &iot[id].u.mu_v2->baSourceId[
4279 iot[id].u.mu_v2->bNrInPins];
4282 case UDESCSUB_AC_SELECTOR:
4283 if (iot[id].u.su_v2->bNrInPins > 0) {
4284 /* XXX This is not really right */
4285 id = iot[id].u.su_v2->baSourceId[0];
4289 case UDESCSUB_AC_SAMPLE_RT:
4290 id = iot[id].u.ru_v2->bSourceId;
4293 case UDESCSUB_AC_EFFECT:
4294 id = iot[id].u.ef_v2->bSourceId;
4297 case UDESCSUB_AC_FEATURE:
4298 id = iot[id].u.fu_v2->bSourceId;
4301 case UDESCSUB_AC_PROCESSING_V2:
4302 r = *((const struct usb_audio20_cluster *)
4303 &iot[id].u.pu_v2->baSourceId[
4304 iot[id].u.pu_v2->bNrInPins]);
4307 case UDESCSUB_AC_EXTENSION_V2:
4308 r = *((const struct usb_audio20_cluster *)
4309 &iot[id].u.eu_v2->baSourceId[
4310 iot[id].u.eu_v2->bNrInPins]);
4318 DPRINTF("Bad data!\n");
4319 memset(&r, 0, sizeof(r));
4325 uaudio_mixer_determine_class(const struct uaudio_terminal_node *iot,
4326 struct uaudio_mixer_node *mix)
4328 uint16_t terminal_type = 0x0000;
4329 const struct uaudio_terminal_node *input[2];
4330 const struct uaudio_terminal_node *output[2];
4332 input[0] = uaudio_mixer_get_input(iot, 0);
4333 input[1] = uaudio_mixer_get_input(iot, 1);
4335 output[0] = uaudio_mixer_get_output(iot, 0);
4336 output[1] = uaudio_mixer_get_output(iot, 1);
4339 * check if there is only
4340 * one output terminal:
4342 if (output[0] && (!output[1])) {
4344 UGETW(output[0]->u.ot_v1->wTerminalType);
4347 * If the only output terminal is USB,
4348 * the class is UAC_RECORD.
4350 if ((terminal_type & 0xff00) == (UAT_UNDEFINED & 0xff00)) {
4352 mix->class = UAC_RECORD;
4353 if (input[0] && (!input[1])) {
4355 UGETW(input[0]->u.it_v1->wTerminalType);
4362 * if the unit is connected to just
4363 * one input terminal, the
4364 * class is UAC_INPUT:
4366 if (input[0] && (!input[1])) {
4367 mix->class = UAC_INPUT;
4369 UGETW(input[0]->u.it_v1->wTerminalType);
4373 * Otherwise, the class is UAC_OUTPUT.
4375 mix->class = UAC_OUTPUT;
4377 return (terminal_type);
4381 uaudio20_mixer_determine_class(const struct uaudio_terminal_node *iot,
4382 struct uaudio_mixer_node *mix)
4384 uint16_t terminal_type = 0x0000;
4385 const struct uaudio_terminal_node *input[2];
4386 const struct uaudio_terminal_node *output[2];
4388 input[0] = uaudio_mixer_get_input(iot, 0);
4389 input[1] = uaudio_mixer_get_input(iot, 1);
4391 output[0] = uaudio_mixer_get_output(iot, 0);
4392 output[1] = uaudio_mixer_get_output(iot, 1);
4395 * check if there is only
4396 * one output terminal:
4398 if (output[0] && (!output[1]))
4399 terminal_type = UGETW(output[0]->u.ot_v2->wTerminalType);
4401 * If the only output terminal is USB,
4402 * the class is UAC_RECORD.
4404 if ((terminal_type & 0xff00) == (UAT_UNDEFINED & 0xff00)) {
4406 mix->class = UAC_RECORD;
4407 if (input[0] && (!input[1])) {
4409 UGETW(input[0]->u.it_v2->wTerminalType);
4416 * if the unit is connected to just
4417 * one input terminal, the
4418 * class is UAC_INPUT:
4420 if (input[0] && (!input[1])) {
4421 mix->class = UAC_INPUT;
4423 UGETW(input[0]->u.it_v2->wTerminalType);
4427 * Otherwise, the class is UAC_OUTPUT.
4429 mix->class = UAC_OUTPUT;
4431 return (terminal_type);
4434 struct uaudio_tt_to_feature {
4435 uint16_t terminal_type;
4439 static const struct uaudio_tt_to_feature uaudio_tt_to_feature[] = {
4441 {UAT_STREAM, SOUND_MIXER_PCM},
4443 {UATI_MICROPHONE, SOUND_MIXER_MIC},
4444 {UATI_DESKMICROPHONE, SOUND_MIXER_MIC},
4445 {UATI_PERSONALMICROPHONE, SOUND_MIXER_MIC},
4446 {UATI_OMNIMICROPHONE, SOUND_MIXER_MIC},
4447 {UATI_MICROPHONEARRAY, SOUND_MIXER_MIC},
4448 {UATI_PROCMICROPHONEARR, SOUND_MIXER_MIC},
4450 {UATO_SPEAKER, SOUND_MIXER_SPEAKER},
4451 {UATO_DESKTOPSPEAKER, SOUND_MIXER_SPEAKER},
4452 {UATO_ROOMSPEAKER, SOUND_MIXER_SPEAKER},
4453 {UATO_COMMSPEAKER, SOUND_MIXER_SPEAKER},
4455 {UATE_ANALOGCONN, SOUND_MIXER_LINE},
4456 {UATE_LINECONN, SOUND_MIXER_LINE},
4457 {UATE_LEGACYCONN, SOUND_MIXER_LINE},
4459 {UATE_DIGITALAUIFC, SOUND_MIXER_ALTPCM},
4460 {UATE_SPDIF, SOUND_MIXER_ALTPCM},
4461 {UATE_1394DA, SOUND_MIXER_ALTPCM},
4462 {UATE_1394DV, SOUND_MIXER_ALTPCM},
4464 {UATF_CDPLAYER, SOUND_MIXER_CD},
4466 {UATF_SYNTHESIZER, SOUND_MIXER_SYNTH},
4468 {UATF_VIDEODISCAUDIO, SOUND_MIXER_VIDEO},
4469 {UATF_DVDAUDIO, SOUND_MIXER_VIDEO},
4470 {UATF_TVTUNERAUDIO, SOUND_MIXER_VIDEO},
4472 /* telephony terminal types */
4473 {UATT_UNDEFINED, SOUND_MIXER_PHONEIN}, /* SOUND_MIXER_PHONEOUT */
4474 {UATT_PHONELINE, SOUND_MIXER_PHONEIN}, /* SOUND_MIXER_PHONEOUT */
4475 {UATT_TELEPHONE, SOUND_MIXER_PHONEIN}, /* SOUND_MIXER_PHONEOUT */
4476 {UATT_DOWNLINEPHONE, SOUND_MIXER_PHONEIN}, /* SOUND_MIXER_PHONEOUT */
4478 {UATF_RADIORECV, SOUND_MIXER_RADIO},
4479 {UATF_RADIOXMIT, SOUND_MIXER_RADIO},
4481 {UAT_UNDEFINED, SOUND_MIXER_VOLUME},
4482 {UAT_VENDOR, SOUND_MIXER_VOLUME},
4483 {UATI_UNDEFINED, SOUND_MIXER_VOLUME},
4485 /* output terminal types */
4486 {UATO_UNDEFINED, SOUND_MIXER_VOLUME},
4487 {UATO_DISPLAYAUDIO, SOUND_MIXER_VOLUME},
4488 {UATO_SUBWOOFER, SOUND_MIXER_VOLUME},
4489 {UATO_HEADPHONES, SOUND_MIXER_VOLUME},
4491 /* bidir terminal types */
4492 {UATB_UNDEFINED, SOUND_MIXER_VOLUME},
4493 {UATB_HANDSET, SOUND_MIXER_VOLUME},
4494 {UATB_HEADSET, SOUND_MIXER_VOLUME},
4495 {UATB_SPEAKERPHONE, SOUND_MIXER_VOLUME},
4496 {UATB_SPEAKERPHONEESUP, SOUND_MIXER_VOLUME},
4497 {UATB_SPEAKERPHONEECANC, SOUND_MIXER_VOLUME},
4499 /* external terminal types */
4500 {UATE_UNDEFINED, SOUND_MIXER_VOLUME},
4502 /* embedded function terminal types */
4503 {UATF_UNDEFINED, SOUND_MIXER_VOLUME},
4504 {UATF_CALIBNOISE, SOUND_MIXER_VOLUME},
4505 {UATF_EQUNOISE, SOUND_MIXER_VOLUME},
4506 {UATF_DAT, SOUND_MIXER_VOLUME},
4507 {UATF_DCC, SOUND_MIXER_VOLUME},
4508 {UATF_MINIDISK, SOUND_MIXER_VOLUME},
4509 {UATF_ANALOGTAPE, SOUND_MIXER_VOLUME},
4510 {UATF_PHONOGRAPH, SOUND_MIXER_VOLUME},
4511 {UATF_VCRAUDIO, SOUND_MIXER_VOLUME},
4512 {UATF_SATELLITE, SOUND_MIXER_VOLUME},
4513 {UATF_CABLETUNER, SOUND_MIXER_VOLUME},
4514 {UATF_DSS, SOUND_MIXER_VOLUME},
4515 {UATF_MULTITRACK, SOUND_MIXER_VOLUME},
4516 {0xffff, SOUND_MIXER_VOLUME},
4519 {0x0000, SOUND_MIXER_VOLUME},
4523 uaudio_mixer_feature_name(const struct uaudio_terminal_node *iot,
4524 struct uaudio_mixer_node *mix)
4526 const struct uaudio_tt_to_feature *uat = uaudio_tt_to_feature;
4527 uint16_t terminal_type = uaudio_mixer_determine_class(iot, mix);
4529 if ((mix->class == UAC_RECORD) && (terminal_type == 0)) {
4530 return (SOUND_MIXER_IMIX);
4532 while (uat->terminal_type) {
4533 if (uat->terminal_type == terminal_type) {
4539 DPRINTF("terminal_type=0x%04x -> %d\n",
4540 terminal_type, uat->feature);
4542 return (uat->feature);
4546 uaudio20_mixer_feature_name(const struct uaudio_terminal_node *iot,
4547 struct uaudio_mixer_node *mix)
4549 const struct uaudio_tt_to_feature *uat;
4550 uint16_t terminal_type = uaudio20_mixer_determine_class(iot, mix);
4552 if ((mix->class == UAC_RECORD) && (terminal_type == 0))
4553 return (SOUND_MIXER_IMIX);
4555 for (uat = uaudio_tt_to_feature; uat->terminal_type != 0; uat++) {
4556 if (uat->terminal_type == terminal_type)
4560 DPRINTF("terminal_type=0x%04x -> %d\n",
4561 terminal_type, uat->feature);
4563 return (uat->feature);
4566 static const struct uaudio_terminal_node *
4567 uaudio_mixer_get_input(const struct uaudio_terminal_node *iot, uint8_t i)
4569 struct uaudio_terminal_node *root = iot->root;
4572 n = iot->usr.id_max;
4574 if (iot->usr.bit_input[n / 8] & (1 << (n % 8))) {
4583 static const struct uaudio_terminal_node *
4584 uaudio_mixer_get_output(const struct uaudio_terminal_node *iot, uint8_t i)
4586 struct uaudio_terminal_node *root = iot->root;
4589 n = iot->usr.id_max;
4591 if (iot->usr.bit_output[n / 8] & (1 << (n % 8))) {
4601 uaudio_mixer_find_inputs_sub(struct uaudio_terminal_node *root,
4602 const uint8_t *p_id, uint8_t n_id,
4603 struct uaudio_search_result *info)
4605 struct uaudio_terminal_node *iot;
4611 for (n = 0; n < n_id; n++) {
4615 if (info->recurse_level == UAUDIO_RECURSE_LIMIT) {
4616 DPRINTF("avoided going into a circle at id=%d!\n", i);
4620 info->recurse_level++;
4624 if (iot->u.desc == NULL)
4627 is_last = ((n + 1) == n_id);
4629 switch (iot->u.desc->bDescriptorSubtype) {
4630 case UDESCSUB_AC_INPUT:
4631 info->bit_input[i / 8] |= (1 << (i % 8));
4634 case UDESCSUB_AC_FEATURE:
4636 p_id = &iot->u.fu_v1->bSourceId;
4640 uaudio_mixer_find_inputs_sub(
4641 root, &iot->u.fu_v1->bSourceId, 1, info);
4644 case UDESCSUB_AC_OUTPUT:
4646 p_id = &iot->u.ot_v1->bSourceId;
4650 uaudio_mixer_find_inputs_sub(
4651 root, &iot->u.ot_v1->bSourceId, 1, info);
4654 case UDESCSUB_AC_MIXER:
4656 p_id = iot->u.mu_v1->baSourceId;
4657 n_id = iot->u.mu_v1->bNrInPins;
4660 uaudio_mixer_find_inputs_sub(
4661 root, iot->u.mu_v1->baSourceId,
4662 iot->u.mu_v1->bNrInPins, info);
4665 case UDESCSUB_AC_SELECTOR:
4667 p_id = iot->u.su_v1->baSourceId;
4668 n_id = iot->u.su_v1->bNrInPins;
4671 uaudio_mixer_find_inputs_sub(
4672 root, iot->u.su_v1->baSourceId,
4673 iot->u.su_v1->bNrInPins, info);
4676 case UDESCSUB_AC_PROCESSING:
4678 p_id = iot->u.pu_v1->baSourceId;
4679 n_id = iot->u.pu_v1->bNrInPins;
4682 uaudio_mixer_find_inputs_sub(
4683 root, iot->u.pu_v1->baSourceId,
4684 iot->u.pu_v1->bNrInPins, info);
4687 case UDESCSUB_AC_EXTENSION:
4689 p_id = iot->u.eu_v1->baSourceId;
4690 n_id = iot->u.eu_v1->bNrInPins;
4693 uaudio_mixer_find_inputs_sub(
4694 root, iot->u.eu_v1->baSourceId,
4695 iot->u.eu_v1->bNrInPins, info);
4705 uaudio20_mixer_find_inputs_sub(struct uaudio_terminal_node *root,
4706 const uint8_t *p_id, uint8_t n_id,
4707 struct uaudio_search_result *info)
4709 struct uaudio_terminal_node *iot;
4715 for (n = 0; n < n_id; n++) {
4719 if (info->recurse_level == UAUDIO_RECURSE_LIMIT) {
4720 DPRINTF("avoided going into a circle at id=%d!\n", i);
4724 info->recurse_level++;
4728 if (iot->u.desc == NULL)
4731 is_last = ((n + 1) == n_id);
4733 switch (iot->u.desc->bDescriptorSubtype) {
4734 case UDESCSUB_AC_INPUT:
4735 info->bit_input[i / 8] |= (1 << (i % 8));
4738 case UDESCSUB_AC_OUTPUT:
4740 p_id = &iot->u.ot_v2->bSourceId;
4744 uaudio20_mixer_find_inputs_sub(
4745 root, &iot->u.ot_v2->bSourceId, 1, info);
4748 case UDESCSUB_AC_MIXER:
4750 p_id = iot->u.mu_v2->baSourceId;
4751 n_id = iot->u.mu_v2->bNrInPins;
4754 uaudio20_mixer_find_inputs_sub(
4755 root, iot->u.mu_v2->baSourceId,
4756 iot->u.mu_v2->bNrInPins, info);
4759 case UDESCSUB_AC_SELECTOR:
4761 p_id = iot->u.su_v2->baSourceId;
4762 n_id = iot->u.su_v2->bNrInPins;
4765 uaudio20_mixer_find_inputs_sub(
4766 root, iot->u.su_v2->baSourceId,
4767 iot->u.su_v2->bNrInPins, info);
4770 case UDESCSUB_AC_SAMPLE_RT:
4772 p_id = &iot->u.ru_v2->bSourceId;
4776 uaudio20_mixer_find_inputs_sub(
4777 root, &iot->u.ru_v2->bSourceId,
4781 case UDESCSUB_AC_EFFECT:
4783 p_id = &iot->u.ef_v2->bSourceId;
4787 uaudio20_mixer_find_inputs_sub(
4788 root, &iot->u.ef_v2->bSourceId,
4792 case UDESCSUB_AC_FEATURE:
4794 p_id = &iot->u.fu_v2->bSourceId;
4798 uaudio20_mixer_find_inputs_sub(
4799 root, &iot->u.fu_v2->bSourceId, 1, info);
4802 case UDESCSUB_AC_PROCESSING_V2:
4804 p_id = iot->u.pu_v2->baSourceId;
4805 n_id = iot->u.pu_v2->bNrInPins;
4808 uaudio20_mixer_find_inputs_sub(
4809 root, iot->u.pu_v2->baSourceId,
4810 iot->u.pu_v2->bNrInPins, info);
4813 case UDESCSUB_AC_EXTENSION_V2:
4815 p_id = iot->u.eu_v2->baSourceId;
4816 n_id = iot->u.eu_v2->bNrInPins;
4819 uaudio20_mixer_find_inputs_sub(
4820 root, iot->u.eu_v2->baSourceId,
4821 iot->u.eu_v2->bNrInPins, info);
4830 uaudio20_mixer_find_clocks_sub(struct uaudio_terminal_node *root,
4831 const uint8_t *p_id, uint8_t n_id,
4832 struct uaudio_search_result *info)
4834 struct uaudio_terminal_node *iot;
4841 for (n = 0; n < n_id; n++) {
4845 if (info->recurse_level == UAUDIO_RECURSE_LIMIT) {
4846 DPRINTF("avoided going into a circle at id=%d!\n", i);
4850 info->recurse_level++;
4854 if (iot->u.desc == NULL)
4857 is_last = ((n + 1) == n_id);
4859 switch (iot->u.desc->bDescriptorSubtype) {
4860 case UDESCSUB_AC_INPUT:
4863 p_id = &iot->u.it_v2->bCSourceId;
4867 uaudio20_mixer_find_clocks_sub(root,
4868 &iot->u.it_v2->bCSourceId, 1, info);
4871 case UDESCSUB_AC_OUTPUT:
4874 p_id = &iot->u.ot_v2->bCSourceId;
4878 uaudio20_mixer_find_clocks_sub(root,
4879 &iot->u.ot_v2->bCSourceId, 1, info);
4882 case UDESCSUB_AC_CLOCK_SEL:
4884 p_id = iot->u.csel_v2->baCSourceId;
4885 n_id = iot->u.csel_v2->bNrInPins;
4888 uaudio20_mixer_find_clocks_sub(root,
4889 iot->u.csel_v2->baCSourceId,
4890 iot->u.csel_v2->bNrInPins, info);
4893 case UDESCSUB_AC_CLOCK_MUL:
4895 p_id = &iot->u.cmul_v2->bCSourceId;
4899 uaudio20_mixer_find_clocks_sub(root,
4900 &iot->u.cmul_v2->bCSourceId,
4904 case UDESCSUB_AC_CLOCK_SRC:
4906 id = iot->u.csrc_v2->bClockId;
4908 switch (info->is_input) {
4910 info->bit_output[id / 8] |= (1 << (id % 8));
4913 info->bit_input[id / 8] |= (1 << (id % 8));
4927 uaudio_mixer_find_outputs_sub(struct uaudio_terminal_node *root, uint8_t id,
4928 uint8_t n_id, struct uaudio_search_result *info)
4930 struct uaudio_terminal_node *iot = (root + id);
4935 if ((j != id) && ((root + j)->u.desc) &&
4936 ((root + j)->u.desc->bDescriptorSubtype == UDESCSUB_AC_OUTPUT)) {
4939 * "j" (output) <--- virtual wire <--- "id" (input)
4941 * if "j" has "id" on the input, then "id" have "j" on
4942 * the output, because they are connected:
4944 if ((root + j)->usr.bit_input[id / 8] & (1 << (id % 8))) {
4945 iot->usr.bit_output[j / 8] |= (1 << (j % 8));
4952 uaudio_mixer_fill_info(struct uaudio_softc *sc,
4953 struct usb_device *udev, void *desc)
4955 const struct usb_audio_control_descriptor *acdp;
4956 struct usb_config_descriptor *cd = usbd_get_config_descriptor(udev);
4957 const struct usb_descriptor *dp;
4958 const struct usb_audio_unit *au;
4959 struct uaudio_terminal_node *iot = NULL;
4961 uint8_t ID_max = 0; /* inclusive */
4964 desc = usb_desc_foreach(cd, desc);
4967 DPRINTF("no Audio Control header\n");
4972 if ((acdp->bLength < sizeof(*acdp)) ||
4973 (acdp->bDescriptorType != UDESC_CS_INTERFACE) ||
4974 (acdp->bDescriptorSubtype != UDESCSUB_AC_HEADER)) {
4975 DPRINTF("invalid Audio Control header\n");
4978 /* "wTotalLen" is allowed to be corrupt */
4979 wTotalLen = UGETW(acdp->wTotalLength) - acdp->bLength;
4981 /* get USB audio revision */
4982 sc->sc_audio_rev = UGETW(acdp->bcdADC);
4984 DPRINTFN(3, "found AC header, vers=%03x, len=%d\n",
4985 sc->sc_audio_rev, wTotalLen);
4987 iot = malloc(sizeof(struct uaudio_terminal_node) * 256, M_TEMP,
4991 DPRINTF("no memory!\n");
4994 while ((desc = usb_desc_foreach(cd, desc))) {
4998 if (dp->bLength > wTotalLen) {
5001 wTotalLen -= dp->bLength;
5004 if (sc->sc_audio_rev >= UAUDIO_VERSION_30)
5006 else if (sc->sc_audio_rev >= UAUDIO_VERSION_20)
5007 au = uaudio20_mixer_verify_desc(dp, 0);
5009 au = uaudio_mixer_verify_desc(dp, 0);
5012 iot[au->bUnitId].u.desc = (const void *)au;
5013 if (au->bUnitId > ID_max)
5014 ID_max = au->bUnitId;
5018 DPRINTF("Maximum ID=%d\n", ID_max);
5021 * determine sourcing inputs for
5022 * all nodes in the tree:
5026 if (sc->sc_audio_rev >= UAUDIO_VERSION_30) {
5028 } else if (sc->sc_audio_rev >= UAUDIO_VERSION_20) {
5029 uaudio20_mixer_find_inputs_sub(iot,
5030 &i, 1, &((iot + i)->usr));
5032 sc->sc_mixer_clocks.is_input = 255;
5033 sc->sc_mixer_clocks.recurse_level = 0;
5035 uaudio20_mixer_find_clocks_sub(iot,
5036 &i, 1, &sc->sc_mixer_clocks);
5038 uaudio_mixer_find_inputs_sub(iot,
5039 &i, 1, &((iot + i)->usr));
5044 * determine outputs for
5045 * all nodes in the tree:
5049 uaudio_mixer_find_outputs_sub(iot,
5050 i, ID_max, &((iot + i)->usr));
5053 /* set "id_max" and "root" */
5057 (iot + i)->usr.id_max = ID_max;
5058 (iot + i)->root = iot;
5062 * Scan the config to create a linked list of "mixer" nodes:
5072 DPRINTFN(11, "id=%d subtype=%d\n",
5073 i, dp->bDescriptorSubtype);
5075 if (sc->sc_audio_rev >= UAUDIO_VERSION_30) {
5077 } else if (sc->sc_audio_rev >= UAUDIO_VERSION_20) {
5079 switch (dp->bDescriptorSubtype) {
5080 case UDESCSUB_AC_HEADER:
5081 DPRINTF("unexpected AC header\n");
5084 case UDESCSUB_AC_INPUT:
5085 case UDESCSUB_AC_OUTPUT:
5086 case UDESCSUB_AC_PROCESSING_V2:
5087 case UDESCSUB_AC_EXTENSION_V2:
5088 case UDESCSUB_AC_EFFECT:
5089 case UDESCSUB_AC_CLOCK_SRC:
5090 case UDESCSUB_AC_CLOCK_SEL:
5091 case UDESCSUB_AC_CLOCK_MUL:
5092 case UDESCSUB_AC_SAMPLE_RT:
5095 case UDESCSUB_AC_MIXER:
5096 uaudio20_mixer_add_mixer(sc, iot, i);
5099 case UDESCSUB_AC_SELECTOR:
5100 uaudio20_mixer_add_selector(sc, iot, i);
5103 case UDESCSUB_AC_FEATURE:
5104 uaudio20_mixer_add_feature(sc, iot, i);
5108 DPRINTF("bad AC desc subtype=0x%02x\n",
5109 dp->bDescriptorSubtype);
5115 switch (dp->bDescriptorSubtype) {
5116 case UDESCSUB_AC_HEADER:
5117 DPRINTF("unexpected AC header\n");
5120 case UDESCSUB_AC_INPUT:
5121 case UDESCSUB_AC_OUTPUT:
5124 case UDESCSUB_AC_MIXER:
5125 uaudio_mixer_add_mixer(sc, iot, i);
5128 case UDESCSUB_AC_SELECTOR:
5129 uaudio_mixer_add_selector(sc, iot, i);
5132 case UDESCSUB_AC_FEATURE:
5133 uaudio_mixer_add_feature(sc, iot, i);
5136 case UDESCSUB_AC_PROCESSING:
5137 uaudio_mixer_add_processing(sc, iot, i);
5140 case UDESCSUB_AC_EXTENSION:
5141 uaudio_mixer_add_extension(sc, iot, i);
5145 DPRINTF("bad AC desc subtype=0x%02x\n",
5146 dp->bDescriptorSubtype);
5157 uaudio_mixer_get(struct usb_device *udev, uint16_t audio_rev,
5158 uint8_t what, struct uaudio_mixer_node *mc)
5160 struct usb_device_request req;
5162 uint8_t data[2 + (2 * 3)];
5165 if (mc->wValue[0] == -1)
5168 if (audio_rev >= UAUDIO_VERSION_30)
5170 else if (audio_rev >= UAUDIO_VERSION_20) {
5171 if (what == GET_CUR) {
5172 req.bRequest = UA20_CS_CUR;
5173 USETW(req.wLength, 2);
5175 req.bRequest = UA20_CS_RANGE;
5176 USETW(req.wLength, 8);
5179 uint16_t len = MIX_SIZE(mc->type);
5181 req.bRequest = what;
5182 USETW(req.wLength, len);
5185 req.bmRequestType = UT_READ_CLASS_INTERFACE;
5186 USETW(req.wValue, mc->wValue[0]);
5187 USETW(req.wIndex, mc->wIndex);
5189 memset(data, 0, sizeof(data));
5191 err = usbd_do_request(udev, NULL, &req, data);
5193 DPRINTF("err=%s\n", usbd_errstr(err));
5197 if (audio_rev >= UAUDIO_VERSION_30) {
5199 } else if (audio_rev >= UAUDIO_VERSION_20) {
5202 val = (data[0] | (data[1] << 8));
5205 val = (data[2] | (data[3] << 8));
5208 val = (data[4] | (data[5] << 8));
5211 val = (data[6] | (data[7] << 8));
5218 val = (data[0] | (data[1] << 8));
5221 if (what == GET_CUR || what == GET_MIN || what == GET_MAX)
5222 val = uaudio_mixer_signext(mc->type, val);
5224 DPRINTFN(3, "val=%d\n", val);
5230 uaudio_mixer_write_cfg_callback(struct usb_xfer *xfer, usb_error_t error)
5232 struct usb_device_request req;
5233 struct uaudio_softc *sc = usbd_xfer_softc(xfer);
5234 struct uaudio_mixer_node *mc = sc->sc_mixer_curr;
5235 struct usb_page_cache *pc;
5244 switch (USB_GET_STATE(xfer)) {
5245 case USB_ST_TRANSFERRED:
5251 mc = sc->sc_mixer_root;
5252 sc->sc_mixer_curr = mc;
5253 sc->sc_mixer_chan = 0;
5257 while (sc->sc_mixer_chan < mc->nchan) {
5259 chan = sc->sc_mixer_chan;
5261 sc->sc_mixer_chan++;
5263 update = ((mc->update[chan / 8] & (1 << (chan % 8))) &&
5264 (mc->wValue[chan] != -1));
5266 mc->update[chan / 8] &= ~(1 << (chan % 8));
5270 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
5271 USETW(req.wValue, mc->wValue[chan]);
5272 USETW(req.wIndex, mc->wIndex);
5274 if (sc->sc_audio_rev >= UAUDIO_VERSION_30) {
5276 } else if (sc->sc_audio_rev >= UAUDIO_VERSION_20) {
5278 req.bRequest = UA20_CS_CUR;
5279 USETW(req.wLength, len);
5281 len = MIX_SIZE(mc->type);
5282 req.bRequest = SET_CUR;
5283 USETW(req.wLength, len);
5286 buf[0] = (mc->wData[chan] & 0xFF);
5287 buf[1] = (mc->wData[chan] >> 8) & 0xFF;
5289 pc = usbd_xfer_get_frame(xfer, 0);
5290 usbd_copy_in(pc, 0, &req, sizeof(req));
5291 pc = usbd_xfer_get_frame(xfer, 1);
5292 usbd_copy_in(pc, 0, buf, len);
5294 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
5295 usbd_xfer_set_frame_len(xfer, 1, len);
5296 usbd_xfer_set_frames(xfer, len ? 2 : 1);
5297 usbd_transfer_submit(xfer);
5303 sc->sc_mixer_curr = mc;
5304 sc->sc_mixer_chan = 0;
5312 default: /* Error */
5313 DPRINTF("error=%s\n", usbd_errstr(error));
5314 if (error == USB_ERR_CANCELLED) {
5315 /* do nothing - we are detaching */
5318 goto tr_transferred;
5323 uaudio_set_speed(struct usb_device *udev, uint8_t endpt, uint32_t speed)
5325 struct usb_device_request req;
5328 DPRINTFN(6, "endpt=%d speed=%u\n", endpt, speed);
5330 req.bmRequestType = UT_WRITE_CLASS_ENDPOINT;
5331 req.bRequest = SET_CUR;
5332 USETW2(req.wValue, SAMPLING_FREQ_CONTROL, 0);
5333 USETW(req.wIndex, endpt);
5334 USETW(req.wLength, 3);
5336 data[1] = speed >> 8;
5337 data[2] = speed >> 16;
5339 return (usbd_do_request(udev, NULL, &req, data));
5343 uaudio20_set_speed(struct usb_device *udev, uint8_t iface_no,
5344 uint8_t clockid, uint32_t speed)
5346 struct usb_device_request req;
5349 DPRINTFN(6, "ifaceno=%d clockid=%d speed=%u\n",
5350 iface_no, clockid, speed);
5352 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
5353 req.bRequest = UA20_CS_CUR;
5354 USETW2(req.wValue, UA20_CS_SAM_FREQ_CONTROL, 0);
5355 USETW2(req.wIndex, clockid, iface_no);
5356 USETW(req.wLength, 4);
5358 data[1] = speed >> 8;
5359 data[2] = speed >> 16;
5360 data[3] = speed >> 24;
5362 return (usbd_do_request(udev, NULL, &req, data));
5366 uaudio_mixer_signext(uint8_t type, int val)
5368 if (!MIX_UNSIGNED(type)) {
5369 if (MIX_SIZE(type) == 2) {
5379 uaudio_mixer_bsd2value(struct uaudio_mixer_node *mc, int val)
5381 if (mc->type == MIX_ON_OFF) {
5383 } else if (mc->type != MIX_SELECTOR) {
5385 /* compute actual volume */
5386 val = (val * mc->mul) / 100;
5388 /* add lower offset */
5389 val = val + mc->minval;
5391 /* make sure we don't write a value out of range */
5392 if (val > mc->maxval)
5394 else if (val < mc->minval)
5397 DPRINTFN(6, "type=0x%03x val=%d min=%d max=%d val=%d\n",
5398 mc->type, val, mc->minval, mc->maxval, val);
5403 uaudio_mixer_ctl_set(struct uaudio_softc *sc, struct uaudio_mixer_node *mc,
5404 uint8_t chan, int val)
5406 val = uaudio_mixer_bsd2value(mc, val);
5408 mc->update[chan / 8] |= (1 << (chan % 8));
5409 mc->wData[chan] = val;
5411 /* start the transfer, if not already started */
5413 usbd_transfer_start(sc->sc_mixer_xfer[0]);
5417 uaudio_mixer_init(struct uaudio_softc *sc)
5419 struct uaudio_mixer_node *mc;
5422 for (mc = sc->sc_mixer_root; mc;
5425 if (mc->ctl != SOUND_MIXER_NRDEVICES) {
5427 * Set device mask bits. See
5428 * /usr/include/machine/soundcard.h
5430 sc->sc_mix_info |= (1 << mc->ctl);
5432 if ((mc->ctl == SOUND_MIXER_NRDEVICES) &&
5433 (mc->type == MIX_SELECTOR)) {
5435 for (i = mc->minval; (i > 0) && (i <= mc->maxval); i++) {
5436 if (mc->slctrtype[i - 1] == SOUND_MIXER_NRDEVICES) {
5439 sc->sc_recsrc_info |= 1 << mc->slctrtype[i - 1];
5446 uaudio_mixer_init_sub(struct uaudio_softc *sc, struct snd_mixer *m)
5450 sc->sc_mixer_lock = mixer_get_lock(m);
5451 sc->sc_mixer_dev = m;
5453 if (usbd_transfer_setup(sc->sc_udev, &sc->sc_mixer_iface_index,
5454 sc->sc_mixer_xfer, uaudio_mixer_config, 1, sc,
5455 sc->sc_mixer_lock)) {
5456 DPRINTFN(0, "could not allocate USB "
5457 "transfer for audio mixer!\n");
5460 if (!(sc->sc_mix_info & SOUND_MASK_VOLUME)) {
5461 mix_setparentchild(m, SOUND_MIXER_VOLUME, SOUND_MASK_PCM);
5462 mix_setrealdev(m, SOUND_MIXER_VOLUME, SOUND_MIXER_NONE);
5464 mix_setdevs(m, sc->sc_mix_info);
5465 mix_setrecdevs(m, sc->sc_recsrc_info);
5470 uaudio_mixer_uninit_sub(struct uaudio_softc *sc)
5474 usbd_transfer_unsetup(sc->sc_mixer_xfer, 1);
5476 sc->sc_mixer_lock = NULL;
5482 uaudio_mixer_set(struct uaudio_softc *sc, unsigned type,
5483 unsigned left, unsigned right)
5485 struct uaudio_mixer_node *mc;
5488 for (mc = sc->sc_mixer_root; mc != NULL; mc = mc->next) {
5490 if (mc->ctl == type) {
5491 for (chan = 0; chan < mc->nchan; chan++) {
5492 uaudio_mixer_ctl_set(sc, mc, chan,
5493 chan == 0 ? left : right);
5500 uaudio_mixer_setrecsrc(struct uaudio_softc *sc, uint32_t src)
5502 struct uaudio_mixer_node *mc;
5507 for (mc = sc->sc_mixer_root; mc;
5510 if ((mc->ctl == SOUND_MIXER_NRDEVICES) &&
5511 (mc->type == MIX_SELECTOR)) {
5513 /* compute selector mask */
5516 for (i = mc->minval; (i > 0) && (i <= mc->maxval); i++) {
5517 mask |= (1 << mc->slctrtype[i - 1]);
5524 /* find the first set bit */
5525 temp = (-temp) & temp;
5531 for (i = mc->minval; (i > 0) && (i <= mc->maxval); i++) {
5532 if (temp != (1 << mc->slctrtype[i - 1])) {
5535 uaudio_mixer_ctl_set(sc, mc, 0, i);
5543 /*========================================================================*
5544 * MIDI support routines
5545 *========================================================================*/
5548 umidi_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
5550 struct umidi_chan *chan = usbd_xfer_softc(xfer);
5551 struct umidi_sub_chan *sub;
5552 struct usb_page_cache *pc;
5559 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
5561 switch (USB_GET_STATE(xfer)) {
5562 case USB_ST_TRANSFERRED:
5564 DPRINTF("actlen=%d bytes\n", actlen);
5567 pc = usbd_xfer_get_frame(xfer, 0);
5569 while (actlen >= 4) {
5571 /* copy out the MIDI data */
5572 usbd_copy_out(pc, pos, buf, 4);
5573 /* command length */
5574 cmd_len = umidi_cmd_to_len[buf[0] & 0xF];
5578 * Lookup sub-channel. The index is range
5581 sub = &chan->sub[cn];
5583 if ((cmd_len != 0) && (cn < chan->max_emb_jack) &&
5584 (sub->read_open != 0)) {
5586 /* Send data to the application */
5587 usb_fifo_put_data_linear(
5588 sub->fifo.fp[USB_FIFO_RX],
5589 buf + 1, cmd_len, 1);
5598 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
5599 usbd_transfer_submit(xfer);
5603 DPRINTF("error=%s\n", usbd_errstr(error));
5605 if (error != USB_ERR_CANCELLED) {
5606 /* try to clear stall first */
5607 usbd_xfer_set_stall(xfer);
5615 * The following statemachine, that converts MIDI commands to
5616 * USB MIDI packets, derives from Linux's usbmidi.c, which
5617 * was written by "Clemens Ladisch":
5621 * Else: Command is complete
5624 umidi_convert_to_usb(struct umidi_sub_chan *sub, uint8_t cn, uint8_t b)
5626 uint8_t p0 = (cn << 4);
5629 sub->temp_0[0] = p0 | 0x0f;
5633 sub->temp_cmd = sub->temp_0;
5636 } else if (b >= 0xf0) {
5638 case 0xf0: /* system exclusive begin */
5640 sub->state = UMIDI_ST_SYSEX_1;
5642 case 0xf1: /* MIDI time code */
5643 case 0xf3: /* song select */
5645 sub->state = UMIDI_ST_1PARAM;
5647 case 0xf2: /* song position pointer */
5649 sub->state = UMIDI_ST_2PARAM_1;
5651 case 0xf4: /* unknown */
5652 case 0xf5: /* unknown */
5653 sub->state = UMIDI_ST_UNKNOWN;
5655 case 0xf6: /* tune request */
5656 sub->temp_1[0] = p0 | 0x05;
5657 sub->temp_1[1] = 0xf6;
5660 sub->temp_cmd = sub->temp_1;
5661 sub->state = UMIDI_ST_UNKNOWN;
5664 case 0xf7: /* system exclusive end */
5665 switch (sub->state) {
5666 case UMIDI_ST_SYSEX_0:
5667 sub->temp_1[0] = p0 | 0x05;
5668 sub->temp_1[1] = 0xf7;
5671 sub->temp_cmd = sub->temp_1;
5672 sub->state = UMIDI_ST_UNKNOWN;
5674 case UMIDI_ST_SYSEX_1:
5675 sub->temp_1[0] = p0 | 0x06;
5676 sub->temp_1[2] = 0xf7;
5678 sub->temp_cmd = sub->temp_1;
5679 sub->state = UMIDI_ST_UNKNOWN;
5681 case UMIDI_ST_SYSEX_2:
5682 sub->temp_1[0] = p0 | 0x07;
5683 sub->temp_1[3] = 0xf7;
5684 sub->temp_cmd = sub->temp_1;
5685 sub->state = UMIDI_ST_UNKNOWN;
5688 sub->state = UMIDI_ST_UNKNOWN;
5691 } else if (b >= 0x80) {
5693 if ((b >= 0xc0) && (b <= 0xdf)) {
5694 sub->state = UMIDI_ST_1PARAM;
5696 sub->state = UMIDI_ST_2PARAM_1;
5698 } else { /* b < 0x80 */
5699 switch (sub->state) {
5700 case UMIDI_ST_1PARAM:
5701 if (sub->temp_1[1] < 0xf0) {
5702 p0 |= sub->temp_1[1] >> 4;
5705 sub->state = UMIDI_ST_UNKNOWN;
5707 sub->temp_1[0] = p0;
5710 sub->temp_cmd = sub->temp_1;
5712 case UMIDI_ST_2PARAM_1:
5714 sub->state = UMIDI_ST_2PARAM_2;
5716 case UMIDI_ST_2PARAM_2:
5717 if (sub->temp_1[1] < 0xf0) {
5718 p0 |= sub->temp_1[1] >> 4;
5719 sub->state = UMIDI_ST_2PARAM_1;
5722 sub->state = UMIDI_ST_UNKNOWN;
5724 sub->temp_1[0] = p0;
5726 sub->temp_cmd = sub->temp_1;
5728 case UMIDI_ST_SYSEX_0:
5730 sub->state = UMIDI_ST_SYSEX_1;
5732 case UMIDI_ST_SYSEX_1:
5734 sub->state = UMIDI_ST_SYSEX_2;
5736 case UMIDI_ST_SYSEX_2:
5737 sub->temp_1[0] = p0 | 0x04;
5739 sub->temp_cmd = sub->temp_1;
5740 sub->state = UMIDI_ST_SYSEX_0;
5750 umidi_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
5752 struct umidi_chan *chan = usbd_xfer_softc(xfer);
5753 struct umidi_sub_chan *sub;
5754 struct usb_page_cache *pc;
5758 uint8_t start_cable;
5762 usbd_xfer_status(xfer, &len, NULL, NULL, NULL);
5765 * NOTE: Some MIDI devices only accept 4 bytes of data per
5766 * short terminated USB transfer.
5768 switch (USB_GET_STATE(xfer)) {
5769 case USB_ST_TRANSFERRED:
5770 DPRINTF("actlen=%d bytes\n", len);
5776 nframes = 0; /* reset */
5777 start_cable = chan->curr_cable;
5779 pc = usbd_xfer_get_frame(xfer, 0);
5783 /* round robin de-queueing */
5785 sub = &chan->sub[chan->curr_cable];
5787 if (sub->write_open) {
5788 usb_fifo_get_data_linear(sub->fifo.fp[USB_FIFO_TX],
5789 &buf, 1, &actlen, 0);
5798 DPRINTF("byte=0x%02x from FIFO %u\n", buf,
5799 (unsigned int)chan->curr_cable);
5801 if (umidi_convert_to_usb(sub, chan->curr_cable, buf)) {
5803 DPRINTF("sub=0x%02x 0x%02x 0x%02x 0x%02x\n",
5804 sub->temp_cmd[0], sub->temp_cmd[1],
5805 sub->temp_cmd[2], sub->temp_cmd[3]);
5807 usbd_copy_in(pc, nframes * 4, sub->temp_cmd, 4);
5811 if ((nframes >= UMIDI_TX_FRAMES) || (chan->single_command != 0))
5819 if (chan->curr_cable >= chan->max_emb_jack)
5820 chan->curr_cable = 0;
5822 if (chan->curr_cable == start_cable) {
5830 DPRINTF("Transferring %d frames\n", (int)nframes);
5831 usbd_xfer_set_frame_len(xfer, 0, 4 * nframes);
5832 usbd_transfer_submit(xfer);
5836 default: /* Error */
5838 DPRINTF("error=%s\n", usbd_errstr(error));
5840 if (error != USB_ERR_CANCELLED) {
5841 /* try to clear stall first */
5842 usbd_xfer_set_stall(xfer);
5849 static struct umidi_sub_chan *
5850 umidi_sub_by_fifo(struct usb_fifo *fifo)
5852 struct umidi_chan *chan = usb_fifo_softc(fifo);
5853 struct umidi_sub_chan *sub;
5856 for (n = 0; n < UMIDI_EMB_JACK_MAX; n++) {
5857 sub = &chan->sub[n];
5858 if ((sub->fifo.fp[USB_FIFO_RX] == fifo) ||
5859 (sub->fifo.fp[USB_FIFO_TX] == fifo)) {
5864 panic("%s:%d cannot find usb_fifo!\n",
5865 __FILE__, __LINE__);
5871 umidi_start_read(struct usb_fifo *fifo)
5873 struct umidi_chan *chan = usb_fifo_softc(fifo);
5875 usbd_transfer_start(chan->xfer[UMIDI_RX_TRANSFER]);
5879 umidi_stop_read(struct usb_fifo *fifo)
5881 struct umidi_chan *chan = usb_fifo_softc(fifo);
5882 struct umidi_sub_chan *sub = umidi_sub_by_fifo(fifo);
5888 if (--(chan->read_open_refcount) == 0) {
5890 * XXX don't stop the read transfer here, hence that causes
5891 * problems with some MIDI adapters
5893 DPRINTF("(stopping read transfer)\n");
5898 umidi_start_write(struct usb_fifo *fifo)
5900 struct umidi_chan *chan = usb_fifo_softc(fifo);
5902 if (chan->xfer[UMIDI_TX_TRANSFER] == NULL) {
5907 usb_fifo_get_data_linear(fifo, buf, 1, &actlen, 0);
5908 } while (actlen > 0);
5910 usbd_transfer_start(chan->xfer[UMIDI_TX_TRANSFER]);
5915 umidi_stop_write(struct usb_fifo *fifo)
5917 struct umidi_chan *chan = usb_fifo_softc(fifo);
5918 struct umidi_sub_chan *sub = umidi_sub_by_fifo(fifo);
5922 sub->write_open = 0;
5924 if (--(chan->write_open_refcount) == 0) {
5925 DPRINTF("(stopping write transfer)\n");
5926 usbd_transfer_stop(chan->xfer[UMIDI_TX_TRANSFER]);
5931 umidi_open(struct usb_fifo *fifo, int fflags)
5933 struct umidi_chan *chan = usb_fifo_softc(fifo);
5934 struct umidi_sub_chan *sub = umidi_sub_by_fifo(fifo);
5936 if (fflags & FREAD) {
5937 if (usb_fifo_alloc_buffer(fifo, 4, (1024 / 4))) {
5940 mtx_lock(&chan->mtx);
5941 chan->read_open_refcount++;
5943 mtx_unlock(&chan->mtx);
5945 if (fflags & FWRITE) {
5946 if (usb_fifo_alloc_buffer(fifo, 32, (1024 / 32))) {
5949 /* clear stall first */
5950 mtx_lock(&chan->mtx);
5951 chan->write_open_refcount++;
5952 sub->write_open = 1;
5955 sub->state = UMIDI_ST_UNKNOWN;
5956 mtx_unlock(&chan->mtx);
5958 return (0); /* success */
5962 umidi_close(struct usb_fifo *fifo, int fflags)
5964 if (fflags & FREAD) {
5965 usb_fifo_free_buffer(fifo);
5967 if (fflags & FWRITE) {
5968 usb_fifo_free_buffer(fifo);
5974 umidi_ioctl(struct usb_fifo *fifo, u_long cmd, void *data,
5981 umidi_init(device_t dev)
5983 struct uaudio_softc *sc = device_get_softc(dev);
5984 struct umidi_chan *chan = &sc->sc_midi_chan;
5986 mtx_init(&chan->mtx, "umidi lock", NULL, MTX_DEF | MTX_RECURSE);
5989 static struct usb_fifo_methods umidi_fifo_methods = {
5990 .f_start_read = &umidi_start_read,
5991 .f_start_write = &umidi_start_write,
5992 .f_stop_read = &umidi_stop_read,
5993 .f_stop_write = &umidi_stop_write,
5994 .f_open = &umidi_open,
5995 .f_close = &umidi_close,
5996 .f_ioctl = &umidi_ioctl,
5997 .basename[0] = "umidi",
6001 umidi_probe(device_t dev)
6003 struct uaudio_softc *sc = device_get_softc(dev);
6004 struct usb_attach_arg *uaa = device_get_ivars(dev);
6005 struct umidi_chan *chan = &sc->sc_midi_chan;
6006 struct umidi_sub_chan *sub;
6007 int unit = device_get_unit(dev);
6011 if (usb_test_quirk(uaa, UQ_SINGLE_CMD_MIDI))
6012 chan->single_command = 1;
6014 if (usbd_set_alt_interface_index(sc->sc_udev, chan->iface_index,
6015 chan->iface_alt_index)) {
6016 DPRINTF("setting of alternate index failed!\n");
6019 usbd_set_parent_iface(sc->sc_udev, chan->iface_index,
6020 sc->sc_mixer_iface_index);
6022 error = usbd_transfer_setup(uaa->device, &chan->iface_index,
6023 chan->xfer, umidi_config, UMIDI_N_TRANSFER,
6026 DPRINTF("error=%s\n", usbd_errstr(error));
6029 if (chan->xfer[UMIDI_TX_TRANSFER] == NULL &&
6030 chan->xfer[UMIDI_RX_TRANSFER] == NULL) {
6031 DPRINTF("no BULK or INTERRUPT MIDI endpoint(s) found\n");
6036 * Some USB MIDI device makers couldn't resist using
6037 * wMaxPacketSize = 4 for RX and TX BULK endpoints, although
6038 * that size is an unsupported value for FULL speed BULK
6039 * endpoints. The same applies to some HIGH speed MIDI devices
6040 * which are using a wMaxPacketSize different from 512 bytes.
6042 * Refer to section 5.8.3 in USB 2.0 PDF: Cite: "All Host
6043 * Controllers are required to have support for 8-, 16-, 32-,
6044 * and 64-byte maximum packet sizes for full-speed bulk
6045 * endpoints and 512 bytes for high-speed bulk endpoints."
6047 if (chan->xfer[UMIDI_TX_TRANSFER] != NULL &&
6048 usbd_xfer_maxp_was_clamped(chan->xfer[UMIDI_TX_TRANSFER]))
6049 chan->single_command = 1;
6051 if (chan->single_command != 0)
6052 device_printf(dev, "Single command MIDI quirk enabled\n");
6054 if ((chan->max_emb_jack == 0) ||
6055 (chan->max_emb_jack > UMIDI_EMB_JACK_MAX)) {
6056 chan->max_emb_jack = UMIDI_EMB_JACK_MAX;
6059 for (n = 0; n < chan->max_emb_jack; n++) {
6061 sub = &chan->sub[n];
6063 error = usb_fifo_attach(sc->sc_udev, chan, &chan->mtx,
6064 &umidi_fifo_methods, &sub->fifo, unit, n,
6066 UID_ROOT, GID_OPERATOR, 0644);
6072 mtx_lock(&chan->mtx);
6075 * NOTE: At least one device will not work properly unless the
6076 * BULK IN pipe is open all the time. This might have to do
6077 * about that the internal queues of the device overflow if we
6078 * don't read them regularly.
6080 usbd_transfer_start(chan->xfer[UMIDI_RX_TRANSFER]);
6082 mtx_unlock(&chan->mtx);
6084 return (0); /* success */
6087 return (ENXIO); /* failure */
6091 umidi_detach(device_t dev)
6093 struct uaudio_softc *sc = device_get_softc(dev);
6094 struct umidi_chan *chan = &sc->sc_midi_chan;
6097 for (n = 0; n < UMIDI_EMB_JACK_MAX; n++)
6098 usb_fifo_detach(&chan->sub[n].fifo);
6100 mtx_lock(&chan->mtx);
6102 usbd_transfer_stop(chan->xfer[UMIDI_RX_TRANSFER]);
6104 mtx_unlock(&chan->mtx);
6106 usbd_transfer_unsetup(chan->xfer, UMIDI_N_TRANSFER);
6108 mtx_destroy(&chan->mtx);
6114 uaudio_hid_rx_callback(struct usb_xfer *xfer, usb_error_t error)
6116 struct uaudio_softc *sc = usbd_xfer_softc(xfer);
6117 const uint8_t *buffer = usbd_xfer_get_frame_buffer(xfer, 0);
6118 struct snd_mixer *m;
6122 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
6124 switch (USB_GET_STATE(xfer)) {
6125 case USB_ST_TRANSFERRED:
6126 DPRINTF("actlen=%d\n", actlen);
6129 (sc->sc_hid.flags & UAUDIO_HID_HAS_ID)) {
6137 m = sc->sc_mixer_dev;
6139 if ((sc->sc_hid.flags & UAUDIO_HID_HAS_MUTE) &&
6140 (sc->sc_hid.mute_id == id) &&
6141 hid_get_data(buffer, actlen,
6142 &sc->sc_hid.mute_loc)) {
6144 DPRINTF("Mute toggle\n");
6146 mixer_hwvol_mute_locked(m);
6149 if ((sc->sc_hid.flags & UAUDIO_HID_HAS_VOLUME_UP) &&
6150 (sc->sc_hid.volume_up_id == id) &&
6151 hid_get_data(buffer, actlen,
6152 &sc->sc_hid.volume_up_loc)) {
6154 DPRINTF("Volume Up\n");
6156 mixer_hwvol_step_locked(m, 1, 1);
6159 if ((sc->sc_hid.flags & UAUDIO_HID_HAS_VOLUME_DOWN) &&
6160 (sc->sc_hid.volume_down_id == id) &&
6161 hid_get_data(buffer, actlen,
6162 &sc->sc_hid.volume_down_loc)) {
6164 DPRINTF("Volume Down\n");
6166 mixer_hwvol_step_locked(m, -1, -1);
6171 /* check if we can put more data into the FIFO */
6172 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
6173 usbd_transfer_submit(xfer);
6176 default: /* Error */
6178 DPRINTF("error=%s\n", usbd_errstr(error));
6180 if (error != USB_ERR_CANCELLED) {
6181 /* try to clear stall first */
6182 usbd_xfer_set_stall(xfer);
6190 uaudio_hid_probe(struct uaudio_softc *sc,
6191 struct usb_attach_arg *uaa)
6199 if (!(sc->sc_hid.flags & UAUDIO_HID_VALID))
6202 if (sc->sc_mixer_lock == NULL)
6205 /* Get HID descriptor */
6206 error = usbd_req_get_hid_desc(uaa->device, NULL, &d_ptr,
6207 &d_len, M_TEMP, sc->sc_hid.iface_index);
6210 DPRINTF("error reading report description\n");
6214 /* check if there is an ID byte */
6215 hid_report_size(d_ptr, d_len, hid_input, &id);
6218 sc->sc_hid.flags |= UAUDIO_HID_HAS_ID;
6220 if (hid_locate(d_ptr, d_len,
6221 HID_USAGE2(HUP_CONSUMER, 0xE9 /* Volume Increment */),
6222 hid_input, 0, &sc->sc_hid.volume_up_loc, &flags,
6223 &sc->sc_hid.volume_up_id)) {
6224 if (flags & HIO_VARIABLE)
6225 sc->sc_hid.flags |= UAUDIO_HID_HAS_VOLUME_UP;
6226 DPRINTFN(1, "Found Volume Up key\n");
6229 if (hid_locate(d_ptr, d_len,
6230 HID_USAGE2(HUP_CONSUMER, 0xEA /* Volume Decrement */),
6231 hid_input, 0, &sc->sc_hid.volume_down_loc, &flags,
6232 &sc->sc_hid.volume_down_id)) {
6233 if (flags & HIO_VARIABLE)
6234 sc->sc_hid.flags |= UAUDIO_HID_HAS_VOLUME_DOWN;
6235 DPRINTFN(1, "Found Volume Down key\n");
6238 if (hid_locate(d_ptr, d_len,
6239 HID_USAGE2(HUP_CONSUMER, 0xE2 /* Mute */),
6240 hid_input, 0, &sc->sc_hid.mute_loc, &flags,
6241 &sc->sc_hid.mute_id)) {
6242 if (flags & HIO_VARIABLE)
6243 sc->sc_hid.flags |= UAUDIO_HID_HAS_MUTE;
6244 DPRINTFN(1, "Found Mute key\n");
6247 free(d_ptr, M_TEMP);
6249 if (!(sc->sc_hid.flags & (UAUDIO_HID_HAS_VOLUME_UP |
6250 UAUDIO_HID_HAS_VOLUME_DOWN |
6251 UAUDIO_HID_HAS_MUTE))) {
6252 DPRINTFN(1, "Did not find any volume related keys\n");
6256 /* prevent the uhid driver from attaching */
6257 usbd_set_parent_iface(uaa->device, sc->sc_hid.iface_index,
6258 sc->sc_mixer_iface_index);
6260 /* allocate USB transfers */
6261 error = usbd_transfer_setup(uaa->device, &sc->sc_hid.iface_index,
6262 sc->sc_hid.xfer, uaudio_hid_config, UAUDIO_HID_N_TRANSFER,
6263 sc, sc->sc_mixer_lock);
6265 DPRINTF("error=%s\n", usbd_errstr(error));
6272 uaudio_hid_detach(struct uaudio_softc *sc)
6274 usbd_transfer_unsetup(sc->sc_hid.xfer, UAUDIO_HID_N_TRANSFER);
6277 DRIVER_MODULE_ORDERED(uaudio, uhub, uaudio_driver, uaudio_devclass, NULL, 0, SI_ORDER_ANY);
6278 MODULE_DEPEND(uaudio, usb, 1, 1, 1);
6279 MODULE_DEPEND(uaudio, sound, SOUND_MINVER, SOUND_PREFVER, SOUND_MAXVER);
6280 MODULE_VERSION(uaudio, 1);