1 // SPDX-License-Identifier: GPL-2.0-only
3 * bebob.c - a part of driver for BeBoB based devices
5 * Copyright (c) 2013-2014 Takashi Sakamoto
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.
16 MODULE_DESCRIPTION("BridgeCo BeBoB driver");
17 MODULE_AUTHOR("Takashi Sakamoto <o-takashi@sakamocchi.jp>");
18 MODULE_LICENSE("GPL v2");
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;
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");
31 static DEFINE_MUTEX(devices_mutex);
32 static DECLARE_BITMAP(devices_used, SNDRV_CARDS);
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
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 #define OUI_SHOUYO 0x002327
64 #define MODEL_FOCUSRITE_SAFFIRE_BOTH 0x00000000
65 #define MODEL_MAUDIO_AUDIOPHILE_BOTH 0x00010060
66 #define MODEL_MAUDIO_FW1814 0x00010071
67 #define MODEL_MAUDIO_PROJECTMIX 0x00010091
70 name_device(struct snd_bebob *bebob)
72 struct fw_device *fw_dev = fw_parent_device(bebob->unit);
73 char vendor[24] = {0};
81 /* get vendor name from root directory */
82 err = fw_csr_string(fw_dev->config_rom + 5, CSR_VENDOR,
83 vendor, sizeof(vendor));
87 /* get model name from unit directory */
88 err = fw_csr_string(bebob->unit->directory, CSR_MODEL,
89 model, sizeof(model));
94 err = snd_bebob_read_quad(bebob->unit, INFO_OFFSET_HW_MODEL_ID,
99 /* get hardware revision */
100 err = snd_bebob_read_quad(bebob->unit, INFO_OFFSET_HW_MODEL_REVISION,
106 err = snd_bebob_read_block(bebob->unit, INFO_OFFSET_GUID,
111 err = snd_bebob_read_quad(bebob->unit, INFO_OFFSET_BEBOB_VERSION,
115 bebob->version = version;
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);
130 bebob_card_free(struct snd_card *card)
132 struct snd_bebob *bebob = card->private_data;
134 mutex_lock(&devices_mutex);
135 clear_bit(bebob->card_index, devices_used);
136 mutex_unlock(&devices_mutex);
138 snd_bebob_stream_destroy_duplex(bebob);
141 static const struct snd_bebob_spec *
142 get_saffire_spec(struct fw_unit *unit)
146 if (fw_csr_string(unit->directory, CSR_MODEL, name, sizeof(name)) < 0)
149 if (strcmp(name, "SaffireLE") == 0)
150 return &saffire_le_spec;
152 return &saffire_spec;
156 check_audiophile_booted(struct fw_unit *unit)
160 if (fw_csr_string(unit->directory, CSR_MODEL, name, sizeof(name)) < 0)
163 return strncmp(name, "FW Audiophile Bootloader", 24) != 0;
167 do_registration(struct work_struct *work)
169 struct snd_bebob *bebob =
170 container_of(work, struct snd_bebob, dwork.work);
171 unsigned int card_index;
174 if (bebob->registered)
177 mutex_lock(&devices_mutex);
178 for (card_index = 0; card_index < SNDRV_CARDS; card_index++) {
179 if (!test_bit(card_index, devices_used) && enable[card_index])
182 if (card_index >= SNDRV_CARDS) {
183 mutex_unlock(&devices_mutex);
187 err = snd_card_new(&bebob->unit->device, index[card_index],
188 id[card_index], THIS_MODULE, 0, &bebob->card);
190 mutex_unlock(&devices_mutex);
193 set_bit(card_index, devices_used);
194 mutex_unlock(&devices_mutex);
196 bebob->card->private_free = bebob_card_free;
197 bebob->card->private_data = bebob;
199 err = name_device(bebob);
203 if (bebob->spec == &maudio_special_spec) {
204 if (bebob->entry->model_id == MODEL_MAUDIO_FW1814)
205 err = snd_bebob_maudio_special_discover(bebob, true);
207 err = snd_bebob_maudio_special_discover(bebob, false);
209 err = snd_bebob_stream_discover(bebob);
214 err = snd_bebob_stream_init_duplex(bebob);
218 snd_bebob_proc_init(bebob);
220 if (bebob->midi_input_ports > 0 || bebob->midi_output_ports > 0) {
221 err = snd_bebob_create_midi_devices(bebob);
226 err = snd_bebob_create_pcm_devices(bebob);
230 err = snd_bebob_create_hwdep_device(bebob);
234 err = snd_card_register(bebob->card);
238 bebob->registered = true;
242 snd_card_free(bebob->card);
243 dev_info(&bebob->unit->device,
244 "Sound card registration failed: %d\n", err);
248 bebob_probe(struct fw_unit *unit, const struct ieee1394_device_id *entry)
250 struct snd_bebob *bebob;
251 const struct snd_bebob_spec *spec;
253 if (entry->vendor_id == VEN_FOCUSRITE &&
254 entry->model_id == MODEL_FOCUSRITE_SAFFIRE_BOTH)
255 spec = get_saffire_spec(unit);
256 else if (entry->vendor_id == VEN_MAUDIO1 &&
257 entry->model_id == MODEL_MAUDIO_AUDIOPHILE_BOTH &&
258 !check_audiophile_booted(unit))
261 spec = (const struct snd_bebob_spec *)entry->driver_data;
264 if (entry->vendor_id == VEN_MAUDIO1 ||
265 entry->vendor_id == VEN_MAUDIO2)
266 return snd_bebob_maudio_load_firmware(unit);
271 /* Allocate this independent of sound card instance. */
272 bebob = devm_kzalloc(&unit->device, sizeof(struct snd_bebob),
276 bebob->unit = fw_unit_get(unit);
277 dev_set_drvdata(&unit->device, bebob);
279 bebob->entry = entry;
281 mutex_init(&bebob->mutex);
282 spin_lock_init(&bebob->lock);
283 init_waitqueue_head(&bebob->hwdep_wait);
285 /* Allocate and register this sound card later. */
286 INIT_DEFERRABLE_WORK(&bebob->dwork, do_registration);
288 if (entry->vendor_id != VEN_MAUDIO1 ||
289 (entry->model_id != MODEL_MAUDIO_FW1814 &&
290 entry->model_id != MODEL_MAUDIO_PROJECTMIX)) {
291 snd_fw_schedule_registration(unit, &bebob->dwork);
294 * This is a workaround. This bus reset seems to have an effect
295 * to make devices correctly handling transactions. Without
296 * this, the devices have gap_count mismatch. This causes much
297 * failure of transaction.
299 * Just after registration, user-land application receive
300 * signals from dbus and starts I/Os. To avoid I/Os till the
301 * future bus reset, registration is done in next update().
303 fw_schedule_bus_reset(fw_parent_device(bebob->unit)->card,
311 * This driver doesn't update streams in bus reset handler.
313 * DM1000/ DM1100/DM1500 chipsets with BeBoB firmware transfer packets with
314 * discontinued counter at bus reset. This discontinuity is immediately
315 * detected in packet streaming layer, then it sets XRUN to PCM substream.
317 * ALSA PCM applications can know the XRUN by getting -EPIPE from PCM operation.
318 * Then, they can recover the PCM substream by executing ioctl(2) with
319 * SNDRV_PCM_IOCTL_PREPARE. 'struct snd_pcm_ops.prepare' is called and drivers
320 * restart packet streaming.
322 * The above processing may be executed before this bus-reset handler is
323 * executed. When this handler updates streams with current isochronous
324 * channels, the streams already have the current ones.
327 bebob_update(struct fw_unit *unit)
329 struct snd_bebob *bebob = dev_get_drvdata(&unit->device);
334 /* Postpone a workqueue for deferred registration. */
335 if (!bebob->registered)
336 snd_fw_schedule_registration(unit, &bebob->dwork);
338 fcp_bus_reset(bebob->unit);
341 static void bebob_remove(struct fw_unit *unit)
343 struct snd_bebob *bebob = dev_get_drvdata(&unit->device);
349 * Confirm to stop the work for registration before the sound card is
350 * going to be released. The work is not scheduled again because bus
351 * reset handler is not called anymore.
353 cancel_delayed_work_sync(&bebob->dwork);
355 if (bebob->registered) {
356 // Block till all of ALSA character devices are released.
357 snd_card_free(bebob->card);
360 mutex_destroy(&bebob->mutex);
361 fw_unit_put(bebob->unit);
364 static const struct snd_bebob_rate_spec normal_rate_spec = {
365 .get = &snd_bebob_stream_get_rate,
366 .set = &snd_bebob_stream_set_rate
368 static const struct snd_bebob_spec spec_normal = {
370 .rate = &normal_rate_spec,
374 static const struct ieee1394_device_id bebob_id_table[] = {
376 SND_BEBOB_DEV_ENTRY(VEN_EDIROL, 0x00010049, &spec_normal),
378 SND_BEBOB_DEV_ENTRY(VEN_EDIROL, 0x00010048, &spec_normal),
379 /* Presonus, FIREBOX */
380 SND_BEBOB_DEV_ENTRY(VEN_PRESONUS, 0x00010000, &spec_normal),
381 /* PreSonus, FIREPOD/FP10 */
382 SND_BEBOB_DEV_ENTRY(VEN_PRESONUS, 0x00010066, &spec_normal),
383 /* PreSonus, Inspire1394 */
384 SND_BEBOB_DEV_ENTRY(VEN_PRESONUS, 0x00010001, &spec_normal),
385 /* BridgeCo, RDAudio1 */
386 SND_BEBOB_DEV_ENTRY(VEN_BRIDGECO, 0x00010048, &spec_normal),
387 /* BridgeCo, Audio5 */
388 SND_BEBOB_DEV_ENTRY(VEN_BRIDGECO, 0x00010049, &spec_normal),
389 /* Mackie, Onyx 1220/1620/1640 (Firewire I/O Card) */
390 SND_BEBOB_DEV_ENTRY(VEN_MACKIE2, 0x00010065, &spec_normal),
391 // Mackie, d.2 (optional Firewire card with DM1000).
392 SND_BEBOB_DEV_ENTRY(VEN_MACKIE1, 0x00010067, &spec_normal),
393 /* Stanton, ScratchAmp */
394 SND_BEBOB_DEV_ENTRY(VEN_STANTON, 0x00000001, &spec_normal),
395 /* Tascam, IF-FW DM */
396 SND_BEBOB_DEV_ENTRY(VEN_TASCAM, 0x00010067, &spec_normal),
397 /* Behringer, XENIX UFX 1204 */
398 SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x00001204, &spec_normal),
399 /* Behringer, XENIX UFX 1604 */
400 SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x00001604, &spec_normal),
401 /* Behringer, Digital Mixer X32 series (X-UF Card) */
402 SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x00000006, &spec_normal),
403 /* Behringer, F-Control Audio 1616 */
404 SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x001616, &spec_normal),
405 /* Behringer, F-Control Audio 610 */
406 SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x000610, &spec_normal),
407 /* Apogee Electronics, Rosetta 200/400 (X-FireWire card) */
408 /* Apogee Electronics, DA/AD/DD-16X (X-FireWire card) */
409 SND_BEBOB_DEV_ENTRY(VEN_APOGEE, 0x00010048, &spec_normal),
410 /* Apogee Electronics, Ensemble */
411 SND_BEBOB_DEV_ENTRY(VEN_APOGEE, 0x01eeee, &spec_normal),
412 /* ESI, Quatafire610 */
413 SND_BEBOB_DEV_ENTRY(VEN_ESI, 0x00010064, &spec_normal),
414 /* AcousticReality, eARMasterOne */
415 SND_BEBOB_DEV_ENTRY(VEN_ACOUSTIC, 0x00000002, &spec_normal),
417 SND_BEBOB_DEV_ENTRY(VEN_CME, 0x00030000, &spec_normal),
418 /* Phonic, Helix Board 12 MkII */
419 SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00050000, &spec_normal),
420 /* Phonic, Helix Board 18 MkII */
421 SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00060000, &spec_normal),
422 /* Phonic, Helix Board 24 MkII */
423 SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00070000, &spec_normal),
424 /* Phonic, Helix Board 12 Universal/18 Universal/24 Universal */
425 SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00000000, &spec_normal),
426 /* Lynx, Aurora 8/16 (LT-FW) */
427 SND_BEBOB_DEV_ENTRY(VEN_LYNX, 0x00000001, &spec_normal),
429 SND_BEBOB_DEV_ENTRY(VEN_ICON, 0x00000001, &spec_normal),
430 /* PrismSound, Orpheus */
431 SND_BEBOB_DEV_ENTRY(VEN_PRISMSOUND, 0x00010048, &spec_normal),
432 /* PrismSound, ADA-8XR */
433 SND_BEBOB_DEV_ENTRY(VEN_PRISMSOUND, 0x0000ada8, &spec_normal),
434 /* TerraTec Electronic GmbH, PHASE 88 Rack FW */
435 SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000003, &phase88_rack_spec),
436 /* TerraTec Electronic GmbH, PHASE 24 FW */
437 SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000004, &yamaha_terratec_spec),
438 /* TerraTec Electronic GmbH, Phase X24 FW */
439 SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000007, &yamaha_terratec_spec),
440 /* TerraTec Electronic GmbH, EWS MIC2/MIC8 */
441 SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000005, &spec_normal),
442 /* Terratec Electronic GmbH, Aureon 7.1 Firewire */
443 SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000002, &spec_normal),
445 SND_BEBOB_DEV_ENTRY(VEN_YAMAHA, 0x0010000b, &yamaha_terratec_spec),
447 SND_BEBOB_DEV_ENTRY(VEN_YAMAHA, 0x0010000c, &yamaha_terratec_spec),
448 /* Focusrite, SaffirePro 26 I/O */
449 SND_BEBOB_DEV_ENTRY(VEN_FOCUSRITE, 0x00000003, &saffirepro_26_spec),
450 /* Focusrite, SaffirePro 10 I/O */
452 // The combination of vendor_id and model_id is the same as the
453 // same as the one of Liquid Saffire 56.
454 .match_flags = IEEE1394_MATCH_VENDOR_ID |
455 IEEE1394_MATCH_MODEL_ID |
456 IEEE1394_MATCH_SPECIFIER_ID |
457 IEEE1394_MATCH_VERSION,
458 .vendor_id = VEN_FOCUSRITE,
459 .model_id = 0x000006,
460 .specifier_id = 0x00a02d,
462 .driver_data = (kernel_ulong_t)&saffirepro_10_spec,
464 /* Focusrite, Saffire(no label and LE) */
465 SND_BEBOB_DEV_ENTRY(VEN_FOCUSRITE, MODEL_FOCUSRITE_SAFFIRE_BOTH,
467 /* M-Audio, Firewire 410 */
468 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO2, 0x00010058, NULL), /* bootloader */
469 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO2, 0x00010046, &maudio_fw410_spec),
470 /* M-Audio, Firewire Audiophile */
471 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, MODEL_MAUDIO_AUDIOPHILE_BOTH,
472 &maudio_audiophile_spec),
473 /* M-Audio, Firewire Solo */
474 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x00010062, &maudio_solo_spec),
475 /* M-Audio, Ozonic */
476 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x0000000a, &maudio_ozonic_spec),
478 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x00010081, &maudio_nrv10_spec),
479 /* M-Audio, ProFireLightbridge */
480 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x000100a1, &spec_normal),
482 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x00010070, NULL), /* bootloader */
483 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, MODEL_MAUDIO_FW1814,
484 &maudio_special_spec),
485 /* M-Audio ProjectMix */
486 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, MODEL_MAUDIO_PROJECTMIX,
487 &maudio_special_spec),
488 /* Digidesign Mbox 2 Pro */
489 SND_BEBOB_DEV_ENTRY(VEN_DIGIDESIGN, 0x0000a9, &spec_normal),
491 SND_BEBOB_DEV_ENTRY(OUI_SHOUYO, 0x020002, &spec_normal),
492 /* IDs are unknown but able to be supported */
493 /* Apogee, Mini-ME Firewire */
494 /* Apogee, Mini-DAC Firewire */
495 /* Cakawalk, Sonar Power Studio 66 */
497 /* ESI, Quotafire XL */
498 /* Infrasonic, DewX */
499 /* Infrasonic, Windy6 */
500 /* Mackie, Digital X Bus x.200 */
501 /* Mackie, Digital X Bus x.400 */
505 /* Phonic, FireFly 202 */
506 /* Phonic, FireFly 302 */
507 /* Rolf Spuler, Firewire Guitar */
510 MODULE_DEVICE_TABLE(ieee1394, bebob_id_table);
512 static struct fw_driver bebob_driver = {
514 .owner = THIS_MODULE,
515 .name = KBUILD_MODNAME,
518 .probe = bebob_probe,
519 .update = bebob_update,
520 .remove = bebob_remove,
521 .id_table = bebob_id_table,
527 return driver_register(&bebob_driver.driver);
533 driver_unregister(&bebob_driver.driver);
536 module_init(snd_bebob_init);
537 module_exit(snd_bebob_exit);