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