1 /* 2 * tascam.c - a part of driver for TASCAM FireWire series 3 * 4 * Copyright (c) 2015 Takashi Sakamoto 5 * 6 * Licensed under the terms of the GNU General Public License, version 2. 7 */ 8 9 #include "tascam.h" 10 11 MODULE_DESCRIPTION("TASCAM FireWire series Driver"); 12 MODULE_AUTHOR("Takashi Sakamoto <o-takashi@sakamocchi.jp>"); 13 MODULE_LICENSE("GPL v2"); 14 15 static const struct snd_tscm_spec model_specs[] = { 16 { 17 .name = "FW-1884", 18 .has_adat = true, 19 .has_spdif = true, 20 .pcm_capture_analog_channels = 8, 21 .pcm_playback_analog_channels = 8, 22 .midi_capture_ports = 4, 23 .midi_playback_ports = 4, 24 }, 25 { 26 .name = "FW-1082", 27 .has_adat = false, 28 .has_spdif = true, 29 .pcm_capture_analog_channels = 8, 30 .pcm_playback_analog_channels = 2, 31 .midi_capture_ports = 2, 32 .midi_playback_ports = 2, 33 }, 34 { 35 .name = "FW-1804", 36 .has_adat = true, 37 .has_spdif = true, 38 .pcm_capture_analog_channels = 8, 39 .pcm_playback_analog_channels = 2, 40 .midi_capture_ports = 2, 41 .midi_playback_ports = 4, 42 }, 43 }; 44 45 static int identify_model(struct snd_tscm *tscm) 46 { 47 struct fw_device *fw_dev = fw_parent_device(tscm->unit); 48 const u32 *config_rom = fw_dev->config_rom; 49 char model[9]; 50 unsigned int i; 51 u8 c; 52 53 if (fw_dev->config_rom_length < 30) { 54 dev_err(&tscm->unit->device, 55 "Configuration ROM is too short.\n"); 56 return -ENODEV; 57 } 58 59 /* Pick up model name from certain addresses. */ 60 for (i = 0; i < 8; i++) { 61 c = config_rom[28 + i / 4] >> (24 - 8 * (i % 4)); 62 if (c == '\0') 63 break; 64 model[i] = c; 65 } 66 model[i] = '\0'; 67 68 for (i = 0; i < ARRAY_SIZE(model_specs); i++) { 69 if (strcmp(model, model_specs[i].name) == 0) { 70 tscm->spec = &model_specs[i]; 71 break; 72 } 73 } 74 if (tscm->spec == NULL) 75 return -ENODEV; 76 77 strcpy(tscm->card->driver, "FW-TASCAM"); 78 strcpy(tscm->card->shortname, model); 79 strcpy(tscm->card->mixername, model); 80 snprintf(tscm->card->longname, sizeof(tscm->card->longname), 81 "TASCAM %s, GUID %08x%08x at %s, S%d", model, 82 fw_dev->config_rom[3], fw_dev->config_rom[4], 83 dev_name(&tscm->unit->device), 100 << fw_dev->max_speed); 84 85 return 0; 86 } 87 88 static void tscm_card_free(struct snd_card *card) 89 { 90 struct snd_tscm *tscm = card->private_data; 91 92 snd_tscm_transaction_unregister(tscm); 93 snd_tscm_stream_destroy_duplex(tscm); 94 } 95 96 static void do_registration(struct work_struct *work) 97 { 98 struct snd_tscm *tscm = container_of(work, struct snd_tscm, dwork.work); 99 int err; 100 101 err = snd_card_new(&tscm->unit->device, -1, NULL, THIS_MODULE, 0, 102 &tscm->card); 103 if (err < 0) 104 return; 105 tscm->card->private_free = tscm_card_free; 106 tscm->card->private_data = tscm; 107 108 err = identify_model(tscm); 109 if (err < 0) 110 goto error; 111 112 err = snd_tscm_transaction_register(tscm); 113 if (err < 0) 114 goto error; 115 116 err = snd_tscm_stream_init_duplex(tscm); 117 if (err < 0) 118 goto error; 119 120 snd_tscm_proc_init(tscm); 121 122 err = snd_tscm_create_pcm_devices(tscm); 123 if (err < 0) 124 goto error; 125 126 err = snd_tscm_create_midi_devices(tscm); 127 if (err < 0) 128 goto error; 129 130 err = snd_tscm_create_hwdep_device(tscm); 131 if (err < 0) 132 goto error; 133 134 err = snd_card_register(tscm->card); 135 if (err < 0) 136 goto error; 137 138 tscm->registered = true; 139 140 return; 141 error: 142 snd_card_free(tscm->card); 143 dev_info(&tscm->unit->device, 144 "Sound card registration failed: %d\n", err); 145 } 146 147 static int snd_tscm_probe(struct fw_unit *unit, 148 const struct ieee1394_device_id *entry) 149 { 150 struct snd_tscm *tscm; 151 152 /* Allocate this independent of sound card instance. */ 153 tscm = devm_kzalloc(&unit->device, sizeof(struct snd_tscm), GFP_KERNEL); 154 if (!tscm) 155 return -ENOMEM; 156 tscm->unit = fw_unit_get(unit); 157 dev_set_drvdata(&unit->device, tscm); 158 159 mutex_init(&tscm->mutex); 160 spin_lock_init(&tscm->lock); 161 init_waitqueue_head(&tscm->hwdep_wait); 162 163 /* Allocate and register this sound card later. */ 164 INIT_DEFERRABLE_WORK(&tscm->dwork, do_registration); 165 snd_fw_schedule_registration(unit, &tscm->dwork); 166 167 return 0; 168 } 169 170 static void snd_tscm_update(struct fw_unit *unit) 171 { 172 struct snd_tscm *tscm = dev_get_drvdata(&unit->device); 173 174 /* Postpone a workqueue for deferred registration. */ 175 if (!tscm->registered) 176 snd_fw_schedule_registration(unit, &tscm->dwork); 177 178 snd_tscm_transaction_reregister(tscm); 179 180 /* 181 * After registration, userspace can start packet streaming, then this 182 * code block works fine. 183 */ 184 if (tscm->registered) { 185 mutex_lock(&tscm->mutex); 186 snd_tscm_stream_update_duplex(tscm); 187 mutex_unlock(&tscm->mutex); 188 } 189 } 190 191 static void snd_tscm_remove(struct fw_unit *unit) 192 { 193 struct snd_tscm *tscm = dev_get_drvdata(&unit->device); 194 195 /* 196 * Confirm to stop the work for registration before the sound card is 197 * going to be released. The work is not scheduled again because bus 198 * reset handler is not called anymore. 199 */ 200 cancel_delayed_work_sync(&tscm->dwork); 201 202 if (tscm->registered) { 203 // Block till all of ALSA character devices are released. 204 snd_card_free(tscm->card); 205 } 206 207 mutex_destroy(&tscm->mutex); 208 fw_unit_put(tscm->unit); 209 } 210 211 static const struct ieee1394_device_id snd_tscm_id_table[] = { 212 { 213 .match_flags = IEEE1394_MATCH_VENDOR_ID | 214 IEEE1394_MATCH_SPECIFIER_ID, 215 .vendor_id = 0x00022e, 216 .specifier_id = 0x00022e, 217 }, 218 /* FE-08 requires reverse-engineering because it just has faders. */ 219 {} 220 }; 221 MODULE_DEVICE_TABLE(ieee1394, snd_tscm_id_table); 222 223 static struct fw_driver tscm_driver = { 224 .driver = { 225 .owner = THIS_MODULE, 226 .name = "snd-firewire-tascam", 227 .bus = &fw_bus_type, 228 }, 229 .probe = snd_tscm_probe, 230 .update = snd_tscm_update, 231 .remove = snd_tscm_remove, 232 .id_table = snd_tscm_id_table, 233 }; 234 235 static int __init snd_tscm_init(void) 236 { 237 return driver_register(&tscm_driver.driver); 238 } 239 240 static void __exit snd_tscm_exit(void) 241 { 242 driver_unregister(&tscm_driver.driver); 243 } 244 245 module_init(snd_tscm_init); 246 module_exit(snd_tscm_exit); 247