sound/usb/caiaq/caiaq-device.c

   1 /*
   2  * caiaq.c: ALSA driver for caiaq/NativeInstruments devices
   3  *
   4  *   Copyright (c) 2007 Daniel Mack <daniel@caiaq.de>
   5  *                      Karsten Wiese <fzu@wemgehoertderstaat.de>
   6  *
   7  *   This program is free software; you can redistribute it and/or modify
   8  *   it under the terms of the GNU General Public License as published by
   9  *   the Free Software Foundation; either version 2 of the License, or
  10  *   (at your option) any later version.
  11  *
  12  *   This program is distributed in the hope that it will be useful,
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *   GNU General Public License for more details.
  16  *
  17  *   You should have received a copy of the GNU General Public License
  18  *   along with this program; if not, write to the Free Software
  19  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  20 */
  21
  22 #include <linux/init.h>
  23 #include <linux/module.h>
  24 #include <linux/moduleparam.h>
  25 #include <linux/interrupt.h>
  26 #include <linux/usb.h>
  27 #include <linux/input.h>
  28 #include <linux/spinlock.h>
  29 #include <sound/core.h>
  30 #include <sound/initval.h>
  31 #include <sound/pcm.h>
  32 #include <sound/rawmidi.h>
  33 #include <sound/control.h>
  34
  35 #include "caiaq-device.h"
  36 #include "caiaq-audio.h"
  37 #include "caiaq-midi.h"
  38 #include "caiaq-control.h"
  39
  40 #ifdef CONFIG_SND_USB_CAIAQ_INPUT
  41 #include "caiaq-input.h"
  42 #endif
  43
  44 MODULE_AUTHOR("Daniel Mack <daniel@caiaq.de>");
  45 MODULE_DESCRIPTION("caiaq USB audio, version 1.3.11");
  46 MODULE_LICENSE("GPL");
  47 MODULE_SUPPORTED_DEVICE("{{Native Instruments, RigKontrol2},"
  48                          "{Native Instruments, RigKontrol3},"
  49                          "{Native Instruments, Kore Controller},"
  50                          "{Native Instruments, Kore Controller 2},"
  51                          "{Native Instruments, Audio Kontrol 1},"
  52                          "{Native Instruments, Audio 4 DJ},"
  53                          "{Native Instruments, Audio 8 DJ},"
  54                          "{Native Instruments, Session I/O},"
  55                          "{Native Instruments, GuitarRig mobile}");
  56
  57 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-max */
  58 static char* id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* Id for this card */
  59 static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP; /* Enable this card */
  60 static int snd_card_used[SNDRV_CARDS];
  61
  62 module_param_array(index, int, NULL, 0444);
  63 MODULE_PARM_DESC(index, "Index value for the caiaq sound device");
  64 module_param_array(id, charp, NULL, 0444);
  65 MODULE_PARM_DESC(id, "ID string for the caiaq soundcard.");
  66 module_param_array(enable, bool, NULL, 0444);
  67 MODULE_PARM_DESC(enable, "Enable the caiaq soundcard.");
  68
  69 enum {
  70         SAMPLERATE_44100        = 0,
  71         SAMPLERATE_48000        = 1,
  72         SAMPLERATE_96000        = 2,
  73         SAMPLERATE_192000       = 3,
  74         SAMPLERATE_88200        = 4,
  75         SAMPLERATE_INVALID      = 0xff
  76 };
  77
  78 enum {
  79         DEPTH_NONE      = 0,
  80         DEPTH_16        = 1,
  81         DEPTH_24        = 2,
  82         DEPTH_32        = 3
  83 };
  84
  85 static struct usb_device_id snd_usb_id_table[] = {
  86         {
  87                 .match_flags =  USB_DEVICE_ID_MATCH_DEVICE,
  88                 .idVendor =     USB_VID_NATIVEINSTRUMENTS,
  89                 .idProduct =    USB_PID_RIGKONTROL2
  90         },
  91         {
  92                 .match_flags =  USB_DEVICE_ID_MATCH_DEVICE,
  93                 .idVendor =     USB_VID_NATIVEINSTRUMENTS,
  94                 .idProduct =    USB_PID_RIGKONTROL3
  95         },
  96         {
  97                 .match_flags =  USB_DEVICE_ID_MATCH_DEVICE,
  98                 .idVendor =     USB_VID_NATIVEINSTRUMENTS,
  99                 .idProduct =    USB_PID_KORECONTROLLER
 100         },
 101         {
 102                 .match_flags =  USB_DEVICE_ID_MATCH_DEVICE,
 103                 .idVendor =     USB_VID_NATIVEINSTRUMENTS,
 104                 .idProduct =    USB_PID_KORECONTROLLER2
 105         },
 106         {
 107                 .match_flags =  USB_DEVICE_ID_MATCH_DEVICE,
 108                 .idVendor =     USB_VID_NATIVEINSTRUMENTS,
 109                 .idProduct =    USB_PID_AK1
 110         },
 111         {
 112                 .match_flags =  USB_DEVICE_ID_MATCH_DEVICE,
 113                 .idVendor =     USB_VID_NATIVEINSTRUMENTS,
 114                 .idProduct =    USB_PID_AUDIO8DJ
 115         },
 116         {
 117                 .match_flags =  USB_DEVICE_ID_MATCH_DEVICE,
 118                 .idVendor =     USB_VID_NATIVEINSTRUMENTS,
 119                 .idProduct =    USB_PID_SESSIONIO
 120         },
 121         {
 122                 .match_flags =  USB_DEVICE_ID_MATCH_DEVICE,
 123                 .idVendor =     USB_VID_NATIVEINSTRUMENTS,
 124                 .idProduct =    USB_PID_GUITARRIGMOBILE
 125         },
 126         {
 127                 .match_flags =  USB_DEVICE_ID_MATCH_DEVICE,
 128                 .idVendor =     USB_VID_NATIVEINSTRUMENTS,
 129                 .idProduct =    USB_PID_AUDIO4DJ
 130         },
 131         { /* terminator */ }
 132 };
 133
 134 static void usb_ep1_command_reply_dispatch (struct urb* urb)
 135 {
 136         int ret;
 137         struct snd_usb_caiaqdev *dev = urb->context;
 138         unsigned char *buf = urb->transfer_buffer;
 139
 140         if (urb->status || !dev) {
 141                 log("received EP1 urb->status = %i\n", urb->status);
 142                 return;
 143         }
 144
 145         switch(buf[0]) {
 146         case EP1_CMD_GET_DEVICE_INFO:
 147                 memcpy(&dev->spec, buf+1, sizeof(struct caiaq_device_spec));
 148                 dev->spec.fw_version = le16_to_cpu(dev->spec.fw_version);
 149                 debug("device spec (firmware %d): audio: %d in, %d out, "
 150                         "MIDI: %d in, %d out, data alignment %d\n",
 151                         dev->spec.fw_version,
 152                         dev->spec.num_analog_audio_in,
 153                         dev->spec.num_analog_audio_out,
 154                         dev->spec.num_midi_in,
 155                         dev->spec.num_midi_out,
 156                         dev->spec.data_alignment);
 157
 158                 dev->spec_received++;
 159                 wake_up(&dev->ep1_wait_queue);
 160                 break;
 161         case EP1_CMD_AUDIO_PARAMS:
 162                 dev->audio_parm_answer = buf[1];
 163                 wake_up(&dev->ep1_wait_queue);
 164                 break;
 165         case EP1_CMD_MIDI_READ:
 166                 snd_usb_caiaq_midi_handle_input(dev, buf[1], buf + 3, buf[2]);
 167                 break;
 168         case EP1_CMD_READ_IO:
 169                 if (dev->chip.usb_id ==
 170                         USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AUDIO8DJ)) {
 171                         if (urb->actual_length > sizeof(dev->control_state))
 172                                 urb->actual_length = sizeof(dev->control_state);
 173                         memcpy(dev->control_state, buf + 1, urb->actual_length);
 174                         wake_up(&dev->ep1_wait_queue);
 175                         break;
 176                 }
 177 #ifdef CONFIG_SND_USB_CAIAQ_INPUT
 178         case EP1_CMD_READ_ERP:
 179         case EP1_CMD_READ_ANALOG:
 180                 snd_usb_caiaq_input_dispatch(dev, buf, urb->actual_length);
 181 #endif
 182                 break;
 183         }
 184
 185         dev->ep1_in_urb.actual_length = 0;
 186         ret = usb_submit_urb(&dev->ep1_in_urb, GFP_ATOMIC);
 187         if (ret < 0)
 188                 log("unable to submit urb. OOM!?\n");
 189 }
 190
 191 int snd_usb_caiaq_send_command(struct snd_usb_caiaqdev *dev,
 192                                unsigned char command,
 193                                const unsigned char *buffer,
 194                                int len)
 195 {
 196         int actual_len;
 197         struct usb_device *usb_dev = dev->chip.dev;
 198
 199         if (!usb_dev)
 200                 return -EIO;
 201
 202         if (len > EP1_BUFSIZE - 1)
 203                 len = EP1_BUFSIZE - 1;
 204
 205         if (buffer && len > 0)
 206                 memcpy(dev->ep1_out_buf+1, buffer, len);
 207
 208         dev->ep1_out_buf[0] = command;
 209         return usb_bulk_msg(usb_dev, usb_sndbulkpipe(usb_dev, 1),
 210                            dev->ep1_out_buf, len+1, &actual_len, 200);
 211 }
 212
 213 int snd_usb_caiaq_set_audio_params (struct snd_usb_caiaqdev *dev,
 214                                     int rate, int depth, int bpp)
 215 {
 216         int ret;
 217         char tmp[5];
 218
 219         switch (rate) {
 220         case 44100:     tmp[0] = SAMPLERATE_44100;   break;
 221         case 48000:     tmp[0] = SAMPLERATE_48000;   break;
 222         case 88200:     tmp[0] = SAMPLERATE_88200;   break;
 223         case 96000:     tmp[0] = SAMPLERATE_96000;   break;
 224         case 192000:    tmp[0] = SAMPLERATE_192000;  break;
 225         default:        return -EINVAL;
 226         }
 227
 228         switch (depth) {
 229         case 16:        tmp[1] = DEPTH_16;   break;
 230         case 24:        tmp[1] = DEPTH_24;   break;
 231         default:        return -EINVAL;
 232         }
 233
 234         tmp[2] = bpp & 0xff;
 235         tmp[3] = bpp >> 8;
 236         tmp[4] = 1; /* packets per microframe */
 237
 238         debug("setting audio params: %d Hz, %d bits, %d bpp\n",
 239                 rate, depth, bpp);
 240
 241         dev->audio_parm_answer = -1;
 242         ret = snd_usb_caiaq_send_command(dev, EP1_CMD_AUDIO_PARAMS,
 243                                          tmp, sizeof(tmp));
 244
 245         if (ret)
 246                 return ret;
 247
 248         if (!wait_event_timeout(dev->ep1_wait_queue,
 249             dev->audio_parm_answer >= 0, HZ))
 250                 return -EPIPE;
 251
 252         if (dev->audio_parm_answer != 1)
 253                 debug("unable to set the device's audio params\n");
 254
 255         return dev->audio_parm_answer == 1 ? 0 : -EINVAL;
 256 }
 257
 258 int snd_usb_caiaq_set_auto_msg (struct snd_usb_caiaqdev *dev,
 259                                 int digital, int analog, int erp)
 260 {
 261         char tmp[3] = { digital, analog, erp };
 262         return snd_usb_caiaq_send_command(dev, EP1_CMD_AUTO_MSG,
 263                                           tmp, sizeof(tmp));
 264 }
 265
 266 static void __devinit setup_card(struct snd_usb_caiaqdev *dev)
 267 {
 268         int ret;
 269         char val[4];
 270
 271         /* device-specific startup specials */
 272         switch (dev->chip.usb_id) {
 273         case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_RIGKONTROL2):
 274                 /* RigKontrol2 - display centered dash ('-') */
 275                 val[0] = 0x00;
 276                 val[1] = 0x00;
 277                 val[2] = 0x01;
 278                 snd_usb_caiaq_send_command(dev, EP1_CMD_WRITE_IO, val, 3);
 279                 break;
 280         case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_RIGKONTROL3):
 281                 /* RigKontrol2 - display two centered dashes ('--') */
 282                 val[0] = 0x00;
 283                 val[1] = 0x40;
 284                 val[2] = 0x40;
 285                 val[3] = 0x00;
 286                 snd_usb_caiaq_send_command(dev, EP1_CMD_WRITE_IO, val, 4);
 287                 break;
 288         case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AK1):
 289                 /* Audio Kontrol 1 - make USB-LED stop blinking */
 290                 val[0] = 0x00;
 291                 snd_usb_caiaq_send_command(dev, EP1_CMD_WRITE_IO, val, 1);
 292                 break;
 293         case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AUDIO8DJ):
 294                 /* Audio 8 DJ - trigger read of current settings */
 295                 dev->control_state[0] = 0xff;
 296                 snd_usb_caiaq_set_auto_msg(dev, 1, 0, 0);
 297                 snd_usb_caiaq_send_command(dev, EP1_CMD_READ_IO, NULL, 0);
 298
 299                 if (!wait_event_timeout(dev->ep1_wait_queue,
 300                                         dev->control_state[0] != 0xff, HZ))
 301                         return;
 302
 303                 /* fix up some defaults */
 304                 if ((dev->control_state[1] != 2) ||
 305                     (dev->control_state[2] != 3) ||
 306                     (dev->control_state[4] != 2)) {
 307                         dev->control_state[1] = 2;
 308                         dev->control_state[2] = 3;
 309                         dev->control_state[4] = 2;
 310                         snd_usb_caiaq_send_command(dev,
 311                                 EP1_CMD_WRITE_IO, dev->control_state, 6);
 312                 }
 313
 314                 break;
 315         case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AUDIO4DJ):
 316                 /* Audio 4 DJ - default input mode to phono */
 317                 dev->control_state[0] = 2;
 318                 snd_usb_caiaq_send_command(dev, EP1_CMD_WRITE_IO,
 319                         dev->control_state, 1);
 320                 break;
 321         }
 322
 323         if (dev->spec.num_analog_audio_out +
 324             dev->spec.num_analog_audio_in +
 325             dev->spec.num_digital_audio_out +
 326             dev->spec.num_digital_audio_in > 0) {
 327                 ret = snd_usb_caiaq_audio_init(dev);
 328                 if (ret < 0)
 329                         log("Unable to set up audio system (ret=%d)\n", ret);
 330         }
 331
 332         if (dev->spec.num_midi_in +
 333             dev->spec.num_midi_out > 0) {
 334                 ret = snd_usb_caiaq_midi_init(dev);
 335                 if (ret < 0)
 336                         log("Unable to set up MIDI system (ret=%d)\n", ret);
 337         }
 338
 339 #ifdef CONFIG_SND_USB_CAIAQ_INPUT
 340         ret = snd_usb_caiaq_input_init(dev);
 341         if (ret < 0)
 342                 log("Unable to set up input system (ret=%d)\n", ret);
 343 #endif
 344
 345         /* finally, register the card and all its sub-instances */
 346         ret = snd_card_register(dev->chip.card);
 347         if (ret < 0) {
 348                 log("snd_card_register() returned %d\n", ret);
 349                 snd_card_free(dev->chip.card);
 350         }
 351
 352         ret = snd_usb_caiaq_control_init(dev);
 353         if (ret < 0)
 354                 log("Unable to set up control system (ret=%d)\n", ret);
 355 }
 356
 357 static struct snd_card* create_card(struct usb_device* usb_dev)
 358 {
 359         int devnum;
 360         struct snd_card *card;
 361         struct snd_usb_caiaqdev *dev;
 362
 363         for (devnum = 0; devnum < SNDRV_CARDS; devnum++)
 364                 if (enable[devnum] && !snd_card_used[devnum])
 365                         break;
 366
 367         if (devnum >= SNDRV_CARDS)
 368                 return NULL;
 369
 370         card = snd_card_new(index[devnum], id[devnum], THIS_MODULE,
 371                                         sizeof(struct snd_usb_caiaqdev));
 372         if (!card)
 373                 return NULL;
 374
 375         dev = caiaqdev(card);
 376         dev->chip.dev = usb_dev;
 377         dev->chip.card = card;
 378         dev->chip.usb_id = USB_ID(le16_to_cpu(usb_dev->descriptor.idVendor),
 379                                   le16_to_cpu(usb_dev->descriptor.idProduct));
 380         spin_lock_init(&dev->spinlock);
 381         snd_card_set_dev(card, &usb_dev->dev);
 382
 383         return card;
 384 }
 385
 386 static int __devinit init_card(struct snd_usb_caiaqdev *dev)
 387 {
 388         char *c;
 389         struct usb_device *usb_dev = dev->chip.dev;
 390         struct snd_card *card = dev->chip.card;
 391         int err, len;
 392
 393         if (usb_set_interface(usb_dev, 0, 1) != 0) {
 394                 log("can't set alt interface.\n");
 395                 return -EIO;
 396         }
 397
 398         usb_init_urb(&dev->ep1_in_urb);
 399         usb_init_urb(&dev->midi_out_urb);
 400
 401         usb_fill_bulk_urb(&dev->ep1_in_urb, usb_dev,
 402                           usb_rcvbulkpipe(usb_dev, 0x1),
 403                           dev->ep1_in_buf, EP1_BUFSIZE,
 404                           usb_ep1_command_reply_dispatch, dev);
 405
 406         usb_fill_bulk_urb(&dev->midi_out_urb, usb_dev,
 407                           usb_sndbulkpipe(usb_dev, 0x1),
 408                           dev->midi_out_buf, EP1_BUFSIZE,
 409                           snd_usb_caiaq_midi_output_done, dev);
 410
 411         init_waitqueue_head(&dev->ep1_wait_queue);
 412         init_waitqueue_head(&dev->prepare_wait_queue);
 413
 414         if (usb_submit_urb(&dev->ep1_in_urb, GFP_KERNEL) != 0)
 415                 return -EIO;
 416
 417         err = snd_usb_caiaq_send_command(dev, EP1_CMD_GET_DEVICE_INFO, NULL, 0);
 418         if (err)
 419                 return err;
 420
 421         if (!wait_event_timeout(dev->ep1_wait_queue, dev->spec_received, HZ))
 422                 return -ENODEV;
 423
 424         usb_string(usb_dev, usb_dev->descriptor.iManufacturer,
 425                    dev->vendor_name, CAIAQ_USB_STR_LEN);
 426
 427         usb_string(usb_dev, usb_dev->descriptor.iProduct,
 428                    dev->product_name, CAIAQ_USB_STR_LEN);
 429
 430         usb_string(usb_dev, usb_dev->descriptor.iSerialNumber,
 431                    dev->serial, CAIAQ_USB_STR_LEN);
 432
 433         /* terminate serial string at first white space occurence */
 434         c = strchr(dev->serial, ' ');
 435         if (c)
 436                 *c = '\0';
 437
 438         strcpy(card->driver, MODNAME);
 439         strcpy(card->shortname, dev->product_name);
 440
 441         len = snprintf(card->longname, sizeof(card->longname),
 442                        "%s %s (serial %s, ",
 443                        dev->vendor_name, dev->product_name, dev->serial);
 444
 445         if (len < sizeof(card->longname) - 2)
 446                 len += usb_make_path(usb_dev, card->longname + len,
 447                                      sizeof(card->longname) - len);
 448
 449         card->longname[len++] = ')';
 450         card->longname[len] = '\0';
 451         setup_card(dev);
 452         return 0;
 453 }
 454
 455 static int __devinit snd_probe(struct usb_interface *intf,
 456                      const struct usb_device_id *id)
 457 {
 458         int ret;
 459         struct snd_card *card;
 460         struct usb_device *device = interface_to_usbdev(intf);
 461
 462         card = create_card(device);
 463
 464         if (!card)
 465                 return -ENOMEM;
 466
 467         usb_set_intfdata(intf, card);
 468         ret = init_card(caiaqdev(card));
 469         if (ret < 0) {
 470                 log("unable to init card! (ret=%d)\n", ret);
 471                 snd_card_free(card);
 472                 return ret;
 473         }
 474
 475         return 0;
 476 }
 477
 478 static void snd_disconnect(struct usb_interface *intf)
 479 {
 480         struct snd_usb_caiaqdev *dev;
 481         struct snd_card *card = usb_get_intfdata(intf);
 482
 483         debug("%s(%p)\n", __func__, intf);
 484
 485         if (!card)
 486                 return;
 487
 488         dev = caiaqdev(card);
 489         snd_card_disconnect(card);
 490
 491 #ifdef CONFIG_SND_USB_CAIAQ_INPUT
 492         snd_usb_caiaq_input_free(dev);
 493 #endif
 494         snd_usb_caiaq_audio_free(dev);
 495
 496         usb_kill_urb(&dev->ep1_in_urb);
 497         usb_kill_urb(&dev->midi_out_urb);
 498
 499         snd_card_free(card);
 500         usb_reset_device(interface_to_usbdev(intf));
 501 }
 502
 503
 504 MODULE_DEVICE_TABLE(usb, snd_usb_id_table);
 505 static struct usb_driver snd_usb_driver = {
 506         .name           = MODNAME,
 507         .probe          = snd_probe,
 508         .disconnect     = snd_disconnect,
 509         .id_table       = snd_usb_id_table,
 510 };
 511
 512 static int __init snd_module_init(void)
 513 {
 514         return usb_register(&snd_usb_driver);
 515 }
 516
 517 static void __exit snd_module_exit(void)
 518 {
 519         usb_deregister(&snd_usb_driver);
 520 }
 521
 522 module_init(snd_module_init)
 523 module_exit(snd_module_exit)
 524