[mirror_ubuntu-bionic-kernel.git] / sound / firewire / tascam / tascam.c

/*
 * tascam.c - a part of driver for TASCAM FireWire series
 *
 * Copyright (c) 2015 Takashi Sakamoto
 *
 * Licensed under the terms of the GNU General Public License, version 2.
 */

#include "tascam.h"

MODULE_DESCRIPTION("TASCAM FireWire series Driver");
MODULE_AUTHOR("Takashi Sakamoto <o-takashi@sakamocchi.jp>");
MODULE_LICENSE("GPL v2");

static const struct snd_tscm_spec model_specs[] = {
	{
		.name = "FW-1884",
		.has_adat = true,
		.has_spdif = true,
		.pcm_capture_analog_channels = 8,
		.pcm_playback_analog_channels = 8,
		.midi_capture_ports = 4,
		.midi_playback_ports = 4,
	},
	{
		.name = "FW-1082",
		.has_adat = false,
		.has_spdif = true,
		.pcm_capture_analog_channels = 8,
		.pcm_playback_analog_channels = 2,
		.midi_capture_ports = 2,
		.midi_playback_ports = 2,
	},
	{
		.name = "FW-1804",
		.has_adat = true,
		.has_spdif = true,
		.pcm_capture_analog_channels = 8,
		.pcm_playback_analog_channels = 2,
		.midi_capture_ports = 2,
		.midi_playback_ports = 4,
	},
};

static int identify_model(struct snd_tscm *tscm)
{
	struct fw_device *fw_dev = fw_parent_device(tscm->unit);
	const u32 *config_rom = fw_dev->config_rom;
	char model[9];
	unsigned int i;
	u8 c;

	if (fw_dev->config_rom_length < 30) {
		dev_err(&tscm->unit->device,
			"Configuration ROM is too short.\n");
		return -ENODEV;
	}

	/* Pick up model name from certain addresses. */
	for (i = 0; i < 8; i++) {
		c = config_rom[28 + i / 4] >> (24 - 8 * (i % 4));
		if (c == '\0')
			break;
		model[i] = c;
	}
	model[i] = '\0';

	for (i = 0; i < ARRAY_SIZE(model_specs); i++) {
		if (strcmp(model, model_specs[i].name) == 0) {
			tscm->spec = &model_specs[i];
			break;
		}
	}
	if (tscm->spec == NULL)
		return -ENODEV;

	strcpy(tscm->card->driver, "FW-TASCAM");
	strcpy(tscm->card->shortname, model);
	strcpy(tscm->card->mixername, model);
	snprintf(tscm->card->longname, sizeof(tscm->card->longname),
		 "TASCAM %s, GUID %08x%08x at %s, S%d", model,
		 fw_dev->config_rom[3], fw_dev->config_rom[4],
		 dev_name(&tscm->unit->device), 100 << fw_dev->max_speed);

	return 0;
}

static void tscm_free(struct snd_tscm *tscm)
{
	snd_tscm_transaction_unregister(tscm);
	snd_tscm_stream_destroy_duplex(tscm);

	fw_unit_put(tscm->unit);

	mutex_destroy(&tscm->mutex);
	kfree(tscm);
}

static void tscm_card_free(struct snd_card *card)
{
	tscm_free(card->private_data);
}

static void do_registration(struct work_struct *work)
{
	struct snd_tscm *tscm = container_of(work, struct snd_tscm, dwork.work);
	int err;

	err = snd_card_new(&tscm->unit->device, -1, NULL, THIS_MODULE, 0,
			   &tscm->card);
	if (err < 0)
		return;

	err = identify_model(tscm);
	if (err < 0)
		goto error;

	err = snd_tscm_transaction_register(tscm);
	if (err < 0)
		goto error;

	err = snd_tscm_stream_init_duplex(tscm);
	if (err < 0)
		goto error;

	snd_tscm_proc_init(tscm);

	err = snd_tscm_create_pcm_devices(tscm);
	if (err < 0)
		goto error;

	err = snd_tscm_create_midi_devices(tscm);
	if (err < 0)
		goto error;

	err = snd_tscm_create_hwdep_device(tscm);
	if (err < 0)
		goto error;

	err = snd_card_register(tscm->card);
	if (err < 0)
		goto error;

	/*
	 * After registered, tscm instance can be released corresponding to
	 * releasing the sound card instance.
	 */
	tscm->card->private_free = tscm_card_free;
	tscm->card->private_data = tscm;
	tscm->registered = true;

	return;
error:
	snd_tscm_transaction_unregister(tscm);
	snd_tscm_stream_destroy_duplex(tscm);
	snd_card_free(tscm->card);
	dev_info(&tscm->unit->device,
		 "Sound card registration failed: %d\n", err);
}

static int snd_tscm_probe(struct fw_unit *unit,
			   const struct ieee1394_device_id *entry)
{
	struct snd_tscm *tscm;

	/* Allocate this independent of sound card instance. */
	tscm = kzalloc(sizeof(struct snd_tscm), GFP_KERNEL);
	if (tscm == NULL)
		return -ENOMEM;

	/* initialize myself */
	tscm->unit = fw_unit_get(unit);
	dev_set_drvdata(&unit->device, tscm);

	mutex_init(&tscm->mutex);
	spin_lock_init(&tscm->lock);
	init_waitqueue_head(&tscm->hwdep_wait);

	/* Allocate and register this sound card later. */
	INIT_DEFERRABLE_WORK(&tscm->dwork, do_registration);
	snd_fw_schedule_registration(unit, &tscm->dwork);

	return 0;
}

static void snd_tscm_update(struct fw_unit *unit)
{
	struct snd_tscm *tscm = dev_get_drvdata(&unit->device);

	/* Postpone a workqueue for deferred registration. */
	if (!tscm->registered)
		snd_fw_schedule_registration(unit, &tscm->dwork);

	snd_tscm_transaction_reregister(tscm);

	/*
	 * After registration, userspace can start packet streaming, then this
	 * code block works fine.
	 */
	if (tscm->registered) {
		mutex_lock(&tscm->mutex);
		snd_tscm_stream_update_duplex(tscm);
		mutex_unlock(&tscm->mutex);
	}
}

static void snd_tscm_remove(struct fw_unit *unit)
{
	struct snd_tscm *tscm = dev_get_drvdata(&unit->device);

	/*
	 * Confirm to stop the work for registration before the sound card is
	 * going to be released. The work is not scheduled again because bus
	 * reset handler is not called anymore.
	 */
	cancel_delayed_work_sync(&tscm->dwork);

	if (tscm->registered) {
		/* No need to wait for releasing card object in this context. */
		snd_card_free_when_closed(tscm->card);
	} else {
		/* Don't forget this case. */
		tscm_free(tscm);
	}
}

static const struct ieee1394_device_id snd_tscm_id_table[] = {
	{
		.match_flags = IEEE1394_MATCH_VENDOR_ID |
			       IEEE1394_MATCH_SPECIFIER_ID,
		.vendor_id = 0x00022e,
		.specifier_id = 0x00022e,
	},
	/* FE-08 requires reverse-engineering because it just has faders. */
	{}
};
MODULE_DEVICE_TABLE(ieee1394, snd_tscm_id_table);

static struct fw_driver tscm_driver = {
	.driver = {
		.owner = THIS_MODULE,
		.name = "snd-firewire-tascam",
		.bus = &fw_bus_type,
	},
	.probe    = snd_tscm_probe,
	.update   = snd_tscm_update,
	.remove   = snd_tscm_remove,
	.id_table = snd_tscm_id_table,
};

static int __init snd_tscm_init(void)
{
	return driver_register(&tscm_driver.driver);
}

static void __exit snd_tscm_exit(void)
{
	driver_unregister(&tscm_driver.driver);
}

module_init(snd_tscm_init);
module_exit(snd_tscm_exit);
Commit	Line	Data
c0949b27 TS	1	/*
	2	* tascam.c - a part of driver for TASCAM FireWire series
	3	*
	4	* Copyright (c) 2015 Takashi Sakamoto
	5	*
	6	* Licensed under the terms of the GNU General Public License, version 2.
	7	*/
	8
	9	#include "tascam.h"
	10
	11	MODULE_DESCRIPTION("TASCAM FireWire series Driver");
	12	MODULE_AUTHOR("Takashi Sakamoto <o-takashi@sakamocchi.jp>");
	13	MODULE_LICENSE("GPL v2");
	14
782fbec7	15	static const struct snd_tscm_spec model_specs[] = {
6f81ba19 TS	16	{
	17	.name = "FW-1884",
	18	.has_adat = true,
	19	.has_spdif = true,
	20	.pcm_capture_analog_channels = 8,
	21	.pcm_playback_analog_channels = 8,
	22	.midi_capture_ports = 4,
	23	.midi_playback_ports = 4,
6f81ba19	24	},
6f81ba19 TS	25	{
	26	.name = "FW-1082",
	27	.has_adat = false,
	28	.has_spdif = true,
	29	.pcm_capture_analog_channels = 8,
	30	.pcm_playback_analog_channels = 2,
	31	.midi_capture_ports = 2,
	32	.midi_playback_ports = 2,
6f81ba19	33	},
3e78e151 TS	34	{
	35	.name = "FW-1804",
	36	.has_adat = true,
	37	.has_spdif = true,
	38	.pcm_capture_analog_channels = 8,
	39	.pcm_playback_analog_channels = 2,
	40	.midi_capture_ports = 2,
	41	.midi_playback_ports = 4,
3e78e151	42	},
6f81ba19 TS	43	};
6f81ba19 TS	44
53b3ffee	45	static int identify_model(struct snd_tscm *tscm)
c0949b27 TS	46	{
c0949b27 TS	47	struct fw_device *fw_dev = fw_parent_device(tscm->unit);
53b3ffee	48	const u32 *config_rom = fw_dev->config_rom;
9a30ae2d	49	char model[9];
53b3ffee TS	50	unsigned int i;
	51	u8 c;
	52
	53	if (fw_dev->config_rom_length < 30) {
	54	dev_err(&tscm->unit->device,
	55	"Configuration ROM is too short.\n");
	56	return -ENODEV;
	57	}
	58
	59	/* Pick up model name from certain addresses. */
	60	for (i = 0; i < 8; i++) {
	61	c = config_rom[28 + i / 4] >> (24 - 8 * (i % 4));
	62	if (c == '\0')
	63	break;
	64	model[i] = c;
	65	}
	66	model[i] = '\0';
	67
	68	for (i = 0; i < ARRAY_SIZE(model_specs); i++) {
	69	if (strcmp(model, model_specs[i].name) == 0) {
	70	tscm->spec = &model_specs[i];
	71	break;
	72	}
	73	}
	74	if (tscm->spec == NULL)
	75	return -ENODEV;
c0949b27 TS	76
	77	strcpy(tscm->card->driver, "FW-TASCAM");
	78	strcpy(tscm->card->shortname, model);
	79	strcpy(tscm->card->mixername, model);
	80	snprintf(tscm->card->longname, sizeof(tscm->card->longname),
53b3ffee	81	"TASCAM %s, GUID %08x%08x at %s, S%d", model,
bd04809b	82	fw_dev->config_rom[3], fw_dev->config_rom[4],
c0949b27 TS	83	dev_name(&tscm->unit->device), 100 << fw_dev->max_speed);
	84
	85	return 0;
	86	}
	87
b610386c	88	static void tscm_free(struct snd_tscm *tscm)
c0949b27	89	{
107cc012	90	snd_tscm_transaction_unregister(tscm);
35efa5c4 TS	91	snd_tscm_stream_destroy_duplex(tscm);
35efa5c4 TS	92
c0949b27 TS	93	fw_unit_put(tscm->unit);
	94
	95	mutex_destroy(&tscm->mutex);
f656779a	96	kfree(tscm);
c0949b27 TS	97	}
c0949b27 TS	98
b610386c	99	static void tscm_card_free(struct snd_card *card)
c0949b27	100	{
b610386c TS	101	tscm_free(card->private_data);
	102	}
	103
	104	static void do_registration(struct work_struct *work)
	105	{
	106	struct snd_tscm *tscm = container_of(work, struct snd_tscm, dwork.work);
c0949b27 TS	107	int err;
c0949b27 TS	108
b610386c TS	109	err = snd_card_new(&tscm->unit->device, -1, NULL, THIS_MODULE, 0,
b610386c TS	110	&tscm->card);
c0949b27	111	if (err < 0)
b610386c	112	return;
c0949b27	113
53b3ffee	114	err = identify_model(tscm);
c0949b27 TS	115	if (err < 0)
	116	goto error;
	117
b610386c	118	err = snd_tscm_transaction_register(tscm);
35efa5c4 TS	119	if (err < 0)
	120	goto error;
	121
b610386c	122	err = snd_tscm_stream_init_duplex(tscm);
e453df44 TS	123	if (err < 0)
	124	goto error;
	125
b610386c TS	126	snd_tscm_proc_init(tscm);
	127
	128	err = snd_tscm_create_pcm_devices(tscm);
107cc012 TS	129	if (err < 0)
	130	goto error;
	131
0db18e7e TS	132	err = snd_tscm_create_midi_devices(tscm);
	133	if (err < 0)
	134	goto error;
	135
e5e0c3dd TS	136	err = snd_tscm_create_hwdep_device(tscm);
	137	if (err < 0)
	138	goto error;
	139
b610386c	140	err = snd_card_register(tscm->card);
c0949b27 TS	141	if (err < 0)
	142	goto error;
	143
b610386c TS	144	/*
	145	* After registered, tscm instance can be released corresponding to
	146	* releasing the sound card instance.
	147	*/
	148	tscm->card->private_free = tscm_card_free;
	149	tscm->card->private_data = tscm;
	150	tscm->registered = true;
c0949b27	151
b610386c	152	return;
c0949b27	153	error:
b610386c TS	154	snd_tscm_transaction_unregister(tscm);
	155	snd_tscm_stream_destroy_duplex(tscm);
	156	snd_card_free(tscm->card);
	157	dev_info(&tscm->unit->device,
	158	"Sound card registration failed: %d\n", err);
	159	}
	160
	161	static int snd_tscm_probe(struct fw_unit *unit,
	162	const struct ieee1394_device_id *entry)
	163	{
	164	struct snd_tscm *tscm;
	165
	166	/* Allocate this independent of sound card instance. */
	167	tscm = kzalloc(sizeof(struct snd_tscm), GFP_KERNEL);
	168	if (tscm == NULL)
	169	return -ENOMEM;
	170
	171	/* initialize myself */
	172	tscm->unit = fw_unit_get(unit);
	173	dev_set_drvdata(&unit->device, tscm);
	174
	175	mutex_init(&tscm->mutex);
	176	spin_lock_init(&tscm->lock);
	177	init_waitqueue_head(&tscm->hwdep_wait);
	178
	179	/* Allocate and register this sound card later. */
	180	INIT_DEFERRABLE_WORK(&tscm->dwork, do_registration);
	181	snd_fw_schedule_registration(unit, &tscm->dwork);
	182
	183	return 0;
c0949b27 TS	184	}
	185
	186	static void snd_tscm_update(struct fw_unit *unit)
	187	{
35efa5c4 TS	188	struct snd_tscm *tscm = dev_get_drvdata(&unit->device);
35efa5c4 TS	189
b610386c TS	190	/* Postpone a workqueue for deferred registration. */
	191	if (!tscm->registered)
	192	snd_fw_schedule_registration(unit, &tscm->dwork);
	193
107cc012 TS	194	snd_tscm_transaction_reregister(tscm);
107cc012 TS	195
b610386c TS	196	/*
	197	* After registration, userspace can start packet streaming, then this
	198	* code block works fine.
	199	*/
	200	if (tscm->registered) {
	201	mutex_lock(&tscm->mutex);
	202	snd_tscm_stream_update_duplex(tscm);
	203	mutex_unlock(&tscm->mutex);
	204	}
c0949b27 TS	205	}
	206
	207	static void snd_tscm_remove(struct fw_unit *unit)
	208	{
	209	struct snd_tscm *tscm = dev_get_drvdata(&unit->device);
	210
b610386c TS	211	/*
	212	* Confirm to stop the work for registration before the sound card is
	213	* going to be released. The work is not scheduled again because bus
	214	* reset handler is not called anymore.
	215	*/
	216	cancel_delayed_work_sync(&tscm->dwork);
	217
	218	if (tscm->registered) {
	219	/* No need to wait for releasing card object in this context. */
	220	snd_card_free_when_closed(tscm->card);
	221	} else {
	222	/* Don't forget this case. */
	223	tscm_free(tscm);
	224	}
c0949b27 TS	225	}
	226
	227	static const struct ieee1394_device_id snd_tscm_id_table[] = {
c0949b27 TS	228	{
c0949b27 TS	229	.match_flags = IEEE1394_MATCH_VENDOR_ID \|
53b3ffee	230	IEEE1394_MATCH_SPECIFIER_ID,
c0949b27 TS	231	.vendor_id = 0x00022e,
c0949b27 TS	232	.specifier_id = 0x00022e,
c0949b27	233	},
c0949b27 TS	234	/* FE-08 requires reverse-engineering because it just has faders. */
	235	{}
	236	};
	237	MODULE_DEVICE_TABLE(ieee1394, snd_tscm_id_table);
	238
	239	static struct fw_driver tscm_driver = {
	240	.driver = {
	241	.owner = THIS_MODULE,
	242	.name = "snd-firewire-tascam",
	243	.bus = &fw_bus_type,
	244	},
	245	.probe = snd_tscm_probe,
	246	.update = snd_tscm_update,
	247	.remove = snd_tscm_remove,
	248	.id_table = snd_tscm_id_table,
	249	};
	250
	251	static int __init snd_tscm_init(void)
	252	{
	253	return driver_register(&tscm_driver.driver);
	254	}
	255
	256	static void __exit snd_tscm_exit(void)
	257	{
	258	driver_unregister(&tscm_driver.driver);
	259	}
	260
	261	module_init(snd_tscm_init);
	262	module_exit(snd_tscm_exit);