[linux-2.6-block.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);
end:
	kfree(hwinfo);
	return err;
}

/*
 * 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;

	snd_efw_stream_destroy_duplex(efw);
	snd_efw_transaction_remove_instance(efw);
	fw_unit_put(efw->unit);

	kfree(efw->resp_buf);

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

	mutex_destroy(&efw->mutex);
}

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

	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) {
		err = -ENOENT;
		goto end;
	}

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

	efw->card = card;
	efw->unit = fw_unit_get(unit);
	mutex_init(&efw->mutex);
	spin_lock_init(&efw->lock);
	init_waitqueue_head(&efw->hwdep_wait);

	/* 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;
	/* AudioFire8 (since 2009) and AudioFirePre8 */
	if (entry->model_id == MODEL_ECHO_AUDIOFIRE_9)
		efw->is_af9 = true;
	/* These models uses the same firmware. */
	if (entry->model_id == MODEL_ECHO_AUDIOFIRE_2 ||
	    entry->model_id == MODEL_ECHO_AUDIOFIRE_4 ||
	    entry->model_id == MODEL_ECHO_AUDIOFIRE_9 ||
	    entry->model_id == MODEL_GIBSON_RIP ||
	    entry->model_id == MODEL_GIBSON_GOLDTOP)
		efw->is_fireworks3 = true;

	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_efw_stream_init_duplex(efw);
	if (err < 0)
		goto error;

	err = snd_card_register(card);
	if (err < 0) {
		snd_efw_stream_destroy_duplex(efw);
		goto error;
	}

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

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

	snd_efw_transaction_bus_reset(efw->unit);
	snd_efw_stream_update_duplex(efw);
}

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

	/* No need to wait for releasing card object in this context. */
	snd_card_free_when_closed(efw->card);
}

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);
bde8a8f2 TS	171	end:
	172	kfree(hwinfo);
	173	return err;
	174	}
	175
12ed7192 TS	176	/*
	177	* This module releases the FireWire unit data after all ALSA character devices
	178	* are released by applications. This is for releasing stream data or finishing
	179	* transactions safely. Thus at returning from .remove(), this module still keep
	180	* references for the unit.
	181	*/
b5b04336 TS	182	static void
	183	efw_card_free(struct snd_card *card)
	184	{
	185	struct snd_efw *efw = card->private_data;
	186
dec84316 TS	187	snd_efw_stream_destroy_duplex(efw);
dec84316 TS	188	snd_efw_transaction_remove_instance(efw);
12ed7192 TS	189	fw_unit_put(efw->unit);
12ed7192 TS	190
dec84316 TS	191	kfree(efw->resp_buf);
dec84316 TS	192
b5b04336 TS	193	if (efw->card_index >= 0) {
	194	mutex_lock(&devices_mutex);
	195	clear_bit(efw->card_index, devices_used);
	196	mutex_unlock(&devices_mutex);
	197	}
	198
	199	mutex_destroy(&efw->mutex);
	200	}
	201
	202	static int
	203	efw_probe(struct fw_unit *unit,
	204	const struct ieee1394_device_id *entry)
	205	{
	206	struct snd_card *card;
	207	struct snd_efw *efw;
	208	int card_index, err;
	209
	210	mutex_lock(&devices_mutex);
	211
	212	/* check registered cards */
	213	for (card_index = 0; card_index < SNDRV_CARDS; ++card_index) {
	214	if (!test_bit(card_index, devices_used) && enable[card_index])
	215	break;
	216	}
	217	if (card_index >= SNDRV_CARDS) {
	218	err = -ENOENT;
	219	goto end;
	220	}
	221
	222	err = snd_card_new(&unit->device, index[card_index], id[card_index],
	223	THIS_MODULE, sizeof(struct snd_efw), &card);
	224	if (err < 0)
	225	goto end;
	226	efw = card->private_data;
	227	efw->card_index = card_index;
	228	set_bit(card_index, devices_used);
	229	card->private_free = efw_card_free;
	230
	231	efw->card = card;
12ed7192	232	efw->unit = fw_unit_get(unit);
b5b04336 TS	233	mutex_init(&efw->mutex);
b5b04336 TS	234	spin_lock_init(&efw->lock);
594ddced	235	init_waitqueue_head(&efw->hwdep_wait);
b5b04336	236
555e8a8f TS	237	/* prepare response buffer */
	238	snd_efw_resp_buf_size = clamp(snd_efw_resp_buf_size,
	239	SND_EFW_RESPONSE_MAXIMUM_BYTES, 4096U);
	240	efw->resp_buf = kzalloc(snd_efw_resp_buf_size, GFP_KERNEL);
	241	if (efw->resp_buf == NULL) {
	242	err = -ENOMEM;
	243	goto error;
	244	}
	245	efw->pull_ptr = efw->push_ptr = efw->resp_buf;
	246	snd_efw_transaction_add_instance(efw);
	247
bde8a8f2 TS	248	err = get_hardware_info(efw);
	249	if (err < 0)
	250	goto error;
18f5ed36	251	/* AudioFire8 (since 2009) and AudioFirePre8 */
69702239 TS	252	if (entry->model_id == MODEL_ECHO_AUDIOFIRE_9)
69702239 TS	253	efw->is_af9 = true;
18f5ed36 TS	254	/* These models uses the same firmware. */
	255	if (entry->model_id == MODEL_ECHO_AUDIOFIRE_2 \|\|
	256	entry->model_id == MODEL_ECHO_AUDIOFIRE_4 \|\|
	257	entry->model_id == MODEL_ECHO_AUDIOFIRE_9 \|\|
	258	entry->model_id == MODEL_GIBSON_RIP \|\|
	259	entry->model_id == MODEL_GIBSON_GOLDTOP)
	260	efw->is_fireworks3 = true;
b5b04336	261
6a22683e TS	262	snd_efw_proc_init(efw);
6a22683e TS	263
a63d3ff1 TS	264	if (efw->midi_out_ports \|\| efw->midi_in_ports) {
	265	err = snd_efw_create_midi_devices(efw);
	266	if (err < 0)
	267	goto error;
	268	}
	269
aa02bb6e TS	270	err = snd_efw_create_pcm_devices(efw);
	271	if (err < 0)
	272	goto error;
	273
594ddced TS	274	err = snd_efw_create_hwdep_device(efw);
	275	if (err < 0)
	276	goto error;
	277
315fd41f	278	err = snd_efw_stream_init_duplex(efw);
b5b04336 TS	279	if (err < 0)
b5b04336 TS	280	goto error;
bde8a8f2	281
315fd41f TS	282	err = snd_card_register(card);
	283	if (err < 0) {
	284	snd_efw_stream_destroy_duplex(efw);
	285	goto error;
	286	}
	287
b5b04336 TS	288	dev_set_drvdata(&unit->device, efw);
	289	end:
	290	mutex_unlock(&devices_mutex);
	291	return err;
	292	error:
555e8a8f	293	snd_efw_transaction_remove_instance(efw);
b5b04336 TS	294	mutex_unlock(&devices_mutex);
	295	snd_card_free(card);
	296	return err;
	297	}
	298
	299	static void efw_update(struct fw_unit *unit)
	300	{
bde8a8f2	301	struct snd_efw *efw = dev_get_drvdata(&unit->device);
315fd41f	302
bde8a8f2	303	snd_efw_transaction_bus_reset(efw->unit);
315fd41f	304	snd_efw_stream_update_duplex(efw);
b5b04336 TS	305	}
	306
	307	static void efw_remove(struct fw_unit *unit)
	308	{
	309	struct snd_efw *efw = dev_get_drvdata(&unit->device);
315fd41f	310
12ed7192	311	/* No need to wait for releasing card object in this context. */
b5b04336 TS	312	snd_card_free_when_closed(efw->card);
	313	}
	314
	315	static const struct ieee1394_device_id efw_id_table[] = {
	316	SND_EFW_DEV_ENTRY(VENDOR_LOUD, MODEL_MACKIE_400F),
	317	SND_EFW_DEV_ENTRY(VENDOR_LOUD, MODEL_MACKIE_1200F),
	318	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_AUDIOFIRE_8),
	319	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_AUDIOFIRE_12),
	320	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_AUDIOFIRE_12HD),
	321	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_AUDIOFIRE_12_APPLE),
	322	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_AUDIOFIRE_2),
	323	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_AUDIOFIRE_4),
	324	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_AUDIOFIRE_9),
	325	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_FIREWORKS_8),
	326	SND_EFW_DEV_ENTRY(VENDOR_ECHO, MODEL_ECHO_FIREWORKS_HDMI),
	327	SND_EFW_DEV_ENTRY(VENDOR_GIBSON, MODEL_GIBSON_RIP),
	328	SND_EFW_DEV_ENTRY(VENDOR_GIBSON, MODEL_GIBSON_GOLDTOP),
	329	{}
	330	};
	331	MODULE_DEVICE_TABLE(ieee1394, efw_id_table);
	332
	333	static struct fw_driver efw_driver = {
	334	.driver = {
	335	.owner = THIS_MODULE,
	336	.name = "snd-fireworks",
	337	.bus = &fw_bus_type,
	338	},
	339	.probe = efw_probe,
	340	.update = efw_update,
	341	.remove = efw_remove,
	342	.id_table = efw_id_table,
	343	};
	344
	345	static int __init snd_efw_init(void)
	346	{
bde8a8f2 TS	347	int err;
	348
	349	err = snd_efw_transaction_register();
	350	if (err < 0)
	351	goto end;
	352
	353	err = driver_register(&efw_driver.driver);
	354	if (err < 0)
	355	snd_efw_transaction_unregister();
	356
	357	end:
	358	return err;
b5b04336 TS	359	}
	360
	361	static void __exit snd_efw_exit(void)
	362	{
bde8a8f2	363	snd_efw_transaction_unregister();
b5b04336	364	driver_unregister(&efw_driver.driver);
b5b04336 TS	365	}
	366
	367	module_init(snd_efw_init);
	368	module_exit(snd_efw_exit);