[linux-block.git] / sound / usb / usx2y / usX2Yhwdep.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * Driver for Tascam US-X2Y USB soundcards
 *
 * FPGA Loader + ALSA Startup
 *
 * Copyright (c) 2003 by Karsten Wiese <annabellesgarden@yahoo.de>
 */

#include <linux/interrupt.h>
#include <linux/slab.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 vm_fault_t snd_us428ctls_vm_fault(struct vm_fault *vmf)
{
	unsigned long offset;
	struct page * page;
	void *vaddr;

	snd_printdd("ENTER, start %lXh, pgoff %ld\n",
		   vmf->vma->vm_start,
		   vmf->pgoff);
	
	offset = vmf->pgoff << PAGE_SHIFT;
	vaddr = (char *)((struct usX2Ydev *)vmf->vma->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);
		us428->us428ctls_sharedmem = alloc_pages_exact(sizeof(struct us428ctls_sharedmem), GFP_KERNEL);
		if (!us428->us428ctls_sharedmem)
			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_DONTEXPAND | VM_DONTDUMP;
	area->vm_private_data = hw->private_data;
	return 0;
}

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

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

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

	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->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)->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;
	struct usb_device* dev = priv->dev;
	int lret, err;
	char *buf;

	snd_printdd( "dsp_load %s\n", dsp->name);

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