1 /* $NetBSD: uaudio.c,v 1.91 2004/11/05 17:46:14 kent Exp $ */
5 * SPDX-License-Identifier: BSD-2-Clause-NetBSD
7 * Copyright (c) 1999 The NetBSD Foundation, Inc.
10 * This code is derived from software contributed to The NetBSD Foundation
11 * by Lennart Augustsson (lennart@augustsson.net) at
12 * Carlstedt Research & Technology.
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the distribution.
23 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
24 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
25 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
27 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGE.
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
40 * USB audio specs: http://www.usb.org/developers/devclass_docs/audio10.pdf
41 * http://www.usb.org/developers/devclass_docs/frmts10.pdf
42 * http://www.usb.org/developers/devclass_docs/termt10.pdf
47 * $NetBSD: uaudio.c,v 1.94 2005/01/15 15:19:53 kent Exp $
48 * $NetBSD: uaudio.c,v 1.95 2005/01/16 06:02:19 dsainty Exp $
49 * $NetBSD: uaudio.c,v 1.96 2005/01/16 12:46:00 kent Exp $
50 * $NetBSD: uaudio.c,v 1.97 2005/02/24 08:19:38 martin Exp $
53 #include <sys/stdint.h>
54 #include <sys/stddef.h>
55 #include <sys/param.h>
56 #include <sys/queue.h>
57 #include <sys/types.h>
58 #include <sys/systm.h>
59 #include <sys/kernel.h>
61 #include <sys/module.h>
63 #include <sys/mutex.h>
64 #include <sys/condvar.h>
65 #include <sys/sysctl.h>
67 #include <sys/unistd.h>
68 #include <sys/callout.h>
69 #include <sys/malloc.h>
73 #include <dev/usb/usb.h>
74 #include <dev/usb/usbdi.h>
75 #include <dev/usb/usbdi_util.h>
76 #include <dev/usb/usbhid.h>
77 #include <dev/usb/usb_request.h>
78 #include <dev/usb/usb_process.h>
80 #define USB_DEBUG_VAR uaudio_debug
81 #include <dev/usb/usb_debug.h>
83 #include <dev/usb/quirk/usb_quirk.h>
85 #include <sys/reboot.h> /* for bootverbose */
87 #ifdef HAVE_KERNEL_OPTION_HEADERS
91 #include <dev/sound/pcm/sound.h>
92 #include <dev/sound/usb/uaudioreg.h>
93 #include <dev/sound/usb/uaudio.h>
94 #include <dev/sound/chip.h>
95 #include "feeder_if.h"
97 static int uaudio_default_rate = 0; /* use rate list */
98 static int uaudio_default_bits = 32;
99 static int uaudio_default_channels = 0; /* use default */
100 static int uaudio_buffer_ms = 8;
103 static int uaudio_debug;
105 static SYSCTL_NODE(_hw_usb, OID_AUTO, uaudio, CTLFLAG_RW, 0, "USB uaudio");
107 SYSCTL_INT(_hw_usb_uaudio, OID_AUTO, debug, CTLFLAG_RWTUN,
108 &uaudio_debug, 0, "uaudio debug level");
109 SYSCTL_INT(_hw_usb_uaudio, OID_AUTO, default_rate, CTLFLAG_RWTUN,
110 &uaudio_default_rate, 0, "uaudio default sample rate");
111 SYSCTL_INT(_hw_usb_uaudio, OID_AUTO, default_bits, CTLFLAG_RWTUN,
112 &uaudio_default_bits, 0, "uaudio default sample bits");
113 SYSCTL_INT(_hw_usb_uaudio, OID_AUTO, default_channels, CTLFLAG_RWTUN,
114 &uaudio_default_channels, 0, "uaudio default sample channels");
117 uaudio_buffer_ms_sysctl(SYSCTL_HANDLER_ARGS)
121 val = uaudio_buffer_ms;
122 err = sysctl_handle_int(oidp, &val, 0, req);
124 if (err != 0 || req->newptr == NULL || val == uaudio_buffer_ms)
132 uaudio_buffer_ms = val;
136 SYSCTL_PROC(_hw_usb_uaudio, OID_AUTO, buffer_ms, CTLTYPE_INT | CTLFLAG_RWTUN,
137 0, sizeof(int), uaudio_buffer_ms_sysctl, "I",
138 "uaudio buffering delay from 2ms to 8ms");
140 #define uaudio_debug 0
143 #define UAUDIO_NFRAMES 64 /* must be factor of 8 due HS-USB */
144 #define UAUDIO_NCHANBUFS 2 /* number of outstanding request */
145 #define UAUDIO_RECURSE_LIMIT 255 /* rounds */
146 #define UAUDIO_CHANNELS_MAX MIN(64, AFMT_CHANNEL_MAX)
147 #define UAUDIO_MATRIX_MAX 8 /* channels */
149 #define MAKE_WORD(h,l) (((h) << 8) | (l))
150 #define BIT_TEST(bm,bno) (((bm)[(bno) / 8] >> (7 - ((bno) % 8))) & 1)
151 #define UAUDIO_MAX_CHAN(x) (x)
152 #define MIX(sc) ((sc)->sc_mixer_node)
155 const struct usb_audio_streaming_interface_descriptor *v1;
156 const struct usb_audio20_streaming_interface_descriptor *v2;
160 const struct usb_audio_streaming_type1_descriptor *v1;
161 const struct usb_audio20_streaming_type1_descriptor *v2;
165 const struct usb_audio_streaming_endpoint_descriptor *v1;
166 const struct usb_audio20_streaming_endpoint_descriptor *v2;
169 struct uaudio_mixer_node {
174 #define MIX_MAX_CHAN 16
175 int32_t wValue[MIX_MAX_CHAN]; /* using nchan */
179 int wData[MIX_MAX_CHAN]; /* using nchan */
182 uint8_t update[(MIX_MAX_CHAN + 7) / 8];
186 #define MIX_SIGNED_16 2
187 #define MIX_UNSIGNED_16 3
188 #define MIX_SIGNED_8 4
189 #define MIX_SELECTOR 5
190 #define MIX_UNKNOWN 6
191 #define MIX_SIZE(n) ((((n) == MIX_SIGNED_16) || \
192 ((n) == MIX_UNSIGNED_16)) ? 2 : 1)
193 #define MIX_UNSIGNED(n) ((n) == MIX_UNSIGNED_16)
195 #define MAX_SELECTOR_INPUT_PIN 256
196 uint8_t slctrtype[MAX_SELECTOR_INPUT_PIN];
202 struct uaudio_mixer_node *next;
205 struct uaudio_configure_msg {
206 struct usb_proc_msg hdr;
207 struct uaudio_softc *sc;
210 #define CHAN_MAX_ALT 24
212 struct uaudio_chan_alt {
213 union uaudio_asf1d p_asf1d;
214 union uaudio_sed p_sed;
215 const usb_endpoint_descriptor_audio_t *p_ed1;
216 const struct uaudio_format *p_fmt;
217 const struct usb_config *usb_cfg;
218 uint32_t sample_rate; /* in Hz */
219 uint16_t sample_size;
221 uint8_t iface_alt_index;
226 struct pcmchan_caps pcm_cap; /* capabilities */
227 struct uaudio_chan_alt usb_alt[CHAN_MAX_ALT];
228 struct snd_dbuf *pcm_buf;
229 struct mtx *pcm_mtx; /* lock protecting this structure */
230 struct uaudio_softc *priv_sc;
231 struct pcm_channel *pcm_ch;
232 struct usb_xfer *xfer[UAUDIO_NCHANBUFS + 1];
234 uint8_t *buf; /* pointer to buffer */
235 uint8_t *start; /* upper layer buffer start */
236 uint8_t *end; /* upper layer buffer end */
237 uint8_t *cur; /* current position in upper layer
240 uint32_t intr_frames; /* in units */
241 uint32_t frames_per_second;
243 uint32_t sample_curr;
250 uint32_t pcm_format[2];
252 uint16_t bytes_per_frame[2];
254 uint32_t intr_counter;
260 #define CHAN_OP_NONE 0
261 #define CHAN_OP_START 1
262 #define CHAN_OP_STOP 2
263 #define CHAN_OP_DRAIN 3
266 #define UMIDI_EMB_JACK_MAX 16 /* units */
267 #define UMIDI_TX_FRAMES 256 /* units */
268 #define UMIDI_TX_BUFFER (UMIDI_TX_FRAMES * 4) /* bytes */
276 struct umidi_sub_chan {
277 struct usb_fifo_sc fifo;
282 #define UMIDI_ST_UNKNOWN 0 /* scan for command */
283 #define UMIDI_ST_1PARAM 1
284 #define UMIDI_ST_2PARAM_1 2
285 #define UMIDI_ST_2PARAM_2 3
286 #define UMIDI_ST_SYSEX_0 4
287 #define UMIDI_ST_SYSEX_1 5
288 #define UMIDI_ST_SYSEX_2 6
291 uint8_t write_open:1;
297 struct umidi_sub_chan sub[UMIDI_EMB_JACK_MAX];
300 struct usb_xfer *xfer[UMIDI_N_TRANSFER];
303 uint8_t iface_alt_index;
305 uint8_t read_open_refcount;
306 uint8_t write_open_refcount;
309 uint8_t max_emb_jack;
311 uint8_t single_command;
314 struct uaudio_search_result {
315 uint8_t bit_input[(256 + 7) / 8];
316 uint8_t bit_output[(256 + 7) / 8];
317 uint8_t recurse_level;
323 UAUDIO_HID_RX_TRANSFER,
324 UAUDIO_HID_N_TRANSFER,
328 struct usb_xfer *xfer[UAUDIO_HID_N_TRANSFER];
329 struct hid_location volume_up_loc;
330 struct hid_location volume_down_loc;
331 struct hid_location mute_loc;
333 #define UAUDIO_HID_VALID 0x0001
334 #define UAUDIO_HID_HAS_ID 0x0002
335 #define UAUDIO_HID_HAS_VOLUME_UP 0x0004
336 #define UAUDIO_HID_HAS_VOLUME_DOWN 0x0008
337 #define UAUDIO_HID_HAS_MUTE 0x0010
339 uint8_t volume_up_id;
340 uint8_t volume_down_id;
344 #define UAUDIO_SPDIF_OUT 0x01 /* Enable S/PDIF output */
345 #define UAUDIO_SPDIF_OUT_48K 0x02 /* Out sample rate = 48K */
346 #define UAUDIO_SPDIF_OUT_96K 0x04 /* Out sample rate = 96K */
347 #define UAUDIO_SPDIF_IN_MIX 0x10 /* Input mix enable */
349 struct uaudio_softc {
350 struct sbuf sc_sndstat;
351 struct sndcard_func sc_sndcard_func;
352 struct uaudio_chan sc_rec_chan;
353 struct uaudio_chan sc_play_chan;
354 struct umidi_chan sc_midi_chan;
355 struct uaudio_hid sc_hid;
356 struct uaudio_search_result sc_mixer_clocks;
357 struct uaudio_mixer_node sc_mixer_node;
358 struct uaudio_configure_msg sc_config_msg[2];
360 struct mtx *sc_mixer_lock;
361 struct snd_mixer *sc_mixer_dev;
362 struct usb_device *sc_udev;
363 struct usb_xfer *sc_mixer_xfer[1];
364 struct uaudio_mixer_node *sc_mixer_root;
365 struct uaudio_mixer_node *sc_mixer_curr;
366 int (*sc_set_spdif_fn) (struct uaudio_softc *, int);
368 uint32_t sc_mix_info;
369 uint32_t sc_recsrc_info;
371 uint16_t sc_audio_rev;
372 uint16_t sc_mixer_count;
374 uint8_t sc_sndstat_valid;
375 uint8_t sc_mixer_iface_index;
376 uint8_t sc_mixer_iface_no;
377 uint8_t sc_mixer_chan;
378 uint8_t sc_pcm_registered:1;
379 uint8_t sc_mixer_init:1;
380 uint8_t sc_uq_audio_swap_lr:1;
381 uint8_t sc_uq_au_inp_async:1;
382 uint8_t sc_uq_au_no_xu:1;
383 uint8_t sc_uq_bad_adc:1;
384 uint8_t sc_uq_au_vendor_class:1;
385 uint8_t sc_pcm_bitperfect:1;
388 struct uaudio_terminal_node {
390 const struct usb_descriptor *desc;
391 const struct usb_audio_input_terminal *it_v1;
392 const struct usb_audio_output_terminal *ot_v1;
393 const struct usb_audio_mixer_unit_0 *mu_v1;
394 const struct usb_audio_selector_unit *su_v1;
395 const struct usb_audio_feature_unit *fu_v1;
396 const struct usb_audio_processing_unit_0 *pu_v1;
397 const struct usb_audio_extension_unit_0 *eu_v1;
398 const struct usb_audio20_clock_source_unit *csrc_v2;
399 const struct usb_audio20_clock_selector_unit_0 *csel_v2;
400 const struct usb_audio20_clock_multiplier_unit *cmul_v2;
401 const struct usb_audio20_input_terminal *it_v2;
402 const struct usb_audio20_output_terminal *ot_v2;
403 const struct usb_audio20_mixer_unit_0 *mu_v2;
404 const struct usb_audio20_selector_unit *su_v2;
405 const struct usb_audio20_feature_unit *fu_v2;
406 const struct usb_audio20_sample_rate_unit *ru_v2;
407 const struct usb_audio20_processing_unit_0 *pu_v2;
408 const struct usb_audio20_extension_unit_0 *eu_v2;
409 const struct usb_audio20_effect_unit *ef_v2;
411 struct uaudio_search_result usr;
412 struct uaudio_terminal_node *root;
415 struct uaudio_format {
418 uint32_t freebsd_fmt;
419 const char *description;
422 static const struct uaudio_format uaudio10_formats[] = {
424 {UA_FMT_PCM8, 8, AFMT_U8, "8-bit U-LE PCM"},
425 {UA_FMT_PCM8, 16, AFMT_U16_LE, "16-bit U-LE PCM"},
426 {UA_FMT_PCM8, 24, AFMT_U24_LE, "24-bit U-LE PCM"},
427 {UA_FMT_PCM8, 32, AFMT_U32_LE, "32-bit U-LE PCM"},
429 {UA_FMT_PCM, 8, AFMT_S8, "8-bit S-LE PCM"},
430 {UA_FMT_PCM, 16, AFMT_S16_LE, "16-bit S-LE PCM"},
431 {UA_FMT_PCM, 24, AFMT_S24_LE, "24-bit S-LE PCM"},
432 {UA_FMT_PCM, 32, AFMT_S32_LE, "32-bit S-LE PCM"},
434 {UA_FMT_ALAW, 8, AFMT_A_LAW, "8-bit A-Law"},
435 {UA_FMT_MULAW, 8, AFMT_MU_LAW, "8-bit mu-Law"},
440 static const struct uaudio_format uaudio20_formats[] = {
442 {UA20_FMT_PCM, 8, AFMT_S8, "8-bit S-LE PCM"},
443 {UA20_FMT_PCM, 16, AFMT_S16_LE, "16-bit S-LE PCM"},
444 {UA20_FMT_PCM, 24, AFMT_S24_LE, "24-bit S-LE PCM"},
445 {UA20_FMT_PCM, 32, AFMT_S32_LE, "32-bit S-LE PCM"},
447 {UA20_FMT_PCM8, 8, AFMT_U8, "8-bit U-LE PCM"},
448 {UA20_FMT_PCM8, 16, AFMT_U16_LE, "16-bit U-LE PCM"},
449 {UA20_FMT_PCM8, 24, AFMT_U24_LE, "24-bit U-LE PCM"},
450 {UA20_FMT_PCM8, 32, AFMT_U32_LE, "32-bit U-LE PCM"},
452 {UA20_FMT_ALAW, 8, AFMT_A_LAW, "8-bit A-Law"},
453 {UA20_FMT_MULAW, 8, AFMT_MU_LAW, "8-bit mu-Law"},
462 #define UAC_NCLASSES 4
465 static const char *uac_names[] = {
466 "outputs", "inputs", "equalization", "record"
473 static device_probe_t uaudio_probe;
474 static device_attach_t uaudio_attach;
475 static device_detach_t uaudio_detach;
477 static usb_callback_t uaudio_chan_play_callback;
478 static usb_callback_t uaudio_chan_play_sync_callback;
479 static usb_callback_t uaudio_chan_record_callback;
480 static usb_callback_t uaudio_chan_record_sync_callback;
481 static usb_callback_t uaudio_mixer_write_cfg_callback;
482 static usb_callback_t umidi_bulk_read_callback;
483 static usb_callback_t umidi_bulk_write_callback;
484 static usb_callback_t uaudio_hid_rx_callback;
486 static usb_proc_callback_t uaudio_configure_msg;
488 /* ==== USB mixer ==== */
490 static int uaudio_mixer_sysctl_handler(SYSCTL_HANDLER_ARGS);
491 static void uaudio_mixer_ctl_free(struct uaudio_softc *);
492 static void uaudio_mixer_register_sysctl(struct uaudio_softc *, device_t);
493 static void uaudio_mixer_reload_all(struct uaudio_softc *);
494 static void uaudio_mixer_controls_create_ftu(struct uaudio_softc *);
496 /* ==== USB audio v1.0 ==== */
498 static void uaudio_mixer_add_mixer(struct uaudio_softc *,
499 const struct uaudio_terminal_node *, int);
500 static void uaudio_mixer_add_selector(struct uaudio_softc *,
501 const struct uaudio_terminal_node *, int);
502 static uint32_t uaudio_mixer_feature_get_bmaControls(
503 const struct usb_audio_feature_unit *, uint8_t);
504 static void uaudio_mixer_add_feature(struct uaudio_softc *,
505 const struct uaudio_terminal_node *, int);
506 static void uaudio_mixer_add_processing_updown(struct uaudio_softc *,
507 const struct uaudio_terminal_node *, int);
508 static void uaudio_mixer_add_processing(struct uaudio_softc *,
509 const struct uaudio_terminal_node *, int);
510 static void uaudio_mixer_add_extension(struct uaudio_softc *,
511 const struct uaudio_terminal_node *, int);
512 static struct usb_audio_cluster uaudio_mixer_get_cluster(uint8_t,
513 const struct uaudio_terminal_node *);
514 static uint16_t uaudio_mixer_determine_class(const struct uaudio_terminal_node *,
515 struct uaudio_mixer_node *);
516 static uint16_t uaudio_mixer_feature_name(const struct uaudio_terminal_node *,
517 struct uaudio_mixer_node *);
518 static void uaudio_mixer_find_inputs_sub(struct uaudio_terminal_node *,
519 const uint8_t *, uint8_t, struct uaudio_search_result *);
520 static const void *uaudio_mixer_verify_desc(const void *, uint32_t);
521 static usb_error_t uaudio_set_speed(struct usb_device *, uint8_t, uint32_t);
522 static int uaudio_mixer_get(struct usb_device *, uint16_t, uint8_t,
523 struct uaudio_mixer_node *);
525 /* ==== USB audio v2.0 ==== */
527 static void uaudio20_mixer_add_mixer(struct uaudio_softc *,
528 const struct uaudio_terminal_node *, int);
529 static void uaudio20_mixer_add_selector(struct uaudio_softc *,
530 const struct uaudio_terminal_node *, int);
531 static void uaudio20_mixer_add_feature(struct uaudio_softc *,
532 const struct uaudio_terminal_node *, int);
533 static struct usb_audio20_cluster uaudio20_mixer_get_cluster(uint8_t,
534 const struct uaudio_terminal_node *);
535 static uint16_t uaudio20_mixer_determine_class(const struct uaudio_terminal_node *,
536 struct uaudio_mixer_node *);
537 static uint16_t uaudio20_mixer_feature_name(const struct uaudio_terminal_node *,
538 struct uaudio_mixer_node *);
539 static void uaudio20_mixer_find_inputs_sub(struct uaudio_terminal_node *,
540 const uint8_t *, uint8_t, struct uaudio_search_result *);
541 static const void *uaudio20_mixer_verify_desc(const void *, uint32_t);
542 static usb_error_t uaudio20_set_speed(struct usb_device *, uint8_t,
545 /* USB audio v1.0 and v2.0 */
547 static void uaudio_chan_fill_info_sub(struct uaudio_softc *,
548 struct usb_device *, uint32_t, uint8_t, uint8_t);
549 static void uaudio_chan_fill_info(struct uaudio_softc *,
550 struct usb_device *);
551 static void uaudio_mixer_add_ctl_sub(struct uaudio_softc *,
552 struct uaudio_mixer_node *);
553 static void uaudio_mixer_add_ctl(struct uaudio_softc *,
554 struct uaudio_mixer_node *);
555 static void uaudio_mixer_fill_info(struct uaudio_softc *,
556 struct usb_device *, void *);
557 static int uaudio_mixer_signext(uint8_t, int);
558 static void uaudio_mixer_init(struct uaudio_softc *);
559 static const struct uaudio_terminal_node *uaudio_mixer_get_input(
560 const struct uaudio_terminal_node *, uint8_t);
561 static const struct uaudio_terminal_node *uaudio_mixer_get_output(
562 const struct uaudio_terminal_node *, uint8_t);
563 static void uaudio_mixer_find_outputs_sub(struct uaudio_terminal_node *,
564 uint8_t, uint8_t, struct uaudio_search_result *);
565 static uint8_t umidi_convert_to_usb(struct umidi_sub_chan *, uint8_t, uint8_t);
566 static struct umidi_sub_chan *umidi_sub_by_fifo(struct usb_fifo *);
567 static void umidi_start_read(struct usb_fifo *);
568 static void umidi_stop_read(struct usb_fifo *);
569 static void umidi_start_write(struct usb_fifo *);
570 static void umidi_stop_write(struct usb_fifo *);
571 static int umidi_open(struct usb_fifo *, int);
572 static int umidi_ioctl(struct usb_fifo *, u_long cmd, void *, int);
573 static void umidi_close(struct usb_fifo *, int);
574 static void umidi_init(device_t dev);
575 static int umidi_probe(device_t dev);
576 static int umidi_detach(device_t dev);
577 static int uaudio_hid_probe(struct uaudio_softc *sc,
578 struct usb_attach_arg *uaa);
579 static void uaudio_hid_detach(struct uaudio_softc *sc);
582 static void uaudio_chan_dump_ep_desc(
583 const usb_endpoint_descriptor_audio_t *);
586 static const struct usb_config
587 uaudio_cfg_record[UAUDIO_NCHANBUFS + 1] = {
589 .type = UE_ISOCHRONOUS,
590 .endpoint = UE_ADDR_ANY,
591 .direction = UE_DIR_IN,
592 .bufsize = 0, /* use "wMaxPacketSize * frames" */
593 .frames = UAUDIO_NFRAMES,
594 .flags = {.short_xfer_ok = 1,},
595 .callback = &uaudio_chan_record_callback,
599 .type = UE_ISOCHRONOUS,
600 .endpoint = UE_ADDR_ANY,
601 .direction = UE_DIR_IN,
602 .bufsize = 0, /* use "wMaxPacketSize * frames" */
603 .frames = UAUDIO_NFRAMES,
604 .flags = {.short_xfer_ok = 1,},
605 .callback = &uaudio_chan_record_callback,
609 .type = UE_ISOCHRONOUS,
610 .endpoint = UE_ADDR_ANY,
611 .direction = UE_DIR_OUT,
612 .bufsize = 0, /* use "wMaxPacketSize * frames" */
614 .flags = {.no_pipe_ok = 1,.short_xfer_ok = 1,},
615 .callback = &uaudio_chan_record_sync_callback,
619 static const struct usb_config
620 uaudio_cfg_play[UAUDIO_NCHANBUFS + 1] = {
622 .type = UE_ISOCHRONOUS,
623 .endpoint = UE_ADDR_ANY,
624 .direction = UE_DIR_OUT,
625 .bufsize = 0, /* use "wMaxPacketSize * frames" */
626 .frames = UAUDIO_NFRAMES,
627 .flags = {.short_xfer_ok = 1,},
628 .callback = &uaudio_chan_play_callback,
632 .type = UE_ISOCHRONOUS,
633 .endpoint = UE_ADDR_ANY,
634 .direction = UE_DIR_OUT,
635 .bufsize = 0, /* use "wMaxPacketSize * frames" */
636 .frames = UAUDIO_NFRAMES,
637 .flags = {.short_xfer_ok = 1,},
638 .callback = &uaudio_chan_play_callback,
642 .type = UE_ISOCHRONOUS,
643 .endpoint = UE_ADDR_ANY,
644 .direction = UE_DIR_IN,
645 .bufsize = 0, /* use "wMaxPacketSize * frames" */
647 .flags = {.no_pipe_ok = 1,.short_xfer_ok = 1,},
648 .callback = &uaudio_chan_play_sync_callback,
652 static const struct usb_config
653 uaudio_mixer_config[1] = {
656 .endpoint = 0x00, /* Control pipe */
657 .direction = UE_DIR_ANY,
658 .bufsize = (sizeof(struct usb_device_request) + 4),
659 .callback = &uaudio_mixer_write_cfg_callback,
660 .timeout = 1000, /* 1 second */
665 uint8_t umidi_cmd_to_len[16] = {
666 [0x0] = 0, /* reserved */
667 [0x1] = 0, /* reserved */
668 [0x2] = 2, /* bytes */
669 [0x3] = 3, /* bytes */
670 [0x4] = 3, /* bytes */
671 [0x5] = 1, /* bytes */
672 [0x6] = 2, /* bytes */
673 [0x7] = 3, /* bytes */
674 [0x8] = 3, /* bytes */
675 [0x9] = 3, /* bytes */
676 [0xA] = 3, /* bytes */
677 [0xB] = 3, /* bytes */
678 [0xC] = 2, /* bytes */
679 [0xD] = 2, /* bytes */
680 [0xE] = 3, /* bytes */
681 [0xF] = 1, /* bytes */
684 static const struct usb_config
685 umidi_config[UMIDI_N_TRANSFER] = {
686 [UMIDI_TX_TRANSFER] = {
688 .endpoint = UE_ADDR_ANY,
689 .direction = UE_DIR_OUT,
690 .bufsize = UMIDI_TX_BUFFER,
691 .flags = {.no_pipe_ok = 1},
692 .callback = &umidi_bulk_write_callback,
695 [UMIDI_RX_TRANSFER] = {
697 .endpoint = UE_ADDR_ANY,
698 .direction = UE_DIR_IN,
699 .bufsize = 4, /* bytes */
700 .flags = {.short_xfer_ok = 1,.proxy_buffer = 1,.no_pipe_ok = 1},
701 .callback = &umidi_bulk_read_callback,
705 static const struct usb_config
706 uaudio_hid_config[UAUDIO_HID_N_TRANSFER] = {
707 [UAUDIO_HID_RX_TRANSFER] = {
708 .type = UE_INTERRUPT,
709 .endpoint = UE_ADDR_ANY,
710 .direction = UE_DIR_IN,
711 .bufsize = 0, /* use wMaxPacketSize */
712 .flags = {.short_xfer_ok = 1,},
713 .callback = &uaudio_hid_rx_callback,
717 static devclass_t uaudio_devclass;
719 static device_method_t uaudio_methods[] = {
720 DEVMETHOD(device_probe, uaudio_probe),
721 DEVMETHOD(device_attach, uaudio_attach),
722 DEVMETHOD(device_detach, uaudio_detach),
723 DEVMETHOD(device_suspend, bus_generic_suspend),
724 DEVMETHOD(device_resume, bus_generic_resume),
725 DEVMETHOD(device_shutdown, bus_generic_shutdown),
730 static driver_t uaudio_driver = {
732 .methods = uaudio_methods,
733 .size = sizeof(struct uaudio_softc),
736 /* The following table is derived from Linux's quirks-table.h */
737 static const STRUCT_USB_HOST_ID uaudio_vendor_midi[] = {
738 { USB_VPI(USB_VENDOR_YAMAHA, 0x1000, 0) }, /* UX256 */
739 { USB_VPI(USB_VENDOR_YAMAHA, 0x1001, 0) }, /* MU1000 */
740 { USB_VPI(USB_VENDOR_YAMAHA, 0x1002, 0) }, /* MU2000 */
741 { USB_VPI(USB_VENDOR_YAMAHA, 0x1003, 0) }, /* MU500 */
742 { USB_VPI(USB_VENDOR_YAMAHA, 0x1004, 3) }, /* UW500 */
743 { USB_VPI(USB_VENDOR_YAMAHA, 0x1005, 0) }, /* MOTIF6 */
744 { USB_VPI(USB_VENDOR_YAMAHA, 0x1006, 0) }, /* MOTIF7 */
745 { USB_VPI(USB_VENDOR_YAMAHA, 0x1007, 0) }, /* MOTIF8 */
746 { USB_VPI(USB_VENDOR_YAMAHA, 0x1008, 0) }, /* UX96 */
747 { USB_VPI(USB_VENDOR_YAMAHA, 0x1009, 0) }, /* UX16 */
748 { USB_VPI(USB_VENDOR_YAMAHA, 0x100a, 3) }, /* EOS BX */
749 { USB_VPI(USB_VENDOR_YAMAHA, 0x100c, 0) }, /* UC-MX */
750 { USB_VPI(USB_VENDOR_YAMAHA, 0x100d, 0) }, /* UC-KX */
751 { USB_VPI(USB_VENDOR_YAMAHA, 0x100e, 0) }, /* S08 */
752 { USB_VPI(USB_VENDOR_YAMAHA, 0x100f, 0) }, /* CLP-150 */
753 { USB_VPI(USB_VENDOR_YAMAHA, 0x1010, 0) }, /* CLP-170 */
754 { USB_VPI(USB_VENDOR_YAMAHA, 0x1011, 0) }, /* P-250 */
755 { USB_VPI(USB_VENDOR_YAMAHA, 0x1012, 0) }, /* TYROS */
756 { USB_VPI(USB_VENDOR_YAMAHA, 0x1013, 0) }, /* PF-500 */
757 { USB_VPI(USB_VENDOR_YAMAHA, 0x1014, 0) }, /* S90 */
758 { USB_VPI(USB_VENDOR_YAMAHA, 0x1015, 0) }, /* MOTIF-R */
759 { USB_VPI(USB_VENDOR_YAMAHA, 0x1016, 0) }, /* MDP-5 */
760 { USB_VPI(USB_VENDOR_YAMAHA, 0x1017, 0) }, /* CVP-204 */
761 { USB_VPI(USB_VENDOR_YAMAHA, 0x1018, 0) }, /* CVP-206 */
762 { USB_VPI(USB_VENDOR_YAMAHA, 0x1019, 0) }, /* CVP-208 */
763 { USB_VPI(USB_VENDOR_YAMAHA, 0x101a, 0) }, /* CVP-210 */
764 { USB_VPI(USB_VENDOR_YAMAHA, 0x101b, 0) }, /* PSR-1100 */
765 { USB_VPI(USB_VENDOR_YAMAHA, 0x101c, 0) }, /* PSR-2100 */
766 { USB_VPI(USB_VENDOR_YAMAHA, 0x101d, 0) }, /* CLP-175 */
767 { USB_VPI(USB_VENDOR_YAMAHA, 0x101e, 0) }, /* PSR-K1 */
768 { USB_VPI(USB_VENDOR_YAMAHA, 0x101f, 0) }, /* EZ-J24 */
769 { USB_VPI(USB_VENDOR_YAMAHA, 0x1020, 0) }, /* EZ-250i */
770 { USB_VPI(USB_VENDOR_YAMAHA, 0x1021, 0) }, /* MOTIF ES 6 */
771 { USB_VPI(USB_VENDOR_YAMAHA, 0x1022, 0) }, /* MOTIF ES 7 */
772 { USB_VPI(USB_VENDOR_YAMAHA, 0x1023, 0) }, /* MOTIF ES 8 */
773 { USB_VPI(USB_VENDOR_YAMAHA, 0x1024, 0) }, /* CVP-301 */
774 { USB_VPI(USB_VENDOR_YAMAHA, 0x1025, 0) }, /* CVP-303 */
775 { USB_VPI(USB_VENDOR_YAMAHA, 0x1026, 0) }, /* CVP-305 */
776 { USB_VPI(USB_VENDOR_YAMAHA, 0x1027, 0) }, /* CVP-307 */
777 { USB_VPI(USB_VENDOR_YAMAHA, 0x1028, 0) }, /* CVP-309 */
778 { USB_VPI(USB_VENDOR_YAMAHA, 0x1029, 0) }, /* CVP-309GP */
779 { USB_VPI(USB_VENDOR_YAMAHA, 0x102a, 0) }, /* PSR-1500 */
780 { USB_VPI(USB_VENDOR_YAMAHA, 0x102b, 0) }, /* PSR-3000 */
781 { USB_VPI(USB_VENDOR_YAMAHA, 0x102e, 0) }, /* ELS-01/01C */
782 { USB_VPI(USB_VENDOR_YAMAHA, 0x1030, 0) }, /* PSR-295/293 */
783 { USB_VPI(USB_VENDOR_YAMAHA, 0x1031, 0) }, /* DGX-205/203 */
784 { USB_VPI(USB_VENDOR_YAMAHA, 0x1032, 0) }, /* DGX-305 */
785 { USB_VPI(USB_VENDOR_YAMAHA, 0x1033, 0) }, /* DGX-505 */
786 { USB_VPI(USB_VENDOR_YAMAHA, 0x1034, 0) }, /* NULL */
787 { USB_VPI(USB_VENDOR_YAMAHA, 0x1035, 0) }, /* NULL */
788 { USB_VPI(USB_VENDOR_YAMAHA, 0x1036, 0) }, /* NULL */
789 { USB_VPI(USB_VENDOR_YAMAHA, 0x1037, 0) }, /* NULL */
790 { USB_VPI(USB_VENDOR_YAMAHA, 0x1038, 0) }, /* NULL */
791 { USB_VPI(USB_VENDOR_YAMAHA, 0x1039, 0) }, /* NULL */
792 { USB_VPI(USB_VENDOR_YAMAHA, 0x103a, 0) }, /* NULL */
793 { USB_VPI(USB_VENDOR_YAMAHA, 0x103b, 0) }, /* NULL */
794 { USB_VPI(USB_VENDOR_YAMAHA, 0x103c, 0) }, /* NULL */
795 { USB_VPI(USB_VENDOR_YAMAHA, 0x103d, 0) }, /* NULL */
796 { USB_VPI(USB_VENDOR_YAMAHA, 0x103e, 0) }, /* NULL */
797 { USB_VPI(USB_VENDOR_YAMAHA, 0x103f, 0) }, /* NULL */
798 { USB_VPI(USB_VENDOR_YAMAHA, 0x1040, 0) }, /* NULL */
799 { USB_VPI(USB_VENDOR_YAMAHA, 0x1041, 0) }, /* NULL */
800 { USB_VPI(USB_VENDOR_YAMAHA, 0x1042, 0) }, /* NULL */
801 { USB_VPI(USB_VENDOR_YAMAHA, 0x1043, 0) }, /* NULL */
802 { USB_VPI(USB_VENDOR_YAMAHA, 0x1044, 0) }, /* NULL */
803 { USB_VPI(USB_VENDOR_YAMAHA, 0x1045, 0) }, /* NULL */
804 { USB_VPI(USB_VENDOR_YAMAHA, 0x104e, 0) }, /* NULL */
805 { USB_VPI(USB_VENDOR_YAMAHA, 0x104f, 0) }, /* NULL */
806 { USB_VPI(USB_VENDOR_YAMAHA, 0x1050, 0) }, /* NULL */
807 { USB_VPI(USB_VENDOR_YAMAHA, 0x1051, 0) }, /* NULL */
808 { USB_VPI(USB_VENDOR_YAMAHA, 0x1052, 0) }, /* NULL */
809 { USB_VPI(USB_VENDOR_YAMAHA, 0x1053, 0) }, /* NULL */
810 { USB_VPI(USB_VENDOR_YAMAHA, 0x1054, 0) }, /* NULL */
811 { USB_VPI(USB_VENDOR_YAMAHA, 0x1055, 0) }, /* NULL */
812 { USB_VPI(USB_VENDOR_YAMAHA, 0x1056, 0) }, /* NULL */
813 { USB_VPI(USB_VENDOR_YAMAHA, 0x1057, 0) }, /* NULL */
814 { USB_VPI(USB_VENDOR_YAMAHA, 0x1058, 0) }, /* NULL */
815 { USB_VPI(USB_VENDOR_YAMAHA, 0x1059, 0) }, /* NULL */
816 { USB_VPI(USB_VENDOR_YAMAHA, 0x105a, 0) }, /* NULL */
817 { USB_VPI(USB_VENDOR_YAMAHA, 0x105b, 0) }, /* NULL */
818 { USB_VPI(USB_VENDOR_YAMAHA, 0x105c, 0) }, /* NULL */
819 { USB_VPI(USB_VENDOR_YAMAHA, 0x105d, 0) }, /* NULL */
820 { USB_VPI(USB_VENDOR_YAMAHA, 0x1503, 3) }, /* MOX6/MOX8 */
821 { USB_VPI(USB_VENDOR_YAMAHA, 0x2000, 0) }, /* DGP-7 */
822 { USB_VPI(USB_VENDOR_YAMAHA, 0x2001, 0) }, /* DGP-5 */
823 { USB_VPI(USB_VENDOR_YAMAHA, 0x2002, 0) }, /* NULL */
824 { USB_VPI(USB_VENDOR_YAMAHA, 0x2003, 0) }, /* NULL */
825 { USB_VPI(USB_VENDOR_YAMAHA, 0x5000, 0) }, /* CS1D */
826 { USB_VPI(USB_VENDOR_YAMAHA, 0x5001, 0) }, /* DSP1D */
827 { USB_VPI(USB_VENDOR_YAMAHA, 0x5002, 0) }, /* DME32 */
828 { USB_VPI(USB_VENDOR_YAMAHA, 0x5003, 0) }, /* DM2000 */
829 { USB_VPI(USB_VENDOR_YAMAHA, 0x5004, 0) }, /* 02R96 */
830 { USB_VPI(USB_VENDOR_YAMAHA, 0x5005, 0) }, /* ACU16-C */
831 { USB_VPI(USB_VENDOR_YAMAHA, 0x5006, 0) }, /* NHB32-C */
832 { USB_VPI(USB_VENDOR_YAMAHA, 0x5007, 0) }, /* DM1000 */
833 { USB_VPI(USB_VENDOR_YAMAHA, 0x5008, 0) }, /* 01V96 */
834 { USB_VPI(USB_VENDOR_YAMAHA, 0x5009, 0) }, /* SPX2000 */
835 { USB_VPI(USB_VENDOR_YAMAHA, 0x500a, 0) }, /* PM5D */
836 { USB_VPI(USB_VENDOR_YAMAHA, 0x500b, 0) }, /* DME64N */
837 { USB_VPI(USB_VENDOR_YAMAHA, 0x500c, 0) }, /* DME24N */
838 { USB_VPI(USB_VENDOR_YAMAHA, 0x500d, 0) }, /* NULL */
839 { USB_VPI(USB_VENDOR_YAMAHA, 0x500e, 0) }, /* NULL */
840 { USB_VPI(USB_VENDOR_YAMAHA, 0x500f, 0) }, /* NULL */
841 { USB_VPI(USB_VENDOR_YAMAHA, 0x7000, 0) }, /* DTX */
842 { USB_VPI(USB_VENDOR_YAMAHA, 0x7010, 0) }, /* UB99 */
845 static const STRUCT_USB_HOST_ID __used uaudio_devs[] = {
846 /* Generic USB audio class match */
847 {USB_IFACE_CLASS(UICLASS_AUDIO),
848 USB_IFACE_SUBCLASS(UISUBCLASS_AUDIOCONTROL),},
849 /* Generic USB MIDI class match */
850 {USB_IFACE_CLASS(UICLASS_AUDIO),
851 USB_IFACE_SUBCLASS(UISUBCLASS_MIDISTREAM),},
855 uaudio_probe(device_t dev)
857 struct usb_attach_arg *uaa = device_get_ivars(dev);
859 if (uaa->usb_mode != USB_MODE_HOST)
862 /* lookup non-standard device(s) */
864 if (usbd_lookup_id_by_uaa(uaudio_vendor_midi,
865 sizeof(uaudio_vendor_midi), uaa) == 0) {
866 return (BUS_PROBE_SPECIFIC);
869 if (uaa->info.bInterfaceClass != UICLASS_AUDIO) {
870 if (uaa->info.bInterfaceClass != UICLASS_VENDOR ||
871 usb_test_quirk(uaa, UQ_AU_VENDOR_CLASS) == 0)
875 /* check for AUDIO control interface */
877 if (uaa->info.bInterfaceSubClass == UISUBCLASS_AUDIOCONTROL) {
878 if (usb_test_quirk(uaa, UQ_BAD_AUDIO))
881 return (BUS_PROBE_GENERIC);
884 /* check for MIDI stream */
886 if (uaa->info.bInterfaceSubClass == UISUBCLASS_MIDISTREAM) {
887 if (usb_test_quirk(uaa, UQ_BAD_MIDI))
890 return (BUS_PROBE_GENERIC);
896 * Set Cmedia CM6206 S/PDIF settings
897 * Source: CM6206 Datasheet v2.3.
900 uaudio_set_spdif_cm6206(struct uaudio_softc *sc, int flags)
902 uint8_t cmd[2][4] = {
903 {0x20, 0x20, 0x00, 0},
904 {0x20, 0x30, 0x02, 1}
908 if (flags & UAUDIO_SPDIF_OUT)
913 if (flags & UAUDIO_SPDIF_OUT_96K)
914 cmd[0][1] = 0x60; /* 96K: 3'b110 */
916 if (flags & UAUDIO_SPDIF_IN_MIX)
917 cmd[1][1] = 0x03; /* SPDIFMIX */
919 for (i = 0; i < 2; i++) {
920 if (usbd_req_set_report(sc->sc_udev, NULL,
921 cmd[i], sizeof(cmd[0]),
922 sc->sc_mixer_iface_index, UHID_OUTPUT_REPORT, 0) != 0) {
930 uaudio_set_spdif_dummy(struct uaudio_softc *sc, int flags)
936 uaudio_attach(device_t dev)
938 struct usb_attach_arg *uaa = device_get_ivars(dev);
939 struct uaudio_softc *sc = device_get_softc(dev);
940 struct usb_interface_descriptor *id;
944 sc->sc_play_chan.priv_sc = sc;
945 sc->sc_rec_chan.priv_sc = sc;
946 sc->sc_udev = uaa->device;
947 sc->sc_mixer_iface_index = uaa->info.bIfaceIndex;
948 sc->sc_mixer_iface_no = uaa->info.bIfaceNum;
949 sc->sc_config_msg[0].hdr.pm_callback = &uaudio_configure_msg;
950 sc->sc_config_msg[0].sc = sc;
951 sc->sc_config_msg[1].hdr.pm_callback = &uaudio_configure_msg;
952 sc->sc_config_msg[1].sc = sc;
954 if (usb_test_quirk(uaa, UQ_AUDIO_SWAP_LR))
955 sc->sc_uq_audio_swap_lr = 1;
957 if (usb_test_quirk(uaa, UQ_AU_INP_ASYNC))
958 sc->sc_uq_au_inp_async = 1;
960 if (usb_test_quirk(uaa, UQ_AU_NO_XU))
961 sc->sc_uq_au_no_xu = 1;
963 if (usb_test_quirk(uaa, UQ_BAD_ADC))
964 sc->sc_uq_bad_adc = 1;
966 if (usb_test_quirk(uaa, UQ_AU_VENDOR_CLASS))
967 sc->sc_uq_au_vendor_class = 1;
969 /* set S/PDIF function */
970 if (usb_test_quirk(uaa, UQ_AU_SET_SPDIF_CM6206))
971 sc->sc_set_spdif_fn = uaudio_set_spdif_cm6206;
973 sc->sc_set_spdif_fn = uaudio_set_spdif_dummy;
977 device_set_usb_desc(dev);
979 id = usbd_get_interface_descriptor(uaa->iface);
981 /* must fill mixer info before channel info */
982 uaudio_mixer_fill_info(sc, uaa->device, id);
984 /* fill channel info */
985 uaudio_chan_fill_info(sc, uaa->device);
987 DPRINTF("audio rev %d.%02x\n",
988 sc->sc_audio_rev >> 8,
989 sc->sc_audio_rev & 0xff);
991 if (sc->sc_mixer_count == 0) {
992 if (uaa->info.idVendor == USB_VENDOR_MAUDIO &&
993 (uaa->info.idProduct == USB_PRODUCT_MAUDIO_FASTTRACKULTRA ||
994 uaa->info.idProduct == USB_PRODUCT_MAUDIO_FASTTRACKULTRA8R)) {
995 DPRINTF("Generating mixer descriptors\n");
996 uaudio_mixer_controls_create_ftu(sc);
1000 DPRINTF("%d mixer controls\n",
1001 sc->sc_mixer_count);
1003 if (sc->sc_play_chan.num_alt > 0) {
1007 * Need to set a default alternate interface, else
1008 * some USB audio devices might go into an infinte
1009 * re-enumeration loop:
1011 err = usbd_set_alt_interface_index(sc->sc_udev,
1012 sc->sc_play_chan.usb_alt[0].iface_index,
1013 sc->sc_play_chan.usb_alt[0].iface_alt_index);
1015 DPRINTF("setting of alternate index failed: %s!\n",
1018 for (x = 0; x != sc->sc_play_chan.num_alt; x++) {
1019 device_printf(dev, "Play: %d Hz, %d ch, %s format, "
1021 sc->sc_play_chan.usb_alt[x].sample_rate,
1022 sc->sc_play_chan.usb_alt[x].channels,
1023 sc->sc_play_chan.usb_alt[x].p_fmt->description);
1026 device_printf(dev, "No playback.\n");
1029 if (sc->sc_rec_chan.num_alt > 0) {
1033 * Need to set a default alternate interface, else
1034 * some USB audio devices might go into an infinte
1035 * re-enumeration loop:
1037 err = usbd_set_alt_interface_index(sc->sc_udev,
1038 sc->sc_rec_chan.usb_alt[0].iface_index,
1039 sc->sc_rec_chan.usb_alt[0].iface_alt_index);
1041 DPRINTF("setting of alternate index failed: %s!\n",
1044 for (x = 0; x != sc->sc_rec_chan.num_alt; x++) {
1045 device_printf(dev, "Record: %d Hz, %d ch, %s format, "
1047 sc->sc_rec_chan.usb_alt[x].sample_rate,
1048 sc->sc_rec_chan.usb_alt[x].channels,
1049 sc->sc_rec_chan.usb_alt[x].p_fmt->description);
1052 device_printf(dev, "No recording.\n");
1055 if (sc->sc_midi_chan.valid == 0) {
1056 if (usbd_lookup_id_by_uaa(uaudio_vendor_midi,
1057 sizeof(uaudio_vendor_midi), uaa) == 0) {
1058 sc->sc_midi_chan.iface_index =
1059 (uint8_t)uaa->driver_info;
1060 sc->sc_midi_chan.iface_alt_index = 0;
1061 sc->sc_midi_chan.valid = 1;
1065 if (sc->sc_midi_chan.valid) {
1067 if (umidi_probe(dev)) {
1070 device_printf(dev, "MIDI sequencer.\n");
1072 device_printf(dev, "No MIDI sequencer.\n");
1075 DPRINTF("doing child attach\n");
1077 /* attach the children */
1079 sc->sc_sndcard_func.func = SCF_PCM;
1082 * Only attach a PCM device if we have a playback, recording
1083 * or mixer device present:
1085 if (sc->sc_play_chan.num_alt > 0 ||
1086 sc->sc_rec_chan.num_alt > 0 ||
1088 child = device_add_child(dev, "pcm", -1);
1090 if (child == NULL) {
1091 DPRINTF("out of memory\n");
1094 device_set_ivars(child, &sc->sc_sndcard_func);
1097 if (bus_generic_attach(dev)) {
1098 DPRINTF("child attach failed\n");
1102 if (uaudio_hid_probe(sc, uaa) == 0) {
1103 device_printf(dev, "HID volume keys found.\n");
1105 device_printf(dev, "No HID volume keys found.\n");
1108 /* reload all mixer settings */
1109 uaudio_mixer_reload_all(sc);
1111 /* enable S/PDIF output, if any */
1112 if (sc->sc_set_spdif_fn(sc,
1113 UAUDIO_SPDIF_OUT | UAUDIO_SPDIF_OUT_48K) != 0) {
1114 device_printf(dev, "Failed to enable S/PDIF at 48K\n");
1116 return (0); /* success */
1124 uaudio_pcm_setflags(device_t dev, uint32_t flags)
1126 pcm_setflags(dev, pcm_getflags(dev) | flags);
1130 uaudio_attach_sub(device_t dev, kobj_class_t mixer_class, kobj_class_t chan_class)
1132 struct uaudio_softc *sc = device_get_softc(device_get_parent(dev));
1133 char status[SND_STATUSLEN];
1135 uaudio_mixer_init(sc);
1137 if (sc->sc_uq_audio_swap_lr) {
1138 DPRINTF("hardware has swapped left and right\n");
1139 /* uaudio_pcm_setflags(dev, SD_F_PSWAPLR); */
1141 if (!(sc->sc_mix_info & SOUND_MASK_PCM)) {
1143 DPRINTF("emulating master volume\n");
1146 * Emulate missing pcm mixer controller
1147 * through FEEDER_VOLUME
1149 uaudio_pcm_setflags(dev, SD_F_SOFTPCMVOL);
1151 if (sc->sc_pcm_bitperfect) {
1152 DPRINTF("device needs bitperfect by default\n");
1153 uaudio_pcm_setflags(dev, SD_F_BITPERFECT);
1155 if (mixer_init(dev, mixer_class, sc))
1157 sc->sc_mixer_init = 1;
1159 mixer_hwvol_init(dev);
1161 snprintf(status, sizeof(status), "at ? %s", PCM_KLDSTRING(snd_uaudio));
1163 if (pcm_register(dev, sc,
1164 (sc->sc_play_chan.num_alt > 0) ? 1 : 0,
1165 (sc->sc_rec_chan.num_alt > 0) ? 1 : 0)) {
1169 uaudio_pcm_setflags(dev, SD_F_MPSAFE);
1170 sc->sc_pcm_registered = 1;
1172 if (sc->sc_play_chan.num_alt > 0) {
1173 pcm_addchan(dev, PCMDIR_PLAY, chan_class, sc);
1175 if (sc->sc_rec_chan.num_alt > 0) {
1176 pcm_addchan(dev, PCMDIR_REC, chan_class, sc);
1178 pcm_setstatus(dev, status);
1180 uaudio_mixer_register_sysctl(sc, dev);
1182 SYSCTL_ADD_INT(device_get_sysctl_ctx(dev),
1183 SYSCTL_CHILDREN(device_get_sysctl_tree(dev)), OID_AUTO,
1184 "feedback_rate", CTLFLAG_RD, &sc->sc_play_chan.feedback_rate,
1185 0, "Feedback sample rate in Hz");
1187 return (0); /* success */
1190 uaudio_detach_sub(dev);
1195 uaudio_detach_sub(device_t dev)
1197 struct uaudio_softc *sc = device_get_softc(device_get_parent(dev));
1200 /* disable S/PDIF output, if any */
1201 (void) sc->sc_set_spdif_fn(sc, 0);
1204 if (sc->sc_pcm_registered) {
1205 error = pcm_unregister(dev);
1207 if (sc->sc_mixer_init) {
1208 error = mixer_uninit(dev);
1213 device_printf(dev, "Waiting for sound application to exit!\n");
1214 usb_pause_mtx(NULL, 2 * hz);
1215 goto repeat; /* try again */
1217 return (0); /* success */
1221 uaudio_detach(device_t dev)
1223 struct uaudio_softc *sc = device_get_softc(dev);
1226 * Stop USB transfers early so that any audio applications
1227 * will time out and close opened /dev/dspX.Y device(s), if
1230 usb_proc_explore_lock(sc->sc_udev);
1231 sc->sc_play_chan.operation = CHAN_OP_DRAIN;
1232 sc->sc_rec_chan.operation = CHAN_OP_DRAIN;
1233 usb_proc_explore_mwait(sc->sc_udev,
1234 &sc->sc_config_msg[0], &sc->sc_config_msg[1]);
1235 usb_proc_explore_unlock(sc->sc_udev);
1237 usbd_transfer_unsetup(sc->sc_play_chan.xfer, UAUDIO_NCHANBUFS + 1);
1238 usbd_transfer_unsetup(sc->sc_rec_chan.xfer, UAUDIO_NCHANBUFS + 1);
1240 uaudio_hid_detach(sc);
1242 if (bus_generic_detach(dev) != 0) {
1243 DPRINTF("detach failed!\n");
1245 sbuf_delete(&sc->sc_sndstat);
1246 sc->sc_sndstat_valid = 0;
1250 /* free mixer data */
1252 uaudio_mixer_ctl_free(sc);
1258 uaudio_get_buffer_size(struct uaudio_chan *ch, uint8_t alt)
1260 struct uaudio_chan_alt *chan_alt = &ch->usb_alt[alt];
1261 /* We use 2 times 8ms of buffer */
1262 uint32_t buf_size = chan_alt->sample_size *
1263 howmany(chan_alt->sample_rate * (UAUDIO_NFRAMES / 8), 1000);
1268 uaudio_configure_msg_sub(struct uaudio_softc *sc,
1269 struct uaudio_chan *chan, int dir)
1271 struct uaudio_chan_alt *chan_alt;
1280 if (chan->num_alt <= 0)
1285 usb_proc_explore_lock(sc->sc_udev);
1286 operation = chan->operation;
1287 chan->operation = CHAN_OP_NONE;
1288 usb_proc_explore_unlock(sc->sc_udev);
1290 mtx_lock(chan->pcm_mtx);
1291 if (chan->cur_alt != chan->set_alt)
1292 set_alt = chan->set_alt;
1294 set_alt = CHAN_MAX_ALT;
1295 mtx_unlock(chan->pcm_mtx);
1297 if (set_alt >= chan->num_alt)
1300 chan_alt = chan->usb_alt + set_alt;
1302 usbd_transfer_unsetup(chan->xfer, UAUDIO_NCHANBUFS + 1);
1304 err = usbd_set_alt_interface_index(sc->sc_udev,
1305 chan_alt->iface_index, chan_alt->iface_alt_index);
1307 DPRINTF("setting of alternate index failed: %s!\n",
1313 * Only set the sample rate if the channel reports that it
1314 * supports the frequency control.
1317 if (sc->sc_audio_rev >= UAUDIO_VERSION_30) {
1319 } else if (sc->sc_audio_rev >= UAUDIO_VERSION_20) {
1322 for (x = 0; x != 256; x++) {
1323 if (dir == PCMDIR_PLAY) {
1324 if (!(sc->sc_mixer_clocks.bit_output[x / 8] &
1329 if (!(sc->sc_mixer_clocks.bit_input[x / 8] &
1335 if (uaudio20_set_speed(sc->sc_udev,
1336 sc->sc_mixer_iface_no, x, chan_alt->sample_rate)) {
1338 * If the endpoint is adaptive setting
1339 * the speed may fail.
1341 DPRINTF("setting of sample rate failed! "
1342 "(continuing anyway)\n");
1345 } else if (chan_alt->p_sed.v1->bmAttributes & UA_SED_FREQ_CONTROL) {
1346 if (uaudio_set_speed(sc->sc_udev,
1347 chan_alt->p_ed1->bEndpointAddress, chan_alt->sample_rate)) {
1349 * If the endpoint is adaptive setting the
1352 DPRINTF("setting of sample rate failed! "
1353 "(continuing anyway)\n");
1356 if (usbd_transfer_setup(sc->sc_udev, &chan_alt->iface_index, chan->xfer,
1357 chan_alt->usb_cfg, UAUDIO_NCHANBUFS + 1, chan, chan->pcm_mtx)) {
1358 DPRINTF("could not allocate USB transfers!\n");
1362 fps = usbd_get_isoc_fps(sc->sc_udev);
1365 /* FULL speed USB */
1366 frames = uaudio_buffer_ms;
1368 /* HIGH speed USB */
1369 frames = uaudio_buffer_ms * 8;
1372 fps_shift = usbd_xfer_get_fps_shift(chan->xfer[0]);
1374 /* down shift number of frames per second, if any */
1376 frames >>= fps_shift;
1378 /* bytes per frame should not be zero */
1379 chan->bytes_per_frame[0] =
1380 ((chan_alt->sample_rate / fps) * chan_alt->sample_size);
1381 chan->bytes_per_frame[1] = howmany(chan_alt->sample_rate, fps) *
1382 chan_alt->sample_size;
1384 /* setup data rate dithering, if any */
1385 chan->frames_per_second = fps;
1386 chan->sample_rem = chan_alt->sample_rate % fps;
1387 chan->sample_curr = 0;
1389 /* compute required buffer size */
1390 buf_size = (chan->bytes_per_frame[1] * frames);
1392 if (buf_size > (chan->end - chan->start)) {
1393 DPRINTF("buffer size is too big\n");
1397 chan->intr_frames = frames;
1399 DPRINTF("fps=%d sample_rem=%d\n", (int)fps, (int)chan->sample_rem);
1401 if (chan->intr_frames == 0) {
1402 DPRINTF("frame shift is too high!\n");
1406 mtx_lock(chan->pcm_mtx);
1407 chan->cur_alt = set_alt;
1408 mtx_unlock(chan->pcm_mtx);
1411 #if (UAUDIO_NCHANBUFS != 2)
1412 #error "please update code"
1414 switch (operation) {
1416 mtx_lock(chan->pcm_mtx);
1417 usbd_transfer_start(chan->xfer[0]);
1418 usbd_transfer_start(chan->xfer[1]);
1419 mtx_unlock(chan->pcm_mtx);
1422 mtx_lock(chan->pcm_mtx);
1423 usbd_transfer_stop(chan->xfer[0]);
1424 usbd_transfer_stop(chan->xfer[1]);
1425 mtx_unlock(chan->pcm_mtx);
1433 usbd_transfer_unsetup(chan->xfer, UAUDIO_NCHANBUFS + 1);
1435 mtx_lock(chan->pcm_mtx);
1436 chan->cur_alt = CHAN_MAX_ALT;
1437 mtx_unlock(chan->pcm_mtx);
1441 uaudio_configure_msg(struct usb_proc_msg *pm)
1443 struct uaudio_softc *sc = ((struct uaudio_configure_msg *)pm)->sc;
1445 usb_proc_explore_unlock(sc->sc_udev);
1446 uaudio_configure_msg_sub(sc, &sc->sc_play_chan, PCMDIR_PLAY);
1447 uaudio_configure_msg_sub(sc, &sc->sc_rec_chan, PCMDIR_REC);
1448 usb_proc_explore_lock(sc->sc_udev);
1451 /*========================================================================*
1452 * AS - Audio Stream - routines
1453 *========================================================================*/
1457 uaudio_chan_dump_ep_desc(const usb_endpoint_descriptor_audio_t *ed)
1460 DPRINTF("endpoint=%p bLength=%d bDescriptorType=%d \n"
1461 "bEndpointAddress=%d bmAttributes=0x%x \n"
1462 "wMaxPacketSize=%d bInterval=%d \n"
1463 "bRefresh=%d bSynchAddress=%d\n",
1464 ed, ed->bLength, ed->bDescriptorType,
1465 ed->bEndpointAddress, ed->bmAttributes,
1466 UGETW(ed->wMaxPacketSize), ed->bInterval,
1467 UEP_HAS_REFRESH(ed) ? ed->bRefresh : 0,
1468 UEP_HAS_SYNCADDR(ed) ? ed->bSynchAddress : 0);
1475 * The following is a workaround for broken no-name USB audio devices
1476 * sold by dealextreme called "3D sound". The problem is that the
1477 * manufacturer computed wMaxPacketSize is too small to hold the
1478 * actual data sent. In other words the device sometimes sends more
1479 * data than it actually reports it can send in a single isochronous
1483 uaudio_record_fix_fs(usb_endpoint_descriptor_audio_t *ep,
1484 uint32_t xps, uint32_t add)
1488 mps = UGETW(ep->wMaxPacketSize);
1491 * If the device indicates it can send more data than what the
1492 * sample rate indicates, we apply the workaround.
1496 /* allow additional data */
1499 /* check against the maximum USB 1.x length */
1503 /* check if we should do an update */
1505 /* simply update the wMaxPacketSize field */
1506 USETW(ep->wMaxPacketSize, xps);
1507 DPRINTF("Workaround: Updated wMaxPacketSize "
1508 "from %d to %d bytes.\n",
1509 (int)mps, (int)xps);
1515 uaudio20_check_rate(struct usb_device *udev, uint8_t iface_no,
1516 uint8_t clockid, uint32_t rate)
1518 struct usb_device_request req;
1520 #define UAUDIO20_MAX_RATES 32 /* we support at maxium 32 rates */
1521 uint8_t data[2 + UAUDIO20_MAX_RATES * 12];
1526 DPRINTFN(6, "ifaceno=%d clockid=%d rate=%u\n",
1527 iface_no, clockid, rate);
1529 req.bmRequestType = UT_READ_CLASS_INTERFACE;
1530 req.bRequest = UA20_CS_RANGE;
1531 USETW2(req.wValue, UA20_CS_SAM_FREQ_CONTROL, 0);
1532 USETW2(req.wIndex, clockid, iface_no);
1534 * Assume there is at least one rate to begin with, else some
1535 * devices might refuse to return the USB descriptor:
1537 USETW(req.wLength, (2 + 1 * 12));
1539 error = usbd_do_request_flags(udev, NULL, &req, data,
1540 USB_SHORT_XFER_OK, &actlen, USB_DEFAULT_TIMEOUT);
1542 if (error != 0 || actlen < 2) {
1544 * Likely the descriptor doesn't fit into the supplied
1545 * buffer. Try using a larger buffer and see if that
1548 rates = MIN(UAUDIO20_MAX_RATES, (255 - 2) / 12);
1549 error = USB_ERR_INVAL;
1551 rates = UGETW(data);
1553 if (rates > UAUDIO20_MAX_RATES) {
1554 DPRINTF("Too many rates truncating to %d\n", UAUDIO20_MAX_RATES);
1555 rates = UAUDIO20_MAX_RATES;
1556 error = USB_ERR_INVAL;
1557 } else if (rates > 1) {
1558 DPRINTF("Need to read full rate descriptor\n");
1559 error = USB_ERR_INVAL;
1565 * Try to read full rate descriptor.
1567 actlen = (2 + rates * 12);
1569 USETW(req.wLength, actlen);
1571 error = usbd_do_request_flags(udev, NULL, &req, data,
1572 USB_SHORT_XFER_OK, &actlen, USB_DEFAULT_TIMEOUT);
1574 if (error != 0 || actlen < 2)
1575 return (USB_ERR_INVAL);
1577 rates = UGETW(data);
1580 actlen = (actlen - 2) / 12;
1582 if (rates > actlen) {
1583 DPRINTF("Too many rates truncating to %d\n", actlen);
1587 for (x = 0; x != rates; x++) {
1588 uint32_t min = UGETDW(data + 2 + (12 * x));
1589 uint32_t max = UGETDW(data + 6 + (12 * x));
1590 uint32_t res = UGETDW(data + 10 + (12 * x));
1593 DPRINTF("Zero residue\n");
1598 DPRINTF("Swapped max and min\n");
1605 if (rate >= min && rate <= max &&
1606 (((rate - min) % res) == 0)) {
1610 return (USB_ERR_INVAL);
1614 uaudio_chan_fill_info_sub(struct uaudio_softc *sc, struct usb_device *udev,
1615 uint32_t rate, uint8_t channels, uint8_t bit_resolution)
1617 struct usb_descriptor *desc = NULL;
1618 union uaudio_asid asid = { NULL };
1619 union uaudio_asf1d asf1d = { NULL };
1620 union uaudio_sed sed = { NULL };
1621 struct usb_midi_streaming_endpoint_descriptor *msid = NULL;
1622 usb_endpoint_descriptor_audio_t *ed1 = NULL;
1623 const struct usb_audio_control_descriptor *acdp = NULL;
1624 struct usb_config_descriptor *cd = usbd_get_config_descriptor(udev);
1625 struct usb_interface_descriptor *id;
1626 const struct uaudio_format *p_fmt = NULL;
1627 struct uaudio_chan *chan;
1628 struct uaudio_chan_alt *chan_alt;
1630 uint16_t curidx = 0xFFFF;
1631 uint16_t lastidx = 0xFFFF;
1632 uint16_t alt_index = 0;
1633 uint16_t audio_rev = 0;
1637 uint8_t bBitResolution;
1638 uint8_t audio_if = 0;
1639 uint8_t midi_if = 0;
1640 uint8_t uma_if_class;
1642 while ((desc = usb_desc_foreach(cd, desc))) {
1644 if ((desc->bDescriptorType == UDESC_INTERFACE) &&
1645 (desc->bLength >= sizeof(*id))) {
1649 if (id->bInterfaceNumber != lastidx) {
1650 lastidx = id->bInterfaceNumber;
1658 if ((!(sc->sc_hid.flags & UAUDIO_HID_VALID)) &&
1659 (id->bInterfaceClass == UICLASS_HID) &&
1660 (id->bInterfaceSubClass == 0) &&
1661 (id->bInterfaceProtocol == 0) &&
1663 usbd_get_iface(udev, curidx) != NULL) {
1664 DPRINTF("Found HID interface at %d\n",
1666 sc->sc_hid.flags |= UAUDIO_HID_VALID;
1667 sc->sc_hid.iface_index = curidx;
1671 ((id->bInterfaceClass == UICLASS_AUDIO) ||
1672 ((id->bInterfaceClass == UICLASS_VENDOR) &&
1673 (sc->sc_uq_au_vendor_class != 0)));
1675 if ((uma_if_class != 0) &&
1676 (id->bInterfaceSubClass == UISUBCLASS_AUDIOSTREAM)) {
1682 if ((uma_if_class != 0) &&
1683 (id->bInterfaceSubClass == UISUBCLASS_MIDISTREAM)) {
1686 * XXX could allow multiple MIDI interfaces
1690 if ((sc->sc_midi_chan.valid == 0) &&
1691 (usbd_get_iface(udev, curidx) != NULL)) {
1692 sc->sc_midi_chan.iface_index = curidx;
1693 sc->sc_midi_chan.iface_alt_index = alt_index;
1694 sc->sc_midi_chan.valid = 1;
1705 * There can only be one USB audio instance
1706 * per USB device. Grab all USB audio
1707 * interfaces on this USB device so that we
1708 * don't attach USB audio twice:
1710 if (alt_index == 0 && curidx != sc->sc_mixer_iface_index &&
1711 (id->bInterfaceClass == UICLASS_AUDIO || audio_if != 0 ||
1713 usbd_set_parent_iface(sc->sc_udev, curidx,
1714 sc->sc_mixer_iface_index);
1718 if (audio_if == 0) {
1720 if ((acdp == NULL) &&
1721 (desc->bDescriptorType == UDESC_CS_INTERFACE) &&
1722 (desc->bDescriptorSubtype == UDESCSUB_AC_HEADER) &&
1723 (desc->bLength >= sizeof(*acdp))) {
1724 acdp = (void *)desc;
1725 audio_rev = UGETW(acdp->bcdADC);
1728 msid = (void *)desc;
1730 /* get the maximum number of embedded jacks in use, if any */
1731 if (msid->bLength >= sizeof(*msid) &&
1732 msid->bDescriptorType == UDESC_CS_ENDPOINT &&
1733 msid->bDescriptorSubtype == MS_GENERAL &&
1734 msid->bNumEmbMIDIJack > sc->sc_midi_chan.max_emb_jack) {
1735 sc->sc_midi_chan.max_emb_jack = msid->bNumEmbMIDIJack;
1739 * Don't collect any USB audio descriptors if
1740 * this is not an USB audio stream interface.
1745 if ((acdp != NULL || sc->sc_uq_au_vendor_class != 0) &&
1746 (desc->bDescriptorType == UDESC_CS_INTERFACE) &&
1747 (desc->bDescriptorSubtype == AS_GENERAL) &&
1748 (asid.v1 == NULL)) {
1749 if (audio_rev >= UAUDIO_VERSION_30) {
1751 } else if (audio_rev >= UAUDIO_VERSION_20) {
1752 if (desc->bLength >= sizeof(*asid.v2)) {
1753 asid.v2 = (void *)desc;
1756 if (desc->bLength >= sizeof(*asid.v1)) {
1757 asid.v1 = (void *)desc;
1761 if ((acdp != NULL || sc->sc_uq_au_vendor_class != 0) &&
1762 (desc->bDescriptorType == UDESC_CS_INTERFACE) &&
1763 (desc->bDescriptorSubtype == FORMAT_TYPE) &&
1764 (asf1d.v1 == NULL)) {
1765 if (audio_rev >= UAUDIO_VERSION_30) {
1767 } else if (audio_rev >= UAUDIO_VERSION_20) {
1768 if (desc->bLength >= sizeof(*asf1d.v2))
1769 asf1d.v2 = (void *)desc;
1771 if (desc->bLength >= sizeof(*asf1d.v1)) {
1772 asf1d.v1 = (void *)desc;
1774 if (asf1d.v1->bFormatType != FORMAT_TYPE_I) {
1775 DPRINTFN(11, "ignored bFormatType = %d\n",
1776 asf1d.v1->bFormatType);
1780 if (desc->bLength < (sizeof(*asf1d.v1) +
1781 ((asf1d.v1->bSamFreqType == 0) ? 6 :
1782 (asf1d.v1->bSamFreqType * 3)))) {
1783 DPRINTFN(11, "invalid descriptor, "
1791 if ((desc->bDescriptorType == UDESC_ENDPOINT) &&
1792 (desc->bLength >= UEP_MINSIZE) &&
1795 if (UE_GET_XFERTYPE(ed1->bmAttributes) != UE_ISOCHRONOUS) {
1800 if ((acdp != NULL || sc->sc_uq_au_vendor_class != 0) &&
1801 (desc->bDescriptorType == UDESC_CS_ENDPOINT) &&
1802 (desc->bDescriptorSubtype == AS_GENERAL) &&
1804 if (audio_rev >= UAUDIO_VERSION_30) {
1806 } else if (audio_rev >= UAUDIO_VERSION_20) {
1807 if (desc->bLength >= sizeof(*sed.v2))
1808 sed.v2 = (void *)desc;
1810 if (desc->bLength >= sizeof(*sed.v1))
1811 sed.v1 = (void *)desc;
1814 if (asid.v1 == NULL || asf1d.v1 == NULL ||
1815 ed1 == NULL || sed.v1 == NULL) {
1816 /* need more descriptors */
1820 ep_dir = UE_GET_DIR(ed1->bEndpointAddress);
1822 /* We ignore sync endpoint information until further. */
1824 if (audio_rev >= UAUDIO_VERSION_30) {
1826 } else if (audio_rev >= UAUDIO_VERSION_20) {
1830 dwFormat = UGETDW(asid.v2->bmFormats);
1831 bChannels = asid.v2->bNrChannels;
1832 bBitResolution = asf1d.v2->bSubslotSize * 8;
1834 if ((bChannels != channels) ||
1835 (bBitResolution != bit_resolution)) {
1836 DPRINTF("Wrong number of channels\n");
1840 for (p_fmt = uaudio20_formats;
1841 p_fmt->wFormat != 0; p_fmt++) {
1842 if ((p_fmt->wFormat & dwFormat) &&
1843 (p_fmt->bPrecision == bBitResolution))
1847 if (p_fmt->wFormat == 0) {
1848 DPRINTF("Unsupported audio format\n");
1852 for (x = 0; x != 256; x++) {
1853 if (ep_dir == UE_DIR_OUT) {
1854 if (!(sc->sc_mixer_clocks.bit_output[x / 8] &
1859 if (!(sc->sc_mixer_clocks.bit_input[x / 8] &
1865 DPRINTF("Checking clock ID=%d\n", x);
1867 if (uaudio20_check_rate(udev,
1868 sc->sc_mixer_iface_no, x, rate)) {
1869 DPRINTF("Unsupported sampling "
1870 "rate, id=%d\n", x);
1877 wFormat = UGETW(asid.v1->wFormatTag);
1878 bChannels = UAUDIO_MAX_CHAN(asf1d.v1->bNrChannels);
1879 bBitResolution = asf1d.v1->bSubFrameSize * 8;
1881 if (asf1d.v1->bSamFreqType == 0) {
1882 DPRINTFN(16, "Sample rate: %d-%dHz\n",
1883 UA_SAMP_LO(asf1d.v1),
1884 UA_SAMP_HI(asf1d.v1));
1886 if ((rate >= UA_SAMP_LO(asf1d.v1)) &&
1887 (rate <= UA_SAMP_HI(asf1d.v1)))
1891 for (x = 0; x < asf1d.v1->bSamFreqType; x++) {
1892 DPRINTFN(16, "Sample rate = %dHz\n",
1893 UA_GETSAMP(asf1d.v1, x));
1895 if (rate == UA_GETSAMP(asf1d.v1, x))
1902 for (p_fmt = uaudio10_formats;
1903 p_fmt->wFormat != 0; p_fmt++) {
1904 if ((p_fmt->wFormat == wFormat) &&
1905 (p_fmt->bPrecision == bBitResolution))
1908 if (p_fmt->wFormat == 0) {
1909 DPRINTF("Unsupported audio format\n");
1913 if ((bChannels != channels) ||
1914 (bBitResolution != bit_resolution)) {
1915 DPRINTF("Wrong number of channels\n");
1920 chan = (ep_dir == UE_DIR_IN) ?
1921 &sc->sc_rec_chan : &sc->sc_play_chan;
1923 if (usbd_get_iface(udev, curidx) == NULL) {
1924 DPRINTF("Interface is not valid\n");
1927 if (chan->num_alt == CHAN_MAX_ALT) {
1928 DPRINTF("Too many alternate settings\n");
1932 chan->cur_alt = CHAN_MAX_ALT;
1934 chan_alt = &chan->usb_alt[chan->num_alt++];
1937 uaudio_chan_dump_ep_desc(ed1);
1939 DPRINTF("Sample rate = %dHz, channels = %d, "
1940 "bits = %d, format = %s\n", rate, channels,
1941 bit_resolution, p_fmt->description);
1943 chan_alt->sample_rate = rate;
1944 chan_alt->p_asf1d = asf1d;
1945 chan_alt->p_ed1 = ed1;
1946 chan_alt->p_fmt = p_fmt;
1947 chan_alt->p_sed = sed;
1948 chan_alt->iface_index = curidx;
1949 chan_alt->iface_alt_index = alt_index;
1951 if (ep_dir == UE_DIR_IN)
1952 chan_alt->usb_cfg = uaudio_cfg_record;
1954 chan_alt->usb_cfg = uaudio_cfg_play;
1956 chan_alt->sample_size = (UAUDIO_MAX_CHAN(channels) *
1957 p_fmt->bPrecision) / 8;
1958 chan_alt->channels = channels;
1960 if (ep_dir == UE_DIR_IN &&
1961 usbd_get_speed(udev) == USB_SPEED_FULL) {
1962 uaudio_record_fix_fs(ed1,
1963 chan_alt->sample_size * (rate / 1000),
1964 chan_alt->sample_size * (rate / 4000));
1967 /* setup play/record format */
1969 format = chan_alt->p_fmt->freebsd_fmt;
1971 /* get default SND_FORMAT() */
1972 format = SND_FORMAT(format, chan_alt->channels, 0);
1974 switch (chan_alt->channels) {
1978 /* mono and stereo */
1981 /* surround and more */
1982 temp_fmt = feeder_matrix_default_format(format);
1983 /* if multichannel, then format can be zero */
1989 /* check if format is not supported */
1991 DPRINTF("The selected audio format is not supported\n");
1995 if (chan->num_alt > 1) {
1996 /* we only accumulate one format at different sample rates */
1997 if (chan->pcm_format[0] != format) {
1998 DPRINTF("Multiple formats is not supported\n");
2002 /* ignore if duplicate sample rate entry */
2003 if (rate == chan->usb_alt[chan->num_alt - 2].sample_rate) {
2004 DPRINTF("Duplicate sample rate detected\n");
2009 chan->pcm_cap.fmtlist = chan->pcm_format;
2010 chan->pcm_cap.fmtlist[0] = format;
2012 /* check if device needs bitperfect */
2013 if (chan_alt->channels > UAUDIO_MATRIX_MAX)
2014 sc->sc_pcm_bitperfect = 1;
2016 if (rate < chan->pcm_cap.minspeed || chan->pcm_cap.minspeed == 0)
2017 chan->pcm_cap.minspeed = rate;
2018 if (rate > chan->pcm_cap.maxspeed || chan->pcm_cap.maxspeed == 0)
2019 chan->pcm_cap.maxspeed = rate;
2021 if (sc->sc_sndstat_valid != 0) {
2022 sbuf_printf(&sc->sc_sndstat, "\n\t"
2023 "mode %d.%d:(%s) %dch, %dbit, %s, %dHz",
2025 (ep_dir == UE_DIR_IN) ? "input" : "output",
2026 channels, p_fmt->bPrecision,
2027 p_fmt->description, rate);
2036 /* This structure defines all the supported rates. */
2038 static const uint32_t uaudio_rate_list[CHAN_MAX_ALT] = {
2063 uaudio_chan_fill_info(struct uaudio_softc *sc, struct usb_device *udev)
2065 uint32_t rate = uaudio_default_rate;
2067 uint8_t bits = uaudio_default_bits;
2069 uint8_t channels = uaudio_default_channels;
2073 if ((bits == 0) || (bits > 32)) {
2074 /* set a valid value */
2077 if (channels == 0) {
2078 switch (usbd_get_speed(udev)) {
2080 case USB_SPEED_FULL:
2082 * Due to high bandwidth usage and problems
2083 * with HIGH-speed split transactions we
2084 * disable surround setups on FULL-speed USB
2090 channels = UAUDIO_CHANNELS_MAX;
2093 } else if (channels > UAUDIO_CHANNELS_MAX)
2094 channels = UAUDIO_CHANNELS_MAX;
2096 if (sbuf_new(&sc->sc_sndstat, NULL, 4096, SBUF_AUTOEXTEND))
2097 sc->sc_sndstat_valid = 1;
2099 /* try to search for a valid config */
2101 for (x = channels; x; x--) {
2102 for (y = bits; y; y -= 8) {
2104 /* try user defined rate, if any */
2106 uaudio_chan_fill_info_sub(sc, udev, rate, x, y);
2108 /* try find a matching rate, if any */
2109 for (z = 0; uaudio_rate_list[z]; z++)
2110 uaudio_chan_fill_info_sub(sc, udev, uaudio_rate_list[z], x, y);
2113 if (sc->sc_sndstat_valid)
2114 sbuf_finish(&sc->sc_sndstat);
2118 uaudio_chan_play_sync_callback(struct usb_xfer *xfer, usb_error_t error)
2120 struct uaudio_chan *ch = usbd_xfer_softc(xfer);
2121 struct usb_page_cache *pc;
2122 uint64_t sample_rate;
2129 usbd_xfer_status(xfer, &actlen, NULL, NULL, &nframes);
2131 switch (USB_GET_STATE(xfer)) {
2132 case USB_ST_TRANSFERRED:
2134 DPRINTFN(6, "transferred %d bytes\n", actlen);
2138 len = usbd_xfer_frame_len(xfer, 0);
2141 if (len > sizeof(buf))
2144 memset(buf, 0, sizeof(buf));
2146 pc = usbd_xfer_get_frame(xfer, 0);
2147 usbd_copy_out(pc, 0, buf, len);
2151 DPRINTF("Value = 0x%08x\n", (int)temp);
2153 /* auto-detect SYNC format */
2158 /* check for no data */
2165 sample_rate = ch->usb_alt[ch->cur_alt].sample_rate;
2168 while (temp < (sample_rate - (sample_rate / 4)))
2171 while (temp > (sample_rate + (sample_rate / 2)))
2174 DPRINTF("Comparing %d Hz :: %d Hz\n",
2175 (int)temp, (int)sample_rate);
2178 * Use feedback value as fallback when there is no
2179 * recording channel:
2181 if (ch->priv_sc->sc_rec_chan.num_alt == 0) {
2182 int32_t jitter_max = howmany(sample_rate, 16000);
2185 * Range check the jitter values to avoid
2186 * bogus sample rate adjustments. The expected
2187 * deviation should not be more than 1Hz per
2188 * second. The USB v2.0 specification also
2189 * mandates this requirement. Refer to chapter
2190 * 5.12.4.2 about feedback.
2192 ch->jitter_curr = temp - sample_rate;
2193 if (ch->jitter_curr > jitter_max)
2194 ch->jitter_curr = jitter_max;
2195 else if (ch->jitter_curr < -jitter_max)
2196 ch->jitter_curr = -jitter_max;
2198 ch->feedback_rate = temp;
2203 * Check if the recording stream can be used as a
2204 * source of jitter information to save some
2205 * isochronous bandwidth:
2207 if (ch->priv_sc->sc_rec_chan.num_alt != 0 &&
2210 usbd_xfer_set_frames(xfer, 1);
2211 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_framelen(xfer));
2212 usbd_transfer_submit(xfer);
2215 default: /* Error */
2221 uaudio_chan_is_async(struct uaudio_chan *ch, uint8_t alt)
2223 uint8_t attr = ch->usb_alt[alt].p_ed1->bmAttributes;
2224 return (UE_GET_ISO_TYPE(attr) == UE_ISO_ASYNC);
2228 uaudio_chan_play_callback(struct usb_xfer *xfer, usb_error_t error)
2230 struct uaudio_chan *ch = usbd_xfer_softc(xfer);
2231 struct uaudio_chan *ch_rec;
2232 struct usb_page_cache *pc;
2235 uint32_t blockcount;
2242 if (ch->running == 0 || ch->start == ch->end) {
2243 DPRINTF("not running or no buffer!\n");
2247 /* check if there is a record channel */
2248 if (ch->priv_sc->sc_rec_chan.num_alt > 0)
2249 ch_rec = &ch->priv_sc->sc_rec_chan;
2253 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL);
2255 switch (USB_GET_STATE(xfer)) {
2258 if (ch_rec != NULL) {
2259 /* reset receive jitter counters */
2260 mtx_lock(ch_rec->pcm_mtx);
2261 ch_rec->jitter_curr = 0;
2262 ch_rec->jitter_rem = 0;
2263 mtx_unlock(ch_rec->pcm_mtx);
2266 /* reset transmit jitter counters */
2267 ch->jitter_curr = 0;
2271 case USB_ST_TRANSFERRED:
2272 if (actlen < sumlen) {
2273 DPRINTF("short transfer, "
2274 "%d of %d bytes\n", actlen, sumlen);
2276 chn_intr(ch->pcm_ch);
2279 * Check for asynchronous playback endpoint and that
2280 * the playback endpoint is properly configured:
2282 if (ch_rec != NULL &&
2283 uaudio_chan_is_async(ch, ch->cur_alt) != 0) {
2284 mtx_lock(ch_rec->pcm_mtx);
2285 if (ch_rec->cur_alt < ch_rec->num_alt) {
2289 /* translate receive jitter into transmit jitter */
2290 tx_jitter = ch->usb_alt[ch->cur_alt].sample_rate;
2291 tx_jitter = (tx_jitter * ch_rec->jitter_curr) +
2294 /* reset receive jitter counters */
2295 ch_rec->jitter_curr = 0;
2296 ch_rec->jitter_rem = 0;
2298 /* compute exact number of transmit jitter samples */
2299 rx_rate = ch_rec->usb_alt[ch_rec->cur_alt].sample_rate;
2300 ch->jitter_curr += tx_jitter / rx_rate;
2301 ch->jitter_rem = tx_jitter % rx_rate;
2303 mtx_unlock(ch_rec->pcm_mtx);
2306 /* start the SYNC transfer one time per second, if any */
2307 ch->intr_counter += ch->intr_frames;
2308 if (ch->intr_counter >= ch->frames_per_second) {
2309 ch->intr_counter -= ch->frames_per_second;
2310 usbd_transfer_start(ch->xfer[UAUDIO_NCHANBUFS]);
2313 mfl = usbd_xfer_max_framelen(xfer);
2315 if (ch->bytes_per_frame[1] > mfl) {
2316 DPRINTF("bytes per transfer, %d, "
2317 "exceeds maximum, %d!\n",
2318 ch->bytes_per_frame[1],
2323 blockcount = ch->intr_frames;
2325 /* setup number of frames */
2326 usbd_xfer_set_frames(xfer, blockcount);
2328 /* get sample size */
2329 sample_size = ch->usb_alt[ch->cur_alt].sample_size;
2331 /* reset total length */
2334 /* setup frame lengths */
2335 for (n = 0; n != blockcount; n++) {
2338 ch->sample_curr += ch->sample_rem;
2339 if (ch->sample_curr >= ch->frames_per_second) {
2340 ch->sample_curr -= ch->frames_per_second;
2341 frame_len = ch->bytes_per_frame[1];
2343 frame_len = ch->bytes_per_frame[0];
2346 /* handle free running clock case */
2347 if (ch->jitter_curr > 0 &&
2348 (frame_len + sample_size) <= mfl) {
2349 DPRINTFN(6, "sending one sample more\n");
2351 frame_len += sample_size;
2352 } else if (ch->jitter_curr < 0 &&
2353 frame_len >= sample_size) {
2354 DPRINTFN(6, "sending one sample less\n");
2356 frame_len -= sample_size;
2358 usbd_xfer_set_frame_len(xfer, n, frame_len);
2362 DPRINTFN(6, "transferring %d bytes\n", total);
2366 pc = usbd_xfer_get_frame(xfer, 0);
2369 n = (ch->end - ch->cur);
2373 usbd_copy_in(pc, offset, ch->cur, n);
2379 if (ch->cur >= ch->end)
2380 ch->cur = ch->start;
2382 usbd_transfer_submit(xfer);
2385 default: /* Error */
2386 if (error != USB_ERR_CANCELLED)
2393 uaudio_chan_record_sync_callback(struct usb_xfer *xfer, usb_error_t error)
2399 uaudio_chan_record_callback(struct usb_xfer *xfer, usb_error_t error)
2401 struct uaudio_chan *ch = usbd_xfer_softc(xfer);
2402 struct usb_page_cache *pc;
2413 if (ch->start == ch->end) {
2414 DPRINTF("no buffer!\n");
2418 usbd_xfer_status(xfer, &actlen, NULL, NULL, &nframes);
2419 mfl = usbd_xfer_max_framelen(xfer);
2421 switch (USB_GET_STATE(xfer)) {
2422 case USB_ST_TRANSFERRED:
2425 pc = usbd_xfer_get_frame(xfer, 0);
2427 /* try to compute the number of expected bytes */
2428 ch->sample_curr += (ch->sample_rem * ch->intr_frames);
2430 /* compute number of expected bytes */
2431 expected_bytes = (ch->intr_frames * ch->bytes_per_frame[0]) +
2432 ((ch->sample_curr / ch->frames_per_second) *
2433 (ch->bytes_per_frame[1] - ch->bytes_per_frame[0]));
2435 /* keep remainder */
2436 ch->sample_curr %= ch->frames_per_second;
2438 /* get current sample size */
2439 sample_size = ch->usb_alt[ch->cur_alt].sample_size;
2441 for (n = 0; n != nframes; n++) {
2442 uint32_t offset1 = offset0;
2444 len = usbd_xfer_frame_len(xfer, n);
2446 /* make sure we only receive complete samples */
2447 len = len - (len % sample_size);
2449 /* subtract bytes received from expected payload */
2450 expected_bytes -= len;
2452 /* don't receive data when not ready */
2453 if (ch->running == 0 || ch->cur_alt != ch->set_alt)
2456 /* fill ring buffer with samples, if any */
2459 m = (ch->end - ch->cur);
2464 usbd_copy_out(pc, offset1, ch->cur, m);
2470 if (ch->cur >= ch->end)
2471 ch->cur = ch->start;
2477 /* update current jitter */
2478 ch->jitter_curr -= (expected_bytes / sample_size);
2480 /* don't allow a huge amount of jitter to accumulate */
2481 nframes = 2 * ch->intr_frames;
2483 /* range check current jitter */
2484 if (ch->jitter_curr < -nframes)
2485 ch->jitter_curr = -nframes;
2486 else if (ch->jitter_curr > nframes)
2487 ch->jitter_curr = nframes;
2489 DPRINTFN(6, "transferred %d bytes, jitter %d samples\n",
2490 actlen, ch->jitter_curr);
2492 if (ch->running != 0)
2493 chn_intr(ch->pcm_ch);
2497 nframes = ch->intr_frames;
2499 usbd_xfer_set_frames(xfer, nframes);
2500 for (n = 0; n != nframes; n++)
2501 usbd_xfer_set_frame_len(xfer, n, mfl);
2503 usbd_transfer_submit(xfer);
2506 default: /* Error */
2507 if (error != USB_ERR_CANCELLED)
2514 uaudio_chan_init(struct uaudio_softc *sc, struct snd_dbuf *b,
2515 struct pcm_channel *c, int dir)
2517 struct uaudio_chan *ch = ((dir == PCMDIR_PLAY) ?
2518 &sc->sc_play_chan : &sc->sc_rec_chan);
2522 /* store mutex and PCM channel */
2525 ch->pcm_mtx = c->lock;
2527 /* compute worst case buffer */
2530 for (x = 0; x != ch->num_alt; x++) {
2531 uint32_t temp = uaudio_get_buffer_size(ch, x);
2532 if (temp > buf_size)
2536 /* allow double buffering */
2539 DPRINTF("Worst case buffer is %d bytes\n", (int)buf_size);
2541 ch->buf = malloc(buf_size, M_DEVBUF, M_WAITOK | M_ZERO);
2542 if (ch->buf == NULL)
2544 if (sndbuf_setup(b, ch->buf, buf_size) != 0)
2547 ch->start = ch->buf;
2548 ch->end = ch->buf + buf_size;
2551 ch->max_buf = buf_size;
2553 if (ch->pcm_mtx == NULL) {
2554 DPRINTF("ERROR: PCM channels does not have a mutex!\n");
2560 uaudio_chan_free(ch);
2565 uaudio_chan_free(struct uaudio_chan *ch)
2567 if (ch->buf != NULL) {
2568 free(ch->buf, M_DEVBUF);
2571 usbd_transfer_unsetup(ch->xfer, UAUDIO_NCHANBUFS + 1);
2579 uaudio_chan_set_param_blocksize(struct uaudio_chan *ch, uint32_t blocksize)
2581 uint32_t temp = 2 * uaudio_get_buffer_size(ch, ch->set_alt);
2582 sndbuf_setup(ch->pcm_buf, ch->buf, temp);
2587 uaudio_chan_set_param_fragments(struct uaudio_chan *ch, uint32_t blocksize,
2588 uint32_t blockcount)
2594 uaudio_chan_set_param_speed(struct uaudio_chan *ch, uint32_t speed)
2596 struct uaudio_softc *sc;
2601 for (x = 0; x < ch->num_alt; x++) {
2602 if (ch->usb_alt[x].sample_rate < speed) {
2603 /* sample rate is too low */
2611 usb_proc_explore_lock(sc->sc_udev);
2613 usb_proc_explore_unlock(sc->sc_udev);
2615 DPRINTF("Selecting alt %d\n", (int)x);
2617 return (ch->usb_alt[x].sample_rate);
2621 uaudio_chan_getptr(struct uaudio_chan *ch)
2623 return (ch->cur - ch->start);
2626 struct pcmchan_caps *
2627 uaudio_chan_getcaps(struct uaudio_chan *ch)
2629 return (&ch->pcm_cap);
2632 static struct pcmchan_matrix uaudio_chan_matrix_swap_2_0 = {
2633 .id = SND_CHN_MATRIX_DRV,
2639 .type = SND_CHN_T_FR,
2641 SND_CHN_T_MASK_FR | SND_CHN_T_MASK_FC |
2642 SND_CHN_T_MASK_LF | SND_CHN_T_MASK_BR |
2643 SND_CHN_T_MASK_BC | SND_CHN_T_MASK_SR
2647 .type = SND_CHN_T_FL,
2649 SND_CHN_T_MASK_FL | SND_CHN_T_MASK_FC |
2650 SND_CHN_T_MASK_LF | SND_CHN_T_MASK_BL |
2651 SND_CHN_T_MASK_BC | SND_CHN_T_MASK_SL
2654 .type = SND_CHN_T_MAX,
2658 .mask = SND_CHN_T_MASK_FR | SND_CHN_T_MASK_FL,
2659 .offset = { 1, 0, -1, -1, -1, -1, -1, -1, -1,
2660 -1, -1, -1, -1, -1, -1, -1, -1, -1 }
2663 struct pcmchan_matrix *
2664 uaudio_chan_getmatrix(struct uaudio_chan *ch, uint32_t format)
2666 struct uaudio_softc *sc;
2670 if (sc != NULL && sc->sc_uq_audio_swap_lr != 0 &&
2671 AFMT_CHANNEL(format) == 2)
2672 return (&uaudio_chan_matrix_swap_2_0);
2674 return (feeder_matrix_format_map(format));
2678 uaudio_chan_set_param_format(struct uaudio_chan *ch, uint32_t format)
2680 DPRINTF("Selecting format 0x%08x\n", (unsigned int)format);
2685 uaudio_chan_start_sub(struct uaudio_chan *ch)
2687 struct uaudio_softc *sc = ch->priv_sc;
2690 if (ch->operation != CHAN_OP_DRAIN) {
2691 if (ch->cur_alt == ch->set_alt &&
2692 ch->operation == CHAN_OP_NONE &&
2693 mtx_owned(ch->pcm_mtx) != 0) {
2694 /* save doing the explore task */
2697 ch->operation = CHAN_OP_START;
2698 (void)usb_proc_explore_msignal(sc->sc_udev,
2699 &sc->sc_config_msg[0], &sc->sc_config_msg[1]);
2703 usbd_transfer_start(ch->xfer[0]);
2704 usbd_transfer_start(ch->xfer[1]);
2709 uaudio_chan_need_both(struct uaudio_softc *sc)
2711 return (sc->sc_play_chan.num_alt > 0 &&
2712 sc->sc_play_chan.running != 0 &&
2713 uaudio_chan_is_async(&sc->sc_play_chan,
2714 sc->sc_play_chan.set_alt) != 0 &&
2715 sc->sc_rec_chan.num_alt > 0 &&
2716 sc->sc_rec_chan.running == 0);
2720 uaudio_chan_need_none(struct uaudio_softc *sc)
2722 return (sc->sc_play_chan.num_alt > 0 &&
2723 sc->sc_play_chan.running == 0 &&
2724 sc->sc_rec_chan.num_alt > 0 &&
2725 sc->sc_rec_chan.running == 0);
2729 uaudio_chan_start(struct uaudio_chan *ch)
2731 struct uaudio_softc *sc = ch->priv_sc;
2733 /* make operation atomic */
2734 usb_proc_explore_lock(sc->sc_udev);
2736 /* check if not running */
2737 if (ch->running == 0) {
2740 /* get current buffer size */
2741 temp = 2 * uaudio_get_buffer_size(ch, ch->set_alt);
2743 /* set running flag */
2746 /* ensure the hardware buffer is reset */
2747 ch->start = ch->buf;
2748 ch->end = ch->buf + temp;
2751 if (uaudio_chan_need_both(sc)) {
2753 * Start both endpoints because of need for
2754 * jitter information:
2756 uaudio_chan_start_sub(&sc->sc_rec_chan);
2757 uaudio_chan_start_sub(&sc->sc_play_chan);
2759 uaudio_chan_start_sub(ch);
2763 /* exit atomic operation */
2764 usb_proc_explore_unlock(sc->sc_udev);
2768 uaudio_chan_stop_sub(struct uaudio_chan *ch)
2770 struct uaudio_softc *sc = ch->priv_sc;
2773 if (ch->operation != CHAN_OP_DRAIN) {
2774 if (ch->cur_alt == ch->set_alt &&
2775 ch->operation == CHAN_OP_NONE &&
2776 mtx_owned(ch->pcm_mtx) != 0) {
2777 /* save doing the explore task */
2780 ch->operation = CHAN_OP_STOP;
2781 (void)usb_proc_explore_msignal(sc->sc_udev,
2782 &sc->sc_config_msg[0], &sc->sc_config_msg[1]);
2786 usbd_transfer_stop(ch->xfer[0]);
2787 usbd_transfer_stop(ch->xfer[1]);
2792 uaudio_chan_stop(struct uaudio_chan *ch)
2794 struct uaudio_softc *sc = ch->priv_sc;
2796 /* make operation atomic */
2797 usb_proc_explore_lock(sc->sc_udev);
2799 /* check if running */
2800 if (ch->running != 0) {
2801 /* clear running flag */
2804 if (uaudio_chan_need_both(sc)) {
2806 * Leave the endpoints running because we need
2807 * information about jitter!
2809 } else if (uaudio_chan_need_none(sc)) {
2811 * Stop both endpoints in case the one was used for
2812 * jitter information:
2814 uaudio_chan_stop_sub(&sc->sc_rec_chan);
2815 uaudio_chan_stop_sub(&sc->sc_play_chan);
2817 uaudio_chan_stop_sub(ch);
2821 /* exit atomic operation */
2822 usb_proc_explore_unlock(sc->sc_udev);
2825 /*========================================================================*
2826 * AC - Audio Controller - routines
2827 *========================================================================*/
2830 uaudio_mixer_sysctl_handler(SYSCTL_HANDLER_ARGS)
2832 struct uaudio_softc *sc;
2833 struct uaudio_mixer_node *pmc;
2839 sc = (struct uaudio_softc *)oidp->oid_arg1;
2840 hint = oidp->oid_arg2;
2842 if (sc->sc_mixer_lock == NULL)
2845 /* lookup mixer node */
2847 mtx_lock(sc->sc_mixer_lock);
2848 for (pmc = sc->sc_mixer_root; pmc != NULL; pmc = pmc->next) {
2849 for (chan = 0; chan != (int)pmc->nchan; chan++) {
2850 if (pmc->wValue[chan] != -1 &&
2851 pmc->wValue[chan] == hint) {
2852 temp = pmc->wData[chan];
2858 mtx_unlock(sc->sc_mixer_lock);
2860 error = sysctl_handle_int(oidp, &temp, 0, req);
2861 if (error != 0 || req->newptr == NULL)
2864 /* update mixer value */
2866 mtx_lock(sc->sc_mixer_lock);
2868 temp >= pmc->minval &&
2869 temp <= pmc->maxval) {
2871 pmc->wData[chan] = temp;
2872 pmc->update[(chan / 8)] |= (1 << (chan % 8));
2874 /* start the transfer, if not already started */
2875 usbd_transfer_start(sc->sc_mixer_xfer[0]);
2877 mtx_unlock(sc->sc_mixer_lock);
2883 uaudio_mixer_ctl_free(struct uaudio_softc *sc)
2885 struct uaudio_mixer_node *p_mc;
2887 while ((p_mc = sc->sc_mixer_root) != NULL) {
2888 sc->sc_mixer_root = p_mc->next;
2889 free(p_mc, M_USBDEV);
2894 uaudio_mixer_register_sysctl(struct uaudio_softc *sc, device_t dev)
2896 struct uaudio_mixer_node *pmc;
2897 struct sysctl_oid *mixer_tree;
2898 struct sysctl_oid *control_tree;
2903 mixer_tree = SYSCTL_ADD_NODE(device_get_sysctl_ctx(dev),
2904 SYSCTL_CHILDREN(device_get_sysctl_tree(dev)), OID_AUTO, "mixer",
2905 CTLFLAG_RD, NULL, "");
2907 if (mixer_tree == NULL)
2910 for (n = 0, pmc = sc->sc_mixer_root; pmc != NULL;
2911 pmc = pmc->next, n++) {
2913 for (chan = 0; chan < pmc->nchan; chan++) {
2915 if (pmc->nchan > 1) {
2916 snprintf(buf, sizeof(buf), "%s_%d_%d",
2917 pmc->name, n, chan);
2919 snprintf(buf, sizeof(buf), "%s_%d",
2923 control_tree = SYSCTL_ADD_NODE(device_get_sysctl_ctx(dev),
2924 SYSCTL_CHILDREN(mixer_tree), OID_AUTO, buf,
2925 CTLFLAG_RD, NULL, "Mixer control nodes");
2927 if (control_tree == NULL)
2930 SYSCTL_ADD_PROC(device_get_sysctl_ctx(dev),
2931 SYSCTL_CHILDREN(control_tree),
2932 OID_AUTO, "val", CTLTYPE_INT | CTLFLAG_RWTUN, sc,
2934 uaudio_mixer_sysctl_handler, "I", "Current value");
2936 SYSCTL_ADD_INT(device_get_sysctl_ctx(dev),
2937 SYSCTL_CHILDREN(control_tree),
2938 OID_AUTO, "min", CTLFLAG_RD, 0, pmc->minval,
2941 SYSCTL_ADD_INT(device_get_sysctl_ctx(dev),
2942 SYSCTL_CHILDREN(control_tree),
2943 OID_AUTO, "max", CTLFLAG_RD, 0, pmc->maxval,
2946 SYSCTL_ADD_STRING(device_get_sysctl_ctx(dev),
2947 SYSCTL_CHILDREN(control_tree),
2948 OID_AUTO, "desc", CTLFLAG_RD, pmc->desc, 0,
2954 /* M-Audio FastTrack Ultra Mixer Description */
2955 /* Origin: Linux USB Audio driver */
2957 uaudio_mixer_controls_create_ftu(struct uaudio_softc *sc)
2962 memset(&MIX(sc), 0, sizeof(MIX(sc)));
2963 MIX(sc).wIndex = MAKE_WORD(6, sc->sc_mixer_iface_no);
2964 MIX(sc).wValue[0] = MAKE_WORD(8, 0);
2965 MIX(sc).class = UAC_OUTPUT;
2966 MIX(sc).type = MIX_UNSIGNED_16;
2967 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
2968 MIX(sc).name = "effect";
2973 MIX(sc).update[0] = 1;
2974 strlcpy(MIX(sc).desc, "Room1,2,3,Hall1,2,Plate,Delay,Echo", sizeof(MIX(sc).desc));
2975 uaudio_mixer_add_ctl_sub(sc, &MIX(sc));
2977 memset(&MIX(sc), 0, sizeof(MIX(sc)));
2978 MIX(sc).wIndex = MAKE_WORD(5, sc->sc_mixer_iface_no);
2980 for (chx = 0; chx != 8; chx++) {
2981 for (chy = 0; chy != 8; chy++) {
2983 MIX(sc).wValue[0] = MAKE_WORD(chx + 1, chy + 1);
2984 MIX(sc).type = MIX_SIGNED_16;
2985 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
2986 MIX(sc).name = "mix_rec";
2988 MIX(sc).update[0] = 1;
2989 MIX(sc).val_default = 0;
2990 snprintf(MIX(sc).desc, sizeof(MIX(sc).desc),
2991 "AIn%d - Out%d Record Volume", chy + 1, chx + 1);
2993 uaudio_mixer_add_ctl(sc, &MIX(sc));
2995 MIX(sc).wValue[0] = MAKE_WORD(chx + 1, chy + 1 + 8);
2996 MIX(sc).type = MIX_SIGNED_16;
2997 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
2998 MIX(sc).name = "mix_play";
3000 MIX(sc).update[0] = 1;
3001 MIX(sc).val_default = (chx == chy) ? 2 : 0;
3002 snprintf(MIX(sc).desc, sizeof(MIX(sc).desc),
3003 "DIn%d - Out%d Playback Volume", chy + 1, chx + 1);
3005 uaudio_mixer_add_ctl(sc, &MIX(sc));
3009 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3010 MIX(sc).wIndex = MAKE_WORD(6, sc->sc_mixer_iface_no);
3011 MIX(sc).wValue[0] = MAKE_WORD(2, 0);
3012 MIX(sc).class = UAC_OUTPUT;
3013 MIX(sc).type = MIX_SIGNED_8;
3014 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3015 MIX(sc).name = "effect_vol";
3017 MIX(sc).update[0] = 1;
3019 MIX(sc).maxval = 0x7f;
3022 MIX(sc).update[0] = 1;
3023 strlcpy(MIX(sc).desc, "Effect Volume", sizeof(MIX(sc).desc));
3024 uaudio_mixer_add_ctl_sub(sc, &MIX(sc));
3026 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3027 MIX(sc).wIndex = MAKE_WORD(6, sc->sc_mixer_iface_no);
3028 MIX(sc).wValue[0] = MAKE_WORD(3, 0);
3029 MIX(sc).class = UAC_OUTPUT;
3030 MIX(sc).type = MIX_SIGNED_16;
3031 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3032 MIX(sc).name = "effect_dur";
3034 MIX(sc).update[0] = 1;
3036 MIX(sc).maxval = 0x7f00;
3037 MIX(sc).mul = 0x7f00;
3039 MIX(sc).update[0] = 1;
3040 strlcpy(MIX(sc).desc, "Effect Duration", sizeof(MIX(sc).desc));
3041 uaudio_mixer_add_ctl_sub(sc, &MIX(sc));
3043 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3044 MIX(sc).wIndex = MAKE_WORD(6, sc->sc_mixer_iface_no);
3045 MIX(sc).wValue[0] = MAKE_WORD(4, 0);
3046 MIX(sc).class = UAC_OUTPUT;
3047 MIX(sc).type = MIX_SIGNED_8;
3048 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3049 MIX(sc).name = "effect_fb";
3051 MIX(sc).update[0] = 1;
3053 MIX(sc).maxval = 0x7f;
3056 MIX(sc).update[0] = 1;
3057 strlcpy(MIX(sc).desc, "Effect Feedback Volume", sizeof(MIX(sc).desc));
3058 uaudio_mixer_add_ctl_sub(sc, &MIX(sc));
3060 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3061 MIX(sc).wIndex = MAKE_WORD(7, sc->sc_mixer_iface_no);
3062 for (chy = 0; chy != 4; chy++) {
3064 MIX(sc).wValue[0] = MAKE_WORD(7, chy + 1);
3065 MIX(sc).type = MIX_SIGNED_16;
3066 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3067 MIX(sc).name = "effect_ret";
3069 MIX(sc).update[0] = 1;
3070 snprintf(MIX(sc).desc, sizeof(MIX(sc).desc),
3071 "Effect Return %d Volume", chy + 1);
3073 uaudio_mixer_add_ctl(sc, &MIX(sc));
3076 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3077 MIX(sc).wIndex = MAKE_WORD(5, sc->sc_mixer_iface_no);
3079 for (chy = 0; chy != 8; chy++) {
3080 MIX(sc).wValue[0] = MAKE_WORD(9, chy + 1);
3081 MIX(sc).type = MIX_SIGNED_16;
3082 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3083 MIX(sc).name = "effect_send";
3085 MIX(sc).update[0] = 1;
3086 snprintf(MIX(sc).desc, sizeof(MIX(sc).desc),
3087 "Effect Send AIn%d Volume", chy + 1);
3089 uaudio_mixer_add_ctl(sc, &MIX(sc));
3091 MIX(sc).wValue[0] = MAKE_WORD(9, chy + 1 + 8);
3092 MIX(sc).type = MIX_SIGNED_16;
3093 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3094 MIX(sc).name = "effect_send";
3096 MIX(sc).update[0] = 1;
3097 snprintf(MIX(sc).desc, sizeof(MIX(sc).desc),
3098 "Effect Send DIn%d Volume", chy + 1);
3100 uaudio_mixer_add_ctl(sc, &MIX(sc));
3105 uaudio_mixer_reload_all(struct uaudio_softc *sc)
3107 struct uaudio_mixer_node *pmc;
3110 if (sc->sc_mixer_lock == NULL)
3113 mtx_lock(sc->sc_mixer_lock);
3114 for (pmc = sc->sc_mixer_root; pmc != NULL; pmc = pmc->next) {
3115 /* use reset defaults for non-oss controlled settings */
3116 if (pmc->ctl == SOUND_MIXER_NRDEVICES)
3118 for (chan = 0; chan < pmc->nchan; chan++)
3119 pmc->update[chan / 8] |= (1 << (chan % 8));
3121 usbd_transfer_start(sc->sc_mixer_xfer[0]);
3123 /* start HID volume keys, if any */
3124 usbd_transfer_start(sc->sc_hid.xfer[0]);
3125 mtx_unlock(sc->sc_mixer_lock);
3129 uaudio_mixer_add_ctl_sub(struct uaudio_softc *sc, struct uaudio_mixer_node *mc)
3131 struct uaudio_mixer_node *p_mc_new =
3132 malloc(sizeof(*p_mc_new), M_USBDEV, M_WAITOK);
3135 if (p_mc_new != NULL) {
3136 memcpy(p_mc_new, mc, sizeof(*p_mc_new));
3137 p_mc_new->next = sc->sc_mixer_root;
3138 sc->sc_mixer_root = p_mc_new;
3139 sc->sc_mixer_count++;
3141 /* set default value for all channels */
3142 for (ch = 0; ch < p_mc_new->nchan; ch++) {
3143 switch (p_mc_new->val_default) {
3146 p_mc_new->wData[ch] = (p_mc_new->maxval + p_mc_new->minval) / 2;
3150 p_mc_new->wData[ch] = p_mc_new->maxval;
3154 p_mc_new->wData[ch] = p_mc_new->minval;
3159 DPRINTF("out of memory\n");
3164 uaudio_mixer_add_ctl(struct uaudio_softc *sc, struct uaudio_mixer_node *mc)
3168 if (mc->class < UAC_NCLASSES) {
3169 DPRINTF("adding %s.%d\n",
3170 uac_names[mc->class], mc->ctl);
3172 DPRINTF("adding %d\n", mc->ctl);
3175 if (mc->type == MIX_ON_OFF) {
3178 } else if (mc->type == MIX_SELECTOR) {
3181 /* determine min and max values */
3183 mc->minval = uaudio_mixer_get(sc->sc_udev,
3184 sc->sc_audio_rev, GET_MIN, mc);
3185 mc->maxval = uaudio_mixer_get(sc->sc_udev,
3186 sc->sc_audio_rev, GET_MAX, mc);
3188 /* check if max and min was swapped */
3190 if (mc->maxval < mc->minval) {
3192 mc->maxval = mc->minval;
3196 /* compute value range */
3197 mc->mul = mc->maxval - mc->minval;
3201 /* compute value alignment */
3202 res = uaudio_mixer_get(sc->sc_udev,
3203 sc->sc_audio_rev, GET_RES, mc);
3205 DPRINTF("Resolution = %d\n", (int)res);
3208 uaudio_mixer_add_ctl_sub(sc, mc);
3211 if (uaudio_debug > 2) {
3214 for (i = 0; i < mc->nchan; i++) {
3215 DPRINTF("[mix] wValue=%04x\n", mc->wValue[0]);
3217 DPRINTF("[mix] wIndex=%04x type=%d ctl='%d' "
3219 mc->wIndex, mc->type, mc->ctl,
3220 mc->minval, mc->maxval);
3226 uaudio_mixer_add_mixer(struct uaudio_softc *sc,
3227 const struct uaudio_terminal_node *iot, int id)
3229 const struct usb_audio_mixer_unit_0 *d0 = iot[id].u.mu_v1;
3230 const struct usb_audio_mixer_unit_1 *d1;
3232 uint32_t bno; /* bit number */
3233 uint32_t p; /* bit number accumulator */
3234 uint32_t mo; /* matching outputs */
3235 uint32_t mc; /* matching channels */
3236 uint32_t ichs; /* input channels */
3237 uint32_t ochs; /* output channels */
3239 uint32_t chs; /* channels */
3243 DPRINTFN(3, "bUnitId=%d bNrInPins=%d\n",
3244 d0->bUnitId, d0->bNrInPins);
3246 /* compute the number of input channels */
3249 for (i = 0; i < d0->bNrInPins; i++) {
3250 ichs += uaudio_mixer_get_cluster(
3251 d0->baSourceId[i], iot).bNrChannels;
3254 d1 = (const void *)(d0->baSourceId + d0->bNrInPins);
3256 /* and the number of output channels */
3258 ochs = d1->bNrChannels;
3260 DPRINTFN(3, "ichs=%d ochs=%d\n", ichs, ochs);
3262 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3264 MIX(sc).wIndex = MAKE_WORD(d0->bUnitId, sc->sc_mixer_iface_no);
3265 uaudio_mixer_determine_class(&iot[id], &MIX(sc));
3266 MIX(sc).type = MIX_SIGNED_16;
3268 if (uaudio_mixer_verify_desc(d0, ((ichs * ochs) + 7) / 8) == NULL)
3271 for (p = i = 0; i < d0->bNrInPins; i++) {
3272 chs = uaudio_mixer_get_cluster(
3273 d0->baSourceId[i], iot).bNrChannels;
3275 for (c = 0; c < chs; c++) {
3277 for (o = 0; o < ochs; o++) {
3278 bno = ((p + c) * ochs) + o;
3279 if (BIT_TEST(d1->bmControls, bno))
3285 if ((mc == chs) && (chs <= MIX_MAX_CHAN)) {
3287 /* repeat bit-scan */
3290 for (c = 0; c < chs; c++) {
3291 for (o = 0; o < ochs; o++) {
3292 bno = ((p + c) * ochs) + o;
3293 if (BIT_TEST(d1->bmControls, bno))
3294 MIX(sc).wValue[mc++] = MAKE_WORD(p + c + 1, o + 1);
3297 MIX(sc).nchan = chs;
3298 uaudio_mixer_add_ctl(sc, &MIX(sc));
3305 uaudio20_mixer_add_mixer(struct uaudio_softc *sc,
3306 const struct uaudio_terminal_node *iot, int id)
3308 const struct usb_audio20_mixer_unit_0 *d0 = iot[id].u.mu_v2;
3309 const struct usb_audio20_mixer_unit_1 *d1;
3311 uint32_t bno; /* bit number */
3312 uint32_t p; /* bit number accumulator */
3313 uint32_t mo; /* matching outputs */
3314 uint32_t mc; /* matching channels */
3315 uint32_t ichs; /* input channels */
3316 uint32_t ochs; /* output channels */
3318 uint32_t chs; /* channels */
3322 DPRINTFN(3, "bUnitId=%d bNrInPins=%d\n",
3323 d0->bUnitId, d0->bNrInPins);
3325 /* compute the number of input channels */
3328 for (i = 0; i < d0->bNrInPins; i++) {
3329 ichs += uaudio20_mixer_get_cluster(
3330 d0->baSourceId[i], iot).bNrChannels;
3333 d1 = (const void *)(d0->baSourceId + d0->bNrInPins);
3335 /* and the number of output channels */
3337 ochs = d1->bNrChannels;
3339 DPRINTFN(3, "ichs=%d ochs=%d\n", ichs, ochs);
3341 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3343 MIX(sc).wIndex = MAKE_WORD(d0->bUnitId, sc->sc_mixer_iface_no);
3344 uaudio20_mixer_determine_class(&iot[id], &MIX(sc));
3345 MIX(sc).type = MIX_SIGNED_16;
3347 if (uaudio20_mixer_verify_desc(d0, ((ichs * ochs) + 7) / 8) == NULL)
3350 for (p = i = 0; i < d0->bNrInPins; i++) {
3351 chs = uaudio20_mixer_get_cluster(
3352 d0->baSourceId[i], iot).bNrChannels;
3354 for (c = 0; c < chs; c++) {
3356 for (o = 0; o < ochs; o++) {
3357 bno = ((p + c) * ochs) + o;
3358 if (BIT_TEST(d1->bmControls, bno))
3364 if ((mc == chs) && (chs <= MIX_MAX_CHAN)) {
3366 /* repeat bit-scan */
3369 for (c = 0; c < chs; c++) {
3370 for (o = 0; o < ochs; o++) {
3371 bno = ((p + c) * ochs) + o;
3372 if (BIT_TEST(d1->bmControls, bno))
3373 MIX(sc).wValue[mc++] = MAKE_WORD(p + c + 1, o + 1);
3376 MIX(sc).nchan = chs;
3377 uaudio_mixer_add_ctl(sc, &MIX(sc));
3384 uaudio_mixer_add_selector(struct uaudio_softc *sc,
3385 const struct uaudio_terminal_node *iot, int id)
3387 const struct usb_audio_selector_unit *d = iot[id].u.su_v1;
3390 DPRINTFN(3, "bUnitId=%d bNrInPins=%d\n",
3391 d->bUnitId, d->bNrInPins);
3393 if (d->bNrInPins == 0)
3396 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3398 MIX(sc).wIndex = MAKE_WORD(d->bUnitId, sc->sc_mixer_iface_no);
3399 MIX(sc).wValue[0] = MAKE_WORD(0, 0);
3400 uaudio_mixer_determine_class(&iot[id], &MIX(sc));
3402 MIX(sc).type = MIX_SELECTOR;
3403 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3405 MIX(sc).maxval = d->bNrInPins;
3406 MIX(sc).name = "selector";
3408 i = d->baSourceId[d->bNrInPins];
3410 usbd_req_get_string_any(sc->sc_udev, NULL,
3411 MIX(sc).desc, sizeof(MIX(sc).desc), i) != 0) {
3412 MIX(sc).desc[0] = 0;
3415 if (MIX(sc).maxval > MAX_SELECTOR_INPUT_PIN) {
3416 MIX(sc).maxval = MAX_SELECTOR_INPUT_PIN;
3418 MIX(sc).mul = (MIX(sc).maxval - MIX(sc).minval);
3419 for (i = 0; i < MAX_SELECTOR_INPUT_PIN; i++) {
3420 MIX(sc).slctrtype[i] = SOUND_MIXER_NRDEVICES;
3423 for (i = 0; i < MIX(sc).maxval; i++) {
3424 MIX(sc).slctrtype[i] = uaudio_mixer_feature_name(
3425 &iot[d->baSourceId[i]], &MIX(sc));
3428 MIX(sc).class = 0; /* not used */
3430 uaudio_mixer_add_ctl(sc, &MIX(sc));
3434 uaudio20_mixer_add_selector(struct uaudio_softc *sc,
3435 const struct uaudio_terminal_node *iot, int id)
3437 const struct usb_audio20_selector_unit *d = iot[id].u.su_v2;
3440 DPRINTFN(3, "bUnitId=%d bNrInPins=%d\n",
3441 d->bUnitId, d->bNrInPins);
3443 if (d->bNrInPins == 0)
3446 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3448 MIX(sc).wIndex = MAKE_WORD(d->bUnitId, sc->sc_mixer_iface_no);
3449 MIX(sc).wValue[0] = MAKE_WORD(0, 0);
3450 uaudio20_mixer_determine_class(&iot[id], &MIX(sc));
3452 MIX(sc).type = MIX_SELECTOR;
3453 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3455 MIX(sc).maxval = d->bNrInPins;
3456 MIX(sc).name = "selector";
3458 i = d->baSourceId[d->bNrInPins];
3460 usbd_req_get_string_any(sc->sc_udev, NULL,
3461 MIX(sc).desc, sizeof(MIX(sc).desc), i) != 0) {
3462 MIX(sc).desc[0] = 0;
3465 if (MIX(sc).maxval > MAX_SELECTOR_INPUT_PIN)
3466 MIX(sc).maxval = MAX_SELECTOR_INPUT_PIN;
3468 MIX(sc).mul = (MIX(sc).maxval - MIX(sc).minval);
3469 for (i = 0; i < MAX_SELECTOR_INPUT_PIN; i++)
3470 MIX(sc).slctrtype[i] = SOUND_MIXER_NRDEVICES;
3472 for (i = 0; i < MIX(sc).maxval; i++) {
3473 MIX(sc).slctrtype[i] = uaudio20_mixer_feature_name(
3474 &iot[d->baSourceId[i]], &MIX(sc));
3477 MIX(sc).class = 0; /* not used */
3479 uaudio_mixer_add_ctl(sc, &MIX(sc));
3483 uaudio_mixer_feature_get_bmaControls(const struct usb_audio_feature_unit *d,
3487 uint32_t offset = (i * d->bControlSize);
3489 if (d->bControlSize > 0) {
3490 temp |= d->bmaControls[offset];
3491 if (d->bControlSize > 1) {
3492 temp |= d->bmaControls[offset + 1] << 8;
3493 if (d->bControlSize > 2) {
3494 temp |= d->bmaControls[offset + 2] << 16;
3495 if (d->bControlSize > 3) {
3496 temp |= d->bmaControls[offset + 3] << 24;
3505 uaudio_mixer_add_feature(struct uaudio_softc *sc,
3506 const struct uaudio_terminal_node *iot, int id)
3508 const struct usb_audio_feature_unit *d = iot[id].u.fu_v1;
3512 uint16_t mixernumber;
3518 if (d->bControlSize == 0)
3521 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3523 nchan = (d->bLength - 7) / d->bControlSize;
3524 mmask = uaudio_mixer_feature_get_bmaControls(d, 0);
3530 /* figure out what we can control */
3532 for (chan = 1; chan < nchan; chan++) {
3533 DPRINTFN(10, "chan=%d mask=%x\n",
3534 chan, uaudio_mixer_feature_get_bmaControls(d, chan));
3536 cmask |= uaudio_mixer_feature_get_bmaControls(d, chan);
3539 if (nchan > MIX_MAX_CHAN) {
3540 nchan = MIX_MAX_CHAN;
3542 MIX(sc).wIndex = MAKE_WORD(d->bUnitId, sc->sc_mixer_iface_no);
3544 i = d->bmaControls[d->bControlSize];
3546 usbd_req_get_string_any(sc->sc_udev, NULL,
3547 MIX(sc).desc, sizeof(MIX(sc).desc), i) != 0) {
3548 MIX(sc).desc[0] = 0;
3551 for (ctl = 1; ctl <= LOUDNESS_CONTROL; ctl++) {
3553 fumask = FU_MASK(ctl);
3555 DPRINTFN(5, "ctl=%d fumask=0x%04x\n",
3558 if (mmask & fumask) {
3560 MIX(sc).wValue[0] = MAKE_WORD(ctl, 0);
3561 } else if (cmask & fumask) {
3562 MIX(sc).nchan = nchan - 1;
3563 for (i = 1; i < nchan; i++) {
3564 if (uaudio_mixer_feature_get_bmaControls(d, i) & fumask)
3565 MIX(sc).wValue[i - 1] = MAKE_WORD(ctl, i);
3567 MIX(sc).wValue[i - 1] = -1;
3573 mixernumber = uaudio_mixer_feature_name(&iot[id], &MIX(sc));
3577 MIX(sc).type = MIX_ON_OFF;
3578 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3579 MIX(sc).name = "mute";
3582 case VOLUME_CONTROL:
3583 MIX(sc).type = MIX_SIGNED_16;
3584 MIX(sc).ctl = mixernumber;
3585 MIX(sc).name = "vol";
3589 MIX(sc).type = MIX_SIGNED_8;
3590 MIX(sc).ctl = SOUND_MIXER_BASS;
3591 MIX(sc).name = "bass";
3595 MIX(sc).type = MIX_SIGNED_8;
3596 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3597 MIX(sc).name = "mid";
3600 case TREBLE_CONTROL:
3601 MIX(sc).type = MIX_SIGNED_8;
3602 MIX(sc).ctl = SOUND_MIXER_TREBLE;
3603 MIX(sc).name = "treble";
3606 case GRAPHIC_EQUALIZER_CONTROL:
3607 continue; /* XXX don't add anything */
3610 MIX(sc).type = MIX_ON_OFF;
3611 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3612 MIX(sc).name = "agc";
3616 MIX(sc).type = MIX_UNSIGNED_16;
3617 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3618 MIX(sc).name = "delay";
3621 case BASS_BOOST_CONTROL:
3622 MIX(sc).type = MIX_ON_OFF;
3623 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3624 MIX(sc).name = "boost";
3627 case LOUDNESS_CONTROL:
3628 MIX(sc).type = MIX_ON_OFF;
3629 MIX(sc).ctl = SOUND_MIXER_LOUD; /* Is this correct ? */
3630 MIX(sc).name = "loudness";
3634 MIX(sc).type = MIX_UNKNOWN;
3638 if (MIX(sc).type != MIX_UNKNOWN)
3639 uaudio_mixer_add_ctl(sc, &MIX(sc));
3644 uaudio20_mixer_add_feature(struct uaudio_softc *sc,
3645 const struct uaudio_terminal_node *iot, int id)
3647 const struct usb_audio20_feature_unit *d = iot[id].u.fu_v2;
3651 uint16_t mixernumber;
3657 if (UGETDW(d->bmaControls[0]) == 0)
3660 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3662 nchan = (d->bLength - 6) / 4;
3663 mmask = UGETDW(d->bmaControls[0]);
3669 /* figure out what we can control */
3671 for (chan = 1; chan < nchan; chan++)
3672 cmask |= UGETDW(d->bmaControls[chan]);
3674 if (nchan > MIX_MAX_CHAN)
3675 nchan = MIX_MAX_CHAN;
3677 MIX(sc).wIndex = MAKE_WORD(d->bUnitId, sc->sc_mixer_iface_no);
3679 i = d->bmaControls[nchan][0];
3681 usbd_req_get_string_any(sc->sc_udev, NULL,
3682 MIX(sc).desc, sizeof(MIX(sc).desc), i) != 0) {
3683 MIX(sc).desc[0] = 0;
3686 for (ctl = 3; ctl != 0; ctl <<= 2) {
3688 mixernumber = uaudio20_mixer_feature_name(&iot[id], &MIX(sc));
3692 MIX(sc).type = MIX_ON_OFF;
3693 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3694 MIX(sc).name = "mute";
3695 what = MUTE_CONTROL;
3698 MIX(sc).type = MIX_SIGNED_16;
3699 MIX(sc).ctl = mixernumber;
3700 MIX(sc).name = "vol";
3701 what = VOLUME_CONTROL;
3704 MIX(sc).type = MIX_SIGNED_8;
3705 MIX(sc).ctl = SOUND_MIXER_BASS;
3706 MIX(sc).name = "bass";
3707 what = BASS_CONTROL;
3710 MIX(sc).type = MIX_SIGNED_8;
3711 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3712 MIX(sc).name = "mid";
3716 MIX(sc).type = MIX_SIGNED_8;
3717 MIX(sc).ctl = SOUND_MIXER_TREBLE;
3718 MIX(sc).name = "treble";
3719 what = TREBLE_CONTROL;
3722 MIX(sc).type = MIX_ON_OFF;
3723 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3724 MIX(sc).name = "agc";
3728 MIX(sc).type = MIX_UNSIGNED_16;
3729 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3730 MIX(sc).name = "delay";
3731 what = DELAY_CONTROL;
3734 MIX(sc).type = MIX_ON_OFF;
3735 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3736 MIX(sc).name = "boost";
3737 what = BASS_BOOST_CONTROL;
3740 MIX(sc).type = MIX_ON_OFF;
3741 MIX(sc).ctl = SOUND_MIXER_LOUD; /* Is this correct ? */
3742 MIX(sc).name = "loudness";
3743 what = LOUDNESS_CONTROL;
3746 MIX(sc).type = MIX_SIGNED_16;
3747 MIX(sc).ctl = mixernumber;
3748 MIX(sc).name = "igain";
3749 what = INPUT_GAIN_CONTROL;
3752 MIX(sc).type = MIX_SIGNED_16;
3753 MIX(sc).ctl = mixernumber;
3754 MIX(sc).name = "igainpad";
3755 what = INPUT_GAIN_PAD_CONTROL;
3761 if ((mmask & ctl) == ctl) {
3763 MIX(sc).wValue[0] = MAKE_WORD(what, 0);
3764 } else if ((cmask & ctl) == ctl) {
3765 MIX(sc).nchan = nchan - 1;
3766 for (i = 1; i < nchan; i++) {
3767 if ((UGETDW(d->bmaControls[i]) & ctl) == ctl)
3768 MIX(sc).wValue[i - 1] = MAKE_WORD(what, i);
3770 MIX(sc).wValue[i - 1] = -1;
3776 if (MIX(sc).type != MIX_UNKNOWN)
3777 uaudio_mixer_add_ctl(sc, &MIX(sc));
3782 uaudio_mixer_add_processing_updown(struct uaudio_softc *sc,
3783 const struct uaudio_terminal_node *iot, int id)
3785 const struct usb_audio_processing_unit_0 *d0 = iot[id].u.pu_v1;
3786 const struct usb_audio_processing_unit_1 *d1 =
3787 (const void *)(d0->baSourceId + d0->bNrInPins);
3788 const struct usb_audio_processing_unit_updown *ud =
3789 (const void *)(d1->bmControls + d1->bControlSize);
3792 if (uaudio_mixer_verify_desc(d0, sizeof(*ud)) == NULL) {
3795 if (uaudio_mixer_verify_desc(d0, sizeof(*ud) + (2 * ud->bNrModes))
3799 DPRINTFN(3, "bUnitId=%d bNrModes=%d\n",
3800 d0->bUnitId, ud->bNrModes);
3802 if (!(d1->bmControls[0] & UA_PROC_MASK(UD_MODE_SELECT_CONTROL))) {
3803 DPRINTF("no mode select\n");
3806 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3808 MIX(sc).wIndex = MAKE_WORD(d0->bUnitId, sc->sc_mixer_iface_no);
3810 MIX(sc).wValue[0] = MAKE_WORD(UD_MODE_SELECT_CONTROL, 0);
3811 uaudio_mixer_determine_class(&iot[id], &MIX(sc));
3812 MIX(sc).type = MIX_ON_OFF; /* XXX */
3814 for (i = 0; i < ud->bNrModes; i++) {
3815 DPRINTFN(3, "i=%d bm=0x%x\n", i, UGETW(ud->waModes[i]));
3819 uaudio_mixer_add_ctl(sc, &MIX(sc));
3823 uaudio_mixer_add_processing(struct uaudio_softc *sc,
3824 const struct uaudio_terminal_node *iot, int id)
3826 const struct usb_audio_processing_unit_0 *d0 = iot[id].u.pu_v1;
3827 const struct usb_audio_processing_unit_1 *d1 =
3828 (const void *)(d0->baSourceId + d0->bNrInPins);
3831 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3833 ptype = UGETW(d0->wProcessType);
3835 DPRINTFN(3, "wProcessType=%d bUnitId=%d "
3836 "bNrInPins=%d\n", ptype, d0->bUnitId, d0->bNrInPins);
3838 if (d1->bControlSize == 0) {
3841 if (d1->bmControls[0] & UA_PROC_ENABLE_MASK) {
3842 MIX(sc).wIndex = MAKE_WORD(d0->bUnitId, sc->sc_mixer_iface_no);
3844 MIX(sc).wValue[0] = MAKE_WORD(XX_ENABLE_CONTROL, 0);
3845 uaudio_mixer_determine_class(&iot[id], &MIX(sc));
3846 MIX(sc).type = MIX_ON_OFF;
3847 uaudio_mixer_add_ctl(sc, &MIX(sc));
3850 case UPDOWNMIX_PROCESS:
3851 uaudio_mixer_add_processing_updown(sc, iot, id);
3854 case DOLBY_PROLOGIC_PROCESS:
3855 case P3D_STEREO_EXTENDER_PROCESS:
3856 case REVERBATION_PROCESS:
3857 case CHORUS_PROCESS:
3858 case DYN_RANGE_COMP_PROCESS:
3860 DPRINTF("unit %d, type=%d is not implemented\n",
3861 d0->bUnitId, ptype);
3867 uaudio_mixer_add_extension(struct uaudio_softc *sc,
3868 const struct uaudio_terminal_node *iot, int id)
3870 const struct usb_audio_extension_unit_0 *d0 = iot[id].u.eu_v1;
3871 const struct usb_audio_extension_unit_1 *d1 =
3872 (const void *)(d0->baSourceId + d0->bNrInPins);
3874 DPRINTFN(3, "bUnitId=%d bNrInPins=%d\n",
3875 d0->bUnitId, d0->bNrInPins);
3877 if (sc->sc_uq_au_no_xu) {
3880 if (d1->bControlSize == 0) {
3883 if (d1->bmControls[0] & UA_EXT_ENABLE_MASK) {
3885 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3887 MIX(sc).wIndex = MAKE_WORD(d0->bUnitId, sc->sc_mixer_iface_no);
3889 MIX(sc).wValue[0] = MAKE_WORD(UA_EXT_ENABLE, 0);
3890 uaudio_mixer_determine_class(&iot[id], &MIX(sc));
3891 MIX(sc).type = MIX_ON_OFF;
3893 uaudio_mixer_add_ctl(sc, &MIX(sc));
3898 uaudio_mixer_verify_desc(const void *arg, uint32_t len)
3900 const struct usb_audio_mixer_unit_1 *d1;
3901 const struct usb_audio_extension_unit_1 *e1;
3902 const struct usb_audio_processing_unit_1 *u1;
3905 const struct usb_descriptor *desc;
3906 const struct usb_audio_input_terminal *it;
3907 const struct usb_audio_output_terminal *ot;
3908 const struct usb_audio_mixer_unit_0 *mu;
3909 const struct usb_audio_selector_unit *su;
3910 const struct usb_audio_feature_unit *fu;
3911 const struct usb_audio_processing_unit_0 *pu;
3912 const struct usb_audio_extension_unit_0 *eu;
3917 if (u.desc == NULL) {
3920 if (u.desc->bDescriptorType != UDESC_CS_INTERFACE) {
3923 switch (u.desc->bDescriptorSubtype) {
3924 case UDESCSUB_AC_INPUT:
3925 len += sizeof(*u.it);
3928 case UDESCSUB_AC_OUTPUT:
3929 len += sizeof(*u.ot);
3932 case UDESCSUB_AC_MIXER:
3933 len += sizeof(*u.mu);
3935 if (u.desc->bLength < len) {
3938 len += u.mu->bNrInPins;
3940 if (u.desc->bLength < len) {
3943 d1 = (const void *)(u.mu->baSourceId + u.mu->bNrInPins);
3948 case UDESCSUB_AC_SELECTOR:
3949 len += sizeof(*u.su);
3951 if (u.desc->bLength < len) {
3954 len += u.su->bNrInPins + 1;
3957 case UDESCSUB_AC_FEATURE:
3958 len += sizeof(*u.fu) + 1;
3960 if (u.desc->bLength < len)
3963 len += u.fu->bControlSize;
3966 case UDESCSUB_AC_PROCESSING:
3967 len += sizeof(*u.pu);
3969 if (u.desc->bLength < len) {
3972 len += u.pu->bNrInPins;
3974 if (u.desc->bLength < len) {
3977 u1 = (const void *)(u.pu->baSourceId + u.pu->bNrInPins);
3981 if (u.desc->bLength < len) {
3984 len += u1->bControlSize;
3988 case UDESCSUB_AC_EXTENSION:
3989 len += sizeof(*u.eu);
3991 if (u.desc->bLength < len) {
3994 len += u.eu->bNrInPins;
3996 if (u.desc->bLength < len) {
3999 e1 = (const void *)(u.eu->baSourceId + u.eu->bNrInPins);
4003 if (u.desc->bLength < len) {
4006 len += e1->bControlSize;
4013 if (u.desc->bLength < len) {
4020 DPRINTF("invalid descriptor, type=%d, "
4021 "sub_type=%d, len=%d of %d bytes\n",
4022 u.desc->bDescriptorType,
4023 u.desc->bDescriptorSubtype,
4024 u.desc->bLength, len);
4030 uaudio20_mixer_verify_desc(const void *arg, uint32_t len)
4032 const struct usb_audio20_mixer_unit_1 *d1;
4033 const struct usb_audio20_extension_unit_1 *e1;
4034 const struct usb_audio20_processing_unit_1 *u1;
4035 const struct usb_audio20_clock_selector_unit_1 *c1;
4038 const struct usb_descriptor *desc;
4039 const struct usb_audio20_clock_source_unit *csrc;
4040 const struct usb_audio20_clock_selector_unit_0 *csel;
4041 const struct usb_audio20_clock_multiplier_unit *cmul;
4042 const struct usb_audio20_input_terminal *it;
4043 const struct usb_audio20_output_terminal *ot;
4044 const struct usb_audio20_mixer_unit_0 *mu;
4045 const struct usb_audio20_selector_unit *su;
4046 const struct usb_audio20_feature_unit *fu;
4047 const struct usb_audio20_sample_rate_unit *ru;
4048 const struct usb_audio20_processing_unit_0 *pu;
4049 const struct usb_audio20_extension_unit_0 *eu;
4050 const struct usb_audio20_effect_unit *ef;
4058 if (u.desc->bDescriptorType != UDESC_CS_INTERFACE)
4061 switch (u.desc->bDescriptorSubtype) {
4062 case UDESCSUB_AC_INPUT:
4063 len += sizeof(*u.it);
4066 case UDESCSUB_AC_OUTPUT:
4067 len += sizeof(*u.ot);
4070 case UDESCSUB_AC_MIXER:
4071 len += sizeof(*u.mu);
4073 if (u.desc->bLength < len)
4075 len += u.mu->bNrInPins;
4077 if (u.desc->bLength < len)
4080 d1 = (const void *)(u.mu->baSourceId + u.mu->bNrInPins);
4082 len += sizeof(*d1) + d1->bNrChannels;
4085 case UDESCSUB_AC_SELECTOR:
4086 len += sizeof(*u.su);
4088 if (u.desc->bLength < len)
4091 len += u.su->bNrInPins + 1;
4094 case UDESCSUB_AC_FEATURE:
4095 len += sizeof(*u.fu) + 1;
4098 case UDESCSUB_AC_EFFECT:
4099 len += sizeof(*u.ef) + 4;
4102 case UDESCSUB_AC_PROCESSING_V2:
4103 len += sizeof(*u.pu);
4105 if (u.desc->bLength < len)
4108 len += u.pu->bNrInPins;
4110 if (u.desc->bLength < len)
4113 u1 = (const void *)(u.pu->baSourceId + u.pu->bNrInPins);
4118 case UDESCSUB_AC_EXTENSION_V2:
4119 len += sizeof(*u.eu);
4121 if (u.desc->bLength < len)
4124 len += u.eu->bNrInPins;
4126 if (u.desc->bLength < len)
4129 e1 = (const void *)(u.eu->baSourceId + u.eu->bNrInPins);
4134 case UDESCSUB_AC_CLOCK_SRC:
4135 len += sizeof(*u.csrc);
4138 case UDESCSUB_AC_CLOCK_SEL:
4139 len += sizeof(*u.csel);
4141 if (u.desc->bLength < len)
4144 len += u.csel->bNrInPins;
4146 if (u.desc->bLength < len)
4149 c1 = (const void *)(u.csel->baCSourceId + u.csel->bNrInPins);
4154 case UDESCSUB_AC_CLOCK_MUL:
4155 len += sizeof(*u.cmul);
4158 case UDESCSUB_AC_SAMPLE_RT:
4159 len += sizeof(*u.ru);
4166 if (u.desc->bLength < len)
4173 DPRINTF("invalid descriptor, type=%d, "
4174 "sub_type=%d, len=%d of %d bytes\n",
4175 u.desc->bDescriptorType,
4176 u.desc->bDescriptorSubtype,
4177 u.desc->bLength, len);
4182 static struct usb_audio_cluster
4183 uaudio_mixer_get_cluster(uint8_t id, const struct uaudio_terminal_node *iot)
4185 struct usb_audio_cluster r;
4186 const struct usb_descriptor *dp;
4189 for (i = 0; i < UAUDIO_RECURSE_LIMIT; i++) { /* avoid infinite loops */
4190 dp = iot[id].u.desc;
4194 switch (dp->bDescriptorSubtype) {
4195 case UDESCSUB_AC_INPUT:
4196 r.bNrChannels = iot[id].u.it_v1->bNrChannels;
4197 r.wChannelConfig[0] = iot[id].u.it_v1->wChannelConfig[0];
4198 r.wChannelConfig[1] = iot[id].u.it_v1->wChannelConfig[1];
4199 r.iChannelNames = iot[id].u.it_v1->iChannelNames;
4202 case UDESCSUB_AC_OUTPUT:
4203 id = iot[id].u.ot_v1->bSourceId;
4206 case UDESCSUB_AC_MIXER:
4207 r = *(const struct usb_audio_cluster *)
4208 &iot[id].u.mu_v1->baSourceId[
4209 iot[id].u.mu_v1->bNrInPins];
4212 case UDESCSUB_AC_SELECTOR:
4213 if (iot[id].u.su_v1->bNrInPins > 0) {
4214 /* XXX This is not really right */
4215 id = iot[id].u.su_v1->baSourceId[0];
4219 case UDESCSUB_AC_FEATURE:
4220 id = iot[id].u.fu_v1->bSourceId;
4223 case UDESCSUB_AC_PROCESSING:
4224 r = *((const struct usb_audio_cluster *)
4225 &iot[id].u.pu_v1->baSourceId[
4226 iot[id].u.pu_v1->bNrInPins]);
4229 case UDESCSUB_AC_EXTENSION:
4230 r = *((const struct usb_audio_cluster *)
4231 &iot[id].u.eu_v1->baSourceId[
4232 iot[id].u.eu_v1->bNrInPins]);
4240 DPRINTF("bad data\n");
4241 memset(&r, 0, sizeof(r));
4246 static struct usb_audio20_cluster
4247 uaudio20_mixer_get_cluster(uint8_t id, const struct uaudio_terminal_node *iot)
4249 struct usb_audio20_cluster r;
4250 const struct usb_descriptor *dp;
4253 for (i = 0; i < UAUDIO_RECURSE_LIMIT; i++) { /* avoid infinite loops */
4254 dp = iot[id].u.desc;
4258 switch (dp->bDescriptorSubtype) {
4259 case UDESCSUB_AC_INPUT:
4260 r.bNrChannels = iot[id].u.it_v2->bNrChannels;
4261 r.bmChannelConfig[0] = iot[id].u.it_v2->bmChannelConfig[0];
4262 r.bmChannelConfig[1] = iot[id].u.it_v2->bmChannelConfig[1];
4263 r.bmChannelConfig[2] = iot[id].u.it_v2->bmChannelConfig[2];
4264 r.bmChannelConfig[3] = iot[id].u.it_v2->bmChannelConfig[3];
4265 r.iChannelNames = iot[id].u.it_v2->iTerminal;
4268 case UDESCSUB_AC_OUTPUT:
4269 id = iot[id].u.ot_v2->bSourceId;
4272 case UDESCSUB_AC_MIXER:
4273 r = *(const struct usb_audio20_cluster *)
4274 &iot[id].u.mu_v2->baSourceId[
4275 iot[id].u.mu_v2->bNrInPins];
4278 case UDESCSUB_AC_SELECTOR:
4279 if (iot[id].u.su_v2->bNrInPins > 0) {
4280 /* XXX This is not really right */
4281 id = iot[id].u.su_v2->baSourceId[0];
4285 case UDESCSUB_AC_SAMPLE_RT:
4286 id = iot[id].u.ru_v2->bSourceId;
4289 case UDESCSUB_AC_EFFECT:
4290 id = iot[id].u.ef_v2->bSourceId;
4293 case UDESCSUB_AC_FEATURE:
4294 id = iot[id].u.fu_v2->bSourceId;
4297 case UDESCSUB_AC_PROCESSING_V2:
4298 r = *((const struct usb_audio20_cluster *)
4299 &iot[id].u.pu_v2->baSourceId[
4300 iot[id].u.pu_v2->bNrInPins]);
4303 case UDESCSUB_AC_EXTENSION_V2:
4304 r = *((const struct usb_audio20_cluster *)
4305 &iot[id].u.eu_v2->baSourceId[
4306 iot[id].u.eu_v2->bNrInPins]);
4314 DPRINTF("Bad data!\n");
4315 memset(&r, 0, sizeof(r));
4321 uaudio_mixer_determine_class(const struct uaudio_terminal_node *iot,
4322 struct uaudio_mixer_node *mix)
4324 uint16_t terminal_type = 0x0000;
4325 const struct uaudio_terminal_node *input[2];
4326 const struct uaudio_terminal_node *output[2];
4328 input[0] = uaudio_mixer_get_input(iot, 0);
4329 input[1] = uaudio_mixer_get_input(iot, 1);
4331 output[0] = uaudio_mixer_get_output(iot, 0);
4332 output[1] = uaudio_mixer_get_output(iot, 1);
4335 * check if there is only
4336 * one output terminal:
4338 if (output[0] && (!output[1])) {
4340 UGETW(output[0]->u.ot_v1->wTerminalType);
4343 * If the only output terminal is USB,
4344 * the class is UAC_RECORD.
4346 if ((terminal_type & 0xff00) == (UAT_UNDEFINED & 0xff00)) {
4348 mix->class = UAC_RECORD;
4349 if (input[0] && (!input[1])) {
4351 UGETW(input[0]->u.it_v1->wTerminalType);
4358 * if the unit is connected to just
4359 * one input terminal, the
4360 * class is UAC_INPUT:
4362 if (input[0] && (!input[1])) {
4363 mix->class = UAC_INPUT;
4365 UGETW(input[0]->u.it_v1->wTerminalType);
4369 * Otherwise, the class is UAC_OUTPUT.
4371 mix->class = UAC_OUTPUT;
4373 return (terminal_type);
4377 uaudio20_mixer_determine_class(const struct uaudio_terminal_node *iot,
4378 struct uaudio_mixer_node *mix)
4380 uint16_t terminal_type = 0x0000;
4381 const struct uaudio_terminal_node *input[2];
4382 const struct uaudio_terminal_node *output[2];
4384 input[0] = uaudio_mixer_get_input(iot, 0);
4385 input[1] = uaudio_mixer_get_input(iot, 1);
4387 output[0] = uaudio_mixer_get_output(iot, 0);
4388 output[1] = uaudio_mixer_get_output(iot, 1);
4391 * check if there is only
4392 * one output terminal:
4394 if (output[0] && (!output[1]))
4395 terminal_type = UGETW(output[0]->u.ot_v2->wTerminalType);
4397 * If the only output terminal is USB,
4398 * the class is UAC_RECORD.
4400 if ((terminal_type & 0xff00) == (UAT_UNDEFINED & 0xff00)) {
4402 mix->class = UAC_RECORD;
4403 if (input[0] && (!input[1])) {
4405 UGETW(input[0]->u.it_v2->wTerminalType);
4412 * if the unit is connected to just
4413 * one input terminal, the
4414 * class is UAC_INPUT:
4416 if (input[0] && (!input[1])) {
4417 mix->class = UAC_INPUT;
4419 UGETW(input[0]->u.it_v2->wTerminalType);
4423 * Otherwise, the class is UAC_OUTPUT.
4425 mix->class = UAC_OUTPUT;
4427 return (terminal_type);
4430 struct uaudio_tt_to_feature {
4431 uint16_t terminal_type;
4435 static const struct uaudio_tt_to_feature uaudio_tt_to_feature[] = {
4437 {UAT_STREAM, SOUND_MIXER_PCM},
4439 {UATI_MICROPHONE, SOUND_MIXER_MIC},
4440 {UATI_DESKMICROPHONE, SOUND_MIXER_MIC},
4441 {UATI_PERSONALMICROPHONE, SOUND_MIXER_MIC},
4442 {UATI_OMNIMICROPHONE, SOUND_MIXER_MIC},
4443 {UATI_MICROPHONEARRAY, SOUND_MIXER_MIC},
4444 {UATI_PROCMICROPHONEARR, SOUND_MIXER_MIC},
4446 {UATO_SPEAKER, SOUND_MIXER_SPEAKER},
4447 {UATO_DESKTOPSPEAKER, SOUND_MIXER_SPEAKER},
4448 {UATO_ROOMSPEAKER, SOUND_MIXER_SPEAKER},
4449 {UATO_COMMSPEAKER, SOUND_MIXER_SPEAKER},
4451 {UATE_ANALOGCONN, SOUND_MIXER_LINE},
4452 {UATE_LINECONN, SOUND_MIXER_LINE},
4453 {UATE_LEGACYCONN, SOUND_MIXER_LINE},
4455 {UATE_DIGITALAUIFC, SOUND_MIXER_ALTPCM},
4456 {UATE_SPDIF, SOUND_MIXER_ALTPCM},
4457 {UATE_1394DA, SOUND_MIXER_ALTPCM},
4458 {UATE_1394DV, SOUND_MIXER_ALTPCM},
4460 {UATF_CDPLAYER, SOUND_MIXER_CD},
4462 {UATF_SYNTHESIZER, SOUND_MIXER_SYNTH},
4464 {UATF_VIDEODISCAUDIO, SOUND_MIXER_VIDEO},
4465 {UATF_DVDAUDIO, SOUND_MIXER_VIDEO},
4466 {UATF_TVTUNERAUDIO, SOUND_MIXER_VIDEO},
4468 /* telephony terminal types */
4469 {UATT_UNDEFINED, SOUND_MIXER_PHONEIN}, /* SOUND_MIXER_PHONEOUT */
4470 {UATT_PHONELINE, SOUND_MIXER_PHONEIN}, /* SOUND_MIXER_PHONEOUT */
4471 {UATT_TELEPHONE, SOUND_MIXER_PHONEIN}, /* SOUND_MIXER_PHONEOUT */
4472 {UATT_DOWNLINEPHONE, SOUND_MIXER_PHONEIN}, /* SOUND_MIXER_PHONEOUT */
4474 {UATF_RADIORECV, SOUND_MIXER_RADIO},
4475 {UATF_RADIOXMIT, SOUND_MIXER_RADIO},
4477 {UAT_UNDEFINED, SOUND_MIXER_VOLUME},
4478 {UAT_VENDOR, SOUND_MIXER_VOLUME},
4479 {UATI_UNDEFINED, SOUND_MIXER_VOLUME},
4481 /* output terminal types */
4482 {UATO_UNDEFINED, SOUND_MIXER_VOLUME},
4483 {UATO_DISPLAYAUDIO, SOUND_MIXER_VOLUME},
4484 {UATO_SUBWOOFER, SOUND_MIXER_VOLUME},
4485 {UATO_HEADPHONES, SOUND_MIXER_VOLUME},
4487 /* bidir terminal types */
4488 {UATB_UNDEFINED, SOUND_MIXER_VOLUME},
4489 {UATB_HANDSET, SOUND_MIXER_VOLUME},
4490 {UATB_HEADSET, SOUND_MIXER_VOLUME},
4491 {UATB_SPEAKERPHONE, SOUND_MIXER_VOLUME},
4492 {UATB_SPEAKERPHONEESUP, SOUND_MIXER_VOLUME},
4493 {UATB_SPEAKERPHONEECANC, SOUND_MIXER_VOLUME},
4495 /* external terminal types */
4496 {UATE_UNDEFINED, SOUND_MIXER_VOLUME},
4498 /* embedded function terminal types */
4499 {UATF_UNDEFINED, SOUND_MIXER_VOLUME},
4500 {UATF_CALIBNOISE, SOUND_MIXER_VOLUME},
4501 {UATF_EQUNOISE, SOUND_MIXER_VOLUME},
4502 {UATF_DAT, SOUND_MIXER_VOLUME},
4503 {UATF_DCC, SOUND_MIXER_VOLUME},
4504 {UATF_MINIDISK, SOUND_MIXER_VOLUME},
4505 {UATF_ANALOGTAPE, SOUND_MIXER_VOLUME},
4506 {UATF_PHONOGRAPH, SOUND_MIXER_VOLUME},
4507 {UATF_VCRAUDIO, SOUND_MIXER_VOLUME},
4508 {UATF_SATELLITE, SOUND_MIXER_VOLUME},
4509 {UATF_CABLETUNER, SOUND_MIXER_VOLUME},
4510 {UATF_DSS, SOUND_MIXER_VOLUME},
4511 {UATF_MULTITRACK, SOUND_MIXER_VOLUME},
4512 {0xffff, SOUND_MIXER_VOLUME},
4515 {0x0000, SOUND_MIXER_VOLUME},
4519 uaudio_mixer_feature_name(const struct uaudio_terminal_node *iot,
4520 struct uaudio_mixer_node *mix)
4522 const struct uaudio_tt_to_feature *uat = uaudio_tt_to_feature;
4523 uint16_t terminal_type = uaudio_mixer_determine_class(iot, mix);
4525 if ((mix->class == UAC_RECORD) && (terminal_type == 0)) {
4526 return (SOUND_MIXER_IMIX);
4528 while (uat->terminal_type) {
4529 if (uat->terminal_type == terminal_type) {
4535 DPRINTF("terminal_type=0x%04x -> %d\n",
4536 terminal_type, uat->feature);
4538 return (uat->feature);
4542 uaudio20_mixer_feature_name(const struct uaudio_terminal_node *iot,
4543 struct uaudio_mixer_node *mix)
4545 const struct uaudio_tt_to_feature *uat;
4546 uint16_t terminal_type = uaudio20_mixer_determine_class(iot, mix);
4548 if ((mix->class == UAC_RECORD) && (terminal_type == 0))
4549 return (SOUND_MIXER_IMIX);
4551 for (uat = uaudio_tt_to_feature; uat->terminal_type != 0; uat++) {
4552 if (uat->terminal_type == terminal_type)
4556 DPRINTF("terminal_type=0x%04x -> %d\n",
4557 terminal_type, uat->feature);
4559 return (uat->feature);
4562 static const struct uaudio_terminal_node *
4563 uaudio_mixer_get_input(const struct uaudio_terminal_node *iot, uint8_t i)
4565 struct uaudio_terminal_node *root = iot->root;
4568 n = iot->usr.id_max;
4570 if (iot->usr.bit_input[n / 8] & (1 << (n % 8))) {
4579 static const struct uaudio_terminal_node *
4580 uaudio_mixer_get_output(const struct uaudio_terminal_node *iot, uint8_t i)
4582 struct uaudio_terminal_node *root = iot->root;
4585 n = iot->usr.id_max;
4587 if (iot->usr.bit_output[n / 8] & (1 << (n % 8))) {
4597 uaudio_mixer_find_inputs_sub(struct uaudio_terminal_node *root,
4598 const uint8_t *p_id, uint8_t n_id,
4599 struct uaudio_search_result *info)
4601 struct uaudio_terminal_node *iot;
4607 for (n = 0; n < n_id; n++) {
4611 if (info->recurse_level == UAUDIO_RECURSE_LIMIT) {
4612 DPRINTF("avoided going into a circle at id=%d!\n", i);
4616 info->recurse_level++;
4620 if (iot->u.desc == NULL)
4623 is_last = ((n + 1) == n_id);
4625 switch (iot->u.desc->bDescriptorSubtype) {
4626 case UDESCSUB_AC_INPUT:
4627 info->bit_input[i / 8] |= (1 << (i % 8));
4630 case UDESCSUB_AC_FEATURE:
4632 p_id = &iot->u.fu_v1->bSourceId;
4636 uaudio_mixer_find_inputs_sub(
4637 root, &iot->u.fu_v1->bSourceId, 1, info);
4640 case UDESCSUB_AC_OUTPUT:
4642 p_id = &iot->u.ot_v1->bSourceId;
4646 uaudio_mixer_find_inputs_sub(
4647 root, &iot->u.ot_v1->bSourceId, 1, info);
4650 case UDESCSUB_AC_MIXER:
4652 p_id = iot->u.mu_v1->baSourceId;
4653 n_id = iot->u.mu_v1->bNrInPins;
4656 uaudio_mixer_find_inputs_sub(
4657 root, iot->u.mu_v1->baSourceId,
4658 iot->u.mu_v1->bNrInPins, info);
4661 case UDESCSUB_AC_SELECTOR:
4663 p_id = iot->u.su_v1->baSourceId;
4664 n_id = iot->u.su_v1->bNrInPins;
4667 uaudio_mixer_find_inputs_sub(
4668 root, iot->u.su_v1->baSourceId,
4669 iot->u.su_v1->bNrInPins, info);
4672 case UDESCSUB_AC_PROCESSING:
4674 p_id = iot->u.pu_v1->baSourceId;
4675 n_id = iot->u.pu_v1->bNrInPins;
4678 uaudio_mixer_find_inputs_sub(
4679 root, iot->u.pu_v1->baSourceId,
4680 iot->u.pu_v1->bNrInPins, info);
4683 case UDESCSUB_AC_EXTENSION:
4685 p_id = iot->u.eu_v1->baSourceId;
4686 n_id = iot->u.eu_v1->bNrInPins;
4689 uaudio_mixer_find_inputs_sub(
4690 root, iot->u.eu_v1->baSourceId,
4691 iot->u.eu_v1->bNrInPins, info);
4701 uaudio20_mixer_find_inputs_sub(struct uaudio_terminal_node *root,
4702 const uint8_t *p_id, uint8_t n_id,
4703 struct uaudio_search_result *info)
4705 struct uaudio_terminal_node *iot;
4711 for (n = 0; n < n_id; n++) {
4715 if (info->recurse_level == UAUDIO_RECURSE_LIMIT) {
4716 DPRINTF("avoided going into a circle at id=%d!\n", i);
4720 info->recurse_level++;
4724 if (iot->u.desc == NULL)
4727 is_last = ((n + 1) == n_id);
4729 switch (iot->u.desc->bDescriptorSubtype) {
4730 case UDESCSUB_AC_INPUT:
4731 info->bit_input[i / 8] |= (1 << (i % 8));
4734 case UDESCSUB_AC_OUTPUT:
4736 p_id = &iot->u.ot_v2->bSourceId;
4740 uaudio20_mixer_find_inputs_sub(
4741 root, &iot->u.ot_v2->bSourceId, 1, info);
4744 case UDESCSUB_AC_MIXER:
4746 p_id = iot->u.mu_v2->baSourceId;
4747 n_id = iot->u.mu_v2->bNrInPins;
4750 uaudio20_mixer_find_inputs_sub(
4751 root, iot->u.mu_v2->baSourceId,
4752 iot->u.mu_v2->bNrInPins, info);
4755 case UDESCSUB_AC_SELECTOR:
4757 p_id = iot->u.su_v2->baSourceId;
4758 n_id = iot->u.su_v2->bNrInPins;
4761 uaudio20_mixer_find_inputs_sub(
4762 root, iot->u.su_v2->baSourceId,
4763 iot->u.su_v2->bNrInPins, info);
4766 case UDESCSUB_AC_SAMPLE_RT:
4768 p_id = &iot->u.ru_v2->bSourceId;
4772 uaudio20_mixer_find_inputs_sub(
4773 root, &iot->u.ru_v2->bSourceId,
4777 case UDESCSUB_AC_EFFECT:
4779 p_id = &iot->u.ef_v2->bSourceId;
4783 uaudio20_mixer_find_inputs_sub(
4784 root, &iot->u.ef_v2->bSourceId,
4788 case UDESCSUB_AC_FEATURE:
4790 p_id = &iot->u.fu_v2->bSourceId;
4794 uaudio20_mixer_find_inputs_sub(
4795 root, &iot->u.fu_v2->bSourceId, 1, info);
4798 case UDESCSUB_AC_PROCESSING_V2:
4800 p_id = iot->u.pu_v2->baSourceId;
4801 n_id = iot->u.pu_v2->bNrInPins;
4804 uaudio20_mixer_find_inputs_sub(
4805 root, iot->u.pu_v2->baSourceId,
4806 iot->u.pu_v2->bNrInPins, info);
4809 case UDESCSUB_AC_EXTENSION_V2:
4811 p_id = iot->u.eu_v2->baSourceId;
4812 n_id = iot->u.eu_v2->bNrInPins;
4815 uaudio20_mixer_find_inputs_sub(
4816 root, iot->u.eu_v2->baSourceId,
4817 iot->u.eu_v2->bNrInPins, info);
4826 uaudio20_mixer_find_clocks_sub(struct uaudio_terminal_node *root,
4827 const uint8_t *p_id, uint8_t n_id,
4828 struct uaudio_search_result *info)
4830 struct uaudio_terminal_node *iot;
4837 for (n = 0; n < n_id; n++) {
4841 if (info->recurse_level == UAUDIO_RECURSE_LIMIT) {
4842 DPRINTF("avoided going into a circle at id=%d!\n", i);
4846 info->recurse_level++;
4850 if (iot->u.desc == NULL)
4853 is_last = ((n + 1) == n_id);
4855 switch (iot->u.desc->bDescriptorSubtype) {
4856 case UDESCSUB_AC_INPUT:
4859 p_id = &iot->u.it_v2->bCSourceId;
4863 uaudio20_mixer_find_clocks_sub(root,
4864 &iot->u.it_v2->bCSourceId, 1, info);
4867 case UDESCSUB_AC_OUTPUT:
4870 p_id = &iot->u.ot_v2->bCSourceId;
4874 uaudio20_mixer_find_clocks_sub(root,
4875 &iot->u.ot_v2->bCSourceId, 1, info);
4878 case UDESCSUB_AC_CLOCK_SEL:
4880 p_id = iot->u.csel_v2->baCSourceId;
4881 n_id = iot->u.csel_v2->bNrInPins;
4884 uaudio20_mixer_find_clocks_sub(root,
4885 iot->u.csel_v2->baCSourceId,
4886 iot->u.csel_v2->bNrInPins, info);
4889 case UDESCSUB_AC_CLOCK_MUL:
4891 p_id = &iot->u.cmul_v2->bCSourceId;
4895 uaudio20_mixer_find_clocks_sub(root,
4896 &iot->u.cmul_v2->bCSourceId,
4900 case UDESCSUB_AC_CLOCK_SRC:
4902 id = iot->u.csrc_v2->bClockId;
4904 switch (info->is_input) {
4906 info->bit_output[id / 8] |= (1 << (id % 8));
4909 info->bit_input[id / 8] |= (1 << (id % 8));
4923 uaudio_mixer_find_outputs_sub(struct uaudio_terminal_node *root, uint8_t id,
4924 uint8_t n_id, struct uaudio_search_result *info)
4926 struct uaudio_terminal_node *iot = (root + id);
4931 if ((j != id) && ((root + j)->u.desc) &&
4932 ((root + j)->u.desc->bDescriptorSubtype == UDESCSUB_AC_OUTPUT)) {
4935 * "j" (output) <--- virtual wire <--- "id" (input)
4937 * if "j" has "id" on the input, then "id" have "j" on
4938 * the output, because they are connected:
4940 if ((root + j)->usr.bit_input[id / 8] & (1 << (id % 8))) {
4941 iot->usr.bit_output[j / 8] |= (1 << (j % 8));
4948 uaudio_mixer_fill_info(struct uaudio_softc *sc,
4949 struct usb_device *udev, void *desc)
4951 const struct usb_audio_control_descriptor *acdp;
4952 struct usb_config_descriptor *cd = usbd_get_config_descriptor(udev);
4953 const struct usb_descriptor *dp;
4954 const struct usb_audio_unit *au;
4955 struct uaudio_terminal_node *iot = NULL;
4957 uint8_t ID_max = 0; /* inclusive */
4960 desc = usb_desc_foreach(cd, desc);
4963 DPRINTF("no Audio Control header\n");
4968 if ((acdp->bLength < sizeof(*acdp)) ||
4969 (acdp->bDescriptorType != UDESC_CS_INTERFACE) ||
4970 (acdp->bDescriptorSubtype != UDESCSUB_AC_HEADER)) {
4971 DPRINTF("invalid Audio Control header\n");
4974 /* "wTotalLen" is allowed to be corrupt */
4975 wTotalLen = UGETW(acdp->wTotalLength) - acdp->bLength;
4977 /* get USB audio revision */
4978 sc->sc_audio_rev = UGETW(acdp->bcdADC);
4980 DPRINTFN(3, "found AC header, vers=%03x, len=%d\n",
4981 sc->sc_audio_rev, wTotalLen);
4983 iot = malloc(sizeof(struct uaudio_terminal_node) * 256, M_TEMP,
4987 DPRINTF("no memory!\n");
4990 while ((desc = usb_desc_foreach(cd, desc))) {
4994 if (dp->bLength > wTotalLen) {
4997 wTotalLen -= dp->bLength;
5000 if (sc->sc_audio_rev >= UAUDIO_VERSION_30)
5002 else if (sc->sc_audio_rev >= UAUDIO_VERSION_20)
5003 au = uaudio20_mixer_verify_desc(dp, 0);
5005 au = uaudio_mixer_verify_desc(dp, 0);
5008 iot[au->bUnitId].u.desc = (const void *)au;
5009 if (au->bUnitId > ID_max)
5010 ID_max = au->bUnitId;
5014 DPRINTF("Maximum ID=%d\n", ID_max);
5017 * determine sourcing inputs for
5018 * all nodes in the tree:
5022 if (sc->sc_audio_rev >= UAUDIO_VERSION_30) {
5024 } else if (sc->sc_audio_rev >= UAUDIO_VERSION_20) {
5025 uaudio20_mixer_find_inputs_sub(iot,
5026 &i, 1, &((iot + i)->usr));
5028 sc->sc_mixer_clocks.is_input = 255;
5029 sc->sc_mixer_clocks.recurse_level = 0;
5031 uaudio20_mixer_find_clocks_sub(iot,
5032 &i, 1, &sc->sc_mixer_clocks);
5034 uaudio_mixer_find_inputs_sub(iot,
5035 &i, 1, &((iot + i)->usr));
5040 * determine outputs for
5041 * all nodes in the tree:
5045 uaudio_mixer_find_outputs_sub(iot,
5046 i, ID_max, &((iot + i)->usr));
5049 /* set "id_max" and "root" */
5053 (iot + i)->usr.id_max = ID_max;
5054 (iot + i)->root = iot;
5058 * Scan the config to create a linked list of "mixer" nodes:
5068 DPRINTFN(11, "id=%d subtype=%d\n",
5069 i, dp->bDescriptorSubtype);
5071 if (sc->sc_audio_rev >= UAUDIO_VERSION_30) {
5073 } else if (sc->sc_audio_rev >= UAUDIO_VERSION_20) {
5075 switch (dp->bDescriptorSubtype) {
5076 case UDESCSUB_AC_HEADER:
5077 DPRINTF("unexpected AC header\n");
5080 case UDESCSUB_AC_INPUT:
5081 case UDESCSUB_AC_OUTPUT:
5082 case UDESCSUB_AC_PROCESSING_V2:
5083 case UDESCSUB_AC_EXTENSION_V2:
5084 case UDESCSUB_AC_EFFECT:
5085 case UDESCSUB_AC_CLOCK_SRC:
5086 case UDESCSUB_AC_CLOCK_SEL:
5087 case UDESCSUB_AC_CLOCK_MUL:
5088 case UDESCSUB_AC_SAMPLE_RT:
5091 case UDESCSUB_AC_MIXER:
5092 uaudio20_mixer_add_mixer(sc, iot, i);
5095 case UDESCSUB_AC_SELECTOR:
5096 uaudio20_mixer_add_selector(sc, iot, i);
5099 case UDESCSUB_AC_FEATURE:
5100 uaudio20_mixer_add_feature(sc, iot, i);
5104 DPRINTF("bad AC desc subtype=0x%02x\n",
5105 dp->bDescriptorSubtype);
5111 switch (dp->bDescriptorSubtype) {
5112 case UDESCSUB_AC_HEADER:
5113 DPRINTF("unexpected AC header\n");
5116 case UDESCSUB_AC_INPUT:
5117 case UDESCSUB_AC_OUTPUT:
5120 case UDESCSUB_AC_MIXER:
5121 uaudio_mixer_add_mixer(sc, iot, i);
5124 case UDESCSUB_AC_SELECTOR:
5125 uaudio_mixer_add_selector(sc, iot, i);
5128 case UDESCSUB_AC_FEATURE:
5129 uaudio_mixer_add_feature(sc, iot, i);
5132 case UDESCSUB_AC_PROCESSING:
5133 uaudio_mixer_add_processing(sc, iot, i);
5136 case UDESCSUB_AC_EXTENSION:
5137 uaudio_mixer_add_extension(sc, iot, i);
5141 DPRINTF("bad AC desc subtype=0x%02x\n",
5142 dp->bDescriptorSubtype);
5153 uaudio_mixer_get(struct usb_device *udev, uint16_t audio_rev,
5154 uint8_t what, struct uaudio_mixer_node *mc)
5156 struct usb_device_request req;
5158 uint8_t data[2 + (2 * 3)];
5161 if (mc->wValue[0] == -1)
5164 if (audio_rev >= UAUDIO_VERSION_30)
5166 else if (audio_rev >= UAUDIO_VERSION_20) {
5167 if (what == GET_CUR) {
5168 req.bRequest = UA20_CS_CUR;
5169 USETW(req.wLength, 2);
5171 req.bRequest = UA20_CS_RANGE;
5172 USETW(req.wLength, 8);
5175 uint16_t len = MIX_SIZE(mc->type);
5177 req.bRequest = what;
5178 USETW(req.wLength, len);
5181 req.bmRequestType = UT_READ_CLASS_INTERFACE;
5182 USETW(req.wValue, mc->wValue[0]);
5183 USETW(req.wIndex, mc->wIndex);
5185 memset(data, 0, sizeof(data));
5187 err = usbd_do_request(udev, NULL, &req, data);
5189 DPRINTF("err=%s\n", usbd_errstr(err));
5193 if (audio_rev >= UAUDIO_VERSION_30) {
5195 } else if (audio_rev >= UAUDIO_VERSION_20) {
5198 val = (data[0] | (data[1] << 8));
5201 val = (data[2] | (data[3] << 8));
5204 val = (data[4] | (data[5] << 8));
5207 val = (data[6] | (data[7] << 8));
5214 val = (data[0] | (data[1] << 8));
5217 if (what == GET_CUR || what == GET_MIN || what == GET_MAX)
5218 val = uaudio_mixer_signext(mc->type, val);
5220 DPRINTFN(3, "val=%d\n", val);
5226 uaudio_mixer_write_cfg_callback(struct usb_xfer *xfer, usb_error_t error)
5228 struct usb_device_request req;
5229 struct uaudio_softc *sc = usbd_xfer_softc(xfer);
5230 struct uaudio_mixer_node *mc = sc->sc_mixer_curr;
5231 struct usb_page_cache *pc;
5240 switch (USB_GET_STATE(xfer)) {
5241 case USB_ST_TRANSFERRED:
5247 mc = sc->sc_mixer_root;
5248 sc->sc_mixer_curr = mc;
5249 sc->sc_mixer_chan = 0;
5253 while (sc->sc_mixer_chan < mc->nchan) {
5255 chan = sc->sc_mixer_chan;
5257 sc->sc_mixer_chan++;
5259 update = ((mc->update[chan / 8] & (1 << (chan % 8))) &&
5260 (mc->wValue[chan] != -1));
5262 mc->update[chan / 8] &= ~(1 << (chan % 8));
5266 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
5267 USETW(req.wValue, mc->wValue[chan]);
5268 USETW(req.wIndex, mc->wIndex);
5270 if (sc->sc_audio_rev >= UAUDIO_VERSION_30) {
5272 } else if (sc->sc_audio_rev >= UAUDIO_VERSION_20) {
5274 req.bRequest = UA20_CS_CUR;
5275 USETW(req.wLength, len);
5277 len = MIX_SIZE(mc->type);
5278 req.bRequest = SET_CUR;
5279 USETW(req.wLength, len);
5282 buf[0] = (mc->wData[chan] & 0xFF);
5283 buf[1] = (mc->wData[chan] >> 8) & 0xFF;
5285 pc = usbd_xfer_get_frame(xfer, 0);
5286 usbd_copy_in(pc, 0, &req, sizeof(req));
5287 pc = usbd_xfer_get_frame(xfer, 1);
5288 usbd_copy_in(pc, 0, buf, len);
5290 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
5291 usbd_xfer_set_frame_len(xfer, 1, len);
5292 usbd_xfer_set_frames(xfer, len ? 2 : 1);
5293 usbd_transfer_submit(xfer);
5299 sc->sc_mixer_curr = mc;
5300 sc->sc_mixer_chan = 0;
5308 default: /* Error */
5309 DPRINTF("error=%s\n", usbd_errstr(error));
5310 if (error == USB_ERR_CANCELLED) {
5311 /* do nothing - we are detaching */
5314 goto tr_transferred;
5319 uaudio_set_speed(struct usb_device *udev, uint8_t endpt, uint32_t speed)
5321 struct usb_device_request req;
5324 DPRINTFN(6, "endpt=%d speed=%u\n", endpt, speed);
5326 req.bmRequestType = UT_WRITE_CLASS_ENDPOINT;
5327 req.bRequest = SET_CUR;
5328 USETW2(req.wValue, SAMPLING_FREQ_CONTROL, 0);
5329 USETW(req.wIndex, endpt);
5330 USETW(req.wLength, 3);
5332 data[1] = speed >> 8;
5333 data[2] = speed >> 16;
5335 return (usbd_do_request(udev, NULL, &req, data));
5339 uaudio20_set_speed(struct usb_device *udev, uint8_t iface_no,
5340 uint8_t clockid, uint32_t speed)
5342 struct usb_device_request req;
5345 DPRINTFN(6, "ifaceno=%d clockid=%d speed=%u\n",
5346 iface_no, clockid, speed);
5348 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
5349 req.bRequest = UA20_CS_CUR;
5350 USETW2(req.wValue, UA20_CS_SAM_FREQ_CONTROL, 0);
5351 USETW2(req.wIndex, clockid, iface_no);
5352 USETW(req.wLength, 4);
5354 data[1] = speed >> 8;
5355 data[2] = speed >> 16;
5356 data[3] = speed >> 24;
5358 return (usbd_do_request(udev, NULL, &req, data));
5362 uaudio_mixer_signext(uint8_t type, int val)
5364 if (!MIX_UNSIGNED(type)) {
5365 if (MIX_SIZE(type) == 2) {
5375 uaudio_mixer_bsd2value(struct uaudio_mixer_node *mc, int val)
5377 if (mc->type == MIX_ON_OFF) {
5379 } else if (mc->type != MIX_SELECTOR) {
5381 /* compute actual volume */
5382 val = (val * mc->mul) / 100;
5384 /* add lower offset */
5385 val = val + mc->minval;
5387 /* make sure we don't write a value out of range */
5388 if (val > mc->maxval)
5390 else if (val < mc->minval)
5393 DPRINTFN(6, "type=0x%03x val=%d min=%d max=%d val=%d\n",
5394 mc->type, val, mc->minval, mc->maxval, val);
5399 uaudio_mixer_ctl_set(struct uaudio_softc *sc, struct uaudio_mixer_node *mc,
5400 uint8_t chan, int val)
5402 val = uaudio_mixer_bsd2value(mc, val);
5404 mc->update[chan / 8] |= (1 << (chan % 8));
5405 mc->wData[chan] = val;
5407 /* start the transfer, if not already started */
5409 usbd_transfer_start(sc->sc_mixer_xfer[0]);
5413 uaudio_mixer_init(struct uaudio_softc *sc)
5415 struct uaudio_mixer_node *mc;
5418 for (mc = sc->sc_mixer_root; mc;
5421 if (mc->ctl != SOUND_MIXER_NRDEVICES) {
5423 * Set device mask bits. See
5424 * /usr/include/machine/soundcard.h
5426 sc->sc_mix_info |= (1 << mc->ctl);
5428 if ((mc->ctl == SOUND_MIXER_NRDEVICES) &&
5429 (mc->type == MIX_SELECTOR)) {
5431 for (i = mc->minval; (i > 0) && (i <= mc->maxval); i++) {
5432 if (mc->slctrtype[i - 1] == SOUND_MIXER_NRDEVICES) {
5435 sc->sc_recsrc_info |= 1 << mc->slctrtype[i - 1];
5442 uaudio_mixer_init_sub(struct uaudio_softc *sc, struct snd_mixer *m)
5446 sc->sc_mixer_lock = mixer_get_lock(m);
5447 sc->sc_mixer_dev = m;
5449 if (usbd_transfer_setup(sc->sc_udev, &sc->sc_mixer_iface_index,
5450 sc->sc_mixer_xfer, uaudio_mixer_config, 1, sc,
5451 sc->sc_mixer_lock)) {
5452 DPRINTFN(0, "could not allocate USB "
5453 "transfer for audio mixer!\n");
5456 if (!(sc->sc_mix_info & SOUND_MASK_VOLUME)) {
5457 mix_setparentchild(m, SOUND_MIXER_VOLUME, SOUND_MASK_PCM);
5458 mix_setrealdev(m, SOUND_MIXER_VOLUME, SOUND_MIXER_NONE);
5460 mix_setdevs(m, sc->sc_mix_info);
5461 mix_setrecdevs(m, sc->sc_recsrc_info);
5466 uaudio_mixer_uninit_sub(struct uaudio_softc *sc)
5470 usbd_transfer_unsetup(sc->sc_mixer_xfer, 1);
5472 sc->sc_mixer_lock = NULL;
5478 uaudio_mixer_set(struct uaudio_softc *sc, unsigned type,
5479 unsigned left, unsigned right)
5481 struct uaudio_mixer_node *mc;
5484 for (mc = sc->sc_mixer_root; mc != NULL; mc = mc->next) {
5486 if (mc->ctl == type) {
5487 for (chan = 0; chan < mc->nchan; chan++) {
5488 uaudio_mixer_ctl_set(sc, mc, chan,
5489 chan == 0 ? left : right);
5496 uaudio_mixer_setrecsrc(struct uaudio_softc *sc, uint32_t src)
5498 struct uaudio_mixer_node *mc;
5503 for (mc = sc->sc_mixer_root; mc;
5506 if ((mc->ctl == SOUND_MIXER_NRDEVICES) &&
5507 (mc->type == MIX_SELECTOR)) {
5509 /* compute selector mask */
5512 for (i = mc->minval; (i > 0) && (i <= mc->maxval); i++) {
5513 mask |= (1 << mc->slctrtype[i - 1]);
5520 /* find the first set bit */
5521 temp = (-temp) & temp;
5527 for (i = mc->minval; (i > 0) && (i <= mc->maxval); i++) {
5528 if (temp != (1 << mc->slctrtype[i - 1])) {
5531 uaudio_mixer_ctl_set(sc, mc, 0, i);
5539 /*========================================================================*
5540 * MIDI support routines
5541 *========================================================================*/
5544 umidi_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
5546 struct umidi_chan *chan = usbd_xfer_softc(xfer);
5547 struct umidi_sub_chan *sub;
5548 struct usb_page_cache *pc;
5555 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
5557 switch (USB_GET_STATE(xfer)) {
5558 case USB_ST_TRANSFERRED:
5560 DPRINTF("actlen=%d bytes\n", actlen);
5563 pc = usbd_xfer_get_frame(xfer, 0);
5565 while (actlen >= 4) {
5567 /* copy out the MIDI data */
5568 usbd_copy_out(pc, pos, buf, 4);
5569 /* command length */
5570 cmd_len = umidi_cmd_to_len[buf[0] & 0xF];
5574 * Lookup sub-channel. The index is range
5577 sub = &chan->sub[cn];
5579 if ((cmd_len != 0) && (cn < chan->max_emb_jack) &&
5580 (sub->read_open != 0)) {
5582 /* Send data to the application */
5583 usb_fifo_put_data_linear(
5584 sub->fifo.fp[USB_FIFO_RX],
5585 buf + 1, cmd_len, 1);
5594 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
5595 usbd_transfer_submit(xfer);
5599 DPRINTF("error=%s\n", usbd_errstr(error));
5601 if (error != USB_ERR_CANCELLED) {
5602 /* try to clear stall first */
5603 usbd_xfer_set_stall(xfer);
5611 * The following statemachine, that converts MIDI commands to
5612 * USB MIDI packets, derives from Linux's usbmidi.c, which
5613 * was written by "Clemens Ladisch":
5617 * Else: Command is complete
5620 umidi_convert_to_usb(struct umidi_sub_chan *sub, uint8_t cn, uint8_t b)
5622 uint8_t p0 = (cn << 4);
5625 sub->temp_0[0] = p0 | 0x0f;
5629 sub->temp_cmd = sub->temp_0;
5632 } else if (b >= 0xf0) {
5634 case 0xf0: /* system exclusive begin */
5636 sub->state = UMIDI_ST_SYSEX_1;
5638 case 0xf1: /* MIDI time code */
5639 case 0xf3: /* song select */
5641 sub->state = UMIDI_ST_1PARAM;
5643 case 0xf2: /* song position pointer */
5645 sub->state = UMIDI_ST_2PARAM_1;
5647 case 0xf4: /* unknown */
5648 case 0xf5: /* unknown */
5649 sub->state = UMIDI_ST_UNKNOWN;
5651 case 0xf6: /* tune request */
5652 sub->temp_1[0] = p0 | 0x05;
5653 sub->temp_1[1] = 0xf6;
5656 sub->temp_cmd = sub->temp_1;
5657 sub->state = UMIDI_ST_UNKNOWN;
5660 case 0xf7: /* system exclusive end */
5661 switch (sub->state) {
5662 case UMIDI_ST_SYSEX_0:
5663 sub->temp_1[0] = p0 | 0x05;
5664 sub->temp_1[1] = 0xf7;
5667 sub->temp_cmd = sub->temp_1;
5668 sub->state = UMIDI_ST_UNKNOWN;
5670 case UMIDI_ST_SYSEX_1:
5671 sub->temp_1[0] = p0 | 0x06;
5672 sub->temp_1[2] = 0xf7;
5674 sub->temp_cmd = sub->temp_1;
5675 sub->state = UMIDI_ST_UNKNOWN;
5677 case UMIDI_ST_SYSEX_2:
5678 sub->temp_1[0] = p0 | 0x07;
5679 sub->temp_1[3] = 0xf7;
5680 sub->temp_cmd = sub->temp_1;
5681 sub->state = UMIDI_ST_UNKNOWN;
5684 sub->state = UMIDI_ST_UNKNOWN;
5687 } else if (b >= 0x80) {
5689 if ((b >= 0xc0) && (b <= 0xdf)) {
5690 sub->state = UMIDI_ST_1PARAM;
5692 sub->state = UMIDI_ST_2PARAM_1;
5694 } else { /* b < 0x80 */
5695 switch (sub->state) {
5696 case UMIDI_ST_1PARAM:
5697 if (sub->temp_1[1] < 0xf0) {
5698 p0 |= sub->temp_1[1] >> 4;
5701 sub->state = UMIDI_ST_UNKNOWN;
5703 sub->temp_1[0] = p0;
5706 sub->temp_cmd = sub->temp_1;
5708 case UMIDI_ST_2PARAM_1:
5710 sub->state = UMIDI_ST_2PARAM_2;
5712 case UMIDI_ST_2PARAM_2:
5713 if (sub->temp_1[1] < 0xf0) {
5714 p0 |= sub->temp_1[1] >> 4;
5715 sub->state = UMIDI_ST_2PARAM_1;
5718 sub->state = UMIDI_ST_UNKNOWN;
5720 sub->temp_1[0] = p0;
5722 sub->temp_cmd = sub->temp_1;
5724 case UMIDI_ST_SYSEX_0:
5726 sub->state = UMIDI_ST_SYSEX_1;
5728 case UMIDI_ST_SYSEX_1:
5730 sub->state = UMIDI_ST_SYSEX_2;
5732 case UMIDI_ST_SYSEX_2:
5733 sub->temp_1[0] = p0 | 0x04;
5735 sub->temp_cmd = sub->temp_1;
5736 sub->state = UMIDI_ST_SYSEX_0;
5746 umidi_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
5748 struct umidi_chan *chan = usbd_xfer_softc(xfer);
5749 struct umidi_sub_chan *sub;
5750 struct usb_page_cache *pc;
5754 uint8_t start_cable;
5758 usbd_xfer_status(xfer, &len, NULL, NULL, NULL);
5761 * NOTE: Some MIDI devices only accept 4 bytes of data per
5762 * short terminated USB transfer.
5764 switch (USB_GET_STATE(xfer)) {
5765 case USB_ST_TRANSFERRED:
5766 DPRINTF("actlen=%d bytes\n", len);
5772 nframes = 0; /* reset */
5773 start_cable = chan->curr_cable;
5775 pc = usbd_xfer_get_frame(xfer, 0);
5779 /* round robin de-queueing */
5781 sub = &chan->sub[chan->curr_cable];
5783 if (sub->write_open) {
5784 usb_fifo_get_data_linear(sub->fifo.fp[USB_FIFO_TX],
5785 &buf, 1, &actlen, 0);
5794 DPRINTF("byte=0x%02x from FIFO %u\n", buf,
5795 (unsigned int)chan->curr_cable);
5797 if (umidi_convert_to_usb(sub, chan->curr_cable, buf)) {
5799 DPRINTF("sub=0x%02x 0x%02x 0x%02x 0x%02x\n",
5800 sub->temp_cmd[0], sub->temp_cmd[1],
5801 sub->temp_cmd[2], sub->temp_cmd[3]);
5803 usbd_copy_in(pc, nframes * 4, sub->temp_cmd, 4);
5807 if ((nframes >= UMIDI_TX_FRAMES) || (chan->single_command != 0))
5815 if (chan->curr_cable >= chan->max_emb_jack)
5816 chan->curr_cable = 0;
5818 if (chan->curr_cable == start_cable) {
5826 DPRINTF("Transferring %d frames\n", (int)nframes);
5827 usbd_xfer_set_frame_len(xfer, 0, 4 * nframes);
5828 usbd_transfer_submit(xfer);
5832 default: /* Error */
5834 DPRINTF("error=%s\n", usbd_errstr(error));
5836 if (error != USB_ERR_CANCELLED) {
5837 /* try to clear stall first */
5838 usbd_xfer_set_stall(xfer);
5845 static struct umidi_sub_chan *
5846 umidi_sub_by_fifo(struct usb_fifo *fifo)
5848 struct umidi_chan *chan = usb_fifo_softc(fifo);
5849 struct umidi_sub_chan *sub;
5852 for (n = 0; n < UMIDI_EMB_JACK_MAX; n++) {
5853 sub = &chan->sub[n];
5854 if ((sub->fifo.fp[USB_FIFO_RX] == fifo) ||
5855 (sub->fifo.fp[USB_FIFO_TX] == fifo)) {
5860 panic("%s:%d cannot find usb_fifo!\n",
5861 __FILE__, __LINE__);
5867 umidi_start_read(struct usb_fifo *fifo)
5869 struct umidi_chan *chan = usb_fifo_softc(fifo);
5871 usbd_transfer_start(chan->xfer[UMIDI_RX_TRANSFER]);
5875 umidi_stop_read(struct usb_fifo *fifo)
5877 struct umidi_chan *chan = usb_fifo_softc(fifo);
5878 struct umidi_sub_chan *sub = umidi_sub_by_fifo(fifo);
5884 if (--(chan->read_open_refcount) == 0) {
5886 * XXX don't stop the read transfer here, hence that causes
5887 * problems with some MIDI adapters
5889 DPRINTF("(stopping read transfer)\n");
5894 umidi_start_write(struct usb_fifo *fifo)
5896 struct umidi_chan *chan = usb_fifo_softc(fifo);
5898 if (chan->xfer[UMIDI_TX_TRANSFER] == NULL) {
5903 usb_fifo_get_data_linear(fifo, buf, 1, &actlen, 0);
5904 } while (actlen > 0);
5906 usbd_transfer_start(chan->xfer[UMIDI_TX_TRANSFER]);
5911 umidi_stop_write(struct usb_fifo *fifo)
5913 struct umidi_chan *chan = usb_fifo_softc(fifo);
5914 struct umidi_sub_chan *sub = umidi_sub_by_fifo(fifo);
5918 sub->write_open = 0;
5920 if (--(chan->write_open_refcount) == 0) {
5921 DPRINTF("(stopping write transfer)\n");
5922 usbd_transfer_stop(chan->xfer[UMIDI_TX_TRANSFER]);
5927 umidi_open(struct usb_fifo *fifo, int fflags)
5929 struct umidi_chan *chan = usb_fifo_softc(fifo);
5930 struct umidi_sub_chan *sub = umidi_sub_by_fifo(fifo);
5932 if (fflags & FREAD) {
5933 if (usb_fifo_alloc_buffer(fifo, 4, (1024 / 4))) {
5936 mtx_lock(&chan->mtx);
5937 chan->read_open_refcount++;
5939 mtx_unlock(&chan->mtx);
5941 if (fflags & FWRITE) {
5942 if (usb_fifo_alloc_buffer(fifo, 32, (1024 / 32))) {
5945 /* clear stall first */
5946 mtx_lock(&chan->mtx);
5947 chan->write_open_refcount++;
5948 sub->write_open = 1;
5951 sub->state = UMIDI_ST_UNKNOWN;
5952 mtx_unlock(&chan->mtx);
5954 return (0); /* success */
5958 umidi_close(struct usb_fifo *fifo, int fflags)
5960 if (fflags & FREAD) {
5961 usb_fifo_free_buffer(fifo);
5963 if (fflags & FWRITE) {
5964 usb_fifo_free_buffer(fifo);
5970 umidi_ioctl(struct usb_fifo *fifo, u_long cmd, void *data,
5977 umidi_init(device_t dev)
5979 struct uaudio_softc *sc = device_get_softc(dev);
5980 struct umidi_chan *chan = &sc->sc_midi_chan;
5982 mtx_init(&chan->mtx, "umidi lock", NULL, MTX_DEF | MTX_RECURSE);
5985 static struct usb_fifo_methods umidi_fifo_methods = {
5986 .f_start_read = &umidi_start_read,
5987 .f_start_write = &umidi_start_write,
5988 .f_stop_read = &umidi_stop_read,
5989 .f_stop_write = &umidi_stop_write,
5990 .f_open = &umidi_open,
5991 .f_close = &umidi_close,
5992 .f_ioctl = &umidi_ioctl,
5993 .basename[0] = "umidi",
5997 umidi_probe(device_t dev)
5999 struct uaudio_softc *sc = device_get_softc(dev);
6000 struct usb_attach_arg *uaa = device_get_ivars(dev);
6001 struct umidi_chan *chan = &sc->sc_midi_chan;
6002 struct umidi_sub_chan *sub;
6003 int unit = device_get_unit(dev);
6007 if (usb_test_quirk(uaa, UQ_SINGLE_CMD_MIDI))
6008 chan->single_command = 1;
6010 if (usbd_set_alt_interface_index(sc->sc_udev, chan->iface_index,
6011 chan->iface_alt_index)) {
6012 DPRINTF("setting of alternate index failed!\n");
6015 usbd_set_parent_iface(sc->sc_udev, chan->iface_index,
6016 sc->sc_mixer_iface_index);
6018 error = usbd_transfer_setup(uaa->device, &chan->iface_index,
6019 chan->xfer, umidi_config, UMIDI_N_TRANSFER,
6022 DPRINTF("error=%s\n", usbd_errstr(error));
6025 if (chan->xfer[UMIDI_TX_TRANSFER] == NULL &&
6026 chan->xfer[UMIDI_RX_TRANSFER] == NULL) {
6027 DPRINTF("no BULK or INTERRUPT MIDI endpoint(s) found\n");
6032 * Some USB MIDI device makers couldn't resist using
6033 * wMaxPacketSize = 4 for RX and TX BULK endpoints, although
6034 * that size is an unsupported value for FULL speed BULK
6035 * endpoints. The same applies to some HIGH speed MIDI devices
6036 * which are using a wMaxPacketSize different from 512 bytes.
6038 * Refer to section 5.8.3 in USB 2.0 PDF: Cite: "All Host
6039 * Controllers are required to have support for 8-, 16-, 32-,
6040 * and 64-byte maximum packet sizes for full-speed bulk
6041 * endpoints and 512 bytes for high-speed bulk endpoints."
6043 if (chan->xfer[UMIDI_TX_TRANSFER] != NULL &&
6044 usbd_xfer_maxp_was_clamped(chan->xfer[UMIDI_TX_TRANSFER]))
6045 chan->single_command = 1;
6047 if (chan->single_command != 0)
6048 device_printf(dev, "Single command MIDI quirk enabled\n");
6050 if ((chan->max_emb_jack == 0) ||
6051 (chan->max_emb_jack > UMIDI_EMB_JACK_MAX)) {
6052 chan->max_emb_jack = UMIDI_EMB_JACK_MAX;
6055 for (n = 0; n < chan->max_emb_jack; n++) {
6057 sub = &chan->sub[n];
6059 error = usb_fifo_attach(sc->sc_udev, chan, &chan->mtx,
6060 &umidi_fifo_methods, &sub->fifo, unit, n,
6062 UID_ROOT, GID_OPERATOR, 0644);
6068 mtx_lock(&chan->mtx);
6071 * NOTE: At least one device will not work properly unless the
6072 * BULK IN pipe is open all the time. This might have to do
6073 * about that the internal queues of the device overflow if we
6074 * don't read them regularly.
6076 usbd_transfer_start(chan->xfer[UMIDI_RX_TRANSFER]);
6078 mtx_unlock(&chan->mtx);
6080 return (0); /* success */
6083 return (ENXIO); /* failure */
6087 umidi_detach(device_t dev)
6089 struct uaudio_softc *sc = device_get_softc(dev);
6090 struct umidi_chan *chan = &sc->sc_midi_chan;
6093 for (n = 0; n < UMIDI_EMB_JACK_MAX; n++)
6094 usb_fifo_detach(&chan->sub[n].fifo);
6096 mtx_lock(&chan->mtx);
6098 usbd_transfer_stop(chan->xfer[UMIDI_RX_TRANSFER]);
6100 mtx_unlock(&chan->mtx);
6102 usbd_transfer_unsetup(chan->xfer, UMIDI_N_TRANSFER);
6104 mtx_destroy(&chan->mtx);
6110 uaudio_hid_rx_callback(struct usb_xfer *xfer, usb_error_t error)
6112 struct uaudio_softc *sc = usbd_xfer_softc(xfer);
6113 const uint8_t *buffer = usbd_xfer_get_frame_buffer(xfer, 0);
6114 struct snd_mixer *m;
6118 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
6120 switch (USB_GET_STATE(xfer)) {
6121 case USB_ST_TRANSFERRED:
6122 DPRINTF("actlen=%d\n", actlen);
6125 (sc->sc_hid.flags & UAUDIO_HID_HAS_ID)) {
6133 m = sc->sc_mixer_dev;
6135 if ((sc->sc_hid.flags & UAUDIO_HID_HAS_MUTE) &&
6136 (sc->sc_hid.mute_id == id) &&
6137 hid_get_data(buffer, actlen,
6138 &sc->sc_hid.mute_loc)) {
6140 DPRINTF("Mute toggle\n");
6142 mixer_hwvol_mute_locked(m);
6145 if ((sc->sc_hid.flags & UAUDIO_HID_HAS_VOLUME_UP) &&
6146 (sc->sc_hid.volume_up_id == id) &&
6147 hid_get_data(buffer, actlen,
6148 &sc->sc_hid.volume_up_loc)) {
6150 DPRINTF("Volume Up\n");
6152 mixer_hwvol_step_locked(m, 1, 1);
6155 if ((sc->sc_hid.flags & UAUDIO_HID_HAS_VOLUME_DOWN) &&
6156 (sc->sc_hid.volume_down_id == id) &&
6157 hid_get_data(buffer, actlen,
6158 &sc->sc_hid.volume_down_loc)) {
6160 DPRINTF("Volume Down\n");
6162 mixer_hwvol_step_locked(m, -1, -1);
6167 /* check if we can put more data into the FIFO */
6168 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
6169 usbd_transfer_submit(xfer);
6172 default: /* Error */
6174 DPRINTF("error=%s\n", usbd_errstr(error));
6176 if (error != USB_ERR_CANCELLED) {
6177 /* try to clear stall first */
6178 usbd_xfer_set_stall(xfer);
6186 uaudio_hid_probe(struct uaudio_softc *sc,
6187 struct usb_attach_arg *uaa)
6195 if (!(sc->sc_hid.flags & UAUDIO_HID_VALID))
6198 if (sc->sc_mixer_lock == NULL)
6201 /* Get HID descriptor */
6202 error = usbd_req_get_hid_desc(uaa->device, NULL, &d_ptr,
6203 &d_len, M_TEMP, sc->sc_hid.iface_index);
6206 DPRINTF("error reading report description\n");
6210 /* check if there is an ID byte */
6211 hid_report_size(d_ptr, d_len, hid_input, &id);
6214 sc->sc_hid.flags |= UAUDIO_HID_HAS_ID;
6216 if (hid_locate(d_ptr, d_len,
6217 HID_USAGE2(HUP_CONSUMER, 0xE9 /* Volume Increment */),
6218 hid_input, 0, &sc->sc_hid.volume_up_loc, &flags,
6219 &sc->sc_hid.volume_up_id)) {
6220 if (flags & HIO_VARIABLE)
6221 sc->sc_hid.flags |= UAUDIO_HID_HAS_VOLUME_UP;
6222 DPRINTFN(1, "Found Volume Up key\n");
6225 if (hid_locate(d_ptr, d_len,
6226 HID_USAGE2(HUP_CONSUMER, 0xEA /* Volume Decrement */),
6227 hid_input, 0, &sc->sc_hid.volume_down_loc, &flags,
6228 &sc->sc_hid.volume_down_id)) {
6229 if (flags & HIO_VARIABLE)
6230 sc->sc_hid.flags |= UAUDIO_HID_HAS_VOLUME_DOWN;
6231 DPRINTFN(1, "Found Volume Down key\n");
6234 if (hid_locate(d_ptr, d_len,
6235 HID_USAGE2(HUP_CONSUMER, 0xE2 /* Mute */),
6236 hid_input, 0, &sc->sc_hid.mute_loc, &flags,
6237 &sc->sc_hid.mute_id)) {
6238 if (flags & HIO_VARIABLE)
6239 sc->sc_hid.flags |= UAUDIO_HID_HAS_MUTE;
6240 DPRINTFN(1, "Found Mute key\n");
6243 free(d_ptr, M_TEMP);
6245 if (!(sc->sc_hid.flags & (UAUDIO_HID_HAS_VOLUME_UP |
6246 UAUDIO_HID_HAS_VOLUME_DOWN |
6247 UAUDIO_HID_HAS_MUTE))) {
6248 DPRINTFN(1, "Did not find any volume related keys\n");
6252 /* prevent the uhid driver from attaching */
6253 usbd_set_parent_iface(uaa->device, sc->sc_hid.iface_index,
6254 sc->sc_mixer_iface_index);
6256 /* allocate USB transfers */
6257 error = usbd_transfer_setup(uaa->device, &sc->sc_hid.iface_index,
6258 sc->sc_hid.xfer, uaudio_hid_config, UAUDIO_HID_N_TRANSFER,
6259 sc, sc->sc_mixer_lock);
6261 DPRINTF("error=%s\n", usbd_errstr(error));
6268 uaudio_hid_detach(struct uaudio_softc *sc)
6270 usbd_transfer_unsetup(sc->sc_hid.xfer, UAUDIO_HID_N_TRANSFER);
6273 DRIVER_MODULE_ORDERED(uaudio, uhub, uaudio_driver, uaudio_devclass, NULL, 0, SI_ORDER_ANY);
6274 MODULE_DEPEND(uaudio, usb, 1, 1, 1);
6275 MODULE_DEPEND(uaudio, sound, SOUND_MINVER, SOUND_PREFVER, SOUND_MAXVER);
6276 MODULE_VERSION(uaudio, 1);
6277 USB_PNP_HOST_INFO(uaudio_devs);
6278 USB_PNP_HOST_INFO(uaudio_vendor_midi);