2 * f_audio.c -- USB Audio class function driver
4 * Copyright (C) 2008 Bryan Wu <cooloney@kernel.org>
5 * Copyright (C) 2008 Analog Devices, Inc
7 * Enter bugs at http://blackfin.uclinux.org/
9 * Licensed under the GPL-2 or later.
12 #include <linux/kernel.h>
13 #include <linux/device.h>
14 #include <asm/atomic.h>
18 #define OUT_EP_MAX_PACKET_SIZE 200
19 static int req_buf_size = OUT_EP_MAX_PACKET_SIZE;
20 module_param(req_buf_size, int, S_IRUGO);
21 MODULE_PARM_DESC(req_buf_size, "ISO OUT endpoint request buffer size");
23 static int req_count = 256;
24 module_param(req_count, int, S_IRUGO);
25 MODULE_PARM_DESC(req_count, "ISO OUT endpoint request count");
27 static int audio_buf_size = 48000;
28 module_param(audio_buf_size, int, S_IRUGO);
29 MODULE_PARM_DESC(audio_buf_size, "Audio buffer size");
31 static int generic_set_cmd(struct usb_audio_control *con, u8 cmd, int value);
32 static int generic_get_cmd(struct usb_audio_control *con, u8 cmd);
35 * DESCRIPTORS ... most are static, but strings and full
36 * configuration descriptors are built on demand.
40 * We have two interfaces- AudioControl and AudioStreaming
41 * TODO: only supcard playback currently
43 #define F_AUDIO_AC_INTERFACE 0
44 #define F_AUDIO_AS_INTERFACE 1
45 #define F_AUDIO_NUM_INTERFACES 2
47 /* B.3.1 Standard AC Interface Descriptor */
48 static struct usb_interface_descriptor ac_interface_desc __initdata = {
49 .bLength = USB_DT_INTERFACE_SIZE,
50 .bDescriptorType = USB_DT_INTERFACE,
52 .bInterfaceClass = USB_CLASS_AUDIO,
53 .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL,
56 DECLARE_UAC_AC_HEADER_DESCRIPTOR(2);
58 #define UAC_DT_AC_HEADER_LENGTH UAC_DT_AC_HEADER_SIZE(F_AUDIO_NUM_INTERFACES)
59 /* B.3.2 Class-Specific AC Interface Descriptor */
60 static struct uac_ac_header_descriptor_2 ac_header_desc = {
61 .bLength = UAC_DT_AC_HEADER_LENGTH,
62 .bDescriptorType = USB_DT_CS_INTERFACE,
63 .bDescriptorSubtype = UAC_HEADER,
64 .bcdADC = __constant_cpu_to_le16(0x0100),
65 .wTotalLength = __constant_cpu_to_le16(UAC_DT_AC_HEADER_LENGTH),
66 .bInCollection = F_AUDIO_NUM_INTERFACES,
68 [0] = F_AUDIO_AC_INTERFACE,
69 [1] = F_AUDIO_AS_INTERFACE,
73 #define INPUT_TERMINAL_ID 1
74 static struct uac_input_terminal_descriptor input_terminal_desc = {
75 .bLength = UAC_DT_INPUT_TERMINAL_SIZE,
76 .bDescriptorType = USB_DT_CS_INTERFACE,
77 .bDescriptorSubtype = UAC_INPUT_TERMINAL,
78 .bTerminalID = INPUT_TERMINAL_ID,
79 .wTerminalType = UAC_TERMINAL_STREAMING,
81 .wChannelConfig = 0x3,
84 DECLARE_UAC_FEATURE_UNIT_DESCRIPTOR(0);
86 #define FEATURE_UNIT_ID 2
87 static struct uac_feature_unit_descriptor_0 feature_unit_desc = {
88 .bLength = UAC_DT_FEATURE_UNIT_SIZE(0),
89 .bDescriptorType = USB_DT_CS_INTERFACE,
90 .bDescriptorSubtype = UAC_FEATURE_UNIT,
91 .bUnitID = FEATURE_UNIT_ID,
92 .bSourceID = INPUT_TERMINAL_ID,
94 .bmaControls[0] = (UAC_FU_MUTE | UAC_FU_VOLUME),
97 static struct usb_audio_control mute_control = {
98 .list = LIST_HEAD_INIT(mute_control.list),
99 .name = "Mute Control",
100 .type = UAC_MUTE_CONTROL,
101 /* Todo: add real Mute control code */
102 .set = generic_set_cmd,
103 .get = generic_get_cmd,
106 static struct usb_audio_control volume_control = {
107 .list = LIST_HEAD_INIT(volume_control.list),
108 .name = "Volume Control",
109 .type = UAC_VOLUME_CONTROL,
110 /* Todo: add real Volume control code */
111 .set = generic_set_cmd,
112 .get = generic_get_cmd,
115 static struct usb_audio_control_selector feature_unit = {
116 .list = LIST_HEAD_INIT(feature_unit.list),
117 .id = FEATURE_UNIT_ID,
118 .name = "Mute & Volume Control",
119 .type = UAC_FEATURE_UNIT,
120 .desc = (struct usb_descriptor_header *)&feature_unit_desc,
123 #define OUTPUT_TERMINAL_ID 3
124 static struct uac_output_terminal_descriptor output_terminal_desc = {
125 .bLength = UAC_DT_OUTPUT_TERMINAL_SIZE,
126 .bDescriptorType = USB_DT_CS_INTERFACE,
127 .bDescriptorSubtype = UAC_OUTPUT_TERMINAL,
128 .bTerminalID = OUTPUT_TERMINAL_ID,
129 .wTerminalType = UAC_OUTPUT_TERMINAL_SPEAKER,
130 .bAssocTerminal = FEATURE_UNIT_ID,
131 .bSourceID = FEATURE_UNIT_ID,
134 /* B.4.1 Standard AS Interface Descriptor */
135 static struct usb_interface_descriptor as_interface_alt_0_desc = {
136 .bLength = USB_DT_INTERFACE_SIZE,
137 .bDescriptorType = USB_DT_INTERFACE,
138 .bAlternateSetting = 0,
140 .bInterfaceClass = USB_CLASS_AUDIO,
141 .bInterfaceSubClass = USB_SUBCLASS_AUDIOSTREAMING,
144 static struct usb_interface_descriptor as_interface_alt_1_desc = {
145 .bLength = USB_DT_INTERFACE_SIZE,
146 .bDescriptorType = USB_DT_INTERFACE,
147 .bAlternateSetting = 1,
149 .bInterfaceClass = USB_CLASS_AUDIO,
150 .bInterfaceSubClass = USB_SUBCLASS_AUDIOSTREAMING,
153 /* B.4.2 Class-Specific AS Interface Descriptor */
154 static struct uac_as_header_descriptor as_header_desc = {
155 .bLength = UAC_DT_AS_HEADER_SIZE,
156 .bDescriptorType = USB_DT_CS_INTERFACE,
157 .bDescriptorSubtype = UAC_AS_GENERAL,
158 .bTerminalLink = INPUT_TERMINAL_ID,
160 .wFormatTag = UAC_FORMAT_TYPE_I_PCM,
163 DECLARE_UAC_FORMAT_TYPE_I_DISCRETE_DESC(1);
165 static struct uac_format_type_i_discrete_descriptor_1 as_type_i_desc = {
166 .bLength = UAC_FORMAT_TYPE_I_DISCRETE_DESC_SIZE(1),
167 .bDescriptorType = USB_DT_CS_INTERFACE,
168 .bDescriptorSubtype = UAC_FORMAT_TYPE,
169 .bFormatType = UAC_FORMAT_TYPE_I,
171 .bBitResolution = 16,
175 /* Standard ISO OUT Endpoint Descriptor */
176 static struct usb_endpoint_descriptor as_out_ep_desc __initdata = {
177 .bLength = USB_DT_ENDPOINT_AUDIO_SIZE,
178 .bDescriptorType = USB_DT_ENDPOINT,
179 .bEndpointAddress = USB_DIR_OUT,
180 .bmAttributes = USB_ENDPOINT_SYNC_ADAPTIVE
181 | USB_ENDPOINT_XFER_ISOC,
182 .wMaxPacketSize = __constant_cpu_to_le16(OUT_EP_MAX_PACKET_SIZE),
186 /* Class-specific AS ISO OUT Endpoint Descriptor */
187 static struct uac_iso_endpoint_descriptor as_iso_out_desc __initdata = {
188 .bLength = UAC_ISO_ENDPOINT_DESC_SIZE,
189 .bDescriptorType = USB_DT_CS_ENDPOINT,
190 .bDescriptorSubtype = UAC_EP_GENERAL,
192 .bLockDelayUnits = 1,
193 .wLockDelay = __constant_cpu_to_le16(1),
196 static struct usb_descriptor_header *f_audio_desc[] __initdata = {
197 (struct usb_descriptor_header *)&ac_interface_desc,
198 (struct usb_descriptor_header *)&ac_header_desc,
200 (struct usb_descriptor_header *)&input_terminal_desc,
201 (struct usb_descriptor_header *)&output_terminal_desc,
202 (struct usb_descriptor_header *)&feature_unit_desc,
204 (struct usb_descriptor_header *)&as_interface_alt_0_desc,
205 (struct usb_descriptor_header *)&as_interface_alt_1_desc,
206 (struct usb_descriptor_header *)&as_header_desc,
208 (struct usb_descriptor_header *)&as_type_i_desc,
210 (struct usb_descriptor_header *)&as_out_ep_desc,
211 (struct usb_descriptor_header *)&as_iso_out_desc,
215 /* string IDs are assigned dynamically */
217 #define STRING_MANUFACTURER_IDX 0
218 #define STRING_PRODUCT_IDX 1
220 static char manufacturer[50];
222 static struct usb_string strings_dev[] = {
223 [STRING_MANUFACTURER_IDX].s = manufacturer,
224 [STRING_PRODUCT_IDX].s = DRIVER_DESC,
225 { } /* end of list */
228 static struct usb_gadget_strings stringtab_dev = {
229 .language = 0x0409, /* en-us */
230 .strings = strings_dev,
233 static struct usb_gadget_strings *audio_strings[] = {
239 * This function is an ALSA sound card following USB Audio Class Spec 1.0.
242 /*-------------------------------------------------------------------------*/
246 struct list_head list;
249 static struct f_audio_buf *f_audio_buffer_alloc(int buf_size)
251 struct f_audio_buf *copy_buf;
253 copy_buf = kzalloc(sizeof *copy_buf, GFP_ATOMIC);
255 return ERR_PTR(-ENOMEM);
257 copy_buf->buf = kzalloc(buf_size, GFP_ATOMIC);
258 if (!copy_buf->buf) {
260 return ERR_PTR(-ENOMEM);
266 static void f_audio_buffer_free(struct f_audio_buf *audio_buf)
268 kfree(audio_buf->buf);
271 /*-------------------------------------------------------------------------*/
276 /* endpoints handle full and/or high speeds */
277 struct usb_ep *out_ep;
278 struct usb_endpoint_descriptor *out_desc;
281 struct f_audio_buf *copy_buf;
282 struct work_struct playback_work;
283 struct list_head play_queue;
285 /* Control Set command */
288 struct usb_audio_control *set_con;
291 static inline struct f_audio *func_to_audio(struct usb_function *f)
293 return container_of(f, struct f_audio, card.func);
296 /*-------------------------------------------------------------------------*/
298 static void f_audio_playback_work(struct work_struct *data)
300 struct f_audio *audio = container_of(data, struct f_audio,
302 struct f_audio_buf *play_buf;
304 spin_lock_irq(&audio->lock);
305 if (list_empty(&audio->play_queue)) {
306 spin_unlock_irq(&audio->lock);
309 play_buf = list_first_entry(&audio->play_queue,
310 struct f_audio_buf, list);
311 list_del(&play_buf->list);
312 spin_unlock_irq(&audio->lock);
314 u_audio_playback(&audio->card, play_buf->buf, play_buf->actual);
315 f_audio_buffer_free(play_buf);
320 static int f_audio_out_ep_complete(struct usb_ep *ep, struct usb_request *req)
322 struct f_audio *audio = req->context;
323 struct usb_composite_dev *cdev = audio->card.func.config->cdev;
324 struct f_audio_buf *copy_buf = audio->copy_buf;
330 /* Copy buffer is full, add it to the play_queue */
331 if (audio_buf_size - copy_buf->actual < req->actual) {
332 list_add_tail(©_buf->list, &audio->play_queue);
333 schedule_work(&audio->playback_work);
334 copy_buf = f_audio_buffer_alloc(audio_buf_size);
335 if (IS_ERR(copy_buf))
339 memcpy(copy_buf->buf + copy_buf->actual, req->buf, req->actual);
340 copy_buf->actual += req->actual;
341 audio->copy_buf = copy_buf;
343 err = usb_ep_queue(ep, req, GFP_ATOMIC);
345 ERROR(cdev, "%s queue req: %d\n", ep->name, err);
351 static void f_audio_complete(struct usb_ep *ep, struct usb_request *req)
353 struct f_audio *audio = req->context;
354 int status = req->status;
356 struct usb_ep *out_ep = audio->out_ep;
360 case 0: /* normal completion? */
362 f_audio_out_ep_complete(ep, req);
363 else if (audio->set_con) {
364 memcpy(&data, req->buf, req->length);
365 audio->set_con->set(audio->set_con, audio->set_cmd,
367 audio->set_con = NULL;
375 static int audio_set_intf_req(struct usb_function *f,
376 const struct usb_ctrlrequest *ctrl)
378 struct f_audio *audio = func_to_audio(f);
379 struct usb_composite_dev *cdev = f->config->cdev;
380 struct usb_request *req = cdev->req;
381 u8 id = ((le16_to_cpu(ctrl->wIndex) >> 8) & 0xFF);
382 u16 len = le16_to_cpu(ctrl->wLength);
383 u16 w_value = le16_to_cpu(ctrl->wValue);
384 u8 con_sel = (w_value >> 8) & 0xFF;
385 u8 cmd = (ctrl->bRequest & 0x0F);
386 struct usb_audio_control_selector *cs;
387 struct usb_audio_control *con;
389 DBG(cdev, "bRequest 0x%x, w_value 0x%04x, len %d, entity %d\n",
390 ctrl->bRequest, w_value, len, id);
392 list_for_each_entry(cs, &audio->cs, list) {
394 list_for_each_entry(con, &cs->control, list) {
395 if (con->type == con_sel) {
396 audio->set_con = con;
404 audio->set_cmd = cmd;
405 req->context = audio;
406 req->complete = f_audio_complete;
411 static int audio_get_intf_req(struct usb_function *f,
412 const struct usb_ctrlrequest *ctrl)
414 struct f_audio *audio = func_to_audio(f);
415 struct usb_composite_dev *cdev = f->config->cdev;
416 struct usb_request *req = cdev->req;
417 int value = -EOPNOTSUPP;
418 u8 id = ((le16_to_cpu(ctrl->wIndex) >> 8) & 0xFF);
419 u16 len = le16_to_cpu(ctrl->wLength);
420 u16 w_value = le16_to_cpu(ctrl->wValue);
421 u8 con_sel = (w_value >> 8) & 0xFF;
422 u8 cmd = (ctrl->bRequest & 0x0F);
423 struct usb_audio_control_selector *cs;
424 struct usb_audio_control *con;
426 DBG(cdev, "bRequest 0x%x, w_value 0x%04x, len %d, entity %d\n",
427 ctrl->bRequest, w_value, len, id);
429 list_for_each_entry(cs, &audio->cs, list) {
431 list_for_each_entry(con, &cs->control, list) {
432 if (con->type == con_sel && con->get) {
433 value = con->get(con, cmd);
441 req->context = audio;
442 req->complete = f_audio_complete;
443 memcpy(req->buf, &value, len);
448 static int audio_set_endpoint_req(struct usb_function *f,
449 const struct usb_ctrlrequest *ctrl)
451 struct usb_composite_dev *cdev = f->config->cdev;
452 int value = -EOPNOTSUPP;
453 u16 ep = le16_to_cpu(ctrl->wIndex);
454 u16 len = le16_to_cpu(ctrl->wLength);
455 u16 w_value = le16_to_cpu(ctrl->wValue);
457 DBG(cdev, "bRequest 0x%x, w_value 0x%04x, len %d, endpoint %d\n",
458 ctrl->bRequest, w_value, len, ep);
460 switch (ctrl->bRequest) {
484 static int audio_get_endpoint_req(struct usb_function *f,
485 const struct usb_ctrlrequest *ctrl)
487 struct usb_composite_dev *cdev = f->config->cdev;
488 int value = -EOPNOTSUPP;
489 u8 ep = ((le16_to_cpu(ctrl->wIndex) >> 8) & 0xFF);
490 u16 len = le16_to_cpu(ctrl->wLength);
491 u16 w_value = le16_to_cpu(ctrl->wValue);
493 DBG(cdev, "bRequest 0x%x, w_value 0x%04x, len %d, endpoint %d\n",
494 ctrl->bRequest, w_value, len, ep);
496 switch (ctrl->bRequest) {
513 f_audio_setup(struct usb_function *f, const struct usb_ctrlrequest *ctrl)
515 struct usb_composite_dev *cdev = f->config->cdev;
516 struct usb_request *req = cdev->req;
517 int value = -EOPNOTSUPP;
518 u16 w_index = le16_to_cpu(ctrl->wIndex);
519 u16 w_value = le16_to_cpu(ctrl->wValue);
520 u16 w_length = le16_to_cpu(ctrl->wLength);
522 /* composite driver infrastructure handles everything; interface
523 * activation uses set_alt().
525 switch (ctrl->bRequestType) {
526 case USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE:
527 value = audio_set_intf_req(f, ctrl);
530 case USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE:
531 value = audio_get_intf_req(f, ctrl);
534 case USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_ENDPOINT:
535 value = audio_set_endpoint_req(f, ctrl);
538 case USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_ENDPOINT:
539 value = audio_get_endpoint_req(f, ctrl);
543 ERROR(cdev, "invalid control req%02x.%02x v%04x i%04x l%d\n",
544 ctrl->bRequestType, ctrl->bRequest,
545 w_value, w_index, w_length);
548 /* respond with data transfer or status phase? */
550 DBG(cdev, "audio req%02x.%02x v%04x i%04x l%d\n",
551 ctrl->bRequestType, ctrl->bRequest,
552 w_value, w_index, w_length);
555 value = usb_ep_queue(cdev->gadget->ep0, req, GFP_ATOMIC);
557 ERROR(cdev, "audio response on err %d\n", value);
560 /* device either stalls (value < 0) or reports success */
564 static int f_audio_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
566 struct f_audio *audio = func_to_audio(f);
567 struct usb_composite_dev *cdev = f->config->cdev;
568 struct usb_ep *out_ep = audio->out_ep;
569 struct usb_request *req;
572 DBG(cdev, "intf %d, alt %d\n", intf, alt);
576 usb_ep_enable(out_ep, audio->out_desc);
577 out_ep->driver_data = audio;
578 audio->copy_buf = f_audio_buffer_alloc(audio_buf_size);
579 if (IS_ERR(audio->copy_buf))
583 * allocate a bunch of read buffers
584 * and queue them all at once.
586 for (i = 0; i < req_count && err == 0; i++) {
587 req = usb_ep_alloc_request(out_ep, GFP_ATOMIC);
589 req->buf = kzalloc(req_buf_size,
592 req->length = req_buf_size;
593 req->context = audio;
596 err = usb_ep_queue(out_ep,
600 "%s queue req: %d\n",
609 struct f_audio_buf *copy_buf = audio->copy_buf;
611 list_add_tail(©_buf->list,
613 schedule_work(&audio->playback_work);
621 static void f_audio_disable(struct usb_function *f)
626 /*-------------------------------------------------------------------------*/
628 static void f_audio_build_desc(struct f_audio *audio)
630 struct gaudio *card = &audio->card;
634 /* Set channel numbers */
635 input_terminal_desc.bNrChannels = u_audio_get_playback_channels(card);
636 as_type_i_desc.bNrChannels = u_audio_get_playback_channels(card);
638 /* Set sample rates */
639 rate = u_audio_get_playback_rate(card);
640 sam_freq = as_type_i_desc.tSamFreq[0];
641 memcpy(sam_freq, &rate, 3);
643 /* Todo: Set Sample bits and other parameters */
648 /* audio function driver setup/binding */
650 f_audio_bind(struct usb_configuration *c, struct usb_function *f)
652 struct usb_composite_dev *cdev = c->cdev;
653 struct f_audio *audio = func_to_audio(f);
657 f_audio_build_desc(audio);
659 /* allocate instance-specific interface IDs, and patch descriptors */
660 status = usb_interface_id(c, f);
663 ac_interface_desc.bInterfaceNumber = status;
665 status = usb_interface_id(c, f);
668 as_interface_alt_0_desc.bInterfaceNumber = status;
669 as_interface_alt_1_desc.bInterfaceNumber = status;
673 /* allocate instance-specific endpoints */
674 ep = usb_ep_autoconfig(cdev->gadget, &as_out_ep_desc);
678 ep->driver_data = cdev; /* claim */
682 /* supcard all relevant hardware speeds... we expect that when
683 * hardware is dual speed, all bulk-capable endpoints work at
687 /* copy descriptors, and track endpoint copies */
688 if (gadget_is_dualspeed(c->cdev->gadget)) {
690 f->hs_descriptors = usb_copy_descriptors(f_audio_desc);
692 f->descriptors = usb_copy_descriptors(f_audio_desc);
702 f_audio_unbind(struct usb_configuration *c, struct usb_function *f)
704 struct f_audio *audio = func_to_audio(f);
706 usb_free_descriptors(f->descriptors);
710 /*-------------------------------------------------------------------------*/
712 static int generic_set_cmd(struct usb_audio_control *con, u8 cmd, int value)
714 con->data[cmd] = value;
719 static int generic_get_cmd(struct usb_audio_control *con, u8 cmd)
721 return con->data[cmd];
724 /* Todo: add more control selecotor dynamically */
725 int __init control_selector_init(struct f_audio *audio)
727 INIT_LIST_HEAD(&audio->cs);
728 list_add(&feature_unit.list, &audio->cs);
730 INIT_LIST_HEAD(&feature_unit.control);
731 list_add(&mute_control.list, &feature_unit.control);
732 list_add(&volume_control.list, &feature_unit.control);
734 volume_control.data[UAC__CUR] = 0xffc0;
735 volume_control.data[UAC__MIN] = 0xe3a0;
736 volume_control.data[UAC__MAX] = 0xfff0;
737 volume_control.data[UAC__RES] = 0x0030;
743 * audio_bind_config - add USB audio fucntion to a configuration
744 * @c: the configuration to supcard the USB audio function
745 * Context: single threaded during gadget setup
747 * Returns zero on success, else negative errno.
749 int __init audio_bind_config(struct usb_configuration *c)
751 struct f_audio *audio;
754 /* allocate and initialize one new instance */
755 audio = kzalloc(sizeof *audio, GFP_KERNEL);
759 audio->card.func.name = "g_audio";
760 audio->card.gadget = c->cdev->gadget;
762 INIT_LIST_HEAD(&audio->play_queue);
763 spin_lock_init(&audio->lock);
765 /* set up ASLA audio devices */
766 status = gaudio_setup(&audio->card);
770 audio->card.func.strings = audio_strings;
771 audio->card.func.bind = f_audio_bind;
772 audio->card.func.unbind = f_audio_unbind;
773 audio->card.func.set_alt = f_audio_set_alt;
774 audio->card.func.setup = f_audio_setup;
775 audio->card.func.disable = f_audio_disable;
776 audio->out_desc = &as_out_ep_desc;
778 control_selector_init(audio);
780 INIT_WORK(&audio->playback_work, f_audio_playback_work);
782 status = usb_add_function(c, &audio->card.func);
786 INFO(c->cdev, "audio_buf_size %d, req_buf_size %d, req_count %d\n",
787 audio_buf_size, req_buf_size, req_count);
792 gaudio_cleanup(&audio->card);