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_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_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
61 #define MODEL_FOCUSRITE_SAFFIRE_BOTH 0x00000000
62 #define MODEL_MAUDIO_AUDIOPHILE_BOTH 0x00010060
63 #define MODEL_MAUDIO_FW1814 0x00010071
64 #define MODEL_MAUDIO_PROJECTMIX 0x00010091
67 name_device(struct snd_bebob *bebob, unsigned int vendor_id)
69 struct fw_device *fw_dev = fw_parent_device(bebob->unit);
70 char vendor[24] = {0};
77 /* get vendor name from root directory */
78 err = fw_csr_string(fw_dev->config_rom + 5, CSR_VENDOR,
79 vendor, sizeof(vendor));
83 /* get model name from unit directory */
84 err = fw_csr_string(bebob->unit->directory, CSR_MODEL,
85 model, sizeof(model));
90 err = snd_bebob_read_quad(bebob->unit, INFO_OFFSET_HW_MODEL_ID,
95 /* get hardware revision */
96 err = snd_bebob_read_quad(bebob->unit, INFO_OFFSET_HW_MODEL_REVISION,
102 err = snd_bebob_read_block(bebob->unit, INFO_OFFSET_GUID,
107 strcpy(bebob->card->driver, "BeBoB");
108 strcpy(bebob->card->shortname, model);
109 strcpy(bebob->card->mixername, model);
110 snprintf(bebob->card->longname, sizeof(bebob->card->longname),
111 "%s %s (id:%d, rev:%d), GUID %08x%08x at %s, S%d",
112 vendor, model, id, revision,
113 data[0], data[1], dev_name(&bebob->unit->device),
114 100 << fw_dev->max_speed);
120 bebob_card_free(struct snd_card *card)
122 struct snd_bebob *bebob = card->private_data;
124 if (bebob->card_index >= 0) {
125 mutex_lock(&devices_mutex);
126 clear_bit(bebob->card_index, devices_used);
127 mutex_unlock(&devices_mutex);
130 mutex_destroy(&bebob->mutex);
133 static const struct snd_bebob_spec *
134 get_saffire_spec(struct fw_unit *unit)
138 if (fw_csr_string(unit->directory, CSR_MODEL, name, sizeof(name)) < 0)
141 if (strcmp(name, "SaffireLE") == 0)
142 return &saffire_le_spec;
144 return &saffire_spec;
148 check_audiophile_booted(struct fw_unit *unit)
152 if (fw_csr_string(unit->directory, CSR_MODEL, name, sizeof(name)) < 0)
155 return strncmp(name, "FW Audiophile Bootloader", 15) != 0;
159 bebob_probe(struct fw_unit *unit,
160 const struct ieee1394_device_id *entry)
162 struct snd_card *card;
163 struct snd_bebob *bebob;
164 const struct snd_bebob_spec *spec;
165 unsigned int card_index;
168 mutex_lock(&devices_mutex);
170 for (card_index = 0; card_index < SNDRV_CARDS; card_index++) {
171 if (!test_bit(card_index, devices_used) && enable[card_index])
174 if (card_index >= SNDRV_CARDS) {
179 if ((entry->vendor_id == VEN_FOCUSRITE) &&
180 (entry->model_id == MODEL_FOCUSRITE_SAFFIRE_BOTH))
181 spec = get_saffire_spec(unit);
182 else if ((entry->vendor_id == VEN_MAUDIO1) &&
183 (entry->model_id == MODEL_MAUDIO_AUDIOPHILE_BOTH) &&
184 !check_audiophile_booted(unit))
187 spec = (const struct snd_bebob_spec *)entry->driver_data;
190 if ((entry->vendor_id == VEN_MAUDIO1) ||
191 (entry->vendor_id == VEN_MAUDIO2))
192 err = snd_bebob_maudio_load_firmware(unit);
198 err = snd_card_new(&unit->device, index[card_index], id[card_index],
199 THIS_MODULE, sizeof(struct snd_bebob), &card);
202 bebob = card->private_data;
203 bebob->card_index = card_index;
204 set_bit(card_index, devices_used);
205 card->private_free = bebob_card_free;
210 mutex_init(&bebob->mutex);
211 spin_lock_init(&bebob->lock);
212 init_waitqueue_head(&bebob->hwdep_wait);
214 err = name_device(bebob, entry->vendor_id);
218 if ((entry->vendor_id == VEN_MAUDIO1) &&
219 (entry->model_id == MODEL_MAUDIO_FW1814))
220 err = snd_bebob_maudio_special_discover(bebob, true);
221 else if ((entry->vendor_id == VEN_MAUDIO1) &&
222 (entry->model_id == MODEL_MAUDIO_PROJECTMIX))
223 err = snd_bebob_maudio_special_discover(bebob, false);
225 err = snd_bebob_stream_discover(bebob);
229 snd_bebob_proc_init(bebob);
231 if ((bebob->midi_input_ports > 0) ||
232 (bebob->midi_output_ports > 0)) {
233 err = snd_bebob_create_midi_devices(bebob);
238 err = snd_bebob_create_pcm_devices(bebob);
242 err = snd_bebob_create_hwdep_device(bebob);
246 err = snd_bebob_stream_init_duplex(bebob);
250 err = snd_card_register(card);
252 snd_bebob_stream_destroy_duplex(bebob);
256 dev_set_drvdata(&unit->device, bebob);
258 mutex_unlock(&devices_mutex);
261 mutex_unlock(&devices_mutex);
267 bebob_update(struct fw_unit *unit)
269 struct snd_bebob *bebob = dev_get_drvdata(&unit->device);
274 fcp_bus_reset(bebob->unit);
275 snd_bebob_stream_update_duplex(bebob);
278 static void bebob_remove(struct fw_unit *unit)
280 struct snd_bebob *bebob = dev_get_drvdata(&unit->device);
285 kfree(bebob->maudio_special_quirk);
287 snd_bebob_stream_destroy_duplex(bebob);
288 snd_card_disconnect(bebob->card);
289 snd_card_free_when_closed(bebob->card);
292 struct snd_bebob_rate_spec normal_rate_spec = {
293 .get = &snd_bebob_stream_get_rate,
294 .set = &snd_bebob_stream_set_rate
296 static const struct snd_bebob_spec spec_normal = {
298 .rate = &normal_rate_spec,
302 static const struct ieee1394_device_id bebob_id_table[] = {
304 SND_BEBOB_DEV_ENTRY(VEN_EDIROL, 0x00010049, &spec_normal),
306 SND_BEBOB_DEV_ENTRY(VEN_EDIROL, 0x00010048, &spec_normal),
307 /* Presonus, FIREBOX */
308 SND_BEBOB_DEV_ENTRY(VEN_PRESONUS, 0x00010000, &spec_normal),
309 /* PreSonus, FIREPOD/FP10 */
310 SND_BEBOB_DEV_ENTRY(VEN_PRESONUS, 0x00010066, &spec_normal),
311 /* PreSonus, Inspire1394 */
312 SND_BEBOB_DEV_ENTRY(VEN_PRESONUS, 0x00010001, &spec_normal),
313 /* BridgeCo, RDAudio1 */
314 SND_BEBOB_DEV_ENTRY(VEN_BRIDGECO, 0x00010048, &spec_normal),
315 /* BridgeCo, Audio5 */
316 SND_BEBOB_DEV_ENTRY(VEN_BRIDGECO, 0x00010049, &spec_normal),
317 /* Mackie, Onyx 1220/1620/1640 (Firewire I/O Card) */
318 SND_BEBOB_DEV_ENTRY(VEN_MACKIE, 0x00010065, &spec_normal),
319 /* Mackie, d.2 (Firewire Option) */
320 SND_BEBOB_DEV_ENTRY(VEN_MACKIE, 0x00010067, &spec_normal),
321 /* Stanton, ScratchAmp */
322 SND_BEBOB_DEV_ENTRY(VEN_STANTON, 0x00000001, &spec_normal),
323 /* Tascam, IF-FW DM */
324 SND_BEBOB_DEV_ENTRY(VEN_TASCAM, 0x00010067, &spec_normal),
325 /* Behringer, XENIX UFX 1204 */
326 SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x00001204, &spec_normal),
327 /* Behringer, XENIX UFX 1604 */
328 SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x00001604, &spec_normal),
329 /* Behringer, Digital Mixer X32 series (X-UF Card) */
330 SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x00000006, &spec_normal),
331 /* Apogee Electronics, Rosetta 200/400 (X-FireWire card) */
332 /* Apogee Electronics, DA/AD/DD-16X (X-FireWire card) */
333 SND_BEBOB_DEV_ENTRY(VEN_APOGEE, 0x00010048, &spec_normal),
334 /* Apogee Electronics, Ensemble */
335 SND_BEBOB_DEV_ENTRY(VEN_APOGEE, 0x00001eee, &spec_normal),
336 /* ESI, Quatafire610 */
337 SND_BEBOB_DEV_ENTRY(VEN_ESI, 0x00010064, &spec_normal),
338 /* AcousticReality, eARMasterOne */
339 SND_BEBOB_DEV_ENTRY(VEN_ACOUSTIC, 0x00000002, &spec_normal),
341 SND_BEBOB_DEV_ENTRY(VEN_CME, 0x00030000, &spec_normal),
342 /* Phonic, Helix Board 12 MkII */
343 SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00050000, &spec_normal),
344 /* Phonic, Helix Board 18 MkII */
345 SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00060000, &spec_normal),
346 /* Phonic, Helix Board 24 MkII */
347 SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00070000, &spec_normal),
348 /* Phonic, Helix Board 12 Universal/18 Universal/24 Universal */
349 SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00000000, &spec_normal),
350 /* Lynx, Aurora 8/16 (LT-FW) */
351 SND_BEBOB_DEV_ENTRY(VEN_LYNX, 0x00000001, &spec_normal),
353 SND_BEBOB_DEV_ENTRY(VEN_ICON, 0x00000001, &spec_normal),
354 /* PrismSound, Orpheus */
355 SND_BEBOB_DEV_ENTRY(VEN_PRISMSOUND, 0x00010048, &spec_normal),
356 /* PrismSound, ADA-8XR */
357 SND_BEBOB_DEV_ENTRY(VEN_PRISMSOUND, 0x0000ada8, &spec_normal),
358 /* TerraTec Electronic GmbH, PHASE 88 Rack FW */
359 SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000003, &phase88_rack_spec),
360 /* TerraTec Electronic GmbH, PHASE 24 FW */
361 SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000004, &phase24_series_spec),
362 /* TerraTec Electronic GmbH, Phase X24 FW */
363 SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000007, &phase24_series_spec),
364 /* TerraTec Electronic GmbH, EWS MIC2/MIC8 */
365 SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000005, &spec_normal),
366 /* Terratec Electronic GmbH, Aureon 7.1 Firewire */
367 SND_BEBOB_DEV_ENTRY(VEN_TERRATEC, 0x00000002, &spec_normal),
369 SND_BEBOB_DEV_ENTRY(VEN_YAMAHA, 0x0010000b, &yamaha_go_spec),
371 SND_BEBOB_DEV_ENTRY(VEN_YAMAHA, 0x0010000c, &yamaha_go_spec),
372 /* Focusrite, SaffirePro 26 I/O */
373 SND_BEBOB_DEV_ENTRY(VEN_FOCUSRITE, 0x00000003, &saffirepro_26_spec),
374 /* Focusrite, SaffirePro 10 I/O */
375 SND_BEBOB_DEV_ENTRY(VEN_FOCUSRITE, 0x00000006, &saffirepro_10_spec),
376 /* Focusrite, Saffire(no label and LE) */
377 SND_BEBOB_DEV_ENTRY(VEN_FOCUSRITE, MODEL_FOCUSRITE_SAFFIRE_BOTH,
379 /* M-Audio, Firewire 410 */
380 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO2, 0x00010058, NULL), /* bootloader */
381 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO2, 0x00010046, &maudio_fw410_spec),
382 /* M-Audio, Firewire Audiophile */
383 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, MODEL_MAUDIO_AUDIOPHILE_BOTH,
384 &maudio_audiophile_spec),
385 /* M-Audio, Firewire Solo */
386 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x00010062, &maudio_solo_spec),
387 /* M-Audio, Ozonic */
388 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x0000000a, &maudio_ozonic_spec),
390 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x00010081, &maudio_nrv10_spec),
391 /* M-Audio, ProFireLightbridge */
392 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x000100a1, &spec_normal),
394 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x00010070, NULL), /* bootloader */
395 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, MODEL_MAUDIO_FW1814,
396 &maudio_special_spec),
397 /* M-Audio ProjectMix */
398 SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, MODEL_MAUDIO_PROJECTMIX,
399 &maudio_special_spec),
400 /* IDs are unknown but able to be supported */
401 /* Apogee, Mini-ME Firewire */
402 /* Apogee, Mini-DAC Firewire */
403 /* Behringer, F-Control Audio 1616 */
404 /* Behringer, F-Control Audio 610 */
405 /* Cakawalk, Sonar Power Studio 66 */
407 /* ESI, Quotafire XL */
408 /* Infrasonic, DewX */
409 /* Infrasonic, Windy6 */
410 /* Mackie, Digital X Bus x.200 */
411 /* Mackie, Digital X Bus x.400 */
415 /* Phonic, FireFly 202 */
416 /* Phonic, FireFly 302 */
417 /* Rolf Spuler, Firewire Guitar */
420 MODULE_DEVICE_TABLE(ieee1394, bebob_id_table);
422 static struct fw_driver bebob_driver = {
424 .owner = THIS_MODULE,
428 .probe = bebob_probe,
429 .update = bebob_update,
430 .remove = bebob_remove,
431 .id_table = bebob_id_table,
437 return driver_register(&bebob_driver.driver);
443 driver_unregister(&bebob_driver.driver);
444 mutex_destroy(&devices_mutex);
447 module_init(snd_bebob_init);
448 module_exit(snd_bebob_exit);