1 // SPDX-License-Identifier: GPL-2.0+
3 * f_uac2.c -- USB Audio Class 2.0 Function
6 * Yadwinder Singh (yadi.brar01@gmail.com)
7 * Jaswinder Singh (jaswinder.singh@linaro.org)
10 * Ruslan Bilovol (ruslan.bilovol@gmail.com)
13 #include <linux/usb/audio.h>
14 #include <linux/usb/audio-v2.h>
15 #include <linux/module.h>
20 /* UAC2 spec: 4.1 Audio Channel Cluster Descriptor */
21 #define UAC2_CHANNEL_MASK 0x07FFFFFF
24 * The driver implements a simple UAC_2 topology.
25 * USB-OUT -> IT_1 -> FU -> OT_3 -> ALSA_Capture
26 * ALSA_Playback -> IT_2 -> FU -> OT_4 -> USB-IN
27 * Capture and Playback sampling rates are independently
28 * controlled by two clock sources :
29 * CLK_5 := c_srate, and CLK_6 := p_srate
31 #define USB_OUT_CLK_ID (out_clk_src_desc.bClockID)
32 #define USB_IN_CLK_ID (in_clk_src_desc.bClockID)
33 #define USB_OUT_FU_ID (out_feature_unit_desc->bUnitID)
34 #define USB_IN_FU_ID (in_feature_unit_desc->bUnitID)
36 #define CONTROL_ABSENT 0
37 #define CONTROL_RDONLY 1
38 #define CONTROL_RDWR 3
40 #define CLK_FREQ_CTRL 0
41 #define CLK_VLD_CTRL 2
42 #define FU_MUTE_CTRL 0
52 #define EPIN_EN(_opts) ((_opts)->p_chmask != 0)
53 #define EPOUT_EN(_opts) ((_opts)->c_chmask != 0)
54 #define FUIN_EN(_opts) (EPIN_EN(_opts) \
55 && ((_opts)->p_mute_present \
56 || (_opts)->p_volume_present))
57 #define FUOUT_EN(_opts) (EPOUT_EN(_opts) \
58 && ((_opts)->c_mute_present \
59 || (_opts)->c_volume_present))
60 #define EPOUT_FBACK_IN_EN(_opts) ((_opts)->c_sync == USB_ENDPOINT_SYNC_ASYNC)
63 struct g_audio g_audio;
64 u8 ac_intf, as_in_intf, as_out_intf;
65 u8 ac_alt, as_in_alt, as_out_alt; /* needed for get_alt() */
67 struct usb_ctrlrequest setup_cr; /* will be used in data stage */
69 /* Interrupt IN endpoint of AC interface */
70 struct usb_ep *int_ep;
74 static inline struct f_uac2 *func_to_uac2(struct usb_function *f)
76 return container_of(f, struct f_uac2, g_audio.func);
80 struct f_uac2_opts *g_audio_to_uac2_opts(struct g_audio *agdev)
82 return container_of(agdev->func.fi, struct f_uac2_opts, func_inst);
85 static int afunc_notify(struct g_audio *agdev, int unit_id, int cs);
87 /* --------- USB Function Interface ------------- */
106 static char clksrc_in[8];
107 static char clksrc_out[8];
109 static struct usb_string strings_fn[] = {
110 [STR_ASSOC].s = "Source/Sink",
111 [STR_IF_CTRL].s = "Topology Control",
112 [STR_CLKSRC_IN].s = clksrc_in,
113 [STR_CLKSRC_OUT].s = clksrc_out,
114 [STR_USB_IT].s = "USBH Out",
115 [STR_IO_IT].s = "USBD Out",
116 [STR_USB_OT].s = "USBH In",
117 [STR_IO_OT].s = "USBD In",
118 [STR_FU_IN].s = "Capture Volume",
119 [STR_FU_OUT].s = "Playback Volume",
120 [STR_AS_OUT_ALT0].s = "Playback Inactive",
121 [STR_AS_OUT_ALT1].s = "Playback Active",
122 [STR_AS_IN_ALT0].s = "Capture Inactive",
123 [STR_AS_IN_ALT1].s = "Capture Active",
127 static struct usb_gadget_strings str_fn = {
128 .language = 0x0409, /* en-us */
129 .strings = strings_fn,
132 static struct usb_gadget_strings *fn_strings[] = {
137 static struct usb_interface_assoc_descriptor iad_desc = {
138 .bLength = sizeof iad_desc,
139 .bDescriptorType = USB_DT_INTERFACE_ASSOCIATION,
141 .bFirstInterface = 0,
142 .bInterfaceCount = 3,
143 .bFunctionClass = USB_CLASS_AUDIO,
144 .bFunctionSubClass = UAC2_FUNCTION_SUBCLASS_UNDEFINED,
145 .bFunctionProtocol = UAC_VERSION_2,
148 /* Audio Control Interface */
149 static struct usb_interface_descriptor std_ac_if_desc = {
150 .bLength = sizeof std_ac_if_desc,
151 .bDescriptorType = USB_DT_INTERFACE,
153 .bAlternateSetting = 0,
154 /* .bNumEndpoints = DYNAMIC */
155 .bInterfaceClass = USB_CLASS_AUDIO,
156 .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL,
157 .bInterfaceProtocol = UAC_VERSION_2,
160 /* Clock source for IN traffic */
161 static struct uac_clock_source_descriptor in_clk_src_desc = {
162 .bLength = sizeof in_clk_src_desc,
163 .bDescriptorType = USB_DT_CS_INTERFACE,
165 .bDescriptorSubtype = UAC2_CLOCK_SOURCE,
166 /* .bClockID = DYNAMIC */
167 .bmAttributes = UAC_CLOCK_SOURCE_TYPE_INT_FIXED,
168 .bmControls = (CONTROL_RDONLY << CLK_FREQ_CTRL),
172 /* Clock source for OUT traffic */
173 static struct uac_clock_source_descriptor out_clk_src_desc = {
174 .bLength = sizeof out_clk_src_desc,
175 .bDescriptorType = USB_DT_CS_INTERFACE,
177 .bDescriptorSubtype = UAC2_CLOCK_SOURCE,
178 /* .bClockID = DYNAMIC */
179 .bmAttributes = UAC_CLOCK_SOURCE_TYPE_INT_FIXED,
180 .bmControls = (CONTROL_RDONLY << CLK_FREQ_CTRL),
184 /* Input Terminal for USB_OUT */
185 static struct uac2_input_terminal_descriptor usb_out_it_desc = {
186 .bLength = sizeof usb_out_it_desc,
187 .bDescriptorType = USB_DT_CS_INTERFACE,
189 .bDescriptorSubtype = UAC_INPUT_TERMINAL,
190 /* .bTerminalID = DYNAMIC */
191 .wTerminalType = cpu_to_le16(UAC_TERMINAL_STREAMING),
193 /* .bCSourceID = DYNAMIC */
195 .bmControls = cpu_to_le16(CONTROL_RDWR << COPY_CTRL),
198 /* Input Terminal for I/O-In */
199 static struct uac2_input_terminal_descriptor io_in_it_desc = {
200 .bLength = sizeof io_in_it_desc,
201 .bDescriptorType = USB_DT_CS_INTERFACE,
203 .bDescriptorSubtype = UAC_INPUT_TERMINAL,
204 /* .bTerminalID = DYNAMIC */
205 .wTerminalType = cpu_to_le16(UAC_INPUT_TERMINAL_UNDEFINED),
207 /* .bCSourceID = DYNAMIC */
209 .bmControls = cpu_to_le16(CONTROL_RDWR << COPY_CTRL),
212 /* Ouput Terminal for USB_IN */
213 static struct uac2_output_terminal_descriptor usb_in_ot_desc = {
214 .bLength = sizeof usb_in_ot_desc,
215 .bDescriptorType = USB_DT_CS_INTERFACE,
217 .bDescriptorSubtype = UAC_OUTPUT_TERMINAL,
218 /* .bTerminalID = DYNAMIC */
219 .wTerminalType = cpu_to_le16(UAC_TERMINAL_STREAMING),
221 /* .bSourceID = DYNAMIC */
222 /* .bCSourceID = DYNAMIC */
223 .bmControls = cpu_to_le16(CONTROL_RDWR << COPY_CTRL),
226 /* Ouput Terminal for I/O-Out */
227 static struct uac2_output_terminal_descriptor io_out_ot_desc = {
228 .bLength = sizeof io_out_ot_desc,
229 .bDescriptorType = USB_DT_CS_INTERFACE,
231 .bDescriptorSubtype = UAC_OUTPUT_TERMINAL,
232 /* .bTerminalID = DYNAMIC */
233 .wTerminalType = cpu_to_le16(UAC_OUTPUT_TERMINAL_UNDEFINED),
235 /* .bSourceID = DYNAMIC */
236 /* .bCSourceID = DYNAMIC */
237 .bmControls = cpu_to_le16(CONTROL_RDWR << COPY_CTRL),
240 static struct uac2_feature_unit_descriptor *in_feature_unit_desc;
241 static struct uac2_feature_unit_descriptor *out_feature_unit_desc;
243 static struct uac2_ac_header_descriptor ac_hdr_desc = {
244 .bLength = sizeof ac_hdr_desc,
245 .bDescriptorType = USB_DT_CS_INTERFACE,
247 .bDescriptorSubtype = UAC_MS_HEADER,
248 .bcdADC = cpu_to_le16(0x200),
249 .bCategory = UAC2_FUNCTION_IO_BOX,
250 /* .wTotalLength = DYNAMIC */
254 /* AC IN Interrupt Endpoint */
255 static struct usb_endpoint_descriptor fs_ep_int_desc = {
256 .bLength = USB_DT_ENDPOINT_SIZE,
257 .bDescriptorType = USB_DT_ENDPOINT,
259 .bEndpointAddress = USB_DIR_IN,
260 .bmAttributes = USB_ENDPOINT_XFER_INT,
261 .wMaxPacketSize = cpu_to_le16(6),
265 static struct usb_endpoint_descriptor hs_ep_int_desc = {
266 .bLength = USB_DT_ENDPOINT_SIZE,
267 .bDescriptorType = USB_DT_ENDPOINT,
269 .bmAttributes = USB_ENDPOINT_XFER_INT,
270 .wMaxPacketSize = cpu_to_le16(6),
274 static struct usb_endpoint_descriptor ss_ep_int_desc = {
275 .bLength = USB_DT_ENDPOINT_SIZE,
276 .bDescriptorType = USB_DT_ENDPOINT,
278 .bEndpointAddress = USB_DIR_IN,
279 .bmAttributes = USB_ENDPOINT_XFER_INT,
280 .wMaxPacketSize = cpu_to_le16(6),
284 /* Audio Streaming OUT Interface - Alt0 */
285 static struct usb_interface_descriptor std_as_out_if0_desc = {
286 .bLength = sizeof std_as_out_if0_desc,
287 .bDescriptorType = USB_DT_INTERFACE,
289 .bAlternateSetting = 0,
291 .bInterfaceClass = USB_CLASS_AUDIO,
292 .bInterfaceSubClass = USB_SUBCLASS_AUDIOSTREAMING,
293 .bInterfaceProtocol = UAC_VERSION_2,
296 /* Audio Streaming OUT Interface - Alt1 */
297 static struct usb_interface_descriptor std_as_out_if1_desc = {
298 .bLength = sizeof std_as_out_if1_desc,
299 .bDescriptorType = USB_DT_INTERFACE,
301 .bAlternateSetting = 1,
303 .bInterfaceClass = USB_CLASS_AUDIO,
304 .bInterfaceSubClass = USB_SUBCLASS_AUDIOSTREAMING,
305 .bInterfaceProtocol = UAC_VERSION_2,
308 /* Audio Stream OUT Intface Desc */
309 static struct uac2_as_header_descriptor as_out_hdr_desc = {
310 .bLength = sizeof as_out_hdr_desc,
311 .bDescriptorType = USB_DT_CS_INTERFACE,
313 .bDescriptorSubtype = UAC_AS_GENERAL,
314 /* .bTerminalLink = DYNAMIC */
316 .bFormatType = UAC_FORMAT_TYPE_I,
317 .bmFormats = cpu_to_le32(UAC_FORMAT_TYPE_I_PCM),
321 /* Audio USB_OUT Format */
322 static struct uac2_format_type_i_descriptor as_out_fmt1_desc = {
323 .bLength = sizeof as_out_fmt1_desc,
324 .bDescriptorType = USB_DT_CS_INTERFACE,
325 .bDescriptorSubtype = UAC_FORMAT_TYPE,
326 .bFormatType = UAC_FORMAT_TYPE_I,
329 /* STD AS ISO OUT Endpoint */
330 static struct usb_endpoint_descriptor fs_epout_desc = {
331 .bLength = USB_DT_ENDPOINT_SIZE,
332 .bDescriptorType = USB_DT_ENDPOINT,
334 .bEndpointAddress = USB_DIR_OUT,
335 /* .bmAttributes = DYNAMIC */
336 /* .wMaxPacketSize = DYNAMIC */
340 static struct usb_endpoint_descriptor hs_epout_desc = {
341 .bLength = USB_DT_ENDPOINT_SIZE,
342 .bDescriptorType = USB_DT_ENDPOINT,
344 /* .bmAttributes = DYNAMIC */
345 /* .wMaxPacketSize = DYNAMIC */
349 static struct usb_endpoint_descriptor ss_epout_desc = {
350 .bLength = USB_DT_ENDPOINT_SIZE,
351 .bDescriptorType = USB_DT_ENDPOINT,
353 .bEndpointAddress = USB_DIR_OUT,
354 /* .bmAttributes = DYNAMIC */
355 /* .wMaxPacketSize = DYNAMIC */
359 static struct usb_ss_ep_comp_descriptor ss_epout_desc_comp = {
360 .bLength = sizeof(ss_epout_desc_comp),
361 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
364 /* wBytesPerInterval = DYNAMIC */
367 /* CS AS ISO OUT Endpoint */
368 static struct uac2_iso_endpoint_descriptor as_iso_out_desc = {
369 .bLength = sizeof as_iso_out_desc,
370 .bDescriptorType = USB_DT_CS_ENDPOINT,
372 .bDescriptorSubtype = UAC_EP_GENERAL,
375 .bLockDelayUnits = 0,
379 /* STD AS ISO IN Feedback Endpoint */
380 static struct usb_endpoint_descriptor fs_epin_fback_desc = {
381 .bLength = USB_DT_ENDPOINT_SIZE,
382 .bDescriptorType = USB_DT_ENDPOINT,
384 .bEndpointAddress = USB_DIR_IN,
385 .bmAttributes = USB_ENDPOINT_XFER_ISOC | USB_ENDPOINT_USAGE_FEEDBACK,
386 .wMaxPacketSize = cpu_to_le16(3),
390 static struct usb_endpoint_descriptor hs_epin_fback_desc = {
391 .bLength = USB_DT_ENDPOINT_SIZE,
392 .bDescriptorType = USB_DT_ENDPOINT,
394 .bmAttributes = USB_ENDPOINT_XFER_ISOC | USB_ENDPOINT_USAGE_FEEDBACK,
395 .wMaxPacketSize = cpu_to_le16(4),
399 static struct usb_endpoint_descriptor ss_epin_fback_desc = {
400 .bLength = USB_DT_ENDPOINT_SIZE,
401 .bDescriptorType = USB_DT_ENDPOINT,
403 .bEndpointAddress = USB_DIR_IN,
404 .bmAttributes = USB_ENDPOINT_XFER_ISOC | USB_ENDPOINT_USAGE_FEEDBACK,
405 .wMaxPacketSize = cpu_to_le16(4),
410 /* Audio Streaming IN Interface - Alt0 */
411 static struct usb_interface_descriptor std_as_in_if0_desc = {
412 .bLength = sizeof std_as_in_if0_desc,
413 .bDescriptorType = USB_DT_INTERFACE,
415 .bAlternateSetting = 0,
417 .bInterfaceClass = USB_CLASS_AUDIO,
418 .bInterfaceSubClass = USB_SUBCLASS_AUDIOSTREAMING,
419 .bInterfaceProtocol = UAC_VERSION_2,
422 /* Audio Streaming IN Interface - Alt1 */
423 static struct usb_interface_descriptor std_as_in_if1_desc = {
424 .bLength = sizeof std_as_in_if1_desc,
425 .bDescriptorType = USB_DT_INTERFACE,
427 .bAlternateSetting = 1,
429 .bInterfaceClass = USB_CLASS_AUDIO,
430 .bInterfaceSubClass = USB_SUBCLASS_AUDIOSTREAMING,
431 .bInterfaceProtocol = UAC_VERSION_2,
434 /* Audio Stream IN Intface Desc */
435 static struct uac2_as_header_descriptor as_in_hdr_desc = {
436 .bLength = sizeof as_in_hdr_desc,
437 .bDescriptorType = USB_DT_CS_INTERFACE,
439 .bDescriptorSubtype = UAC_AS_GENERAL,
440 /* .bTerminalLink = DYNAMIC */
442 .bFormatType = UAC_FORMAT_TYPE_I,
443 .bmFormats = cpu_to_le32(UAC_FORMAT_TYPE_I_PCM),
447 /* Audio USB_IN Format */
448 static struct uac2_format_type_i_descriptor as_in_fmt1_desc = {
449 .bLength = sizeof as_in_fmt1_desc,
450 .bDescriptorType = USB_DT_CS_INTERFACE,
451 .bDescriptorSubtype = UAC_FORMAT_TYPE,
452 .bFormatType = UAC_FORMAT_TYPE_I,
455 /* STD AS ISO IN Endpoint */
456 static struct usb_endpoint_descriptor fs_epin_desc = {
457 .bLength = USB_DT_ENDPOINT_SIZE,
458 .bDescriptorType = USB_DT_ENDPOINT,
460 .bEndpointAddress = USB_DIR_IN,
461 .bmAttributes = USB_ENDPOINT_XFER_ISOC | USB_ENDPOINT_SYNC_ASYNC,
462 /* .wMaxPacketSize = DYNAMIC */
466 static struct usb_endpoint_descriptor hs_epin_desc = {
467 .bLength = USB_DT_ENDPOINT_SIZE,
468 .bDescriptorType = USB_DT_ENDPOINT,
470 .bmAttributes = USB_ENDPOINT_XFER_ISOC | USB_ENDPOINT_SYNC_ASYNC,
471 /* .wMaxPacketSize = DYNAMIC */
475 static struct usb_endpoint_descriptor ss_epin_desc = {
476 .bLength = USB_DT_ENDPOINT_SIZE,
477 .bDescriptorType = USB_DT_ENDPOINT,
479 .bEndpointAddress = USB_DIR_IN,
480 .bmAttributes = USB_ENDPOINT_XFER_ISOC | USB_ENDPOINT_SYNC_ASYNC,
481 /* .wMaxPacketSize = DYNAMIC */
485 static struct usb_ss_ep_comp_descriptor ss_epin_desc_comp = {
486 .bLength = sizeof(ss_epin_desc_comp),
487 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
490 /* wBytesPerInterval = DYNAMIC */
493 /* CS AS ISO IN Endpoint */
494 static struct uac2_iso_endpoint_descriptor as_iso_in_desc = {
495 .bLength = sizeof as_iso_in_desc,
496 .bDescriptorType = USB_DT_CS_ENDPOINT,
498 .bDescriptorSubtype = UAC_EP_GENERAL,
501 .bLockDelayUnits = 0,
505 static struct usb_descriptor_header *fs_audio_desc[] = {
506 (struct usb_descriptor_header *)&iad_desc,
507 (struct usb_descriptor_header *)&std_ac_if_desc,
509 (struct usb_descriptor_header *)&ac_hdr_desc,
510 (struct usb_descriptor_header *)&in_clk_src_desc,
511 (struct usb_descriptor_header *)&out_clk_src_desc,
512 (struct usb_descriptor_header *)&usb_out_it_desc,
513 (struct usb_descriptor_header *)&out_feature_unit_desc,
514 (struct usb_descriptor_header *)&io_in_it_desc,
515 (struct usb_descriptor_header *)&usb_in_ot_desc,
516 (struct usb_descriptor_header *)&in_feature_unit_desc,
517 (struct usb_descriptor_header *)&io_out_ot_desc,
519 (struct usb_descriptor_header *)&fs_ep_int_desc,
521 (struct usb_descriptor_header *)&std_as_out_if0_desc,
522 (struct usb_descriptor_header *)&std_as_out_if1_desc,
524 (struct usb_descriptor_header *)&as_out_hdr_desc,
525 (struct usb_descriptor_header *)&as_out_fmt1_desc,
526 (struct usb_descriptor_header *)&fs_epout_desc,
527 (struct usb_descriptor_header *)&as_iso_out_desc,
528 (struct usb_descriptor_header *)&fs_epin_fback_desc,
530 (struct usb_descriptor_header *)&std_as_in_if0_desc,
531 (struct usb_descriptor_header *)&std_as_in_if1_desc,
533 (struct usb_descriptor_header *)&as_in_hdr_desc,
534 (struct usb_descriptor_header *)&as_in_fmt1_desc,
535 (struct usb_descriptor_header *)&fs_epin_desc,
536 (struct usb_descriptor_header *)&as_iso_in_desc,
540 static struct usb_descriptor_header *hs_audio_desc[] = {
541 (struct usb_descriptor_header *)&iad_desc,
542 (struct usb_descriptor_header *)&std_ac_if_desc,
544 (struct usb_descriptor_header *)&ac_hdr_desc,
545 (struct usb_descriptor_header *)&in_clk_src_desc,
546 (struct usb_descriptor_header *)&out_clk_src_desc,
547 (struct usb_descriptor_header *)&usb_out_it_desc,
548 (struct usb_descriptor_header *)&out_feature_unit_desc,
549 (struct usb_descriptor_header *)&io_in_it_desc,
550 (struct usb_descriptor_header *)&usb_in_ot_desc,
551 (struct usb_descriptor_header *)&in_feature_unit_desc,
552 (struct usb_descriptor_header *)&io_out_ot_desc,
554 (struct usb_descriptor_header *)&hs_ep_int_desc,
556 (struct usb_descriptor_header *)&std_as_out_if0_desc,
557 (struct usb_descriptor_header *)&std_as_out_if1_desc,
559 (struct usb_descriptor_header *)&as_out_hdr_desc,
560 (struct usb_descriptor_header *)&as_out_fmt1_desc,
561 (struct usb_descriptor_header *)&hs_epout_desc,
562 (struct usb_descriptor_header *)&as_iso_out_desc,
563 (struct usb_descriptor_header *)&hs_epin_fback_desc,
565 (struct usb_descriptor_header *)&std_as_in_if0_desc,
566 (struct usb_descriptor_header *)&std_as_in_if1_desc,
568 (struct usb_descriptor_header *)&as_in_hdr_desc,
569 (struct usb_descriptor_header *)&as_in_fmt1_desc,
570 (struct usb_descriptor_header *)&hs_epin_desc,
571 (struct usb_descriptor_header *)&as_iso_in_desc,
575 static struct usb_descriptor_header *ss_audio_desc[] = {
576 (struct usb_descriptor_header *)&iad_desc,
577 (struct usb_descriptor_header *)&std_ac_if_desc,
579 (struct usb_descriptor_header *)&ac_hdr_desc,
580 (struct usb_descriptor_header *)&in_clk_src_desc,
581 (struct usb_descriptor_header *)&out_clk_src_desc,
582 (struct usb_descriptor_header *)&usb_out_it_desc,
583 (struct usb_descriptor_header *)&out_feature_unit_desc,
584 (struct usb_descriptor_header *)&io_in_it_desc,
585 (struct usb_descriptor_header *)&usb_in_ot_desc,
586 (struct usb_descriptor_header *)&in_feature_unit_desc,
587 (struct usb_descriptor_header *)&io_out_ot_desc,
589 (struct usb_descriptor_header *)&ss_ep_int_desc,
591 (struct usb_descriptor_header *)&std_as_out_if0_desc,
592 (struct usb_descriptor_header *)&std_as_out_if1_desc,
594 (struct usb_descriptor_header *)&as_out_hdr_desc,
595 (struct usb_descriptor_header *)&as_out_fmt1_desc,
596 (struct usb_descriptor_header *)&ss_epout_desc,
597 (struct usb_descriptor_header *)&ss_epout_desc_comp,
598 (struct usb_descriptor_header *)&as_iso_out_desc,
599 (struct usb_descriptor_header *)&ss_epin_fback_desc,
601 (struct usb_descriptor_header *)&std_as_in_if0_desc,
602 (struct usb_descriptor_header *)&std_as_in_if1_desc,
604 (struct usb_descriptor_header *)&as_in_hdr_desc,
605 (struct usb_descriptor_header *)&as_in_fmt1_desc,
606 (struct usb_descriptor_header *)&ss_epin_desc,
607 (struct usb_descriptor_header *)&ss_epin_desc_comp,
608 (struct usb_descriptor_header *)&as_iso_in_desc,
612 struct cntrl_cur_lay2 {
616 struct cntrl_range_lay2 {
617 __le16 wNumSubRanges;
623 struct cntrl_cur_lay3 {
627 struct cntrl_range_lay3 {
628 __le16 wNumSubRanges;
634 static int set_ep_max_packet_size(const struct f_uac2_opts *uac2_opts,
635 struct usb_endpoint_descriptor *ep_desc,
636 enum usb_device_speed speed, bool is_playback)
638 int chmask, srate, ssize;
639 u16 max_size_bw, max_size_ep;
649 case USB_SPEED_SUPER:
659 chmask = uac2_opts->p_chmask;
660 srate = uac2_opts->p_srate;
661 ssize = uac2_opts->p_ssize;
663 chmask = uac2_opts->c_chmask;
664 srate = uac2_opts->c_srate;
665 ssize = uac2_opts->c_ssize;
668 if (!is_playback && (uac2_opts->c_sync == USB_ENDPOINT_SYNC_ASYNC))
669 srate = srate * (1000 + uac2_opts->fb_max) / 1000;
671 max_size_bw = num_channels(chmask) * ssize *
672 DIV_ROUND_UP(srate, factor / (1 << (ep_desc->bInterval - 1)));
673 ep_desc->wMaxPacketSize = cpu_to_le16(min_t(u16, max_size_bw,
679 static struct uac2_feature_unit_descriptor *build_fu_desc(int chmask)
681 struct uac2_feature_unit_descriptor *fu_desc;
682 int channels = num_channels(chmask);
683 int fu_desc_size = UAC2_DT_FEATURE_UNIT_SIZE(channels);
685 fu_desc = kzalloc(fu_desc_size, GFP_KERNEL);
689 fu_desc->bLength = fu_desc_size;
690 fu_desc->bDescriptorType = USB_DT_CS_INTERFACE;
692 fu_desc->bDescriptorSubtype = UAC_FEATURE_UNIT;
694 /* bUnitID, bSourceID and bmaControls will be defined later */
699 /* Use macro to overcome line length limitation */
700 #define USBDHDR(p) (struct usb_descriptor_header *)(p)
702 static void setup_headers(struct f_uac2_opts *opts,
703 struct usb_descriptor_header **headers,
704 enum usb_device_speed speed)
706 struct usb_ss_ep_comp_descriptor *epout_desc_comp = NULL;
707 struct usb_ss_ep_comp_descriptor *epin_desc_comp = NULL;
708 struct usb_endpoint_descriptor *epout_desc;
709 struct usb_endpoint_descriptor *epin_desc;
710 struct usb_endpoint_descriptor *epin_fback_desc;
711 struct usb_endpoint_descriptor *ep_int_desc;
716 epout_desc = &fs_epout_desc;
717 epin_desc = &fs_epin_desc;
718 epin_fback_desc = &fs_epin_fback_desc;
719 ep_int_desc = &fs_ep_int_desc;
722 epout_desc = &hs_epout_desc;
723 epin_desc = &hs_epin_desc;
724 epin_fback_desc = &hs_epin_fback_desc;
725 ep_int_desc = &hs_ep_int_desc;
728 epout_desc = &ss_epout_desc;
729 epin_desc = &ss_epin_desc;
730 epout_desc_comp = &ss_epout_desc_comp;
731 epin_desc_comp = &ss_epin_desc_comp;
732 epin_fback_desc = &ss_epin_fback_desc;
733 ep_int_desc = &ss_ep_int_desc;
737 headers[i++] = USBDHDR(&iad_desc);
738 headers[i++] = USBDHDR(&std_ac_if_desc);
739 headers[i++] = USBDHDR(&ac_hdr_desc);
741 headers[i++] = USBDHDR(&in_clk_src_desc);
742 if (EPOUT_EN(opts)) {
743 headers[i++] = USBDHDR(&out_clk_src_desc);
744 headers[i++] = USBDHDR(&usb_out_it_desc);
747 headers[i++] = USBDHDR(out_feature_unit_desc);
751 headers[i++] = USBDHDR(&io_in_it_desc);
754 headers[i++] = USBDHDR(in_feature_unit_desc);
756 headers[i++] = USBDHDR(&usb_in_ot_desc);
760 headers[i++] = USBDHDR(&io_out_ot_desc);
762 if (FUOUT_EN(opts) || FUIN_EN(opts))
763 headers[i++] = USBDHDR(ep_int_desc);
765 if (EPOUT_EN(opts)) {
766 headers[i++] = USBDHDR(&std_as_out_if0_desc);
767 headers[i++] = USBDHDR(&std_as_out_if1_desc);
768 headers[i++] = USBDHDR(&as_out_hdr_desc);
769 headers[i++] = USBDHDR(&as_out_fmt1_desc);
770 headers[i++] = USBDHDR(epout_desc);
772 headers[i++] = USBDHDR(epout_desc_comp);
774 headers[i++] = USBDHDR(&as_iso_out_desc);
776 if (EPOUT_FBACK_IN_EN(opts))
777 headers[i++] = USBDHDR(epin_fback_desc);
781 headers[i++] = USBDHDR(&std_as_in_if0_desc);
782 headers[i++] = USBDHDR(&std_as_in_if1_desc);
783 headers[i++] = USBDHDR(&as_in_hdr_desc);
784 headers[i++] = USBDHDR(&as_in_fmt1_desc);
785 headers[i++] = USBDHDR(epin_desc);
787 headers[i++] = USBDHDR(epin_desc_comp);
789 headers[i++] = USBDHDR(&as_iso_in_desc);
794 static void setup_descriptor(struct f_uac2_opts *opts)
796 /* patch descriptors */
797 int i = 1; /* ID's start with 1 */
800 usb_out_it_desc.bTerminalID = i++;
802 io_in_it_desc.bTerminalID = i++;
804 io_out_ot_desc.bTerminalID = i++;
806 usb_in_ot_desc.bTerminalID = i++;
808 out_feature_unit_desc->bUnitID = i++;
810 in_feature_unit_desc->bUnitID = i++;
812 out_clk_src_desc.bClockID = i++;
814 in_clk_src_desc.bClockID = i++;
816 usb_out_it_desc.bCSourceID = out_clk_src_desc.bClockID;
819 usb_in_ot_desc.bSourceID = in_feature_unit_desc->bUnitID;
820 in_feature_unit_desc->bSourceID = io_in_it_desc.bTerminalID;
822 usb_in_ot_desc.bSourceID = io_in_it_desc.bTerminalID;
825 usb_in_ot_desc.bCSourceID = in_clk_src_desc.bClockID;
826 io_in_it_desc.bCSourceID = in_clk_src_desc.bClockID;
827 io_out_ot_desc.bCSourceID = out_clk_src_desc.bClockID;
829 if (FUOUT_EN(opts)) {
830 io_out_ot_desc.bSourceID = out_feature_unit_desc->bUnitID;
831 out_feature_unit_desc->bSourceID = usb_out_it_desc.bTerminalID;
833 io_out_ot_desc.bSourceID = usb_out_it_desc.bTerminalID;
836 as_out_hdr_desc.bTerminalLink = usb_out_it_desc.bTerminalID;
837 as_in_hdr_desc.bTerminalLink = usb_in_ot_desc.bTerminalID;
839 iad_desc.bInterfaceCount = 1;
840 ac_hdr_desc.wTotalLength = cpu_to_le16(sizeof(ac_hdr_desc));
843 u16 len = le16_to_cpu(ac_hdr_desc.wTotalLength);
845 len += sizeof(in_clk_src_desc);
846 len += sizeof(usb_in_ot_desc);
849 len += in_feature_unit_desc->bLength;
851 len += sizeof(io_in_it_desc);
852 ac_hdr_desc.wTotalLength = cpu_to_le16(len);
853 iad_desc.bInterfaceCount++;
855 if (EPOUT_EN(opts)) {
856 u16 len = le16_to_cpu(ac_hdr_desc.wTotalLength);
858 len += sizeof(out_clk_src_desc);
859 len += sizeof(usb_out_it_desc);
862 len += out_feature_unit_desc->bLength;
864 len += sizeof(io_out_ot_desc);
865 ac_hdr_desc.wTotalLength = cpu_to_le16(len);
866 iad_desc.bInterfaceCount++;
869 setup_headers(opts, fs_audio_desc, USB_SPEED_FULL);
870 setup_headers(opts, hs_audio_desc, USB_SPEED_HIGH);
871 setup_headers(opts, ss_audio_desc, USB_SPEED_SUPER);
874 static int afunc_validate_opts(struct g_audio *agdev, struct device *dev)
876 struct f_uac2_opts *opts = g_audio_to_uac2_opts(agdev);
878 if (!opts->p_chmask && !opts->c_chmask) {
879 dev_err(dev, "Error: no playback and capture channels\n");
881 } else if (opts->p_chmask & ~UAC2_CHANNEL_MASK) {
882 dev_err(dev, "Error: unsupported playback channels mask\n");
884 } else if (opts->c_chmask & ~UAC2_CHANNEL_MASK) {
885 dev_err(dev, "Error: unsupported capture channels mask\n");
887 } else if ((opts->p_ssize < 1) || (opts->p_ssize > 4)) {
888 dev_err(dev, "Error: incorrect playback sample size\n");
890 } else if ((opts->c_ssize < 1) || (opts->c_ssize > 4)) {
891 dev_err(dev, "Error: incorrect capture sample size\n");
893 } else if (!opts->p_srate) {
894 dev_err(dev, "Error: incorrect playback sampling rate\n");
896 } else if (!opts->c_srate) {
897 dev_err(dev, "Error: incorrect capture sampling rate\n");
901 if (opts->p_volume_max <= opts->p_volume_min) {
902 dev_err(dev, "Error: incorrect playback volume max/min\n");
904 } else if (opts->c_volume_max <= opts->c_volume_min) {
905 dev_err(dev, "Error: incorrect capture volume max/min\n");
907 } else if (opts->p_volume_res <= 0) {
908 dev_err(dev, "Error: negative/zero playback volume resolution\n");
910 } else if (opts->c_volume_res <= 0) {
911 dev_err(dev, "Error: negative/zero capture volume resolution\n");
915 if ((opts->p_volume_max - opts->p_volume_min) % opts->p_volume_res) {
916 dev_err(dev, "Error: incorrect playback volume resolution\n");
918 } else if ((opts->c_volume_max - opts->c_volume_min) % opts->c_volume_res) {
919 dev_err(dev, "Error: incorrect capture volume resolution\n");
927 afunc_bind(struct usb_configuration *cfg, struct usb_function *fn)
929 struct f_uac2 *uac2 = func_to_uac2(fn);
930 struct g_audio *agdev = func_to_g_audio(fn);
931 struct usb_composite_dev *cdev = cfg->cdev;
932 struct usb_gadget *gadget = cdev->gadget;
933 struct device *dev = &gadget->dev;
934 struct f_uac2_opts *uac2_opts = g_audio_to_uac2_opts(agdev);
935 struct usb_string *us;
938 ret = afunc_validate_opts(agdev, dev);
942 us = usb_gstrings_attach(cdev, fn_strings, ARRAY_SIZE(strings_fn));
946 if (FUOUT_EN(uac2_opts)) {
947 out_feature_unit_desc = build_fu_desc(uac2_opts->c_chmask);
948 if (!out_feature_unit_desc)
951 if (FUIN_EN(uac2_opts)) {
952 in_feature_unit_desc = build_fu_desc(uac2_opts->p_chmask);
953 if (!in_feature_unit_desc) {
959 iad_desc.iFunction = us[STR_ASSOC].id;
960 std_ac_if_desc.iInterface = us[STR_IF_CTRL].id;
961 in_clk_src_desc.iClockSource = us[STR_CLKSRC_IN].id;
962 out_clk_src_desc.iClockSource = us[STR_CLKSRC_OUT].id;
963 usb_out_it_desc.iTerminal = us[STR_USB_IT].id;
964 io_in_it_desc.iTerminal = us[STR_IO_IT].id;
965 usb_in_ot_desc.iTerminal = us[STR_USB_OT].id;
966 io_out_ot_desc.iTerminal = us[STR_IO_OT].id;
967 std_as_out_if0_desc.iInterface = us[STR_AS_OUT_ALT0].id;
968 std_as_out_if1_desc.iInterface = us[STR_AS_OUT_ALT1].id;
969 std_as_in_if0_desc.iInterface = us[STR_AS_IN_ALT0].id;
970 std_as_in_if1_desc.iInterface = us[STR_AS_IN_ALT1].id;
972 if (FUOUT_EN(uac2_opts)) {
973 u8 *i_feature = (u8 *)out_feature_unit_desc +
974 out_feature_unit_desc->bLength - 1;
975 *i_feature = us[STR_FU_OUT].id;
977 if (FUIN_EN(uac2_opts)) {
978 u8 *i_feature = (u8 *)in_feature_unit_desc +
979 in_feature_unit_desc->bLength - 1;
980 *i_feature = us[STR_FU_IN].id;
984 /* Initialize the configurable parameters */
985 usb_out_it_desc.bNrChannels = num_channels(uac2_opts->c_chmask);
986 usb_out_it_desc.bmChannelConfig = cpu_to_le32(uac2_opts->c_chmask);
987 io_in_it_desc.bNrChannels = num_channels(uac2_opts->p_chmask);
988 io_in_it_desc.bmChannelConfig = cpu_to_le32(uac2_opts->p_chmask);
989 as_out_hdr_desc.bNrChannels = num_channels(uac2_opts->c_chmask);
990 as_out_hdr_desc.bmChannelConfig = cpu_to_le32(uac2_opts->c_chmask);
991 as_in_hdr_desc.bNrChannels = num_channels(uac2_opts->p_chmask);
992 as_in_hdr_desc.bmChannelConfig = cpu_to_le32(uac2_opts->p_chmask);
993 as_out_fmt1_desc.bSubslotSize = uac2_opts->c_ssize;
994 as_out_fmt1_desc.bBitResolution = uac2_opts->c_ssize * 8;
995 as_in_fmt1_desc.bSubslotSize = uac2_opts->p_ssize;
996 as_in_fmt1_desc.bBitResolution = uac2_opts->p_ssize * 8;
997 if (FUOUT_EN(uac2_opts)) {
998 __le32 *bma = (__le32 *)&out_feature_unit_desc->bmaControls[0];
1001 if (uac2_opts->c_mute_present)
1002 control |= CONTROL_RDWR << FU_MUTE_CTRL;
1003 if (uac2_opts->c_volume_present)
1004 control |= CONTROL_RDWR << FU_VOL_CTRL;
1005 *bma = cpu_to_le32(control);
1007 if (FUIN_EN(uac2_opts)) {
1008 __le32 *bma = (__le32 *)&in_feature_unit_desc->bmaControls[0];
1011 if (uac2_opts->p_mute_present)
1012 control |= CONTROL_RDWR << FU_MUTE_CTRL;
1013 if (uac2_opts->p_volume_present)
1014 control |= CONTROL_RDWR << FU_VOL_CTRL;
1015 *bma = cpu_to_le32(control);
1018 snprintf(clksrc_in, sizeof(clksrc_in), "%uHz", uac2_opts->p_srate);
1019 snprintf(clksrc_out, sizeof(clksrc_out), "%uHz", uac2_opts->c_srate);
1021 ret = usb_interface_id(cfg, fn);
1023 dev_err(dev, "%s:%d Error!\n", __func__, __LINE__);
1026 iad_desc.bFirstInterface = ret;
1028 std_ac_if_desc.bInterfaceNumber = ret;
1029 uac2->ac_intf = ret;
1032 if (EPOUT_EN(uac2_opts)) {
1033 ret = usb_interface_id(cfg, fn);
1035 dev_err(dev, "%s:%d Error!\n", __func__, __LINE__);
1038 std_as_out_if0_desc.bInterfaceNumber = ret;
1039 std_as_out_if1_desc.bInterfaceNumber = ret;
1040 uac2->as_out_intf = ret;
1041 uac2->as_out_alt = 0;
1043 if (EPOUT_FBACK_IN_EN(uac2_opts)) {
1044 fs_epout_desc.bmAttributes =
1045 USB_ENDPOINT_XFER_ISOC | USB_ENDPOINT_SYNC_ASYNC;
1046 hs_epout_desc.bmAttributes =
1047 USB_ENDPOINT_XFER_ISOC | USB_ENDPOINT_SYNC_ASYNC;
1048 ss_epout_desc.bmAttributes =
1049 USB_ENDPOINT_XFER_ISOC | USB_ENDPOINT_SYNC_ASYNC;
1050 std_as_out_if1_desc.bNumEndpoints++;
1052 fs_epout_desc.bmAttributes =
1053 USB_ENDPOINT_XFER_ISOC | USB_ENDPOINT_SYNC_ADAPTIVE;
1054 hs_epout_desc.bmAttributes =
1055 USB_ENDPOINT_XFER_ISOC | USB_ENDPOINT_SYNC_ADAPTIVE;
1056 ss_epout_desc.bmAttributes =
1057 USB_ENDPOINT_XFER_ISOC | USB_ENDPOINT_SYNC_ADAPTIVE;
1061 if (EPIN_EN(uac2_opts)) {
1062 ret = usb_interface_id(cfg, fn);
1064 dev_err(dev, "%s:%d Error!\n", __func__, __LINE__);
1067 std_as_in_if0_desc.bInterfaceNumber = ret;
1068 std_as_in_if1_desc.bInterfaceNumber = ret;
1069 uac2->as_in_intf = ret;
1070 uac2->as_in_alt = 0;
1073 if (FUOUT_EN(uac2_opts) || FUIN_EN(uac2_opts)) {
1074 uac2->int_ep = usb_ep_autoconfig(gadget, &fs_ep_int_desc);
1075 if (!uac2->int_ep) {
1076 dev_err(dev, "%s:%d Error!\n", __func__, __LINE__);
1081 std_ac_if_desc.bNumEndpoints = 1;
1084 /* Calculate wMaxPacketSize according to audio bandwidth */
1085 ret = set_ep_max_packet_size(uac2_opts, &fs_epin_desc, USB_SPEED_FULL,
1088 dev_err(dev, "%s:%d Error!\n", __func__, __LINE__);
1092 ret = set_ep_max_packet_size(uac2_opts, &fs_epout_desc, USB_SPEED_FULL,
1095 dev_err(dev, "%s:%d Error!\n", __func__, __LINE__);
1099 ret = set_ep_max_packet_size(uac2_opts, &hs_epin_desc, USB_SPEED_HIGH,
1102 dev_err(dev, "%s:%d Error!\n", __func__, __LINE__);
1106 ret = set_ep_max_packet_size(uac2_opts, &hs_epout_desc, USB_SPEED_HIGH,
1109 dev_err(dev, "%s:%d Error!\n", __func__, __LINE__);
1113 ret = set_ep_max_packet_size(uac2_opts, &ss_epin_desc, USB_SPEED_SUPER,
1116 dev_err(dev, "%s:%d Error!\n", __func__, __LINE__);
1120 ret = set_ep_max_packet_size(uac2_opts, &ss_epout_desc, USB_SPEED_SUPER,
1123 dev_err(dev, "%s:%d Error!\n", __func__, __LINE__);
1127 if (EPOUT_EN(uac2_opts)) {
1128 agdev->out_ep = usb_ep_autoconfig(gadget, &fs_epout_desc);
1129 if (!agdev->out_ep) {
1130 dev_err(dev, "%s:%d Error!\n", __func__, __LINE__);
1134 if (EPOUT_FBACK_IN_EN(uac2_opts)) {
1135 agdev->in_ep_fback = usb_ep_autoconfig(gadget,
1136 &fs_epin_fback_desc);
1137 if (!agdev->in_ep_fback) {
1138 dev_err(dev, "%s:%d Error!\n",
1139 __func__, __LINE__);
1146 if (EPIN_EN(uac2_opts)) {
1147 agdev->in_ep = usb_ep_autoconfig(gadget, &fs_epin_desc);
1148 if (!agdev->in_ep) {
1149 dev_err(dev, "%s:%d Error!\n", __func__, __LINE__);
1155 agdev->in_ep_maxpsize = max_t(u16,
1156 le16_to_cpu(fs_epin_desc.wMaxPacketSize),
1157 le16_to_cpu(hs_epin_desc.wMaxPacketSize));
1158 agdev->out_ep_maxpsize = max_t(u16,
1159 le16_to_cpu(fs_epout_desc.wMaxPacketSize),
1160 le16_to_cpu(hs_epout_desc.wMaxPacketSize));
1162 agdev->in_ep_maxpsize = max_t(u16, agdev->in_ep_maxpsize,
1163 le16_to_cpu(ss_epin_desc.wMaxPacketSize));
1164 agdev->out_ep_maxpsize = max_t(u16, agdev->out_ep_maxpsize,
1165 le16_to_cpu(ss_epout_desc.wMaxPacketSize));
1167 // HS and SS endpoint addresses are copied from autoconfigured FS descriptors
1168 hs_ep_int_desc.bEndpointAddress = fs_ep_int_desc.bEndpointAddress;
1169 hs_epout_desc.bEndpointAddress = fs_epout_desc.bEndpointAddress;
1170 hs_epin_fback_desc.bEndpointAddress = fs_epin_fback_desc.bEndpointAddress;
1171 hs_epin_desc.bEndpointAddress = fs_epin_desc.bEndpointAddress;
1172 ss_epout_desc.bEndpointAddress = fs_epout_desc.bEndpointAddress;
1173 ss_epin_fback_desc.bEndpointAddress = fs_epin_fback_desc.bEndpointAddress;
1174 ss_epin_desc.bEndpointAddress = fs_epin_desc.bEndpointAddress;
1175 ss_ep_int_desc.bEndpointAddress = fs_ep_int_desc.bEndpointAddress;
1177 setup_descriptor(uac2_opts);
1179 ret = usb_assign_descriptors(fn, fs_audio_desc, hs_audio_desc, ss_audio_desc,
1184 agdev->gadget = gadget;
1186 agdev->params.p_chmask = uac2_opts->p_chmask;
1187 agdev->params.p_srate = uac2_opts->p_srate;
1188 agdev->params.p_ssize = uac2_opts->p_ssize;
1189 if (FUIN_EN(uac2_opts)) {
1190 agdev->params.p_fu.id = USB_IN_FU_ID;
1191 agdev->params.p_fu.mute_present = uac2_opts->p_mute_present;
1192 agdev->params.p_fu.volume_present = uac2_opts->p_volume_present;
1193 agdev->params.p_fu.volume_min = uac2_opts->p_volume_min;
1194 agdev->params.p_fu.volume_max = uac2_opts->p_volume_max;
1195 agdev->params.p_fu.volume_res = uac2_opts->p_volume_res;
1197 agdev->params.c_chmask = uac2_opts->c_chmask;
1198 agdev->params.c_srate = uac2_opts->c_srate;
1199 agdev->params.c_ssize = uac2_opts->c_ssize;
1200 if (FUOUT_EN(uac2_opts)) {
1201 agdev->params.c_fu.id = USB_OUT_FU_ID;
1202 agdev->params.c_fu.mute_present = uac2_opts->c_mute_present;
1203 agdev->params.c_fu.volume_present = uac2_opts->c_volume_present;
1204 agdev->params.c_fu.volume_min = uac2_opts->c_volume_min;
1205 agdev->params.c_fu.volume_max = uac2_opts->c_volume_max;
1206 agdev->params.c_fu.volume_res = uac2_opts->c_volume_res;
1208 agdev->params.req_number = uac2_opts->req_number;
1209 agdev->params.fb_max = uac2_opts->fb_max;
1211 if (FUOUT_EN(uac2_opts) || FUIN_EN(uac2_opts))
1212 agdev->notify = afunc_notify;
1214 ret = g_audio_setup(agdev, "UAC2 PCM", "UAC2_Gadget");
1216 goto err_free_descs;
1221 usb_free_all_descriptors(fn);
1222 agdev->gadget = NULL;
1224 kfree(out_feature_unit_desc);
1225 out_feature_unit_desc = NULL;
1226 kfree(in_feature_unit_desc);
1227 in_feature_unit_desc = NULL;
1232 afunc_notify_complete(struct usb_ep *_ep, struct usb_request *req)
1234 struct g_audio *agdev = req->context;
1235 struct f_uac2 *uac2 = func_to_uac2(&agdev->func);
1237 atomic_dec(&uac2->int_count);
1239 usb_ep_free_request(_ep, req);
1243 afunc_notify(struct g_audio *agdev, int unit_id, int cs)
1245 struct f_uac2 *uac2 = func_to_uac2(&agdev->func);
1246 struct usb_request *req;
1247 struct uac2_interrupt_data_msg *msg;
1248 u16 w_index, w_value;
1251 if (!uac2->int_ep->enabled)
1254 if (atomic_inc_return(&uac2->int_count) > UAC2_DEF_INT_REQ_NUM) {
1255 atomic_dec(&uac2->int_count);
1259 req = usb_ep_alloc_request(uac2->int_ep, GFP_ATOMIC);
1262 goto err_dec_int_count;
1265 msg = kzalloc(sizeof(*msg), GFP_ATOMIC);
1268 goto err_free_request;
1271 w_index = unit_id << 8 | uac2->ac_intf;
1274 msg->bInfo = 0; /* Non-vendor, interface interrupt */
1275 msg->bAttribute = UAC2_CS_CUR;
1276 msg->wIndex = cpu_to_le16(w_index);
1277 msg->wValue = cpu_to_le16(w_value);
1279 req->length = sizeof(*msg);
1281 req->context = agdev;
1282 req->complete = afunc_notify_complete;
1284 ret = usb_ep_queue(uac2->int_ep, req, GFP_ATOMIC);
1294 usb_ep_free_request(uac2->int_ep, req);
1296 atomic_dec(&uac2->int_count);
1302 afunc_set_alt(struct usb_function *fn, unsigned intf, unsigned alt)
1304 struct usb_composite_dev *cdev = fn->config->cdev;
1305 struct f_uac2 *uac2 = func_to_uac2(fn);
1306 struct g_audio *agdev = func_to_g_audio(fn);
1307 struct usb_gadget *gadget = cdev->gadget;
1308 struct device *dev = &gadget->dev;
1311 /* No i/f has more than 2 alt settings */
1313 dev_err(dev, "%s:%d Error!\n", __func__, __LINE__);
1317 if (intf == uac2->ac_intf) {
1318 /* Control I/f has only 1 AltSetting - 0 */
1320 dev_err(dev, "%s:%d Error!\n", __func__, __LINE__);
1324 /* restart interrupt endpoint */
1326 usb_ep_disable(uac2->int_ep);
1327 config_ep_by_speed(gadget, &agdev->func, uac2->int_ep);
1328 usb_ep_enable(uac2->int_ep);
1334 if (intf == uac2->as_out_intf) {
1335 uac2->as_out_alt = alt;
1338 ret = u_audio_start_capture(&uac2->g_audio);
1340 u_audio_stop_capture(&uac2->g_audio);
1341 } else if (intf == uac2->as_in_intf) {
1342 uac2->as_in_alt = alt;
1345 ret = u_audio_start_playback(&uac2->g_audio);
1347 u_audio_stop_playback(&uac2->g_audio);
1349 dev_err(dev, "%s:%d Error!\n", __func__, __LINE__);
1357 afunc_get_alt(struct usb_function *fn, unsigned intf)
1359 struct f_uac2 *uac2 = func_to_uac2(fn);
1360 struct g_audio *agdev = func_to_g_audio(fn);
1362 if (intf == uac2->ac_intf)
1363 return uac2->ac_alt;
1364 else if (intf == uac2->as_out_intf)
1365 return uac2->as_out_alt;
1366 else if (intf == uac2->as_in_intf)
1367 return uac2->as_in_alt;
1369 dev_err(&agdev->gadget->dev,
1370 "%s:%d Invalid Interface %d!\n",
1371 __func__, __LINE__, intf);
1377 afunc_disable(struct usb_function *fn)
1379 struct f_uac2 *uac2 = func_to_uac2(fn);
1381 uac2->as_in_alt = 0;
1382 uac2->as_out_alt = 0;
1383 u_audio_stop_capture(&uac2->g_audio);
1384 u_audio_stop_playback(&uac2->g_audio);
1386 usb_ep_disable(uac2->int_ep);
1390 in_rq_cur(struct usb_function *fn, const struct usb_ctrlrequest *cr)
1392 struct usb_request *req = fn->config->cdev->req;
1393 struct g_audio *agdev = func_to_g_audio(fn);
1394 struct f_uac2_opts *opts = g_audio_to_uac2_opts(agdev);
1395 u16 w_length = le16_to_cpu(cr->wLength);
1396 u16 w_index = le16_to_cpu(cr->wIndex);
1397 u16 w_value = le16_to_cpu(cr->wValue);
1398 u8 entity_id = (w_index >> 8) & 0xff;
1399 u8 control_selector = w_value >> 8;
1400 int value = -EOPNOTSUPP;
1401 int p_srate, c_srate;
1403 p_srate = opts->p_srate;
1404 c_srate = opts->c_srate;
1406 if ((entity_id == USB_IN_CLK_ID) || (entity_id == USB_OUT_CLK_ID)) {
1407 if (control_selector == UAC2_CS_CONTROL_SAM_FREQ) {
1408 struct cntrl_cur_lay3 c;
1410 memset(&c, 0, sizeof(struct cntrl_cur_lay3));
1412 if (entity_id == USB_IN_CLK_ID)
1413 c.dCUR = cpu_to_le32(p_srate);
1414 else if (entity_id == USB_OUT_CLK_ID)
1415 c.dCUR = cpu_to_le32(c_srate);
1417 value = min_t(unsigned int, w_length, sizeof(c));
1418 memcpy(req->buf, &c, value);
1419 } else if (control_selector == UAC2_CS_CONTROL_CLOCK_VALID) {
1420 *(u8 *)req->buf = 1;
1421 value = min_t(unsigned int, w_length, 1);
1423 dev_err(&agdev->gadget->dev,
1424 "%s:%d control_selector=%d TODO!\n",
1425 __func__, __LINE__, control_selector);
1427 } else if ((FUIN_EN(opts) && (entity_id == USB_IN_FU_ID)) ||
1428 (FUOUT_EN(opts) && (entity_id == USB_OUT_FU_ID))) {
1429 unsigned int is_playback = 0;
1431 if (FUIN_EN(opts) && (entity_id == USB_IN_FU_ID))
1434 if (control_selector == UAC_FU_MUTE) {
1437 u_audio_get_mute(agdev, is_playback, &mute);
1439 *(u8 *)req->buf = mute;
1440 value = min_t(unsigned int, w_length, 1);
1441 } else if (control_selector == UAC_FU_VOLUME) {
1442 struct cntrl_cur_lay2 c;
1445 memset(&c, 0, sizeof(struct cntrl_cur_lay2));
1447 u_audio_get_volume(agdev, is_playback, &volume);
1448 c.wCUR = cpu_to_le16(volume);
1450 value = min_t(unsigned int, w_length, sizeof(c));
1451 memcpy(req->buf, &c, value);
1453 dev_err(&agdev->gadget->dev,
1454 "%s:%d control_selector=%d TODO!\n",
1455 __func__, __LINE__, control_selector);
1458 dev_err(&agdev->gadget->dev,
1459 "%s:%d entity_id=%d control_selector=%d TODO!\n",
1460 __func__, __LINE__, entity_id, control_selector);
1467 in_rq_range(struct usb_function *fn, const struct usb_ctrlrequest *cr)
1469 struct usb_request *req = fn->config->cdev->req;
1470 struct g_audio *agdev = func_to_g_audio(fn);
1471 struct f_uac2_opts *opts = g_audio_to_uac2_opts(agdev);
1472 u16 w_length = le16_to_cpu(cr->wLength);
1473 u16 w_index = le16_to_cpu(cr->wIndex);
1474 u16 w_value = le16_to_cpu(cr->wValue);
1475 u8 entity_id = (w_index >> 8) & 0xff;
1476 u8 control_selector = w_value >> 8;
1477 int value = -EOPNOTSUPP;
1478 int p_srate, c_srate;
1480 p_srate = opts->p_srate;
1481 c_srate = opts->c_srate;
1483 if ((entity_id == USB_IN_CLK_ID) || (entity_id == USB_OUT_CLK_ID)) {
1484 if (control_selector == UAC2_CS_CONTROL_SAM_FREQ) {
1485 struct cntrl_range_lay3 r;
1487 if (entity_id == USB_IN_CLK_ID)
1488 r.dMIN = cpu_to_le32(p_srate);
1489 else if (entity_id == USB_OUT_CLK_ID)
1490 r.dMIN = cpu_to_le32(c_srate);
1496 r.wNumSubRanges = cpu_to_le16(1);
1498 value = min_t(unsigned int, w_length, sizeof(r));
1499 memcpy(req->buf, &r, value);
1501 dev_err(&agdev->gadget->dev,
1502 "%s:%d control_selector=%d TODO!\n",
1503 __func__, __LINE__, control_selector);
1505 } else if ((FUIN_EN(opts) && (entity_id == USB_IN_FU_ID)) ||
1506 (FUOUT_EN(opts) && (entity_id == USB_OUT_FU_ID))) {
1507 unsigned int is_playback = 0;
1509 if (FUIN_EN(opts) && (entity_id == USB_IN_FU_ID))
1512 if (control_selector == UAC_FU_VOLUME) {
1513 struct cntrl_range_lay2 r;
1514 s16 max_db, min_db, res_db;
1517 max_db = opts->p_volume_max;
1518 min_db = opts->p_volume_min;
1519 res_db = opts->p_volume_res;
1521 max_db = opts->c_volume_max;
1522 min_db = opts->c_volume_min;
1523 res_db = opts->c_volume_res;
1526 r.wMAX = cpu_to_le16(max_db);
1527 r.wMIN = cpu_to_le16(min_db);
1528 r.wRES = cpu_to_le16(res_db);
1529 r.wNumSubRanges = cpu_to_le16(1);
1531 value = min_t(unsigned int, w_length, sizeof(r));
1532 memcpy(req->buf, &r, value);
1534 dev_err(&agdev->gadget->dev,
1535 "%s:%d control_selector=%d TODO!\n",
1536 __func__, __LINE__, control_selector);
1539 dev_err(&agdev->gadget->dev,
1540 "%s:%d entity_id=%d control_selector=%d TODO!\n",
1541 __func__, __LINE__, entity_id, control_selector);
1548 ac_rq_in(struct usb_function *fn, const struct usb_ctrlrequest *cr)
1550 if (cr->bRequest == UAC2_CS_CUR)
1551 return in_rq_cur(fn, cr);
1552 else if (cr->bRequest == UAC2_CS_RANGE)
1553 return in_rq_range(fn, cr);
1559 out_rq_cur_complete(struct usb_ep *ep, struct usb_request *req)
1561 struct g_audio *agdev = req->context;
1562 struct usb_composite_dev *cdev = agdev->func.config->cdev;
1563 struct f_uac2_opts *opts = g_audio_to_uac2_opts(agdev);
1564 struct f_uac2 *uac2 = func_to_uac2(&agdev->func);
1565 struct usb_ctrlrequest *cr = &uac2->setup_cr;
1566 u16 w_index = le16_to_cpu(cr->wIndex);
1567 u16 w_value = le16_to_cpu(cr->wValue);
1568 u8 entity_id = (w_index >> 8) & 0xff;
1569 u8 control_selector = w_value >> 8;
1571 if (req->status != 0) {
1572 dev_dbg(&cdev->gadget->dev, "completion err %d\n", req->status);
1576 if ((FUIN_EN(opts) && (entity_id == USB_IN_FU_ID)) ||
1577 (FUOUT_EN(opts) && (entity_id == USB_OUT_FU_ID))) {
1578 unsigned int is_playback = 0;
1580 if (FUIN_EN(opts) && (entity_id == USB_IN_FU_ID))
1583 if (control_selector == UAC_FU_MUTE) {
1584 u8 mute = *(u8 *)req->buf;
1586 u_audio_set_mute(agdev, is_playback, mute);
1589 } else if (control_selector == UAC_FU_VOLUME) {
1590 struct cntrl_cur_lay2 *c = req->buf;
1593 volume = le16_to_cpu(c->wCUR);
1594 u_audio_set_volume(agdev, is_playback, volume);
1598 dev_err(&agdev->gadget->dev,
1599 "%s:%d control_selector=%d TODO!\n",
1600 __func__, __LINE__, control_selector);
1601 usb_ep_set_halt(ep);
1607 out_rq_cur(struct usb_function *fn, const struct usb_ctrlrequest *cr)
1609 struct usb_request *req = fn->config->cdev->req;
1610 struct g_audio *agdev = func_to_g_audio(fn);
1611 struct f_uac2_opts *opts = g_audio_to_uac2_opts(agdev);
1612 struct f_uac2 *uac2 = func_to_uac2(fn);
1613 u16 w_length = le16_to_cpu(cr->wLength);
1614 u16 w_index = le16_to_cpu(cr->wIndex);
1615 u16 w_value = le16_to_cpu(cr->wValue);
1616 u8 entity_id = (w_index >> 8) & 0xff;
1617 u8 control_selector = w_value >> 8;
1619 if ((entity_id == USB_IN_CLK_ID) || (entity_id == USB_OUT_CLK_ID)) {
1620 if (control_selector == UAC2_CS_CONTROL_SAM_FREQ)
1622 } else if ((FUIN_EN(opts) && (entity_id == USB_IN_FU_ID)) ||
1623 (FUOUT_EN(opts) && (entity_id == USB_OUT_FU_ID))) {
1624 memcpy(&uac2->setup_cr, cr, sizeof(*cr));
1625 req->context = agdev;
1626 req->complete = out_rq_cur_complete;
1630 dev_err(&agdev->gadget->dev,
1631 "%s:%d entity_id=%d control_selector=%d TODO!\n",
1632 __func__, __LINE__, entity_id, control_selector);
1638 setup_rq_inf(struct usb_function *fn, const struct usb_ctrlrequest *cr)
1640 struct f_uac2 *uac2 = func_to_uac2(fn);
1641 struct g_audio *agdev = func_to_g_audio(fn);
1642 u16 w_index = le16_to_cpu(cr->wIndex);
1643 u8 intf = w_index & 0xff;
1645 if (intf != uac2->ac_intf) {
1646 dev_err(&agdev->gadget->dev,
1647 "%s:%d Error!\n", __func__, __LINE__);
1651 if (cr->bRequestType & USB_DIR_IN)
1652 return ac_rq_in(fn, cr);
1653 else if (cr->bRequest == UAC2_CS_CUR)
1654 return out_rq_cur(fn, cr);
1660 afunc_setup(struct usb_function *fn, const struct usb_ctrlrequest *cr)
1662 struct usb_composite_dev *cdev = fn->config->cdev;
1663 struct g_audio *agdev = func_to_g_audio(fn);
1664 struct usb_request *req = cdev->req;
1665 u16 w_length = le16_to_cpu(cr->wLength);
1666 int value = -EOPNOTSUPP;
1668 /* Only Class specific requests are supposed to reach here */
1669 if ((cr->bRequestType & USB_TYPE_MASK) != USB_TYPE_CLASS)
1672 if ((cr->bRequestType & USB_RECIP_MASK) == USB_RECIP_INTERFACE)
1673 value = setup_rq_inf(fn, cr);
1675 dev_err(&agdev->gadget->dev, "%s:%d Error!\n",
1676 __func__, __LINE__);
1679 req->length = value;
1680 req->zero = value < w_length;
1681 value = usb_ep_queue(cdev->gadget->ep0, req, GFP_ATOMIC);
1683 dev_err(&agdev->gadget->dev,
1684 "%s:%d Error!\n", __func__, __LINE__);
1692 static inline struct f_uac2_opts *to_f_uac2_opts(struct config_item *item)
1694 return container_of(to_config_group(item), struct f_uac2_opts,
1698 static void f_uac2_attr_release(struct config_item *item)
1700 struct f_uac2_opts *opts = to_f_uac2_opts(item);
1702 usb_put_function_instance(&opts->func_inst);
1705 static struct configfs_item_operations f_uac2_item_ops = {
1706 .release = f_uac2_attr_release,
1709 #define uac2_kstrtou32 kstrtou32
1710 #define uac2_kstrtos16 kstrtos16
1711 #define uac2_kstrtobool(s, base, res) kstrtobool((s), (res))
1713 static const char *u32_fmt = "%u\n";
1714 static const char *s16_fmt = "%hd\n";
1715 static const char *bool_fmt = "%u\n";
1717 #define UAC2_ATTRIBUTE(type, name) \
1718 static ssize_t f_uac2_opts_##name##_show(struct config_item *item, \
1721 struct f_uac2_opts *opts = to_f_uac2_opts(item); \
1724 mutex_lock(&opts->lock); \
1725 result = sprintf(page, type##_fmt, opts->name); \
1726 mutex_unlock(&opts->lock); \
1731 static ssize_t f_uac2_opts_##name##_store(struct config_item *item, \
1732 const char *page, size_t len) \
1734 struct f_uac2_opts *opts = to_f_uac2_opts(item); \
1738 mutex_lock(&opts->lock); \
1739 if (opts->refcnt) { \
1744 ret = uac2_kstrto##type(page, 0, &num); \
1752 mutex_unlock(&opts->lock); \
1756 CONFIGFS_ATTR(f_uac2_opts_, name)
1758 #define UAC2_ATTRIBUTE_SYNC(name) \
1759 static ssize_t f_uac2_opts_##name##_show(struct config_item *item, \
1762 struct f_uac2_opts *opts = to_f_uac2_opts(item); \
1766 mutex_lock(&opts->lock); \
1767 switch (opts->name) { \
1768 case USB_ENDPOINT_SYNC_ASYNC: \
1771 case USB_ENDPOINT_SYNC_ADAPTIVE: \
1778 result = sprintf(page, "%s\n", str); \
1779 mutex_unlock(&opts->lock); \
1784 static ssize_t f_uac2_opts_##name##_store(struct config_item *item, \
1785 const char *page, size_t len) \
1787 struct f_uac2_opts *opts = to_f_uac2_opts(item); \
1790 mutex_lock(&opts->lock); \
1791 if (opts->refcnt) { \
1796 if (!strncmp(page, "async", 5)) \
1797 opts->name = USB_ENDPOINT_SYNC_ASYNC; \
1798 else if (!strncmp(page, "adaptive", 8)) \
1799 opts->name = USB_ENDPOINT_SYNC_ADAPTIVE; \
1808 mutex_unlock(&opts->lock); \
1812 CONFIGFS_ATTR(f_uac2_opts_, name)
1814 UAC2_ATTRIBUTE(u32, p_chmask);
1815 UAC2_ATTRIBUTE(u32, p_srate);
1816 UAC2_ATTRIBUTE(u32, p_ssize);
1817 UAC2_ATTRIBUTE(u32, c_chmask);
1818 UAC2_ATTRIBUTE(u32, c_srate);
1819 UAC2_ATTRIBUTE_SYNC(c_sync);
1820 UAC2_ATTRIBUTE(u32, c_ssize);
1821 UAC2_ATTRIBUTE(u32, req_number);
1823 UAC2_ATTRIBUTE(bool, p_mute_present);
1824 UAC2_ATTRIBUTE(bool, p_volume_present);
1825 UAC2_ATTRIBUTE(s16, p_volume_min);
1826 UAC2_ATTRIBUTE(s16, p_volume_max);
1827 UAC2_ATTRIBUTE(s16, p_volume_res);
1829 UAC2_ATTRIBUTE(bool, c_mute_present);
1830 UAC2_ATTRIBUTE(bool, c_volume_present);
1831 UAC2_ATTRIBUTE(s16, c_volume_min);
1832 UAC2_ATTRIBUTE(s16, c_volume_max);
1833 UAC2_ATTRIBUTE(s16, c_volume_res);
1834 UAC2_ATTRIBUTE(u32, fb_max);
1836 static struct configfs_attribute *f_uac2_attrs[] = {
1837 &f_uac2_opts_attr_p_chmask,
1838 &f_uac2_opts_attr_p_srate,
1839 &f_uac2_opts_attr_p_ssize,
1840 &f_uac2_opts_attr_c_chmask,
1841 &f_uac2_opts_attr_c_srate,
1842 &f_uac2_opts_attr_c_ssize,
1843 &f_uac2_opts_attr_c_sync,
1844 &f_uac2_opts_attr_req_number,
1845 &f_uac2_opts_attr_fb_max,
1847 &f_uac2_opts_attr_p_mute_present,
1848 &f_uac2_opts_attr_p_volume_present,
1849 &f_uac2_opts_attr_p_volume_min,
1850 &f_uac2_opts_attr_p_volume_max,
1851 &f_uac2_opts_attr_p_volume_res,
1853 &f_uac2_opts_attr_c_mute_present,
1854 &f_uac2_opts_attr_c_volume_present,
1855 &f_uac2_opts_attr_c_volume_min,
1856 &f_uac2_opts_attr_c_volume_max,
1857 &f_uac2_opts_attr_c_volume_res,
1862 static const struct config_item_type f_uac2_func_type = {
1863 .ct_item_ops = &f_uac2_item_ops,
1864 .ct_attrs = f_uac2_attrs,
1865 .ct_owner = THIS_MODULE,
1868 static void afunc_free_inst(struct usb_function_instance *f)
1870 struct f_uac2_opts *opts;
1872 opts = container_of(f, struct f_uac2_opts, func_inst);
1876 static struct usb_function_instance *afunc_alloc_inst(void)
1878 struct f_uac2_opts *opts;
1880 opts = kzalloc(sizeof(*opts), GFP_KERNEL);
1882 return ERR_PTR(-ENOMEM);
1884 mutex_init(&opts->lock);
1885 opts->func_inst.free_func_inst = afunc_free_inst;
1887 config_group_init_type_name(&opts->func_inst.group, "",
1890 opts->p_chmask = UAC2_DEF_PCHMASK;
1891 opts->p_srate = UAC2_DEF_PSRATE;
1892 opts->p_ssize = UAC2_DEF_PSSIZE;
1893 opts->c_chmask = UAC2_DEF_CCHMASK;
1894 opts->c_srate = UAC2_DEF_CSRATE;
1895 opts->c_ssize = UAC2_DEF_CSSIZE;
1896 opts->c_sync = UAC2_DEF_CSYNC;
1898 opts->p_mute_present = UAC2_DEF_MUTE_PRESENT;
1899 opts->p_volume_present = UAC2_DEF_VOLUME_PRESENT;
1900 opts->p_volume_min = UAC2_DEF_MIN_DB;
1901 opts->p_volume_max = UAC2_DEF_MAX_DB;
1902 opts->p_volume_res = UAC2_DEF_RES_DB;
1904 opts->c_mute_present = UAC2_DEF_MUTE_PRESENT;
1905 opts->c_volume_present = UAC2_DEF_VOLUME_PRESENT;
1906 opts->c_volume_min = UAC2_DEF_MIN_DB;
1907 opts->c_volume_max = UAC2_DEF_MAX_DB;
1908 opts->c_volume_res = UAC2_DEF_RES_DB;
1910 opts->req_number = UAC2_DEF_REQ_NUM;
1911 opts->fb_max = UAC2_DEF_FB_MAX;
1912 return &opts->func_inst;
1915 static void afunc_free(struct usb_function *f)
1917 struct g_audio *agdev;
1918 struct f_uac2_opts *opts;
1920 agdev = func_to_g_audio(f);
1921 opts = container_of(f->fi, struct f_uac2_opts, func_inst);
1923 mutex_lock(&opts->lock);
1925 mutex_unlock(&opts->lock);
1928 static void afunc_unbind(struct usb_configuration *c, struct usb_function *f)
1930 struct g_audio *agdev = func_to_g_audio(f);
1932 g_audio_cleanup(agdev);
1933 usb_free_all_descriptors(f);
1935 agdev->gadget = NULL;
1937 kfree(out_feature_unit_desc);
1938 out_feature_unit_desc = NULL;
1939 kfree(in_feature_unit_desc);
1940 in_feature_unit_desc = NULL;
1943 static struct usb_function *afunc_alloc(struct usb_function_instance *fi)
1945 struct f_uac2 *uac2;
1946 struct f_uac2_opts *opts;
1948 uac2 = kzalloc(sizeof(*uac2), GFP_KERNEL);
1950 return ERR_PTR(-ENOMEM);
1952 opts = container_of(fi, struct f_uac2_opts, func_inst);
1953 mutex_lock(&opts->lock);
1955 mutex_unlock(&opts->lock);
1957 uac2->g_audio.func.name = "uac2_func";
1958 uac2->g_audio.func.bind = afunc_bind;
1959 uac2->g_audio.func.unbind = afunc_unbind;
1960 uac2->g_audio.func.set_alt = afunc_set_alt;
1961 uac2->g_audio.func.get_alt = afunc_get_alt;
1962 uac2->g_audio.func.disable = afunc_disable;
1963 uac2->g_audio.func.setup = afunc_setup;
1964 uac2->g_audio.func.free_func = afunc_free;
1966 return &uac2->g_audio.func;
1969 DECLARE_USB_FUNCTION_INIT(uac2, afunc_alloc_inst, afunc_alloc);
1970 MODULE_LICENSE("GPL");
1971 MODULE_AUTHOR("Yadwinder Singh");
1972 MODULE_AUTHOR("Jaswinder Singh");
1973 MODULE_AUTHOR("Ruslan Bilovol");