2 * f_uac2.c -- USB Audio Class 2.0 Function
5 * Yadwinder Singh (yadi.brar01@gmail.com)
6 * Jaswinder Singh (jaswinder.singh@linaro.org)
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
14 #include <linux/usb/audio.h>
15 #include <linux/usb/audio-v2.h>
16 #include <linux/platform_device.h>
17 #include <linux/module.h>
19 #include <sound/core.h>
20 #include <sound/pcm.h>
21 #include <sound/pcm_params.h>
23 /* Playback(USB-IN) Default Stereo - Fl/Fr */
24 static int p_chmask = 0x3;
25 module_param(p_chmask, uint, S_IRUGO);
26 MODULE_PARM_DESC(p_chmask, "Playback Channel Mask");
28 /* Playback Default 48 KHz */
29 static int p_srate = 48000;
30 module_param(p_srate, uint, S_IRUGO);
31 MODULE_PARM_DESC(p_srate, "Playback Sampling Rate");
33 /* Playback Default 16bits/sample */
34 static int p_ssize = 2;
35 module_param(p_ssize, uint, S_IRUGO);
36 MODULE_PARM_DESC(p_ssize, "Playback Sample Size(bytes)");
38 /* Capture(USB-OUT) Default Stereo - Fl/Fr */
39 static int c_chmask = 0x3;
40 module_param(c_chmask, uint, S_IRUGO);
41 MODULE_PARM_DESC(c_chmask, "Capture Channel Mask");
43 /* Capture Default 64 KHz */
44 static int c_srate = 64000;
45 module_param(c_srate, uint, S_IRUGO);
46 MODULE_PARM_DESC(c_srate, "Capture Sampling Rate");
48 /* Capture Default 16bits/sample */
49 static int c_ssize = 2;
50 module_param(c_ssize, uint, S_IRUGO);
51 MODULE_PARM_DESC(c_ssize, "Capture Sample Size(bytes)");
53 /* Keep everyone on toes */
57 * The driver implements a simple UAC_2 topology.
58 * USB-OUT -> IT_1 -> OT_3 -> ALSA_Capture
59 * ALSA_Playback -> IT_2 -> OT_4 -> USB-IN
60 * Capture and Playback sampling rates are independently
61 * controlled by two clock sources :
62 * CLK_5 := c_srate, and CLK_6 := p_srate
64 #define USB_OUT_IT_ID 1
66 #define IO_OUT_OT_ID 3
67 #define USB_IN_OT_ID 4
68 #define USB_OUT_CLK_ID 5
69 #define USB_IN_CLK_ID 6
71 #define CONTROL_ABSENT 0
72 #define CONTROL_RDONLY 1
73 #define CONTROL_RDWR 3
75 #define CLK_FREQ_CTRL 0
76 #define CLK_VLD_CTRL 2
85 const char *uac2_name = "snd_uac2";
88 struct uac2_rtd_params *pp; /* parent param */
89 struct usb_request *req;
92 struct uac2_rtd_params {
93 bool ep_enabled; /* if the ep is enabled */
94 /* Size of the ring buffer */
96 unsigned char *dma_area;
98 struct snd_pcm_substream *ss;
108 struct uac2_req ureq[USB_XFERS];
113 struct snd_uac2_chip {
114 struct platform_device pdev;
115 struct platform_driver pdrv;
117 struct uac2_rtd_params p_prm;
118 struct uac2_rtd_params c_prm;
120 struct snd_card *card;
124 #define BUFF_SIZE_MAX (PAGE_SIZE * 16)
125 #define PRD_SIZE_MAX PAGE_SIZE
126 #define MIN_PERIODS 4
128 static struct snd_pcm_hardware uac2_pcm_hardware = {
129 .info = SNDRV_PCM_INFO_INTERLEAVED | SNDRV_PCM_INFO_BLOCK_TRANSFER
130 | SNDRV_PCM_INFO_MMAP | SNDRV_PCM_INFO_MMAP_VALID
131 | SNDRV_PCM_INFO_PAUSE | SNDRV_PCM_INFO_RESUME,
132 .rates = SNDRV_PCM_RATE_CONTINUOUS,
133 .periods_max = BUFF_SIZE_MAX / PRD_SIZE_MAX,
134 .buffer_bytes_max = BUFF_SIZE_MAX,
135 .period_bytes_max = PRD_SIZE_MAX,
136 .periods_min = MIN_PERIODS,
141 u8 as_out_intf, as_out_alt;
142 u8 as_in_intf, as_in_alt;
144 struct usb_ep *in_ep, *out_ep;
145 struct usb_function func;
147 /* The ALSA Sound Card it represents on the USB-Client side */
148 struct snd_uac2_chip uac2;
151 static struct audio_dev *agdev_g;
154 struct audio_dev *func_to_agdev(struct usb_function *f)
156 return container_of(f, struct audio_dev, func);
160 struct audio_dev *uac2_to_agdev(struct snd_uac2_chip *u)
162 return container_of(u, struct audio_dev, uac2);
166 struct snd_uac2_chip *pdev_to_uac2(struct platform_device *p)
168 return container_of(p, struct snd_uac2_chip, pdev);
172 struct snd_uac2_chip *prm_to_uac2(struct uac2_rtd_params *r)
174 struct snd_uac2_chip *uac2 = container_of(r,
175 struct snd_uac2_chip, c_prm);
177 if (&uac2->c_prm != r)
178 uac2 = container_of(r, struct snd_uac2_chip, p_prm);
184 uint num_channels(uint chanmask)
189 num += (chanmask & 1);
197 agdev_iso_complete(struct usb_ep *ep, struct usb_request *req)
201 bool update_alsa = false;
202 unsigned char *src, *dst;
203 int status = req->status;
204 struct uac2_req *ur = req->context;
205 struct snd_pcm_substream *substream;
206 struct uac2_rtd_params *prm = ur->pp;
207 struct snd_uac2_chip *uac2 = prm_to_uac2(prm);
209 /* i/f shutting down */
210 if (!prm->ep_enabled)
214 * We can't really do much about bad xfers.
215 * Afterall, the ISOCH xfers could fail legitimately.
218 pr_debug("%s: iso_complete status(%d) %d/%d\n",
219 __func__, status, req->actual, req->length);
223 /* Do nothing if ALSA isn't active */
227 spin_lock_irqsave(&prm->lock, flags);
229 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
230 src = prm->dma_area + prm->hw_ptr;
231 req->actual = req->length;
234 dst = prm->dma_area + prm->hw_ptr;
238 pending = prm->hw_ptr % prm->period_size;
239 pending += req->actual;
240 if (pending >= prm->period_size)
243 prm->hw_ptr = (prm->hw_ptr + req->actual) % prm->dma_bytes;
245 spin_unlock_irqrestore(&prm->lock, flags);
247 /* Pack USB load in ALSA ring buffer */
248 memcpy(dst, src, req->actual);
250 if (usb_ep_queue(ep, req, GFP_ATOMIC))
251 dev_err(&uac2->pdev.dev, "%d Error!\n", __LINE__);
254 snd_pcm_period_elapsed(substream);
260 uac2_pcm_trigger(struct snd_pcm_substream *substream, int cmd)
262 struct snd_uac2_chip *uac2 = snd_pcm_substream_chip(substream);
263 struct uac2_rtd_params *prm;
267 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
272 spin_lock_irqsave(&prm->lock, flags);
278 case SNDRV_PCM_TRIGGER_START:
279 case SNDRV_PCM_TRIGGER_RESUME:
282 case SNDRV_PCM_TRIGGER_STOP:
283 case SNDRV_PCM_TRIGGER_SUSPEND:
290 spin_unlock_irqrestore(&prm->lock, flags);
292 /* Clear buffer after Play stops */
293 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK && !prm->ss)
294 memset(prm->rbuf, 0, prm->max_psize * USB_XFERS);
299 static snd_pcm_uframes_t uac2_pcm_pointer(struct snd_pcm_substream *substream)
301 struct snd_uac2_chip *uac2 = snd_pcm_substream_chip(substream);
302 struct uac2_rtd_params *prm;
304 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
309 return bytes_to_frames(substream->runtime, prm->hw_ptr);
312 static int uac2_pcm_hw_params(struct snd_pcm_substream *substream,
313 struct snd_pcm_hw_params *hw_params)
315 struct snd_uac2_chip *uac2 = snd_pcm_substream_chip(substream);
316 struct uac2_rtd_params *prm;
319 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
324 err = snd_pcm_lib_malloc_pages(substream,
325 params_buffer_bytes(hw_params));
327 prm->dma_bytes = substream->runtime->dma_bytes;
328 prm->dma_area = substream->runtime->dma_area;
329 prm->period_size = params_period_bytes(hw_params);
335 static int uac2_pcm_hw_free(struct snd_pcm_substream *substream)
337 struct snd_uac2_chip *uac2 = snd_pcm_substream_chip(substream);
338 struct uac2_rtd_params *prm;
340 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
345 prm->dma_area = NULL;
347 prm->period_size = 0;
349 return snd_pcm_lib_free_pages(substream);
352 static int uac2_pcm_open(struct snd_pcm_substream *substream)
354 struct snd_uac2_chip *uac2 = snd_pcm_substream_chip(substream);
355 struct snd_pcm_runtime *runtime = substream->runtime;
357 runtime->hw = uac2_pcm_hardware;
359 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
360 spin_lock_init(&uac2->p_prm.lock);
361 runtime->hw.rate_min = p_srate;
362 runtime->hw.formats = SNDRV_PCM_FMTBIT_S16_LE; /* ! p_ssize ! */
363 runtime->hw.channels_min = num_channels(p_chmask);
364 runtime->hw.period_bytes_min = 2 * uac2->p_prm.max_psize
365 / runtime->hw.periods_min;
367 spin_lock_init(&uac2->c_prm.lock);
368 runtime->hw.rate_min = c_srate;
369 runtime->hw.formats = SNDRV_PCM_FMTBIT_S16_LE; /* ! c_ssize ! */
370 runtime->hw.channels_min = num_channels(c_chmask);
371 runtime->hw.period_bytes_min = 2 * uac2->c_prm.max_psize
372 / runtime->hw.periods_min;
375 runtime->hw.rate_max = runtime->hw.rate_min;
376 runtime->hw.channels_max = runtime->hw.channels_min;
378 snd_pcm_hw_constraint_integer(runtime, SNDRV_PCM_HW_PARAM_PERIODS);
383 /* ALSA cries without these function pointers */
384 static int uac2_pcm_null(struct snd_pcm_substream *substream)
389 static struct snd_pcm_ops uac2_pcm_ops = {
390 .open = uac2_pcm_open,
391 .close = uac2_pcm_null,
392 .ioctl = snd_pcm_lib_ioctl,
393 .hw_params = uac2_pcm_hw_params,
394 .hw_free = uac2_pcm_hw_free,
395 .trigger = uac2_pcm_trigger,
396 .pointer = uac2_pcm_pointer,
397 .prepare = uac2_pcm_null,
400 static int snd_uac2_probe(struct platform_device *pdev)
402 struct snd_uac2_chip *uac2 = pdev_to_uac2(pdev);
403 struct snd_card *card;
407 /* Choose any slot, with no id */
408 err = snd_card_create(-1, NULL, THIS_MODULE, 0, &card);
415 * Create first PCM device
416 * Create a substream only for non-zero channel streams
418 err = snd_pcm_new(uac2->card, "UAC2 PCM", 0,
419 p_chmask ? 1 : 0, c_chmask ? 1 : 0, &pcm);
423 strcpy(pcm->name, "UAC2 PCM");
424 pcm->private_data = uac2;
428 snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK, &uac2_pcm_ops);
429 snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &uac2_pcm_ops);
431 strcpy(card->driver, "UAC2_Gadget");
432 strcpy(card->shortname, "UAC2_Gadget");
433 sprintf(card->longname, "UAC2_Gadget %i", pdev->id);
435 snd_card_set_dev(card, &pdev->dev);
437 snd_pcm_lib_preallocate_pages_for_all(pcm, SNDRV_DMA_TYPE_CONTINUOUS,
438 snd_dma_continuous_data(GFP_KERNEL), 0, BUFF_SIZE_MAX);
440 err = snd_card_register(card);
442 platform_set_drvdata(pdev, card);
455 static int snd_uac2_remove(struct platform_device *pdev)
457 struct snd_card *card = platform_get_drvdata(pdev);
460 return snd_card_free(card);
465 static int alsa_uac2_init(struct audio_dev *agdev)
467 struct snd_uac2_chip *uac2 = &agdev->uac2;
470 uac2->pdrv.probe = snd_uac2_probe;
471 uac2->pdrv.remove = snd_uac2_remove;
472 uac2->pdrv.driver.name = uac2_name;
475 uac2->pdev.name = uac2_name;
477 /* Register snd_uac2 driver */
478 err = platform_driver_register(&uac2->pdrv);
482 /* Register snd_uac2 device */
483 err = platform_device_register(&uac2->pdev);
485 platform_driver_unregister(&uac2->pdrv);
490 static void alsa_uac2_exit(struct audio_dev *agdev)
492 struct snd_uac2_chip *uac2 = &agdev->uac2;
494 platform_driver_unregister(&uac2->pdrv);
495 platform_device_unregister(&uac2->pdev);
499 /* --------- USB Function Interface ------------- */
516 static char clksrc_in[8];
517 static char clksrc_out[8];
519 static struct usb_string strings_fn[] = {
520 [STR_ASSOC].s = "Source/Sink",
521 [STR_IF_CTRL].s = "Topology Control",
522 [STR_CLKSRC_IN].s = clksrc_in,
523 [STR_CLKSRC_OUT].s = clksrc_out,
524 [STR_USB_IT].s = "USBH Out",
525 [STR_IO_IT].s = "USBD Out",
526 [STR_USB_OT].s = "USBH In",
527 [STR_IO_OT].s = "USBD In",
528 [STR_AS_OUT_ALT0].s = "Playback Inactive",
529 [STR_AS_OUT_ALT1].s = "Playback Active",
530 [STR_AS_IN_ALT0].s = "Capture Inactive",
531 [STR_AS_IN_ALT1].s = "Capture Active",
535 static struct usb_gadget_strings str_fn = {
536 .language = 0x0409, /* en-us */
537 .strings = strings_fn,
540 static struct usb_gadget_strings *fn_strings[] = {
545 static struct usb_qualifier_descriptor devqual_desc = {
546 .bLength = sizeof devqual_desc,
547 .bDescriptorType = USB_DT_DEVICE_QUALIFIER,
549 .bcdUSB = cpu_to_le16(0x200),
550 .bDeviceClass = USB_CLASS_MISC,
551 .bDeviceSubClass = 0x02,
552 .bDeviceProtocol = 0x01,
553 .bNumConfigurations = 1,
557 static struct usb_interface_assoc_descriptor iad_desc = {
558 .bLength = sizeof iad_desc,
559 .bDescriptorType = USB_DT_INTERFACE_ASSOCIATION,
561 .bFirstInterface = 0,
562 .bInterfaceCount = 3,
563 .bFunctionClass = USB_CLASS_AUDIO,
564 .bFunctionSubClass = UAC2_FUNCTION_SUBCLASS_UNDEFINED,
565 .bFunctionProtocol = UAC_VERSION_2,
568 /* Audio Control Interface */
569 static struct usb_interface_descriptor std_ac_if_desc = {
570 .bLength = sizeof std_ac_if_desc,
571 .bDescriptorType = USB_DT_INTERFACE,
573 .bAlternateSetting = 0,
575 .bInterfaceClass = USB_CLASS_AUDIO,
576 .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL,
577 .bInterfaceProtocol = UAC_VERSION_2,
580 /* Clock source for IN traffic */
581 struct uac_clock_source_descriptor in_clk_src_desc = {
582 .bLength = sizeof in_clk_src_desc,
583 .bDescriptorType = USB_DT_CS_INTERFACE,
585 .bDescriptorSubtype = UAC2_CLOCK_SOURCE,
586 .bClockID = USB_IN_CLK_ID,
587 .bmAttributes = UAC_CLOCK_SOURCE_TYPE_INT_FIXED,
588 .bmControls = (CONTROL_RDONLY << CLK_FREQ_CTRL),
592 /* Clock source for OUT traffic */
593 struct uac_clock_source_descriptor out_clk_src_desc = {
594 .bLength = sizeof out_clk_src_desc,
595 .bDescriptorType = USB_DT_CS_INTERFACE,
597 .bDescriptorSubtype = UAC2_CLOCK_SOURCE,
598 .bClockID = USB_OUT_CLK_ID,
599 .bmAttributes = UAC_CLOCK_SOURCE_TYPE_INT_FIXED,
600 .bmControls = (CONTROL_RDONLY << CLK_FREQ_CTRL),
604 /* Input Terminal for USB_OUT */
605 struct uac2_input_terminal_descriptor usb_out_it_desc = {
606 .bLength = sizeof usb_out_it_desc,
607 .bDescriptorType = USB_DT_CS_INTERFACE,
609 .bDescriptorSubtype = UAC_INPUT_TERMINAL,
610 .bTerminalID = USB_OUT_IT_ID,
611 .wTerminalType = cpu_to_le16(UAC_TERMINAL_STREAMING),
613 .bCSourceID = USB_OUT_CLK_ID,
615 .bmControls = (CONTROL_RDWR << COPY_CTRL),
618 /* Input Terminal for I/O-In */
619 struct uac2_input_terminal_descriptor io_in_it_desc = {
620 .bLength = sizeof io_in_it_desc,
621 .bDescriptorType = USB_DT_CS_INTERFACE,
623 .bDescriptorSubtype = UAC_INPUT_TERMINAL,
624 .bTerminalID = IO_IN_IT_ID,
625 .wTerminalType = cpu_to_le16(UAC_INPUT_TERMINAL_UNDEFINED),
627 .bCSourceID = USB_IN_CLK_ID,
629 .bmControls = (CONTROL_RDWR << COPY_CTRL),
632 /* Ouput Terminal for USB_IN */
633 struct uac2_output_terminal_descriptor usb_in_ot_desc = {
634 .bLength = sizeof usb_in_ot_desc,
635 .bDescriptorType = USB_DT_CS_INTERFACE,
637 .bDescriptorSubtype = UAC_OUTPUT_TERMINAL,
638 .bTerminalID = USB_IN_OT_ID,
639 .wTerminalType = cpu_to_le16(UAC_TERMINAL_STREAMING),
641 .bSourceID = IO_IN_IT_ID,
642 .bCSourceID = USB_IN_CLK_ID,
643 .bmControls = (CONTROL_RDWR << COPY_CTRL),
646 /* Ouput Terminal for I/O-Out */
647 struct uac2_output_terminal_descriptor io_out_ot_desc = {
648 .bLength = sizeof io_out_ot_desc,
649 .bDescriptorType = USB_DT_CS_INTERFACE,
651 .bDescriptorSubtype = UAC_OUTPUT_TERMINAL,
652 .bTerminalID = IO_OUT_OT_ID,
653 .wTerminalType = cpu_to_le16(UAC_OUTPUT_TERMINAL_UNDEFINED),
655 .bSourceID = USB_OUT_IT_ID,
656 .bCSourceID = USB_OUT_CLK_ID,
657 .bmControls = (CONTROL_RDWR << COPY_CTRL),
660 struct uac2_ac_header_descriptor ac_hdr_desc = {
661 .bLength = sizeof ac_hdr_desc,
662 .bDescriptorType = USB_DT_CS_INTERFACE,
664 .bDescriptorSubtype = UAC_MS_HEADER,
665 .bcdADC = cpu_to_le16(0x200),
666 .bCategory = UAC2_FUNCTION_IO_BOX,
667 .wTotalLength = sizeof in_clk_src_desc + sizeof out_clk_src_desc
668 + sizeof usb_out_it_desc + sizeof io_in_it_desc
669 + sizeof usb_in_ot_desc + sizeof io_out_ot_desc,
673 /* Audio Streaming OUT Interface - Alt0 */
674 static struct usb_interface_descriptor std_as_out_if0_desc = {
675 .bLength = sizeof std_as_out_if0_desc,
676 .bDescriptorType = USB_DT_INTERFACE,
678 .bAlternateSetting = 0,
680 .bInterfaceClass = USB_CLASS_AUDIO,
681 .bInterfaceSubClass = USB_SUBCLASS_AUDIOSTREAMING,
682 .bInterfaceProtocol = UAC_VERSION_2,
685 /* Audio Streaming OUT Interface - Alt1 */
686 static struct usb_interface_descriptor std_as_out_if1_desc = {
687 .bLength = sizeof std_as_out_if1_desc,
688 .bDescriptorType = USB_DT_INTERFACE,
690 .bAlternateSetting = 1,
692 .bInterfaceClass = USB_CLASS_AUDIO,
693 .bInterfaceSubClass = USB_SUBCLASS_AUDIOSTREAMING,
694 .bInterfaceProtocol = UAC_VERSION_2,
697 /* Audio Stream OUT Intface Desc */
698 struct uac2_as_header_descriptor as_out_hdr_desc = {
699 .bLength = sizeof as_out_hdr_desc,
700 .bDescriptorType = USB_DT_CS_INTERFACE,
702 .bDescriptorSubtype = UAC_AS_GENERAL,
703 .bTerminalLink = USB_OUT_IT_ID,
705 .bFormatType = UAC_FORMAT_TYPE_I,
706 .bmFormats = cpu_to_le32(UAC_FORMAT_TYPE_I_PCM),
710 /* Audio USB_OUT Format */
711 struct uac2_format_type_i_descriptor as_out_fmt1_desc = {
712 .bLength = sizeof as_out_fmt1_desc,
713 .bDescriptorType = USB_DT_CS_INTERFACE,
714 .bDescriptorSubtype = UAC_FORMAT_TYPE,
715 .bFormatType = UAC_FORMAT_TYPE_I,
718 /* STD AS ISO OUT Endpoint */
719 struct usb_endpoint_descriptor fs_epout_desc = {
720 .bLength = USB_DT_ENDPOINT_SIZE,
721 .bDescriptorType = USB_DT_ENDPOINT,
723 .bEndpointAddress = USB_DIR_OUT,
724 .bmAttributes = USB_ENDPOINT_XFER_ISOC | USB_ENDPOINT_SYNC_ASYNC,
728 struct usb_endpoint_descriptor hs_epout_desc = {
729 .bLength = USB_DT_ENDPOINT_SIZE,
730 .bDescriptorType = USB_DT_ENDPOINT,
732 .bmAttributes = USB_ENDPOINT_XFER_ISOC | USB_ENDPOINT_SYNC_ASYNC,
736 /* CS AS ISO OUT Endpoint */
737 static struct uac2_iso_endpoint_descriptor as_iso_out_desc = {
738 .bLength = sizeof as_iso_out_desc,
739 .bDescriptorType = USB_DT_CS_ENDPOINT,
741 .bDescriptorSubtype = UAC_EP_GENERAL,
744 .bLockDelayUnits = 0,
748 /* Audio Streaming IN Interface - Alt0 */
749 static struct usb_interface_descriptor std_as_in_if0_desc = {
750 .bLength = sizeof std_as_in_if0_desc,
751 .bDescriptorType = USB_DT_INTERFACE,
753 .bAlternateSetting = 0,
755 .bInterfaceClass = USB_CLASS_AUDIO,
756 .bInterfaceSubClass = USB_SUBCLASS_AUDIOSTREAMING,
757 .bInterfaceProtocol = UAC_VERSION_2,
760 /* Audio Streaming IN Interface - Alt1 */
761 static struct usb_interface_descriptor std_as_in_if1_desc = {
762 .bLength = sizeof std_as_in_if1_desc,
763 .bDescriptorType = USB_DT_INTERFACE,
765 .bAlternateSetting = 1,
767 .bInterfaceClass = USB_CLASS_AUDIO,
768 .bInterfaceSubClass = USB_SUBCLASS_AUDIOSTREAMING,
769 .bInterfaceProtocol = UAC_VERSION_2,
772 /* Audio Stream IN Intface Desc */
773 struct uac2_as_header_descriptor as_in_hdr_desc = {
774 .bLength = sizeof as_in_hdr_desc,
775 .bDescriptorType = USB_DT_CS_INTERFACE,
777 .bDescriptorSubtype = UAC_AS_GENERAL,
778 .bTerminalLink = USB_IN_OT_ID,
780 .bFormatType = UAC_FORMAT_TYPE_I,
781 .bmFormats = cpu_to_le32(UAC_FORMAT_TYPE_I_PCM),
785 /* Audio USB_IN Format */
786 struct uac2_format_type_i_descriptor as_in_fmt1_desc = {
787 .bLength = sizeof as_in_fmt1_desc,
788 .bDescriptorType = USB_DT_CS_INTERFACE,
789 .bDescriptorSubtype = UAC_FORMAT_TYPE,
790 .bFormatType = UAC_FORMAT_TYPE_I,
793 /* STD AS ISO IN Endpoint */
794 struct usb_endpoint_descriptor fs_epin_desc = {
795 .bLength = USB_DT_ENDPOINT_SIZE,
796 .bDescriptorType = USB_DT_ENDPOINT,
798 .bEndpointAddress = USB_DIR_IN,
799 .bmAttributes = USB_ENDPOINT_XFER_ISOC | USB_ENDPOINT_SYNC_ASYNC,
803 struct usb_endpoint_descriptor hs_epin_desc = {
804 .bLength = USB_DT_ENDPOINT_SIZE,
805 .bDescriptorType = USB_DT_ENDPOINT,
807 .bmAttributes = USB_ENDPOINT_XFER_ISOC | USB_ENDPOINT_SYNC_ASYNC,
811 /* CS AS ISO IN Endpoint */
812 static struct uac2_iso_endpoint_descriptor as_iso_in_desc = {
813 .bLength = sizeof as_iso_in_desc,
814 .bDescriptorType = USB_DT_CS_ENDPOINT,
816 .bDescriptorSubtype = UAC_EP_GENERAL,
819 .bLockDelayUnits = 0,
823 static struct usb_descriptor_header *fs_audio_desc[] = {
824 (struct usb_descriptor_header *)&iad_desc,
825 (struct usb_descriptor_header *)&std_ac_if_desc,
827 (struct usb_descriptor_header *)&ac_hdr_desc,
828 (struct usb_descriptor_header *)&in_clk_src_desc,
829 (struct usb_descriptor_header *)&out_clk_src_desc,
830 (struct usb_descriptor_header *)&usb_out_it_desc,
831 (struct usb_descriptor_header *)&io_in_it_desc,
832 (struct usb_descriptor_header *)&usb_in_ot_desc,
833 (struct usb_descriptor_header *)&io_out_ot_desc,
835 (struct usb_descriptor_header *)&std_as_out_if0_desc,
836 (struct usb_descriptor_header *)&std_as_out_if1_desc,
838 (struct usb_descriptor_header *)&as_out_hdr_desc,
839 (struct usb_descriptor_header *)&as_out_fmt1_desc,
840 (struct usb_descriptor_header *)&fs_epout_desc,
841 (struct usb_descriptor_header *)&as_iso_out_desc,
843 (struct usb_descriptor_header *)&std_as_in_if0_desc,
844 (struct usb_descriptor_header *)&std_as_in_if1_desc,
846 (struct usb_descriptor_header *)&as_in_hdr_desc,
847 (struct usb_descriptor_header *)&as_in_fmt1_desc,
848 (struct usb_descriptor_header *)&fs_epin_desc,
849 (struct usb_descriptor_header *)&as_iso_in_desc,
853 static struct usb_descriptor_header *hs_audio_desc[] = {
854 (struct usb_descriptor_header *)&iad_desc,
855 (struct usb_descriptor_header *)&std_ac_if_desc,
857 (struct usb_descriptor_header *)&ac_hdr_desc,
858 (struct usb_descriptor_header *)&in_clk_src_desc,
859 (struct usb_descriptor_header *)&out_clk_src_desc,
860 (struct usb_descriptor_header *)&usb_out_it_desc,
861 (struct usb_descriptor_header *)&io_in_it_desc,
862 (struct usb_descriptor_header *)&usb_in_ot_desc,
863 (struct usb_descriptor_header *)&io_out_ot_desc,
865 (struct usb_descriptor_header *)&std_as_out_if0_desc,
866 (struct usb_descriptor_header *)&std_as_out_if1_desc,
868 (struct usb_descriptor_header *)&as_out_hdr_desc,
869 (struct usb_descriptor_header *)&as_out_fmt1_desc,
870 (struct usb_descriptor_header *)&hs_epout_desc,
871 (struct usb_descriptor_header *)&as_iso_out_desc,
873 (struct usb_descriptor_header *)&std_as_in_if0_desc,
874 (struct usb_descriptor_header *)&std_as_in_if1_desc,
876 (struct usb_descriptor_header *)&as_in_hdr_desc,
877 (struct usb_descriptor_header *)&as_in_fmt1_desc,
878 (struct usb_descriptor_header *)&hs_epin_desc,
879 (struct usb_descriptor_header *)&as_iso_in_desc,
883 struct cntrl_cur_lay3 {
887 struct cntrl_range_lay3 {
895 free_ep(struct uac2_rtd_params *prm, struct usb_ep *ep)
897 struct snd_uac2_chip *uac2 = prm_to_uac2(prm);
900 prm->ep_enabled = false;
902 for (i = 0; i < USB_XFERS; i++) {
903 if (prm->ureq[i].req) {
904 usb_ep_dequeue(ep, prm->ureq[i].req);
905 usb_ep_free_request(ep, prm->ureq[i].req);
906 prm->ureq[i].req = NULL;
910 if (usb_ep_disable(ep))
911 dev_err(&uac2->pdev.dev,
912 "%s:%d Error!\n", __func__, __LINE__);
916 afunc_bind(struct usb_configuration *cfg, struct usb_function *fn)
918 struct audio_dev *agdev = func_to_agdev(fn);
919 struct snd_uac2_chip *uac2 = &agdev->uac2;
920 struct usb_composite_dev *cdev = cfg->cdev;
921 struct usb_gadget *gadget = cdev->gadget;
922 struct uac2_rtd_params *prm;
925 ret = usb_interface_id(cfg, fn);
927 dev_err(&uac2->pdev.dev,
928 "%s:%d Error!\n", __func__, __LINE__);
931 std_ac_if_desc.bInterfaceNumber = ret;
932 agdev->ac_intf = ret;
935 ret = usb_interface_id(cfg, fn);
937 dev_err(&uac2->pdev.dev,
938 "%s:%d Error!\n", __func__, __LINE__);
941 std_as_out_if0_desc.bInterfaceNumber = ret;
942 std_as_out_if1_desc.bInterfaceNumber = ret;
943 agdev->as_out_intf = ret;
944 agdev->as_out_alt = 0;
946 ret = usb_interface_id(cfg, fn);
948 dev_err(&uac2->pdev.dev,
949 "%s:%d Error!\n", __func__, __LINE__);
952 std_as_in_if0_desc.bInterfaceNumber = ret;
953 std_as_in_if1_desc.bInterfaceNumber = ret;
954 agdev->as_in_intf = ret;
955 agdev->as_in_alt = 0;
957 agdev->out_ep = usb_ep_autoconfig(gadget, &fs_epout_desc);
958 if (!agdev->out_ep) {
959 dev_err(&uac2->pdev.dev,
960 "%s:%d Error!\n", __func__, __LINE__);
963 agdev->out_ep->driver_data = agdev;
965 agdev->in_ep = usb_ep_autoconfig(gadget, &fs_epin_desc);
967 dev_err(&uac2->pdev.dev,
968 "%s:%d Error!\n", __func__, __LINE__);
971 agdev->in_ep->driver_data = agdev;
973 hs_epout_desc.bEndpointAddress = fs_epout_desc.bEndpointAddress;
974 hs_epout_desc.wMaxPacketSize = fs_epout_desc.wMaxPacketSize;
975 hs_epin_desc.bEndpointAddress = fs_epin_desc.bEndpointAddress;
976 hs_epin_desc.wMaxPacketSize = fs_epin_desc.wMaxPacketSize;
978 ret = usb_assign_descriptors(fn, fs_audio_desc, hs_audio_desc, NULL);
982 prm = &agdev->uac2.c_prm;
983 prm->max_psize = hs_epout_desc.wMaxPacketSize;
984 prm->rbuf = kzalloc(prm->max_psize * USB_XFERS, GFP_KERNEL);
987 dev_err(&uac2->pdev.dev,
988 "%s:%d Error!\n", __func__, __LINE__);
992 prm = &agdev->uac2.p_prm;
993 prm->max_psize = hs_epin_desc.wMaxPacketSize;
994 prm->rbuf = kzalloc(prm->max_psize * USB_XFERS, GFP_KERNEL);
997 dev_err(&uac2->pdev.dev,
998 "%s:%d Error!\n", __func__, __LINE__);
1002 ret = alsa_uac2_init(agdev);
1007 kfree(agdev->uac2.p_prm.rbuf);
1008 kfree(agdev->uac2.c_prm.rbuf);
1009 usb_free_all_descriptors(fn);
1011 agdev->in_ep->driver_data = NULL;
1013 agdev->out_ep->driver_data = NULL;
1018 afunc_unbind(struct usb_configuration *cfg, struct usb_function *fn)
1020 struct audio_dev *agdev = func_to_agdev(fn);
1021 struct uac2_rtd_params *prm;
1023 alsa_uac2_exit(agdev);
1025 prm = &agdev->uac2.p_prm;
1028 prm = &agdev->uac2.c_prm;
1030 usb_free_all_descriptors(fn);
1033 agdev->in_ep->driver_data = NULL;
1035 agdev->out_ep->driver_data = NULL;
1039 afunc_set_alt(struct usb_function *fn, unsigned intf, unsigned alt)
1041 struct usb_composite_dev *cdev = fn->config->cdev;
1042 struct audio_dev *agdev = func_to_agdev(fn);
1043 struct snd_uac2_chip *uac2 = &agdev->uac2;
1044 struct usb_gadget *gadget = cdev->gadget;
1045 struct usb_request *req;
1047 struct uac2_rtd_params *prm;
1050 /* No i/f has more than 2 alt settings */
1052 dev_err(&uac2->pdev.dev,
1053 "%s:%d Error!\n", __func__, __LINE__);
1057 if (intf == agdev->ac_intf) {
1058 /* Control I/f has only 1 AltSetting - 0 */
1060 dev_err(&uac2->pdev.dev,
1061 "%s:%d Error!\n", __func__, __LINE__);
1067 if (intf == agdev->as_out_intf) {
1070 config_ep_by_speed(gadget, fn, ep);
1071 agdev->as_out_alt = alt;
1072 } else if (intf == agdev->as_in_intf) {
1075 config_ep_by_speed(gadget, fn, ep);
1076 agdev->as_in_alt = alt;
1078 dev_err(&uac2->pdev.dev,
1079 "%s:%d Error!\n", __func__, __LINE__);
1088 prm->ep_enabled = true;
1091 for (i = 0; i < USB_XFERS; i++) {
1092 if (prm->ureq[i].req) {
1093 if (usb_ep_queue(ep, prm->ureq[i].req, GFP_ATOMIC))
1094 dev_err(&uac2->pdev.dev, "%d Error!\n",
1099 req = usb_ep_alloc_request(ep, GFP_ATOMIC);
1101 dev_err(&uac2->pdev.dev,
1102 "%s:%d Error!\n", __func__, __LINE__);
1106 prm->ureq[i].req = req;
1107 prm->ureq[i].pp = prm;
1110 req->context = &prm->ureq[i];
1111 req->length = prm->max_psize;
1112 req->complete = agdev_iso_complete;
1113 req->buf = prm->rbuf + i * req->length;
1115 if (usb_ep_queue(ep, req, GFP_ATOMIC))
1116 dev_err(&uac2->pdev.dev, "%d Error!\n", __LINE__);
1123 afunc_get_alt(struct usb_function *fn, unsigned intf)
1125 struct audio_dev *agdev = func_to_agdev(fn);
1126 struct snd_uac2_chip *uac2 = &agdev->uac2;
1128 if (intf == agdev->ac_intf)
1129 return agdev->ac_alt;
1130 else if (intf == agdev->as_out_intf)
1131 return agdev->as_out_alt;
1132 else if (intf == agdev->as_in_intf)
1133 return agdev->as_in_alt;
1135 dev_err(&uac2->pdev.dev,
1136 "%s:%d Invalid Interface %d!\n",
1137 __func__, __LINE__, intf);
1143 afunc_disable(struct usb_function *fn)
1145 struct audio_dev *agdev = func_to_agdev(fn);
1146 struct snd_uac2_chip *uac2 = &agdev->uac2;
1148 free_ep(&uac2->p_prm, agdev->in_ep);
1149 agdev->as_in_alt = 0;
1151 free_ep(&uac2->c_prm, agdev->out_ep);
1152 agdev->as_out_alt = 0;
1156 in_rq_cur(struct usb_function *fn, const struct usb_ctrlrequest *cr)
1158 struct usb_request *req = fn->config->cdev->req;
1159 struct audio_dev *agdev = func_to_agdev(fn);
1160 struct snd_uac2_chip *uac2 = &agdev->uac2;
1161 u16 w_length = le16_to_cpu(cr->wLength);
1162 u16 w_index = le16_to_cpu(cr->wIndex);
1163 u16 w_value = le16_to_cpu(cr->wValue);
1164 u8 entity_id = (w_index >> 8) & 0xff;
1165 u8 control_selector = w_value >> 8;
1166 int value = -EOPNOTSUPP;
1168 if (control_selector == UAC2_CS_CONTROL_SAM_FREQ) {
1169 struct cntrl_cur_lay3 c;
1171 if (entity_id == USB_IN_CLK_ID)
1173 else if (entity_id == USB_OUT_CLK_ID)
1176 value = min_t(unsigned, w_length, sizeof c);
1177 memcpy(req->buf, &c, value);
1178 } else if (control_selector == UAC2_CS_CONTROL_CLOCK_VALID) {
1179 *(u8 *)req->buf = 1;
1180 value = min_t(unsigned, w_length, 1);
1182 dev_err(&uac2->pdev.dev,
1183 "%s:%d control_selector=%d TODO!\n",
1184 __func__, __LINE__, control_selector);
1191 in_rq_range(struct usb_function *fn, const struct usb_ctrlrequest *cr)
1193 struct usb_request *req = fn->config->cdev->req;
1194 struct audio_dev *agdev = func_to_agdev(fn);
1195 struct snd_uac2_chip *uac2 = &agdev->uac2;
1196 u16 w_length = le16_to_cpu(cr->wLength);
1197 u16 w_index = le16_to_cpu(cr->wIndex);
1198 u16 w_value = le16_to_cpu(cr->wValue);
1199 u8 entity_id = (w_index >> 8) & 0xff;
1200 u8 control_selector = w_value >> 8;
1201 struct cntrl_range_lay3 r;
1202 int value = -EOPNOTSUPP;
1204 if (control_selector == UAC2_CS_CONTROL_SAM_FREQ) {
1205 if (entity_id == USB_IN_CLK_ID)
1207 else if (entity_id == USB_OUT_CLK_ID)
1214 r.wNumSubRanges = 1;
1216 value = min_t(unsigned, w_length, sizeof r);
1217 memcpy(req->buf, &r, value);
1219 dev_err(&uac2->pdev.dev,
1220 "%s:%d control_selector=%d TODO!\n",
1221 __func__, __LINE__, control_selector);
1228 ac_rq_in(struct usb_function *fn, const struct usb_ctrlrequest *cr)
1230 if (cr->bRequest == UAC2_CS_CUR)
1231 return in_rq_cur(fn, cr);
1232 else if (cr->bRequest == UAC2_CS_RANGE)
1233 return in_rq_range(fn, cr);
1239 out_rq_cur(struct usb_function *fn, const struct usb_ctrlrequest *cr)
1241 u16 w_length = le16_to_cpu(cr->wLength);
1242 u16 w_value = le16_to_cpu(cr->wValue);
1243 u8 control_selector = w_value >> 8;
1245 if (control_selector == UAC2_CS_CONTROL_SAM_FREQ)
1252 setup_rq_inf(struct usb_function *fn, const struct usb_ctrlrequest *cr)
1254 struct audio_dev *agdev = func_to_agdev(fn);
1255 struct snd_uac2_chip *uac2 = &agdev->uac2;
1256 u16 w_index = le16_to_cpu(cr->wIndex);
1257 u8 intf = w_index & 0xff;
1259 if (intf != agdev->ac_intf) {
1260 dev_err(&uac2->pdev.dev,
1261 "%s:%d Error!\n", __func__, __LINE__);
1265 if (cr->bRequestType & USB_DIR_IN)
1266 return ac_rq_in(fn, cr);
1267 else if (cr->bRequest == UAC2_CS_CUR)
1268 return out_rq_cur(fn, cr);
1274 afunc_setup(struct usb_function *fn, const struct usb_ctrlrequest *cr)
1276 struct usb_composite_dev *cdev = fn->config->cdev;
1277 struct audio_dev *agdev = func_to_agdev(fn);
1278 struct snd_uac2_chip *uac2 = &agdev->uac2;
1279 struct usb_request *req = cdev->req;
1280 u16 w_length = le16_to_cpu(cr->wLength);
1281 int value = -EOPNOTSUPP;
1283 /* Only Class specific requests are supposed to reach here */
1284 if ((cr->bRequestType & USB_TYPE_MASK) != USB_TYPE_CLASS)
1287 if ((cr->bRequestType & USB_RECIP_MASK) == USB_RECIP_INTERFACE)
1288 value = setup_rq_inf(fn, cr);
1290 dev_err(&uac2->pdev.dev, "%s:%d Error!\n", __func__, __LINE__);
1293 req->length = value;
1294 req->zero = value < w_length;
1295 value = usb_ep_queue(cdev->gadget->ep0, req, GFP_ATOMIC);
1297 dev_err(&uac2->pdev.dev,
1298 "%s:%d Error!\n", __func__, __LINE__);
1306 static int audio_bind_config(struct usb_configuration *cfg)
1310 agdev_g = kzalloc(sizeof *agdev_g, GFP_KERNEL);
1311 if (agdev_g == NULL) {
1312 printk(KERN_ERR "Unable to allocate audio gadget\n");
1316 res = usb_string_ids_tab(cfg->cdev, strings_fn);
1319 iad_desc.iFunction = strings_fn[STR_ASSOC].id;
1320 std_ac_if_desc.iInterface = strings_fn[STR_IF_CTRL].id;
1321 in_clk_src_desc.iClockSource = strings_fn[STR_CLKSRC_IN].id;
1322 out_clk_src_desc.iClockSource = strings_fn[STR_CLKSRC_OUT].id;
1323 usb_out_it_desc.iTerminal = strings_fn[STR_USB_IT].id;
1324 io_in_it_desc.iTerminal = strings_fn[STR_IO_IT].id;
1325 usb_in_ot_desc.iTerminal = strings_fn[STR_USB_OT].id;
1326 io_out_ot_desc.iTerminal = strings_fn[STR_IO_OT].id;
1327 std_as_out_if0_desc.iInterface = strings_fn[STR_AS_OUT_ALT0].id;
1328 std_as_out_if1_desc.iInterface = strings_fn[STR_AS_OUT_ALT1].id;
1329 std_as_in_if0_desc.iInterface = strings_fn[STR_AS_IN_ALT0].id;
1330 std_as_in_if1_desc.iInterface = strings_fn[STR_AS_IN_ALT1].id;
1332 agdev_g->func.name = "uac2_func";
1333 agdev_g->func.strings = fn_strings;
1334 agdev_g->func.bind = afunc_bind;
1335 agdev_g->func.unbind = afunc_unbind;
1336 agdev_g->func.set_alt = afunc_set_alt;
1337 agdev_g->func.get_alt = afunc_get_alt;
1338 agdev_g->func.disable = afunc_disable;
1339 agdev_g->func.setup = afunc_setup;
1341 /* Initialize the configurable parameters */
1342 usb_out_it_desc.bNrChannels = num_channels(c_chmask);
1343 usb_out_it_desc.bmChannelConfig = cpu_to_le32(c_chmask);
1344 io_in_it_desc.bNrChannels = num_channels(p_chmask);
1345 io_in_it_desc.bmChannelConfig = cpu_to_le32(p_chmask);
1346 as_out_hdr_desc.bNrChannels = num_channels(c_chmask);
1347 as_out_hdr_desc.bmChannelConfig = cpu_to_le32(c_chmask);
1348 as_in_hdr_desc.bNrChannels = num_channels(p_chmask);
1349 as_in_hdr_desc.bmChannelConfig = cpu_to_le32(p_chmask);
1350 as_out_fmt1_desc.bSubslotSize = c_ssize;
1351 as_out_fmt1_desc.bBitResolution = c_ssize * 8;
1352 as_in_fmt1_desc.bSubslotSize = p_ssize;
1353 as_in_fmt1_desc.bBitResolution = p_ssize * 8;
1355 snprintf(clksrc_in, sizeof(clksrc_in), "%uHz", p_srate);
1356 snprintf(clksrc_out, sizeof(clksrc_out), "%uHz", c_srate);
1358 res = usb_add_function(cfg, &agdev_g->func);
1366 uac2_unbind_config(struct usb_configuration *cfg)