[GitHub/moto-9609/android_kernel_motorola_exynos9610.git] / sound / firewire / fireworks / fireworks.c

/*
 * fireworks.c - a part of driver for Fireworks based devices
 *
 * Copyright (c) 2009-2010 Clemens Ladisch
 * Copyright (c) 2013-2014 Takashi Sakamoto
 *
 * Licensed under the terms of the GNU General Public License, version 2.
 */

/*
 * Fireworks is a board module which Echo Audio produced. This module consists
 * of three chipsets:
 *  - Communication chipset for IEEE1394 PHY/Link and IEC 61883-1/6
 *  - DSP or/and FPGA for signal processing
 *  - Flash Memory to store firmwares
 */

#include "fireworks.h"

MODULE_DESCRIPTION("Echo Fireworks 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;
unsigned int snd_efw_resp_buf_size	= 1024;
bool snd_efw_resp_buf_debug		= false;

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 Fireworks sound card");
module_param_named(resp_buf_size, snd_efw_resp_buf_size, uint, 0444);
MODULE_PARM_DESC(resp_buf_size,
		 "response buffer size (max 4096, default 1024)");
module_param_named(resp_buf_debug, snd_efw_resp_buf_debug, bool, 0444);
MODULE_PARM_DESC(resp_buf_debug, "store all responses to buffer");

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

#define VENDOR_LOUD			0x000ff2
#define  MODEL_MACKIE_400F		0x00400f
#define  MODEL_MACKIE_1200F		0x01200f

#define VENDOR_ECHO			0x001486
#define  MODEL_ECHO_AUDIOFIRE_12	0x00af12
#define  MODEL_ECHO_AUDIOFIRE_12HD	0x0af12d
#define  MODEL_ECHO_AUDIOFIRE_12_APPLE	0x0af12a
/* This is applied for AudioFire8 (until 2009 July) */
#define  MODEL_ECHO_AUDIOFIRE_8		0x000af8
#define  MODEL_ECHO_AUDIOFIRE_2		0x000af2
#define  MODEL_ECHO_AUDIOFIRE_4		0x000af4
/* AudioFire9 is applied for AudioFire8(since 2009 July) and AudioFirePre8 */
#define  MODEL_ECHO_AUDIOFIRE_9		0x000af9
/* unknown as product */
#define  MODEL_ECHO_FIREWORKS_8		0x0000f8
#define  MODEL_ECHO_FIREWORKS_HDMI	0x00afd1

#define VENDOR_GIBSON			0x00075b
/* for Robot Interface Pack of Dark Fire, Dusk Tiger, Les Paul Standard 2010 */
#define  MODEL_GIBSON_RIP		0x00afb2
/* unknown as product */
#define  MODEL_GIBSON_GOLDTOP		0x00afb9

/* part of hardware capability flags */
#define FLAG_RESP_ADDR_CHANGABLE	0

static int
get_hardware_info(struct snd_efw *efw)
{
	struct fw_device *fw_dev = fw_parent_device(efw->unit);
	struct snd_efw_hwinfo *hwinfo;
	char version[12] = {0};
	int err;

	hwinfo = kzalloc(sizeof(struct snd_efw_hwinfo), GFP_KERNEL);
	if (hwinfo == NULL)
		return -ENOMEM;

	err = snd_efw_command_get_hwinfo(efw, hwinfo);
	if (err < 0)
		goto end;

	/* firmware version for communication chipset */
	snprintf(version, sizeof(version), "%u.%u",
		 (hwinfo->arm_version >> 24) & 0xff,
		 (hwinfo->arm_version >> 16) & 0xff);
	efw->firmware_version = hwinfo->arm_version;

	strcpy(efw->card->driver, "Fireworks");
	strcpy(efw->card->shortname, hwinfo->model_name);
	strcpy(efw->card->mixername, hwinfo->model_name);
	snprintf(efw->card->longname, sizeof(efw->card->longname),
		 "%s %s v%s, GUID %08x%08x at %s, S%d",
		 hwinfo->vendor_name, hwinfo->model_name, version,
		 hwinfo->guid_hi, hwinfo->guid_lo,
		 dev_name(&efw->unit->device), 100 << fw_dev->max_speed);

	if (hwinfo->flags & BIT(FLAG_RESP_ADDR_CHANGABLE))
		efw->resp_addr_changable = true;

	efw->supported_sampling_rate = 0;
	if ((hwinfo->min_sample_rate <= 22050)
	 && (22050 <= hwinfo->max_sample_rate))
		efw->supported_sampling_rate |= SNDRV_PCM_RATE_22050;
	if ((hwinfo->min_sample_rate <= 32000)
	 && (32000 <= hwinfo->max_sample_rate))
		efw->supported_sampling_rate |= SNDRV_PCM_RATE_32000;
	if ((hwinfo->min_sample_rate <= 44100)
	 && (44100 <= hwinfo->max_sample_rate))
		efw->supported_sampling_rate |= SNDRV_PCM_RATE_44100;
	if ((hwinfo->min_sample_rate <= 48000)
	 && (48000 <= hwinfo->max_sample_rate))
		efw->supported_sampling_rate |= SNDRV_PCM_RATE_48000;
	if ((hwinfo->min_sample_rate <= 88200)
	 && (88200 <= hwinfo->max_sample_rate))
		efw->supported_sampling_rate |= SNDRV_PCM_RATE_88200;
	if ((hwinfo->min_sample_rate <= 96000)
	 && (96000 <= hwinfo->max_sample_rate))
		efw->supported_sampling_rate |= SNDRV_PCM_RATE_96000;
	if ((hwinfo->min_sample_rate <= 176400)
	 && (176400 <= hwinfo->max_sample_rate))
		efw->supported_sampling_rate |= SNDRV_PCM_RATE_176400;
	if ((hwinfo->min_sample_rate <= 192000)
	 && (192000 <= hwinfo->max_sample_rate))
		efw->supported_sampling_rate |= SNDRV_PCM_RATE_192000;

	/* the number of MIDI ports, not of MIDI conformant data channels */
	if (hwinfo->midi_out_ports > SND_EFW_MAX_MIDI_OUT_PORTS ||
	    hwinfo->midi_in_ports > SND_EFW_MAX_MIDI_IN_PORTS) {
		err = -EIO;
		goto end;
	}
	efw->midi_out_ports = hwinfo->midi_out_ports;
	efw->midi_in_ports = hwinfo->midi_in_ports;

	if (hwinfo->amdtp_tx_pcm_channels    > AM824_MAX_CHANNELS_FOR_PCM ||
	    hwinfo->amdtp_tx_pcm_channels_2x > AM824_MAX_CHANNELS_FOR_PCM ||
	    hwinfo->amdtp_tx_pcm_channels_4x > AM824_MAX_CHANNELS_FOR_PCM ||
	    hwinfo->amdtp_rx_pcm_channels    > AM824_MAX_CHANNELS_FOR_PCM ||
	    hwinfo->amdtp_rx_pcm_channels_2x > AM824_MAX_CHANNELS_FOR_PCM ||
	    hwinfo->amdtp_rx_pcm_channels_4x > AM824_MAX_CHANNELS_FOR_PCM) {
		err = -ENOSYS;
		goto end;
	}
	efw->pcm_capture_channels[0] = hwinfo->amdtp_tx_pcm_channels;
	efw->pcm_capture_channels[1] = hwinfo->amdtp_tx_pcm_channels_2x;
	efw->pcm_capture_channels[2] = hwinfo->amdtp_tx_pcm_channels_4x;
	efw->pcm_playback_channels[0] = hwinfo->amdtp_rx_pcm_channels;
	efw->pcm_playback_channels[1] = hwinfo->amdtp_rx_pcm_channels_2x;
	efw->pcm_playback_channels[2] = hwinfo->amdtp_rx_pcm_channels_4x;

	/* Hardware metering. */
	if (hwinfo->phys_in_grp_count  > HWINFO_MAX_CAPS_GROUPS ||
	    hwinfo->phys_out_grp_count > HWINFO_MAX_CAPS_GROUPS) {
		err = -EIO;
		goto end;
	}
	efw->phys_in = hwinfo->phys_in;
	efw->phys_out = hwinfo->phys_out;
	efw->phys_in_grp_count = hwinfo->phys_in_grp_count;
	efw->phys_out_grp_count = hwinfo->phys_out_grp_count;
	memcpy(&efw->phys_in_grps, hwinfo->phys_in_grps,
	       sizeof(struct snd_efw_phys_grp) * hwinfo->phys_in_grp_count);
	memcpy(&efw->phys_out_grps, hwinfo->phys_out_grps,
	       sizeof(struct snd_efw_phys_grp) * hwinfo->phys_out_grp_count);

	/* AudioFire8 (since 2009) and AudioFirePre8 */
	if (hwinfo->type == MODEL_ECHO_AUDIOFIRE_9)
		efw->is_af9 = true;
	/* These models uses the same firmware. */
	if (hwinfo->type == MODEL_ECHO_AUDIOFIRE_2 ||
	    hwinfo->type == MODEL_ECHO_AUDIOFIRE_4 ||
	    hwinfo->type == MODEL_ECHO_AUDIOFIRE_9 ||
	    hwinfo->type == MODEL_GIBSON_RIP ||
	    hwinfo->type == MODEL_GIBSON_GOLDTOP)
		efw->is_fireworks3 = true;
end:
	kfree(hwinfo);
	return err;
}

static void efw_free(struct snd_efw *efw)
{
	snd_efw_stream_destroy_duplex(efw);
	snd_efw_transaction_remove_instance(efw);
	fw_unit_put(efw->unit);

	kfree(efw->resp_buf);

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

/*
 * 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
efw_card_free(struct snd_card *card)
{
	struct snd_efw *efw = card->private_data;

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

	efw_free(card->private_data);
}

static void
do_registration(struct work_struct *work)
{
	struct snd_efw *efw = container_of(work, struct snd_efw, dwork.work);
	unsigned int card_index;
	int err;

	if (efw->registered)
		return;

	mutex_lock(&devices_mutex);

	/* check registered cards */
	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(&efw->unit->device, index[card_index],
			   id[card_index], THIS_MODULE, 0, &efw->card);
	if (err < 0) {
		mutex_unlock(&devices_mutex);
		return;
	}

	/* prepare response buffer */
	snd_efw_resp_buf_size = clamp(snd_efw_resp_buf_size,
				      SND_EFW_RESPONSE_MAXIMUM_BYTES, 4096U);
	efw->resp_buf = kzalloc(snd_efw_resp_buf_size, GFP_KERNEL);
	if (efw->resp_buf == NULL) {
		err = -ENOMEM;
		goto error;
	}
	efw->pull_ptr = efw->push_ptr = efw->resp_buf;
	snd_efw_transaction_add_instance(efw);

	err = get_hardware_info(efw);
	if (err < 0)
		goto error;

	err = snd_efw_stream_init_duplex(efw);
	if (err < 0)
		goto error;

	snd_efw_proc_init(efw);

	if (efw->midi_out_ports || efw->midi_in_ports) {
		err = snd_efw_create_midi_devices(efw);
		if (err < 0)
			goto error;
	}

	err = snd_efw_create_pcm_devices(efw);
	if (err < 0)
		goto error;

	err = snd_efw_create_hwdep_device(efw);
	if (err < 0)
		goto error;

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

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

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

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

static int
efw_probe(struct fw_unit *unit, const struct ieee1394_device_id *entry)
{
	struct snd_efw *efw;

	efw = kzalloc(sizeof(struct snd_efw), GFP_KERNEL);
	if (efw == NULL)
		return -ENOMEM;

	efw->unit = fw_unit_get(unit);
	dev_set_drvdata(&unit->device, efw);

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

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

	return 0;
}

static void efw_update(struct fw_unit *unit)
{
	struct snd_efw *efw = dev_get_drvdata(&unit->device);

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

	snd_efw_transaction_bus_reset(efw->unit);

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

static void efw_remove(struct fw_unit *unit)
{
	struct snd_efw *efw = 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(&efw->dwork);

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

static const struct ieee1394_device_id efw_id_table[] = {
	SND_EFW_DEV_ENTRY(VENDOR_LOUD, MODEL_MACKIE_400F),
	SND_EFW_DEV_ENTRY(VENDOR_LOUD, MODEL_MACKIE_1200F),
	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_AUDIOFIRE_8),
	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_AUDIOFIRE_12),
	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_AUDIOFIRE_12HD),
	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_AUDIOFIRE_12_APPLE),
	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_AUDIOFIRE_2),
	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_AUDIOFIRE_4),
	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_AUDIOFIRE_9),
	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_FIREWORKS_8),
	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_FIREWORKS_HDMI),
	SND_EFW_DEV_ENTRY(VENDOR_GIBSON, MODEL_GIBSON_RIP),
	SND_EFW_DEV_ENTRY(VENDOR_GIBSON, MODEL_GIBSON_GOLDTOP),
	{}
};
MODULE_DEVICE_TABLE(ieee1394, efw_id_table);

static struct fw_driver efw_driver = {
	.driver = {
		.owner = THIS_MODULE,
		.name = "snd-fireworks",
		.bus = &fw_bus_type,
	},
	.probe    = efw_probe,
	.update   = efw_update,
	.remove   = efw_remove,
	.id_table = efw_id_table,
};

static int __init snd_efw_init(void)
{
	int err;

	err = snd_efw_transaction_register();
	if (err < 0)
		goto end;

	err = driver_register(&efw_driver.driver);
	if (err < 0)
		snd_efw_transaction_unregister();

end:
	return err;
}

static void __exit snd_efw_exit(void)
{
	snd_efw_transaction_unregister();
	driver_unregister(&efw_driver.driver);
}

module_init(snd_efw_init);
module_exit(snd_efw_exit);
Commit	Line	Data
b5b04336 TS	1	/*
	2	* fireworks.c - a part of driver for Fireworks based devices
	3	*
	4	* Copyright (c) 2009-2010 Clemens Ladisch
	5	* Copyright (c) 2013-2014 Takashi Sakamoto
	6	*
	7	* Licensed under the terms of the GNU General Public License, version 2.
	8	*/
	9
	10	/*
	11	* Fireworks is a board module which Echo Audio produced. This module consists
	12	* of three chipsets:
	13	* - Communication chipset for IEEE1394 PHY/Link and IEC 61883-1/6
	14	* - DSP or/and FPGA for signal processing
	15	* - Flash Memory to store firmwares
	16	*/
	17
	18	#include "fireworks.h"
	19
	20	MODULE_DESCRIPTION("Echo Fireworks driver");
	21	MODULE_AUTHOR("Takashi Sakamoto <o-takashi@sakamocchi.jp>");
	22	MODULE_LICENSE("GPL v2");
	23
	24	static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;
	25	static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;
	26	static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;
555e8a8f TS	27	unsigned int snd_efw_resp_buf_size = 1024;
555e8a8f TS	28	bool snd_efw_resp_buf_debug = false;
b5b04336 TS	29
	30	module_param_array(index, int, NULL, 0444);
	31	MODULE_PARM_DESC(index, "card index");
	32	module_param_array(id, charp, NULL, 0444);
	33	MODULE_PARM_DESC(id, "ID string");
	34	module_param_array(enable, bool, NULL, 0444);
	35	MODULE_PARM_DESC(enable, "enable Fireworks sound card");
555e8a8f TS	36	module_param_named(resp_buf_size, snd_efw_resp_buf_size, uint, 0444);
	37	MODULE_PARM_DESC(resp_buf_size,
	38	"response buffer size (max 4096, default 1024)");
	39	module_param_named(resp_buf_debug, snd_efw_resp_buf_debug, bool, 0444);
	40	MODULE_PARM_DESC(resp_buf_debug, "store all responses to buffer");
b5b04336 TS	41
	42	static DEFINE_MUTEX(devices_mutex);
	43	static DECLARE_BITMAP(devices_used, SNDRV_CARDS);
	44
	45	#define VENDOR_LOUD 0x000ff2
	46	#define MODEL_MACKIE_400F 0x00400f
	47	#define MODEL_MACKIE_1200F 0x01200f
	48
	49	#define VENDOR_ECHO 0x001486
	50	#define MODEL_ECHO_AUDIOFIRE_12 0x00af12
	51	#define MODEL_ECHO_AUDIOFIRE_12HD 0x0af12d
	52	#define MODEL_ECHO_AUDIOFIRE_12_APPLE 0x0af12a
	53	/* This is applied for AudioFire8 (until 2009 July) */
	54	#define MODEL_ECHO_AUDIOFIRE_8 0x000af8
	55	#define MODEL_ECHO_AUDIOFIRE_2 0x000af2
	56	#define MODEL_ECHO_AUDIOFIRE_4 0x000af4
	57	/* AudioFire9 is applied for AudioFire8(since 2009 July) and AudioFirePre8 */
	58	#define MODEL_ECHO_AUDIOFIRE_9 0x000af9
	59	/* unknown as product */
	60	#define MODEL_ECHO_FIREWORKS_8 0x0000f8
	61	#define MODEL_ECHO_FIREWORKS_HDMI 0x00afd1
	62
	63	#define VENDOR_GIBSON 0x00075b
	64	/* for Robot Interface Pack of Dark Fire, Dusk Tiger, Les Paul Standard 2010 */
	65	#define MODEL_GIBSON_RIP 0x00afb2
	66	/* unknown as product */
	67	#define MODEL_GIBSON_GOLDTOP 0x00afb9
	68
bde8a8f2 TS	69	/* part of hardware capability flags */
	70	#define FLAG_RESP_ADDR_CHANGABLE 0
	71
	72	static int
	73	get_hardware_info(struct snd_efw *efw)
	74	{
	75	struct fw_device *fw_dev = fw_parent_device(efw->unit);
	76	struct snd_efw_hwinfo *hwinfo;
	77	char version[12] = {0};
	78	int err;
	79
	80	hwinfo = kzalloc(sizeof(struct snd_efw_hwinfo), GFP_KERNEL);
	81	if (hwinfo == NULL)
	82	return -ENOMEM;
	83
	84	err = snd_efw_command_get_hwinfo(efw, hwinfo);
	85	if (err < 0)
	86	goto end;
	87
	88	/* firmware version for communication chipset */
	89	snprintf(version, sizeof(version), "%u.%u",
	90	(hwinfo->arm_version >> 24) & 0xff,
	91	(hwinfo->arm_version >> 16) & 0xff);
d9cd0065	92	efw->firmware_version = hwinfo->arm_version;
bde8a8f2 TS	93
	94	strcpy(efw->card->driver, "Fireworks");
	95	strcpy(efw->card->shortname, hwinfo->model_name);
	96	strcpy(efw->card->mixername, hwinfo->model_name);
	97	snprintf(efw->card->longname, sizeof(efw->card->longname),
	98	"%s %s v%s, GUID %08x%08x at %s, S%d",
	99	hwinfo->vendor_name, hwinfo->model_name, version,
	100	hwinfo->guid_hi, hwinfo->guid_lo,
	101	dev_name(&efw->unit->device), 100 << fw_dev->max_speed);
bde8a8f2 TS	102
	103	if (hwinfo->flags & BIT(FLAG_RESP_ADDR_CHANGABLE))
	104	efw->resp_addr_changable = true;
315fd41f TS	105
	106	efw->supported_sampling_rate = 0;
	107	if ((hwinfo->min_sample_rate <= 22050)
	108	&& (22050 <= hwinfo->max_sample_rate))
	109	efw->supported_sampling_rate \|= SNDRV_PCM_RATE_22050;
	110	if ((hwinfo->min_sample_rate <= 32000)
	111	&& (32000 <= hwinfo->max_sample_rate))
	112	efw->supported_sampling_rate \|= SNDRV_PCM_RATE_32000;
	113	if ((hwinfo->min_sample_rate <= 44100)
	114	&& (44100 <= hwinfo->max_sample_rate))
	115	efw->supported_sampling_rate \|= SNDRV_PCM_RATE_44100;
	116	if ((hwinfo->min_sample_rate <= 48000)
	117	&& (48000 <= hwinfo->max_sample_rate))
	118	efw->supported_sampling_rate \|= SNDRV_PCM_RATE_48000;
	119	if ((hwinfo->min_sample_rate <= 88200)
	120	&& (88200 <= hwinfo->max_sample_rate))
	121	efw->supported_sampling_rate \|= SNDRV_PCM_RATE_88200;
	122	if ((hwinfo->min_sample_rate <= 96000)
	123	&& (96000 <= hwinfo->max_sample_rate))
	124	efw->supported_sampling_rate \|= SNDRV_PCM_RATE_96000;
	125	if ((hwinfo->min_sample_rate <= 176400)
	126	&& (176400 <= hwinfo->max_sample_rate))
	127	efw->supported_sampling_rate \|= SNDRV_PCM_RATE_176400;
	128	if ((hwinfo->min_sample_rate <= 192000)
	129	&& (192000 <= hwinfo->max_sample_rate))
	130	efw->supported_sampling_rate \|= SNDRV_PCM_RATE_192000;
	131
	132	/* the number of MIDI ports, not of MIDI conformant data channels */
	133	if (hwinfo->midi_out_ports > SND_EFW_MAX_MIDI_OUT_PORTS \|\|
	134	hwinfo->midi_in_ports > SND_EFW_MAX_MIDI_IN_PORTS) {
	135	err = -EIO;
	136	goto end;
	137	}
	138	efw->midi_out_ports = hwinfo->midi_out_ports;
	139	efw->midi_in_ports = hwinfo->midi_in_ports;
	140
49c7b3fc TS	141	if (hwinfo->amdtp_tx_pcm_channels > AM824_MAX_CHANNELS_FOR_PCM \|\|
	142	hwinfo->amdtp_tx_pcm_channels_2x > AM824_MAX_CHANNELS_FOR_PCM \|\|
	143	hwinfo->amdtp_tx_pcm_channels_4x > AM824_MAX_CHANNELS_FOR_PCM \|\|
	144	hwinfo->amdtp_rx_pcm_channels > AM824_MAX_CHANNELS_FOR_PCM \|\|
	145	hwinfo->amdtp_rx_pcm_channels_2x > AM824_MAX_CHANNELS_FOR_PCM \|\|
	146	hwinfo->amdtp_rx_pcm_channels_4x > AM824_MAX_CHANNELS_FOR_PCM) {
315fd41f TS	147	err = -ENOSYS;
	148	goto end;
	149	}
	150	efw->pcm_capture_channels[0] = hwinfo->amdtp_tx_pcm_channels;
	151	efw->pcm_capture_channels[1] = hwinfo->amdtp_tx_pcm_channels_2x;
	152	efw->pcm_capture_channels[2] = hwinfo->amdtp_tx_pcm_channels_4x;
	153	efw->pcm_playback_channels[0] = hwinfo->amdtp_rx_pcm_channels;
	154	efw->pcm_playback_channels[1] = hwinfo->amdtp_rx_pcm_channels_2x;
	155	efw->pcm_playback_channels[2] = hwinfo->amdtp_rx_pcm_channels_4x;
6a22683e TS	156
	157	/* Hardware metering. */
	158	if (hwinfo->phys_in_grp_count > HWINFO_MAX_CAPS_GROUPS \|\|
	159	hwinfo->phys_out_grp_count > HWINFO_MAX_CAPS_GROUPS) {
39617837	160	err = -EIO;
6a22683e TS	161	goto end;
	162	}
	163	efw->phys_in = hwinfo->phys_in;
	164	efw->phys_out = hwinfo->phys_out;
	165	efw->phys_in_grp_count = hwinfo->phys_in_grp_count;
	166	efw->phys_out_grp_count = hwinfo->phys_out_grp_count;
	167	memcpy(&efw->phys_in_grps, hwinfo->phys_in_grps,
	168	sizeof(struct snd_efw_phys_grp) * hwinfo->phys_in_grp_count);
	169	memcpy(&efw->phys_out_grps, hwinfo->phys_out_grps,
	170	sizeof(struct snd_efw_phys_grp) * hwinfo->phys_out_grp_count);
0655ac2f TS	171
	172	/* AudioFire8 (since 2009) and AudioFirePre8 */
	173	if (hwinfo->type == MODEL_ECHO_AUDIOFIRE_9)
	174	efw->is_af9 = true;
	175	/* These models uses the same firmware. */
	176	if (hwinfo->type == MODEL_ECHO_AUDIOFIRE_2 \|\|
	177	hwinfo->type == MODEL_ECHO_AUDIOFIRE_4 \|\|
	178	hwinfo->type == MODEL_ECHO_AUDIOFIRE_9 \|\|
	179	hwinfo->type == MODEL_GIBSON_RIP \|\|
	180	hwinfo->type == MODEL_GIBSON_GOLDTOP)
	181	efw->is_fireworks3 = true;
bde8a8f2 TS	182	end:
	183	kfree(hwinfo);
	184	return err;
	185	}
	186
7d3c1d59 TS	187	static void efw_free(struct snd_efw *efw)
	188	{
	189	snd_efw_stream_destroy_duplex(efw);
	190	snd_efw_transaction_remove_instance(efw);
	191	fw_unit_put(efw->unit);
	192
	193	kfree(efw->resp_buf);
	194
	195	mutex_destroy(&efw->mutex);
	196	kfree(efw);
	197	}
	198
12ed7192 TS	199	/*
	200	* This module releases the FireWire unit data after all ALSA character devices
	201	* are released by applications. This is for releasing stream data or finishing
	202	* transactions safely. Thus at returning from .remove(), this module still keep
	203	* references for the unit.
	204	*/
b5b04336 TS	205	static void
	206	efw_card_free(struct snd_card *card)
	207	{
	208	struct snd_efw *efw = card->private_data;
	209
	210	if (efw->card_index >= 0) {
	211	mutex_lock(&devices_mutex);
	212	clear_bit(efw->card_index, devices_used);
	213	mutex_unlock(&devices_mutex);
	214	}
	215
7d3c1d59	216	efw_free(card->private_data);
b5b04336 TS	217	}
b5b04336 TS	218
7d3c1d59 TS	219	static void
7d3c1d59 TS	220	do_registration(struct work_struct *work)
b5b04336	221	{
7d3c1d59 TS	222	struct snd_efw *efw = container_of(work, struct snd_efw, dwork.work);
	223	unsigned int card_index;
	224	int err;
	225
	226	if (efw->registered)
	227	return;
b5b04336 TS	228
	229	mutex_lock(&devices_mutex);
	230
	231	/* check registered cards */
	232	for (card_index = 0; card_index < SNDRV_CARDS; ++card_index) {
	233	if (!test_bit(card_index, devices_used) && enable[card_index])
	234	break;
	235	}
	236	if (card_index >= SNDRV_CARDS) {
7d3c1d59 TS	237	mutex_unlock(&devices_mutex);
7d3c1d59 TS	238	return;
b5b04336 TS	239	}
b5b04336 TS	240
7d3c1d59 TS	241	err = snd_card_new(&efw->unit->device, index[card_index],
	242	id[card_index], THIS_MODULE, 0, &efw->card);
	243	if (err < 0) {
	244	mutex_unlock(&devices_mutex);
	245	return;
	246	}
b5b04336	247
555e8a8f TS	248	/* prepare response buffer */
	249	snd_efw_resp_buf_size = clamp(snd_efw_resp_buf_size,
	250	SND_EFW_RESPONSE_MAXIMUM_BYTES, 4096U);
	251	efw->resp_buf = kzalloc(snd_efw_resp_buf_size, GFP_KERNEL);
	252	if (efw->resp_buf == NULL) {
	253	err = -ENOMEM;
	254	goto error;
	255	}
	256	efw->pull_ptr = efw->push_ptr = efw->resp_buf;
	257	snd_efw_transaction_add_instance(efw);
	258
bde8a8f2 TS	259	err = get_hardware_info(efw);
	260	if (err < 0)
	261	goto error;
b5b04336	262
7d3c1d59 TS	263	err = snd_efw_stream_init_duplex(efw);
	264	if (err < 0)
	265	goto error;
	266
6a22683e TS	267	snd_efw_proc_init(efw);
6a22683e TS	268
a63d3ff1 TS	269	if (efw->midi_out_ports \|\| efw->midi_in_ports) {
	270	err = snd_efw_create_midi_devices(efw);
	271	if (err < 0)
	272	goto error;
	273	}
	274
aa02bb6e TS	275	err = snd_efw_create_pcm_devices(efw);
	276	if (err < 0)
	277	goto error;
	278
594ddced TS	279	err = snd_efw_create_hwdep_device(efw);
	280	if (err < 0)
	281	goto error;
	282
7d3c1d59	283	err = snd_card_register(efw->card);
b5b04336 TS	284	if (err < 0)
b5b04336 TS	285	goto error;
bde8a8f2	286
7d3c1d59	287	set_bit(card_index, devices_used);
b5b04336	288	mutex_unlock(&devices_mutex);
7d3c1d59 TS	289
	290	/*
	291	* After registered, efw instance can be released corresponding to
	292	* releasing the sound card instance.
	293	*/
	294	efw->card->private_free = efw_card_free;
	295	efw->card->private_data = efw;
	296	efw->registered = true;
	297
	298	return;
b5b04336 TS	299	error:
b5b04336 TS	300	mutex_unlock(&devices_mutex);
7d3c1d59 TS	301	snd_efw_transaction_remove_instance(efw);
	302	snd_efw_stream_destroy_duplex(efw);
	303	snd_card_free(efw->card);
d9929097 TS	304	kfree(efw->resp_buf);
d9929097 TS	305	efw->resp_buf = NULL;
7d3c1d59 TS	306	dev_info(&efw->unit->device,
	307	"Sound card registration failed: %d\n", err);
	308	}
	309
	310	static int
	311	efw_probe(struct fw_unit unit, const struct ieee1394_device_id entry)
	312	{
	313	struct snd_efw *efw;
	314
	315	efw = kzalloc(sizeof(struct snd_efw), GFP_KERNEL);
	316	if (efw == NULL)
	317	return -ENOMEM;
	318
	319	efw->unit = fw_unit_get(unit);
	320	dev_set_drvdata(&unit->device, efw);
	321
	322	mutex_init(&efw->mutex);
	323	spin_lock_init(&efw->lock);
	324	init_waitqueue_head(&efw->hwdep_wait);
	325
	326	/* Allocate and register this sound card later. */
	327	INIT_DEFERRABLE_WORK(&efw->dwork, do_registration);
	328	snd_fw_schedule_registration(unit, &efw->dwork);
	329
	330	return 0;
b5b04336 TS	331	}
	332
	333	static void efw_update(struct fw_unit *unit)
	334	{
bde8a8f2	335	struct snd_efw *efw = dev_get_drvdata(&unit->device);
315fd41f	336
7d3c1d59 TS	337	/* Postpone a workqueue for deferred registration. */
	338	if (!efw->registered)
	339	snd_fw_schedule_registration(unit, &efw->dwork);
	340
bde8a8f2	341	snd_efw_transaction_bus_reset(efw->unit);
99d73559	342
7d3c1d59 TS	343	/*
	344	* After registration, userspace can start packet streaming, then this
	345	* code block works fine.
	346	*/
	347	if (efw->registered) {
	348	mutex_lock(&efw->mutex);
	349	snd_efw_stream_update_duplex(efw);
	350	mutex_unlock(&efw->mutex);
	351	}
b5b04336 TS	352	}
	353
	354	static void efw_remove(struct fw_unit *unit)
	355	{
	356	struct snd_efw *efw = dev_get_drvdata(&unit->device);
315fd41f	357
7d3c1d59 TS	358	/*
	359	* Confirm to stop the work for registration before the sound card is
	360	* going to be released. The work is not scheduled again because bus
	361	* reset handler is not called anymore.
	362	*/
	363	cancel_delayed_work_sync(&efw->dwork);
	364
	365	if (efw->registered) {
	366	/* No need to wait for releasing card object in this context. */
	367	snd_card_free_when_closed(efw->card);
	368	} else {
	369	/* Don't forget this case. */
	370	efw_free(efw);
	371	}
b5b04336 TS	372	}
	373
	374	static const struct ieee1394_device_id efw_id_table[] = {
	375	SND_EFW_DEV_ENTRY(VENDOR_LOUD, MODEL_MACKIE_400F),
	376	SND_EFW_DEV_ENTRY(VENDOR_LOUD, MODEL_MACKIE_1200F),
	377	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_AUDIOFIRE_8),
	378	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_AUDIOFIRE_12),
	379	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_AUDIOFIRE_12HD),
	380	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_AUDIOFIRE_12_APPLE),
	381	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_AUDIOFIRE_2),
	382	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_AUDIOFIRE_4),
	383	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_AUDIOFIRE_9),
	384	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_FIREWORKS_8),
	385	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_FIREWORKS_HDMI),
	386	SND_EFW_DEV_ENTRY(VENDOR_GIBSON, MODEL_GIBSON_RIP),
	387	SND_EFW_DEV_ENTRY(VENDOR_GIBSON, MODEL_GIBSON_GOLDTOP),
	388	{}
	389	};
	390	MODULE_DEVICE_TABLE(ieee1394, efw_id_table);
	391
	392	static struct fw_driver efw_driver = {
	393	.driver = {
	394	.owner = THIS_MODULE,
	395	.name = "snd-fireworks",
	396	.bus = &fw_bus_type,
	397	},
	398	.probe = efw_probe,
	399	.update = efw_update,
	400	.remove = efw_remove,
	401	.id_table = efw_id_table,
	402	};
	403
	404	static int __init snd_efw_init(void)
	405	{
bde8a8f2 TS	406	int err;
	407
	408	err = snd_efw_transaction_register();
	409	if (err < 0)
	410	goto end;
	411
	412	err = driver_register(&efw_driver.driver);
	413	if (err < 0)
	414	snd_efw_transaction_unregister();
	415
	416	end:
	417	return err;
b5b04336 TS	418	}
	419
	420	static void __exit snd_efw_exit(void)
	421	{
bde8a8f2	422	snd_efw_transaction_unregister();
b5b04336	423	driver_unregister(&efw_driver.driver);
b5b04336 TS	424	}
	425
	426	module_init(snd_efw_init);
	427	module_exit(snd_efw_exit);