[net-next-2.6.git] / sound / usb / usx2y / usX2Yhwdep.c

/*
 * Driver for Tascam US-X2Y USB soundcards
 *
 * FPGA Loader + ALSA Startup
 *
 * Copyright (c) 2003 by Karsten Wiese <annabellesgarden@yahoo.de>
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 */

#include <linux/interrupt.h>
#include <linux/usb.h>
#include <sound/core.h>
#include <sound/memalloc.h>
#include <sound/pcm.h>
#include <sound/hwdep.h>
#include "usx2y.h"
#include "usbusx2y.h"
#include "usX2Yhwdep.h"

static int snd_us428ctls_vm_fault(struct vm_area_struct *area,
				  struct vm_fault *vmf)
{
	unsigned long offset;
	struct page * page;
	void *vaddr;

	snd_printdd("ENTER, start %lXh, pgoff %ld\n",
		   area->vm_start,
		   vmf->pgoff);
	
	offset = vmf->pgoff << PAGE_SHIFT;
	vaddr = (char*)((struct usX2Ydev *)area->vm_private_data)->us428ctls_sharedmem + offset;
	page = virt_to_page(vaddr);
	get_page(page);
	vmf->page = page;

	snd_printdd("vaddr=%p made us428ctls_vm_fault() page %p\n",
		    vaddr, page);

	return 0;
}

static const struct vm_operations_struct us428ctls_vm_ops = {
	.fault = snd_us428ctls_vm_fault,
};

static int snd_us428ctls_mmap(struct snd_hwdep * hw, struct file *filp, struct vm_area_struct *area)
{
	unsigned long	size = (unsigned long)(area->vm_end - area->vm_start);
	struct usX2Ydev	*us428 = hw->private_data;

	// FIXME this hwdep interface is used twice: fpga download and mmap for controlling Lights etc. Maybe better using 2 hwdep devs?
	// so as long as the device isn't fully initialised yet we return -EBUSY here.
 	if (!(us428->chip_status & USX2Y_STAT_CHIP_INIT))
		return -EBUSY;

	/* if userspace tries to mmap beyond end of our buffer, fail */ 
        if (size > PAGE_ALIGN(sizeof(struct us428ctls_sharedmem))) {
		snd_printd( "%lu > %lu\n", size, (unsigned long)sizeof(struct us428ctls_sharedmem)); 
                return -EINVAL;
	}

	if (!us428->us428ctls_sharedmem) {
		init_waitqueue_head(&us428->us428ctls_wait_queue_head);
		if(!(us428->us428ctls_sharedmem = snd_malloc_pages(sizeof(struct us428ctls_sharedmem), GFP_KERNEL)))
			return -ENOMEM;
		memset(us428->us428ctls_sharedmem, -1, sizeof(struct us428ctls_sharedmem));
		us428->us428ctls_sharedmem->CtlSnapShotLast = -2;
	}
	area->vm_ops = &us428ctls_vm_ops;
	area->vm_flags |= VM_RESERVED | VM_DONTEXPAND;
	area->vm_private_data = hw->private_data;
	return 0;
}

static unsigned int snd_us428ctls_poll(struct snd_hwdep *hw, struct file *file, poll_table *wait)
{
	unsigned int	mask = 0;
	struct usX2Ydev	*us428 = hw->private_data;
	struct us428ctls_sharedmem *shm = us428->us428ctls_sharedmem;
	if (us428->chip_status & USX2Y_STAT_CHIP_HUP)
		return POLLHUP;

	poll_wait(file, &us428->us428ctls_wait_queue_head, wait);

	if (shm != NULL && shm->CtlSnapShotLast != shm->CtlSnapShotRed)
		mask |= POLLIN;

	return mask;
}


static int snd_usX2Y_hwdep_dsp_status(struct snd_hwdep *hw,
				      struct snd_hwdep_dsp_status *info)
{
	static char *type_ids[USX2Y_TYPE_NUMS] = {
		[USX2Y_TYPE_122] = "us122",
		[USX2Y_TYPE_224] = "us224",
		[USX2Y_TYPE_428] = "us428",
	};
	struct usX2Ydev	*us428 = hw->private_data;
	int id = -1;

	switch (le16_to_cpu(us428->chip.dev->descriptor.idProduct)) {
	case USB_ID_US122:
		id = USX2Y_TYPE_122;
		break;
	case USB_ID_US224:
		id = USX2Y_TYPE_224;
		break;
	case USB_ID_US428:
		id = USX2Y_TYPE_428;
		break;
	}
	if (0 > id)
		return -ENODEV;
	strcpy(info->id, type_ids[id]);
	info->num_dsps = 2;		// 0: Prepad Data, 1: FPGA Code
	if (us428->chip_status & USX2Y_STAT_CHIP_INIT)
		info->chip_ready = 1;
 	info->version = USX2Y_DRIVER_VERSION; 
	return 0;
}


static int usX2Y_create_usbmidi(struct snd_card *card)
{
	static struct snd_usb_midi_endpoint_info quirk_data_1 = {
		.out_ep = 0x06,
		.in_ep = 0x06,
		.out_cables =	0x001,
		.in_cables =	0x001
	};
	static struct snd_usb_audio_quirk quirk_1 = {
		.vendor_name =	"TASCAM",
		.product_name =	NAME_ALLCAPS,
		.ifnum = 	0,
       		.type = QUIRK_MIDI_FIXED_ENDPOINT,
		.data = &quirk_data_1
	};
	static struct snd_usb_midi_endpoint_info quirk_data_2 = {
		.out_ep = 0x06,
		.in_ep = 0x06,
		.out_cables =	0x003,
		.in_cables =	0x003
	};
	static struct snd_usb_audio_quirk quirk_2 = {
		.vendor_name =	"TASCAM",
		.product_name =	"US428",
		.ifnum = 	0,
       		.type = QUIRK_MIDI_FIXED_ENDPOINT,
		.data = &quirk_data_2
	};
	struct usb_device *dev = usX2Y(card)->chip.dev;
	struct usb_interface *iface = usb_ifnum_to_if(dev, 0);
	struct snd_usb_audio_quirk *quirk =
		le16_to_cpu(dev->descriptor.idProduct) == USB_ID_US428 ?
		&quirk_2 : &quirk_1;

	snd_printdd("usX2Y_create_usbmidi \n");
	return snd_usbmidi_create(card, iface, &usX2Y(card)->midi_list, quirk);
}

static int usX2Y_create_alsa_devices(struct snd_card *card)
{
	int err;

	do {
		if ((err = usX2Y_create_usbmidi(card)) < 0) {
			snd_printk(KERN_ERR "usX2Y_create_alsa_devices: usX2Y_create_usbmidi error %i \n", err);
			break;
		}
		if ((err = usX2Y_audio_create(card)) < 0) 
			break;
		if ((err = usX2Y_hwdep_pcm_new(card)) < 0)
			break;
		if ((err = snd_card_register(card)) < 0)
			break;
	} while (0);

	return err;
} 

static int snd_usX2Y_hwdep_dsp_load(struct snd_hwdep *hw,
				    struct snd_hwdep_dsp_image *dsp)
{
	struct usX2Ydev *priv = hw->private_data;
	int	lret, err = -EINVAL;
	snd_printdd( "dsp_load %s\n", dsp->name);

	if (access_ok(VERIFY_READ, dsp->image, dsp->length)) {
		struct usb_device* dev = priv->chip.dev;
		char *buf;

		buf = memdup_user(dsp->image, dsp->length);
		if (IS_ERR(buf))
			return PTR_ERR(buf);

		err = usb_set_interface(dev, 0, 1);
		if (err)
			snd_printk(KERN_ERR "usb_set_interface error \n");
		else
			err = usb_bulk_msg(dev, usb_sndbulkpipe(dev, 2), buf, dsp->length, &lret, 6000);
		kfree(buf);
	}
	if (err)
		return err;
	if (dsp->index == 1) {
		msleep(250);				// give the device some time
		err = usX2Y_AsyncSeq04_init(priv);
		if (err) {
			snd_printk(KERN_ERR "usX2Y_AsyncSeq04_init error \n");
			return err;
		}
		err = usX2Y_In04_init(priv);
		if (err) {
			snd_printk(KERN_ERR "usX2Y_In04_init error \n");
			return err;
		}
		err = usX2Y_create_alsa_devices(hw->card);
		if (err) {
			snd_printk(KERN_ERR "usX2Y_create_alsa_devices error %i \n", err);
			snd_card_free(hw->card);
			return err;
		}
		priv->chip_status |= USX2Y_STAT_CHIP_INIT; 
		snd_printdd("%s: alsa all started\n", hw->name);
	}
	return err;
}


int usX2Y_hwdep_new(struct snd_card *card, struct usb_device* device)
{
	int err;
	struct snd_hwdep *hw;

	if ((err = snd_hwdep_new(card, SND_USX2Y_LOADER_ID, 0, &hw)) < 0)
		return err;

	hw->iface = SNDRV_HWDEP_IFACE_USX2Y;
	hw->private_data = usX2Y(card);
	hw->ops.dsp_status = snd_usX2Y_hwdep_dsp_status;
	hw->ops.dsp_load = snd_usX2Y_hwdep_dsp_load;
	hw->ops.mmap = snd_us428ctls_mmap;
	hw->ops.poll = snd_us428ctls_poll;
	hw->exclusive = 1;
	sprintf(hw->name, "/proc/bus/usb/%03d/%03d", device->bus->busnum, device->devnum);
	return 0;
}
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Driver for Tascam US-X2Y USB soundcards
	3	*
	4	* FPGA Loader + ALSA Startup
	5	*
	6	* Copyright (c) 2003 by Karsten Wiese <annabellesgarden@yahoo.de>
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published by
	10	* the Free Software Foundation; either version 2 of the License, or
	11	* (at your option) any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program; if not, write to the Free Software
	20	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	21	*/
	22
1da177e4 LT	23	#include <linux/interrupt.h>
	24	#include <linux/usb.h>
	25	#include <sound/core.h>
	26	#include <sound/memalloc.h>
	27	#include <sound/pcm.h>
	28	#include <sound/hwdep.h>
	29	#include "usx2y.h"
	30	#include "usbusx2y.h"
	31	#include "usX2Yhwdep.h"
	32
eb415b8f NP	33	static int snd_us428ctls_vm_fault(struct vm_area_struct *area,
eb415b8f NP	34	struct vm_fault *vmf)
1da177e4 LT	35	{
	36	unsigned long offset;
	37	struct page * page;
	38	void *vaddr;
	39
eb415b8f	40	snd_printdd("ENTER, start %lXh, pgoff %ld\n",
1da177e4	41	area->vm_start,
eb415b8f	42	vmf->pgoff);
1da177e4	43
eb415b8f	44	offset = vmf->pgoff << PAGE_SHIFT;
bbe85bbd	45	vaddr = (char)((struct usX2Ydev )area->vm_private_data)->us428ctls_sharedmem + offset;
1da177e4 LT	46	page = virt_to_page(vaddr);
1da177e4 LT	47	get_page(page);
eb415b8f	48	vmf->page = page;
1da177e4	49
eb415b8f NP	50	snd_printdd("vaddr=%p made us428ctls_vm_fault() page %p\n",
eb415b8f NP	51	vaddr, page);
1da177e4	52
eb415b8f	53	return 0;
1da177e4 LT	54	}
1da177e4 LT	55
f0f37e2f	56	static const struct vm_operations_struct us428ctls_vm_ops = {
eb415b8f	57	.fault = snd_us428ctls_vm_fault,
1da177e4 LT	58	};
1da177e4 LT	59
bbe85bbd	60	static int snd_us428ctls_mmap(struct snd_hwdep * hw, struct file filp, struct vm_area_struct area)
1da177e4 LT	61	{
1da177e4 LT	62	unsigned long size = (unsigned long)(area->vm_end - area->vm_start);
bbe85bbd	63	struct usX2Ydev *us428 = hw->private_data;
1da177e4 LT	64
	65	// FIXME this hwdep interface is used twice: fpga download and mmap for controlling Lights etc. Maybe better using 2 hwdep devs?
	66	// so as long as the device isn't fully initialised yet we return -EBUSY here.
cb432379	67	if (!(us428->chip_status & USX2Y_STAT_CHIP_INIT))
1da177e4 LT	68	return -EBUSY;
	69
	70	/* if userspace tries to mmap beyond end of our buffer, fail */
bbe85bbd TI	71	if (size > PAGE_ALIGN(sizeof(struct us428ctls_sharedmem))) {
bbe85bbd TI	72	snd_printd( "%lu > %lu\n", size, (unsigned long)sizeof(struct us428ctls_sharedmem));
1da177e4 LT	73	return -EINVAL;
	74	}
	75
	76	if (!us428->us428ctls_sharedmem) {
	77	init_waitqueue_head(&us428->us428ctls_wait_queue_head);
bbe85bbd	78	if(!(us428->us428ctls_sharedmem = snd_malloc_pages(sizeof(struct us428ctls_sharedmem), GFP_KERNEL)))
1da177e4	79	return -ENOMEM;
bbe85bbd	80	memset(us428->us428ctls_sharedmem, -1, sizeof(struct us428ctls_sharedmem));
1da177e4 LT	81	us428->us428ctls_sharedmem->CtlSnapShotLast = -2;
	82	}
	83	area->vm_ops = &us428ctls_vm_ops;
2f98735c	84	area->vm_flags \|= VM_RESERVED \| VM_DONTEXPAND;
1da177e4 LT	85	area->vm_private_data = hw->private_data;
	86	return 0;
	87	}
	88
bbe85bbd	89	static unsigned int snd_us428ctls_poll(struct snd_hwdep hw, struct file file, poll_table *wait)
1da177e4 LT	90	{
1da177e4 LT	91	unsigned int mask = 0;
bbe85bbd TI	92	struct usX2Ydev *us428 = hw->private_data;
bbe85bbd TI	93	struct us428ctls_sharedmem *shm = us428->us428ctls_sharedmem;
1da177e4 LT	94	if (us428->chip_status & USX2Y_STAT_CHIP_HUP)
	95	return POLLHUP;
	96
	97	poll_wait(file, &us428->us428ctls_wait_queue_head, wait);
	98
	99	if (shm != NULL && shm->CtlSnapShotLast != shm->CtlSnapShotRed)
	100	mask \|= POLLIN;
	101
	102	return mask;
	103	}
	104
	105
bbe85bbd TI	106	static int snd_usX2Y_hwdep_dsp_status(struct snd_hwdep *hw,
bbe85bbd TI	107	struct snd_hwdep_dsp_status *info)
1da177e4 LT	108	{
	109	static char *type_ids[USX2Y_TYPE_NUMS] = {
	110	[USX2Y_TYPE_122] = "us122",
	111	[USX2Y_TYPE_224] = "us224",
	112	[USX2Y_TYPE_428] = "us428",
	113	};
bbe85bbd	114	struct usX2Ydev *us428 = hw->private_data;
1da177e4 LT	115	int id = -1;
1da177e4 LT	116
cb432379	117	switch (le16_to_cpu(us428->chip.dev->descriptor.idProduct)) {
1da177e4 LT	118	case USB_ID_US122:
	119	id = USX2Y_TYPE_122;
	120	break;
	121	case USB_ID_US224:
	122	id = USX2Y_TYPE_224;
	123	break;
	124	case USB_ID_US428:
	125	id = USX2Y_TYPE_428;
	126	break;
	127	}
	128	if (0 > id)
	129	return -ENODEV;
	130	strcpy(info->id, type_ids[id]);
	131	info->num_dsps = 2; // 0: Prepad Data, 1: FPGA Code
bbe85bbd	132	if (us428->chip_status & USX2Y_STAT_CHIP_INIT)
1da177e4 LT	133	info->chip_ready = 1;
	134	info->version = USX2Y_DRIVER_VERSION;
	135	return 0;
	136	}
	137
	138
bbe85bbd	139	static int usX2Y_create_usbmidi(struct snd_card *card)
1da177e4	140	{
bbe85bbd TI	141	static struct snd_usb_midi_endpoint_info quirk_data_1 = {
bbe85bbd TI	142	.out_ep = 0x06,
1da177e4 LT	143	.in_ep = 0x06,
	144	.out_cables = 0x001,
	145	.in_cables = 0x001
	146	};
bbe85bbd	147	static struct snd_usb_audio_quirk quirk_1 = {
1da177e4 LT	148	.vendor_name = "TASCAM",
	149	.product_name = NAME_ALLCAPS,
	150	.ifnum = 0,
	151	.type = QUIRK_MIDI_FIXED_ENDPOINT,
	152	.data = &quirk_data_1
	153	};
bbe85bbd TI	154	static struct snd_usb_midi_endpoint_info quirk_data_2 = {
bbe85bbd TI	155	.out_ep = 0x06,
1da177e4 LT	156	.in_ep = 0x06,
	157	.out_cables = 0x003,
	158	.in_cables = 0x003
	159	};
bbe85bbd	160	static struct snd_usb_audio_quirk quirk_2 = {
1da177e4 LT	161	.vendor_name = "TASCAM",
	162	.product_name = "US428",
	163	.ifnum = 0,
	164	.type = QUIRK_MIDI_FIXED_ENDPOINT,
	165	.data = &quirk_data_2
	166	};
	167	struct usb_device *dev = usX2Y(card)->chip.dev;
	168	struct usb_interface *iface = usb_ifnum_to_if(dev, 0);
bbe85bbd TI	169	struct snd_usb_audio_quirk *quirk =
	170	le16_to_cpu(dev->descriptor.idProduct) == USB_ID_US428 ?
	171	&quirk_2 : &quirk_1;
1da177e4 LT	172
1da177e4 LT	173	snd_printdd("usX2Y_create_usbmidi \n");
d82af9f9	174	return snd_usbmidi_create(card, iface, &usX2Y(card)->midi_list, quirk);
1da177e4 LT	175	}
1da177e4 LT	176
bbe85bbd	177	static int usX2Y_create_alsa_devices(struct snd_card *card)
1da177e4 LT	178	{
	179	int err;
	180
	181	do {
	182	if ((err = usX2Y_create_usbmidi(card)) < 0) {
d3d579f8	183	snd_printk(KERN_ERR "usX2Y_create_alsa_devices: usX2Y_create_usbmidi error %i \n", err);
1da177e4 LT	184	break;
	185	}
	186	if ((err = usX2Y_audio_create(card)) < 0)
	187	break;
	188	if ((err = usX2Y_hwdep_pcm_new(card)) < 0)
	189	break;
	190	if ((err = snd_card_register(card)) < 0)
	191	break;
	192	} while (0);
	193
	194	return err;
	195	}
	196
bbe85bbd TI	197	static int snd_usX2Y_hwdep_dsp_load(struct snd_hwdep *hw,
bbe85bbd TI	198	struct snd_hwdep_dsp_image *dsp)
1da177e4	199	{
bbe85bbd	200	struct usX2Ydev *priv = hw->private_data;
1da177e4 LT	201	int lret, err = -EINVAL;
	202	snd_printdd( "dsp_load %s\n", dsp->name);
	203
	204	if (access_ok(VERIFY_READ, dsp->image, dsp->length)) {
	205	struct usb_device* dev = priv->chip.dev;
85385c15 LZ	206	char *buf;
	207
	208	buf = memdup_user(dsp->image, dsp->length);
	209	if (IS_ERR(buf))
	210	return PTR_ERR(buf);
	211
1da177e4 LT	212	err = usb_set_interface(dev, 0, 1);
1da177e4 LT	213	if (err)
d3d579f8	214	snd_printk(KERN_ERR "usb_set_interface error \n");
1da177e4 LT	215	else
	216	err = usb_bulk_msg(dev, usb_sndbulkpipe(dev, 2), buf, dsp->length, &lret, 6000);
	217	kfree(buf);
	218	}
	219	if (err)
	220	return err;
	221	if (dsp->index == 1) {
b27c187f	222	msleep(250); // give the device some time
1da177e4 LT	223	err = usX2Y_AsyncSeq04_init(priv);
1da177e4 LT	224	if (err) {
d3d579f8	225	snd_printk(KERN_ERR "usX2Y_AsyncSeq04_init error \n");
1da177e4 LT	226	return err;
	227	}
	228	err = usX2Y_In04_init(priv);
	229	if (err) {
d3d579f8	230	snd_printk(KERN_ERR "usX2Y_In04_init error \n");
1da177e4 LT	231	return err;
	232	}
	233	err = usX2Y_create_alsa_devices(hw->card);
	234	if (err) {
d3d579f8	235	snd_printk(KERN_ERR "usX2Y_create_alsa_devices error %i \n", err);
1da177e4 LT	236	snd_card_free(hw->card);
	237	return err;
	238	}
	239	priv->chip_status \|= USX2Y_STAT_CHIP_INIT;
	240	snd_printdd("%s: alsa all started\n", hw->name);
	241	}
	242	return err;
	243	}
	244
	245
bbe85bbd	246	int usX2Y_hwdep_new(struct snd_card card, struct usb_device device)
1da177e4 LT	247	{
1da177e4 LT	248	int err;
bbe85bbd	249	struct snd_hwdep *hw;
1da177e4 LT	250
	251	if ((err = snd_hwdep_new(card, SND_USX2Y_LOADER_ID, 0, &hw)) < 0)
	252	return err;
	253
	254	hw->iface = SNDRV_HWDEP_IFACE_USX2Y;
	255	hw->private_data = usX2Y(card);
1da177e4 LT	256	hw->ops.dsp_status = snd_usX2Y_hwdep_dsp_status;
	257	hw->ops.dsp_load = snd_usX2Y_hwdep_dsp_load;
	258	hw->ops.mmap = snd_us428ctls_mmap;
	259	hw->ops.poll = snd_us428ctls_poll;
	260	hw->exclusive = 1;
	261	sprintf(hw->name, "/proc/bus/usb/%03d/%03d", device->bus->busnum, device->devnum);
	262	return 0;
	263	}
	264