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 */
100 static int uaudio_debug = 0;
102 static SYSCTL_NODE(_hw_usb, OID_AUTO, uaudio, CTLFLAG_RW, 0, "USB uaudio");
104 SYSCTL_INT(_hw_usb_uaudio, OID_AUTO, debug, CTLFLAG_RW,
105 &uaudio_debug, 0, "uaudio debug level");
107 TUNABLE_INT("hw.usb.uaudio.default_rate", &uaudio_default_rate);
108 SYSCTL_INT(_hw_usb_uaudio, OID_AUTO, default_rate, CTLFLAG_RW,
109 &uaudio_default_rate, 0, "uaudio default sample rate");
111 TUNABLE_INT("hw.usb.uaudio.default_bits", &uaudio_default_bits);
112 SYSCTL_INT(_hw_usb_uaudio, OID_AUTO, default_bits, CTLFLAG_RW,
113 &uaudio_default_bits, 0, "uaudio default sample bits");
115 TUNABLE_INT("hw.usb.uaudio.default_channels", &uaudio_default_channels);
116 SYSCTL_INT(_hw_usb_uaudio, OID_AUTO, default_channels, CTLFLAG_RW,
117 &uaudio_default_channels, 0, "uaudio default sample channels");
120 #define UAUDIO_NFRAMES 64 /* must be factor of 8 due HS-USB */
121 #define UAUDIO_NCHANBUFS 2 /* number of outstanding request */
122 #define UAUDIO_RECURSE_LIMIT 255 /* rounds */
124 #define MAKE_WORD(h,l) (((h) << 8) | (l))
125 #define BIT_TEST(bm,bno) (((bm)[(bno) / 8] >> (7 - ((bno) % 8))) & 1)
126 #define UAUDIO_MAX_CHAN(x) (x)
127 #define MIX(sc) ((sc)->sc_mixer_node)
130 const struct usb_audio_streaming_interface_descriptor *v1;
131 const struct usb_audio20_streaming_interface_descriptor *v2;
135 const struct usb_audio_streaming_type1_descriptor *v1;
136 const struct usb_audio20_streaming_type1_descriptor *v2;
140 const struct usb_audio_streaming_endpoint_descriptor *v1;
141 const struct usb_audio20_streaming_endpoint_descriptor *v2;
144 struct uaudio_mixer_node {
149 #define MIX_MAX_CHAN 16
150 int32_t wValue[MIX_MAX_CHAN]; /* using nchan */
154 int wData[MIX_MAX_CHAN]; /* using nchan */
157 uint8_t update[(MIX_MAX_CHAN + 7) / 8];
161 #define MIX_SIGNED_16 2
162 #define MIX_UNSIGNED_16 3
163 #define MIX_SIGNED_8 4
164 #define MIX_SELECTOR 5
165 #define MIX_UNKNOWN 6
166 #define MIX_SIZE(n) ((((n) == MIX_SIGNED_16) || \
167 ((n) == MIX_UNSIGNED_16)) ? 2 : 1)
168 #define MIX_UNSIGNED(n) ((n) == MIX_UNSIGNED_16)
170 #define MAX_SELECTOR_INPUT_PIN 256
171 uint8_t slctrtype[MAX_SELECTOR_INPUT_PIN];
177 struct uaudio_mixer_node *next;
180 struct uaudio_configure_msg {
181 struct usb_proc_msg hdr;
182 struct uaudio_softc *sc;
185 #define CHAN_MAX_ALT 24
187 struct uaudio_chan_alt {
188 union uaudio_asf1d p_asf1d;
189 union uaudio_sed p_sed;
190 const usb_endpoint_descriptor_audio_t *p_ed1;
191 const struct uaudio_format *p_fmt;
192 const struct usb_config *usb_cfg;
193 uint32_t sample_rate; /* in Hz */
194 uint16_t sample_size;
196 uint8_t iface_alt_index;
201 struct pcmchan_caps pcm_cap; /* capabilities */
202 struct uaudio_chan_alt usb_alt[CHAN_MAX_ALT];
203 struct snd_dbuf *pcm_buf;
204 struct mtx *pcm_mtx; /* lock protecting this structure */
205 struct uaudio_softc *priv_sc;
206 struct pcm_channel *pcm_ch;
207 struct usb_xfer *xfer[UAUDIO_NCHANBUFS + 1];
209 uint8_t *buf; /* pointer to buffer */
210 uint8_t *start; /* upper layer buffer start */
211 uint8_t *end; /* upper layer buffer end */
212 uint8_t *cur; /* current position in upper layer
215 uint32_t intr_frames; /* in units */
216 uint32_t frames_per_second;
218 uint32_t sample_curr;
221 uint32_t pcm_format[2];
223 uint16_t bytes_per_frame[2];
229 #define CHAN_OP_NONE 0
230 #define CHAN_OP_START 1
231 #define CHAN_OP_STOP 2
232 #define CHAN_OP_DRAIN 3
234 uint8_t last_sync_time;
235 uint8_t last_sync_state;
236 #define UAUDIO_SYNC_NONE 0
237 #define UAUDIO_SYNC_MORE 1
238 #define UAUDIO_SYNC_LESS 2
241 #define UMIDI_CABLES_MAX 16 /* units */
242 #define UMIDI_TX_FRAMES 256 /* units */
243 #define UMIDI_TX_BUFFER (UMIDI_TX_FRAMES * 4) /* bytes */
251 struct umidi_sub_chan {
252 struct usb_fifo_sc fifo;
257 #define UMIDI_ST_UNKNOWN 0 /* scan for command */
258 #define UMIDI_ST_1PARAM 1
259 #define UMIDI_ST_2PARAM_1 2
260 #define UMIDI_ST_2PARAM_2 3
261 #define UMIDI_ST_SYSEX_0 4
262 #define UMIDI_ST_SYSEX_1 5
263 #define UMIDI_ST_SYSEX_2 6
266 uint8_t write_open:1;
272 struct umidi_sub_chan sub[UMIDI_CABLES_MAX];
275 struct usb_xfer *xfer[UMIDI_N_TRANSFER];
278 uint8_t iface_alt_index;
280 uint8_t read_open_refcount;
281 uint8_t write_open_refcount;
286 uint8_t single_command;
289 struct uaudio_search_result {
290 uint8_t bit_input[(256 + 7) / 8];
291 uint8_t bit_output[(256 + 7) / 8];
292 uint8_t recurse_level;
298 UAUDIO_HID_RX_TRANSFER,
299 UAUDIO_HID_N_TRANSFER,
303 struct usb_xfer *xfer[UAUDIO_HID_N_TRANSFER];
304 struct hid_location volume_up_loc;
305 struct hid_location volume_down_loc;
306 struct hid_location mute_loc;
308 #define UAUDIO_HID_VALID 0x0001
309 #define UAUDIO_HID_HAS_ID 0x0002
310 #define UAUDIO_HID_HAS_VOLUME_UP 0x0004
311 #define UAUDIO_HID_HAS_VOLUME_DOWN 0x0008
312 #define UAUDIO_HID_HAS_MUTE 0x0010
314 uint8_t volume_up_id;
315 uint8_t volume_down_id;
319 struct uaudio_softc {
320 struct sbuf sc_sndstat;
321 struct sndcard_func sc_sndcard_func;
322 struct uaudio_chan sc_rec_chan;
323 struct uaudio_chan sc_play_chan;
324 struct umidi_chan sc_midi_chan;
325 struct uaudio_hid sc_hid;
326 struct uaudio_search_result sc_mixer_clocks;
327 struct uaudio_mixer_node sc_mixer_node;
328 struct uaudio_configure_msg sc_config_msg[2];
330 struct mtx *sc_mixer_lock;
331 struct snd_mixer *sc_mixer_dev;
332 struct usb_device *sc_udev;
333 struct usb_xfer *sc_mixer_xfer[1];
334 struct uaudio_mixer_node *sc_mixer_root;
335 struct uaudio_mixer_node *sc_mixer_curr;
337 uint32_t sc_mix_info;
338 uint32_t sc_recsrc_info;
340 uint16_t sc_audio_rev;
341 uint16_t sc_mixer_count;
343 uint8_t sc_sndstat_valid;
344 uint8_t sc_mixer_iface_index;
345 uint8_t sc_mixer_iface_no;
346 uint8_t sc_mixer_chan;
347 uint8_t sc_pcm_registered:1;
348 uint8_t sc_mixer_init:1;
349 uint8_t sc_uq_audio_swap_lr:1;
350 uint8_t sc_uq_au_inp_async:1;
351 uint8_t sc_uq_au_no_xu:1;
352 uint8_t sc_uq_bad_adc:1;
353 uint8_t sc_uq_au_vendor_class:1;
356 struct uaudio_terminal_node {
358 const struct usb_descriptor *desc;
359 const struct usb_audio_input_terminal *it_v1;
360 const struct usb_audio_output_terminal *ot_v1;
361 const struct usb_audio_mixer_unit_0 *mu_v1;
362 const struct usb_audio_selector_unit *su_v1;
363 const struct usb_audio_feature_unit *fu_v1;
364 const struct usb_audio_processing_unit_0 *pu_v1;
365 const struct usb_audio_extension_unit_0 *eu_v1;
366 const struct usb_audio20_clock_source_unit *csrc_v2;
367 const struct usb_audio20_clock_selector_unit_0 *csel_v2;
368 const struct usb_audio20_clock_multiplier_unit *cmul_v2;
369 const struct usb_audio20_input_terminal *it_v2;
370 const struct usb_audio20_output_terminal *ot_v2;
371 const struct usb_audio20_mixer_unit_0 *mu_v2;
372 const struct usb_audio20_selector_unit *su_v2;
373 const struct usb_audio20_feature_unit *fu_v2;
374 const struct usb_audio20_sample_rate_unit *ru_v2;
375 const struct usb_audio20_processing_unit_0 *pu_v2;
376 const struct usb_audio20_extension_unit_0 *eu_v2;
377 const struct usb_audio20_effect_unit *ef_v2;
379 struct uaudio_search_result usr;
380 struct uaudio_terminal_node *root;
383 struct uaudio_format {
386 uint32_t freebsd_fmt;
387 const char *description;
390 static const struct uaudio_format uaudio10_formats[] = {
392 {UA_FMT_PCM8, 8, AFMT_U8, "8-bit U-LE PCM"},
393 {UA_FMT_PCM8, 16, AFMT_U16_LE, "16-bit U-LE PCM"},
394 {UA_FMT_PCM8, 24, AFMT_U24_LE, "24-bit U-LE PCM"},
395 {UA_FMT_PCM8, 32, AFMT_U32_LE, "32-bit U-LE PCM"},
397 {UA_FMT_PCM, 8, AFMT_S8, "8-bit S-LE PCM"},
398 {UA_FMT_PCM, 16, AFMT_S16_LE, "16-bit S-LE PCM"},
399 {UA_FMT_PCM, 24, AFMT_S24_LE, "24-bit S-LE PCM"},
400 {UA_FMT_PCM, 32, AFMT_S32_LE, "32-bit S-LE PCM"},
402 {UA_FMT_ALAW, 8, AFMT_A_LAW, "8-bit A-Law"},
403 {UA_FMT_MULAW, 8, AFMT_MU_LAW, "8-bit mu-Law"},
408 static const struct uaudio_format uaudio20_formats[] = {
410 {UA20_FMT_PCM, 8, AFMT_S8, "8-bit S-LE PCM"},
411 {UA20_FMT_PCM, 16, AFMT_S16_LE, "16-bit S-LE PCM"},
412 {UA20_FMT_PCM, 24, AFMT_S24_LE, "24-bit S-LE PCM"},
413 {UA20_FMT_PCM, 32, AFMT_S32_LE, "32-bit S-LE PCM"},
415 {UA20_FMT_PCM8, 8, AFMT_U8, "8-bit U-LE PCM"},
416 {UA20_FMT_PCM8, 16, AFMT_U16_LE, "16-bit U-LE PCM"},
417 {UA20_FMT_PCM8, 24, AFMT_U24_LE, "24-bit U-LE PCM"},
418 {UA20_FMT_PCM8, 32, AFMT_U32_LE, "32-bit U-LE PCM"},
420 {UA20_FMT_ALAW, 8, AFMT_A_LAW, "8-bit A-Law"},
421 {UA20_FMT_MULAW, 8, AFMT_MU_LAW, "8-bit mu-Law"},
430 #define UAC_NCLASSES 4
433 static const char *uac_names[] = {
434 "outputs", "inputs", "equalization", "record"
441 static device_probe_t uaudio_probe;
442 static device_attach_t uaudio_attach;
443 static device_detach_t uaudio_detach;
445 static usb_callback_t uaudio_chan_play_callback;
446 static usb_callback_t uaudio_chan_play_sync_callback;
447 static usb_callback_t uaudio_chan_record_callback;
448 static usb_callback_t uaudio_chan_record_sync_callback;
449 static usb_callback_t uaudio_mixer_write_cfg_callback;
450 static usb_callback_t umidi_bulk_read_callback;
451 static usb_callback_t umidi_bulk_write_callback;
452 static usb_callback_t uaudio_hid_rx_callback;
454 static usb_proc_callback_t uaudio_configure_msg;
456 /* ==== USB mixer ==== */
458 static int uaudio_mixer_sysctl_handler(SYSCTL_HANDLER_ARGS);
459 static void uaudio_mixer_ctl_free(struct uaudio_softc *);
460 static void uaudio_mixer_register_sysctl(struct uaudio_softc *, device_t);
461 static void uaudio_mixer_reload_all(struct uaudio_softc *);
462 static void uaudio_mixer_controls_create_ftu(struct uaudio_softc *);
464 /* ==== USB audio v1.0 ==== */
466 static void uaudio_mixer_add_mixer(struct uaudio_softc *,
467 const struct uaudio_terminal_node *, int);
468 static void uaudio_mixer_add_selector(struct uaudio_softc *,
469 const struct uaudio_terminal_node *, int);
470 static uint32_t uaudio_mixer_feature_get_bmaControls(
471 const struct usb_audio_feature_unit *, uint8_t);
472 static void uaudio_mixer_add_feature(struct uaudio_softc *,
473 const struct uaudio_terminal_node *, int);
474 static void uaudio_mixer_add_processing_updown(struct uaudio_softc *,
475 const struct uaudio_terminal_node *, int);
476 static void uaudio_mixer_add_processing(struct uaudio_softc *,
477 const struct uaudio_terminal_node *, int);
478 static void uaudio_mixer_add_extension(struct uaudio_softc *,
479 const struct uaudio_terminal_node *, int);
480 static struct usb_audio_cluster uaudio_mixer_get_cluster(uint8_t,
481 const struct uaudio_terminal_node *);
482 static uint16_t uaudio_mixer_determine_class(const struct uaudio_terminal_node *,
483 struct uaudio_mixer_node *);
484 static uint16_t uaudio_mixer_feature_name(const struct uaudio_terminal_node *,
485 struct uaudio_mixer_node *);
486 static void uaudio_mixer_find_inputs_sub(struct uaudio_terminal_node *,
487 const uint8_t *, uint8_t, struct uaudio_search_result *);
488 static const void *uaudio_mixer_verify_desc(const void *, uint32_t);
489 static usb_error_t uaudio_set_speed(struct usb_device *, uint8_t, uint32_t);
490 static int uaudio_mixer_get(struct usb_device *, uint16_t, uint8_t,
491 struct uaudio_mixer_node *);
493 /* ==== USB audio v2.0 ==== */
495 static void uaudio20_mixer_add_mixer(struct uaudio_softc *,
496 const struct uaudio_terminal_node *, int);
497 static void uaudio20_mixer_add_selector(struct uaudio_softc *,
498 const struct uaudio_terminal_node *, int);
499 static void uaudio20_mixer_add_feature(struct uaudio_softc *,
500 const struct uaudio_terminal_node *, int);
501 static struct usb_audio20_cluster uaudio20_mixer_get_cluster(uint8_t,
502 const struct uaudio_terminal_node *);
503 static uint16_t uaudio20_mixer_determine_class(const struct uaudio_terminal_node *,
504 struct uaudio_mixer_node *);
505 static uint16_t uaudio20_mixer_feature_name(const struct uaudio_terminal_node *,
506 struct uaudio_mixer_node *);
507 static void uaudio20_mixer_find_inputs_sub(struct uaudio_terminal_node *,
508 const uint8_t *, uint8_t, struct uaudio_search_result *);
509 static const void *uaudio20_mixer_verify_desc(const void *, uint32_t);
510 static usb_error_t uaudio20_set_speed(struct usb_device *, uint8_t,
513 /* USB audio v1.0 and v2.0 */
515 static void uaudio_chan_fill_info_sub(struct uaudio_softc *,
516 struct usb_device *, uint32_t, uint8_t, uint8_t);
517 static void uaudio_chan_fill_info(struct uaudio_softc *,
518 struct usb_device *);
519 static void uaudio_mixer_add_ctl_sub(struct uaudio_softc *,
520 struct uaudio_mixer_node *);
521 static void uaudio_mixer_add_ctl(struct uaudio_softc *,
522 struct uaudio_mixer_node *);
523 static void uaudio_mixer_fill_info(struct uaudio_softc *,
524 struct usb_device *, void *);
525 static void uaudio_mixer_ctl_set(struct uaudio_softc *,
526 struct uaudio_mixer_node *, uint8_t, int32_t val);
527 static int uaudio_mixer_signext(uint8_t, int);
528 static int uaudio_mixer_bsd2value(struct uaudio_mixer_node *, int32_t val);
529 static void uaudio_mixer_init(struct uaudio_softc *);
530 static const struct uaudio_terminal_node *uaudio_mixer_get_input(
531 const struct uaudio_terminal_node *, uint8_t);
532 static const struct uaudio_terminal_node *uaudio_mixer_get_output(
533 const struct uaudio_terminal_node *, uint8_t);
534 static void uaudio_mixer_find_outputs_sub(struct uaudio_terminal_node *,
535 uint8_t, uint8_t, struct uaudio_search_result *);
536 static uint8_t umidi_convert_to_usb(struct umidi_sub_chan *, uint8_t, uint8_t);
537 static struct umidi_sub_chan *umidi_sub_by_fifo(struct usb_fifo *);
538 static void umidi_start_read(struct usb_fifo *);
539 static void umidi_stop_read(struct usb_fifo *);
540 static void umidi_start_write(struct usb_fifo *);
541 static void umidi_stop_write(struct usb_fifo *);
542 static int umidi_open(struct usb_fifo *, int);
543 static int umidi_ioctl(struct usb_fifo *, u_long cmd, void *, int);
544 static void umidi_close(struct usb_fifo *, int);
545 static void umidi_init(device_t dev);
546 static int umidi_probe(device_t dev);
547 static int umidi_detach(device_t dev);
548 static int uaudio_hid_probe(struct uaudio_softc *sc,
549 struct usb_attach_arg *uaa);
550 static void uaudio_hid_detach(struct uaudio_softc *sc);
553 static void uaudio_chan_dump_ep_desc(
554 const usb_endpoint_descriptor_audio_t *);
557 static const struct usb_config
558 uaudio_cfg_record[UAUDIO_NCHANBUFS + 1] = {
560 .type = UE_ISOCHRONOUS,
561 .endpoint = UE_ADDR_ANY,
562 .direction = UE_DIR_IN,
563 .bufsize = 0, /* use "wMaxPacketSize * frames" */
564 .frames = UAUDIO_NFRAMES,
565 .flags = {.short_xfer_ok = 1,},
566 .callback = &uaudio_chan_record_callback,
570 .type = UE_ISOCHRONOUS,
571 .endpoint = UE_ADDR_ANY,
572 .direction = UE_DIR_IN,
573 .bufsize = 0, /* use "wMaxPacketSize * frames" */
574 .frames = UAUDIO_NFRAMES,
575 .flags = {.short_xfer_ok = 1,},
576 .callback = &uaudio_chan_record_callback,
580 .type = UE_ISOCHRONOUS,
581 .endpoint = UE_ADDR_ANY,
582 .direction = UE_DIR_OUT,
583 .bufsize = 0, /* use "wMaxPacketSize * frames" */
585 .flags = {.no_pipe_ok = 1,.short_xfer_ok = 1,},
586 .callback = &uaudio_chan_record_sync_callback,
590 static const struct usb_config
591 uaudio_cfg_play[UAUDIO_NCHANBUFS + 1] = {
593 .type = UE_ISOCHRONOUS,
594 .endpoint = UE_ADDR_ANY,
595 .direction = UE_DIR_OUT,
596 .bufsize = 0, /* use "wMaxPacketSize * frames" */
597 .frames = UAUDIO_NFRAMES,
598 .flags = {.short_xfer_ok = 1,},
599 .callback = &uaudio_chan_play_callback,
603 .type = UE_ISOCHRONOUS,
604 .endpoint = UE_ADDR_ANY,
605 .direction = UE_DIR_OUT,
606 .bufsize = 0, /* use "wMaxPacketSize * frames" */
607 .frames = UAUDIO_NFRAMES,
608 .flags = {.short_xfer_ok = 1,},
609 .callback = &uaudio_chan_play_callback,
613 .type = UE_ISOCHRONOUS,
614 .endpoint = UE_ADDR_ANY,
615 .direction = UE_DIR_IN,
616 .bufsize = 0, /* use "wMaxPacketSize * frames" */
618 .flags = {.no_pipe_ok = 1,.short_xfer_ok = 1,},
619 .callback = &uaudio_chan_play_sync_callback,
623 static const struct usb_config
624 uaudio_mixer_config[1] = {
627 .endpoint = 0x00, /* Control pipe */
628 .direction = UE_DIR_ANY,
629 .bufsize = (sizeof(struct usb_device_request) + 4),
630 .callback = &uaudio_mixer_write_cfg_callback,
631 .timeout = 1000, /* 1 second */
636 uint8_t umidi_cmd_to_len[16] = {
637 [0x0] = 0, /* reserved */
638 [0x1] = 0, /* reserved */
639 [0x2] = 2, /* bytes */
640 [0x3] = 3, /* bytes */
641 [0x4] = 3, /* bytes */
642 [0x5] = 1, /* bytes */
643 [0x6] = 2, /* bytes */
644 [0x7] = 3, /* bytes */
645 [0x8] = 3, /* bytes */
646 [0x9] = 3, /* bytes */
647 [0xA] = 3, /* bytes */
648 [0xB] = 3, /* bytes */
649 [0xC] = 2, /* bytes */
650 [0xD] = 2, /* bytes */
651 [0xE] = 3, /* bytes */
652 [0xF] = 1, /* bytes */
655 static const struct usb_config
656 umidi_config[UMIDI_N_TRANSFER] = {
657 [UMIDI_TX_TRANSFER] = {
659 .endpoint = UE_ADDR_ANY,
660 .direction = UE_DIR_OUT,
661 .bufsize = UMIDI_TX_BUFFER,
662 .callback = &umidi_bulk_write_callback,
665 [UMIDI_RX_TRANSFER] = {
667 .endpoint = UE_ADDR_ANY,
668 .direction = UE_DIR_IN,
669 .bufsize = 4, /* bytes */
670 .flags = {.short_xfer_ok = 1,.proxy_buffer = 1,},
671 .callback = &umidi_bulk_read_callback,
675 static const struct usb_config
676 uaudio_hid_config[UAUDIO_HID_N_TRANSFER] = {
677 [UAUDIO_HID_RX_TRANSFER] = {
678 .type = UE_INTERRUPT,
679 .endpoint = UE_ADDR_ANY,
680 .direction = UE_DIR_IN,
681 .bufsize = 0, /* use wMaxPacketSize */
682 .flags = {.short_xfer_ok = 1,},
683 .callback = &uaudio_hid_rx_callback,
687 static devclass_t uaudio_devclass;
689 static device_method_t uaudio_methods[] = {
690 DEVMETHOD(device_probe, uaudio_probe),
691 DEVMETHOD(device_attach, uaudio_attach),
692 DEVMETHOD(device_detach, uaudio_detach),
693 DEVMETHOD(device_suspend, bus_generic_suspend),
694 DEVMETHOD(device_resume, bus_generic_resume),
695 DEVMETHOD(device_shutdown, bus_generic_shutdown),
700 static driver_t uaudio_driver = {
702 .methods = uaudio_methods,
703 .size = sizeof(struct uaudio_softc),
706 /* The following table is derived from Linux's quirks-table.h */
707 static const STRUCT_USB_HOST_ID uaudio_vendor_midi[] = {
708 { USB_VPI(USB_VENDOR_YAMAHA, 0x1000, 0) }, /* UX256 */
709 { USB_VPI(USB_VENDOR_YAMAHA, 0x1001, 0) }, /* MU1000 */
710 { USB_VPI(USB_VENDOR_YAMAHA, 0x1002, 0) }, /* MU2000 */
711 { USB_VPI(USB_VENDOR_YAMAHA, 0x1003, 0) }, /* MU500 */
712 { USB_VPI(USB_VENDOR_YAMAHA, 0x1004, 3) }, /* UW500 */
713 { USB_VPI(USB_VENDOR_YAMAHA, 0x1005, 0) }, /* MOTIF6 */
714 { USB_VPI(USB_VENDOR_YAMAHA, 0x1006, 0) }, /* MOTIF7 */
715 { USB_VPI(USB_VENDOR_YAMAHA, 0x1007, 0) }, /* MOTIF8 */
716 { USB_VPI(USB_VENDOR_YAMAHA, 0x1008, 0) }, /* UX96 */
717 { USB_VPI(USB_VENDOR_YAMAHA, 0x1009, 0) }, /* UX16 */
718 { USB_VPI(USB_VENDOR_YAMAHA, 0x100a, 3) }, /* EOS BX */
719 { USB_VPI(USB_VENDOR_YAMAHA, 0x100c, 0) }, /* UC-MX */
720 { USB_VPI(USB_VENDOR_YAMAHA, 0x100d, 0) }, /* UC-KX */
721 { USB_VPI(USB_VENDOR_YAMAHA, 0x100e, 0) }, /* S08 */
722 { USB_VPI(USB_VENDOR_YAMAHA, 0x100f, 0) }, /* CLP-150 */
723 { USB_VPI(USB_VENDOR_YAMAHA, 0x1010, 0) }, /* CLP-170 */
724 { USB_VPI(USB_VENDOR_YAMAHA, 0x1011, 0) }, /* P-250 */
725 { USB_VPI(USB_VENDOR_YAMAHA, 0x1012, 0) }, /* TYROS */
726 { USB_VPI(USB_VENDOR_YAMAHA, 0x1013, 0) }, /* PF-500 */
727 { USB_VPI(USB_VENDOR_YAMAHA, 0x1014, 0) }, /* S90 */
728 { USB_VPI(USB_VENDOR_YAMAHA, 0x1015, 0) }, /* MOTIF-R */
729 { USB_VPI(USB_VENDOR_YAMAHA, 0x1016, 0) }, /* MDP-5 */
730 { USB_VPI(USB_VENDOR_YAMAHA, 0x1017, 0) }, /* CVP-204 */
731 { USB_VPI(USB_VENDOR_YAMAHA, 0x1018, 0) }, /* CVP-206 */
732 { USB_VPI(USB_VENDOR_YAMAHA, 0x1019, 0) }, /* CVP-208 */
733 { USB_VPI(USB_VENDOR_YAMAHA, 0x101a, 0) }, /* CVP-210 */
734 { USB_VPI(USB_VENDOR_YAMAHA, 0x101b, 0) }, /* PSR-1100 */
735 { USB_VPI(USB_VENDOR_YAMAHA, 0x101c, 0) }, /* PSR-2100 */
736 { USB_VPI(USB_VENDOR_YAMAHA, 0x101d, 0) }, /* CLP-175 */
737 { USB_VPI(USB_VENDOR_YAMAHA, 0x101e, 0) }, /* PSR-K1 */
738 { USB_VPI(USB_VENDOR_YAMAHA, 0x101f, 0) }, /* EZ-J24 */
739 { USB_VPI(USB_VENDOR_YAMAHA, 0x1020, 0) }, /* EZ-250i */
740 { USB_VPI(USB_VENDOR_YAMAHA, 0x1021, 0) }, /* MOTIF ES 6 */
741 { USB_VPI(USB_VENDOR_YAMAHA, 0x1022, 0) }, /* MOTIF ES 7 */
742 { USB_VPI(USB_VENDOR_YAMAHA, 0x1023, 0) }, /* MOTIF ES 8 */
743 { USB_VPI(USB_VENDOR_YAMAHA, 0x1024, 0) }, /* CVP-301 */
744 { USB_VPI(USB_VENDOR_YAMAHA, 0x1025, 0) }, /* CVP-303 */
745 { USB_VPI(USB_VENDOR_YAMAHA, 0x1026, 0) }, /* CVP-305 */
746 { USB_VPI(USB_VENDOR_YAMAHA, 0x1027, 0) }, /* CVP-307 */
747 { USB_VPI(USB_VENDOR_YAMAHA, 0x1028, 0) }, /* CVP-309 */
748 { USB_VPI(USB_VENDOR_YAMAHA, 0x1029, 0) }, /* CVP-309GP */
749 { USB_VPI(USB_VENDOR_YAMAHA, 0x102a, 0) }, /* PSR-1500 */
750 { USB_VPI(USB_VENDOR_YAMAHA, 0x102b, 0) }, /* PSR-3000 */
751 { USB_VPI(USB_VENDOR_YAMAHA, 0x102e, 0) }, /* ELS-01/01C */
752 { USB_VPI(USB_VENDOR_YAMAHA, 0x1030, 0) }, /* PSR-295/293 */
753 { USB_VPI(USB_VENDOR_YAMAHA, 0x1031, 0) }, /* DGX-205/203 */
754 { USB_VPI(USB_VENDOR_YAMAHA, 0x1032, 0) }, /* DGX-305 */
755 { USB_VPI(USB_VENDOR_YAMAHA, 0x1033, 0) }, /* DGX-505 */
756 { USB_VPI(USB_VENDOR_YAMAHA, 0x1034, 0) }, /* NULL */
757 { USB_VPI(USB_VENDOR_YAMAHA, 0x1035, 0) }, /* NULL */
758 { USB_VPI(USB_VENDOR_YAMAHA, 0x1036, 0) }, /* NULL */
759 { USB_VPI(USB_VENDOR_YAMAHA, 0x1037, 0) }, /* NULL */
760 { USB_VPI(USB_VENDOR_YAMAHA, 0x1038, 0) }, /* NULL */
761 { USB_VPI(USB_VENDOR_YAMAHA, 0x1039, 0) }, /* NULL */
762 { USB_VPI(USB_VENDOR_YAMAHA, 0x103a, 0) }, /* NULL */
763 { USB_VPI(USB_VENDOR_YAMAHA, 0x103b, 0) }, /* NULL */
764 { USB_VPI(USB_VENDOR_YAMAHA, 0x103c, 0) }, /* NULL */
765 { USB_VPI(USB_VENDOR_YAMAHA, 0x103d, 0) }, /* NULL */
766 { USB_VPI(USB_VENDOR_YAMAHA, 0x103e, 0) }, /* NULL */
767 { USB_VPI(USB_VENDOR_YAMAHA, 0x103f, 0) }, /* NULL */
768 { USB_VPI(USB_VENDOR_YAMAHA, 0x1040, 0) }, /* NULL */
769 { USB_VPI(USB_VENDOR_YAMAHA, 0x1041, 0) }, /* NULL */
770 { USB_VPI(USB_VENDOR_YAMAHA, 0x1042, 0) }, /* NULL */
771 { USB_VPI(USB_VENDOR_YAMAHA, 0x1043, 0) }, /* NULL */
772 { USB_VPI(USB_VENDOR_YAMAHA, 0x1044, 0) }, /* NULL */
773 { USB_VPI(USB_VENDOR_YAMAHA, 0x1045, 0) }, /* NULL */
774 { USB_VPI(USB_VENDOR_YAMAHA, 0x104e, 0) }, /* NULL */
775 { USB_VPI(USB_VENDOR_YAMAHA, 0x104f, 0) }, /* NULL */
776 { USB_VPI(USB_VENDOR_YAMAHA, 0x1050, 0) }, /* NULL */
777 { USB_VPI(USB_VENDOR_YAMAHA, 0x1051, 0) }, /* NULL */
778 { USB_VPI(USB_VENDOR_YAMAHA, 0x1052, 0) }, /* NULL */
779 { USB_VPI(USB_VENDOR_YAMAHA, 0x1053, 0) }, /* NULL */
780 { USB_VPI(USB_VENDOR_YAMAHA, 0x1054, 0) }, /* NULL */
781 { USB_VPI(USB_VENDOR_YAMAHA, 0x1055, 0) }, /* NULL */
782 { USB_VPI(USB_VENDOR_YAMAHA, 0x1056, 0) }, /* NULL */
783 { USB_VPI(USB_VENDOR_YAMAHA, 0x1057, 0) }, /* NULL */
784 { USB_VPI(USB_VENDOR_YAMAHA, 0x1058, 0) }, /* NULL */
785 { USB_VPI(USB_VENDOR_YAMAHA, 0x1059, 0) }, /* NULL */
786 { USB_VPI(USB_VENDOR_YAMAHA, 0x105a, 0) }, /* NULL */
787 { USB_VPI(USB_VENDOR_YAMAHA, 0x105b, 0) }, /* NULL */
788 { USB_VPI(USB_VENDOR_YAMAHA, 0x105c, 0) }, /* NULL */
789 { USB_VPI(USB_VENDOR_YAMAHA, 0x105d, 0) }, /* NULL */
790 { USB_VPI(USB_VENDOR_YAMAHA, 0x1503, 3) }, /* MOX6/MOX8 */
791 { USB_VPI(USB_VENDOR_YAMAHA, 0x2000, 0) }, /* DGP-7 */
792 { USB_VPI(USB_VENDOR_YAMAHA, 0x2001, 0) }, /* DGP-5 */
793 { USB_VPI(USB_VENDOR_YAMAHA, 0x2002, 0) }, /* NULL */
794 { USB_VPI(USB_VENDOR_YAMAHA, 0x2003, 0) }, /* NULL */
795 { USB_VPI(USB_VENDOR_YAMAHA, 0x5000, 0) }, /* CS1D */
796 { USB_VPI(USB_VENDOR_YAMAHA, 0x5001, 0) }, /* DSP1D */
797 { USB_VPI(USB_VENDOR_YAMAHA, 0x5002, 0) }, /* DME32 */
798 { USB_VPI(USB_VENDOR_YAMAHA, 0x5003, 0) }, /* DM2000 */
799 { USB_VPI(USB_VENDOR_YAMAHA, 0x5004, 0) }, /* 02R96 */
800 { USB_VPI(USB_VENDOR_YAMAHA, 0x5005, 0) }, /* ACU16-C */
801 { USB_VPI(USB_VENDOR_YAMAHA, 0x5006, 0) }, /* NHB32-C */
802 { USB_VPI(USB_VENDOR_YAMAHA, 0x5007, 0) }, /* DM1000 */
803 { USB_VPI(USB_VENDOR_YAMAHA, 0x5008, 0) }, /* 01V96 */
804 { USB_VPI(USB_VENDOR_YAMAHA, 0x5009, 0) }, /* SPX2000 */
805 { USB_VPI(USB_VENDOR_YAMAHA, 0x500a, 0) }, /* PM5D */
806 { USB_VPI(USB_VENDOR_YAMAHA, 0x500b, 0) }, /* DME64N */
807 { USB_VPI(USB_VENDOR_YAMAHA, 0x500c, 0) }, /* DME24N */
808 { USB_VPI(USB_VENDOR_YAMAHA, 0x500d, 0) }, /* NULL */
809 { USB_VPI(USB_VENDOR_YAMAHA, 0x500e, 0) }, /* NULL */
810 { USB_VPI(USB_VENDOR_YAMAHA, 0x500f, 0) }, /* NULL */
811 { USB_VPI(USB_VENDOR_YAMAHA, 0x7000, 0) }, /* DTX */
812 { USB_VPI(USB_VENDOR_YAMAHA, 0x7010, 0) }, /* UB99 */
815 static const STRUCT_USB_HOST_ID __used uaudio_devs[] = {
816 /* Generic USB audio class match */
817 {USB_IFACE_CLASS(UICLASS_AUDIO),
818 USB_IFACE_SUBCLASS(UISUBCLASS_AUDIOCONTROL),},
819 /* Generic USB MIDI class match */
820 {USB_IFACE_CLASS(UICLASS_AUDIO),
821 USB_IFACE_SUBCLASS(UISUBCLASS_MIDISTREAM),},
825 uaudio_probe(device_t dev)
827 struct usb_attach_arg *uaa = device_get_ivars(dev);
829 if (uaa->usb_mode != USB_MODE_HOST)
832 /* lookup non-standard device(s) */
834 if (usbd_lookup_id_by_uaa(uaudio_vendor_midi,
835 sizeof(uaudio_vendor_midi), uaa) == 0) {
836 return (BUS_PROBE_SPECIFIC);
839 if (uaa->info.bInterfaceClass != UICLASS_AUDIO) {
840 if (uaa->info.bInterfaceClass != UICLASS_VENDOR ||
841 usb_test_quirk(uaa, UQ_AU_VENDOR_CLASS) == 0)
845 /* check for AUDIO control interface */
847 if (uaa->info.bInterfaceSubClass == UISUBCLASS_AUDIOCONTROL) {
848 if (usb_test_quirk(uaa, UQ_BAD_AUDIO))
851 return (BUS_PROBE_GENERIC);
854 /* check for MIDI stream */
856 if (uaa->info.bInterfaceSubClass == UISUBCLASS_MIDISTREAM) {
857 if (usb_test_quirk(uaa, UQ_BAD_MIDI))
860 return (BUS_PROBE_GENERIC);
866 uaudio_attach(device_t dev)
868 struct usb_attach_arg *uaa = device_get_ivars(dev);
869 struct uaudio_softc *sc = device_get_softc(dev);
870 struct usb_interface_descriptor *id;
874 sc->sc_play_chan.priv_sc = sc;
875 sc->sc_rec_chan.priv_sc = sc;
876 sc->sc_udev = uaa->device;
877 sc->sc_mixer_iface_index = uaa->info.bIfaceIndex;
878 sc->sc_mixer_iface_no = uaa->info.bIfaceNum;
879 sc->sc_config_msg[0].hdr.pm_callback = &uaudio_configure_msg;
880 sc->sc_config_msg[0].sc = sc;
881 sc->sc_config_msg[1].hdr.pm_callback = &uaudio_configure_msg;
882 sc->sc_config_msg[1].sc = sc;
884 if (usb_test_quirk(uaa, UQ_AUDIO_SWAP_LR))
885 sc->sc_uq_audio_swap_lr = 1;
887 if (usb_test_quirk(uaa, UQ_AU_INP_ASYNC))
888 sc->sc_uq_au_inp_async = 1;
890 if (usb_test_quirk(uaa, UQ_AU_NO_XU))
891 sc->sc_uq_au_no_xu = 1;
893 if (usb_test_quirk(uaa, UQ_BAD_ADC))
894 sc->sc_uq_bad_adc = 1;
896 if (usb_test_quirk(uaa, UQ_AU_VENDOR_CLASS))
897 sc->sc_uq_au_vendor_class = 1;
901 device_set_usb_desc(dev);
903 id = usbd_get_interface_descriptor(uaa->iface);
905 /* must fill mixer info before channel info */
906 uaudio_mixer_fill_info(sc, uaa->device, id);
908 /* fill channel info */
909 uaudio_chan_fill_info(sc, uaa->device);
911 DPRINTF("audio rev %d.%02x\n",
912 sc->sc_audio_rev >> 8,
913 sc->sc_audio_rev & 0xff);
915 if (sc->sc_mixer_count == 0) {
916 if (uaa->info.idVendor == USB_VENDOR_MAUDIO &&
917 (uaa->info.idProduct == USB_PRODUCT_MAUDIO_FASTTRACKULTRA ||
918 uaa->info.idProduct == USB_PRODUCT_MAUDIO_FASTTRACKULTRA8R)) {
919 DPRINTF("Generating mixer descriptors\n");
920 uaudio_mixer_controls_create_ftu(sc);
924 DPRINTF("%d mixer controls\n",
927 if (sc->sc_play_chan.num_alt > 0) {
931 * Need to set a default alternate interface, else
932 * some USB audio devices might go into an infinte
933 * re-enumeration loop:
935 err = usbd_set_alt_interface_index(sc->sc_udev,
936 sc->sc_play_chan.usb_alt[0].iface_index,
937 sc->sc_play_chan.usb_alt[0].iface_alt_index);
939 DPRINTF("setting of alternate index failed: %s!\n",
942 for (x = 0; x != sc->sc_play_chan.num_alt; x++) {
943 device_printf(dev, "Play: %d Hz, %d ch, %s format, "
945 sc->sc_play_chan.usb_alt[x].sample_rate,
946 sc->sc_play_chan.usb_alt[x].channels,
947 sc->sc_play_chan.usb_alt[x].p_fmt->description);
950 device_printf(dev, "No playback.\n");
953 if (sc->sc_rec_chan.num_alt > 0) {
957 * Need to set a default alternate interface, else
958 * some USB audio devices might go into an infinte
959 * re-enumeration loop:
961 err = usbd_set_alt_interface_index(sc->sc_udev,
962 sc->sc_rec_chan.usb_alt[0].iface_index,
963 sc->sc_rec_chan.usb_alt[0].iface_alt_index);
965 DPRINTF("setting of alternate index failed: %s!\n",
968 for (x = 0; x != sc->sc_rec_chan.num_alt; x++) {
969 device_printf(dev, "Record: %d Hz, %d ch, %s format, "
971 sc->sc_rec_chan.usb_alt[x].sample_rate,
972 sc->sc_rec_chan.usb_alt[x].channels,
973 sc->sc_rec_chan.usb_alt[x].p_fmt->description);
976 device_printf(dev, "No recording.\n");
979 if (sc->sc_midi_chan.valid == 0) {
980 if (usbd_lookup_id_by_uaa(uaudio_vendor_midi,
981 sizeof(uaudio_vendor_midi), uaa) == 0) {
982 sc->sc_midi_chan.iface_index =
983 (uint8_t)uaa->driver_info;
984 sc->sc_midi_chan.iface_alt_index = 0;
985 sc->sc_midi_chan.valid = 1;
989 if (sc->sc_midi_chan.valid) {
991 if (umidi_probe(dev)) {
994 device_printf(dev, "MIDI sequencer.\n");
996 device_printf(dev, "No MIDI sequencer.\n");
999 DPRINTF("doing child attach\n");
1001 /* attach the children */
1003 sc->sc_sndcard_func.func = SCF_PCM;
1006 * Only attach a PCM device if we have a playback, recording
1007 * or mixer device present:
1009 if (sc->sc_play_chan.num_alt > 0 ||
1010 sc->sc_rec_chan.num_alt > 0 ||
1012 child = device_add_child(dev, "pcm", -1);
1014 if (child == NULL) {
1015 DPRINTF("out of memory\n");
1018 device_set_ivars(child, &sc->sc_sndcard_func);
1021 if (bus_generic_attach(dev)) {
1022 DPRINTF("child attach failed\n");
1026 if (uaudio_hid_probe(sc, uaa) == 0) {
1027 device_printf(dev, "HID volume keys found.\n");
1029 device_printf(dev, "No HID volume keys found.\n");
1032 /* reload all mixer settings */
1033 uaudio_mixer_reload_all(sc);
1035 return (0); /* success */
1043 uaudio_pcm_setflags(device_t dev, uint32_t flags)
1045 pcm_setflags(dev, pcm_getflags(dev) | flags);
1049 uaudio_attach_sub(device_t dev, kobj_class_t mixer_class, kobj_class_t chan_class)
1051 struct uaudio_softc *sc = device_get_softc(device_get_parent(dev));
1052 char status[SND_STATUSLEN];
1054 uaudio_mixer_init(sc);
1056 if (sc->sc_uq_audio_swap_lr) {
1057 DPRINTF("hardware has swapped left and right\n");
1058 /* uaudio_pcm_setflags(dev, SD_F_PSWAPLR); */
1060 if (!(sc->sc_mix_info & SOUND_MASK_PCM)) {
1062 DPRINTF("emulating master volume\n");
1065 * Emulate missing pcm mixer controller
1066 * through FEEDER_VOLUME
1068 uaudio_pcm_setflags(dev, SD_F_SOFTPCMVOL);
1070 if (mixer_init(dev, mixer_class, sc))
1072 sc->sc_mixer_init = 1;
1074 mixer_hwvol_init(dev);
1076 snprintf(status, sizeof(status), "at ? %s", PCM_KLDSTRING(snd_uaudio));
1078 if (pcm_register(dev, sc,
1079 (sc->sc_play_chan.num_alt > 0) ? 1 : 0,
1080 (sc->sc_rec_chan.num_alt > 0) ? 1 : 0)) {
1084 uaudio_pcm_setflags(dev, SD_F_MPSAFE);
1085 sc->sc_pcm_registered = 1;
1087 if (sc->sc_play_chan.num_alt > 0) {
1088 pcm_addchan(dev, PCMDIR_PLAY, chan_class, sc);
1090 if (sc->sc_rec_chan.num_alt > 0) {
1091 pcm_addchan(dev, PCMDIR_REC, chan_class, sc);
1093 pcm_setstatus(dev, status);
1095 uaudio_mixer_register_sysctl(sc, dev);
1097 return (0); /* success */
1100 uaudio_detach_sub(dev);
1105 uaudio_detach_sub(device_t dev)
1107 struct uaudio_softc *sc = device_get_softc(device_get_parent(dev));
1111 if (sc->sc_pcm_registered) {
1112 error = pcm_unregister(dev);
1114 if (sc->sc_mixer_init) {
1115 error = mixer_uninit(dev);
1120 device_printf(dev, "Waiting for sound application to exit!\n");
1121 usb_pause_mtx(NULL, 2 * hz);
1122 goto repeat; /* try again */
1124 return (0); /* success */
1128 uaudio_detach(device_t dev)
1130 struct uaudio_softc *sc = device_get_softc(dev);
1133 * Stop USB transfers early so that any audio applications
1134 * will time out and close opened /dev/dspX.Y device(s), if
1137 usb_proc_explore_lock(sc->sc_udev);
1138 sc->sc_play_chan.operation = CHAN_OP_DRAIN;
1139 sc->sc_rec_chan.operation = CHAN_OP_DRAIN;
1140 usb_proc_explore_mwait(sc->sc_udev,
1141 &sc->sc_config_msg[0], &sc->sc_config_msg[1]);
1142 usb_proc_explore_unlock(sc->sc_udev);
1144 usbd_transfer_unsetup(sc->sc_play_chan.xfer, UAUDIO_NCHANBUFS + 1);
1145 usbd_transfer_unsetup(sc->sc_rec_chan.xfer, UAUDIO_NCHANBUFS + 1);
1147 uaudio_hid_detach(sc);
1149 if (bus_generic_detach(dev) != 0) {
1150 DPRINTF("detach failed!\n");
1152 sbuf_delete(&sc->sc_sndstat);
1153 sc->sc_sndstat_valid = 0;
1157 /* free mixer data */
1159 uaudio_mixer_ctl_free(sc);
1165 uaudio_get_buffer_size(struct uaudio_chan *ch, uint8_t alt)
1167 struct uaudio_chan_alt *chan_alt = &ch->usb_alt[alt];
1168 /* We use 2 times 8ms of buffer */
1169 uint32_t buf_size = (((chan_alt->sample_rate * (UAUDIO_NFRAMES / 8)) +
1170 1000 - 1) / 1000) * chan_alt->sample_size;
1175 uaudio_configure_msg_sub(struct uaudio_softc *sc,
1176 struct uaudio_chan *chan, int dir)
1178 struct uaudio_chan_alt *chan_alt;
1187 if (chan->num_alt <= 0)
1192 usb_proc_explore_lock(sc->sc_udev);
1193 operation = chan->operation;
1194 chan->operation = CHAN_OP_NONE;
1195 usb_proc_explore_unlock(sc->sc_udev);
1197 mtx_lock(chan->pcm_mtx);
1198 if (chan->cur_alt != chan->set_alt)
1199 set_alt = chan->set_alt;
1201 set_alt = CHAN_MAX_ALT;
1202 mtx_unlock(chan->pcm_mtx);
1204 if (set_alt >= chan->num_alt)
1207 chan_alt = chan->usb_alt + set_alt;
1209 usbd_transfer_unsetup(chan->xfer, UAUDIO_NCHANBUFS + 1);
1211 err = usbd_set_alt_interface_index(sc->sc_udev,
1212 chan_alt->iface_index, chan_alt->iface_alt_index);
1214 DPRINTF("setting of alternate index failed: %s!\n",
1220 * Only set the sample rate if the channel reports that it
1221 * supports the frequency control.
1224 if (sc->sc_audio_rev >= UAUDIO_VERSION_30) {
1226 } else if (sc->sc_audio_rev >= UAUDIO_VERSION_20) {
1229 for (x = 0; x != 256; x++) {
1230 if (dir == PCMDIR_PLAY) {
1231 if (!(sc->sc_mixer_clocks.bit_output[x / 8] &
1236 if (!(sc->sc_mixer_clocks.bit_input[x / 8] &
1242 if (uaudio20_set_speed(sc->sc_udev,
1243 sc->sc_mixer_iface_no, x, chan_alt->sample_rate)) {
1245 * If the endpoint is adaptive setting
1246 * the speed may fail.
1248 DPRINTF("setting of sample rate failed! "
1249 "(continuing anyway)\n");
1252 } else if (chan_alt->p_sed.v1->bmAttributes & UA_SED_FREQ_CONTROL) {
1253 if (uaudio_set_speed(sc->sc_udev,
1254 chan_alt->p_ed1->bEndpointAddress, chan_alt->sample_rate)) {
1256 * If the endpoint is adaptive setting the
1259 DPRINTF("setting of sample rate failed! "
1260 "(continuing anyway)\n");
1263 if (usbd_transfer_setup(sc->sc_udev, &chan_alt->iface_index, chan->xfer,
1264 chan_alt->usb_cfg, UAUDIO_NCHANBUFS + 1, chan, chan->pcm_mtx)) {
1265 DPRINTF("could not allocate USB transfers!\n");
1269 fps = usbd_get_isoc_fps(sc->sc_udev);
1272 /* FULL speed USB */
1275 /* HIGH speed USB */
1276 frames = UAUDIO_NFRAMES;
1279 fps_shift = usbd_xfer_get_fps_shift(chan->xfer[0]);
1281 /* down shift number of frames per second, if any */
1283 frames >>= fps_shift;
1285 /* bytes per frame should not be zero */
1286 chan->bytes_per_frame[0] =
1287 ((chan_alt->sample_rate / fps) * chan_alt->sample_size);
1288 chan->bytes_per_frame[1] =
1289 (((chan_alt->sample_rate + fps - 1) / fps) * chan_alt->sample_size);
1291 /* setup data rate dithering, if any */
1292 chan->frames_per_second = fps;
1293 chan->sample_rem = chan_alt->sample_rate % fps;
1294 chan->sample_curr = 0;
1295 chan->frames_per_second = fps;
1297 /* compute required buffer size */
1298 buf_size = (chan->bytes_per_frame[1] * frames);
1300 if (buf_size > (chan->end - chan->start)) {
1301 DPRINTF("buffer size is too big\n");
1305 chan->intr_frames = frames;
1307 DPRINTF("fps=%d sample_rem=%d\n", (int)fps, (int)chan->sample_rem);
1309 if (chan->intr_frames == 0) {
1310 DPRINTF("frame shift is too high!\n");
1314 mtx_lock(chan->pcm_mtx);
1315 chan->cur_alt = set_alt;
1316 mtx_unlock(chan->pcm_mtx);
1319 #if (UAUDIO_NCHANBUFS != 2)
1320 #error "please update code"
1322 switch (operation) {
1324 mtx_lock(chan->pcm_mtx);
1325 usbd_transfer_start(chan->xfer[0]);
1326 usbd_transfer_start(chan->xfer[1]);
1327 mtx_unlock(chan->pcm_mtx);
1330 mtx_lock(chan->pcm_mtx);
1331 usbd_transfer_stop(chan->xfer[0]);
1332 usbd_transfer_stop(chan->xfer[1]);
1333 mtx_unlock(chan->pcm_mtx);
1341 usbd_transfer_unsetup(chan->xfer, UAUDIO_NCHANBUFS + 1);
1343 mtx_lock(chan->pcm_mtx);
1344 chan->cur_alt = CHAN_MAX_ALT;
1345 mtx_unlock(chan->pcm_mtx);
1349 uaudio_configure_msg(struct usb_proc_msg *pm)
1351 struct uaudio_softc *sc = ((struct uaudio_configure_msg *)pm)->sc;
1353 usb_proc_explore_unlock(sc->sc_udev);
1354 uaudio_configure_msg_sub(sc, &sc->sc_play_chan, PCMDIR_PLAY);
1355 uaudio_configure_msg_sub(sc, &sc->sc_rec_chan, PCMDIR_REC);
1356 usb_proc_explore_lock(sc->sc_udev);
1359 /*========================================================================*
1360 * AS - Audio Stream - routines
1361 *========================================================================*/
1365 uaudio_chan_dump_ep_desc(const usb_endpoint_descriptor_audio_t *ed)
1368 DPRINTF("endpoint=%p bLength=%d bDescriptorType=%d \n"
1369 "bEndpointAddress=%d bmAttributes=0x%x \n"
1370 "wMaxPacketSize=%d bInterval=%d \n"
1371 "bRefresh=%d bSynchAddress=%d\n",
1372 ed, ed->bLength, ed->bDescriptorType,
1373 ed->bEndpointAddress, ed->bmAttributes,
1374 UGETW(ed->wMaxPacketSize), ed->bInterval,
1375 UEP_HAS_REFRESH(ed) ? ed->bRefresh : 0,
1376 UEP_HAS_SYNCADDR(ed) ? ed->bSynchAddress : 0);
1383 * The following is a workaround for broken no-name USB audio devices
1384 * sold by dealextreme called "3D sound". The problem is that the
1385 * manufacturer computed wMaxPacketSize is too small to hold the
1386 * actual data sent. In other words the device sometimes sends more
1387 * data than it actually reports it can send in a single isochronous
1391 uaudio_record_fix_fs(usb_endpoint_descriptor_audio_t *ep,
1392 uint32_t xps, uint32_t add)
1396 mps = UGETW(ep->wMaxPacketSize);
1399 * If the device indicates it can send more data than what the
1400 * sample rate indicates, we apply the workaround.
1404 /* allow additional data */
1407 /* check against the maximum USB 1.x length */
1411 /* check if we should do an update */
1413 /* simply update the wMaxPacketSize field */
1414 USETW(ep->wMaxPacketSize, xps);
1415 DPRINTF("Workaround: Updated wMaxPacketSize "
1416 "from %d to %d bytes.\n",
1417 (int)mps, (int)xps);
1423 uaudio20_check_rate(struct usb_device *udev, uint8_t iface_no,
1424 uint8_t clockid, uint32_t rate)
1426 struct usb_device_request req;
1433 DPRINTFN(6, "ifaceno=%d clockid=%d rate=%u\n",
1434 iface_no, clockid, rate);
1436 req.bmRequestType = UT_READ_CLASS_INTERFACE;
1437 req.bRequest = UA20_CS_RANGE;
1438 USETW2(req.wValue, UA20_CS_SAM_FREQ_CONTROL, 0);
1439 USETW2(req.wIndex, clockid, iface_no);
1440 USETW(req.wLength, 255);
1442 error = usbd_do_request_flags(udev, NULL, &req, data,
1443 USB_SHORT_XFER_OK, &actlen, USB_DEFAULT_TIMEOUT);
1445 if (error != 0 || actlen < 2)
1446 return (USB_ERR_INVAL);
1448 rates = data[0] | (data[1] << 8);
1449 actlen = (actlen - 2) / 12;
1451 if (rates > actlen) {
1452 DPRINTF("Too many rates\n");
1456 for (x = 0; x != rates; x++) {
1457 uint32_t min = UGETDW(data + 2 + (12 * x));
1458 uint32_t max = UGETDW(data + 6 + (12 * x));
1459 uint32_t res = UGETDW(data + 10 + (12 * x));
1462 DPRINTF("Zero residue\n");
1467 DPRINTF("Swapped max and min\n");
1474 if (rate >= min && rate <= max &&
1475 (((rate - min) % res) == 0)) {
1479 return (USB_ERR_INVAL);
1483 uaudio_chan_fill_info_sub(struct uaudio_softc *sc, struct usb_device *udev,
1484 uint32_t rate, uint8_t channels, uint8_t bit_resolution)
1486 struct usb_descriptor *desc = NULL;
1487 union uaudio_asid asid = { NULL };
1488 union uaudio_asf1d asf1d = { NULL };
1489 union uaudio_sed sed = { NULL };
1490 usb_endpoint_descriptor_audio_t *ed1 = NULL;
1491 const struct usb_audio_control_descriptor *acdp = NULL;
1492 struct usb_config_descriptor *cd = usbd_get_config_descriptor(udev);
1493 struct usb_interface_descriptor *id;
1494 const struct uaudio_format *p_fmt = NULL;
1495 struct uaudio_chan *chan;
1496 struct uaudio_chan_alt *chan_alt;
1498 uint16_t curidx = 0xFFFF;
1499 uint16_t lastidx = 0xFFFF;
1500 uint16_t alt_index = 0;
1501 uint16_t audio_rev = 0;
1505 uint8_t bBitResolution;
1506 uint8_t audio_if = 0;
1507 uint8_t uma_if_class;
1509 while ((desc = usb_desc_foreach(cd, desc))) {
1511 if ((desc->bDescriptorType == UDESC_INTERFACE) &&
1512 (desc->bLength >= sizeof(*id))) {
1516 if (id->bInterfaceNumber != lastidx) {
1517 lastidx = id->bInterfaceNumber;
1525 if ((!(sc->sc_hid.flags & UAUDIO_HID_VALID)) &&
1526 (id->bInterfaceClass == UICLASS_HID) &&
1527 (id->bInterfaceSubClass == 0) &&
1528 (id->bInterfaceProtocol == 0) &&
1530 usbd_get_iface(udev, curidx) != NULL) {
1531 DPRINTF("Found HID interface at %d\n",
1533 sc->sc_hid.flags |= UAUDIO_HID_VALID;
1534 sc->sc_hid.iface_index = curidx;
1538 ((id->bInterfaceClass == UICLASS_AUDIO) ||
1539 ((id->bInterfaceClass == UICLASS_VENDOR) &&
1540 (sc->sc_uq_au_vendor_class != 0)));
1542 if ((uma_if_class != 0) && (id->bInterfaceSubClass == UISUBCLASS_AUDIOSTREAM)) {
1548 if ((uma_if_class != 0) &&
1549 (id->bInterfaceSubClass == UISUBCLASS_MIDISTREAM)) {
1552 * XXX could allow multiple MIDI interfaces
1555 if ((sc->sc_midi_chan.valid == 0) &&
1556 usbd_get_iface(udev, curidx)) {
1557 sc->sc_midi_chan.iface_index = curidx;
1558 sc->sc_midi_chan.iface_alt_index = alt_index;
1559 sc->sc_midi_chan.valid = 1;
1568 if (audio_if == 0) {
1569 if ((acdp == NULL) &&
1570 (desc->bDescriptorType == UDESC_CS_INTERFACE) &&
1571 (desc->bDescriptorSubtype == UDESCSUB_AC_HEADER) &&
1572 (desc->bLength >= sizeof(*acdp))) {
1573 acdp = (void *)desc;
1574 audio_rev = UGETW(acdp->bcdADC);
1578 * Don't collect any USB audio descriptors if
1579 * this is not an USB audio stream interface.
1584 if ((acdp != NULL) &&
1585 (desc->bDescriptorType == UDESC_CS_INTERFACE) &&
1586 (desc->bDescriptorSubtype == AS_GENERAL) &&
1587 (asid.v1 == NULL)) {
1588 if (audio_rev >= UAUDIO_VERSION_30) {
1590 } else if (audio_rev >= UAUDIO_VERSION_20) {
1591 if (desc->bLength >= sizeof(*asid.v2)) {
1592 asid.v2 = (void *)desc;
1595 if (desc->bLength >= sizeof(*asid.v1)) {
1596 asid.v1 = (void *)desc;
1600 if ((acdp != NULL) &&
1601 (desc->bDescriptorType == UDESC_CS_INTERFACE) &&
1602 (desc->bDescriptorSubtype == FORMAT_TYPE) &&
1603 (asf1d.v1 == NULL)) {
1604 if (audio_rev >= UAUDIO_VERSION_30) {
1606 } else if (audio_rev >= UAUDIO_VERSION_20) {
1607 if (desc->bLength >= sizeof(*asf1d.v2))
1608 asf1d.v2 = (void *)desc;
1610 if (desc->bLength >= sizeof(*asf1d.v1)) {
1611 asf1d.v1 = (void *)desc;
1613 if (asf1d.v1->bFormatType != FORMAT_TYPE_I) {
1614 DPRINTFN(11, "ignored bFormatType = %d\n",
1615 asf1d.v1->bFormatType);
1619 if (desc->bLength < (sizeof(*asf1d.v1) +
1620 ((asf1d.v1->bSamFreqType == 0) ? 6 :
1621 (asf1d.v1->bSamFreqType * 3)))) {
1622 DPRINTFN(11, "invalid descriptor, "
1630 if ((desc->bDescriptorType == UDESC_ENDPOINT) &&
1631 (desc->bLength >= UEP_MINSIZE) &&
1634 if (UE_GET_XFERTYPE(ed1->bmAttributes) != UE_ISOCHRONOUS) {
1639 if ((acdp != NULL) &&
1640 (desc->bDescriptorType == UDESC_CS_ENDPOINT) &&
1641 (desc->bDescriptorSubtype == AS_GENERAL) &&
1643 if (audio_rev >= UAUDIO_VERSION_30) {
1645 } else if (audio_rev >= UAUDIO_VERSION_20) {
1646 if (desc->bLength >= sizeof(*sed.v2))
1647 sed.v2 = (void *)desc;
1649 if (desc->bLength >= sizeof(*sed.v1))
1650 sed.v1 = (void *)desc;
1653 if (asid.v1 == NULL || asf1d.v1 == NULL ||
1654 ed1 == NULL || sed.v1 == NULL) {
1655 /* need more descriptors */
1659 ep_dir = UE_GET_DIR(ed1->bEndpointAddress);
1661 /* We ignore sync endpoint information until further. */
1663 if (audio_rev >= UAUDIO_VERSION_30) {
1665 } else if (audio_rev >= UAUDIO_VERSION_20) {
1668 uint8_t bSubslotSize;
1670 dwFormat = UGETDW(asid.v2->bmFormats);
1671 bChannels = asid.v2->bNrChannels;
1672 bBitResolution = asf1d.v2->bBitResolution;
1673 bSubslotSize = asf1d.v2->bSubslotSize;
1675 /* Map 4-byte aligned 24-bit samples into 32-bit */
1676 if (bBitResolution == 24 && bSubslotSize == 4)
1677 bBitResolution = 32;
1679 if (bBitResolution != (bSubslotSize * 8)) {
1680 DPRINTF("Invalid bSubslotSize\n");
1684 if ((bChannels != channels) ||
1685 (bBitResolution != bit_resolution)) {
1686 DPRINTF("Wrong number of channels\n");
1690 for (p_fmt = uaudio20_formats;
1691 p_fmt->wFormat != 0; p_fmt++) {
1692 if ((p_fmt->wFormat & dwFormat) &&
1693 (p_fmt->bPrecision == bBitResolution))
1697 if (p_fmt->wFormat == 0) {
1698 DPRINTF("Unsupported audio format\n");
1702 for (x = 0; x != 256; x++) {
1703 if (ep_dir == UE_DIR_OUT) {
1704 if (!(sc->sc_mixer_clocks.bit_output[x / 8] &
1709 if (!(sc->sc_mixer_clocks.bit_input[x / 8] &
1715 DPRINTF("Checking clock ID=%d\n", x);
1717 if (uaudio20_check_rate(udev,
1718 sc->sc_mixer_iface_no, x, rate)) {
1719 DPRINTF("Unsupported sampling "
1720 "rate, id=%d\n", x);
1727 wFormat = UGETW(asid.v1->wFormatTag);
1728 bChannels = UAUDIO_MAX_CHAN(asf1d.v1->bNrChannels);
1729 bBitResolution = asf1d.v1->bBitResolution;
1731 if (asf1d.v1->bSamFreqType == 0) {
1732 DPRINTFN(16, "Sample rate: %d-%dHz\n",
1733 UA_SAMP_LO(asf1d.v1),
1734 UA_SAMP_HI(asf1d.v1));
1736 if ((rate >= UA_SAMP_LO(asf1d.v1)) &&
1737 (rate <= UA_SAMP_HI(asf1d.v1)))
1741 for (x = 0; x < asf1d.v1->bSamFreqType; x++) {
1742 DPRINTFN(16, "Sample rate = %dHz\n",
1743 UA_GETSAMP(asf1d.v1, x));
1745 if (rate == UA_GETSAMP(asf1d.v1, x))
1752 for (p_fmt = uaudio10_formats;
1753 p_fmt->wFormat != 0; p_fmt++) {
1754 if ((p_fmt->wFormat == wFormat) &&
1755 (p_fmt->bPrecision == bBitResolution))
1758 if (p_fmt->wFormat == 0) {
1759 DPRINTF("Unsupported audio format\n");
1763 if ((bChannels != channels) ||
1764 (bBitResolution != bit_resolution)) {
1765 DPRINTF("Wrong number of channels\n");
1770 chan = (ep_dir == UE_DIR_IN) ?
1771 &sc->sc_rec_chan : &sc->sc_play_chan;
1773 if (usbd_get_iface(udev, curidx) == NULL) {
1774 DPRINTF("Interface is not valid\n");
1777 if (chan->num_alt == CHAN_MAX_ALT) {
1778 DPRINTF("Too many alternate settings\n");
1782 chan->cur_alt = CHAN_MAX_ALT;
1784 chan_alt = &chan->usb_alt[chan->num_alt++];
1787 uaudio_chan_dump_ep_desc(ed1);
1789 DPRINTF("Sample rate = %dHz, channels = %d, "
1790 "bits = %d, format = %s\n", rate, channels,
1791 bit_resolution, p_fmt->description);
1793 chan_alt->sample_rate = rate;
1794 chan_alt->p_asf1d = asf1d;
1795 chan_alt->p_ed1 = ed1;
1796 chan_alt->p_fmt = p_fmt;
1797 chan_alt->p_sed = sed;
1798 chan_alt->iface_index = curidx;
1799 chan_alt->iface_alt_index = alt_index;
1801 usbd_set_parent_iface(sc->sc_udev, curidx,
1802 sc->sc_mixer_iface_index);
1804 if (ep_dir == UE_DIR_IN)
1805 chan_alt->usb_cfg = uaudio_cfg_record;
1807 chan_alt->usb_cfg = uaudio_cfg_play;
1809 chan_alt->sample_size = (UAUDIO_MAX_CHAN(channels) *
1810 p_fmt->bPrecision) / 8;
1811 chan_alt->channels = channels;
1813 if (ep_dir == UE_DIR_IN &&
1814 usbd_get_speed(udev) == USB_SPEED_FULL) {
1815 uaudio_record_fix_fs(ed1,
1816 chan_alt->sample_size * (rate / 1000),
1817 chan_alt->sample_size * (rate / 4000));
1820 /* setup play/record format */
1822 format = chan_alt->p_fmt->freebsd_fmt;
1824 switch (chan_alt->channels) {
1827 format = SND_FORMAT(format, 2, 0);
1831 format = SND_FORMAT(format, 1, 0);
1834 /* surround and more */
1835 format = feeder_matrix_default_format(
1836 SND_FORMAT(format, chan_alt->channels, 0));
1840 /* check if format is not supported */
1842 DPRINTF("The selected audio format is not supported\n");
1846 if (chan->num_alt > 1) {
1847 /* we only accumulate one format at different sample rates */
1848 if (chan->pcm_format[0] != format) {
1849 DPRINTF("Multiple formats is not supported\n");
1853 /* ignore if duplicate sample rate entry */
1854 if (rate == chan->usb_alt[chan->num_alt - 2].sample_rate) {
1855 DPRINTF("Duplicate sample rate detected\n");
1860 chan->pcm_cap.fmtlist = chan->pcm_format;
1861 chan->pcm_cap.fmtlist[0] = format;
1863 if (rate < chan->pcm_cap.minspeed || chan->pcm_cap.minspeed == 0)
1864 chan->pcm_cap.minspeed = rate;
1865 if (rate > chan->pcm_cap.maxspeed || chan->pcm_cap.maxspeed == 0)
1866 chan->pcm_cap.maxspeed = rate;
1868 if (sc->sc_sndstat_valid != 0) {
1869 sbuf_printf(&sc->sc_sndstat, "\n\t"
1870 "mode %d.%d:(%s) %dch, %dbit, %s, %dHz",
1872 (ep_dir == UE_DIR_IN) ? "input" : "output",
1873 channels, p_fmt->bPrecision,
1874 p_fmt->description, rate);
1883 /* This structure defines all the supported rates. */
1885 static const uint32_t uaudio_rate_list[CHAN_MAX_ALT] = {
1910 uaudio_chan_fill_info(struct uaudio_softc *sc, struct usb_device *udev)
1912 uint32_t rate = uaudio_default_rate;
1914 uint8_t bits = uaudio_default_bits;
1916 uint8_t channels = uaudio_default_channels;
1920 if ((bits == 0) || (bits > 32)) {
1921 /* set a valid value */
1924 if (channels == 0) {
1925 switch (usbd_get_speed(udev)) {
1927 case USB_SPEED_FULL:
1929 * Due to high bandwidth usage and problems
1930 * with HIGH-speed split transactions we
1931 * disable surround setups on FULL-speed USB
1940 } else if (channels > 16) {
1943 if (sbuf_new(&sc->sc_sndstat, NULL, 4096, SBUF_AUTOEXTEND)) {
1944 sc->sc_sndstat_valid = 1;
1946 /* try to search for a valid config */
1948 for (x = channels; x; x--) {
1949 for (y = bits; y; y -= 8) {
1951 /* try user defined rate, if any */
1953 uaudio_chan_fill_info_sub(sc, udev, rate, x, y);
1955 /* try find a matching rate, if any */
1956 for (z = 0; uaudio_rate_list[z]; z++)
1957 uaudio_chan_fill_info_sub(sc, udev, uaudio_rate_list[z], x, y);
1960 if (sc->sc_sndstat_valid)
1961 sbuf_finish(&sc->sc_sndstat);
1965 uaudio_chan_play_sync_callback(struct usb_xfer *xfer, usb_error_t error)
1967 struct uaudio_chan *ch = usbd_xfer_softc(xfer);
1968 struct usb_page_cache *pc;
1969 uint64_t sample_rate = ch->usb_alt[ch->cur_alt].sample_rate;
1976 usbd_xfer_status(xfer, &actlen, NULL, NULL, &nframes);
1978 switch (USB_GET_STATE(xfer)) {
1979 case USB_ST_TRANSFERRED:
1981 DPRINTFN(6, "transferred %d bytes\n", actlen);
1985 len = usbd_xfer_frame_len(xfer, 0);
1988 if (len > sizeof(buf))
1991 memset(buf, 0, sizeof(buf));
1993 pc = usbd_xfer_get_frame(xfer, 0);
1994 usbd_copy_out(pc, 0, buf, len);
1998 DPRINTF("Value = 0x%08x\n", (int)temp);
2000 /* auto-detect SYNC format */
2005 /* check for no data */
2010 /* correctly scale value */
2012 temp = (temp * 125ULL) - 64;
2016 while (temp < (sample_rate - (sample_rate / 4)))
2019 while (temp > (sample_rate + (sample_rate / 2)))
2024 DPRINTF("Comparing %d < %d\n",
2025 (int)temp, (int)sample_rate);
2027 if (temp == sample_rate)
2028 ch->last_sync_state = UAUDIO_SYNC_NONE;
2029 else if (temp > sample_rate)
2030 ch->last_sync_state = UAUDIO_SYNC_MORE;
2032 ch->last_sync_state = UAUDIO_SYNC_LESS;
2036 usbd_xfer_set_frames(xfer, 1);
2037 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_framelen(xfer));
2038 usbd_transfer_submit(xfer);
2041 default: /* Error */
2047 uaudio_chan_play_callback(struct usb_xfer *xfer, usb_error_t error)
2049 struct uaudio_chan *ch = usbd_xfer_softc(xfer);
2050 struct usb_page_cache *pc;
2051 uint32_t sample_size = ch->usb_alt[ch->cur_alt].sample_size;
2054 uint32_t blockcount;
2060 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL);
2062 if (ch->end == ch->start) {
2063 DPRINTF("no buffer!\n");
2067 switch (USB_GET_STATE(xfer)) {
2068 case USB_ST_TRANSFERRED:
2070 if (actlen < sumlen) {
2071 DPRINTF("short transfer, "
2072 "%d of %d bytes\n", actlen, sumlen);
2074 chn_intr(ch->pcm_ch);
2076 /* start SYNC transfer, if any */
2077 if ((ch->last_sync_time++ & 7) == 0)
2078 usbd_transfer_start(ch->xfer[UAUDIO_NCHANBUFS]);
2081 mfl = usbd_xfer_max_framelen(xfer);
2083 if (ch->bytes_per_frame[1] > mfl) {
2084 DPRINTF("bytes per transfer, %d, "
2085 "exceeds maximum, %d!\n",
2086 ch->bytes_per_frame[1],
2091 blockcount = ch->intr_frames;
2093 /* setup number of frames */
2094 usbd_xfer_set_frames(xfer, blockcount);
2096 /* reset total length */
2099 /* setup frame lengths */
2100 for (n = 0; n != blockcount; n++) {
2103 ch->sample_curr += ch->sample_rem;
2104 if (ch->sample_curr >= ch->frames_per_second) {
2105 ch->sample_curr -= ch->frames_per_second;
2106 frame_len = ch->bytes_per_frame[1];
2108 frame_len = ch->bytes_per_frame[0];
2111 if (n == (blockcount - 1)) {
2112 switch (ch->last_sync_state) {
2113 case UAUDIO_SYNC_MORE:
2114 DPRINTFN(6, "sending one sample more\n");
2115 if ((frame_len + sample_size) <= mfl)
2116 frame_len += sample_size;
2117 ch->last_sync_state = UAUDIO_SYNC_NONE;
2119 case UAUDIO_SYNC_LESS:
2120 DPRINTFN(6, "sending one sample less\n");
2121 if (frame_len >= sample_size)
2122 frame_len -= sample_size;
2123 ch->last_sync_state = UAUDIO_SYNC_NONE;
2130 usbd_xfer_set_frame_len(xfer, n, frame_len);
2134 DPRINTFN(6, "transfer %d bytes\n", total);
2138 pc = usbd_xfer_get_frame(xfer, 0);
2141 n = (ch->end - ch->cur);
2145 usbd_copy_in(pc, offset, ch->cur, n);
2151 if (ch->cur >= ch->end) {
2152 ch->cur = ch->start;
2156 usbd_transfer_submit(xfer);
2159 default: /* Error */
2160 if (error == USB_ERR_CANCELLED) {
2163 goto tr_transferred;
2168 uaudio_chan_record_sync_callback(struct usb_xfer *xfer, usb_error_t error)
2174 uaudio_chan_record_callback(struct usb_xfer *xfer, usb_error_t error)
2176 struct uaudio_chan *ch = usbd_xfer_softc(xfer);
2177 struct usb_page_cache *pc;
2188 usbd_xfer_status(xfer, &actlen, NULL, NULL, &nframes);
2189 mfl = usbd_xfer_max_framelen(xfer);
2191 if (ch->end == ch->start) {
2192 DPRINTF("no buffer!\n");
2196 switch (USB_GET_STATE(xfer)) {
2197 case USB_ST_TRANSFERRED:
2199 DPRINTFN(6, "transferred %d bytes\n", actlen);
2202 pc = usbd_xfer_get_frame(xfer, 0);
2204 for (n = 0; n != nframes; n++) {
2207 len = usbd_xfer_frame_len(xfer, n);
2211 m = (ch->end - ch->cur);
2216 usbd_copy_out(pc, offset1, ch->cur, m);
2222 if (ch->cur >= ch->end) {
2223 ch->cur = ch->start;
2230 chn_intr(ch->pcm_ch);
2234 blockcount = ch->intr_frames;
2236 usbd_xfer_set_frames(xfer, blockcount);
2237 for (n = 0; n < blockcount; n++) {
2238 usbd_xfer_set_frame_len(xfer, n, mfl);
2241 usbd_transfer_submit(xfer);
2244 default: /* Error */
2245 if (error == USB_ERR_CANCELLED) {
2253 uaudio_chan_init(struct uaudio_softc *sc, struct snd_dbuf *b,
2254 struct pcm_channel *c, int dir)
2256 struct uaudio_chan *ch = ((dir == PCMDIR_PLAY) ?
2257 &sc->sc_play_chan : &sc->sc_rec_chan);
2261 /* store mutex and PCM channel */
2264 ch->pcm_mtx = c->lock;
2266 /* compute worst case buffer */
2269 for (x = 0; x != ch->num_alt; x++) {
2270 uint32_t temp = uaudio_get_buffer_size(ch, x);
2271 if (temp > buf_size)
2275 /* allow double buffering */
2278 DPRINTF("Worst case buffer is %d bytes\n", (int)buf_size);
2280 ch->buf = malloc(buf_size, M_DEVBUF, M_WAITOK | M_ZERO);
2281 if (ch->buf == NULL)
2283 if (sndbuf_setup(b, ch->buf, buf_size) != 0)
2286 ch->start = ch->buf;
2287 ch->end = ch->buf + buf_size;
2290 ch->max_buf = buf_size;
2292 if (ch->pcm_mtx == NULL) {
2293 DPRINTF("ERROR: PCM channels does not have a mutex!\n");
2299 uaudio_chan_free(ch);
2304 uaudio_chan_free(struct uaudio_chan *ch)
2306 if (ch->buf != NULL) {
2307 free(ch->buf, M_DEVBUF);
2310 usbd_transfer_unsetup(ch->xfer, UAUDIO_NCHANBUFS + 1);
2318 uaudio_chan_set_param_blocksize(struct uaudio_chan *ch, uint32_t blocksize)
2320 uint32_t temp = 2 * uaudio_get_buffer_size(ch, ch->set_alt);
2322 sndbuf_setup(ch->pcm_buf, ch->buf, temp);
2324 ch->start = ch->buf;
2325 ch->end = ch->buf + temp;
2332 uaudio_chan_set_param_fragments(struct uaudio_chan *ch, uint32_t blocksize,
2333 uint32_t blockcount)
2339 uaudio_chan_set_param_speed(struct uaudio_chan *ch, uint32_t speed)
2343 for (x = 0; x < ch->num_alt; x++) {
2344 if (ch->usb_alt[x].sample_rate < speed) {
2345 /* sample rate is too low */
2355 DPRINTF("Selecting alt %d\n", (int)x);
2357 return (ch->usb_alt[x].sample_rate);
2361 uaudio_chan_getptr(struct uaudio_chan *ch)
2363 return (ch->cur - ch->start);
2366 struct pcmchan_caps *
2367 uaudio_chan_getcaps(struct uaudio_chan *ch)
2369 return (&ch->pcm_cap);
2372 static struct pcmchan_matrix uaudio_chan_matrix_swap_2_0 = {
2373 .id = SND_CHN_MATRIX_DRV,
2379 .type = SND_CHN_T_FR,
2381 SND_CHN_T_MASK_FR | SND_CHN_T_MASK_FC |
2382 SND_CHN_T_MASK_LF | SND_CHN_T_MASK_BR |
2383 SND_CHN_T_MASK_BC | SND_CHN_T_MASK_SR
2387 .type = SND_CHN_T_FL,
2389 SND_CHN_T_MASK_FL | SND_CHN_T_MASK_FC |
2390 SND_CHN_T_MASK_LF | SND_CHN_T_MASK_BL |
2391 SND_CHN_T_MASK_BC | SND_CHN_T_MASK_SL
2394 .type = SND_CHN_T_MAX,
2398 .mask = SND_CHN_T_MASK_FR | SND_CHN_T_MASK_FL,
2399 .offset = { 1, 0, -1, -1, -1, -1, -1, -1, -1,
2400 -1, -1, -1, -1, -1, -1, -1, -1, -1 }
2403 struct pcmchan_matrix *
2404 uaudio_chan_getmatrix(struct uaudio_chan *ch, uint32_t format)
2406 struct uaudio_softc *sc;
2410 if (sc != NULL && sc->sc_uq_audio_swap_lr != 0 &&
2411 AFMT_CHANNEL(format) == 2)
2412 return (&uaudio_chan_matrix_swap_2_0);
2414 return (feeder_matrix_format_map(format));
2418 uaudio_chan_set_param_format(struct uaudio_chan *ch, uint32_t format)
2420 DPRINTF("Selecting format 0x%08x\n", (unsigned int)format);
2425 uaudio_chan_start(struct uaudio_chan *ch)
2427 struct uaudio_softc *sc = ch->priv_sc;
2430 usb_proc_explore_lock(sc->sc_udev);
2431 if (ch->operation != CHAN_OP_DRAIN) {
2432 if (ch->cur_alt == ch->set_alt &&
2433 ch->operation == CHAN_OP_NONE) {
2434 /* save doing the explore task */
2437 ch->operation = CHAN_OP_START;
2438 (void)usb_proc_explore_msignal(sc->sc_udev,
2439 &sc->sc_config_msg[0], &sc->sc_config_msg[1]);
2442 usb_proc_explore_unlock(sc->sc_udev);
2445 usbd_transfer_start(ch->xfer[0]);
2446 usbd_transfer_start(ch->xfer[1]);
2452 uaudio_chan_stop(struct uaudio_chan *ch)
2454 struct uaudio_softc *sc = ch->priv_sc;
2457 usb_proc_explore_lock(sc->sc_udev);
2458 if (ch->operation != CHAN_OP_DRAIN) {
2459 if (ch->cur_alt == ch->set_alt &&
2460 ch->operation == CHAN_OP_NONE) {
2461 /* save doing the explore task */
2464 ch->operation = CHAN_OP_STOP;
2465 (void)usb_proc_explore_msignal(sc->sc_udev,
2466 &sc->sc_config_msg[0], &sc->sc_config_msg[1]);
2469 usb_proc_explore_unlock(sc->sc_udev);
2472 usbd_transfer_stop(ch->xfer[0]);
2473 usbd_transfer_stop(ch->xfer[1]);
2478 /*========================================================================*
2479 * AC - Audio Controller - routines
2480 *========================================================================*/
2483 uaudio_mixer_sysctl_handler(SYSCTL_HANDLER_ARGS)
2485 struct uaudio_softc *sc;
2486 struct uaudio_mixer_node *pmc;
2492 sc = (struct uaudio_softc *)oidp->oid_arg1;
2493 hint = oidp->oid_arg2;
2495 if (sc->sc_mixer_lock == NULL)
2498 /* lookup mixer node */
2500 mtx_lock(sc->sc_mixer_lock);
2501 for (pmc = sc->sc_mixer_root; pmc != NULL; pmc = pmc->next) {
2502 for (chan = 0; chan != (int)pmc->nchan; chan++) {
2503 if (pmc->wValue[chan] != -1 &&
2504 pmc->wValue[chan] == hint) {
2505 temp = pmc->wData[chan];
2511 mtx_unlock(sc->sc_mixer_lock);
2513 error = sysctl_handle_int(oidp, &temp, 0, req);
2514 if (error != 0 || req->newptr == NULL)
2517 /* update mixer value */
2519 mtx_lock(sc->sc_mixer_lock);
2521 temp >= pmc->minval &&
2522 temp <= pmc->maxval) {
2524 pmc->wData[chan] = temp;
2525 pmc->update[(chan / 8)] |= (1 << (chan % 8));
2527 /* start the transfer, if not already started */
2528 usbd_transfer_start(sc->sc_mixer_xfer[0]);
2530 mtx_unlock(sc->sc_mixer_lock);
2536 uaudio_mixer_ctl_free(struct uaudio_softc *sc)
2538 struct uaudio_mixer_node *p_mc;
2540 while ((p_mc = sc->sc_mixer_root) != NULL) {
2541 sc->sc_mixer_root = p_mc->next;
2542 free(p_mc, M_USBDEV);
2547 uaudio_mixer_register_sysctl(struct uaudio_softc *sc, device_t dev)
2549 struct uaudio_mixer_node *pmc;
2550 struct sysctl_oid *mixer_tree;
2551 struct sysctl_oid *control_tree;
2556 mixer_tree = SYSCTL_ADD_NODE(device_get_sysctl_ctx(dev),
2557 SYSCTL_CHILDREN(device_get_sysctl_tree(dev)), OID_AUTO, "mixer",
2558 CTLFLAG_RD, NULL, "");
2560 if (mixer_tree == NULL)
2563 for (n = 0, pmc = sc->sc_mixer_root; pmc != NULL;
2564 pmc = pmc->next, n++) {
2566 for (chan = 0; chan < pmc->nchan; chan++) {
2568 if (pmc->nchan > 1) {
2569 snprintf(buf, sizeof(buf), "%s_%d_%d",
2570 pmc->name, n, chan);
2572 snprintf(buf, sizeof(buf), "%s_%d",
2576 control_tree = SYSCTL_ADD_NODE(device_get_sysctl_ctx(dev),
2577 SYSCTL_CHILDREN(mixer_tree), OID_AUTO, buf,
2578 CTLFLAG_RD, NULL, "Mixer control nodes");
2580 if (control_tree == NULL)
2583 SYSCTL_ADD_PROC(device_get_sysctl_ctx(dev),
2584 SYSCTL_CHILDREN(control_tree),
2585 OID_AUTO, "val", CTLTYPE_INT | CTLFLAG_RW, sc,
2587 uaudio_mixer_sysctl_handler, "I", "Current value");
2589 SYSCTL_ADD_INT(device_get_sysctl_ctx(dev),
2590 SYSCTL_CHILDREN(control_tree),
2591 OID_AUTO, "min", CTLFLAG_RD, 0, pmc->minval,
2594 SYSCTL_ADD_INT(device_get_sysctl_ctx(dev),
2595 SYSCTL_CHILDREN(control_tree),
2596 OID_AUTO, "max", CTLFLAG_RD, 0, pmc->maxval,
2599 SYSCTL_ADD_STRING(device_get_sysctl_ctx(dev),
2600 SYSCTL_CHILDREN(control_tree),
2601 OID_AUTO, "desc", CTLFLAG_RD, pmc->desc, 0,
2607 /* M-Audio FastTrack Ultra Mixer Description */
2608 /* Origin: Linux USB Audio driver */
2610 uaudio_mixer_controls_create_ftu(struct uaudio_softc *sc)
2615 memset(&MIX(sc), 0, sizeof(MIX(sc)));
2616 MIX(sc).wIndex = MAKE_WORD(6, sc->sc_mixer_iface_no);
2617 MIX(sc).wValue[0] = MAKE_WORD(8, 0);
2618 MIX(sc).class = UAC_OUTPUT;
2619 MIX(sc).type = MIX_UNSIGNED_16;
2620 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
2621 MIX(sc).name = "effect";
2626 MIX(sc).update[0] = 1;
2627 strlcpy(MIX(sc).desc, "Room1,2,3,Hall1,2,Plate,Delay,Echo", sizeof(MIX(sc).desc));
2628 uaudio_mixer_add_ctl_sub(sc, &MIX(sc));
2630 memset(&MIX(sc), 0, sizeof(MIX(sc)));
2631 MIX(sc).wIndex = MAKE_WORD(5, sc->sc_mixer_iface_no);
2633 for (chx = 0; chx != 8; chx++) {
2634 for (chy = 0; chy != 8; chy++) {
2636 MIX(sc).wValue[0] = MAKE_WORD(chx + 1, chy + 1);
2637 MIX(sc).type = MIX_SIGNED_16;
2638 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
2639 MIX(sc).name = "mix_rec";
2641 MIX(sc).update[0] = 1;
2642 MIX(sc).val_default = 0;
2643 snprintf(MIX(sc).desc, sizeof(MIX(sc).desc),
2644 "AIn%d - Out%d Record Volume", chy + 1, chx + 1);
2646 uaudio_mixer_add_ctl(sc, &MIX(sc));
2648 MIX(sc).wValue[0] = MAKE_WORD(chx + 1, chy + 1 + 8);
2649 MIX(sc).type = MIX_SIGNED_16;
2650 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
2651 MIX(sc).name = "mix_play";
2653 MIX(sc).update[0] = 1;
2654 MIX(sc).val_default = (chx == chy) ? 2 : 0;
2655 snprintf(MIX(sc).desc, sizeof(MIX(sc).desc),
2656 "DIn%d - Out%d Playback Volume", chy + 1, chx + 1);
2658 uaudio_mixer_add_ctl(sc, &MIX(sc));
2662 memset(&MIX(sc), 0, sizeof(MIX(sc)));
2663 MIX(sc).wIndex = MAKE_WORD(6, sc->sc_mixer_iface_no);
2664 MIX(sc).wValue[0] = MAKE_WORD(2, 0);
2665 MIX(sc).class = UAC_OUTPUT;
2666 MIX(sc).type = MIX_SIGNED_8;
2667 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
2668 MIX(sc).name = "effect_vol";
2670 MIX(sc).update[0] = 1;
2672 MIX(sc).maxval = 0x7f;
2675 MIX(sc).update[0] = 1;
2676 strlcpy(MIX(sc).desc, "Effect Volume", sizeof(MIX(sc).desc));
2677 uaudio_mixer_add_ctl_sub(sc, &MIX(sc));
2679 memset(&MIX(sc), 0, sizeof(MIX(sc)));
2680 MIX(sc).wIndex = MAKE_WORD(6, sc->sc_mixer_iface_no);
2681 MIX(sc).wValue[0] = MAKE_WORD(3, 0);
2682 MIX(sc).class = UAC_OUTPUT;
2683 MIX(sc).type = MIX_SIGNED_16;
2684 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
2685 MIX(sc).name = "effect_dur";
2687 MIX(sc).update[0] = 1;
2689 MIX(sc).maxval = 0x7f00;
2690 MIX(sc).mul = 0x7f00;
2692 MIX(sc).update[0] = 1;
2693 strlcpy(MIX(sc).desc, "Effect Duration", sizeof(MIX(sc).desc));
2694 uaudio_mixer_add_ctl_sub(sc, &MIX(sc));
2696 memset(&MIX(sc), 0, sizeof(MIX(sc)));
2697 MIX(sc).wIndex = MAKE_WORD(6, sc->sc_mixer_iface_no);
2698 MIX(sc).wValue[0] = MAKE_WORD(4, 0);
2699 MIX(sc).class = UAC_OUTPUT;
2700 MIX(sc).type = MIX_SIGNED_8;
2701 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
2702 MIX(sc).name = "effect_fb";
2704 MIX(sc).update[0] = 1;
2706 MIX(sc).maxval = 0x7f;
2709 MIX(sc).update[0] = 1;
2710 strlcpy(MIX(sc).desc, "Effect Feedback Volume", sizeof(MIX(sc).desc));
2711 uaudio_mixer_add_ctl_sub(sc, &MIX(sc));
2713 memset(&MIX(sc), 0, sizeof(MIX(sc)));
2714 MIX(sc).wIndex = MAKE_WORD(7, sc->sc_mixer_iface_no);
2715 for (chy = 0; chy != 4; chy++) {
2717 MIX(sc).wValue[0] = MAKE_WORD(7, chy + 1);
2718 MIX(sc).type = MIX_SIGNED_16;
2719 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
2720 MIX(sc).name = "effect_ret";
2722 MIX(sc).update[0] = 1;
2723 snprintf(MIX(sc).desc, sizeof(MIX(sc).desc),
2724 "Effect Return %d Volume", chy + 1);
2726 uaudio_mixer_add_ctl(sc, &MIX(sc));
2729 memset(&MIX(sc), 0, sizeof(MIX(sc)));
2730 MIX(sc).wIndex = MAKE_WORD(5, sc->sc_mixer_iface_no);
2732 for (chy = 0; chy != 8; chy++) {
2733 MIX(sc).wValue[0] = MAKE_WORD(9, chy + 1);
2734 MIX(sc).type = MIX_SIGNED_16;
2735 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
2736 MIX(sc).name = "effect_send";
2738 MIX(sc).update[0] = 1;
2739 snprintf(MIX(sc).desc, sizeof(MIX(sc).desc),
2740 "Effect Send AIn%d Volume", chy + 1);
2742 uaudio_mixer_add_ctl(sc, &MIX(sc));
2744 MIX(sc).wValue[0] = MAKE_WORD(9, chy + 1);
2745 MIX(sc).type = MIX_SIGNED_16;
2746 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
2747 MIX(sc).name = "effect_send";
2749 MIX(sc).update[0] = 1;
2750 snprintf(MIX(sc).desc, sizeof(MIX(sc).desc),
2751 "Effect Send DIn%d Volume", chy + 1 + 8);
2753 uaudio_mixer_add_ctl(sc, &MIX(sc));
2758 uaudio_mixer_reload_all(struct uaudio_softc *sc)
2760 struct uaudio_mixer_node *pmc;
2763 if (sc->sc_mixer_lock == NULL)
2766 mtx_lock(sc->sc_mixer_lock);
2767 for (pmc = sc->sc_mixer_root; pmc != NULL; pmc = pmc->next) {
2768 /* use reset defaults for non-oss controlled settings */
2769 if (pmc->ctl == SOUND_MIXER_NRDEVICES)
2771 for (chan = 0; chan < pmc->nchan; chan++)
2772 pmc->update[chan / 8] |= (1 << (chan % 8));
2774 usbd_transfer_start(sc->sc_mixer_xfer[0]);
2776 /* start HID volume keys, if any */
2777 usbd_transfer_start(sc->sc_hid.xfer[0]);
2778 mtx_unlock(sc->sc_mixer_lock);
2782 uaudio_mixer_add_ctl_sub(struct uaudio_softc *sc, struct uaudio_mixer_node *mc)
2784 struct uaudio_mixer_node *p_mc_new =
2785 malloc(sizeof(*p_mc_new), M_USBDEV, M_WAITOK);
2788 if (p_mc_new != NULL) {
2789 memcpy(p_mc_new, mc, sizeof(*p_mc_new));
2790 p_mc_new->next = sc->sc_mixer_root;
2791 sc->sc_mixer_root = p_mc_new;
2792 sc->sc_mixer_count++;
2794 /* set default value for all channels */
2795 for (ch = 0; ch < p_mc_new->nchan; ch++) {
2796 switch (p_mc_new->val_default) {
2799 p_mc_new->wData[ch] = (p_mc_new->maxval + p_mc_new->minval) / 2;
2803 p_mc_new->wData[ch] = p_mc_new->maxval;
2807 p_mc_new->wData[ch] = p_mc_new->minval;
2812 DPRINTF("out of memory\n");
2817 uaudio_mixer_add_ctl(struct uaudio_softc *sc, struct uaudio_mixer_node *mc)
2821 if (mc->class < UAC_NCLASSES) {
2822 DPRINTF("adding %s.%d\n",
2823 uac_names[mc->class], mc->ctl);
2825 DPRINTF("adding %d\n", mc->ctl);
2828 if (mc->type == MIX_ON_OFF) {
2831 } else if (mc->type == MIX_SELECTOR) {
2834 /* determine min and max values */
2836 mc->minval = uaudio_mixer_get(sc->sc_udev,
2837 sc->sc_audio_rev, GET_MIN, mc);
2838 mc->maxval = uaudio_mixer_get(sc->sc_udev,
2839 sc->sc_audio_rev, GET_MAX, mc);
2841 /* check if max and min was swapped */
2843 if (mc->maxval < mc->minval) {
2845 mc->maxval = mc->minval;
2849 /* compute value range */
2850 mc->mul = mc->maxval - mc->minval;
2854 /* compute value alignment */
2855 res = uaudio_mixer_get(sc->sc_udev,
2856 sc->sc_audio_rev, GET_RES, mc);
2858 DPRINTF("Resolution = %d\n", (int)res);
2861 uaudio_mixer_add_ctl_sub(sc, mc);
2864 if (uaudio_debug > 2) {
2867 for (i = 0; i < mc->nchan; i++) {
2868 DPRINTF("[mix] wValue=%04x\n", mc->wValue[0]);
2870 DPRINTF("[mix] wIndex=%04x type=%d ctl='%d' "
2872 mc->wIndex, mc->type, mc->ctl,
2873 mc->minval, mc->maxval);
2879 uaudio_mixer_add_mixer(struct uaudio_softc *sc,
2880 const struct uaudio_terminal_node *iot, int id)
2882 const struct usb_audio_mixer_unit_0 *d0 = iot[id].u.mu_v1;
2883 const struct usb_audio_mixer_unit_1 *d1;
2885 uint32_t bno; /* bit number */
2886 uint32_t p; /* bit number accumulator */
2887 uint32_t mo; /* matching outputs */
2888 uint32_t mc; /* matching channels */
2889 uint32_t ichs; /* input channels */
2890 uint32_t ochs; /* output channels */
2892 uint32_t chs; /* channels */
2896 DPRINTFN(3, "bUnitId=%d bNrInPins=%d\n",
2897 d0->bUnitId, d0->bNrInPins);
2899 /* compute the number of input channels */
2902 for (i = 0; i < d0->bNrInPins; i++) {
2903 ichs += uaudio_mixer_get_cluster(
2904 d0->baSourceId[i], iot).bNrChannels;
2907 d1 = (const void *)(d0->baSourceId + d0->bNrInPins);
2909 /* and the number of output channels */
2911 ochs = d1->bNrChannels;
2913 DPRINTFN(3, "ichs=%d ochs=%d\n", ichs, ochs);
2915 memset(&MIX(sc), 0, sizeof(MIX(sc)));
2917 MIX(sc).wIndex = MAKE_WORD(d0->bUnitId, sc->sc_mixer_iface_no);
2918 uaudio_mixer_determine_class(&iot[id], &MIX(sc));
2919 MIX(sc).type = MIX_SIGNED_16;
2921 if (uaudio_mixer_verify_desc(d0, ((ichs * ochs) + 7) / 8) == NULL)
2924 for (p = i = 0; i < d0->bNrInPins; i++) {
2925 chs = uaudio_mixer_get_cluster(
2926 d0->baSourceId[i], iot).bNrChannels;
2928 for (c = 0; c < chs; c++) {
2930 for (o = 0; o < ochs; o++) {
2931 bno = ((p + c) * ochs) + o;
2932 if (BIT_TEST(d1->bmControls, bno))
2938 if ((mc == chs) && (chs <= MIX_MAX_CHAN)) {
2940 /* repeat bit-scan */
2943 for (c = 0; c < chs; c++) {
2944 for (o = 0; o < ochs; o++) {
2945 bno = ((p + c) * ochs) + o;
2946 if (BIT_TEST(d1->bmControls, bno))
2947 MIX(sc).wValue[mc++] = MAKE_WORD(p + c + 1, o + 1);
2950 MIX(sc).nchan = chs;
2951 uaudio_mixer_add_ctl(sc, &MIX(sc));
2958 uaudio20_mixer_add_mixer(struct uaudio_softc *sc,
2959 const struct uaudio_terminal_node *iot, int id)
2961 const struct usb_audio20_mixer_unit_0 *d0 = iot[id].u.mu_v2;
2962 const struct usb_audio20_mixer_unit_1 *d1;
2964 uint32_t bno; /* bit number */
2965 uint32_t p; /* bit number accumulator */
2966 uint32_t mo; /* matching outputs */
2967 uint32_t mc; /* matching channels */
2968 uint32_t ichs; /* input channels */
2969 uint32_t ochs; /* output channels */
2971 uint32_t chs; /* channels */
2975 DPRINTFN(3, "bUnitId=%d bNrInPins=%d\n",
2976 d0->bUnitId, d0->bNrInPins);
2978 /* compute the number of input channels */
2981 for (i = 0; i < d0->bNrInPins; i++) {
2982 ichs += uaudio20_mixer_get_cluster(
2983 d0->baSourceId[i], iot).bNrChannels;
2986 d1 = (const void *)(d0->baSourceId + d0->bNrInPins);
2988 /* and the number of output channels */
2990 ochs = d1->bNrChannels;
2992 DPRINTFN(3, "ichs=%d ochs=%d\n", ichs, ochs);
2994 memset(&MIX(sc), 0, sizeof(MIX(sc)));
2996 MIX(sc).wIndex = MAKE_WORD(d0->bUnitId, sc->sc_mixer_iface_no);
2997 uaudio20_mixer_determine_class(&iot[id], &MIX(sc));
2998 MIX(sc).type = MIX_SIGNED_16;
3000 if (uaudio20_mixer_verify_desc(d0, ((ichs * ochs) + 7) / 8) == NULL)
3003 for (p = i = 0; i < d0->bNrInPins; i++) {
3004 chs = uaudio20_mixer_get_cluster(
3005 d0->baSourceId[i], iot).bNrChannels;
3007 for (c = 0; c < chs; c++) {
3009 for (o = 0; o < ochs; o++) {
3010 bno = ((p + c) * ochs) + o;
3011 if (BIT_TEST(d1->bmControls, bno))
3017 if ((mc == chs) && (chs <= MIX_MAX_CHAN)) {
3019 /* repeat bit-scan */
3022 for (c = 0; c < chs; c++) {
3023 for (o = 0; o < ochs; o++) {
3024 bno = ((p + c) * ochs) + o;
3025 if (BIT_TEST(d1->bmControls, bno))
3026 MIX(sc).wValue[mc++] = MAKE_WORD(p + c + 1, o + 1);
3029 MIX(sc).nchan = chs;
3030 uaudio_mixer_add_ctl(sc, &MIX(sc));
3037 uaudio_mixer_add_selector(struct uaudio_softc *sc,
3038 const struct uaudio_terminal_node *iot, int id)
3040 const struct usb_audio_selector_unit *d = iot[id].u.su_v1;
3043 DPRINTFN(3, "bUnitId=%d bNrInPins=%d\n",
3044 d->bUnitId, d->bNrInPins);
3046 if (d->bNrInPins == 0)
3049 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3051 MIX(sc).wIndex = MAKE_WORD(d->bUnitId, sc->sc_mixer_iface_no);
3052 MIX(sc).wValue[0] = MAKE_WORD(0, 0);
3053 uaudio_mixer_determine_class(&iot[id], &MIX(sc));
3055 MIX(sc).type = MIX_SELECTOR;
3056 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3058 MIX(sc).maxval = d->bNrInPins;
3059 MIX(sc).name = "selector";
3061 i = d->baSourceId[d->bNrInPins];
3063 usbd_req_get_string_any(sc->sc_udev, NULL,
3064 MIX(sc).desc, sizeof(MIX(sc).desc), i) != 0) {
3065 MIX(sc).desc[0] = 0;
3068 if (MIX(sc).maxval > MAX_SELECTOR_INPUT_PIN) {
3069 MIX(sc).maxval = MAX_SELECTOR_INPUT_PIN;
3071 MIX(sc).mul = (MIX(sc).maxval - MIX(sc).minval);
3072 for (i = 0; i < MAX_SELECTOR_INPUT_PIN; i++) {
3073 MIX(sc).slctrtype[i] = SOUND_MIXER_NRDEVICES;
3076 for (i = 0; i < MIX(sc).maxval; i++) {
3077 MIX(sc).slctrtype[i] = uaudio_mixer_feature_name(
3078 &iot[d->baSourceId[i]], &MIX(sc));
3081 MIX(sc).class = 0; /* not used */
3083 uaudio_mixer_add_ctl(sc, &MIX(sc));
3087 uaudio20_mixer_add_selector(struct uaudio_softc *sc,
3088 const struct uaudio_terminal_node *iot, int id)
3090 const struct usb_audio20_selector_unit *d = iot[id].u.su_v2;
3093 DPRINTFN(3, "bUnitId=%d bNrInPins=%d\n",
3094 d->bUnitId, d->bNrInPins);
3096 if (d->bNrInPins == 0)
3099 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3101 MIX(sc).wIndex = MAKE_WORD(d->bUnitId, sc->sc_mixer_iface_no);
3102 MIX(sc).wValue[0] = MAKE_WORD(0, 0);
3103 uaudio20_mixer_determine_class(&iot[id], &MIX(sc));
3105 MIX(sc).type = MIX_SELECTOR;
3106 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3108 MIX(sc).maxval = d->bNrInPins;
3109 MIX(sc).name = "selector";
3111 i = d->baSourceId[d->bNrInPins];
3113 usbd_req_get_string_any(sc->sc_udev, NULL,
3114 MIX(sc).desc, sizeof(MIX(sc).desc), i) != 0) {
3115 MIX(sc).desc[0] = 0;
3118 if (MIX(sc).maxval > MAX_SELECTOR_INPUT_PIN)
3119 MIX(sc).maxval = MAX_SELECTOR_INPUT_PIN;
3121 MIX(sc).mul = (MIX(sc).maxval - MIX(sc).minval);
3122 for (i = 0; i < MAX_SELECTOR_INPUT_PIN; i++)
3123 MIX(sc).slctrtype[i] = SOUND_MIXER_NRDEVICES;
3125 for (i = 0; i < MIX(sc).maxval; i++) {
3126 MIX(sc).slctrtype[i] = uaudio20_mixer_feature_name(
3127 &iot[d->baSourceId[i]], &MIX(sc));
3130 MIX(sc).class = 0; /* not used */
3132 uaudio_mixer_add_ctl(sc, &MIX(sc));
3136 uaudio_mixer_feature_get_bmaControls(const struct usb_audio_feature_unit *d,
3140 uint32_t offset = (i * d->bControlSize);
3142 if (d->bControlSize > 0) {
3143 temp |= d->bmaControls[offset];
3144 if (d->bControlSize > 1) {
3145 temp |= d->bmaControls[offset + 1] << 8;
3146 if (d->bControlSize > 2) {
3147 temp |= d->bmaControls[offset + 2] << 16;
3148 if (d->bControlSize > 3) {
3149 temp |= d->bmaControls[offset + 3] << 24;
3158 uaudio_mixer_add_feature(struct uaudio_softc *sc,
3159 const struct uaudio_terminal_node *iot, int id)
3161 const struct usb_audio_feature_unit *d = iot[id].u.fu_v1;
3165 uint16_t mixernumber;
3171 if (d->bControlSize == 0)
3174 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3176 nchan = (d->bLength - 7) / d->bControlSize;
3177 mmask = uaudio_mixer_feature_get_bmaControls(d, 0);
3183 /* figure out what we can control */
3185 for (chan = 1; chan < nchan; chan++) {
3186 DPRINTFN(10, "chan=%d mask=%x\n",
3187 chan, uaudio_mixer_feature_get_bmaControls(d, chan));
3189 cmask |= uaudio_mixer_feature_get_bmaControls(d, chan);
3192 if (nchan > MIX_MAX_CHAN) {
3193 nchan = MIX_MAX_CHAN;
3195 MIX(sc).wIndex = MAKE_WORD(d->bUnitId, sc->sc_mixer_iface_no);
3197 i = d->bmaControls[d->bControlSize];
3199 usbd_req_get_string_any(sc->sc_udev, NULL,
3200 MIX(sc).desc, sizeof(MIX(sc).desc), i) != 0) {
3201 MIX(sc).desc[0] = 0;
3204 for (ctl = 1; ctl <= LOUDNESS_CONTROL; ctl++) {
3206 fumask = FU_MASK(ctl);
3208 DPRINTFN(5, "ctl=%d fumask=0x%04x\n",
3211 if (mmask & fumask) {
3213 MIX(sc).wValue[0] = MAKE_WORD(ctl, 0);
3214 } else if (cmask & fumask) {
3215 MIX(sc).nchan = nchan - 1;
3216 for (i = 1; i < nchan; i++) {
3217 if (uaudio_mixer_feature_get_bmaControls(d, i) & fumask)
3218 MIX(sc).wValue[i - 1] = MAKE_WORD(ctl, i);
3220 MIX(sc).wValue[i - 1] = -1;
3226 mixernumber = uaudio_mixer_feature_name(&iot[id], &MIX(sc));
3230 MIX(sc).type = MIX_ON_OFF;
3231 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3232 MIX(sc).name = "mute";
3235 case VOLUME_CONTROL:
3236 MIX(sc).type = MIX_SIGNED_16;
3237 MIX(sc).ctl = mixernumber;
3238 MIX(sc).name = "vol";
3242 MIX(sc).type = MIX_SIGNED_8;
3243 MIX(sc).ctl = SOUND_MIXER_BASS;
3244 MIX(sc).name = "bass";
3248 MIX(sc).type = MIX_SIGNED_8;
3249 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3250 MIX(sc).name = "mid";
3253 case TREBLE_CONTROL:
3254 MIX(sc).type = MIX_SIGNED_8;
3255 MIX(sc).ctl = SOUND_MIXER_TREBLE;
3256 MIX(sc).name = "treble";
3259 case GRAPHIC_EQUALIZER_CONTROL:
3260 continue; /* XXX don't add anything */
3263 MIX(sc).type = MIX_ON_OFF;
3264 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3265 MIX(sc).name = "agc";
3269 MIX(sc).type = MIX_UNSIGNED_16;
3270 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3271 MIX(sc).name = "delay";
3274 case BASS_BOOST_CONTROL:
3275 MIX(sc).type = MIX_ON_OFF;
3276 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3277 MIX(sc).name = "boost";
3280 case LOUDNESS_CONTROL:
3281 MIX(sc).type = MIX_ON_OFF;
3282 MIX(sc).ctl = SOUND_MIXER_LOUD; /* Is this correct ? */
3283 MIX(sc).name = "loudness";
3287 MIX(sc).type = MIX_UNKNOWN;
3291 if (MIX(sc).type != MIX_UNKNOWN)
3292 uaudio_mixer_add_ctl(sc, &MIX(sc));
3297 uaudio20_mixer_add_feature(struct uaudio_softc *sc,
3298 const struct uaudio_terminal_node *iot, int id)
3300 const struct usb_audio20_feature_unit *d = iot[id].u.fu_v2;
3304 uint16_t mixernumber;
3310 if (UGETDW(d->bmaControls[0]) == 0)
3313 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3315 nchan = (d->bLength - 6) / 4;
3316 mmask = UGETDW(d->bmaControls[0]);
3322 /* figure out what we can control */
3324 for (chan = 1; chan < nchan; chan++)
3325 cmask |= UGETDW(d->bmaControls[chan]);
3327 if (nchan > MIX_MAX_CHAN)
3328 nchan = MIX_MAX_CHAN;
3330 MIX(sc).wIndex = MAKE_WORD(d->bUnitId, sc->sc_mixer_iface_no);
3332 i = d->bmaControls[nchan][0];
3334 usbd_req_get_string_any(sc->sc_udev, NULL,
3335 MIX(sc).desc, sizeof(MIX(sc).desc), i) != 0) {
3336 MIX(sc).desc[0] = 0;
3339 for (ctl = 3; ctl != 0; ctl <<= 2) {
3341 mixernumber = uaudio20_mixer_feature_name(&iot[id], &MIX(sc));
3345 MIX(sc).type = MIX_ON_OFF;
3346 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3347 MIX(sc).name = "mute";
3348 what = MUTE_CONTROL;
3351 MIX(sc).type = MIX_SIGNED_16;
3352 MIX(sc).ctl = mixernumber;
3353 MIX(sc).name = "vol";
3354 what = VOLUME_CONTROL;
3357 MIX(sc).type = MIX_SIGNED_8;
3358 MIX(sc).ctl = SOUND_MIXER_BASS;
3359 MIX(sc).name = "bass";
3360 what = BASS_CONTROL;
3363 MIX(sc).type = MIX_SIGNED_8;
3364 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3365 MIX(sc).name = "mid";
3369 MIX(sc).type = MIX_SIGNED_8;
3370 MIX(sc).ctl = SOUND_MIXER_TREBLE;
3371 MIX(sc).name = "treble";
3372 what = TREBLE_CONTROL;
3375 MIX(sc).type = MIX_ON_OFF;
3376 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3377 MIX(sc).name = "agc";
3381 MIX(sc).type = MIX_UNSIGNED_16;
3382 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3383 MIX(sc).name = "delay";
3384 what = DELAY_CONTROL;
3387 MIX(sc).type = MIX_ON_OFF;
3388 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3389 MIX(sc).name = "boost";
3390 what = BASS_BOOST_CONTROL;
3393 MIX(sc).type = MIX_ON_OFF;
3394 MIX(sc).ctl = SOUND_MIXER_LOUD; /* Is this correct ? */
3395 MIX(sc).name = "loudness";
3396 what = LOUDNESS_CONTROL;
3399 MIX(sc).type = MIX_SIGNED_16;
3400 MIX(sc).ctl = mixernumber;
3401 MIX(sc).name = "igain";
3402 what = INPUT_GAIN_CONTROL;
3405 MIX(sc).type = MIX_SIGNED_16;
3406 MIX(sc).ctl = mixernumber;
3407 MIX(sc).name = "igainpad";
3408 what = INPUT_GAIN_PAD_CONTROL;
3414 if ((mmask & ctl) == ctl) {
3416 MIX(sc).wValue[0] = MAKE_WORD(what, 0);
3417 } else if ((cmask & ctl) == ctl) {
3418 MIX(sc).nchan = nchan - 1;
3419 for (i = 1; i < nchan; i++) {
3420 if ((UGETDW(d->bmaControls[i]) & ctl) == ctl)
3421 MIX(sc).wValue[i - 1] = MAKE_WORD(what, i);
3423 MIX(sc).wValue[i - 1] = -1;
3429 if (MIX(sc).type != MIX_UNKNOWN)
3430 uaudio_mixer_add_ctl(sc, &MIX(sc));
3435 uaudio_mixer_add_processing_updown(struct uaudio_softc *sc,
3436 const struct uaudio_terminal_node *iot, int id)
3438 const struct usb_audio_processing_unit_0 *d0 = iot[id].u.pu_v1;
3439 const struct usb_audio_processing_unit_1 *d1 =
3440 (const void *)(d0->baSourceId + d0->bNrInPins);
3441 const struct usb_audio_processing_unit_updown *ud =
3442 (const void *)(d1->bmControls + d1->bControlSize);
3445 if (uaudio_mixer_verify_desc(d0, sizeof(*ud)) == NULL) {
3448 if (uaudio_mixer_verify_desc(d0, sizeof(*ud) + (2 * ud->bNrModes))
3452 DPRINTFN(3, "bUnitId=%d bNrModes=%d\n",
3453 d0->bUnitId, ud->bNrModes);
3455 if (!(d1->bmControls[0] & UA_PROC_MASK(UD_MODE_SELECT_CONTROL))) {
3456 DPRINTF("no mode select\n");
3459 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3461 MIX(sc).wIndex = MAKE_WORD(d0->bUnitId, sc->sc_mixer_iface_no);
3463 MIX(sc).wValue[0] = MAKE_WORD(UD_MODE_SELECT_CONTROL, 0);
3464 uaudio_mixer_determine_class(&iot[id], &MIX(sc));
3465 MIX(sc).type = MIX_ON_OFF; /* XXX */
3467 for (i = 0; i < ud->bNrModes; i++) {
3468 DPRINTFN(3, "i=%d bm=0x%x\n", i, UGETW(ud->waModes[i]));
3472 uaudio_mixer_add_ctl(sc, &MIX(sc));
3476 uaudio_mixer_add_processing(struct uaudio_softc *sc,
3477 const struct uaudio_terminal_node *iot, int id)
3479 const struct usb_audio_processing_unit_0 *d0 = iot[id].u.pu_v1;
3480 const struct usb_audio_processing_unit_1 *d1 =
3481 (const void *)(d0->baSourceId + d0->bNrInPins);
3484 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3486 ptype = UGETW(d0->wProcessType);
3488 DPRINTFN(3, "wProcessType=%d bUnitId=%d "
3489 "bNrInPins=%d\n", ptype, d0->bUnitId, d0->bNrInPins);
3491 if (d1->bControlSize == 0) {
3494 if (d1->bmControls[0] & UA_PROC_ENABLE_MASK) {
3495 MIX(sc).wIndex = MAKE_WORD(d0->bUnitId, sc->sc_mixer_iface_no);
3497 MIX(sc).wValue[0] = MAKE_WORD(XX_ENABLE_CONTROL, 0);
3498 uaudio_mixer_determine_class(&iot[id], &MIX(sc));
3499 MIX(sc).type = MIX_ON_OFF;
3500 uaudio_mixer_add_ctl(sc, &MIX(sc));
3503 case UPDOWNMIX_PROCESS:
3504 uaudio_mixer_add_processing_updown(sc, iot, id);
3507 case DOLBY_PROLOGIC_PROCESS:
3508 case P3D_STEREO_EXTENDER_PROCESS:
3509 case REVERBATION_PROCESS:
3510 case CHORUS_PROCESS:
3511 case DYN_RANGE_COMP_PROCESS:
3513 DPRINTF("unit %d, type=%d is not implemented\n",
3514 d0->bUnitId, ptype);
3520 uaudio_mixer_add_extension(struct uaudio_softc *sc,
3521 const struct uaudio_terminal_node *iot, int id)
3523 const struct usb_audio_extension_unit_0 *d0 = iot[id].u.eu_v1;
3524 const struct usb_audio_extension_unit_1 *d1 =
3525 (const void *)(d0->baSourceId + d0->bNrInPins);
3527 DPRINTFN(3, "bUnitId=%d bNrInPins=%d\n",
3528 d0->bUnitId, d0->bNrInPins);
3530 if (sc->sc_uq_au_no_xu) {
3533 if (d1->bControlSize == 0) {
3536 if (d1->bmControls[0] & UA_EXT_ENABLE_MASK) {
3538 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3540 MIX(sc).wIndex = MAKE_WORD(d0->bUnitId, sc->sc_mixer_iface_no);
3542 MIX(sc).wValue[0] = MAKE_WORD(UA_EXT_ENABLE, 0);
3543 uaudio_mixer_determine_class(&iot[id], &MIX(sc));
3544 MIX(sc).type = MIX_ON_OFF;
3546 uaudio_mixer_add_ctl(sc, &MIX(sc));
3551 uaudio_mixer_verify_desc(const void *arg, uint32_t len)
3553 const struct usb_audio_mixer_unit_1 *d1;
3554 const struct usb_audio_extension_unit_1 *e1;
3555 const struct usb_audio_processing_unit_1 *u1;
3558 const struct usb_descriptor *desc;
3559 const struct usb_audio_input_terminal *it;
3560 const struct usb_audio_output_terminal *ot;
3561 const struct usb_audio_mixer_unit_0 *mu;
3562 const struct usb_audio_selector_unit *su;
3563 const struct usb_audio_feature_unit *fu;
3564 const struct usb_audio_processing_unit_0 *pu;
3565 const struct usb_audio_extension_unit_0 *eu;
3570 if (u.desc == NULL) {
3573 if (u.desc->bDescriptorType != UDESC_CS_INTERFACE) {
3576 switch (u.desc->bDescriptorSubtype) {
3577 case UDESCSUB_AC_INPUT:
3578 len += sizeof(*u.it);
3581 case UDESCSUB_AC_OUTPUT:
3582 len += sizeof(*u.ot);
3585 case UDESCSUB_AC_MIXER:
3586 len += sizeof(*u.mu);
3588 if (u.desc->bLength < len) {
3591 len += u.mu->bNrInPins;
3593 if (u.desc->bLength < len) {
3596 d1 = (const void *)(u.mu->baSourceId + u.mu->bNrInPins);
3601 case UDESCSUB_AC_SELECTOR:
3602 len += sizeof(*u.su);
3604 if (u.desc->bLength < len) {
3607 len += u.su->bNrInPins + 1;
3610 case UDESCSUB_AC_FEATURE:
3611 len += sizeof(*u.fu) + 1;
3613 if (u.desc->bLength < len)
3616 len += u.fu->bControlSize;
3619 case UDESCSUB_AC_PROCESSING:
3620 len += sizeof(*u.pu);
3622 if (u.desc->bLength < len) {
3625 len += u.pu->bNrInPins;
3627 if (u.desc->bLength < len) {
3630 u1 = (const void *)(u.pu->baSourceId + u.pu->bNrInPins);
3634 if (u.desc->bLength < len) {
3637 len += u1->bControlSize;
3641 case UDESCSUB_AC_EXTENSION:
3642 len += sizeof(*u.eu);
3644 if (u.desc->bLength < len) {
3647 len += u.eu->bNrInPins;
3649 if (u.desc->bLength < len) {
3652 e1 = (const void *)(u.eu->baSourceId + u.eu->bNrInPins);
3656 if (u.desc->bLength < len) {
3659 len += e1->bControlSize;
3666 if (u.desc->bLength < len) {
3673 DPRINTF("invalid descriptor, type=%d, "
3674 "sub_type=%d, len=%d of %d bytes\n",
3675 u.desc->bDescriptorType,
3676 u.desc->bDescriptorSubtype,
3677 u.desc->bLength, len);
3683 uaudio20_mixer_verify_desc(const void *arg, uint32_t len)
3685 const struct usb_audio20_mixer_unit_1 *d1;
3686 const struct usb_audio20_extension_unit_1 *e1;
3687 const struct usb_audio20_processing_unit_1 *u1;
3688 const struct usb_audio20_clock_selector_unit_1 *c1;
3691 const struct usb_descriptor *desc;
3692 const struct usb_audio20_clock_source_unit *csrc;
3693 const struct usb_audio20_clock_selector_unit_0 *csel;
3694 const struct usb_audio20_clock_multiplier_unit *cmul;
3695 const struct usb_audio20_input_terminal *it;
3696 const struct usb_audio20_output_terminal *ot;
3697 const struct usb_audio20_mixer_unit_0 *mu;
3698 const struct usb_audio20_selector_unit *su;
3699 const struct usb_audio20_feature_unit *fu;
3700 const struct usb_audio20_sample_rate_unit *ru;
3701 const struct usb_audio20_processing_unit_0 *pu;
3702 const struct usb_audio20_extension_unit_0 *eu;
3703 const struct usb_audio20_effect_unit *ef;
3711 if (u.desc->bDescriptorType != UDESC_CS_INTERFACE)
3714 switch (u.desc->bDescriptorSubtype) {
3715 case UDESCSUB_AC_INPUT:
3716 len += sizeof(*u.it);
3719 case UDESCSUB_AC_OUTPUT:
3720 len += sizeof(*u.ot);
3723 case UDESCSUB_AC_MIXER:
3724 len += sizeof(*u.mu);
3726 if (u.desc->bLength < len)
3728 len += u.mu->bNrInPins;
3730 if (u.desc->bLength < len)
3733 d1 = (const void *)(u.mu->baSourceId + u.mu->bNrInPins);
3735 len += sizeof(*d1) + d1->bNrChannels;
3738 case UDESCSUB_AC_SELECTOR:
3739 len += sizeof(*u.su);
3741 if (u.desc->bLength < len)
3744 len += u.su->bNrInPins + 1;
3747 case UDESCSUB_AC_FEATURE:
3748 len += sizeof(*u.fu) + 1;
3751 case UDESCSUB_AC_EFFECT:
3752 len += sizeof(*u.ef) + 4;
3755 case UDESCSUB_AC_PROCESSING_V2:
3756 len += sizeof(*u.pu);
3758 if (u.desc->bLength < len)
3761 len += u.pu->bNrInPins;
3763 if (u.desc->bLength < len)
3766 u1 = (const void *)(u.pu->baSourceId + u.pu->bNrInPins);
3771 case UDESCSUB_AC_EXTENSION_V2:
3772 len += sizeof(*u.eu);
3774 if (u.desc->bLength < len)
3777 len += u.eu->bNrInPins;
3779 if (u.desc->bLength < len)
3782 e1 = (const void *)(u.eu->baSourceId + u.eu->bNrInPins);
3787 case UDESCSUB_AC_CLOCK_SRC:
3788 len += sizeof(*u.csrc);
3791 case UDESCSUB_AC_CLOCK_SEL:
3792 len += sizeof(*u.csel);
3794 if (u.desc->bLength < len)
3797 len += u.csel->bNrInPins;
3799 if (u.desc->bLength < len)
3802 c1 = (const void *)(u.csel->baCSourceId + u.csel->bNrInPins);
3807 case UDESCSUB_AC_CLOCK_MUL:
3808 len += sizeof(*u.cmul);
3811 case UDESCSUB_AC_SAMPLE_RT:
3812 len += sizeof(*u.ru);
3819 if (u.desc->bLength < len)
3826 DPRINTF("invalid descriptor, type=%d, "
3827 "sub_type=%d, len=%d of %d bytes\n",
3828 u.desc->bDescriptorType,
3829 u.desc->bDescriptorSubtype,
3830 u.desc->bLength, len);
3835 static struct usb_audio_cluster
3836 uaudio_mixer_get_cluster(uint8_t id, const struct uaudio_terminal_node *iot)
3838 struct usb_audio_cluster r;
3839 const struct usb_descriptor *dp;
3842 for (i = 0; i < UAUDIO_RECURSE_LIMIT; i++) { /* avoid infinite loops */
3843 dp = iot[id].u.desc;
3847 switch (dp->bDescriptorSubtype) {
3848 case UDESCSUB_AC_INPUT:
3849 r.bNrChannels = iot[id].u.it_v1->bNrChannels;
3850 r.wChannelConfig[0] = iot[id].u.it_v1->wChannelConfig[0];
3851 r.wChannelConfig[1] = iot[id].u.it_v1->wChannelConfig[1];
3852 r.iChannelNames = iot[id].u.it_v1->iChannelNames;
3855 case UDESCSUB_AC_OUTPUT:
3856 id = iot[id].u.ot_v1->bSourceId;
3859 case UDESCSUB_AC_MIXER:
3860 r = *(const struct usb_audio_cluster *)
3861 &iot[id].u.mu_v1->baSourceId[
3862 iot[id].u.mu_v1->bNrInPins];
3865 case UDESCSUB_AC_SELECTOR:
3866 if (iot[id].u.su_v1->bNrInPins > 0) {
3867 /* XXX This is not really right */
3868 id = iot[id].u.su_v1->baSourceId[0];
3872 case UDESCSUB_AC_FEATURE:
3873 id = iot[id].u.fu_v1->bSourceId;
3876 case UDESCSUB_AC_PROCESSING:
3877 r = *((const struct usb_audio_cluster *)
3878 &iot[id].u.pu_v1->baSourceId[
3879 iot[id].u.pu_v1->bNrInPins]);
3882 case UDESCSUB_AC_EXTENSION:
3883 r = *((const struct usb_audio_cluster *)
3884 &iot[id].u.eu_v1->baSourceId[
3885 iot[id].u.eu_v1->bNrInPins]);
3893 DPRINTF("bad data\n");
3894 memset(&r, 0, sizeof(r));
3899 static struct usb_audio20_cluster
3900 uaudio20_mixer_get_cluster(uint8_t id, const struct uaudio_terminal_node *iot)
3902 struct usb_audio20_cluster r;
3903 const struct usb_descriptor *dp;
3906 for (i = 0; i < UAUDIO_RECURSE_LIMIT; i++) { /* avoid infinite loops */
3907 dp = iot[id].u.desc;
3911 switch (dp->bDescriptorSubtype) {
3912 case UDESCSUB_AC_INPUT:
3913 r.bNrChannels = iot[id].u.it_v2->bNrChannels;
3914 r.bmChannelConfig[0] = iot[id].u.it_v2->bmChannelConfig[0];
3915 r.bmChannelConfig[1] = iot[id].u.it_v2->bmChannelConfig[1];
3916 r.bmChannelConfig[2] = iot[id].u.it_v2->bmChannelConfig[2];
3917 r.bmChannelConfig[3] = iot[id].u.it_v2->bmChannelConfig[3];
3918 r.iChannelNames = iot[id].u.it_v2->iTerminal;
3921 case UDESCSUB_AC_OUTPUT:
3922 id = iot[id].u.ot_v2->bSourceId;
3925 case UDESCSUB_AC_MIXER:
3926 r = *(const struct usb_audio20_cluster *)
3927 &iot[id].u.mu_v2->baSourceId[
3928 iot[id].u.mu_v2->bNrInPins];
3931 case UDESCSUB_AC_SELECTOR:
3932 if (iot[id].u.su_v2->bNrInPins > 0) {
3933 /* XXX This is not really right */
3934 id = iot[id].u.su_v2->baSourceId[0];
3938 case UDESCSUB_AC_SAMPLE_RT:
3939 id = iot[id].u.ru_v2->bSourceId;
3942 case UDESCSUB_AC_EFFECT:
3943 id = iot[id].u.ef_v2->bSourceId;
3946 case UDESCSUB_AC_FEATURE:
3947 id = iot[id].u.fu_v2->bSourceId;
3950 case UDESCSUB_AC_PROCESSING_V2:
3951 r = *((const struct usb_audio20_cluster *)
3952 &iot[id].u.pu_v2->baSourceId[
3953 iot[id].u.pu_v2->bNrInPins]);
3956 case UDESCSUB_AC_EXTENSION_V2:
3957 r = *((const struct usb_audio20_cluster *)
3958 &iot[id].u.eu_v2->baSourceId[
3959 iot[id].u.eu_v2->bNrInPins]);
3967 DPRINTF("Bad data!\n");
3968 memset(&r, 0, sizeof(r));
3974 uaudio_mixer_determine_class(const struct uaudio_terminal_node *iot,
3975 struct uaudio_mixer_node *mix)
3977 uint16_t terminal_type = 0x0000;
3978 const struct uaudio_terminal_node *input[2];
3979 const struct uaudio_terminal_node *output[2];
3981 input[0] = uaudio_mixer_get_input(iot, 0);
3982 input[1] = uaudio_mixer_get_input(iot, 1);
3984 output[0] = uaudio_mixer_get_output(iot, 0);
3985 output[1] = uaudio_mixer_get_output(iot, 1);
3988 * check if there is only
3989 * one output terminal:
3991 if (output[0] && (!output[1])) {
3993 UGETW(output[0]->u.ot_v1->wTerminalType);
3996 * If the only output terminal is USB,
3997 * the class is UAC_RECORD.
3999 if ((terminal_type & 0xff00) == (UAT_UNDEFINED & 0xff00)) {
4001 mix->class = UAC_RECORD;
4002 if (input[0] && (!input[1])) {
4004 UGETW(input[0]->u.it_v1->wTerminalType);
4011 * if the unit is connected to just
4012 * one input terminal, the
4013 * class is UAC_INPUT:
4015 if (input[0] && (!input[1])) {
4016 mix->class = UAC_INPUT;
4018 UGETW(input[0]->u.it_v1->wTerminalType);
4022 * Otherwise, the class is UAC_OUTPUT.
4024 mix->class = UAC_OUTPUT;
4026 return (terminal_type);
4030 uaudio20_mixer_determine_class(const struct uaudio_terminal_node *iot,
4031 struct uaudio_mixer_node *mix)
4033 uint16_t terminal_type = 0x0000;
4034 const struct uaudio_terminal_node *input[2];
4035 const struct uaudio_terminal_node *output[2];
4037 input[0] = uaudio_mixer_get_input(iot, 0);
4038 input[1] = uaudio_mixer_get_input(iot, 1);
4040 output[0] = uaudio_mixer_get_output(iot, 0);
4041 output[1] = uaudio_mixer_get_output(iot, 1);
4044 * check if there is only
4045 * one output terminal:
4047 if (output[0] && (!output[1]))
4048 terminal_type = UGETW(output[0]->u.ot_v2->wTerminalType);
4050 * If the only output terminal is USB,
4051 * the class is UAC_RECORD.
4053 if ((terminal_type & 0xff00) == (UAT_UNDEFINED & 0xff00)) {
4055 mix->class = UAC_RECORD;
4056 if (input[0] && (!input[1])) {
4058 UGETW(input[0]->u.it_v2->wTerminalType);
4065 * if the unit is connected to just
4066 * one input terminal, the
4067 * class is UAC_INPUT:
4069 if (input[0] && (!input[1])) {
4070 mix->class = UAC_INPUT;
4072 UGETW(input[0]->u.it_v2->wTerminalType);
4076 * Otherwise, the class is UAC_OUTPUT.
4078 mix->class = UAC_OUTPUT;
4080 return (terminal_type);
4083 struct uaudio_tt_to_feature {
4084 uint16_t terminal_type;
4088 static const struct uaudio_tt_to_feature uaudio_tt_to_feature[] = {
4090 {UAT_STREAM, SOUND_MIXER_PCM},
4092 {UATI_MICROPHONE, SOUND_MIXER_MIC},
4093 {UATI_DESKMICROPHONE, SOUND_MIXER_MIC},
4094 {UATI_PERSONALMICROPHONE, SOUND_MIXER_MIC},
4095 {UATI_OMNIMICROPHONE, SOUND_MIXER_MIC},
4096 {UATI_MICROPHONEARRAY, SOUND_MIXER_MIC},
4097 {UATI_PROCMICROPHONEARR, SOUND_MIXER_MIC},
4099 {UATO_SPEAKER, SOUND_MIXER_SPEAKER},
4100 {UATO_DESKTOPSPEAKER, SOUND_MIXER_SPEAKER},
4101 {UATO_ROOMSPEAKER, SOUND_MIXER_SPEAKER},
4102 {UATO_COMMSPEAKER, SOUND_MIXER_SPEAKER},
4104 {UATE_ANALOGCONN, SOUND_MIXER_LINE},
4105 {UATE_LINECONN, SOUND_MIXER_LINE},
4106 {UATE_LEGACYCONN, SOUND_MIXER_LINE},
4108 {UATE_DIGITALAUIFC, SOUND_MIXER_ALTPCM},
4109 {UATE_SPDIF, SOUND_MIXER_ALTPCM},
4110 {UATE_1394DA, SOUND_MIXER_ALTPCM},
4111 {UATE_1394DV, SOUND_MIXER_ALTPCM},
4113 {UATF_CDPLAYER, SOUND_MIXER_CD},
4115 {UATF_SYNTHESIZER, SOUND_MIXER_SYNTH},
4117 {UATF_VIDEODISCAUDIO, SOUND_MIXER_VIDEO},
4118 {UATF_DVDAUDIO, SOUND_MIXER_VIDEO},
4119 {UATF_TVTUNERAUDIO, SOUND_MIXER_VIDEO},
4121 /* telephony terminal types */
4122 {UATT_UNDEFINED, SOUND_MIXER_PHONEIN}, /* SOUND_MIXER_PHONEOUT */
4123 {UATT_PHONELINE, SOUND_MIXER_PHONEIN}, /* SOUND_MIXER_PHONEOUT */
4124 {UATT_TELEPHONE, SOUND_MIXER_PHONEIN}, /* SOUND_MIXER_PHONEOUT */
4125 {UATT_DOWNLINEPHONE, SOUND_MIXER_PHONEIN}, /* SOUND_MIXER_PHONEOUT */
4127 {UATF_RADIORECV, SOUND_MIXER_RADIO},
4128 {UATF_RADIOXMIT, SOUND_MIXER_RADIO},
4130 {UAT_UNDEFINED, SOUND_MIXER_VOLUME},
4131 {UAT_VENDOR, SOUND_MIXER_VOLUME},
4132 {UATI_UNDEFINED, SOUND_MIXER_VOLUME},
4134 /* output terminal types */
4135 {UATO_UNDEFINED, SOUND_MIXER_VOLUME},
4136 {UATO_DISPLAYAUDIO, SOUND_MIXER_VOLUME},
4137 {UATO_SUBWOOFER, SOUND_MIXER_VOLUME},
4138 {UATO_HEADPHONES, SOUND_MIXER_VOLUME},
4140 /* bidir terminal types */
4141 {UATB_UNDEFINED, SOUND_MIXER_VOLUME},
4142 {UATB_HANDSET, SOUND_MIXER_VOLUME},
4143 {UATB_HEADSET, SOUND_MIXER_VOLUME},
4144 {UATB_SPEAKERPHONE, SOUND_MIXER_VOLUME},
4145 {UATB_SPEAKERPHONEESUP, SOUND_MIXER_VOLUME},
4146 {UATB_SPEAKERPHONEECANC, SOUND_MIXER_VOLUME},
4148 /* external terminal types */
4149 {UATE_UNDEFINED, SOUND_MIXER_VOLUME},
4151 /* embedded function terminal types */
4152 {UATF_UNDEFINED, SOUND_MIXER_VOLUME},
4153 {UATF_CALIBNOISE, SOUND_MIXER_VOLUME},
4154 {UATF_EQUNOISE, SOUND_MIXER_VOLUME},
4155 {UATF_DAT, SOUND_MIXER_VOLUME},
4156 {UATF_DCC, SOUND_MIXER_VOLUME},
4157 {UATF_MINIDISK, SOUND_MIXER_VOLUME},
4158 {UATF_ANALOGTAPE, SOUND_MIXER_VOLUME},
4159 {UATF_PHONOGRAPH, SOUND_MIXER_VOLUME},
4160 {UATF_VCRAUDIO, SOUND_MIXER_VOLUME},
4161 {UATF_SATELLITE, SOUND_MIXER_VOLUME},
4162 {UATF_CABLETUNER, SOUND_MIXER_VOLUME},
4163 {UATF_DSS, SOUND_MIXER_VOLUME},
4164 {UATF_MULTITRACK, SOUND_MIXER_VOLUME},
4165 {0xffff, SOUND_MIXER_VOLUME},
4168 {0x0000, SOUND_MIXER_VOLUME},
4172 uaudio_mixer_feature_name(const struct uaudio_terminal_node *iot,
4173 struct uaudio_mixer_node *mix)
4175 const struct uaudio_tt_to_feature *uat = uaudio_tt_to_feature;
4176 uint16_t terminal_type = uaudio_mixer_determine_class(iot, mix);
4178 if ((mix->class == UAC_RECORD) && (terminal_type == 0)) {
4179 return (SOUND_MIXER_IMIX);
4181 while (uat->terminal_type) {
4182 if (uat->terminal_type == terminal_type) {
4188 DPRINTF("terminal_type=0x%04x -> %d\n",
4189 terminal_type, uat->feature);
4191 return (uat->feature);
4195 uaudio20_mixer_feature_name(const struct uaudio_terminal_node *iot,
4196 struct uaudio_mixer_node *mix)
4198 const struct uaudio_tt_to_feature *uat;
4199 uint16_t terminal_type = uaudio20_mixer_determine_class(iot, mix);
4201 if ((mix->class == UAC_RECORD) && (terminal_type == 0))
4202 return (SOUND_MIXER_IMIX);
4204 for (uat = uaudio_tt_to_feature; uat->terminal_type != 0; uat++) {
4205 if (uat->terminal_type == terminal_type)
4209 DPRINTF("terminal_type=0x%04x -> %d\n",
4210 terminal_type, uat->feature);
4212 return (uat->feature);
4215 static const struct uaudio_terminal_node *
4216 uaudio_mixer_get_input(const struct uaudio_terminal_node *iot, uint8_t i)
4218 struct uaudio_terminal_node *root = iot->root;
4221 n = iot->usr.id_max;
4223 if (iot->usr.bit_input[n / 8] & (1 << (n % 8))) {
4232 static const struct uaudio_terminal_node *
4233 uaudio_mixer_get_output(const struct uaudio_terminal_node *iot, uint8_t i)
4235 struct uaudio_terminal_node *root = iot->root;
4238 n = iot->usr.id_max;
4240 if (iot->usr.bit_output[n / 8] & (1 << (n % 8))) {
4250 uaudio_mixer_find_inputs_sub(struct uaudio_terminal_node *root,
4251 const uint8_t *p_id, uint8_t n_id,
4252 struct uaudio_search_result *info)
4254 struct uaudio_terminal_node *iot;
4260 for (n = 0; n < n_id; n++) {
4264 if (info->recurse_level == UAUDIO_RECURSE_LIMIT) {
4265 DPRINTF("avoided going into a circle at id=%d!\n", i);
4269 info->recurse_level++;
4273 if (iot->u.desc == NULL)
4276 is_last = ((n + 1) == n_id);
4278 switch (iot->u.desc->bDescriptorSubtype) {
4279 case UDESCSUB_AC_INPUT:
4280 info->bit_input[i / 8] |= (1 << (i % 8));
4283 case UDESCSUB_AC_FEATURE:
4285 p_id = &iot->u.fu_v1->bSourceId;
4289 uaudio_mixer_find_inputs_sub(
4290 root, &iot->u.fu_v1->bSourceId, 1, info);
4293 case UDESCSUB_AC_OUTPUT:
4295 p_id = &iot->u.ot_v1->bSourceId;
4299 uaudio_mixer_find_inputs_sub(
4300 root, &iot->u.ot_v1->bSourceId, 1, info);
4303 case UDESCSUB_AC_MIXER:
4305 p_id = iot->u.mu_v1->baSourceId;
4306 n_id = iot->u.mu_v1->bNrInPins;
4309 uaudio_mixer_find_inputs_sub(
4310 root, iot->u.mu_v1->baSourceId,
4311 iot->u.mu_v1->bNrInPins, info);
4314 case UDESCSUB_AC_SELECTOR:
4316 p_id = iot->u.su_v1->baSourceId;
4317 n_id = iot->u.su_v1->bNrInPins;
4320 uaudio_mixer_find_inputs_sub(
4321 root, iot->u.su_v1->baSourceId,
4322 iot->u.su_v1->bNrInPins, info);
4325 case UDESCSUB_AC_PROCESSING:
4327 p_id = iot->u.pu_v1->baSourceId;
4328 n_id = iot->u.pu_v1->bNrInPins;
4331 uaudio_mixer_find_inputs_sub(
4332 root, iot->u.pu_v1->baSourceId,
4333 iot->u.pu_v1->bNrInPins, info);
4336 case UDESCSUB_AC_EXTENSION:
4338 p_id = iot->u.eu_v1->baSourceId;
4339 n_id = iot->u.eu_v1->bNrInPins;
4342 uaudio_mixer_find_inputs_sub(
4343 root, iot->u.eu_v1->baSourceId,
4344 iot->u.eu_v1->bNrInPins, info);
4354 uaudio20_mixer_find_inputs_sub(struct uaudio_terminal_node *root,
4355 const uint8_t *p_id, uint8_t n_id,
4356 struct uaudio_search_result *info)
4358 struct uaudio_terminal_node *iot;
4364 for (n = 0; n < n_id; n++) {
4368 if (info->recurse_level == UAUDIO_RECURSE_LIMIT) {
4369 DPRINTF("avoided going into a circle at id=%d!\n", i);
4373 info->recurse_level++;
4377 if (iot->u.desc == NULL)
4380 is_last = ((n + 1) == n_id);
4382 switch (iot->u.desc->bDescriptorSubtype) {
4383 case UDESCSUB_AC_INPUT:
4384 info->bit_input[i / 8] |= (1 << (i % 8));
4387 case UDESCSUB_AC_OUTPUT:
4389 p_id = &iot->u.ot_v2->bSourceId;
4393 uaudio20_mixer_find_inputs_sub(
4394 root, &iot->u.ot_v2->bSourceId, 1, info);
4397 case UDESCSUB_AC_MIXER:
4399 p_id = iot->u.mu_v2->baSourceId;
4400 n_id = iot->u.mu_v2->bNrInPins;
4403 uaudio20_mixer_find_inputs_sub(
4404 root, iot->u.mu_v2->baSourceId,
4405 iot->u.mu_v2->bNrInPins, info);
4408 case UDESCSUB_AC_SELECTOR:
4410 p_id = iot->u.su_v2->baSourceId;
4411 n_id = iot->u.su_v2->bNrInPins;
4414 uaudio20_mixer_find_inputs_sub(
4415 root, iot->u.su_v2->baSourceId,
4416 iot->u.su_v2->bNrInPins, info);
4419 case UDESCSUB_AC_SAMPLE_RT:
4421 p_id = &iot->u.ru_v2->bSourceId;
4425 uaudio20_mixer_find_inputs_sub(
4426 root, &iot->u.ru_v2->bSourceId,
4430 case UDESCSUB_AC_EFFECT:
4432 p_id = &iot->u.ef_v2->bSourceId;
4436 uaudio20_mixer_find_inputs_sub(
4437 root, &iot->u.ef_v2->bSourceId,
4441 case UDESCSUB_AC_FEATURE:
4443 p_id = &iot->u.fu_v2->bSourceId;
4447 uaudio20_mixer_find_inputs_sub(
4448 root, &iot->u.fu_v2->bSourceId, 1, info);
4451 case UDESCSUB_AC_PROCESSING_V2:
4453 p_id = iot->u.pu_v2->baSourceId;
4454 n_id = iot->u.pu_v2->bNrInPins;
4457 uaudio20_mixer_find_inputs_sub(
4458 root, iot->u.pu_v2->baSourceId,
4459 iot->u.pu_v2->bNrInPins, info);
4462 case UDESCSUB_AC_EXTENSION_V2:
4464 p_id = iot->u.eu_v2->baSourceId;
4465 n_id = iot->u.eu_v2->bNrInPins;
4468 uaudio20_mixer_find_inputs_sub(
4469 root, iot->u.eu_v2->baSourceId,
4470 iot->u.eu_v2->bNrInPins, info);
4479 uaudio20_mixer_find_clocks_sub(struct uaudio_terminal_node *root,
4480 const uint8_t *p_id, uint8_t n_id,
4481 struct uaudio_search_result *info)
4483 struct uaudio_terminal_node *iot;
4490 for (n = 0; n < n_id; n++) {
4494 if (info->recurse_level == UAUDIO_RECURSE_LIMIT) {
4495 DPRINTF("avoided going into a circle at id=%d!\n", i);
4499 info->recurse_level++;
4503 if (iot->u.desc == NULL)
4506 is_last = ((n + 1) == n_id);
4508 switch (iot->u.desc->bDescriptorSubtype) {
4509 case UDESCSUB_AC_INPUT:
4512 p_id = &iot->u.it_v2->bCSourceId;
4516 uaudio20_mixer_find_clocks_sub(root,
4517 &iot->u.it_v2->bCSourceId, 1, info);
4520 case UDESCSUB_AC_OUTPUT:
4523 p_id = &iot->u.ot_v2->bCSourceId;
4527 uaudio20_mixer_find_clocks_sub(root,
4528 &iot->u.ot_v2->bCSourceId, 1, info);
4531 case UDESCSUB_AC_CLOCK_SEL:
4533 p_id = iot->u.csel_v2->baCSourceId;
4534 n_id = iot->u.csel_v2->bNrInPins;
4537 uaudio20_mixer_find_clocks_sub(root,
4538 iot->u.csel_v2->baCSourceId,
4539 iot->u.csel_v2->bNrInPins, info);
4542 case UDESCSUB_AC_CLOCK_MUL:
4544 p_id = &iot->u.cmul_v2->bCSourceId;
4548 uaudio20_mixer_find_clocks_sub(root,
4549 &iot->u.cmul_v2->bCSourceId,
4553 case UDESCSUB_AC_CLOCK_SRC:
4555 id = iot->u.csrc_v2->bClockId;
4557 switch (info->is_input) {
4559 info->bit_output[id / 8] |= (1 << (id % 8));
4562 info->bit_input[id / 8] |= (1 << (id % 8));
4576 uaudio_mixer_find_outputs_sub(struct uaudio_terminal_node *root, uint8_t id,
4577 uint8_t n_id, struct uaudio_search_result *info)
4579 struct uaudio_terminal_node *iot = (root + id);
4584 if ((j != id) && ((root + j)->u.desc) &&
4585 ((root + j)->u.desc->bDescriptorSubtype == UDESCSUB_AC_OUTPUT)) {
4588 * "j" (output) <--- virtual wire <--- "id" (input)
4590 * if "j" has "id" on the input, then "id" have "j" on
4591 * the output, because they are connected:
4593 if ((root + j)->usr.bit_input[id / 8] & (1 << (id % 8))) {
4594 iot->usr.bit_output[j / 8] |= (1 << (j % 8));
4601 uaudio_mixer_fill_info(struct uaudio_softc *sc,
4602 struct usb_device *udev, void *desc)
4604 const struct usb_audio_control_descriptor *acdp;
4605 struct usb_config_descriptor *cd = usbd_get_config_descriptor(udev);
4606 const struct usb_descriptor *dp;
4607 const struct usb_audio_unit *au;
4608 struct uaudio_terminal_node *iot = NULL;
4610 uint8_t ID_max = 0; /* inclusive */
4613 desc = usb_desc_foreach(cd, desc);
4616 DPRINTF("no Audio Control header\n");
4621 if ((acdp->bLength < sizeof(*acdp)) ||
4622 (acdp->bDescriptorType != UDESC_CS_INTERFACE) ||
4623 (acdp->bDescriptorSubtype != UDESCSUB_AC_HEADER)) {
4624 DPRINTF("invalid Audio Control header\n");
4627 /* "wTotalLen" is allowed to be corrupt */
4628 wTotalLen = UGETW(acdp->wTotalLength) - acdp->bLength;
4630 /* get USB audio revision */
4631 sc->sc_audio_rev = UGETW(acdp->bcdADC);
4633 DPRINTFN(3, "found AC header, vers=%03x, len=%d\n",
4634 sc->sc_audio_rev, wTotalLen);
4636 iot = malloc(sizeof(struct uaudio_terminal_node) * 256, M_TEMP,
4640 DPRINTF("no memory!\n");
4643 while ((desc = usb_desc_foreach(cd, desc))) {
4647 if (dp->bLength > wTotalLen) {
4650 wTotalLen -= dp->bLength;
4653 if (sc->sc_audio_rev >= UAUDIO_VERSION_30)
4655 else if (sc->sc_audio_rev >= UAUDIO_VERSION_20)
4656 au = uaudio20_mixer_verify_desc(dp, 0);
4658 au = uaudio_mixer_verify_desc(dp, 0);
4661 iot[au->bUnitId].u.desc = (const void *)au;
4662 if (au->bUnitId > ID_max)
4663 ID_max = au->bUnitId;
4667 DPRINTF("Maximum ID=%d\n", ID_max);
4670 * determine sourcing inputs for
4671 * all nodes in the tree:
4675 if (sc->sc_audio_rev >= UAUDIO_VERSION_30) {
4677 } else if (sc->sc_audio_rev >= UAUDIO_VERSION_20) {
4678 uaudio20_mixer_find_inputs_sub(iot,
4679 &i, 1, &((iot + i)->usr));
4681 sc->sc_mixer_clocks.is_input = 255;
4682 sc->sc_mixer_clocks.recurse_level = 0;
4684 uaudio20_mixer_find_clocks_sub(iot,
4685 &i, 1, &sc->sc_mixer_clocks);
4687 uaudio_mixer_find_inputs_sub(iot,
4688 &i, 1, &((iot + i)->usr));
4693 * determine outputs for
4694 * all nodes in the tree:
4698 uaudio_mixer_find_outputs_sub(iot,
4699 i, ID_max, &((iot + i)->usr));
4702 /* set "id_max" and "root" */
4706 (iot + i)->usr.id_max = ID_max;
4707 (iot + i)->root = iot;
4711 * Scan the config to create a linked list of "mixer" nodes:
4721 DPRINTFN(11, "id=%d subtype=%d\n",
4722 i, dp->bDescriptorSubtype);
4724 if (sc->sc_audio_rev >= UAUDIO_VERSION_30) {
4726 } else if (sc->sc_audio_rev >= UAUDIO_VERSION_20) {
4728 switch (dp->bDescriptorSubtype) {
4729 case UDESCSUB_AC_HEADER:
4730 DPRINTF("unexpected AC header\n");
4733 case UDESCSUB_AC_INPUT:
4734 case UDESCSUB_AC_OUTPUT:
4735 case UDESCSUB_AC_PROCESSING_V2:
4736 case UDESCSUB_AC_EXTENSION_V2:
4737 case UDESCSUB_AC_EFFECT:
4738 case UDESCSUB_AC_CLOCK_SRC:
4739 case UDESCSUB_AC_CLOCK_SEL:
4740 case UDESCSUB_AC_CLOCK_MUL:
4741 case UDESCSUB_AC_SAMPLE_RT:
4744 case UDESCSUB_AC_MIXER:
4745 uaudio20_mixer_add_mixer(sc, iot, i);
4748 case UDESCSUB_AC_SELECTOR:
4749 uaudio20_mixer_add_selector(sc, iot, i);
4752 case UDESCSUB_AC_FEATURE:
4753 uaudio20_mixer_add_feature(sc, iot, i);
4757 DPRINTF("bad AC desc subtype=0x%02x\n",
4758 dp->bDescriptorSubtype);
4764 switch (dp->bDescriptorSubtype) {
4765 case UDESCSUB_AC_HEADER:
4766 DPRINTF("unexpected AC header\n");
4769 case UDESCSUB_AC_INPUT:
4770 case UDESCSUB_AC_OUTPUT:
4773 case UDESCSUB_AC_MIXER:
4774 uaudio_mixer_add_mixer(sc, iot, i);
4777 case UDESCSUB_AC_SELECTOR:
4778 uaudio_mixer_add_selector(sc, iot, i);
4781 case UDESCSUB_AC_FEATURE:
4782 uaudio_mixer_add_feature(sc, iot, i);
4785 case UDESCSUB_AC_PROCESSING:
4786 uaudio_mixer_add_processing(sc, iot, i);
4789 case UDESCSUB_AC_EXTENSION:
4790 uaudio_mixer_add_extension(sc, iot, i);
4794 DPRINTF("bad AC desc subtype=0x%02x\n",
4795 dp->bDescriptorSubtype);
4806 uaudio_mixer_get(struct usb_device *udev, uint16_t audio_rev,
4807 uint8_t what, struct uaudio_mixer_node *mc)
4809 struct usb_device_request req;
4811 uint8_t data[2 + (2 * 3)];
4814 if (mc->wValue[0] == -1)
4817 if (audio_rev >= UAUDIO_VERSION_30)
4819 else if (audio_rev >= UAUDIO_VERSION_20) {
4820 if (what == GET_CUR) {
4821 req.bRequest = UA20_CS_CUR;
4822 USETW(req.wLength, 2);
4824 req.bRequest = UA20_CS_RANGE;
4825 USETW(req.wLength, 8);
4828 uint16_t len = MIX_SIZE(mc->type);
4830 req.bRequest = what;
4831 USETW(req.wLength, len);
4834 req.bmRequestType = UT_READ_CLASS_INTERFACE;
4835 USETW(req.wValue, mc->wValue[0]);
4836 USETW(req.wIndex, mc->wIndex);
4838 memset(data, 0, sizeof(data));
4840 err = usbd_do_request(udev, NULL, &req, data);
4842 DPRINTF("err=%s\n", usbd_errstr(err));
4846 if (audio_rev >= UAUDIO_VERSION_30) {
4848 } else if (audio_rev >= UAUDIO_VERSION_20) {
4851 val = (data[0] | (data[1] << 8));
4854 val = (data[2] | (data[3] << 8));
4857 val = (data[4] | (data[5] << 8));
4860 val = (data[6] | (data[7] << 8));
4867 val = (data[0] | (data[1] << 8));
4870 if (what == GET_CUR || what == GET_MIN || what == GET_MAX)
4871 val = uaudio_mixer_signext(mc->type, val);
4873 DPRINTFN(3, "val=%d\n", val);
4879 uaudio_mixer_write_cfg_callback(struct usb_xfer *xfer, usb_error_t error)
4881 struct usb_device_request req;
4882 struct uaudio_softc *sc = usbd_xfer_softc(xfer);
4883 struct uaudio_mixer_node *mc = sc->sc_mixer_curr;
4884 struct usb_page_cache *pc;
4893 switch (USB_GET_STATE(xfer)) {
4894 case USB_ST_TRANSFERRED:
4900 mc = sc->sc_mixer_root;
4901 sc->sc_mixer_curr = mc;
4902 sc->sc_mixer_chan = 0;
4906 while (sc->sc_mixer_chan < mc->nchan) {
4908 chan = sc->sc_mixer_chan;
4910 sc->sc_mixer_chan++;
4912 update = ((mc->update[chan / 8] & (1 << (chan % 8))) &&
4913 (mc->wValue[chan] != -1));
4915 mc->update[chan / 8] &= ~(1 << (chan % 8));
4919 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
4920 USETW(req.wValue, mc->wValue[chan]);
4921 USETW(req.wIndex, mc->wIndex);
4923 if (sc->sc_audio_rev >= UAUDIO_VERSION_30) {
4925 } else if (sc->sc_audio_rev >= UAUDIO_VERSION_20) {
4927 req.bRequest = UA20_CS_CUR;
4928 USETW(req.wLength, len);
4930 len = MIX_SIZE(mc->type);
4931 req.bRequest = SET_CUR;
4932 USETW(req.wLength, len);
4935 buf[0] = (mc->wData[chan] & 0xFF);
4936 buf[1] = (mc->wData[chan] >> 8) & 0xFF;
4938 pc = usbd_xfer_get_frame(xfer, 0);
4939 usbd_copy_in(pc, 0, &req, sizeof(req));
4940 pc = usbd_xfer_get_frame(xfer, 1);
4941 usbd_copy_in(pc, 0, buf, len);
4943 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
4944 usbd_xfer_set_frame_len(xfer, 1, len);
4945 usbd_xfer_set_frames(xfer, len ? 2 : 1);
4946 usbd_transfer_submit(xfer);
4952 sc->sc_mixer_curr = mc;
4953 sc->sc_mixer_chan = 0;
4961 default: /* Error */
4962 DPRINTF("error=%s\n", usbd_errstr(error));
4963 if (error == USB_ERR_CANCELLED) {
4964 /* do nothing - we are detaching */
4967 goto tr_transferred;
4972 uaudio_set_speed(struct usb_device *udev, uint8_t endpt, uint32_t speed)
4974 struct usb_device_request req;
4977 DPRINTFN(6, "endpt=%d speed=%u\n", endpt, speed);
4979 req.bmRequestType = UT_WRITE_CLASS_ENDPOINT;
4980 req.bRequest = SET_CUR;
4981 USETW2(req.wValue, SAMPLING_FREQ_CONTROL, 0);
4982 USETW(req.wIndex, endpt);
4983 USETW(req.wLength, 3);
4985 data[1] = speed >> 8;
4986 data[2] = speed >> 16;
4988 return (usbd_do_request(udev, NULL, &req, data));
4992 uaudio20_set_speed(struct usb_device *udev, uint8_t iface_no,
4993 uint8_t clockid, uint32_t speed)
4995 struct usb_device_request req;
4998 DPRINTFN(6, "ifaceno=%d clockid=%d speed=%u\n",
4999 iface_no, clockid, speed);
5001 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
5002 req.bRequest = UA20_CS_CUR;
5003 USETW2(req.wValue, UA20_CS_SAM_FREQ_CONTROL, 0);
5004 USETW2(req.wIndex, clockid, iface_no);
5005 USETW(req.wLength, 4);
5007 data[1] = speed >> 8;
5008 data[2] = speed >> 16;
5009 data[3] = speed >> 24;
5011 return (usbd_do_request(udev, NULL, &req, data));
5015 uaudio_mixer_signext(uint8_t type, int val)
5017 if (!MIX_UNSIGNED(type)) {
5018 if (MIX_SIZE(type) == 2) {
5028 uaudio_mixer_bsd2value(struct uaudio_mixer_node *mc, int32_t val)
5030 if (mc->type == MIX_ON_OFF) {
5032 } else if (mc->type == MIX_SELECTOR) {
5033 if ((val < mc->minval) ||
5034 (val > mc->maxval)) {
5039 /* compute actual volume */
5040 val = (val * mc->mul) / 255;
5042 /* add lower offset */
5043 val = val + mc->minval;
5045 /* make sure we don't write a value out of range */
5046 if (val > mc->maxval)
5048 else if (val < mc->minval)
5052 DPRINTFN(6, "type=0x%03x val=%d min=%d max=%d val=%d\n",
5053 mc->type, val, mc->minval, mc->maxval, val);
5058 uaudio_mixer_ctl_set(struct uaudio_softc *sc, struct uaudio_mixer_node *mc,
5059 uint8_t chan, int32_t val)
5061 val = uaudio_mixer_bsd2value(mc, val);
5063 mc->update[chan / 8] |= (1 << (chan % 8));
5064 mc->wData[chan] = val;
5066 /* start the transfer, if not already started */
5068 usbd_transfer_start(sc->sc_mixer_xfer[0]);
5072 uaudio_mixer_init(struct uaudio_softc *sc)
5074 struct uaudio_mixer_node *mc;
5077 for (mc = sc->sc_mixer_root; mc;
5080 if (mc->ctl != SOUND_MIXER_NRDEVICES) {
5082 * Set device mask bits. See
5083 * /usr/include/machine/soundcard.h
5085 sc->sc_mix_info |= (1 << mc->ctl);
5087 if ((mc->ctl == SOUND_MIXER_NRDEVICES) &&
5088 (mc->type == MIX_SELECTOR)) {
5090 for (i = mc->minval; (i > 0) && (i <= mc->maxval); i++) {
5091 if (mc->slctrtype[i - 1] == SOUND_MIXER_NRDEVICES) {
5094 sc->sc_recsrc_info |= 1 << mc->slctrtype[i - 1];
5101 uaudio_mixer_init_sub(struct uaudio_softc *sc, struct snd_mixer *m)
5105 sc->sc_mixer_lock = mixer_get_lock(m);
5106 sc->sc_mixer_dev = m;
5108 if (usbd_transfer_setup(sc->sc_udev, &sc->sc_mixer_iface_index,
5109 sc->sc_mixer_xfer, uaudio_mixer_config, 1, sc,
5110 sc->sc_mixer_lock)) {
5111 DPRINTFN(0, "could not allocate USB "
5112 "transfer for audio mixer!\n");
5115 if (!(sc->sc_mix_info & SOUND_MASK_VOLUME)) {
5116 mix_setparentchild(m, SOUND_MIXER_VOLUME, SOUND_MASK_PCM);
5117 mix_setrealdev(m, SOUND_MIXER_VOLUME, SOUND_MIXER_NONE);
5119 mix_setdevs(m, sc->sc_mix_info);
5120 mix_setrecdevs(m, sc->sc_recsrc_info);
5125 uaudio_mixer_uninit_sub(struct uaudio_softc *sc)
5129 usbd_transfer_unsetup(sc->sc_mixer_xfer, 1);
5131 sc->sc_mixer_lock = NULL;
5137 uaudio_mixer_set(struct uaudio_softc *sc, unsigned type,
5138 unsigned left, unsigned right)
5140 struct uaudio_mixer_node *mc;
5143 for (mc = sc->sc_mixer_root; mc != NULL; mc = mc->next) {
5145 if (mc->ctl == type) {
5146 for (chan = 0; chan < mc->nchan; chan++) {
5147 uaudio_mixer_ctl_set(sc, mc, chan,
5148 (int)((chan == 0 ? left : right) *
5156 uaudio_mixer_setrecsrc(struct uaudio_softc *sc, uint32_t src)
5158 struct uaudio_mixer_node *mc;
5163 for (mc = sc->sc_mixer_root; mc;
5166 if ((mc->ctl == SOUND_MIXER_NRDEVICES) &&
5167 (mc->type == MIX_SELECTOR)) {
5169 /* compute selector mask */
5172 for (i = mc->minval; (i > 0) && (i <= mc->maxval); i++) {
5173 mask |= (1 << mc->slctrtype[i - 1]);
5180 /* find the first set bit */
5181 temp = (-temp) & temp;
5187 for (i = mc->minval; (i > 0) && (i <= mc->maxval); i++) {
5188 if (temp != (1 << mc->slctrtype[i - 1])) {
5191 uaudio_mixer_ctl_set(sc, mc, 0, i);
5199 /*========================================================================*
5200 * MIDI support routines
5201 *========================================================================*/
5204 umidi_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
5206 struct umidi_chan *chan = usbd_xfer_softc(xfer);
5207 struct umidi_sub_chan *sub;
5208 struct usb_page_cache *pc;
5215 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
5217 switch (USB_GET_STATE(xfer)) {
5218 case USB_ST_TRANSFERRED:
5220 DPRINTF("actlen=%d bytes\n", actlen);
5223 pc = usbd_xfer_get_frame(xfer, 0);
5225 while (actlen >= 4) {
5227 /* copy out the MIDI data */
5228 usbd_copy_out(pc, pos, buf, 4);
5229 /* command length */
5230 cmd_len = umidi_cmd_to_len[buf[0] & 0xF];
5234 * Lookup sub-channel. The index is range
5237 sub = &chan->sub[cn];
5239 if ((cmd_len != 0) &&
5240 (cn < chan->max_cable) &&
5241 (sub->read_open != 0)) {
5243 /* Send data to the application */
5244 usb_fifo_put_data_linear(
5245 sub->fifo.fp[USB_FIFO_RX],
5246 buf + 1, cmd_len, 1);
5255 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
5256 usbd_transfer_submit(xfer);
5260 DPRINTF("error=%s\n", usbd_errstr(error));
5262 if (error != USB_ERR_CANCELLED) {
5263 /* try to clear stall first */
5264 usbd_xfer_set_stall(xfer);
5272 * The following statemachine, that converts MIDI commands to
5273 * USB MIDI packets, derives from Linux's usbmidi.c, which
5274 * was written by "Clemens Ladisch":
5278 * Else: Command is complete
5281 umidi_convert_to_usb(struct umidi_sub_chan *sub, uint8_t cn, uint8_t b)
5283 uint8_t p0 = (cn << 4);
5286 sub->temp_0[0] = p0 | 0x0f;
5290 sub->temp_cmd = sub->temp_0;
5293 } else if (b >= 0xf0) {
5295 case 0xf0: /* system exclusive begin */
5297 sub->state = UMIDI_ST_SYSEX_1;
5299 case 0xf1: /* MIDI time code */
5300 case 0xf3: /* song select */
5302 sub->state = UMIDI_ST_1PARAM;
5304 case 0xf2: /* song position pointer */
5306 sub->state = UMIDI_ST_2PARAM_1;
5308 case 0xf4: /* unknown */
5309 case 0xf5: /* unknown */
5310 sub->state = UMIDI_ST_UNKNOWN;
5312 case 0xf6: /* tune request */
5313 sub->temp_1[0] = p0 | 0x05;
5314 sub->temp_1[1] = 0xf6;
5317 sub->temp_cmd = sub->temp_1;
5318 sub->state = UMIDI_ST_UNKNOWN;
5321 case 0xf7: /* system exclusive end */
5322 switch (sub->state) {
5323 case UMIDI_ST_SYSEX_0:
5324 sub->temp_1[0] = p0 | 0x05;
5325 sub->temp_1[1] = 0xf7;
5328 sub->temp_cmd = sub->temp_1;
5329 sub->state = UMIDI_ST_UNKNOWN;
5331 case UMIDI_ST_SYSEX_1:
5332 sub->temp_1[0] = p0 | 0x06;
5333 sub->temp_1[2] = 0xf7;
5335 sub->temp_cmd = sub->temp_1;
5336 sub->state = UMIDI_ST_UNKNOWN;
5338 case UMIDI_ST_SYSEX_2:
5339 sub->temp_1[0] = p0 | 0x07;
5340 sub->temp_1[3] = 0xf7;
5341 sub->temp_cmd = sub->temp_1;
5342 sub->state = UMIDI_ST_UNKNOWN;
5345 sub->state = UMIDI_ST_UNKNOWN;
5348 } else if (b >= 0x80) {
5350 if ((b >= 0xc0) && (b <= 0xdf)) {
5351 sub->state = UMIDI_ST_1PARAM;
5353 sub->state = UMIDI_ST_2PARAM_1;
5355 } else { /* b < 0x80 */
5356 switch (sub->state) {
5357 case UMIDI_ST_1PARAM:
5358 if (sub->temp_1[1] < 0xf0) {
5359 p0 |= sub->temp_1[1] >> 4;
5362 sub->state = UMIDI_ST_UNKNOWN;
5364 sub->temp_1[0] = p0;
5367 sub->temp_cmd = sub->temp_1;
5369 case UMIDI_ST_2PARAM_1:
5371 sub->state = UMIDI_ST_2PARAM_2;
5373 case UMIDI_ST_2PARAM_2:
5374 if (sub->temp_1[1] < 0xf0) {
5375 p0 |= sub->temp_1[1] >> 4;
5376 sub->state = UMIDI_ST_2PARAM_1;
5379 sub->state = UMIDI_ST_UNKNOWN;
5381 sub->temp_1[0] = p0;
5383 sub->temp_cmd = sub->temp_1;
5385 case UMIDI_ST_SYSEX_0:
5387 sub->state = UMIDI_ST_SYSEX_1;
5389 case UMIDI_ST_SYSEX_1:
5391 sub->state = UMIDI_ST_SYSEX_2;
5393 case UMIDI_ST_SYSEX_2:
5394 sub->temp_1[0] = p0 | 0x04;
5396 sub->temp_cmd = sub->temp_1;
5397 sub->state = UMIDI_ST_SYSEX_0;
5407 umidi_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
5409 struct umidi_chan *chan = usbd_xfer_softc(xfer);
5410 struct umidi_sub_chan *sub;
5411 struct usb_page_cache *pc;
5415 uint8_t start_cable;
5419 usbd_xfer_status(xfer, &len, NULL, NULL, NULL);
5422 * NOTE: Some MIDI devices only accept 4 bytes of data per
5423 * short terminated USB transfer.
5425 switch (USB_GET_STATE(xfer)) {
5426 case USB_ST_TRANSFERRED:
5427 DPRINTF("actlen=%d bytes\n", len);
5433 nframes = 0; /* reset */
5434 start_cable = chan->curr_cable;
5436 pc = usbd_xfer_get_frame(xfer, 0);
5440 /* round robin de-queueing */
5442 sub = &chan->sub[chan->curr_cable];
5444 if (sub->write_open) {
5445 usb_fifo_get_data_linear(sub->fifo.fp[USB_FIFO_TX],
5446 &buf, 1, &actlen, 0);
5455 DPRINTF("byte=0x%02x from FIFO %u\n", buf,
5456 (unsigned int)chan->curr_cable);
5458 if (umidi_convert_to_usb(sub, chan->curr_cable, buf)) {
5460 DPRINTF("sub=0x%02x 0x%02x 0x%02x 0x%02x\n",
5461 sub->temp_cmd[0], sub->temp_cmd[1],
5462 sub->temp_cmd[2], sub->temp_cmd[3]);
5464 usbd_copy_in(pc, nframes * 4, sub->temp_cmd, 4);
5468 if ((nframes >= UMIDI_TX_FRAMES) || (chan->single_command != 0))
5476 if (chan->curr_cable >= chan->max_cable)
5477 chan->curr_cable = 0;
5479 if (chan->curr_cable == start_cable) {
5487 DPRINTF("Transferring %d frames\n", (int)nframes);
5488 usbd_xfer_set_frame_len(xfer, 0, 4 * nframes);
5489 usbd_transfer_submit(xfer);
5493 default: /* Error */
5495 DPRINTF("error=%s\n", usbd_errstr(error));
5497 if (error != USB_ERR_CANCELLED) {
5498 /* try to clear stall first */
5499 usbd_xfer_set_stall(xfer);
5506 static struct umidi_sub_chan *
5507 umidi_sub_by_fifo(struct usb_fifo *fifo)
5509 struct umidi_chan *chan = usb_fifo_softc(fifo);
5510 struct umidi_sub_chan *sub;
5513 for (n = 0; n < UMIDI_CABLES_MAX; n++) {
5514 sub = &chan->sub[n];
5515 if ((sub->fifo.fp[USB_FIFO_RX] == fifo) ||
5516 (sub->fifo.fp[USB_FIFO_TX] == fifo)) {
5521 panic("%s:%d cannot find usb_fifo!\n",
5522 __FILE__, __LINE__);
5528 umidi_start_read(struct usb_fifo *fifo)
5530 struct umidi_chan *chan = usb_fifo_softc(fifo);
5532 usbd_transfer_start(chan->xfer[UMIDI_RX_TRANSFER]);
5536 umidi_stop_read(struct usb_fifo *fifo)
5538 struct umidi_chan *chan = usb_fifo_softc(fifo);
5539 struct umidi_sub_chan *sub = umidi_sub_by_fifo(fifo);
5545 if (--(chan->read_open_refcount) == 0) {
5547 * XXX don't stop the read transfer here, hence that causes
5548 * problems with some MIDI adapters
5550 DPRINTF("(stopping read transfer)\n");
5555 umidi_start_write(struct usb_fifo *fifo)
5557 struct umidi_chan *chan = usb_fifo_softc(fifo);
5559 usbd_transfer_start(chan->xfer[UMIDI_TX_TRANSFER]);
5563 umidi_stop_write(struct usb_fifo *fifo)
5565 struct umidi_chan *chan = usb_fifo_softc(fifo);
5566 struct umidi_sub_chan *sub = umidi_sub_by_fifo(fifo);
5570 sub->write_open = 0;
5572 if (--(chan->write_open_refcount) == 0) {
5573 DPRINTF("(stopping write transfer)\n");
5574 usbd_transfer_stop(chan->xfer[UMIDI_TX_TRANSFER]);
5579 umidi_open(struct usb_fifo *fifo, int fflags)
5581 struct umidi_chan *chan = usb_fifo_softc(fifo);
5582 struct umidi_sub_chan *sub = umidi_sub_by_fifo(fifo);
5584 if (fflags & FREAD) {
5585 if (usb_fifo_alloc_buffer(fifo, 4, (1024 / 4))) {
5588 mtx_lock(&chan->mtx);
5589 chan->read_open_refcount++;
5591 mtx_unlock(&chan->mtx);
5593 if (fflags & FWRITE) {
5594 if (usb_fifo_alloc_buffer(fifo, 32, (1024 / 32))) {
5597 /* clear stall first */
5598 mtx_lock(&chan->mtx);
5599 chan->write_open_refcount++;
5600 sub->write_open = 1;
5603 sub->state = UMIDI_ST_UNKNOWN;
5604 mtx_unlock(&chan->mtx);
5606 return (0); /* success */
5610 umidi_close(struct usb_fifo *fifo, int fflags)
5612 if (fflags & FREAD) {
5613 usb_fifo_free_buffer(fifo);
5615 if (fflags & FWRITE) {
5616 usb_fifo_free_buffer(fifo);
5622 umidi_ioctl(struct usb_fifo *fifo, u_long cmd, void *data,
5629 umidi_init(device_t dev)
5631 struct uaudio_softc *sc = device_get_softc(dev);
5632 struct umidi_chan *chan = &sc->sc_midi_chan;
5634 mtx_init(&chan->mtx, "umidi lock", NULL, MTX_DEF | MTX_RECURSE);
5637 static struct usb_fifo_methods umidi_fifo_methods = {
5638 .f_start_read = &umidi_start_read,
5639 .f_start_write = &umidi_start_write,
5640 .f_stop_read = &umidi_stop_read,
5641 .f_stop_write = &umidi_stop_write,
5642 .f_open = &umidi_open,
5643 .f_close = &umidi_close,
5644 .f_ioctl = &umidi_ioctl,
5645 .basename[0] = "umidi",
5649 umidi_probe(device_t dev)
5651 struct uaudio_softc *sc = device_get_softc(dev);
5652 struct usb_attach_arg *uaa = device_get_ivars(dev);
5653 struct umidi_chan *chan = &sc->sc_midi_chan;
5654 struct umidi_sub_chan *sub;
5655 int unit = device_get_unit(dev);
5659 if (usb_test_quirk(uaa, UQ_SINGLE_CMD_MIDI))
5660 chan->single_command = 1;
5662 if (usbd_set_alt_interface_index(sc->sc_udev, chan->iface_index,
5663 chan->iface_alt_index)) {
5664 DPRINTF("setting of alternate index failed!\n");
5667 usbd_set_parent_iface(sc->sc_udev, chan->iface_index,
5668 sc->sc_mixer_iface_index);
5670 error = usbd_transfer_setup(uaa->device, &chan->iface_index,
5671 chan->xfer, umidi_config, UMIDI_N_TRANSFER,
5674 DPRINTF("error=%s\n", usbd_errstr(error));
5679 * Some USB MIDI device makers couldn't resist using
5680 * wMaxPacketSize = 4 for RX and TX BULK endpoints, although
5681 * that size is an unsupported value for FULL speed BULK
5682 * endpoints. The same applies to some HIGH speed MIDI devices
5683 * which are using a wMaxPacketSize different from 512 bytes.
5685 * Refer to section 5.8.3 in USB 2.0 PDF: Cite: "All Host
5686 * Controllers are required to have support for 8-, 16-, 32-,
5687 * and 64-byte maximum packet sizes for full-speed bulk
5688 * endpoints and 512 bytes for high-speed bulk endpoints."
5690 if (usbd_xfer_maxp_was_clamped(chan->xfer[UMIDI_TX_TRANSFER]))
5691 chan->single_command = 1;
5693 if (chan->single_command != 0)
5694 device_printf(dev, "Single command MIDI quirk enabled\n");
5696 if ((chan->max_cable > UMIDI_CABLES_MAX) ||
5697 (chan->max_cable == 0)) {
5698 chan->max_cable = UMIDI_CABLES_MAX;
5701 for (n = 0; n < chan->max_cable; n++) {
5703 sub = &chan->sub[n];
5705 error = usb_fifo_attach(sc->sc_udev, chan, &chan->mtx,
5706 &umidi_fifo_methods, &sub->fifo, unit, n,
5708 UID_ROOT, GID_OPERATOR, 0644);
5714 mtx_lock(&chan->mtx);
5717 * NOTE: At least one device will not work properly unless the
5718 * BULK IN pipe is open all the time. This might have to do
5719 * about that the internal queues of the device overflow if we
5720 * don't read them regularly.
5722 usbd_transfer_start(chan->xfer[UMIDI_RX_TRANSFER]);
5724 mtx_unlock(&chan->mtx);
5726 return (0); /* success */
5729 return (ENXIO); /* failure */
5733 umidi_detach(device_t dev)
5735 struct uaudio_softc *sc = device_get_softc(dev);
5736 struct umidi_chan *chan = &sc->sc_midi_chan;
5739 for (n = 0; n < UMIDI_CABLES_MAX; n++) {
5740 usb_fifo_detach(&chan->sub[n].fifo);
5743 mtx_lock(&chan->mtx);
5745 usbd_transfer_stop(chan->xfer[UMIDI_RX_TRANSFER]);
5747 mtx_unlock(&chan->mtx);
5749 usbd_transfer_unsetup(chan->xfer, UMIDI_N_TRANSFER);
5751 mtx_destroy(&chan->mtx);
5757 uaudio_hid_rx_callback(struct usb_xfer *xfer, usb_error_t error)
5759 struct uaudio_softc *sc = usbd_xfer_softc(xfer);
5760 const uint8_t *buffer = usbd_xfer_get_frame_buffer(xfer, 0);
5761 struct snd_mixer *m;
5765 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
5767 switch (USB_GET_STATE(xfer)) {
5768 case USB_ST_TRANSFERRED:
5769 DPRINTF("actlen=%d\n", actlen);
5772 (sc->sc_hid.flags & UAUDIO_HID_HAS_ID)) {
5780 m = sc->sc_mixer_dev;
5782 if ((sc->sc_hid.flags & UAUDIO_HID_HAS_MUTE) &&
5783 (sc->sc_hid.mute_id == id) &&
5784 hid_get_data(buffer, actlen,
5785 &sc->sc_hid.mute_loc)) {
5787 DPRINTF("Mute toggle\n");
5789 mixer_hwvol_mute_locked(m);
5792 if ((sc->sc_hid.flags & UAUDIO_HID_HAS_VOLUME_UP) &&
5793 (sc->sc_hid.volume_up_id == id) &&
5794 hid_get_data(buffer, actlen,
5795 &sc->sc_hid.volume_up_loc)) {
5797 DPRINTF("Volume Up\n");
5799 mixer_hwvol_step_locked(m, 1, 1);
5802 if ((sc->sc_hid.flags & UAUDIO_HID_HAS_VOLUME_DOWN) &&
5803 (sc->sc_hid.volume_down_id == id) &&
5804 hid_get_data(buffer, actlen,
5805 &sc->sc_hid.volume_down_loc)) {
5807 DPRINTF("Volume Down\n");
5809 mixer_hwvol_step_locked(m, -1, -1);
5814 /* check if we can put more data into the FIFO */
5815 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
5816 usbd_transfer_submit(xfer);
5819 default: /* Error */
5821 DPRINTF("error=%s\n", usbd_errstr(error));
5823 if (error != USB_ERR_CANCELLED) {
5824 /* try to clear stall first */
5825 usbd_xfer_set_stall(xfer);
5833 uaudio_hid_probe(struct uaudio_softc *sc,
5834 struct usb_attach_arg *uaa)
5842 if (!(sc->sc_hid.flags & UAUDIO_HID_VALID))
5845 if (sc->sc_mixer_lock == NULL)
5848 /* Get HID descriptor */
5849 error = usbd_req_get_hid_desc(uaa->device, NULL, &d_ptr,
5850 &d_len, M_TEMP, sc->sc_hid.iface_index);
5853 DPRINTF("error reading report description\n");
5857 /* check if there is an ID byte */
5858 hid_report_size(d_ptr, d_len, hid_input, &id);
5861 sc->sc_hid.flags |= UAUDIO_HID_HAS_ID;
5863 if (hid_locate(d_ptr, d_len,
5864 HID_USAGE2(HUP_CONSUMER, 0xE9 /* Volume Increment */),
5865 hid_input, 0, &sc->sc_hid.volume_up_loc, &flags,
5866 &sc->sc_hid.volume_up_id)) {
5867 if (flags & HIO_VARIABLE)
5868 sc->sc_hid.flags |= UAUDIO_HID_HAS_VOLUME_UP;
5869 DPRINTFN(1, "Found Volume Up key\n");
5872 if (hid_locate(d_ptr, d_len,
5873 HID_USAGE2(HUP_CONSUMER, 0xEA /* Volume Decrement */),
5874 hid_input, 0, &sc->sc_hid.volume_down_loc, &flags,
5875 &sc->sc_hid.volume_down_id)) {
5876 if (flags & HIO_VARIABLE)
5877 sc->sc_hid.flags |= UAUDIO_HID_HAS_VOLUME_DOWN;
5878 DPRINTFN(1, "Found Volume Down key\n");
5881 if (hid_locate(d_ptr, d_len,
5882 HID_USAGE2(HUP_CONSUMER, 0xE2 /* Mute */),
5883 hid_input, 0, &sc->sc_hid.mute_loc, &flags,
5884 &sc->sc_hid.mute_id)) {
5885 if (flags & HIO_VARIABLE)
5886 sc->sc_hid.flags |= UAUDIO_HID_HAS_MUTE;
5887 DPRINTFN(1, "Found Mute key\n");
5890 free(d_ptr, M_TEMP);
5892 if (!(sc->sc_hid.flags & (UAUDIO_HID_HAS_VOLUME_UP |
5893 UAUDIO_HID_HAS_VOLUME_DOWN |
5894 UAUDIO_HID_HAS_MUTE))) {
5895 DPRINTFN(1, "Did not find any volume related keys\n");
5899 /* prevent the uhid driver from attaching */
5900 usbd_set_parent_iface(uaa->device, sc->sc_hid.iface_index,
5901 sc->sc_mixer_iface_index);
5903 /* allocate USB transfers */
5904 error = usbd_transfer_setup(uaa->device, &sc->sc_hid.iface_index,
5905 sc->sc_hid.xfer, uaudio_hid_config, UAUDIO_HID_N_TRANSFER,
5906 sc, sc->sc_mixer_lock);
5908 DPRINTF("error=%s\n", usbd_errstr(error));
5915 uaudio_hid_detach(struct uaudio_softc *sc)
5917 usbd_transfer_unsetup(sc->sc_hid.xfer, UAUDIO_HID_N_TRANSFER);
5920 DRIVER_MODULE(uaudio, uhub, uaudio_driver, uaudio_devclass, NULL, 0);
5921 MODULE_DEPEND(uaudio, usb, 1, 1, 1);
5922 MODULE_DEPEND(uaudio, sound, SOUND_MINVER, SOUND_PREFVER, SOUND_MAXVER);
5923 MODULE_VERSION(uaudio, 1);