2 * Copyright (C) 2007, 2008 Karsten Wiese <fzu@wemgehoertderstaat.de>
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License as published by the
6 * Free Software Foundation; either version 2 of the License, or (at your
7 * option) any later version.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
11 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software Foundation,
16 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 #include <linux/usb.h>
20 #include <linux/usb/audio.h>
21 #include <sound/core.h>
22 #include <sound/hwdep.h>
23 #include <sound/pcm.h>
24 #include <sound/initval.h>
25 #define MODNAME "US122L"
26 #include "usb_stream.c"
27 #include "../usbaudio.h"
30 MODULE_AUTHOR("Karsten Wiese <fzu@wemgehoertderstaat.de>");
31 MODULE_DESCRIPTION("TASCAM "NAME_ALLCAPS
" Version 0.5");
32 MODULE_LICENSE("GPL");
34 static int index
[SNDRV_CARDS
] = SNDRV_DEFAULT_IDX
; /* Index 0-max */
35 static char *id
[SNDRV_CARDS
] = SNDRV_DEFAULT_STR
; /* Id for this card */
36 /* Enable this card */
37 static int enable
[SNDRV_CARDS
] = SNDRV_DEFAULT_ENABLE_PNP
;
39 module_param_array(index
, int, NULL
, 0444);
40 MODULE_PARM_DESC(index
, "Index value for "NAME_ALLCAPS
".");
41 module_param_array(id
, charp
, NULL
, 0444);
42 MODULE_PARM_DESC(id
, "ID string for "NAME_ALLCAPS
".");
43 module_param_array(enable
, bool, NULL
, 0444);
44 MODULE_PARM_DESC(enable
, "Enable "NAME_ALLCAPS
".");
46 static int snd_us122l_card_used
[SNDRV_CARDS
];
49 static int us122l_create_usbmidi(struct snd_card
*card
)
51 static struct snd_usb_midi_endpoint_info quirk_data
= {
57 static struct snd_usb_audio_quirk quirk
= {
58 .vendor_name
= "US122L",
59 .product_name
= NAME_ALLCAPS
,
61 .type
= QUIRK_MIDI_US122L
,
64 struct usb_device
*dev
= US122L(card
)->dev
;
65 struct usb_interface
*iface
= usb_ifnum_to_if(dev
, 1);
67 return snd_usbmidi_create(card
, iface
,
68 &US122L(card
)->midi_list
, &quirk
);
71 static int us144_create_usbmidi(struct snd_card
*card
)
73 static struct snd_usb_midi_endpoint_info quirk_data
= {
79 static struct snd_usb_audio_quirk quirk
= {
80 .vendor_name
= "US144",
81 .product_name
= NAME_ALLCAPS
,
83 .type
= QUIRK_MIDI_US122L
,
86 struct usb_device
*dev
= US122L(card
)->dev
;
87 struct usb_interface
*iface
= usb_ifnum_to_if(dev
, 0);
89 return snd_usbmidi_create(card
, iface
,
90 &US122L(card
)->midi_list
, &quirk
);
94 * Wrapper for usb_control_msg().
95 * Allocates a temp buffer to prevent dmaing from/to the stack.
97 static int us122l_ctl_msg(struct usb_device
*dev
, unsigned int pipe
,
98 __u8 request
, __u8 requesttype
,
99 __u16 value
, __u16 index
, void *data
,
100 __u16 size
, int timeout
)
106 buf
= kmemdup(data
, size
, GFP_KERNEL
);
110 err
= usb_control_msg(dev
, pipe
, request
, requesttype
,
111 value
, index
, buf
, size
, timeout
);
113 memcpy(data
, buf
, size
);
119 static void pt_info_set(struct usb_device
*dev
, u8 v
)
123 ret
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
125 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
126 v
, 0, NULL
, 0, 1000);
127 snd_printdd(KERN_DEBUG
"%i\n", ret
);
130 static void usb_stream_hwdep_vm_open(struct vm_area_struct
*area
)
132 struct us122l
*us122l
= area
->vm_private_data
;
133 atomic_inc(&us122l
->mmap_count
);
134 snd_printdd(KERN_DEBUG
"%i\n", atomic_read(&us122l
->mmap_count
));
137 static int usb_stream_hwdep_vm_fault(struct vm_area_struct
*area
,
138 struct vm_fault
*vmf
)
140 unsigned long offset
;
143 struct us122l
*us122l
= area
->vm_private_data
;
144 struct usb_stream
*s
;
146 mutex_lock(&us122l
->mutex
);
151 offset
= vmf
->pgoff
<< PAGE_SHIFT
;
152 if (offset
< PAGE_ALIGN(s
->read_size
))
153 vaddr
= (char *)s
+ offset
;
155 offset
-= PAGE_ALIGN(s
->read_size
);
156 if (offset
>= PAGE_ALIGN(s
->write_size
))
159 vaddr
= us122l
->sk
.write_page
+ offset
;
161 page
= virt_to_page(vaddr
);
164 mutex_unlock(&us122l
->mutex
);
170 mutex_unlock(&us122l
->mutex
);
171 return VM_FAULT_SIGBUS
;
174 static void usb_stream_hwdep_vm_close(struct vm_area_struct
*area
)
176 struct us122l
*us122l
= area
->vm_private_data
;
177 atomic_dec(&us122l
->mmap_count
);
178 snd_printdd(KERN_DEBUG
"%i\n", atomic_read(&us122l
->mmap_count
));
181 static const struct vm_operations_struct usb_stream_hwdep_vm_ops
= {
182 .open
= usb_stream_hwdep_vm_open
,
183 .fault
= usb_stream_hwdep_vm_fault
,
184 .close
= usb_stream_hwdep_vm_close
,
188 static int usb_stream_hwdep_open(struct snd_hwdep
*hw
, struct file
*file
)
190 struct us122l
*us122l
= hw
->private_data
;
191 struct usb_interface
*iface
;
192 snd_printdd(KERN_DEBUG
"%p %p\n", hw
, file
);
197 us122l
->first
= file
;
199 if (us122l
->dev
->descriptor
.idProduct
== USB_ID_US144
||
200 us122l
->dev
->descriptor
.idProduct
== USB_ID_US144MKII
) {
201 iface
= usb_ifnum_to_if(us122l
->dev
, 0);
202 usb_autopm_get_interface(iface
);
204 iface
= usb_ifnum_to_if(us122l
->dev
, 1);
205 usb_autopm_get_interface(iface
);
209 static int usb_stream_hwdep_release(struct snd_hwdep
*hw
, struct file
*file
)
211 struct us122l
*us122l
= hw
->private_data
;
212 struct usb_interface
*iface
;
213 snd_printdd(KERN_DEBUG
"%p %p\n", hw
, file
);
215 if (us122l
->dev
->descriptor
.idProduct
== USB_ID_US144
||
216 us122l
->dev
->descriptor
.idProduct
== USB_ID_US144MKII
) {
217 iface
= usb_ifnum_to_if(us122l
->dev
, 0);
218 usb_autopm_put_interface(iface
);
220 iface
= usb_ifnum_to_if(us122l
->dev
, 1);
221 usb_autopm_put_interface(iface
);
222 if (us122l
->first
== file
)
223 us122l
->first
= NULL
;
224 mutex_lock(&us122l
->mutex
);
225 if (us122l
->master
== file
)
226 us122l
->master
= us122l
->slave
;
228 us122l
->slave
= NULL
;
229 mutex_unlock(&us122l
->mutex
);
233 static int usb_stream_hwdep_mmap(struct snd_hwdep
*hw
,
234 struct file
*filp
, struct vm_area_struct
*area
)
236 unsigned long size
= area
->vm_end
- area
->vm_start
;
237 struct us122l
*us122l
= hw
->private_data
;
238 unsigned long offset
;
239 struct usb_stream
*s
;
243 offset
= area
->vm_pgoff
<< PAGE_SHIFT
;
244 mutex_lock(&us122l
->mutex
);
246 read
= offset
< s
->read_size
;
247 if (read
&& area
->vm_flags
& VM_WRITE
) {
251 snd_printdd(KERN_DEBUG
"%lu %u\n", size
,
252 read
? s
->read_size
: s
->write_size
);
253 /* if userspace tries to mmap beyond end of our buffer, fail */
254 if (size
> PAGE_ALIGN(read
? s
->read_size
: s
->write_size
)) {
255 snd_printk(KERN_WARNING
"%lu > %u\n", size
,
256 read
? s
->read_size
: s
->write_size
);
261 area
->vm_ops
= &usb_stream_hwdep_vm_ops
;
262 area
->vm_flags
|= VM_RESERVED
;
263 area
->vm_private_data
= us122l
;
264 atomic_inc(&us122l
->mmap_count
);
266 mutex_unlock(&us122l
->mutex
);
270 static unsigned int usb_stream_hwdep_poll(struct snd_hwdep
*hw
,
271 struct file
*file
, poll_table
*wait
)
273 struct us122l
*us122l
= hw
->private_data
;
274 struct usb_stream
*s
= us122l
->sk
.s
;
278 poll_wait(file
, &us122l
->sk
.sleep
, wait
);
281 case usb_stream_ready
:
282 if (us122l
->first
== file
)
283 polled
= &s
->periods_polled
;
285 polled
= &us122l
->second_periods_polled
;
286 if (*polled
!= s
->periods_done
) {
287 *polled
= s
->periods_done
;
288 mask
= POLLIN
| POLLOUT
| POLLWRNORM
;
295 mask
= POLLIN
| POLLOUT
| POLLWRNORM
| POLLERR
;
301 static void us122l_stop(struct us122l
*us122l
)
304 list_for_each(p
, &us122l
->midi_list
)
305 snd_usbmidi_input_stop(p
);
307 usb_stream_stop(&us122l
->sk
);
308 usb_stream_free(&us122l
->sk
);
311 static int us122l_set_sample_rate(struct usb_device
*dev
, int rate
)
313 unsigned int ep
= 0x81;
314 unsigned char data
[3];
319 data
[2] = rate
>> 16;
320 err
= us122l_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), UAC_SET_CUR
,
321 USB_TYPE_CLASS
|USB_RECIP_ENDPOINT
|USB_DIR_OUT
,
322 UAC_EP_CS_ATTR_SAMPLE_RATE
<< 8, ep
, data
, 3, 1000);
324 snd_printk(KERN_ERR
"%d: cannot set freq %d to ep 0x%x\n",
325 dev
->devnum
, rate
, ep
);
329 static bool us122l_start(struct us122l
*us122l
,
330 unsigned rate
, unsigned period_frames
)
334 unsigned use_packsize
= 0;
335 bool success
= false;
337 if (us122l
->dev
->speed
== USB_SPEED_HIGH
) {
338 /* The us-122l's descriptor defaults to iso max_packsize 78,
339 which isn't needed for samplerates <= 48000.
340 Lets save some memory:
354 if (!usb_stream_new(&us122l
->sk
, us122l
->dev
, 1, 2,
355 rate
, use_packsize
, period_frames
, 6))
358 err
= us122l_set_sample_rate(us122l
->dev
, rate
);
361 snd_printk(KERN_ERR
"us122l_set_sample_rate error \n");
364 err
= usb_stream_start(&us122l
->sk
);
367 snd_printk(KERN_ERR
"us122l_start error %i \n", err
);
370 list_for_each(p
, &us122l
->midi_list
)
371 snd_usbmidi_input_start(p
);
377 static int usb_stream_hwdep_ioctl(struct snd_hwdep
*hw
, struct file
*file
,
378 unsigned cmd
, unsigned long arg
)
380 struct usb_stream_config
*cfg
;
381 struct us122l
*us122l
= hw
->private_data
;
382 unsigned min_period_frames
;
386 if (cmd
!= SNDRV_USB_STREAM_IOCTL_SET_PARAMS
)
389 cfg
= memdup_user((void *)arg
, sizeof(*cfg
));
393 if (cfg
->version
!= USB_STREAM_INTERFACE_VERSION
) {
397 high_speed
= us122l
->dev
->speed
== USB_SPEED_HIGH
;
398 if ((cfg
->sample_rate
!= 44100 && cfg
->sample_rate
!= 48000 &&
400 (cfg
->sample_rate
!= 88200 && cfg
->sample_rate
!= 96000))) ||
401 cfg
->frame_size
!= 6 ||
402 cfg
->period_frames
> 0x3000) {
406 switch (cfg
->sample_rate
) {
408 min_period_frames
= 48;
411 min_period_frames
= 52;
414 min_period_frames
= 104;
418 min_period_frames
<<= 1;
419 if (cfg
->period_frames
< min_period_frames
) {
424 snd_power_wait(hw
->card
, SNDRV_CTL_POWER_D0
);
426 mutex_lock(&us122l
->mutex
);
428 us122l
->master
= file
;
429 else if (us122l
->master
!= file
) {
430 if (memcmp(cfg
, &us122l
->sk
.s
->cfg
, sizeof(*cfg
))) {
434 us122l
->slave
= file
;
437 memcmp(cfg
, &us122l
->sk
.s
->cfg
, sizeof(*cfg
)) ||
438 us122l
->sk
.s
->state
== usb_stream_xrun
) {
440 if (!us122l_start(us122l
, cfg
->sample_rate
, cfg
->period_frames
))
446 mutex_unlock(&us122l
->mutex
);
452 #define SND_USB_STREAM_ID "USB STREAM"
453 static int usb_stream_hwdep_new(struct snd_card
*card
)
456 struct snd_hwdep
*hw
;
457 struct usb_device
*dev
= US122L(card
)->dev
;
459 err
= snd_hwdep_new(card
, SND_USB_STREAM_ID
, 0, &hw
);
463 hw
->iface
= SNDRV_HWDEP_IFACE_USB_STREAM
;
464 hw
->private_data
= US122L(card
);
465 hw
->ops
.open
= usb_stream_hwdep_open
;
466 hw
->ops
.release
= usb_stream_hwdep_release
;
467 hw
->ops
.ioctl
= usb_stream_hwdep_ioctl
;
468 hw
->ops
.ioctl_compat
= usb_stream_hwdep_ioctl
;
469 hw
->ops
.mmap
= usb_stream_hwdep_mmap
;
470 hw
->ops
.poll
= usb_stream_hwdep_poll
;
472 sprintf(hw
->name
, "/proc/bus/usb/%03d/%03d/hwdeppcm",
473 dev
->bus
->busnum
, dev
->devnum
);
478 static bool us122l_create_card(struct snd_card
*card
)
481 struct us122l
*us122l
= US122L(card
);
483 if (us122l
->dev
->descriptor
.idProduct
== USB_ID_US144
||
484 us122l
->dev
->descriptor
.idProduct
== USB_ID_US144MKII
) {
485 err
= usb_set_interface(us122l
->dev
, 0, 1);
487 snd_printk(KERN_ERR
"usb_set_interface error \n");
491 err
= usb_set_interface(us122l
->dev
, 1, 1);
493 snd_printk(KERN_ERR
"usb_set_interface error \n");
497 pt_info_set(us122l
->dev
, 0x11);
498 pt_info_set(us122l
->dev
, 0x10);
500 if (!us122l_start(us122l
, 44100, 256))
503 if (us122l
->dev
->descriptor
.idProduct
== USB_ID_US144
||
504 us122l
->dev
->descriptor
.idProduct
== USB_ID_US144MKII
)
505 err
= us144_create_usbmidi(card
);
507 err
= us122l_create_usbmidi(card
);
509 snd_printk(KERN_ERR
"us122l_create_usbmidi error %i \n", err
);
513 err
= usb_stream_hwdep_new(card
);
515 /* release the midi resources */
517 list_for_each(p
, &us122l
->midi_list
)
518 snd_usbmidi_disconnect(p
);
526 static void snd_us122l_free(struct snd_card
*card
)
528 struct us122l
*us122l
= US122L(card
);
529 int index
= us122l
->card_index
;
530 if (index
>= 0 && index
< SNDRV_CARDS
)
531 snd_us122l_card_used
[index
] = 0;
534 static int usx2y_create_card(struct usb_device
*device
, struct snd_card
**cardp
)
537 struct snd_card
*card
;
540 for (dev
= 0; dev
< SNDRV_CARDS
; ++dev
)
541 if (enable
[dev
] && !snd_us122l_card_used
[dev
])
543 if (dev
>= SNDRV_CARDS
)
545 err
= snd_card_create(index
[dev
], id
[dev
], THIS_MODULE
,
546 sizeof(struct us122l
), &card
);
549 snd_us122l_card_used
[US122L(card
)->card_index
= dev
] = 1;
550 card
->private_free
= snd_us122l_free
;
551 US122L(card
)->dev
= device
;
552 mutex_init(&US122L(card
)->mutex
);
553 init_waitqueue_head(&US122L(card
)->sk
.sleep
);
554 INIT_LIST_HEAD(&US122L(card
)->midi_list
);
555 strcpy(card
->driver
, "USB "NAME_ALLCAPS
"");
556 sprintf(card
->shortname
, "TASCAM "NAME_ALLCAPS
"");
557 sprintf(card
->longname
, "%s (%x:%x if %d at %03d/%03d)",
559 le16_to_cpu(device
->descriptor
.idVendor
),
560 le16_to_cpu(device
->descriptor
.idProduct
),
562 US122L(card
)->dev
->bus
->busnum
,
563 US122L(card
)->dev
->devnum
569 static int us122l_usb_probe(struct usb_interface
*intf
,
570 const struct usb_device_id
*device_id
,
571 struct snd_card
**cardp
)
573 struct usb_device
*device
= interface_to_usbdev(intf
);
574 struct snd_card
*card
;
577 err
= usx2y_create_card(device
, &card
);
581 snd_card_set_dev(card
, &intf
->dev
);
582 if (!us122l_create_card(card
)) {
587 err
= snd_card_register(card
);
593 usb_get_intf(usb_ifnum_to_if(device
, 0));
599 static int snd_us122l_probe(struct usb_interface
*intf
,
600 const struct usb_device_id
*id
)
602 struct usb_device
*device
= interface_to_usbdev(intf
);
603 struct snd_card
*card
;
606 if ((device
->descriptor
.idProduct
== USB_ID_US144
||
607 device
->descriptor
.idProduct
== USB_ID_US144MKII
)
608 && device
->speed
== USB_SPEED_HIGH
) {
609 snd_printk(KERN_ERR
"disable ehci-hcd to run US-144 \n");
613 snd_printdd(KERN_DEBUG
"%p:%i\n",
614 intf
, intf
->cur_altsetting
->desc
.bInterfaceNumber
);
615 if (intf
->cur_altsetting
->desc
.bInterfaceNumber
!= 1)
618 err
= us122l_usb_probe(usb_get_intf(intf
), id
, &card
);
624 usb_set_intfdata(intf
, card
);
628 static void snd_us122l_disconnect(struct usb_interface
*intf
)
630 struct snd_card
*card
;
631 struct us122l
*us122l
;
634 card
= usb_get_intfdata(intf
);
638 snd_card_disconnect(card
);
640 us122l
= US122L(card
);
641 mutex_lock(&us122l
->mutex
);
643 mutex_unlock(&us122l
->mutex
);
645 /* release the midi resources */
646 list_for_each(p
, &us122l
->midi_list
) {
647 snd_usbmidi_disconnect(p
);
650 usb_put_intf(usb_ifnum_to_if(us122l
->dev
, 0));
651 usb_put_intf(usb_ifnum_to_if(us122l
->dev
, 1));
652 usb_put_dev(us122l
->dev
);
654 while (atomic_read(&us122l
->mmap_count
))
660 static int snd_us122l_suspend(struct usb_interface
*intf
, pm_message_t message
)
662 struct snd_card
*card
;
663 struct us122l
*us122l
;
666 card
= usb_get_intfdata(intf
);
669 snd_power_change_state(card
, SNDRV_CTL_POWER_D3hot
);
671 us122l
= US122L(card
);
675 list_for_each(p
, &us122l
->midi_list
)
676 snd_usbmidi_input_stop(p
);
678 mutex_lock(&us122l
->mutex
);
679 usb_stream_stop(&us122l
->sk
);
680 mutex_unlock(&us122l
->mutex
);
685 static int snd_us122l_resume(struct usb_interface
*intf
)
687 struct snd_card
*card
;
688 struct us122l
*us122l
;
692 card
= usb_get_intfdata(intf
);
696 us122l
= US122L(card
);
700 mutex_lock(&us122l
->mutex
);
701 /* needed, doesn't restart without: */
702 if (us122l
->dev
->descriptor
.idProduct
== USB_ID_US144
||
703 us122l
->dev
->descriptor
.idProduct
== USB_ID_US144MKII
) {
704 err
= usb_set_interface(us122l
->dev
, 0, 1);
706 snd_printk(KERN_ERR
"usb_set_interface error \n");
710 err
= usb_set_interface(us122l
->dev
, 1, 1);
712 snd_printk(KERN_ERR
"usb_set_interface error \n");
716 pt_info_set(us122l
->dev
, 0x11);
717 pt_info_set(us122l
->dev
, 0x10);
719 err
= us122l_set_sample_rate(us122l
->dev
,
720 us122l
->sk
.s
->cfg
.sample_rate
);
722 snd_printk(KERN_ERR
"us122l_set_sample_rate error \n");
725 err
= usb_stream_start(&us122l
->sk
);
729 list_for_each(p
, &us122l
->midi_list
)
730 snd_usbmidi_input_start(p
);
732 mutex_unlock(&us122l
->mutex
);
733 snd_power_change_state(card
, SNDRV_CTL_POWER_D0
);
737 static struct usb_device_id snd_us122l_usb_id_table
[] = {
739 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
741 .idProduct
= USB_ID_US122L
743 { /* US-144 only works at USB1.1! Disable module ehci-hcd. */
744 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
746 .idProduct
= USB_ID_US144
749 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
751 .idProduct
= USB_ID_US122MKII
754 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
756 .idProduct
= USB_ID_US144MKII
761 MODULE_DEVICE_TABLE(usb
, snd_us122l_usb_id_table
);
762 static struct usb_driver snd_us122l_usb_driver
= {
763 .name
= "snd-usb-us122l",
764 .probe
= snd_us122l_probe
,
765 .disconnect
= snd_us122l_disconnect
,
766 .suspend
= snd_us122l_suspend
,
767 .resume
= snd_us122l_resume
,
768 .reset_resume
= snd_us122l_resume
,
769 .id_table
= snd_us122l_usb_id_table
,
770 .supports_autosuspend
= 1
774 static int __init
snd_us122l_module_init(void)
776 return usb_register(&snd_us122l_usb_driver
);
779 static void __exit
snd_us122l_module_exit(void)
781 usb_deregister(&snd_us122l_usb_driver
);
784 module_init(snd_us122l_module_init
)
785 module_exit(snd_us122l_module_exit
)