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