16c3cef48STakashi Sakamoto /* 26c3cef48STakashi Sakamoto * motu.c - a part of driver for MOTU FireWire series 36c3cef48STakashi Sakamoto * 46c3cef48STakashi Sakamoto * Copyright (c) 2015-2017 Takashi Sakamoto <o-takashi@sakamocchi.jp> 56c3cef48STakashi Sakamoto * 66c3cef48STakashi Sakamoto * Licensed under the terms of the GNU General Public License, version 2. 76c3cef48STakashi Sakamoto */ 86c3cef48STakashi Sakamoto 96c3cef48STakashi Sakamoto #include "motu.h" 106c3cef48STakashi Sakamoto 116c3cef48STakashi Sakamoto #define OUI_MOTU 0x0001f2 126c3cef48STakashi Sakamoto 136c3cef48STakashi Sakamoto MODULE_DESCRIPTION("MOTU FireWire driver"); 146c3cef48STakashi Sakamoto MODULE_AUTHOR("Takashi Sakamoto <o-takashi@sakamocchi.jp>"); 156c3cef48STakashi Sakamoto MODULE_LICENSE("GPL v2"); 166c3cef48STakashi Sakamoto 1759f6482cSTakashi Sakamoto const unsigned int snd_motu_clock_rates[SND_MOTU_CLOCK_RATE_COUNT] = { 1859f6482cSTakashi Sakamoto /* mode 0 */ 1959f6482cSTakashi Sakamoto [0] = 44100, 2059f6482cSTakashi Sakamoto [1] = 48000, 2159f6482cSTakashi Sakamoto /* mode 1 */ 2259f6482cSTakashi Sakamoto [2] = 88200, 2359f6482cSTakashi Sakamoto [3] = 96000, 2459f6482cSTakashi Sakamoto /* mode 2 */ 2559f6482cSTakashi Sakamoto [4] = 176400, 2659f6482cSTakashi Sakamoto [5] = 192000, 2759f6482cSTakashi Sakamoto }; 2859f6482cSTakashi Sakamoto 296c3cef48STakashi Sakamoto static void name_card(struct snd_motu *motu) 306c3cef48STakashi Sakamoto { 316c3cef48STakashi Sakamoto struct fw_device *fw_dev = fw_parent_device(motu->unit); 326c3cef48STakashi Sakamoto struct fw_csr_iterator it; 336c3cef48STakashi Sakamoto int key, val; 346c3cef48STakashi Sakamoto u32 version = 0; 356c3cef48STakashi Sakamoto 366c3cef48STakashi Sakamoto fw_csr_iterator_init(&it, motu->unit->directory); 376c3cef48STakashi Sakamoto while (fw_csr_iterator_next(&it, &key, &val)) { 386c3cef48STakashi Sakamoto switch (key) { 396c3cef48STakashi Sakamoto case CSR_VERSION: 406c3cef48STakashi Sakamoto version = val; 416c3cef48STakashi Sakamoto break; 426c3cef48STakashi Sakamoto } 436c3cef48STakashi Sakamoto } 446c3cef48STakashi Sakamoto 456c3cef48STakashi Sakamoto strcpy(motu->card->driver, "FW-MOTU"); 465e03c33eSTakashi Sakamoto strcpy(motu->card->shortname, motu->spec->name); 475e03c33eSTakashi Sakamoto strcpy(motu->card->mixername, motu->spec->name); 486c3cef48STakashi Sakamoto snprintf(motu->card->longname, sizeof(motu->card->longname), 495e03c33eSTakashi Sakamoto "MOTU %s (version:%d), GUID %08x%08x at %s, S%d", 505e03c33eSTakashi Sakamoto motu->spec->name, version, 516c3cef48STakashi Sakamoto fw_dev->config_rom[3], fw_dev->config_rom[4], 526c3cef48STakashi Sakamoto dev_name(&motu->unit->device), 100 << fw_dev->max_speed); 536c3cef48STakashi Sakamoto } 546c3cef48STakashi Sakamoto 558865a31eSTakashi Sakamoto static void motu_free(struct snd_motu *motu) 566c3cef48STakashi Sakamoto { 572e76701bSTakashi Sakamoto snd_motu_transaction_unregister(motu); 582e76701bSTakashi Sakamoto 599b2bb4f2STakashi Sakamoto snd_motu_stream_destroy_duplex(motu); 606c3cef48STakashi Sakamoto fw_unit_put(motu->unit); 616c3cef48STakashi Sakamoto 626c3cef48STakashi Sakamoto mutex_destroy(&motu->mutex); 638865a31eSTakashi Sakamoto kfree(motu); 648865a31eSTakashi Sakamoto } 658865a31eSTakashi Sakamoto 668865a31eSTakashi Sakamoto /* 678865a31eSTakashi Sakamoto * This module releases the FireWire unit data after all ALSA character devices 688865a31eSTakashi Sakamoto * are released by applications. This is for releasing stream data or finishing 698865a31eSTakashi Sakamoto * transactions safely. Thus at returning from .remove(), this module still keep 708865a31eSTakashi Sakamoto * references for the unit. 718865a31eSTakashi Sakamoto */ 728865a31eSTakashi Sakamoto static void motu_card_free(struct snd_card *card) 738865a31eSTakashi Sakamoto { 748865a31eSTakashi Sakamoto motu_free(card->private_data); 758865a31eSTakashi Sakamoto } 768865a31eSTakashi Sakamoto 778865a31eSTakashi Sakamoto static void do_registration(struct work_struct *work) 788865a31eSTakashi Sakamoto { 798865a31eSTakashi Sakamoto struct snd_motu *motu = container_of(work, struct snd_motu, dwork.work); 808865a31eSTakashi Sakamoto int err; 818865a31eSTakashi Sakamoto 828865a31eSTakashi Sakamoto if (motu->registered) 838865a31eSTakashi Sakamoto return; 848865a31eSTakashi Sakamoto 858865a31eSTakashi Sakamoto err = snd_card_new(&motu->unit->device, -1, NULL, THIS_MODULE, 0, 868865a31eSTakashi Sakamoto &motu->card); 878865a31eSTakashi Sakamoto if (err < 0) 888865a31eSTakashi Sakamoto return; 898865a31eSTakashi Sakamoto 908865a31eSTakashi Sakamoto name_card(motu); 918865a31eSTakashi Sakamoto 922e76701bSTakashi Sakamoto err = snd_motu_transaction_register(motu); 932e76701bSTakashi Sakamoto if (err < 0) 942e76701bSTakashi Sakamoto goto error; 952e76701bSTakashi Sakamoto 969b2bb4f2STakashi Sakamoto err = snd_motu_stream_init_duplex(motu); 979b2bb4f2STakashi Sakamoto if (err < 0) 989b2bb4f2STakashi Sakamoto goto error; 999b2bb4f2STakashi Sakamoto 1004638ec6eSTakashi Sakamoto snd_motu_proc_init(motu); 1014638ec6eSTakashi Sakamoto 102dd49b2d1STakashi Sakamoto err = snd_motu_create_pcm_devices(motu); 103dd49b2d1STakashi Sakamoto if (err < 0) 104dd49b2d1STakashi Sakamoto goto error; 105dd49b2d1STakashi Sakamoto 1068b460c76STakashi Sakamoto if ((motu->spec->flags & SND_MOTU_SPEC_RX_MIDI_2ND_Q) || 1078b460c76STakashi Sakamoto (motu->spec->flags & SND_MOTU_SPEC_RX_MIDI_3RD_Q) || 1088b460c76STakashi Sakamoto (motu->spec->flags & SND_MOTU_SPEC_TX_MIDI_2ND_Q) || 1098b460c76STakashi Sakamoto (motu->spec->flags & SND_MOTU_SPEC_TX_MIDI_3RD_Q)) { 1109e796e7dSTakashi Sakamoto err = snd_motu_create_midi_devices(motu); 1119e796e7dSTakashi Sakamoto if (err < 0) 1129e796e7dSTakashi Sakamoto goto error; 1139e796e7dSTakashi Sakamoto } 1149e796e7dSTakashi Sakamoto 11571c37977STakashi Sakamoto err = snd_motu_create_hwdep_device(motu); 11671c37977STakashi Sakamoto if (err < 0) 11771c37977STakashi Sakamoto goto error; 11871c37977STakashi Sakamoto 1198865a31eSTakashi Sakamoto err = snd_card_register(motu->card); 1208865a31eSTakashi Sakamoto if (err < 0) 1218865a31eSTakashi Sakamoto goto error; 1228865a31eSTakashi Sakamoto 1238865a31eSTakashi Sakamoto /* 1248865a31eSTakashi Sakamoto * After registered, motu instance can be released corresponding to 1258865a31eSTakashi Sakamoto * releasing the sound card instance. 1268865a31eSTakashi Sakamoto */ 1278865a31eSTakashi Sakamoto motu->card->private_free = motu_card_free; 1288865a31eSTakashi Sakamoto motu->card->private_data = motu; 1298865a31eSTakashi Sakamoto motu->registered = true; 1308865a31eSTakashi Sakamoto 1318865a31eSTakashi Sakamoto return; 1328865a31eSTakashi Sakamoto error: 1332e76701bSTakashi Sakamoto snd_motu_transaction_unregister(motu); 134dbd7396bSTakashi Sakamoto snd_motu_stream_destroy_duplex(motu); 1358865a31eSTakashi Sakamoto snd_card_free(motu->card); 1368865a31eSTakashi Sakamoto dev_info(&motu->unit->device, 1378865a31eSTakashi Sakamoto "Sound card registration failed: %d\n", err); 1386c3cef48STakashi Sakamoto } 1396c3cef48STakashi Sakamoto 1406c3cef48STakashi Sakamoto static int motu_probe(struct fw_unit *unit, 1416c3cef48STakashi Sakamoto const struct ieee1394_device_id *entry) 1426c3cef48STakashi Sakamoto { 1436c3cef48STakashi Sakamoto struct snd_motu *motu; 1446c3cef48STakashi Sakamoto 1458865a31eSTakashi Sakamoto /* Allocate this independently of sound card instance. */ 1468865a31eSTakashi Sakamoto motu = kzalloc(sizeof(struct snd_motu), GFP_KERNEL); 1478865a31eSTakashi Sakamoto if (motu == NULL) 1488865a31eSTakashi Sakamoto return -ENOMEM; 1496c3cef48STakashi Sakamoto 1505e03c33eSTakashi Sakamoto motu->spec = (const struct snd_motu_spec *)entry->driver_data; 1516c3cef48STakashi Sakamoto motu->unit = fw_unit_get(unit); 1528865a31eSTakashi Sakamoto dev_set_drvdata(&unit->device, motu); 1536c3cef48STakashi Sakamoto 1546c3cef48STakashi Sakamoto mutex_init(&motu->mutex); 1559e796e7dSTakashi Sakamoto spin_lock_init(&motu->lock); 15671c37977STakashi Sakamoto init_waitqueue_head(&motu->hwdep_wait); 1576c3cef48STakashi Sakamoto 1588865a31eSTakashi Sakamoto /* Allocate and register this sound card later. */ 1598865a31eSTakashi Sakamoto INIT_DEFERRABLE_WORK(&motu->dwork, do_registration); 1608865a31eSTakashi Sakamoto snd_fw_schedule_registration(unit, &motu->dwork); 1616c3cef48STakashi Sakamoto 1626c3cef48STakashi Sakamoto return 0; 1636c3cef48STakashi Sakamoto } 1646c3cef48STakashi Sakamoto 1656c3cef48STakashi Sakamoto static void motu_remove(struct fw_unit *unit) 1666c3cef48STakashi Sakamoto { 1676c3cef48STakashi Sakamoto struct snd_motu *motu = dev_get_drvdata(&unit->device); 1686c3cef48STakashi Sakamoto 1698865a31eSTakashi Sakamoto /* 1708865a31eSTakashi Sakamoto * Confirm to stop the work for registration before the sound card is 1718865a31eSTakashi Sakamoto * going to be released. The work is not scheduled again because bus 1728865a31eSTakashi Sakamoto * reset handler is not called anymore. 1738865a31eSTakashi Sakamoto */ 1748865a31eSTakashi Sakamoto cancel_delayed_work_sync(&motu->dwork); 1758865a31eSTakashi Sakamoto 1768865a31eSTakashi Sakamoto if (motu->registered) { 1776c3cef48STakashi Sakamoto /* No need to wait for releasing card object in this context. */ 1786c3cef48STakashi Sakamoto snd_card_free_when_closed(motu->card); 1798865a31eSTakashi Sakamoto } else { 1808865a31eSTakashi Sakamoto /* Don't forget this case. */ 1818865a31eSTakashi Sakamoto motu_free(motu); 1828865a31eSTakashi Sakamoto } 1836c3cef48STakashi Sakamoto } 1846c3cef48STakashi Sakamoto 1856c3cef48STakashi Sakamoto static void motu_bus_update(struct fw_unit *unit) 1866c3cef48STakashi Sakamoto { 1878865a31eSTakashi Sakamoto struct snd_motu *motu = dev_get_drvdata(&unit->device); 1888865a31eSTakashi Sakamoto 1898865a31eSTakashi Sakamoto /* Postpone a workqueue for deferred registration. */ 1908865a31eSTakashi Sakamoto if (!motu->registered) 1918865a31eSTakashi Sakamoto snd_fw_schedule_registration(unit, &motu->dwork); 1922e76701bSTakashi Sakamoto 1932e76701bSTakashi Sakamoto /* The handler address register becomes initialized. */ 1942e76701bSTakashi Sakamoto snd_motu_transaction_reregister(motu); 1956c3cef48STakashi Sakamoto } 1966c3cef48STakashi Sakamoto 197782fbec7STakashi Sakamoto static const struct snd_motu_spec motu_828mk2 = { 198949613e3STakashi Sakamoto .name = "828mk2", 199949613e3STakashi Sakamoto .protocol = &snd_motu_protocol_v2, 200949613e3STakashi Sakamoto .flags = SND_MOTU_SPEC_SUPPORT_CLOCK_X2 | 201949613e3STakashi Sakamoto SND_MOTU_SPEC_TX_MICINST_CHUNK | 202949613e3STakashi Sakamoto SND_MOTU_SPEC_TX_RETURN_CHUNK | 203*81720c6dSTakashi Sakamoto SND_MOTU_SPEC_RX_SEPARETED_MAIN | 204949613e3STakashi Sakamoto SND_MOTU_SPEC_HAS_OPT_IFACE_A | 2058b460c76STakashi Sakamoto SND_MOTU_SPEC_RX_MIDI_2ND_Q | 2068b460c76STakashi Sakamoto SND_MOTU_SPEC_TX_MIDI_2ND_Q, 207949613e3STakashi Sakamoto 208949613e3STakashi Sakamoto .analog_in_ports = 8, 209949613e3STakashi Sakamoto .analog_out_ports = 8, 210949613e3STakashi Sakamoto }; 211949613e3STakashi Sakamoto 212782fbec7STakashi Sakamoto static const struct snd_motu_spec motu_828mk3 = { 2135992e300STakashi Sakamoto .name = "828mk3", 2145992e300STakashi Sakamoto .protocol = &snd_motu_protocol_v3, 2155992e300STakashi Sakamoto .flags = SND_MOTU_SPEC_SUPPORT_CLOCK_X2 | 2165992e300STakashi Sakamoto SND_MOTU_SPEC_SUPPORT_CLOCK_X4 | 2175992e300STakashi Sakamoto SND_MOTU_SPEC_TX_MICINST_CHUNK | 2185992e300STakashi Sakamoto SND_MOTU_SPEC_TX_RETURN_CHUNK | 2195992e300STakashi Sakamoto SND_MOTU_SPEC_TX_REVERB_CHUNK | 220*81720c6dSTakashi Sakamoto SND_MOTU_SPEC_RX_SEPARETED_MAIN | 2215992e300STakashi Sakamoto SND_MOTU_SPEC_HAS_OPT_IFACE_A | 2225992e300STakashi Sakamoto SND_MOTU_SPEC_HAS_OPT_IFACE_B | 2238b460c76STakashi Sakamoto SND_MOTU_SPEC_RX_MIDI_3RD_Q | 2248b460c76STakashi Sakamoto SND_MOTU_SPEC_TX_MIDI_3RD_Q, 2255992e300STakashi Sakamoto 2265992e300STakashi Sakamoto .analog_in_ports = 8, 2275992e300STakashi Sakamoto .analog_out_ports = 8, 2285992e300STakashi Sakamoto }; 2295992e300STakashi Sakamoto 230782fbec7STakashi Sakamoto static const struct snd_motu_spec motu_audio_express = { 2313a93d082STakashi Sakamoto .name = "AudioExpress", 2323a93d082STakashi Sakamoto .protocol = &snd_motu_protocol_v3, 2333a93d082STakashi Sakamoto .flags = SND_MOTU_SPEC_SUPPORT_CLOCK_X2 | 2343a93d082STakashi Sakamoto SND_MOTU_SPEC_TX_MICINST_CHUNK | 2353a93d082STakashi Sakamoto SND_MOTU_SPEC_TX_RETURN_CHUNK | 236*81720c6dSTakashi Sakamoto SND_MOTU_SPEC_RX_SEPARETED_MAIN | 2373a93d082STakashi Sakamoto SND_MOTU_SPEC_RX_MIDI_2ND_Q | 2383a93d082STakashi Sakamoto SND_MOTU_SPEC_TX_MIDI_3RD_Q, 2393a93d082STakashi Sakamoto .analog_in_ports = 2, 2403a93d082STakashi Sakamoto .analog_out_ports = 4, 2413a93d082STakashi Sakamoto }; 2423a93d082STakashi Sakamoto 2435e03c33eSTakashi Sakamoto #define SND_MOTU_DEV_ENTRY(model, data) \ 2446c3cef48STakashi Sakamoto { \ 2456c3cef48STakashi Sakamoto .match_flags = IEEE1394_MATCH_VENDOR_ID | \ 2466c3cef48STakashi Sakamoto IEEE1394_MATCH_MODEL_ID | \ 2476c3cef48STakashi Sakamoto IEEE1394_MATCH_SPECIFIER_ID, \ 2486c3cef48STakashi Sakamoto .vendor_id = OUI_MOTU, \ 2496c3cef48STakashi Sakamoto .model_id = model, \ 2506c3cef48STakashi Sakamoto .specifier_id = OUI_MOTU, \ 2515e03c33eSTakashi Sakamoto .driver_data = (kernel_ulong_t)data, \ 2526c3cef48STakashi Sakamoto } 2536c3cef48STakashi Sakamoto 2546c3cef48STakashi Sakamoto static const struct ieee1394_device_id motu_id_table[] = { 255949613e3STakashi Sakamoto SND_MOTU_DEV_ENTRY(0x101800, &motu_828mk2), 2565992e300STakashi Sakamoto SND_MOTU_DEV_ENTRY(0x106800, &motu_828mk3), /* FireWire only. */ 2575992e300STakashi Sakamoto SND_MOTU_DEV_ENTRY(0x100800, &motu_828mk3), /* Hybrid. */ 2583a93d082STakashi Sakamoto SND_MOTU_DEV_ENTRY(0x104800, &motu_audio_express), 2596c3cef48STakashi Sakamoto { } 2606c3cef48STakashi Sakamoto }; 2616c3cef48STakashi Sakamoto MODULE_DEVICE_TABLE(ieee1394, motu_id_table); 2626c3cef48STakashi Sakamoto 2636c3cef48STakashi Sakamoto static struct fw_driver motu_driver = { 2646c3cef48STakashi Sakamoto .driver = { 2656c3cef48STakashi Sakamoto .owner = THIS_MODULE, 2666c3cef48STakashi Sakamoto .name = KBUILD_MODNAME, 2676c3cef48STakashi Sakamoto .bus = &fw_bus_type, 2686c3cef48STakashi Sakamoto }, 2696c3cef48STakashi Sakamoto .probe = motu_probe, 2706c3cef48STakashi Sakamoto .update = motu_bus_update, 2716c3cef48STakashi Sakamoto .remove = motu_remove, 2726c3cef48STakashi Sakamoto .id_table = motu_id_table, 2736c3cef48STakashi Sakamoto }; 2746c3cef48STakashi Sakamoto 2756c3cef48STakashi Sakamoto static int __init alsa_motu_init(void) 2766c3cef48STakashi Sakamoto { 2776c3cef48STakashi Sakamoto return driver_register(&motu_driver.driver); 2786c3cef48STakashi Sakamoto } 2796c3cef48STakashi Sakamoto 2806c3cef48STakashi Sakamoto static void __exit alsa_motu_exit(void) 2816c3cef48STakashi Sakamoto { 2826c3cef48STakashi Sakamoto driver_unregister(&motu_driver.driver); 2836c3cef48STakashi Sakamoto } 2846c3cef48STakashi Sakamoto 2856c3cef48STakashi Sakamoto module_init(alsa_motu_init); 2866c3cef48STakashi Sakamoto module_exit(alsa_motu_exit); 287