sound/firewire/bebob/bebob.c - kernel/msm-4.9 - Gitiles

 /*
  * 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_BEBOB_VERSION	0x08
 #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_MACKIE1	0x0000000f
 #define VEN_MACKIE2	0x00000ff2
 #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 VEN_DIGIDESIGN	0x00a07e

 #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)
 {
 	struct fw_device *fw_dev = fw_parent_device(bebob->unit);
 	char vendor[24] = {0};
 	char model[32] = {0};
 	u32 hw_id;
 	u32 data[2] = {0};
 	u32 revision;
 	u32 version;
 	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,
 				  &hw_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;

 	err = snd_bebob_read_quad(bebob->unit, INFO_OFFSET_BEBOB_VERSION,
 				  &version);
 	if (err < 0)
 		goto end;
 	bebob->version = version;

 	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, hw_id, revision,
 		 data[0], data[1], dev_name(&bebob->unit->device),
 		 100 << fw_dev->max_speed);
 end:
 	return err;
 }

 static void bebob_free(struct snd_bebob *bebob)
 {
 	snd_bebob_stream_destroy_duplex(bebob);
 	fw_unit_put(bebob->unit);

 	kfree(bebob->maudio_special_quirk);

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

 /*
  * This module releases the FireWire unit data after all ALSA character devices
  * are released by applications. This is for releasing stream data or finishing
  * transactions safely. Thus at returning from .remove(), this module still keep
  * references for the unit.
  */
 static void
 bebob_card_free(struct snd_card *card)
 {
 	struct snd_bebob *bebob = card->private_data;

 	mutex_lock(&devices_mutex);
 	clear_bit(bebob->card_index, devices_used);
 	mutex_unlock(&devices_mutex);

 	bebob_free(card->private_data);
 }

 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 void
 do_registration(struct work_struct *work)
 {
 	struct snd_bebob *bebob =
 			container_of(work, struct snd_bebob, dwork.work);
 	unsigned int card_index;
 	int err;

 	if (bebob->registered)
 		return;

 	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) {
 		mutex_unlock(&devices_mutex);
 		return;
 	}

 	err = snd_card_new(&bebob->unit->device, index[card_index],
 			   id[card_index], THIS_MODULE, 0, &bebob->card);
 	if (err < 0) {
 		mutex_unlock(&devices_mutex);
 		return;
 	}

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

 	if (bebob->spec == &maudio_special_spec) {
 		if (bebob->entry->model_id == MODEL_MAUDIO_FW1814)
 			err = snd_bebob_maudio_special_discover(bebob, true);
 		else
 			err = snd_bebob_maudio_special_discover(bebob, false);
 	} else {
 		err = snd_bebob_stream_discover(bebob);
 	}
 	if (err < 0)
 		goto error;

 	err = snd_bebob_stream_init_duplex(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_card_register(bebob->card);
 	if (err < 0)
 		goto error;

 	set_bit(card_index, devices_used);
 	mutex_unlock(&devices_mutex);

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

 	return;
 error:
 	mutex_unlock(&devices_mutex);
 	snd_bebob_stream_destroy_duplex(bebob);
 	kfree(bebob->maudio_special_quirk);
 	bebob->maudio_special_quirk = NULL;
 	snd_card_free(bebob->card);
 	dev_info(&bebob->unit->device,
 		 "Sound card registration failed: %d\n", err);
 }

 static int
 bebob_probe(struct fw_unit *unit, const struct ieee1394_device_id *entry)
 {
 	struct snd_bebob *bebob;
 	const struct snd_bebob_spec *spec;

 	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))
 		spec = NULL;
 	else
 		spec = (const struct snd_bebob_spec *)entry->driver_data;

 	if (spec == NULL) {
 		if (entry->vendor_id == VEN_MAUDIO1 ||
 		    entry->vendor_id == VEN_MAUDIO2)
 			return snd_bebob_maudio_load_firmware(unit);
 		else
 			return -ENODEV;
 	}

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

 	bebob->unit = fw_unit_get(unit);
 	bebob->entry = entry;
 	bebob->spec = spec;
 	dev_set_drvdata(&unit->device, bebob);

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

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

 	if (entry->vendor_id != VEN_MAUDIO1 ||
 	    (entry->model_id != MODEL_MAUDIO_FW1814 &&
 	     entry->model_id != MODEL_MAUDIO_PROJECTMIX)) {
 		snd_fw_schedule_registration(unit, &bebob->dwork);
 	} else {
 		/*
 		 * This is a workaround. This bus reset seems to have an effect
 		 * to make devices correctly handling transactions. Without
 		 * this, the devices have gap_count mismatch. This causes much
 		 * failure of transaction.
 		 *
 		 * Just after registration, user-land application receive
 		 * signals from dbus and starts I/Os. To avoid I/Os till the
 		 * future bus reset, registration is done in next update().
 		 */
 		fw_schedule_bus_reset(fw_parent_device(bebob->unit)->card,
 				      false, true);
 	}

 	return 0;
 }

 /*
  * This driver doesn't update streams in bus reset handler.
  *
  * DM1000/ DM1100/DM1500 chipsets with BeBoB firmware transfer packets with
  * discontinued counter at bus reset. This discontinuity is immediately
  * detected in packet streaming layer, then it sets XRUN to PCM substream.
  *
  * ALSA PCM applications can know the XRUN by getting -EPIPE from PCM operation.
  * Then, they can recover the PCM substream by executing ioctl(2) with
  * SNDRV_PCM_IOCTL_PREPARE. 'struct snd_pcm_ops.prepare' is called and drivers
  * restart packet streaming.
  *
  * The above processing may be executed before this bus-reset handler is
  * executed. When this handler updates streams with current isochronous
  * channels, the streams already have the current ones.
  */
 static void
 bebob_update(struct fw_unit *unit)
 {
 	struct snd_bebob *bebob = dev_get_drvdata(&unit->device);

 	if (bebob == NULL)
 		return;

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

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

 	if (bebob == NULL)
 		return;

 	/*
 	 * 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(&bebob->dwork);

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

 static const 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_MACKIE2, 0x00010065, &spec_normal),
 	/* Mackie, d.2 (Firewire Option) */
 	SND_BEBOB_DEV_ENTRY(VEN_MACKIE1, 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),
 	/*  Behringer, F-Control Audio 1616 */
 	SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x001616, &spec_normal),
 	/*  Behringer, F-Control Audio 610 */
 	SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x000610, &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, 0x01eeee, &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, &yamaha_terratec_spec),
 	/* TerraTec Electronic GmbH, Phase X24 FW */
 	SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000007, &yamaha_terratec_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_terratec_spec),
 	/* YAMAHA, GO46 */
 	SND_BEBOB_DEV_ENTRY(VEN_YAMAHA, 0x0010000c, &yamaha_terratec_spec),
 	/* Focusrite, SaffirePro 26 I/O */
 	SND_BEBOB_DEV_ENTRY(VEN_FOCUSRITE, 0x00000003, &saffirepro_26_spec),
 	/* Focusrite, SaffirePro 10 I/O */
 	{
 		// The combination of vendor_id and model_id is the same as the
 		// same as the one of Liquid Saffire 56.
 		.match_flags	= IEEE1394_MATCH_VENDOR_ID |
 				  IEEE1394_MATCH_MODEL_ID |
 				  IEEE1394_MATCH_SPECIFIER_ID |
 				  IEEE1394_MATCH_VERSION,
 		.vendor_id	= VEN_FOCUSRITE,
 		.model_id	= 0x000006,
 		.specifier_id	= 0x00a02d,
 		.version	= 0x010001,
 		.driver_data	= (kernel_ulong_t)&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, 0x00010058, NULL),	/* bootloader */
 	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, 0x00010070, NULL),	/* bootloader */
 	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),
 	/* Digidesign Mbox 2 Pro */
 	SND_BEBOB_DEV_ENTRY(VEN_DIGIDESIGN, 0x0000a9, &spec_normal),
 	/* IDs are unknown but able to be supported */
 	/*  Apogee, Mini-ME Firewire */
 	/*  Apogee, Mini-DAC Firewire */
 	/*  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);
 }

 module_init(snd_bebob_init);
 module_exit(snd_bebob_exit);
	/*
	* 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_BEBOB_VERSION 0x08
	#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_MACKIE1 0x0000000f
	#define VEN_MACKIE2 0x00000ff2
	#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 VEN_DIGIDESIGN 0x00a07e

	#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)
	{
	struct fw_device *fw_dev = fw_parent_device(bebob->unit);
	char vendor[24] = {0};
	char model[32] = {0};
	u32 hw_id;
	u32 data[2] = {0};
	u32 revision;
	u32 version;
	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,
	&hw_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;

	err = snd_bebob_read_quad(bebob->unit, INFO_OFFSET_BEBOB_VERSION,
	&version);
	if (err < 0)
	goto end;
	bebob->version = version;

	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, hw_id, revision,
	data[0], data[1], dev_name(&bebob->unit->device),
	100 << fw_dev->max_speed);
	end:
	return err;
	}

	static void bebob_free(struct snd_bebob *bebob)
	{
	snd_bebob_stream_destroy_duplex(bebob);
	fw_unit_put(bebob->unit);

	kfree(bebob->maudio_special_quirk);

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

	/*
	* This module releases the FireWire unit data after all ALSA character devices
	* are released by applications. This is for releasing stream data or finishing
	* transactions safely. Thus at returning from .remove(), this module still keep
	* references for the unit.
	*/
	static void
	bebob_card_free(struct snd_card *card)
	{
	struct snd_bebob *bebob = card->private_data;

	mutex_lock(&devices_mutex);
	clear_bit(bebob->card_index, devices_used);
	mutex_unlock(&devices_mutex);

	bebob_free(card->private_data);
	}

	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 void
	do_registration(struct work_struct *work)
	{
	struct snd_bebob *bebob =
	container_of(work, struct snd_bebob, dwork.work);
	unsigned int card_index;
	int err;

	if (bebob->registered)
	return;

	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) {
	mutex_unlock(&devices_mutex);
	return;
	}

	err = snd_card_new(&bebob->unit->device, index[card_index],
	id[card_index], THIS_MODULE, 0, &bebob->card);
	if (err < 0) {
	mutex_unlock(&devices_mutex);
	return;
	}

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

	if (bebob->spec == &maudio_special_spec) {
	if (bebob->entry->model_id == MODEL_MAUDIO_FW1814)
	err = snd_bebob_maudio_special_discover(bebob, true);
	else
	err = snd_bebob_maudio_special_discover(bebob, false);
	} else {
	err = snd_bebob_stream_discover(bebob);
	}
	if (err < 0)
	goto error;

	err = snd_bebob_stream_init_duplex(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_card_register(bebob->card);
	if (err < 0)
	goto error;

	set_bit(card_index, devices_used);
	mutex_unlock(&devices_mutex);

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

	return;
	error:
	mutex_unlock(&devices_mutex);
	snd_bebob_stream_destroy_duplex(bebob);
	kfree(bebob->maudio_special_quirk);
	bebob->maudio_special_quirk = NULL;
	snd_card_free(bebob->card);
	dev_info(&bebob->unit->device,
	"Sound card registration failed: %d\n", err);
	}

	static int
	bebob_probe(struct fw_unit unit, const struct ieee1394_device_id entry)
	{
	struct snd_bebob *bebob;
	const struct snd_bebob_spec *spec;

	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))
	spec = NULL;
	else
	spec = (const struct snd_bebob_spec *)entry->driver_data;

	if (spec == NULL) {
	if (entry->vendor_id == VEN_MAUDIO1 \|\|
	entry->vendor_id == VEN_MAUDIO2)
	return snd_bebob_maudio_load_firmware(unit);
	else
	return -ENODEV;
	}

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

	bebob->unit = fw_unit_get(unit);
	bebob->entry = entry;
	bebob->spec = spec;
	dev_set_drvdata(&unit->device, bebob);

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

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

	if (entry->vendor_id != VEN_MAUDIO1 \|\|
	(entry->model_id != MODEL_MAUDIO_FW1814 &&
	entry->model_id != MODEL_MAUDIO_PROJECTMIX)) {
	snd_fw_schedule_registration(unit, &bebob->dwork);
	} else {
	/*
	* This is a workaround. This bus reset seems to have an effect
	* to make devices correctly handling transactions. Without
	* this, the devices have gap_count mismatch. This causes much
	* failure of transaction.
	*
	* Just after registration, user-land application receive
	* signals from dbus and starts I/Os. To avoid I/Os till the
	* future bus reset, registration is done in next update().
	*/
	fw_schedule_bus_reset(fw_parent_device(bebob->unit)->card,
	false, true);
	}

	return 0;
	}

	/*
	* This driver doesn't update streams in bus reset handler.
	*
	* DM1000/ DM1100/DM1500 chipsets with BeBoB firmware transfer packets with
	* discontinued counter at bus reset. This discontinuity is immediately
	* detected in packet streaming layer, then it sets XRUN to PCM substream.
	*
	* ALSA PCM applications can know the XRUN by getting -EPIPE from PCM operation.
	* Then, they can recover the PCM substream by executing ioctl(2) with
	* SNDRV_PCM_IOCTL_PREPARE. 'struct snd_pcm_ops.prepare' is called and drivers
	* restart packet streaming.
	*
	* The above processing may be executed before this bus-reset handler is
	* executed. When this handler updates streams with current isochronous
	* channels, the streams already have the current ones.
	*/
	static void
	bebob_update(struct fw_unit *unit)
	{
	struct snd_bebob *bebob = dev_get_drvdata(&unit->device);

	if (bebob == NULL)
	return;

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

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

	if (bebob == NULL)
	return;

	/*
	* 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(&bebob->dwork);

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

	static const 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_MACKIE2, 0x00010065, &spec_normal),
	/* Mackie, d.2 (Firewire Option) */
	SND_BEBOB_DEV_ENTRY(VEN_MACKIE1, 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),
	/* Behringer, F-Control Audio 1616 */
	SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x001616, &spec_normal),
	/* Behringer, F-Control Audio 610 */
	SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x000610, &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, 0x01eeee, &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, &yamaha_terratec_spec),
	/* TerraTec Electronic GmbH, Phase X24 FW */
	SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000007, &yamaha_terratec_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_terratec_spec),
	/* YAMAHA, GO46 */
	SND_BEBOB_DEV_ENTRY(VEN_YAMAHA, 0x0010000c, &yamaha_terratec_spec),
	/* Focusrite, SaffirePro 26 I/O */
	SND_BEBOB_DEV_ENTRY(VEN_FOCUSRITE, 0x00000003, &saffirepro_26_spec),
	/* Focusrite, SaffirePro 10 I/O */
	{
	// The combination of vendor_id and model_id is the same as the
	// same as the one of Liquid Saffire 56.
	.match_flags = IEEE1394_MATCH_VENDOR_ID \|
	IEEE1394_MATCH_MODEL_ID \|
	IEEE1394_MATCH_SPECIFIER_ID \|
	IEEE1394_MATCH_VERSION,
	.vendor_id = VEN_FOCUSRITE,
	.model_id = 0x000006,
	.specifier_id = 0x00a02d,
	.version = 0x010001,
	.driver_data = (kernel_ulong_t)&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, 0x00010058, NULL), /* bootloader */
	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, 0x00010070, NULL), /* bootloader */
	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),
	/* Digidesign Mbox 2 Pro */
	SND_BEBOB_DEV_ENTRY(VEN_DIGIDESIGN, 0x0000a9, &spec_normal),
	/* IDs are unknown but able to be supported */
	/* Apogee, Mini-ME Firewire */
	/* Apogee, Mini-DAC Firewire */
	/* 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);
	}

	module_init(snd_bebob_init);
	module_exit(snd_bebob_exit);