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 <sound/core.h>
20 #include <sound/hwdep.h>
21 #include <sound/pcm.h>
22 #include <sound/initval.h>
23 #define MODNAME "US122L"
24 #include "usb_stream.c"
25 #include "../usbaudio.h"
28 MODULE_AUTHOR("Karsten Wiese <fzu@wemgehoertderstaat.de>");
29 MODULE_DESCRIPTION("TASCAM "NAME_ALLCAPS
" Version 0.5");
30 MODULE_LICENSE("GPL");
32 static int index
[SNDRV_CARDS
] = SNDRV_DEFAULT_IDX
; /* Index 0-max */
33 static char *id
[SNDRV_CARDS
] = SNDRV_DEFAULT_STR
; /* Id for this card */
34 /* Enable this card */
35 static int enable
[SNDRV_CARDS
] = SNDRV_DEFAULT_ENABLE_PNP
;
37 module_param_array(index
, int, NULL
, 0444);
38 MODULE_PARM_DESC(index
, "Index value for "NAME_ALLCAPS
".");
39 module_param_array(id
, charp
, NULL
, 0444);
40 MODULE_PARM_DESC(id
, "ID string for "NAME_ALLCAPS
".");
41 module_param_array(enable
, bool, NULL
, 0444);
42 MODULE_PARM_DESC(enable
, "Enable "NAME_ALLCAPS
".");
44 static int snd_us122l_card_used
[SNDRV_CARDS
];
47 static int us122l_create_usbmidi(struct snd_card
*card
)
49 static struct snd_usb_midi_endpoint_info quirk_data
= {
55 static struct snd_usb_audio_quirk quirk
= {
56 .vendor_name
= "US122L",
57 .product_name
= NAME_ALLCAPS
,
59 .type
= QUIRK_MIDI_US122L
,
62 struct usb_device
*dev
= US122L(card
)->dev
;
63 struct usb_interface
*iface
= usb_ifnum_to_if(dev
, 1);
65 return snd_usbmidi_create(card
, iface
,
66 &US122L(card
)->midi_list
, &quirk
);
69 static int us144_create_usbmidi(struct snd_card
*card
)
71 static struct snd_usb_midi_endpoint_info quirk_data
= {
77 static struct snd_usb_audio_quirk quirk
= {
78 .vendor_name
= "US144",
79 .product_name
= NAME_ALLCAPS
,
81 .type
= QUIRK_MIDI_US122L
,
84 struct usb_device
*dev
= US122L(card
)->dev
;
85 struct usb_interface
*iface
= usb_ifnum_to_if(dev
, 0);
87 return snd_usbmidi_create(card
, iface
,
88 &US122L(card
)->midi_list
, &quirk
);
92 * Wrapper for usb_control_msg().
93 * Allocates a temp buffer to prevent dmaing from/to the stack.
95 static int us122l_ctl_msg(struct usb_device
*dev
, unsigned int pipe
,
96 __u8 request
, __u8 requesttype
,
97 __u16 value
, __u16 index
, void *data
,
98 __u16 size
, int timeout
)
104 buf
= kmemdup(data
, size
, GFP_KERNEL
);
108 err
= usb_control_msg(dev
, pipe
, request
, requesttype
,
109 value
, index
, buf
, size
, timeout
);
111 memcpy(data
, buf
, size
);
117 static void pt_info_set(struct usb_device
*dev
, u8 v
)
121 ret
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
123 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
124 v
, 0, NULL
, 0, 1000);
125 snd_printdd(KERN_DEBUG
"%i\n", ret
);
128 static void usb_stream_hwdep_vm_open(struct vm_area_struct
*area
)
130 struct us122l
*us122l
= area
->vm_private_data
;
131 atomic_inc(&us122l
->mmap_count
);
132 snd_printdd(KERN_DEBUG
"%i\n", atomic_read(&us122l
->mmap_count
));
135 static int usb_stream_hwdep_vm_fault(struct vm_area_struct
*area
,
136 struct vm_fault
*vmf
)
138 unsigned long offset
;
141 struct us122l
*us122l
= area
->vm_private_data
;
142 struct usb_stream
*s
;
144 mutex_lock(&us122l
->mutex
);
149 offset
= vmf
->pgoff
<< PAGE_SHIFT
;
150 if (offset
< PAGE_ALIGN(s
->read_size
))
151 vaddr
= (char *)s
+ offset
;
153 offset
-= PAGE_ALIGN(s
->read_size
);
154 if (offset
>= PAGE_ALIGN(s
->write_size
))
157 vaddr
= us122l
->sk
.write_page
+ offset
;
159 page
= virt_to_page(vaddr
);
162 mutex_unlock(&us122l
->mutex
);
168 mutex_unlock(&us122l
->mutex
);
169 return VM_FAULT_SIGBUS
;
172 static void usb_stream_hwdep_vm_close(struct vm_area_struct
*area
)
174 struct us122l
*us122l
= area
->vm_private_data
;
175 atomic_dec(&us122l
->mmap_count
);
176 snd_printdd(KERN_DEBUG
"%i\n", atomic_read(&us122l
->mmap_count
));
179 static const struct vm_operations_struct usb_stream_hwdep_vm_ops
= {
180 .open
= usb_stream_hwdep_vm_open
,
181 .fault
= usb_stream_hwdep_vm_fault
,
182 .close
= usb_stream_hwdep_vm_close
,
186 static int usb_stream_hwdep_open(struct snd_hwdep
*hw
, struct file
*file
)
188 struct us122l
*us122l
= hw
->private_data
;
189 struct usb_interface
*iface
;
190 snd_printdd(KERN_DEBUG
"%p %p\n", hw
, file
);
195 us122l
->first
= file
;
197 if (us122l
->dev
->descriptor
.idProduct
== USB_ID_US144
||
198 us122l
->dev
->descriptor
.idProduct
== USB_ID_US144MKII
) {
199 iface
= usb_ifnum_to_if(us122l
->dev
, 0);
200 usb_autopm_get_interface(iface
);
202 iface
= usb_ifnum_to_if(us122l
->dev
, 1);
203 usb_autopm_get_interface(iface
);
207 static int usb_stream_hwdep_release(struct snd_hwdep
*hw
, struct file
*file
)
209 struct us122l
*us122l
= hw
->private_data
;
210 struct usb_interface
*iface
;
211 snd_printdd(KERN_DEBUG
"%p %p\n", hw
, file
);
213 if (us122l
->dev
->descriptor
.idProduct
== USB_ID_US144
||
214 us122l
->dev
->descriptor
.idProduct
== USB_ID_US144MKII
) {
215 iface
= usb_ifnum_to_if(us122l
->dev
, 0);
216 usb_autopm_put_interface(iface
);
218 iface
= usb_ifnum_to_if(us122l
->dev
, 1);
219 usb_autopm_put_interface(iface
);
220 if (us122l
->first
== file
)
221 us122l
->first
= NULL
;
222 mutex_lock(&us122l
->mutex
);
223 if (us122l
->master
== file
)
224 us122l
->master
= us122l
->slave
;
226 us122l
->slave
= NULL
;
227 mutex_unlock(&us122l
->mutex
);
231 static int usb_stream_hwdep_mmap(struct snd_hwdep
*hw
,
232 struct file
*filp
, struct vm_area_struct
*area
)
234 unsigned long size
= area
->vm_end
- area
->vm_start
;
235 struct us122l
*us122l
= hw
->private_data
;
236 unsigned long offset
;
237 struct usb_stream
*s
;
241 offset
= area
->vm_pgoff
<< PAGE_SHIFT
;
242 mutex_lock(&us122l
->mutex
);
244 read
= offset
< s
->read_size
;
245 if (read
&& area
->vm_flags
& VM_WRITE
) {
249 snd_printdd(KERN_DEBUG
"%lu %u\n", size
,
250 read
? s
->read_size
: s
->write_size
);
251 /* if userspace tries to mmap beyond end of our buffer, fail */
252 if (size
> PAGE_ALIGN(read
? s
->read_size
: s
->write_size
)) {
253 snd_printk(KERN_WARNING
"%lu > %u\n", size
,
254 read
? s
->read_size
: s
->write_size
);
259 area
->vm_ops
= &usb_stream_hwdep_vm_ops
;
260 area
->vm_flags
|= VM_RESERVED
;
261 area
->vm_private_data
= us122l
;
262 atomic_inc(&us122l
->mmap_count
);
264 mutex_unlock(&us122l
->mutex
);
268 static unsigned int usb_stream_hwdep_poll(struct snd_hwdep
*hw
,
269 struct file
*file
, poll_table
*wait
)
271 struct us122l
*us122l
= hw
->private_data
;
272 struct usb_stream
*s
= us122l
->sk
.s
;
276 poll_wait(file
, &us122l
->sk
.sleep
, wait
);
279 case usb_stream_ready
:
280 if (us122l
->first
== file
)
281 polled
= &s
->periods_polled
;
283 polled
= &us122l
->second_periods_polled
;
284 if (*polled
!= s
->periods_done
) {
285 *polled
= s
->periods_done
;
286 mask
= POLLIN
| POLLOUT
| POLLWRNORM
;
293 mask
= POLLIN
| POLLOUT
| POLLWRNORM
| POLLERR
;
299 static void us122l_stop(struct us122l
*us122l
)
302 list_for_each(p
, &us122l
->midi_list
)
303 snd_usbmidi_input_stop(p
);
305 usb_stream_stop(&us122l
->sk
);
306 usb_stream_free(&us122l
->sk
);
309 static int us122l_set_sample_rate(struct usb_device
*dev
, int rate
)
311 unsigned int ep
= 0x81;
312 unsigned char data
[3];
317 data
[2] = rate
>> 16;
318 err
= us122l_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), SET_CUR
,
319 USB_TYPE_CLASS
|USB_RECIP_ENDPOINT
|USB_DIR_OUT
,
320 SAMPLING_FREQ_CONTROL
<< 8, ep
, data
, 3, 1000);
322 snd_printk(KERN_ERR
"%d: cannot set freq %d to ep 0x%x\n",
323 dev
->devnum
, rate
, ep
);
327 static bool us122l_start(struct us122l
*us122l
,
328 unsigned rate
, unsigned period_frames
)
332 unsigned use_packsize
= 0;
333 bool success
= false;
335 if (us122l
->dev
->speed
== USB_SPEED_HIGH
) {
336 /* The us-122l's descriptor defaults to iso max_packsize 78,
337 which isn't needed for samplerates <= 48000.
338 Lets save some memory:
352 if (!usb_stream_new(&us122l
->sk
, us122l
->dev
, 1, 2,
353 rate
, use_packsize
, period_frames
, 6))
356 err
= us122l_set_sample_rate(us122l
->dev
, rate
);
359 snd_printk(KERN_ERR
"us122l_set_sample_rate error \n");
362 err
= usb_stream_start(&us122l
->sk
);
365 snd_printk(KERN_ERR
"us122l_start error %i \n", err
);
368 list_for_each(p
, &us122l
->midi_list
)
369 snd_usbmidi_input_start(p
);
375 static int usb_stream_hwdep_ioctl(struct snd_hwdep
*hw
, struct file
*file
,
376 unsigned cmd
, unsigned long arg
)
378 struct usb_stream_config
*cfg
;
379 struct us122l
*us122l
= hw
->private_data
;
380 unsigned min_period_frames
;
384 if (cmd
!= SNDRV_USB_STREAM_IOCTL_SET_PARAMS
)
387 cfg
= memdup_user((void *)arg
, sizeof(*cfg
));
391 if (cfg
->version
!= USB_STREAM_INTERFACE_VERSION
) {
395 high_speed
= us122l
->dev
->speed
== USB_SPEED_HIGH
;
396 if ((cfg
->sample_rate
!= 44100 && cfg
->sample_rate
!= 48000 &&
398 (cfg
->sample_rate
!= 88200 && cfg
->sample_rate
!= 96000))) ||
399 cfg
->frame_size
!= 6 ||
400 cfg
->period_frames
> 0x3000) {
404 switch (cfg
->sample_rate
) {
406 min_period_frames
= 48;
409 min_period_frames
= 52;
412 min_period_frames
= 104;
416 min_period_frames
<<= 1;
417 if (cfg
->period_frames
< min_period_frames
) {
422 snd_power_wait(hw
->card
, SNDRV_CTL_POWER_D0
);
424 mutex_lock(&us122l
->mutex
);
426 us122l
->master
= file
;
427 else if (us122l
->master
!= file
) {
428 if (memcmp(cfg
, &us122l
->sk
.s
->cfg
, sizeof(*cfg
))) {
432 us122l
->slave
= file
;
435 memcmp(cfg
, &us122l
->sk
.s
->cfg
, sizeof(*cfg
)) ||
436 us122l
->sk
.s
->state
== usb_stream_xrun
) {
438 if (!us122l_start(us122l
, cfg
->sample_rate
, cfg
->period_frames
))
444 mutex_unlock(&us122l
->mutex
);
450 #define SND_USB_STREAM_ID "USB STREAM"
451 static int usb_stream_hwdep_new(struct snd_card
*card
)
454 struct snd_hwdep
*hw
;
455 struct usb_device
*dev
= US122L(card
)->dev
;
457 err
= snd_hwdep_new(card
, SND_USB_STREAM_ID
, 0, &hw
);
461 hw
->iface
= SNDRV_HWDEP_IFACE_USB_STREAM
;
462 hw
->private_data
= US122L(card
);
463 hw
->ops
.open
= usb_stream_hwdep_open
;
464 hw
->ops
.release
= usb_stream_hwdep_release
;
465 hw
->ops
.ioctl
= usb_stream_hwdep_ioctl
;
466 hw
->ops
.ioctl_compat
= usb_stream_hwdep_ioctl
;
467 hw
->ops
.mmap
= usb_stream_hwdep_mmap
;
468 hw
->ops
.poll
= usb_stream_hwdep_poll
;
470 sprintf(hw
->name
, "/proc/bus/usb/%03d/%03d/hwdeppcm",
471 dev
->bus
->busnum
, dev
->devnum
);
476 static bool us122l_create_card(struct snd_card
*card
)
479 struct us122l
*us122l
= US122L(card
);
481 if (us122l
->dev
->descriptor
.idProduct
== USB_ID_US144
||
482 us122l
->dev
->descriptor
.idProduct
== USB_ID_US144MKII
) {
483 err
= usb_set_interface(us122l
->dev
, 0, 1);
485 snd_printk(KERN_ERR
"usb_set_interface error \n");
489 err
= usb_set_interface(us122l
->dev
, 1, 1);
491 snd_printk(KERN_ERR
"usb_set_interface error \n");
495 pt_info_set(us122l
->dev
, 0x11);
496 pt_info_set(us122l
->dev
, 0x10);
498 if (!us122l_start(us122l
, 44100, 256))
501 if (us122l
->dev
->descriptor
.idProduct
== USB_ID_US144
||
502 us122l
->dev
->descriptor
.idProduct
== USB_ID_US144MKII
)
503 err
= us144_create_usbmidi(card
);
505 err
= us122l_create_usbmidi(card
);
507 snd_printk(KERN_ERR
"us122l_create_usbmidi error %i \n", err
);
511 err
= usb_stream_hwdep_new(card
);
513 /* release the midi resources */
515 list_for_each(p
, &us122l
->midi_list
)
516 snd_usbmidi_disconnect(p
);
524 static void snd_us122l_free(struct snd_card
*card
)
526 struct us122l
*us122l
= US122L(card
);
527 int index
= us122l
->card_index
;
528 if (index
>= 0 && index
< SNDRV_CARDS
)
529 snd_us122l_card_used
[index
] = 0;
532 static int usx2y_create_card(struct usb_device
*device
, struct snd_card
**cardp
)
535 struct snd_card
*card
;
538 for (dev
= 0; dev
< SNDRV_CARDS
; ++dev
)
539 if (enable
[dev
] && !snd_us122l_card_used
[dev
])
541 if (dev
>= SNDRV_CARDS
)
543 err
= snd_card_create(index
[dev
], id
[dev
], THIS_MODULE
,
544 sizeof(struct us122l
), &card
);
547 snd_us122l_card_used
[US122L(card
)->card_index
= dev
] = 1;
548 card
->private_free
= snd_us122l_free
;
549 US122L(card
)->dev
= device
;
550 mutex_init(&US122L(card
)->mutex
);
551 init_waitqueue_head(&US122L(card
)->sk
.sleep
);
552 INIT_LIST_HEAD(&US122L(card
)->midi_list
);
553 strcpy(card
->driver
, "USB "NAME_ALLCAPS
"");
554 sprintf(card
->shortname
, "TASCAM "NAME_ALLCAPS
"");
555 sprintf(card
->longname
, "%s (%x:%x if %d at %03d/%03d)",
557 le16_to_cpu(device
->descriptor
.idVendor
),
558 le16_to_cpu(device
->descriptor
.idProduct
),
560 US122L(card
)->dev
->bus
->busnum
,
561 US122L(card
)->dev
->devnum
567 static int us122l_usb_probe(struct usb_interface
*intf
,
568 const struct usb_device_id
*device_id
,
569 struct snd_card
**cardp
)
571 struct usb_device
*device
= interface_to_usbdev(intf
);
572 struct snd_card
*card
;
575 err
= usx2y_create_card(device
, &card
);
579 snd_card_set_dev(card
, &intf
->dev
);
580 if (!us122l_create_card(card
)) {
585 err
= snd_card_register(card
);
591 usb_get_intf(usb_ifnum_to_if(device
, 0));
597 static int snd_us122l_probe(struct usb_interface
*intf
,
598 const struct usb_device_id
*id
)
600 struct usb_device
*device
= interface_to_usbdev(intf
);
601 struct snd_card
*card
;
604 if ((device
->descriptor
.idProduct
== USB_ID_US144
||
605 device
->descriptor
.idProduct
== USB_ID_US144MKII
)
606 && device
->speed
== USB_SPEED_HIGH
) {
607 snd_printk(KERN_ERR
"disable ehci-hcd to run US-144 \n");
611 snd_printdd(KERN_DEBUG
"%p:%i\n",
612 intf
, intf
->cur_altsetting
->desc
.bInterfaceNumber
);
613 if (intf
->cur_altsetting
->desc
.bInterfaceNumber
!= 1)
616 err
= us122l_usb_probe(usb_get_intf(intf
), id
, &card
);
622 usb_set_intfdata(intf
, card
);
626 static void snd_us122l_disconnect(struct usb_interface
*intf
)
628 struct snd_card
*card
;
629 struct us122l
*us122l
;
632 card
= usb_get_intfdata(intf
);
636 snd_card_disconnect(card
);
638 us122l
= US122L(card
);
639 mutex_lock(&us122l
->mutex
);
641 mutex_unlock(&us122l
->mutex
);
643 /* release the midi resources */
644 list_for_each(p
, &us122l
->midi_list
) {
645 snd_usbmidi_disconnect(p
);
648 usb_put_intf(usb_ifnum_to_if(us122l
->dev
, 0));
649 usb_put_intf(usb_ifnum_to_if(us122l
->dev
, 1));
650 usb_put_dev(us122l
->dev
);
652 while (atomic_read(&us122l
->mmap_count
))
658 static int snd_us122l_suspend(struct usb_interface
*intf
, pm_message_t message
)
660 struct snd_card
*card
;
661 struct us122l
*us122l
;
664 card
= usb_get_intfdata(intf
);
667 snd_power_change_state(card
, SNDRV_CTL_POWER_D3hot
);
669 us122l
= US122L(card
);
673 list_for_each(p
, &us122l
->midi_list
)
674 snd_usbmidi_input_stop(p
);
676 mutex_lock(&us122l
->mutex
);
677 usb_stream_stop(&us122l
->sk
);
678 mutex_unlock(&us122l
->mutex
);
683 static int snd_us122l_resume(struct usb_interface
*intf
)
685 struct snd_card
*card
;
686 struct us122l
*us122l
;
690 card
= usb_get_intfdata(intf
);
694 us122l
= US122L(card
);
698 mutex_lock(&us122l
->mutex
);
699 /* needed, doesn't restart without: */
700 if (us122l
->dev
->descriptor
.idProduct
== USB_ID_US144
||
701 us122l
->dev
->descriptor
.idProduct
== USB_ID_US144MKII
) {
702 err
= usb_set_interface(us122l
->dev
, 0, 1);
704 snd_printk(KERN_ERR
"usb_set_interface error \n");
708 err
= usb_set_interface(us122l
->dev
, 1, 1);
710 snd_printk(KERN_ERR
"usb_set_interface error \n");
714 pt_info_set(us122l
->dev
, 0x11);
715 pt_info_set(us122l
->dev
, 0x10);
717 err
= us122l_set_sample_rate(us122l
->dev
,
718 us122l
->sk
.s
->cfg
.sample_rate
);
720 snd_printk(KERN_ERR
"us122l_set_sample_rate error \n");
723 err
= usb_stream_start(&us122l
->sk
);
727 list_for_each(p
, &us122l
->midi_list
)
728 snd_usbmidi_input_start(p
);
730 mutex_unlock(&us122l
->mutex
);
731 snd_power_change_state(card
, SNDRV_CTL_POWER_D0
);
735 static struct usb_device_id snd_us122l_usb_id_table
[] = {
737 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
739 .idProduct
= USB_ID_US122L
741 { /* US-144 only works at USB1.1! Disable module ehci-hcd. */
742 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
744 .idProduct
= USB_ID_US144
747 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
749 .idProduct
= USB_ID_US122MKII
752 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
754 .idProduct
= USB_ID_US144MKII
759 MODULE_DEVICE_TABLE(usb
, snd_us122l_usb_id_table
);
760 static struct usb_driver snd_us122l_usb_driver
= {
761 .name
= "snd-usb-us122l",
762 .probe
= snd_us122l_probe
,
763 .disconnect
= snd_us122l_disconnect
,
764 .suspend
= snd_us122l_suspend
,
765 .resume
= snd_us122l_resume
,
766 .reset_resume
= snd_us122l_resume
,
767 .id_table
= snd_us122l_usb_id_table
,
768 .supports_autosuspend
= 1
772 static int __init
snd_us122l_module_init(void)
774 return usb_register(&snd_us122l_usb_driver
);
777 static void __exit
snd_us122l_module_exit(void)
779 usb_deregister(&snd_us122l_usb_driver
);
782 module_init(snd_us122l_module_init
)
783 module_exit(snd_us122l_module_exit
)