2 * bebob.c - a part of driver for BeBoB based devices
4 * Copyright (c) 2013-2014 Takashi Sakamoto
6 * Licensed under the terms of the GNU General Public License, version 2.
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.
17 MODULE_DESCRIPTION("BridgeCo BeBoB driver");
18 MODULE_AUTHOR("Takashi Sakamoto <o-takashi@sakamocchi.jp>");
19 MODULE_LICENSE("GPL v2");
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;
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");
32 static DEFINE_MUTEX(devices_mutex);
33 static DECLARE_BITMAP(devices_used, SNDRV_CARDS);
35 /* Offsets from information register. */
36 #define INFO_OFFSET_BEBOB_VERSION 0x08
37 #define INFO_OFFSET_GUID 0x10
38 #define INFO_OFFSET_HW_MODEL_ID 0x18
39 #define INFO_OFFSET_HW_MODEL_REVISION 0x1c
41 #define VEN_EDIROL 0x000040ab
42 #define VEN_PRESONUS 0x00000a92
43 #define VEN_BRIDGECO 0x000007f5
44 #define VEN_MACKIE 0x0000000f
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
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
69 name_device(struct snd_bebob *bebob, unsigned int vendor_id)
71 struct fw_device *fw_dev = fw_parent_device(bebob->unit);
72 char vendor[24] = {0};
80 /* get vendor name from root directory */
81 err = fw_csr_string(fw_dev->config_rom + 5, CSR_VENDOR,
82 vendor, sizeof(vendor));
86 /* get model name from unit directory */
87 err = fw_csr_string(bebob->unit->directory, CSR_MODEL,
88 model, sizeof(model));
93 err = snd_bebob_read_quad(bebob->unit, INFO_OFFSET_HW_MODEL_ID,
98 /* get hardware revision */
99 err = snd_bebob_read_quad(bebob->unit, INFO_OFFSET_HW_MODEL_REVISION,
105 err = snd_bebob_read_block(bebob->unit, INFO_OFFSET_GUID,
110 err = snd_bebob_read_quad(bebob->unit, INFO_OFFSET_BEBOB_VERSION,
114 bebob->version = version;
116 strcpy(bebob->card->driver, "BeBoB");
117 strcpy(bebob->card->shortname, model);
118 strcpy(bebob->card->mixername, model);
119 snprintf(bebob->card->longname, sizeof(bebob->card->longname),
120 "%s %s (id:%d, rev:%d), GUID %08x%08x at %s, S%d",
121 vendor, model, hw_id, revision,
122 data[0], data[1], dev_name(&bebob->unit->device),
123 100 << fw_dev->max_speed);
129 * This module releases the FireWire unit data after all ALSA character devices
130 * are released by applications. This is for releasing stream data or finishing
131 * transactions safely. Thus at returning from .remove(), this module still keep
132 * references for the unit.
135 bebob_card_free(struct snd_card *card)
137 struct snd_bebob *bebob = card->private_data;
139 snd_bebob_stream_destroy_duplex(bebob);
140 fw_unit_put(bebob->unit);
142 kfree(bebob->maudio_special_quirk);
144 if (bebob->card_index >= 0) {
145 mutex_lock(&devices_mutex);
146 clear_bit(bebob->card_index, devices_used);
147 mutex_unlock(&devices_mutex);
150 mutex_destroy(&bebob->mutex);
153 static const struct snd_bebob_spec *
154 get_saffire_spec(struct fw_unit *unit)
158 if (fw_csr_string(unit->directory, CSR_MODEL, name, sizeof(name)) < 0)
161 if (strcmp(name, "SaffireLE") == 0)
162 return &saffire_le_spec;
164 return &saffire_spec;
168 check_audiophile_booted(struct fw_unit *unit)
172 if (fw_csr_string(unit->directory, CSR_MODEL, name, sizeof(name)) < 0)
175 return strncmp(name, "FW Audiophile Bootloader", 15) != 0;
179 bebob_probe(struct fw_unit *unit,
180 const struct ieee1394_device_id *entry)
182 struct snd_card *card;
183 struct snd_bebob *bebob;
184 const struct snd_bebob_spec *spec;
185 unsigned int card_index;
188 mutex_lock(&devices_mutex);
190 for (card_index = 0; card_index < SNDRV_CARDS; card_index++) {
191 if (!test_bit(card_index, devices_used) && enable[card_index])
194 if (card_index >= SNDRV_CARDS) {
199 if ((entry->vendor_id == VEN_FOCUSRITE) &&
200 (entry->model_id == MODEL_FOCUSRITE_SAFFIRE_BOTH))
201 spec = get_saffire_spec(unit);
202 else if ((entry->vendor_id == VEN_MAUDIO1) &&
203 (entry->model_id == MODEL_MAUDIO_AUDIOPHILE_BOTH) &&
204 !check_audiophile_booted(unit))
207 spec = (const struct snd_bebob_spec *)entry->driver_data;
210 if ((entry->vendor_id == VEN_MAUDIO1) ||
211 (entry->vendor_id == VEN_MAUDIO2))
212 err = snd_bebob_maudio_load_firmware(unit);
218 err = snd_card_new(&unit->device, index[card_index], id[card_index],
219 THIS_MODULE, sizeof(struct snd_bebob), &card);
222 bebob = card->private_data;
223 bebob->card_index = card_index;
224 set_bit(card_index, devices_used);
225 card->private_free = bebob_card_free;
228 bebob->unit = fw_unit_get(unit);
230 mutex_init(&bebob->mutex);
231 spin_lock_init(&bebob->lock);
232 init_waitqueue_head(&bebob->hwdep_wait);
234 err = name_device(bebob, entry->vendor_id);
238 if ((entry->vendor_id == VEN_MAUDIO1) &&
239 (entry->model_id == MODEL_MAUDIO_FW1814))
240 err = snd_bebob_maudio_special_discover(bebob, true);
241 else if ((entry->vendor_id == VEN_MAUDIO1) &&
242 (entry->model_id == MODEL_MAUDIO_PROJECTMIX))
243 err = snd_bebob_maudio_special_discover(bebob, false);
245 err = snd_bebob_stream_discover(bebob);
249 snd_bebob_proc_init(bebob);
251 if ((bebob->midi_input_ports > 0) ||
252 (bebob->midi_output_ports > 0)) {
253 err = snd_bebob_create_midi_devices(bebob);
258 err = snd_bebob_create_pcm_devices(bebob);
262 err = snd_bebob_create_hwdep_device(bebob);
266 err = snd_bebob_stream_init_duplex(bebob);
270 if (!bebob->maudio_special_quirk) {
271 err = snd_card_register(card);
273 snd_bebob_stream_destroy_duplex(bebob);
278 * This is a workaround. This bus reset seems to have an effect
279 * to make devices correctly handling transactions. Without
280 * this, the devices have gap_count mismatch. This causes much
281 * failure of transaction.
283 * Just after registration, user-land application receive
284 * signals from dbus and starts I/Os. To avoid I/Os till the
285 * future bus reset, registration is done in next update().
287 bebob->deferred_registration = true;
288 fw_schedule_bus_reset(fw_parent_device(bebob->unit)->card,
292 dev_set_drvdata(&unit->device, bebob);
294 mutex_unlock(&devices_mutex);
297 mutex_unlock(&devices_mutex);
303 bebob_update(struct fw_unit *unit)
305 struct snd_bebob *bebob = dev_get_drvdata(&unit->device);
310 fcp_bus_reset(bebob->unit);
311 snd_bebob_stream_update_duplex(bebob);
313 if (bebob->deferred_registration) {
314 if (snd_card_register(bebob->card) < 0) {
315 snd_bebob_stream_destroy_duplex(bebob);
316 snd_card_free(bebob->card);
318 bebob->deferred_registration = false;
322 static void bebob_remove(struct fw_unit *unit)
324 struct snd_bebob *bebob = dev_get_drvdata(&unit->device);
329 /* Awake bus-reset waiters. */
330 if (!completion_done(&bebob->bus_reset))
331 complete_all(&bebob->bus_reset);
333 /* No need to wait for releasing card object in this context. */
334 snd_card_free_when_closed(bebob->card);
337 static struct snd_bebob_rate_spec normal_rate_spec = {
338 .get = &snd_bebob_stream_get_rate,
339 .set = &snd_bebob_stream_set_rate
341 static const struct snd_bebob_spec spec_normal = {
343 .rate = &normal_rate_spec,
347 static const struct ieee1394_device_id bebob_id_table[] = {
349 SND_BEBOB_DEV_ENTRY(VEN_EDIROL, 0x00010049, &spec_normal),
351 SND_BEBOB_DEV_ENTRY(VEN_EDIROL, 0x00010048, &spec_normal),
352 /* Presonus, FIREBOX */
353 SND_BEBOB_DEV_ENTRY(VEN_PRESONUS, 0x00010000, &spec_normal),
354 /* PreSonus, FIREPOD/FP10 */
355 SND_BEBOB_DEV_ENTRY(VEN_PRESONUS, 0x00010066, &spec_normal),
356 /* PreSonus, Inspire1394 */
357 SND_BEBOB_DEV_ENTRY(VEN_PRESONUS, 0x00010001, &spec_normal),
358 /* BridgeCo, RDAudio1 */
359 SND_BEBOB_DEV_ENTRY(VEN_BRIDGECO, 0x00010048, &spec_normal),
360 /* BridgeCo, Audio5 */
361 SND_BEBOB_DEV_ENTRY(VEN_BRIDGECO, 0x00010049, &spec_normal),
362 /* Mackie, Onyx 1220/1620/1640 (Firewire I/O Card) */
363 SND_BEBOB_DEV_ENTRY(VEN_MACKIE, 0x00010065, &spec_normal),
364 /* Mackie, d.2 (Firewire Option) */
365 SND_BEBOB_DEV_ENTRY(VEN_MACKIE, 0x00010067, &spec_normal),
366 /* Stanton, ScratchAmp */
367 SND_BEBOB_DEV_ENTRY(VEN_STANTON, 0x00000001, &spec_normal),
368 /* Tascam, IF-FW DM */
369 SND_BEBOB_DEV_ENTRY(VEN_TASCAM, 0x00010067, &spec_normal),
370 /* Behringer, XENIX UFX 1204 */
371 SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x00001204, &spec_normal),
372 /* Behringer, XENIX UFX 1604 */
373 SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x00001604, &spec_normal),
374 /* Behringer, Digital Mixer X32 series (X-UF Card) */
375 SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x00000006, &spec_normal),
376 /* Behringer, F-Control Audio 1616 */
377 SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x001616, &spec_normal),
378 /* Behringer, F-Control Audio 610 */
379 SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x000610, &spec_normal),
380 /* Apogee Electronics, Rosetta 200/400 (X-FireWire card) */
381 /* Apogee Electronics, DA/AD/DD-16X (X-FireWire card) */
382 SND_BEBOB_DEV_ENTRY(VEN_APOGEE, 0x00010048, &spec_normal),
383 /* Apogee Electronics, Ensemble */
384 SND_BEBOB_DEV_ENTRY(VEN_APOGEE, 0x00001eee, &spec_normal),
385 /* ESI, Quatafire610 */
386 SND_BEBOB_DEV_ENTRY(VEN_ESI, 0x00010064, &spec_normal),
387 /* AcousticReality, eARMasterOne */
388 SND_BEBOB_DEV_ENTRY(VEN_ACOUSTIC, 0x00000002, &spec_normal),
390 SND_BEBOB_DEV_ENTRY(VEN_CME, 0x00030000, &spec_normal),
391 /* Phonic, Helix Board 12 MkII */
392 SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00050000, &spec_normal),
393 /* Phonic, Helix Board 18 MkII */
394 SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00060000, &spec_normal),
395 /* Phonic, Helix Board 24 MkII */
396 SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00070000, &spec_normal),
397 /* Phonic, Helix Board 12 Universal/18 Universal/24 Universal */
398 SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00000000, &spec_normal),
399 /* Lynx, Aurora 8/16 (LT-FW) */
400 SND_BEBOB_DEV_ENTRY(VEN_LYNX, 0x00000001, &spec_normal),
402 SND_BEBOB_DEV_ENTRY(VEN_ICON, 0x00000001, &spec_normal),
403 /* PrismSound, Orpheus */
404 SND_BEBOB_DEV_ENTRY(VEN_PRISMSOUND, 0x00010048, &spec_normal),
405 /* PrismSound, ADA-8XR */
406 SND_BEBOB_DEV_ENTRY(VEN_PRISMSOUND, 0x0000ada8, &spec_normal),
407 /* TerraTec Electronic GmbH, PHASE 88 Rack FW */
408 SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000003, &phase88_rack_spec),
409 /* TerraTec Electronic GmbH, PHASE 24 FW */
410 SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000004, &phase24_series_spec),
411 /* TerraTec Electronic GmbH, Phase X24 FW */
412 SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000007, &phase24_series_spec),
413 /* TerraTec Electronic GmbH, EWS MIC2/MIC8 */
414 SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000005, &spec_normal),
415 /* Terratec Electronic GmbH, Aureon 7.1 Firewire */
416 SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000002, &spec_normal),
418 SND_BEBOB_DEV_ENTRY(VEN_YAMAHA, 0x0010000b, &yamaha_go_spec),
420 SND_BEBOB_DEV_ENTRY(VEN_YAMAHA, 0x0010000c, &yamaha_go_spec),
421 /* Focusrite, SaffirePro 26 I/O */
422 SND_BEBOB_DEV_ENTRY(VEN_FOCUSRITE, 0x00000003, &saffirepro_26_spec),
423 /* Focusrite, SaffirePro 10 I/O */
424 SND_BEBOB_DEV_ENTRY(VEN_FOCUSRITE, 0x00000006, &saffirepro_10_spec),
425 /* Focusrite, Saffire(no label and LE) */
426 SND_BEBOB_DEV_ENTRY(VEN_FOCUSRITE, MODEL_FOCUSRITE_SAFFIRE_BOTH,
428 /* M-Audio, Firewire 410 */
429 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO2, 0x00010058, NULL), /* bootloader */
430 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO2, 0x00010046, &maudio_fw410_spec),
431 /* M-Audio, Firewire Audiophile */
432 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, MODEL_MAUDIO_AUDIOPHILE_BOTH,
433 &maudio_audiophile_spec),
434 /* M-Audio, Firewire Solo */
435 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x00010062, &maudio_solo_spec),
436 /* M-Audio, Ozonic */
437 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x0000000a, &maudio_ozonic_spec),
439 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x00010081, &maudio_nrv10_spec),
440 /* M-Audio, ProFireLightbridge */
441 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x000100a1, &spec_normal),
443 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x00010070, NULL), /* bootloader */
444 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, MODEL_MAUDIO_FW1814,
445 &maudio_special_spec),
446 /* M-Audio ProjectMix */
447 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, MODEL_MAUDIO_PROJECTMIX,
448 &maudio_special_spec),
449 /* Digidesign Mbox 2 Pro */
450 SND_BEBOB_DEV_ENTRY(VEN_DIGIDESIGN, 0x0000a9, &spec_normal),
451 /* IDs are unknown but able to be supported */
452 /* Apogee, Mini-ME Firewire */
453 /* Apogee, Mini-DAC Firewire */
454 /* Cakawalk, Sonar Power Studio 66 */
456 /* ESI, Quotafire XL */
457 /* Infrasonic, DewX */
458 /* Infrasonic, Windy6 */
459 /* Mackie, Digital X Bus x.200 */
460 /* Mackie, Digital X Bus x.400 */
464 /* Phonic, FireFly 202 */
465 /* Phonic, FireFly 302 */
466 /* Rolf Spuler, Firewire Guitar */
469 MODULE_DEVICE_TABLE(ieee1394, bebob_id_table);
471 static struct fw_driver bebob_driver = {
473 .owner = THIS_MODULE,
477 .probe = bebob_probe,
478 .update = bebob_update,
479 .remove = bebob_remove,
480 .id_table = bebob_id_table,
486 return driver_register(&bebob_driver.driver);
492 driver_unregister(&bebob_driver.driver);
495 module_init(snd_bebob_init);
496 module_exit(snd_bebob_exit);