[mirror_ubuntu-jammy-kernel.git] / sound / usb / 6fire / chip.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * Linux driver for TerraTec DMX 6Fire USB
 *
 * Main routines and module definitions.
 *
 * Author:	Torsten Schenk <torsten.schenk@zoho.com>
 * Created:	Jan 01, 2011
 * Copyright:	(C) Torsten Schenk
 */

#include "chip.h"
#include "firmware.h"
#include "pcm.h"
#include "control.h"
#include "comm.h"
#include "midi.h"

#include <linux/moduleparam.h>
#include <linux/interrupt.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/gfp.h>
#include <sound/initval.h>

MODULE_AUTHOR("Torsten Schenk <torsten.schenk@zoho.com>");
MODULE_DESCRIPTION("TerraTec DMX 6Fire USB audio driver");
MODULE_LICENSE("GPL v2");

static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-max */
static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* Id for card */
static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP; /* Enable card */
static struct sfire_chip *chips[SNDRV_CARDS] = SNDRV_DEFAULT_PTR;
static struct usb_device *devices[SNDRV_CARDS] = SNDRV_DEFAULT_PTR;

module_param_array(index, int, NULL, 0444);
MODULE_PARM_DESC(index, "Index value for the 6fire sound device");
module_param_array(id, charp, NULL, 0444);
MODULE_PARM_DESC(id, "ID string for the 6fire sound device.");
module_param_array(enable, bool, NULL, 0444);
MODULE_PARM_DESC(enable, "Enable the 6fire sound device.");

static DEFINE_MUTEX(register_mutex);

static void usb6fire_chip_abort(struct sfire_chip *chip)
{
	if (chip) {
		if (chip->pcm)
			usb6fire_pcm_abort(chip);
		if (chip->midi)
			usb6fire_midi_abort(chip);
		if (chip->comm)
			usb6fire_comm_abort(chip);
		if (chip->control)
			usb6fire_control_abort(chip);
		if (chip->card) {
			snd_card_disconnect(chip->card);
			snd_card_free_when_closed(chip->card);
			chip->card = NULL;
		}
	}
}

static void usb6fire_chip_destroy(struct sfire_chip *chip)
{
	if (chip) {
		if (chip->pcm)
			usb6fire_pcm_destroy(chip);
		if (chip->midi)
			usb6fire_midi_destroy(chip);
		if (chip->comm)
			usb6fire_comm_destroy(chip);
		if (chip->control)
			usb6fire_control_destroy(chip);
		if (chip->card)
			snd_card_free(chip->card);
	}
}

static int usb6fire_chip_probe(struct usb_interface *intf,
			       const struct usb_device_id *usb_id)
{
	int ret;
	int i;
	struct sfire_chip *chip = NULL;
	struct usb_device *device = interface_to_usbdev(intf);
	int regidx = -1; /* index in module parameter array */
	struct snd_card *card = NULL;

	/* look if we already serve this card and return if so */
	mutex_lock(&register_mutex);
	for (i = 0; i < SNDRV_CARDS; i++) {
		if (devices[i] == device) {
			if (chips[i])
				chips[i]->intf_count++;
			usb_set_intfdata(intf, chips[i]);
			mutex_unlock(&register_mutex);
			return 0;
		} else if (!devices[i] && regidx < 0)
			regidx = i;
	}
	if (regidx < 0) {
		mutex_unlock(&register_mutex);
		dev_err(&intf->dev, "too many cards registered.\n");
		return -ENODEV;
	}
	devices[regidx] = device;
	mutex_unlock(&register_mutex);

	/* check, if firmware is present on device, upload it if not */
	ret = usb6fire_fw_init(intf);
	if (ret < 0)
		return ret;
	else if (ret == FW_NOT_READY) /* firmware update performed */
		return 0;

	/* if we are here, card can be registered in alsa. */
	if (usb_set_interface(device, 0, 0) != 0) {
		dev_err(&intf->dev, "can't set first interface.\n");
		return -EIO;
	}
	ret = snd_card_new(&intf->dev, index[regidx], id[regidx],
			   THIS_MODULE, sizeof(struct sfire_chip), &card);
	if (ret < 0) {
		dev_err(&intf->dev, "cannot create alsa card.\n");
		return ret;
	}
	strcpy(card->driver, "6FireUSB");
	strcpy(card->shortname, "TerraTec DMX6FireUSB");
	sprintf(card->longname, "%s at %d:%d", card->shortname,
			device->bus->busnum, device->devnum);

	chip = card->private_data;
	chips[regidx] = chip;
	chip->dev = device;
	chip->regidx = regidx;
	chip->intf_count = 1;
	chip->card = card;

	ret = usb6fire_comm_init(chip);
	if (ret < 0)
		goto destroy_chip;

	ret = usb6fire_midi_init(chip);
	if (ret < 0)
		goto destroy_chip;

	ret = usb6fire_pcm_init(chip);
	if (ret < 0)
		goto destroy_chip;

	ret = usb6fire_control_init(chip);
	if (ret < 0)
		goto destroy_chip;

	ret = snd_card_register(card);
	if (ret < 0) {
		dev_err(&intf->dev, "cannot register card.");
		goto destroy_chip;
	}
	usb_set_intfdata(intf, chip);
	return 0;

destroy_chip:
	usb6fire_chip_destroy(chip);
	return ret;
}

static void usb6fire_chip_disconnect(struct usb_interface *intf)
{
	struct sfire_chip *chip;

	chip = usb_get_intfdata(intf);
	if (chip) { /* if !chip, fw upload has been performed */
		chip->intf_count--;
		if (!chip->intf_count) {
			mutex_lock(&register_mutex);
			devices[chip->regidx] = NULL;
			chips[chip->regidx] = NULL;
			mutex_unlock(&register_mutex);

			chip->shutdown = true;
			usb6fire_chip_abort(chip);
			usb6fire_chip_destroy(chip);
		}
	}
}

static const struct usb_device_id device_table[] = {
	{
		.match_flags = USB_DEVICE_ID_MATCH_DEVICE,
		.idVendor = 0x0ccd,
		.idProduct = 0x0080
	},
	{}
};

MODULE_DEVICE_TABLE(usb, device_table);

static struct usb_driver usb_driver = {
	.name = "snd-usb-6fire",
	.probe = usb6fire_chip_probe,
	.disconnect = usb6fire_chip_disconnect,
	.id_table = device_table,
};

module_usb_driver(usb_driver);
Commit	Line	Data
2874c5fd	1	// SPDX-License-Identifier: GPL-2.0-or-later
c6d43ba8 TS	2	/*
	3	* Linux driver for TerraTec DMX 6Fire USB
	4	*
	5	* Main routines and module definitions.
	6	*
	7	* Author: Torsten Schenk <torsten.schenk@zoho.com>
	8	* Created: Jan 01, 2011
c6d43ba8	9	* Copyright: (C) Torsten Schenk
c6d43ba8 TS	10	*/
	11
	12	#include "chip.h"
	13	#include "firmware.h"
	14	#include "pcm.h"
	15	#include "control.h"
	16	#include "comm.h"
	17	#include "midi.h"
	18
	19	#include <linux/moduleparam.h>
	20	#include <linux/interrupt.h>
	21	#include <linux/module.h>
	22	#include <linux/init.h>
	23	#include <linux/gfp.h>
	24	#include <sound/initval.h>
	25
	26	MODULE_AUTHOR("Torsten Schenk <torsten.schenk@zoho.com>");
c596758f	27	MODULE_DESCRIPTION("TerraTec DMX 6Fire USB audio driver");
c6d43ba8	28	MODULE_LICENSE("GPL v2");
c6d43ba8 TS	29
	30	static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-max */
	31	static char id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; / Id for card */
a67ff6a5	32	static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP; /* Enable card */
c6d43ba8 TS	33	static struct sfire_chip *chips[SNDRV_CARDS] = SNDRV_DEFAULT_PTR;
	34	static struct usb_device *devices[SNDRV_CARDS] = SNDRV_DEFAULT_PTR;
	35
	36	module_param_array(index, int, NULL, 0444);
	37	MODULE_PARM_DESC(index, "Index value for the 6fire sound device");
	38	module_param_array(id, charp, NULL, 0444);
	39	MODULE_PARM_DESC(id, "ID string for the 6fire sound device.");
	40	module_param_array(enable, bool, NULL, 0444);
	41	MODULE_PARM_DESC(enable, "Enable the 6fire sound device.");
	42
	43	static DEFINE_MUTEX(register_mutex);
	44
	45	static void usb6fire_chip_abort(struct sfire_chip *chip)
	46	{
	47	if (chip) {
	48	if (chip->pcm)
	49	usb6fire_pcm_abort(chip);
	50	if (chip->midi)
	51	usb6fire_midi_abort(chip);
	52	if (chip->comm)
	53	usb6fire_comm_abort(chip);
	54	if (chip->control)
	55	usb6fire_control_abort(chip);
	56	if (chip->card) {
	57	snd_card_disconnect(chip->card);
	58	snd_card_free_when_closed(chip->card);
	59	chip->card = NULL;
	60	}
	61	}
	62	}
	63
	64	static void usb6fire_chip_destroy(struct sfire_chip *chip)
	65	{
	66	if (chip) {
	67	if (chip->pcm)
	68	usb6fire_pcm_destroy(chip);
	69	if (chip->midi)
	70	usb6fire_midi_destroy(chip);
	71	if (chip->comm)
	72	usb6fire_comm_destroy(chip);
	73	if (chip->control)
	74	usb6fire_control_destroy(chip);
	75	if (chip->card)
	76	snd_card_free(chip->card);
	77	}
	78	}
	79
87f9796a BP	80	static int usb6fire_chip_probe(struct usb_interface *intf,
87f9796a BP	81	const struct usb_device_id *usb_id)
c6d43ba8 TS	82	{
	83	int ret;
	84	int i;
	85	struct sfire_chip *chip = NULL;
	86	struct usb_device *device = interface_to_usbdev(intf);
	87	int regidx = -1; /* index in module parameter array */
	88	struct snd_card *card = NULL;
	89
	90	/* look if we already serve this card and return if so */
	91	mutex_lock(&register_mutex);
	92	for (i = 0; i < SNDRV_CARDS; i++) {
	93	if (devices[i] == device) {
	94	if (chips[i])
	95	chips[i]->intf_count++;
	96	usb_set_intfdata(intf, chips[i]);
	97	mutex_unlock(&register_mutex);
	98	return 0;
9b389a8a	99	} else if (!devices[i] && regidx < 0)
c6d43ba8 TS	100	regidx = i;
	101	}
	102	if (regidx < 0) {
	103	mutex_unlock(&register_mutex);
e3b3757b	104	dev_err(&intf->dev, "too many cards registered.\n");
c6d43ba8 TS	105	return -ENODEV;
	106	}
	107	devices[regidx] = device;
	108	mutex_unlock(&register_mutex);
	109
	110	/* check, if firmware is present on device, upload it if not */
	111	ret = usb6fire_fw_init(intf);
	112	if (ret < 0)
	113	return ret;
	114	else if (ret == FW_NOT_READY) /* firmware update performed */
	115	return 0;
	116
	117	/* if we are here, card can be registered in alsa. */
	118	if (usb_set_interface(device, 0, 0) != 0) {
e3b3757b	119	dev_err(&intf->dev, "can't set first interface.\n");
c6d43ba8 TS	120	return -EIO;
c6d43ba8 TS	121	}
874b8d42 TI	122	ret = snd_card_new(&intf->dev, index[regidx], id[regidx],
874b8d42 TI	123	THIS_MODULE, sizeof(struct sfire_chip), &card);
c6d43ba8	124	if (ret < 0) {
e3b3757b	125	dev_err(&intf->dev, "cannot create alsa card.\n");
c6d43ba8 TS	126	return ret;
	127	}
	128	strcpy(card->driver, "6FireUSB");
	129	strcpy(card->shortname, "TerraTec DMX6FireUSB");
	130	sprintf(card->longname, "%s at %d:%d", card->shortname,
	131	device->bus->busnum, device->devnum);
c6d43ba8 TS	132
	133	chip = card->private_data;
	134	chips[regidx] = chip;
	135	chip->dev = device;
	136	chip->regidx = regidx;
	137	chip->intf_count = 1;
	138	chip->card = card;
	139
	140	ret = usb6fire_comm_init(chip);
f804fff1 ME	141	if (ret < 0)
f804fff1 ME	142	goto destroy_chip;
c6d43ba8 TS	143
c6d43ba8 TS	144	ret = usb6fire_midi_init(chip);
f804fff1 ME	145	if (ret < 0)
f804fff1 ME	146	goto destroy_chip;
c6d43ba8 TS	147
c6d43ba8 TS	148	ret = usb6fire_pcm_init(chip);
f804fff1 ME	149	if (ret < 0)
f804fff1 ME	150	goto destroy_chip;
c6d43ba8 TS	151
c6d43ba8 TS	152	ret = usb6fire_control_init(chip);
f804fff1 ME	153	if (ret < 0)
f804fff1 ME	154	goto destroy_chip;
c6d43ba8 TS	155
	156	ret = snd_card_register(card);
	157	if (ret < 0) {
e3b3757b	158	dev_err(&intf->dev, "cannot register card.");
f804fff1	159	goto destroy_chip;
c6d43ba8 TS	160	}
	161	usb_set_intfdata(intf, chip);
	162	return 0;
f804fff1 ME	163
	164	destroy_chip:
	165	usb6fire_chip_destroy(chip);
	166	return ret;
c6d43ba8 TS	167	}
	168
	169	static void usb6fire_chip_disconnect(struct usb_interface *intf)
	170	{
	171	struct sfire_chip *chip;
c6d43ba8 TS	172
	173	chip = usb_get_intfdata(intf);
	174	if (chip) { /* if !chip, fw upload has been performed */
c6d43ba8 TS	175	chip->intf_count--;
	176	if (!chip->intf_count) {
	177	mutex_lock(&register_mutex);
	178	devices[chip->regidx] = NULL;
	179	chips[chip->regidx] = NULL;
	180	mutex_unlock(&register_mutex);
	181
	182	chip->shutdown = true;
	183	usb6fire_chip_abort(chip);
	184	usb6fire_chip_destroy(chip);
	185	}
	186	}
	187	}
	188
05d72cd5	189	static const struct usb_device_id device_table[] = {
c6d43ba8 TS	190	{
	191	.match_flags = USB_DEVICE_ID_MATCH_DEVICE,
	192	.idVendor = 0x0ccd,
	193	.idProduct = 0x0080
	194	},
	195	{}
	196	};
	197
	198	MODULE_DEVICE_TABLE(usb, device_table);
	199
424f0750	200	static struct usb_driver usb_driver = {
c6d43ba8 TS	201	.name = "snd-usb-6fire",
	202	.probe = usb6fire_chip_probe,
	203	.disconnect = usb6fire_chip_disconnect,
	204	.id_table = device_table,
	205	};
	206
424f0750	207	module_usb_driver(usb_driver);