[linux-block.git] / sound / usb / caiaq / device.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * caiaq.c: ALSA driver for caiaq/NativeInstruments devices
 *
 *   Copyright (c) 2007 Daniel Mack <daniel@caiaq.de>
 *                      Karsten Wiese <fzu@wemgehoertderstaat.de>
*/

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

#include "device.h"
#include "audio.h"
#include "midi.h"
#include "control.h"
#include "input.h"

MODULE_AUTHOR("Daniel Mack <daniel@caiaq.de>");
MODULE_DESCRIPTION("caiaq USB audio");
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 the caiaq sound device");
module_param_array(id, charp, NULL, 0444);
MODULE_PARM_DESC(id, "ID string for the caiaq soundcard.");
module_param_array(enable, bool, NULL, 0444);
MODULE_PARM_DESC(enable, "Enable the caiaq soundcard.");

enum {
	SAMPLERATE_44100	= 0,
	SAMPLERATE_48000	= 1,
	SAMPLERATE_96000	= 2,
	SAMPLERATE_192000	= 3,
	SAMPLERATE_88200	= 4,
	SAMPLERATE_INVALID	= 0xff
};

enum {
	DEPTH_NONE	= 0,
	DEPTH_16	= 1,
	DEPTH_24	= 2,
	DEPTH_32	= 3
};

static const struct usb_device_id snd_usb_id_table[] = {
	{
		.match_flags =	USB_DEVICE_ID_MATCH_DEVICE,
		.idVendor =	USB_VID_NATIVEINSTRUMENTS,
		.idProduct =	USB_PID_RIGKONTROL2
	},
	{
		.match_flags =	USB_DEVICE_ID_MATCH_DEVICE,
		.idVendor =	USB_VID_NATIVEINSTRUMENTS,
		.idProduct =	USB_PID_RIGKONTROL3
	},
	{
		.match_flags =	USB_DEVICE_ID_MATCH_DEVICE,
		.idVendor =	USB_VID_NATIVEINSTRUMENTS,
		.idProduct =	USB_PID_KORECONTROLLER
	},
	{
		.match_flags =	USB_DEVICE_ID_MATCH_DEVICE,
		.idVendor =	USB_VID_NATIVEINSTRUMENTS,
		.idProduct =	USB_PID_KORECONTROLLER2
	},
	{
		.match_flags =  USB_DEVICE_ID_MATCH_DEVICE,
		.idVendor =     USB_VID_NATIVEINSTRUMENTS,
		.idProduct =    USB_PID_AK1
	},
	{
		.match_flags =  USB_DEVICE_ID_MATCH_DEVICE,
		.idVendor =     USB_VID_NATIVEINSTRUMENTS,
		.idProduct =    USB_PID_AUDIO8DJ
	},
	{
		.match_flags =  USB_DEVICE_ID_MATCH_DEVICE,
		.idVendor =     USB_VID_NATIVEINSTRUMENTS,
		.idProduct =    USB_PID_SESSIONIO
	},
	{
		.match_flags =  USB_DEVICE_ID_MATCH_DEVICE,
		.idVendor =     USB_VID_NATIVEINSTRUMENTS,
		.idProduct =    USB_PID_GUITARRIGMOBILE
	},
	{
		.match_flags =  USB_DEVICE_ID_MATCH_DEVICE,
		.idVendor =     USB_VID_NATIVEINSTRUMENTS,
		.idProduct =    USB_PID_AUDIO4DJ
	},
	{
		.match_flags =  USB_DEVICE_ID_MATCH_DEVICE,
		.idVendor =     USB_VID_NATIVEINSTRUMENTS,
		.idProduct =    USB_PID_AUDIO2DJ
	},
	{
		.match_flags =  USB_DEVICE_ID_MATCH_DEVICE,
		.idVendor =     USB_VID_NATIVEINSTRUMENTS,
		.idProduct =    USB_PID_TRAKTORKONTROLX1
	},
	{
		.match_flags =  USB_DEVICE_ID_MATCH_DEVICE,
		.idVendor =     USB_VID_NATIVEINSTRUMENTS,
		.idProduct =    USB_PID_TRAKTORKONTROLS4
	},
	{
		.match_flags =  USB_DEVICE_ID_MATCH_DEVICE,
		.idVendor =     USB_VID_NATIVEINSTRUMENTS,
		.idProduct =    USB_PID_TRAKTORAUDIO2
	},
	{
		.match_flags =  USB_DEVICE_ID_MATCH_DEVICE,
		.idVendor =     USB_VID_NATIVEINSTRUMENTS,
		.idProduct =    USB_PID_MASCHINECONTROLLER
	},
	{ /* terminator */ }
};

static void usb_ep1_command_reply_dispatch (struct urb* urb)
{
	int ret;
	struct device *dev = &urb->dev->dev;
	struct snd_usb_caiaqdev *cdev = urb->context;
	unsigned char *buf = urb->transfer_buffer;

	if (urb->status || !cdev) {
		dev_warn(dev, "received EP1 urb->status = %i\n", urb->status);
		return;
	}

	switch(buf[0]) {
	case EP1_CMD_GET_DEVICE_INFO:
	 	memcpy(&cdev->spec, buf+1, sizeof(struct caiaq_device_spec));
		cdev->spec.fw_version = le16_to_cpu(cdev->spec.fw_version);
		dev_dbg(dev, "device spec (firmware %d): audio: %d in, %d out, "
			"MIDI: %d in, %d out, data alignment %d\n",
			cdev->spec.fw_version,
			cdev->spec.num_analog_audio_in,
			cdev->spec.num_analog_audio_out,
			cdev->spec.num_midi_in,
			cdev->spec.num_midi_out,
			cdev->spec.data_alignment);

		cdev->spec_received++;
		wake_up(&cdev->ep1_wait_queue);
		break;
	case EP1_CMD_AUDIO_PARAMS:
		cdev->audio_parm_answer = buf[1];
		wake_up(&cdev->ep1_wait_queue);
		break;
	case EP1_CMD_MIDI_READ:
		snd_usb_caiaq_midi_handle_input(cdev, buf[1], buf + 3, buf[2]);
		break;
	case EP1_CMD_READ_IO:
		if (cdev->chip.usb_id ==
			USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AUDIO8DJ)) {
			if (urb->actual_length > sizeof(cdev->control_state))
				urb->actual_length = sizeof(cdev->control_state);
			memcpy(cdev->control_state, buf + 1, urb->actual_length);
			wake_up(&cdev->ep1_wait_queue);
			break;
		}
#ifdef CONFIG_SND_USB_CAIAQ_INPUT
		fallthrough;
	case EP1_CMD_READ_ERP:
	case EP1_CMD_READ_ANALOG:
		snd_usb_caiaq_input_dispatch(cdev, buf, urb->actual_length);
#endif
		break;
	}

	cdev->ep1_in_urb.actual_length = 0;
	ret = usb_submit_urb(&cdev->ep1_in_urb, GFP_ATOMIC);
	if (ret < 0)
		dev_err(dev, "unable to submit urb. OOM!?\n");
}

int snd_usb_caiaq_send_command(struct snd_usb_caiaqdev *cdev,
			       unsigned char command,
			       const unsigned char *buffer,
			       int len)
{
	int actual_len;
	struct usb_device *usb_dev = cdev->chip.dev;

	if (!usb_dev)
		return -EIO;

	if (len > EP1_BUFSIZE - 1)
		len = EP1_BUFSIZE - 1;

	if (buffer && len > 0)
		memcpy(cdev->ep1_out_buf+1, buffer, len);

	cdev->ep1_out_buf[0] = command;
	return usb_bulk_msg(usb_dev, usb_sndbulkpipe(usb_dev, 1),
			   cdev->ep1_out_buf, len+1, &actual_len, 200);
}

int snd_usb_caiaq_send_command_bank(struct snd_usb_caiaqdev *cdev,
			       unsigned char command,
			       unsigned char bank,
			       const unsigned char *buffer,
			       int len)
{
	int actual_len;
	struct usb_device *usb_dev = cdev->chip.dev;

	if (!usb_dev)
		return -EIO;

	if (len > EP1_BUFSIZE - 2)
		len = EP1_BUFSIZE - 2;

	if (buffer && len > 0)
		memcpy(cdev->ep1_out_buf+2, buffer, len);

	cdev->ep1_out_buf[0] = command;
	cdev->ep1_out_buf[1] = bank;

	return usb_bulk_msg(usb_dev, usb_sndbulkpipe(usb_dev, 1),
			   cdev->ep1_out_buf, len+2, &actual_len, 200);
}

int snd_usb_caiaq_set_audio_params (struct snd_usb_caiaqdev *cdev,
		   		    int rate, int depth, int bpp)
{
	int ret;
	char tmp[5];
	struct device *dev = caiaqdev_to_dev(cdev);

	switch (rate) {
	case 44100:	tmp[0] = SAMPLERATE_44100;   break;
	case 48000:	tmp[0] = SAMPLERATE_48000;   break;
	case 88200:	tmp[0] = SAMPLERATE_88200;   break;
	case 96000:	tmp[0] = SAMPLERATE_96000;   break;
	case 192000:	tmp[0] = SAMPLERATE_192000;  break;
	default:	return -EINVAL;
	}

	switch (depth) {
	case 16:	tmp[1] = DEPTH_16;   break;
	case 24:	tmp[1] = DEPTH_24;   break;
	default:	return -EINVAL;
	}

	tmp[2] = bpp & 0xff;
	tmp[3] = bpp >> 8;
	tmp[4] = 1; /* packets per microframe */

	dev_dbg(dev, "setting audio params: %d Hz, %d bits, %d bpp\n",
		rate, depth, bpp);

	cdev->audio_parm_answer = -1;
	ret = snd_usb_caiaq_send_command(cdev, EP1_CMD_AUDIO_PARAMS,
					 tmp, sizeof(tmp));

	if (ret)
		return ret;

	if (!wait_event_timeout(cdev->ep1_wait_queue,
	    cdev->audio_parm_answer >= 0, HZ))
		return -EPIPE;

	if (cdev->audio_parm_answer != 1)
		dev_dbg(dev, "unable to set the device's audio params\n");
	else
		cdev->bpp = bpp;

	return cdev->audio_parm_answer == 1 ? 0 : -EINVAL;
}

int snd_usb_caiaq_set_auto_msg(struct snd_usb_caiaqdev *cdev,
			       int digital, int analog, int erp)
{
	char tmp[3] = { digital, analog, erp };
	return snd_usb_caiaq_send_command(cdev, EP1_CMD_AUTO_MSG,
					  tmp, sizeof(tmp));
}

static void setup_card(struct snd_usb_caiaqdev *cdev)
{
	int ret;
	char val[4];
	struct device *dev = caiaqdev_to_dev(cdev);

	/* device-specific startup specials */
	switch (cdev->chip.usb_id) {
	case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_RIGKONTROL2):
		/* RigKontrol2 - display centered dash ('-') */
		val[0] = 0x00;
		val[1] = 0x00;
		val[2] = 0x01;
		snd_usb_caiaq_send_command(cdev, EP1_CMD_WRITE_IO, val, 3);
		break;
	case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_RIGKONTROL3):
		/* RigKontrol2 - display two centered dashes ('--') */
		val[0] = 0x00;
		val[1] = 0x40;
		val[2] = 0x40;
		val[3] = 0x00;
		snd_usb_caiaq_send_command(cdev, EP1_CMD_WRITE_IO, val, 4);
		break;
	case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AK1):
		/* Audio Kontrol 1 - make USB-LED stop blinking */
		val[0] = 0x00;
		snd_usb_caiaq_send_command(cdev, EP1_CMD_WRITE_IO, val, 1);
		break;
	case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AUDIO8DJ):
		/* Audio 8 DJ - trigger read of current settings */
		cdev->control_state[0] = 0xff;
		snd_usb_caiaq_set_auto_msg(cdev, 1, 0, 0);
		snd_usb_caiaq_send_command(cdev, EP1_CMD_READ_IO, NULL, 0);

		if (!wait_event_timeout(cdev->ep1_wait_queue,
					cdev->control_state[0] != 0xff, HZ))
			return;

		/* fix up some defaults */
		if ((cdev->control_state[1] != 2) ||
		    (cdev->control_state[2] != 3) ||
		    (cdev->control_state[4] != 2)) {
			cdev->control_state[1] = 2;
			cdev->control_state[2] = 3;
			cdev->control_state[4] = 2;
			snd_usb_caiaq_send_command(cdev,
				EP1_CMD_WRITE_IO, cdev->control_state, 6);
		}

		break;
	}

	if (cdev->spec.num_analog_audio_out +
	    cdev->spec.num_analog_audio_in +
	    cdev->spec.num_digital_audio_out +
	    cdev->spec.num_digital_audio_in > 0) {
		ret = snd_usb_caiaq_audio_init(cdev);
		if (ret < 0)
			dev_err(dev, "Unable to set up audio system (ret=%d)\n", ret);
	}

	if (cdev->spec.num_midi_in +
	    cdev->spec.num_midi_out > 0) {
		ret = snd_usb_caiaq_midi_init(cdev);
		if (ret < 0)
			dev_err(dev, "Unable to set up MIDI system (ret=%d)\n", ret);
	}

#ifdef CONFIG_SND_USB_CAIAQ_INPUT
	ret = snd_usb_caiaq_input_init(cdev);
	if (ret < 0)
		dev_err(dev, "Unable to set up input system (ret=%d)\n", ret);
#endif

	/* finally, register the card and all its sub-instances */
	ret = snd_card_register(cdev->chip.card);
	if (ret < 0) {
		dev_err(dev, "snd_card_register() returned %d\n", ret);
		snd_card_free(cdev->chip.card);
	}

	ret = snd_usb_caiaq_control_init(cdev);
	if (ret < 0)
		dev_err(dev, "Unable to set up control system (ret=%d)\n", ret);
}

static int create_card(struct usb_device *usb_dev,
		       struct usb_interface *intf,
		       struct snd_card **cardp)
{
	int devnum;
	int err;
	struct snd_card *card;
	struct snd_usb_caiaqdev *cdev;

	for (devnum = 0; devnum < SNDRV_CARDS; devnum++)
		if (enable[devnum])
			break;

	if (devnum >= SNDRV_CARDS)
		return -ENODEV;

	err = snd_card_new(&intf->dev,
			   index[devnum], id[devnum], THIS_MODULE,
			   sizeof(struct snd_usb_caiaqdev), &card);
	if (err < 0)
		return err;

	cdev = caiaqdev(card);
	cdev->chip.dev = usb_dev;
	cdev->chip.card = card;
	cdev->chip.usb_id = USB_ID(le16_to_cpu(usb_dev->descriptor.idVendor),
				  le16_to_cpu(usb_dev->descriptor.idProduct));
	spin_lock_init(&cdev->spinlock);

	*cardp = card;
	return 0;
}

static int init_card(struct snd_usb_caiaqdev *cdev)
{
	char *c, usbpath[32];
	struct usb_device *usb_dev = cdev->chip.dev;
	struct snd_card *card = cdev->chip.card;
	struct device *dev = caiaqdev_to_dev(cdev);
	int err, len;

	if (usb_set_interface(usb_dev, 0, 1) != 0) {
		dev_err(dev, "can't set alt interface.\n");
		return -EIO;
	}

	usb_init_urb(&cdev->ep1_in_urb);
	usb_init_urb(&cdev->midi_out_urb);

	usb_fill_bulk_urb(&cdev->ep1_in_urb, usb_dev,
			  usb_rcvbulkpipe(usb_dev, 0x1),
			  cdev->ep1_in_buf, EP1_BUFSIZE,
			  usb_ep1_command_reply_dispatch, cdev);

	usb_fill_bulk_urb(&cdev->midi_out_urb, usb_dev,
			  usb_sndbulkpipe(usb_dev, 0x1),
			  cdev->midi_out_buf, EP1_BUFSIZE,
			  snd_usb_caiaq_midi_output_done, cdev);

	/* sanity checks of EPs before actually submitting */
	if (usb_urb_ep_type_check(&cdev->ep1_in_urb) ||
	    usb_urb_ep_type_check(&cdev->midi_out_urb)) {
		dev_err(dev, "invalid EPs\n");
		return -EINVAL;
	}

	init_waitqueue_head(&cdev->ep1_wait_queue);
	init_waitqueue_head(&cdev->prepare_wait_queue);

	if (usb_submit_urb(&cdev->ep1_in_urb, GFP_KERNEL) != 0)
		return -EIO;

	err = snd_usb_caiaq_send_command(cdev, EP1_CMD_GET_DEVICE_INFO, NULL, 0);
	if (err)
		goto err_kill_urb;

	if (!wait_event_timeout(cdev->ep1_wait_queue, cdev->spec_received, HZ)) {
		err = -ENODEV;
		goto err_kill_urb;
	}

	usb_string(usb_dev, usb_dev->descriptor.iManufacturer,
		   cdev->vendor_name, CAIAQ_USB_STR_LEN);

	usb_string(usb_dev, usb_dev->descriptor.iProduct,
		   cdev->product_name, CAIAQ_USB_STR_LEN);

	strscpy(card->driver, MODNAME, sizeof(card->driver));
	strscpy(card->shortname, cdev->product_name, sizeof(card->shortname));
	strscpy(card->mixername, cdev->product_name, sizeof(card->mixername));

	/* if the id was not passed as module option, fill it with a shortened
	 * version of the product string which does not contain any
	 * whitespaces */

	if (*card->id == '\0') {
		char id[sizeof(card->id)];

		memset(id, 0, sizeof(id));

		for (c = card->shortname, len = 0;
			*c && len < sizeof(card->id); c++)
			if (*c != ' ')
				id[len++] = *c;

		snd_card_set_id(card, id);
	}

	usb_make_path(usb_dev, usbpath, sizeof(usbpath));
	scnprintf(card->longname, sizeof(card->longname), "%s %s (%s)",
		       cdev->vendor_name, cdev->product_name, usbpath);

	setup_card(cdev);
	return 0;

 err_kill_urb:
	usb_kill_urb(&cdev->ep1_in_urb);
	return err;
}

static int snd_probe(struct usb_interface *intf,
		     const struct usb_device_id *id)
{
	int ret;
	struct snd_card *card = NULL;
	struct usb_device *usb_dev = interface_to_usbdev(intf);

	ret = create_card(usb_dev, intf, &card);

	if (ret < 0)
		return ret;

	usb_set_intfdata(intf, card);
	ret = init_card(caiaqdev(card));
	if (ret < 0) {
		dev_err(&usb_dev->dev, "unable to init card! (ret=%d)\n", ret);
		snd_card_free(card);
		return ret;
	}

	return 0;
}

static void snd_disconnect(struct usb_interface *intf)
{
	struct snd_card *card = usb_get_intfdata(intf);
	struct device *dev = intf->usb_dev;
	struct snd_usb_caiaqdev *cdev;

	if (!card)
		return;

	cdev = caiaqdev(card);
	dev_dbg(dev, "%s(%p)\n", __func__, intf);

	snd_card_disconnect(card);

#ifdef CONFIG_SND_USB_CAIAQ_INPUT
	snd_usb_caiaq_input_free(cdev);
#endif
	snd_usb_caiaq_audio_free(cdev);

	usb_kill_urb(&cdev->ep1_in_urb);
	usb_kill_urb(&cdev->midi_out_urb);

	snd_card_free(card);
	usb_reset_device(interface_to_usbdev(intf));
}


MODULE_DEVICE_TABLE(usb, snd_usb_id_table);
static struct usb_driver snd_usb_driver = {
	.name 		= MODNAME,
	.probe 		= snd_probe,
	.disconnect	= snd_disconnect,
	.id_table 	= snd_usb_id_table,
};

module_usb_driver(snd_usb_driver);
Commit	Line	Data
1a59d1b8	1	// SPDX-License-Identifier: GPL-2.0-or-later
523f1dce DM	2	/*
	3	* caiaq.c: ALSA driver for caiaq/NativeInstruments devices
	4	*
	5	* Copyright (c) 2007 Daniel Mack <daniel@caiaq.de>
	6	* Karsten Wiese <fzu@wemgehoertderstaat.de>
523f1dce DM	7	*/
523f1dce DM	8
523f1dce	9	#include <linux/moduleparam.h>
f1f6b8f6	10	#include <linux/device.h>
523f1dce	11	#include <linux/interrupt.h>
e431cf45 DM	12	#include <linux/module.h>
e431cf45 DM	13	#include <linux/init.h>
5a0e3ad6	14	#include <linux/gfp.h>
523f1dce	15	#include <linux/usb.h>
523f1dce	16	#include <sound/initval.h>
e431cf45	17	#include <sound/core.h>
523f1dce	18	#include <sound/pcm.h>
523f1dce	19
936e7d03 DM	20	#include "device.h"
	21	#include "audio.h"
	22	#include "midi.h"
	23	#include "control.h"
	24	#include "input.h"
523f1dce DM	25
523f1dce DM	26	MODULE_AUTHOR("Daniel Mack <daniel@caiaq.de>");
6008fd5a	27	MODULE_DESCRIPTION("caiaq USB audio");
523f1dce	28	MODULE_LICENSE("GPL");
523f1dce DM	29
	30	static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-max */
	31	static char* id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* Id for this card */
a67ff6a5	32	static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP; /* Enable this card */
523f1dce DM	33
	34	module_param_array(index, int, NULL, 0444);
	35	MODULE_PARM_DESC(index, "Index value for the caiaq sound device");
	36	module_param_array(id, charp, NULL, 0444);
	37	MODULE_PARM_DESC(id, "ID string for the caiaq soundcard.");
	38	module_param_array(enable, bool, NULL, 0444);
	39	MODULE_PARM_DESC(enable, "Enable the caiaq soundcard.");
	40
	41	enum {
	42	SAMPLERATE_44100 = 0,
	43	SAMPLERATE_48000 = 1,
	44	SAMPLERATE_96000 = 2,
	45	SAMPLERATE_192000 = 3,
	46	SAMPLERATE_88200 = 4,
	47	SAMPLERATE_INVALID = 0xff
	48	};
	49
	50	enum {
	51	DEPTH_NONE = 0,
	52	DEPTH_16 = 1,
	53	DEPTH_24 = 2,
	54	DEPTH_32 = 3
	55	};
	56
57ee11ea	57	static const struct usb_device_id snd_usb_id_table[] = {
523f1dce DM	58	{
	59	.match_flags = USB_DEVICE_ID_MATCH_DEVICE,
	60	.idVendor = USB_VID_NATIVEINSTRUMENTS,
9318dce5	61	.idProduct = USB_PID_RIGKONTROL2
523f1dce	62	},
ad1e34b5 DM	63	{
	64	.match_flags = USB_DEVICE_ID_MATCH_DEVICE,
	65	.idVendor = USB_VID_NATIVEINSTRUMENTS,
	66	.idProduct = USB_PID_RIGKONTROL3
	67	},
523f1dce DM	68	{
	69	.match_flags = USB_DEVICE_ID_MATCH_DEVICE,
	70	.idVendor = USB_VID_NATIVEINSTRUMENTS,
	71	.idProduct = USB_PID_KORECONTROLLER
	72	},
7829d0ec DM	73	{
	74	.match_flags = USB_DEVICE_ID_MATCH_DEVICE,
	75	.idVendor = USB_VID_NATIVEINSTRUMENTS,
	76	.idProduct = USB_PID_KORECONTROLLER2
	77	},
523f1dce DM	78	{
	79	.match_flags = USB_DEVICE_ID_MATCH_DEVICE,
	80	.idVendor = USB_VID_NATIVEINSTRUMENTS,
	81	.idProduct = USB_PID_AK1
	82	},
	83	{
	84	.match_flags = USB_DEVICE_ID_MATCH_DEVICE,
	85	.idVendor = USB_VID_NATIVEINSTRUMENTS,
	86	.idProduct = USB_PID_AUDIO8DJ
	87	},
f3e9d5d1 DM	88	{
	89	.match_flags = USB_DEVICE_ID_MATCH_DEVICE,
	90	.idVendor = USB_VID_NATIVEINSTRUMENTS,
	91	.idProduct = USB_PID_SESSIONIO
	92	},
2165592b DM	93	{
	94	.match_flags = USB_DEVICE_ID_MATCH_DEVICE,
	95	.idVendor = USB_VID_NATIVEINSTRUMENTS,
	96	.idProduct = USB_PID_GUITARRIGMOBILE
	97	},
	98	{
	99	.match_flags = USB_DEVICE_ID_MATCH_DEVICE,
	100	.idVendor = USB_VID_NATIVEINSTRUMENTS,
	101	.idProduct = USB_PID_AUDIO4DJ
	102	},
b30c4947 DM	103	{
	104	.match_flags = USB_DEVICE_ID_MATCH_DEVICE,
	105	.idVendor = USB_VID_NATIVEINSTRUMENTS,
	106	.idProduct = USB_PID_AUDIO2DJ
	107	},
6da7a2aa DM	108	{
	109	.match_flags = USB_DEVICE_ID_MATCH_DEVICE,
	110	.idVendor = USB_VID_NATIVEINSTRUMENTS,
	111	.idProduct = USB_PID_TRAKTORKONTROLX1
	112	},
15c5ab60 DM	113	{
	114	.match_flags = USB_DEVICE_ID_MATCH_DEVICE,
	115	.idVendor = USB_VID_NATIVEINSTRUMENTS,
	116	.idProduct = USB_PID_TRAKTORKONTROLS4
	117	},
df8d81a3 DM	118	{
	119	.match_flags = USB_DEVICE_ID_MATCH_DEVICE,
	120	.idVendor = USB_VID_NATIVEINSTRUMENTS,
	121	.idProduct = USB_PID_TRAKTORAUDIO2
	122	},
e653510a WL	123	{
	124	.match_flags = USB_DEVICE_ID_MATCH_DEVICE,
	125	.idVendor = USB_VID_NATIVEINSTRUMENTS,
	126	.idProduct = USB_PID_MASCHINECONTROLLER
	127	},
523f1dce DM	128	{ /* terminator */ }
	129	};
	130
	131	static void usb_ep1_command_reply_dispatch (struct urb* urb)
	132	{
	133	int ret;
2dad9402	134	struct device *dev = &urb->dev->dev;
1c8470ce	135	struct snd_usb_caiaqdev *cdev = urb->context;
523f1dce DM	136	unsigned char *buf = urb->transfer_buffer;
523f1dce DM	137
1c8470ce	138	if (urb->status \|\| !cdev) {
f1f6b8f6	139	dev_warn(dev, "received EP1 urb->status = %i\n", urb->status);
523f1dce DM	140	return;
	141	}
	142
	143	switch(buf[0]) {
	144	case EP1_CMD_GET_DEVICE_INFO:
1c8470ce DM	145	memcpy(&cdev->spec, buf+1, sizeof(struct caiaq_device_spec));
1c8470ce DM	146	cdev->spec.fw_version = le16_to_cpu(cdev->spec.fw_version);
f1f6b8f6	147	dev_dbg(dev, "device spec (firmware %d): audio: %d in, %d out, "
523f1dce	148	"MIDI: %d in, %d out, data alignment %d\n",
1c8470ce DM	149	cdev->spec.fw_version,
	150	cdev->spec.num_analog_audio_in,
	151	cdev->spec.num_analog_audio_out,
	152	cdev->spec.num_midi_in,
	153	cdev->spec.num_midi_out,
	154	cdev->spec.data_alignment);
	155
	156	cdev->spec_received++;
	157	wake_up(&cdev->ep1_wait_queue);
523f1dce DM	158	break;
523f1dce DM	159	case EP1_CMD_AUDIO_PARAMS:
1c8470ce DM	160	cdev->audio_parm_answer = buf[1];
1c8470ce DM	161	wake_up(&cdev->ep1_wait_queue);
523f1dce DM	162	break;
523f1dce DM	163	case EP1_CMD_MIDI_READ:
1c8470ce	164	snd_usb_caiaq_midi_handle_input(cdev, buf[1], buf + 3, buf[2]);
523f1dce	165	break;
8e3cd08e	166	case EP1_CMD_READ_IO:
1c8470ce	167	if (cdev->chip.usb_id ==
8e3cd08e	168	USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AUDIO8DJ)) {
1c8470ce DM	169	if (urb->actual_length > sizeof(cdev->control_state))
	170	urb->actual_length = sizeof(cdev->control_state);
	171	memcpy(cdev->control_state, buf + 1, urb->actual_length);
	172	wake_up(&cdev->ep1_wait_queue);
8e3cd08e DM	173	break;
8e3cd08e DM	174	}
523f1dce	175	#ifdef CONFIG_SND_USB_CAIAQ_INPUT
e2d413f9	176	fallthrough;
523f1dce DM	177	case EP1_CMD_READ_ERP:
523f1dce DM	178	case EP1_CMD_READ_ANALOG:
1c8470ce	179	snd_usb_caiaq_input_dispatch(cdev, buf, urb->actual_length);
523f1dce	180	#endif
8e3cd08e	181	break;
523f1dce DM	182	}
523f1dce DM	183
1c8470ce DM	184	cdev->ep1_in_urb.actual_length = 0;
1c8470ce DM	185	ret = usb_submit_urb(&cdev->ep1_in_urb, GFP_ATOMIC);
523f1dce	186	if (ret < 0)
f1f6b8f6	187	dev_err(dev, "unable to submit urb. OOM!?\n");
523f1dce DM	188	}
523f1dce DM	189
1c8470ce	190	int snd_usb_caiaq_send_command(struct snd_usb_caiaqdev *cdev,
8e3cd08e DM	191	unsigned char command,
	192	const unsigned char *buffer,
	193	int len)
523f1dce DM	194	{
523f1dce DM	195	int actual_len;
1c8470ce	196	struct usb_device *usb_dev = cdev->chip.dev;
523f1dce DM	197
	198	if (!usb_dev)
	199	return -EIO;
	200
	201	if (len > EP1_BUFSIZE - 1)
	202	len = EP1_BUFSIZE - 1;
	203
	204	if (buffer && len > 0)
1c8470ce	205	memcpy(cdev->ep1_out_buf+1, buffer, len);
9318dce5	206
1c8470ce	207	cdev->ep1_out_buf[0] = command;
523f1dce	208	return usb_bulk_msg(usb_dev, usb_sndbulkpipe(usb_dev, 1),
1c8470ce	209	cdev->ep1_out_buf, len+1, &actual_len, 200);
523f1dce DM	210	}
523f1dce DM	211
d2724de1 HG	212	int snd_usb_caiaq_send_command_bank(struct snd_usb_caiaqdev *cdev,
	213	unsigned char command,
	214	unsigned char bank,
	215	const unsigned char *buffer,
	216	int len)
	217	{
	218	int actual_len;
	219	struct usb_device *usb_dev = cdev->chip.dev;
	220
	221	if (!usb_dev)
	222	return -EIO;
	223
	224	if (len > EP1_BUFSIZE - 2)
	225	len = EP1_BUFSIZE - 2;
	226
	227	if (buffer && len > 0)
	228	memcpy(cdev->ep1_out_buf+2, buffer, len);
	229
	230	cdev->ep1_out_buf[0] = command;
	231	cdev->ep1_out_buf[1] = bank;
	232
	233	return usb_bulk_msg(usb_dev, usb_sndbulkpipe(usb_dev, 1),
	234	cdev->ep1_out_buf, len+2, &actual_len, 200);
	235	}
	236
1c8470ce	237	int snd_usb_caiaq_set_audio_params (struct snd_usb_caiaqdev *cdev,
523f1dce DM	238	int rate, int depth, int bpp)
	239	{
	240	int ret;
	241	char tmp[5];
f1f6b8f6	242	struct device *dev = caiaqdev_to_dev(cdev);
9318dce5	243
523f1dce DM	244	switch (rate) {
	245	case 44100: tmp[0] = SAMPLERATE_44100; break;
	246	case 48000: tmp[0] = SAMPLERATE_48000; break;
	247	case 88200: tmp[0] = SAMPLERATE_88200; break;
	248	case 96000: tmp[0] = SAMPLERATE_96000; break;
	249	case 192000: tmp[0] = SAMPLERATE_192000; break;
	250	default: return -EINVAL;
	251	}
	252
	253	switch (depth) {
	254	case 16: tmp[1] = DEPTH_16; break;
	255	case 24: tmp[1] = DEPTH_24; break;
	256	default: return -EINVAL;
	257	}
	258
	259	tmp[2] = bpp & 0xff;
	260	tmp[3] = bpp >> 8;
	261	tmp[4] = 1; /* packets per microframe */
	262
f1f6b8f6	263	dev_dbg(dev, "setting audio params: %d Hz, %d bits, %d bpp\n",
523f1dce DM	264	rate, depth, bpp);
523f1dce DM	265
1c8470ce DM	266	cdev->audio_parm_answer = -1;
1c8470ce DM	267	ret = snd_usb_caiaq_send_command(cdev, EP1_CMD_AUDIO_PARAMS,
8e3cd08e	268	tmp, sizeof(tmp));
523f1dce DM	269
	270	if (ret)
	271	return ret;
9318dce5	272
1c8470ce DM	273	if (!wait_event_timeout(cdev->ep1_wait_queue,
1c8470ce DM	274	cdev->audio_parm_answer >= 0, HZ))
523f1dce	275	return -EPIPE;
9318dce5	276
1c8470ce	277	if (cdev->audio_parm_answer != 1)
f1f6b8f6	278	dev_dbg(dev, "unable to set the device's audio params\n");
9311c9b4	279	else
1c8470ce	280	cdev->bpp = bpp;
523f1dce	281
1c8470ce	282	return cdev->audio_parm_answer == 1 ? 0 : -EINVAL;
523f1dce DM	283	}
523f1dce DM	284
1c8470ce	285	int snd_usb_caiaq_set_auto_msg(struct snd_usb_caiaqdev *cdev,
9318dce5	286	int digital, int analog, int erp)
523f1dce DM	287	{
523f1dce DM	288	char tmp[3] = { digital, analog, erp };
1c8470ce	289	return snd_usb_caiaq_send_command(cdev, EP1_CMD_AUTO_MSG,
8e3cd08e	290	tmp, sizeof(tmp));
523f1dce DM	291	}
523f1dce DM	292
1c8470ce	293	static void setup_card(struct snd_usb_caiaqdev *cdev)
523f1dce DM	294	{
523f1dce DM	295	int ret;
ad1e34b5	296	char val[4];
f1f6b8f6	297	struct device *dev = caiaqdev_to_dev(cdev);
9318dce5	298
523f1dce	299	/* device-specific startup specials */
1c8470ce	300	switch (cdev->chip.usb_id) {
523f1dce DM	301	case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_RIGKONTROL2):
	302	/* RigKontrol2 - display centered dash ('-') */
	303	val[0] = 0x00;
	304	val[1] = 0x00;
	305	val[2] = 0x01;
1c8470ce	306	snd_usb_caiaq_send_command(cdev, EP1_CMD_WRITE_IO, val, 3);
523f1dce	307	break;
ad1e34b5 DM	308	case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_RIGKONTROL3):
	309	/* RigKontrol2 - display two centered dashes ('--') */
	310	val[0] = 0x00;
	311	val[1] = 0x40;
	312	val[2] = 0x40;
	313	val[3] = 0x00;
1c8470ce	314	snd_usb_caiaq_send_command(cdev, EP1_CMD_WRITE_IO, val, 4);
ad1e34b5	315	break;
523f1dce DM	316	case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AK1):
	317	/* Audio Kontrol 1 - make USB-LED stop blinking */
	318	val[0] = 0x00;
1c8470ce	319	snd_usb_caiaq_send_command(cdev, EP1_CMD_WRITE_IO, val, 1);
8e3cd08e DM	320	break;
	321	case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AUDIO8DJ):
	322	/* Audio 8 DJ - trigger read of current settings */
1c8470ce DM	323	cdev->control_state[0] = 0xff;
	324	snd_usb_caiaq_set_auto_msg(cdev, 1, 0, 0);
	325	snd_usb_caiaq_send_command(cdev, EP1_CMD_READ_IO, NULL, 0);
8e3cd08e	326
1c8470ce DM	327	if (!wait_event_timeout(cdev->ep1_wait_queue,
1c8470ce DM	328	cdev->control_state[0] != 0xff, HZ))
8e3cd08e DM	329	return;
	330
	331	/* fix up some defaults */
1c8470ce DM	332	if ((cdev->control_state[1] != 2) \|\|
	333	(cdev->control_state[2] != 3) \|\|
	334	(cdev->control_state[4] != 2)) {
	335	cdev->control_state[1] = 2;
	336	cdev->control_state[2] = 3;
	337	cdev->control_state[4] = 2;
	338	snd_usb_caiaq_send_command(cdev,
	339	EP1_CMD_WRITE_IO, cdev->control_state, 6);
8e3cd08e DM	340	}
8e3cd08e DM	341
523f1dce DM	342	break;
523f1dce DM	343	}
9318dce5	344
1c8470ce DM	345	if (cdev->spec.num_analog_audio_out +
	346	cdev->spec.num_analog_audio_in +
	347	cdev->spec.num_digital_audio_out +
	348	cdev->spec.num_digital_audio_in > 0) {
	349	ret = snd_usb_caiaq_audio_init(cdev);
7829d0ec	350	if (ret < 0)
f1f6b8f6	351	dev_err(dev, "Unable to set up audio system (ret=%d)\n", ret);
7829d0ec	352	}
9318dce5	353
1c8470ce DM	354	if (cdev->spec.num_midi_in +
	355	cdev->spec.num_midi_out > 0) {
	356	ret = snd_usb_caiaq_midi_init(cdev);
7829d0ec	357	if (ret < 0)
f1f6b8f6	358	dev_err(dev, "Unable to set up MIDI system (ret=%d)\n", ret);
7829d0ec	359	}
523f1dce DM	360
523f1dce DM	361	#ifdef CONFIG_SND_USB_CAIAQ_INPUT
1c8470ce	362	ret = snd_usb_caiaq_input_init(cdev);
523f1dce	363	if (ret < 0)
f1f6b8f6	364	dev_err(dev, "Unable to set up input system (ret=%d)\n", ret);
523f1dce DM	365	#endif
	366
	367	/* finally, register the card and all its sub-instances */
1c8470ce	368	ret = snd_card_register(cdev->chip.card);
523f1dce	369	if (ret < 0) {
f1f6b8f6	370	dev_err(dev, "snd_card_register() returned %d\n", ret);
1c8470ce	371	snd_card_free(cdev->chip.card);
523f1dce	372	}
8e3cd08e	373
1c8470ce	374	ret = snd_usb_caiaq_control_init(cdev);
8e3cd08e	375	if (ret < 0)
f1f6b8f6	376	dev_err(dev, "Unable to set up control system (ret=%d)\n", ret);
523f1dce DM	377	}
523f1dce DM	378
563c2bf5 DM	379	static int create_card(struct usb_device *usb_dev,
	380	struct usb_interface *intf,
	381	struct snd_card **cardp)
523f1dce DM	382	{
523f1dce DM	383	int devnum;
bd7dd77c	384	int err;
523f1dce	385	struct snd_card *card;
1c8470ce	386	struct snd_usb_caiaqdev *cdev;
523f1dce DM	387
523f1dce DM	388	for (devnum = 0; devnum < SNDRV_CARDS; devnum++)
3dd446a7	389	if (enable[devnum])
523f1dce DM	390	break;
	391
	392	if (devnum >= SNDRV_CARDS)
51721f70	393	return -ENODEV;
523f1dce	394
874b8d42 TI	395	err = snd_card_new(&intf->dev,
	396	index[devnum], id[devnum], THIS_MODULE,
	397	sizeof(struct snd_usb_caiaqdev), &card);
bd7dd77c	398	if (err < 0)
51721f70	399	return err;
523f1dce	400
1c8470ce DM	401	cdev = caiaqdev(card);
	402	cdev->chip.dev = usb_dev;
	403	cdev->chip.card = card;
	404	cdev->chip.usb_id = USB_ID(le16_to_cpu(usb_dev->descriptor.idVendor),
8c5330a5	405	le16_to_cpu(usb_dev->descriptor.idProduct));
1c8470ce	406	spin_lock_init(&cdev->spinlock);
523f1dce	407
51721f70 TI	408	*cardp = card;
51721f70 TI	409	return 0;
523f1dce DM	410	}
523f1dce DM	411
1c8470ce	412	static int init_card(struct snd_usb_caiaqdev *cdev)
523f1dce	413	{
bafeee5b	414	char *c, usbpath[32];
1c8470ce DM	415	struct usb_device *usb_dev = cdev->chip.dev;
1c8470ce DM	416	struct snd_card *card = cdev->chip.card;
f1f6b8f6	417	struct device *dev = caiaqdev_to_dev(cdev);
bafeee5b	418	int err, len;
9318dce5	419
523f1dce	420	if (usb_set_interface(usb_dev, 0, 1) != 0) {
f1f6b8f6	421	dev_err(dev, "can't set alt interface.\n");
523f1dce DM	422	return -EIO;
	423	}
	424
1c8470ce DM	425	usb_init_urb(&cdev->ep1_in_urb);
1c8470ce DM	426	usb_init_urb(&cdev->midi_out_urb);
523f1dce	427
1c8470ce	428	usb_fill_bulk_urb(&cdev->ep1_in_urb, usb_dev,
523f1dce	429	usb_rcvbulkpipe(usb_dev, 0x1),
1c8470ce DM	430	cdev->ep1_in_buf, EP1_BUFSIZE,
1c8470ce DM	431	usb_ep1_command_reply_dispatch, cdev);
523f1dce	432
1c8470ce	433	usb_fill_bulk_urb(&cdev->midi_out_urb, usb_dev,
523f1dce	434	usb_sndbulkpipe(usb_dev, 0x1),
1c8470ce DM	435	cdev->midi_out_buf, EP1_BUFSIZE,
1c8470ce DM	436	snd_usb_caiaq_midi_output_done, cdev);
9318dce5	437
58fc7f73 TI	438	/* sanity checks of EPs before actually submitting */
	439	if (usb_urb_ep_type_check(&cdev->ep1_in_urb) \|\|
	440	usb_urb_ep_type_check(&cdev->midi_out_urb)) {
	441	dev_err(dev, "invalid EPs\n");
	442	return -EINVAL;
	443	}
	444
1c8470ce DM	445	init_waitqueue_head(&cdev->ep1_wait_queue);
1c8470ce DM	446	init_waitqueue_head(&cdev->prepare_wait_queue);
9318dce5	447
1c8470ce	448	if (usb_submit_urb(&cdev->ep1_in_urb, GFP_KERNEL) != 0)
523f1dce DM	449	return -EIO;
523f1dce DM	450
1c8470ce	451	err = snd_usb_caiaq_send_command(cdev, EP1_CMD_GET_DEVICE_INFO, NULL, 0);
523f1dce	452	if (err)
99fee508	453	goto err_kill_urb;
523f1dce	454
99fee508 TI	455	if (!wait_event_timeout(cdev->ep1_wait_queue, cdev->spec_received, HZ)) {
	456	err = -ENODEV;
	457	goto err_kill_urb;
	458	}
523f1dce DM	459
523f1dce DM	460	usb_string(usb_dev, usb_dev->descriptor.iManufacturer,
1c8470ce	461	cdev->vendor_name, CAIAQ_USB_STR_LEN);
9318dce5	462
523f1dce	463	usb_string(usb_dev, usb_dev->descriptor.iProduct,
1c8470ce	464	cdev->product_name, CAIAQ_USB_STR_LEN);
9318dce5	465
75b1a8f9 JP	466	strscpy(card->driver, MODNAME, sizeof(card->driver));
	467	strscpy(card->shortname, cdev->product_name, sizeof(card->shortname));
	468	strscpy(card->mixername, cdev->product_name, sizeof(card->mixername));
523f1dce	469
bafeee5b DM	470	/* if the id was not passed as module option, fill it with a shortened
	471	* version of the product string which does not contain any
	472	* whitespaces */
	473
	474	if (*card->id == '\0') {
	475	char id[sizeof(card->id)];
	476
	477	memset(id, 0, sizeof(id));
	478
	479	for (c = card->shortname, len = 0;
	480	*c && len < sizeof(card->id); c++)
	481	if (*c != ' ')
	482	id[len++] = *c;
	483
	484	snd_card_set_id(card, id);
	485	}
	486
1a1df6f0	487	usb_make_path(usb_dev, usbpath, sizeof(usbpath));
e9dde5a9	488	scnprintf(card->longname, sizeof(card->longname), "%s %s (%s)",
1c8470ce	489	cdev->vendor_name, cdev->product_name, usbpath);
523f1dce	490
1c8470ce	491	setup_card(cdev);
523f1dce	492	return 0;
99fee508 TI	493
	494	err_kill_urb:
	495	usb_kill_urb(&cdev->ep1_in_urb);
	496	return err;
523f1dce DM	497	}
523f1dce DM	498
14c56706	499	static int snd_probe(struct usb_interface *intf,
523f1dce DM	500	const struct usb_device_id *id)
	501	{
	502	int ret;
da185443	503	struct snd_card *card = NULL;
1c8470ce	504	struct usb_device *usb_dev = interface_to_usbdev(intf);
9318dce5	505
1c8470ce	506	ret = create_card(usb_dev, intf, &card);
9318dce5	507
51721f70 TI	508	if (ret < 0)
51721f70 TI	509	return ret;
9318dce5	510
f4e9749f	511	usb_set_intfdata(intf, card);
523f1dce DM	512	ret = init_card(caiaqdev(card));
523f1dce DM	513	if (ret < 0) {
f1f6b8f6	514	dev_err(&usb_dev->dev, "unable to init card! (ret=%d)\n", ret);
523f1dce DM	515	snd_card_free(card);
	516	return ret;
	517	}
9318dce5	518
523f1dce DM	519	return 0;
	520	}
	521
	522	static void snd_disconnect(struct usb_interface *intf)
	523	{
f4e9749f	524	struct snd_card *card = usb_get_intfdata(intf);
2dad9402 DM	525	struct device *dev = intf->usb_dev;
2dad9402 DM	526	struct snd_usb_caiaqdev *cdev;
523f1dce DM	527
	528	if (!card)
	529	return;
	530
2dad9402	531	cdev = caiaqdev(card);
f1f6b8f6 DM	532	dev_dbg(dev, "%s(%p)\n", __func__, intf);
f1f6b8f6 DM	533
523f1dce DM	534	snd_card_disconnect(card);
	535
	536	#ifdef CONFIG_SND_USB_CAIAQ_INPUT
1c8470ce	537	snd_usb_caiaq_input_free(cdev);
523f1dce	538	#endif
1c8470ce	539	snd_usb_caiaq_audio_free(cdev);
9318dce5	540
1c8470ce DM	541	usb_kill_urb(&cdev->ep1_in_urb);
1c8470ce DM	542	usb_kill_urb(&cdev->midi_out_urb);
9318dce5	543
523f1dce DM	544	snd_card_free(card);
	545	usb_reset_device(interface_to_usbdev(intf));
	546	}
	547
	548
	549	MODULE_DEVICE_TABLE(usb, snd_usb_id_table);
	550	static struct usb_driver snd_usb_driver = {
	551	.name = MODNAME,
	552	.probe = snd_probe,
	553	.disconnect = snd_disconnect,
	554	.id_table = snd_usb_id_table,
	555	};
	556
424f0750	557	module_usb_driver(snd_usb_driver);