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