[mirror_ubuntu-jammy-kernel.git] / sound / usb / usx2y / usbusx2y.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * usbusy2y.c - ALSA USB US-428 Driver
 *
2005-04-14 Karsten Wiese
	Version 0.8.7.2:
	Call snd_card_free() instead of snd_card_free_in_thread() to prevent oops with dead keyboard symptom.
	Tested ok with kernel 2.6.12-rc2.

2004-12-14 Karsten Wiese
	Version 0.8.7.1:
	snd_pcm_open for rawusb pcm-devices now returns -EBUSY if called without rawusb's hwdep device being open.

2004-12-02 Karsten Wiese
	Version 0.8.7:
	Use macro usb_maxpacket() for portability.

2004-10-26 Karsten Wiese
	Version 0.8.6:
	wake_up() process waiting in usX2Y_urbs_start() on error.

2004-10-21 Karsten Wiese
	Version 0.8.5:
	nrpacks is runtime or compiletime configurable now with tested values from 1 to 4.

2004-10-03 Karsten Wiese
	Version 0.8.2:
	Avoid any possible racing while in prepare callback.

2004-09-30 Karsten Wiese
	Version 0.8.0:
	Simplified things and made ohci work again.

2004-09-20 Karsten Wiese
	Version 0.7.3:
	Use usb_kill_urb() instead of deprecated (kernel 2.6.9) usb_unlink_urb().

2004-07-13 Karsten Wiese
	Version 0.7.1:
	Don't sleep in START/STOP callbacks anymore.
	us428 channels C/D not handled just for this version, sorry.

2004-06-21 Karsten Wiese
	Version 0.6.4:
	Temporarely suspend midi input
	to sanely call usb_set_interface() when setting format.

2004-06-12 Karsten Wiese
	Version 0.6.3:
	Made it thus the following rule is enforced:
	"All pcm substreams of one usX2Y have to operate at the same rate & format."

2004-04-06 Karsten Wiese
	Version 0.6.0:
	Runs on 2.6.5 kernel without any "--with-debug=" things.
	us224 reported running.

2004-01-14 Karsten Wiese
	Version 0.5.1:
	Runs with 2.6.1 kernel.

2003-12-30 Karsten Wiese
	Version 0.4.1:
	Fix 24Bit 4Channel capturing for the us428.

2003-11-27 Karsten Wiese, Martin Langer
	Version 0.4:
	us122 support.
	us224 could be tested by uncommenting the sections containing USB_ID_US224

2003-11-03 Karsten Wiese
	Version 0.3:
	24Bit support. 
	"arecord -D hw:1 -c 2 -r 48000 -M -f S24_3LE|aplay -D hw:1 -c 2 -r 48000 -M -f S24_3LE" works.

2003-08-22 Karsten Wiese
	Version 0.0.8:
	Removed EZUSB Firmware. First Stage Firmwaredownload is now done by tascam-firmware downloader.
	See:
	http://usb-midi-fw.sourceforge.net/tascam-firmware.tar.gz

2003-06-18 Karsten Wiese
	Version 0.0.5:
	changed to compile with kernel 2.4.21 and alsa 0.9.4

2002-10-16 Karsten Wiese
	Version 0.0.4:
	compiles again with alsa-current.
	USB_ISO_ASAP not used anymore (most of the time), instead
	urb->start_frame is calculated here now, some calls inside usb-driver don't need to happen anymore.

	To get the best out of this:
	Disable APM-support in the kernel as APM-BIOS calls (once each second) hard disable interrupt for many precious milliseconds.
	This helped me much on my slowish PII 400 & PIII 500.
	ACPI yet untested but might cause the same bad behaviour.
	Use a kernel with lowlatency and preemptiv patches applied.
	To autoload snd-usb-midi append a line 
		post-install snd-usb-us428 modprobe snd-usb-midi
	to /etc/modules.conf.

	known problems:
	sliders, knobs, lights not yet handled except MASTER Volume slider.
       	"pcm -c 2" doesn't work. "pcm -c 2 -m direct_interleaved" does.
	KDE3: "Enable full duplex operation" deadlocks.

	
2002-08-31 Karsten Wiese
	Version 0.0.3: audio also simplex;
	simplifying: iso urbs only 1 packet, melted structs.
	ASYNC_UNLINK not used anymore: no more crashes so far.....
	for alsa 0.9 rc3.

2002-08-09 Karsten Wiese
	Version 0.0.2: midi works with snd-usb-midi, audio (only fullduplex now) with i.e. bristol.
	The firmware has been sniffed from win2k us-428 driver 3.09.

 *   Copyright (c) 2002 - 2004 Karsten Wiese
*/

#include <linux/init.h>
#include <linux/module.h>
#include <linux/moduleparam.h>
#include <linux/slab.h>
#include <linux/interrupt.h>
#include <linux/usb.h>
#include <sound/core.h>
#include <sound/initval.h>
#include <sound/pcm.h>

#include <sound/rawmidi.h>
#include "usx2y.h"
#include "usbusx2y.h"
#include "usX2Yhwdep.h"


MODULE_AUTHOR("Karsten Wiese <annabellesgarden@yahoo.de>");
MODULE_DESCRIPTION("TASCAM "NAME_ALLCAPS" Version 0.8.7.2");
MODULE_LICENSE("GPL");

static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-max */
static char* id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* Id for this card */
static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP; /* Enable this card */

module_param_array(index, int, NULL, 0444);
MODULE_PARM_DESC(index, "Index value for "NAME_ALLCAPS".");
module_param_array(id, charp, NULL, 0444);
MODULE_PARM_DESC(id, "ID string for "NAME_ALLCAPS".");
module_param_array(enable, bool, NULL, 0444);
MODULE_PARM_DESC(enable, "Enable "NAME_ALLCAPS".");


static int snd_usX2Y_card_used[SNDRV_CARDS];

static void usX2Y_usb_disconnect(struct usb_device* usb_device, void* ptr);
static void snd_usX2Y_card_private_free(struct snd_card *card);

/* 
 * pipe 4 is used for switching the lamps, setting samplerate, volumes ....   
 */
static void i_usX2Y_Out04Int(struct urb *urb)
{
#ifdef CONFIG_SND_DEBUG
	if (urb->status) {
		int 		i;
		struct usX2Ydev *usX2Y = urb->context;
		for (i = 0; i < 10 && usX2Y->AS04.urb[i] != urb; i++);
		snd_printdd("i_usX2Y_Out04Int() urb %i status=%i\n", i, urb->status);
	}
#endif
}

static void i_usX2Y_In04Int(struct urb *urb)
{
	int			err = 0;
	struct usX2Ydev		*usX2Y = urb->context;
	struct us428ctls_sharedmem	*us428ctls = usX2Y->us428ctls_sharedmem;

	usX2Y->In04IntCalls++;

	if (urb->status) {
		snd_printdd("Interrupt Pipe 4 came back with status=%i\n", urb->status);
		return;
	}

	//	printk("%i:0x%02X ", 8, (int)((unsigned char*)usX2Y->In04Buf)[8]); Master volume shows 0 here if fader is at max during boot ?!?
	if (us428ctls) {
		int diff = -1;
		if (-2 == us428ctls->CtlSnapShotLast) {
			diff = 0;
			memcpy(usX2Y->In04Last, usX2Y->In04Buf, sizeof(usX2Y->In04Last));
			us428ctls->CtlSnapShotLast = -1;
		} else {
			int i;
			for (i = 0; i < 21; i++) {
				if (usX2Y->In04Last[i] != ((char*)usX2Y->In04Buf)[i]) {
					if (diff < 0)
						diff = i;
					usX2Y->In04Last[i] = ((char*)usX2Y->In04Buf)[i];
				}
			}
		}
		if (0 <= diff) {
			int n = us428ctls->CtlSnapShotLast + 1;
			if (n >= N_us428_ctl_BUFS  ||  n < 0)
				n = 0;
			memcpy(us428ctls->CtlSnapShot + n, usX2Y->In04Buf, sizeof(us428ctls->CtlSnapShot[0]));
			us428ctls->CtlSnapShotDiffersAt[n] = diff;
			us428ctls->CtlSnapShotLast = n;
			wake_up(&usX2Y->us428ctls_wait_queue_head);
		}
	}
	
	
	if (usX2Y->US04) {
		if (0 == usX2Y->US04->submitted)
			do {
				err = usb_submit_urb(usX2Y->US04->urb[usX2Y->US04->submitted++], GFP_ATOMIC);
			} while (!err && usX2Y->US04->submitted < usX2Y->US04->len);
	} else
		if (us428ctls && us428ctls->p4outLast >= 0 && us428ctls->p4outLast < N_us428_p4out_BUFS) {
			if (us428ctls->p4outLast != us428ctls->p4outSent) {
				int j, send = us428ctls->p4outSent + 1;
				if (send >= N_us428_p4out_BUFS)
					send = 0;
				for (j = 0; j < URBS_AsyncSeq  &&  !err; ++j)
					if (0 == usX2Y->AS04.urb[j]->status) {
						struct us428_p4out *p4out = us428ctls->p4out + send;	// FIXME if more than 1 p4out is new, 1 gets lost.
						usb_fill_bulk_urb(usX2Y->AS04.urb[j], usX2Y->dev,
								  usb_sndbulkpipe(usX2Y->dev, 0x04), &p4out->val.vol,
								  p4out->type == eLT_Light ? sizeof(struct us428_lights) : 5,
								  i_usX2Y_Out04Int, usX2Y);
						err = usb_submit_urb(usX2Y->AS04.urb[j], GFP_ATOMIC);
						us428ctls->p4outSent = send;
						break;
					}
			}
		}

	if (err)
		snd_printk(KERN_ERR "In04Int() usb_submit_urb err=%i\n", err);

	urb->dev = usX2Y->dev;
	usb_submit_urb(urb, GFP_ATOMIC);
}

/*
 * Prepare some urbs
 */
int usX2Y_AsyncSeq04_init(struct usX2Ydev *usX2Y)
{
	int	err = 0,
		i;

	usX2Y->AS04.buffer = kmalloc_array(URBS_AsyncSeq,
					   URB_DataLen_AsyncSeq, GFP_KERNEL);
	if (NULL == usX2Y->AS04.buffer) {
		err = -ENOMEM;
	} else
		for (i = 0; i < URBS_AsyncSeq; ++i) {
			if (NULL == (usX2Y->AS04.urb[i] = usb_alloc_urb(0, GFP_KERNEL))) {
				err = -ENOMEM;
				break;
			}
			usb_fill_bulk_urb(	usX2Y->AS04.urb[i], usX2Y->dev,
						usb_sndbulkpipe(usX2Y->dev, 0x04),
						usX2Y->AS04.buffer + URB_DataLen_AsyncSeq*i, 0,
						i_usX2Y_Out04Int, usX2Y
				);
			err = usb_urb_ep_type_check(usX2Y->AS04.urb[i]);
			if (err < 0)
				break;
		}
	return err;
}

int usX2Y_In04_init(struct usX2Ydev *usX2Y)
{
	if (! (usX2Y->In04urb = usb_alloc_urb(0, GFP_KERNEL)))
		return -ENOMEM;

	if (! (usX2Y->In04Buf = kmalloc(21, GFP_KERNEL)))
		return -ENOMEM;
	 
	init_waitqueue_head(&usX2Y->In04WaitQueue);
	usb_fill_int_urb(usX2Y->In04urb, usX2Y->dev, usb_rcvintpipe(usX2Y->dev, 0x4),
			 usX2Y->In04Buf, 21,
			 i_usX2Y_In04Int, usX2Y,
			 10);
	if (usb_urb_ep_type_check(usX2Y->In04urb))
		return -EINVAL;
	return usb_submit_urb(usX2Y->In04urb, GFP_KERNEL);
}

static void usX2Y_unlinkSeq(struct snd_usX2Y_AsyncSeq *S)
{
	int	i;
	for (i = 0; i < URBS_AsyncSeq; ++i) {
		usb_kill_urb(S->urb[i]);
		usb_free_urb(S->urb[i]);
		S->urb[i] = NULL;
	}
	kfree(S->buffer);
}


static const struct usb_device_id snd_usX2Y_usb_id_table[] = {
	{
		.match_flags =	USB_DEVICE_ID_MATCH_DEVICE,
		.idVendor =	0x1604,
		.idProduct =	USB_ID_US428 
	},
	{
		.match_flags =	USB_DEVICE_ID_MATCH_DEVICE,
		.idVendor =	0x1604,
		.idProduct =	USB_ID_US122 
	},
 	{
		.match_flags =	USB_DEVICE_ID_MATCH_DEVICE,
		.idVendor =	0x1604,
		.idProduct =	USB_ID_US224
	},
	{ /* terminator */ }
};

static int usX2Y_create_card(struct usb_device *device,
			     struct usb_interface *intf,
			     struct snd_card **cardp)
{
	int		dev;
	struct snd_card *	card;
	int err;

	for (dev = 0; dev < SNDRV_CARDS; ++dev)
		if (enable[dev] && !snd_usX2Y_card_used[dev])
			break;
	if (dev >= SNDRV_CARDS)
		return -ENODEV;
	err = snd_card_new(&intf->dev, index[dev], id[dev], THIS_MODULE,
			   sizeof(struct usX2Ydev), &card);
	if (err < 0)
		return err;
	snd_usX2Y_card_used[usX2Y(card)->card_index = dev] = 1;
	card->private_free = snd_usX2Y_card_private_free;
	usX2Y(card)->dev = device;
	init_waitqueue_head(&usX2Y(card)->prepare_wait_queue);
	mutex_init(&usX2Y(card)->pcm_mutex);
	INIT_LIST_HEAD(&usX2Y(card)->midi_list);
	strcpy(card->driver, "USB "NAME_ALLCAPS"");
	sprintf(card->shortname, "TASCAM "NAME_ALLCAPS"");
	sprintf(card->longname, "%s (%x:%x if %d at %03d/%03d)",
		card->shortname, 
		le16_to_cpu(device->descriptor.idVendor),
		le16_to_cpu(device->descriptor.idProduct),
		0,//us428(card)->usbmidi.ifnum,
		usX2Y(card)->dev->bus->busnum, usX2Y(card)->dev->devnum
		);
	*cardp = card;
	return 0;
}


static int usX2Y_usb_probe(struct usb_device *device,
			   struct usb_interface *intf,
			   const struct usb_device_id *device_id,
			   struct snd_card **cardp)
{
	int		err;
	struct snd_card *	card;

	*cardp = NULL;
	if (le16_to_cpu(device->descriptor.idVendor) != 0x1604 ||
	    (le16_to_cpu(device->descriptor.idProduct) != USB_ID_US122 &&
	     le16_to_cpu(device->descriptor.idProduct) != USB_ID_US224 &&
	     le16_to_cpu(device->descriptor.idProduct) != USB_ID_US428))
		return -EINVAL;

	err = usX2Y_create_card(device, intf, &card);
	if (err < 0)
		return err;
	if ((err = usX2Y_hwdep_new(card, device)) < 0  ||
	    (err = snd_card_register(card)) < 0) {
		snd_card_free(card);
		return err;
	}
	*cardp = card;
	return 0;
}

/*
 * new 2.5 USB kernel API
 */
static int snd_usX2Y_probe(struct usb_interface *intf, const struct usb_device_id *id)
{
	struct snd_card *card;
	int err;

	err = usX2Y_usb_probe(interface_to_usbdev(intf), intf, id, &card);
	if (err < 0)
		return err;
	dev_set_drvdata(&intf->dev, card);
	return 0;
}

static void snd_usX2Y_disconnect(struct usb_interface *intf)
{
	usX2Y_usb_disconnect(interface_to_usbdev(intf),
				 usb_get_intfdata(intf));
}

MODULE_DEVICE_TABLE(usb, snd_usX2Y_usb_id_table);
static struct usb_driver snd_usX2Y_usb_driver = {
	.name =		"snd-usb-usx2y",
	.probe =	snd_usX2Y_probe,
	.disconnect =	snd_usX2Y_disconnect,
	.id_table =	snd_usX2Y_usb_id_table,
};

static void snd_usX2Y_card_private_free(struct snd_card *card)
{
	kfree(usX2Y(card)->In04Buf);
	usb_free_urb(usX2Y(card)->In04urb);
	if (usX2Y(card)->us428ctls_sharedmem)
		free_pages_exact(usX2Y(card)->us428ctls_sharedmem,
				 sizeof(*usX2Y(card)->us428ctls_sharedmem));
	if (usX2Y(card)->card_index >= 0  &&  usX2Y(card)->card_index < SNDRV_CARDS)
		snd_usX2Y_card_used[usX2Y(card)->card_index] = 0;
}

/*
 * Frees the device.
 */
static void usX2Y_usb_disconnect(struct usb_device *device, void* ptr)
{
	if (ptr) {
		struct snd_card *card = ptr;
		struct usX2Ydev *usX2Y = usX2Y(card);
		struct list_head *p;
		usX2Y->chip_status = USX2Y_STAT_CHIP_HUP;
		usX2Y_unlinkSeq(&usX2Y->AS04);
		usb_kill_urb(usX2Y->In04urb);
		snd_card_disconnect(card);
		/* release the midi resources */
		list_for_each(p, &usX2Y->midi_list) {
			snd_usbmidi_disconnect(p);
		}
		if (usX2Y->us428ctls_sharedmem) 
			wake_up(&usX2Y->us428ctls_wait_queue_head);
		snd_card_free(card);
	}
}

module_usb_driver(snd_usX2Y_usb_driver);
Commit	Line	Data
1a59d1b8	1	// SPDX-License-Identifier: GPL-2.0-or-later
1da177e4 LT	2	/*
	3	* usbusy2y.c - ALSA USB US-428 Driver
	4	*
230cd5e2 KW	5	2005-04-14 Karsten Wiese
	6	Version 0.8.7.2:
	7	Call snd_card_free() instead of snd_card_free_in_thread() to prevent oops with dead keyboard symptom.
	8	Tested ok with kernel 2.6.12-rc2.
	9
1da177e4 LT	10	2004-12-14 Karsten Wiese
	11	Version 0.8.7.1:
	12	snd_pcm_open for rawusb pcm-devices now returns -EBUSY if called without rawusb's hwdep device being open.
	13
	14	2004-12-02 Karsten Wiese
	15	Version 0.8.7:
	16	Use macro usb_maxpacket() for portability.
	17
	18	2004-10-26 Karsten Wiese
	19	Version 0.8.6:
	20	wake_up() process waiting in usX2Y_urbs_start() on error.
	21
	22	2004-10-21 Karsten Wiese
	23	Version 0.8.5:
	24	nrpacks is runtime or compiletime configurable now with tested values from 1 to 4.
	25
	26	2004-10-03 Karsten Wiese
	27	Version 0.8.2:
	28	Avoid any possible racing while in prepare callback.
	29
	30	2004-09-30 Karsten Wiese
	31	Version 0.8.0:
	32	Simplified things and made ohci work again.
	33
	34	2004-09-20 Karsten Wiese
	35	Version 0.7.3:
	36	Use usb_kill_urb() instead of deprecated (kernel 2.6.9) usb_unlink_urb().
	37
	38	2004-07-13 Karsten Wiese
	39	Version 0.7.1:
	40	Don't sleep in START/STOP callbacks anymore.
	41	us428 channels C/D not handled just for this version, sorry.
	42
	43	2004-06-21 Karsten Wiese
	44	Version 0.6.4:
	45	Temporarely suspend midi input
	46	to sanely call usb_set_interface() when setting format.
	47
	48	2004-06-12 Karsten Wiese
	49	Version 0.6.3:
	50	Made it thus the following rule is enforced:
	51	"All pcm substreams of one usX2Y have to operate at the same rate & format."
	52
	53	2004-04-06 Karsten Wiese
	54	Version 0.6.0:
	55	Runs on 2.6.5 kernel without any "--with-debug=" things.
	56	us224 reported running.
	57
	58	2004-01-14 Karsten Wiese
	59	Version 0.5.1:
	60	Runs with 2.6.1 kernel.
	61
	62	2003-12-30 Karsten Wiese
	63	Version 0.4.1:
	64	Fix 24Bit 4Channel capturing for the us428.
	65
	66	2003-11-27 Karsten Wiese, Martin Langer
	67	Version 0.4:
	68	us122 support.
	69	us224 could be tested by uncommenting the sections containing USB_ID_US224
	70
	71	2003-11-03 Karsten Wiese
	72	Version 0.3:
	73	24Bit support.
74	"arecord -D hw:1 -c 2 -r 48000 -M -f S24_3LE\|aplay -D hw:1 -c 2 -r 48000 -M -f S24_3LE" works.
75
76	2003-08-22 Karsten Wiese
77	Version 0.0.8:
78	Removed EZUSB Firmware. First Stage Firmwaredownload is now done by tascam-firmware downloader.
79	See:
80	http://usb-midi-fw.sourceforge.net/tascam-firmware.tar.gz
81
82	2003-06-18 Karsten Wiese
83	Version 0.0.5:
84	changed to compile with kernel 2.4.21 and alsa 0.9.4
85
86	2002-10-16 Karsten Wiese
87	Version 0.0.4:
88	compiles again with alsa-current.
89	USB_ISO_ASAP not used anymore (most of the time), instead
90	urb->start_frame is calculated here now, some calls inside usb-driver don't need to happen anymore.
91
92	To get the best out of this:
93	Disable APM-support in the kernel as APM-BIOS calls (once each second) hard disable interrupt for many precious milliseconds.
94	This helped me much on my slowish PII 400 & PIII 500.
95	ACPI yet untested but might cause the same bad behaviour.
96	Use a kernel with lowlatency and preemptiv patches applied.
97	To autoload snd-usb-midi append a line
98	post-install snd-usb-us428 modprobe snd-usb-midi
99	to /etc/modules.conf.
100
101	known problems:
102	sliders, knobs, lights not yet handled except MASTER Volume slider.
103	"pcm -c 2" doesn't work. "pcm -c 2 -m direct_interleaved" does.
104	KDE3: "Enable full duplex operation" deadlocks.
105
106
107	2002-08-31 Karsten Wiese
108	Version 0.0.3: audio also simplex;
109	simplifying: iso urbs only 1 packet, melted structs.
110	ASYNC_UNLINK not used anymore: no more crashes so far.....
111	for alsa 0.9 rc3.
112
113	2002-08-09 Karsten Wiese
114	Version 0.0.2: midi works with snd-usb-midi, audio (only fullduplex now) with i.e. bristol.
115	The firmware has been sniffed from win2k us-428 driver 3.09.
116
117	* Copyright (c) 2002 - 2004 Karsten Wiese
1da177e4 LT	118	*/
1da177e4 LT	119
1da177e4 LT	120	#include <linux/init.h>
	121	#include <linux/module.h>
	122	#include <linux/moduleparam.h>
5a0e3ad6	123	#include <linux/slab.h>
1da177e4 LT	124	#include <linux/interrupt.h>
	125	#include <linux/usb.h>
	126	#include <sound/core.h>
	127	#include <sound/initval.h>
	128	#include <sound/pcm.h>
	129
	130	#include <sound/rawmidi.h>
	131	#include "usx2y.h"
	132	#include "usbusx2y.h"
	133	#include "usX2Yhwdep.h"
	134
	135
	136
	137	MODULE_AUTHOR("Karsten Wiese <annabellesgarden@yahoo.de>");
230cd5e2	138	MODULE_DESCRIPTION("TASCAM "NAME_ALLCAPS" Version 0.8.7.2");
1da177e4	139	MODULE_LICENSE("GPL");
1da177e4 LT	140
	141	static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-max */
	142	static char* id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* Id for this card */
a67ff6a5	143	static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP; /* Enable this card */
1da177e4 LT	144
	145	module_param_array(index, int, NULL, 0444);
	146	MODULE_PARM_DESC(index, "Index value for "NAME_ALLCAPS".");
	147	module_param_array(id, charp, NULL, 0444);
	148	MODULE_PARM_DESC(id, "ID string for "NAME_ALLCAPS".");
	149	module_param_array(enable, bool, NULL, 0444);
	150	MODULE_PARM_DESC(enable, "Enable "NAME_ALLCAPS".");
	151
	152
	153	static int snd_usX2Y_card_used[SNDRV_CARDS];
	154
	155	static void usX2Y_usb_disconnect(struct usb_device* usb_device, void* ptr);
bbe85bbd	156	static void snd_usX2Y_card_private_free(struct snd_card *card);
1da177e4 LT	157
	158	/*
	159	* pipe 4 is used for switching the lamps, setting samplerate, volumes ....
	160	*/
7d12e780	161	static void i_usX2Y_Out04Int(struct urb *urb)
1da177e4 LT	162	{
	163	#ifdef CONFIG_SND_DEBUG
	164	if (urb->status) {
	165	int i;
bbe85bbd	166	struct usX2Ydev *usX2Y = urb->context;
1da177e4 LT	167	for (i = 0; i < 10 && usX2Y->AS04.urb[i] != urb; i++);
	168	snd_printdd("i_usX2Y_Out04Int() urb %i status=%i\n", i, urb->status);
	169	}
	170	#endif
	171	}
	172
7d12e780	173	static void i_usX2Y_In04Int(struct urb *urb)
1da177e4 LT	174	{
1da177e4 LT	175	int err = 0;
bbe85bbd TI	176	struct usX2Ydev *usX2Y = urb->context;
bbe85bbd TI	177	struct us428ctls_sharedmem *us428ctls = usX2Y->us428ctls_sharedmem;
1da177e4 LT	178
	179	usX2Y->In04IntCalls++;
	180
	181	if (urb->status) {
	182	snd_printdd("Interrupt Pipe 4 came back with status=%i\n", urb->status);
	183	return;
	184	}
	185
	186	// printk("%i:0x%02X ", 8, (int)((unsigned char*)usX2Y->In04Buf)[8]); Master volume shows 0 here if fader is at max during boot ?!?
	187	if (us428ctls) {
	188	int diff = -1;
	189	if (-2 == us428ctls->CtlSnapShotLast) {
	190	diff = 0;
	191	memcpy(usX2Y->In04Last, usX2Y->In04Buf, sizeof(usX2Y->In04Last));
	192	us428ctls->CtlSnapShotLast = -1;
	193	} else {
	194	int i;
	195	for (i = 0; i < 21; i++) {
	196	if (usX2Y->In04Last[i] != ((char*)usX2Y->In04Buf)[i]) {
	197	if (diff < 0)
	198	diff = i;
	199	usX2Y->In04Last[i] = ((char*)usX2Y->In04Buf)[i];
	200	}
	201	}
	202	}
	203	if (0 <= diff) {
	204	int n = us428ctls->CtlSnapShotLast + 1;
	205	if (n >= N_us428_ctl_BUFS \|\| n < 0)
	206	n = 0;
	207	memcpy(us428ctls->CtlSnapShot + n, usX2Y->In04Buf, sizeof(us428ctls->CtlSnapShot[0]));
	208	us428ctls->CtlSnapShotDiffersAt[n] = diff;
	209	us428ctls->CtlSnapShotLast = n;
	210	wake_up(&usX2Y->us428ctls_wait_queue_head);
	211	}
	212	}
	213
	214
	215	if (usX2Y->US04) {
	216	if (0 == usX2Y->US04->submitted)
3a755ec2	217	do {
1da177e4	218	err = usb_submit_urb(usX2Y->US04->urb[usX2Y->US04->submitted++], GFP_ATOMIC);
3a755ec2	219	} while (!err && usX2Y->US04->submitted < usX2Y->US04->len);
1da177e4 LT	220	} else
	221	if (us428ctls && us428ctls->p4outLast >= 0 && us428ctls->p4outLast < N_us428_p4out_BUFS) {
	222	if (us428ctls->p4outLast != us428ctls->p4outSent) {
	223	int j, send = us428ctls->p4outSent + 1;
	224	if (send >= N_us428_p4out_BUFS)
	225	send = 0;
	226	for (j = 0; j < URBS_AsyncSeq && !err; ++j)
	227	if (0 == usX2Y->AS04.urb[j]->status) {
025dfdaf	228	struct us428_p4out *p4out = us428ctls->p4out + send; // FIXME if more than 1 p4out is new, 1 gets lost.
a014bbad CL	229	usb_fill_bulk_urb(usX2Y->AS04.urb[j], usX2Y->dev,
a014bbad CL	230	usb_sndbulkpipe(usX2Y->dev, 0x04), &p4out->val.vol,
bbe85bbd	231	p4out->type == eLT_Light ? sizeof(struct us428_lights) : 5,
1da177e4 LT	232	i_usX2Y_Out04Int, usX2Y);
	233	err = usb_submit_urb(usX2Y->AS04.urb[j], GFP_ATOMIC);
	234	us428ctls->p4outSent = send;
	235	break;
	236	}
	237	}
	238	}
	239
d3d579f8 TI	240	if (err)
d3d579f8 TI	241	snd_printk(KERN_ERR "In04Int() usb_submit_urb err=%i\n", err);
1da177e4	242
a014bbad	243	urb->dev = usX2Y->dev;
1da177e4 LT	244	usb_submit_urb(urb, GFP_ATOMIC);
	245	}
	246
	247	/*
	248	* Prepare some urbs
	249	*/
bbe85bbd	250	int usX2Y_AsyncSeq04_init(struct usX2Ydev *usX2Y)
1da177e4 LT	251	{
	252	int err = 0,
	253	i;
	254
6da2ec56 KC	255	usX2Y->AS04.buffer = kmalloc_array(URBS_AsyncSeq,
	256	URB_DataLen_AsyncSeq, GFP_KERNEL);
	257	if (NULL == usX2Y->AS04.buffer) {
1da177e4 LT	258	err = -ENOMEM;
	259	} else
	260	for (i = 0; i < URBS_AsyncSeq; ++i) {
	261	if (NULL == (usX2Y->AS04.urb[i] = usb_alloc_urb(0, GFP_KERNEL))) {
	262	err = -ENOMEM;
	263	break;
	264	}
a014bbad CL	265	usb_fill_bulk_urb( usX2Y->AS04.urb[i], usX2Y->dev,
a014bbad CL	266	usb_sndbulkpipe(usX2Y->dev, 0x04),
1da177e4 LT	267	usX2Y->AS04.buffer + URB_DataLen_AsyncSeq*i, 0,
	268	i_usX2Y_Out04Int, usX2Y
	269	);
1f100349 TI	270	err = usb_urb_ep_type_check(usX2Y->AS04.urb[i]);
	271	if (err < 0)
	272	break;
1da177e4 LT	273	}
	274	return err;
	275	}
	276
bbe85bbd	277	int usX2Y_In04_init(struct usX2Ydev *usX2Y)
1da177e4	278	{
1da177e4 LT	279	if (! (usX2Y->In04urb = usb_alloc_urb(0, GFP_KERNEL)))
	280	return -ENOMEM;
	281
cbb88db7	282	if (! (usX2Y->In04Buf = kmalloc(21, GFP_KERNEL)))
1da177e4	283	return -ENOMEM;
1da177e4 LT	284
1da177e4 LT	285	init_waitqueue_head(&usX2Y->In04WaitQueue);
a014bbad	286	usb_fill_int_urb(usX2Y->In04urb, usX2Y->dev, usb_rcvintpipe(usX2Y->dev, 0x4),
1da177e4 LT	287	usX2Y->In04Buf, 21,
	288	i_usX2Y_In04Int, usX2Y,
	289	10);
1f100349 TI	290	if (usb_urb_ep_type_check(usX2Y->In04urb))
1f100349 TI	291	return -EINVAL;
cb432379	292	return usb_submit_urb(usX2Y->In04urb, GFP_KERNEL);
1da177e4 LT	293	}
1da177e4 LT	294
bbe85bbd	295	static void usX2Y_unlinkSeq(struct snd_usX2Y_AsyncSeq *S)
1da177e4 LT	296	{
	297	int i;
	298	for (i = 0; i < URBS_AsyncSeq; ++i) {
85054b21 DC	299	usb_kill_urb(S->urb[i]);
	300	usb_free_urb(S->urb[i]);
	301	S->urb[i] = NULL;
1da177e4 LT	302	}
	303	kfree(S->buffer);
	304	}
	305
	306
5e463d6d	307	static const struct usb_device_id snd_usX2Y_usb_id_table[] = {
1da177e4 LT	308	{
	309	.match_flags = USB_DEVICE_ID_MATCH_DEVICE,
	310	.idVendor = 0x1604,
	311	.idProduct = USB_ID_US428
	312	},
	313	{
	314	.match_flags = USB_DEVICE_ID_MATCH_DEVICE,
	315	.idVendor = 0x1604,
	316	.idProduct = USB_ID_US122
	317	},
	318	{
	319	.match_flags = USB_DEVICE_ID_MATCH_DEVICE,
	320	.idVendor = 0x1604,
	321	.idProduct = USB_ID_US224
	322	},
	323	{ /* terminator */ }
	324	};
	325
874b8d42 TI	326	static int usX2Y_create_card(struct usb_device *device,
	327	struct usb_interface *intf,
	328	struct snd_card **cardp)
1da177e4 LT	329	{
1da177e4 LT	330	int dev;
bbe85bbd	331	struct snd_card * card;
bd7dd77c TI	332	int err;
bd7dd77c TI	333
1da177e4 LT	334	for (dev = 0; dev < SNDRV_CARDS; ++dev)
	335	if (enable[dev] && !snd_usX2Y_card_used[dev])
	336	break;
	337	if (dev >= SNDRV_CARDS)
51721f70	338	return -ENODEV;
874b8d42 TI	339	err = snd_card_new(&intf->dev, index[dev], id[dev], THIS_MODULE,
874b8d42 TI	340	sizeof(struct usX2Ydev), &card);
bd7dd77c	341	if (err < 0)
51721f70	342	return err;
a014bbad	343	snd_usX2Y_card_used[usX2Y(card)->card_index = dev] = 1;
1da177e4	344	card->private_free = snd_usX2Y_card_private_free;
a014bbad	345	usX2Y(card)->dev = device;
1da177e4	346	init_waitqueue_head(&usX2Y(card)->prepare_wait_queue);
e2439a54	347	mutex_init(&usX2Y(card)->pcm_mutex);
d82af9f9	348	INIT_LIST_HEAD(&usX2Y(card)->midi_list);
1da177e4 LT	349	strcpy(card->driver, "USB "NAME_ALLCAPS"");
	350	sprintf(card->shortname, "TASCAM "NAME_ALLCAPS"");
	351	sprintf(card->longname, "%s (%x:%x if %d at %03d/%03d)",
	352	card->shortname,
	353	le16_to_cpu(device->descriptor.idVendor),
	354	le16_to_cpu(device->descriptor.idProduct),
	355	0,//us428(card)->usbmidi.ifnum,
a014bbad	356	usX2Y(card)->dev->bus->busnum, usX2Y(card)->dev->devnum
1da177e4	357	);
51721f70 TI	358	*cardp = card;
51721f70 TI	359	return 0;
1da177e4 LT	360	}
	361
	362
51721f70 TI	363	static int usX2Y_usb_probe(struct usb_device *device,
	364	struct usb_interface *intf,
	365	const struct usb_device_id *device_id,
	366	struct snd_card **cardp)
1da177e4 LT	367	{
1da177e4 LT	368	int err;
bbe85bbd	369	struct snd_card * card;
51721f70 TI	370
51721f70 TI	371	*cardp = NULL;
1da177e4 LT	372	if (le16_to_cpu(device->descriptor.idVendor) != 0x1604 \|\|
	373	(le16_to_cpu(device->descriptor.idProduct) != USB_ID_US122 &&
	374	le16_to_cpu(device->descriptor.idProduct) != USB_ID_US224 &&
51721f70 TI	375	le16_to_cpu(device->descriptor.idProduct) != USB_ID_US428))
	376	return -EINVAL;
	377
874b8d42	378	err = usX2Y_create_card(device, intf, &card);
51721f70 TI	379	if (err < 0)
51721f70 TI	380	return err;
1da177e4 LT	381	if ((err = usX2Y_hwdep_new(card, device)) < 0 \|\|
	382	(err = snd_card_register(card)) < 0) {
	383	snd_card_free(card);
51721f70	384	return err;
1da177e4	385	}
51721f70 TI	386	*cardp = card;
51721f70 TI	387	return 0;
1da177e4 LT	388	}
	389
	390	/*
	391	* new 2.5 USB kernel API
	392	*/
	393	static int snd_usX2Y_probe(struct usb_interface intf, const struct usb_device_id id)
	394	{
51721f70 TI	395	struct snd_card *card;
	396	int err;
	397
	398	err = usX2Y_usb_probe(interface_to_usbdev(intf), intf, id, &card);
	399	if (err < 0)
	400	return err;
	401	dev_set_drvdata(&intf->dev, card);
	402	return 0;
1da177e4 LT	403	}
	404
	405	static void snd_usX2Y_disconnect(struct usb_interface *intf)
	406	{
	407	usX2Y_usb_disconnect(interface_to_usbdev(intf),
f4e9749f	408	usb_get_intfdata(intf));
1da177e4 LT	409	}
	410
	411	MODULE_DEVICE_TABLE(usb, snd_usX2Y_usb_id_table);
	412	static struct usb_driver snd_usX2Y_usb_driver = {
1da177e4 LT	413	.name = "snd-usb-usx2y",
	414	.probe = snd_usX2Y_probe,
	415	.disconnect = snd_usX2Y_disconnect,
	416	.id_table = snd_usX2Y_usb_id_table,
	417	};
	418
bbe85bbd	419	static void snd_usX2Y_card_private_free(struct snd_card *card)
1da177e4 LT	420	{
	421	kfree(usX2Y(card)->In04Buf);
	422	usb_free_urb(usX2Y(card)->In04urb);
	423	if (usX2Y(card)->us428ctls_sharedmem)
734b5a0b TI	424	free_pages_exact(usX2Y(card)->us428ctls_sharedmem,
734b5a0b TI	425	sizeof(*usX2Y(card)->us428ctls_sharedmem));
a014bbad CL	426	if (usX2Y(card)->card_index >= 0 && usX2Y(card)->card_index < SNDRV_CARDS)
a014bbad CL	427	snd_usX2Y_card_used[usX2Y(card)->card_index] = 0;
1da177e4 LT	428	}
	429
	430	/*
	431	* Frees the device.
	432	*/
bbe85bbd	433	static void usX2Y_usb_disconnect(struct usb_device device, void ptr)
1da177e4 LT	434	{
1da177e4 LT	435	if (ptr) {
bbe85bbd TI	436	struct snd_card *card = ptr;
bbe85bbd TI	437	struct usX2Ydev *usX2Y = usX2Y(card);
cb432379	438	struct list_head *p;
1da177e4 LT	439	usX2Y->chip_status = USX2Y_STAT_CHIP_HUP;
	440	usX2Y_unlinkSeq(&usX2Y->AS04);
	441	usb_kill_urb(usX2Y->In04urb);
cb432379	442	snd_card_disconnect(card);
1da177e4	443	/* release the midi resources */
d82af9f9	444	list_for_each(p, &usX2Y->midi_list) {
ee733397	445	snd_usbmidi_disconnect(p);
1da177e4 LT	446	}
	447	if (usX2Y->us428ctls_sharedmem)
	448	wake_up(&usX2Y->us428ctls_wait_queue_head);
cb432379	449	snd_card_free(card);
1da177e4 LT	450	}
	451	}
	452
424f0750	453	module_usb_driver(snd_usX2Y_usb_driver);