1 /* 2 * bebob.c - a part of driver for BeBoB based devices 3 * 4 * Copyright (c) 2013-2014 Takashi Sakamoto 5 * 6 * Licensed under the terms of the GNU General Public License, version 2. 7 */ 8 9 /* 10 * BeBoB is 'BridgeCo enhanced Breakout Box'. This is installed to firewire 11 * devices with DM1000/DM1100/DM1500 chipset. It gives common way for host 12 * system to handle BeBoB based devices. 13 */ 14 15 #include "bebob.h" 16 17 MODULE_DESCRIPTION("BridgeCo BeBoB driver"); 18 MODULE_AUTHOR("Takashi Sakamoto <o-takashi@sakamocchi.jp>"); 19 MODULE_LICENSE("GPL v2"); 20 21 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; 22 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; 23 static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP; 24 25 module_param_array(index, int, NULL, 0444); 26 MODULE_PARM_DESC(index, "card index"); 27 module_param_array(id, charp, NULL, 0444); 28 MODULE_PARM_DESC(id, "ID string"); 29 module_param_array(enable, bool, NULL, 0444); 30 MODULE_PARM_DESC(enable, "enable BeBoB sound card"); 31 32 static DEFINE_MUTEX(devices_mutex); 33 static DECLARE_BITMAP(devices_used, SNDRV_CARDS); 34 35 /* Offsets from information register. */ 36 #define INFO_OFFSET_GUID 0x10 37 #define INFO_OFFSET_HW_MODEL_ID 0x18 38 #define INFO_OFFSET_HW_MODEL_REVISION 0x1c 39 40 #define VEN_EDIROL 0x000040ab 41 #define VEN_PRESONUS 0x00000a92 42 #define VEN_BRIDGECO 0x000007f5 43 #define VEN_MACKIE 0x0000000f 44 #define VEN_STANTON 0x00001260 45 #define VEN_TASCAM 0x0000022e 46 #define VEN_BEHRINGER 0x00001564 47 #define VEN_APOGEE 0x000003db 48 #define VEN_ESI 0x00000f1b 49 #define VEN_ACOUSTIC 0x00000002 50 #define VEN_CME 0x0000000a 51 #define VEN_PHONIC 0x00001496 52 #define VEN_LYNX 0x000019e5 53 #define VEN_ICON 0x00001a9e 54 #define VEN_PRISMSOUND 0x00001198 55 #define VEN_TERRATEC 0x00000aac 56 #define VEN_YAMAHA 0x0000a0de 57 #define VEN_FOCUSRITE 0x0000130e 58 #define VEN_MAUDIO1 0x00000d6c 59 #define VEN_MAUDIO2 0x000007f5 60 #define VEN_DIGIDESIGN 0x00a07e 61 62 #define MODEL_FOCUSRITE_SAFFIRE_BOTH 0x00000000 63 #define MODEL_MAUDIO_AUDIOPHILE_BOTH 0x00010060 64 #define MODEL_MAUDIO_FW1814 0x00010071 65 #define MODEL_MAUDIO_PROJECTMIX 0x00010091 66 67 static int 68 name_device(struct snd_bebob *bebob, unsigned int vendor_id) 69 { 70 struct fw_device *fw_dev = fw_parent_device(bebob->unit); 71 char vendor[24] = {0}; 72 char model[32] = {0}; 73 u32 hw_id; 74 u32 data[2] = {0}; 75 u32 revision; 76 int err; 77 78 /* get vendor name from root directory */ 79 err = fw_csr_string(fw_dev->config_rom + 5, CSR_VENDOR, 80 vendor, sizeof(vendor)); 81 if (err < 0) 82 goto end; 83 84 /* get model name from unit directory */ 85 err = fw_csr_string(bebob->unit->directory, CSR_MODEL, 86 model, sizeof(model)); 87 if (err < 0) 88 goto end; 89 90 /* get hardware id */ 91 err = snd_bebob_read_quad(bebob->unit, INFO_OFFSET_HW_MODEL_ID, 92 &hw_id); 93 if (err < 0) 94 goto end; 95 96 /* get hardware revision */ 97 err = snd_bebob_read_quad(bebob->unit, INFO_OFFSET_HW_MODEL_REVISION, 98 &revision); 99 if (err < 0) 100 goto end; 101 102 /* get GUID */ 103 err = snd_bebob_read_block(bebob->unit, INFO_OFFSET_GUID, 104 data, sizeof(data)); 105 if (err < 0) 106 goto end; 107 108 strcpy(bebob->card->driver, "BeBoB"); 109 strcpy(bebob->card->shortname, model); 110 strcpy(bebob->card->mixername, model); 111 snprintf(bebob->card->longname, sizeof(bebob->card->longname), 112 "%s %s (id:%d, rev:%d), GUID %08x%08x at %s, S%d", 113 vendor, model, hw_id, revision, 114 data[0], data[1], dev_name(&bebob->unit->device), 115 100 << fw_dev->max_speed); 116 end: 117 return err; 118 } 119 120 /* 121 * This module releases the FireWire unit data after all ALSA character devices 122 * are released by applications. This is for releasing stream data or finishing 123 * transactions safely. Thus at returning from .remove(), this module still keep 124 * references for the unit. 125 */ 126 static void 127 bebob_card_free(struct snd_card *card) 128 { 129 struct snd_bebob *bebob = card->private_data; 130 131 snd_bebob_stream_destroy_duplex(bebob); 132 fw_unit_put(bebob->unit); 133 134 kfree(bebob->maudio_special_quirk); 135 136 if (bebob->card_index >= 0) { 137 mutex_lock(&devices_mutex); 138 clear_bit(bebob->card_index, devices_used); 139 mutex_unlock(&devices_mutex); 140 } 141 142 mutex_destroy(&bebob->mutex); 143 } 144 145 static const struct snd_bebob_spec * 146 get_saffire_spec(struct fw_unit *unit) 147 { 148 char name[24] = {0}; 149 150 if (fw_csr_string(unit->directory, CSR_MODEL, name, sizeof(name)) < 0) 151 return NULL; 152 153 if (strcmp(name, "SaffireLE") == 0) 154 return &saffire_le_spec; 155 else 156 return &saffire_spec; 157 } 158 159 static bool 160 check_audiophile_booted(struct fw_unit *unit) 161 { 162 char name[24] = {0}; 163 164 if (fw_csr_string(unit->directory, CSR_MODEL, name, sizeof(name)) < 0) 165 return false; 166 167 return strncmp(name, "FW Audiophile Bootloader", 15) != 0; 168 } 169 170 static int 171 bebob_probe(struct fw_unit *unit, 172 const struct ieee1394_device_id *entry) 173 { 174 struct snd_card *card; 175 struct snd_bebob *bebob; 176 const struct snd_bebob_spec *spec; 177 unsigned int card_index; 178 int err; 179 180 mutex_lock(&devices_mutex); 181 182 for (card_index = 0; card_index < SNDRV_CARDS; card_index++) { 183 if (!test_bit(card_index, devices_used) && enable[card_index]) 184 break; 185 } 186 if (card_index >= SNDRV_CARDS) { 187 err = -ENOENT; 188 goto end; 189 } 190 191 if ((entry->vendor_id == VEN_FOCUSRITE) && 192 (entry->model_id == MODEL_FOCUSRITE_SAFFIRE_BOTH)) 193 spec = get_saffire_spec(unit); 194 else if ((entry->vendor_id == VEN_MAUDIO1) && 195 (entry->model_id == MODEL_MAUDIO_AUDIOPHILE_BOTH) && 196 !check_audiophile_booted(unit)) 197 spec = NULL; 198 else 199 spec = (const struct snd_bebob_spec *)entry->driver_data; 200 201 if (spec == NULL) { 202 if ((entry->vendor_id == VEN_MAUDIO1) || 203 (entry->vendor_id == VEN_MAUDIO2)) 204 err = snd_bebob_maudio_load_firmware(unit); 205 else 206 err = -ENOSYS; 207 goto end; 208 } 209 210 err = snd_card_new(&unit->device, index[card_index], id[card_index], 211 THIS_MODULE, sizeof(struct snd_bebob), &card); 212 if (err < 0) 213 goto end; 214 bebob = card->private_data; 215 bebob->card_index = card_index; 216 set_bit(card_index, devices_used); 217 card->private_free = bebob_card_free; 218 219 bebob->card = card; 220 bebob->unit = fw_unit_get(unit); 221 bebob->spec = spec; 222 mutex_init(&bebob->mutex); 223 spin_lock_init(&bebob->lock); 224 init_waitqueue_head(&bebob->hwdep_wait); 225 226 err = name_device(bebob, entry->vendor_id); 227 if (err < 0) 228 goto error; 229 230 if ((entry->vendor_id == VEN_MAUDIO1) && 231 (entry->model_id == MODEL_MAUDIO_FW1814)) 232 err = snd_bebob_maudio_special_discover(bebob, true); 233 else if ((entry->vendor_id == VEN_MAUDIO1) && 234 (entry->model_id == MODEL_MAUDIO_PROJECTMIX)) 235 err = snd_bebob_maudio_special_discover(bebob, false); 236 else 237 err = snd_bebob_stream_discover(bebob); 238 if (err < 0) 239 goto error; 240 241 snd_bebob_proc_init(bebob); 242 243 if ((bebob->midi_input_ports > 0) || 244 (bebob->midi_output_ports > 0)) { 245 err = snd_bebob_create_midi_devices(bebob); 246 if (err < 0) 247 goto error; 248 } 249 250 err = snd_bebob_create_pcm_devices(bebob); 251 if (err < 0) 252 goto error; 253 254 err = snd_bebob_create_hwdep_device(bebob); 255 if (err < 0) 256 goto error; 257 258 err = snd_bebob_stream_init_duplex(bebob); 259 if (err < 0) 260 goto error; 261 262 if (!bebob->maudio_special_quirk) { 263 err = snd_card_register(card); 264 if (err < 0) { 265 snd_bebob_stream_destroy_duplex(bebob); 266 goto error; 267 } 268 } else { 269 /* 270 * This is a workaround. This bus reset seems to have an effect 271 * to make devices correctly handling transactions. Without 272 * this, the devices have gap_count mismatch. This causes much 273 * failure of transaction. 274 * 275 * Just after registration, user-land application receive 276 * signals from dbus and starts I/Os. To avoid I/Os till the 277 * future bus reset, registration is done in next update(). 278 */ 279 bebob->deferred_registration = true; 280 fw_schedule_bus_reset(fw_parent_device(bebob->unit)->card, 281 false, true); 282 } 283 284 dev_set_drvdata(&unit->device, bebob); 285 end: 286 mutex_unlock(&devices_mutex); 287 return err; 288 error: 289 mutex_unlock(&devices_mutex); 290 snd_card_free(card); 291 return err; 292 } 293 294 static void 295 bebob_update(struct fw_unit *unit) 296 { 297 struct snd_bebob *bebob = dev_get_drvdata(&unit->device); 298 299 if (bebob == NULL) 300 return; 301 302 fcp_bus_reset(bebob->unit); 303 snd_bebob_stream_update_duplex(bebob); 304 305 if (bebob->deferred_registration) { 306 if (snd_card_register(bebob->card) < 0) { 307 snd_bebob_stream_destroy_duplex(bebob); 308 snd_card_free(bebob->card); 309 } 310 bebob->deferred_registration = false; 311 } 312 } 313 314 static void bebob_remove(struct fw_unit *unit) 315 { 316 struct snd_bebob *bebob = dev_get_drvdata(&unit->device); 317 318 if (bebob == NULL) 319 return; 320 321 /* Awake bus-reset waiters. */ 322 if (!completion_done(&bebob->bus_reset)) 323 complete_all(&bebob->bus_reset); 324 325 /* No need to wait for releasing card object in this context. */ 326 snd_card_free_when_closed(bebob->card); 327 } 328 329 static struct snd_bebob_rate_spec normal_rate_spec = { 330 .get = &snd_bebob_stream_get_rate, 331 .set = &snd_bebob_stream_set_rate 332 }; 333 static const struct snd_bebob_spec spec_normal = { 334 .clock = NULL, 335 .rate = &normal_rate_spec, 336 .meter = NULL 337 }; 338 339 static const struct ieee1394_device_id bebob_id_table[] = { 340 /* Edirol, FA-66 */ 341 SND_BEBOB_DEV_ENTRY(VEN_EDIROL, 0x00010049, &spec_normal), 342 /* Edirol, FA-101 */ 343 SND_BEBOB_DEV_ENTRY(VEN_EDIROL, 0x00010048, &spec_normal), 344 /* Presonus, FIREBOX */ 345 SND_BEBOB_DEV_ENTRY(VEN_PRESONUS, 0x00010000, &spec_normal), 346 /* PreSonus, FIREPOD/FP10 */ 347 SND_BEBOB_DEV_ENTRY(VEN_PRESONUS, 0x00010066, &spec_normal), 348 /* PreSonus, Inspire1394 */ 349 SND_BEBOB_DEV_ENTRY(VEN_PRESONUS, 0x00010001, &spec_normal), 350 /* BridgeCo, RDAudio1 */ 351 SND_BEBOB_DEV_ENTRY(VEN_BRIDGECO, 0x00010048, &spec_normal), 352 /* BridgeCo, Audio5 */ 353 SND_BEBOB_DEV_ENTRY(VEN_BRIDGECO, 0x00010049, &spec_normal), 354 /* Mackie, Onyx 1220/1620/1640 (Firewire I/O Card) */ 355 SND_BEBOB_DEV_ENTRY(VEN_MACKIE, 0x00010065, &spec_normal), 356 /* Mackie, d.2 (Firewire Option) */ 357 SND_BEBOB_DEV_ENTRY(VEN_MACKIE, 0x00010067, &spec_normal), 358 /* Stanton, ScratchAmp */ 359 SND_BEBOB_DEV_ENTRY(VEN_STANTON, 0x00000001, &spec_normal), 360 /* Tascam, IF-FW DM */ 361 SND_BEBOB_DEV_ENTRY(VEN_TASCAM, 0x00010067, &spec_normal), 362 /* Behringer, XENIX UFX 1204 */ 363 SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x00001204, &spec_normal), 364 /* Behringer, XENIX UFX 1604 */ 365 SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x00001604, &spec_normal), 366 /* Behringer, Digital Mixer X32 series (X-UF Card) */ 367 SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x00000006, &spec_normal), 368 /* Apogee Electronics, Rosetta 200/400 (X-FireWire card) */ 369 /* Apogee Electronics, DA/AD/DD-16X (X-FireWire card) */ 370 SND_BEBOB_DEV_ENTRY(VEN_APOGEE, 0x00010048, &spec_normal), 371 /* Apogee Electronics, Ensemble */ 372 SND_BEBOB_DEV_ENTRY(VEN_APOGEE, 0x00001eee, &spec_normal), 373 /* ESI, Quatafire610 */ 374 SND_BEBOB_DEV_ENTRY(VEN_ESI, 0x00010064, &spec_normal), 375 /* AcousticReality, eARMasterOne */ 376 SND_BEBOB_DEV_ENTRY(VEN_ACOUSTIC, 0x00000002, &spec_normal), 377 /* CME, MatrixKFW */ 378 SND_BEBOB_DEV_ENTRY(VEN_CME, 0x00030000, &spec_normal), 379 /* Phonic, Helix Board 12 MkII */ 380 SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00050000, &spec_normal), 381 /* Phonic, Helix Board 18 MkII */ 382 SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00060000, &spec_normal), 383 /* Phonic, Helix Board 24 MkII */ 384 SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00070000, &spec_normal), 385 /* Phonic, Helix Board 12 Universal/18 Universal/24 Universal */ 386 SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00000000, &spec_normal), 387 /* Lynx, Aurora 8/16 (LT-FW) */ 388 SND_BEBOB_DEV_ENTRY(VEN_LYNX, 0x00000001, &spec_normal), 389 /* ICON, FireXon */ 390 SND_BEBOB_DEV_ENTRY(VEN_ICON, 0x00000001, &spec_normal), 391 /* PrismSound, Orpheus */ 392 SND_BEBOB_DEV_ENTRY(VEN_PRISMSOUND, 0x00010048, &spec_normal), 393 /* PrismSound, ADA-8XR */ 394 SND_BEBOB_DEV_ENTRY(VEN_PRISMSOUND, 0x0000ada8, &spec_normal), 395 /* TerraTec Electronic GmbH, PHASE 88 Rack FW */ 396 SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000003, &phase88_rack_spec), 397 /* TerraTec Electronic GmbH, PHASE 24 FW */ 398 SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000004, &phase24_series_spec), 399 /* TerraTec Electronic GmbH, Phase X24 FW */ 400 SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000007, &phase24_series_spec), 401 /* TerraTec Electronic GmbH, EWS MIC2/MIC8 */ 402 SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000005, &spec_normal), 403 /* Terratec Electronic GmbH, Aureon 7.1 Firewire */ 404 SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000002, &spec_normal), 405 /* Yamaha, GO44 */ 406 SND_BEBOB_DEV_ENTRY(VEN_YAMAHA, 0x0010000b, &yamaha_go_spec), 407 /* YAMAHA, GO46 */ 408 SND_BEBOB_DEV_ENTRY(VEN_YAMAHA, 0x0010000c, &yamaha_go_spec), 409 /* Focusrite, SaffirePro 26 I/O */ 410 SND_BEBOB_DEV_ENTRY(VEN_FOCUSRITE, 0x00000003, &saffirepro_26_spec), 411 /* Focusrite, SaffirePro 10 I/O */ 412 SND_BEBOB_DEV_ENTRY(VEN_FOCUSRITE, 0x00000006, &saffirepro_10_spec), 413 /* Focusrite, Saffire(no label and LE) */ 414 SND_BEBOB_DEV_ENTRY(VEN_FOCUSRITE, MODEL_FOCUSRITE_SAFFIRE_BOTH, 415 &saffire_spec), 416 /* M-Audio, Firewire 410 */ 417 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO2, 0x00010058, NULL), /* bootloader */ 418 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO2, 0x00010046, &maudio_fw410_spec), 419 /* M-Audio, Firewire Audiophile */ 420 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, MODEL_MAUDIO_AUDIOPHILE_BOTH, 421 &maudio_audiophile_spec), 422 /* M-Audio, Firewire Solo */ 423 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x00010062, &maudio_solo_spec), 424 /* M-Audio, Ozonic */ 425 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x0000000a, &maudio_ozonic_spec), 426 /* M-Audio NRV10 */ 427 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x00010081, &maudio_nrv10_spec), 428 /* M-Audio, ProFireLightbridge */ 429 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x000100a1, &spec_normal), 430 /* Firewire 1814 */ 431 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x00010070, NULL), /* bootloader */ 432 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, MODEL_MAUDIO_FW1814, 433 &maudio_special_spec), 434 /* M-Audio ProjectMix */ 435 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, MODEL_MAUDIO_PROJECTMIX, 436 &maudio_special_spec), 437 /* Digidesign Mbox 2 Pro */ 438 SND_BEBOB_DEV_ENTRY(VEN_DIGIDESIGN, 0x0000a9, &spec_normal), 439 /* IDs are unknown but able to be supported */ 440 /* Apogee, Mini-ME Firewire */ 441 /* Apogee, Mini-DAC Firewire */ 442 /* Behringer, F-Control Audio 1616 */ 443 /* Behringer, F-Control Audio 610 */ 444 /* Cakawalk, Sonar Power Studio 66 */ 445 /* CME, UF400e */ 446 /* ESI, Quotafire XL */ 447 /* Infrasonic, DewX */ 448 /* Infrasonic, Windy6 */ 449 /* Mackie, Digital X Bus x.200 */ 450 /* Mackie, Digital X Bus x.400 */ 451 /* Phonic, HB 12 */ 452 /* Phonic, HB 24 */ 453 /* Phonic, HB 18 */ 454 /* Phonic, FireFly 202 */ 455 /* Phonic, FireFly 302 */ 456 /* Rolf Spuler, Firewire Guitar */ 457 {} 458 }; 459 MODULE_DEVICE_TABLE(ieee1394, bebob_id_table); 460 461 static struct fw_driver bebob_driver = { 462 .driver = { 463 .owner = THIS_MODULE, 464 .name = "snd-bebob", 465 .bus = &fw_bus_type, 466 }, 467 .probe = bebob_probe, 468 .update = bebob_update, 469 .remove = bebob_remove, 470 .id_table = bebob_id_table, 471 }; 472 473 static int __init 474 snd_bebob_init(void) 475 { 476 return driver_register(&bebob_driver.driver); 477 } 478 479 static void __exit 480 snd_bebob_exit(void) 481 { 482 driver_unregister(&bebob_driver.driver); 483 } 484 485 module_init(snd_bebob_init); 486 module_exit(snd_bebob_exit); 487