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/slab.h>
20 #include <linux/usb.h>
21 #include <linux/usb/audio.h>
22 #include <sound/core.h>
23 #include <sound/hwdep.h>
24 #include <sound/pcm.h>
25 #include <sound/initval.h>
26 #define MODNAME "US122L"
27 #include "usb_stream.c"
28 #include "../usbaudio.h"
32 MODULE_AUTHOR("Karsten Wiese <fzu@wemgehoertderstaat.de>");
33 MODULE_DESCRIPTION("TASCAM "NAME_ALLCAPS
" Version 0.5");
34 MODULE_LICENSE("GPL");
36 static int index
[SNDRV_CARDS
] = SNDRV_DEFAULT_IDX
; /* Index 0-max */
37 static char *id
[SNDRV_CARDS
] = SNDRV_DEFAULT_STR
; /* Id for this card */
38 /* Enable this card */
39 static int enable
[SNDRV_CARDS
] = SNDRV_DEFAULT_ENABLE_PNP
;
41 module_param_array(index
, int, NULL
, 0444);
42 MODULE_PARM_DESC(index
, "Index value for "NAME_ALLCAPS
".");
43 module_param_array(id
, charp
, NULL
, 0444);
44 MODULE_PARM_DESC(id
, "ID string for "NAME_ALLCAPS
".");
45 module_param_array(enable
, bool, NULL
, 0444);
46 MODULE_PARM_DESC(enable
, "Enable "NAME_ALLCAPS
".");
48 static int snd_us122l_card_used
[SNDRV_CARDS
];
51 static int us122l_create_usbmidi(struct snd_card
*card
)
53 static struct snd_usb_midi_endpoint_info quirk_data
= {
59 static struct snd_usb_audio_quirk quirk
= {
60 .vendor_name
= "US122L",
61 .product_name
= NAME_ALLCAPS
,
63 .type
= QUIRK_MIDI_US122L
,
66 struct usb_device
*dev
= US122L(card
)->dev
;
67 struct usb_interface
*iface
= usb_ifnum_to_if(dev
, 1);
69 return snd_usbmidi_create(card
, iface
,
70 &US122L(card
)->midi_list
, &quirk
);
73 static int us144_create_usbmidi(struct snd_card
*card
)
75 static struct snd_usb_midi_endpoint_info quirk_data
= {
81 static struct snd_usb_audio_quirk quirk
= {
82 .vendor_name
= "US144",
83 .product_name
= NAME_ALLCAPS
,
85 .type
= QUIRK_MIDI_US122L
,
88 struct usb_device
*dev
= US122L(card
)->dev
;
89 struct usb_interface
*iface
= usb_ifnum_to_if(dev
, 0);
91 return snd_usbmidi_create(card
, iface
,
92 &US122L(card
)->midi_list
, &quirk
);
96 * Wrapper for usb_control_msg().
97 * Allocates a temp buffer to prevent dmaing from/to the stack.
99 static int us122l_ctl_msg(struct usb_device
*dev
, unsigned int pipe
,
100 __u8 request
, __u8 requesttype
,
101 __u16 value
, __u16 index
, void *data
,
102 __u16 size
, int timeout
)
108 buf
= kmemdup(data
, size
, GFP_KERNEL
);
112 err
= usb_control_msg(dev
, pipe
, request
, requesttype
,
113 value
, index
, buf
, size
, timeout
);
115 memcpy(data
, buf
, size
);
121 static void pt_info_set(struct usb_device
*dev
, u8 v
)
125 ret
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
127 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
128 v
, 0, NULL
, 0, 1000);
129 snd_printdd(KERN_DEBUG
"%i\n", ret
);
132 static void usb_stream_hwdep_vm_open(struct vm_area_struct
*area
)
134 struct us122l
*us122l
= area
->vm_private_data
;
135 atomic_inc(&us122l
->mmap_count
);
136 snd_printdd(KERN_DEBUG
"%i\n", atomic_read(&us122l
->mmap_count
));
139 static int usb_stream_hwdep_vm_fault(struct vm_area_struct
*area
,
140 struct vm_fault
*vmf
)
142 unsigned long offset
;
145 struct us122l
*us122l
= area
->vm_private_data
;
146 struct usb_stream
*s
;
148 mutex_lock(&us122l
->mutex
);
153 offset
= vmf
->pgoff
<< PAGE_SHIFT
;
154 if (offset
< PAGE_ALIGN(s
->read_size
))
155 vaddr
= (char *)s
+ offset
;
157 offset
-= PAGE_ALIGN(s
->read_size
);
158 if (offset
>= PAGE_ALIGN(s
->write_size
))
161 vaddr
= us122l
->sk
.write_page
+ offset
;
163 page
= virt_to_page(vaddr
);
166 mutex_unlock(&us122l
->mutex
);
172 mutex_unlock(&us122l
->mutex
);
173 return VM_FAULT_SIGBUS
;
176 static void usb_stream_hwdep_vm_close(struct vm_area_struct
*area
)
178 struct us122l
*us122l
= area
->vm_private_data
;
179 atomic_dec(&us122l
->mmap_count
);
180 snd_printdd(KERN_DEBUG
"%i\n", atomic_read(&us122l
->mmap_count
));
183 static const struct vm_operations_struct usb_stream_hwdep_vm_ops
= {
184 .open
= usb_stream_hwdep_vm_open
,
185 .fault
= usb_stream_hwdep_vm_fault
,
186 .close
= usb_stream_hwdep_vm_close
,
190 static int usb_stream_hwdep_open(struct snd_hwdep
*hw
, struct file
*file
)
192 struct us122l
*us122l
= hw
->private_data
;
193 struct usb_interface
*iface
;
194 snd_printdd(KERN_DEBUG
"%p %p\n", hw
, file
);
199 us122l
->first
= file
;
201 if (us122l
->dev
->descriptor
.idProduct
== USB_ID_US144
||
202 us122l
->dev
->descriptor
.idProduct
== USB_ID_US144MKII
) {
203 iface
= usb_ifnum_to_if(us122l
->dev
, 0);
204 usb_autopm_get_interface(iface
);
206 iface
= usb_ifnum_to_if(us122l
->dev
, 1);
207 usb_autopm_get_interface(iface
);
211 static int usb_stream_hwdep_release(struct snd_hwdep
*hw
, struct file
*file
)
213 struct us122l
*us122l
= hw
->private_data
;
214 struct usb_interface
*iface
;
215 snd_printdd(KERN_DEBUG
"%p %p\n", hw
, file
);
217 if (us122l
->dev
->descriptor
.idProduct
== USB_ID_US144
||
218 us122l
->dev
->descriptor
.idProduct
== USB_ID_US144MKII
) {
219 iface
= usb_ifnum_to_if(us122l
->dev
, 0);
220 usb_autopm_put_interface(iface
);
222 iface
= usb_ifnum_to_if(us122l
->dev
, 1);
223 usb_autopm_put_interface(iface
);
224 if (us122l
->first
== file
)
225 us122l
->first
= NULL
;
226 mutex_lock(&us122l
->mutex
);
227 if (us122l
->master
== file
)
228 us122l
->master
= us122l
->slave
;
230 us122l
->slave
= NULL
;
231 mutex_unlock(&us122l
->mutex
);
235 static int usb_stream_hwdep_mmap(struct snd_hwdep
*hw
,
236 struct file
*filp
, struct vm_area_struct
*area
)
238 unsigned long size
= area
->vm_end
- area
->vm_start
;
239 struct us122l
*us122l
= hw
->private_data
;
240 unsigned long offset
;
241 struct usb_stream
*s
;
245 offset
= area
->vm_pgoff
<< PAGE_SHIFT
;
246 mutex_lock(&us122l
->mutex
);
248 read
= offset
< s
->read_size
;
249 if (read
&& area
->vm_flags
& VM_WRITE
) {
253 snd_printdd(KERN_DEBUG
"%lu %u\n", size
,
254 read
? s
->read_size
: s
->write_size
);
255 /* if userspace tries to mmap beyond end of our buffer, fail */
256 if (size
> PAGE_ALIGN(read
? s
->read_size
: s
->write_size
)) {
257 snd_printk(KERN_WARNING
"%lu > %u\n", size
,
258 read
? s
->read_size
: s
->write_size
);
263 area
->vm_ops
= &usb_stream_hwdep_vm_ops
;
264 area
->vm_flags
|= VM_RESERVED
;
265 area
->vm_private_data
= us122l
;
266 atomic_inc(&us122l
->mmap_count
);
268 mutex_unlock(&us122l
->mutex
);
272 static unsigned int usb_stream_hwdep_poll(struct snd_hwdep
*hw
,
273 struct file
*file
, poll_table
*wait
)
275 struct us122l
*us122l
= hw
->private_data
;
276 struct usb_stream
*s
= us122l
->sk
.s
;
280 poll_wait(file
, &us122l
->sk
.sleep
, wait
);
283 case usb_stream_ready
:
284 if (us122l
->first
== file
)
285 polled
= &s
->periods_polled
;
287 polled
= &us122l
->second_periods_polled
;
288 if (*polled
!= s
->periods_done
) {
289 *polled
= s
->periods_done
;
290 mask
= POLLIN
| POLLOUT
| POLLWRNORM
;
297 mask
= POLLIN
| POLLOUT
| POLLWRNORM
| POLLERR
;
303 static void us122l_stop(struct us122l
*us122l
)
306 list_for_each(p
, &us122l
->midi_list
)
307 snd_usbmidi_input_stop(p
);
309 usb_stream_stop(&us122l
->sk
);
310 usb_stream_free(&us122l
->sk
);
313 static int us122l_set_sample_rate(struct usb_device
*dev
, int rate
)
315 unsigned int ep
= 0x81;
316 unsigned char data
[3];
321 data
[2] = rate
>> 16;
322 err
= us122l_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), UAC_SET_CUR
,
323 USB_TYPE_CLASS
|USB_RECIP_ENDPOINT
|USB_DIR_OUT
,
324 UAC_EP_CS_ATTR_SAMPLE_RATE
<< 8, ep
, data
, 3, 1000);
326 snd_printk(KERN_ERR
"%d: cannot set freq %d to ep 0x%x\n",
327 dev
->devnum
, rate
, ep
);
331 static bool us122l_start(struct us122l
*us122l
,
332 unsigned rate
, unsigned period_frames
)
336 unsigned use_packsize
= 0;
337 bool success
= false;
339 if (us122l
->dev
->speed
== USB_SPEED_HIGH
) {
340 /* The us-122l's descriptor defaults to iso max_packsize 78,
341 which isn't needed for samplerates <= 48000.
342 Lets save some memory:
356 if (!usb_stream_new(&us122l
->sk
, us122l
->dev
, 1, 2,
357 rate
, use_packsize
, period_frames
, 6))
360 err
= us122l_set_sample_rate(us122l
->dev
, rate
);
363 snd_printk(KERN_ERR
"us122l_set_sample_rate error \n");
366 err
= usb_stream_start(&us122l
->sk
);
369 snd_printk(KERN_ERR
"us122l_start error %i \n", err
);
372 list_for_each(p
, &us122l
->midi_list
)
373 snd_usbmidi_input_start(p
);
379 static int usb_stream_hwdep_ioctl(struct snd_hwdep
*hw
, struct file
*file
,
380 unsigned cmd
, unsigned long arg
)
382 struct usb_stream_config
*cfg
;
383 struct us122l
*us122l
= hw
->private_data
;
384 unsigned min_period_frames
;
388 if (cmd
!= SNDRV_USB_STREAM_IOCTL_SET_PARAMS
)
391 cfg
= memdup_user((void *)arg
, sizeof(*cfg
));
395 if (cfg
->version
!= USB_STREAM_INTERFACE_VERSION
) {
399 high_speed
= us122l
->dev
->speed
== USB_SPEED_HIGH
;
400 if ((cfg
->sample_rate
!= 44100 && cfg
->sample_rate
!= 48000 &&
402 (cfg
->sample_rate
!= 88200 && cfg
->sample_rate
!= 96000))) ||
403 cfg
->frame_size
!= 6 ||
404 cfg
->period_frames
> 0x3000) {
408 switch (cfg
->sample_rate
) {
410 min_period_frames
= 48;
413 min_period_frames
= 52;
416 min_period_frames
= 104;
420 min_period_frames
<<= 1;
421 if (cfg
->period_frames
< min_period_frames
) {
426 snd_power_wait(hw
->card
, SNDRV_CTL_POWER_D0
);
428 mutex_lock(&us122l
->mutex
);
430 us122l
->master
= file
;
431 else if (us122l
->master
!= file
) {
432 if (memcmp(cfg
, &us122l
->sk
.s
->cfg
, sizeof(*cfg
))) {
436 us122l
->slave
= file
;
439 memcmp(cfg
, &us122l
->sk
.s
->cfg
, sizeof(*cfg
)) ||
440 us122l
->sk
.s
->state
== usb_stream_xrun
) {
442 if (!us122l_start(us122l
, cfg
->sample_rate
, cfg
->period_frames
))
448 mutex_unlock(&us122l
->mutex
);
454 #define SND_USB_STREAM_ID "USB STREAM"
455 static int usb_stream_hwdep_new(struct snd_card
*card
)
458 struct snd_hwdep
*hw
;
459 struct usb_device
*dev
= US122L(card
)->dev
;
461 err
= snd_hwdep_new(card
, SND_USB_STREAM_ID
, 0, &hw
);
465 hw
->iface
= SNDRV_HWDEP_IFACE_USB_STREAM
;
466 hw
->private_data
= US122L(card
);
467 hw
->ops
.open
= usb_stream_hwdep_open
;
468 hw
->ops
.release
= usb_stream_hwdep_release
;
469 hw
->ops
.ioctl
= usb_stream_hwdep_ioctl
;
470 hw
->ops
.ioctl_compat
= usb_stream_hwdep_ioctl
;
471 hw
->ops
.mmap
= usb_stream_hwdep_mmap
;
472 hw
->ops
.poll
= usb_stream_hwdep_poll
;
474 sprintf(hw
->name
, "/proc/bus/usb/%03d/%03d/hwdeppcm",
475 dev
->bus
->busnum
, dev
->devnum
);
480 static bool us122l_create_card(struct snd_card
*card
)
483 struct us122l
*us122l
= US122L(card
);
485 if (us122l
->dev
->descriptor
.idProduct
== USB_ID_US144
||
486 us122l
->dev
->descriptor
.idProduct
== USB_ID_US144MKII
) {
487 err
= usb_set_interface(us122l
->dev
, 0, 1);
489 snd_printk(KERN_ERR
"usb_set_interface error \n");
493 err
= usb_set_interface(us122l
->dev
, 1, 1);
495 snd_printk(KERN_ERR
"usb_set_interface error \n");
499 pt_info_set(us122l
->dev
, 0x11);
500 pt_info_set(us122l
->dev
, 0x10);
502 if (!us122l_start(us122l
, 44100, 256))
505 if (us122l
->dev
->descriptor
.idProduct
== USB_ID_US144
||
506 us122l
->dev
->descriptor
.idProduct
== USB_ID_US144MKII
)
507 err
= us144_create_usbmidi(card
);
509 err
= us122l_create_usbmidi(card
);
511 snd_printk(KERN_ERR
"us122l_create_usbmidi error %i \n", err
);
515 err
= usb_stream_hwdep_new(card
);
517 /* release the midi resources */
519 list_for_each(p
, &us122l
->midi_list
)
520 snd_usbmidi_disconnect(p
);
528 static void snd_us122l_free(struct snd_card
*card
)
530 struct us122l
*us122l
= US122L(card
);
531 int index
= us122l
->card_index
;
532 if (index
>= 0 && index
< SNDRV_CARDS
)
533 snd_us122l_card_used
[index
] = 0;
536 static int usx2y_create_card(struct usb_device
*device
, struct snd_card
**cardp
)
539 struct snd_card
*card
;
542 for (dev
= 0; dev
< SNDRV_CARDS
; ++dev
)
543 if (enable
[dev
] && !snd_us122l_card_used
[dev
])
545 if (dev
>= SNDRV_CARDS
)
547 err
= snd_card_create(index
[dev
], id
[dev
], THIS_MODULE
,
548 sizeof(struct us122l
), &card
);
551 snd_us122l_card_used
[US122L(card
)->card_index
= dev
] = 1;
552 card
->private_free
= snd_us122l_free
;
553 US122L(card
)->dev
= device
;
554 mutex_init(&US122L(card
)->mutex
);
555 init_waitqueue_head(&US122L(card
)->sk
.sleep
);
556 INIT_LIST_HEAD(&US122L(card
)->midi_list
);
557 strcpy(card
->driver
, "USB "NAME_ALLCAPS
"");
558 sprintf(card
->shortname
, "TASCAM "NAME_ALLCAPS
"");
559 sprintf(card
->longname
, "%s (%x:%x if %d at %03d/%03d)",
561 le16_to_cpu(device
->descriptor
.idVendor
),
562 le16_to_cpu(device
->descriptor
.idProduct
),
564 US122L(card
)->dev
->bus
->busnum
,
565 US122L(card
)->dev
->devnum
571 static int us122l_usb_probe(struct usb_interface
*intf
,
572 const struct usb_device_id
*device_id
,
573 struct snd_card
**cardp
)
575 struct usb_device
*device
= interface_to_usbdev(intf
);
576 struct snd_card
*card
;
579 err
= usx2y_create_card(device
, &card
);
583 snd_card_set_dev(card
, &intf
->dev
);
584 if (!us122l_create_card(card
)) {
589 err
= snd_card_register(card
);
595 usb_get_intf(usb_ifnum_to_if(device
, 0));
601 static int snd_us122l_probe(struct usb_interface
*intf
,
602 const struct usb_device_id
*id
)
604 struct usb_device
*device
= interface_to_usbdev(intf
);
605 struct snd_card
*card
;
608 if ((device
->descriptor
.idProduct
== USB_ID_US144
||
609 device
->descriptor
.idProduct
== USB_ID_US144MKII
)
610 && device
->speed
== USB_SPEED_HIGH
) {
611 snd_printk(KERN_ERR
"disable ehci-hcd to run US-144 \n");
615 snd_printdd(KERN_DEBUG
"%p:%i\n",
616 intf
, intf
->cur_altsetting
->desc
.bInterfaceNumber
);
617 if (intf
->cur_altsetting
->desc
.bInterfaceNumber
!= 1)
620 err
= us122l_usb_probe(usb_get_intf(intf
), id
, &card
);
626 usb_set_intfdata(intf
, card
);
630 static void snd_us122l_disconnect(struct usb_interface
*intf
)
632 struct snd_card
*card
;
633 struct us122l
*us122l
;
636 card
= usb_get_intfdata(intf
);
640 snd_card_disconnect(card
);
642 us122l
= US122L(card
);
643 mutex_lock(&us122l
->mutex
);
645 mutex_unlock(&us122l
->mutex
);
647 /* release the midi resources */
648 list_for_each(p
, &us122l
->midi_list
) {
649 snd_usbmidi_disconnect(p
);
652 usb_put_intf(usb_ifnum_to_if(us122l
->dev
, 0));
653 usb_put_intf(usb_ifnum_to_if(us122l
->dev
, 1));
654 usb_put_dev(us122l
->dev
);
656 while (atomic_read(&us122l
->mmap_count
))
662 static int snd_us122l_suspend(struct usb_interface
*intf
, pm_message_t message
)
664 struct snd_card
*card
;
665 struct us122l
*us122l
;
668 card
= usb_get_intfdata(intf
);
671 snd_power_change_state(card
, SNDRV_CTL_POWER_D3hot
);
673 us122l
= US122L(card
);
677 list_for_each(p
, &us122l
->midi_list
)
678 snd_usbmidi_input_stop(p
);
680 mutex_lock(&us122l
->mutex
);
681 usb_stream_stop(&us122l
->sk
);
682 mutex_unlock(&us122l
->mutex
);
687 static int snd_us122l_resume(struct usb_interface
*intf
)
689 struct snd_card
*card
;
690 struct us122l
*us122l
;
694 card
= usb_get_intfdata(intf
);
698 us122l
= US122L(card
);
702 mutex_lock(&us122l
->mutex
);
703 /* needed, doesn't restart without: */
704 if (us122l
->dev
->descriptor
.idProduct
== USB_ID_US144
||
705 us122l
->dev
->descriptor
.idProduct
== USB_ID_US144MKII
) {
706 err
= usb_set_interface(us122l
->dev
, 0, 1);
708 snd_printk(KERN_ERR
"usb_set_interface error \n");
712 err
= usb_set_interface(us122l
->dev
, 1, 1);
714 snd_printk(KERN_ERR
"usb_set_interface error \n");
718 pt_info_set(us122l
->dev
, 0x11);
719 pt_info_set(us122l
->dev
, 0x10);
721 err
= us122l_set_sample_rate(us122l
->dev
,
722 us122l
->sk
.s
->cfg
.sample_rate
);
724 snd_printk(KERN_ERR
"us122l_set_sample_rate error \n");
727 err
= usb_stream_start(&us122l
->sk
);
731 list_for_each(p
, &us122l
->midi_list
)
732 snd_usbmidi_input_start(p
);
734 mutex_unlock(&us122l
->mutex
);
735 snd_power_change_state(card
, SNDRV_CTL_POWER_D0
);
739 static struct usb_device_id snd_us122l_usb_id_table
[] = {
741 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
743 .idProduct
= USB_ID_US122L
745 { /* US-144 only works at USB1.1! Disable module ehci-hcd. */
746 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
748 .idProduct
= USB_ID_US144
751 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
753 .idProduct
= USB_ID_US122MKII
756 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
758 .idProduct
= USB_ID_US144MKII
763 MODULE_DEVICE_TABLE(usb
, snd_us122l_usb_id_table
);
764 static struct usb_driver snd_us122l_usb_driver
= {
765 .name
= "snd-usb-us122l",
766 .probe
= snd_us122l_probe
,
767 .disconnect
= snd_us122l_disconnect
,
768 .suspend
= snd_us122l_suspend
,
769 .resume
= snd_us122l_resume
,
770 .reset_resume
= snd_us122l_resume
,
771 .id_table
= snd_us122l_usb_id_table
,
772 .supports_autosuspend
= 1
776 static int __init
snd_us122l_module_init(void)
778 return usb_register(&snd_us122l_usb_driver
);
781 static void __exit
snd_us122l_module_exit(void)
783 usb_deregister(&snd_us122l_usb_driver
);
786 module_init(snd_us122l_module_init
)
787 module_exit(snd_us122l_module_exit
)