[deliverable/linux.git] / sound / firewire / bebob / bebob.c

/*
 * bebob.c - a part of driver for BeBoB based devices
 *
 * Copyright (c) 2013-2014 Takashi Sakamoto
 *
 * Licensed under the terms of the GNU General Public License, version 2.
 */

/*
 * BeBoB is 'BridgeCo enhanced Breakout Box'. This is installed to firewire
 * devices with DM1000/DM1100/DM1500 chipset. It gives common way for host
 * system to handle BeBoB based devices.
 */

#include "bebob.h"

MODULE_DESCRIPTION("BridgeCo BeBoB driver");
MODULE_AUTHOR("Takashi Sakamoto <o-takashi@sakamocchi.jp>");
MODULE_LICENSE("GPL v2");

static int index[SNDRV_CARDS]	= SNDRV_DEFAULT_IDX;
static char *id[SNDRV_CARDS]	= SNDRV_DEFAULT_STR;
static bool enable[SNDRV_CARDS]	= SNDRV_DEFAULT_ENABLE_PNP;

module_param_array(index, int, NULL, 0444);
MODULE_PARM_DESC(index, "card index");
module_param_array(id, charp, NULL, 0444);
MODULE_PARM_DESC(id, "ID string");
module_param_array(enable, bool, NULL, 0444);
MODULE_PARM_DESC(enable, "enable BeBoB sound card");

static DEFINE_MUTEX(devices_mutex);
static DECLARE_BITMAP(devices_used, SNDRV_CARDS);

/* Offsets from information register. */
#define INFO_OFFSET_GUID		0x10
#define INFO_OFFSET_HW_MODEL_ID		0x18
#define INFO_OFFSET_HW_MODEL_REVISION	0x1c

#define VEN_EDIROL	0x000040ab
#define VEN_PRESONUS	0x00000a92
#define VEN_BRIDGECO	0x000007f5
#define VEN_MACKIE	0x0000000f
#define VEN_STANTON	0x00001260
#define VEN_TASCAM	0x0000022e
#define VEN_BEHRINGER	0x00001564
#define VEN_APOGEE	0x000003db
#define VEN_ESI		0x00000f1b
#define VEN_ACOUSTIC	0x00000002
#define VEN_CME		0x0000000a
#define VEN_PHONIC	0x00001496
#define VEN_LYNX	0x000019e5
#define VEN_ICON	0x00001a9e
#define VEN_PRISMSOUND	0x00001198
#define VEN_TERRATEC	0x00000aac
#define VEN_YAMAHA	0x0000a0de
#define VEN_FOCUSRITE	0x0000130e
#define VEN_MAUDIO1	0x00000d6c
#define VEN_MAUDIO2	0x000007f5

#define MODEL_FOCUSRITE_SAFFIRE_BOTH	0x00000000
#define MODEL_MAUDIO_AUDIOPHILE_BOTH	0x00010060
#define MODEL_MAUDIO_FW1814		0x00010071
#define MODEL_MAUDIO_PROJECTMIX		0x00010091

static int
name_device(struct snd_bebob *bebob, unsigned int vendor_id)
{
	struct fw_device *fw_dev = fw_parent_device(bebob->unit);
	char vendor[24] = {0};
	char model[32] = {0};
	u32 id;
	u32 data[2] = {0};
	u32 revision;
	int err;

	/* get vendor name from root directory */
	err = fw_csr_string(fw_dev->config_rom + 5, CSR_VENDOR,
			    vendor, sizeof(vendor));
	if (err < 0)
		goto end;

	/* get model name from unit directory */
	err = fw_csr_string(bebob->unit->directory, CSR_MODEL,
			    model, sizeof(model));
	if (err < 0)
		goto end;

	/* get hardware id */
	err = snd_bebob_read_quad(bebob->unit, INFO_OFFSET_HW_MODEL_ID,
				  &id);
	if (err < 0)
		goto end;

	/* get hardware revision */
	err = snd_bebob_read_quad(bebob->unit, INFO_OFFSET_HW_MODEL_REVISION,
				  &revision);
	if (err < 0)
		goto end;

	/* get GUID */
	err = snd_bebob_read_block(bebob->unit, INFO_OFFSET_GUID,
				   data, sizeof(data));
	if (err < 0)
		goto end;

	strcpy(bebob->card->driver, "BeBoB");
	strcpy(bebob->card->shortname, model);
	strcpy(bebob->card->mixername, model);
	snprintf(bebob->card->longname, sizeof(bebob->card->longname),
		 "%s %s (id:%d, rev:%d), GUID %08x%08x at %s, S%d",
		 vendor, model, id, revision,
		 data[0], data[1], dev_name(&bebob->unit->device),
		 100 << fw_dev->max_speed);
end:
	return err;
}

static void
bebob_card_free(struct snd_card *card)
{
	struct snd_bebob *bebob = card->private_data;

	if (bebob->card_index >= 0) {
		mutex_lock(&devices_mutex);
		clear_bit(bebob->card_index, devices_used);
		mutex_unlock(&devices_mutex);
	}

	mutex_destroy(&bebob->mutex);
}

static const struct snd_bebob_spec *
get_saffire_spec(struct fw_unit *unit)
{
	char name[24] = {0};

	if (fw_csr_string(unit->directory, CSR_MODEL, name, sizeof(name)) < 0)
		return NULL;

	if (strcmp(name, "SaffireLE") == 0)
		return &saffire_le_spec;
	else
		return &saffire_spec;
}

static bool
check_audiophile_booted(struct fw_unit *unit)
{
	char name[24] = {0};

	if (fw_csr_string(unit->directory, CSR_MODEL, name, sizeof(name)) < 0)
		return false;

	return strncmp(name, "FW Audiophile Bootloader", 15) != 0;
}

static int
bebob_probe(struct fw_unit *unit,
	    const struct ieee1394_device_id *entry)
{
	struct snd_card *card;
	struct snd_bebob *bebob;
	const struct snd_bebob_spec *spec;
	unsigned int card_index;
	int err;

	mutex_lock(&devices_mutex);

	for (card_index = 0; card_index < SNDRV_CARDS; card_index++) {
		if (!test_bit(card_index, devices_used) && enable[card_index])
			break;
	}
	if (card_index >= SNDRV_CARDS) {
		err = -ENOENT;
		goto end;
	}

	if ((entry->vendor_id == VEN_FOCUSRITE) &&
	    (entry->model_id == MODEL_FOCUSRITE_SAFFIRE_BOTH)) {
		spec = get_saffire_spec(unit);
	} else if ((entry->vendor_id == VEN_MAUDIO1) &&
		   (entry->model_id == MODEL_MAUDIO_AUDIOPHILE_BOTH) &&
		   !check_audiophile_booted(unit)) {
			err = 0;
			goto end;
	} else {
		spec = (const struct snd_bebob_spec *)entry->driver_data;
	}
	if (spec == NULL) {
		err = -ENOSYS;
		goto end;
	}

	err = snd_card_new(&unit->device, index[card_index], id[card_index],
			   THIS_MODULE, sizeof(struct snd_bebob), &card);
	if (err < 0)
		goto end;
	bebob = card->private_data;
	bebob->card_index = card_index;
	set_bit(card_index, devices_used);
	card->private_free = bebob_card_free;

	bebob->card = card;
	bebob->unit = unit;
	bebob->spec = spec;
	mutex_init(&bebob->mutex);
	spin_lock_init(&bebob->lock);
	init_waitqueue_head(&bebob->hwdep_wait);

	err = name_device(bebob, entry->vendor_id);
	if (err < 0)
		goto error;

	if ((entry->vendor_id == VEN_MAUDIO1) &&
	    (entry->model_id == MODEL_MAUDIO_FW1814))
		err = snd_bebob_maudio_special_discover(bebob, true);
	else if ((entry->vendor_id == VEN_MAUDIO1) &&
		 (entry->model_id == MODEL_MAUDIO_PROJECTMIX))
		err = snd_bebob_maudio_special_discover(bebob, false);
	else
		err = snd_bebob_stream_discover(bebob);
	if (err < 0)
		goto error;

	snd_bebob_proc_init(bebob);

	if ((bebob->midi_input_ports > 0) ||
	    (bebob->midi_output_ports > 0)) {
		err = snd_bebob_create_midi_devices(bebob);
		if (err < 0)
			goto error;
	}

	err = snd_bebob_create_pcm_devices(bebob);
	if (err < 0)
		goto error;

	err = snd_bebob_create_hwdep_device(bebob);
	if (err < 0)
		goto error;

	err = snd_bebob_stream_init_duplex(bebob);
	if (err < 0)
		goto error;

	err = snd_card_register(card);
	if (err < 0) {
		snd_bebob_stream_destroy_duplex(bebob);
		goto error;
	}

	dev_set_drvdata(&unit->device, bebob);
end:
	mutex_unlock(&devices_mutex);
	return err;
error:
	mutex_unlock(&devices_mutex);
	snd_card_free(card);
	return err;
}

static void
bebob_update(struct fw_unit *unit)
{
	struct snd_bebob *bebob = dev_get_drvdata(&unit->device);

	if (bebob == NULL)
		return;

	fcp_bus_reset(bebob->unit);
	snd_bebob_stream_update_duplex(bebob);
}

static void bebob_remove(struct fw_unit *unit)
{
	struct snd_bebob *bebob = dev_get_drvdata(&unit->device);

	if (bebob == NULL)
		return;

	kfree(bebob->maudio_special_quirk);

	snd_bebob_stream_destroy_duplex(bebob);
	snd_card_disconnect(bebob->card);
	snd_card_free_when_closed(bebob->card);
}

struct snd_bebob_rate_spec normal_rate_spec = {
	.get	= &snd_bebob_stream_get_rate,
	.set	= &snd_bebob_stream_set_rate
};
static const struct snd_bebob_spec spec_normal = {
	.clock	= NULL,
	.rate	= &normal_rate_spec,
	.meter	= NULL
};

static const struct ieee1394_device_id bebob_id_table[] = {
	/* Edirol, FA-66 */
	SND_BEBOB_DEV_ENTRY(VEN_EDIROL, 0x00010049, &spec_normal),
	/* Edirol, FA-101 */
	SND_BEBOB_DEV_ENTRY(VEN_EDIROL, 0x00010048, &spec_normal),
	/* Presonus, FIREBOX */
	SND_BEBOB_DEV_ENTRY(VEN_PRESONUS, 0x00010000, &spec_normal),
	/* PreSonus, FIREPOD/FP10 */
	SND_BEBOB_DEV_ENTRY(VEN_PRESONUS, 0x00010066, &spec_normal),
	/* PreSonus, Inspire1394 */
	SND_BEBOB_DEV_ENTRY(VEN_PRESONUS, 0x00010001, &spec_normal),
	/* BridgeCo, RDAudio1 */
	SND_BEBOB_DEV_ENTRY(VEN_BRIDGECO, 0x00010048, &spec_normal),
	/* BridgeCo, Audio5 */
	SND_BEBOB_DEV_ENTRY(VEN_BRIDGECO, 0x00010049, &spec_normal),
	/* Mackie, Onyx 1220/1620/1640 (Firewire I/O Card) */
	SND_BEBOB_DEV_ENTRY(VEN_MACKIE, 0x00010065, &spec_normal),
	/* Mackie, d.2 (Firewire Option) */
	SND_BEBOB_DEV_ENTRY(VEN_MACKIE, 0x00010067, &spec_normal),
	/* Stanton, ScratchAmp */
	SND_BEBOB_DEV_ENTRY(VEN_STANTON, 0x00000001, &spec_normal),
	/* Tascam, IF-FW DM */
	SND_BEBOB_DEV_ENTRY(VEN_TASCAM, 0x00010067, &spec_normal),
	/* Behringer, XENIX UFX 1204 */
	SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x00001204, &spec_normal),
	/* Behringer, XENIX UFX 1604 */
	SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x00001604, &spec_normal),
	/* Behringer, Digital Mixer X32 series (X-UF Card) */
	SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x00000006, &spec_normal),
	/* Apogee Electronics, Rosetta 200/400 (X-FireWire card) */
	/* Apogee Electronics, DA/AD/DD-16X (X-FireWire card) */
	SND_BEBOB_DEV_ENTRY(VEN_APOGEE, 0x00010048, &spec_normal),
	/* Apogee Electronics, Ensemble */
	SND_BEBOB_DEV_ENTRY(VEN_APOGEE, 0x00001eee, &spec_normal),
	/* ESI, Quatafire610 */
	SND_BEBOB_DEV_ENTRY(VEN_ESI, 0x00010064, &spec_normal),
	/* AcousticReality, eARMasterOne */
	SND_BEBOB_DEV_ENTRY(VEN_ACOUSTIC, 0x00000002, &spec_normal),
	/* CME, MatrixKFW */
	SND_BEBOB_DEV_ENTRY(VEN_CME, 0x00030000, &spec_normal),
	/* Phonic, Helix Board 12 MkII */
	SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00050000, &spec_normal),
	/* Phonic, Helix Board 18 MkII */
	SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00060000, &spec_normal),
	/* Phonic, Helix Board 24 MkII */
	SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00070000, &spec_normal),
	/* Phonic, Helix Board 12 Universal/18 Universal/24 Universal */
	SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00000000, &spec_normal),
	/* Lynx, Aurora 8/16 (LT-FW) */
	SND_BEBOB_DEV_ENTRY(VEN_LYNX, 0x00000001, &spec_normal),
	/* ICON, FireXon */
	SND_BEBOB_DEV_ENTRY(VEN_ICON, 0x00000001, &spec_normal),
	/* PrismSound, Orpheus */
	SND_BEBOB_DEV_ENTRY(VEN_PRISMSOUND, 0x00010048, &spec_normal),
	/* PrismSound, ADA-8XR */
	SND_BEBOB_DEV_ENTRY(VEN_PRISMSOUND, 0x0000ada8, &spec_normal),
	/* TerraTec Electronic GmbH, PHASE 88 Rack FW */
	SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000003, &phase88_rack_spec),
	/* TerraTec Electronic GmbH, PHASE 24 FW */
	SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000004, &phase24_series_spec),
	/* TerraTec Electronic GmbH, Phase X24 FW */
	SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000007, &phase24_series_spec),
	/* TerraTec Electronic GmbH, EWS MIC2/MIC8 */
	SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000005, &spec_normal),
	/* Terratec Electronic GmbH, Aureon 7.1 Firewire */
	SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000002, &spec_normal),
	/* Yamaha, GO44 */
	SND_BEBOB_DEV_ENTRY(VEN_YAMAHA, 0x0010000b, &yamaha_go_spec),
	/* YAMAHA, GO46 */
	SND_BEBOB_DEV_ENTRY(VEN_YAMAHA, 0x0010000c, &yamaha_go_spec),
	/* Focusrite, SaffirePro 26 I/O */
	SND_BEBOB_DEV_ENTRY(VEN_FOCUSRITE, 0x00000003, &saffirepro_26_spec),
	/* Focusrite, SaffirePro 10 I/O */
	SND_BEBOB_DEV_ENTRY(VEN_FOCUSRITE, 0x00000006, &saffirepro_10_spec),
	/* Focusrite, Saffire(no label and LE) */
	SND_BEBOB_DEV_ENTRY(VEN_FOCUSRITE, MODEL_FOCUSRITE_SAFFIRE_BOTH,
			    &saffire_spec),
	/* M-Audio, Firewire 410 */
	SND_BEBOB_DEV_ENTRY(VEN_MAUDIO2, 0x00010046, &maudio_fw410_spec),
	/* M-Audio, Firewire Audiophile */
	SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, MODEL_MAUDIO_AUDIOPHILE_BOTH,
			    &maudio_audiophile_spec),
	/* M-Audio, Firewire Solo */
	SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x00010062, &maudio_solo_spec),
	/* M-Audio, Ozonic */
	SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x0000000a, &maudio_ozonic_spec),
	/* M-Audio NRV10 */
	SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x00010081, &maudio_nrv10_spec),
	/* M-Audio, ProFireLightbridge */
	SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x000100a1, &spec_normal),
	/* Firewire 1814 */
	SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, MODEL_MAUDIO_FW1814,
			    &maudio_special_spec),
	/* M-Audio ProjectMix */
	SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, MODEL_MAUDIO_PROJECTMIX,
			    &maudio_special_spec),
	/* IDs are unknown but able to be supported */
	/*  Apogee, Mini-ME Firewire */
	/*  Apogee, Mini-DAC Firewire */
	/*  Behringer, F-Control Audio 1616 */
	/*  Behringer, F-Control Audio 610 */
	/*  Cakawalk, Sonar Power Studio 66 */
	/*  CME, UF400e */
	/*  ESI, Quotafire XL */
	/*  Infrasonic, DewX */
	/*  Infrasonic, Windy6 */
	/*  Mackie, Digital X Bus x.200 */
	/*  Mackie, Digital X Bus x.400 */
	/*  Phonic, HB 12 */
	/*  Phonic, HB 24 */
	/*  Phonic, HB 18 */
	/*  Phonic, FireFly 202 */
	/*  Phonic, FireFly 302 */
	/*  Rolf Spuler, Firewire Guitar */
	{}
};
MODULE_DEVICE_TABLE(ieee1394, bebob_id_table);

static struct fw_driver bebob_driver = {
	.driver = {
		.owner	= THIS_MODULE,
		.name	= "snd-bebob",
		.bus	= &fw_bus_type,
	},
	.probe    = bebob_probe,
	.update	  = bebob_update,
	.remove   = bebob_remove,
	.id_table = bebob_id_table,
};

static int __init
snd_bebob_init(void)
{
	return driver_register(&bebob_driver.driver);
}

static void __exit
snd_bebob_exit(void)
{
	driver_unregister(&bebob_driver.driver);
	mutex_destroy(&devices_mutex);
}

module_init(snd_bebob_init);
module_exit(snd_bebob_exit);
Commit	Line	Data
fd6f4b0d TS	1	/*
	2	* bebob.c - a part of driver for BeBoB based devices
	3	*
	4	* Copyright (c) 2013-2014 Takashi Sakamoto
	5	*
	6	* Licensed under the terms of the GNU General Public License, version 2.
	7	*/
	8
	9	/*
	10	* BeBoB is 'BridgeCo enhanced Breakout Box'. This is installed to firewire
	11	* devices with DM1000/DM1100/DM1500 chipset. It gives common way for host
	12	* system to handle BeBoB based devices.
	13	*/
	14
	15	#include "bebob.h"
	16
	17	MODULE_DESCRIPTION("BridgeCo BeBoB driver");
	18	MODULE_AUTHOR("Takashi Sakamoto <o-takashi@sakamocchi.jp>");
	19	MODULE_LICENSE("GPL v2");
	20
	21	static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;
	22	static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;
	23	static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;
	24
	25	module_param_array(index, int, NULL, 0444);
	26	MODULE_PARM_DESC(index, "card index");
	27	module_param_array(id, charp, NULL, 0444);
	28	MODULE_PARM_DESC(id, "ID string");
	29	module_param_array(enable, bool, NULL, 0444);
	30	MODULE_PARM_DESC(enable, "enable BeBoB sound card");
	31
	32	static DEFINE_MUTEX(devices_mutex);
	33	static DECLARE_BITMAP(devices_used, SNDRV_CARDS);
	34
	35	/* Offsets from information register. */
	36	#define INFO_OFFSET_GUID 0x10
	37	#define INFO_OFFSET_HW_MODEL_ID 0x18
	38	#define INFO_OFFSET_HW_MODEL_REVISION 0x1c
	39
	40	#define VEN_EDIROL 0x000040ab
	41	#define VEN_PRESONUS 0x00000a92
	42	#define VEN_BRIDGECO 0x000007f5
	43	#define VEN_MACKIE 0x0000000f
	44	#define VEN_STANTON 0x00001260
	45	#define VEN_TASCAM 0x0000022e
	46	#define VEN_BEHRINGER 0x00001564
	47	#define VEN_APOGEE 0x000003db
	48	#define VEN_ESI 0x00000f1b
	49	#define VEN_ACOUSTIC 0x00000002
	50	#define VEN_CME 0x0000000a
	51	#define VEN_PHONIC 0x00001496
	52	#define VEN_LYNX 0x000019e5
	53	#define VEN_ICON 0x00001a9e
	54	#define VEN_PRISMSOUND 0x00001198
326b9cac	55	#define VEN_TERRATEC 0x00000aac
8ac98a35	56	#define VEN_YAMAHA 0x0000a0de
25784ec2	57	#define VEN_FOCUSRITE 0x0000130e
9076c22d TS	58	#define VEN_MAUDIO1 0x00000d6c
9076c22d TS	59	#define VEN_MAUDIO2 0x000007f5
25784ec2 TS	60
25784ec2 TS	61	#define MODEL_FOCUSRITE_SAFFIRE_BOTH 0x00000000
9076c22d	62	#define MODEL_MAUDIO_AUDIOPHILE_BOTH 0x00010060
3149ac48 TS	63	#define MODEL_MAUDIO_FW1814 0x00010071
3149ac48 TS	64	#define MODEL_MAUDIO_PROJECTMIX 0x00010091
fd6f4b0d TS	65
	66	static int
	67	name_device(struct snd_bebob *bebob, unsigned int vendor_id)
	68	{
	69	struct fw_device *fw_dev = fw_parent_device(bebob->unit);
	70	char vendor[24] = {0};
	71	char model[32] = {0};
	72	u32 id;
	73	u32 data[2] = {0};
	74	u32 revision;
	75	int err;
	76
	77	/* get vendor name from root directory */
	78	err = fw_csr_string(fw_dev->config_rom + 5, CSR_VENDOR,
	79	vendor, sizeof(vendor));
	80	if (err < 0)
	81	goto end;
	82
	83	/* get model name from unit directory */
	84	err = fw_csr_string(bebob->unit->directory, CSR_MODEL,
	85	model, sizeof(model));
	86	if (err < 0)
	87	goto end;
	88
	89	/* get hardware id */
	90	err = snd_bebob_read_quad(bebob->unit, INFO_OFFSET_HW_MODEL_ID,
	91	&id);
	92	if (err < 0)
	93	goto end;
	94
	95	/* get hardware revision */
	96	err = snd_bebob_read_quad(bebob->unit, INFO_OFFSET_HW_MODEL_REVISION,
	97	&revision);
	98	if (err < 0)
	99	goto end;
	100
	101	/* get GUID */
	102	err = snd_bebob_read_block(bebob->unit, INFO_OFFSET_GUID,
	103	data, sizeof(data));
	104	if (err < 0)
	105	goto end;
	106
	107	strcpy(bebob->card->driver, "BeBoB");
	108	strcpy(bebob->card->shortname, model);
	109	strcpy(bebob->card->mixername, model);
	110	snprintf(bebob->card->longname, sizeof(bebob->card->longname),
	111	"%s %s (id:%d, rev:%d), GUID %08x%08x at %s, S%d",
	112	vendor, model, id, revision,
	113	data[0], data[1], dev_name(&bebob->unit->device),
	114	100 << fw_dev->max_speed);
	115	end:
	116	return err;
	117	}
	118
	119	static void
	120	bebob_card_free(struct snd_card *card)
	121	{
	122	struct snd_bebob *bebob = card->private_data;
	123
	124	if (bebob->card_index >= 0) {
	125	mutex_lock(&devices_mutex);
	126	clear_bit(bebob->card_index, devices_used);
	127	mutex_unlock(&devices_mutex);
	128	}
129
130	mutex_destroy(&bebob->mutex);
131	}
132
25784ec2 TS	133	static const struct snd_bebob_spec *
	134	get_saffire_spec(struct fw_unit *unit)
	135	{
	136	char name[24] = {0};
	137
	138	if (fw_csr_string(unit->directory, CSR_MODEL, name, sizeof(name)) < 0)
	139	return NULL;
	140
	141	if (strcmp(name, "SaffireLE") == 0)
	142	return &saffire_le_spec;
	143	else
	144	return &saffire_spec;
	145	}
	146
9076c22d TS	147	static bool
	148	check_audiophile_booted(struct fw_unit *unit)
	149	{
	150	char name[24] = {0};
	151
	152	if (fw_csr_string(unit->directory, CSR_MODEL, name, sizeof(name)) < 0)
	153	return false;
	154
	155	return strncmp(name, "FW Audiophile Bootloader", 15) != 0;
	156	}
	157
fd6f4b0d TS	158	static int
	159	bebob_probe(struct fw_unit *unit,
	160	const struct ieee1394_device_id *entry)
	161	{
	162	struct snd_card *card;
	163	struct snd_bebob *bebob;
1fc9522a	164	const struct snd_bebob_spec *spec;
fd6f4b0d TS	165	unsigned int card_index;
	166	int err;
	167
	168	mutex_lock(&devices_mutex);
	169
	170	for (card_index = 0; card_index < SNDRV_CARDS; card_index++) {
	171	if (!test_bit(card_index, devices_used) && enable[card_index])
	172	break;
	173	}
	174	if (card_index >= SNDRV_CARDS) {
	175	err = -ENOENT;
	176	goto end;
	177	}
	178
25784ec2	179	if ((entry->vendor_id == VEN_FOCUSRITE) &&
9076c22d	180	(entry->model_id == MODEL_FOCUSRITE_SAFFIRE_BOTH)) {
25784ec2	181	spec = get_saffire_spec(unit);
9076c22d TS	182	} else if ((entry->vendor_id == VEN_MAUDIO1) &&
	183	(entry->model_id == MODEL_MAUDIO_AUDIOPHILE_BOTH) &&
	184	!check_audiophile_booted(unit)) {
	185	err = 0;
	186	goto end;
	187	} else {
25784ec2	188	spec = (const struct snd_bebob_spec *)entry->driver_data;
9076c22d	189	}
1fc9522a TS	190	if (spec == NULL) {
	191	err = -ENOSYS;
	192	goto end;
	193	}
	194
fd6f4b0d TS	195	err = snd_card_new(&unit->device, index[card_index], id[card_index],
	196	THIS_MODULE, sizeof(struct snd_bebob), &card);
	197	if (err < 0)
	198	goto end;
	199	bebob = card->private_data;
	200	bebob->card_index = card_index;
	201	set_bit(card_index, devices_used);
	202	card->private_free = bebob_card_free;
	203
	204	bebob->card = card;
	205	bebob->unit = unit;
1fc9522a	206	bebob->spec = spec;
fd6f4b0d TS	207	mutex_init(&bebob->mutex);
fd6f4b0d TS	208	spin_lock_init(&bebob->lock);
618eabea	209	init_waitqueue_head(&bebob->hwdep_wait);
fd6f4b0d TS	210
	211	err = name_device(bebob, entry->vendor_id);
	212	if (err < 0)
	213	goto error;
	214
3149ac48 TS	215	if ((entry->vendor_id == VEN_MAUDIO1) &&
	216	(entry->model_id == MODEL_MAUDIO_FW1814))
	217	err = snd_bebob_maudio_special_discover(bebob, true);
	218	else if ((entry->vendor_id == VEN_MAUDIO1) &&
	219	(entry->model_id == MODEL_MAUDIO_PROJECTMIX))
	220	err = snd_bebob_maudio_special_discover(bebob, false);
	221	else
	222	err = snd_bebob_stream_discover(bebob);
fd6f4b0d TS	223	if (err < 0)
fd6f4b0d TS	224	goto error;
eb7b3a05	225
ad9697ba TS	226	snd_bebob_proc_init(bebob);
ad9697ba TS	227
248b7802 TS	228	if ((bebob->midi_input_ports > 0) \|\|
	229	(bebob->midi_output_ports > 0)) {
	230	err = snd_bebob_create_midi_devices(bebob);
	231	if (err < 0)
	232	goto error;
	233	}
	234
fbbebd2c TS	235	err = snd_bebob_create_pcm_devices(bebob);
	236	if (err < 0)
	237	goto error;
	238
618eabea TS	239	err = snd_bebob_create_hwdep_device(bebob);
	240	if (err < 0)
	241	goto error;
	242
eb7b3a05 TS	243	err = snd_bebob_stream_init_duplex(bebob);
	244	if (err < 0)
	245	goto error;
	246
	247	err = snd_card_register(card);
	248	if (err < 0) {
	249	snd_bebob_stream_destroy_duplex(bebob);
	250	goto error;
	251	}
	252
fd6f4b0d TS	253	dev_set_drvdata(&unit->device, bebob);
	254	end:
	255	mutex_unlock(&devices_mutex);
	256	return err;
	257	error:
	258	mutex_unlock(&devices_mutex);
	259	snd_card_free(card);
	260	return err;
	261	}
	262
	263	static void
	264	bebob_update(struct fw_unit *unit)
	265	{
	266	struct snd_bebob *bebob = dev_get_drvdata(&unit->device);
9076c22d TS	267
	268	if (bebob == NULL)
	269	return;
	270
fd6f4b0d	271	fcp_bus_reset(bebob->unit);
eb7b3a05	272	snd_bebob_stream_update_duplex(bebob);
fd6f4b0d TS	273	}
	274
	275	static void bebob_remove(struct fw_unit *unit)
	276	{
	277	struct snd_bebob *bebob = dev_get_drvdata(&unit->device);
9076c22d TS	278
	279	if (bebob == NULL)
	280	return;
	281
3149ac48 TS	282	kfree(bebob->maudio_special_quirk);
3149ac48 TS	283
eb7b3a05	284	snd_bebob_stream_destroy_duplex(bebob);
fd6f4b0d TS	285	snd_card_disconnect(bebob->card);
	286	snd_card_free_when_closed(bebob->card);
	287	}
	288
1fc9522a TS	289	struct snd_bebob_rate_spec normal_rate_spec = {
	290	.get = &snd_bebob_stream_get_rate,
	291	.set = &snd_bebob_stream_set_rate
	292	};
	293	static const struct snd_bebob_spec spec_normal = {
	294	.clock = NULL,
	295	.rate = &normal_rate_spec,
	296	.meter = NULL
	297	};
	298
fd6f4b0d TS	299	static const struct ieee1394_device_id bebob_id_table[] = {
fd6f4b0d TS	300	/* Edirol, FA-66 */
1fc9522a	301	SND_BEBOB_DEV_ENTRY(VEN_EDIROL, 0x00010049, &spec_normal),
fd6f4b0d	302	/* Edirol, FA-101 */
1fc9522a	303	SND_BEBOB_DEV_ENTRY(VEN_EDIROL, 0x00010048, &spec_normal),
fd6f4b0d	304	/* Presonus, FIREBOX */
1fc9522a	305	SND_BEBOB_DEV_ENTRY(VEN_PRESONUS, 0x00010000, &spec_normal),
fd6f4b0d	306	/* PreSonus, FIREPOD/FP10 */
1fc9522a	307	SND_BEBOB_DEV_ENTRY(VEN_PRESONUS, 0x00010066, &spec_normal),
fd6f4b0d	308	/* PreSonus, Inspire1394 */
1fc9522a	309	SND_BEBOB_DEV_ENTRY(VEN_PRESONUS, 0x00010001, &spec_normal),
fd6f4b0d	310	/* BridgeCo, RDAudio1 */
1fc9522a	311	SND_BEBOB_DEV_ENTRY(VEN_BRIDGECO, 0x00010048, &spec_normal),
fd6f4b0d	312	/* BridgeCo, Audio5 */
1fc9522a	313	SND_BEBOB_DEV_ENTRY(VEN_BRIDGECO, 0x00010049, &spec_normal),
fd6f4b0d	314	/* Mackie, Onyx 1220/1620/1640 (Firewire I/O Card) */
1fc9522a	315	SND_BEBOB_DEV_ENTRY(VEN_MACKIE, 0x00010065, &spec_normal),
fd6f4b0d	316	/* Mackie, d.2 (Firewire Option) */
1fc9522a	317	SND_BEBOB_DEV_ENTRY(VEN_MACKIE, 0x00010067, &spec_normal),
fd6f4b0d	318	/* Stanton, ScratchAmp */
1fc9522a	319	SND_BEBOB_DEV_ENTRY(VEN_STANTON, 0x00000001, &spec_normal),
fd6f4b0d	320	/* Tascam, IF-FW DM */
1fc9522a	321	SND_BEBOB_DEV_ENTRY(VEN_TASCAM, 0x00010067, &spec_normal),
fd6f4b0d	322	/* Behringer, XENIX UFX 1204 */
1fc9522a	323	SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x00001204, &spec_normal),
fd6f4b0d	324	/* Behringer, XENIX UFX 1604 */
1fc9522a	325	SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x00001604, &spec_normal),
fd6f4b0d	326	/* Behringer, Digital Mixer X32 series (X-UF Card) */
1fc9522a	327	SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x00000006, &spec_normal),
fd6f4b0d TS	328	/* Apogee Electronics, Rosetta 200/400 (X-FireWire card) */
fd6f4b0d TS	329	/* Apogee Electronics, DA/AD/DD-16X (X-FireWire card) */
1fc9522a	330	SND_BEBOB_DEV_ENTRY(VEN_APOGEE, 0x00010048, &spec_normal),
fd6f4b0d	331	/* Apogee Electronics, Ensemble */
1fc9522a	332	SND_BEBOB_DEV_ENTRY(VEN_APOGEE, 0x00001eee, &spec_normal),
fd6f4b0d	333	/* ESI, Quatafire610 */
1fc9522a	334	SND_BEBOB_DEV_ENTRY(VEN_ESI, 0x00010064, &spec_normal),
fd6f4b0d	335	/* AcousticReality, eARMasterOne */
1fc9522a	336	SND_BEBOB_DEV_ENTRY(VEN_ACOUSTIC, 0x00000002, &spec_normal),
fd6f4b0d	337	/* CME, MatrixKFW */
1fc9522a	338	SND_BEBOB_DEV_ENTRY(VEN_CME, 0x00030000, &spec_normal),
fd6f4b0d	339	/* Phonic, Helix Board 12 MkII */
1fc9522a	340	SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00050000, &spec_normal),
fd6f4b0d	341	/* Phonic, Helix Board 18 MkII */
1fc9522a	342	SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00060000, &spec_normal),
fd6f4b0d	343	/* Phonic, Helix Board 24 MkII */
1fc9522a	344	SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00070000, &spec_normal),
fd6f4b0d	345	/* Phonic, Helix Board 12 Universal/18 Universal/24 Universal */
1fc9522a	346	SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00000000, &spec_normal),
fd6f4b0d	347	/* Lynx, Aurora 8/16 (LT-FW) */
1fc9522a	348	SND_BEBOB_DEV_ENTRY(VEN_LYNX, 0x00000001, &spec_normal),
fd6f4b0d	349	/* ICON, FireXon */
1fc9522a	350	SND_BEBOB_DEV_ENTRY(VEN_ICON, 0x00000001, &spec_normal),
fd6f4b0d	351	/* PrismSound, Orpheus */
1fc9522a	352	SND_BEBOB_DEV_ENTRY(VEN_PRISMSOUND, 0x00010048, &spec_normal),
fd6f4b0d	353	/* PrismSound, ADA-8XR */
1fc9522a	354	SND_BEBOB_DEV_ENTRY(VEN_PRISMSOUND, 0x0000ada8, &spec_normal),
326b9cac TS	355	/* TerraTec Electronic GmbH, PHASE 88 Rack FW */
	356	SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000003, &phase88_rack_spec),
	357	/* TerraTec Electronic GmbH, PHASE 24 FW */
	358	SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000004, &phase24_series_spec),
	359	/* TerraTec Electronic GmbH, Phase X24 FW */
	360	SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000007, &phase24_series_spec),
	361	/* TerraTec Electronic GmbH, EWS MIC2/MIC8 */
	362	SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000005, &spec_normal),
	363	/* Terratec Electronic GmbH, Aureon 7.1 Firewire */
	364	SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000002, &spec_normal),
8ac98a35 TS	365	/* Yamaha, GO44 */
	366	SND_BEBOB_DEV_ENTRY(VEN_YAMAHA, 0x0010000b, &yamaha_go_spec),
	367	/* YAMAHA, GO46 */
	368	SND_BEBOB_DEV_ENTRY(VEN_YAMAHA, 0x0010000c, &yamaha_go_spec),
25784ec2 TS	369	/* Focusrite, SaffirePro 26 I/O */
	370	SND_BEBOB_DEV_ENTRY(VEN_FOCUSRITE, 0x00000003, &saffirepro_26_spec),
	371	/* Focusrite, SaffirePro 10 I/O */
	372	SND_BEBOB_DEV_ENTRY(VEN_FOCUSRITE, 0x00000006, &saffirepro_10_spec),
	373	/* Focusrite, Saffire(no label and LE) */
	374	SND_BEBOB_DEV_ENTRY(VEN_FOCUSRITE, MODEL_FOCUSRITE_SAFFIRE_BOTH,
	375	&saffire_spec),
9076c22d TS	376	/* M-Audio, Firewire 410 */
	377	SND_BEBOB_DEV_ENTRY(VEN_MAUDIO2, 0x00010046, &maudio_fw410_spec),
	378	/* M-Audio, Firewire Audiophile */
	379	SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, MODEL_MAUDIO_AUDIOPHILE_BOTH,
	380	&maudio_audiophile_spec),
	381	/* M-Audio, Firewire Solo */
	382	SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x00010062, &maudio_solo_spec),
	383	/* M-Audio, Ozonic */
	384	SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x0000000a, &maudio_ozonic_spec),
	385	/* M-Audio NRV10 */
	386	SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x00010081, &maudio_nrv10_spec),
	387	/* M-Audio, ProFireLightbridge */
	388	SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x000100a1, &spec_normal),
3149ac48 TS	389	/* Firewire 1814 */
	390	SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, MODEL_MAUDIO_FW1814,
	391	&maudio_special_spec),
	392	/* M-Audio ProjectMix */
	393	SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, MODEL_MAUDIO_PROJECTMIX,
	394	&maudio_special_spec),
fd6f4b0d TS	395	/* IDs are unknown but able to be supported */
	396	/* Apogee, Mini-ME Firewire */
	397	/* Apogee, Mini-DAC Firewire */
	398	/* Behringer, F-Control Audio 1616 */
	399	/* Behringer, F-Control Audio 610 */
	400	/* Cakawalk, Sonar Power Studio 66 */
	401	/* CME, UF400e */
	402	/* ESI, Quotafire XL */
	403	/* Infrasonic, DewX */
	404	/* Infrasonic, Windy6 */
	405	/* Mackie, Digital X Bus x.200 */
	406	/* Mackie, Digital X Bus x.400 */
	407	/* Phonic, HB 12 */
	408	/* Phonic, HB 24 */
	409	/* Phonic, HB 18 */
	410	/* Phonic, FireFly 202 */
	411	/* Phonic, FireFly 302 */
	412	/* Rolf Spuler, Firewire Guitar */
	413	{}
	414	};
	415	MODULE_DEVICE_TABLE(ieee1394, bebob_id_table);
	416
	417	static struct fw_driver bebob_driver = {
	418	.driver = {
	419	.owner = THIS_MODULE,
	420	.name = "snd-bebob",
	421	.bus = &fw_bus_type,
	422	},
	423	.probe = bebob_probe,
	424	.update = bebob_update,
	425	.remove = bebob_remove,
	426	.id_table = bebob_id_table,
	427	};
	428
	429	static int __init
	430	snd_bebob_init(void)
	431	{
	432	return driver_register(&bebob_driver.driver);
	433	}
	434
	435	static void __exit
	436	snd_bebob_exit(void)
	437	{
	438	driver_unregister(&bebob_driver.driver);
	439	mutex_destroy(&devices_mutex);
	440	}
	441
	442	module_init(snd_bebob_init);
	443	module_exit(snd_bebob_exit);