drivers/staging/line6/toneport.c

   1 /*
   2  * Line6 Linux USB driver - 0.9.1beta
   3  *
   4  * Copyright (C) 2004-2010 Markus Grabner (grabner@icg.tugraz.at)
   5  *                         Emil Myhrman (emil.myhrman@gmail.com)
   6  *
   7  *      This program is free software; you can redistribute it and/or
   8  *      modify it under the terms of the GNU General Public License as
   9  *      published by the Free Software Foundation, version 2.
  10  *
  11  */
  12
  13 #include <linux/wait.h>
  14 #include <sound/control.h>
  15
  16 #include "audio.h"
  17 #include "capture.h"
  18 #include "driver.h"
  19 #include "playback.h"
  20 #include "toneport.h"
  21
  22 static int toneport_send_cmd(struct usb_device *usbdev, int cmd1, int cmd2);
  23
  24 #define TONEPORT_PCM_DELAY 1
  25
  26 static struct snd_ratden toneport_ratden = {
  27         .num_min = 44100,
  28         .num_max = 44100,
  29         .num_step = 1,
  30         .den = 1
  31 };
  32
  33 static struct line6_pcm_properties toneport_pcm_properties = {
  34         .snd_line6_playback_hw = {
  35                                   .info = (SNDRV_PCM_INFO_MMAP |
  36                                            SNDRV_PCM_INFO_INTERLEAVED |
  37                                            SNDRV_PCM_INFO_BLOCK_TRANSFER |
  38                                            SNDRV_PCM_INFO_MMAP_VALID |
  39                                            SNDRV_PCM_INFO_PAUSE |
  40 #ifdef CONFIG_PM
  41                                            SNDRV_PCM_INFO_RESUME |
  42 #endif
  43                                            SNDRV_PCM_INFO_SYNC_START),
  44                                   .formats = SNDRV_PCM_FMTBIT_S16_LE,
  45                                   .rates = SNDRV_PCM_RATE_KNOT,
  46                                   .rate_min = 44100,
  47                                   .rate_max = 44100,
  48                                   .channels_min = 2,
  49                                   .channels_max = 2,
  50                                   .buffer_bytes_max = 60000,
  51                                   .period_bytes_min = 64,
  52                                   .period_bytes_max = 8192,
  53                                   .periods_min = 1,
  54                                   .periods_max = 1024},
  55         .snd_line6_capture_hw = {
  56                                  .info = (SNDRV_PCM_INFO_MMAP |
  57                                           SNDRV_PCM_INFO_INTERLEAVED |
  58                                           SNDRV_PCM_INFO_BLOCK_TRANSFER |
  59                                           SNDRV_PCM_INFO_MMAP_VALID |
  60 #ifdef CONFIG_PM
  61                                           SNDRV_PCM_INFO_RESUME |
  62 #endif
  63                                           SNDRV_PCM_INFO_SYNC_START),
  64                                  .formats = SNDRV_PCM_FMTBIT_S16_LE,
  65                                  .rates = SNDRV_PCM_RATE_KNOT,
  66                                  .rate_min = 44100,
  67                                  .rate_max = 44100,
  68                                  .channels_min = 2,
  69                                  .channels_max = 2,
  70                                  .buffer_bytes_max = 60000,
  71                                  .period_bytes_min = 64,
  72                                  .period_bytes_max = 8192,
  73                                  .periods_min = 1,
  74                                  .periods_max = 1024},
  75         .snd_line6_rates = {
  76                             .nrats = 1,
  77                             .rats = &toneport_ratden},
  78         .bytes_per_frame = 4
  79 };
  80
  81 /*
  82         For the led on Guitarport.
  83         Brightness goes from 0x00 to 0x26. Set a value above this to have led
  84         blink.
  85         (void cmd_0x02(byte red, byte green)
  86 */
  87 static int led_red = 0x00;
  88 static int led_green = 0x26;
  89
  90 struct ToneportSourceInfo {
  91         const char *name;
  92         int code;
  93 };
  94
  95 static const struct ToneportSourceInfo toneport_source_info[] = {
  96         {"Microphone", 0x0a01},
  97         {"Line", 0x0801},
  98         {"Instrument", 0x0b01},
  99         {"Inst & Mic", 0x0901}
 100 };
 101
 102 static bool toneport_has_led(short product)
 103 {
 104         return
 105             (product == LINE6_DEVID_GUITARPORT) ||
 106             (product == LINE6_DEVID_TONEPORT_GX);
 107         /* add your device here if you are missing support for the LEDs */
 108 }
 109
 110 static void toneport_update_led(struct device *dev)
 111 {
 112         struct usb_interface *interface = to_usb_interface(dev);
 113         struct usb_line6_toneport *tp = usb_get_intfdata(interface);
 114         struct usb_line6 *line6;
 115
 116         if (!tp)
 117                 return;
 118
 119         line6 = &tp->line6;
 120         if (line6)
 121                 toneport_send_cmd(line6->usbdev, (led_red << 8) | 0x0002,
 122                                   led_green);
 123 }
 124
 125 static ssize_t toneport_set_led_red(struct device *dev,
 126                                     struct device_attribute *attr,
 127                                     const char *buf, size_t count)
 128 {
 129         int retval;
 130
 131         retval = kstrtoint(buf, 10, &led_red);
 132         if (retval)
 133                 return retval;
 134
 135         toneport_update_led(dev);
 136         return count;
 137 }
 138
 139 static ssize_t toneport_set_led_green(struct device *dev,
 140                                       struct device_attribute *attr,
 141                                       const char *buf, size_t count)
 142 {
 143         int retval;
 144
 145         retval = kstrtoint(buf, 10, &led_green);
 146         if (retval)
 147                 return retval;
 148
 149         toneport_update_led(dev);
 150         return count;
 151 }
 152
 153 static DEVICE_ATTR(led_red, S_IWUSR | S_IRUGO, line6_nop_read,
 154                    toneport_set_led_red);
 155 static DEVICE_ATTR(led_green, S_IWUSR | S_IRUGO, line6_nop_read,
 156                    toneport_set_led_green);
 157
 158 static int toneport_send_cmd(struct usb_device *usbdev, int cmd1, int cmd2)
 159 {
 160         int ret;
 161
 162         ret = usb_control_msg(usbdev, usb_sndctrlpipe(usbdev, 0), 0x67,
 163                               USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,
 164                               cmd1, cmd2, NULL, 0, LINE6_TIMEOUT * HZ);
 165
 166         if (ret < 0) {
 167                 dev_err(&usbdev->dev, "send failed (error %d)\n", ret);
 168                 return ret;
 169         }
 170
 171         return 0;
 172 }
 173
 174 /* monitor info callback */
 175 static int snd_toneport_monitor_info(struct snd_kcontrol *kcontrol,
 176                                      struct snd_ctl_elem_info *uinfo)
 177 {
 178         uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
 179         uinfo->count = 1;
 180         uinfo->value.integer.min = 0;
 181         uinfo->value.integer.max = 256;
 182         return 0;
 183 }
 184
 185 /* monitor get callback */
 186 static int snd_toneport_monitor_get(struct snd_kcontrol *kcontrol,
 187                                     struct snd_ctl_elem_value *ucontrol)
 188 {
 189         struct snd_line6_pcm *line6pcm = snd_kcontrol_chip(kcontrol);
 190         ucontrol->value.integer.value[0] = line6pcm->volume_monitor;
 191         return 0;
 192 }
 193
 194 /* monitor put callback */
 195 static int snd_toneport_monitor_put(struct snd_kcontrol *kcontrol,
 196                                     struct snd_ctl_elem_value *ucontrol)
 197 {
 198         struct snd_line6_pcm *line6pcm = snd_kcontrol_chip(kcontrol);
 199
 200         if (ucontrol->value.integer.value[0] == line6pcm->volume_monitor)
 201                 return 0;
 202
 203         line6pcm->volume_monitor = ucontrol->value.integer.value[0];
 204
 205         if (line6pcm->volume_monitor > 0)
 206                 line6_pcm_acquire(line6pcm, LINE6_BITS_PCM_MONITOR);
 207         else
 208                 line6_pcm_release(line6pcm, LINE6_BITS_PCM_MONITOR);
 209
 210         return 1;
 211 }
 212
 213 /* source info callback */
 214 static int snd_toneport_source_info(struct snd_kcontrol *kcontrol,
 215                                     struct snd_ctl_elem_info *uinfo)
 216 {
 217         const int size = ARRAY_SIZE(toneport_source_info);
 218         uinfo->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
 219         uinfo->count = 1;
 220         uinfo->value.enumerated.items = size;
 221
 222         if (uinfo->value.enumerated.item >= size)
 223                 uinfo->value.enumerated.item = size - 1;
 224
 225         strcpy(uinfo->value.enumerated.name,
 226                toneport_source_info[uinfo->value.enumerated.item].name);
 227
 228         return 0;
 229 }
 230
 231 /* source get callback */
 232 static int snd_toneport_source_get(struct snd_kcontrol *kcontrol,
 233                                    struct snd_ctl_elem_value *ucontrol)
 234 {
 235         struct snd_line6_pcm *line6pcm = snd_kcontrol_chip(kcontrol);
 236         struct usb_line6_toneport *toneport =
 237             (struct usb_line6_toneport *)line6pcm->line6;
 238         ucontrol->value.enumerated.item[0] = toneport->source;
 239         return 0;
 240 }
 241
 242 /* source put callback */
 243 static int snd_toneport_source_put(struct snd_kcontrol *kcontrol,
 244                                    struct snd_ctl_elem_value *ucontrol)
 245 {
 246         struct snd_line6_pcm *line6pcm = snd_kcontrol_chip(kcontrol);
 247         struct usb_line6_toneport *toneport =
 248             (struct usb_line6_toneport *)line6pcm->line6;
 249
 250         if (ucontrol->value.enumerated.item[0] == toneport->source)
 251                 return 0;
 252
 253         toneport->source = ucontrol->value.enumerated.item[0];
 254         toneport_send_cmd(toneport->line6.usbdev,
 255                           toneport_source_info[toneport->source].code, 0x0000);
 256         return 1;
 257 }
 258
 259 static void toneport_start_pcm(unsigned long arg)
 260 {
 261         struct usb_line6_toneport *toneport = (struct usb_line6_toneport *)arg;
 262         struct usb_line6 *line6 = &toneport->line6;
 263         line6_pcm_acquire(line6->line6pcm, LINE6_BITS_PCM_MONITOR);
 264 }
 265
 266 /* control definition */
 267 static struct snd_kcontrol_new toneport_control_monitor = {
 268         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
 269         .name = "Monitor Playback Volume",
 270         .index = 0,
 271         .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
 272         .info = snd_toneport_monitor_info,
 273         .get = snd_toneport_monitor_get,
 274         .put = snd_toneport_monitor_put
 275 };
 276
 277 /* source selector definition */
 278 static struct snd_kcontrol_new toneport_control_source = {
 279         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
 280         .name = "PCM Capture Source",
 281         .index = 0,
 282         .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
 283         .info = snd_toneport_source_info,
 284         .get = snd_toneport_source_get,
 285         .put = snd_toneport_source_put
 286 };
 287
 288 /*
 289         Toneport destructor.
 290 */
 291 static void toneport_destruct(struct usb_interface *interface)
 292 {
 293         struct usb_line6_toneport *toneport = usb_get_intfdata(interface);
 294
 295         if (toneport == NULL)
 296                 return;
 297         line6_cleanup_audio(&toneport->line6);
 298 }
 299
 300 /*
 301         Setup Toneport device.
 302 */
 303 static void toneport_setup(struct usb_line6_toneport *toneport)
 304 {
 305         int ticks;
 306         struct usb_line6 *line6 = &toneport->line6;
 307         struct usb_device *usbdev = line6->usbdev;
 308
 309         /* sync time on device with host: */
 310         ticks = (int)get_seconds();
 311         line6_write_data(line6, 0x80c6, &ticks, 4);
 312
 313         /* enable device: */
 314         toneport_send_cmd(usbdev, 0x0301, 0x0000);
 315
 316         /* initialize source select: */
 317         switch (usbdev->descriptor.idProduct) {
 318         case LINE6_DEVID_TONEPORT_UX1:
 319         case LINE6_DEVID_TONEPORT_UX2:
 320         case LINE6_DEVID_PODSTUDIO_UX1:
 321         case LINE6_DEVID_PODSTUDIO_UX2:
 322                 toneport_send_cmd(usbdev,
 323                                   toneport_source_info[toneport->source].code,
 324                                   0x0000);
 325         }
 326
 327         if (toneport_has_led(usbdev->descriptor.idProduct))
 328                 toneport_update_led(&usbdev->dev);
 329 }
 330
 331 /*
 332          Try to init Toneport device.
 333 */
 334 static int toneport_try_init(struct usb_interface *interface,
 335                              struct usb_line6_toneport *toneport)
 336 {
 337         int err;
 338         struct usb_line6 *line6 = &toneport->line6;
 339         struct usb_device *usbdev = line6->usbdev;
 340
 341         if ((interface == NULL) || (toneport == NULL))
 342                 return -ENODEV;
 343
 344         /* initialize audio system: */
 345         err = line6_init_audio(line6);
 346         if (err < 0)
 347                 return err;
 348
 349         /* initialize PCM subsystem: */
 350         err = line6_init_pcm(line6, &toneport_pcm_properties);
 351         if (err < 0)
 352                 return err;
 353
 354         /* register monitor control: */
 355         err = snd_ctl_add(line6->card,
 356                           snd_ctl_new1(&toneport_control_monitor,
 357                                        line6->line6pcm));
 358         if (err < 0)
 359                 return err;
 360
 361         /* register source select control: */
 362         switch (usbdev->descriptor.idProduct) {
 363         case LINE6_DEVID_TONEPORT_UX1:
 364         case LINE6_DEVID_TONEPORT_UX2:
 365         case LINE6_DEVID_PODSTUDIO_UX1:
 366         case LINE6_DEVID_PODSTUDIO_UX2:
 367                 err =
 368                     snd_ctl_add(line6->card,
 369                                 snd_ctl_new1(&toneport_control_source,
 370                                              line6->line6pcm));
 371                 if (err < 0)
 372                         return err;
 373         }
 374
 375         /* register audio system: */
 376         err = line6_register_audio(line6);
 377         if (err < 0)
 378                 return err;
 379
 380         line6_read_serial_number(line6, &toneport->serial_number);
 381         line6_read_data(line6, 0x80c2, &toneport->firmware_version, 1);
 382
 383         if (toneport_has_led(usbdev->descriptor.idProduct)) {
 384                 CHECK_RETURN(device_create_file
 385                              (&interface->dev, &dev_attr_led_red));
 386                 CHECK_RETURN(device_create_file
 387                              (&interface->dev, &dev_attr_led_green));
 388         }
 389
 390         toneport_setup(toneport);
 391
 392         init_timer(&toneport->timer);
 393         toneport->timer.expires = jiffies + TONEPORT_PCM_DELAY * HZ;
 394         toneport->timer.function = toneport_start_pcm;
 395         toneport->timer.data = (unsigned long)toneport;
 396         add_timer(&toneport->timer);
 397
 398         return 0;
 399 }
 400
 401 /*
 402          Init Toneport device (and clean up in case of failure).
 403 */
 404 int line6_toneport_init(struct usb_interface *interface,
 405                         struct usb_line6_toneport *toneport)
 406 {
 407         int err = toneport_try_init(interface, toneport);
 408
 409         if (err < 0)
 410                 toneport_destruct(interface);
 411
 412         return err;
 413 }
 414
 415 /*
 416         Resume Toneport device after reset.
 417 */
 418 void line6_toneport_reset_resume(struct usb_line6_toneport *toneport)
 419 {
 420         toneport_setup(toneport);
 421 }
 422
 423 /*
 424         Toneport device disconnected.
 425 */
 426 void line6_toneport_disconnect(struct usb_interface *interface)
 427 {
 428         struct usb_line6_toneport *toneport;
 429
 430         if (interface == NULL)
 431                 return;
 432
 433         toneport = usb_get_intfdata(interface);
 434         del_timer_sync(&toneport->timer);
 435
 436         if (toneport_has_led(toneport->line6.usbdev->descriptor.idProduct)) {
 437                 device_remove_file(&interface->dev, &dev_attr_led_red);
 438                 device_remove_file(&interface->dev, &dev_attr_led_green);
 439         }
 440
 441         if (toneport != NULL) {
 442                 struct snd_line6_pcm *line6pcm = toneport->line6.line6pcm;
 443
 444                 if (line6pcm != NULL) {
 445                         line6_pcm_release(line6pcm, LINE6_BITS_PCM_MONITOR);
 446                         line6_pcm_disconnect(line6pcm);
 447                 }
 448         }
 449
 450         toneport_destruct(interface);
 451 }