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 (struct f_audio_buf
*)-ENOMEM
;
257 copy_buf
->buf
= kzalloc(buf_size
, GFP_ATOMIC
);
258 if (!copy_buf
->buf
) {
260 return (struct f_audio_buf
*)-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
);
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
);
449 f_audio_setup(struct usb_function
*f
, const struct usb_ctrlrequest
*ctrl
)
451 struct usb_composite_dev
*cdev
= f
->config
->cdev
;
452 struct usb_request
*req
= cdev
->req
;
453 int value
= -EOPNOTSUPP
;
454 u16 w_index
= le16_to_cpu(ctrl
->wIndex
);
455 u16 w_value
= le16_to_cpu(ctrl
->wValue
);
456 u16 w_length
= le16_to_cpu(ctrl
->wLength
);
458 /* composite driver infrastructure handles everything except
459 * Audio class messages; interface activation uses set_alt().
461 switch (ctrl
->bRequestType
) {
462 case USB_DIR_OUT
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
:
463 value
= audio_set_intf_req(f
, ctrl
);
466 case USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
:
467 value
= audio_get_intf_req(f
, ctrl
);
471 ERROR(cdev
, "invalid control req%02x.%02x v%04x i%04x l%d\n",
472 ctrl
->bRequestType
, ctrl
->bRequest
,
473 w_value
, w_index
, w_length
);
476 /* respond with data transfer or status phase? */
478 DBG(cdev
, "audio req%02x.%02x v%04x i%04x l%d\n",
479 ctrl
->bRequestType
, ctrl
->bRequest
,
480 w_value
, w_index
, w_length
);
483 value
= usb_ep_queue(cdev
->gadget
->ep0
, req
, GFP_ATOMIC
);
485 ERROR(cdev
, "audio response on err %d\n", value
);
488 /* device either stalls (value < 0) or reports success */
492 static int f_audio_set_alt(struct usb_function
*f
, unsigned intf
, unsigned alt
)
494 struct f_audio
*audio
= func_to_audio(f
);
495 struct usb_composite_dev
*cdev
= f
->config
->cdev
;
496 struct usb_ep
*out_ep
= audio
->out_ep
;
497 struct usb_request
*req
;
500 DBG(cdev
, "intf %d, alt %d\n", intf
, alt
);
504 usb_ep_enable(out_ep
, audio
->out_desc
);
505 out_ep
->driver_data
= audio
;
506 audio
->copy_buf
= f_audio_buffer_alloc(audio_buf_size
);
509 * allocate a bunch of read buffers
510 * and queue them all at once.
512 for (i
= 0; i
< req_count
&& err
== 0; i
++) {
513 req
= usb_ep_alloc_request(out_ep
, GFP_ATOMIC
);
515 req
->buf
= kzalloc(req_buf_size
,
518 req
->length
= req_buf_size
;
519 req
->context
= audio
;
522 err
= usb_ep_queue(out_ep
,
526 "%s queue req: %d\n",
535 struct f_audio_buf
*copy_buf
= audio
->copy_buf
;
537 list_add_tail(©_buf
->list
,
539 schedule_work(&audio
->playback_work
);
547 static void f_audio_disable(struct usb_function
*f
)
552 /*-------------------------------------------------------------------------*/
554 static void f_audio_build_desc(struct f_audio
*audio
)
556 struct gaudio
*card
= &audio
->card
;
560 /* Set channel numbers */
561 input_terminal_desc
.bNrChannels
= u_audio_get_playback_channels(card
);
562 as_type_i_desc
.bNrChannels
= u_audio_get_playback_channels(card
);
564 /* Set sample rates */
565 rate
= u_audio_get_playback_rate(card
);
566 sam_freq
= as_type_i_desc
.tSamFreq
[0];
567 memcpy(sam_freq
, &rate
, 3);
569 /* Todo: Set Sample bits and other parameters */
574 /* audio function driver setup/binding */
576 f_audio_bind(struct usb_configuration
*c
, struct usb_function
*f
)
578 struct usb_composite_dev
*cdev
= c
->cdev
;
579 struct f_audio
*audio
= func_to_audio(f
);
583 f_audio_build_desc(audio
);
585 /* allocate instance-specific interface IDs, and patch descriptors */
586 status
= usb_interface_id(c
, f
);
589 ac_interface_desc
.bInterfaceNumber
= status
;
591 status
= usb_interface_id(c
, f
);
594 as_interface_alt_0_desc
.bInterfaceNumber
= status
;
595 as_interface_alt_1_desc
.bInterfaceNumber
= status
;
599 /* allocate instance-specific endpoints */
600 ep
= usb_ep_autoconfig(cdev
->gadget
, &as_out_ep_desc
);
604 ep
->driver_data
= cdev
; /* claim */
608 /* supcard all relevant hardware speeds... we expect that when
609 * hardware is dual speed, all bulk-capable endpoints work at
613 /* copy descriptors, and track endpoint copies */
614 if (gadget_is_dualspeed(c
->cdev
->gadget
)) {
616 f
->hs_descriptors
= usb_copy_descriptors(f_audio_desc
);
618 f
->descriptors
= usb_copy_descriptors(f_audio_desc
);
628 f_audio_unbind(struct usb_configuration
*c
, struct usb_function
*f
)
630 struct f_audio
*audio
= func_to_audio(f
);
632 usb_free_descriptors(f
->descriptors
);
636 /*-------------------------------------------------------------------------*/
638 static int generic_set_cmd(struct usb_audio_control
*con
, u8 cmd
, int value
)
640 con
->data
[cmd
] = value
;
645 static int generic_get_cmd(struct usb_audio_control
*con
, u8 cmd
)
647 return con
->data
[cmd
];
650 /* Todo: add more control selecotor dynamically */
651 int __init
control_selector_init(struct f_audio
*audio
)
653 INIT_LIST_HEAD(&audio
->cs
);
654 list_add(&feature_unit
.list
, &audio
->cs
);
656 INIT_LIST_HEAD(&feature_unit
.control
);
657 list_add(&mute_control
.list
, &feature_unit
.control
);
658 list_add(&volume_control
.list
, &feature_unit
.control
);
660 volume_control
.data
[UAC__CUR
] = 0xffc0;
661 volume_control
.data
[UAC__MIN
] = 0xe3a0;
662 volume_control
.data
[UAC__MAX
] = 0xfff0;
663 volume_control
.data
[UAC__RES
] = 0x0030;
669 * audio_bind_config - add USB audio fucntion to a configuration
670 * @c: the configuration to supcard the USB audio function
671 * Context: single threaded during gadget setup
673 * Returns zero on success, else negative errno.
675 int __init
audio_bind_config(struct usb_configuration
*c
)
677 struct f_audio
*audio
;
680 /* allocate and initialize one new instance */
681 audio
= kzalloc(sizeof *audio
, GFP_KERNEL
);
685 audio
->card
.func
.name
= "g_audio";
686 audio
->card
.gadget
= c
->cdev
->gadget
;
688 INIT_LIST_HEAD(&audio
->play_queue
);
689 spin_lock_init(&audio
->lock
);
691 /* set up ASLA audio devices */
692 status
= gaudio_setup(&audio
->card
);
696 audio
->card
.func
.strings
= audio_strings
;
697 audio
->card
.func
.bind
= f_audio_bind
;
698 audio
->card
.func
.unbind
= f_audio_unbind
;
699 audio
->card
.func
.set_alt
= f_audio_set_alt
;
700 audio
->card
.func
.setup
= f_audio_setup
;
701 audio
->card
.func
.disable
= f_audio_disable
;
702 audio
->out_desc
= &as_out_ep_desc
;
704 control_selector_init(audio
);
706 INIT_WORK(&audio
->playback_work
, f_audio_playback_work
);
708 status
= usb_add_function(c
, &audio
->card
.func
);
712 INFO(c
->cdev
, "audio_buf_size %d, req_buf_size %d, req_count %d\n",
713 audio_buf_size
, req_buf_size
, req_count
);
718 gaudio_cleanup(&audio
->card
);