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 audio_dev *agdev = uac2_to_agdev(uac2);
264 struct uac2_rtd_params *prm;
269 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
277 spin_lock_irqsave(&prm->lock, flags);
283 case SNDRV_PCM_TRIGGER_START:
284 case SNDRV_PCM_TRIGGER_RESUME:
287 case SNDRV_PCM_TRIGGER_STOP:
288 case SNDRV_PCM_TRIGGER_SUSPEND:
295 spin_unlock_irqrestore(&prm->lock, flags);
297 /* Clear buffer after Play stops */
298 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK && !prm->ss)
299 memset(prm->rbuf, 0, prm->max_psize * USB_XFERS);
304 static snd_pcm_uframes_t uac2_pcm_pointer(struct snd_pcm_substream *substream)
306 struct snd_uac2_chip *uac2 = snd_pcm_substream_chip(substream);
307 struct uac2_rtd_params *prm;
309 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
314 return bytes_to_frames(substream->runtime, prm->hw_ptr);
317 static int uac2_pcm_hw_params(struct snd_pcm_substream *substream,
318 struct snd_pcm_hw_params *hw_params)
320 struct snd_uac2_chip *uac2 = snd_pcm_substream_chip(substream);
321 struct uac2_rtd_params *prm;
324 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
329 err = snd_pcm_lib_malloc_pages(substream,
330 params_buffer_bytes(hw_params));
332 prm->dma_bytes = substream->runtime->dma_bytes;
333 prm->dma_area = substream->runtime->dma_area;
334 prm->period_size = params_period_bytes(hw_params);
340 static int uac2_pcm_hw_free(struct snd_pcm_substream *substream)
342 struct snd_uac2_chip *uac2 = snd_pcm_substream_chip(substream);
343 struct uac2_rtd_params *prm;
345 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
350 prm->dma_area = NULL;
352 prm->period_size = 0;
354 return snd_pcm_lib_free_pages(substream);
357 static int uac2_pcm_open(struct snd_pcm_substream *substream)
359 struct snd_uac2_chip *uac2 = snd_pcm_substream_chip(substream);
360 struct snd_pcm_runtime *runtime = substream->runtime;
362 runtime->hw = uac2_pcm_hardware;
364 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
365 spin_lock_init(&uac2->p_prm.lock);
366 runtime->hw.rate_min = p_srate;
367 runtime->hw.formats = SNDRV_PCM_FMTBIT_S16_LE; /* ! p_ssize ! */
368 runtime->hw.channels_min = num_channels(p_chmask);
369 runtime->hw.period_bytes_min = 2 * uac2->p_prm.max_psize
370 / runtime->hw.periods_min;
372 spin_lock_init(&uac2->c_prm.lock);
373 runtime->hw.rate_min = c_srate;
374 runtime->hw.formats = SNDRV_PCM_FMTBIT_S16_LE; /* ! c_ssize ! */
375 runtime->hw.channels_min = num_channels(c_chmask);
376 runtime->hw.period_bytes_min = 2 * uac2->c_prm.max_psize
377 / runtime->hw.periods_min;
380 runtime->hw.rate_max = runtime->hw.rate_min;
381 runtime->hw.channels_max = runtime->hw.channels_min;
383 snd_pcm_hw_constraint_integer(runtime, SNDRV_PCM_HW_PARAM_PERIODS);
388 /* ALSA cries without these function pointers */
389 static int uac2_pcm_null(struct snd_pcm_substream *substream)
394 static struct snd_pcm_ops uac2_pcm_ops = {
395 .open = uac2_pcm_open,
396 .close = uac2_pcm_null,
397 .ioctl = snd_pcm_lib_ioctl,
398 .hw_params = uac2_pcm_hw_params,
399 .hw_free = uac2_pcm_hw_free,
400 .trigger = uac2_pcm_trigger,
401 .pointer = uac2_pcm_pointer,
402 .prepare = uac2_pcm_null,
405 static int snd_uac2_probe(struct platform_device *pdev)
407 struct snd_uac2_chip *uac2 = pdev_to_uac2(pdev);
408 struct snd_card *card;
412 /* Choose any slot, with no id */
413 err = snd_card_create(-1, NULL, THIS_MODULE, 0, &card);
420 * Create first PCM device
421 * Create a substream only for non-zero channel streams
423 err = snd_pcm_new(uac2->card, "UAC2 PCM", 0,
424 p_chmask ? 1 : 0, c_chmask ? 1 : 0, &pcm);
428 strcpy(pcm->name, "UAC2 PCM");
429 pcm->private_data = uac2;
433 snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK, &uac2_pcm_ops);
434 snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &uac2_pcm_ops);
436 strcpy(card->driver, "UAC2_Gadget");
437 strcpy(card->shortname, "UAC2_Gadget");
438 sprintf(card->longname, "UAC2_Gadget %i", pdev->id);
440 snd_card_set_dev(card, &pdev->dev);
442 snd_pcm_lib_preallocate_pages_for_all(pcm, SNDRV_DMA_TYPE_CONTINUOUS,
443 snd_dma_continuous_data(GFP_KERNEL), 0, BUFF_SIZE_MAX);
445 err = snd_card_register(card);
447 platform_set_drvdata(pdev, card);
460 static int snd_uac2_remove(struct platform_device *pdev)
462 struct snd_card *card = platform_get_drvdata(pdev);
464 platform_set_drvdata(pdev, NULL);
467 return snd_card_free(card);
472 static int alsa_uac2_init(struct audio_dev *agdev)
474 struct snd_uac2_chip *uac2 = &agdev->uac2;
477 uac2->pdrv.probe = snd_uac2_probe;
478 uac2->pdrv.remove = snd_uac2_remove;
479 uac2->pdrv.driver.name = uac2_name;
482 uac2->pdev.name = uac2_name;
484 /* Register snd_uac2 driver */
485 err = platform_driver_register(&uac2->pdrv);
489 /* Register snd_uac2 device */
490 err = platform_device_register(&uac2->pdev);
492 platform_driver_unregister(&uac2->pdrv);
497 static void alsa_uac2_exit(struct audio_dev *agdev)
499 struct snd_uac2_chip *uac2 = &agdev->uac2;
501 platform_driver_unregister(&uac2->pdrv);
502 platform_device_unregister(&uac2->pdev);
506 /* --------- USB Function Interface ------------- */
523 static char clksrc_in[8];
524 static char clksrc_out[8];
526 static struct usb_string strings_fn[] = {
527 [STR_ASSOC].s = "Source/Sink",
528 [STR_IF_CTRL].s = "Topology Control",
529 [STR_CLKSRC_IN].s = clksrc_in,
530 [STR_CLKSRC_OUT].s = clksrc_out,
531 [STR_USB_IT].s = "USBH Out",
532 [STR_IO_IT].s = "USBD Out",
533 [STR_USB_OT].s = "USBH In",
534 [STR_IO_OT].s = "USBD In",
535 [STR_AS_OUT_ALT0].s = "Playback Inactive",
536 [STR_AS_OUT_ALT1].s = "Playback Active",
537 [STR_AS_IN_ALT0].s = "Capture Inactive",
538 [STR_AS_IN_ALT1].s = "Capture Active",
542 static struct usb_gadget_strings str_fn = {
543 .language = 0x0409, /* en-us */
544 .strings = strings_fn,
547 static struct usb_gadget_strings *fn_strings[] = {
552 static struct usb_qualifier_descriptor devqual_desc = {
553 .bLength = sizeof devqual_desc,
554 .bDescriptorType = USB_DT_DEVICE_QUALIFIER,
556 .bcdUSB = cpu_to_le16(0x200),
557 .bDeviceClass = USB_CLASS_MISC,
558 .bDeviceSubClass = 0x02,
559 .bDeviceProtocol = 0x01,
560 .bNumConfigurations = 1,
564 static struct usb_interface_assoc_descriptor iad_desc = {
565 .bLength = sizeof iad_desc,
566 .bDescriptorType = USB_DT_INTERFACE_ASSOCIATION,
568 .bFirstInterface = 0,
569 .bInterfaceCount = 3,
570 .bFunctionClass = USB_CLASS_AUDIO,
571 .bFunctionSubClass = UAC2_FUNCTION_SUBCLASS_UNDEFINED,
572 .bFunctionProtocol = UAC_VERSION_2,
575 /* Audio Control Interface */
576 static struct usb_interface_descriptor std_ac_if_desc = {
577 .bLength = sizeof std_ac_if_desc,
578 .bDescriptorType = USB_DT_INTERFACE,
580 .bAlternateSetting = 0,
582 .bInterfaceClass = USB_CLASS_AUDIO,
583 .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL,
584 .bInterfaceProtocol = UAC_VERSION_2,
587 /* Clock source for IN traffic */
588 struct uac_clock_source_descriptor in_clk_src_desc = {
589 .bLength = sizeof in_clk_src_desc,
590 .bDescriptorType = USB_DT_CS_INTERFACE,
592 .bDescriptorSubtype = UAC2_CLOCK_SOURCE,
593 .bClockID = USB_IN_CLK_ID,
594 .bmAttributes = UAC_CLOCK_SOURCE_TYPE_INT_FIXED,
595 .bmControls = (CONTROL_RDONLY << CLK_FREQ_CTRL),
599 /* Clock source for OUT traffic */
600 struct uac_clock_source_descriptor out_clk_src_desc = {
601 .bLength = sizeof out_clk_src_desc,
602 .bDescriptorType = USB_DT_CS_INTERFACE,
604 .bDescriptorSubtype = UAC2_CLOCK_SOURCE,
605 .bClockID = USB_OUT_CLK_ID,
606 .bmAttributes = UAC_CLOCK_SOURCE_TYPE_INT_FIXED,
607 .bmControls = (CONTROL_RDONLY << CLK_FREQ_CTRL),
611 /* Input Terminal for USB_OUT */
612 struct uac2_input_terminal_descriptor usb_out_it_desc = {
613 .bLength = sizeof usb_out_it_desc,
614 .bDescriptorType = USB_DT_CS_INTERFACE,
616 .bDescriptorSubtype = UAC_INPUT_TERMINAL,
617 .bTerminalID = USB_OUT_IT_ID,
618 .wTerminalType = cpu_to_le16(UAC_TERMINAL_STREAMING),
620 .bCSourceID = USB_OUT_CLK_ID,
622 .bmControls = (CONTROL_RDWR << COPY_CTRL),
625 /* Input Terminal for I/O-In */
626 struct uac2_input_terminal_descriptor io_in_it_desc = {
627 .bLength = sizeof io_in_it_desc,
628 .bDescriptorType = USB_DT_CS_INTERFACE,
630 .bDescriptorSubtype = UAC_INPUT_TERMINAL,
631 .bTerminalID = IO_IN_IT_ID,
632 .wTerminalType = cpu_to_le16(UAC_INPUT_TERMINAL_UNDEFINED),
634 .bCSourceID = USB_IN_CLK_ID,
636 .bmControls = (CONTROL_RDWR << COPY_CTRL),
639 /* Ouput Terminal for USB_IN */
640 struct uac2_output_terminal_descriptor usb_in_ot_desc = {
641 .bLength = sizeof usb_in_ot_desc,
642 .bDescriptorType = USB_DT_CS_INTERFACE,
644 .bDescriptorSubtype = UAC_OUTPUT_TERMINAL,
645 .bTerminalID = USB_IN_OT_ID,
646 .wTerminalType = cpu_to_le16(UAC_TERMINAL_STREAMING),
648 .bSourceID = IO_IN_IT_ID,
649 .bCSourceID = USB_IN_CLK_ID,
650 .bmControls = (CONTROL_RDWR << COPY_CTRL),
653 /* Ouput Terminal for I/O-Out */
654 struct uac2_output_terminal_descriptor io_out_ot_desc = {
655 .bLength = sizeof io_out_ot_desc,
656 .bDescriptorType = USB_DT_CS_INTERFACE,
658 .bDescriptorSubtype = UAC_OUTPUT_TERMINAL,
659 .bTerminalID = IO_OUT_OT_ID,
660 .wTerminalType = cpu_to_le16(UAC_OUTPUT_TERMINAL_UNDEFINED),
662 .bSourceID = USB_OUT_IT_ID,
663 .bCSourceID = USB_OUT_CLK_ID,
664 .bmControls = (CONTROL_RDWR << COPY_CTRL),
667 struct uac2_ac_header_descriptor ac_hdr_desc = {
668 .bLength = sizeof ac_hdr_desc,
669 .bDescriptorType = USB_DT_CS_INTERFACE,
671 .bDescriptorSubtype = UAC_MS_HEADER,
672 .bcdADC = cpu_to_le16(0x200),
673 .bCategory = UAC2_FUNCTION_IO_BOX,
674 .wTotalLength = sizeof in_clk_src_desc + sizeof out_clk_src_desc
675 + sizeof usb_out_it_desc + sizeof io_in_it_desc
676 + sizeof usb_in_ot_desc + sizeof io_out_ot_desc,
680 /* Audio Streaming OUT Interface - Alt0 */
681 static struct usb_interface_descriptor std_as_out_if0_desc = {
682 .bLength = sizeof std_as_out_if0_desc,
683 .bDescriptorType = USB_DT_INTERFACE,
685 .bAlternateSetting = 0,
687 .bInterfaceClass = USB_CLASS_AUDIO,
688 .bInterfaceSubClass = USB_SUBCLASS_AUDIOSTREAMING,
689 .bInterfaceProtocol = UAC_VERSION_2,
692 /* Audio Streaming OUT Interface - Alt1 */
693 static struct usb_interface_descriptor std_as_out_if1_desc = {
694 .bLength = sizeof std_as_out_if1_desc,
695 .bDescriptorType = USB_DT_INTERFACE,
697 .bAlternateSetting = 1,
699 .bInterfaceClass = USB_CLASS_AUDIO,
700 .bInterfaceSubClass = USB_SUBCLASS_AUDIOSTREAMING,
701 .bInterfaceProtocol = UAC_VERSION_2,
704 /* Audio Stream OUT Intface Desc */
705 struct uac2_as_header_descriptor as_out_hdr_desc = {
706 .bLength = sizeof as_out_hdr_desc,
707 .bDescriptorType = USB_DT_CS_INTERFACE,
709 .bDescriptorSubtype = UAC_AS_GENERAL,
710 .bTerminalLink = USB_OUT_IT_ID,
712 .bFormatType = UAC_FORMAT_TYPE_I,
713 .bmFormats = cpu_to_le32(UAC_FORMAT_TYPE_I_PCM),
717 /* Audio USB_OUT Format */
718 struct uac2_format_type_i_descriptor as_out_fmt1_desc = {
719 .bLength = sizeof as_out_fmt1_desc,
720 .bDescriptorType = USB_DT_CS_INTERFACE,
721 .bDescriptorSubtype = UAC_FORMAT_TYPE,
722 .bFormatType = UAC_FORMAT_TYPE_I,
725 /* STD AS ISO OUT Endpoint */
726 struct usb_endpoint_descriptor fs_epout_desc = {
727 .bLength = USB_DT_ENDPOINT_SIZE,
728 .bDescriptorType = USB_DT_ENDPOINT,
730 .bEndpointAddress = USB_DIR_OUT,
731 .bmAttributes = USB_ENDPOINT_XFER_ISOC | USB_ENDPOINT_SYNC_ASYNC,
735 struct usb_endpoint_descriptor hs_epout_desc = {
736 .bLength = USB_DT_ENDPOINT_SIZE,
737 .bDescriptorType = USB_DT_ENDPOINT,
739 .bmAttributes = USB_ENDPOINT_XFER_ISOC | USB_ENDPOINT_SYNC_ASYNC,
743 /* CS AS ISO OUT Endpoint */
744 static struct uac2_iso_endpoint_descriptor as_iso_out_desc = {
745 .bLength = sizeof as_iso_out_desc,
746 .bDescriptorType = USB_DT_CS_ENDPOINT,
748 .bDescriptorSubtype = UAC_EP_GENERAL,
751 .bLockDelayUnits = 0,
755 /* Audio Streaming IN Interface - Alt0 */
756 static struct usb_interface_descriptor std_as_in_if0_desc = {
757 .bLength = sizeof std_as_in_if0_desc,
758 .bDescriptorType = USB_DT_INTERFACE,
760 .bAlternateSetting = 0,
762 .bInterfaceClass = USB_CLASS_AUDIO,
763 .bInterfaceSubClass = USB_SUBCLASS_AUDIOSTREAMING,
764 .bInterfaceProtocol = UAC_VERSION_2,
767 /* Audio Streaming IN Interface - Alt1 */
768 static struct usb_interface_descriptor std_as_in_if1_desc = {
769 .bLength = sizeof std_as_in_if1_desc,
770 .bDescriptorType = USB_DT_INTERFACE,
772 .bAlternateSetting = 1,
774 .bInterfaceClass = USB_CLASS_AUDIO,
775 .bInterfaceSubClass = USB_SUBCLASS_AUDIOSTREAMING,
776 .bInterfaceProtocol = UAC_VERSION_2,
779 /* Audio Stream IN Intface Desc */
780 struct uac2_as_header_descriptor as_in_hdr_desc = {
781 .bLength = sizeof as_in_hdr_desc,
782 .bDescriptorType = USB_DT_CS_INTERFACE,
784 .bDescriptorSubtype = UAC_AS_GENERAL,
785 .bTerminalLink = USB_IN_OT_ID,
787 .bFormatType = UAC_FORMAT_TYPE_I,
788 .bmFormats = cpu_to_le32(UAC_FORMAT_TYPE_I_PCM),
792 /* Audio USB_IN Format */
793 struct uac2_format_type_i_descriptor as_in_fmt1_desc = {
794 .bLength = sizeof as_in_fmt1_desc,
795 .bDescriptorType = USB_DT_CS_INTERFACE,
796 .bDescriptorSubtype = UAC_FORMAT_TYPE,
797 .bFormatType = UAC_FORMAT_TYPE_I,
800 /* STD AS ISO IN Endpoint */
801 struct usb_endpoint_descriptor fs_epin_desc = {
802 .bLength = USB_DT_ENDPOINT_SIZE,
803 .bDescriptorType = USB_DT_ENDPOINT,
805 .bEndpointAddress = USB_DIR_IN,
806 .bmAttributes = USB_ENDPOINT_XFER_ISOC | USB_ENDPOINT_SYNC_ASYNC,
810 struct usb_endpoint_descriptor hs_epin_desc = {
811 .bLength = USB_DT_ENDPOINT_SIZE,
812 .bDescriptorType = USB_DT_ENDPOINT,
814 .bmAttributes = USB_ENDPOINT_XFER_ISOC | USB_ENDPOINT_SYNC_ASYNC,
818 /* CS AS ISO IN Endpoint */
819 static struct uac2_iso_endpoint_descriptor as_iso_in_desc = {
820 .bLength = sizeof as_iso_in_desc,
821 .bDescriptorType = USB_DT_CS_ENDPOINT,
823 .bDescriptorSubtype = UAC_EP_GENERAL,
826 .bLockDelayUnits = 0,
830 static struct usb_descriptor_header *fs_audio_desc[] = {
831 (struct usb_descriptor_header *)&iad_desc,
832 (struct usb_descriptor_header *)&std_ac_if_desc,
834 (struct usb_descriptor_header *)&ac_hdr_desc,
835 (struct usb_descriptor_header *)&in_clk_src_desc,
836 (struct usb_descriptor_header *)&out_clk_src_desc,
837 (struct usb_descriptor_header *)&usb_out_it_desc,
838 (struct usb_descriptor_header *)&io_in_it_desc,
839 (struct usb_descriptor_header *)&usb_in_ot_desc,
840 (struct usb_descriptor_header *)&io_out_ot_desc,
842 (struct usb_descriptor_header *)&std_as_out_if0_desc,
843 (struct usb_descriptor_header *)&std_as_out_if1_desc,
845 (struct usb_descriptor_header *)&as_out_hdr_desc,
846 (struct usb_descriptor_header *)&as_out_fmt1_desc,
847 (struct usb_descriptor_header *)&fs_epout_desc,
848 (struct usb_descriptor_header *)&as_iso_out_desc,
850 (struct usb_descriptor_header *)&std_as_in_if0_desc,
851 (struct usb_descriptor_header *)&std_as_in_if1_desc,
853 (struct usb_descriptor_header *)&as_in_hdr_desc,
854 (struct usb_descriptor_header *)&as_in_fmt1_desc,
855 (struct usb_descriptor_header *)&fs_epin_desc,
856 (struct usb_descriptor_header *)&as_iso_in_desc,
860 static struct usb_descriptor_header *hs_audio_desc[] = {
861 (struct usb_descriptor_header *)&iad_desc,
862 (struct usb_descriptor_header *)&std_ac_if_desc,
864 (struct usb_descriptor_header *)&ac_hdr_desc,
865 (struct usb_descriptor_header *)&in_clk_src_desc,
866 (struct usb_descriptor_header *)&out_clk_src_desc,
867 (struct usb_descriptor_header *)&usb_out_it_desc,
868 (struct usb_descriptor_header *)&io_in_it_desc,
869 (struct usb_descriptor_header *)&usb_in_ot_desc,
870 (struct usb_descriptor_header *)&io_out_ot_desc,
872 (struct usb_descriptor_header *)&std_as_out_if0_desc,
873 (struct usb_descriptor_header *)&std_as_out_if1_desc,
875 (struct usb_descriptor_header *)&as_out_hdr_desc,
876 (struct usb_descriptor_header *)&as_out_fmt1_desc,
877 (struct usb_descriptor_header *)&hs_epout_desc,
878 (struct usb_descriptor_header *)&as_iso_out_desc,
880 (struct usb_descriptor_header *)&std_as_in_if0_desc,
881 (struct usb_descriptor_header *)&std_as_in_if1_desc,
883 (struct usb_descriptor_header *)&as_in_hdr_desc,
884 (struct usb_descriptor_header *)&as_in_fmt1_desc,
885 (struct usb_descriptor_header *)&hs_epin_desc,
886 (struct usb_descriptor_header *)&as_iso_in_desc,
890 struct cntrl_cur_lay3 {
894 struct cntrl_range_lay3 {
902 free_ep(struct uac2_rtd_params *prm, struct usb_ep *ep)
904 struct snd_uac2_chip *uac2 = prm_to_uac2(prm);
907 prm->ep_enabled = false;
909 for (i = 0; i < USB_XFERS; i++) {
910 if (prm->ureq[i].req) {
911 usb_ep_dequeue(ep, prm->ureq[i].req);
912 usb_ep_free_request(ep, prm->ureq[i].req);
913 prm->ureq[i].req = NULL;
917 if (usb_ep_disable(ep))
918 dev_err(&uac2->pdev.dev,
919 "%s:%d Error!\n", __func__, __LINE__);
923 afunc_bind(struct usb_configuration *cfg, struct usb_function *fn)
925 struct audio_dev *agdev = func_to_agdev(fn);
926 struct snd_uac2_chip *uac2 = &agdev->uac2;
927 struct usb_composite_dev *cdev = cfg->cdev;
928 struct usb_gadget *gadget = cdev->gadget;
929 struct uac2_rtd_params *prm;
932 ret = usb_interface_id(cfg, fn);
934 dev_err(&uac2->pdev.dev,
935 "%s:%d Error!\n", __func__, __LINE__);
938 std_ac_if_desc.bInterfaceNumber = ret;
939 agdev->ac_intf = ret;
942 ret = usb_interface_id(cfg, fn);
944 dev_err(&uac2->pdev.dev,
945 "%s:%d Error!\n", __func__, __LINE__);
948 std_as_out_if0_desc.bInterfaceNumber = ret;
949 std_as_out_if1_desc.bInterfaceNumber = ret;
950 agdev->as_out_intf = ret;
951 agdev->as_out_alt = 0;
953 ret = usb_interface_id(cfg, fn);
955 dev_err(&uac2->pdev.dev,
956 "%s:%d Error!\n", __func__, __LINE__);
959 std_as_in_if0_desc.bInterfaceNumber = ret;
960 std_as_in_if1_desc.bInterfaceNumber = ret;
961 agdev->as_in_intf = ret;
962 agdev->as_in_alt = 0;
964 agdev->out_ep = usb_ep_autoconfig(gadget, &fs_epout_desc);
965 if (!agdev->out_ep) {
966 dev_err(&uac2->pdev.dev,
967 "%s:%d Error!\n", __func__, __LINE__);
970 agdev->out_ep->driver_data = agdev;
972 agdev->in_ep = usb_ep_autoconfig(gadget, &fs_epin_desc);
974 dev_err(&uac2->pdev.dev,
975 "%s:%d Error!\n", __func__, __LINE__);
978 agdev->in_ep->driver_data = agdev;
980 hs_epout_desc.bEndpointAddress = fs_epout_desc.bEndpointAddress;
981 hs_epout_desc.wMaxPacketSize = fs_epout_desc.wMaxPacketSize;
982 hs_epin_desc.bEndpointAddress = fs_epin_desc.bEndpointAddress;
983 hs_epin_desc.wMaxPacketSize = fs_epin_desc.wMaxPacketSize;
985 ret = usb_assign_descriptors(fn, fs_audio_desc, hs_audio_desc, NULL);
989 prm = &agdev->uac2.c_prm;
990 prm->max_psize = hs_epout_desc.wMaxPacketSize;
991 prm->rbuf = kzalloc(prm->max_psize * USB_XFERS, GFP_KERNEL);
994 dev_err(&uac2->pdev.dev,
995 "%s:%d Error!\n", __func__, __LINE__);
999 prm = &agdev->uac2.p_prm;
1000 prm->max_psize = hs_epin_desc.wMaxPacketSize;
1001 prm->rbuf = kzalloc(prm->max_psize * USB_XFERS, GFP_KERNEL);
1004 dev_err(&uac2->pdev.dev,
1005 "%s:%d Error!\n", __func__, __LINE__);
1009 ret = alsa_uac2_init(agdev);
1014 kfree(agdev->uac2.p_prm.rbuf);
1015 kfree(agdev->uac2.c_prm.rbuf);
1016 usb_free_all_descriptors(fn);
1018 agdev->in_ep->driver_data = NULL;
1020 agdev->out_ep->driver_data = NULL;
1025 afunc_unbind(struct usb_configuration *cfg, struct usb_function *fn)
1027 struct audio_dev *agdev = func_to_agdev(fn);
1028 struct uac2_rtd_params *prm;
1030 alsa_uac2_exit(agdev);
1032 prm = &agdev->uac2.p_prm;
1035 prm = &agdev->uac2.c_prm;
1037 usb_free_all_descriptors(fn);
1040 agdev->in_ep->driver_data = NULL;
1042 agdev->out_ep->driver_data = NULL;
1046 afunc_set_alt(struct usb_function *fn, unsigned intf, unsigned alt)
1048 struct usb_composite_dev *cdev = fn->config->cdev;
1049 struct audio_dev *agdev = func_to_agdev(fn);
1050 struct snd_uac2_chip *uac2 = &agdev->uac2;
1051 struct usb_gadget *gadget = cdev->gadget;
1052 struct usb_request *req;
1054 struct uac2_rtd_params *prm;
1057 /* No i/f has more than 2 alt settings */
1059 dev_err(&uac2->pdev.dev,
1060 "%s:%d Error!\n", __func__, __LINE__);
1064 if (intf == agdev->ac_intf) {
1065 /* Control I/f has only 1 AltSetting - 0 */
1067 dev_err(&uac2->pdev.dev,
1068 "%s:%d Error!\n", __func__, __LINE__);
1074 if (intf == agdev->as_out_intf) {
1077 config_ep_by_speed(gadget, fn, ep);
1078 agdev->as_out_alt = alt;
1079 } else if (intf == agdev->as_in_intf) {
1082 config_ep_by_speed(gadget, fn, ep);
1083 agdev->as_in_alt = alt;
1085 dev_err(&uac2->pdev.dev,
1086 "%s:%d Error!\n", __func__, __LINE__);
1095 prm->ep_enabled = true;
1098 for (i = 0; i < USB_XFERS; i++) {
1099 if (prm->ureq[i].req) {
1100 if (usb_ep_queue(ep, prm->ureq[i].req, GFP_ATOMIC))
1101 dev_err(&uac2->pdev.dev, "%d Error!\n",
1106 req = usb_ep_alloc_request(ep, GFP_ATOMIC);
1108 dev_err(&uac2->pdev.dev,
1109 "%s:%d Error!\n", __func__, __LINE__);
1113 prm->ureq[i].req = req;
1114 prm->ureq[i].pp = prm;
1117 req->context = &prm->ureq[i];
1118 req->length = prm->max_psize;
1119 req->complete = agdev_iso_complete;
1120 req->buf = prm->rbuf + i * req->length;
1122 if (usb_ep_queue(ep, req, GFP_ATOMIC))
1123 dev_err(&uac2->pdev.dev, "%d Error!\n", __LINE__);
1130 afunc_get_alt(struct usb_function *fn, unsigned intf)
1132 struct audio_dev *agdev = func_to_agdev(fn);
1133 struct snd_uac2_chip *uac2 = &agdev->uac2;
1135 if (intf == agdev->ac_intf)
1136 return agdev->ac_alt;
1137 else if (intf == agdev->as_out_intf)
1138 return agdev->as_out_alt;
1139 else if (intf == agdev->as_in_intf)
1140 return agdev->as_in_alt;
1142 dev_err(&uac2->pdev.dev,
1143 "%s:%d Invalid Interface %d!\n",
1144 __func__, __LINE__, intf);
1150 afunc_disable(struct usb_function *fn)
1152 struct audio_dev *agdev = func_to_agdev(fn);
1153 struct snd_uac2_chip *uac2 = &agdev->uac2;
1155 free_ep(&uac2->p_prm, agdev->in_ep);
1156 agdev->as_in_alt = 0;
1158 free_ep(&uac2->c_prm, agdev->out_ep);
1159 agdev->as_out_alt = 0;
1163 in_rq_cur(struct usb_function *fn, const struct usb_ctrlrequest *cr)
1165 struct usb_request *req = fn->config->cdev->req;
1166 struct audio_dev *agdev = func_to_agdev(fn);
1167 struct snd_uac2_chip *uac2 = &agdev->uac2;
1168 u16 w_length = le16_to_cpu(cr->wLength);
1169 u16 w_index = le16_to_cpu(cr->wIndex);
1170 u16 w_value = le16_to_cpu(cr->wValue);
1171 u8 entity_id = (w_index >> 8) & 0xff;
1172 u8 control_selector = w_value >> 8;
1173 int value = -EOPNOTSUPP;
1175 if (control_selector == UAC2_CS_CONTROL_SAM_FREQ) {
1176 struct cntrl_cur_lay3 c;
1178 if (entity_id == USB_IN_CLK_ID)
1180 else if (entity_id == USB_OUT_CLK_ID)
1183 value = min_t(unsigned, w_length, sizeof c);
1184 memcpy(req->buf, &c, value);
1185 } else if (control_selector == UAC2_CS_CONTROL_CLOCK_VALID) {
1186 *(u8 *)req->buf = 1;
1187 value = min_t(unsigned, w_length, 1);
1189 dev_err(&uac2->pdev.dev,
1190 "%s:%d control_selector=%d TODO!\n",
1191 __func__, __LINE__, control_selector);
1198 in_rq_range(struct usb_function *fn, const struct usb_ctrlrequest *cr)
1200 struct usb_request *req = fn->config->cdev->req;
1201 struct audio_dev *agdev = func_to_agdev(fn);
1202 struct snd_uac2_chip *uac2 = &agdev->uac2;
1203 u16 w_length = le16_to_cpu(cr->wLength);
1204 u16 w_index = le16_to_cpu(cr->wIndex);
1205 u16 w_value = le16_to_cpu(cr->wValue);
1206 u8 entity_id = (w_index >> 8) & 0xff;
1207 u8 control_selector = w_value >> 8;
1208 struct cntrl_range_lay3 r;
1209 int value = -EOPNOTSUPP;
1211 if (control_selector == UAC2_CS_CONTROL_SAM_FREQ) {
1212 if (entity_id == USB_IN_CLK_ID)
1214 else if (entity_id == USB_OUT_CLK_ID)
1221 r.wNumSubRanges = 1;
1223 value = min_t(unsigned, w_length, sizeof r);
1224 memcpy(req->buf, &r, value);
1226 dev_err(&uac2->pdev.dev,
1227 "%s:%d control_selector=%d TODO!\n",
1228 __func__, __LINE__, control_selector);
1235 ac_rq_in(struct usb_function *fn, const struct usb_ctrlrequest *cr)
1237 if (cr->bRequest == UAC2_CS_CUR)
1238 return in_rq_cur(fn, cr);
1239 else if (cr->bRequest == UAC2_CS_RANGE)
1240 return in_rq_range(fn, cr);
1246 out_rq_cur(struct usb_function *fn, const struct usb_ctrlrequest *cr)
1248 u16 w_length = le16_to_cpu(cr->wLength);
1249 u16 w_value = le16_to_cpu(cr->wValue);
1250 u8 control_selector = w_value >> 8;
1252 if (control_selector == UAC2_CS_CONTROL_SAM_FREQ)
1259 setup_rq_inf(struct usb_function *fn, const struct usb_ctrlrequest *cr)
1261 struct audio_dev *agdev = func_to_agdev(fn);
1262 struct snd_uac2_chip *uac2 = &agdev->uac2;
1263 u16 w_index = le16_to_cpu(cr->wIndex);
1264 u8 intf = w_index & 0xff;
1266 if (intf != agdev->ac_intf) {
1267 dev_err(&uac2->pdev.dev,
1268 "%s:%d Error!\n", __func__, __LINE__);
1272 if (cr->bRequestType & USB_DIR_IN)
1273 return ac_rq_in(fn, cr);
1274 else if (cr->bRequest == UAC2_CS_CUR)
1275 return out_rq_cur(fn, cr);
1281 afunc_setup(struct usb_function *fn, const struct usb_ctrlrequest *cr)
1283 struct usb_composite_dev *cdev = fn->config->cdev;
1284 struct audio_dev *agdev = func_to_agdev(fn);
1285 struct snd_uac2_chip *uac2 = &agdev->uac2;
1286 struct usb_request *req = cdev->req;
1287 u16 w_length = le16_to_cpu(cr->wLength);
1288 int value = -EOPNOTSUPP;
1290 /* Only Class specific requests are supposed to reach here */
1291 if ((cr->bRequestType & USB_TYPE_MASK) != USB_TYPE_CLASS)
1294 if ((cr->bRequestType & USB_RECIP_MASK) == USB_RECIP_INTERFACE)
1295 value = setup_rq_inf(fn, cr);
1297 dev_err(&uac2->pdev.dev, "%s:%d Error!\n", __func__, __LINE__);
1300 req->length = value;
1301 req->zero = value < w_length;
1302 value = usb_ep_queue(cdev->gadget->ep0, req, GFP_ATOMIC);
1304 dev_err(&uac2->pdev.dev,
1305 "%s:%d Error!\n", __func__, __LINE__);
1313 static int audio_bind_config(struct usb_configuration *cfg)
1317 agdev_g = kzalloc(sizeof *agdev_g, GFP_KERNEL);
1318 if (agdev_g == NULL) {
1319 printk(KERN_ERR "Unable to allocate audio gadget\n");
1323 res = usb_string_ids_tab(cfg->cdev, strings_fn);
1326 iad_desc.iFunction = strings_fn[STR_ASSOC].id;
1327 std_ac_if_desc.iInterface = strings_fn[STR_IF_CTRL].id;
1328 in_clk_src_desc.iClockSource = strings_fn[STR_CLKSRC_IN].id;
1329 out_clk_src_desc.iClockSource = strings_fn[STR_CLKSRC_OUT].id;
1330 usb_out_it_desc.iTerminal = strings_fn[STR_USB_IT].id;
1331 io_in_it_desc.iTerminal = strings_fn[STR_IO_IT].id;
1332 usb_in_ot_desc.iTerminal = strings_fn[STR_USB_OT].id;
1333 io_out_ot_desc.iTerminal = strings_fn[STR_IO_OT].id;
1334 std_as_out_if0_desc.iInterface = strings_fn[STR_AS_OUT_ALT0].id;
1335 std_as_out_if1_desc.iInterface = strings_fn[STR_AS_OUT_ALT1].id;
1336 std_as_in_if0_desc.iInterface = strings_fn[STR_AS_IN_ALT0].id;
1337 std_as_in_if1_desc.iInterface = strings_fn[STR_AS_IN_ALT1].id;
1339 agdev_g->func.name = "uac2_func";
1340 agdev_g->func.strings = fn_strings;
1341 agdev_g->func.bind = afunc_bind;
1342 agdev_g->func.unbind = afunc_unbind;
1343 agdev_g->func.set_alt = afunc_set_alt;
1344 agdev_g->func.get_alt = afunc_get_alt;
1345 agdev_g->func.disable = afunc_disable;
1346 agdev_g->func.setup = afunc_setup;
1348 /* Initialize the configurable parameters */
1349 usb_out_it_desc.bNrChannels = num_channels(c_chmask);
1350 usb_out_it_desc.bmChannelConfig = cpu_to_le32(c_chmask);
1351 io_in_it_desc.bNrChannels = num_channels(p_chmask);
1352 io_in_it_desc.bmChannelConfig = cpu_to_le32(p_chmask);
1353 as_out_hdr_desc.bNrChannels = num_channels(c_chmask);
1354 as_out_hdr_desc.bmChannelConfig = cpu_to_le32(c_chmask);
1355 as_in_hdr_desc.bNrChannels = num_channels(p_chmask);
1356 as_in_hdr_desc.bmChannelConfig = cpu_to_le32(p_chmask);
1357 as_out_fmt1_desc.bSubslotSize = c_ssize;
1358 as_out_fmt1_desc.bBitResolution = c_ssize * 8;
1359 as_in_fmt1_desc.bSubslotSize = p_ssize;
1360 as_in_fmt1_desc.bBitResolution = p_ssize * 8;
1362 snprintf(clksrc_in, sizeof(clksrc_in), "%uHz", p_srate);
1363 snprintf(clksrc_out, sizeof(clksrc_out), "%uHz", c_srate);
1365 res = usb_add_function(cfg, &agdev_g->func);
1373 uac2_unbind_config(struct usb_configuration *cfg)