2017-03-31 20:05:59 +07:00
|
|
|
/*
|
|
|
|
* ff.c - a part of driver for RME Fireface series
|
|
|
|
*
|
|
|
|
* Copyright (c) 2015-2017 Takashi Sakamoto
|
|
|
|
*
|
|
|
|
* Licensed under the terms of the GNU General Public License, version 2.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include "ff.h"
|
|
|
|
|
|
|
|
#define OUI_RME 0x000a35
|
|
|
|
|
|
|
|
MODULE_DESCRIPTION("RME Fireface series Driver");
|
|
|
|
MODULE_AUTHOR("Takashi Sakamoto <o-takashi@sakamocchi.jp>");
|
|
|
|
MODULE_LICENSE("GPL v2");
|
|
|
|
|
|
|
|
static void name_card(struct snd_ff *ff)
|
|
|
|
{
|
|
|
|
struct fw_device *fw_dev = fw_parent_device(ff->unit);
|
|
|
|
|
|
|
|
strcpy(ff->card->driver, "Fireface");
|
2017-03-31 20:06:01 +07:00
|
|
|
strcpy(ff->card->shortname, ff->spec->name);
|
|
|
|
strcpy(ff->card->mixername, ff->spec->name);
|
2017-03-31 20:05:59 +07:00
|
|
|
snprintf(ff->card->longname, sizeof(ff->card->longname),
|
2017-03-31 20:06:01 +07:00
|
|
|
"RME %s, GUID %08x%08x at %s, S%d", ff->spec->name,
|
2017-03-31 20:05:59 +07:00
|
|
|
fw_dev->config_rom[3], fw_dev->config_rom[4],
|
|
|
|
dev_name(&ff->unit->device), 100 << fw_dev->max_speed);
|
|
|
|
}
|
|
|
|
|
2017-03-31 20:06:00 +07:00
|
|
|
static void ff_free(struct snd_ff *ff)
|
2017-03-31 20:05:59 +07:00
|
|
|
{
|
2017-03-31 20:06:09 +07:00
|
|
|
snd_ff_stream_destroy_duplex(ff);
|
ALSA: fireface: add transaction support
As long as investigating Fireface 400, MIDI messages are transferred by
asynchronous communication over IEEE 1394 bus.
Fireface 400 receives MIDI messages by write transactions to two addresses;
0x'0000'0801'8000 and 0x'0000'0801'9000. Each of two seems to correspond to
MIDI port 1 and 2.
Fireface 400 transfers MIDI messages by write transactions to certain
addresses which configured by drivers. The drivers can decide upper 4 byte
of the addresses by write transactions to 0x'0000'0801'03f4. For the rest
part of the address, drivers can select from below options:
* 0x'0000'0000
* 0x'0000'0080
* 0x'0000'0100
* 0x'0000'0180
Selected options are represented in register 0x'0000'0801'051c as bit
flags. Due to this mechanism, drivers are restricted to use addresses on
'Memory space' of IEEE 1222, even if transactions to the address have
some side effects.
This commit adds transaction support for MIDI messaging, based on my
assumption that the similar mechanism is used on the other protocols. To
receive asynchronous transactions, the driver allocates a range of address
in 'Memory space'. I apply a strategy to use 0x'0000'0000 as lower 4 byte
of the address. When getting failure from Linux FireWire subsystem, this
driver retries to allocate addresses.
Unfortunately, read transaction to address 0x'0000'0801'051c returns zero
always, however write transactions have effects to the other features such
as status of sampling clock. For this reason, this commit delegates a task
to configure this register to user space applications. The applications
should set 3rd bit in LSB in little endian order.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2017-03-31 20:06:03 +07:00
|
|
|
snd_ff_transaction_unregister(ff);
|
|
|
|
|
2017-03-31 20:05:59 +07:00
|
|
|
fw_unit_put(ff->unit);
|
|
|
|
|
|
|
|
mutex_destroy(&ff->mutex);
|
2017-03-31 20:06:00 +07:00
|
|
|
kfree(ff);
|
|
|
|
}
|
|
|
|
|
|
|
|
static void ff_card_free(struct snd_card *card)
|
|
|
|
{
|
|
|
|
ff_free(card->private_data);
|
|
|
|
}
|
|
|
|
|
|
|
|
static void do_registration(struct work_struct *work)
|
|
|
|
{
|
|
|
|
struct snd_ff *ff = container_of(work, struct snd_ff, dwork.work);
|
|
|
|
int err;
|
|
|
|
|
|
|
|
if (ff->registered)
|
|
|
|
return;
|
|
|
|
|
|
|
|
err = snd_card_new(&ff->unit->device, -1, NULL, THIS_MODULE, 0,
|
|
|
|
&ff->card);
|
|
|
|
if (err < 0)
|
|
|
|
return;
|
|
|
|
|
ALSA: fireface: add transaction support
As long as investigating Fireface 400, MIDI messages are transferred by
asynchronous communication over IEEE 1394 bus.
Fireface 400 receives MIDI messages by write transactions to two addresses;
0x'0000'0801'8000 and 0x'0000'0801'9000. Each of two seems to correspond to
MIDI port 1 and 2.
Fireface 400 transfers MIDI messages by write transactions to certain
addresses which configured by drivers. The drivers can decide upper 4 byte
of the addresses by write transactions to 0x'0000'0801'03f4. For the rest
part of the address, drivers can select from below options:
* 0x'0000'0000
* 0x'0000'0080
* 0x'0000'0100
* 0x'0000'0180
Selected options are represented in register 0x'0000'0801'051c as bit
flags. Due to this mechanism, drivers are restricted to use addresses on
'Memory space' of IEEE 1222, even if transactions to the address have
some side effects.
This commit adds transaction support for MIDI messaging, based on my
assumption that the similar mechanism is used on the other protocols. To
receive asynchronous transactions, the driver allocates a range of address
in 'Memory space'. I apply a strategy to use 0x'0000'0000 as lower 4 byte
of the address. When getting failure from Linux FireWire subsystem, this
driver retries to allocate addresses.
Unfortunately, read transaction to address 0x'0000'0801'051c returns zero
always, however write transactions have effects to the other features such
as status of sampling clock. For this reason, this commit delegates a task
to configure this register to user space applications. The applications
should set 3rd bit in LSB in little endian order.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2017-03-31 20:06:03 +07:00
|
|
|
err = snd_ff_transaction_register(ff);
|
|
|
|
if (err < 0)
|
|
|
|
goto error;
|
|
|
|
|
2017-03-31 20:06:00 +07:00
|
|
|
name_card(ff);
|
|
|
|
|
2017-03-31 20:06:09 +07:00
|
|
|
err = snd_ff_stream_init_duplex(ff);
|
|
|
|
if (err < 0)
|
|
|
|
goto error;
|
|
|
|
|
2017-03-31 20:06:05 +07:00
|
|
|
snd_ff_proc_init(ff);
|
|
|
|
|
2017-03-31 20:06:04 +07:00
|
|
|
err = snd_ff_create_midi_devices(ff);
|
|
|
|
if (err < 0)
|
|
|
|
goto error;
|
|
|
|
|
ALSA: fireface: add support for PCM functionality
This commit adds PCM functionality to transmit/receive PCM frames on
isochronous packet streaming. This commit enables userspace applications
to start/stop packet streaming via ALSA PCM interface.
Sampling rate requested by applications is used as sampling transmission
frequency of IEC 61883-1/6packet streaming. As I described in followed
commits, units in this series manages sampling clock frequency
independently of sampling transmission frequency, and they supports
resampling between their packet streaming/data block processing layer and
sampling data processing layer. This commit take this driver to utilize
these features for usability.
When internal clock is selected as source signal of sampling clock, this
driver allows user space applications to start PCM substreams at any rate
which packet streaming engine supports as sampling transmission frequency.
In this case, this driver expects units to perform resampling PCM frames
for rx/tx packets when sampling clock frequency and sampling transmission
frequency are mismatched. This is for daily use cases.
When any external clock is selected as the source signal, this driver
gets configured sampling rate from units, then restricts available
sampling rate to the rate for PCM applications. This is for studio use
cases.
Models in this series supports 64.0/128.0 kHz of sampling rate, however
these frequencies are not supported by IEC 61883-6 as sampling transmission
frequency. Therefore, packet streaming engine of ALSA firewire stack can't
handle them. When units are configured to use any external clock as source
signal of sampling clock and one of these unsupported rate is configured
as rate of the sampling clock, this driver returns EIO to user space
applications.
Anyway, this driver doesn't voluntarily configure parameters of sampling
clock. It's better for users to work with appropriate user space
implementations to configure the parameters in advance of usage.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2017-03-31 20:06:10 +07:00
|
|
|
err = snd_ff_create_pcm_devices(ff);
|
|
|
|
if (err < 0)
|
|
|
|
goto error;
|
|
|
|
|
2017-03-31 20:06:11 +07:00
|
|
|
err = snd_ff_create_hwdep_devices(ff);
|
|
|
|
if (err < 0)
|
|
|
|
goto error;
|
|
|
|
|
2017-03-31 20:06:00 +07:00
|
|
|
err = snd_card_register(ff->card);
|
|
|
|
if (err < 0)
|
|
|
|
goto error;
|
|
|
|
|
|
|
|
ff->card->private_free = ff_card_free;
|
|
|
|
ff->card->private_data = ff;
|
|
|
|
ff->registered = true;
|
|
|
|
|
|
|
|
return;
|
|
|
|
error:
|
ALSA: fireface: add transaction support
As long as investigating Fireface 400, MIDI messages are transferred by
asynchronous communication over IEEE 1394 bus.
Fireface 400 receives MIDI messages by write transactions to two addresses;
0x'0000'0801'8000 and 0x'0000'0801'9000. Each of two seems to correspond to
MIDI port 1 and 2.
Fireface 400 transfers MIDI messages by write transactions to certain
addresses which configured by drivers. The drivers can decide upper 4 byte
of the addresses by write transactions to 0x'0000'0801'03f4. For the rest
part of the address, drivers can select from below options:
* 0x'0000'0000
* 0x'0000'0080
* 0x'0000'0100
* 0x'0000'0180
Selected options are represented in register 0x'0000'0801'051c as bit
flags. Due to this mechanism, drivers are restricted to use addresses on
'Memory space' of IEEE 1222, even if transactions to the address have
some side effects.
This commit adds transaction support for MIDI messaging, based on my
assumption that the similar mechanism is used on the other protocols. To
receive asynchronous transactions, the driver allocates a range of address
in 'Memory space'. I apply a strategy to use 0x'0000'0000 as lower 4 byte
of the address. When getting failure from Linux FireWire subsystem, this
driver retries to allocate addresses.
Unfortunately, read transaction to address 0x'0000'0801'051c returns zero
always, however write transactions have effects to the other features such
as status of sampling clock. For this reason, this commit delegates a task
to configure this register to user space applications. The applications
should set 3rd bit in LSB in little endian order.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2017-03-31 20:06:03 +07:00
|
|
|
snd_ff_transaction_unregister(ff);
|
2017-03-31 20:06:09 +07:00
|
|
|
snd_ff_stream_destroy_duplex(ff);
|
2017-03-31 20:06:00 +07:00
|
|
|
snd_card_free(ff->card);
|
|
|
|
dev_info(&ff->unit->device,
|
|
|
|
"Sound card registration failed: %d\n", err);
|
2017-03-31 20:05:59 +07:00
|
|
|
}
|
|
|
|
|
|
|
|
static int snd_ff_probe(struct fw_unit *unit,
|
|
|
|
const struct ieee1394_device_id *entry)
|
|
|
|
{
|
|
|
|
struct snd_ff *ff;
|
|
|
|
|
2017-03-31 20:06:00 +07:00
|
|
|
ff = kzalloc(sizeof(struct snd_ff), GFP_KERNEL);
|
|
|
|
if (ff == NULL)
|
|
|
|
return -ENOMEM;
|
2017-03-31 20:05:59 +07:00
|
|
|
|
|
|
|
/* initialize myself */
|
|
|
|
ff->unit = fw_unit_get(unit);
|
|
|
|
dev_set_drvdata(&unit->device, ff);
|
|
|
|
|
|
|
|
mutex_init(&ff->mutex);
|
2017-03-31 20:06:04 +07:00
|
|
|
spin_lock_init(&ff->lock);
|
2017-03-31 20:06:11 +07:00
|
|
|
init_waitqueue_head(&ff->hwdep_wait);
|
2017-03-31 20:05:59 +07:00
|
|
|
|
2017-03-31 20:06:01 +07:00
|
|
|
ff->spec = (const struct snd_ff_spec *)entry->driver_data;
|
|
|
|
|
2017-03-31 20:06:00 +07:00
|
|
|
/* Register this sound card later. */
|
|
|
|
INIT_DEFERRABLE_WORK(&ff->dwork, do_registration);
|
|
|
|
snd_fw_schedule_registration(unit, &ff->dwork);
|
2017-03-31 20:05:59 +07:00
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
static void snd_ff_update(struct fw_unit *unit)
|
|
|
|
{
|
2017-03-31 20:06:00 +07:00
|
|
|
struct snd_ff *ff = dev_get_drvdata(&unit->device);
|
|
|
|
|
|
|
|
/* Postpone a workqueue for deferred registration. */
|
|
|
|
if (!ff->registered)
|
|
|
|
snd_fw_schedule_registration(unit, &ff->dwork);
|
ALSA: fireface: add transaction support
As long as investigating Fireface 400, MIDI messages are transferred by
asynchronous communication over IEEE 1394 bus.
Fireface 400 receives MIDI messages by write transactions to two addresses;
0x'0000'0801'8000 and 0x'0000'0801'9000. Each of two seems to correspond to
MIDI port 1 and 2.
Fireface 400 transfers MIDI messages by write transactions to certain
addresses which configured by drivers. The drivers can decide upper 4 byte
of the addresses by write transactions to 0x'0000'0801'03f4. For the rest
part of the address, drivers can select from below options:
* 0x'0000'0000
* 0x'0000'0080
* 0x'0000'0100
* 0x'0000'0180
Selected options are represented in register 0x'0000'0801'051c as bit
flags. Due to this mechanism, drivers are restricted to use addresses on
'Memory space' of IEEE 1222, even if transactions to the address have
some side effects.
This commit adds transaction support for MIDI messaging, based on my
assumption that the similar mechanism is used on the other protocols. To
receive asynchronous transactions, the driver allocates a range of address
in 'Memory space'. I apply a strategy to use 0x'0000'0000 as lower 4 byte
of the address. When getting failure from Linux FireWire subsystem, this
driver retries to allocate addresses.
Unfortunately, read transaction to address 0x'0000'0801'051c returns zero
always, however write transactions have effects to the other features such
as status of sampling clock. For this reason, this commit delegates a task
to configure this register to user space applications. The applications
should set 3rd bit in LSB in little endian order.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2017-03-31 20:06:03 +07:00
|
|
|
|
|
|
|
snd_ff_transaction_reregister(ff);
|
2017-03-31 20:06:09 +07:00
|
|
|
|
|
|
|
if (ff->registered)
|
|
|
|
snd_ff_stream_update_duplex(ff);
|
2017-03-31 20:05:59 +07:00
|
|
|
}
|
|
|
|
|
|
|
|
static void snd_ff_remove(struct fw_unit *unit)
|
|
|
|
{
|
|
|
|
struct snd_ff *ff = dev_get_drvdata(&unit->device);
|
|
|
|
|
2017-03-31 20:06:00 +07:00
|
|
|
/*
|
|
|
|
* 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_work_sync(&ff->dwork.work);
|
|
|
|
|
|
|
|
if (ff->registered) {
|
|
|
|
/* No need to wait for releasing card object in this context. */
|
|
|
|
snd_card_free_when_closed(ff->card);
|
|
|
|
} else {
|
|
|
|
/* Don't forget this case. */
|
|
|
|
ff_free(ff);
|
|
|
|
}
|
2017-03-31 20:05:59 +07:00
|
|
|
}
|
|
|
|
|
ALSA: fireface: add support for Fireface 400
Fireface 400 is a second model of RME Fireface series, released in 2006.
This commit adds support for this model.
This model supports 8 analog channels, 2 S/PDIF channels and 8 ADAT
channels in both of tx/rx packet. The number of ADAT channels differs
depending on each mode of sampling transmission frequency.
$ python2 linux-firewire-utils/src/crpp < /sys/bus/firewire/devices/fw1/config_rom
ROM header and bus information block
-----------------------------------------------------------------
400 04107768 bus_info_length 4, crc_length 16, crc 30568 (should be 61311)
404 31333934 bus_name "1394"
408 20009002 irmc 0, cmc 0, isc 1, bmc 0, cyc_clk_acc 0, max_rec 9 (1024)
40c 000a3501 company_id 000a35 |
410 1bd0862a device_id 011bd0862a | EUI-64 000a35011bd0862a
root directory
-----------------------------------------------------------------
414 000485ec directory_length 4, crc 34284
418 03000a35 vendor
41c 0c0083c0 node capabilities per IEEE 1394
420 8d000006 --> eui-64 leaf at 438
424 d1000001 --> unit directory at 428
unit directory at 428
-----------------------------------------------------------------
428 000314c4 directory_length 3, crc 5316
42c 12000a35 specifier id
430 13000002 version
434 17101800 model
eui-64 leaf at 438
-----------------------------------------------------------------
438 000261a8 leaf_length 2, crc 25000
43c 000a3501 company_id 000a35 |
440 1bd0862a device_id 011bd0862a | EUI-64 000a35011bd0862a
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2017-03-31 20:06:12 +07:00
|
|
|
static struct snd_ff_spec spec_ff400 = {
|
|
|
|
.name = "Fireface400",
|
|
|
|
.pcm_capture_channels = {18, 14, 10},
|
|
|
|
.pcm_playback_channels = {18, 14, 10},
|
|
|
|
.midi_in_ports = 2,
|
|
|
|
.midi_out_ports = 2,
|
|
|
|
.protocol = &snd_ff_protocol_ff400,
|
|
|
|
};
|
|
|
|
|
2017-03-31 20:05:59 +07:00
|
|
|
static const struct ieee1394_device_id snd_ff_id_table[] = {
|
ALSA: fireface: add support for Fireface 400
Fireface 400 is a second model of RME Fireface series, released in 2006.
This commit adds support for this model.
This model supports 8 analog channels, 2 S/PDIF channels and 8 ADAT
channels in both of tx/rx packet. The number of ADAT channels differs
depending on each mode of sampling transmission frequency.
$ python2 linux-firewire-utils/src/crpp < /sys/bus/firewire/devices/fw1/config_rom
ROM header and bus information block
-----------------------------------------------------------------
400 04107768 bus_info_length 4, crc_length 16, crc 30568 (should be 61311)
404 31333934 bus_name "1394"
408 20009002 irmc 0, cmc 0, isc 1, bmc 0, cyc_clk_acc 0, max_rec 9 (1024)
40c 000a3501 company_id 000a35 |
410 1bd0862a device_id 011bd0862a | EUI-64 000a35011bd0862a
root directory
-----------------------------------------------------------------
414 000485ec directory_length 4, crc 34284
418 03000a35 vendor
41c 0c0083c0 node capabilities per IEEE 1394
420 8d000006 --> eui-64 leaf at 438
424 d1000001 --> unit directory at 428
unit directory at 428
-----------------------------------------------------------------
428 000314c4 directory_length 3, crc 5316
42c 12000a35 specifier id
430 13000002 version
434 17101800 model
eui-64 leaf at 438
-----------------------------------------------------------------
438 000261a8 leaf_length 2, crc 25000
43c 000a3501 company_id 000a35 |
440 1bd0862a device_id 011bd0862a | EUI-64 000a35011bd0862a
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2017-03-31 20:06:12 +07:00
|
|
|
/* Fireface 400 */
|
|
|
|
{
|
|
|
|
.match_flags = IEEE1394_MATCH_VENDOR_ID |
|
|
|
|
IEEE1394_MATCH_SPECIFIER_ID |
|
|
|
|
IEEE1394_MATCH_VERSION |
|
|
|
|
IEEE1394_MATCH_MODEL_ID,
|
|
|
|
.vendor_id = OUI_RME,
|
|
|
|
.specifier_id = 0x000a35,
|
|
|
|
.version = 0x000002,
|
|
|
|
.model_id = 0x101800,
|
|
|
|
.driver_data = (kernel_ulong_t)&spec_ff400,
|
|
|
|
},
|
2017-03-31 20:05:59 +07:00
|
|
|
{}
|
|
|
|
};
|
|
|
|
MODULE_DEVICE_TABLE(ieee1394, snd_ff_id_table);
|
|
|
|
|
|
|
|
static struct fw_driver ff_driver = {
|
|
|
|
.driver = {
|
|
|
|
.owner = THIS_MODULE,
|
|
|
|
.name = "snd-fireface",
|
|
|
|
.bus = &fw_bus_type,
|
|
|
|
},
|
|
|
|
.probe = snd_ff_probe,
|
|
|
|
.update = snd_ff_update,
|
|
|
|
.remove = snd_ff_remove,
|
|
|
|
.id_table = snd_ff_id_table,
|
|
|
|
};
|
|
|
|
|
|
|
|
static int __init snd_ff_init(void)
|
|
|
|
{
|
|
|
|
return driver_register(&ff_driver.driver);
|
|
|
|
}
|
|
|
|
|
|
|
|
static void __exit snd_ff_exit(void)
|
|
|
|
{
|
|
|
|
driver_unregister(&ff_driver.driver);
|
|
|
|
}
|
|
|
|
|
|
|
|
module_init(snd_ff_init);
|
|
|
|
module_exit(snd_ff_exit);
|