sound/firewire/bebob/bebob.c

   1 /*
   2  * bebob.c - a part of driver for BeBoB based devices
   3  *
   4  * Copyright (c) 2013-2014 Takashi Sakamoto
   5  *
   6  * Licensed under the terms of the GNU General Public License, version 2.
   7  */
   8
   9 /*
  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.
  13  */
  14
  15 #include "bebob.h"
  16
  17 MODULE_DESCRIPTION("BridgeCo BeBoB driver");
  18 MODULE_AUTHOR("Takashi Sakamoto <o-takashi@sakamocchi.jp>");
  19 MODULE_LICENSE("GPL v2");
  20
  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;
  24
  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");
  31
  32 static DEFINE_MUTEX(devices_mutex);
  33 static DECLARE_BITMAP(devices_used, SNDRV_CARDS);
  34
  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
  39
  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
  56 static int
  57 name_device(struct snd_bebob *bebob, unsigned int vendor_id)
  58 {
  59         struct fw_device *fw_dev = fw_parent_device(bebob->unit);
  60         char vendor[24] = {0};
  61         char model[32] = {0};
  62         u32 id;
  63         u32 data[2] = {0};
  64         u32 revision;
  65         int err;
  66
  67         /* get vendor name from root directory */
  68         err = fw_csr_string(fw_dev->config_rom + 5, CSR_VENDOR,
  69                             vendor, sizeof(vendor));
  70         if (err < 0)
  71                 goto end;
  72
  73         /* get model name from unit directory */
  74         err = fw_csr_string(bebob->unit->directory, CSR_MODEL,
  75                             model, sizeof(model));
  76         if (err < 0)
  77                 goto end;
  78
  79         /* get hardware id */
  80         err = snd_bebob_read_quad(bebob->unit, INFO_OFFSET_HW_MODEL_ID,
  81                                   &id);
  82         if (err < 0)
  83                 goto end;
  84
  85         /* get hardware revision */
  86         err = snd_bebob_read_quad(bebob->unit, INFO_OFFSET_HW_MODEL_REVISION,
  87                                   &revision);
  88         if (err < 0)
  89                 goto end;
  90
  91         /* get GUID */
  92         err = snd_bebob_read_block(bebob->unit, INFO_OFFSET_GUID,
  93                                    data, sizeof(data));
  94         if (err < 0)
  95                 goto end;
  96
  97         strcpy(bebob->card->driver, "BeBoB");
  98         strcpy(bebob->card->shortname, model);
  99         strcpy(bebob->card->mixername, model);
 100         snprintf(bebob->card->longname, sizeof(bebob->card->longname),
 101                  "%s %s (id:%d, rev:%d), GUID %08x%08x at %s, S%d",
 102                  vendor, model, id, revision,
 103                  data[0], data[1], dev_name(&bebob->unit->device),
 104                  100 << fw_dev->max_speed);
 105 end:
 106         return err;
 107 }
 108
 109 static void
 110 bebob_card_free(struct snd_card *card)
 111 {
 112         struct snd_bebob *bebob = card->private_data;
 113
 114         if (bebob->card_index >= 0) {
 115                 mutex_lock(&devices_mutex);
 116                 clear_bit(bebob->card_index, devices_used);
 117                 mutex_unlock(&devices_mutex);
 118         }
 119
 120         mutex_destroy(&bebob->mutex);
 121 }
 122
 123 static int
 124 bebob_probe(struct fw_unit *unit,
 125             const struct ieee1394_device_id *entry)
 126 {
 127         struct snd_card *card;
 128         struct snd_bebob *bebob;
 129         unsigned int card_index;
 130         int err;
 131
 132         mutex_lock(&devices_mutex);
 133
 134         for (card_index = 0; card_index < SNDRV_CARDS; card_index++) {
 135                 if (!test_bit(card_index, devices_used) && enable[card_index])
 136                         break;
 137         }
 138         if (card_index >= SNDRV_CARDS) {
 139                 err = -ENOENT;
 140                 goto end;
 141         }
 142
 143         err = snd_card_new(&unit->device, index[card_index], id[card_index],
 144                            THIS_MODULE, sizeof(struct snd_bebob), &card);
 145         if (err < 0)
 146                 goto end;
 147         bebob = card->private_data;
 148         bebob->card_index = card_index;
 149         set_bit(card_index, devices_used);
 150         card->private_free = bebob_card_free;
 151
 152         bebob->card = card;
 153         bebob->unit = unit;
 154         mutex_init(&bebob->mutex);
 155         spin_lock_init(&bebob->lock);
 156
 157         err = name_device(bebob, entry->vendor_id);
 158         if (err < 0)
 159                 goto error;
 160
 161         err = snd_bebob_stream_discover(bebob);
 162         if (err < 0)
 163                 goto error;
 164
 165         snd_bebob_proc_init(bebob);
 166
 167         if ((bebob->midi_input_ports > 0) ||
 168             (bebob->midi_output_ports > 0)) {
 169                 err = snd_bebob_create_midi_devices(bebob);
 170                 if (err < 0)
 171                         goto error;
 172         }
 173
 174         err = snd_bebob_stream_init_duplex(bebob);
 175         if (err < 0)
 176                 goto error;
 177
 178         err = snd_card_register(card);
 179         if (err < 0) {
 180                 snd_bebob_stream_destroy_duplex(bebob);
 181                 goto error;
 182         }
 183
 184         dev_set_drvdata(&unit->device, bebob);
 185 end:
 186         mutex_unlock(&devices_mutex);
 187         return err;
 188 error:
 189         mutex_unlock(&devices_mutex);
 190         snd_card_free(card);
 191         return err;
 192 }
 193
 194 static void
 195 bebob_update(struct fw_unit *unit)
 196 {
 197         struct snd_bebob *bebob = dev_get_drvdata(&unit->device);
 198         fcp_bus_reset(bebob->unit);
 199         snd_bebob_stream_update_duplex(bebob);
 200 }
 201
 202 static void bebob_remove(struct fw_unit *unit)
 203 {
 204         struct snd_bebob *bebob = dev_get_drvdata(&unit->device);
 205         snd_bebob_stream_destroy_duplex(bebob);
 206         snd_card_disconnect(bebob->card);
 207         snd_card_free_when_closed(bebob->card);
 208 }
 209
 210 static const struct ieee1394_device_id bebob_id_table[] = {
 211         /* Edirol, FA-66 */
 212         SND_BEBOB_DEV_ENTRY(VEN_EDIROL, 0x00010049),
 213         /* Edirol, FA-101 */
 214         SND_BEBOB_DEV_ENTRY(VEN_EDIROL, 0x00010048),
 215         /* Presonus, FIREBOX */
 216         SND_BEBOB_DEV_ENTRY(VEN_PRESONUS, 0x00010000),
 217         /* PreSonus, FIREPOD/FP10 */
 218         SND_BEBOB_DEV_ENTRY(VEN_PRESONUS, 0x00010066),
 219         /* PreSonus, Inspire1394 */
 220         SND_BEBOB_DEV_ENTRY(VEN_PRESONUS, 0x00010001),
 221         /* BridgeCo, RDAudio1 */
 222         SND_BEBOB_DEV_ENTRY(VEN_BRIDGECO, 0x00010048),
 223         /* BridgeCo, Audio5 */
 224         SND_BEBOB_DEV_ENTRY(VEN_BRIDGECO, 0x00010049),
 225         /* Mackie, Onyx 1220/1620/1640 (Firewire I/O Card) */
 226         SND_BEBOB_DEV_ENTRY(VEN_MACKIE, 0x00010065),
 227         /* Mackie, d.2 (Firewire Option) */
 228         SND_BEBOB_DEV_ENTRY(VEN_MACKIE, 0x00010067),
 229         /* Stanton, ScratchAmp */
 230         SND_BEBOB_DEV_ENTRY(VEN_STANTON, 0x00000001),
 231         /* Tascam, IF-FW DM */
 232         SND_BEBOB_DEV_ENTRY(VEN_TASCAM, 0x00010067),
 233         /* Behringer, XENIX UFX 1204 */
 234         SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x00001204),
 235         /* Behringer, XENIX UFX 1604 */
 236         SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x00001604),
 237         /* Behringer, Digital Mixer X32 series (X-UF Card) */
 238         SND_BEBOB_DEV_ENTRY(VEN_BEHRINGER, 0x00000006),
 239         /* Apogee Electronics, Rosetta 200/400 (X-FireWire card) */
 240         /* Apogee Electronics, DA/AD/DD-16X (X-FireWire card) */
 241         SND_BEBOB_DEV_ENTRY(VEN_APOGEE, 0x00010048),
 242         /* Apogee Electronics, Ensemble */
 243         SND_BEBOB_DEV_ENTRY(VEN_APOGEE, 0x00001eee),
 244         /* ESI, Quatafire610 */
 245         SND_BEBOB_DEV_ENTRY(VEN_ESI, 0x00010064),
 246         /* AcousticReality, eARMasterOne */
 247         SND_BEBOB_DEV_ENTRY(VEN_ACOUSTIC, 0x00000002),
 248         /* CME, MatrixKFW */
 249         SND_BEBOB_DEV_ENTRY(VEN_CME, 0x00030000),
 250         /* Phonic, Helix Board 12 MkII */
 251         SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00050000),
 252         /* Phonic, Helix Board 18 MkII */
 253         SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00060000),
 254         /* Phonic, Helix Board 24 MkII */
 255         SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00070000),
 256         /* Phonic, Helix Board 12 Universal/18 Universal/24 Universal */
 257         SND_BEBOB_DEV_ENTRY(VEN_PHONIC, 0x00000000),
 258         /* Lynx, Aurora 8/16 (LT-FW) */
 259         SND_BEBOB_DEV_ENTRY(VEN_LYNX, 0x00000001),
 260         /* ICON, FireXon */
 261         SND_BEBOB_DEV_ENTRY(VEN_ICON, 0x00000001),
 262         /* PrismSound, Orpheus */
 263         SND_BEBOB_DEV_ENTRY(VEN_PRISMSOUND, 0x00010048),
 264         /* PrismSound, ADA-8XR */
 265         SND_BEBOB_DEV_ENTRY(VEN_PRISMSOUND, 0x0000ada8),
 266         /* IDs are unknown but able to be supported */
 267         /*  Apogee, Mini-ME Firewire */
 268         /*  Apogee, Mini-DAC Firewire */
 269         /*  Behringer, F-Control Audio 1616 */
 270         /*  Behringer, F-Control Audio 610 */
 271         /*  Cakawalk, Sonar Power Studio 66 */
 272         /*  CME, UF400e */
 273         /*  ESI, Quotafire XL */
 274         /*  Infrasonic, DewX */
 275         /*  Infrasonic, Windy6 */
 276         /*  Mackie, Digital X Bus x.200 */
 277         /*  Mackie, Digital X Bus x.400 */
 278         /*  Phonic, HB 12 */
 279         /*  Phonic, HB 24 */
 280         /*  Phonic, HB 18 */
 281         /*  Phonic, FireFly 202 */
 282         /*  Phonic, FireFly 302 */
 283         /*  Rolf Spuler, Firewire Guitar */
 284         {}
 285 };
 286 MODULE_DEVICE_TABLE(ieee1394, bebob_id_table);
 287
 288 static struct fw_driver bebob_driver = {
 289         .driver = {
 290                 .owner  = THIS_MODULE,
 291                 .name   = "snd-bebob",
 292                 .bus    = &fw_bus_type,
 293         },
 294         .probe    = bebob_probe,
 295         .update   = bebob_update,
 296         .remove   = bebob_remove,
 297         .id_table = bebob_id_table,
 298 };
 299
 300 static int __init
 301 snd_bebob_init(void)
 302 {
 303         return driver_register(&bebob_driver.driver);
 304 }
 305
 306 static void __exit
 307 snd_bebob_exit(void)
 308 {
 309         driver_unregister(&bebob_driver.driver);
 310         mutex_destroy(&devices_mutex);
 311 }
 312
 313 module_init(snd_bebob_init);
 314 module_exit(snd_bebob_exit);