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