sound/usb/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/moduleparam.h>
  23 #include <linux/device.h>
  24 #include <linux/interrupt.h>
  25 #include <linux/module.h>
  26 #include <linux/init.h>
  27 #include <linux/gfp.h>
  28 #include <linux/usb.h>
  29 #include <sound/initval.h>
  30 #include <sound/core.h>
  31 #include <sound/pcm.h>
  32
  33 #include "device.h"
  34 #include "audio.h"
  35 #include "midi.h"
  36 #include "control.h"
  37 #include "input.h"
  38
  39 MODULE_AUTHOR("Daniel Mack <daniel@caiaq.de>");
  40 MODULE_DESCRIPTION("caiaq USB audio");
  41 MODULE_LICENSE("GPL");
  42 MODULE_SUPPORTED_DEVICE("{{Native Instruments, RigKontrol2},"
  43                          "{Native Instruments, RigKontrol3},"
  44                          "{Native Instruments, Kore Controller},"
  45                          "{Native Instruments, Kore Controller 2},"
  46                          "{Native Instruments, Audio Kontrol 1},"
  47                          "{Native Instruments, Audio 2 DJ},"
  48                          "{Native Instruments, Audio 4 DJ},"
  49                          "{Native Instruments, Audio 8 DJ},"
  50                          "{Native Instruments, Traktor Audio 2},"
  51                          "{Native Instruments, Session I/O},"
  52                          "{Native Instruments, GuitarRig mobile},"
  53                          "{Native Instruments, Traktor Kontrol X1},"
  54                          "{Native Instruments, Traktor Kontrol S4},"
  55                          "{Native Instruments, Maschine Controller}}");
  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 bool 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         {
 132                 .match_flags =  USB_DEVICE_ID_MATCH_DEVICE,
 133                 .idVendor =     USB_VID_NATIVEINSTRUMENTS,
 134                 .idProduct =    USB_PID_AUDIO2DJ
 135         },
 136         {
 137                 .match_flags =  USB_DEVICE_ID_MATCH_DEVICE,
 138                 .idVendor =     USB_VID_NATIVEINSTRUMENTS,
 139                 .idProduct =    USB_PID_TRAKTORKONTROLX1
 140         },
 141         {
 142                 .match_flags =  USB_DEVICE_ID_MATCH_DEVICE,
 143                 .idVendor =     USB_VID_NATIVEINSTRUMENTS,
 144                 .idProduct =    USB_PID_TRAKTORKONTROLS4
 145         },
 146         {
 147                 .match_flags =  USB_DEVICE_ID_MATCH_DEVICE,
 148                 .idVendor =     USB_VID_NATIVEINSTRUMENTS,
 149                 .idProduct =    USB_PID_TRAKTORAUDIO2
 150         },
 151         {
 152                 .match_flags =  USB_DEVICE_ID_MATCH_DEVICE,
 153                 .idVendor =     USB_VID_NATIVEINSTRUMENTS,
 154                 .idProduct =    USB_PID_MASCHINECONTROLLER
 155         },
 156         { /* terminator */ }
 157 };
 158
 159 static void usb_ep1_command_reply_dispatch (struct urb* urb)
 160 {
 161         int ret;
 162         struct device *dev = &urb->dev->dev;
 163         struct snd_usb_caiaqdev *cdev = urb->context;
 164         unsigned char *buf = urb->transfer_buffer;
 165
 166         if (urb->status || !cdev) {
 167                 dev_warn(dev, "received EP1 urb->status = %i\n", urb->status);
 168                 return;
 169         }
 170
 171         switch(buf[0]) {
 172         case EP1_CMD_GET_DEVICE_INFO:
 173                 memcpy(&cdev->spec, buf+1, sizeof(struct caiaq_device_spec));
 174                 cdev->spec.fw_version = le16_to_cpu(cdev->spec.fw_version);
 175                 dev_dbg(dev, "device spec (firmware %d): audio: %d in, %d out, "
 176                         "MIDI: %d in, %d out, data alignment %d\n",
 177                         cdev->spec.fw_version,
 178                         cdev->spec.num_analog_audio_in,
 179                         cdev->spec.num_analog_audio_out,
 180                         cdev->spec.num_midi_in,
 181                         cdev->spec.num_midi_out,
 182                         cdev->spec.data_alignment);
 183
 184                 cdev->spec_received++;
 185                 wake_up(&cdev->ep1_wait_queue);
 186                 break;
 187         case EP1_CMD_AUDIO_PARAMS:
 188                 cdev->audio_parm_answer = buf[1];
 189                 wake_up(&cdev->ep1_wait_queue);
 190                 break;
 191         case EP1_CMD_MIDI_READ:
 192                 snd_usb_caiaq_midi_handle_input(cdev, buf[1], buf + 3, buf[2]);
 193                 break;
 194         case EP1_CMD_READ_IO:
 195                 if (cdev->chip.usb_id ==
 196                         USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AUDIO8DJ)) {
 197                         if (urb->actual_length > sizeof(cdev->control_state))
 198                                 urb->actual_length = sizeof(cdev->control_state);
 199                         memcpy(cdev->control_state, buf + 1, urb->actual_length);
 200                         wake_up(&cdev->ep1_wait_queue);
 201                         break;
 202                 }
 203 #ifdef CONFIG_SND_USB_CAIAQ_INPUT
 204         case EP1_CMD_READ_ERP:
 205         case EP1_CMD_READ_ANALOG:
 206                 snd_usb_caiaq_input_dispatch(cdev, buf, urb->actual_length);
 207 #endif
 208                 break;
 209         }
 210
 211         cdev->ep1_in_urb.actual_length = 0;
 212         ret = usb_submit_urb(&cdev->ep1_in_urb, GFP_ATOMIC);
 213         if (ret < 0)
 214                 dev_err(dev, "unable to submit urb. OOM!?\n");
 215 }
 216
 217 int snd_usb_caiaq_send_command(struct snd_usb_caiaqdev *cdev,
 218                                unsigned char command,
 219                                const unsigned char *buffer,
 220                                int len)
 221 {
 222         int actual_len;
 223         struct usb_device *usb_dev = cdev->chip.dev;
 224
 225         if (!usb_dev)
 226                 return -EIO;
 227
 228         if (len > EP1_BUFSIZE - 1)
 229                 len = EP1_BUFSIZE - 1;
 230
 231         if (buffer && len > 0)
 232                 memcpy(cdev->ep1_out_buf+1, buffer, len);
 233
 234         cdev->ep1_out_buf[0] = command;
 235         return usb_bulk_msg(usb_dev, usb_sndbulkpipe(usb_dev, 1),
 236                            cdev->ep1_out_buf, len+1, &actual_len, 200);
 237 }
 238
 239 int snd_usb_caiaq_set_audio_params (struct snd_usb_caiaqdev *cdev,
 240                                     int rate, int depth, int bpp)
 241 {
 242         int ret;
 243         char tmp[5];
 244         struct device *dev = caiaqdev_to_dev(cdev);
 245
 246         switch (rate) {
 247         case 44100:     tmp[0] = SAMPLERATE_44100;   break;
 248         case 48000:     tmp[0] = SAMPLERATE_48000;   break;
 249         case 88200:     tmp[0] = SAMPLERATE_88200;   break;
 250         case 96000:     tmp[0] = SAMPLERATE_96000;   break;
 251         case 192000:    tmp[0] = SAMPLERATE_192000;  break;
 252         default:        return -EINVAL;
 253         }
 254
 255         switch (depth) {
 256         case 16:        tmp[1] = DEPTH_16;   break;
 257         case 24:        tmp[1] = DEPTH_24;   break;
 258         default:        return -EINVAL;
 259         }
 260
 261         tmp[2] = bpp & 0xff;
 262         tmp[3] = bpp >> 8;
 263         tmp[4] = 1; /* packets per microframe */
 264
 265         dev_dbg(dev, "setting audio params: %d Hz, %d bits, %d bpp\n",
 266                 rate, depth, bpp);
 267
 268         cdev->audio_parm_answer = -1;
 269         ret = snd_usb_caiaq_send_command(cdev, EP1_CMD_AUDIO_PARAMS,
 270                                          tmp, sizeof(tmp));
 271
 272         if (ret)
 273                 return ret;
 274
 275         if (!wait_event_timeout(cdev->ep1_wait_queue,
 276             cdev->audio_parm_answer >= 0, HZ))
 277                 return -EPIPE;
 278
 279         if (cdev->audio_parm_answer != 1)
 280                 dev_dbg(dev, "unable to set the device's audio params\n");
 281         else
 282                 cdev->bpp = bpp;
 283
 284         return cdev->audio_parm_answer == 1 ? 0 : -EINVAL;
 285 }
 286
 287 int snd_usb_caiaq_set_auto_msg(struct snd_usb_caiaqdev *cdev,
 288                                int digital, int analog, int erp)
 289 {
 290         char tmp[3] = { digital, analog, erp };
 291         return snd_usb_caiaq_send_command(cdev, EP1_CMD_AUTO_MSG,
 292                                           tmp, sizeof(tmp));
 293 }
 294
 295 static void setup_card(struct snd_usb_caiaqdev *cdev)
 296 {
 297         int ret;
 298         char val[4];
 299         struct device *dev = caiaqdev_to_dev(cdev);
 300
 301         /* device-specific startup specials */
 302         switch (cdev->chip.usb_id) {
 303         case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_RIGKONTROL2):
 304                 /* RigKontrol2 - display centered dash ('-') */
 305                 val[0] = 0x00;
 306                 val[1] = 0x00;
 307                 val[2] = 0x01;
 308                 snd_usb_caiaq_send_command(cdev, EP1_CMD_WRITE_IO, val, 3);
 309                 break;
 310         case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_RIGKONTROL3):
 311                 /* RigKontrol2 - display two centered dashes ('--') */
 312                 val[0] = 0x00;
 313                 val[1] = 0x40;
 314                 val[2] = 0x40;
 315                 val[3] = 0x00;
 316                 snd_usb_caiaq_send_command(cdev, EP1_CMD_WRITE_IO, val, 4);
 317                 break;
 318         case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AK1):
 319                 /* Audio Kontrol 1 - make USB-LED stop blinking */
 320                 val[0] = 0x00;
 321                 snd_usb_caiaq_send_command(cdev, EP1_CMD_WRITE_IO, val, 1);
 322                 break;
 323         case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AUDIO8DJ):
 324                 /* Audio 8 DJ - trigger read of current settings */
 325                 cdev->control_state[0] = 0xff;
 326                 snd_usb_caiaq_set_auto_msg(cdev, 1, 0, 0);
 327                 snd_usb_caiaq_send_command(cdev, EP1_CMD_READ_IO, NULL, 0);
 328
 329                 if (!wait_event_timeout(cdev->ep1_wait_queue,
 330                                         cdev->control_state[0] != 0xff, HZ))
 331                         return;
 332
 333                 /* fix up some defaults */
 334                 if ((cdev->control_state[1] != 2) ||
 335                     (cdev->control_state[2] != 3) ||
 336                     (cdev->control_state[4] != 2)) {
 337                         cdev->control_state[1] = 2;
 338                         cdev->control_state[2] = 3;
 339                         cdev->control_state[4] = 2;
 340                         snd_usb_caiaq_send_command(cdev,
 341                                 EP1_CMD_WRITE_IO, cdev->control_state, 6);
 342                 }
 343
 344                 break;
 345         }
 346
 347         if (cdev->spec.num_analog_audio_out +
 348             cdev->spec.num_analog_audio_in +
 349             cdev->spec.num_digital_audio_out +
 350             cdev->spec.num_digital_audio_in > 0) {
 351                 ret = snd_usb_caiaq_audio_init(cdev);
 352                 if (ret < 0)
 353                         dev_err(dev, "Unable to set up audio system (ret=%d)\n", ret);
 354         }
 355
 356         if (cdev->spec.num_midi_in +
 357             cdev->spec.num_midi_out > 0) {
 358                 ret = snd_usb_caiaq_midi_init(cdev);
 359                 if (ret < 0)
 360                         dev_err(dev, "Unable to set up MIDI system (ret=%d)\n", ret);
 361         }
 362
 363 #ifdef CONFIG_SND_USB_CAIAQ_INPUT
 364         ret = snd_usb_caiaq_input_init(cdev);
 365         if (ret < 0)
 366                 dev_err(dev, "Unable to set up input system (ret=%d)\n", ret);
 367 #endif
 368
 369         /* finally, register the card and all its sub-instances */
 370         ret = snd_card_register(cdev->chip.card);
 371         if (ret < 0) {
 372                 dev_err(dev, "snd_card_register() returned %d\n", ret);
 373                 snd_card_free(cdev->chip.card);
 374         }
 375
 376         ret = snd_usb_caiaq_control_init(cdev);
 377         if (ret < 0)
 378                 dev_err(dev, "Unable to set up control system (ret=%d)\n", ret);
 379 }
 380
 381 static int create_card(struct usb_device *usb_dev,
 382                        struct usb_interface *intf,
 383                        struct snd_card **cardp)
 384 {
 385         int devnum;
 386         int err;
 387         struct snd_card *card;
 388         struct snd_usb_caiaqdev *cdev;
 389
 390         for (devnum = 0; devnum < SNDRV_CARDS; devnum++)
 391                 if (enable[devnum] && !snd_card_used[devnum])
 392                         break;
 393
 394         if (devnum >= SNDRV_CARDS)
 395                 return -ENODEV;
 396
 397         err = snd_card_create(index[devnum], id[devnum], THIS_MODULE,
 398                               sizeof(struct snd_usb_caiaqdev), &card);
 399         if (err < 0)
 400                 return err;
 401
 402         cdev = caiaqdev(card);
 403         cdev->chip.dev = usb_dev;
 404         cdev->chip.card = card;
 405         cdev->chip.usb_id = USB_ID(le16_to_cpu(usb_dev->descriptor.idVendor),
 406                                   le16_to_cpu(usb_dev->descriptor.idProduct));
 407         spin_lock_init(&cdev->spinlock);
 408         snd_card_set_dev(card, &intf->dev);
 409
 410         *cardp = card;
 411         return 0;
 412 }
 413
 414 static int init_card(struct snd_usb_caiaqdev *cdev)
 415 {
 416         char *c, usbpath[32];
 417         struct usb_device *usb_dev = cdev->chip.dev;
 418         struct snd_card *card = cdev->chip.card;
 419         struct device *dev = caiaqdev_to_dev(cdev);
 420         int err, len;
 421
 422         if (usb_set_interface(usb_dev, 0, 1) != 0) {
 423                 dev_err(dev, "can't set alt interface.\n");
 424                 return -EIO;
 425         }
 426
 427         usb_init_urb(&cdev->ep1_in_urb);
 428         usb_init_urb(&cdev->midi_out_urb);
 429
 430         usb_fill_bulk_urb(&cdev->ep1_in_urb, usb_dev,
 431                           usb_rcvbulkpipe(usb_dev, 0x1),
 432                           cdev->ep1_in_buf, EP1_BUFSIZE,
 433                           usb_ep1_command_reply_dispatch, cdev);
 434
 435         usb_fill_bulk_urb(&cdev->midi_out_urb, usb_dev,
 436                           usb_sndbulkpipe(usb_dev, 0x1),
 437                           cdev->midi_out_buf, EP1_BUFSIZE,
 438                           snd_usb_caiaq_midi_output_done, cdev);
 439
 440         init_waitqueue_head(&cdev->ep1_wait_queue);
 441         init_waitqueue_head(&cdev->prepare_wait_queue);
 442
 443         if (usb_submit_urb(&cdev->ep1_in_urb, GFP_KERNEL) != 0)
 444                 return -EIO;
 445
 446         err = snd_usb_caiaq_send_command(cdev, EP1_CMD_GET_DEVICE_INFO, NULL, 0);
 447         if (err)
 448                 return err;
 449
 450         if (!wait_event_timeout(cdev->ep1_wait_queue, cdev->spec_received, HZ))
 451                 return -ENODEV;
 452
 453         usb_string(usb_dev, usb_dev->descriptor.iManufacturer,
 454                    cdev->vendor_name, CAIAQ_USB_STR_LEN);
 455
 456         usb_string(usb_dev, usb_dev->descriptor.iProduct,
 457                    cdev->product_name, CAIAQ_USB_STR_LEN);
 458
 459         strlcpy(card->driver, MODNAME, sizeof(card->driver));
 460         strlcpy(card->shortname, cdev->product_name, sizeof(card->shortname));
 461         strlcpy(card->mixername, cdev->product_name, sizeof(card->mixername));
 462
 463         /* if the id was not passed as module option, fill it with a shortened
 464          * version of the product string which does not contain any
 465          * whitespaces */
 466
 467         if (*card->id == '\0') {
 468                 char id[sizeof(card->id)];
 469
 470                 memset(id, 0, sizeof(id));
 471
 472                 for (c = card->shortname, len = 0;
 473                         *c && len < sizeof(card->id); c++)
 474                         if (*c != ' ')
 475                                 id[len++] = *c;
 476
 477                 snd_card_set_id(card, id);
 478         }
 479
 480         usb_make_path(usb_dev, usbpath, sizeof(usbpath));
 481         snprintf(card->longname, sizeof(card->longname), "%s %s (%s)",
 482                        cdev->vendor_name, cdev->product_name, usbpath);
 483
 484         setup_card(cdev);
 485         return 0;
 486 }
 487
 488 static int snd_probe(struct usb_interface *intf,
 489                      const struct usb_device_id *id)
 490 {
 491         int ret;
 492         struct snd_card *card = NULL;
 493         struct usb_device *usb_dev = interface_to_usbdev(intf);
 494
 495         ret = create_card(usb_dev, intf, &card);
 496
 497         if (ret < 0)
 498                 return ret;
 499
 500         usb_set_intfdata(intf, card);
 501         ret = init_card(caiaqdev(card));
 502         if (ret < 0) {
 503                 dev_err(&usb_dev->dev, "unable to init card! (ret=%d)\n", ret);
 504                 snd_card_free(card);
 505                 return ret;
 506         }
 507
 508         return 0;
 509 }
 510
 511 static void snd_disconnect(struct usb_interface *intf)
 512 {
 513         struct snd_card *card = usb_get_intfdata(intf);
 514         struct device *dev = intf->usb_dev;
 515         struct snd_usb_caiaqdev *cdev;
 516
 517         if (!card)
 518                 return;
 519
 520         cdev = caiaqdev(card);
 521         dev_dbg(dev, "%s(%p)\n", __func__, intf);
 522
 523         snd_card_disconnect(card);
 524
 525 #ifdef CONFIG_SND_USB_CAIAQ_INPUT
 526         snd_usb_caiaq_input_free(cdev);
 527 #endif
 528         snd_usb_caiaq_audio_free(cdev);
 529
 530         usb_kill_urb(&cdev->ep1_in_urb);
 531         usb_kill_urb(&cdev->midi_out_urb);
 532
 533         snd_card_free(card);
 534         usb_reset_device(interface_to_usbdev(intf));
 535 }
 536
 537
 538 MODULE_DEVICE_TABLE(usb, snd_usb_id_table);
 539 static struct usb_driver snd_usb_driver = {
 540         .name           = MODNAME,
 541         .probe          = snd_probe,
 542         .disconnect     = snd_disconnect,
 543         .id_table       = snd_usb_id_table,
 544 };
 545
 546 module_usb_driver(snd_usb_driver);