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 void uaudio_mixer_ctl_set(struct uaudio_softc *,
562 struct uaudio_mixer_node *, uint8_t, int32_t val);
563 static int uaudio_mixer_signext(uint8_t, int);
564 static int uaudio_mixer_bsd2value(struct uaudio_mixer_node *, int32_t val);
565 static void uaudio_mixer_init(struct uaudio_softc *);
566 static const struct uaudio_terminal_node *uaudio_mixer_get_input(
567 const struct uaudio_terminal_node *, uint8_t);
568 static const struct uaudio_terminal_node *uaudio_mixer_get_output(
569 const struct uaudio_terminal_node *, uint8_t);
570 static void uaudio_mixer_find_outputs_sub(struct uaudio_terminal_node *,
571 uint8_t, uint8_t, struct uaudio_search_result *);
572 static uint8_t umidi_convert_to_usb(struct umidi_sub_chan *, uint8_t, uint8_t);
573 static struct umidi_sub_chan *umidi_sub_by_fifo(struct usb_fifo *);
574 static void umidi_start_read(struct usb_fifo *);
575 static void umidi_stop_read(struct usb_fifo *);
576 static void umidi_start_write(struct usb_fifo *);
577 static void umidi_stop_write(struct usb_fifo *);
578 static int umidi_open(struct usb_fifo *, int);
579 static int umidi_ioctl(struct usb_fifo *, u_long cmd, void *, int);
580 static void umidi_close(struct usb_fifo *, int);
581 static void umidi_init(device_t dev);
582 static int umidi_probe(device_t dev);
583 static int umidi_detach(device_t dev);
584 static int uaudio_hid_probe(struct uaudio_softc *sc,
585 struct usb_attach_arg *uaa);
586 static void uaudio_hid_detach(struct uaudio_softc *sc);
589 static void uaudio_chan_dump_ep_desc(
590 const usb_endpoint_descriptor_audio_t *);
593 static const struct usb_config
594 uaudio_cfg_record[UAUDIO_NCHANBUFS + 1] = {
596 .type = UE_ISOCHRONOUS,
597 .endpoint = UE_ADDR_ANY,
598 .direction = UE_DIR_IN,
599 .bufsize = 0, /* use "wMaxPacketSize * frames" */
600 .frames = UAUDIO_NFRAMES,
601 .flags = {.short_xfer_ok = 1,},
602 .callback = &uaudio_chan_record_callback,
606 .type = UE_ISOCHRONOUS,
607 .endpoint = UE_ADDR_ANY,
608 .direction = UE_DIR_IN,
609 .bufsize = 0, /* use "wMaxPacketSize * frames" */
610 .frames = UAUDIO_NFRAMES,
611 .flags = {.short_xfer_ok = 1,},
612 .callback = &uaudio_chan_record_callback,
616 .type = UE_ISOCHRONOUS,
617 .endpoint = UE_ADDR_ANY,
618 .direction = UE_DIR_OUT,
619 .bufsize = 0, /* use "wMaxPacketSize * frames" */
621 .flags = {.no_pipe_ok = 1,.short_xfer_ok = 1,},
622 .callback = &uaudio_chan_record_sync_callback,
626 static const struct usb_config
627 uaudio_cfg_play[UAUDIO_NCHANBUFS + 1] = {
629 .type = UE_ISOCHRONOUS,
630 .endpoint = UE_ADDR_ANY,
631 .direction = UE_DIR_OUT,
632 .bufsize = 0, /* use "wMaxPacketSize * frames" */
633 .frames = UAUDIO_NFRAMES,
634 .flags = {.short_xfer_ok = 1,},
635 .callback = &uaudio_chan_play_callback,
639 .type = UE_ISOCHRONOUS,
640 .endpoint = UE_ADDR_ANY,
641 .direction = UE_DIR_OUT,
642 .bufsize = 0, /* use "wMaxPacketSize * frames" */
643 .frames = UAUDIO_NFRAMES,
644 .flags = {.short_xfer_ok = 1,},
645 .callback = &uaudio_chan_play_callback,
649 .type = UE_ISOCHRONOUS,
650 .endpoint = UE_ADDR_ANY,
651 .direction = UE_DIR_IN,
652 .bufsize = 0, /* use "wMaxPacketSize * frames" */
654 .flags = {.no_pipe_ok = 1,.short_xfer_ok = 1,},
655 .callback = &uaudio_chan_play_sync_callback,
659 static const struct usb_config
660 uaudio_mixer_config[1] = {
663 .endpoint = 0x00, /* Control pipe */
664 .direction = UE_DIR_ANY,
665 .bufsize = (sizeof(struct usb_device_request) + 4),
666 .callback = &uaudio_mixer_write_cfg_callback,
667 .timeout = 1000, /* 1 second */
672 uint8_t umidi_cmd_to_len[16] = {
673 [0x0] = 0, /* reserved */
674 [0x1] = 0, /* reserved */
675 [0x2] = 2, /* bytes */
676 [0x3] = 3, /* bytes */
677 [0x4] = 3, /* bytes */
678 [0x5] = 1, /* bytes */
679 [0x6] = 2, /* bytes */
680 [0x7] = 3, /* bytes */
681 [0x8] = 3, /* bytes */
682 [0x9] = 3, /* bytes */
683 [0xA] = 3, /* bytes */
684 [0xB] = 3, /* bytes */
685 [0xC] = 2, /* bytes */
686 [0xD] = 2, /* bytes */
687 [0xE] = 3, /* bytes */
688 [0xF] = 1, /* bytes */
691 static const struct usb_config
692 umidi_config[UMIDI_N_TRANSFER] = {
693 [UMIDI_TX_TRANSFER] = {
695 .endpoint = UE_ADDR_ANY,
696 .direction = UE_DIR_OUT,
697 .bufsize = UMIDI_TX_BUFFER,
698 .flags = {.no_pipe_ok = 1},
699 .callback = &umidi_bulk_write_callback,
702 [UMIDI_RX_TRANSFER] = {
704 .endpoint = UE_ADDR_ANY,
705 .direction = UE_DIR_IN,
706 .bufsize = 4, /* bytes */
707 .flags = {.short_xfer_ok = 1,.proxy_buffer = 1,.no_pipe_ok = 1},
708 .callback = &umidi_bulk_read_callback,
712 static const struct usb_config
713 uaudio_hid_config[UAUDIO_HID_N_TRANSFER] = {
714 [UAUDIO_HID_RX_TRANSFER] = {
715 .type = UE_INTERRUPT,
716 .endpoint = UE_ADDR_ANY,
717 .direction = UE_DIR_IN,
718 .bufsize = 0, /* use wMaxPacketSize */
719 .flags = {.short_xfer_ok = 1,},
720 .callback = &uaudio_hid_rx_callback,
724 static devclass_t uaudio_devclass;
726 static device_method_t uaudio_methods[] = {
727 DEVMETHOD(device_probe, uaudio_probe),
728 DEVMETHOD(device_attach, uaudio_attach),
729 DEVMETHOD(device_detach, uaudio_detach),
730 DEVMETHOD(device_suspend, bus_generic_suspend),
731 DEVMETHOD(device_resume, bus_generic_resume),
732 DEVMETHOD(device_shutdown, bus_generic_shutdown),
737 static driver_t uaudio_driver = {
739 .methods = uaudio_methods,
740 .size = sizeof(struct uaudio_softc),
743 /* The following table is derived from Linux's quirks-table.h */
744 static const STRUCT_USB_HOST_ID uaudio_vendor_midi[] = {
745 { USB_VPI(USB_VENDOR_YAMAHA, 0x1000, 0) }, /* UX256 */
746 { USB_VPI(USB_VENDOR_YAMAHA, 0x1001, 0) }, /* MU1000 */
747 { USB_VPI(USB_VENDOR_YAMAHA, 0x1002, 0) }, /* MU2000 */
748 { USB_VPI(USB_VENDOR_YAMAHA, 0x1003, 0) }, /* MU500 */
749 { USB_VPI(USB_VENDOR_YAMAHA, 0x1004, 3) }, /* UW500 */
750 { USB_VPI(USB_VENDOR_YAMAHA, 0x1005, 0) }, /* MOTIF6 */
751 { USB_VPI(USB_VENDOR_YAMAHA, 0x1006, 0) }, /* MOTIF7 */
752 { USB_VPI(USB_VENDOR_YAMAHA, 0x1007, 0) }, /* MOTIF8 */
753 { USB_VPI(USB_VENDOR_YAMAHA, 0x1008, 0) }, /* UX96 */
754 { USB_VPI(USB_VENDOR_YAMAHA, 0x1009, 0) }, /* UX16 */
755 { USB_VPI(USB_VENDOR_YAMAHA, 0x100a, 3) }, /* EOS BX */
756 { USB_VPI(USB_VENDOR_YAMAHA, 0x100c, 0) }, /* UC-MX */
757 { USB_VPI(USB_VENDOR_YAMAHA, 0x100d, 0) }, /* UC-KX */
758 { USB_VPI(USB_VENDOR_YAMAHA, 0x100e, 0) }, /* S08 */
759 { USB_VPI(USB_VENDOR_YAMAHA, 0x100f, 0) }, /* CLP-150 */
760 { USB_VPI(USB_VENDOR_YAMAHA, 0x1010, 0) }, /* CLP-170 */
761 { USB_VPI(USB_VENDOR_YAMAHA, 0x1011, 0) }, /* P-250 */
762 { USB_VPI(USB_VENDOR_YAMAHA, 0x1012, 0) }, /* TYROS */
763 { USB_VPI(USB_VENDOR_YAMAHA, 0x1013, 0) }, /* PF-500 */
764 { USB_VPI(USB_VENDOR_YAMAHA, 0x1014, 0) }, /* S90 */
765 { USB_VPI(USB_VENDOR_YAMAHA, 0x1015, 0) }, /* MOTIF-R */
766 { USB_VPI(USB_VENDOR_YAMAHA, 0x1016, 0) }, /* MDP-5 */
767 { USB_VPI(USB_VENDOR_YAMAHA, 0x1017, 0) }, /* CVP-204 */
768 { USB_VPI(USB_VENDOR_YAMAHA, 0x1018, 0) }, /* CVP-206 */
769 { USB_VPI(USB_VENDOR_YAMAHA, 0x1019, 0) }, /* CVP-208 */
770 { USB_VPI(USB_VENDOR_YAMAHA, 0x101a, 0) }, /* CVP-210 */
771 { USB_VPI(USB_VENDOR_YAMAHA, 0x101b, 0) }, /* PSR-1100 */
772 { USB_VPI(USB_VENDOR_YAMAHA, 0x101c, 0) }, /* PSR-2100 */
773 { USB_VPI(USB_VENDOR_YAMAHA, 0x101d, 0) }, /* CLP-175 */
774 { USB_VPI(USB_VENDOR_YAMAHA, 0x101e, 0) }, /* PSR-K1 */
775 { USB_VPI(USB_VENDOR_YAMAHA, 0x101f, 0) }, /* EZ-J24 */
776 { USB_VPI(USB_VENDOR_YAMAHA, 0x1020, 0) }, /* EZ-250i */
777 { USB_VPI(USB_VENDOR_YAMAHA, 0x1021, 0) }, /* MOTIF ES 6 */
778 { USB_VPI(USB_VENDOR_YAMAHA, 0x1022, 0) }, /* MOTIF ES 7 */
779 { USB_VPI(USB_VENDOR_YAMAHA, 0x1023, 0) }, /* MOTIF ES 8 */
780 { USB_VPI(USB_VENDOR_YAMAHA, 0x1024, 0) }, /* CVP-301 */
781 { USB_VPI(USB_VENDOR_YAMAHA, 0x1025, 0) }, /* CVP-303 */
782 { USB_VPI(USB_VENDOR_YAMAHA, 0x1026, 0) }, /* CVP-305 */
783 { USB_VPI(USB_VENDOR_YAMAHA, 0x1027, 0) }, /* CVP-307 */
784 { USB_VPI(USB_VENDOR_YAMAHA, 0x1028, 0) }, /* CVP-309 */
785 { USB_VPI(USB_VENDOR_YAMAHA, 0x1029, 0) }, /* CVP-309GP */
786 { USB_VPI(USB_VENDOR_YAMAHA, 0x102a, 0) }, /* PSR-1500 */
787 { USB_VPI(USB_VENDOR_YAMAHA, 0x102b, 0) }, /* PSR-3000 */
788 { USB_VPI(USB_VENDOR_YAMAHA, 0x102e, 0) }, /* ELS-01/01C */
789 { USB_VPI(USB_VENDOR_YAMAHA, 0x1030, 0) }, /* PSR-295/293 */
790 { USB_VPI(USB_VENDOR_YAMAHA, 0x1031, 0) }, /* DGX-205/203 */
791 { USB_VPI(USB_VENDOR_YAMAHA, 0x1032, 0) }, /* DGX-305 */
792 { USB_VPI(USB_VENDOR_YAMAHA, 0x1033, 0) }, /* DGX-505 */
793 { USB_VPI(USB_VENDOR_YAMAHA, 0x1034, 0) }, /* NULL */
794 { USB_VPI(USB_VENDOR_YAMAHA, 0x1035, 0) }, /* NULL */
795 { USB_VPI(USB_VENDOR_YAMAHA, 0x1036, 0) }, /* NULL */
796 { USB_VPI(USB_VENDOR_YAMAHA, 0x1037, 0) }, /* NULL */
797 { USB_VPI(USB_VENDOR_YAMAHA, 0x1038, 0) }, /* NULL */
798 { USB_VPI(USB_VENDOR_YAMAHA, 0x1039, 0) }, /* NULL */
799 { USB_VPI(USB_VENDOR_YAMAHA, 0x103a, 0) }, /* NULL */
800 { USB_VPI(USB_VENDOR_YAMAHA, 0x103b, 0) }, /* NULL */
801 { USB_VPI(USB_VENDOR_YAMAHA, 0x103c, 0) }, /* NULL */
802 { USB_VPI(USB_VENDOR_YAMAHA, 0x103d, 0) }, /* NULL */
803 { USB_VPI(USB_VENDOR_YAMAHA, 0x103e, 0) }, /* NULL */
804 { USB_VPI(USB_VENDOR_YAMAHA, 0x103f, 0) }, /* NULL */
805 { USB_VPI(USB_VENDOR_YAMAHA, 0x1040, 0) }, /* NULL */
806 { USB_VPI(USB_VENDOR_YAMAHA, 0x1041, 0) }, /* NULL */
807 { USB_VPI(USB_VENDOR_YAMAHA, 0x1042, 0) }, /* NULL */
808 { USB_VPI(USB_VENDOR_YAMAHA, 0x1043, 0) }, /* NULL */
809 { USB_VPI(USB_VENDOR_YAMAHA, 0x1044, 0) }, /* NULL */
810 { USB_VPI(USB_VENDOR_YAMAHA, 0x1045, 0) }, /* NULL */
811 { USB_VPI(USB_VENDOR_YAMAHA, 0x104e, 0) }, /* NULL */
812 { USB_VPI(USB_VENDOR_YAMAHA, 0x104f, 0) }, /* NULL */
813 { USB_VPI(USB_VENDOR_YAMAHA, 0x1050, 0) }, /* NULL */
814 { USB_VPI(USB_VENDOR_YAMAHA, 0x1051, 0) }, /* NULL */
815 { USB_VPI(USB_VENDOR_YAMAHA, 0x1052, 0) }, /* NULL */
816 { USB_VPI(USB_VENDOR_YAMAHA, 0x1053, 0) }, /* NULL */
817 { USB_VPI(USB_VENDOR_YAMAHA, 0x1054, 0) }, /* NULL */
818 { USB_VPI(USB_VENDOR_YAMAHA, 0x1055, 0) }, /* NULL */
819 { USB_VPI(USB_VENDOR_YAMAHA, 0x1056, 0) }, /* NULL */
820 { USB_VPI(USB_VENDOR_YAMAHA, 0x1057, 0) }, /* NULL */
821 { USB_VPI(USB_VENDOR_YAMAHA, 0x1058, 0) }, /* NULL */
822 { USB_VPI(USB_VENDOR_YAMAHA, 0x1059, 0) }, /* NULL */
823 { USB_VPI(USB_VENDOR_YAMAHA, 0x105a, 0) }, /* NULL */
824 { USB_VPI(USB_VENDOR_YAMAHA, 0x105b, 0) }, /* NULL */
825 { USB_VPI(USB_VENDOR_YAMAHA, 0x105c, 0) }, /* NULL */
826 { USB_VPI(USB_VENDOR_YAMAHA, 0x105d, 0) }, /* NULL */
827 { USB_VPI(USB_VENDOR_YAMAHA, 0x1503, 3) }, /* MOX6/MOX8 */
828 { USB_VPI(USB_VENDOR_YAMAHA, 0x2000, 0) }, /* DGP-7 */
829 { USB_VPI(USB_VENDOR_YAMAHA, 0x2001, 0) }, /* DGP-5 */
830 { USB_VPI(USB_VENDOR_YAMAHA, 0x2002, 0) }, /* NULL */
831 { USB_VPI(USB_VENDOR_YAMAHA, 0x2003, 0) }, /* NULL */
832 { USB_VPI(USB_VENDOR_YAMAHA, 0x5000, 0) }, /* CS1D */
833 { USB_VPI(USB_VENDOR_YAMAHA, 0x5001, 0) }, /* DSP1D */
834 { USB_VPI(USB_VENDOR_YAMAHA, 0x5002, 0) }, /* DME32 */
835 { USB_VPI(USB_VENDOR_YAMAHA, 0x5003, 0) }, /* DM2000 */
836 { USB_VPI(USB_VENDOR_YAMAHA, 0x5004, 0) }, /* 02R96 */
837 { USB_VPI(USB_VENDOR_YAMAHA, 0x5005, 0) }, /* ACU16-C */
838 { USB_VPI(USB_VENDOR_YAMAHA, 0x5006, 0) }, /* NHB32-C */
839 { USB_VPI(USB_VENDOR_YAMAHA, 0x5007, 0) }, /* DM1000 */
840 { USB_VPI(USB_VENDOR_YAMAHA, 0x5008, 0) }, /* 01V96 */
841 { USB_VPI(USB_VENDOR_YAMAHA, 0x5009, 0) }, /* SPX2000 */
842 { USB_VPI(USB_VENDOR_YAMAHA, 0x500a, 0) }, /* PM5D */
843 { USB_VPI(USB_VENDOR_YAMAHA, 0x500b, 0) }, /* DME64N */
844 { USB_VPI(USB_VENDOR_YAMAHA, 0x500c, 0) }, /* DME24N */
845 { USB_VPI(USB_VENDOR_YAMAHA, 0x500d, 0) }, /* NULL */
846 { USB_VPI(USB_VENDOR_YAMAHA, 0x500e, 0) }, /* NULL */
847 { USB_VPI(USB_VENDOR_YAMAHA, 0x500f, 0) }, /* NULL */
848 { USB_VPI(USB_VENDOR_YAMAHA, 0x7000, 0) }, /* DTX */
849 { USB_VPI(USB_VENDOR_YAMAHA, 0x7010, 0) }, /* UB99 */
852 static const STRUCT_USB_HOST_ID __used uaudio_devs[] = {
853 /* Generic USB audio class match */
854 {USB_IFACE_CLASS(UICLASS_AUDIO),
855 USB_IFACE_SUBCLASS(UISUBCLASS_AUDIOCONTROL),},
856 /* Generic USB MIDI class match */
857 {USB_IFACE_CLASS(UICLASS_AUDIO),
858 USB_IFACE_SUBCLASS(UISUBCLASS_MIDISTREAM),},
862 uaudio_probe(device_t dev)
864 struct usb_attach_arg *uaa = device_get_ivars(dev);
866 if (uaa->usb_mode != USB_MODE_HOST)
869 /* lookup non-standard device(s) */
871 if (usbd_lookup_id_by_uaa(uaudio_vendor_midi,
872 sizeof(uaudio_vendor_midi), uaa) == 0) {
873 return (BUS_PROBE_SPECIFIC);
876 if (uaa->info.bInterfaceClass != UICLASS_AUDIO) {
877 if (uaa->info.bInterfaceClass != UICLASS_VENDOR ||
878 usb_test_quirk(uaa, UQ_AU_VENDOR_CLASS) == 0)
882 /* check for AUDIO control interface */
884 if (uaa->info.bInterfaceSubClass == UISUBCLASS_AUDIOCONTROL) {
885 if (usb_test_quirk(uaa, UQ_BAD_AUDIO))
888 return (BUS_PROBE_GENERIC);
891 /* check for MIDI stream */
893 if (uaa->info.bInterfaceSubClass == UISUBCLASS_MIDISTREAM) {
894 if (usb_test_quirk(uaa, UQ_BAD_MIDI))
897 return (BUS_PROBE_GENERIC);
903 * Set Cmedia CM6206 S/PDIF settings
904 * Source: CM6206 Datasheet v2.3.
907 uaudio_set_spdif_cm6206(struct uaudio_softc *sc, int flags)
909 uint8_t cmd[2][4] = {
910 {0x20, 0x20, 0x00, 0},
911 {0x20, 0x30, 0x02, 1}
915 if (flags & UAUDIO_SPDIF_OUT)
920 if (flags & UAUDIO_SPDIF_OUT_96K)
921 cmd[0][1] = 0x60; /* 96K: 3'b110 */
923 if (flags & UAUDIO_SPDIF_IN_MIX)
924 cmd[1][1] = 0x03; /* SPDIFMIX */
926 for (i = 0; i < 2; i++) {
927 if (usbd_req_set_report(sc->sc_udev, NULL,
928 cmd[i], sizeof(cmd[0]),
929 sc->sc_mixer_iface_index, UHID_OUTPUT_REPORT, 0) != 0) {
937 uaudio_set_spdif_dummy(struct uaudio_softc *sc, int flags)
943 uaudio_attach(device_t dev)
945 struct usb_attach_arg *uaa = device_get_ivars(dev);
946 struct uaudio_softc *sc = device_get_softc(dev);
947 struct usb_interface_descriptor *id;
951 sc->sc_play_chan.priv_sc = sc;
952 sc->sc_rec_chan.priv_sc = sc;
953 sc->sc_udev = uaa->device;
954 sc->sc_mixer_iface_index = uaa->info.bIfaceIndex;
955 sc->sc_mixer_iface_no = uaa->info.bIfaceNum;
956 sc->sc_config_msg[0].hdr.pm_callback = &uaudio_configure_msg;
957 sc->sc_config_msg[0].sc = sc;
958 sc->sc_config_msg[1].hdr.pm_callback = &uaudio_configure_msg;
959 sc->sc_config_msg[1].sc = sc;
961 if (usb_test_quirk(uaa, UQ_AUDIO_SWAP_LR))
962 sc->sc_uq_audio_swap_lr = 1;
964 if (usb_test_quirk(uaa, UQ_AU_INP_ASYNC))
965 sc->sc_uq_au_inp_async = 1;
967 if (usb_test_quirk(uaa, UQ_AU_NO_XU))
968 sc->sc_uq_au_no_xu = 1;
970 if (usb_test_quirk(uaa, UQ_BAD_ADC))
971 sc->sc_uq_bad_adc = 1;
973 if (usb_test_quirk(uaa, UQ_AU_VENDOR_CLASS))
974 sc->sc_uq_au_vendor_class = 1;
976 /* set S/PDIF function */
977 if (usb_test_quirk(uaa, UQ_AU_SET_SPDIF_CM6206))
978 sc->sc_set_spdif_fn = uaudio_set_spdif_cm6206;
980 sc->sc_set_spdif_fn = uaudio_set_spdif_dummy;
984 device_set_usb_desc(dev);
986 id = usbd_get_interface_descriptor(uaa->iface);
988 /* must fill mixer info before channel info */
989 uaudio_mixer_fill_info(sc, uaa->device, id);
991 /* fill channel info */
992 uaudio_chan_fill_info(sc, uaa->device);
994 DPRINTF("audio rev %d.%02x\n",
995 sc->sc_audio_rev >> 8,
996 sc->sc_audio_rev & 0xff);
998 if (sc->sc_mixer_count == 0) {
999 if (uaa->info.idVendor == USB_VENDOR_MAUDIO &&
1000 (uaa->info.idProduct == USB_PRODUCT_MAUDIO_FASTTRACKULTRA ||
1001 uaa->info.idProduct == USB_PRODUCT_MAUDIO_FASTTRACKULTRA8R)) {
1002 DPRINTF("Generating mixer descriptors\n");
1003 uaudio_mixer_controls_create_ftu(sc);
1007 DPRINTF("%d mixer controls\n",
1008 sc->sc_mixer_count);
1010 if (sc->sc_play_chan.num_alt > 0) {
1014 * Need to set a default alternate interface, else
1015 * some USB audio devices might go into an infinte
1016 * re-enumeration loop:
1018 err = usbd_set_alt_interface_index(sc->sc_udev,
1019 sc->sc_play_chan.usb_alt[0].iface_index,
1020 sc->sc_play_chan.usb_alt[0].iface_alt_index);
1022 DPRINTF("setting of alternate index failed: %s!\n",
1025 for (x = 0; x != sc->sc_play_chan.num_alt; x++) {
1026 device_printf(dev, "Play: %d Hz, %d ch, %s format, "
1028 sc->sc_play_chan.usb_alt[x].sample_rate,
1029 sc->sc_play_chan.usb_alt[x].channels,
1030 sc->sc_play_chan.usb_alt[x].p_fmt->description);
1033 device_printf(dev, "No playback.\n");
1036 if (sc->sc_rec_chan.num_alt > 0) {
1040 * Need to set a default alternate interface, else
1041 * some USB audio devices might go into an infinte
1042 * re-enumeration loop:
1044 err = usbd_set_alt_interface_index(sc->sc_udev,
1045 sc->sc_rec_chan.usb_alt[0].iface_index,
1046 sc->sc_rec_chan.usb_alt[0].iface_alt_index);
1048 DPRINTF("setting of alternate index failed: %s!\n",
1051 for (x = 0; x != sc->sc_rec_chan.num_alt; x++) {
1052 device_printf(dev, "Record: %d Hz, %d ch, %s format, "
1054 sc->sc_rec_chan.usb_alt[x].sample_rate,
1055 sc->sc_rec_chan.usb_alt[x].channels,
1056 sc->sc_rec_chan.usb_alt[x].p_fmt->description);
1059 device_printf(dev, "No recording.\n");
1062 if (sc->sc_midi_chan.valid == 0) {
1063 if (usbd_lookup_id_by_uaa(uaudio_vendor_midi,
1064 sizeof(uaudio_vendor_midi), uaa) == 0) {
1065 sc->sc_midi_chan.iface_index =
1066 (uint8_t)uaa->driver_info;
1067 sc->sc_midi_chan.iface_alt_index = 0;
1068 sc->sc_midi_chan.valid = 1;
1072 if (sc->sc_midi_chan.valid) {
1074 if (umidi_probe(dev)) {
1077 device_printf(dev, "MIDI sequencer.\n");
1079 device_printf(dev, "No MIDI sequencer.\n");
1082 DPRINTF("doing child attach\n");
1084 /* attach the children */
1086 sc->sc_sndcard_func.func = SCF_PCM;
1089 * Only attach a PCM device if we have a playback, recording
1090 * or mixer device present:
1092 if (sc->sc_play_chan.num_alt > 0 ||
1093 sc->sc_rec_chan.num_alt > 0 ||
1095 child = device_add_child(dev, "pcm", -1);
1097 if (child == NULL) {
1098 DPRINTF("out of memory\n");
1101 device_set_ivars(child, &sc->sc_sndcard_func);
1104 if (bus_generic_attach(dev)) {
1105 DPRINTF("child attach failed\n");
1109 if (uaudio_hid_probe(sc, uaa) == 0) {
1110 device_printf(dev, "HID volume keys found.\n");
1112 device_printf(dev, "No HID volume keys found.\n");
1115 /* reload all mixer settings */
1116 uaudio_mixer_reload_all(sc);
1118 /* enable S/PDIF output, if any */
1119 if (sc->sc_set_spdif_fn(sc,
1120 UAUDIO_SPDIF_OUT | UAUDIO_SPDIF_OUT_48K) != 0) {
1121 device_printf(dev, "Failed to enable S/PDIF at 48K\n");
1123 return (0); /* success */
1131 uaudio_pcm_setflags(device_t dev, uint32_t flags)
1133 pcm_setflags(dev, pcm_getflags(dev) | flags);
1137 uaudio_attach_sub(device_t dev, kobj_class_t mixer_class, kobj_class_t chan_class)
1139 struct uaudio_softc *sc = device_get_softc(device_get_parent(dev));
1140 char status[SND_STATUSLEN];
1142 uaudio_mixer_init(sc);
1144 if (sc->sc_uq_audio_swap_lr) {
1145 DPRINTF("hardware has swapped left and right\n");
1146 /* uaudio_pcm_setflags(dev, SD_F_PSWAPLR); */
1148 if (!(sc->sc_mix_info & SOUND_MASK_PCM)) {
1150 DPRINTF("emulating master volume\n");
1153 * Emulate missing pcm mixer controller
1154 * through FEEDER_VOLUME
1156 uaudio_pcm_setflags(dev, SD_F_SOFTPCMVOL);
1158 if (sc->sc_pcm_bitperfect) {
1159 DPRINTF("device needs bitperfect by default\n");
1160 uaudio_pcm_setflags(dev, SD_F_BITPERFECT);
1162 if (mixer_init(dev, mixer_class, sc))
1164 sc->sc_mixer_init = 1;
1166 mixer_hwvol_init(dev);
1168 snprintf(status, sizeof(status), "at ? %s", PCM_KLDSTRING(snd_uaudio));
1170 if (pcm_register(dev, sc,
1171 (sc->sc_play_chan.num_alt > 0) ? 1 : 0,
1172 (sc->sc_rec_chan.num_alt > 0) ? 1 : 0)) {
1176 uaudio_pcm_setflags(dev, SD_F_MPSAFE);
1177 sc->sc_pcm_registered = 1;
1179 if (sc->sc_play_chan.num_alt > 0) {
1180 pcm_addchan(dev, PCMDIR_PLAY, chan_class, sc);
1182 if (sc->sc_rec_chan.num_alt > 0) {
1183 pcm_addchan(dev, PCMDIR_REC, chan_class, sc);
1185 pcm_setstatus(dev, status);
1187 uaudio_mixer_register_sysctl(sc, dev);
1189 SYSCTL_ADD_INT(device_get_sysctl_ctx(dev),
1190 SYSCTL_CHILDREN(device_get_sysctl_tree(dev)), OID_AUTO,
1191 "feedback_rate", CTLFLAG_RD, &sc->sc_play_chan.feedback_rate,
1192 0, "Feedback sample rate in Hz");
1194 return (0); /* success */
1197 uaudio_detach_sub(dev);
1202 uaudio_detach_sub(device_t dev)
1204 struct uaudio_softc *sc = device_get_softc(device_get_parent(dev));
1207 /* disable S/PDIF output, if any */
1208 (void) sc->sc_set_spdif_fn(sc, 0);
1211 if (sc->sc_pcm_registered) {
1212 error = pcm_unregister(dev);
1214 if (sc->sc_mixer_init) {
1215 error = mixer_uninit(dev);
1220 device_printf(dev, "Waiting for sound application to exit!\n");
1221 usb_pause_mtx(NULL, 2 * hz);
1222 goto repeat; /* try again */
1224 return (0); /* success */
1228 uaudio_detach(device_t dev)
1230 struct uaudio_softc *sc = device_get_softc(dev);
1233 * Stop USB transfers early so that any audio applications
1234 * will time out and close opened /dev/dspX.Y device(s), if
1237 usb_proc_explore_lock(sc->sc_udev);
1238 sc->sc_play_chan.operation = CHAN_OP_DRAIN;
1239 sc->sc_rec_chan.operation = CHAN_OP_DRAIN;
1240 usb_proc_explore_mwait(sc->sc_udev,
1241 &sc->sc_config_msg[0], &sc->sc_config_msg[1]);
1242 usb_proc_explore_unlock(sc->sc_udev);
1244 usbd_transfer_unsetup(sc->sc_play_chan.xfer, UAUDIO_NCHANBUFS + 1);
1245 usbd_transfer_unsetup(sc->sc_rec_chan.xfer, UAUDIO_NCHANBUFS + 1);
1247 uaudio_hid_detach(sc);
1249 if (bus_generic_detach(dev) != 0) {
1250 DPRINTF("detach failed!\n");
1252 sbuf_delete(&sc->sc_sndstat);
1253 sc->sc_sndstat_valid = 0;
1257 /* free mixer data */
1259 uaudio_mixer_ctl_free(sc);
1265 uaudio_get_buffer_size(struct uaudio_chan *ch, uint8_t alt)
1267 struct uaudio_chan_alt *chan_alt = &ch->usb_alt[alt];
1268 /* We use 2 times 8ms of buffer */
1269 uint32_t buf_size = (((chan_alt->sample_rate * (UAUDIO_NFRAMES / 8)) +
1270 1000 - 1) / 1000) * chan_alt->sample_size;
1275 uaudio_configure_msg_sub(struct uaudio_softc *sc,
1276 struct uaudio_chan *chan, int dir)
1278 struct uaudio_chan_alt *chan_alt;
1287 if (chan->num_alt <= 0)
1292 usb_proc_explore_lock(sc->sc_udev);
1293 operation = chan->operation;
1294 chan->operation = CHAN_OP_NONE;
1295 usb_proc_explore_unlock(sc->sc_udev);
1297 mtx_lock(chan->pcm_mtx);
1298 if (chan->cur_alt != chan->set_alt)
1299 set_alt = chan->set_alt;
1301 set_alt = CHAN_MAX_ALT;
1302 mtx_unlock(chan->pcm_mtx);
1304 if (set_alt >= chan->num_alt)
1307 chan_alt = chan->usb_alt + set_alt;
1309 usbd_transfer_unsetup(chan->xfer, UAUDIO_NCHANBUFS + 1);
1311 err = usbd_set_alt_interface_index(sc->sc_udev,
1312 chan_alt->iface_index, chan_alt->iface_alt_index);
1314 DPRINTF("setting of alternate index failed: %s!\n",
1320 * Only set the sample rate if the channel reports that it
1321 * supports the frequency control.
1324 if (sc->sc_audio_rev >= UAUDIO_VERSION_30) {
1326 } else if (sc->sc_audio_rev >= UAUDIO_VERSION_20) {
1329 for (x = 0; x != 256; x++) {
1330 if (dir == PCMDIR_PLAY) {
1331 if (!(sc->sc_mixer_clocks.bit_output[x / 8] &
1336 if (!(sc->sc_mixer_clocks.bit_input[x / 8] &
1342 if (uaudio20_set_speed(sc->sc_udev,
1343 sc->sc_mixer_iface_no, x, chan_alt->sample_rate)) {
1345 * If the endpoint is adaptive setting
1346 * the speed may fail.
1348 DPRINTF("setting of sample rate failed! "
1349 "(continuing anyway)\n");
1352 } else if (chan_alt->p_sed.v1->bmAttributes & UA_SED_FREQ_CONTROL) {
1353 if (uaudio_set_speed(sc->sc_udev,
1354 chan_alt->p_ed1->bEndpointAddress, chan_alt->sample_rate)) {
1356 * If the endpoint is adaptive setting the
1359 DPRINTF("setting of sample rate failed! "
1360 "(continuing anyway)\n");
1363 if (usbd_transfer_setup(sc->sc_udev, &chan_alt->iface_index, chan->xfer,
1364 chan_alt->usb_cfg, UAUDIO_NCHANBUFS + 1, chan, chan->pcm_mtx)) {
1365 DPRINTF("could not allocate USB transfers!\n");
1369 fps = usbd_get_isoc_fps(sc->sc_udev);
1372 /* FULL speed USB */
1373 frames = uaudio_buffer_ms;
1375 /* HIGH speed USB */
1376 frames = uaudio_buffer_ms * 8;
1379 fps_shift = usbd_xfer_get_fps_shift(chan->xfer[0]);
1381 /* down shift number of frames per second, if any */
1383 frames >>= fps_shift;
1385 /* bytes per frame should not be zero */
1386 chan->bytes_per_frame[0] =
1387 ((chan_alt->sample_rate / fps) * chan_alt->sample_size);
1388 chan->bytes_per_frame[1] =
1389 (((chan_alt->sample_rate + fps - 1) / fps) * chan_alt->sample_size);
1391 /* setup data rate dithering, if any */
1392 chan->frames_per_second = fps;
1393 chan->sample_rem = chan_alt->sample_rate % fps;
1394 chan->sample_curr = 0;
1396 /* compute required buffer size */
1397 buf_size = (chan->bytes_per_frame[1] * frames);
1399 if (buf_size > (chan->end - chan->start)) {
1400 DPRINTF("buffer size is too big\n");
1404 chan->intr_frames = frames;
1406 DPRINTF("fps=%d sample_rem=%d\n", (int)fps, (int)chan->sample_rem);
1408 if (chan->intr_frames == 0) {
1409 DPRINTF("frame shift is too high!\n");
1413 mtx_lock(chan->pcm_mtx);
1414 chan->cur_alt = set_alt;
1415 mtx_unlock(chan->pcm_mtx);
1418 #if (UAUDIO_NCHANBUFS != 2)
1419 #error "please update code"
1421 switch (operation) {
1423 mtx_lock(chan->pcm_mtx);
1424 usbd_transfer_start(chan->xfer[0]);
1425 usbd_transfer_start(chan->xfer[1]);
1426 mtx_unlock(chan->pcm_mtx);
1429 mtx_lock(chan->pcm_mtx);
1430 usbd_transfer_stop(chan->xfer[0]);
1431 usbd_transfer_stop(chan->xfer[1]);
1432 mtx_unlock(chan->pcm_mtx);
1440 usbd_transfer_unsetup(chan->xfer, UAUDIO_NCHANBUFS + 1);
1442 mtx_lock(chan->pcm_mtx);
1443 chan->cur_alt = CHAN_MAX_ALT;
1444 mtx_unlock(chan->pcm_mtx);
1448 uaudio_configure_msg(struct usb_proc_msg *pm)
1450 struct uaudio_softc *sc = ((struct uaudio_configure_msg *)pm)->sc;
1452 usb_proc_explore_unlock(sc->sc_udev);
1453 uaudio_configure_msg_sub(sc, &sc->sc_play_chan, PCMDIR_PLAY);
1454 uaudio_configure_msg_sub(sc, &sc->sc_rec_chan, PCMDIR_REC);
1455 usb_proc_explore_lock(sc->sc_udev);
1458 /*========================================================================*
1459 * AS - Audio Stream - routines
1460 *========================================================================*/
1464 uaudio_chan_dump_ep_desc(const usb_endpoint_descriptor_audio_t *ed)
1467 DPRINTF("endpoint=%p bLength=%d bDescriptorType=%d \n"
1468 "bEndpointAddress=%d bmAttributes=0x%x \n"
1469 "wMaxPacketSize=%d bInterval=%d \n"
1470 "bRefresh=%d bSynchAddress=%d\n",
1471 ed, ed->bLength, ed->bDescriptorType,
1472 ed->bEndpointAddress, ed->bmAttributes,
1473 UGETW(ed->wMaxPacketSize), ed->bInterval,
1474 UEP_HAS_REFRESH(ed) ? ed->bRefresh : 0,
1475 UEP_HAS_SYNCADDR(ed) ? ed->bSynchAddress : 0);
1482 * The following is a workaround for broken no-name USB audio devices
1483 * sold by dealextreme called "3D sound". The problem is that the
1484 * manufacturer computed wMaxPacketSize is too small to hold the
1485 * actual data sent. In other words the device sometimes sends more
1486 * data than it actually reports it can send in a single isochronous
1490 uaudio_record_fix_fs(usb_endpoint_descriptor_audio_t *ep,
1491 uint32_t xps, uint32_t add)
1495 mps = UGETW(ep->wMaxPacketSize);
1498 * If the device indicates it can send more data than what the
1499 * sample rate indicates, we apply the workaround.
1503 /* allow additional data */
1506 /* check against the maximum USB 1.x length */
1510 /* check if we should do an update */
1512 /* simply update the wMaxPacketSize field */
1513 USETW(ep->wMaxPacketSize, xps);
1514 DPRINTF("Workaround: Updated wMaxPacketSize "
1515 "from %d to %d bytes.\n",
1516 (int)mps, (int)xps);
1522 uaudio20_check_rate(struct usb_device *udev, uint8_t iface_no,
1523 uint8_t clockid, uint32_t rate)
1525 struct usb_device_request req;
1527 #define UAUDIO20_MAX_RATES 32 /* we support at maxium 32 rates */
1528 uint8_t data[2 + UAUDIO20_MAX_RATES * 12];
1533 DPRINTFN(6, "ifaceno=%d clockid=%d rate=%u\n",
1534 iface_no, clockid, rate);
1536 req.bmRequestType = UT_READ_CLASS_INTERFACE;
1537 req.bRequest = UA20_CS_RANGE;
1538 USETW2(req.wValue, UA20_CS_SAM_FREQ_CONTROL, 0);
1539 USETW2(req.wIndex, clockid, iface_no);
1541 * Assume there is at least one rate to begin with, else some
1542 * devices might refuse to return the USB descriptor:
1544 USETW(req.wLength, (2 + 1 * 12));
1546 error = usbd_do_request_flags(udev, NULL, &req, data,
1547 USB_SHORT_XFER_OK, &actlen, USB_DEFAULT_TIMEOUT);
1549 if (error != 0 || actlen < 2) {
1551 * Likely the descriptor doesn't fit into the supplied
1552 * buffer. Try using a larger buffer and see if that
1555 rates = MIN(UAUDIO20_MAX_RATES, (255 - 2) / 12);
1556 error = USB_ERR_INVAL;
1558 rates = UGETW(data);
1560 if (rates > UAUDIO20_MAX_RATES) {
1561 DPRINTF("Too many rates truncating to %d\n", UAUDIO20_MAX_RATES);
1562 rates = UAUDIO20_MAX_RATES;
1563 error = USB_ERR_INVAL;
1564 } else if (rates > 1) {
1565 DPRINTF("Need to read full rate descriptor\n");
1566 error = USB_ERR_INVAL;
1572 * Try to read full rate descriptor.
1574 actlen = (2 + rates * 12);
1576 USETW(req.wLength, actlen);
1578 error = usbd_do_request_flags(udev, NULL, &req, data,
1579 USB_SHORT_XFER_OK, &actlen, USB_DEFAULT_TIMEOUT);
1581 if (error != 0 || actlen < 2)
1582 return (USB_ERR_INVAL);
1584 rates = UGETW(data);
1587 actlen = (actlen - 2) / 12;
1589 if (rates > actlen) {
1590 DPRINTF("Too many rates truncating to %d\n", actlen);
1594 for (x = 0; x != rates; x++) {
1595 uint32_t min = UGETDW(data + 2 + (12 * x));
1596 uint32_t max = UGETDW(data + 6 + (12 * x));
1597 uint32_t res = UGETDW(data + 10 + (12 * x));
1600 DPRINTF("Zero residue\n");
1605 DPRINTF("Swapped max and min\n");
1612 if (rate >= min && rate <= max &&
1613 (((rate - min) % res) == 0)) {
1617 return (USB_ERR_INVAL);
1621 uaudio_chan_fill_info_sub(struct uaudio_softc *sc, struct usb_device *udev,
1622 uint32_t rate, uint8_t channels, uint8_t bit_resolution)
1624 struct usb_descriptor *desc = NULL;
1625 union uaudio_asid asid = { NULL };
1626 union uaudio_asf1d asf1d = { NULL };
1627 union uaudio_sed sed = { NULL };
1628 struct usb_midi_streaming_endpoint_descriptor *msid = NULL;
1629 usb_endpoint_descriptor_audio_t *ed1 = NULL;
1630 const struct usb_audio_control_descriptor *acdp = NULL;
1631 struct usb_config_descriptor *cd = usbd_get_config_descriptor(udev);
1632 struct usb_interface_descriptor *id;
1633 const struct uaudio_format *p_fmt = NULL;
1634 struct uaudio_chan *chan;
1635 struct uaudio_chan_alt *chan_alt;
1637 uint16_t curidx = 0xFFFF;
1638 uint16_t lastidx = 0xFFFF;
1639 uint16_t alt_index = 0;
1640 uint16_t audio_rev = 0;
1644 uint8_t bBitResolution;
1645 uint8_t audio_if = 0;
1646 uint8_t midi_if = 0;
1647 uint8_t uma_if_class;
1649 while ((desc = usb_desc_foreach(cd, desc))) {
1651 if ((desc->bDescriptorType == UDESC_INTERFACE) &&
1652 (desc->bLength >= sizeof(*id))) {
1656 if (id->bInterfaceNumber != lastidx) {
1657 lastidx = id->bInterfaceNumber;
1665 if ((!(sc->sc_hid.flags & UAUDIO_HID_VALID)) &&
1666 (id->bInterfaceClass == UICLASS_HID) &&
1667 (id->bInterfaceSubClass == 0) &&
1668 (id->bInterfaceProtocol == 0) &&
1670 usbd_get_iface(udev, curidx) != NULL) {
1671 DPRINTF("Found HID interface at %d\n",
1673 sc->sc_hid.flags |= UAUDIO_HID_VALID;
1674 sc->sc_hid.iface_index = curidx;
1678 ((id->bInterfaceClass == UICLASS_AUDIO) ||
1679 ((id->bInterfaceClass == UICLASS_VENDOR) &&
1680 (sc->sc_uq_au_vendor_class != 0)));
1682 if ((uma_if_class != 0) &&
1683 (id->bInterfaceSubClass == UISUBCLASS_AUDIOSTREAM)) {
1689 if ((uma_if_class != 0) &&
1690 (id->bInterfaceSubClass == UISUBCLASS_MIDISTREAM)) {
1693 * XXX could allow multiple MIDI interfaces
1697 if ((sc->sc_midi_chan.valid == 0) &&
1698 (usbd_get_iface(udev, curidx) != NULL)) {
1699 sc->sc_midi_chan.iface_index = curidx;
1700 sc->sc_midi_chan.iface_alt_index = alt_index;
1701 sc->sc_midi_chan.valid = 1;
1712 * There can only be one USB audio instance
1713 * per USB device. Grab all USB audio
1714 * interfaces on this USB device so that we
1715 * don't attach USB audio twice:
1717 if (alt_index == 0 && curidx != sc->sc_mixer_iface_index &&
1718 (id->bInterfaceClass == UICLASS_AUDIO || audio_if != 0 ||
1720 usbd_set_parent_iface(sc->sc_udev, curidx,
1721 sc->sc_mixer_iface_index);
1725 if (audio_if == 0) {
1727 if ((acdp == NULL) &&
1728 (desc->bDescriptorType == UDESC_CS_INTERFACE) &&
1729 (desc->bDescriptorSubtype == UDESCSUB_AC_HEADER) &&
1730 (desc->bLength >= sizeof(*acdp))) {
1731 acdp = (void *)desc;
1732 audio_rev = UGETW(acdp->bcdADC);
1735 msid = (void *)desc;
1737 /* get the maximum number of embedded jacks in use, if any */
1738 if (msid->bLength >= sizeof(*msid) &&
1739 msid->bDescriptorType == UDESC_CS_ENDPOINT &&
1740 msid->bDescriptorSubtype == MS_GENERAL &&
1741 msid->bNumEmbMIDIJack > sc->sc_midi_chan.max_emb_jack) {
1742 sc->sc_midi_chan.max_emb_jack = msid->bNumEmbMIDIJack;
1746 * Don't collect any USB audio descriptors if
1747 * this is not an USB audio stream interface.
1752 if ((acdp != NULL || sc->sc_uq_au_vendor_class != 0) &&
1753 (desc->bDescriptorType == UDESC_CS_INTERFACE) &&
1754 (desc->bDescriptorSubtype == AS_GENERAL) &&
1755 (asid.v1 == NULL)) {
1756 if (audio_rev >= UAUDIO_VERSION_30) {
1758 } else if (audio_rev >= UAUDIO_VERSION_20) {
1759 if (desc->bLength >= sizeof(*asid.v2)) {
1760 asid.v2 = (void *)desc;
1763 if (desc->bLength >= sizeof(*asid.v1)) {
1764 asid.v1 = (void *)desc;
1768 if ((acdp != NULL || sc->sc_uq_au_vendor_class != 0) &&
1769 (desc->bDescriptorType == UDESC_CS_INTERFACE) &&
1770 (desc->bDescriptorSubtype == FORMAT_TYPE) &&
1771 (asf1d.v1 == NULL)) {
1772 if (audio_rev >= UAUDIO_VERSION_30) {
1774 } else if (audio_rev >= UAUDIO_VERSION_20) {
1775 if (desc->bLength >= sizeof(*asf1d.v2))
1776 asf1d.v2 = (void *)desc;
1778 if (desc->bLength >= sizeof(*asf1d.v1)) {
1779 asf1d.v1 = (void *)desc;
1781 if (asf1d.v1->bFormatType != FORMAT_TYPE_I) {
1782 DPRINTFN(11, "ignored bFormatType = %d\n",
1783 asf1d.v1->bFormatType);
1787 if (desc->bLength < (sizeof(*asf1d.v1) +
1788 ((asf1d.v1->bSamFreqType == 0) ? 6 :
1789 (asf1d.v1->bSamFreqType * 3)))) {
1790 DPRINTFN(11, "invalid descriptor, "
1798 if ((desc->bDescriptorType == UDESC_ENDPOINT) &&
1799 (desc->bLength >= UEP_MINSIZE) &&
1802 if (UE_GET_XFERTYPE(ed1->bmAttributes) != UE_ISOCHRONOUS) {
1807 if ((acdp != NULL || sc->sc_uq_au_vendor_class != 0) &&
1808 (desc->bDescriptorType == UDESC_CS_ENDPOINT) &&
1809 (desc->bDescriptorSubtype == AS_GENERAL) &&
1811 if (audio_rev >= UAUDIO_VERSION_30) {
1813 } else if (audio_rev >= UAUDIO_VERSION_20) {
1814 if (desc->bLength >= sizeof(*sed.v2))
1815 sed.v2 = (void *)desc;
1817 if (desc->bLength >= sizeof(*sed.v1))
1818 sed.v1 = (void *)desc;
1821 if (asid.v1 == NULL || asf1d.v1 == NULL ||
1822 ed1 == NULL || sed.v1 == NULL) {
1823 /* need more descriptors */
1827 ep_dir = UE_GET_DIR(ed1->bEndpointAddress);
1829 /* We ignore sync endpoint information until further. */
1831 if (audio_rev >= UAUDIO_VERSION_30) {
1833 } else if (audio_rev >= UAUDIO_VERSION_20) {
1837 dwFormat = UGETDW(asid.v2->bmFormats);
1838 bChannels = asid.v2->bNrChannels;
1839 bBitResolution = asf1d.v2->bSubslotSize * 8;
1841 if ((bChannels != channels) ||
1842 (bBitResolution != bit_resolution)) {
1843 DPRINTF("Wrong number of channels\n");
1847 for (p_fmt = uaudio20_formats;
1848 p_fmt->wFormat != 0; p_fmt++) {
1849 if ((p_fmt->wFormat & dwFormat) &&
1850 (p_fmt->bPrecision == bBitResolution))
1854 if (p_fmt->wFormat == 0) {
1855 DPRINTF("Unsupported audio format\n");
1859 for (x = 0; x != 256; x++) {
1860 if (ep_dir == UE_DIR_OUT) {
1861 if (!(sc->sc_mixer_clocks.bit_output[x / 8] &
1866 if (!(sc->sc_mixer_clocks.bit_input[x / 8] &
1872 DPRINTF("Checking clock ID=%d\n", x);
1874 if (uaudio20_check_rate(udev,
1875 sc->sc_mixer_iface_no, x, rate)) {
1876 DPRINTF("Unsupported sampling "
1877 "rate, id=%d\n", x);
1884 wFormat = UGETW(asid.v1->wFormatTag);
1885 bChannels = UAUDIO_MAX_CHAN(asf1d.v1->bNrChannels);
1886 bBitResolution = asf1d.v1->bSubFrameSize * 8;
1888 if (asf1d.v1->bSamFreqType == 0) {
1889 DPRINTFN(16, "Sample rate: %d-%dHz\n",
1890 UA_SAMP_LO(asf1d.v1),
1891 UA_SAMP_HI(asf1d.v1));
1893 if ((rate >= UA_SAMP_LO(asf1d.v1)) &&
1894 (rate <= UA_SAMP_HI(asf1d.v1)))
1898 for (x = 0; x < asf1d.v1->bSamFreqType; x++) {
1899 DPRINTFN(16, "Sample rate = %dHz\n",
1900 UA_GETSAMP(asf1d.v1, x));
1902 if (rate == UA_GETSAMP(asf1d.v1, x))
1909 for (p_fmt = uaudio10_formats;
1910 p_fmt->wFormat != 0; p_fmt++) {
1911 if ((p_fmt->wFormat == wFormat) &&
1912 (p_fmt->bPrecision == bBitResolution))
1915 if (p_fmt->wFormat == 0) {
1916 DPRINTF("Unsupported audio format\n");
1920 if ((bChannels != channels) ||
1921 (bBitResolution != bit_resolution)) {
1922 DPRINTF("Wrong number of channels\n");
1927 chan = (ep_dir == UE_DIR_IN) ?
1928 &sc->sc_rec_chan : &sc->sc_play_chan;
1930 if (usbd_get_iface(udev, curidx) == NULL) {
1931 DPRINTF("Interface is not valid\n");
1934 if (chan->num_alt == CHAN_MAX_ALT) {
1935 DPRINTF("Too many alternate settings\n");
1939 chan->cur_alt = CHAN_MAX_ALT;
1941 chan_alt = &chan->usb_alt[chan->num_alt++];
1944 uaudio_chan_dump_ep_desc(ed1);
1946 DPRINTF("Sample rate = %dHz, channels = %d, "
1947 "bits = %d, format = %s\n", rate, channels,
1948 bit_resolution, p_fmt->description);
1950 chan_alt->sample_rate = rate;
1951 chan_alt->p_asf1d = asf1d;
1952 chan_alt->p_ed1 = ed1;
1953 chan_alt->p_fmt = p_fmt;
1954 chan_alt->p_sed = sed;
1955 chan_alt->iface_index = curidx;
1956 chan_alt->iface_alt_index = alt_index;
1958 if (ep_dir == UE_DIR_IN)
1959 chan_alt->usb_cfg = uaudio_cfg_record;
1961 chan_alt->usb_cfg = uaudio_cfg_play;
1963 chan_alt->sample_size = (UAUDIO_MAX_CHAN(channels) *
1964 p_fmt->bPrecision) / 8;
1965 chan_alt->channels = channels;
1967 if (ep_dir == UE_DIR_IN &&
1968 usbd_get_speed(udev) == USB_SPEED_FULL) {
1969 uaudio_record_fix_fs(ed1,
1970 chan_alt->sample_size * (rate / 1000),
1971 chan_alt->sample_size * (rate / 4000));
1974 /* setup play/record format */
1976 format = chan_alt->p_fmt->freebsd_fmt;
1978 /* get default SND_FORMAT() */
1979 format = SND_FORMAT(format, chan_alt->channels, 0);
1981 switch (chan_alt->channels) {
1985 /* mono and stereo */
1988 /* surround and more */
1989 temp_fmt = feeder_matrix_default_format(format);
1990 /* if multichannel, then format can be zero */
1996 /* check if format is not supported */
1998 DPRINTF("The selected audio format is not supported\n");
2002 if (chan->num_alt > 1) {
2003 /* we only accumulate one format at different sample rates */
2004 if (chan->pcm_format[0] != format) {
2005 DPRINTF("Multiple formats is not supported\n");
2009 /* ignore if duplicate sample rate entry */
2010 if (rate == chan->usb_alt[chan->num_alt - 2].sample_rate) {
2011 DPRINTF("Duplicate sample rate detected\n");
2016 chan->pcm_cap.fmtlist = chan->pcm_format;
2017 chan->pcm_cap.fmtlist[0] = format;
2019 /* check if device needs bitperfect */
2020 if (chan_alt->channels > UAUDIO_MATRIX_MAX)
2021 sc->sc_pcm_bitperfect = 1;
2023 if (rate < chan->pcm_cap.minspeed || chan->pcm_cap.minspeed == 0)
2024 chan->pcm_cap.minspeed = rate;
2025 if (rate > chan->pcm_cap.maxspeed || chan->pcm_cap.maxspeed == 0)
2026 chan->pcm_cap.maxspeed = rate;
2028 if (sc->sc_sndstat_valid != 0) {
2029 sbuf_printf(&sc->sc_sndstat, "\n\t"
2030 "mode %d.%d:(%s) %dch, %dbit, %s, %dHz",
2032 (ep_dir == UE_DIR_IN) ? "input" : "output",
2033 channels, p_fmt->bPrecision,
2034 p_fmt->description, rate);
2043 /* This structure defines all the supported rates. */
2045 static const uint32_t uaudio_rate_list[CHAN_MAX_ALT] = {
2070 uaudio_chan_fill_info(struct uaudio_softc *sc, struct usb_device *udev)
2072 uint32_t rate = uaudio_default_rate;
2074 uint8_t bits = uaudio_default_bits;
2076 uint8_t channels = uaudio_default_channels;
2080 if ((bits == 0) || (bits > 32)) {
2081 /* set a valid value */
2084 if (channels == 0) {
2085 switch (usbd_get_speed(udev)) {
2087 case USB_SPEED_FULL:
2089 * Due to high bandwidth usage and problems
2090 * with HIGH-speed split transactions we
2091 * disable surround setups on FULL-speed USB
2097 channels = UAUDIO_CHANNELS_MAX;
2100 } else if (channels > UAUDIO_CHANNELS_MAX)
2101 channels = UAUDIO_CHANNELS_MAX;
2103 if (sbuf_new(&sc->sc_sndstat, NULL, 4096, SBUF_AUTOEXTEND))
2104 sc->sc_sndstat_valid = 1;
2106 /* try to search for a valid config */
2108 for (x = channels; x; x--) {
2109 for (y = bits; y; y -= 8) {
2111 /* try user defined rate, if any */
2113 uaudio_chan_fill_info_sub(sc, udev, rate, x, y);
2115 /* try find a matching rate, if any */
2116 for (z = 0; uaudio_rate_list[z]; z++)
2117 uaudio_chan_fill_info_sub(sc, udev, uaudio_rate_list[z], x, y);
2120 if (sc->sc_sndstat_valid)
2121 sbuf_finish(&sc->sc_sndstat);
2125 uaudio_chan_play_sync_callback(struct usb_xfer *xfer, usb_error_t error)
2127 struct uaudio_chan *ch = usbd_xfer_softc(xfer);
2128 struct usb_page_cache *pc;
2129 uint64_t sample_rate;
2136 usbd_xfer_status(xfer, &actlen, NULL, NULL, &nframes);
2138 switch (USB_GET_STATE(xfer)) {
2139 case USB_ST_TRANSFERRED:
2141 DPRINTFN(6, "transferred %d bytes\n", actlen);
2145 len = usbd_xfer_frame_len(xfer, 0);
2148 if (len > sizeof(buf))
2151 memset(buf, 0, sizeof(buf));
2153 pc = usbd_xfer_get_frame(xfer, 0);
2154 usbd_copy_out(pc, 0, buf, len);
2158 DPRINTF("Value = 0x%08x\n", (int)temp);
2160 /* auto-detect SYNC format */
2165 /* check for no data */
2172 sample_rate = ch->usb_alt[ch->cur_alt].sample_rate;
2175 while (temp < (sample_rate - (sample_rate / 4)))
2178 while (temp > (sample_rate + (sample_rate / 2)))
2181 DPRINTF("Comparing %d Hz :: %d Hz\n",
2182 (int)temp, (int)sample_rate);
2185 * Use feedback value as fallback when there is no
2186 * recording channel:
2188 if (ch->priv_sc->sc_rec_chan.num_alt == 0) {
2189 int32_t jitter_max = howmany(sample_rate, 16000);
2192 * Range check the jitter values to avoid
2193 * bogus sample rate adjustments. The expected
2194 * deviation should not be more than 1Hz per
2195 * second. The USB v2.0 specification also
2196 * mandates this requirement. Refer to chapter
2197 * 5.12.4.2 about feedback.
2199 ch->jitter_curr = temp - sample_rate;
2200 if (ch->jitter_curr > jitter_max)
2201 ch->jitter_curr = jitter_max;
2202 else if (ch->jitter_curr < -jitter_max)
2203 ch->jitter_curr = -jitter_max;
2205 ch->feedback_rate = temp;
2210 * Check if the recording stream can be used as a
2211 * source of jitter information to save some
2212 * isochronous bandwidth:
2214 if (ch->priv_sc->sc_rec_chan.num_alt != 0 &&
2217 usbd_xfer_set_frames(xfer, 1);
2218 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_framelen(xfer));
2219 usbd_transfer_submit(xfer);
2222 default: /* Error */
2228 uaudio_chan_is_async(struct uaudio_chan *ch, uint8_t alt)
2230 uint8_t attr = ch->usb_alt[alt].p_ed1->bmAttributes;
2231 return (UE_GET_ISO_TYPE(attr) == UE_ISO_ASYNC);
2235 uaudio_chan_play_callback(struct usb_xfer *xfer, usb_error_t error)
2237 struct uaudio_chan *ch = usbd_xfer_softc(xfer);
2238 struct uaudio_chan *ch_rec;
2239 struct usb_page_cache *pc;
2242 uint32_t blockcount;
2249 if (ch->running == 0 || ch->start == ch->end) {
2250 DPRINTF("not running or no buffer!\n");
2254 /* check if there is a record channel */
2255 if (ch->priv_sc->sc_rec_chan.num_alt > 0)
2256 ch_rec = &ch->priv_sc->sc_rec_chan;
2260 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL);
2262 switch (USB_GET_STATE(xfer)) {
2265 if (ch_rec != NULL) {
2266 /* reset receive jitter counters */
2267 mtx_lock(ch_rec->pcm_mtx);
2268 ch_rec->jitter_curr = 0;
2269 ch_rec->jitter_rem = 0;
2270 mtx_unlock(ch_rec->pcm_mtx);
2273 /* reset transmit jitter counters */
2274 ch->jitter_curr = 0;
2278 case USB_ST_TRANSFERRED:
2279 if (actlen < sumlen) {
2280 DPRINTF("short transfer, "
2281 "%d of %d bytes\n", actlen, sumlen);
2283 chn_intr(ch->pcm_ch);
2286 * Check for asynchronous playback endpoint and that
2287 * the playback endpoint is properly configured:
2289 if (ch_rec != NULL &&
2290 uaudio_chan_is_async(ch, ch->cur_alt) != 0) {
2291 mtx_lock(ch_rec->pcm_mtx);
2292 if (ch_rec->cur_alt < ch_rec->num_alt) {
2296 /* translate receive jitter into transmit jitter */
2297 tx_jitter = ch->usb_alt[ch->cur_alt].sample_rate;
2298 tx_jitter = (tx_jitter * ch_rec->jitter_curr) +
2301 /* reset receive jitter counters */
2302 ch_rec->jitter_curr = 0;
2303 ch_rec->jitter_rem = 0;
2305 /* compute exact number of transmit jitter samples */
2306 rx_rate = ch_rec->usb_alt[ch_rec->cur_alt].sample_rate;
2307 ch->jitter_curr += tx_jitter / rx_rate;
2308 ch->jitter_rem = tx_jitter % rx_rate;
2310 mtx_unlock(ch_rec->pcm_mtx);
2313 /* start the SYNC transfer one time per second, if any */
2314 ch->intr_counter += ch->intr_frames;
2315 if (ch->intr_counter >= ch->frames_per_second) {
2316 ch->intr_counter -= ch->frames_per_second;
2317 usbd_transfer_start(ch->xfer[UAUDIO_NCHANBUFS]);
2320 mfl = usbd_xfer_max_framelen(xfer);
2322 if (ch->bytes_per_frame[1] > mfl) {
2323 DPRINTF("bytes per transfer, %d, "
2324 "exceeds maximum, %d!\n",
2325 ch->bytes_per_frame[1],
2330 blockcount = ch->intr_frames;
2332 /* setup number of frames */
2333 usbd_xfer_set_frames(xfer, blockcount);
2335 /* get sample size */
2336 sample_size = ch->usb_alt[ch->cur_alt].sample_size;
2338 /* reset total length */
2341 /* setup frame lengths */
2342 for (n = 0; n != blockcount; n++) {
2345 ch->sample_curr += ch->sample_rem;
2346 if (ch->sample_curr >= ch->frames_per_second) {
2347 ch->sample_curr -= ch->frames_per_second;
2348 frame_len = ch->bytes_per_frame[1];
2350 frame_len = ch->bytes_per_frame[0];
2353 /* handle free running clock case */
2354 if (ch->jitter_curr > 0 &&
2355 (frame_len + sample_size) <= mfl) {
2356 DPRINTFN(6, "sending one sample more\n");
2358 frame_len += sample_size;
2359 } else if (ch->jitter_curr < 0 &&
2360 frame_len >= sample_size) {
2361 DPRINTFN(6, "sending one sample less\n");
2363 frame_len -= sample_size;
2365 usbd_xfer_set_frame_len(xfer, n, frame_len);
2369 DPRINTFN(6, "transferring %d bytes\n", total);
2373 pc = usbd_xfer_get_frame(xfer, 0);
2376 n = (ch->end - ch->cur);
2380 usbd_copy_in(pc, offset, ch->cur, n);
2386 if (ch->cur >= ch->end)
2387 ch->cur = ch->start;
2389 usbd_transfer_submit(xfer);
2392 default: /* Error */
2393 if (error != USB_ERR_CANCELLED)
2400 uaudio_chan_record_sync_callback(struct usb_xfer *xfer, usb_error_t error)
2406 uaudio_chan_record_callback(struct usb_xfer *xfer, usb_error_t error)
2408 struct uaudio_chan *ch = usbd_xfer_softc(xfer);
2409 struct usb_page_cache *pc;
2420 if (ch->start == ch->end) {
2421 DPRINTF("no buffer!\n");
2425 usbd_xfer_status(xfer, &actlen, NULL, NULL, &nframes);
2426 mfl = usbd_xfer_max_framelen(xfer);
2428 switch (USB_GET_STATE(xfer)) {
2429 case USB_ST_TRANSFERRED:
2432 pc = usbd_xfer_get_frame(xfer, 0);
2434 /* try to compute the number of expected bytes */
2435 ch->sample_curr += (ch->sample_rem * ch->intr_frames);
2437 /* compute number of expected bytes */
2438 expected_bytes = (ch->intr_frames * ch->bytes_per_frame[0]) +
2439 ((ch->sample_curr / ch->frames_per_second) *
2440 (ch->bytes_per_frame[1] - ch->bytes_per_frame[0]));
2442 /* keep remainder */
2443 ch->sample_curr %= ch->frames_per_second;
2445 /* get current sample size */
2446 sample_size = ch->usb_alt[ch->cur_alt].sample_size;
2448 for (n = 0; n != nframes; n++) {
2449 uint32_t offset1 = offset0;
2451 len = usbd_xfer_frame_len(xfer, n);
2453 /* make sure we only receive complete samples */
2454 len = len - (len % sample_size);
2456 /* subtract bytes received from expected payload */
2457 expected_bytes -= len;
2459 /* don't receive data when not ready */
2460 if (ch->running == 0 || ch->cur_alt != ch->set_alt)
2463 /* fill ring buffer with samples, if any */
2466 m = (ch->end - ch->cur);
2471 usbd_copy_out(pc, offset1, ch->cur, m);
2477 if (ch->cur >= ch->end)
2478 ch->cur = ch->start;
2484 /* update current jitter */
2485 ch->jitter_curr -= (expected_bytes / sample_size);
2487 /* don't allow a huge amount of jitter to accumulate */
2488 nframes = 2 * ch->intr_frames;
2490 /* range check current jitter */
2491 if (ch->jitter_curr < -nframes)
2492 ch->jitter_curr = -nframes;
2493 else if (ch->jitter_curr > nframes)
2494 ch->jitter_curr = nframes;
2496 DPRINTFN(6, "transferred %d bytes, jitter %d samples\n",
2497 actlen, ch->jitter_curr);
2499 if (ch->running != 0)
2500 chn_intr(ch->pcm_ch);
2504 nframes = ch->intr_frames;
2506 usbd_xfer_set_frames(xfer, nframes);
2507 for (n = 0; n != nframes; n++)
2508 usbd_xfer_set_frame_len(xfer, n, mfl);
2510 usbd_transfer_submit(xfer);
2513 default: /* Error */
2514 if (error != USB_ERR_CANCELLED)
2521 uaudio_chan_init(struct uaudio_softc *sc, struct snd_dbuf *b,
2522 struct pcm_channel *c, int dir)
2524 struct uaudio_chan *ch = ((dir == PCMDIR_PLAY) ?
2525 &sc->sc_play_chan : &sc->sc_rec_chan);
2529 /* store mutex and PCM channel */
2532 ch->pcm_mtx = c->lock;
2534 /* compute worst case buffer */
2537 for (x = 0; x != ch->num_alt; x++) {
2538 uint32_t temp = uaudio_get_buffer_size(ch, x);
2539 if (temp > buf_size)
2543 /* allow double buffering */
2546 DPRINTF("Worst case buffer is %d bytes\n", (int)buf_size);
2548 ch->buf = malloc(buf_size, M_DEVBUF, M_WAITOK | M_ZERO);
2549 if (ch->buf == NULL)
2551 if (sndbuf_setup(b, ch->buf, buf_size) != 0)
2554 ch->start = ch->buf;
2555 ch->end = ch->buf + buf_size;
2558 ch->max_buf = buf_size;
2560 if (ch->pcm_mtx == NULL) {
2561 DPRINTF("ERROR: PCM channels does not have a mutex!\n");
2567 uaudio_chan_free(ch);
2572 uaudio_chan_free(struct uaudio_chan *ch)
2574 if (ch->buf != NULL) {
2575 free(ch->buf, M_DEVBUF);
2578 usbd_transfer_unsetup(ch->xfer, UAUDIO_NCHANBUFS + 1);
2586 uaudio_chan_set_param_blocksize(struct uaudio_chan *ch, uint32_t blocksize)
2588 uint32_t temp = 2 * uaudio_get_buffer_size(ch, ch->set_alt);
2589 sndbuf_setup(ch->pcm_buf, ch->buf, temp);
2594 uaudio_chan_set_param_fragments(struct uaudio_chan *ch, uint32_t blocksize,
2595 uint32_t blockcount)
2601 uaudio_chan_set_param_speed(struct uaudio_chan *ch, uint32_t speed)
2603 struct uaudio_softc *sc;
2608 for (x = 0; x < ch->num_alt; x++) {
2609 if (ch->usb_alt[x].sample_rate < speed) {
2610 /* sample rate is too low */
2618 usb_proc_explore_lock(sc->sc_udev);
2620 usb_proc_explore_unlock(sc->sc_udev);
2622 DPRINTF("Selecting alt %d\n", (int)x);
2624 return (ch->usb_alt[x].sample_rate);
2628 uaudio_chan_getptr(struct uaudio_chan *ch)
2630 return (ch->cur - ch->start);
2633 struct pcmchan_caps *
2634 uaudio_chan_getcaps(struct uaudio_chan *ch)
2636 return (&ch->pcm_cap);
2639 static struct pcmchan_matrix uaudio_chan_matrix_swap_2_0 = {
2640 .id = SND_CHN_MATRIX_DRV,
2646 .type = SND_CHN_T_FR,
2648 SND_CHN_T_MASK_FR | SND_CHN_T_MASK_FC |
2649 SND_CHN_T_MASK_LF | SND_CHN_T_MASK_BR |
2650 SND_CHN_T_MASK_BC | SND_CHN_T_MASK_SR
2654 .type = SND_CHN_T_FL,
2656 SND_CHN_T_MASK_FL | SND_CHN_T_MASK_FC |
2657 SND_CHN_T_MASK_LF | SND_CHN_T_MASK_BL |
2658 SND_CHN_T_MASK_BC | SND_CHN_T_MASK_SL
2661 .type = SND_CHN_T_MAX,
2665 .mask = SND_CHN_T_MASK_FR | SND_CHN_T_MASK_FL,
2666 .offset = { 1, 0, -1, -1, -1, -1, -1, -1, -1,
2667 -1, -1, -1, -1, -1, -1, -1, -1, -1 }
2670 struct pcmchan_matrix *
2671 uaudio_chan_getmatrix(struct uaudio_chan *ch, uint32_t format)
2673 struct uaudio_softc *sc;
2677 if (sc != NULL && sc->sc_uq_audio_swap_lr != 0 &&
2678 AFMT_CHANNEL(format) == 2)
2679 return (&uaudio_chan_matrix_swap_2_0);
2681 return (feeder_matrix_format_map(format));
2685 uaudio_chan_set_param_format(struct uaudio_chan *ch, uint32_t format)
2687 DPRINTF("Selecting format 0x%08x\n", (unsigned int)format);
2692 uaudio_chan_start_sub(struct uaudio_chan *ch)
2694 struct uaudio_softc *sc = ch->priv_sc;
2697 if (ch->operation != CHAN_OP_DRAIN) {
2698 if (ch->cur_alt == ch->set_alt &&
2699 ch->operation == CHAN_OP_NONE &&
2700 mtx_owned(ch->pcm_mtx) != 0) {
2701 /* save doing the explore task */
2704 ch->operation = CHAN_OP_START;
2705 (void)usb_proc_explore_msignal(sc->sc_udev,
2706 &sc->sc_config_msg[0], &sc->sc_config_msg[1]);
2710 usbd_transfer_start(ch->xfer[0]);
2711 usbd_transfer_start(ch->xfer[1]);
2716 uaudio_chan_need_both(struct uaudio_softc *sc)
2718 return (sc->sc_play_chan.num_alt > 0 &&
2719 sc->sc_play_chan.running != 0 &&
2720 uaudio_chan_is_async(&sc->sc_play_chan,
2721 sc->sc_play_chan.set_alt) != 0 &&
2722 sc->sc_rec_chan.num_alt > 0 &&
2723 sc->sc_rec_chan.running == 0);
2727 uaudio_chan_need_none(struct uaudio_softc *sc)
2729 return (sc->sc_play_chan.num_alt > 0 &&
2730 sc->sc_play_chan.running == 0 &&
2731 sc->sc_rec_chan.num_alt > 0 &&
2732 sc->sc_rec_chan.running == 0);
2736 uaudio_chan_start(struct uaudio_chan *ch)
2738 struct uaudio_softc *sc = ch->priv_sc;
2740 /* make operation atomic */
2741 usb_proc_explore_lock(sc->sc_udev);
2743 /* check if not running */
2744 if (ch->running == 0) {
2747 /* get current buffer size */
2748 temp = 2 * uaudio_get_buffer_size(ch, ch->set_alt);
2750 /* set running flag */
2753 /* ensure the hardware buffer is reset */
2754 ch->start = ch->buf;
2755 ch->end = ch->buf + temp;
2758 if (uaudio_chan_need_both(sc)) {
2760 * Start both endpoints because of need for
2761 * jitter information:
2763 uaudio_chan_start_sub(&sc->sc_rec_chan);
2764 uaudio_chan_start_sub(&sc->sc_play_chan);
2766 uaudio_chan_start_sub(ch);
2770 /* exit atomic operation */
2771 usb_proc_explore_unlock(sc->sc_udev);
2775 uaudio_chan_stop_sub(struct uaudio_chan *ch)
2777 struct uaudio_softc *sc = ch->priv_sc;
2780 if (ch->operation != CHAN_OP_DRAIN) {
2781 if (ch->cur_alt == ch->set_alt &&
2782 ch->operation == CHAN_OP_NONE &&
2783 mtx_owned(ch->pcm_mtx) != 0) {
2784 /* save doing the explore task */
2787 ch->operation = CHAN_OP_STOP;
2788 (void)usb_proc_explore_msignal(sc->sc_udev,
2789 &sc->sc_config_msg[0], &sc->sc_config_msg[1]);
2793 usbd_transfer_stop(ch->xfer[0]);
2794 usbd_transfer_stop(ch->xfer[1]);
2799 uaudio_chan_stop(struct uaudio_chan *ch)
2801 struct uaudio_softc *sc = ch->priv_sc;
2803 /* make operation atomic */
2804 usb_proc_explore_lock(sc->sc_udev);
2806 /* check if running */
2807 if (ch->running != 0) {
2808 /* clear running flag */
2811 if (uaudio_chan_need_both(sc)) {
2813 * Leave the endpoints running because we need
2814 * information about jitter!
2816 } else if (uaudio_chan_need_none(sc)) {
2818 * Stop both endpoints in case the one was used for
2819 * jitter information:
2821 uaudio_chan_stop_sub(&sc->sc_rec_chan);
2822 uaudio_chan_stop_sub(&sc->sc_play_chan);
2824 uaudio_chan_stop_sub(ch);
2828 /* exit atomic operation */
2829 usb_proc_explore_unlock(sc->sc_udev);
2832 /*========================================================================*
2833 * AC - Audio Controller - routines
2834 *========================================================================*/
2837 uaudio_mixer_sysctl_handler(SYSCTL_HANDLER_ARGS)
2839 struct uaudio_softc *sc;
2840 struct uaudio_mixer_node *pmc;
2846 sc = (struct uaudio_softc *)oidp->oid_arg1;
2847 hint = oidp->oid_arg2;
2849 if (sc->sc_mixer_lock == NULL)
2852 /* lookup mixer node */
2854 mtx_lock(sc->sc_mixer_lock);
2855 for (pmc = sc->sc_mixer_root; pmc != NULL; pmc = pmc->next) {
2856 for (chan = 0; chan != (int)pmc->nchan; chan++) {
2857 if (pmc->wValue[chan] != -1 &&
2858 pmc->wValue[chan] == hint) {
2859 temp = pmc->wData[chan];
2865 mtx_unlock(sc->sc_mixer_lock);
2867 error = sysctl_handle_int(oidp, &temp, 0, req);
2868 if (error != 0 || req->newptr == NULL)
2871 /* update mixer value */
2873 mtx_lock(sc->sc_mixer_lock);
2875 temp >= pmc->minval &&
2876 temp <= pmc->maxval) {
2878 pmc->wData[chan] = temp;
2879 pmc->update[(chan / 8)] |= (1 << (chan % 8));
2881 /* start the transfer, if not already started */
2882 usbd_transfer_start(sc->sc_mixer_xfer[0]);
2884 mtx_unlock(sc->sc_mixer_lock);
2890 uaudio_mixer_ctl_free(struct uaudio_softc *sc)
2892 struct uaudio_mixer_node *p_mc;
2894 while ((p_mc = sc->sc_mixer_root) != NULL) {
2895 sc->sc_mixer_root = p_mc->next;
2896 free(p_mc, M_USBDEV);
2901 uaudio_mixer_register_sysctl(struct uaudio_softc *sc, device_t dev)
2903 struct uaudio_mixer_node *pmc;
2904 struct sysctl_oid *mixer_tree;
2905 struct sysctl_oid *control_tree;
2910 mixer_tree = SYSCTL_ADD_NODE(device_get_sysctl_ctx(dev),
2911 SYSCTL_CHILDREN(device_get_sysctl_tree(dev)), OID_AUTO, "mixer",
2912 CTLFLAG_RD, NULL, "");
2914 if (mixer_tree == NULL)
2917 for (n = 0, pmc = sc->sc_mixer_root; pmc != NULL;
2918 pmc = pmc->next, n++) {
2920 for (chan = 0; chan < pmc->nchan; chan++) {
2922 if (pmc->nchan > 1) {
2923 snprintf(buf, sizeof(buf), "%s_%d_%d",
2924 pmc->name, n, chan);
2926 snprintf(buf, sizeof(buf), "%s_%d",
2930 control_tree = SYSCTL_ADD_NODE(device_get_sysctl_ctx(dev),
2931 SYSCTL_CHILDREN(mixer_tree), OID_AUTO, buf,
2932 CTLFLAG_RD, NULL, "Mixer control nodes");
2934 if (control_tree == NULL)
2937 SYSCTL_ADD_PROC(device_get_sysctl_ctx(dev),
2938 SYSCTL_CHILDREN(control_tree),
2939 OID_AUTO, "val", CTLTYPE_INT | CTLFLAG_RW, sc,
2941 uaudio_mixer_sysctl_handler, "I", "Current value");
2943 SYSCTL_ADD_INT(device_get_sysctl_ctx(dev),
2944 SYSCTL_CHILDREN(control_tree),
2945 OID_AUTO, "min", CTLFLAG_RD, 0, pmc->minval,
2948 SYSCTL_ADD_INT(device_get_sysctl_ctx(dev),
2949 SYSCTL_CHILDREN(control_tree),
2950 OID_AUTO, "max", CTLFLAG_RD, 0, pmc->maxval,
2953 SYSCTL_ADD_STRING(device_get_sysctl_ctx(dev),
2954 SYSCTL_CHILDREN(control_tree),
2955 OID_AUTO, "desc", CTLFLAG_RD, pmc->desc, 0,
2961 /* M-Audio FastTrack Ultra Mixer Description */
2962 /* Origin: Linux USB Audio driver */
2964 uaudio_mixer_controls_create_ftu(struct uaudio_softc *sc)
2969 memset(&MIX(sc), 0, sizeof(MIX(sc)));
2970 MIX(sc).wIndex = MAKE_WORD(6, sc->sc_mixer_iface_no);
2971 MIX(sc).wValue[0] = MAKE_WORD(8, 0);
2972 MIX(sc).class = UAC_OUTPUT;
2973 MIX(sc).type = MIX_UNSIGNED_16;
2974 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
2975 MIX(sc).name = "effect";
2980 MIX(sc).update[0] = 1;
2981 strlcpy(MIX(sc).desc, "Room1,2,3,Hall1,2,Plate,Delay,Echo", sizeof(MIX(sc).desc));
2982 uaudio_mixer_add_ctl_sub(sc, &MIX(sc));
2984 memset(&MIX(sc), 0, sizeof(MIX(sc)));
2985 MIX(sc).wIndex = MAKE_WORD(5, sc->sc_mixer_iface_no);
2987 for (chx = 0; chx != 8; chx++) {
2988 for (chy = 0; chy != 8; chy++) {
2990 MIX(sc).wValue[0] = MAKE_WORD(chx + 1, chy + 1);
2991 MIX(sc).type = MIX_SIGNED_16;
2992 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
2993 MIX(sc).name = "mix_rec";
2995 MIX(sc).update[0] = 1;
2996 MIX(sc).val_default = 0;
2997 snprintf(MIX(sc).desc, sizeof(MIX(sc).desc),
2998 "AIn%d - Out%d Record Volume", chy + 1, chx + 1);
3000 uaudio_mixer_add_ctl(sc, &MIX(sc));
3002 MIX(sc).wValue[0] = MAKE_WORD(chx + 1, chy + 1 + 8);
3003 MIX(sc).type = MIX_SIGNED_16;
3004 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3005 MIX(sc).name = "mix_play";
3007 MIX(sc).update[0] = 1;
3008 MIX(sc).val_default = (chx == chy) ? 2 : 0;
3009 snprintf(MIX(sc).desc, sizeof(MIX(sc).desc),
3010 "DIn%d - Out%d Playback Volume", chy + 1, chx + 1);
3012 uaudio_mixer_add_ctl(sc, &MIX(sc));
3016 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3017 MIX(sc).wIndex = MAKE_WORD(6, sc->sc_mixer_iface_no);
3018 MIX(sc).wValue[0] = MAKE_WORD(2, 0);
3019 MIX(sc).class = UAC_OUTPUT;
3020 MIX(sc).type = MIX_SIGNED_8;
3021 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3022 MIX(sc).name = "effect_vol";
3024 MIX(sc).update[0] = 1;
3026 MIX(sc).maxval = 0x7f;
3029 MIX(sc).update[0] = 1;
3030 strlcpy(MIX(sc).desc, "Effect Volume", sizeof(MIX(sc).desc));
3031 uaudio_mixer_add_ctl_sub(sc, &MIX(sc));
3033 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3034 MIX(sc).wIndex = MAKE_WORD(6, sc->sc_mixer_iface_no);
3035 MIX(sc).wValue[0] = MAKE_WORD(3, 0);
3036 MIX(sc).class = UAC_OUTPUT;
3037 MIX(sc).type = MIX_SIGNED_16;
3038 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3039 MIX(sc).name = "effect_dur";
3041 MIX(sc).update[0] = 1;
3043 MIX(sc).maxval = 0x7f00;
3044 MIX(sc).mul = 0x7f00;
3046 MIX(sc).update[0] = 1;
3047 strlcpy(MIX(sc).desc, "Effect Duration", sizeof(MIX(sc).desc));
3048 uaudio_mixer_add_ctl_sub(sc, &MIX(sc));
3050 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3051 MIX(sc).wIndex = MAKE_WORD(6, sc->sc_mixer_iface_no);
3052 MIX(sc).wValue[0] = MAKE_WORD(4, 0);
3053 MIX(sc).class = UAC_OUTPUT;
3054 MIX(sc).type = MIX_SIGNED_8;
3055 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3056 MIX(sc).name = "effect_fb";
3058 MIX(sc).update[0] = 1;
3060 MIX(sc).maxval = 0x7f;
3063 MIX(sc).update[0] = 1;
3064 strlcpy(MIX(sc).desc, "Effect Feedback Volume", sizeof(MIX(sc).desc));
3065 uaudio_mixer_add_ctl_sub(sc, &MIX(sc));
3067 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3068 MIX(sc).wIndex = MAKE_WORD(7, sc->sc_mixer_iface_no);
3069 for (chy = 0; chy != 4; chy++) {
3071 MIX(sc).wValue[0] = MAKE_WORD(7, chy + 1);
3072 MIX(sc).type = MIX_SIGNED_16;
3073 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3074 MIX(sc).name = "effect_ret";
3076 MIX(sc).update[0] = 1;
3077 snprintf(MIX(sc).desc, sizeof(MIX(sc).desc),
3078 "Effect Return %d Volume", chy + 1);
3080 uaudio_mixer_add_ctl(sc, &MIX(sc));
3083 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3084 MIX(sc).wIndex = MAKE_WORD(5, sc->sc_mixer_iface_no);
3086 for (chy = 0; chy != 8; chy++) {
3087 MIX(sc).wValue[0] = MAKE_WORD(9, chy + 1);
3088 MIX(sc).type = MIX_SIGNED_16;
3089 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3090 MIX(sc).name = "effect_send";
3092 MIX(sc).update[0] = 1;
3093 snprintf(MIX(sc).desc, sizeof(MIX(sc).desc),
3094 "Effect Send AIn%d Volume", chy + 1);
3096 uaudio_mixer_add_ctl(sc, &MIX(sc));
3098 MIX(sc).wValue[0] = MAKE_WORD(9, chy + 1 + 8);
3099 MIX(sc).type = MIX_SIGNED_16;
3100 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3101 MIX(sc).name = "effect_send";
3103 MIX(sc).update[0] = 1;
3104 snprintf(MIX(sc).desc, sizeof(MIX(sc).desc),
3105 "Effect Send DIn%d Volume", chy + 1);
3107 uaudio_mixer_add_ctl(sc, &MIX(sc));
3112 uaudio_mixer_reload_all(struct uaudio_softc *sc)
3114 struct uaudio_mixer_node *pmc;
3117 if (sc->sc_mixer_lock == NULL)
3120 mtx_lock(sc->sc_mixer_lock);
3121 for (pmc = sc->sc_mixer_root; pmc != NULL; pmc = pmc->next) {
3122 /* use reset defaults for non-oss controlled settings */
3123 if (pmc->ctl == SOUND_MIXER_NRDEVICES)
3125 for (chan = 0; chan < pmc->nchan; chan++)
3126 pmc->update[chan / 8] |= (1 << (chan % 8));
3128 usbd_transfer_start(sc->sc_mixer_xfer[0]);
3130 /* start HID volume keys, if any */
3131 usbd_transfer_start(sc->sc_hid.xfer[0]);
3132 mtx_unlock(sc->sc_mixer_lock);
3136 uaudio_mixer_add_ctl_sub(struct uaudio_softc *sc, struct uaudio_mixer_node *mc)
3138 struct uaudio_mixer_node *p_mc_new =
3139 malloc(sizeof(*p_mc_new), M_USBDEV, M_WAITOK);
3142 if (p_mc_new != NULL) {
3143 memcpy(p_mc_new, mc, sizeof(*p_mc_new));
3144 p_mc_new->next = sc->sc_mixer_root;
3145 sc->sc_mixer_root = p_mc_new;
3146 sc->sc_mixer_count++;
3148 /* set default value for all channels */
3149 for (ch = 0; ch < p_mc_new->nchan; ch++) {
3150 switch (p_mc_new->val_default) {
3153 p_mc_new->wData[ch] = (p_mc_new->maxval + p_mc_new->minval) / 2;
3157 p_mc_new->wData[ch] = p_mc_new->maxval;
3161 p_mc_new->wData[ch] = p_mc_new->minval;
3166 DPRINTF("out of memory\n");
3171 uaudio_mixer_add_ctl(struct uaudio_softc *sc, struct uaudio_mixer_node *mc)
3175 if (mc->class < UAC_NCLASSES) {
3176 DPRINTF("adding %s.%d\n",
3177 uac_names[mc->class], mc->ctl);
3179 DPRINTF("adding %d\n", mc->ctl);
3182 if (mc->type == MIX_ON_OFF) {
3185 } else if (mc->type == MIX_SELECTOR) {
3188 /* determine min and max values */
3190 mc->minval = uaudio_mixer_get(sc->sc_udev,
3191 sc->sc_audio_rev, GET_MIN, mc);
3192 mc->maxval = uaudio_mixer_get(sc->sc_udev,
3193 sc->sc_audio_rev, GET_MAX, mc);
3195 /* check if max and min was swapped */
3197 if (mc->maxval < mc->minval) {
3199 mc->maxval = mc->minval;
3203 /* compute value range */
3204 mc->mul = mc->maxval - mc->minval;
3208 /* compute value alignment */
3209 res = uaudio_mixer_get(sc->sc_udev,
3210 sc->sc_audio_rev, GET_RES, mc);
3212 DPRINTF("Resolution = %d\n", (int)res);
3215 uaudio_mixer_add_ctl_sub(sc, mc);
3218 if (uaudio_debug > 2) {
3221 for (i = 0; i < mc->nchan; i++) {
3222 DPRINTF("[mix] wValue=%04x\n", mc->wValue[0]);
3224 DPRINTF("[mix] wIndex=%04x type=%d ctl='%d' "
3226 mc->wIndex, mc->type, mc->ctl,
3227 mc->minval, mc->maxval);
3233 uaudio_mixer_add_mixer(struct uaudio_softc *sc,
3234 const struct uaudio_terminal_node *iot, int id)
3236 const struct usb_audio_mixer_unit_0 *d0 = iot[id].u.mu_v1;
3237 const struct usb_audio_mixer_unit_1 *d1;
3239 uint32_t bno; /* bit number */
3240 uint32_t p; /* bit number accumulator */
3241 uint32_t mo; /* matching outputs */
3242 uint32_t mc; /* matching channels */
3243 uint32_t ichs; /* input channels */
3244 uint32_t ochs; /* output channels */
3246 uint32_t chs; /* channels */
3250 DPRINTFN(3, "bUnitId=%d bNrInPins=%d\n",
3251 d0->bUnitId, d0->bNrInPins);
3253 /* compute the number of input channels */
3256 for (i = 0; i < d0->bNrInPins; i++) {
3257 ichs += uaudio_mixer_get_cluster(
3258 d0->baSourceId[i], iot).bNrChannels;
3261 d1 = (const void *)(d0->baSourceId + d0->bNrInPins);
3263 /* and the number of output channels */
3265 ochs = d1->bNrChannels;
3267 DPRINTFN(3, "ichs=%d ochs=%d\n", ichs, ochs);
3269 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3271 MIX(sc).wIndex = MAKE_WORD(d0->bUnitId, sc->sc_mixer_iface_no);
3272 uaudio_mixer_determine_class(&iot[id], &MIX(sc));
3273 MIX(sc).type = MIX_SIGNED_16;
3275 if (uaudio_mixer_verify_desc(d0, ((ichs * ochs) + 7) / 8) == NULL)
3278 for (p = i = 0; i < d0->bNrInPins; i++) {
3279 chs = uaudio_mixer_get_cluster(
3280 d0->baSourceId[i], iot).bNrChannels;
3282 for (c = 0; c < chs; c++) {
3284 for (o = 0; o < ochs; o++) {
3285 bno = ((p + c) * ochs) + o;
3286 if (BIT_TEST(d1->bmControls, bno))
3292 if ((mc == chs) && (chs <= MIX_MAX_CHAN)) {
3294 /* repeat bit-scan */
3297 for (c = 0; c < chs; c++) {
3298 for (o = 0; o < ochs; o++) {
3299 bno = ((p + c) * ochs) + o;
3300 if (BIT_TEST(d1->bmControls, bno))
3301 MIX(sc).wValue[mc++] = MAKE_WORD(p + c + 1, o + 1);
3304 MIX(sc).nchan = chs;
3305 uaudio_mixer_add_ctl(sc, &MIX(sc));
3312 uaudio20_mixer_add_mixer(struct uaudio_softc *sc,
3313 const struct uaudio_terminal_node *iot, int id)
3315 const struct usb_audio20_mixer_unit_0 *d0 = iot[id].u.mu_v2;
3316 const struct usb_audio20_mixer_unit_1 *d1;
3318 uint32_t bno; /* bit number */
3319 uint32_t p; /* bit number accumulator */
3320 uint32_t mo; /* matching outputs */
3321 uint32_t mc; /* matching channels */
3322 uint32_t ichs; /* input channels */
3323 uint32_t ochs; /* output channels */
3325 uint32_t chs; /* channels */
3329 DPRINTFN(3, "bUnitId=%d bNrInPins=%d\n",
3330 d0->bUnitId, d0->bNrInPins);
3332 /* compute the number of input channels */
3335 for (i = 0; i < d0->bNrInPins; i++) {
3336 ichs += uaudio20_mixer_get_cluster(
3337 d0->baSourceId[i], iot).bNrChannels;
3340 d1 = (const void *)(d0->baSourceId + d0->bNrInPins);
3342 /* and the number of output channels */
3344 ochs = d1->bNrChannels;
3346 DPRINTFN(3, "ichs=%d ochs=%d\n", ichs, ochs);
3348 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3350 MIX(sc).wIndex = MAKE_WORD(d0->bUnitId, sc->sc_mixer_iface_no);
3351 uaudio20_mixer_determine_class(&iot[id], &MIX(sc));
3352 MIX(sc).type = MIX_SIGNED_16;
3354 if (uaudio20_mixer_verify_desc(d0, ((ichs * ochs) + 7) / 8) == NULL)
3357 for (p = i = 0; i < d0->bNrInPins; i++) {
3358 chs = uaudio20_mixer_get_cluster(
3359 d0->baSourceId[i], iot).bNrChannels;
3361 for (c = 0; c < chs; c++) {
3363 for (o = 0; o < ochs; o++) {
3364 bno = ((p + c) * ochs) + o;
3365 if (BIT_TEST(d1->bmControls, bno))
3371 if ((mc == chs) && (chs <= MIX_MAX_CHAN)) {
3373 /* repeat bit-scan */
3376 for (c = 0; c < chs; c++) {
3377 for (o = 0; o < ochs; o++) {
3378 bno = ((p + c) * ochs) + o;
3379 if (BIT_TEST(d1->bmControls, bno))
3380 MIX(sc).wValue[mc++] = MAKE_WORD(p + c + 1, o + 1);
3383 MIX(sc).nchan = chs;
3384 uaudio_mixer_add_ctl(sc, &MIX(sc));
3391 uaudio_mixer_add_selector(struct uaudio_softc *sc,
3392 const struct uaudio_terminal_node *iot, int id)
3394 const struct usb_audio_selector_unit *d = iot[id].u.su_v1;
3397 DPRINTFN(3, "bUnitId=%d bNrInPins=%d\n",
3398 d->bUnitId, d->bNrInPins);
3400 if (d->bNrInPins == 0)
3403 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3405 MIX(sc).wIndex = MAKE_WORD(d->bUnitId, sc->sc_mixer_iface_no);
3406 MIX(sc).wValue[0] = MAKE_WORD(0, 0);
3407 uaudio_mixer_determine_class(&iot[id], &MIX(sc));
3409 MIX(sc).type = MIX_SELECTOR;
3410 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3412 MIX(sc).maxval = d->bNrInPins;
3413 MIX(sc).name = "selector";
3415 i = d->baSourceId[d->bNrInPins];
3417 usbd_req_get_string_any(sc->sc_udev, NULL,
3418 MIX(sc).desc, sizeof(MIX(sc).desc), i) != 0) {
3419 MIX(sc).desc[0] = 0;
3422 if (MIX(sc).maxval > MAX_SELECTOR_INPUT_PIN) {
3423 MIX(sc).maxval = MAX_SELECTOR_INPUT_PIN;
3425 MIX(sc).mul = (MIX(sc).maxval - MIX(sc).minval);
3426 for (i = 0; i < MAX_SELECTOR_INPUT_PIN; i++) {
3427 MIX(sc).slctrtype[i] = SOUND_MIXER_NRDEVICES;
3430 for (i = 0; i < MIX(sc).maxval; i++) {
3431 MIX(sc).slctrtype[i] = uaudio_mixer_feature_name(
3432 &iot[d->baSourceId[i]], &MIX(sc));
3435 MIX(sc).class = 0; /* not used */
3437 uaudio_mixer_add_ctl(sc, &MIX(sc));
3441 uaudio20_mixer_add_selector(struct uaudio_softc *sc,
3442 const struct uaudio_terminal_node *iot, int id)
3444 const struct usb_audio20_selector_unit *d = iot[id].u.su_v2;
3447 DPRINTFN(3, "bUnitId=%d bNrInPins=%d\n",
3448 d->bUnitId, d->bNrInPins);
3450 if (d->bNrInPins == 0)
3453 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3455 MIX(sc).wIndex = MAKE_WORD(d->bUnitId, sc->sc_mixer_iface_no);
3456 MIX(sc).wValue[0] = MAKE_WORD(0, 0);
3457 uaudio20_mixer_determine_class(&iot[id], &MIX(sc));
3459 MIX(sc).type = MIX_SELECTOR;
3460 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3462 MIX(sc).maxval = d->bNrInPins;
3463 MIX(sc).name = "selector";
3465 i = d->baSourceId[d->bNrInPins];
3467 usbd_req_get_string_any(sc->sc_udev, NULL,
3468 MIX(sc).desc, sizeof(MIX(sc).desc), i) != 0) {
3469 MIX(sc).desc[0] = 0;
3472 if (MIX(sc).maxval > MAX_SELECTOR_INPUT_PIN)
3473 MIX(sc).maxval = MAX_SELECTOR_INPUT_PIN;
3475 MIX(sc).mul = (MIX(sc).maxval - MIX(sc).minval);
3476 for (i = 0; i < MAX_SELECTOR_INPUT_PIN; i++)
3477 MIX(sc).slctrtype[i] = SOUND_MIXER_NRDEVICES;
3479 for (i = 0; i < MIX(sc).maxval; i++) {
3480 MIX(sc).slctrtype[i] = uaudio20_mixer_feature_name(
3481 &iot[d->baSourceId[i]], &MIX(sc));
3484 MIX(sc).class = 0; /* not used */
3486 uaudio_mixer_add_ctl(sc, &MIX(sc));
3490 uaudio_mixer_feature_get_bmaControls(const struct usb_audio_feature_unit *d,
3494 uint32_t offset = (i * d->bControlSize);
3496 if (d->bControlSize > 0) {
3497 temp |= d->bmaControls[offset];
3498 if (d->bControlSize > 1) {
3499 temp |= d->bmaControls[offset + 1] << 8;
3500 if (d->bControlSize > 2) {
3501 temp |= d->bmaControls[offset + 2] << 16;
3502 if (d->bControlSize > 3) {
3503 temp |= d->bmaControls[offset + 3] << 24;
3512 uaudio_mixer_add_feature(struct uaudio_softc *sc,
3513 const struct uaudio_terminal_node *iot, int id)
3515 const struct usb_audio_feature_unit *d = iot[id].u.fu_v1;
3519 uint16_t mixernumber;
3525 if (d->bControlSize == 0)
3528 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3530 nchan = (d->bLength - 7) / d->bControlSize;
3531 mmask = uaudio_mixer_feature_get_bmaControls(d, 0);
3537 /* figure out what we can control */
3539 for (chan = 1; chan < nchan; chan++) {
3540 DPRINTFN(10, "chan=%d mask=%x\n",
3541 chan, uaudio_mixer_feature_get_bmaControls(d, chan));
3543 cmask |= uaudio_mixer_feature_get_bmaControls(d, chan);
3546 if (nchan > MIX_MAX_CHAN) {
3547 nchan = MIX_MAX_CHAN;
3549 MIX(sc).wIndex = MAKE_WORD(d->bUnitId, sc->sc_mixer_iface_no);
3551 i = d->bmaControls[d->bControlSize];
3553 usbd_req_get_string_any(sc->sc_udev, NULL,
3554 MIX(sc).desc, sizeof(MIX(sc).desc), i) != 0) {
3555 MIX(sc).desc[0] = 0;
3558 for (ctl = 1; ctl <= LOUDNESS_CONTROL; ctl++) {
3560 fumask = FU_MASK(ctl);
3562 DPRINTFN(5, "ctl=%d fumask=0x%04x\n",
3565 if (mmask & fumask) {
3567 MIX(sc).wValue[0] = MAKE_WORD(ctl, 0);
3568 } else if (cmask & fumask) {
3569 MIX(sc).nchan = nchan - 1;
3570 for (i = 1; i < nchan; i++) {
3571 if (uaudio_mixer_feature_get_bmaControls(d, i) & fumask)
3572 MIX(sc).wValue[i - 1] = MAKE_WORD(ctl, i);
3574 MIX(sc).wValue[i - 1] = -1;
3580 mixernumber = uaudio_mixer_feature_name(&iot[id], &MIX(sc));
3584 MIX(sc).type = MIX_ON_OFF;
3585 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3586 MIX(sc).name = "mute";
3589 case VOLUME_CONTROL:
3590 MIX(sc).type = MIX_SIGNED_16;
3591 MIX(sc).ctl = mixernumber;
3592 MIX(sc).name = "vol";
3596 MIX(sc).type = MIX_SIGNED_8;
3597 MIX(sc).ctl = SOUND_MIXER_BASS;
3598 MIX(sc).name = "bass";
3602 MIX(sc).type = MIX_SIGNED_8;
3603 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3604 MIX(sc).name = "mid";
3607 case TREBLE_CONTROL:
3608 MIX(sc).type = MIX_SIGNED_8;
3609 MIX(sc).ctl = SOUND_MIXER_TREBLE;
3610 MIX(sc).name = "treble";
3613 case GRAPHIC_EQUALIZER_CONTROL:
3614 continue; /* XXX don't add anything */
3617 MIX(sc).type = MIX_ON_OFF;
3618 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3619 MIX(sc).name = "agc";
3623 MIX(sc).type = MIX_UNSIGNED_16;
3624 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3625 MIX(sc).name = "delay";
3628 case BASS_BOOST_CONTROL:
3629 MIX(sc).type = MIX_ON_OFF;
3630 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3631 MIX(sc).name = "boost";
3634 case LOUDNESS_CONTROL:
3635 MIX(sc).type = MIX_ON_OFF;
3636 MIX(sc).ctl = SOUND_MIXER_LOUD; /* Is this correct ? */
3637 MIX(sc).name = "loudness";
3641 MIX(sc).type = MIX_UNKNOWN;
3645 if (MIX(sc).type != MIX_UNKNOWN)
3646 uaudio_mixer_add_ctl(sc, &MIX(sc));
3651 uaudio20_mixer_add_feature(struct uaudio_softc *sc,
3652 const struct uaudio_terminal_node *iot, int id)
3654 const struct usb_audio20_feature_unit *d = iot[id].u.fu_v2;
3658 uint16_t mixernumber;
3664 if (UGETDW(d->bmaControls[0]) == 0)
3667 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3669 nchan = (d->bLength - 6) / 4;
3670 mmask = UGETDW(d->bmaControls[0]);
3676 /* figure out what we can control */
3678 for (chan = 1; chan < nchan; chan++)
3679 cmask |= UGETDW(d->bmaControls[chan]);
3681 if (nchan > MIX_MAX_CHAN)
3682 nchan = MIX_MAX_CHAN;
3684 MIX(sc).wIndex = MAKE_WORD(d->bUnitId, sc->sc_mixer_iface_no);
3686 i = d->bmaControls[nchan][0];
3688 usbd_req_get_string_any(sc->sc_udev, NULL,
3689 MIX(sc).desc, sizeof(MIX(sc).desc), i) != 0) {
3690 MIX(sc).desc[0] = 0;
3693 for (ctl = 3; ctl != 0; ctl <<= 2) {
3695 mixernumber = uaudio20_mixer_feature_name(&iot[id], &MIX(sc));
3699 MIX(sc).type = MIX_ON_OFF;
3700 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3701 MIX(sc).name = "mute";
3702 what = MUTE_CONTROL;
3705 MIX(sc).type = MIX_SIGNED_16;
3706 MIX(sc).ctl = mixernumber;
3707 MIX(sc).name = "vol";
3708 what = VOLUME_CONTROL;
3711 MIX(sc).type = MIX_SIGNED_8;
3712 MIX(sc).ctl = SOUND_MIXER_BASS;
3713 MIX(sc).name = "bass";
3714 what = BASS_CONTROL;
3717 MIX(sc).type = MIX_SIGNED_8;
3718 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3719 MIX(sc).name = "mid";
3723 MIX(sc).type = MIX_SIGNED_8;
3724 MIX(sc).ctl = SOUND_MIXER_TREBLE;
3725 MIX(sc).name = "treble";
3726 what = TREBLE_CONTROL;
3729 MIX(sc).type = MIX_ON_OFF;
3730 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3731 MIX(sc).name = "agc";
3735 MIX(sc).type = MIX_UNSIGNED_16;
3736 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3737 MIX(sc).name = "delay";
3738 what = DELAY_CONTROL;
3741 MIX(sc).type = MIX_ON_OFF;
3742 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3743 MIX(sc).name = "boost";
3744 what = BASS_BOOST_CONTROL;
3747 MIX(sc).type = MIX_ON_OFF;
3748 MIX(sc).ctl = SOUND_MIXER_LOUD; /* Is this correct ? */
3749 MIX(sc).name = "loudness";
3750 what = LOUDNESS_CONTROL;
3753 MIX(sc).type = MIX_SIGNED_16;
3754 MIX(sc).ctl = mixernumber;
3755 MIX(sc).name = "igain";
3756 what = INPUT_GAIN_CONTROL;
3759 MIX(sc).type = MIX_SIGNED_16;
3760 MIX(sc).ctl = mixernumber;
3761 MIX(sc).name = "igainpad";
3762 what = INPUT_GAIN_PAD_CONTROL;
3768 if ((mmask & ctl) == ctl) {
3770 MIX(sc).wValue[0] = MAKE_WORD(what, 0);
3771 } else if ((cmask & ctl) == ctl) {
3772 MIX(sc).nchan = nchan - 1;
3773 for (i = 1; i < nchan; i++) {
3774 if ((UGETDW(d->bmaControls[i]) & ctl) == ctl)
3775 MIX(sc).wValue[i - 1] = MAKE_WORD(what, i);
3777 MIX(sc).wValue[i - 1] = -1;
3783 if (MIX(sc).type != MIX_UNKNOWN)
3784 uaudio_mixer_add_ctl(sc, &MIX(sc));
3789 uaudio_mixer_add_processing_updown(struct uaudio_softc *sc,
3790 const struct uaudio_terminal_node *iot, int id)
3792 const struct usb_audio_processing_unit_0 *d0 = iot[id].u.pu_v1;
3793 const struct usb_audio_processing_unit_1 *d1 =
3794 (const void *)(d0->baSourceId + d0->bNrInPins);
3795 const struct usb_audio_processing_unit_updown *ud =
3796 (const void *)(d1->bmControls + d1->bControlSize);
3799 if (uaudio_mixer_verify_desc(d0, sizeof(*ud)) == NULL) {
3802 if (uaudio_mixer_verify_desc(d0, sizeof(*ud) + (2 * ud->bNrModes))
3806 DPRINTFN(3, "bUnitId=%d bNrModes=%d\n",
3807 d0->bUnitId, ud->bNrModes);
3809 if (!(d1->bmControls[0] & UA_PROC_MASK(UD_MODE_SELECT_CONTROL))) {
3810 DPRINTF("no mode select\n");
3813 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3815 MIX(sc).wIndex = MAKE_WORD(d0->bUnitId, sc->sc_mixer_iface_no);
3817 MIX(sc).wValue[0] = MAKE_WORD(UD_MODE_SELECT_CONTROL, 0);
3818 uaudio_mixer_determine_class(&iot[id], &MIX(sc));
3819 MIX(sc).type = MIX_ON_OFF; /* XXX */
3821 for (i = 0; i < ud->bNrModes; i++) {
3822 DPRINTFN(3, "i=%d bm=0x%x\n", i, UGETW(ud->waModes[i]));
3826 uaudio_mixer_add_ctl(sc, &MIX(sc));
3830 uaudio_mixer_add_processing(struct uaudio_softc *sc,
3831 const struct uaudio_terminal_node *iot, int id)
3833 const struct usb_audio_processing_unit_0 *d0 = iot[id].u.pu_v1;
3834 const struct usb_audio_processing_unit_1 *d1 =
3835 (const void *)(d0->baSourceId + d0->bNrInPins);
3838 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3840 ptype = UGETW(d0->wProcessType);
3842 DPRINTFN(3, "wProcessType=%d bUnitId=%d "
3843 "bNrInPins=%d\n", ptype, d0->bUnitId, d0->bNrInPins);
3845 if (d1->bControlSize == 0) {
3848 if (d1->bmControls[0] & UA_PROC_ENABLE_MASK) {
3849 MIX(sc).wIndex = MAKE_WORD(d0->bUnitId, sc->sc_mixer_iface_no);
3851 MIX(sc).wValue[0] = MAKE_WORD(XX_ENABLE_CONTROL, 0);
3852 uaudio_mixer_determine_class(&iot[id], &MIX(sc));
3853 MIX(sc).type = MIX_ON_OFF;
3854 uaudio_mixer_add_ctl(sc, &MIX(sc));
3857 case UPDOWNMIX_PROCESS:
3858 uaudio_mixer_add_processing_updown(sc, iot, id);
3861 case DOLBY_PROLOGIC_PROCESS:
3862 case P3D_STEREO_EXTENDER_PROCESS:
3863 case REVERBATION_PROCESS:
3864 case CHORUS_PROCESS:
3865 case DYN_RANGE_COMP_PROCESS:
3867 DPRINTF("unit %d, type=%d is not implemented\n",
3868 d0->bUnitId, ptype);
3874 uaudio_mixer_add_extension(struct uaudio_softc *sc,
3875 const struct uaudio_terminal_node *iot, int id)
3877 const struct usb_audio_extension_unit_0 *d0 = iot[id].u.eu_v1;
3878 const struct usb_audio_extension_unit_1 *d1 =
3879 (const void *)(d0->baSourceId + d0->bNrInPins);
3881 DPRINTFN(3, "bUnitId=%d bNrInPins=%d\n",
3882 d0->bUnitId, d0->bNrInPins);
3884 if (sc->sc_uq_au_no_xu) {
3887 if (d1->bControlSize == 0) {
3890 if (d1->bmControls[0] & UA_EXT_ENABLE_MASK) {
3892 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3894 MIX(sc).wIndex = MAKE_WORD(d0->bUnitId, sc->sc_mixer_iface_no);
3896 MIX(sc).wValue[0] = MAKE_WORD(UA_EXT_ENABLE, 0);
3897 uaudio_mixer_determine_class(&iot[id], &MIX(sc));
3898 MIX(sc).type = MIX_ON_OFF;
3900 uaudio_mixer_add_ctl(sc, &MIX(sc));
3905 uaudio_mixer_verify_desc(const void *arg, uint32_t len)
3907 const struct usb_audio_mixer_unit_1 *d1;
3908 const struct usb_audio_extension_unit_1 *e1;
3909 const struct usb_audio_processing_unit_1 *u1;
3912 const struct usb_descriptor *desc;
3913 const struct usb_audio_input_terminal *it;
3914 const struct usb_audio_output_terminal *ot;
3915 const struct usb_audio_mixer_unit_0 *mu;
3916 const struct usb_audio_selector_unit *su;
3917 const struct usb_audio_feature_unit *fu;
3918 const struct usb_audio_processing_unit_0 *pu;
3919 const struct usb_audio_extension_unit_0 *eu;
3924 if (u.desc == NULL) {
3927 if (u.desc->bDescriptorType != UDESC_CS_INTERFACE) {
3930 switch (u.desc->bDescriptorSubtype) {
3931 case UDESCSUB_AC_INPUT:
3932 len += sizeof(*u.it);
3935 case UDESCSUB_AC_OUTPUT:
3936 len += sizeof(*u.ot);
3939 case UDESCSUB_AC_MIXER:
3940 len += sizeof(*u.mu);
3942 if (u.desc->bLength < len) {
3945 len += u.mu->bNrInPins;
3947 if (u.desc->bLength < len) {
3950 d1 = (const void *)(u.mu->baSourceId + u.mu->bNrInPins);
3955 case UDESCSUB_AC_SELECTOR:
3956 len += sizeof(*u.su);
3958 if (u.desc->bLength < len) {
3961 len += u.su->bNrInPins + 1;
3964 case UDESCSUB_AC_FEATURE:
3965 len += sizeof(*u.fu) + 1;
3967 if (u.desc->bLength < len)
3970 len += u.fu->bControlSize;
3973 case UDESCSUB_AC_PROCESSING:
3974 len += sizeof(*u.pu);
3976 if (u.desc->bLength < len) {
3979 len += u.pu->bNrInPins;
3981 if (u.desc->bLength < len) {
3984 u1 = (const void *)(u.pu->baSourceId + u.pu->bNrInPins);
3988 if (u.desc->bLength < len) {
3991 len += u1->bControlSize;
3995 case UDESCSUB_AC_EXTENSION:
3996 len += sizeof(*u.eu);
3998 if (u.desc->bLength < len) {
4001 len += u.eu->bNrInPins;
4003 if (u.desc->bLength < len) {
4006 e1 = (const void *)(u.eu->baSourceId + u.eu->bNrInPins);
4010 if (u.desc->bLength < len) {
4013 len += e1->bControlSize;
4020 if (u.desc->bLength < len) {
4027 DPRINTF("invalid descriptor, type=%d, "
4028 "sub_type=%d, len=%d of %d bytes\n",
4029 u.desc->bDescriptorType,
4030 u.desc->bDescriptorSubtype,
4031 u.desc->bLength, len);
4037 uaudio20_mixer_verify_desc(const void *arg, uint32_t len)
4039 const struct usb_audio20_mixer_unit_1 *d1;
4040 const struct usb_audio20_extension_unit_1 *e1;
4041 const struct usb_audio20_processing_unit_1 *u1;
4042 const struct usb_audio20_clock_selector_unit_1 *c1;
4045 const struct usb_descriptor *desc;
4046 const struct usb_audio20_clock_source_unit *csrc;
4047 const struct usb_audio20_clock_selector_unit_0 *csel;
4048 const struct usb_audio20_clock_multiplier_unit *cmul;
4049 const struct usb_audio20_input_terminal *it;
4050 const struct usb_audio20_output_terminal *ot;
4051 const struct usb_audio20_mixer_unit_0 *mu;
4052 const struct usb_audio20_selector_unit *su;
4053 const struct usb_audio20_feature_unit *fu;
4054 const struct usb_audio20_sample_rate_unit *ru;
4055 const struct usb_audio20_processing_unit_0 *pu;
4056 const struct usb_audio20_extension_unit_0 *eu;
4057 const struct usb_audio20_effect_unit *ef;
4065 if (u.desc->bDescriptorType != UDESC_CS_INTERFACE)
4068 switch (u.desc->bDescriptorSubtype) {
4069 case UDESCSUB_AC_INPUT:
4070 len += sizeof(*u.it);
4073 case UDESCSUB_AC_OUTPUT:
4074 len += sizeof(*u.ot);
4077 case UDESCSUB_AC_MIXER:
4078 len += sizeof(*u.mu);
4080 if (u.desc->bLength < len)
4082 len += u.mu->bNrInPins;
4084 if (u.desc->bLength < len)
4087 d1 = (const void *)(u.mu->baSourceId + u.mu->bNrInPins);
4089 len += sizeof(*d1) + d1->bNrChannels;
4092 case UDESCSUB_AC_SELECTOR:
4093 len += sizeof(*u.su);
4095 if (u.desc->bLength < len)
4098 len += u.su->bNrInPins + 1;
4101 case UDESCSUB_AC_FEATURE:
4102 len += sizeof(*u.fu) + 1;
4105 case UDESCSUB_AC_EFFECT:
4106 len += sizeof(*u.ef) + 4;
4109 case UDESCSUB_AC_PROCESSING_V2:
4110 len += sizeof(*u.pu);
4112 if (u.desc->bLength < len)
4115 len += u.pu->bNrInPins;
4117 if (u.desc->bLength < len)
4120 u1 = (const void *)(u.pu->baSourceId + u.pu->bNrInPins);
4125 case UDESCSUB_AC_EXTENSION_V2:
4126 len += sizeof(*u.eu);
4128 if (u.desc->bLength < len)
4131 len += u.eu->bNrInPins;
4133 if (u.desc->bLength < len)
4136 e1 = (const void *)(u.eu->baSourceId + u.eu->bNrInPins);
4141 case UDESCSUB_AC_CLOCK_SRC:
4142 len += sizeof(*u.csrc);
4145 case UDESCSUB_AC_CLOCK_SEL:
4146 len += sizeof(*u.csel);
4148 if (u.desc->bLength < len)
4151 len += u.csel->bNrInPins;
4153 if (u.desc->bLength < len)
4156 c1 = (const void *)(u.csel->baCSourceId + u.csel->bNrInPins);
4161 case UDESCSUB_AC_CLOCK_MUL:
4162 len += sizeof(*u.cmul);
4165 case UDESCSUB_AC_SAMPLE_RT:
4166 len += sizeof(*u.ru);
4173 if (u.desc->bLength < len)
4180 DPRINTF("invalid descriptor, type=%d, "
4181 "sub_type=%d, len=%d of %d bytes\n",
4182 u.desc->bDescriptorType,
4183 u.desc->bDescriptorSubtype,
4184 u.desc->bLength, len);
4189 static struct usb_audio_cluster
4190 uaudio_mixer_get_cluster(uint8_t id, const struct uaudio_terminal_node *iot)
4192 struct usb_audio_cluster r;
4193 const struct usb_descriptor *dp;
4196 for (i = 0; i < UAUDIO_RECURSE_LIMIT; i++) { /* avoid infinite loops */
4197 dp = iot[id].u.desc;
4201 switch (dp->bDescriptorSubtype) {
4202 case UDESCSUB_AC_INPUT:
4203 r.bNrChannels = iot[id].u.it_v1->bNrChannels;
4204 r.wChannelConfig[0] = iot[id].u.it_v1->wChannelConfig[0];
4205 r.wChannelConfig[1] = iot[id].u.it_v1->wChannelConfig[1];
4206 r.iChannelNames = iot[id].u.it_v1->iChannelNames;
4209 case UDESCSUB_AC_OUTPUT:
4210 id = iot[id].u.ot_v1->bSourceId;
4213 case UDESCSUB_AC_MIXER:
4214 r = *(const struct usb_audio_cluster *)
4215 &iot[id].u.mu_v1->baSourceId[
4216 iot[id].u.mu_v1->bNrInPins];
4219 case UDESCSUB_AC_SELECTOR:
4220 if (iot[id].u.su_v1->bNrInPins > 0) {
4221 /* XXX This is not really right */
4222 id = iot[id].u.su_v1->baSourceId[0];
4226 case UDESCSUB_AC_FEATURE:
4227 id = iot[id].u.fu_v1->bSourceId;
4230 case UDESCSUB_AC_PROCESSING:
4231 r = *((const struct usb_audio_cluster *)
4232 &iot[id].u.pu_v1->baSourceId[
4233 iot[id].u.pu_v1->bNrInPins]);
4236 case UDESCSUB_AC_EXTENSION:
4237 r = *((const struct usb_audio_cluster *)
4238 &iot[id].u.eu_v1->baSourceId[
4239 iot[id].u.eu_v1->bNrInPins]);
4247 DPRINTF("bad data\n");
4248 memset(&r, 0, sizeof(r));
4253 static struct usb_audio20_cluster
4254 uaudio20_mixer_get_cluster(uint8_t id, const struct uaudio_terminal_node *iot)
4256 struct usb_audio20_cluster r;
4257 const struct usb_descriptor *dp;
4260 for (i = 0; i < UAUDIO_RECURSE_LIMIT; i++) { /* avoid infinite loops */
4261 dp = iot[id].u.desc;
4265 switch (dp->bDescriptorSubtype) {
4266 case UDESCSUB_AC_INPUT:
4267 r.bNrChannels = iot[id].u.it_v2->bNrChannels;
4268 r.bmChannelConfig[0] = iot[id].u.it_v2->bmChannelConfig[0];
4269 r.bmChannelConfig[1] = iot[id].u.it_v2->bmChannelConfig[1];
4270 r.bmChannelConfig[2] = iot[id].u.it_v2->bmChannelConfig[2];
4271 r.bmChannelConfig[3] = iot[id].u.it_v2->bmChannelConfig[3];
4272 r.iChannelNames = iot[id].u.it_v2->iTerminal;
4275 case UDESCSUB_AC_OUTPUT:
4276 id = iot[id].u.ot_v2->bSourceId;
4279 case UDESCSUB_AC_MIXER:
4280 r = *(const struct usb_audio20_cluster *)
4281 &iot[id].u.mu_v2->baSourceId[
4282 iot[id].u.mu_v2->bNrInPins];
4285 case UDESCSUB_AC_SELECTOR:
4286 if (iot[id].u.su_v2->bNrInPins > 0) {
4287 /* XXX This is not really right */
4288 id = iot[id].u.su_v2->baSourceId[0];
4292 case UDESCSUB_AC_SAMPLE_RT:
4293 id = iot[id].u.ru_v2->bSourceId;
4296 case UDESCSUB_AC_EFFECT:
4297 id = iot[id].u.ef_v2->bSourceId;
4300 case UDESCSUB_AC_FEATURE:
4301 id = iot[id].u.fu_v2->bSourceId;
4304 case UDESCSUB_AC_PROCESSING_V2:
4305 r = *((const struct usb_audio20_cluster *)
4306 &iot[id].u.pu_v2->baSourceId[
4307 iot[id].u.pu_v2->bNrInPins]);
4310 case UDESCSUB_AC_EXTENSION_V2:
4311 r = *((const struct usb_audio20_cluster *)
4312 &iot[id].u.eu_v2->baSourceId[
4313 iot[id].u.eu_v2->bNrInPins]);
4321 DPRINTF("Bad data!\n");
4322 memset(&r, 0, sizeof(r));
4328 uaudio_mixer_determine_class(const struct uaudio_terminal_node *iot,
4329 struct uaudio_mixer_node *mix)
4331 uint16_t terminal_type = 0x0000;
4332 const struct uaudio_terminal_node *input[2];
4333 const struct uaudio_terminal_node *output[2];
4335 input[0] = uaudio_mixer_get_input(iot, 0);
4336 input[1] = uaudio_mixer_get_input(iot, 1);
4338 output[0] = uaudio_mixer_get_output(iot, 0);
4339 output[1] = uaudio_mixer_get_output(iot, 1);
4342 * check if there is only
4343 * one output terminal:
4345 if (output[0] && (!output[1])) {
4347 UGETW(output[0]->u.ot_v1->wTerminalType);
4350 * If the only output terminal is USB,
4351 * the class is UAC_RECORD.
4353 if ((terminal_type & 0xff00) == (UAT_UNDEFINED & 0xff00)) {
4355 mix->class = UAC_RECORD;
4356 if (input[0] && (!input[1])) {
4358 UGETW(input[0]->u.it_v1->wTerminalType);
4365 * if the unit is connected to just
4366 * one input terminal, the
4367 * class is UAC_INPUT:
4369 if (input[0] && (!input[1])) {
4370 mix->class = UAC_INPUT;
4372 UGETW(input[0]->u.it_v1->wTerminalType);
4376 * Otherwise, the class is UAC_OUTPUT.
4378 mix->class = UAC_OUTPUT;
4380 return (terminal_type);
4384 uaudio20_mixer_determine_class(const struct uaudio_terminal_node *iot,
4385 struct uaudio_mixer_node *mix)
4387 uint16_t terminal_type = 0x0000;
4388 const struct uaudio_terminal_node *input[2];
4389 const struct uaudio_terminal_node *output[2];
4391 input[0] = uaudio_mixer_get_input(iot, 0);
4392 input[1] = uaudio_mixer_get_input(iot, 1);
4394 output[0] = uaudio_mixer_get_output(iot, 0);
4395 output[1] = uaudio_mixer_get_output(iot, 1);
4398 * check if there is only
4399 * one output terminal:
4401 if (output[0] && (!output[1]))
4402 terminal_type = UGETW(output[0]->u.ot_v2->wTerminalType);
4404 * If the only output terminal is USB,
4405 * the class is UAC_RECORD.
4407 if ((terminal_type & 0xff00) == (UAT_UNDEFINED & 0xff00)) {
4409 mix->class = UAC_RECORD;
4410 if (input[0] && (!input[1])) {
4412 UGETW(input[0]->u.it_v2->wTerminalType);
4419 * if the unit is connected to just
4420 * one input terminal, the
4421 * class is UAC_INPUT:
4423 if (input[0] && (!input[1])) {
4424 mix->class = UAC_INPUT;
4426 UGETW(input[0]->u.it_v2->wTerminalType);
4430 * Otherwise, the class is UAC_OUTPUT.
4432 mix->class = UAC_OUTPUT;
4434 return (terminal_type);
4437 struct uaudio_tt_to_feature {
4438 uint16_t terminal_type;
4442 static const struct uaudio_tt_to_feature uaudio_tt_to_feature[] = {
4444 {UAT_STREAM, SOUND_MIXER_PCM},
4446 {UATI_MICROPHONE, SOUND_MIXER_MIC},
4447 {UATI_DESKMICROPHONE, SOUND_MIXER_MIC},
4448 {UATI_PERSONALMICROPHONE, SOUND_MIXER_MIC},
4449 {UATI_OMNIMICROPHONE, SOUND_MIXER_MIC},
4450 {UATI_MICROPHONEARRAY, SOUND_MIXER_MIC},
4451 {UATI_PROCMICROPHONEARR, SOUND_MIXER_MIC},
4453 {UATO_SPEAKER, SOUND_MIXER_SPEAKER},
4454 {UATO_DESKTOPSPEAKER, SOUND_MIXER_SPEAKER},
4455 {UATO_ROOMSPEAKER, SOUND_MIXER_SPEAKER},
4456 {UATO_COMMSPEAKER, SOUND_MIXER_SPEAKER},
4458 {UATE_ANALOGCONN, SOUND_MIXER_LINE},
4459 {UATE_LINECONN, SOUND_MIXER_LINE},
4460 {UATE_LEGACYCONN, SOUND_MIXER_LINE},
4462 {UATE_DIGITALAUIFC, SOUND_MIXER_ALTPCM},
4463 {UATE_SPDIF, SOUND_MIXER_ALTPCM},
4464 {UATE_1394DA, SOUND_MIXER_ALTPCM},
4465 {UATE_1394DV, SOUND_MIXER_ALTPCM},
4467 {UATF_CDPLAYER, SOUND_MIXER_CD},
4469 {UATF_SYNTHESIZER, SOUND_MIXER_SYNTH},
4471 {UATF_VIDEODISCAUDIO, SOUND_MIXER_VIDEO},
4472 {UATF_DVDAUDIO, SOUND_MIXER_VIDEO},
4473 {UATF_TVTUNERAUDIO, SOUND_MIXER_VIDEO},
4475 /* telephony terminal types */
4476 {UATT_UNDEFINED, SOUND_MIXER_PHONEIN}, /* SOUND_MIXER_PHONEOUT */
4477 {UATT_PHONELINE, SOUND_MIXER_PHONEIN}, /* SOUND_MIXER_PHONEOUT */
4478 {UATT_TELEPHONE, SOUND_MIXER_PHONEIN}, /* SOUND_MIXER_PHONEOUT */
4479 {UATT_DOWNLINEPHONE, SOUND_MIXER_PHONEIN}, /* SOUND_MIXER_PHONEOUT */
4481 {UATF_RADIORECV, SOUND_MIXER_RADIO},
4482 {UATF_RADIOXMIT, SOUND_MIXER_RADIO},
4484 {UAT_UNDEFINED, SOUND_MIXER_VOLUME},
4485 {UAT_VENDOR, SOUND_MIXER_VOLUME},
4486 {UATI_UNDEFINED, SOUND_MIXER_VOLUME},
4488 /* output terminal types */
4489 {UATO_UNDEFINED, SOUND_MIXER_VOLUME},
4490 {UATO_DISPLAYAUDIO, SOUND_MIXER_VOLUME},
4491 {UATO_SUBWOOFER, SOUND_MIXER_VOLUME},
4492 {UATO_HEADPHONES, SOUND_MIXER_VOLUME},
4494 /* bidir terminal types */
4495 {UATB_UNDEFINED, SOUND_MIXER_VOLUME},
4496 {UATB_HANDSET, SOUND_MIXER_VOLUME},
4497 {UATB_HEADSET, SOUND_MIXER_VOLUME},
4498 {UATB_SPEAKERPHONE, SOUND_MIXER_VOLUME},
4499 {UATB_SPEAKERPHONEESUP, SOUND_MIXER_VOLUME},
4500 {UATB_SPEAKERPHONEECANC, SOUND_MIXER_VOLUME},
4502 /* external terminal types */
4503 {UATE_UNDEFINED, SOUND_MIXER_VOLUME},
4505 /* embedded function terminal types */
4506 {UATF_UNDEFINED, SOUND_MIXER_VOLUME},
4507 {UATF_CALIBNOISE, SOUND_MIXER_VOLUME},
4508 {UATF_EQUNOISE, SOUND_MIXER_VOLUME},
4509 {UATF_DAT, SOUND_MIXER_VOLUME},
4510 {UATF_DCC, SOUND_MIXER_VOLUME},
4511 {UATF_MINIDISK, SOUND_MIXER_VOLUME},
4512 {UATF_ANALOGTAPE, SOUND_MIXER_VOLUME},
4513 {UATF_PHONOGRAPH, SOUND_MIXER_VOLUME},
4514 {UATF_VCRAUDIO, SOUND_MIXER_VOLUME},
4515 {UATF_SATELLITE, SOUND_MIXER_VOLUME},
4516 {UATF_CABLETUNER, SOUND_MIXER_VOLUME},
4517 {UATF_DSS, SOUND_MIXER_VOLUME},
4518 {UATF_MULTITRACK, SOUND_MIXER_VOLUME},
4519 {0xffff, SOUND_MIXER_VOLUME},
4522 {0x0000, SOUND_MIXER_VOLUME},
4526 uaudio_mixer_feature_name(const struct uaudio_terminal_node *iot,
4527 struct uaudio_mixer_node *mix)
4529 const struct uaudio_tt_to_feature *uat = uaudio_tt_to_feature;
4530 uint16_t terminal_type = uaudio_mixer_determine_class(iot, mix);
4532 if ((mix->class == UAC_RECORD) && (terminal_type == 0)) {
4533 return (SOUND_MIXER_IMIX);
4535 while (uat->terminal_type) {
4536 if (uat->terminal_type == terminal_type) {
4542 DPRINTF("terminal_type=0x%04x -> %d\n",
4543 terminal_type, uat->feature);
4545 return (uat->feature);
4549 uaudio20_mixer_feature_name(const struct uaudio_terminal_node *iot,
4550 struct uaudio_mixer_node *mix)
4552 const struct uaudio_tt_to_feature *uat;
4553 uint16_t terminal_type = uaudio20_mixer_determine_class(iot, mix);
4555 if ((mix->class == UAC_RECORD) && (terminal_type == 0))
4556 return (SOUND_MIXER_IMIX);
4558 for (uat = uaudio_tt_to_feature; uat->terminal_type != 0; uat++) {
4559 if (uat->terminal_type == terminal_type)
4563 DPRINTF("terminal_type=0x%04x -> %d\n",
4564 terminal_type, uat->feature);
4566 return (uat->feature);
4569 static const struct uaudio_terminal_node *
4570 uaudio_mixer_get_input(const struct uaudio_terminal_node *iot, uint8_t i)
4572 struct uaudio_terminal_node *root = iot->root;
4575 n = iot->usr.id_max;
4577 if (iot->usr.bit_input[n / 8] & (1 << (n % 8))) {
4586 static const struct uaudio_terminal_node *
4587 uaudio_mixer_get_output(const struct uaudio_terminal_node *iot, uint8_t i)
4589 struct uaudio_terminal_node *root = iot->root;
4592 n = iot->usr.id_max;
4594 if (iot->usr.bit_output[n / 8] & (1 << (n % 8))) {
4604 uaudio_mixer_find_inputs_sub(struct uaudio_terminal_node *root,
4605 const uint8_t *p_id, uint8_t n_id,
4606 struct uaudio_search_result *info)
4608 struct uaudio_terminal_node *iot;
4614 for (n = 0; n < n_id; n++) {
4618 if (info->recurse_level == UAUDIO_RECURSE_LIMIT) {
4619 DPRINTF("avoided going into a circle at id=%d!\n", i);
4623 info->recurse_level++;
4627 if (iot->u.desc == NULL)
4630 is_last = ((n + 1) == n_id);
4632 switch (iot->u.desc->bDescriptorSubtype) {
4633 case UDESCSUB_AC_INPUT:
4634 info->bit_input[i / 8] |= (1 << (i % 8));
4637 case UDESCSUB_AC_FEATURE:
4639 p_id = &iot->u.fu_v1->bSourceId;
4643 uaudio_mixer_find_inputs_sub(
4644 root, &iot->u.fu_v1->bSourceId, 1, info);
4647 case UDESCSUB_AC_OUTPUT:
4649 p_id = &iot->u.ot_v1->bSourceId;
4653 uaudio_mixer_find_inputs_sub(
4654 root, &iot->u.ot_v1->bSourceId, 1, info);
4657 case UDESCSUB_AC_MIXER:
4659 p_id = iot->u.mu_v1->baSourceId;
4660 n_id = iot->u.mu_v1->bNrInPins;
4663 uaudio_mixer_find_inputs_sub(
4664 root, iot->u.mu_v1->baSourceId,
4665 iot->u.mu_v1->bNrInPins, info);
4668 case UDESCSUB_AC_SELECTOR:
4670 p_id = iot->u.su_v1->baSourceId;
4671 n_id = iot->u.su_v1->bNrInPins;
4674 uaudio_mixer_find_inputs_sub(
4675 root, iot->u.su_v1->baSourceId,
4676 iot->u.su_v1->bNrInPins, info);
4679 case UDESCSUB_AC_PROCESSING:
4681 p_id = iot->u.pu_v1->baSourceId;
4682 n_id = iot->u.pu_v1->bNrInPins;
4685 uaudio_mixer_find_inputs_sub(
4686 root, iot->u.pu_v1->baSourceId,
4687 iot->u.pu_v1->bNrInPins, info);
4690 case UDESCSUB_AC_EXTENSION:
4692 p_id = iot->u.eu_v1->baSourceId;
4693 n_id = iot->u.eu_v1->bNrInPins;
4696 uaudio_mixer_find_inputs_sub(
4697 root, iot->u.eu_v1->baSourceId,
4698 iot->u.eu_v1->bNrInPins, info);
4708 uaudio20_mixer_find_inputs_sub(struct uaudio_terminal_node *root,
4709 const uint8_t *p_id, uint8_t n_id,
4710 struct uaudio_search_result *info)
4712 struct uaudio_terminal_node *iot;
4718 for (n = 0; n < n_id; n++) {
4722 if (info->recurse_level == UAUDIO_RECURSE_LIMIT) {
4723 DPRINTF("avoided going into a circle at id=%d!\n", i);
4727 info->recurse_level++;
4731 if (iot->u.desc == NULL)
4734 is_last = ((n + 1) == n_id);
4736 switch (iot->u.desc->bDescriptorSubtype) {
4737 case UDESCSUB_AC_INPUT:
4738 info->bit_input[i / 8] |= (1 << (i % 8));
4741 case UDESCSUB_AC_OUTPUT:
4743 p_id = &iot->u.ot_v2->bSourceId;
4747 uaudio20_mixer_find_inputs_sub(
4748 root, &iot->u.ot_v2->bSourceId, 1, info);
4751 case UDESCSUB_AC_MIXER:
4753 p_id = iot->u.mu_v2->baSourceId;
4754 n_id = iot->u.mu_v2->bNrInPins;
4757 uaudio20_mixer_find_inputs_sub(
4758 root, iot->u.mu_v2->baSourceId,
4759 iot->u.mu_v2->bNrInPins, info);
4762 case UDESCSUB_AC_SELECTOR:
4764 p_id = iot->u.su_v2->baSourceId;
4765 n_id = iot->u.su_v2->bNrInPins;
4768 uaudio20_mixer_find_inputs_sub(
4769 root, iot->u.su_v2->baSourceId,
4770 iot->u.su_v2->bNrInPins, info);
4773 case UDESCSUB_AC_SAMPLE_RT:
4775 p_id = &iot->u.ru_v2->bSourceId;
4779 uaudio20_mixer_find_inputs_sub(
4780 root, &iot->u.ru_v2->bSourceId,
4784 case UDESCSUB_AC_EFFECT:
4786 p_id = &iot->u.ef_v2->bSourceId;
4790 uaudio20_mixer_find_inputs_sub(
4791 root, &iot->u.ef_v2->bSourceId,
4795 case UDESCSUB_AC_FEATURE:
4797 p_id = &iot->u.fu_v2->bSourceId;
4801 uaudio20_mixer_find_inputs_sub(
4802 root, &iot->u.fu_v2->bSourceId, 1, info);
4805 case UDESCSUB_AC_PROCESSING_V2:
4807 p_id = iot->u.pu_v2->baSourceId;
4808 n_id = iot->u.pu_v2->bNrInPins;
4811 uaudio20_mixer_find_inputs_sub(
4812 root, iot->u.pu_v2->baSourceId,
4813 iot->u.pu_v2->bNrInPins, info);
4816 case UDESCSUB_AC_EXTENSION_V2:
4818 p_id = iot->u.eu_v2->baSourceId;
4819 n_id = iot->u.eu_v2->bNrInPins;
4822 uaudio20_mixer_find_inputs_sub(
4823 root, iot->u.eu_v2->baSourceId,
4824 iot->u.eu_v2->bNrInPins, info);
4833 uaudio20_mixer_find_clocks_sub(struct uaudio_terminal_node *root,
4834 const uint8_t *p_id, uint8_t n_id,
4835 struct uaudio_search_result *info)
4837 struct uaudio_terminal_node *iot;
4844 for (n = 0; n < n_id; n++) {
4848 if (info->recurse_level == UAUDIO_RECURSE_LIMIT) {
4849 DPRINTF("avoided going into a circle at id=%d!\n", i);
4853 info->recurse_level++;
4857 if (iot->u.desc == NULL)
4860 is_last = ((n + 1) == n_id);
4862 switch (iot->u.desc->bDescriptorSubtype) {
4863 case UDESCSUB_AC_INPUT:
4866 p_id = &iot->u.it_v2->bCSourceId;
4870 uaudio20_mixer_find_clocks_sub(root,
4871 &iot->u.it_v2->bCSourceId, 1, info);
4874 case UDESCSUB_AC_OUTPUT:
4877 p_id = &iot->u.ot_v2->bCSourceId;
4881 uaudio20_mixer_find_clocks_sub(root,
4882 &iot->u.ot_v2->bCSourceId, 1, info);
4885 case UDESCSUB_AC_CLOCK_SEL:
4887 p_id = iot->u.csel_v2->baCSourceId;
4888 n_id = iot->u.csel_v2->bNrInPins;
4891 uaudio20_mixer_find_clocks_sub(root,
4892 iot->u.csel_v2->baCSourceId,
4893 iot->u.csel_v2->bNrInPins, info);
4896 case UDESCSUB_AC_CLOCK_MUL:
4898 p_id = &iot->u.cmul_v2->bCSourceId;
4902 uaudio20_mixer_find_clocks_sub(root,
4903 &iot->u.cmul_v2->bCSourceId,
4907 case UDESCSUB_AC_CLOCK_SRC:
4909 id = iot->u.csrc_v2->bClockId;
4911 switch (info->is_input) {
4913 info->bit_output[id / 8] |= (1 << (id % 8));
4916 info->bit_input[id / 8] |= (1 << (id % 8));
4930 uaudio_mixer_find_outputs_sub(struct uaudio_terminal_node *root, uint8_t id,
4931 uint8_t n_id, struct uaudio_search_result *info)
4933 struct uaudio_terminal_node *iot = (root + id);
4938 if ((j != id) && ((root + j)->u.desc) &&
4939 ((root + j)->u.desc->bDescriptorSubtype == UDESCSUB_AC_OUTPUT)) {
4942 * "j" (output) <--- virtual wire <--- "id" (input)
4944 * if "j" has "id" on the input, then "id" have "j" on
4945 * the output, because they are connected:
4947 if ((root + j)->usr.bit_input[id / 8] & (1 << (id % 8))) {
4948 iot->usr.bit_output[j / 8] |= (1 << (j % 8));
4955 uaudio_mixer_fill_info(struct uaudio_softc *sc,
4956 struct usb_device *udev, void *desc)
4958 const struct usb_audio_control_descriptor *acdp;
4959 struct usb_config_descriptor *cd = usbd_get_config_descriptor(udev);
4960 const struct usb_descriptor *dp;
4961 const struct usb_audio_unit *au;
4962 struct uaudio_terminal_node *iot = NULL;
4964 uint8_t ID_max = 0; /* inclusive */
4967 desc = usb_desc_foreach(cd, desc);
4970 DPRINTF("no Audio Control header\n");
4975 if ((acdp->bLength < sizeof(*acdp)) ||
4976 (acdp->bDescriptorType != UDESC_CS_INTERFACE) ||
4977 (acdp->bDescriptorSubtype != UDESCSUB_AC_HEADER)) {
4978 DPRINTF("invalid Audio Control header\n");
4981 /* "wTotalLen" is allowed to be corrupt */
4982 wTotalLen = UGETW(acdp->wTotalLength) - acdp->bLength;
4984 /* get USB audio revision */
4985 sc->sc_audio_rev = UGETW(acdp->bcdADC);
4987 DPRINTFN(3, "found AC header, vers=%03x, len=%d\n",
4988 sc->sc_audio_rev, wTotalLen);
4990 iot = malloc(sizeof(struct uaudio_terminal_node) * 256, M_TEMP,
4994 DPRINTF("no memory!\n");
4997 while ((desc = usb_desc_foreach(cd, desc))) {
5001 if (dp->bLength > wTotalLen) {
5004 wTotalLen -= dp->bLength;
5007 if (sc->sc_audio_rev >= UAUDIO_VERSION_30)
5009 else if (sc->sc_audio_rev >= UAUDIO_VERSION_20)
5010 au = uaudio20_mixer_verify_desc(dp, 0);
5012 au = uaudio_mixer_verify_desc(dp, 0);
5015 iot[au->bUnitId].u.desc = (const void *)au;
5016 if (au->bUnitId > ID_max)
5017 ID_max = au->bUnitId;
5021 DPRINTF("Maximum ID=%d\n", ID_max);
5024 * determine sourcing inputs for
5025 * all nodes in the tree:
5029 if (sc->sc_audio_rev >= UAUDIO_VERSION_30) {
5031 } else if (sc->sc_audio_rev >= UAUDIO_VERSION_20) {
5032 uaudio20_mixer_find_inputs_sub(iot,
5033 &i, 1, &((iot + i)->usr));
5035 sc->sc_mixer_clocks.is_input = 255;
5036 sc->sc_mixer_clocks.recurse_level = 0;
5038 uaudio20_mixer_find_clocks_sub(iot,
5039 &i, 1, &sc->sc_mixer_clocks);
5041 uaudio_mixer_find_inputs_sub(iot,
5042 &i, 1, &((iot + i)->usr));
5047 * determine outputs for
5048 * all nodes in the tree:
5052 uaudio_mixer_find_outputs_sub(iot,
5053 i, ID_max, &((iot + i)->usr));
5056 /* set "id_max" and "root" */
5060 (iot + i)->usr.id_max = ID_max;
5061 (iot + i)->root = iot;
5065 * Scan the config to create a linked list of "mixer" nodes:
5075 DPRINTFN(11, "id=%d subtype=%d\n",
5076 i, dp->bDescriptorSubtype);
5078 if (sc->sc_audio_rev >= UAUDIO_VERSION_30) {
5080 } else if (sc->sc_audio_rev >= UAUDIO_VERSION_20) {
5082 switch (dp->bDescriptorSubtype) {
5083 case UDESCSUB_AC_HEADER:
5084 DPRINTF("unexpected AC header\n");
5087 case UDESCSUB_AC_INPUT:
5088 case UDESCSUB_AC_OUTPUT:
5089 case UDESCSUB_AC_PROCESSING_V2:
5090 case UDESCSUB_AC_EXTENSION_V2:
5091 case UDESCSUB_AC_EFFECT:
5092 case UDESCSUB_AC_CLOCK_SRC:
5093 case UDESCSUB_AC_CLOCK_SEL:
5094 case UDESCSUB_AC_CLOCK_MUL:
5095 case UDESCSUB_AC_SAMPLE_RT:
5098 case UDESCSUB_AC_MIXER:
5099 uaudio20_mixer_add_mixer(sc, iot, i);
5102 case UDESCSUB_AC_SELECTOR:
5103 uaudio20_mixer_add_selector(sc, iot, i);
5106 case UDESCSUB_AC_FEATURE:
5107 uaudio20_mixer_add_feature(sc, iot, i);
5111 DPRINTF("bad AC desc subtype=0x%02x\n",
5112 dp->bDescriptorSubtype);
5118 switch (dp->bDescriptorSubtype) {
5119 case UDESCSUB_AC_HEADER:
5120 DPRINTF("unexpected AC header\n");
5123 case UDESCSUB_AC_INPUT:
5124 case UDESCSUB_AC_OUTPUT:
5127 case UDESCSUB_AC_MIXER:
5128 uaudio_mixer_add_mixer(sc, iot, i);
5131 case UDESCSUB_AC_SELECTOR:
5132 uaudio_mixer_add_selector(sc, iot, i);
5135 case UDESCSUB_AC_FEATURE:
5136 uaudio_mixer_add_feature(sc, iot, i);
5139 case UDESCSUB_AC_PROCESSING:
5140 uaudio_mixer_add_processing(sc, iot, i);
5143 case UDESCSUB_AC_EXTENSION:
5144 uaudio_mixer_add_extension(sc, iot, i);
5148 DPRINTF("bad AC desc subtype=0x%02x\n",
5149 dp->bDescriptorSubtype);
5160 uaudio_mixer_get(struct usb_device *udev, uint16_t audio_rev,
5161 uint8_t what, struct uaudio_mixer_node *mc)
5163 struct usb_device_request req;
5165 uint8_t data[2 + (2 * 3)];
5168 if (mc->wValue[0] == -1)
5171 if (audio_rev >= UAUDIO_VERSION_30)
5173 else if (audio_rev >= UAUDIO_VERSION_20) {
5174 if (what == GET_CUR) {
5175 req.bRequest = UA20_CS_CUR;
5176 USETW(req.wLength, 2);
5178 req.bRequest = UA20_CS_RANGE;
5179 USETW(req.wLength, 8);
5182 uint16_t len = MIX_SIZE(mc->type);
5184 req.bRequest = what;
5185 USETW(req.wLength, len);
5188 req.bmRequestType = UT_READ_CLASS_INTERFACE;
5189 USETW(req.wValue, mc->wValue[0]);
5190 USETW(req.wIndex, mc->wIndex);
5192 memset(data, 0, sizeof(data));
5194 err = usbd_do_request(udev, NULL, &req, data);
5196 DPRINTF("err=%s\n", usbd_errstr(err));
5200 if (audio_rev >= UAUDIO_VERSION_30) {
5202 } else if (audio_rev >= UAUDIO_VERSION_20) {
5205 val = (data[0] | (data[1] << 8));
5208 val = (data[2] | (data[3] << 8));
5211 val = (data[4] | (data[5] << 8));
5214 val = (data[6] | (data[7] << 8));
5221 val = (data[0] | (data[1] << 8));
5224 if (what == GET_CUR || what == GET_MIN || what == GET_MAX)
5225 val = uaudio_mixer_signext(mc->type, val);
5227 DPRINTFN(3, "val=%d\n", val);
5233 uaudio_mixer_write_cfg_callback(struct usb_xfer *xfer, usb_error_t error)
5235 struct usb_device_request req;
5236 struct uaudio_softc *sc = usbd_xfer_softc(xfer);
5237 struct uaudio_mixer_node *mc = sc->sc_mixer_curr;
5238 struct usb_page_cache *pc;
5247 switch (USB_GET_STATE(xfer)) {
5248 case USB_ST_TRANSFERRED:
5254 mc = sc->sc_mixer_root;
5255 sc->sc_mixer_curr = mc;
5256 sc->sc_mixer_chan = 0;
5260 while (sc->sc_mixer_chan < mc->nchan) {
5262 chan = sc->sc_mixer_chan;
5264 sc->sc_mixer_chan++;
5266 update = ((mc->update[chan / 8] & (1 << (chan % 8))) &&
5267 (mc->wValue[chan] != -1));
5269 mc->update[chan / 8] &= ~(1 << (chan % 8));
5273 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
5274 USETW(req.wValue, mc->wValue[chan]);
5275 USETW(req.wIndex, mc->wIndex);
5277 if (sc->sc_audio_rev >= UAUDIO_VERSION_30) {
5279 } else if (sc->sc_audio_rev >= UAUDIO_VERSION_20) {
5281 req.bRequest = UA20_CS_CUR;
5282 USETW(req.wLength, len);
5284 len = MIX_SIZE(mc->type);
5285 req.bRequest = SET_CUR;
5286 USETW(req.wLength, len);
5289 buf[0] = (mc->wData[chan] & 0xFF);
5290 buf[1] = (mc->wData[chan] >> 8) & 0xFF;
5292 pc = usbd_xfer_get_frame(xfer, 0);
5293 usbd_copy_in(pc, 0, &req, sizeof(req));
5294 pc = usbd_xfer_get_frame(xfer, 1);
5295 usbd_copy_in(pc, 0, buf, len);
5297 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
5298 usbd_xfer_set_frame_len(xfer, 1, len);
5299 usbd_xfer_set_frames(xfer, len ? 2 : 1);
5300 usbd_transfer_submit(xfer);
5306 sc->sc_mixer_curr = mc;
5307 sc->sc_mixer_chan = 0;
5315 default: /* Error */
5316 DPRINTF("error=%s\n", usbd_errstr(error));
5317 if (error == USB_ERR_CANCELLED) {
5318 /* do nothing - we are detaching */
5321 goto tr_transferred;
5326 uaudio_set_speed(struct usb_device *udev, uint8_t endpt, uint32_t speed)
5328 struct usb_device_request req;
5331 DPRINTFN(6, "endpt=%d speed=%u\n", endpt, speed);
5333 req.bmRequestType = UT_WRITE_CLASS_ENDPOINT;
5334 req.bRequest = SET_CUR;
5335 USETW2(req.wValue, SAMPLING_FREQ_CONTROL, 0);
5336 USETW(req.wIndex, endpt);
5337 USETW(req.wLength, 3);
5339 data[1] = speed >> 8;
5340 data[2] = speed >> 16;
5342 return (usbd_do_request(udev, NULL, &req, data));
5346 uaudio20_set_speed(struct usb_device *udev, uint8_t iface_no,
5347 uint8_t clockid, uint32_t speed)
5349 struct usb_device_request req;
5352 DPRINTFN(6, "ifaceno=%d clockid=%d speed=%u\n",
5353 iface_no, clockid, speed);
5355 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
5356 req.bRequest = UA20_CS_CUR;
5357 USETW2(req.wValue, UA20_CS_SAM_FREQ_CONTROL, 0);
5358 USETW2(req.wIndex, clockid, iface_no);
5359 USETW(req.wLength, 4);
5361 data[1] = speed >> 8;
5362 data[2] = speed >> 16;
5363 data[3] = speed >> 24;
5365 return (usbd_do_request(udev, NULL, &req, data));
5369 uaudio_mixer_signext(uint8_t type, int val)
5371 if (!MIX_UNSIGNED(type)) {
5372 if (MIX_SIZE(type) == 2) {
5382 uaudio_mixer_bsd2value(struct uaudio_mixer_node *mc, int32_t val)
5384 if (mc->type == MIX_ON_OFF) {
5386 } else if (mc->type == MIX_SELECTOR) {
5387 if ((val < mc->minval) ||
5388 (val > mc->maxval)) {
5393 /* compute actual volume */
5394 val = (val * mc->mul) / 255;
5396 /* add lower offset */
5397 val = val + mc->minval;
5399 /* make sure we don't write a value out of range */
5400 if (val > mc->maxval)
5402 else if (val < mc->minval)
5406 DPRINTFN(6, "type=0x%03x val=%d min=%d max=%d val=%d\n",
5407 mc->type, val, mc->minval, mc->maxval, val);
5412 uaudio_mixer_ctl_set(struct uaudio_softc *sc, struct uaudio_mixer_node *mc,
5413 uint8_t chan, int32_t val)
5415 val = uaudio_mixer_bsd2value(mc, val);
5417 mc->update[chan / 8] |= (1 << (chan % 8));
5418 mc->wData[chan] = val;
5420 /* start the transfer, if not already started */
5422 usbd_transfer_start(sc->sc_mixer_xfer[0]);
5426 uaudio_mixer_init(struct uaudio_softc *sc)
5428 struct uaudio_mixer_node *mc;
5431 for (mc = sc->sc_mixer_root; mc;
5434 if (mc->ctl != SOUND_MIXER_NRDEVICES) {
5436 * Set device mask bits. See
5437 * /usr/include/machine/soundcard.h
5439 sc->sc_mix_info |= (1 << mc->ctl);
5441 if ((mc->ctl == SOUND_MIXER_NRDEVICES) &&
5442 (mc->type == MIX_SELECTOR)) {
5444 for (i = mc->minval; (i > 0) && (i <= mc->maxval); i++) {
5445 if (mc->slctrtype[i - 1] == SOUND_MIXER_NRDEVICES) {
5448 sc->sc_recsrc_info |= 1 << mc->slctrtype[i - 1];
5455 uaudio_mixer_init_sub(struct uaudio_softc *sc, struct snd_mixer *m)
5459 sc->sc_mixer_lock = mixer_get_lock(m);
5460 sc->sc_mixer_dev = m;
5462 if (usbd_transfer_setup(sc->sc_udev, &sc->sc_mixer_iface_index,
5463 sc->sc_mixer_xfer, uaudio_mixer_config, 1, sc,
5464 sc->sc_mixer_lock)) {
5465 DPRINTFN(0, "could not allocate USB "
5466 "transfer for audio mixer!\n");
5469 if (!(sc->sc_mix_info & SOUND_MASK_VOLUME)) {
5470 mix_setparentchild(m, SOUND_MIXER_VOLUME, SOUND_MASK_PCM);
5471 mix_setrealdev(m, SOUND_MIXER_VOLUME, SOUND_MIXER_NONE);
5473 mix_setdevs(m, sc->sc_mix_info);
5474 mix_setrecdevs(m, sc->sc_recsrc_info);
5479 uaudio_mixer_uninit_sub(struct uaudio_softc *sc)
5483 usbd_transfer_unsetup(sc->sc_mixer_xfer, 1);
5485 sc->sc_mixer_lock = NULL;
5491 uaudio_mixer_set(struct uaudio_softc *sc, unsigned type,
5492 unsigned left, unsigned right)
5494 struct uaudio_mixer_node *mc;
5497 for (mc = sc->sc_mixer_root; mc != NULL; mc = mc->next) {
5499 if (mc->ctl == type) {
5500 for (chan = 0; chan < mc->nchan; chan++) {
5501 uaudio_mixer_ctl_set(sc, mc, chan,
5502 (int)((chan == 0 ? left : right) *
5510 uaudio_mixer_setrecsrc(struct uaudio_softc *sc, uint32_t src)
5512 struct uaudio_mixer_node *mc;
5517 for (mc = sc->sc_mixer_root; mc;
5520 if ((mc->ctl == SOUND_MIXER_NRDEVICES) &&
5521 (mc->type == MIX_SELECTOR)) {
5523 /* compute selector mask */
5526 for (i = mc->minval; (i > 0) && (i <= mc->maxval); i++) {
5527 mask |= (1 << mc->slctrtype[i - 1]);
5534 /* find the first set bit */
5535 temp = (-temp) & temp;
5541 for (i = mc->minval; (i > 0) && (i <= mc->maxval); i++) {
5542 if (temp != (1 << mc->slctrtype[i - 1])) {
5545 uaudio_mixer_ctl_set(sc, mc, 0, i);
5553 /*========================================================================*
5554 * MIDI support routines
5555 *========================================================================*/
5558 umidi_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
5560 struct umidi_chan *chan = usbd_xfer_softc(xfer);
5561 struct umidi_sub_chan *sub;
5562 struct usb_page_cache *pc;
5569 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
5571 switch (USB_GET_STATE(xfer)) {
5572 case USB_ST_TRANSFERRED:
5574 DPRINTF("actlen=%d bytes\n", actlen);
5577 pc = usbd_xfer_get_frame(xfer, 0);
5579 while (actlen >= 4) {
5581 /* copy out the MIDI data */
5582 usbd_copy_out(pc, pos, buf, 4);
5583 /* command length */
5584 cmd_len = umidi_cmd_to_len[buf[0] & 0xF];
5588 * Lookup sub-channel. The index is range
5591 sub = &chan->sub[cn];
5593 if ((cmd_len != 0) && (cn < chan->max_emb_jack) &&
5594 (sub->read_open != 0)) {
5596 /* Send data to the application */
5597 usb_fifo_put_data_linear(
5598 sub->fifo.fp[USB_FIFO_RX],
5599 buf + 1, cmd_len, 1);
5608 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
5609 usbd_transfer_submit(xfer);
5613 DPRINTF("error=%s\n", usbd_errstr(error));
5615 if (error != USB_ERR_CANCELLED) {
5616 /* try to clear stall first */
5617 usbd_xfer_set_stall(xfer);
5625 * The following statemachine, that converts MIDI commands to
5626 * USB MIDI packets, derives from Linux's usbmidi.c, which
5627 * was written by "Clemens Ladisch":
5631 * Else: Command is complete
5634 umidi_convert_to_usb(struct umidi_sub_chan *sub, uint8_t cn, uint8_t b)
5636 uint8_t p0 = (cn << 4);
5639 sub->temp_0[0] = p0 | 0x0f;
5643 sub->temp_cmd = sub->temp_0;
5646 } else if (b >= 0xf0) {
5648 case 0xf0: /* system exclusive begin */
5650 sub->state = UMIDI_ST_SYSEX_1;
5652 case 0xf1: /* MIDI time code */
5653 case 0xf3: /* song select */
5655 sub->state = UMIDI_ST_1PARAM;
5657 case 0xf2: /* song position pointer */
5659 sub->state = UMIDI_ST_2PARAM_1;
5661 case 0xf4: /* unknown */
5662 case 0xf5: /* unknown */
5663 sub->state = UMIDI_ST_UNKNOWN;
5665 case 0xf6: /* tune request */
5666 sub->temp_1[0] = p0 | 0x05;
5667 sub->temp_1[1] = 0xf6;
5670 sub->temp_cmd = sub->temp_1;
5671 sub->state = UMIDI_ST_UNKNOWN;
5674 case 0xf7: /* system exclusive end */
5675 switch (sub->state) {
5676 case UMIDI_ST_SYSEX_0:
5677 sub->temp_1[0] = p0 | 0x05;
5678 sub->temp_1[1] = 0xf7;
5681 sub->temp_cmd = sub->temp_1;
5682 sub->state = UMIDI_ST_UNKNOWN;
5684 case UMIDI_ST_SYSEX_1:
5685 sub->temp_1[0] = p0 | 0x06;
5686 sub->temp_1[2] = 0xf7;
5688 sub->temp_cmd = sub->temp_1;
5689 sub->state = UMIDI_ST_UNKNOWN;
5691 case UMIDI_ST_SYSEX_2:
5692 sub->temp_1[0] = p0 | 0x07;
5693 sub->temp_1[3] = 0xf7;
5694 sub->temp_cmd = sub->temp_1;
5695 sub->state = UMIDI_ST_UNKNOWN;
5698 sub->state = UMIDI_ST_UNKNOWN;
5701 } else if (b >= 0x80) {
5703 if ((b >= 0xc0) && (b <= 0xdf)) {
5704 sub->state = UMIDI_ST_1PARAM;
5706 sub->state = UMIDI_ST_2PARAM_1;
5708 } else { /* b < 0x80 */
5709 switch (sub->state) {
5710 case UMIDI_ST_1PARAM:
5711 if (sub->temp_1[1] < 0xf0) {
5712 p0 |= sub->temp_1[1] >> 4;
5715 sub->state = UMIDI_ST_UNKNOWN;
5717 sub->temp_1[0] = p0;
5720 sub->temp_cmd = sub->temp_1;
5722 case UMIDI_ST_2PARAM_1:
5724 sub->state = UMIDI_ST_2PARAM_2;
5726 case UMIDI_ST_2PARAM_2:
5727 if (sub->temp_1[1] < 0xf0) {
5728 p0 |= sub->temp_1[1] >> 4;
5729 sub->state = UMIDI_ST_2PARAM_1;
5732 sub->state = UMIDI_ST_UNKNOWN;
5734 sub->temp_1[0] = p0;
5736 sub->temp_cmd = sub->temp_1;
5738 case UMIDI_ST_SYSEX_0:
5740 sub->state = UMIDI_ST_SYSEX_1;
5742 case UMIDI_ST_SYSEX_1:
5744 sub->state = UMIDI_ST_SYSEX_2;
5746 case UMIDI_ST_SYSEX_2:
5747 sub->temp_1[0] = p0 | 0x04;
5749 sub->temp_cmd = sub->temp_1;
5750 sub->state = UMIDI_ST_SYSEX_0;
5760 umidi_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
5762 struct umidi_chan *chan = usbd_xfer_softc(xfer);
5763 struct umidi_sub_chan *sub;
5764 struct usb_page_cache *pc;
5768 uint8_t start_cable;
5772 usbd_xfer_status(xfer, &len, NULL, NULL, NULL);
5775 * NOTE: Some MIDI devices only accept 4 bytes of data per
5776 * short terminated USB transfer.
5778 switch (USB_GET_STATE(xfer)) {
5779 case USB_ST_TRANSFERRED:
5780 DPRINTF("actlen=%d bytes\n", len);
5786 nframes = 0; /* reset */
5787 start_cable = chan->curr_cable;
5789 pc = usbd_xfer_get_frame(xfer, 0);
5793 /* round robin de-queueing */
5795 sub = &chan->sub[chan->curr_cable];
5797 if (sub->write_open) {
5798 usb_fifo_get_data_linear(sub->fifo.fp[USB_FIFO_TX],
5799 &buf, 1, &actlen, 0);
5808 DPRINTF("byte=0x%02x from FIFO %u\n", buf,
5809 (unsigned int)chan->curr_cable);
5811 if (umidi_convert_to_usb(sub, chan->curr_cable, buf)) {
5813 DPRINTF("sub=0x%02x 0x%02x 0x%02x 0x%02x\n",
5814 sub->temp_cmd[0], sub->temp_cmd[1],
5815 sub->temp_cmd[2], sub->temp_cmd[3]);
5817 usbd_copy_in(pc, nframes * 4, sub->temp_cmd, 4);
5821 if ((nframes >= UMIDI_TX_FRAMES) || (chan->single_command != 0))
5829 if (chan->curr_cable >= chan->max_emb_jack)
5830 chan->curr_cable = 0;
5832 if (chan->curr_cable == start_cable) {
5840 DPRINTF("Transferring %d frames\n", (int)nframes);
5841 usbd_xfer_set_frame_len(xfer, 0, 4 * nframes);
5842 usbd_transfer_submit(xfer);
5846 default: /* Error */
5848 DPRINTF("error=%s\n", usbd_errstr(error));
5850 if (error != USB_ERR_CANCELLED) {
5851 /* try to clear stall first */
5852 usbd_xfer_set_stall(xfer);
5859 static struct umidi_sub_chan *
5860 umidi_sub_by_fifo(struct usb_fifo *fifo)
5862 struct umidi_chan *chan = usb_fifo_softc(fifo);
5863 struct umidi_sub_chan *sub;
5866 for (n = 0; n < UMIDI_EMB_JACK_MAX; n++) {
5867 sub = &chan->sub[n];
5868 if ((sub->fifo.fp[USB_FIFO_RX] == fifo) ||
5869 (sub->fifo.fp[USB_FIFO_TX] == fifo)) {
5874 panic("%s:%d cannot find usb_fifo!\n",
5875 __FILE__, __LINE__);
5881 umidi_start_read(struct usb_fifo *fifo)
5883 struct umidi_chan *chan = usb_fifo_softc(fifo);
5885 usbd_transfer_start(chan->xfer[UMIDI_RX_TRANSFER]);
5889 umidi_stop_read(struct usb_fifo *fifo)
5891 struct umidi_chan *chan = usb_fifo_softc(fifo);
5892 struct umidi_sub_chan *sub = umidi_sub_by_fifo(fifo);
5898 if (--(chan->read_open_refcount) == 0) {
5900 * XXX don't stop the read transfer here, hence that causes
5901 * problems with some MIDI adapters
5903 DPRINTF("(stopping read transfer)\n");
5908 umidi_start_write(struct usb_fifo *fifo)
5910 struct umidi_chan *chan = usb_fifo_softc(fifo);
5912 if (chan->xfer[UMIDI_TX_TRANSFER] == NULL) {
5917 usb_fifo_get_data_linear(fifo, buf, 1, &actlen, 0);
5918 } while (actlen > 0);
5920 usbd_transfer_start(chan->xfer[UMIDI_TX_TRANSFER]);
5925 umidi_stop_write(struct usb_fifo *fifo)
5927 struct umidi_chan *chan = usb_fifo_softc(fifo);
5928 struct umidi_sub_chan *sub = umidi_sub_by_fifo(fifo);
5932 sub->write_open = 0;
5934 if (--(chan->write_open_refcount) == 0) {
5935 DPRINTF("(stopping write transfer)\n");
5936 usbd_transfer_stop(chan->xfer[UMIDI_TX_TRANSFER]);
5941 umidi_open(struct usb_fifo *fifo, int fflags)
5943 struct umidi_chan *chan = usb_fifo_softc(fifo);
5944 struct umidi_sub_chan *sub = umidi_sub_by_fifo(fifo);
5946 if (fflags & FREAD) {
5947 if (usb_fifo_alloc_buffer(fifo, 4, (1024 / 4))) {
5950 mtx_lock(&chan->mtx);
5951 chan->read_open_refcount++;
5953 mtx_unlock(&chan->mtx);
5955 if (fflags & FWRITE) {
5956 if (usb_fifo_alloc_buffer(fifo, 32, (1024 / 32))) {
5959 /* clear stall first */
5960 mtx_lock(&chan->mtx);
5961 chan->write_open_refcount++;
5962 sub->write_open = 1;
5965 sub->state = UMIDI_ST_UNKNOWN;
5966 mtx_unlock(&chan->mtx);
5968 return (0); /* success */
5972 umidi_close(struct usb_fifo *fifo, int fflags)
5974 if (fflags & FREAD) {
5975 usb_fifo_free_buffer(fifo);
5977 if (fflags & FWRITE) {
5978 usb_fifo_free_buffer(fifo);
5984 umidi_ioctl(struct usb_fifo *fifo, u_long cmd, void *data,
5991 umidi_init(device_t dev)
5993 struct uaudio_softc *sc = device_get_softc(dev);
5994 struct umidi_chan *chan = &sc->sc_midi_chan;
5996 mtx_init(&chan->mtx, "umidi lock", NULL, MTX_DEF | MTX_RECURSE);
5999 static struct usb_fifo_methods umidi_fifo_methods = {
6000 .f_start_read = &umidi_start_read,
6001 .f_start_write = &umidi_start_write,
6002 .f_stop_read = &umidi_stop_read,
6003 .f_stop_write = &umidi_stop_write,
6004 .f_open = &umidi_open,
6005 .f_close = &umidi_close,
6006 .f_ioctl = &umidi_ioctl,
6007 .basename[0] = "umidi",
6011 umidi_probe(device_t dev)
6013 struct uaudio_softc *sc = device_get_softc(dev);
6014 struct usb_attach_arg *uaa = device_get_ivars(dev);
6015 struct umidi_chan *chan = &sc->sc_midi_chan;
6016 struct umidi_sub_chan *sub;
6017 int unit = device_get_unit(dev);
6021 if (usb_test_quirk(uaa, UQ_SINGLE_CMD_MIDI))
6022 chan->single_command = 1;
6024 if (usbd_set_alt_interface_index(sc->sc_udev, chan->iface_index,
6025 chan->iface_alt_index)) {
6026 DPRINTF("setting of alternate index failed!\n");
6029 usbd_set_parent_iface(sc->sc_udev, chan->iface_index,
6030 sc->sc_mixer_iface_index);
6032 error = usbd_transfer_setup(uaa->device, &chan->iface_index,
6033 chan->xfer, umidi_config, UMIDI_N_TRANSFER,
6036 DPRINTF("error=%s\n", usbd_errstr(error));
6039 if (chan->xfer[UMIDI_TX_TRANSFER] == NULL &&
6040 chan->xfer[UMIDI_RX_TRANSFER] == NULL) {
6041 DPRINTF("no BULK or INTERRUPT MIDI endpoint(s) found\n");
6046 * Some USB MIDI device makers couldn't resist using
6047 * wMaxPacketSize = 4 for RX and TX BULK endpoints, although
6048 * that size is an unsupported value for FULL speed BULK
6049 * endpoints. The same applies to some HIGH speed MIDI devices
6050 * which are using a wMaxPacketSize different from 512 bytes.
6052 * Refer to section 5.8.3 in USB 2.0 PDF: Cite: "All Host
6053 * Controllers are required to have support for 8-, 16-, 32-,
6054 * and 64-byte maximum packet sizes for full-speed bulk
6055 * endpoints and 512 bytes for high-speed bulk endpoints."
6057 if (chan->xfer[UMIDI_TX_TRANSFER] != NULL &&
6058 usbd_xfer_maxp_was_clamped(chan->xfer[UMIDI_TX_TRANSFER]))
6059 chan->single_command = 1;
6061 if (chan->single_command != 0)
6062 device_printf(dev, "Single command MIDI quirk enabled\n");
6064 if ((chan->max_emb_jack == 0) ||
6065 (chan->max_emb_jack > UMIDI_EMB_JACK_MAX)) {
6066 chan->max_emb_jack = UMIDI_EMB_JACK_MAX;
6069 for (n = 0; n < chan->max_emb_jack; n++) {
6071 sub = &chan->sub[n];
6073 error = usb_fifo_attach(sc->sc_udev, chan, &chan->mtx,
6074 &umidi_fifo_methods, &sub->fifo, unit, n,
6076 UID_ROOT, GID_OPERATOR, 0644);
6082 mtx_lock(&chan->mtx);
6085 * NOTE: At least one device will not work properly unless the
6086 * BULK IN pipe is open all the time. This might have to do
6087 * about that the internal queues of the device overflow if we
6088 * don't read them regularly.
6090 usbd_transfer_start(chan->xfer[UMIDI_RX_TRANSFER]);
6092 mtx_unlock(&chan->mtx);
6094 return (0); /* success */
6097 return (ENXIO); /* failure */
6101 umidi_detach(device_t dev)
6103 struct uaudio_softc *sc = device_get_softc(dev);
6104 struct umidi_chan *chan = &sc->sc_midi_chan;
6107 for (n = 0; n < UMIDI_EMB_JACK_MAX; n++)
6108 usb_fifo_detach(&chan->sub[n].fifo);
6110 mtx_lock(&chan->mtx);
6112 usbd_transfer_stop(chan->xfer[UMIDI_RX_TRANSFER]);
6114 mtx_unlock(&chan->mtx);
6116 usbd_transfer_unsetup(chan->xfer, UMIDI_N_TRANSFER);
6118 mtx_destroy(&chan->mtx);
6124 uaudio_hid_rx_callback(struct usb_xfer *xfer, usb_error_t error)
6126 struct uaudio_softc *sc = usbd_xfer_softc(xfer);
6127 const uint8_t *buffer = usbd_xfer_get_frame_buffer(xfer, 0);
6128 struct snd_mixer *m;
6132 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
6134 switch (USB_GET_STATE(xfer)) {
6135 case USB_ST_TRANSFERRED:
6136 DPRINTF("actlen=%d\n", actlen);
6139 (sc->sc_hid.flags & UAUDIO_HID_HAS_ID)) {
6147 m = sc->sc_mixer_dev;
6149 if ((sc->sc_hid.flags & UAUDIO_HID_HAS_MUTE) &&
6150 (sc->sc_hid.mute_id == id) &&
6151 hid_get_data(buffer, actlen,
6152 &sc->sc_hid.mute_loc)) {
6154 DPRINTF("Mute toggle\n");
6156 mixer_hwvol_mute_locked(m);
6159 if ((sc->sc_hid.flags & UAUDIO_HID_HAS_VOLUME_UP) &&
6160 (sc->sc_hid.volume_up_id == id) &&
6161 hid_get_data(buffer, actlen,
6162 &sc->sc_hid.volume_up_loc)) {
6164 DPRINTF("Volume Up\n");
6166 mixer_hwvol_step_locked(m, 1, 1);
6169 if ((sc->sc_hid.flags & UAUDIO_HID_HAS_VOLUME_DOWN) &&
6170 (sc->sc_hid.volume_down_id == id) &&
6171 hid_get_data(buffer, actlen,
6172 &sc->sc_hid.volume_down_loc)) {
6174 DPRINTF("Volume Down\n");
6176 mixer_hwvol_step_locked(m, -1, -1);
6181 /* check if we can put more data into the FIFO */
6182 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
6183 usbd_transfer_submit(xfer);
6186 default: /* Error */
6188 DPRINTF("error=%s\n", usbd_errstr(error));
6190 if (error != USB_ERR_CANCELLED) {
6191 /* try to clear stall first */
6192 usbd_xfer_set_stall(xfer);
6200 uaudio_hid_probe(struct uaudio_softc *sc,
6201 struct usb_attach_arg *uaa)
6209 if (!(sc->sc_hid.flags & UAUDIO_HID_VALID))
6212 if (sc->sc_mixer_lock == NULL)
6215 /* Get HID descriptor */
6216 error = usbd_req_get_hid_desc(uaa->device, NULL, &d_ptr,
6217 &d_len, M_TEMP, sc->sc_hid.iface_index);
6220 DPRINTF("error reading report description\n");
6224 /* check if there is an ID byte */
6225 hid_report_size(d_ptr, d_len, hid_input, &id);
6228 sc->sc_hid.flags |= UAUDIO_HID_HAS_ID;
6230 if (hid_locate(d_ptr, d_len,
6231 HID_USAGE2(HUP_CONSUMER, 0xE9 /* Volume Increment */),
6232 hid_input, 0, &sc->sc_hid.volume_up_loc, &flags,
6233 &sc->sc_hid.volume_up_id)) {
6234 if (flags & HIO_VARIABLE)
6235 sc->sc_hid.flags |= UAUDIO_HID_HAS_VOLUME_UP;
6236 DPRINTFN(1, "Found Volume Up key\n");
6239 if (hid_locate(d_ptr, d_len,
6240 HID_USAGE2(HUP_CONSUMER, 0xEA /* Volume Decrement */),
6241 hid_input, 0, &sc->sc_hid.volume_down_loc, &flags,
6242 &sc->sc_hid.volume_down_id)) {
6243 if (flags & HIO_VARIABLE)
6244 sc->sc_hid.flags |= UAUDIO_HID_HAS_VOLUME_DOWN;
6245 DPRINTFN(1, "Found Volume Down key\n");
6248 if (hid_locate(d_ptr, d_len,
6249 HID_USAGE2(HUP_CONSUMER, 0xE2 /* Mute */),
6250 hid_input, 0, &sc->sc_hid.mute_loc, &flags,
6251 &sc->sc_hid.mute_id)) {
6252 if (flags & HIO_VARIABLE)
6253 sc->sc_hid.flags |= UAUDIO_HID_HAS_MUTE;
6254 DPRINTFN(1, "Found Mute key\n");
6257 free(d_ptr, M_TEMP);
6259 if (!(sc->sc_hid.flags & (UAUDIO_HID_HAS_VOLUME_UP |
6260 UAUDIO_HID_HAS_VOLUME_DOWN |
6261 UAUDIO_HID_HAS_MUTE))) {
6262 DPRINTFN(1, "Did not find any volume related keys\n");
6266 /* prevent the uhid driver from attaching */
6267 usbd_set_parent_iface(uaa->device, sc->sc_hid.iface_index,
6268 sc->sc_mixer_iface_index);
6270 /* allocate USB transfers */
6271 error = usbd_transfer_setup(uaa->device, &sc->sc_hid.iface_index,
6272 sc->sc_hid.xfer, uaudio_hid_config, UAUDIO_HID_N_TRANSFER,
6273 sc, sc->sc_mixer_lock);
6275 DPRINTF("error=%s\n", usbd_errstr(error));
6282 uaudio_hid_detach(struct uaudio_softc *sc)
6284 usbd_transfer_unsetup(sc->sc_hid.xfer, UAUDIO_HID_N_TRANSFER);
6287 DRIVER_MODULE_ORDERED(uaudio, uhub, uaudio_driver, uaudio_devclass, NULL, 0, SI_ORDER_ANY);
6288 MODULE_DEPEND(uaudio, usb, 1, 1, 1);
6289 MODULE_DEPEND(uaudio, sound, SOUND_MINVER, SOUND_PREFVER, SOUND_MAXVER);
6290 MODULE_VERSION(uaudio, 1);