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 = 0;
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");
141 #define UAUDIO_NFRAMES 64 /* must be factor of 8 due HS-USB */
142 #define UAUDIO_NCHANBUFS 2 /* number of outstanding request */
143 #define UAUDIO_RECURSE_LIMIT 255 /* rounds */
144 #define UAUDIO_CHANNELS_MAX MIN(64, AFMT_CHANNEL_MAX)
145 #define UAUDIO_MATRIX_MAX 8 /* channels */
147 #define MAKE_WORD(h,l) (((h) << 8) | (l))
148 #define BIT_TEST(bm,bno) (((bm)[(bno) / 8] >> (7 - ((bno) % 8))) & 1)
149 #define UAUDIO_MAX_CHAN(x) (x)
150 #define MIX(sc) ((sc)->sc_mixer_node)
153 const struct usb_audio_streaming_interface_descriptor *v1;
154 const struct usb_audio20_streaming_interface_descriptor *v2;
158 const struct usb_audio_streaming_type1_descriptor *v1;
159 const struct usb_audio20_streaming_type1_descriptor *v2;
163 const struct usb_audio_streaming_endpoint_descriptor *v1;
164 const struct usb_audio20_streaming_endpoint_descriptor *v2;
167 struct uaudio_mixer_node {
172 #define MIX_MAX_CHAN 16
173 int32_t wValue[MIX_MAX_CHAN]; /* using nchan */
177 int wData[MIX_MAX_CHAN]; /* using nchan */
180 uint8_t update[(MIX_MAX_CHAN + 7) / 8];
184 #define MIX_SIGNED_16 2
185 #define MIX_UNSIGNED_16 3
186 #define MIX_SIGNED_8 4
187 #define MIX_SELECTOR 5
188 #define MIX_UNKNOWN 6
189 #define MIX_SIZE(n) ((((n) == MIX_SIGNED_16) || \
190 ((n) == MIX_UNSIGNED_16)) ? 2 : 1)
191 #define MIX_UNSIGNED(n) ((n) == MIX_UNSIGNED_16)
193 #define MAX_SELECTOR_INPUT_PIN 256
194 uint8_t slctrtype[MAX_SELECTOR_INPUT_PIN];
200 struct uaudio_mixer_node *next;
203 struct uaudio_configure_msg {
204 struct usb_proc_msg hdr;
205 struct uaudio_softc *sc;
208 #define CHAN_MAX_ALT 24
210 struct uaudio_chan_alt {
211 union uaudio_asf1d p_asf1d;
212 union uaudio_sed p_sed;
213 const usb_endpoint_descriptor_audio_t *p_ed1;
214 const struct uaudio_format *p_fmt;
215 const struct usb_config *usb_cfg;
216 uint32_t sample_rate; /* in Hz */
217 uint16_t sample_size;
219 uint8_t iface_alt_index;
224 struct pcmchan_caps pcm_cap; /* capabilities */
225 struct uaudio_chan_alt usb_alt[CHAN_MAX_ALT];
226 struct snd_dbuf *pcm_buf;
227 struct mtx *pcm_mtx; /* lock protecting this structure */
228 struct uaudio_softc *priv_sc;
229 struct pcm_channel *pcm_ch;
230 struct usb_xfer *xfer[UAUDIO_NCHANBUFS + 1];
232 uint8_t *buf; /* pointer to buffer */
233 uint8_t *start; /* upper layer buffer start */
234 uint8_t *end; /* upper layer buffer end */
235 uint8_t *cur; /* current position in upper layer
238 uint32_t intr_frames; /* in units */
239 uint32_t frames_per_second;
241 uint32_t sample_curr;
248 uint32_t pcm_format[2];
250 uint16_t bytes_per_frame[2];
252 uint32_t intr_counter;
258 #define CHAN_OP_NONE 0
259 #define CHAN_OP_START 1
260 #define CHAN_OP_STOP 2
261 #define CHAN_OP_DRAIN 3
264 #define UMIDI_EMB_JACK_MAX 16 /* units */
265 #define UMIDI_TX_FRAMES 256 /* units */
266 #define UMIDI_TX_BUFFER (UMIDI_TX_FRAMES * 4) /* bytes */
274 struct umidi_sub_chan {
275 struct usb_fifo_sc fifo;
280 #define UMIDI_ST_UNKNOWN 0 /* scan for command */
281 #define UMIDI_ST_1PARAM 1
282 #define UMIDI_ST_2PARAM_1 2
283 #define UMIDI_ST_2PARAM_2 3
284 #define UMIDI_ST_SYSEX_0 4
285 #define UMIDI_ST_SYSEX_1 5
286 #define UMIDI_ST_SYSEX_2 6
289 uint8_t write_open:1;
295 struct umidi_sub_chan sub[UMIDI_EMB_JACK_MAX];
298 struct usb_xfer *xfer[UMIDI_N_TRANSFER];
301 uint8_t iface_alt_index;
303 uint8_t read_open_refcount;
304 uint8_t write_open_refcount;
307 uint8_t max_emb_jack;
309 uint8_t single_command;
312 struct uaudio_search_result {
313 uint8_t bit_input[(256 + 7) / 8];
314 uint8_t bit_output[(256 + 7) / 8];
315 uint8_t recurse_level;
321 UAUDIO_HID_RX_TRANSFER,
322 UAUDIO_HID_N_TRANSFER,
326 struct usb_xfer *xfer[UAUDIO_HID_N_TRANSFER];
327 struct hid_location volume_up_loc;
328 struct hid_location volume_down_loc;
329 struct hid_location mute_loc;
331 #define UAUDIO_HID_VALID 0x0001
332 #define UAUDIO_HID_HAS_ID 0x0002
333 #define UAUDIO_HID_HAS_VOLUME_UP 0x0004
334 #define UAUDIO_HID_HAS_VOLUME_DOWN 0x0008
335 #define UAUDIO_HID_HAS_MUTE 0x0010
337 uint8_t volume_up_id;
338 uint8_t volume_down_id;
342 #define UAUDIO_SPDIF_OUT 0x01 /* Enable S/PDIF output */
343 #define UAUDIO_SPDIF_OUT_48K 0x02 /* Out sample rate = 48K */
344 #define UAUDIO_SPDIF_OUT_96K 0x04 /* Out sample rate = 96K */
345 #define UAUDIO_SPDIF_IN_MIX 0x10 /* Input mix enable */
347 struct uaudio_softc {
348 struct sbuf sc_sndstat;
349 struct sndcard_func sc_sndcard_func;
350 struct uaudio_chan sc_rec_chan;
351 struct uaudio_chan sc_play_chan;
352 struct umidi_chan sc_midi_chan;
353 struct uaudio_hid sc_hid;
354 struct uaudio_search_result sc_mixer_clocks;
355 struct uaudio_mixer_node sc_mixer_node;
356 struct uaudio_configure_msg sc_config_msg[2];
358 struct mtx *sc_mixer_lock;
359 struct snd_mixer *sc_mixer_dev;
360 struct usb_device *sc_udev;
361 struct usb_xfer *sc_mixer_xfer[1];
362 struct uaudio_mixer_node *sc_mixer_root;
363 struct uaudio_mixer_node *sc_mixer_curr;
364 int (*sc_set_spdif_fn) (struct uaudio_softc *, int);
366 uint32_t sc_mix_info;
367 uint32_t sc_recsrc_info;
369 uint16_t sc_audio_rev;
370 uint16_t sc_mixer_count;
372 uint8_t sc_sndstat_valid;
373 uint8_t sc_mixer_iface_index;
374 uint8_t sc_mixer_iface_no;
375 uint8_t sc_mixer_chan;
376 uint8_t sc_pcm_registered:1;
377 uint8_t sc_mixer_init:1;
378 uint8_t sc_uq_audio_swap_lr:1;
379 uint8_t sc_uq_au_inp_async:1;
380 uint8_t sc_uq_au_no_xu:1;
381 uint8_t sc_uq_bad_adc:1;
382 uint8_t sc_uq_au_vendor_class:1;
383 uint8_t sc_pcm_bitperfect:1;
386 struct uaudio_terminal_node {
388 const struct usb_descriptor *desc;
389 const struct usb_audio_input_terminal *it_v1;
390 const struct usb_audio_output_terminal *ot_v1;
391 const struct usb_audio_mixer_unit_0 *mu_v1;
392 const struct usb_audio_selector_unit *su_v1;
393 const struct usb_audio_feature_unit *fu_v1;
394 const struct usb_audio_processing_unit_0 *pu_v1;
395 const struct usb_audio_extension_unit_0 *eu_v1;
396 const struct usb_audio20_clock_source_unit *csrc_v2;
397 const struct usb_audio20_clock_selector_unit_0 *csel_v2;
398 const struct usb_audio20_clock_multiplier_unit *cmul_v2;
399 const struct usb_audio20_input_terminal *it_v2;
400 const struct usb_audio20_output_terminal *ot_v2;
401 const struct usb_audio20_mixer_unit_0 *mu_v2;
402 const struct usb_audio20_selector_unit *su_v2;
403 const struct usb_audio20_feature_unit *fu_v2;
404 const struct usb_audio20_sample_rate_unit *ru_v2;
405 const struct usb_audio20_processing_unit_0 *pu_v2;
406 const struct usb_audio20_extension_unit_0 *eu_v2;
407 const struct usb_audio20_effect_unit *ef_v2;
409 struct uaudio_search_result usr;
410 struct uaudio_terminal_node *root;
413 struct uaudio_format {
416 uint32_t freebsd_fmt;
417 const char *description;
420 static const struct uaudio_format uaudio10_formats[] = {
422 {UA_FMT_PCM8, 8, AFMT_U8, "8-bit U-LE PCM"},
423 {UA_FMT_PCM8, 16, AFMT_U16_LE, "16-bit U-LE PCM"},
424 {UA_FMT_PCM8, 24, AFMT_U24_LE, "24-bit U-LE PCM"},
425 {UA_FMT_PCM8, 32, AFMT_U32_LE, "32-bit U-LE PCM"},
427 {UA_FMT_PCM, 8, AFMT_S8, "8-bit S-LE PCM"},
428 {UA_FMT_PCM, 16, AFMT_S16_LE, "16-bit S-LE PCM"},
429 {UA_FMT_PCM, 24, AFMT_S24_LE, "24-bit S-LE PCM"},
430 {UA_FMT_PCM, 32, AFMT_S32_LE, "32-bit S-LE PCM"},
432 {UA_FMT_ALAW, 8, AFMT_A_LAW, "8-bit A-Law"},
433 {UA_FMT_MULAW, 8, AFMT_MU_LAW, "8-bit mu-Law"},
438 static const struct uaudio_format uaudio20_formats[] = {
440 {UA20_FMT_PCM, 8, AFMT_S8, "8-bit S-LE PCM"},
441 {UA20_FMT_PCM, 16, AFMT_S16_LE, "16-bit S-LE PCM"},
442 {UA20_FMT_PCM, 24, AFMT_S24_LE, "24-bit S-LE PCM"},
443 {UA20_FMT_PCM, 32, AFMT_S32_LE, "32-bit S-LE PCM"},
445 {UA20_FMT_PCM8, 8, AFMT_U8, "8-bit U-LE PCM"},
446 {UA20_FMT_PCM8, 16, AFMT_U16_LE, "16-bit U-LE PCM"},
447 {UA20_FMT_PCM8, 24, AFMT_U24_LE, "24-bit U-LE PCM"},
448 {UA20_FMT_PCM8, 32, AFMT_U32_LE, "32-bit U-LE PCM"},
450 {UA20_FMT_ALAW, 8, AFMT_A_LAW, "8-bit A-Law"},
451 {UA20_FMT_MULAW, 8, AFMT_MU_LAW, "8-bit mu-Law"},
460 #define UAC_NCLASSES 4
463 static const char *uac_names[] = {
464 "outputs", "inputs", "equalization", "record"
471 static device_probe_t uaudio_probe;
472 static device_attach_t uaudio_attach;
473 static device_detach_t uaudio_detach;
475 static usb_callback_t uaudio_chan_play_callback;
476 static usb_callback_t uaudio_chan_play_sync_callback;
477 static usb_callback_t uaudio_chan_record_callback;
478 static usb_callback_t uaudio_chan_record_sync_callback;
479 static usb_callback_t uaudio_mixer_write_cfg_callback;
480 static usb_callback_t umidi_bulk_read_callback;
481 static usb_callback_t umidi_bulk_write_callback;
482 static usb_callback_t uaudio_hid_rx_callback;
484 static usb_proc_callback_t uaudio_configure_msg;
486 /* ==== USB mixer ==== */
488 static int uaudio_mixer_sysctl_handler(SYSCTL_HANDLER_ARGS);
489 static void uaudio_mixer_ctl_free(struct uaudio_softc *);
490 static void uaudio_mixer_register_sysctl(struct uaudio_softc *, device_t);
491 static void uaudio_mixer_reload_all(struct uaudio_softc *);
492 static void uaudio_mixer_controls_create_ftu(struct uaudio_softc *);
494 /* ==== USB audio v1.0 ==== */
496 static void uaudio_mixer_add_mixer(struct uaudio_softc *,
497 const struct uaudio_terminal_node *, int);
498 static void uaudio_mixer_add_selector(struct uaudio_softc *,
499 const struct uaudio_terminal_node *, int);
500 static uint32_t uaudio_mixer_feature_get_bmaControls(
501 const struct usb_audio_feature_unit *, uint8_t);
502 static void uaudio_mixer_add_feature(struct uaudio_softc *,
503 const struct uaudio_terminal_node *, int);
504 static void uaudio_mixer_add_processing_updown(struct uaudio_softc *,
505 const struct uaudio_terminal_node *, int);
506 static void uaudio_mixer_add_processing(struct uaudio_softc *,
507 const struct uaudio_terminal_node *, int);
508 static void uaudio_mixer_add_extension(struct uaudio_softc *,
509 const struct uaudio_terminal_node *, int);
510 static struct usb_audio_cluster uaudio_mixer_get_cluster(uint8_t,
511 const struct uaudio_terminal_node *);
512 static uint16_t uaudio_mixer_determine_class(const struct uaudio_terminal_node *,
513 struct uaudio_mixer_node *);
514 static uint16_t uaudio_mixer_feature_name(const struct uaudio_terminal_node *,
515 struct uaudio_mixer_node *);
516 static void uaudio_mixer_find_inputs_sub(struct uaudio_terminal_node *,
517 const uint8_t *, uint8_t, struct uaudio_search_result *);
518 static const void *uaudio_mixer_verify_desc(const void *, uint32_t);
519 static usb_error_t uaudio_set_speed(struct usb_device *, uint8_t, uint32_t);
520 static int uaudio_mixer_get(struct usb_device *, uint16_t, uint8_t,
521 struct uaudio_mixer_node *);
523 /* ==== USB audio v2.0 ==== */
525 static void uaudio20_mixer_add_mixer(struct uaudio_softc *,
526 const struct uaudio_terminal_node *, int);
527 static void uaudio20_mixer_add_selector(struct uaudio_softc *,
528 const struct uaudio_terminal_node *, int);
529 static void uaudio20_mixer_add_feature(struct uaudio_softc *,
530 const struct uaudio_terminal_node *, int);
531 static struct usb_audio20_cluster uaudio20_mixer_get_cluster(uint8_t,
532 const struct uaudio_terminal_node *);
533 static uint16_t uaudio20_mixer_determine_class(const struct uaudio_terminal_node *,
534 struct uaudio_mixer_node *);
535 static uint16_t uaudio20_mixer_feature_name(const struct uaudio_terminal_node *,
536 struct uaudio_mixer_node *);
537 static void uaudio20_mixer_find_inputs_sub(struct uaudio_terminal_node *,
538 const uint8_t *, uint8_t, struct uaudio_search_result *);
539 static const void *uaudio20_mixer_verify_desc(const void *, uint32_t);
540 static usb_error_t uaudio20_set_speed(struct usb_device *, uint8_t,
543 /* USB audio v1.0 and v2.0 */
545 static void uaudio_chan_fill_info_sub(struct uaudio_softc *,
546 struct usb_device *, uint32_t, uint8_t, uint8_t);
547 static void uaudio_chan_fill_info(struct uaudio_softc *,
548 struct usb_device *);
549 static void uaudio_mixer_add_ctl_sub(struct uaudio_softc *,
550 struct uaudio_mixer_node *);
551 static void uaudio_mixer_add_ctl(struct uaudio_softc *,
552 struct uaudio_mixer_node *);
553 static void uaudio_mixer_fill_info(struct uaudio_softc *,
554 struct usb_device *, void *);
555 static void uaudio_mixer_ctl_set(struct uaudio_softc *,
556 struct uaudio_mixer_node *, uint8_t, int32_t val);
557 static int uaudio_mixer_signext(uint8_t, int);
558 static int uaudio_mixer_bsd2value(struct uaudio_mixer_node *, int32_t val);
559 static void uaudio_mixer_init(struct uaudio_softc *);
560 static const struct uaudio_terminal_node *uaudio_mixer_get_input(
561 const struct uaudio_terminal_node *, uint8_t);
562 static const struct uaudio_terminal_node *uaudio_mixer_get_output(
563 const struct uaudio_terminal_node *, uint8_t);
564 static void uaudio_mixer_find_outputs_sub(struct uaudio_terminal_node *,
565 uint8_t, uint8_t, struct uaudio_search_result *);
566 static uint8_t umidi_convert_to_usb(struct umidi_sub_chan *, uint8_t, uint8_t);
567 static struct umidi_sub_chan *umidi_sub_by_fifo(struct usb_fifo *);
568 static void umidi_start_read(struct usb_fifo *);
569 static void umidi_stop_read(struct usb_fifo *);
570 static void umidi_start_write(struct usb_fifo *);
571 static void umidi_stop_write(struct usb_fifo *);
572 static int umidi_open(struct usb_fifo *, int);
573 static int umidi_ioctl(struct usb_fifo *, u_long cmd, void *, int);
574 static void umidi_close(struct usb_fifo *, int);
575 static void umidi_init(device_t dev);
576 static int umidi_probe(device_t dev);
577 static int umidi_detach(device_t dev);
578 static int uaudio_hid_probe(struct uaudio_softc *sc,
579 struct usb_attach_arg *uaa);
580 static void uaudio_hid_detach(struct uaudio_softc *sc);
583 static void uaudio_chan_dump_ep_desc(
584 const usb_endpoint_descriptor_audio_t *);
587 static const struct usb_config
588 uaudio_cfg_record[UAUDIO_NCHANBUFS + 1] = {
590 .type = UE_ISOCHRONOUS,
591 .endpoint = UE_ADDR_ANY,
592 .direction = UE_DIR_IN,
593 .bufsize = 0, /* use "wMaxPacketSize * frames" */
594 .frames = UAUDIO_NFRAMES,
595 .flags = {.short_xfer_ok = 1,},
596 .callback = &uaudio_chan_record_callback,
600 .type = UE_ISOCHRONOUS,
601 .endpoint = UE_ADDR_ANY,
602 .direction = UE_DIR_IN,
603 .bufsize = 0, /* use "wMaxPacketSize * frames" */
604 .frames = UAUDIO_NFRAMES,
605 .flags = {.short_xfer_ok = 1,},
606 .callback = &uaudio_chan_record_callback,
610 .type = UE_ISOCHRONOUS,
611 .endpoint = UE_ADDR_ANY,
612 .direction = UE_DIR_OUT,
613 .bufsize = 0, /* use "wMaxPacketSize * frames" */
615 .flags = {.no_pipe_ok = 1,.short_xfer_ok = 1,},
616 .callback = &uaudio_chan_record_sync_callback,
620 static const struct usb_config
621 uaudio_cfg_play[UAUDIO_NCHANBUFS + 1] = {
623 .type = UE_ISOCHRONOUS,
624 .endpoint = UE_ADDR_ANY,
625 .direction = UE_DIR_OUT,
626 .bufsize = 0, /* use "wMaxPacketSize * frames" */
627 .frames = UAUDIO_NFRAMES,
628 .flags = {.short_xfer_ok = 1,},
629 .callback = &uaudio_chan_play_callback,
633 .type = UE_ISOCHRONOUS,
634 .endpoint = UE_ADDR_ANY,
635 .direction = UE_DIR_OUT,
636 .bufsize = 0, /* use "wMaxPacketSize * frames" */
637 .frames = UAUDIO_NFRAMES,
638 .flags = {.short_xfer_ok = 1,},
639 .callback = &uaudio_chan_play_callback,
643 .type = UE_ISOCHRONOUS,
644 .endpoint = UE_ADDR_ANY,
645 .direction = UE_DIR_IN,
646 .bufsize = 0, /* use "wMaxPacketSize * frames" */
648 .flags = {.no_pipe_ok = 1,.short_xfer_ok = 1,},
649 .callback = &uaudio_chan_play_sync_callback,
653 static const struct usb_config
654 uaudio_mixer_config[1] = {
657 .endpoint = 0x00, /* Control pipe */
658 .direction = UE_DIR_ANY,
659 .bufsize = (sizeof(struct usb_device_request) + 4),
660 .callback = &uaudio_mixer_write_cfg_callback,
661 .timeout = 1000, /* 1 second */
666 uint8_t umidi_cmd_to_len[16] = {
667 [0x0] = 0, /* reserved */
668 [0x1] = 0, /* reserved */
669 [0x2] = 2, /* bytes */
670 [0x3] = 3, /* bytes */
671 [0x4] = 3, /* bytes */
672 [0x5] = 1, /* bytes */
673 [0x6] = 2, /* bytes */
674 [0x7] = 3, /* bytes */
675 [0x8] = 3, /* bytes */
676 [0x9] = 3, /* bytes */
677 [0xA] = 3, /* bytes */
678 [0xB] = 3, /* bytes */
679 [0xC] = 2, /* bytes */
680 [0xD] = 2, /* bytes */
681 [0xE] = 3, /* bytes */
682 [0xF] = 1, /* bytes */
685 static const struct usb_config
686 umidi_config[UMIDI_N_TRANSFER] = {
687 [UMIDI_TX_TRANSFER] = {
689 .endpoint = UE_ADDR_ANY,
690 .direction = UE_DIR_OUT,
691 .bufsize = UMIDI_TX_BUFFER,
692 .flags = {.no_pipe_ok = 1},
693 .callback = &umidi_bulk_write_callback,
696 [UMIDI_RX_TRANSFER] = {
698 .endpoint = UE_ADDR_ANY,
699 .direction = UE_DIR_IN,
700 .bufsize = 4, /* bytes */
701 .flags = {.short_xfer_ok = 1,.proxy_buffer = 1,.no_pipe_ok = 1},
702 .callback = &umidi_bulk_read_callback,
706 static const struct usb_config
707 uaudio_hid_config[UAUDIO_HID_N_TRANSFER] = {
708 [UAUDIO_HID_RX_TRANSFER] = {
709 .type = UE_INTERRUPT,
710 .endpoint = UE_ADDR_ANY,
711 .direction = UE_DIR_IN,
712 .bufsize = 0, /* use wMaxPacketSize */
713 .flags = {.short_xfer_ok = 1,},
714 .callback = &uaudio_hid_rx_callback,
718 static devclass_t uaudio_devclass;
720 static device_method_t uaudio_methods[] = {
721 DEVMETHOD(device_probe, uaudio_probe),
722 DEVMETHOD(device_attach, uaudio_attach),
723 DEVMETHOD(device_detach, uaudio_detach),
724 DEVMETHOD(device_suspend, bus_generic_suspend),
725 DEVMETHOD(device_resume, bus_generic_resume),
726 DEVMETHOD(device_shutdown, bus_generic_shutdown),
731 static driver_t uaudio_driver = {
733 .methods = uaudio_methods,
734 .size = sizeof(struct uaudio_softc),
737 /* The following table is derived from Linux's quirks-table.h */
738 static const STRUCT_USB_HOST_ID uaudio_vendor_midi[] = {
739 { USB_VPI(USB_VENDOR_YAMAHA, 0x1000, 0) }, /* UX256 */
740 { USB_VPI(USB_VENDOR_YAMAHA, 0x1001, 0) }, /* MU1000 */
741 { USB_VPI(USB_VENDOR_YAMAHA, 0x1002, 0) }, /* MU2000 */
742 { USB_VPI(USB_VENDOR_YAMAHA, 0x1003, 0) }, /* MU500 */
743 { USB_VPI(USB_VENDOR_YAMAHA, 0x1004, 3) }, /* UW500 */
744 { USB_VPI(USB_VENDOR_YAMAHA, 0x1005, 0) }, /* MOTIF6 */
745 { USB_VPI(USB_VENDOR_YAMAHA, 0x1006, 0) }, /* MOTIF7 */
746 { USB_VPI(USB_VENDOR_YAMAHA, 0x1007, 0) }, /* MOTIF8 */
747 { USB_VPI(USB_VENDOR_YAMAHA, 0x1008, 0) }, /* UX96 */
748 { USB_VPI(USB_VENDOR_YAMAHA, 0x1009, 0) }, /* UX16 */
749 { USB_VPI(USB_VENDOR_YAMAHA, 0x100a, 3) }, /* EOS BX */
750 { USB_VPI(USB_VENDOR_YAMAHA, 0x100c, 0) }, /* UC-MX */
751 { USB_VPI(USB_VENDOR_YAMAHA, 0x100d, 0) }, /* UC-KX */
752 { USB_VPI(USB_VENDOR_YAMAHA, 0x100e, 0) }, /* S08 */
753 { USB_VPI(USB_VENDOR_YAMAHA, 0x100f, 0) }, /* CLP-150 */
754 { USB_VPI(USB_VENDOR_YAMAHA, 0x1010, 0) }, /* CLP-170 */
755 { USB_VPI(USB_VENDOR_YAMAHA, 0x1011, 0) }, /* P-250 */
756 { USB_VPI(USB_VENDOR_YAMAHA, 0x1012, 0) }, /* TYROS */
757 { USB_VPI(USB_VENDOR_YAMAHA, 0x1013, 0) }, /* PF-500 */
758 { USB_VPI(USB_VENDOR_YAMAHA, 0x1014, 0) }, /* S90 */
759 { USB_VPI(USB_VENDOR_YAMAHA, 0x1015, 0) }, /* MOTIF-R */
760 { USB_VPI(USB_VENDOR_YAMAHA, 0x1016, 0) }, /* MDP-5 */
761 { USB_VPI(USB_VENDOR_YAMAHA, 0x1017, 0) }, /* CVP-204 */
762 { USB_VPI(USB_VENDOR_YAMAHA, 0x1018, 0) }, /* CVP-206 */
763 { USB_VPI(USB_VENDOR_YAMAHA, 0x1019, 0) }, /* CVP-208 */
764 { USB_VPI(USB_VENDOR_YAMAHA, 0x101a, 0) }, /* CVP-210 */
765 { USB_VPI(USB_VENDOR_YAMAHA, 0x101b, 0) }, /* PSR-1100 */
766 { USB_VPI(USB_VENDOR_YAMAHA, 0x101c, 0) }, /* PSR-2100 */
767 { USB_VPI(USB_VENDOR_YAMAHA, 0x101d, 0) }, /* CLP-175 */
768 { USB_VPI(USB_VENDOR_YAMAHA, 0x101e, 0) }, /* PSR-K1 */
769 { USB_VPI(USB_VENDOR_YAMAHA, 0x101f, 0) }, /* EZ-J24 */
770 { USB_VPI(USB_VENDOR_YAMAHA, 0x1020, 0) }, /* EZ-250i */
771 { USB_VPI(USB_VENDOR_YAMAHA, 0x1021, 0) }, /* MOTIF ES 6 */
772 { USB_VPI(USB_VENDOR_YAMAHA, 0x1022, 0) }, /* MOTIF ES 7 */
773 { USB_VPI(USB_VENDOR_YAMAHA, 0x1023, 0) }, /* MOTIF ES 8 */
774 { USB_VPI(USB_VENDOR_YAMAHA, 0x1024, 0) }, /* CVP-301 */
775 { USB_VPI(USB_VENDOR_YAMAHA, 0x1025, 0) }, /* CVP-303 */
776 { USB_VPI(USB_VENDOR_YAMAHA, 0x1026, 0) }, /* CVP-305 */
777 { USB_VPI(USB_VENDOR_YAMAHA, 0x1027, 0) }, /* CVP-307 */
778 { USB_VPI(USB_VENDOR_YAMAHA, 0x1028, 0) }, /* CVP-309 */
779 { USB_VPI(USB_VENDOR_YAMAHA, 0x1029, 0) }, /* CVP-309GP */
780 { USB_VPI(USB_VENDOR_YAMAHA, 0x102a, 0) }, /* PSR-1500 */
781 { USB_VPI(USB_VENDOR_YAMAHA, 0x102b, 0) }, /* PSR-3000 */
782 { USB_VPI(USB_VENDOR_YAMAHA, 0x102e, 0) }, /* ELS-01/01C */
783 { USB_VPI(USB_VENDOR_YAMAHA, 0x1030, 0) }, /* PSR-295/293 */
784 { USB_VPI(USB_VENDOR_YAMAHA, 0x1031, 0) }, /* DGX-205/203 */
785 { USB_VPI(USB_VENDOR_YAMAHA, 0x1032, 0) }, /* DGX-305 */
786 { USB_VPI(USB_VENDOR_YAMAHA, 0x1033, 0) }, /* DGX-505 */
787 { USB_VPI(USB_VENDOR_YAMAHA, 0x1034, 0) }, /* NULL */
788 { USB_VPI(USB_VENDOR_YAMAHA, 0x1035, 0) }, /* NULL */
789 { USB_VPI(USB_VENDOR_YAMAHA, 0x1036, 0) }, /* NULL */
790 { USB_VPI(USB_VENDOR_YAMAHA, 0x1037, 0) }, /* NULL */
791 { USB_VPI(USB_VENDOR_YAMAHA, 0x1038, 0) }, /* NULL */
792 { USB_VPI(USB_VENDOR_YAMAHA, 0x1039, 0) }, /* NULL */
793 { USB_VPI(USB_VENDOR_YAMAHA, 0x103a, 0) }, /* NULL */
794 { USB_VPI(USB_VENDOR_YAMAHA, 0x103b, 0) }, /* NULL */
795 { USB_VPI(USB_VENDOR_YAMAHA, 0x103c, 0) }, /* NULL */
796 { USB_VPI(USB_VENDOR_YAMAHA, 0x103d, 0) }, /* NULL */
797 { USB_VPI(USB_VENDOR_YAMAHA, 0x103e, 0) }, /* NULL */
798 { USB_VPI(USB_VENDOR_YAMAHA, 0x103f, 0) }, /* NULL */
799 { USB_VPI(USB_VENDOR_YAMAHA, 0x1040, 0) }, /* NULL */
800 { USB_VPI(USB_VENDOR_YAMAHA, 0x1041, 0) }, /* NULL */
801 { USB_VPI(USB_VENDOR_YAMAHA, 0x1042, 0) }, /* NULL */
802 { USB_VPI(USB_VENDOR_YAMAHA, 0x1043, 0) }, /* NULL */
803 { USB_VPI(USB_VENDOR_YAMAHA, 0x1044, 0) }, /* NULL */
804 { USB_VPI(USB_VENDOR_YAMAHA, 0x1045, 0) }, /* NULL */
805 { USB_VPI(USB_VENDOR_YAMAHA, 0x104e, 0) }, /* NULL */
806 { USB_VPI(USB_VENDOR_YAMAHA, 0x104f, 0) }, /* NULL */
807 { USB_VPI(USB_VENDOR_YAMAHA, 0x1050, 0) }, /* NULL */
808 { USB_VPI(USB_VENDOR_YAMAHA, 0x1051, 0) }, /* NULL */
809 { USB_VPI(USB_VENDOR_YAMAHA, 0x1052, 0) }, /* NULL */
810 { USB_VPI(USB_VENDOR_YAMAHA, 0x1053, 0) }, /* NULL */
811 { USB_VPI(USB_VENDOR_YAMAHA, 0x1054, 0) }, /* NULL */
812 { USB_VPI(USB_VENDOR_YAMAHA, 0x1055, 0) }, /* NULL */
813 { USB_VPI(USB_VENDOR_YAMAHA, 0x1056, 0) }, /* NULL */
814 { USB_VPI(USB_VENDOR_YAMAHA, 0x1057, 0) }, /* NULL */
815 { USB_VPI(USB_VENDOR_YAMAHA, 0x1058, 0) }, /* NULL */
816 { USB_VPI(USB_VENDOR_YAMAHA, 0x1059, 0) }, /* NULL */
817 { USB_VPI(USB_VENDOR_YAMAHA, 0x105a, 0) }, /* NULL */
818 { USB_VPI(USB_VENDOR_YAMAHA, 0x105b, 0) }, /* NULL */
819 { USB_VPI(USB_VENDOR_YAMAHA, 0x105c, 0) }, /* NULL */
820 { USB_VPI(USB_VENDOR_YAMAHA, 0x105d, 0) }, /* NULL */
821 { USB_VPI(USB_VENDOR_YAMAHA, 0x1503, 3) }, /* MOX6/MOX8 */
822 { USB_VPI(USB_VENDOR_YAMAHA, 0x2000, 0) }, /* DGP-7 */
823 { USB_VPI(USB_VENDOR_YAMAHA, 0x2001, 0) }, /* DGP-5 */
824 { USB_VPI(USB_VENDOR_YAMAHA, 0x2002, 0) }, /* NULL */
825 { USB_VPI(USB_VENDOR_YAMAHA, 0x2003, 0) }, /* NULL */
826 { USB_VPI(USB_VENDOR_YAMAHA, 0x5000, 0) }, /* CS1D */
827 { USB_VPI(USB_VENDOR_YAMAHA, 0x5001, 0) }, /* DSP1D */
828 { USB_VPI(USB_VENDOR_YAMAHA, 0x5002, 0) }, /* DME32 */
829 { USB_VPI(USB_VENDOR_YAMAHA, 0x5003, 0) }, /* DM2000 */
830 { USB_VPI(USB_VENDOR_YAMAHA, 0x5004, 0) }, /* 02R96 */
831 { USB_VPI(USB_VENDOR_YAMAHA, 0x5005, 0) }, /* ACU16-C */
832 { USB_VPI(USB_VENDOR_YAMAHA, 0x5006, 0) }, /* NHB32-C */
833 { USB_VPI(USB_VENDOR_YAMAHA, 0x5007, 0) }, /* DM1000 */
834 { USB_VPI(USB_VENDOR_YAMAHA, 0x5008, 0) }, /* 01V96 */
835 { USB_VPI(USB_VENDOR_YAMAHA, 0x5009, 0) }, /* SPX2000 */
836 { USB_VPI(USB_VENDOR_YAMAHA, 0x500a, 0) }, /* PM5D */
837 { USB_VPI(USB_VENDOR_YAMAHA, 0x500b, 0) }, /* DME64N */
838 { USB_VPI(USB_VENDOR_YAMAHA, 0x500c, 0) }, /* DME24N */
839 { USB_VPI(USB_VENDOR_YAMAHA, 0x500d, 0) }, /* NULL */
840 { USB_VPI(USB_VENDOR_YAMAHA, 0x500e, 0) }, /* NULL */
841 { USB_VPI(USB_VENDOR_YAMAHA, 0x500f, 0) }, /* NULL */
842 { USB_VPI(USB_VENDOR_YAMAHA, 0x7000, 0) }, /* DTX */
843 { USB_VPI(USB_VENDOR_YAMAHA, 0x7010, 0) }, /* UB99 */
846 static const STRUCT_USB_HOST_ID __used uaudio_devs[] = {
847 /* Generic USB audio class match */
848 {USB_IFACE_CLASS(UICLASS_AUDIO),
849 USB_IFACE_SUBCLASS(UISUBCLASS_AUDIOCONTROL),},
850 /* Generic USB MIDI class match */
851 {USB_IFACE_CLASS(UICLASS_AUDIO),
852 USB_IFACE_SUBCLASS(UISUBCLASS_MIDISTREAM),},
856 uaudio_probe(device_t dev)
858 struct usb_attach_arg *uaa = device_get_ivars(dev);
860 if (uaa->usb_mode != USB_MODE_HOST)
863 /* lookup non-standard device(s) */
865 if (usbd_lookup_id_by_uaa(uaudio_vendor_midi,
866 sizeof(uaudio_vendor_midi), uaa) == 0) {
867 return (BUS_PROBE_SPECIFIC);
870 if (uaa->info.bInterfaceClass != UICLASS_AUDIO) {
871 if (uaa->info.bInterfaceClass != UICLASS_VENDOR ||
872 usb_test_quirk(uaa, UQ_AU_VENDOR_CLASS) == 0)
876 /* check for AUDIO control interface */
878 if (uaa->info.bInterfaceSubClass == UISUBCLASS_AUDIOCONTROL) {
879 if (usb_test_quirk(uaa, UQ_BAD_AUDIO))
882 return (BUS_PROBE_GENERIC);
885 /* check for MIDI stream */
887 if (uaa->info.bInterfaceSubClass == UISUBCLASS_MIDISTREAM) {
888 if (usb_test_quirk(uaa, UQ_BAD_MIDI))
891 return (BUS_PROBE_GENERIC);
897 * Set Cmedia CM6206 S/PDIF settings
898 * Source: CM6206 Datasheet v2.3.
901 uaudio_set_spdif_cm6206(struct uaudio_softc *sc, int flags)
903 uint8_t cmd[2][4] = {
904 {0x20, 0x20, 0x00, 0},
905 {0x20, 0x30, 0x02, 1}
909 if (flags & UAUDIO_SPDIF_OUT)
914 if (flags & UAUDIO_SPDIF_OUT_96K)
915 cmd[0][1] = 0x60; /* 96K: 3'b110 */
917 if (flags & UAUDIO_SPDIF_IN_MIX)
918 cmd[1][1] = 0x03; /* SPDIFMIX */
920 for (i = 0; i < 2; i++) {
921 if (usbd_req_set_report(sc->sc_udev, NULL,
922 cmd[i], sizeof(cmd[0]),
923 sc->sc_mixer_iface_index, UHID_OUTPUT_REPORT, 0) != 0) {
931 uaudio_set_spdif_dummy(struct uaudio_softc *sc, int flags)
937 uaudio_attach(device_t dev)
939 struct usb_attach_arg *uaa = device_get_ivars(dev);
940 struct uaudio_softc *sc = device_get_softc(dev);
941 struct usb_interface_descriptor *id;
945 sc->sc_play_chan.priv_sc = sc;
946 sc->sc_rec_chan.priv_sc = sc;
947 sc->sc_udev = uaa->device;
948 sc->sc_mixer_iface_index = uaa->info.bIfaceIndex;
949 sc->sc_mixer_iface_no = uaa->info.bIfaceNum;
950 sc->sc_config_msg[0].hdr.pm_callback = &uaudio_configure_msg;
951 sc->sc_config_msg[0].sc = sc;
952 sc->sc_config_msg[1].hdr.pm_callback = &uaudio_configure_msg;
953 sc->sc_config_msg[1].sc = sc;
955 if (usb_test_quirk(uaa, UQ_AUDIO_SWAP_LR))
956 sc->sc_uq_audio_swap_lr = 1;
958 if (usb_test_quirk(uaa, UQ_AU_INP_ASYNC))
959 sc->sc_uq_au_inp_async = 1;
961 if (usb_test_quirk(uaa, UQ_AU_NO_XU))
962 sc->sc_uq_au_no_xu = 1;
964 if (usb_test_quirk(uaa, UQ_BAD_ADC))
965 sc->sc_uq_bad_adc = 1;
967 if (usb_test_quirk(uaa, UQ_AU_VENDOR_CLASS))
968 sc->sc_uq_au_vendor_class = 1;
970 /* set S/PDIF function */
971 if (usb_test_quirk(uaa, UQ_AU_SET_SPDIF_CM6206))
972 sc->sc_set_spdif_fn = uaudio_set_spdif_cm6206;
974 sc->sc_set_spdif_fn = uaudio_set_spdif_dummy;
978 device_set_usb_desc(dev);
980 id = usbd_get_interface_descriptor(uaa->iface);
982 /* must fill mixer info before channel info */
983 uaudio_mixer_fill_info(sc, uaa->device, id);
985 /* fill channel info */
986 uaudio_chan_fill_info(sc, uaa->device);
988 DPRINTF("audio rev %d.%02x\n",
989 sc->sc_audio_rev >> 8,
990 sc->sc_audio_rev & 0xff);
992 if (sc->sc_mixer_count == 0) {
993 if (uaa->info.idVendor == USB_VENDOR_MAUDIO &&
994 (uaa->info.idProduct == USB_PRODUCT_MAUDIO_FASTTRACKULTRA ||
995 uaa->info.idProduct == USB_PRODUCT_MAUDIO_FASTTRACKULTRA8R)) {
996 DPRINTF("Generating mixer descriptors\n");
997 uaudio_mixer_controls_create_ftu(sc);
1001 DPRINTF("%d mixer controls\n",
1002 sc->sc_mixer_count);
1004 if (sc->sc_play_chan.num_alt > 0) {
1008 * Need to set a default alternate interface, else
1009 * some USB audio devices might go into an infinte
1010 * re-enumeration loop:
1012 err = usbd_set_alt_interface_index(sc->sc_udev,
1013 sc->sc_play_chan.usb_alt[0].iface_index,
1014 sc->sc_play_chan.usb_alt[0].iface_alt_index);
1016 DPRINTF("setting of alternate index failed: %s!\n",
1019 for (x = 0; x != sc->sc_play_chan.num_alt; x++) {
1020 device_printf(dev, "Play: %d Hz, %d ch, %s format, "
1022 sc->sc_play_chan.usb_alt[x].sample_rate,
1023 sc->sc_play_chan.usb_alt[x].channels,
1024 sc->sc_play_chan.usb_alt[x].p_fmt->description);
1027 device_printf(dev, "No playback.\n");
1030 if (sc->sc_rec_chan.num_alt > 0) {
1034 * Need to set a default alternate interface, else
1035 * some USB audio devices might go into an infinte
1036 * re-enumeration loop:
1038 err = usbd_set_alt_interface_index(sc->sc_udev,
1039 sc->sc_rec_chan.usb_alt[0].iface_index,
1040 sc->sc_rec_chan.usb_alt[0].iface_alt_index);
1042 DPRINTF("setting of alternate index failed: %s!\n",
1045 for (x = 0; x != sc->sc_rec_chan.num_alt; x++) {
1046 device_printf(dev, "Record: %d Hz, %d ch, %s format, "
1048 sc->sc_rec_chan.usb_alt[x].sample_rate,
1049 sc->sc_rec_chan.usb_alt[x].channels,
1050 sc->sc_rec_chan.usb_alt[x].p_fmt->description);
1053 device_printf(dev, "No recording.\n");
1056 if (sc->sc_midi_chan.valid == 0) {
1057 if (usbd_lookup_id_by_uaa(uaudio_vendor_midi,
1058 sizeof(uaudio_vendor_midi), uaa) == 0) {
1059 sc->sc_midi_chan.iface_index =
1060 (uint8_t)uaa->driver_info;
1061 sc->sc_midi_chan.iface_alt_index = 0;
1062 sc->sc_midi_chan.valid = 1;
1066 if (sc->sc_midi_chan.valid) {
1068 if (umidi_probe(dev)) {
1071 device_printf(dev, "MIDI sequencer.\n");
1073 device_printf(dev, "No MIDI sequencer.\n");
1076 DPRINTF("doing child attach\n");
1078 /* attach the children */
1080 sc->sc_sndcard_func.func = SCF_PCM;
1083 * Only attach a PCM device if we have a playback, recording
1084 * or mixer device present:
1086 if (sc->sc_play_chan.num_alt > 0 ||
1087 sc->sc_rec_chan.num_alt > 0 ||
1089 child = device_add_child(dev, "pcm", -1);
1091 if (child == NULL) {
1092 DPRINTF("out of memory\n");
1095 device_set_ivars(child, &sc->sc_sndcard_func);
1098 if (bus_generic_attach(dev)) {
1099 DPRINTF("child attach failed\n");
1103 if (uaudio_hid_probe(sc, uaa) == 0) {
1104 device_printf(dev, "HID volume keys found.\n");
1106 device_printf(dev, "No HID volume keys found.\n");
1109 /* reload all mixer settings */
1110 uaudio_mixer_reload_all(sc);
1112 /* enable S/PDIF output, if any */
1113 if (sc->sc_set_spdif_fn(sc,
1114 UAUDIO_SPDIF_OUT | UAUDIO_SPDIF_OUT_48K) != 0) {
1115 device_printf(dev, "Failed to enable S/PDIF at 48K\n");
1117 return (0); /* success */
1125 uaudio_pcm_setflags(device_t dev, uint32_t flags)
1127 pcm_setflags(dev, pcm_getflags(dev) | flags);
1131 uaudio_attach_sub(device_t dev, kobj_class_t mixer_class, kobj_class_t chan_class)
1133 struct uaudio_softc *sc = device_get_softc(device_get_parent(dev));
1134 char status[SND_STATUSLEN];
1136 uaudio_mixer_init(sc);
1138 if (sc->sc_uq_audio_swap_lr) {
1139 DPRINTF("hardware has swapped left and right\n");
1140 /* uaudio_pcm_setflags(dev, SD_F_PSWAPLR); */
1142 if (!(sc->sc_mix_info & SOUND_MASK_PCM)) {
1144 DPRINTF("emulating master volume\n");
1147 * Emulate missing pcm mixer controller
1148 * through FEEDER_VOLUME
1150 uaudio_pcm_setflags(dev, SD_F_SOFTPCMVOL);
1152 if (sc->sc_pcm_bitperfect) {
1153 DPRINTF("device needs bitperfect by default\n");
1154 uaudio_pcm_setflags(dev, SD_F_BITPERFECT);
1156 if (mixer_init(dev, mixer_class, sc))
1158 sc->sc_mixer_init = 1;
1160 mixer_hwvol_init(dev);
1162 snprintf(status, sizeof(status), "at ? %s", PCM_KLDSTRING(snd_uaudio));
1164 if (pcm_register(dev, sc,
1165 (sc->sc_play_chan.num_alt > 0) ? 1 : 0,
1166 (sc->sc_rec_chan.num_alt > 0) ? 1 : 0)) {
1170 uaudio_pcm_setflags(dev, SD_F_MPSAFE);
1171 sc->sc_pcm_registered = 1;
1173 if (sc->sc_play_chan.num_alt > 0) {
1174 pcm_addchan(dev, PCMDIR_PLAY, chan_class, sc);
1176 if (sc->sc_rec_chan.num_alt > 0) {
1177 pcm_addchan(dev, PCMDIR_REC, chan_class, sc);
1179 pcm_setstatus(dev, status);
1181 uaudio_mixer_register_sysctl(sc, dev);
1183 SYSCTL_ADD_INT(device_get_sysctl_ctx(dev),
1184 SYSCTL_CHILDREN(device_get_sysctl_tree(dev)), OID_AUTO,
1185 "feedback_rate", CTLFLAG_RD, &sc->sc_play_chan.feedback_rate,
1186 0, "Feedback sample rate in Hz");
1188 return (0); /* success */
1191 uaudio_detach_sub(dev);
1196 uaudio_detach_sub(device_t dev)
1198 struct uaudio_softc *sc = device_get_softc(device_get_parent(dev));
1201 /* disable S/PDIF output, if any */
1202 (void) sc->sc_set_spdif_fn(sc, 0);
1205 if (sc->sc_pcm_registered) {
1206 error = pcm_unregister(dev);
1208 if (sc->sc_mixer_init) {
1209 error = mixer_uninit(dev);
1214 device_printf(dev, "Waiting for sound application to exit!\n");
1215 usb_pause_mtx(NULL, 2 * hz);
1216 goto repeat; /* try again */
1218 return (0); /* success */
1222 uaudio_detach(device_t dev)
1224 struct uaudio_softc *sc = device_get_softc(dev);
1227 * Stop USB transfers early so that any audio applications
1228 * will time out and close opened /dev/dspX.Y device(s), if
1231 usb_proc_explore_lock(sc->sc_udev);
1232 sc->sc_play_chan.operation = CHAN_OP_DRAIN;
1233 sc->sc_rec_chan.operation = CHAN_OP_DRAIN;
1234 usb_proc_explore_mwait(sc->sc_udev,
1235 &sc->sc_config_msg[0], &sc->sc_config_msg[1]);
1236 usb_proc_explore_unlock(sc->sc_udev);
1238 usbd_transfer_unsetup(sc->sc_play_chan.xfer, UAUDIO_NCHANBUFS + 1);
1239 usbd_transfer_unsetup(sc->sc_rec_chan.xfer, UAUDIO_NCHANBUFS + 1);
1241 uaudio_hid_detach(sc);
1243 if (bus_generic_detach(dev) != 0) {
1244 DPRINTF("detach failed!\n");
1246 sbuf_delete(&sc->sc_sndstat);
1247 sc->sc_sndstat_valid = 0;
1251 /* free mixer data */
1253 uaudio_mixer_ctl_free(sc);
1259 uaudio_get_buffer_size(struct uaudio_chan *ch, uint8_t alt)
1261 struct uaudio_chan_alt *chan_alt = &ch->usb_alt[alt];
1262 /* We use 2 times 8ms of buffer */
1263 uint32_t buf_size = chan_alt->sample_size *
1264 howmany(chan_alt->sample_rate * (UAUDIO_NFRAMES / 8), 1000);
1269 uaudio_configure_msg_sub(struct uaudio_softc *sc,
1270 struct uaudio_chan *chan, int dir)
1272 struct uaudio_chan_alt *chan_alt;
1281 if (chan->num_alt <= 0)
1286 usb_proc_explore_lock(sc->sc_udev);
1287 operation = chan->operation;
1288 chan->operation = CHAN_OP_NONE;
1289 usb_proc_explore_unlock(sc->sc_udev);
1291 mtx_lock(chan->pcm_mtx);
1292 if (chan->cur_alt != chan->set_alt)
1293 set_alt = chan->set_alt;
1295 set_alt = CHAN_MAX_ALT;
1296 mtx_unlock(chan->pcm_mtx);
1298 if (set_alt >= chan->num_alt)
1301 chan_alt = chan->usb_alt + set_alt;
1303 usbd_transfer_unsetup(chan->xfer, UAUDIO_NCHANBUFS + 1);
1305 err = usbd_set_alt_interface_index(sc->sc_udev,
1306 chan_alt->iface_index, chan_alt->iface_alt_index);
1308 DPRINTF("setting of alternate index failed: %s!\n",
1314 * Only set the sample rate if the channel reports that it
1315 * supports the frequency control.
1318 if (sc->sc_audio_rev >= UAUDIO_VERSION_30) {
1320 } else if (sc->sc_audio_rev >= UAUDIO_VERSION_20) {
1323 for (x = 0; x != 256; x++) {
1324 if (dir == PCMDIR_PLAY) {
1325 if (!(sc->sc_mixer_clocks.bit_output[x / 8] &
1330 if (!(sc->sc_mixer_clocks.bit_input[x / 8] &
1336 if (uaudio20_set_speed(sc->sc_udev,
1337 sc->sc_mixer_iface_no, x, chan_alt->sample_rate)) {
1339 * If the endpoint is adaptive setting
1340 * the speed may fail.
1342 DPRINTF("setting of sample rate failed! "
1343 "(continuing anyway)\n");
1346 } else if (chan_alt->p_sed.v1->bmAttributes & UA_SED_FREQ_CONTROL) {
1347 if (uaudio_set_speed(sc->sc_udev,
1348 chan_alt->p_ed1->bEndpointAddress, chan_alt->sample_rate)) {
1350 * If the endpoint is adaptive setting the
1353 DPRINTF("setting of sample rate failed! "
1354 "(continuing anyway)\n");
1357 if (usbd_transfer_setup(sc->sc_udev, &chan_alt->iface_index, chan->xfer,
1358 chan_alt->usb_cfg, UAUDIO_NCHANBUFS + 1, chan, chan->pcm_mtx)) {
1359 DPRINTF("could not allocate USB transfers!\n");
1363 fps = usbd_get_isoc_fps(sc->sc_udev);
1366 /* FULL speed USB */
1367 frames = uaudio_buffer_ms;
1369 /* HIGH speed USB */
1370 frames = uaudio_buffer_ms * 8;
1373 fps_shift = usbd_xfer_get_fps_shift(chan->xfer[0]);
1375 /* down shift number of frames per second, if any */
1377 frames >>= fps_shift;
1379 /* bytes per frame should not be zero */
1380 chan->bytes_per_frame[0] =
1381 ((chan_alt->sample_rate / fps) * chan_alt->sample_size);
1382 chan->bytes_per_frame[1] = howmany(chan_alt->sample_rate, fps) *
1383 chan_alt->sample_size;
1385 /* setup data rate dithering, if any */
1386 chan->frames_per_second = fps;
1387 chan->sample_rem = chan_alt->sample_rate % fps;
1388 chan->sample_curr = 0;
1390 /* compute required buffer size */
1391 buf_size = (chan->bytes_per_frame[1] * frames);
1393 if (buf_size > (chan->end - chan->start)) {
1394 DPRINTF("buffer size is too big\n");
1398 chan->intr_frames = frames;
1400 DPRINTF("fps=%d sample_rem=%d\n", (int)fps, (int)chan->sample_rem);
1402 if (chan->intr_frames == 0) {
1403 DPRINTF("frame shift is too high!\n");
1407 mtx_lock(chan->pcm_mtx);
1408 chan->cur_alt = set_alt;
1409 mtx_unlock(chan->pcm_mtx);
1412 #if (UAUDIO_NCHANBUFS != 2)
1413 #error "please update code"
1415 switch (operation) {
1417 mtx_lock(chan->pcm_mtx);
1418 usbd_transfer_start(chan->xfer[0]);
1419 usbd_transfer_start(chan->xfer[1]);
1420 mtx_unlock(chan->pcm_mtx);
1423 mtx_lock(chan->pcm_mtx);
1424 usbd_transfer_stop(chan->xfer[0]);
1425 usbd_transfer_stop(chan->xfer[1]);
1426 mtx_unlock(chan->pcm_mtx);
1434 usbd_transfer_unsetup(chan->xfer, UAUDIO_NCHANBUFS + 1);
1436 mtx_lock(chan->pcm_mtx);
1437 chan->cur_alt = CHAN_MAX_ALT;
1438 mtx_unlock(chan->pcm_mtx);
1442 uaudio_configure_msg(struct usb_proc_msg *pm)
1444 struct uaudio_softc *sc = ((struct uaudio_configure_msg *)pm)->sc;
1446 usb_proc_explore_unlock(sc->sc_udev);
1447 uaudio_configure_msg_sub(sc, &sc->sc_play_chan, PCMDIR_PLAY);
1448 uaudio_configure_msg_sub(sc, &sc->sc_rec_chan, PCMDIR_REC);
1449 usb_proc_explore_lock(sc->sc_udev);
1452 /*========================================================================*
1453 * AS - Audio Stream - routines
1454 *========================================================================*/
1458 uaudio_chan_dump_ep_desc(const usb_endpoint_descriptor_audio_t *ed)
1461 DPRINTF("endpoint=%p bLength=%d bDescriptorType=%d \n"
1462 "bEndpointAddress=%d bmAttributes=0x%x \n"
1463 "wMaxPacketSize=%d bInterval=%d \n"
1464 "bRefresh=%d bSynchAddress=%d\n",
1465 ed, ed->bLength, ed->bDescriptorType,
1466 ed->bEndpointAddress, ed->bmAttributes,
1467 UGETW(ed->wMaxPacketSize), ed->bInterval,
1468 UEP_HAS_REFRESH(ed) ? ed->bRefresh : 0,
1469 UEP_HAS_SYNCADDR(ed) ? ed->bSynchAddress : 0);
1476 * The following is a workaround for broken no-name USB audio devices
1477 * sold by dealextreme called "3D sound". The problem is that the
1478 * manufacturer computed wMaxPacketSize is too small to hold the
1479 * actual data sent. In other words the device sometimes sends more
1480 * data than it actually reports it can send in a single isochronous
1484 uaudio_record_fix_fs(usb_endpoint_descriptor_audio_t *ep,
1485 uint32_t xps, uint32_t add)
1489 mps = UGETW(ep->wMaxPacketSize);
1492 * If the device indicates it can send more data than what the
1493 * sample rate indicates, we apply the workaround.
1497 /* allow additional data */
1500 /* check against the maximum USB 1.x length */
1504 /* check if we should do an update */
1506 /* simply update the wMaxPacketSize field */
1507 USETW(ep->wMaxPacketSize, xps);
1508 DPRINTF("Workaround: Updated wMaxPacketSize "
1509 "from %d to %d bytes.\n",
1510 (int)mps, (int)xps);
1516 uaudio20_check_rate(struct usb_device *udev, uint8_t iface_no,
1517 uint8_t clockid, uint32_t rate)
1519 struct usb_device_request req;
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);
1533 USETW(req.wLength, 255);
1535 error = usbd_do_request_flags(udev, NULL, &req, data,
1536 USB_SHORT_XFER_OK, &actlen, USB_DEFAULT_TIMEOUT);
1538 if (error != 0 || actlen < 2)
1539 return (USB_ERR_INVAL);
1541 rates = data[0] | (data[1] << 8);
1542 actlen = (actlen - 2) / 12;
1544 if (rates > actlen) {
1545 DPRINTF("Too many rates\n");
1549 for (x = 0; x != rates; x++) {
1550 uint32_t min = UGETDW(data + 2 + (12 * x));
1551 uint32_t max = UGETDW(data + 6 + (12 * x));
1552 uint32_t res = UGETDW(data + 10 + (12 * x));
1555 DPRINTF("Zero residue\n");
1560 DPRINTF("Swapped max and min\n");
1567 if (rate >= min && rate <= max &&
1568 (((rate - min) % res) == 0)) {
1572 return (USB_ERR_INVAL);
1576 uaudio_chan_fill_info_sub(struct uaudio_softc *sc, struct usb_device *udev,
1577 uint32_t rate, uint8_t channels, uint8_t bit_resolution)
1579 struct usb_descriptor *desc = NULL;
1580 union uaudio_asid asid = { NULL };
1581 union uaudio_asf1d asf1d = { NULL };
1582 union uaudio_sed sed = { NULL };
1583 struct usb_midi_streaming_endpoint_descriptor *msid = NULL;
1584 usb_endpoint_descriptor_audio_t *ed1 = NULL;
1585 const struct usb_audio_control_descriptor *acdp = NULL;
1586 struct usb_config_descriptor *cd = usbd_get_config_descriptor(udev);
1587 struct usb_interface_descriptor *id;
1588 const struct uaudio_format *p_fmt = NULL;
1589 struct uaudio_chan *chan;
1590 struct uaudio_chan_alt *chan_alt;
1592 uint16_t curidx = 0xFFFF;
1593 uint16_t lastidx = 0xFFFF;
1594 uint16_t alt_index = 0;
1595 uint16_t audio_rev = 0;
1599 uint8_t bBitResolution;
1600 uint8_t audio_if = 0;
1601 uint8_t midi_if = 0;
1602 uint8_t uma_if_class;
1604 while ((desc = usb_desc_foreach(cd, desc))) {
1606 if ((desc->bDescriptorType == UDESC_INTERFACE) &&
1607 (desc->bLength >= sizeof(*id))) {
1611 if (id->bInterfaceNumber != lastidx) {
1612 lastidx = id->bInterfaceNumber;
1620 if ((!(sc->sc_hid.flags & UAUDIO_HID_VALID)) &&
1621 (id->bInterfaceClass == UICLASS_HID) &&
1622 (id->bInterfaceSubClass == 0) &&
1623 (id->bInterfaceProtocol == 0) &&
1625 usbd_get_iface(udev, curidx) != NULL) {
1626 DPRINTF("Found HID interface at %d\n",
1628 sc->sc_hid.flags |= UAUDIO_HID_VALID;
1629 sc->sc_hid.iface_index = curidx;
1633 ((id->bInterfaceClass == UICLASS_AUDIO) ||
1634 ((id->bInterfaceClass == UICLASS_VENDOR) &&
1635 (sc->sc_uq_au_vendor_class != 0)));
1637 if ((uma_if_class != 0) &&
1638 (id->bInterfaceSubClass == UISUBCLASS_AUDIOSTREAM)) {
1644 if ((uma_if_class != 0) &&
1645 (id->bInterfaceSubClass == UISUBCLASS_MIDISTREAM)) {
1648 * XXX could allow multiple MIDI interfaces
1652 if ((sc->sc_midi_chan.valid == 0) &&
1653 (usbd_get_iface(udev, curidx) != NULL)) {
1654 sc->sc_midi_chan.iface_index = curidx;
1655 sc->sc_midi_chan.iface_alt_index = alt_index;
1656 sc->sc_midi_chan.valid = 1;
1667 * There can only be one USB audio instance
1668 * per USB device. Grab all USB audio
1669 * interfaces on this USB device so that we
1670 * don't attach USB audio twice:
1672 if (alt_index == 0 && curidx != sc->sc_mixer_iface_index &&
1673 (id->bInterfaceClass == UICLASS_AUDIO || audio_if != 0 ||
1675 usbd_set_parent_iface(sc->sc_udev, curidx,
1676 sc->sc_mixer_iface_index);
1680 if (audio_if == 0) {
1682 if ((acdp == NULL) &&
1683 (desc->bDescriptorType == UDESC_CS_INTERFACE) &&
1684 (desc->bDescriptorSubtype == UDESCSUB_AC_HEADER) &&
1685 (desc->bLength >= sizeof(*acdp))) {
1686 acdp = (void *)desc;
1687 audio_rev = UGETW(acdp->bcdADC);
1690 msid = (void *)desc;
1692 /* get the maximum number of embedded jacks in use, if any */
1693 if (msid->bLength >= sizeof(*msid) &&
1694 msid->bDescriptorType == UDESC_CS_ENDPOINT &&
1695 msid->bDescriptorSubtype == MS_GENERAL &&
1696 msid->bNumEmbMIDIJack > sc->sc_midi_chan.max_emb_jack) {
1697 sc->sc_midi_chan.max_emb_jack = msid->bNumEmbMIDIJack;
1701 * Don't collect any USB audio descriptors if
1702 * this is not an USB audio stream interface.
1707 if ((acdp != NULL) &&
1708 (desc->bDescriptorType == UDESC_CS_INTERFACE) &&
1709 (desc->bDescriptorSubtype == AS_GENERAL) &&
1710 (asid.v1 == NULL)) {
1711 if (audio_rev >= UAUDIO_VERSION_30) {
1713 } else if (audio_rev >= UAUDIO_VERSION_20) {
1714 if (desc->bLength >= sizeof(*asid.v2)) {
1715 asid.v2 = (void *)desc;
1718 if (desc->bLength >= sizeof(*asid.v1)) {
1719 asid.v1 = (void *)desc;
1723 if ((acdp != NULL) &&
1724 (desc->bDescriptorType == UDESC_CS_INTERFACE) &&
1725 (desc->bDescriptorSubtype == FORMAT_TYPE) &&
1726 (asf1d.v1 == NULL)) {
1727 if (audio_rev >= UAUDIO_VERSION_30) {
1729 } else if (audio_rev >= UAUDIO_VERSION_20) {
1730 if (desc->bLength >= sizeof(*asf1d.v2))
1731 asf1d.v2 = (void *)desc;
1733 if (desc->bLength >= sizeof(*asf1d.v1)) {
1734 asf1d.v1 = (void *)desc;
1736 if (asf1d.v1->bFormatType != FORMAT_TYPE_I) {
1737 DPRINTFN(11, "ignored bFormatType = %d\n",
1738 asf1d.v1->bFormatType);
1742 if (desc->bLength < (sizeof(*asf1d.v1) +
1743 ((asf1d.v1->bSamFreqType == 0) ? 6 :
1744 (asf1d.v1->bSamFreqType * 3)))) {
1745 DPRINTFN(11, "invalid descriptor, "
1753 if ((desc->bDescriptorType == UDESC_ENDPOINT) &&
1754 (desc->bLength >= UEP_MINSIZE) &&
1757 if (UE_GET_XFERTYPE(ed1->bmAttributes) != UE_ISOCHRONOUS) {
1762 if ((acdp != NULL) &&
1763 (desc->bDescriptorType == UDESC_CS_ENDPOINT) &&
1764 (desc->bDescriptorSubtype == AS_GENERAL) &&
1766 if (audio_rev >= UAUDIO_VERSION_30) {
1768 } else if (audio_rev >= UAUDIO_VERSION_20) {
1769 if (desc->bLength >= sizeof(*sed.v2))
1770 sed.v2 = (void *)desc;
1772 if (desc->bLength >= sizeof(*sed.v1))
1773 sed.v1 = (void *)desc;
1776 if (asid.v1 == NULL || asf1d.v1 == NULL ||
1777 ed1 == NULL || sed.v1 == NULL) {
1778 /* need more descriptors */
1782 ep_dir = UE_GET_DIR(ed1->bEndpointAddress);
1784 /* We ignore sync endpoint information until further. */
1786 if (audio_rev >= UAUDIO_VERSION_30) {
1788 } else if (audio_rev >= UAUDIO_VERSION_20) {
1792 dwFormat = UGETDW(asid.v2->bmFormats);
1793 bChannels = asid.v2->bNrChannels;
1794 bBitResolution = asf1d.v2->bSubslotSize * 8;
1796 if ((bChannels != channels) ||
1797 (bBitResolution != bit_resolution)) {
1798 DPRINTF("Wrong number of channels\n");
1802 for (p_fmt = uaudio20_formats;
1803 p_fmt->wFormat != 0; p_fmt++) {
1804 if ((p_fmt->wFormat & dwFormat) &&
1805 (p_fmt->bPrecision == bBitResolution))
1809 if (p_fmt->wFormat == 0) {
1810 DPRINTF("Unsupported audio format\n");
1814 for (x = 0; x != 256; x++) {
1815 if (ep_dir == UE_DIR_OUT) {
1816 if (!(sc->sc_mixer_clocks.bit_output[x / 8] &
1821 if (!(sc->sc_mixer_clocks.bit_input[x / 8] &
1827 DPRINTF("Checking clock ID=%d\n", x);
1829 if (uaudio20_check_rate(udev,
1830 sc->sc_mixer_iface_no, x, rate)) {
1831 DPRINTF("Unsupported sampling "
1832 "rate, id=%d\n", x);
1839 wFormat = UGETW(asid.v1->wFormatTag);
1840 bChannels = UAUDIO_MAX_CHAN(asf1d.v1->bNrChannels);
1841 bBitResolution = asf1d.v1->bSubFrameSize * 8;
1843 if (asf1d.v1->bSamFreqType == 0) {
1844 DPRINTFN(16, "Sample rate: %d-%dHz\n",
1845 UA_SAMP_LO(asf1d.v1),
1846 UA_SAMP_HI(asf1d.v1));
1848 if ((rate >= UA_SAMP_LO(asf1d.v1)) &&
1849 (rate <= UA_SAMP_HI(asf1d.v1)))
1853 for (x = 0; x < asf1d.v1->bSamFreqType; x++) {
1854 DPRINTFN(16, "Sample rate = %dHz\n",
1855 UA_GETSAMP(asf1d.v1, x));
1857 if (rate == UA_GETSAMP(asf1d.v1, x))
1864 for (p_fmt = uaudio10_formats;
1865 p_fmt->wFormat != 0; p_fmt++) {
1866 if ((p_fmt->wFormat == wFormat) &&
1867 (p_fmt->bPrecision == bBitResolution))
1870 if (p_fmt->wFormat == 0) {
1871 DPRINTF("Unsupported audio format\n");
1875 if ((bChannels != channels) ||
1876 (bBitResolution != bit_resolution)) {
1877 DPRINTF("Wrong number of channels\n");
1882 chan = (ep_dir == UE_DIR_IN) ?
1883 &sc->sc_rec_chan : &sc->sc_play_chan;
1885 if (usbd_get_iface(udev, curidx) == NULL) {
1886 DPRINTF("Interface is not valid\n");
1889 if (chan->num_alt == CHAN_MAX_ALT) {
1890 DPRINTF("Too many alternate settings\n");
1894 chan->cur_alt = CHAN_MAX_ALT;
1896 chan_alt = &chan->usb_alt[chan->num_alt++];
1899 uaudio_chan_dump_ep_desc(ed1);
1901 DPRINTF("Sample rate = %dHz, channels = %d, "
1902 "bits = %d, format = %s\n", rate, channels,
1903 bit_resolution, p_fmt->description);
1905 chan_alt->sample_rate = rate;
1906 chan_alt->p_asf1d = asf1d;
1907 chan_alt->p_ed1 = ed1;
1908 chan_alt->p_fmt = p_fmt;
1909 chan_alt->p_sed = sed;
1910 chan_alt->iface_index = curidx;
1911 chan_alt->iface_alt_index = alt_index;
1913 if (ep_dir == UE_DIR_IN)
1914 chan_alt->usb_cfg = uaudio_cfg_record;
1916 chan_alt->usb_cfg = uaudio_cfg_play;
1918 chan_alt->sample_size = (UAUDIO_MAX_CHAN(channels) *
1919 p_fmt->bPrecision) / 8;
1920 chan_alt->channels = channels;
1922 if (ep_dir == UE_DIR_IN &&
1923 usbd_get_speed(udev) == USB_SPEED_FULL) {
1924 uaudio_record_fix_fs(ed1,
1925 chan_alt->sample_size * (rate / 1000),
1926 chan_alt->sample_size * (rate / 4000));
1929 /* setup play/record format */
1931 format = chan_alt->p_fmt->freebsd_fmt;
1933 /* get default SND_FORMAT() */
1934 format = SND_FORMAT(format, chan_alt->channels, 0);
1936 switch (chan_alt->channels) {
1940 /* mono and stereo */
1943 /* surround and more */
1944 temp_fmt = feeder_matrix_default_format(format);
1945 /* if multichannel, then format can be zero */
1951 /* check if format is not supported */
1953 DPRINTF("The selected audio format is not supported\n");
1957 if (chan->num_alt > 1) {
1958 /* we only accumulate one format at different sample rates */
1959 if (chan->pcm_format[0] != format) {
1960 DPRINTF("Multiple formats is not supported\n");
1964 /* ignore if duplicate sample rate entry */
1965 if (rate == chan->usb_alt[chan->num_alt - 2].sample_rate) {
1966 DPRINTF("Duplicate sample rate detected\n");
1971 chan->pcm_cap.fmtlist = chan->pcm_format;
1972 chan->pcm_cap.fmtlist[0] = format;
1974 /* check if device needs bitperfect */
1975 if (chan_alt->channels > UAUDIO_MATRIX_MAX)
1976 sc->sc_pcm_bitperfect = 1;
1978 if (rate < chan->pcm_cap.minspeed || chan->pcm_cap.minspeed == 0)
1979 chan->pcm_cap.minspeed = rate;
1980 if (rate > chan->pcm_cap.maxspeed || chan->pcm_cap.maxspeed == 0)
1981 chan->pcm_cap.maxspeed = rate;
1983 if (sc->sc_sndstat_valid != 0) {
1984 sbuf_printf(&sc->sc_sndstat, "\n\t"
1985 "mode %d.%d:(%s) %dch, %dbit, %s, %dHz",
1987 (ep_dir == UE_DIR_IN) ? "input" : "output",
1988 channels, p_fmt->bPrecision,
1989 p_fmt->description, rate);
1998 /* This structure defines all the supported rates. */
2000 static const uint32_t uaudio_rate_list[CHAN_MAX_ALT] = {
2025 uaudio_chan_fill_info(struct uaudio_softc *sc, struct usb_device *udev)
2027 uint32_t rate = uaudio_default_rate;
2029 uint8_t bits = uaudio_default_bits;
2031 uint8_t channels = uaudio_default_channels;
2035 if ((bits == 0) || (bits > 32)) {
2036 /* set a valid value */
2039 if (channels == 0) {
2040 switch (usbd_get_speed(udev)) {
2042 case USB_SPEED_FULL:
2044 * Due to high bandwidth usage and problems
2045 * with HIGH-speed split transactions we
2046 * disable surround setups on FULL-speed USB
2052 channels = UAUDIO_CHANNELS_MAX;
2055 } else if (channels > UAUDIO_CHANNELS_MAX)
2056 channels = UAUDIO_CHANNELS_MAX;
2058 if (sbuf_new(&sc->sc_sndstat, NULL, 4096, SBUF_AUTOEXTEND))
2059 sc->sc_sndstat_valid = 1;
2061 /* try to search for a valid config */
2063 for (x = channels; x; x--) {
2064 for (y = bits; y; y -= 8) {
2066 /* try user defined rate, if any */
2068 uaudio_chan_fill_info_sub(sc, udev, rate, x, y);
2070 /* try find a matching rate, if any */
2071 for (z = 0; uaudio_rate_list[z]; z++)
2072 uaudio_chan_fill_info_sub(sc, udev, uaudio_rate_list[z], x, y);
2075 if (sc->sc_sndstat_valid)
2076 sbuf_finish(&sc->sc_sndstat);
2080 uaudio_chan_play_sync_callback(struct usb_xfer *xfer, usb_error_t error)
2082 struct uaudio_chan *ch = usbd_xfer_softc(xfer);
2083 struct usb_page_cache *pc;
2084 uint64_t sample_rate;
2091 usbd_xfer_status(xfer, &actlen, NULL, NULL, &nframes);
2093 switch (USB_GET_STATE(xfer)) {
2094 case USB_ST_TRANSFERRED:
2096 DPRINTFN(6, "transferred %d bytes\n", actlen);
2100 len = usbd_xfer_frame_len(xfer, 0);
2103 if (len > sizeof(buf))
2106 memset(buf, 0, sizeof(buf));
2108 pc = usbd_xfer_get_frame(xfer, 0);
2109 usbd_copy_out(pc, 0, buf, len);
2113 DPRINTF("Value = 0x%08x\n", (int)temp);
2115 /* auto-detect SYNC format */
2120 /* check for no data */
2127 sample_rate = ch->usb_alt[ch->cur_alt].sample_rate;
2130 while (temp < (sample_rate - (sample_rate / 4)))
2133 while (temp > (sample_rate + (sample_rate / 2)))
2136 DPRINTF("Comparing %d Hz :: %d Hz\n",
2137 (int)temp, (int)sample_rate);
2140 * Use feedback value as fallback when there is no
2141 * recording channel:
2143 if (ch->priv_sc->sc_rec_chan.num_alt == 0) {
2144 int32_t jitter_max = howmany(sample_rate, 16000);
2147 * Range check the jitter values to avoid
2148 * bogus sample rate adjustments. The expected
2149 * deviation should not be more than 1Hz per
2150 * second. The USB v2.0 specification also
2151 * mandates this requirement. Refer to chapter
2152 * 5.12.4.2 about feedback.
2154 ch->jitter_curr = temp - sample_rate;
2155 if (ch->jitter_curr > jitter_max)
2156 ch->jitter_curr = jitter_max;
2157 else if (ch->jitter_curr < -jitter_max)
2158 ch->jitter_curr = -jitter_max;
2160 ch->feedback_rate = temp;
2164 usbd_xfer_set_frames(xfer, 1);
2165 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_framelen(xfer));
2166 usbd_transfer_submit(xfer);
2169 default: /* Error */
2175 uaudio_chan_is_async(struct uaudio_chan *ch, uint8_t alt)
2177 uint8_t attr = ch->usb_alt[alt].p_ed1->bmAttributes;
2178 return (UE_GET_ISO_TYPE(attr) == UE_ISO_ASYNC);
2182 uaudio_chan_play_callback(struct usb_xfer *xfer, usb_error_t error)
2184 struct uaudio_chan *ch = usbd_xfer_softc(xfer);
2185 struct uaudio_chan *ch_rec;
2186 struct usb_page_cache *pc;
2189 uint32_t blockcount;
2196 if (ch->running == 0 || ch->start == ch->end) {
2197 DPRINTF("not running or no buffer!\n");
2201 /* check if there is a record channel */
2202 if (ch->priv_sc->sc_rec_chan.num_alt > 0)
2203 ch_rec = &ch->priv_sc->sc_rec_chan;
2207 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL);
2209 switch (USB_GET_STATE(xfer)) {
2212 if (ch_rec != NULL) {
2213 /* reset receive jitter counters */
2214 mtx_lock(ch_rec->pcm_mtx);
2215 ch_rec->jitter_curr = 0;
2216 ch_rec->jitter_rem = 0;
2217 mtx_unlock(ch_rec->pcm_mtx);
2220 /* reset transmit jitter counters */
2221 ch->jitter_curr = 0;
2225 case USB_ST_TRANSFERRED:
2226 if (actlen < sumlen) {
2227 DPRINTF("short transfer, "
2228 "%d of %d bytes\n", actlen, sumlen);
2230 chn_intr(ch->pcm_ch);
2233 * Check for asynchronous playback endpoint and that
2234 * the playback endpoint is properly configured:
2236 if (ch_rec != NULL &&
2237 uaudio_chan_is_async(ch, ch->cur_alt) != 0) {
2238 mtx_lock(ch_rec->pcm_mtx);
2239 if (ch_rec->cur_alt < ch_rec->num_alt) {
2243 /* translate receive jitter into transmit jitter */
2244 tx_jitter = ch->usb_alt[ch->cur_alt].sample_rate;
2245 tx_jitter = (tx_jitter * ch_rec->jitter_curr) +
2248 /* reset receive jitter counters */
2249 ch_rec->jitter_curr = 0;
2250 ch_rec->jitter_rem = 0;
2252 /* compute exact number of transmit jitter samples */
2253 rx_rate = ch_rec->usb_alt[ch_rec->cur_alt].sample_rate;
2254 ch->jitter_curr += tx_jitter / rx_rate;
2255 ch->jitter_rem = tx_jitter % rx_rate;
2257 mtx_unlock(ch_rec->pcm_mtx);
2260 /* start the SYNC transfer one time per second, if any */
2261 ch->intr_counter += ch->intr_frames;
2262 if (ch->intr_counter >= ch->frames_per_second) {
2263 ch->intr_counter -= ch->frames_per_second;
2264 usbd_transfer_start(ch->xfer[UAUDIO_NCHANBUFS]);
2267 mfl = usbd_xfer_max_framelen(xfer);
2269 if (ch->bytes_per_frame[1] > mfl) {
2270 DPRINTF("bytes per transfer, %d, "
2271 "exceeds maximum, %d!\n",
2272 ch->bytes_per_frame[1],
2277 blockcount = ch->intr_frames;
2279 /* setup number of frames */
2280 usbd_xfer_set_frames(xfer, blockcount);
2282 /* get sample size */
2283 sample_size = ch->usb_alt[ch->cur_alt].sample_size;
2285 /* reset total length */
2288 /* setup frame lengths */
2289 for (n = 0; n != blockcount; n++) {
2292 ch->sample_curr += ch->sample_rem;
2293 if (ch->sample_curr >= ch->frames_per_second) {
2294 ch->sample_curr -= ch->frames_per_second;
2295 frame_len = ch->bytes_per_frame[1];
2297 frame_len = ch->bytes_per_frame[0];
2300 /* handle free running clock case */
2301 if (ch->jitter_curr > 0 &&
2302 (frame_len + sample_size) <= mfl) {
2303 DPRINTFN(6, "sending one sample more\n");
2305 frame_len += sample_size;
2306 } else if (ch->jitter_curr < 0 &&
2307 frame_len >= sample_size) {
2308 DPRINTFN(6, "sending one sample less\n");
2310 frame_len -= sample_size;
2312 usbd_xfer_set_frame_len(xfer, n, frame_len);
2316 DPRINTFN(6, "transferring %d bytes\n", total);
2320 pc = usbd_xfer_get_frame(xfer, 0);
2323 n = (ch->end - ch->cur);
2327 usbd_copy_in(pc, offset, ch->cur, n);
2333 if (ch->cur >= ch->end)
2334 ch->cur = ch->start;
2336 usbd_transfer_submit(xfer);
2339 default: /* Error */
2340 if (error != USB_ERR_CANCELLED)
2347 uaudio_chan_record_sync_callback(struct usb_xfer *xfer, usb_error_t error)
2353 uaudio_chan_record_callback(struct usb_xfer *xfer, usb_error_t error)
2355 struct uaudio_chan *ch = usbd_xfer_softc(xfer);
2356 struct usb_page_cache *pc;
2367 if (ch->start == ch->end) {
2368 DPRINTF("no buffer!\n");
2372 usbd_xfer_status(xfer, &actlen, NULL, NULL, &nframes);
2373 mfl = usbd_xfer_max_framelen(xfer);
2375 switch (USB_GET_STATE(xfer)) {
2376 case USB_ST_TRANSFERRED:
2379 pc = usbd_xfer_get_frame(xfer, 0);
2381 /* try to compute the number of expected bytes */
2382 ch->sample_curr += (ch->sample_rem * ch->intr_frames);
2384 /* compute number of expected bytes */
2385 expected_bytes = (ch->intr_frames * ch->bytes_per_frame[0]) +
2386 ((ch->sample_curr / ch->frames_per_second) *
2387 (ch->bytes_per_frame[1] - ch->bytes_per_frame[0]));
2389 /* keep remainder */
2390 ch->sample_curr %= ch->frames_per_second;
2392 /* get current sample size */
2393 sample_size = ch->usb_alt[ch->cur_alt].sample_size;
2395 for (n = 0; n != nframes; n++) {
2396 uint32_t offset1 = offset0;
2398 len = usbd_xfer_frame_len(xfer, n);
2400 /* make sure we only receive complete samples */
2401 len = len - (len % sample_size);
2403 /* subtract bytes received from expected payload */
2404 expected_bytes -= len;
2406 /* don't receive data when not ready */
2407 if (ch->running == 0 || ch->cur_alt != ch->set_alt)
2410 /* fill ring buffer with samples, if any */
2413 m = (ch->end - ch->cur);
2418 usbd_copy_out(pc, offset1, ch->cur, m);
2424 if (ch->cur >= ch->end)
2425 ch->cur = ch->start;
2431 /* update current jitter */
2432 ch->jitter_curr -= (expected_bytes / sample_size);
2434 /* don't allow a huge amount of jitter to accumulate */
2435 nframes = 2 * ch->intr_frames;
2437 /* range check current jitter */
2438 if (ch->jitter_curr < -nframes)
2439 ch->jitter_curr = -nframes;
2440 else if (ch->jitter_curr > nframes)
2441 ch->jitter_curr = nframes;
2443 DPRINTFN(6, "transferred %d bytes, jitter %d samples\n",
2444 actlen, ch->jitter_curr);
2446 if (ch->running != 0)
2447 chn_intr(ch->pcm_ch);
2451 nframes = ch->intr_frames;
2453 usbd_xfer_set_frames(xfer, nframes);
2454 for (n = 0; n != nframes; n++)
2455 usbd_xfer_set_frame_len(xfer, n, mfl);
2457 usbd_transfer_submit(xfer);
2460 default: /* Error */
2461 if (error != USB_ERR_CANCELLED)
2468 uaudio_chan_init(struct uaudio_softc *sc, struct snd_dbuf *b,
2469 struct pcm_channel *c, int dir)
2471 struct uaudio_chan *ch = ((dir == PCMDIR_PLAY) ?
2472 &sc->sc_play_chan : &sc->sc_rec_chan);
2476 /* store mutex and PCM channel */
2479 ch->pcm_mtx = c->lock;
2481 /* compute worst case buffer */
2484 for (x = 0; x != ch->num_alt; x++) {
2485 uint32_t temp = uaudio_get_buffer_size(ch, x);
2486 if (temp > buf_size)
2490 /* allow double buffering */
2493 DPRINTF("Worst case buffer is %d bytes\n", (int)buf_size);
2495 ch->buf = malloc(buf_size, M_DEVBUF, M_WAITOK | M_ZERO);
2496 if (ch->buf == NULL)
2498 if (sndbuf_setup(b, ch->buf, buf_size) != 0)
2501 ch->start = ch->buf;
2502 ch->end = ch->buf + buf_size;
2505 ch->max_buf = buf_size;
2507 if (ch->pcm_mtx == NULL) {
2508 DPRINTF("ERROR: PCM channels does not have a mutex!\n");
2514 uaudio_chan_free(ch);
2519 uaudio_chan_free(struct uaudio_chan *ch)
2521 if (ch->buf != NULL) {
2522 free(ch->buf, M_DEVBUF);
2525 usbd_transfer_unsetup(ch->xfer, UAUDIO_NCHANBUFS + 1);
2533 uaudio_chan_set_param_blocksize(struct uaudio_chan *ch, uint32_t blocksize)
2535 uint32_t temp = 2 * uaudio_get_buffer_size(ch, ch->set_alt);
2536 sndbuf_setup(ch->pcm_buf, ch->buf, temp);
2541 uaudio_chan_set_param_fragments(struct uaudio_chan *ch, uint32_t blocksize,
2542 uint32_t blockcount)
2548 uaudio_chan_set_param_speed(struct uaudio_chan *ch, uint32_t speed)
2550 struct uaudio_softc *sc;
2555 for (x = 0; x < ch->num_alt; x++) {
2556 if (ch->usb_alt[x].sample_rate < speed) {
2557 /* sample rate is too low */
2565 usb_proc_explore_lock(sc->sc_udev);
2567 usb_proc_explore_unlock(sc->sc_udev);
2569 DPRINTF("Selecting alt %d\n", (int)x);
2571 return (ch->usb_alt[x].sample_rate);
2575 uaudio_chan_getptr(struct uaudio_chan *ch)
2577 return (ch->cur - ch->start);
2580 struct pcmchan_caps *
2581 uaudio_chan_getcaps(struct uaudio_chan *ch)
2583 return (&ch->pcm_cap);
2586 static struct pcmchan_matrix uaudio_chan_matrix_swap_2_0 = {
2587 .id = SND_CHN_MATRIX_DRV,
2593 .type = SND_CHN_T_FR,
2595 SND_CHN_T_MASK_FR | SND_CHN_T_MASK_FC |
2596 SND_CHN_T_MASK_LF | SND_CHN_T_MASK_BR |
2597 SND_CHN_T_MASK_BC | SND_CHN_T_MASK_SR
2601 .type = SND_CHN_T_FL,
2603 SND_CHN_T_MASK_FL | SND_CHN_T_MASK_FC |
2604 SND_CHN_T_MASK_LF | SND_CHN_T_MASK_BL |
2605 SND_CHN_T_MASK_BC | SND_CHN_T_MASK_SL
2608 .type = SND_CHN_T_MAX,
2612 .mask = SND_CHN_T_MASK_FR | SND_CHN_T_MASK_FL,
2613 .offset = { 1, 0, -1, -1, -1, -1, -1, -1, -1,
2614 -1, -1, -1, -1, -1, -1, -1, -1, -1 }
2617 struct pcmchan_matrix *
2618 uaudio_chan_getmatrix(struct uaudio_chan *ch, uint32_t format)
2620 struct uaudio_softc *sc;
2624 if (sc != NULL && sc->sc_uq_audio_swap_lr != 0 &&
2625 AFMT_CHANNEL(format) == 2)
2626 return (&uaudio_chan_matrix_swap_2_0);
2628 return (feeder_matrix_format_map(format));
2632 uaudio_chan_set_param_format(struct uaudio_chan *ch, uint32_t format)
2634 DPRINTF("Selecting format 0x%08x\n", (unsigned int)format);
2639 uaudio_chan_start_sub(struct uaudio_chan *ch)
2641 struct uaudio_softc *sc = ch->priv_sc;
2644 if (ch->operation != CHAN_OP_DRAIN) {
2645 if (ch->cur_alt == ch->set_alt &&
2646 ch->operation == CHAN_OP_NONE &&
2647 mtx_owned(ch->pcm_mtx) != 0) {
2648 /* save doing the explore task */
2651 ch->operation = CHAN_OP_START;
2652 (void)usb_proc_explore_msignal(sc->sc_udev,
2653 &sc->sc_config_msg[0], &sc->sc_config_msg[1]);
2657 usbd_transfer_start(ch->xfer[0]);
2658 usbd_transfer_start(ch->xfer[1]);
2663 uaudio_chan_need_both(struct uaudio_softc *sc)
2665 return (sc->sc_play_chan.num_alt > 0 &&
2666 sc->sc_play_chan.running != 0 &&
2667 uaudio_chan_is_async(&sc->sc_play_chan,
2668 sc->sc_play_chan.set_alt) != 0 &&
2669 sc->sc_rec_chan.num_alt > 0 &&
2670 sc->sc_rec_chan.running == 0);
2674 uaudio_chan_need_none(struct uaudio_softc *sc)
2676 return (sc->sc_play_chan.num_alt > 0 &&
2677 sc->sc_play_chan.running == 0 &&
2678 sc->sc_rec_chan.num_alt > 0 &&
2679 sc->sc_rec_chan.running == 0);
2683 uaudio_chan_start(struct uaudio_chan *ch)
2685 struct uaudio_softc *sc = ch->priv_sc;
2687 /* make operation atomic */
2688 usb_proc_explore_lock(sc->sc_udev);
2690 /* check if not running */
2691 if (ch->running == 0) {
2694 /* get current buffer size */
2695 temp = 2 * uaudio_get_buffer_size(ch, ch->set_alt);
2697 /* set running flag */
2700 /* ensure the hardware buffer is reset */
2701 ch->start = ch->buf;
2702 ch->end = ch->buf + temp;
2705 if (uaudio_chan_need_both(sc)) {
2707 * Start both endpoints because of need for
2708 * jitter information:
2710 uaudio_chan_start_sub(&sc->sc_rec_chan);
2711 uaudio_chan_start_sub(&sc->sc_play_chan);
2713 uaudio_chan_start_sub(ch);
2717 /* exit atomic operation */
2718 usb_proc_explore_unlock(sc->sc_udev);
2722 uaudio_chan_stop_sub(struct uaudio_chan *ch)
2724 struct uaudio_softc *sc = ch->priv_sc;
2727 if (ch->operation != CHAN_OP_DRAIN) {
2728 if (ch->cur_alt == ch->set_alt &&
2729 ch->operation == CHAN_OP_NONE &&
2730 mtx_owned(ch->pcm_mtx) != 0) {
2731 /* save doing the explore task */
2734 ch->operation = CHAN_OP_STOP;
2735 (void)usb_proc_explore_msignal(sc->sc_udev,
2736 &sc->sc_config_msg[0], &sc->sc_config_msg[1]);
2740 usbd_transfer_stop(ch->xfer[0]);
2741 usbd_transfer_stop(ch->xfer[1]);
2746 uaudio_chan_stop(struct uaudio_chan *ch)
2748 struct uaudio_softc *sc = ch->priv_sc;
2750 /* make operation atomic */
2751 usb_proc_explore_lock(sc->sc_udev);
2753 /* check if running */
2754 if (ch->running != 0) {
2755 /* clear running flag */
2758 if (uaudio_chan_need_both(sc)) {
2760 * Leave the endpoints running because we need
2761 * information about jitter!
2763 } else if (uaudio_chan_need_none(sc)) {
2765 * Stop both endpoints in case the one was used for
2766 * jitter information:
2768 uaudio_chan_stop_sub(&sc->sc_rec_chan);
2769 uaudio_chan_stop_sub(&sc->sc_play_chan);
2771 uaudio_chan_stop_sub(ch);
2775 /* exit atomic operation */
2776 usb_proc_explore_unlock(sc->sc_udev);
2779 /*========================================================================*
2780 * AC - Audio Controller - routines
2781 *========================================================================*/
2784 uaudio_mixer_sysctl_handler(SYSCTL_HANDLER_ARGS)
2786 struct uaudio_softc *sc;
2787 struct uaudio_mixer_node *pmc;
2793 sc = (struct uaudio_softc *)oidp->oid_arg1;
2794 hint = oidp->oid_arg2;
2796 if (sc->sc_mixer_lock == NULL)
2799 /* lookup mixer node */
2801 mtx_lock(sc->sc_mixer_lock);
2802 for (pmc = sc->sc_mixer_root; pmc != NULL; pmc = pmc->next) {
2803 for (chan = 0; chan != (int)pmc->nchan; chan++) {
2804 if (pmc->wValue[chan] != -1 &&
2805 pmc->wValue[chan] == hint) {
2806 temp = pmc->wData[chan];
2812 mtx_unlock(sc->sc_mixer_lock);
2814 error = sysctl_handle_int(oidp, &temp, 0, req);
2815 if (error != 0 || req->newptr == NULL)
2818 /* update mixer value */
2820 mtx_lock(sc->sc_mixer_lock);
2822 temp >= pmc->minval &&
2823 temp <= pmc->maxval) {
2825 pmc->wData[chan] = temp;
2826 pmc->update[(chan / 8)] |= (1 << (chan % 8));
2828 /* start the transfer, if not already started */
2829 usbd_transfer_start(sc->sc_mixer_xfer[0]);
2831 mtx_unlock(sc->sc_mixer_lock);
2837 uaudio_mixer_ctl_free(struct uaudio_softc *sc)
2839 struct uaudio_mixer_node *p_mc;
2841 while ((p_mc = sc->sc_mixer_root) != NULL) {
2842 sc->sc_mixer_root = p_mc->next;
2843 free(p_mc, M_USBDEV);
2848 uaudio_mixer_register_sysctl(struct uaudio_softc *sc, device_t dev)
2850 struct uaudio_mixer_node *pmc;
2851 struct sysctl_oid *mixer_tree;
2852 struct sysctl_oid *control_tree;
2857 mixer_tree = SYSCTL_ADD_NODE(device_get_sysctl_ctx(dev),
2858 SYSCTL_CHILDREN(device_get_sysctl_tree(dev)), OID_AUTO, "mixer",
2859 CTLFLAG_RD, NULL, "");
2861 if (mixer_tree == NULL)
2864 for (n = 0, pmc = sc->sc_mixer_root; pmc != NULL;
2865 pmc = pmc->next, n++) {
2867 for (chan = 0; chan < pmc->nchan; chan++) {
2869 if (pmc->nchan > 1) {
2870 snprintf(buf, sizeof(buf), "%s_%d_%d",
2871 pmc->name, n, chan);
2873 snprintf(buf, sizeof(buf), "%s_%d",
2877 control_tree = SYSCTL_ADD_NODE(device_get_sysctl_ctx(dev),
2878 SYSCTL_CHILDREN(mixer_tree), OID_AUTO, buf,
2879 CTLFLAG_RD, NULL, "Mixer control nodes");
2881 if (control_tree == NULL)
2884 SYSCTL_ADD_PROC(device_get_sysctl_ctx(dev),
2885 SYSCTL_CHILDREN(control_tree),
2886 OID_AUTO, "val", CTLTYPE_INT | CTLFLAG_RWTUN, sc,
2888 uaudio_mixer_sysctl_handler, "I", "Current value");
2890 SYSCTL_ADD_INT(device_get_sysctl_ctx(dev),
2891 SYSCTL_CHILDREN(control_tree),
2892 OID_AUTO, "min", CTLFLAG_RD, 0, pmc->minval,
2895 SYSCTL_ADD_INT(device_get_sysctl_ctx(dev),
2896 SYSCTL_CHILDREN(control_tree),
2897 OID_AUTO, "max", CTLFLAG_RD, 0, pmc->maxval,
2900 SYSCTL_ADD_STRING(device_get_sysctl_ctx(dev),
2901 SYSCTL_CHILDREN(control_tree),
2902 OID_AUTO, "desc", CTLFLAG_RD, pmc->desc, 0,
2908 /* M-Audio FastTrack Ultra Mixer Description */
2909 /* Origin: Linux USB Audio driver */
2911 uaudio_mixer_controls_create_ftu(struct uaudio_softc *sc)
2916 memset(&MIX(sc), 0, sizeof(MIX(sc)));
2917 MIX(sc).wIndex = MAKE_WORD(6, sc->sc_mixer_iface_no);
2918 MIX(sc).wValue[0] = MAKE_WORD(8, 0);
2919 MIX(sc).class = UAC_OUTPUT;
2920 MIX(sc).type = MIX_UNSIGNED_16;
2921 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
2922 MIX(sc).name = "effect";
2927 MIX(sc).update[0] = 1;
2928 strlcpy(MIX(sc).desc, "Room1,2,3,Hall1,2,Plate,Delay,Echo", sizeof(MIX(sc).desc));
2929 uaudio_mixer_add_ctl_sub(sc, &MIX(sc));
2931 memset(&MIX(sc), 0, sizeof(MIX(sc)));
2932 MIX(sc).wIndex = MAKE_WORD(5, sc->sc_mixer_iface_no);
2934 for (chx = 0; chx != 8; chx++) {
2935 for (chy = 0; chy != 8; chy++) {
2937 MIX(sc).wValue[0] = MAKE_WORD(chx + 1, chy + 1);
2938 MIX(sc).type = MIX_SIGNED_16;
2939 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
2940 MIX(sc).name = "mix_rec";
2942 MIX(sc).update[0] = 1;
2943 MIX(sc).val_default = 0;
2944 snprintf(MIX(sc).desc, sizeof(MIX(sc).desc),
2945 "AIn%d - Out%d Record Volume", chy + 1, chx + 1);
2947 uaudio_mixer_add_ctl(sc, &MIX(sc));
2949 MIX(sc).wValue[0] = MAKE_WORD(chx + 1, chy + 1 + 8);
2950 MIX(sc).type = MIX_SIGNED_16;
2951 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
2952 MIX(sc).name = "mix_play";
2954 MIX(sc).update[0] = 1;
2955 MIX(sc).val_default = (chx == chy) ? 2 : 0;
2956 snprintf(MIX(sc).desc, sizeof(MIX(sc).desc),
2957 "DIn%d - Out%d Playback Volume", chy + 1, chx + 1);
2959 uaudio_mixer_add_ctl(sc, &MIX(sc));
2963 memset(&MIX(sc), 0, sizeof(MIX(sc)));
2964 MIX(sc).wIndex = MAKE_WORD(6, sc->sc_mixer_iface_no);
2965 MIX(sc).wValue[0] = MAKE_WORD(2, 0);
2966 MIX(sc).class = UAC_OUTPUT;
2967 MIX(sc).type = MIX_SIGNED_8;
2968 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
2969 MIX(sc).name = "effect_vol";
2971 MIX(sc).update[0] = 1;
2973 MIX(sc).maxval = 0x7f;
2976 MIX(sc).update[0] = 1;
2977 strlcpy(MIX(sc).desc, "Effect Volume", sizeof(MIX(sc).desc));
2978 uaudio_mixer_add_ctl_sub(sc, &MIX(sc));
2980 memset(&MIX(sc), 0, sizeof(MIX(sc)));
2981 MIX(sc).wIndex = MAKE_WORD(6, sc->sc_mixer_iface_no);
2982 MIX(sc).wValue[0] = MAKE_WORD(3, 0);
2983 MIX(sc).class = UAC_OUTPUT;
2984 MIX(sc).type = MIX_SIGNED_16;
2985 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
2986 MIX(sc).name = "effect_dur";
2988 MIX(sc).update[0] = 1;
2990 MIX(sc).maxval = 0x7f00;
2991 MIX(sc).mul = 0x7f00;
2993 MIX(sc).update[0] = 1;
2994 strlcpy(MIX(sc).desc, "Effect Duration", sizeof(MIX(sc).desc));
2995 uaudio_mixer_add_ctl_sub(sc, &MIX(sc));
2997 memset(&MIX(sc), 0, sizeof(MIX(sc)));
2998 MIX(sc).wIndex = MAKE_WORD(6, sc->sc_mixer_iface_no);
2999 MIX(sc).wValue[0] = MAKE_WORD(4, 0);
3000 MIX(sc).class = UAC_OUTPUT;
3001 MIX(sc).type = MIX_SIGNED_8;
3002 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3003 MIX(sc).name = "effect_fb";
3005 MIX(sc).update[0] = 1;
3007 MIX(sc).maxval = 0x7f;
3010 MIX(sc).update[0] = 1;
3011 strlcpy(MIX(sc).desc, "Effect Feedback Volume", sizeof(MIX(sc).desc));
3012 uaudio_mixer_add_ctl_sub(sc, &MIX(sc));
3014 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3015 MIX(sc).wIndex = MAKE_WORD(7, sc->sc_mixer_iface_no);
3016 for (chy = 0; chy != 4; chy++) {
3018 MIX(sc).wValue[0] = MAKE_WORD(7, chy + 1);
3019 MIX(sc).type = MIX_SIGNED_16;
3020 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3021 MIX(sc).name = "effect_ret";
3023 MIX(sc).update[0] = 1;
3024 snprintf(MIX(sc).desc, sizeof(MIX(sc).desc),
3025 "Effect Return %d Volume", chy + 1);
3027 uaudio_mixer_add_ctl(sc, &MIX(sc));
3030 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3031 MIX(sc).wIndex = MAKE_WORD(5, sc->sc_mixer_iface_no);
3033 for (chy = 0; chy != 8; chy++) {
3034 MIX(sc).wValue[0] = MAKE_WORD(9, chy + 1);
3035 MIX(sc).type = MIX_SIGNED_16;
3036 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3037 MIX(sc).name = "effect_send";
3039 MIX(sc).update[0] = 1;
3040 snprintf(MIX(sc).desc, sizeof(MIX(sc).desc),
3041 "Effect Send AIn%d Volume", chy + 1);
3043 uaudio_mixer_add_ctl(sc, &MIX(sc));
3045 MIX(sc).wValue[0] = MAKE_WORD(9, chy + 1 + 8);
3046 MIX(sc).type = MIX_SIGNED_16;
3047 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3048 MIX(sc).name = "effect_send";
3050 MIX(sc).update[0] = 1;
3051 snprintf(MIX(sc).desc, sizeof(MIX(sc).desc),
3052 "Effect Send DIn%d Volume", chy + 1);
3054 uaudio_mixer_add_ctl(sc, &MIX(sc));
3059 uaudio_mixer_reload_all(struct uaudio_softc *sc)
3061 struct uaudio_mixer_node *pmc;
3064 if (sc->sc_mixer_lock == NULL)
3067 mtx_lock(sc->sc_mixer_lock);
3068 for (pmc = sc->sc_mixer_root; pmc != NULL; pmc = pmc->next) {
3069 /* use reset defaults for non-oss controlled settings */
3070 if (pmc->ctl == SOUND_MIXER_NRDEVICES)
3072 for (chan = 0; chan < pmc->nchan; chan++)
3073 pmc->update[chan / 8] |= (1 << (chan % 8));
3075 usbd_transfer_start(sc->sc_mixer_xfer[0]);
3077 /* start HID volume keys, if any */
3078 usbd_transfer_start(sc->sc_hid.xfer[0]);
3079 mtx_unlock(sc->sc_mixer_lock);
3083 uaudio_mixer_add_ctl_sub(struct uaudio_softc *sc, struct uaudio_mixer_node *mc)
3085 struct uaudio_mixer_node *p_mc_new =
3086 malloc(sizeof(*p_mc_new), M_USBDEV, M_WAITOK);
3089 if (p_mc_new != NULL) {
3090 memcpy(p_mc_new, mc, sizeof(*p_mc_new));
3091 p_mc_new->next = sc->sc_mixer_root;
3092 sc->sc_mixer_root = p_mc_new;
3093 sc->sc_mixer_count++;
3095 /* set default value for all channels */
3096 for (ch = 0; ch < p_mc_new->nchan; ch++) {
3097 switch (p_mc_new->val_default) {
3100 p_mc_new->wData[ch] = (p_mc_new->maxval + p_mc_new->minval) / 2;
3104 p_mc_new->wData[ch] = p_mc_new->maxval;
3108 p_mc_new->wData[ch] = p_mc_new->minval;
3113 DPRINTF("out of memory\n");
3118 uaudio_mixer_add_ctl(struct uaudio_softc *sc, struct uaudio_mixer_node *mc)
3122 if (mc->class < UAC_NCLASSES) {
3123 DPRINTF("adding %s.%d\n",
3124 uac_names[mc->class], mc->ctl);
3126 DPRINTF("adding %d\n", mc->ctl);
3129 if (mc->type == MIX_ON_OFF) {
3132 } else if (mc->type == MIX_SELECTOR) {
3135 /* determine min and max values */
3137 mc->minval = uaudio_mixer_get(sc->sc_udev,
3138 sc->sc_audio_rev, GET_MIN, mc);
3139 mc->maxval = uaudio_mixer_get(sc->sc_udev,
3140 sc->sc_audio_rev, GET_MAX, mc);
3142 /* check if max and min was swapped */
3144 if (mc->maxval < mc->minval) {
3146 mc->maxval = mc->minval;
3150 /* compute value range */
3151 mc->mul = mc->maxval - mc->minval;
3155 /* compute value alignment */
3156 res = uaudio_mixer_get(sc->sc_udev,
3157 sc->sc_audio_rev, GET_RES, mc);
3159 DPRINTF("Resolution = %d\n", (int)res);
3162 uaudio_mixer_add_ctl_sub(sc, mc);
3165 if (uaudio_debug > 2) {
3168 for (i = 0; i < mc->nchan; i++) {
3169 DPRINTF("[mix] wValue=%04x\n", mc->wValue[0]);
3171 DPRINTF("[mix] wIndex=%04x type=%d ctl='%d' "
3173 mc->wIndex, mc->type, mc->ctl,
3174 mc->minval, mc->maxval);
3180 uaudio_mixer_add_mixer(struct uaudio_softc *sc,
3181 const struct uaudio_terminal_node *iot, int id)
3183 const struct usb_audio_mixer_unit_0 *d0 = iot[id].u.mu_v1;
3184 const struct usb_audio_mixer_unit_1 *d1;
3186 uint32_t bno; /* bit number */
3187 uint32_t p; /* bit number accumulator */
3188 uint32_t mo; /* matching outputs */
3189 uint32_t mc; /* matching channels */
3190 uint32_t ichs; /* input channels */
3191 uint32_t ochs; /* output channels */
3193 uint32_t chs; /* channels */
3197 DPRINTFN(3, "bUnitId=%d bNrInPins=%d\n",
3198 d0->bUnitId, d0->bNrInPins);
3200 /* compute the number of input channels */
3203 for (i = 0; i < d0->bNrInPins; i++) {
3204 ichs += uaudio_mixer_get_cluster(
3205 d0->baSourceId[i], iot).bNrChannels;
3208 d1 = (const void *)(d0->baSourceId + d0->bNrInPins);
3210 /* and the number of output channels */
3212 ochs = d1->bNrChannels;
3214 DPRINTFN(3, "ichs=%d ochs=%d\n", ichs, ochs);
3216 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3218 MIX(sc).wIndex = MAKE_WORD(d0->bUnitId, sc->sc_mixer_iface_no);
3219 uaudio_mixer_determine_class(&iot[id], &MIX(sc));
3220 MIX(sc).type = MIX_SIGNED_16;
3222 if (uaudio_mixer_verify_desc(d0, ((ichs * ochs) + 7) / 8) == NULL)
3225 for (p = i = 0; i < d0->bNrInPins; i++) {
3226 chs = uaudio_mixer_get_cluster(
3227 d0->baSourceId[i], iot).bNrChannels;
3229 for (c = 0; c < chs; c++) {
3231 for (o = 0; o < ochs; o++) {
3232 bno = ((p + c) * ochs) + o;
3233 if (BIT_TEST(d1->bmControls, bno))
3239 if ((mc == chs) && (chs <= MIX_MAX_CHAN)) {
3241 /* repeat bit-scan */
3244 for (c = 0; c < chs; c++) {
3245 for (o = 0; o < ochs; o++) {
3246 bno = ((p + c) * ochs) + o;
3247 if (BIT_TEST(d1->bmControls, bno))
3248 MIX(sc).wValue[mc++] = MAKE_WORD(p + c + 1, o + 1);
3251 MIX(sc).nchan = chs;
3252 uaudio_mixer_add_ctl(sc, &MIX(sc));
3259 uaudio20_mixer_add_mixer(struct uaudio_softc *sc,
3260 const struct uaudio_terminal_node *iot, int id)
3262 const struct usb_audio20_mixer_unit_0 *d0 = iot[id].u.mu_v2;
3263 const struct usb_audio20_mixer_unit_1 *d1;
3265 uint32_t bno; /* bit number */
3266 uint32_t p; /* bit number accumulator */
3267 uint32_t mo; /* matching outputs */
3268 uint32_t mc; /* matching channels */
3269 uint32_t ichs; /* input channels */
3270 uint32_t ochs; /* output channels */
3272 uint32_t chs; /* channels */
3276 DPRINTFN(3, "bUnitId=%d bNrInPins=%d\n",
3277 d0->bUnitId, d0->bNrInPins);
3279 /* compute the number of input channels */
3282 for (i = 0; i < d0->bNrInPins; i++) {
3283 ichs += uaudio20_mixer_get_cluster(
3284 d0->baSourceId[i], iot).bNrChannels;
3287 d1 = (const void *)(d0->baSourceId + d0->bNrInPins);
3289 /* and the number of output channels */
3291 ochs = d1->bNrChannels;
3293 DPRINTFN(3, "ichs=%d ochs=%d\n", ichs, ochs);
3295 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3297 MIX(sc).wIndex = MAKE_WORD(d0->bUnitId, sc->sc_mixer_iface_no);
3298 uaudio20_mixer_determine_class(&iot[id], &MIX(sc));
3299 MIX(sc).type = MIX_SIGNED_16;
3301 if (uaudio20_mixer_verify_desc(d0, ((ichs * ochs) + 7) / 8) == NULL)
3304 for (p = i = 0; i < d0->bNrInPins; i++) {
3305 chs = uaudio20_mixer_get_cluster(
3306 d0->baSourceId[i], iot).bNrChannels;
3308 for (c = 0; c < chs; c++) {
3310 for (o = 0; o < ochs; o++) {
3311 bno = ((p + c) * ochs) + o;
3312 if (BIT_TEST(d1->bmControls, bno))
3318 if ((mc == chs) && (chs <= MIX_MAX_CHAN)) {
3320 /* repeat bit-scan */
3323 for (c = 0; c < chs; c++) {
3324 for (o = 0; o < ochs; o++) {
3325 bno = ((p + c) * ochs) + o;
3326 if (BIT_TEST(d1->bmControls, bno))
3327 MIX(sc).wValue[mc++] = MAKE_WORD(p + c + 1, o + 1);
3330 MIX(sc).nchan = chs;
3331 uaudio_mixer_add_ctl(sc, &MIX(sc));
3338 uaudio_mixer_add_selector(struct uaudio_softc *sc,
3339 const struct uaudio_terminal_node *iot, int id)
3341 const struct usb_audio_selector_unit *d = iot[id].u.su_v1;
3344 DPRINTFN(3, "bUnitId=%d bNrInPins=%d\n",
3345 d->bUnitId, d->bNrInPins);
3347 if (d->bNrInPins == 0)
3350 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3352 MIX(sc).wIndex = MAKE_WORD(d->bUnitId, sc->sc_mixer_iface_no);
3353 MIX(sc).wValue[0] = MAKE_WORD(0, 0);
3354 uaudio_mixer_determine_class(&iot[id], &MIX(sc));
3356 MIX(sc).type = MIX_SELECTOR;
3357 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3359 MIX(sc).maxval = d->bNrInPins;
3360 MIX(sc).name = "selector";
3362 i = d->baSourceId[d->bNrInPins];
3364 usbd_req_get_string_any(sc->sc_udev, NULL,
3365 MIX(sc).desc, sizeof(MIX(sc).desc), i) != 0) {
3366 MIX(sc).desc[0] = 0;
3369 if (MIX(sc).maxval > MAX_SELECTOR_INPUT_PIN) {
3370 MIX(sc).maxval = MAX_SELECTOR_INPUT_PIN;
3372 MIX(sc).mul = (MIX(sc).maxval - MIX(sc).minval);
3373 for (i = 0; i < MAX_SELECTOR_INPUT_PIN; i++) {
3374 MIX(sc).slctrtype[i] = SOUND_MIXER_NRDEVICES;
3377 for (i = 0; i < MIX(sc).maxval; i++) {
3378 MIX(sc).slctrtype[i] = uaudio_mixer_feature_name(
3379 &iot[d->baSourceId[i]], &MIX(sc));
3382 MIX(sc).class = 0; /* not used */
3384 uaudio_mixer_add_ctl(sc, &MIX(sc));
3388 uaudio20_mixer_add_selector(struct uaudio_softc *sc,
3389 const struct uaudio_terminal_node *iot, int id)
3391 const struct usb_audio20_selector_unit *d = iot[id].u.su_v2;
3394 DPRINTFN(3, "bUnitId=%d bNrInPins=%d\n",
3395 d->bUnitId, d->bNrInPins);
3397 if (d->bNrInPins == 0)
3400 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3402 MIX(sc).wIndex = MAKE_WORD(d->bUnitId, sc->sc_mixer_iface_no);
3403 MIX(sc).wValue[0] = MAKE_WORD(0, 0);
3404 uaudio20_mixer_determine_class(&iot[id], &MIX(sc));
3406 MIX(sc).type = MIX_SELECTOR;
3407 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3409 MIX(sc).maxval = d->bNrInPins;
3410 MIX(sc).name = "selector";
3412 i = d->baSourceId[d->bNrInPins];
3414 usbd_req_get_string_any(sc->sc_udev, NULL,
3415 MIX(sc).desc, sizeof(MIX(sc).desc), i) != 0) {
3416 MIX(sc).desc[0] = 0;
3419 if (MIX(sc).maxval > MAX_SELECTOR_INPUT_PIN)
3420 MIX(sc).maxval = MAX_SELECTOR_INPUT_PIN;
3422 MIX(sc).mul = (MIX(sc).maxval - MIX(sc).minval);
3423 for (i = 0; i < MAX_SELECTOR_INPUT_PIN; i++)
3424 MIX(sc).slctrtype[i] = SOUND_MIXER_NRDEVICES;
3426 for (i = 0; i < MIX(sc).maxval; i++) {
3427 MIX(sc).slctrtype[i] = uaudio20_mixer_feature_name(
3428 &iot[d->baSourceId[i]], &MIX(sc));
3431 MIX(sc).class = 0; /* not used */
3433 uaudio_mixer_add_ctl(sc, &MIX(sc));
3437 uaudio_mixer_feature_get_bmaControls(const struct usb_audio_feature_unit *d,
3441 uint32_t offset = (i * d->bControlSize);
3443 if (d->bControlSize > 0) {
3444 temp |= d->bmaControls[offset];
3445 if (d->bControlSize > 1) {
3446 temp |= d->bmaControls[offset + 1] << 8;
3447 if (d->bControlSize > 2) {
3448 temp |= d->bmaControls[offset + 2] << 16;
3449 if (d->bControlSize > 3) {
3450 temp |= d->bmaControls[offset + 3] << 24;
3459 uaudio_mixer_add_feature(struct uaudio_softc *sc,
3460 const struct uaudio_terminal_node *iot, int id)
3462 const struct usb_audio_feature_unit *d = iot[id].u.fu_v1;
3466 uint16_t mixernumber;
3472 if (d->bControlSize == 0)
3475 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3477 nchan = (d->bLength - 7) / d->bControlSize;
3478 mmask = uaudio_mixer_feature_get_bmaControls(d, 0);
3484 /* figure out what we can control */
3486 for (chan = 1; chan < nchan; chan++) {
3487 DPRINTFN(10, "chan=%d mask=%x\n",
3488 chan, uaudio_mixer_feature_get_bmaControls(d, chan));
3490 cmask |= uaudio_mixer_feature_get_bmaControls(d, chan);
3493 if (nchan > MIX_MAX_CHAN) {
3494 nchan = MIX_MAX_CHAN;
3496 MIX(sc).wIndex = MAKE_WORD(d->bUnitId, sc->sc_mixer_iface_no);
3498 i = d->bmaControls[d->bControlSize];
3500 usbd_req_get_string_any(sc->sc_udev, NULL,
3501 MIX(sc).desc, sizeof(MIX(sc).desc), i) != 0) {
3502 MIX(sc).desc[0] = 0;
3505 for (ctl = 1; ctl <= LOUDNESS_CONTROL; ctl++) {
3507 fumask = FU_MASK(ctl);
3509 DPRINTFN(5, "ctl=%d fumask=0x%04x\n",
3512 if (mmask & fumask) {
3514 MIX(sc).wValue[0] = MAKE_WORD(ctl, 0);
3515 } else if (cmask & fumask) {
3516 MIX(sc).nchan = nchan - 1;
3517 for (i = 1; i < nchan; i++) {
3518 if (uaudio_mixer_feature_get_bmaControls(d, i) & fumask)
3519 MIX(sc).wValue[i - 1] = MAKE_WORD(ctl, i);
3521 MIX(sc).wValue[i - 1] = -1;
3527 mixernumber = uaudio_mixer_feature_name(&iot[id], &MIX(sc));
3531 MIX(sc).type = MIX_ON_OFF;
3532 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3533 MIX(sc).name = "mute";
3536 case VOLUME_CONTROL:
3537 MIX(sc).type = MIX_SIGNED_16;
3538 MIX(sc).ctl = mixernumber;
3539 MIX(sc).name = "vol";
3543 MIX(sc).type = MIX_SIGNED_8;
3544 MIX(sc).ctl = SOUND_MIXER_BASS;
3545 MIX(sc).name = "bass";
3549 MIX(sc).type = MIX_SIGNED_8;
3550 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3551 MIX(sc).name = "mid";
3554 case TREBLE_CONTROL:
3555 MIX(sc).type = MIX_SIGNED_8;
3556 MIX(sc).ctl = SOUND_MIXER_TREBLE;
3557 MIX(sc).name = "treble";
3560 case GRAPHIC_EQUALIZER_CONTROL:
3561 continue; /* XXX don't add anything */
3564 MIX(sc).type = MIX_ON_OFF;
3565 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3566 MIX(sc).name = "agc";
3570 MIX(sc).type = MIX_UNSIGNED_16;
3571 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3572 MIX(sc).name = "delay";
3575 case BASS_BOOST_CONTROL:
3576 MIX(sc).type = MIX_ON_OFF;
3577 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3578 MIX(sc).name = "boost";
3581 case LOUDNESS_CONTROL:
3582 MIX(sc).type = MIX_ON_OFF;
3583 MIX(sc).ctl = SOUND_MIXER_LOUD; /* Is this correct ? */
3584 MIX(sc).name = "loudness";
3588 MIX(sc).type = MIX_UNKNOWN;
3592 if (MIX(sc).type != MIX_UNKNOWN)
3593 uaudio_mixer_add_ctl(sc, &MIX(sc));
3598 uaudio20_mixer_add_feature(struct uaudio_softc *sc,
3599 const struct uaudio_terminal_node *iot, int id)
3601 const struct usb_audio20_feature_unit *d = iot[id].u.fu_v2;
3605 uint16_t mixernumber;
3611 if (UGETDW(d->bmaControls[0]) == 0)
3614 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3616 nchan = (d->bLength - 6) / 4;
3617 mmask = UGETDW(d->bmaControls[0]);
3623 /* figure out what we can control */
3625 for (chan = 1; chan < nchan; chan++)
3626 cmask |= UGETDW(d->bmaControls[chan]);
3628 if (nchan > MIX_MAX_CHAN)
3629 nchan = MIX_MAX_CHAN;
3631 MIX(sc).wIndex = MAKE_WORD(d->bUnitId, sc->sc_mixer_iface_no);
3633 i = d->bmaControls[nchan][0];
3635 usbd_req_get_string_any(sc->sc_udev, NULL,
3636 MIX(sc).desc, sizeof(MIX(sc).desc), i) != 0) {
3637 MIX(sc).desc[0] = 0;
3640 for (ctl = 3; ctl != 0; ctl <<= 2) {
3642 mixernumber = uaudio20_mixer_feature_name(&iot[id], &MIX(sc));
3646 MIX(sc).type = MIX_ON_OFF;
3647 MIX(sc).ctl = SOUND_MIXER_NRDEVICES;
3648 MIX(sc).name = "mute";
3649 what = MUTE_CONTROL;
3652 MIX(sc).type = MIX_SIGNED_16;
3653 MIX(sc).ctl = mixernumber;
3654 MIX(sc).name = "vol";
3655 what = VOLUME_CONTROL;
3658 MIX(sc).type = MIX_SIGNED_8;
3659 MIX(sc).ctl = SOUND_MIXER_BASS;
3660 MIX(sc).name = "bass";
3661 what = BASS_CONTROL;
3664 MIX(sc).type = MIX_SIGNED_8;
3665 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3666 MIX(sc).name = "mid";
3670 MIX(sc).type = MIX_SIGNED_8;
3671 MIX(sc).ctl = SOUND_MIXER_TREBLE;
3672 MIX(sc).name = "treble";
3673 what = TREBLE_CONTROL;
3676 MIX(sc).type = MIX_ON_OFF;
3677 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3678 MIX(sc).name = "agc";
3682 MIX(sc).type = MIX_UNSIGNED_16;
3683 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3684 MIX(sc).name = "delay";
3685 what = DELAY_CONTROL;
3688 MIX(sc).type = MIX_ON_OFF;
3689 MIX(sc).ctl = SOUND_MIXER_NRDEVICES; /* XXXXX */
3690 MIX(sc).name = "boost";
3691 what = BASS_BOOST_CONTROL;
3694 MIX(sc).type = MIX_ON_OFF;
3695 MIX(sc).ctl = SOUND_MIXER_LOUD; /* Is this correct ? */
3696 MIX(sc).name = "loudness";
3697 what = LOUDNESS_CONTROL;
3700 MIX(sc).type = MIX_SIGNED_16;
3701 MIX(sc).ctl = mixernumber;
3702 MIX(sc).name = "igain";
3703 what = INPUT_GAIN_CONTROL;
3706 MIX(sc).type = MIX_SIGNED_16;
3707 MIX(sc).ctl = mixernumber;
3708 MIX(sc).name = "igainpad";
3709 what = INPUT_GAIN_PAD_CONTROL;
3715 if ((mmask & ctl) == ctl) {
3717 MIX(sc).wValue[0] = MAKE_WORD(what, 0);
3718 } else if ((cmask & ctl) == ctl) {
3719 MIX(sc).nchan = nchan - 1;
3720 for (i = 1; i < nchan; i++) {
3721 if ((UGETDW(d->bmaControls[i]) & ctl) == ctl)
3722 MIX(sc).wValue[i - 1] = MAKE_WORD(what, i);
3724 MIX(sc).wValue[i - 1] = -1;
3730 if (MIX(sc).type != MIX_UNKNOWN)
3731 uaudio_mixer_add_ctl(sc, &MIX(sc));
3736 uaudio_mixer_add_processing_updown(struct uaudio_softc *sc,
3737 const struct uaudio_terminal_node *iot, int id)
3739 const struct usb_audio_processing_unit_0 *d0 = iot[id].u.pu_v1;
3740 const struct usb_audio_processing_unit_1 *d1 =
3741 (const void *)(d0->baSourceId + d0->bNrInPins);
3742 const struct usb_audio_processing_unit_updown *ud =
3743 (const void *)(d1->bmControls + d1->bControlSize);
3746 if (uaudio_mixer_verify_desc(d0, sizeof(*ud)) == NULL) {
3749 if (uaudio_mixer_verify_desc(d0, sizeof(*ud) + (2 * ud->bNrModes))
3753 DPRINTFN(3, "bUnitId=%d bNrModes=%d\n",
3754 d0->bUnitId, ud->bNrModes);
3756 if (!(d1->bmControls[0] & UA_PROC_MASK(UD_MODE_SELECT_CONTROL))) {
3757 DPRINTF("no mode select\n");
3760 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3762 MIX(sc).wIndex = MAKE_WORD(d0->bUnitId, sc->sc_mixer_iface_no);
3764 MIX(sc).wValue[0] = MAKE_WORD(UD_MODE_SELECT_CONTROL, 0);
3765 uaudio_mixer_determine_class(&iot[id], &MIX(sc));
3766 MIX(sc).type = MIX_ON_OFF; /* XXX */
3768 for (i = 0; i < ud->bNrModes; i++) {
3769 DPRINTFN(3, "i=%d bm=0x%x\n", i, UGETW(ud->waModes[i]));
3773 uaudio_mixer_add_ctl(sc, &MIX(sc));
3777 uaudio_mixer_add_processing(struct uaudio_softc *sc,
3778 const struct uaudio_terminal_node *iot, int id)
3780 const struct usb_audio_processing_unit_0 *d0 = iot[id].u.pu_v1;
3781 const struct usb_audio_processing_unit_1 *d1 =
3782 (const void *)(d0->baSourceId + d0->bNrInPins);
3785 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3787 ptype = UGETW(d0->wProcessType);
3789 DPRINTFN(3, "wProcessType=%d bUnitId=%d "
3790 "bNrInPins=%d\n", ptype, d0->bUnitId, d0->bNrInPins);
3792 if (d1->bControlSize == 0) {
3795 if (d1->bmControls[0] & UA_PROC_ENABLE_MASK) {
3796 MIX(sc).wIndex = MAKE_WORD(d0->bUnitId, sc->sc_mixer_iface_no);
3798 MIX(sc).wValue[0] = MAKE_WORD(XX_ENABLE_CONTROL, 0);
3799 uaudio_mixer_determine_class(&iot[id], &MIX(sc));
3800 MIX(sc).type = MIX_ON_OFF;
3801 uaudio_mixer_add_ctl(sc, &MIX(sc));
3804 case UPDOWNMIX_PROCESS:
3805 uaudio_mixer_add_processing_updown(sc, iot, id);
3808 case DOLBY_PROLOGIC_PROCESS:
3809 case P3D_STEREO_EXTENDER_PROCESS:
3810 case REVERBATION_PROCESS:
3811 case CHORUS_PROCESS:
3812 case DYN_RANGE_COMP_PROCESS:
3814 DPRINTF("unit %d, type=%d is not implemented\n",
3815 d0->bUnitId, ptype);
3821 uaudio_mixer_add_extension(struct uaudio_softc *sc,
3822 const struct uaudio_terminal_node *iot, int id)
3824 const struct usb_audio_extension_unit_0 *d0 = iot[id].u.eu_v1;
3825 const struct usb_audio_extension_unit_1 *d1 =
3826 (const void *)(d0->baSourceId + d0->bNrInPins);
3828 DPRINTFN(3, "bUnitId=%d bNrInPins=%d\n",
3829 d0->bUnitId, d0->bNrInPins);
3831 if (sc->sc_uq_au_no_xu) {
3834 if (d1->bControlSize == 0) {
3837 if (d1->bmControls[0] & UA_EXT_ENABLE_MASK) {
3839 memset(&MIX(sc), 0, sizeof(MIX(sc)));
3841 MIX(sc).wIndex = MAKE_WORD(d0->bUnitId, sc->sc_mixer_iface_no);
3843 MIX(sc).wValue[0] = MAKE_WORD(UA_EXT_ENABLE, 0);
3844 uaudio_mixer_determine_class(&iot[id], &MIX(sc));
3845 MIX(sc).type = MIX_ON_OFF;
3847 uaudio_mixer_add_ctl(sc, &MIX(sc));
3852 uaudio_mixer_verify_desc(const void *arg, uint32_t len)
3854 const struct usb_audio_mixer_unit_1 *d1;
3855 const struct usb_audio_extension_unit_1 *e1;
3856 const struct usb_audio_processing_unit_1 *u1;
3859 const struct usb_descriptor *desc;
3860 const struct usb_audio_input_terminal *it;
3861 const struct usb_audio_output_terminal *ot;
3862 const struct usb_audio_mixer_unit_0 *mu;
3863 const struct usb_audio_selector_unit *su;
3864 const struct usb_audio_feature_unit *fu;
3865 const struct usb_audio_processing_unit_0 *pu;
3866 const struct usb_audio_extension_unit_0 *eu;
3871 if (u.desc == NULL) {
3874 if (u.desc->bDescriptorType != UDESC_CS_INTERFACE) {
3877 switch (u.desc->bDescriptorSubtype) {
3878 case UDESCSUB_AC_INPUT:
3879 len += sizeof(*u.it);
3882 case UDESCSUB_AC_OUTPUT:
3883 len += sizeof(*u.ot);
3886 case UDESCSUB_AC_MIXER:
3887 len += sizeof(*u.mu);
3889 if (u.desc->bLength < len) {
3892 len += u.mu->bNrInPins;
3894 if (u.desc->bLength < len) {
3897 d1 = (const void *)(u.mu->baSourceId + u.mu->bNrInPins);
3902 case UDESCSUB_AC_SELECTOR:
3903 len += sizeof(*u.su);
3905 if (u.desc->bLength < len) {
3908 len += u.su->bNrInPins + 1;
3911 case UDESCSUB_AC_FEATURE:
3912 len += sizeof(*u.fu) + 1;
3914 if (u.desc->bLength < len)
3917 len += u.fu->bControlSize;
3920 case UDESCSUB_AC_PROCESSING:
3921 len += sizeof(*u.pu);
3923 if (u.desc->bLength < len) {
3926 len += u.pu->bNrInPins;
3928 if (u.desc->bLength < len) {
3931 u1 = (const void *)(u.pu->baSourceId + u.pu->bNrInPins);
3935 if (u.desc->bLength < len) {
3938 len += u1->bControlSize;
3942 case UDESCSUB_AC_EXTENSION:
3943 len += sizeof(*u.eu);
3945 if (u.desc->bLength < len) {
3948 len += u.eu->bNrInPins;
3950 if (u.desc->bLength < len) {
3953 e1 = (const void *)(u.eu->baSourceId + u.eu->bNrInPins);
3957 if (u.desc->bLength < len) {
3960 len += e1->bControlSize;
3967 if (u.desc->bLength < len) {
3974 DPRINTF("invalid descriptor, type=%d, "
3975 "sub_type=%d, len=%d of %d bytes\n",
3976 u.desc->bDescriptorType,
3977 u.desc->bDescriptorSubtype,
3978 u.desc->bLength, len);
3984 uaudio20_mixer_verify_desc(const void *arg, uint32_t len)
3986 const struct usb_audio20_mixer_unit_1 *d1;
3987 const struct usb_audio20_extension_unit_1 *e1;
3988 const struct usb_audio20_processing_unit_1 *u1;
3989 const struct usb_audio20_clock_selector_unit_1 *c1;
3992 const struct usb_descriptor *desc;
3993 const struct usb_audio20_clock_source_unit *csrc;
3994 const struct usb_audio20_clock_selector_unit_0 *csel;
3995 const struct usb_audio20_clock_multiplier_unit *cmul;
3996 const struct usb_audio20_input_terminal *it;
3997 const struct usb_audio20_output_terminal *ot;
3998 const struct usb_audio20_mixer_unit_0 *mu;
3999 const struct usb_audio20_selector_unit *su;
4000 const struct usb_audio20_feature_unit *fu;
4001 const struct usb_audio20_sample_rate_unit *ru;
4002 const struct usb_audio20_processing_unit_0 *pu;
4003 const struct usb_audio20_extension_unit_0 *eu;
4004 const struct usb_audio20_effect_unit *ef;
4012 if (u.desc->bDescriptorType != UDESC_CS_INTERFACE)
4015 switch (u.desc->bDescriptorSubtype) {
4016 case UDESCSUB_AC_INPUT:
4017 len += sizeof(*u.it);
4020 case UDESCSUB_AC_OUTPUT:
4021 len += sizeof(*u.ot);
4024 case UDESCSUB_AC_MIXER:
4025 len += sizeof(*u.mu);
4027 if (u.desc->bLength < len)
4029 len += u.mu->bNrInPins;
4031 if (u.desc->bLength < len)
4034 d1 = (const void *)(u.mu->baSourceId + u.mu->bNrInPins);
4036 len += sizeof(*d1) + d1->bNrChannels;
4039 case UDESCSUB_AC_SELECTOR:
4040 len += sizeof(*u.su);
4042 if (u.desc->bLength < len)
4045 len += u.su->bNrInPins + 1;
4048 case UDESCSUB_AC_FEATURE:
4049 len += sizeof(*u.fu) + 1;
4052 case UDESCSUB_AC_EFFECT:
4053 len += sizeof(*u.ef) + 4;
4056 case UDESCSUB_AC_PROCESSING_V2:
4057 len += sizeof(*u.pu);
4059 if (u.desc->bLength < len)
4062 len += u.pu->bNrInPins;
4064 if (u.desc->bLength < len)
4067 u1 = (const void *)(u.pu->baSourceId + u.pu->bNrInPins);
4072 case UDESCSUB_AC_EXTENSION_V2:
4073 len += sizeof(*u.eu);
4075 if (u.desc->bLength < len)
4078 len += u.eu->bNrInPins;
4080 if (u.desc->bLength < len)
4083 e1 = (const void *)(u.eu->baSourceId + u.eu->bNrInPins);
4088 case UDESCSUB_AC_CLOCK_SRC:
4089 len += sizeof(*u.csrc);
4092 case UDESCSUB_AC_CLOCK_SEL:
4093 len += sizeof(*u.csel);
4095 if (u.desc->bLength < len)
4098 len += u.csel->bNrInPins;
4100 if (u.desc->bLength < len)
4103 c1 = (const void *)(u.csel->baCSourceId + u.csel->bNrInPins);
4108 case UDESCSUB_AC_CLOCK_MUL:
4109 len += sizeof(*u.cmul);
4112 case UDESCSUB_AC_SAMPLE_RT:
4113 len += sizeof(*u.ru);
4120 if (u.desc->bLength < len)
4127 DPRINTF("invalid descriptor, type=%d, "
4128 "sub_type=%d, len=%d of %d bytes\n",
4129 u.desc->bDescriptorType,
4130 u.desc->bDescriptorSubtype,
4131 u.desc->bLength, len);
4136 static struct usb_audio_cluster
4137 uaudio_mixer_get_cluster(uint8_t id, const struct uaudio_terminal_node *iot)
4139 struct usb_audio_cluster r;
4140 const struct usb_descriptor *dp;
4143 for (i = 0; i < UAUDIO_RECURSE_LIMIT; i++) { /* avoid infinite loops */
4144 dp = iot[id].u.desc;
4148 switch (dp->bDescriptorSubtype) {
4149 case UDESCSUB_AC_INPUT:
4150 r.bNrChannels = iot[id].u.it_v1->bNrChannels;
4151 r.wChannelConfig[0] = iot[id].u.it_v1->wChannelConfig[0];
4152 r.wChannelConfig[1] = iot[id].u.it_v1->wChannelConfig[1];
4153 r.iChannelNames = iot[id].u.it_v1->iChannelNames;
4156 case UDESCSUB_AC_OUTPUT:
4157 id = iot[id].u.ot_v1->bSourceId;
4160 case UDESCSUB_AC_MIXER:
4161 r = *(const struct usb_audio_cluster *)
4162 &iot[id].u.mu_v1->baSourceId[
4163 iot[id].u.mu_v1->bNrInPins];
4166 case UDESCSUB_AC_SELECTOR:
4167 if (iot[id].u.su_v1->bNrInPins > 0) {
4168 /* XXX This is not really right */
4169 id = iot[id].u.su_v1->baSourceId[0];
4173 case UDESCSUB_AC_FEATURE:
4174 id = iot[id].u.fu_v1->bSourceId;
4177 case UDESCSUB_AC_PROCESSING:
4178 r = *((const struct usb_audio_cluster *)
4179 &iot[id].u.pu_v1->baSourceId[
4180 iot[id].u.pu_v1->bNrInPins]);
4183 case UDESCSUB_AC_EXTENSION:
4184 r = *((const struct usb_audio_cluster *)
4185 &iot[id].u.eu_v1->baSourceId[
4186 iot[id].u.eu_v1->bNrInPins]);
4194 DPRINTF("bad data\n");
4195 memset(&r, 0, sizeof(r));
4200 static struct usb_audio20_cluster
4201 uaudio20_mixer_get_cluster(uint8_t id, const struct uaudio_terminal_node *iot)
4203 struct usb_audio20_cluster r;
4204 const struct usb_descriptor *dp;
4207 for (i = 0; i < UAUDIO_RECURSE_LIMIT; i++) { /* avoid infinite loops */
4208 dp = iot[id].u.desc;
4212 switch (dp->bDescriptorSubtype) {
4213 case UDESCSUB_AC_INPUT:
4214 r.bNrChannels = iot[id].u.it_v2->bNrChannels;
4215 r.bmChannelConfig[0] = iot[id].u.it_v2->bmChannelConfig[0];
4216 r.bmChannelConfig[1] = iot[id].u.it_v2->bmChannelConfig[1];
4217 r.bmChannelConfig[2] = iot[id].u.it_v2->bmChannelConfig[2];
4218 r.bmChannelConfig[3] = iot[id].u.it_v2->bmChannelConfig[3];
4219 r.iChannelNames = iot[id].u.it_v2->iTerminal;
4222 case UDESCSUB_AC_OUTPUT:
4223 id = iot[id].u.ot_v2->bSourceId;
4226 case UDESCSUB_AC_MIXER:
4227 r = *(const struct usb_audio20_cluster *)
4228 &iot[id].u.mu_v2->baSourceId[
4229 iot[id].u.mu_v2->bNrInPins];
4232 case UDESCSUB_AC_SELECTOR:
4233 if (iot[id].u.su_v2->bNrInPins > 0) {
4234 /* XXX This is not really right */
4235 id = iot[id].u.su_v2->baSourceId[0];
4239 case UDESCSUB_AC_SAMPLE_RT:
4240 id = iot[id].u.ru_v2->bSourceId;
4243 case UDESCSUB_AC_EFFECT:
4244 id = iot[id].u.ef_v2->bSourceId;
4247 case UDESCSUB_AC_FEATURE:
4248 id = iot[id].u.fu_v2->bSourceId;
4251 case UDESCSUB_AC_PROCESSING_V2:
4252 r = *((const struct usb_audio20_cluster *)
4253 &iot[id].u.pu_v2->baSourceId[
4254 iot[id].u.pu_v2->bNrInPins]);
4257 case UDESCSUB_AC_EXTENSION_V2:
4258 r = *((const struct usb_audio20_cluster *)
4259 &iot[id].u.eu_v2->baSourceId[
4260 iot[id].u.eu_v2->bNrInPins]);
4268 DPRINTF("Bad data!\n");
4269 memset(&r, 0, sizeof(r));
4275 uaudio_mixer_determine_class(const struct uaudio_terminal_node *iot,
4276 struct uaudio_mixer_node *mix)
4278 uint16_t terminal_type = 0x0000;
4279 const struct uaudio_terminal_node *input[2];
4280 const struct uaudio_terminal_node *output[2];
4282 input[0] = uaudio_mixer_get_input(iot, 0);
4283 input[1] = uaudio_mixer_get_input(iot, 1);
4285 output[0] = uaudio_mixer_get_output(iot, 0);
4286 output[1] = uaudio_mixer_get_output(iot, 1);
4289 * check if there is only
4290 * one output terminal:
4292 if (output[0] && (!output[1])) {
4294 UGETW(output[0]->u.ot_v1->wTerminalType);
4297 * If the only output terminal is USB,
4298 * the class is UAC_RECORD.
4300 if ((terminal_type & 0xff00) == (UAT_UNDEFINED & 0xff00)) {
4302 mix->class = UAC_RECORD;
4303 if (input[0] && (!input[1])) {
4305 UGETW(input[0]->u.it_v1->wTerminalType);
4312 * if the unit is connected to just
4313 * one input terminal, the
4314 * class is UAC_INPUT:
4316 if (input[0] && (!input[1])) {
4317 mix->class = UAC_INPUT;
4319 UGETW(input[0]->u.it_v1->wTerminalType);
4323 * Otherwise, the class is UAC_OUTPUT.
4325 mix->class = UAC_OUTPUT;
4327 return (terminal_type);
4331 uaudio20_mixer_determine_class(const struct uaudio_terminal_node *iot,
4332 struct uaudio_mixer_node *mix)
4334 uint16_t terminal_type = 0x0000;
4335 const struct uaudio_terminal_node *input[2];
4336 const struct uaudio_terminal_node *output[2];
4338 input[0] = uaudio_mixer_get_input(iot, 0);
4339 input[1] = uaudio_mixer_get_input(iot, 1);
4341 output[0] = uaudio_mixer_get_output(iot, 0);
4342 output[1] = uaudio_mixer_get_output(iot, 1);
4345 * check if there is only
4346 * one output terminal:
4348 if (output[0] && (!output[1]))
4349 terminal_type = UGETW(output[0]->u.ot_v2->wTerminalType);
4351 * If the only output terminal is USB,
4352 * the class is UAC_RECORD.
4354 if ((terminal_type & 0xff00) == (UAT_UNDEFINED & 0xff00)) {
4356 mix->class = UAC_RECORD;
4357 if (input[0] && (!input[1])) {
4359 UGETW(input[0]->u.it_v2->wTerminalType);
4366 * if the unit is connected to just
4367 * one input terminal, the
4368 * class is UAC_INPUT:
4370 if (input[0] && (!input[1])) {
4371 mix->class = UAC_INPUT;
4373 UGETW(input[0]->u.it_v2->wTerminalType);
4377 * Otherwise, the class is UAC_OUTPUT.
4379 mix->class = UAC_OUTPUT;
4381 return (terminal_type);
4384 struct uaudio_tt_to_feature {
4385 uint16_t terminal_type;
4389 static const struct uaudio_tt_to_feature uaudio_tt_to_feature[] = {
4391 {UAT_STREAM, SOUND_MIXER_PCM},
4393 {UATI_MICROPHONE, SOUND_MIXER_MIC},
4394 {UATI_DESKMICROPHONE, SOUND_MIXER_MIC},
4395 {UATI_PERSONALMICROPHONE, SOUND_MIXER_MIC},
4396 {UATI_OMNIMICROPHONE, SOUND_MIXER_MIC},
4397 {UATI_MICROPHONEARRAY, SOUND_MIXER_MIC},
4398 {UATI_PROCMICROPHONEARR, SOUND_MIXER_MIC},
4400 {UATO_SPEAKER, SOUND_MIXER_SPEAKER},
4401 {UATO_DESKTOPSPEAKER, SOUND_MIXER_SPEAKER},
4402 {UATO_ROOMSPEAKER, SOUND_MIXER_SPEAKER},
4403 {UATO_COMMSPEAKER, SOUND_MIXER_SPEAKER},
4405 {UATE_ANALOGCONN, SOUND_MIXER_LINE},
4406 {UATE_LINECONN, SOUND_MIXER_LINE},
4407 {UATE_LEGACYCONN, SOUND_MIXER_LINE},
4409 {UATE_DIGITALAUIFC, SOUND_MIXER_ALTPCM},
4410 {UATE_SPDIF, SOUND_MIXER_ALTPCM},
4411 {UATE_1394DA, SOUND_MIXER_ALTPCM},
4412 {UATE_1394DV, SOUND_MIXER_ALTPCM},
4414 {UATF_CDPLAYER, SOUND_MIXER_CD},
4416 {UATF_SYNTHESIZER, SOUND_MIXER_SYNTH},
4418 {UATF_VIDEODISCAUDIO, SOUND_MIXER_VIDEO},
4419 {UATF_DVDAUDIO, SOUND_MIXER_VIDEO},
4420 {UATF_TVTUNERAUDIO, SOUND_MIXER_VIDEO},
4422 /* telephony terminal types */
4423 {UATT_UNDEFINED, SOUND_MIXER_PHONEIN}, /* SOUND_MIXER_PHONEOUT */
4424 {UATT_PHONELINE, SOUND_MIXER_PHONEIN}, /* SOUND_MIXER_PHONEOUT */
4425 {UATT_TELEPHONE, SOUND_MIXER_PHONEIN}, /* SOUND_MIXER_PHONEOUT */
4426 {UATT_DOWNLINEPHONE, SOUND_MIXER_PHONEIN}, /* SOUND_MIXER_PHONEOUT */
4428 {UATF_RADIORECV, SOUND_MIXER_RADIO},
4429 {UATF_RADIOXMIT, SOUND_MIXER_RADIO},
4431 {UAT_UNDEFINED, SOUND_MIXER_VOLUME},
4432 {UAT_VENDOR, SOUND_MIXER_VOLUME},
4433 {UATI_UNDEFINED, SOUND_MIXER_VOLUME},
4435 /* output terminal types */
4436 {UATO_UNDEFINED, SOUND_MIXER_VOLUME},
4437 {UATO_DISPLAYAUDIO, SOUND_MIXER_VOLUME},
4438 {UATO_SUBWOOFER, SOUND_MIXER_VOLUME},
4439 {UATO_HEADPHONES, SOUND_MIXER_VOLUME},
4441 /* bidir terminal types */
4442 {UATB_UNDEFINED, SOUND_MIXER_VOLUME},
4443 {UATB_HANDSET, SOUND_MIXER_VOLUME},
4444 {UATB_HEADSET, SOUND_MIXER_VOLUME},
4445 {UATB_SPEAKERPHONE, SOUND_MIXER_VOLUME},
4446 {UATB_SPEAKERPHONEESUP, SOUND_MIXER_VOLUME},
4447 {UATB_SPEAKERPHONEECANC, SOUND_MIXER_VOLUME},
4449 /* external terminal types */
4450 {UATE_UNDEFINED, SOUND_MIXER_VOLUME},
4452 /* embedded function terminal types */
4453 {UATF_UNDEFINED, SOUND_MIXER_VOLUME},
4454 {UATF_CALIBNOISE, SOUND_MIXER_VOLUME},
4455 {UATF_EQUNOISE, SOUND_MIXER_VOLUME},
4456 {UATF_DAT, SOUND_MIXER_VOLUME},
4457 {UATF_DCC, SOUND_MIXER_VOLUME},
4458 {UATF_MINIDISK, SOUND_MIXER_VOLUME},
4459 {UATF_ANALOGTAPE, SOUND_MIXER_VOLUME},
4460 {UATF_PHONOGRAPH, SOUND_MIXER_VOLUME},
4461 {UATF_VCRAUDIO, SOUND_MIXER_VOLUME},
4462 {UATF_SATELLITE, SOUND_MIXER_VOLUME},
4463 {UATF_CABLETUNER, SOUND_MIXER_VOLUME},
4464 {UATF_DSS, SOUND_MIXER_VOLUME},
4465 {UATF_MULTITRACK, SOUND_MIXER_VOLUME},
4466 {0xffff, SOUND_MIXER_VOLUME},
4469 {0x0000, SOUND_MIXER_VOLUME},
4473 uaudio_mixer_feature_name(const struct uaudio_terminal_node *iot,
4474 struct uaudio_mixer_node *mix)
4476 const struct uaudio_tt_to_feature *uat = uaudio_tt_to_feature;
4477 uint16_t terminal_type = uaudio_mixer_determine_class(iot, mix);
4479 if ((mix->class == UAC_RECORD) && (terminal_type == 0)) {
4480 return (SOUND_MIXER_IMIX);
4482 while (uat->terminal_type) {
4483 if (uat->terminal_type == terminal_type) {
4489 DPRINTF("terminal_type=0x%04x -> %d\n",
4490 terminal_type, uat->feature);
4492 return (uat->feature);
4496 uaudio20_mixer_feature_name(const struct uaudio_terminal_node *iot,
4497 struct uaudio_mixer_node *mix)
4499 const struct uaudio_tt_to_feature *uat;
4500 uint16_t terminal_type = uaudio20_mixer_determine_class(iot, mix);
4502 if ((mix->class == UAC_RECORD) && (terminal_type == 0))
4503 return (SOUND_MIXER_IMIX);
4505 for (uat = uaudio_tt_to_feature; uat->terminal_type != 0; uat++) {
4506 if (uat->terminal_type == terminal_type)
4510 DPRINTF("terminal_type=0x%04x -> %d\n",
4511 terminal_type, uat->feature);
4513 return (uat->feature);
4516 static const struct uaudio_terminal_node *
4517 uaudio_mixer_get_input(const struct uaudio_terminal_node *iot, uint8_t i)
4519 struct uaudio_terminal_node *root = iot->root;
4522 n = iot->usr.id_max;
4524 if (iot->usr.bit_input[n / 8] & (1 << (n % 8))) {
4533 static const struct uaudio_terminal_node *
4534 uaudio_mixer_get_output(const struct uaudio_terminal_node *iot, uint8_t i)
4536 struct uaudio_terminal_node *root = iot->root;
4539 n = iot->usr.id_max;
4541 if (iot->usr.bit_output[n / 8] & (1 << (n % 8))) {
4551 uaudio_mixer_find_inputs_sub(struct uaudio_terminal_node *root,
4552 const uint8_t *p_id, uint8_t n_id,
4553 struct uaudio_search_result *info)
4555 struct uaudio_terminal_node *iot;
4561 for (n = 0; n < n_id; n++) {
4565 if (info->recurse_level == UAUDIO_RECURSE_LIMIT) {
4566 DPRINTF("avoided going into a circle at id=%d!\n", i);
4570 info->recurse_level++;
4574 if (iot->u.desc == NULL)
4577 is_last = ((n + 1) == n_id);
4579 switch (iot->u.desc->bDescriptorSubtype) {
4580 case UDESCSUB_AC_INPUT:
4581 info->bit_input[i / 8] |= (1 << (i % 8));
4584 case UDESCSUB_AC_FEATURE:
4586 p_id = &iot->u.fu_v1->bSourceId;
4590 uaudio_mixer_find_inputs_sub(
4591 root, &iot->u.fu_v1->bSourceId, 1, info);
4594 case UDESCSUB_AC_OUTPUT:
4596 p_id = &iot->u.ot_v1->bSourceId;
4600 uaudio_mixer_find_inputs_sub(
4601 root, &iot->u.ot_v1->bSourceId, 1, info);
4604 case UDESCSUB_AC_MIXER:
4606 p_id = iot->u.mu_v1->baSourceId;
4607 n_id = iot->u.mu_v1->bNrInPins;
4610 uaudio_mixer_find_inputs_sub(
4611 root, iot->u.mu_v1->baSourceId,
4612 iot->u.mu_v1->bNrInPins, info);
4615 case UDESCSUB_AC_SELECTOR:
4617 p_id = iot->u.su_v1->baSourceId;
4618 n_id = iot->u.su_v1->bNrInPins;
4621 uaudio_mixer_find_inputs_sub(
4622 root, iot->u.su_v1->baSourceId,
4623 iot->u.su_v1->bNrInPins, info);
4626 case UDESCSUB_AC_PROCESSING:
4628 p_id = iot->u.pu_v1->baSourceId;
4629 n_id = iot->u.pu_v1->bNrInPins;
4632 uaudio_mixer_find_inputs_sub(
4633 root, iot->u.pu_v1->baSourceId,
4634 iot->u.pu_v1->bNrInPins, info);
4637 case UDESCSUB_AC_EXTENSION:
4639 p_id = iot->u.eu_v1->baSourceId;
4640 n_id = iot->u.eu_v1->bNrInPins;
4643 uaudio_mixer_find_inputs_sub(
4644 root, iot->u.eu_v1->baSourceId,
4645 iot->u.eu_v1->bNrInPins, info);
4655 uaudio20_mixer_find_inputs_sub(struct uaudio_terminal_node *root,
4656 const uint8_t *p_id, uint8_t n_id,
4657 struct uaudio_search_result *info)
4659 struct uaudio_terminal_node *iot;
4665 for (n = 0; n < n_id; n++) {
4669 if (info->recurse_level == UAUDIO_RECURSE_LIMIT) {
4670 DPRINTF("avoided going into a circle at id=%d!\n", i);
4674 info->recurse_level++;
4678 if (iot->u.desc == NULL)
4681 is_last = ((n + 1) == n_id);
4683 switch (iot->u.desc->bDescriptorSubtype) {
4684 case UDESCSUB_AC_INPUT:
4685 info->bit_input[i / 8] |= (1 << (i % 8));
4688 case UDESCSUB_AC_OUTPUT:
4690 p_id = &iot->u.ot_v2->bSourceId;
4694 uaudio20_mixer_find_inputs_sub(
4695 root, &iot->u.ot_v2->bSourceId, 1, info);
4698 case UDESCSUB_AC_MIXER:
4700 p_id = iot->u.mu_v2->baSourceId;
4701 n_id = iot->u.mu_v2->bNrInPins;
4704 uaudio20_mixer_find_inputs_sub(
4705 root, iot->u.mu_v2->baSourceId,
4706 iot->u.mu_v2->bNrInPins, info);
4709 case UDESCSUB_AC_SELECTOR:
4711 p_id = iot->u.su_v2->baSourceId;
4712 n_id = iot->u.su_v2->bNrInPins;
4715 uaudio20_mixer_find_inputs_sub(
4716 root, iot->u.su_v2->baSourceId,
4717 iot->u.su_v2->bNrInPins, info);
4720 case UDESCSUB_AC_SAMPLE_RT:
4722 p_id = &iot->u.ru_v2->bSourceId;
4726 uaudio20_mixer_find_inputs_sub(
4727 root, &iot->u.ru_v2->bSourceId,
4731 case UDESCSUB_AC_EFFECT:
4733 p_id = &iot->u.ef_v2->bSourceId;
4737 uaudio20_mixer_find_inputs_sub(
4738 root, &iot->u.ef_v2->bSourceId,
4742 case UDESCSUB_AC_FEATURE:
4744 p_id = &iot->u.fu_v2->bSourceId;
4748 uaudio20_mixer_find_inputs_sub(
4749 root, &iot->u.fu_v2->bSourceId, 1, info);
4752 case UDESCSUB_AC_PROCESSING_V2:
4754 p_id = iot->u.pu_v2->baSourceId;
4755 n_id = iot->u.pu_v2->bNrInPins;
4758 uaudio20_mixer_find_inputs_sub(
4759 root, iot->u.pu_v2->baSourceId,
4760 iot->u.pu_v2->bNrInPins, info);
4763 case UDESCSUB_AC_EXTENSION_V2:
4765 p_id = iot->u.eu_v2->baSourceId;
4766 n_id = iot->u.eu_v2->bNrInPins;
4769 uaudio20_mixer_find_inputs_sub(
4770 root, iot->u.eu_v2->baSourceId,
4771 iot->u.eu_v2->bNrInPins, info);
4780 uaudio20_mixer_find_clocks_sub(struct uaudio_terminal_node *root,
4781 const uint8_t *p_id, uint8_t n_id,
4782 struct uaudio_search_result *info)
4784 struct uaudio_terminal_node *iot;
4791 for (n = 0; n < n_id; n++) {
4795 if (info->recurse_level == UAUDIO_RECURSE_LIMIT) {
4796 DPRINTF("avoided going into a circle at id=%d!\n", i);
4800 info->recurse_level++;
4804 if (iot->u.desc == NULL)
4807 is_last = ((n + 1) == n_id);
4809 switch (iot->u.desc->bDescriptorSubtype) {
4810 case UDESCSUB_AC_INPUT:
4813 p_id = &iot->u.it_v2->bCSourceId;
4817 uaudio20_mixer_find_clocks_sub(root,
4818 &iot->u.it_v2->bCSourceId, 1, info);
4821 case UDESCSUB_AC_OUTPUT:
4824 p_id = &iot->u.ot_v2->bCSourceId;
4828 uaudio20_mixer_find_clocks_sub(root,
4829 &iot->u.ot_v2->bCSourceId, 1, info);
4832 case UDESCSUB_AC_CLOCK_SEL:
4834 p_id = iot->u.csel_v2->baCSourceId;
4835 n_id = iot->u.csel_v2->bNrInPins;
4838 uaudio20_mixer_find_clocks_sub(root,
4839 iot->u.csel_v2->baCSourceId,
4840 iot->u.csel_v2->bNrInPins, info);
4843 case UDESCSUB_AC_CLOCK_MUL:
4845 p_id = &iot->u.cmul_v2->bCSourceId;
4849 uaudio20_mixer_find_clocks_sub(root,
4850 &iot->u.cmul_v2->bCSourceId,
4854 case UDESCSUB_AC_CLOCK_SRC:
4856 id = iot->u.csrc_v2->bClockId;
4858 switch (info->is_input) {
4860 info->bit_output[id / 8] |= (1 << (id % 8));
4863 info->bit_input[id / 8] |= (1 << (id % 8));
4877 uaudio_mixer_find_outputs_sub(struct uaudio_terminal_node *root, uint8_t id,
4878 uint8_t n_id, struct uaudio_search_result *info)
4880 struct uaudio_terminal_node *iot = (root + id);
4885 if ((j != id) && ((root + j)->u.desc) &&
4886 ((root + j)->u.desc->bDescriptorSubtype == UDESCSUB_AC_OUTPUT)) {
4889 * "j" (output) <--- virtual wire <--- "id" (input)
4891 * if "j" has "id" on the input, then "id" have "j" on
4892 * the output, because they are connected:
4894 if ((root + j)->usr.bit_input[id / 8] & (1 << (id % 8))) {
4895 iot->usr.bit_output[j / 8] |= (1 << (j % 8));
4902 uaudio_mixer_fill_info(struct uaudio_softc *sc,
4903 struct usb_device *udev, void *desc)
4905 const struct usb_audio_control_descriptor *acdp;
4906 struct usb_config_descriptor *cd = usbd_get_config_descriptor(udev);
4907 const struct usb_descriptor *dp;
4908 const struct usb_audio_unit *au;
4909 struct uaudio_terminal_node *iot = NULL;
4911 uint8_t ID_max = 0; /* inclusive */
4914 desc = usb_desc_foreach(cd, desc);
4917 DPRINTF("no Audio Control header\n");
4922 if ((acdp->bLength < sizeof(*acdp)) ||
4923 (acdp->bDescriptorType != UDESC_CS_INTERFACE) ||
4924 (acdp->bDescriptorSubtype != UDESCSUB_AC_HEADER)) {
4925 DPRINTF("invalid Audio Control header\n");
4928 /* "wTotalLen" is allowed to be corrupt */
4929 wTotalLen = UGETW(acdp->wTotalLength) - acdp->bLength;
4931 /* get USB audio revision */
4932 sc->sc_audio_rev = UGETW(acdp->bcdADC);
4934 DPRINTFN(3, "found AC header, vers=%03x, len=%d\n",
4935 sc->sc_audio_rev, wTotalLen);
4937 iot = malloc(sizeof(struct uaudio_terminal_node) * 256, M_TEMP,
4941 DPRINTF("no memory!\n");
4944 while ((desc = usb_desc_foreach(cd, desc))) {
4948 if (dp->bLength > wTotalLen) {
4951 wTotalLen -= dp->bLength;
4954 if (sc->sc_audio_rev >= UAUDIO_VERSION_30)
4956 else if (sc->sc_audio_rev >= UAUDIO_VERSION_20)
4957 au = uaudio20_mixer_verify_desc(dp, 0);
4959 au = uaudio_mixer_verify_desc(dp, 0);
4962 iot[au->bUnitId].u.desc = (const void *)au;
4963 if (au->bUnitId > ID_max)
4964 ID_max = au->bUnitId;
4968 DPRINTF("Maximum ID=%d\n", ID_max);
4971 * determine sourcing inputs for
4972 * all nodes in the tree:
4976 if (sc->sc_audio_rev >= UAUDIO_VERSION_30) {
4978 } else if (sc->sc_audio_rev >= UAUDIO_VERSION_20) {
4979 uaudio20_mixer_find_inputs_sub(iot,
4980 &i, 1, &((iot + i)->usr));
4982 sc->sc_mixer_clocks.is_input = 255;
4983 sc->sc_mixer_clocks.recurse_level = 0;
4985 uaudio20_mixer_find_clocks_sub(iot,
4986 &i, 1, &sc->sc_mixer_clocks);
4988 uaudio_mixer_find_inputs_sub(iot,
4989 &i, 1, &((iot + i)->usr));
4994 * determine outputs for
4995 * all nodes in the tree:
4999 uaudio_mixer_find_outputs_sub(iot,
5000 i, ID_max, &((iot + i)->usr));
5003 /* set "id_max" and "root" */
5007 (iot + i)->usr.id_max = ID_max;
5008 (iot + i)->root = iot;
5012 * Scan the config to create a linked list of "mixer" nodes:
5022 DPRINTFN(11, "id=%d subtype=%d\n",
5023 i, dp->bDescriptorSubtype);
5025 if (sc->sc_audio_rev >= UAUDIO_VERSION_30) {
5027 } else if (sc->sc_audio_rev >= UAUDIO_VERSION_20) {
5029 switch (dp->bDescriptorSubtype) {
5030 case UDESCSUB_AC_HEADER:
5031 DPRINTF("unexpected AC header\n");
5034 case UDESCSUB_AC_INPUT:
5035 case UDESCSUB_AC_OUTPUT:
5036 case UDESCSUB_AC_PROCESSING_V2:
5037 case UDESCSUB_AC_EXTENSION_V2:
5038 case UDESCSUB_AC_EFFECT:
5039 case UDESCSUB_AC_CLOCK_SRC:
5040 case UDESCSUB_AC_CLOCK_SEL:
5041 case UDESCSUB_AC_CLOCK_MUL:
5042 case UDESCSUB_AC_SAMPLE_RT:
5045 case UDESCSUB_AC_MIXER:
5046 uaudio20_mixer_add_mixer(sc, iot, i);
5049 case UDESCSUB_AC_SELECTOR:
5050 uaudio20_mixer_add_selector(sc, iot, i);
5053 case UDESCSUB_AC_FEATURE:
5054 uaudio20_mixer_add_feature(sc, iot, i);
5058 DPRINTF("bad AC desc subtype=0x%02x\n",
5059 dp->bDescriptorSubtype);
5065 switch (dp->bDescriptorSubtype) {
5066 case UDESCSUB_AC_HEADER:
5067 DPRINTF("unexpected AC header\n");
5070 case UDESCSUB_AC_INPUT:
5071 case UDESCSUB_AC_OUTPUT:
5074 case UDESCSUB_AC_MIXER:
5075 uaudio_mixer_add_mixer(sc, iot, i);
5078 case UDESCSUB_AC_SELECTOR:
5079 uaudio_mixer_add_selector(sc, iot, i);
5082 case UDESCSUB_AC_FEATURE:
5083 uaudio_mixer_add_feature(sc, iot, i);
5086 case UDESCSUB_AC_PROCESSING:
5087 uaudio_mixer_add_processing(sc, iot, i);
5090 case UDESCSUB_AC_EXTENSION:
5091 uaudio_mixer_add_extension(sc, iot, i);
5095 DPRINTF("bad AC desc subtype=0x%02x\n",
5096 dp->bDescriptorSubtype);
5107 uaudio_mixer_get(struct usb_device *udev, uint16_t audio_rev,
5108 uint8_t what, struct uaudio_mixer_node *mc)
5110 struct usb_device_request req;
5112 uint8_t data[2 + (2 * 3)];
5115 if (mc->wValue[0] == -1)
5118 if (audio_rev >= UAUDIO_VERSION_30)
5120 else if (audio_rev >= UAUDIO_VERSION_20) {
5121 if (what == GET_CUR) {
5122 req.bRequest = UA20_CS_CUR;
5123 USETW(req.wLength, 2);
5125 req.bRequest = UA20_CS_RANGE;
5126 USETW(req.wLength, 8);
5129 uint16_t len = MIX_SIZE(mc->type);
5131 req.bRequest = what;
5132 USETW(req.wLength, len);
5135 req.bmRequestType = UT_READ_CLASS_INTERFACE;
5136 USETW(req.wValue, mc->wValue[0]);
5137 USETW(req.wIndex, mc->wIndex);
5139 memset(data, 0, sizeof(data));
5141 err = usbd_do_request(udev, NULL, &req, data);
5143 DPRINTF("err=%s\n", usbd_errstr(err));
5147 if (audio_rev >= UAUDIO_VERSION_30) {
5149 } else if (audio_rev >= UAUDIO_VERSION_20) {
5152 val = (data[0] | (data[1] << 8));
5155 val = (data[2] | (data[3] << 8));
5158 val = (data[4] | (data[5] << 8));
5161 val = (data[6] | (data[7] << 8));
5168 val = (data[0] | (data[1] << 8));
5171 if (what == GET_CUR || what == GET_MIN || what == GET_MAX)
5172 val = uaudio_mixer_signext(mc->type, val);
5174 DPRINTFN(3, "val=%d\n", val);
5180 uaudio_mixer_write_cfg_callback(struct usb_xfer *xfer, usb_error_t error)
5182 struct usb_device_request req;
5183 struct uaudio_softc *sc = usbd_xfer_softc(xfer);
5184 struct uaudio_mixer_node *mc = sc->sc_mixer_curr;
5185 struct usb_page_cache *pc;
5194 switch (USB_GET_STATE(xfer)) {
5195 case USB_ST_TRANSFERRED:
5201 mc = sc->sc_mixer_root;
5202 sc->sc_mixer_curr = mc;
5203 sc->sc_mixer_chan = 0;
5207 while (sc->sc_mixer_chan < mc->nchan) {
5209 chan = sc->sc_mixer_chan;
5211 sc->sc_mixer_chan++;
5213 update = ((mc->update[chan / 8] & (1 << (chan % 8))) &&
5214 (mc->wValue[chan] != -1));
5216 mc->update[chan / 8] &= ~(1 << (chan % 8));
5220 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
5221 USETW(req.wValue, mc->wValue[chan]);
5222 USETW(req.wIndex, mc->wIndex);
5224 if (sc->sc_audio_rev >= UAUDIO_VERSION_30) {
5226 } else if (sc->sc_audio_rev >= UAUDIO_VERSION_20) {
5228 req.bRequest = UA20_CS_CUR;
5229 USETW(req.wLength, len);
5231 len = MIX_SIZE(mc->type);
5232 req.bRequest = SET_CUR;
5233 USETW(req.wLength, len);
5236 buf[0] = (mc->wData[chan] & 0xFF);
5237 buf[1] = (mc->wData[chan] >> 8) & 0xFF;
5239 pc = usbd_xfer_get_frame(xfer, 0);
5240 usbd_copy_in(pc, 0, &req, sizeof(req));
5241 pc = usbd_xfer_get_frame(xfer, 1);
5242 usbd_copy_in(pc, 0, buf, len);
5244 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
5245 usbd_xfer_set_frame_len(xfer, 1, len);
5246 usbd_xfer_set_frames(xfer, len ? 2 : 1);
5247 usbd_transfer_submit(xfer);
5253 sc->sc_mixer_curr = mc;
5254 sc->sc_mixer_chan = 0;
5262 default: /* Error */
5263 DPRINTF("error=%s\n", usbd_errstr(error));
5264 if (error == USB_ERR_CANCELLED) {
5265 /* do nothing - we are detaching */
5268 goto tr_transferred;
5273 uaudio_set_speed(struct usb_device *udev, uint8_t endpt, uint32_t speed)
5275 struct usb_device_request req;
5278 DPRINTFN(6, "endpt=%d speed=%u\n", endpt, speed);
5280 req.bmRequestType = UT_WRITE_CLASS_ENDPOINT;
5281 req.bRequest = SET_CUR;
5282 USETW2(req.wValue, SAMPLING_FREQ_CONTROL, 0);
5283 USETW(req.wIndex, endpt);
5284 USETW(req.wLength, 3);
5286 data[1] = speed >> 8;
5287 data[2] = speed >> 16;
5289 return (usbd_do_request(udev, NULL, &req, data));
5293 uaudio20_set_speed(struct usb_device *udev, uint8_t iface_no,
5294 uint8_t clockid, uint32_t speed)
5296 struct usb_device_request req;
5299 DPRINTFN(6, "ifaceno=%d clockid=%d speed=%u\n",
5300 iface_no, clockid, speed);
5302 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
5303 req.bRequest = UA20_CS_CUR;
5304 USETW2(req.wValue, UA20_CS_SAM_FREQ_CONTROL, 0);
5305 USETW2(req.wIndex, clockid, iface_no);
5306 USETW(req.wLength, 4);
5308 data[1] = speed >> 8;
5309 data[2] = speed >> 16;
5310 data[3] = speed >> 24;
5312 return (usbd_do_request(udev, NULL, &req, data));
5316 uaudio_mixer_signext(uint8_t type, int val)
5318 if (!MIX_UNSIGNED(type)) {
5319 if (MIX_SIZE(type) == 2) {
5329 uaudio_mixer_bsd2value(struct uaudio_mixer_node *mc, int32_t val)
5331 if (mc->type == MIX_ON_OFF) {
5333 } else if (mc->type == MIX_SELECTOR) {
5334 if ((val < mc->minval) ||
5335 (val > mc->maxval)) {
5340 /* compute actual volume */
5341 val = (val * mc->mul) / 255;
5343 /* add lower offset */
5344 val = val + mc->minval;
5346 /* make sure we don't write a value out of range */
5347 if (val > mc->maxval)
5349 else if (val < mc->minval)
5353 DPRINTFN(6, "type=0x%03x val=%d min=%d max=%d val=%d\n",
5354 mc->type, val, mc->minval, mc->maxval, val);
5359 uaudio_mixer_ctl_set(struct uaudio_softc *sc, struct uaudio_mixer_node *mc,
5360 uint8_t chan, int32_t val)
5362 val = uaudio_mixer_bsd2value(mc, val);
5364 mc->update[chan / 8] |= (1 << (chan % 8));
5365 mc->wData[chan] = val;
5367 /* start the transfer, if not already started */
5369 usbd_transfer_start(sc->sc_mixer_xfer[0]);
5373 uaudio_mixer_init(struct uaudio_softc *sc)
5375 struct uaudio_mixer_node *mc;
5378 for (mc = sc->sc_mixer_root; mc;
5381 if (mc->ctl != SOUND_MIXER_NRDEVICES) {
5383 * Set device mask bits. See
5384 * /usr/include/machine/soundcard.h
5386 sc->sc_mix_info |= (1 << mc->ctl);
5388 if ((mc->ctl == SOUND_MIXER_NRDEVICES) &&
5389 (mc->type == MIX_SELECTOR)) {
5391 for (i = mc->minval; (i > 0) && (i <= mc->maxval); i++) {
5392 if (mc->slctrtype[i - 1] == SOUND_MIXER_NRDEVICES) {
5395 sc->sc_recsrc_info |= 1 << mc->slctrtype[i - 1];
5402 uaudio_mixer_init_sub(struct uaudio_softc *sc, struct snd_mixer *m)
5406 sc->sc_mixer_lock = mixer_get_lock(m);
5407 sc->sc_mixer_dev = m;
5409 if (usbd_transfer_setup(sc->sc_udev, &sc->sc_mixer_iface_index,
5410 sc->sc_mixer_xfer, uaudio_mixer_config, 1, sc,
5411 sc->sc_mixer_lock)) {
5412 DPRINTFN(0, "could not allocate USB "
5413 "transfer for audio mixer!\n");
5416 if (!(sc->sc_mix_info & SOUND_MASK_VOLUME)) {
5417 mix_setparentchild(m, SOUND_MIXER_VOLUME, SOUND_MASK_PCM);
5418 mix_setrealdev(m, SOUND_MIXER_VOLUME, SOUND_MIXER_NONE);
5420 mix_setdevs(m, sc->sc_mix_info);
5421 mix_setrecdevs(m, sc->sc_recsrc_info);
5426 uaudio_mixer_uninit_sub(struct uaudio_softc *sc)
5430 usbd_transfer_unsetup(sc->sc_mixer_xfer, 1);
5432 sc->sc_mixer_lock = NULL;
5438 uaudio_mixer_set(struct uaudio_softc *sc, unsigned type,
5439 unsigned left, unsigned right)
5441 struct uaudio_mixer_node *mc;
5444 for (mc = sc->sc_mixer_root; mc != NULL; mc = mc->next) {
5446 if (mc->ctl == type) {
5447 for (chan = 0; chan < mc->nchan; chan++) {
5448 uaudio_mixer_ctl_set(sc, mc, chan,
5449 (int)((chan == 0 ? left : right) *
5457 uaudio_mixer_setrecsrc(struct uaudio_softc *sc, uint32_t src)
5459 struct uaudio_mixer_node *mc;
5464 for (mc = sc->sc_mixer_root; mc;
5467 if ((mc->ctl == SOUND_MIXER_NRDEVICES) &&
5468 (mc->type == MIX_SELECTOR)) {
5470 /* compute selector mask */
5473 for (i = mc->minval; (i > 0) && (i <= mc->maxval); i++) {
5474 mask |= (1 << mc->slctrtype[i - 1]);
5481 /* find the first set bit */
5482 temp = (-temp) & temp;
5488 for (i = mc->minval; (i > 0) && (i <= mc->maxval); i++) {
5489 if (temp != (1 << mc->slctrtype[i - 1])) {
5492 uaudio_mixer_ctl_set(sc, mc, 0, i);
5500 /*========================================================================*
5501 * MIDI support routines
5502 *========================================================================*/
5505 umidi_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
5507 struct umidi_chan *chan = usbd_xfer_softc(xfer);
5508 struct umidi_sub_chan *sub;
5509 struct usb_page_cache *pc;
5516 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
5518 switch (USB_GET_STATE(xfer)) {
5519 case USB_ST_TRANSFERRED:
5521 DPRINTF("actlen=%d bytes\n", actlen);
5524 pc = usbd_xfer_get_frame(xfer, 0);
5526 while (actlen >= 4) {
5528 /* copy out the MIDI data */
5529 usbd_copy_out(pc, pos, buf, 4);
5530 /* command length */
5531 cmd_len = umidi_cmd_to_len[buf[0] & 0xF];
5535 * Lookup sub-channel. The index is range
5538 sub = &chan->sub[cn];
5540 if ((cmd_len != 0) && (cn < chan->max_emb_jack) &&
5541 (sub->read_open != 0)) {
5543 /* Send data to the application */
5544 usb_fifo_put_data_linear(
5545 sub->fifo.fp[USB_FIFO_RX],
5546 buf + 1, cmd_len, 1);
5555 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
5556 usbd_transfer_submit(xfer);
5560 DPRINTF("error=%s\n", usbd_errstr(error));
5562 if (error != USB_ERR_CANCELLED) {
5563 /* try to clear stall first */
5564 usbd_xfer_set_stall(xfer);
5572 * The following statemachine, that converts MIDI commands to
5573 * USB MIDI packets, derives from Linux's usbmidi.c, which
5574 * was written by "Clemens Ladisch":
5578 * Else: Command is complete
5581 umidi_convert_to_usb(struct umidi_sub_chan *sub, uint8_t cn, uint8_t b)
5583 uint8_t p0 = (cn << 4);
5586 sub->temp_0[0] = p0 | 0x0f;
5590 sub->temp_cmd = sub->temp_0;
5593 } else if (b >= 0xf0) {
5595 case 0xf0: /* system exclusive begin */
5597 sub->state = UMIDI_ST_SYSEX_1;
5599 case 0xf1: /* MIDI time code */
5600 case 0xf3: /* song select */
5602 sub->state = UMIDI_ST_1PARAM;
5604 case 0xf2: /* song position pointer */
5606 sub->state = UMIDI_ST_2PARAM_1;
5608 case 0xf4: /* unknown */
5609 case 0xf5: /* unknown */
5610 sub->state = UMIDI_ST_UNKNOWN;
5612 case 0xf6: /* tune request */
5613 sub->temp_1[0] = p0 | 0x05;
5614 sub->temp_1[1] = 0xf6;
5617 sub->temp_cmd = sub->temp_1;
5618 sub->state = UMIDI_ST_UNKNOWN;
5621 case 0xf7: /* system exclusive end */
5622 switch (sub->state) {
5623 case UMIDI_ST_SYSEX_0:
5624 sub->temp_1[0] = p0 | 0x05;
5625 sub->temp_1[1] = 0xf7;
5628 sub->temp_cmd = sub->temp_1;
5629 sub->state = UMIDI_ST_UNKNOWN;
5631 case UMIDI_ST_SYSEX_1:
5632 sub->temp_1[0] = p0 | 0x06;
5633 sub->temp_1[2] = 0xf7;
5635 sub->temp_cmd = sub->temp_1;
5636 sub->state = UMIDI_ST_UNKNOWN;
5638 case UMIDI_ST_SYSEX_2:
5639 sub->temp_1[0] = p0 | 0x07;
5640 sub->temp_1[3] = 0xf7;
5641 sub->temp_cmd = sub->temp_1;
5642 sub->state = UMIDI_ST_UNKNOWN;
5645 sub->state = UMIDI_ST_UNKNOWN;
5648 } else if (b >= 0x80) {
5650 if ((b >= 0xc0) && (b <= 0xdf)) {
5651 sub->state = UMIDI_ST_1PARAM;
5653 sub->state = UMIDI_ST_2PARAM_1;
5655 } else { /* b < 0x80 */
5656 switch (sub->state) {
5657 case UMIDI_ST_1PARAM:
5658 if (sub->temp_1[1] < 0xf0) {
5659 p0 |= sub->temp_1[1] >> 4;
5662 sub->state = UMIDI_ST_UNKNOWN;
5664 sub->temp_1[0] = p0;
5667 sub->temp_cmd = sub->temp_1;
5669 case UMIDI_ST_2PARAM_1:
5671 sub->state = UMIDI_ST_2PARAM_2;
5673 case UMIDI_ST_2PARAM_2:
5674 if (sub->temp_1[1] < 0xf0) {
5675 p0 |= sub->temp_1[1] >> 4;
5676 sub->state = UMIDI_ST_2PARAM_1;
5679 sub->state = UMIDI_ST_UNKNOWN;
5681 sub->temp_1[0] = p0;
5683 sub->temp_cmd = sub->temp_1;
5685 case UMIDI_ST_SYSEX_0:
5687 sub->state = UMIDI_ST_SYSEX_1;
5689 case UMIDI_ST_SYSEX_1:
5691 sub->state = UMIDI_ST_SYSEX_2;
5693 case UMIDI_ST_SYSEX_2:
5694 sub->temp_1[0] = p0 | 0x04;
5696 sub->temp_cmd = sub->temp_1;
5697 sub->state = UMIDI_ST_SYSEX_0;
5707 umidi_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
5709 struct umidi_chan *chan = usbd_xfer_softc(xfer);
5710 struct umidi_sub_chan *sub;
5711 struct usb_page_cache *pc;
5715 uint8_t start_cable;
5719 usbd_xfer_status(xfer, &len, NULL, NULL, NULL);
5722 * NOTE: Some MIDI devices only accept 4 bytes of data per
5723 * short terminated USB transfer.
5725 switch (USB_GET_STATE(xfer)) {
5726 case USB_ST_TRANSFERRED:
5727 DPRINTF("actlen=%d bytes\n", len);
5733 nframes = 0; /* reset */
5734 start_cable = chan->curr_cable;
5736 pc = usbd_xfer_get_frame(xfer, 0);
5740 /* round robin de-queueing */
5742 sub = &chan->sub[chan->curr_cable];
5744 if (sub->write_open) {
5745 usb_fifo_get_data_linear(sub->fifo.fp[USB_FIFO_TX],
5746 &buf, 1, &actlen, 0);
5755 DPRINTF("byte=0x%02x from FIFO %u\n", buf,
5756 (unsigned int)chan->curr_cable);
5758 if (umidi_convert_to_usb(sub, chan->curr_cable, buf)) {
5760 DPRINTF("sub=0x%02x 0x%02x 0x%02x 0x%02x\n",
5761 sub->temp_cmd[0], sub->temp_cmd[1],
5762 sub->temp_cmd[2], sub->temp_cmd[3]);
5764 usbd_copy_in(pc, nframes * 4, sub->temp_cmd, 4);
5768 if ((nframes >= UMIDI_TX_FRAMES) || (chan->single_command != 0))
5776 if (chan->curr_cable >= chan->max_emb_jack)
5777 chan->curr_cable = 0;
5779 if (chan->curr_cable == start_cable) {
5787 DPRINTF("Transferring %d frames\n", (int)nframes);
5788 usbd_xfer_set_frame_len(xfer, 0, 4 * nframes);
5789 usbd_transfer_submit(xfer);
5793 default: /* Error */
5795 DPRINTF("error=%s\n", usbd_errstr(error));
5797 if (error != USB_ERR_CANCELLED) {
5798 /* try to clear stall first */
5799 usbd_xfer_set_stall(xfer);
5806 static struct umidi_sub_chan *
5807 umidi_sub_by_fifo(struct usb_fifo *fifo)
5809 struct umidi_chan *chan = usb_fifo_softc(fifo);
5810 struct umidi_sub_chan *sub;
5813 for (n = 0; n < UMIDI_EMB_JACK_MAX; n++) {
5814 sub = &chan->sub[n];
5815 if ((sub->fifo.fp[USB_FIFO_RX] == fifo) ||
5816 (sub->fifo.fp[USB_FIFO_TX] == fifo)) {
5821 panic("%s:%d cannot find usb_fifo!\n",
5822 __FILE__, __LINE__);
5828 umidi_start_read(struct usb_fifo *fifo)
5830 struct umidi_chan *chan = usb_fifo_softc(fifo);
5832 usbd_transfer_start(chan->xfer[UMIDI_RX_TRANSFER]);
5836 umidi_stop_read(struct usb_fifo *fifo)
5838 struct umidi_chan *chan = usb_fifo_softc(fifo);
5839 struct umidi_sub_chan *sub = umidi_sub_by_fifo(fifo);
5845 if (--(chan->read_open_refcount) == 0) {
5847 * XXX don't stop the read transfer here, hence that causes
5848 * problems with some MIDI adapters
5850 DPRINTF("(stopping read transfer)\n");
5855 umidi_start_write(struct usb_fifo *fifo)
5857 struct umidi_chan *chan = usb_fifo_softc(fifo);
5859 if (chan->xfer[UMIDI_TX_TRANSFER] == NULL) {
5864 usb_fifo_get_data_linear(fifo, buf, 1, &actlen, 0);
5865 } while (actlen > 0);
5867 usbd_transfer_start(chan->xfer[UMIDI_TX_TRANSFER]);
5872 umidi_stop_write(struct usb_fifo *fifo)
5874 struct umidi_chan *chan = usb_fifo_softc(fifo);
5875 struct umidi_sub_chan *sub = umidi_sub_by_fifo(fifo);
5879 sub->write_open = 0;
5881 if (--(chan->write_open_refcount) == 0) {
5882 DPRINTF("(stopping write transfer)\n");
5883 usbd_transfer_stop(chan->xfer[UMIDI_TX_TRANSFER]);
5888 umidi_open(struct usb_fifo *fifo, int fflags)
5890 struct umidi_chan *chan = usb_fifo_softc(fifo);
5891 struct umidi_sub_chan *sub = umidi_sub_by_fifo(fifo);
5893 if (fflags & FREAD) {
5894 if (usb_fifo_alloc_buffer(fifo, 4, (1024 / 4))) {
5897 mtx_lock(&chan->mtx);
5898 chan->read_open_refcount++;
5900 mtx_unlock(&chan->mtx);
5902 if (fflags & FWRITE) {
5903 if (usb_fifo_alloc_buffer(fifo, 32, (1024 / 32))) {
5906 /* clear stall first */
5907 mtx_lock(&chan->mtx);
5908 chan->write_open_refcount++;
5909 sub->write_open = 1;
5912 sub->state = UMIDI_ST_UNKNOWN;
5913 mtx_unlock(&chan->mtx);
5915 return (0); /* success */
5919 umidi_close(struct usb_fifo *fifo, int fflags)
5921 if (fflags & FREAD) {
5922 usb_fifo_free_buffer(fifo);
5924 if (fflags & FWRITE) {
5925 usb_fifo_free_buffer(fifo);
5931 umidi_ioctl(struct usb_fifo *fifo, u_long cmd, void *data,
5938 umidi_init(device_t dev)
5940 struct uaudio_softc *sc = device_get_softc(dev);
5941 struct umidi_chan *chan = &sc->sc_midi_chan;
5943 mtx_init(&chan->mtx, "umidi lock", NULL, MTX_DEF | MTX_RECURSE);
5946 static struct usb_fifo_methods umidi_fifo_methods = {
5947 .f_start_read = &umidi_start_read,
5948 .f_start_write = &umidi_start_write,
5949 .f_stop_read = &umidi_stop_read,
5950 .f_stop_write = &umidi_stop_write,
5951 .f_open = &umidi_open,
5952 .f_close = &umidi_close,
5953 .f_ioctl = &umidi_ioctl,
5954 .basename[0] = "umidi",
5958 umidi_probe(device_t dev)
5960 struct uaudio_softc *sc = device_get_softc(dev);
5961 struct usb_attach_arg *uaa = device_get_ivars(dev);
5962 struct umidi_chan *chan = &sc->sc_midi_chan;
5963 struct umidi_sub_chan *sub;
5964 int unit = device_get_unit(dev);
5968 if (usb_test_quirk(uaa, UQ_SINGLE_CMD_MIDI))
5969 chan->single_command = 1;
5971 if (usbd_set_alt_interface_index(sc->sc_udev, chan->iface_index,
5972 chan->iface_alt_index)) {
5973 DPRINTF("setting of alternate index failed!\n");
5976 usbd_set_parent_iface(sc->sc_udev, chan->iface_index,
5977 sc->sc_mixer_iface_index);
5979 error = usbd_transfer_setup(uaa->device, &chan->iface_index,
5980 chan->xfer, umidi_config, UMIDI_N_TRANSFER,
5983 DPRINTF("error=%s\n", usbd_errstr(error));
5986 if (chan->xfer[UMIDI_TX_TRANSFER] == NULL &&
5987 chan->xfer[UMIDI_RX_TRANSFER] == NULL) {
5988 DPRINTF("no BULK or INTERRUPT MIDI endpoint(s) found\n");
5993 * Some USB MIDI device makers couldn't resist using
5994 * wMaxPacketSize = 4 for RX and TX BULK endpoints, although
5995 * that size is an unsupported value for FULL speed BULK
5996 * endpoints. The same applies to some HIGH speed MIDI devices
5997 * which are using a wMaxPacketSize different from 512 bytes.
5999 * Refer to section 5.8.3 in USB 2.0 PDF: Cite: "All Host
6000 * Controllers are required to have support for 8-, 16-, 32-,
6001 * and 64-byte maximum packet sizes for full-speed bulk
6002 * endpoints and 512 bytes for high-speed bulk endpoints."
6004 if (chan->xfer[UMIDI_TX_TRANSFER] != NULL &&
6005 usbd_xfer_maxp_was_clamped(chan->xfer[UMIDI_TX_TRANSFER]))
6006 chan->single_command = 1;
6008 if (chan->single_command != 0)
6009 device_printf(dev, "Single command MIDI quirk enabled\n");
6011 if ((chan->max_emb_jack == 0) ||
6012 (chan->max_emb_jack > UMIDI_EMB_JACK_MAX)) {
6013 chan->max_emb_jack = UMIDI_EMB_JACK_MAX;
6016 for (n = 0; n < chan->max_emb_jack; n++) {
6018 sub = &chan->sub[n];
6020 error = usb_fifo_attach(sc->sc_udev, chan, &chan->mtx,
6021 &umidi_fifo_methods, &sub->fifo, unit, n,
6023 UID_ROOT, GID_OPERATOR, 0644);
6029 mtx_lock(&chan->mtx);
6032 * NOTE: At least one device will not work properly unless the
6033 * BULK IN pipe is open all the time. This might have to do
6034 * about that the internal queues of the device overflow if we
6035 * don't read them regularly.
6037 usbd_transfer_start(chan->xfer[UMIDI_RX_TRANSFER]);
6039 mtx_unlock(&chan->mtx);
6041 return (0); /* success */
6044 return (ENXIO); /* failure */
6048 umidi_detach(device_t dev)
6050 struct uaudio_softc *sc = device_get_softc(dev);
6051 struct umidi_chan *chan = &sc->sc_midi_chan;
6054 for (n = 0; n < UMIDI_EMB_JACK_MAX; n++)
6055 usb_fifo_detach(&chan->sub[n].fifo);
6057 mtx_lock(&chan->mtx);
6059 usbd_transfer_stop(chan->xfer[UMIDI_RX_TRANSFER]);
6061 mtx_unlock(&chan->mtx);
6063 usbd_transfer_unsetup(chan->xfer, UMIDI_N_TRANSFER);
6065 mtx_destroy(&chan->mtx);
6071 uaudio_hid_rx_callback(struct usb_xfer *xfer, usb_error_t error)
6073 struct uaudio_softc *sc = usbd_xfer_softc(xfer);
6074 const uint8_t *buffer = usbd_xfer_get_frame_buffer(xfer, 0);
6075 struct snd_mixer *m;
6079 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
6081 switch (USB_GET_STATE(xfer)) {
6082 case USB_ST_TRANSFERRED:
6083 DPRINTF("actlen=%d\n", actlen);
6086 (sc->sc_hid.flags & UAUDIO_HID_HAS_ID)) {
6094 m = sc->sc_mixer_dev;
6096 if ((sc->sc_hid.flags & UAUDIO_HID_HAS_MUTE) &&
6097 (sc->sc_hid.mute_id == id) &&
6098 hid_get_data(buffer, actlen,
6099 &sc->sc_hid.mute_loc)) {
6101 DPRINTF("Mute toggle\n");
6103 mixer_hwvol_mute_locked(m);
6106 if ((sc->sc_hid.flags & UAUDIO_HID_HAS_VOLUME_UP) &&
6107 (sc->sc_hid.volume_up_id == id) &&
6108 hid_get_data(buffer, actlen,
6109 &sc->sc_hid.volume_up_loc)) {
6111 DPRINTF("Volume Up\n");
6113 mixer_hwvol_step_locked(m, 1, 1);
6116 if ((sc->sc_hid.flags & UAUDIO_HID_HAS_VOLUME_DOWN) &&
6117 (sc->sc_hid.volume_down_id == id) &&
6118 hid_get_data(buffer, actlen,
6119 &sc->sc_hid.volume_down_loc)) {
6121 DPRINTF("Volume Down\n");
6123 mixer_hwvol_step_locked(m, -1, -1);
6128 /* check if we can put more data into the FIFO */
6129 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
6130 usbd_transfer_submit(xfer);
6133 default: /* Error */
6135 DPRINTF("error=%s\n", usbd_errstr(error));
6137 if (error != USB_ERR_CANCELLED) {
6138 /* try to clear stall first */
6139 usbd_xfer_set_stall(xfer);
6147 uaudio_hid_probe(struct uaudio_softc *sc,
6148 struct usb_attach_arg *uaa)
6156 if (!(sc->sc_hid.flags & UAUDIO_HID_VALID))
6159 if (sc->sc_mixer_lock == NULL)
6162 /* Get HID descriptor */
6163 error = usbd_req_get_hid_desc(uaa->device, NULL, &d_ptr,
6164 &d_len, M_TEMP, sc->sc_hid.iface_index);
6167 DPRINTF("error reading report description\n");
6171 /* check if there is an ID byte */
6172 hid_report_size(d_ptr, d_len, hid_input, &id);
6175 sc->sc_hid.flags |= UAUDIO_HID_HAS_ID;
6177 if (hid_locate(d_ptr, d_len,
6178 HID_USAGE2(HUP_CONSUMER, 0xE9 /* Volume Increment */),
6179 hid_input, 0, &sc->sc_hid.volume_up_loc, &flags,
6180 &sc->sc_hid.volume_up_id)) {
6181 if (flags & HIO_VARIABLE)
6182 sc->sc_hid.flags |= UAUDIO_HID_HAS_VOLUME_UP;
6183 DPRINTFN(1, "Found Volume Up key\n");
6186 if (hid_locate(d_ptr, d_len,
6187 HID_USAGE2(HUP_CONSUMER, 0xEA /* Volume Decrement */),
6188 hid_input, 0, &sc->sc_hid.volume_down_loc, &flags,
6189 &sc->sc_hid.volume_down_id)) {
6190 if (flags & HIO_VARIABLE)
6191 sc->sc_hid.flags |= UAUDIO_HID_HAS_VOLUME_DOWN;
6192 DPRINTFN(1, "Found Volume Down key\n");
6195 if (hid_locate(d_ptr, d_len,
6196 HID_USAGE2(HUP_CONSUMER, 0xE2 /* Mute */),
6197 hid_input, 0, &sc->sc_hid.mute_loc, &flags,
6198 &sc->sc_hid.mute_id)) {
6199 if (flags & HIO_VARIABLE)
6200 sc->sc_hid.flags |= UAUDIO_HID_HAS_MUTE;
6201 DPRINTFN(1, "Found Mute key\n");
6204 free(d_ptr, M_TEMP);
6206 if (!(sc->sc_hid.flags & (UAUDIO_HID_HAS_VOLUME_UP |
6207 UAUDIO_HID_HAS_VOLUME_DOWN |
6208 UAUDIO_HID_HAS_MUTE))) {
6209 DPRINTFN(1, "Did not find any volume related keys\n");
6213 /* prevent the uhid driver from attaching */
6214 usbd_set_parent_iface(uaa->device, sc->sc_hid.iface_index,
6215 sc->sc_mixer_iface_index);
6217 /* allocate USB transfers */
6218 error = usbd_transfer_setup(uaa->device, &sc->sc_hid.iface_index,
6219 sc->sc_hid.xfer, uaudio_hid_config, UAUDIO_HID_N_TRANSFER,
6220 sc, sc->sc_mixer_lock);
6222 DPRINTF("error=%s\n", usbd_errstr(error));
6229 uaudio_hid_detach(struct uaudio_softc *sc)
6231 usbd_transfer_unsetup(sc->sc_hid.xfer, UAUDIO_HID_N_TRANSFER);
6234 DRIVER_MODULE_ORDERED(uaudio, uhub, uaudio_driver, uaudio_devclass, NULL, 0, SI_ORDER_ANY);
6235 MODULE_DEPEND(uaudio, usb, 1, 1, 1);
6236 MODULE_DEPEND(uaudio, sound, SOUND_MINVER, SOUND_PREFVER, SOUND_MAXVER);
6237 MODULE_VERSION(uaudio, 1);
6238 USB_PNP_HOST_INFO(uaudio_devs);