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"
28 #include "../usbmidi.h"
31 MODULE_AUTHOR("Karsten Wiese <fzu@wemgehoertderstaat.de>");
32 MODULE_DESCRIPTION("TASCAM "NAME_ALLCAPS
" Version 0.5");
33 MODULE_LICENSE("GPL");
35 static int index
[SNDRV_CARDS
] = SNDRV_DEFAULT_IDX
; /* Index 0-max */
36 static char *id
[SNDRV_CARDS
] = SNDRV_DEFAULT_STR
; /* Id for this card */
37 /* Enable this card */
38 static int enable
[SNDRV_CARDS
] = SNDRV_DEFAULT_ENABLE_PNP
;
40 module_param_array(index
, int, NULL
, 0444);
41 MODULE_PARM_DESC(index
, "Index value for "NAME_ALLCAPS
".");
42 module_param_array(id
, charp
, NULL
, 0444);
43 MODULE_PARM_DESC(id
, "ID string for "NAME_ALLCAPS
".");
44 module_param_array(enable
, bool, NULL
, 0444);
45 MODULE_PARM_DESC(enable
, "Enable "NAME_ALLCAPS
".");
47 static int snd_us122l_card_used
[SNDRV_CARDS
];
50 static int us122l_create_usbmidi(struct snd_card
*card
)
52 static struct snd_usb_midi_endpoint_info quirk_data
= {
58 static struct snd_usb_audio_quirk quirk
= {
59 .vendor_name
= "US122L",
60 .product_name
= NAME_ALLCAPS
,
62 .type
= QUIRK_MIDI_US122L
,
65 struct usb_device
*dev
= US122L(card
)->dev
;
66 struct usb_interface
*iface
= usb_ifnum_to_if(dev
, 1);
68 return snd_usbmidi_create(card
, iface
,
69 &US122L(card
)->midi_list
, &quirk
);
72 static int us144_create_usbmidi(struct snd_card
*card
)
74 static struct snd_usb_midi_endpoint_info quirk_data
= {
80 static struct snd_usb_audio_quirk quirk
= {
81 .vendor_name
= "US144",
82 .product_name
= NAME_ALLCAPS
,
84 .type
= QUIRK_MIDI_US122L
,
87 struct usb_device
*dev
= US122L(card
)->dev
;
88 struct usb_interface
*iface
= usb_ifnum_to_if(dev
, 0);
90 return snd_usbmidi_create(card
, iface
,
91 &US122L(card
)->midi_list
, &quirk
);
95 * Wrapper for usb_control_msg().
96 * Allocates a temp buffer to prevent dmaing from/to the stack.
98 static int us122l_ctl_msg(struct usb_device
*dev
, unsigned int pipe
,
99 __u8 request
, __u8 requesttype
,
100 __u16 value
, __u16 index
, void *data
,
101 __u16 size
, int timeout
)
107 buf
= kmemdup(data
, size
, GFP_KERNEL
);
111 err
= usb_control_msg(dev
, pipe
, request
, requesttype
,
112 value
, index
, buf
, size
, timeout
);
114 memcpy(data
, buf
, size
);
120 static void pt_info_set(struct usb_device
*dev
, u8 v
)
124 ret
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
126 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
127 v
, 0, NULL
, 0, 1000);
128 snd_printdd(KERN_DEBUG
"%i\n", ret
);
131 static void usb_stream_hwdep_vm_open(struct vm_area_struct
*area
)
133 struct us122l
*us122l
= area
->vm_private_data
;
134 atomic_inc(&us122l
->mmap_count
);
135 snd_printdd(KERN_DEBUG
"%i\n", atomic_read(&us122l
->mmap_count
));
138 static int usb_stream_hwdep_vm_fault(struct vm_area_struct
*area
,
139 struct vm_fault
*vmf
)
141 unsigned long offset
;
144 struct us122l
*us122l
= area
->vm_private_data
;
145 struct usb_stream
*s
;
147 mutex_lock(&us122l
->mutex
);
152 offset
= vmf
->pgoff
<< PAGE_SHIFT
;
153 if (offset
< PAGE_ALIGN(s
->read_size
))
154 vaddr
= (char *)s
+ offset
;
156 offset
-= PAGE_ALIGN(s
->read_size
);
157 if (offset
>= PAGE_ALIGN(s
->write_size
))
160 vaddr
= us122l
->sk
.write_page
+ offset
;
162 page
= virt_to_page(vaddr
);
165 mutex_unlock(&us122l
->mutex
);
171 mutex_unlock(&us122l
->mutex
);
172 return VM_FAULT_SIGBUS
;
175 static void usb_stream_hwdep_vm_close(struct vm_area_struct
*area
)
177 struct us122l
*us122l
= area
->vm_private_data
;
178 atomic_dec(&us122l
->mmap_count
);
179 snd_printdd(KERN_DEBUG
"%i\n", atomic_read(&us122l
->mmap_count
));
182 static const struct vm_operations_struct usb_stream_hwdep_vm_ops
= {
183 .open
= usb_stream_hwdep_vm_open
,
184 .fault
= usb_stream_hwdep_vm_fault
,
185 .close
= usb_stream_hwdep_vm_close
,
189 static int usb_stream_hwdep_open(struct snd_hwdep
*hw
, struct file
*file
)
191 struct us122l
*us122l
= hw
->private_data
;
192 struct usb_interface
*iface
;
193 snd_printdd(KERN_DEBUG
"%p %p\n", hw
, file
);
198 us122l
->first
= file
;
200 if (us122l
->dev
->descriptor
.idProduct
== USB_ID_US144
||
201 us122l
->dev
->descriptor
.idProduct
== USB_ID_US144MKII
) {
202 iface
= usb_ifnum_to_if(us122l
->dev
, 0);
203 usb_autopm_get_interface(iface
);
205 iface
= usb_ifnum_to_if(us122l
->dev
, 1);
206 usb_autopm_get_interface(iface
);
210 static int usb_stream_hwdep_release(struct snd_hwdep
*hw
, struct file
*file
)
212 struct us122l
*us122l
= hw
->private_data
;
213 struct usb_interface
*iface
;
214 snd_printdd(KERN_DEBUG
"%p %p\n", hw
, file
);
216 if (us122l
->dev
->descriptor
.idProduct
== USB_ID_US144
||
217 us122l
->dev
->descriptor
.idProduct
== USB_ID_US144MKII
) {
218 iface
= usb_ifnum_to_if(us122l
->dev
, 0);
219 usb_autopm_put_interface(iface
);
221 iface
= usb_ifnum_to_if(us122l
->dev
, 1);
222 usb_autopm_put_interface(iface
);
223 if (us122l
->first
== file
)
224 us122l
->first
= NULL
;
225 mutex_lock(&us122l
->mutex
);
226 if (us122l
->master
== file
)
227 us122l
->master
= us122l
->slave
;
229 us122l
->slave
= NULL
;
230 mutex_unlock(&us122l
->mutex
);
234 static int usb_stream_hwdep_mmap(struct snd_hwdep
*hw
,
235 struct file
*filp
, struct vm_area_struct
*area
)
237 unsigned long size
= area
->vm_end
- area
->vm_start
;
238 struct us122l
*us122l
= hw
->private_data
;
239 unsigned long offset
;
240 struct usb_stream
*s
;
244 offset
= area
->vm_pgoff
<< PAGE_SHIFT
;
245 mutex_lock(&us122l
->mutex
);
247 read
= offset
< s
->read_size
;
248 if (read
&& area
->vm_flags
& VM_WRITE
) {
252 snd_printdd(KERN_DEBUG
"%lu %u\n", size
,
253 read
? s
->read_size
: s
->write_size
);
254 /* if userspace tries to mmap beyond end of our buffer, fail */
255 if (size
> PAGE_ALIGN(read
? s
->read_size
: s
->write_size
)) {
256 snd_printk(KERN_WARNING
"%lu > %u\n", size
,
257 read
? s
->read_size
: s
->write_size
);
262 area
->vm_ops
= &usb_stream_hwdep_vm_ops
;
263 area
->vm_flags
|= VM_RESERVED
;
264 area
->vm_private_data
= us122l
;
265 atomic_inc(&us122l
->mmap_count
);
267 mutex_unlock(&us122l
->mutex
);
271 static unsigned int usb_stream_hwdep_poll(struct snd_hwdep
*hw
,
272 struct file
*file
, poll_table
*wait
)
274 struct us122l
*us122l
= hw
->private_data
;
275 struct usb_stream
*s
= us122l
->sk
.s
;
279 poll_wait(file
, &us122l
->sk
.sleep
, wait
);
282 case usb_stream_ready
:
283 if (us122l
->first
== file
)
284 polled
= &s
->periods_polled
;
286 polled
= &us122l
->second_periods_polled
;
287 if (*polled
!= s
->periods_done
) {
288 *polled
= s
->periods_done
;
289 mask
= POLLIN
| POLLOUT
| POLLWRNORM
;
296 mask
= POLLIN
| POLLOUT
| POLLWRNORM
| POLLERR
;
302 static void us122l_stop(struct us122l
*us122l
)
305 list_for_each(p
, &us122l
->midi_list
)
306 snd_usbmidi_input_stop(p
);
308 usb_stream_stop(&us122l
->sk
);
309 usb_stream_free(&us122l
->sk
);
312 static int us122l_set_sample_rate(struct usb_device
*dev
, int rate
)
314 unsigned int ep
= 0x81;
315 unsigned char data
[3];
320 data
[2] = rate
>> 16;
321 err
= us122l_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), UAC_SET_CUR
,
322 USB_TYPE_CLASS
|USB_RECIP_ENDPOINT
|USB_DIR_OUT
,
323 UAC_EP_CS_ATTR_SAMPLE_RATE
<< 8, ep
, data
, 3, 1000);
325 snd_printk(KERN_ERR
"%d: cannot set freq %d to ep 0x%x\n",
326 dev
->devnum
, rate
, ep
);
330 static bool us122l_start(struct us122l
*us122l
,
331 unsigned rate
, unsigned period_frames
)
335 unsigned use_packsize
= 0;
336 bool success
= false;
338 if (us122l
->dev
->speed
== USB_SPEED_HIGH
) {
339 /* The us-122l's descriptor defaults to iso max_packsize 78,
340 which isn't needed for samplerates <= 48000.
341 Lets save some memory:
355 if (!usb_stream_new(&us122l
->sk
, us122l
->dev
, 1, 2,
356 rate
, use_packsize
, period_frames
, 6))
359 err
= us122l_set_sample_rate(us122l
->dev
, rate
);
362 snd_printk(KERN_ERR
"us122l_set_sample_rate error \n");
365 err
= usb_stream_start(&us122l
->sk
);
368 snd_printk(KERN_ERR
"us122l_start error %i \n", err
);
371 list_for_each(p
, &us122l
->midi_list
)
372 snd_usbmidi_input_start(p
);
378 static int usb_stream_hwdep_ioctl(struct snd_hwdep
*hw
, struct file
*file
,
379 unsigned cmd
, unsigned long arg
)
381 struct usb_stream_config
*cfg
;
382 struct us122l
*us122l
= hw
->private_data
;
383 unsigned min_period_frames
;
387 if (cmd
!= SNDRV_USB_STREAM_IOCTL_SET_PARAMS
)
390 cfg
= memdup_user((void *)arg
, sizeof(*cfg
));
394 if (cfg
->version
!= USB_STREAM_INTERFACE_VERSION
) {
398 high_speed
= us122l
->dev
->speed
== USB_SPEED_HIGH
;
399 if ((cfg
->sample_rate
!= 44100 && cfg
->sample_rate
!= 48000 &&
401 (cfg
->sample_rate
!= 88200 && cfg
->sample_rate
!= 96000))) ||
402 cfg
->frame_size
!= 6 ||
403 cfg
->period_frames
> 0x3000) {
407 switch (cfg
->sample_rate
) {
409 min_period_frames
= 48;
412 min_period_frames
= 52;
415 min_period_frames
= 104;
419 min_period_frames
<<= 1;
420 if (cfg
->period_frames
< min_period_frames
) {
425 snd_power_wait(hw
->card
, SNDRV_CTL_POWER_D0
);
427 mutex_lock(&us122l
->mutex
);
429 us122l
->master
= file
;
430 else if (us122l
->master
!= file
) {
431 if (memcmp(cfg
, &us122l
->sk
.s
->cfg
, sizeof(*cfg
))) {
435 us122l
->slave
= file
;
438 memcmp(cfg
, &us122l
->sk
.s
->cfg
, sizeof(*cfg
)) ||
439 us122l
->sk
.s
->state
== usb_stream_xrun
) {
441 if (!us122l_start(us122l
, cfg
->sample_rate
, cfg
->period_frames
))
447 mutex_unlock(&us122l
->mutex
);
453 #define SND_USB_STREAM_ID "USB STREAM"
454 static int usb_stream_hwdep_new(struct snd_card
*card
)
457 struct snd_hwdep
*hw
;
458 struct usb_device
*dev
= US122L(card
)->dev
;
460 err
= snd_hwdep_new(card
, SND_USB_STREAM_ID
, 0, &hw
);
464 hw
->iface
= SNDRV_HWDEP_IFACE_USB_STREAM
;
465 hw
->private_data
= US122L(card
);
466 hw
->ops
.open
= usb_stream_hwdep_open
;
467 hw
->ops
.release
= usb_stream_hwdep_release
;
468 hw
->ops
.ioctl
= usb_stream_hwdep_ioctl
;
469 hw
->ops
.ioctl_compat
= usb_stream_hwdep_ioctl
;
470 hw
->ops
.mmap
= usb_stream_hwdep_mmap
;
471 hw
->ops
.poll
= usb_stream_hwdep_poll
;
473 sprintf(hw
->name
, "/proc/bus/usb/%03d/%03d/hwdeppcm",
474 dev
->bus
->busnum
, dev
->devnum
);
479 static bool us122l_create_card(struct snd_card
*card
)
482 struct us122l
*us122l
= US122L(card
);
484 if (us122l
->dev
->descriptor
.idProduct
== USB_ID_US144
||
485 us122l
->dev
->descriptor
.idProduct
== USB_ID_US144MKII
) {
486 err
= usb_set_interface(us122l
->dev
, 0, 1);
488 snd_printk(KERN_ERR
"usb_set_interface error \n");
492 err
= usb_set_interface(us122l
->dev
, 1, 1);
494 snd_printk(KERN_ERR
"usb_set_interface error \n");
498 pt_info_set(us122l
->dev
, 0x11);
499 pt_info_set(us122l
->dev
, 0x10);
501 if (!us122l_start(us122l
, 44100, 256))
504 if (us122l
->dev
->descriptor
.idProduct
== USB_ID_US144
||
505 us122l
->dev
->descriptor
.idProduct
== USB_ID_US144MKII
)
506 err
= us144_create_usbmidi(card
);
508 err
= us122l_create_usbmidi(card
);
510 snd_printk(KERN_ERR
"us122l_create_usbmidi error %i \n", err
);
514 err
= usb_stream_hwdep_new(card
);
516 /* release the midi resources */
518 list_for_each(p
, &us122l
->midi_list
)
519 snd_usbmidi_disconnect(p
);
527 static void snd_us122l_free(struct snd_card
*card
)
529 struct us122l
*us122l
= US122L(card
);
530 int index
= us122l
->card_index
;
531 if (index
>= 0 && index
< SNDRV_CARDS
)
532 snd_us122l_card_used
[index
] = 0;
535 static int usx2y_create_card(struct usb_device
*device
, struct snd_card
**cardp
)
538 struct snd_card
*card
;
541 for (dev
= 0; dev
< SNDRV_CARDS
; ++dev
)
542 if (enable
[dev
] && !snd_us122l_card_used
[dev
])
544 if (dev
>= SNDRV_CARDS
)
546 err
= snd_card_create(index
[dev
], id
[dev
], THIS_MODULE
,
547 sizeof(struct us122l
), &card
);
550 snd_us122l_card_used
[US122L(card
)->card_index
= dev
] = 1;
551 card
->private_free
= snd_us122l_free
;
552 US122L(card
)->dev
= device
;
553 mutex_init(&US122L(card
)->mutex
);
554 init_waitqueue_head(&US122L(card
)->sk
.sleep
);
555 INIT_LIST_HEAD(&US122L(card
)->midi_list
);
556 strcpy(card
->driver
, "USB "NAME_ALLCAPS
"");
557 sprintf(card
->shortname
, "TASCAM "NAME_ALLCAPS
"");
558 sprintf(card
->longname
, "%s (%x:%x if %d at %03d/%03d)",
560 le16_to_cpu(device
->descriptor
.idVendor
),
561 le16_to_cpu(device
->descriptor
.idProduct
),
563 US122L(card
)->dev
->bus
->busnum
,
564 US122L(card
)->dev
->devnum
570 static int us122l_usb_probe(struct usb_interface
*intf
,
571 const struct usb_device_id
*device_id
,
572 struct snd_card
**cardp
)
574 struct usb_device
*device
= interface_to_usbdev(intf
);
575 struct snd_card
*card
;
578 err
= usx2y_create_card(device
, &card
);
582 snd_card_set_dev(card
, &intf
->dev
);
583 if (!us122l_create_card(card
)) {
588 err
= snd_card_register(card
);
594 usb_get_intf(usb_ifnum_to_if(device
, 0));
600 static int snd_us122l_probe(struct usb_interface
*intf
,
601 const struct usb_device_id
*id
)
603 struct usb_device
*device
= interface_to_usbdev(intf
);
604 struct snd_card
*card
;
607 if ((device
->descriptor
.idProduct
== USB_ID_US144
||
608 device
->descriptor
.idProduct
== USB_ID_US144MKII
)
609 && device
->speed
== USB_SPEED_HIGH
) {
610 snd_printk(KERN_ERR
"disable ehci-hcd to run US-144 \n");
614 snd_printdd(KERN_DEBUG
"%p:%i\n",
615 intf
, intf
->cur_altsetting
->desc
.bInterfaceNumber
);
616 if (intf
->cur_altsetting
->desc
.bInterfaceNumber
!= 1)
619 err
= us122l_usb_probe(usb_get_intf(intf
), id
, &card
);
625 usb_set_intfdata(intf
, card
);
629 static void snd_us122l_disconnect(struct usb_interface
*intf
)
631 struct snd_card
*card
;
632 struct us122l
*us122l
;
635 card
= usb_get_intfdata(intf
);
639 snd_card_disconnect(card
);
641 us122l
= US122L(card
);
642 mutex_lock(&us122l
->mutex
);
644 mutex_unlock(&us122l
->mutex
);
646 /* release the midi resources */
647 list_for_each(p
, &us122l
->midi_list
) {
648 snd_usbmidi_disconnect(p
);
651 usb_put_intf(usb_ifnum_to_if(us122l
->dev
, 0));
652 usb_put_intf(usb_ifnum_to_if(us122l
->dev
, 1));
653 usb_put_dev(us122l
->dev
);
655 while (atomic_read(&us122l
->mmap_count
))
661 static int snd_us122l_suspend(struct usb_interface
*intf
, pm_message_t message
)
663 struct snd_card
*card
;
664 struct us122l
*us122l
;
667 card
= usb_get_intfdata(intf
);
670 snd_power_change_state(card
, SNDRV_CTL_POWER_D3hot
);
672 us122l
= US122L(card
);
676 list_for_each(p
, &us122l
->midi_list
)
677 snd_usbmidi_input_stop(p
);
679 mutex_lock(&us122l
->mutex
);
680 usb_stream_stop(&us122l
->sk
);
681 mutex_unlock(&us122l
->mutex
);
686 static int snd_us122l_resume(struct usb_interface
*intf
)
688 struct snd_card
*card
;
689 struct us122l
*us122l
;
693 card
= usb_get_intfdata(intf
);
697 us122l
= US122L(card
);
701 mutex_lock(&us122l
->mutex
);
702 /* needed, doesn't restart without: */
703 if (us122l
->dev
->descriptor
.idProduct
== USB_ID_US144
||
704 us122l
->dev
->descriptor
.idProduct
== USB_ID_US144MKII
) {
705 err
= usb_set_interface(us122l
->dev
, 0, 1);
707 snd_printk(KERN_ERR
"usb_set_interface error \n");
711 err
= usb_set_interface(us122l
->dev
, 1, 1);
713 snd_printk(KERN_ERR
"usb_set_interface error \n");
717 pt_info_set(us122l
->dev
, 0x11);
718 pt_info_set(us122l
->dev
, 0x10);
720 err
= us122l_set_sample_rate(us122l
->dev
,
721 us122l
->sk
.s
->cfg
.sample_rate
);
723 snd_printk(KERN_ERR
"us122l_set_sample_rate error \n");
726 err
= usb_stream_start(&us122l
->sk
);
730 list_for_each(p
, &us122l
->midi_list
)
731 snd_usbmidi_input_start(p
);
733 mutex_unlock(&us122l
->mutex
);
734 snd_power_change_state(card
, SNDRV_CTL_POWER_D0
);
738 static struct usb_device_id snd_us122l_usb_id_table
[] = {
740 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
742 .idProduct
= USB_ID_US122L
744 { /* US-144 only works at USB1.1! Disable module ehci-hcd. */
745 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
747 .idProduct
= USB_ID_US144
750 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
752 .idProduct
= USB_ID_US122MKII
755 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
757 .idProduct
= USB_ID_US144MKII
762 MODULE_DEVICE_TABLE(usb
, snd_us122l_usb_id_table
);
763 static struct usb_driver snd_us122l_usb_driver
= {
764 .name
= "snd-usb-us122l",
765 .probe
= snd_us122l_probe
,
766 .disconnect
= snd_us122l_disconnect
,
767 .suspend
= snd_us122l_suspend
,
768 .resume
= snd_us122l_resume
,
769 .reset_resume
= snd_us122l_resume
,
770 .id_table
= snd_us122l_usb_id_table
,
771 .supports_autosuspend
= 1
775 static int __init
snd_us122l_module_init(void)
777 return usb_register(&snd_us122l_usb_driver
);
780 static void __exit
snd_us122l_module_exit(void)
782 usb_deregister(&snd_us122l_usb_driver
);
785 module_init(snd_us122l_module_init
)
786 module_exit(snd_us122l_module_exit
)