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 static const struct {
  91         const char *name;
  92         int code;
  93 } toneport_source_info[] = {
  94         {"Microphone", 0x0a01},
  95         {"Line", 0x0801},
  96         {"Instrument", 0x0b01},
  97         {"Inst & Mic", 0x0901}
  98 };
  99
 100 static bool toneport_has_led(short product)
 101 {
 102         return
 103             (product == LINE6_DEVID_GUITARPORT) ||
 104             (product == LINE6_DEVID_TONEPORT_GX);
 105         /* add your device here if you are missing support for the LEDs */
 106 }
 107
 108 static void toneport_update_led(struct device *dev)
 109 {
 110         struct usb_interface *interface = to_usb_interface(dev);
 111         struct usb_line6_toneport *tp = usb_get_intfdata(interface);
 112         struct usb_line6 *line6;
 113
 114         if (!tp)
 115                 return;
 116
 117         line6 = &tp->line6;
 118         if (line6)
 119                 toneport_send_cmd(line6->usbdev, (led_red << 8) | 0x0002,
 120                                   led_green);
 121 }
 122
 123 static ssize_t toneport_set_led_red(struct device *dev,
 124                                     struct device_attribute *attr,
 125                                     const char *buf, size_t count)
 126 {
 127         int retval;
 128
 129         retval = kstrtoint(buf, 10, &led_red);
 130         if (retval)
 131                 return retval;
 132
 133         toneport_update_led(dev);
 134         return count;
 135 }
 136
 137 static ssize_t toneport_set_led_green(struct device *dev,
 138                                       struct device_attribute *attr,
 139                                       const char *buf, size_t count)
 140 {
 141         int retval;
 142
 143         retval = kstrtoint(buf, 10, &led_green);
 144         if (retval)
 145                 return retval;
 146
 147         toneport_update_led(dev);
 148         return count;
 149 }
 150
 151 static DEVICE_ATTR(led_red, S_IWUSR | S_IRUGO, line6_nop_read,
 152                    toneport_set_led_red);
 153 static DEVICE_ATTR(led_green, S_IWUSR | S_IRUGO, line6_nop_read,
 154                    toneport_set_led_green);
 155
 156 static int toneport_send_cmd(struct usb_device *usbdev, int cmd1, int cmd2)
 157 {
 158         int ret;
 159
 160         ret = usb_control_msg(usbdev, usb_sndctrlpipe(usbdev, 0), 0x67,
 161                               USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,
 162                               cmd1, cmd2, NULL, 0, LINE6_TIMEOUT * HZ);
 163
 164         if (ret < 0) {
 165                 dev_err(&usbdev->dev, "send failed (error %d)\n", ret);
 166                 return ret;
 167         }
 168
 169         return 0;
 170 }
 171
 172 /* monitor info callback */
 173 static int snd_toneport_monitor_info(struct snd_kcontrol *kcontrol,
 174                                      struct snd_ctl_elem_info *uinfo)
 175 {
 176         uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
 177         uinfo->count = 1;
 178         uinfo->value.integer.min = 0;
 179         uinfo->value.integer.max = 256;
 180         return 0;
 181 }
 182
 183 /* monitor get callback */
 184 static int snd_toneport_monitor_get(struct snd_kcontrol *kcontrol,
 185                                     struct snd_ctl_elem_value *ucontrol)
 186 {
 187         struct snd_line6_pcm *line6pcm = snd_kcontrol_chip(kcontrol);
 188
 189         ucontrol->value.integer.value[0] = line6pcm->volume_monitor;
 190         return 0;
 191 }
 192
 193 /* monitor put callback */
 194 static int snd_toneport_monitor_put(struct snd_kcontrol *kcontrol,
 195                                     struct snd_ctl_elem_value *ucontrol)
 196 {
 197         struct snd_line6_pcm *line6pcm = snd_kcontrol_chip(kcontrol);
 198
 199         if (ucontrol->value.integer.value[0] == line6pcm->volume_monitor)
 200                 return 0;
 201
 202         line6pcm->volume_monitor = ucontrol->value.integer.value[0];
 203
 204         if (line6pcm->volume_monitor > 0)
 205                 line6_pcm_acquire(line6pcm, LINE6_BITS_PCM_MONITOR);
 206         else
 207                 line6_pcm_release(line6pcm, LINE6_BITS_PCM_MONITOR);
 208
 209         return 1;
 210 }
 211
 212 /* source info callback */
 213 static int snd_toneport_source_info(struct snd_kcontrol *kcontrol,
 214                                     struct snd_ctl_elem_info *uinfo)
 215 {
 216         const int size = ARRAY_SIZE(toneport_source_info);
 217
 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         unsigned int source;
 250
 251         source = ucontrol->value.enumerated.item[0];
 252         if (source >= ARRAY_SIZE(toneport_source_info))
 253                 return -EINVAL;
 254         if (source == toneport->source)
 255                 return 0;
 256
 257         toneport->source = source;
 258         toneport_send_cmd(toneport->line6.usbdev,
 259                           toneport_source_info[source].code, 0x0000);
 260         return 1;
 261 }
 262
 263 static void toneport_start_pcm(unsigned long arg)
 264 {
 265         struct usb_line6_toneport *toneport = (struct usb_line6_toneport *)arg;
 266         struct usb_line6 *line6 = &toneport->line6;
 267
 268         line6_pcm_acquire(line6->line6pcm, LINE6_BITS_PCM_MONITOR);
 269 }
 270
 271 /* control definition */
 272 static struct snd_kcontrol_new toneport_control_monitor = {
 273         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
 274         .name = "Monitor Playback Volume",
 275         .index = 0,
 276         .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
 277         .info = snd_toneport_monitor_info,
 278         .get = snd_toneport_monitor_get,
 279         .put = snd_toneport_monitor_put
 280 };
 281
 282 /* source selector definition */
 283 static struct snd_kcontrol_new toneport_control_source = {
 284         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
 285         .name = "PCM Capture Source",
 286         .index = 0,
 287         .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
 288         .info = snd_toneport_source_info,
 289         .get = snd_toneport_source_get,
 290         .put = snd_toneport_source_put
 291 };
 292
 293 /*
 294         Toneport destructor.
 295 */
 296 static void toneport_destruct(struct usb_interface *interface)
 297 {
 298         struct usb_line6_toneport *toneport = usb_get_intfdata(interface);
 299
 300         if (toneport == NULL)
 301                 return;
 302         line6_cleanup_audio(&toneport->line6);
 303 }
 304
 305 /*
 306         Setup Toneport device.
 307 */
 308 static void toneport_setup(struct usb_line6_toneport *toneport)
 309 {
 310         int ticks;
 311         struct usb_line6 *line6 = &toneport->line6;
 312         struct usb_device *usbdev = line6->usbdev;
 313         u16 idProduct = le16_to_cpu(usbdev->descriptor.idProduct);
 314
 315         /* sync time on device with host: */
 316         ticks = (int)get_seconds();
 317         line6_write_data(line6, 0x80c6, &ticks, 4);
 318
 319         /* enable device: */
 320         toneport_send_cmd(usbdev, 0x0301, 0x0000);
 321
 322         /* initialize source select: */
 323         switch (le16_to_cpu(usbdev->descriptor.idProduct)) {
 324         case LINE6_DEVID_TONEPORT_UX1:
 325         case LINE6_DEVID_TONEPORT_UX2:
 326         case LINE6_DEVID_PODSTUDIO_UX1:
 327         case LINE6_DEVID_PODSTUDIO_UX2:
 328                 toneport_send_cmd(usbdev,
 329                                   toneport_source_info[toneport->source].code,
 330                                   0x0000);
 331         }
 332
 333         if (toneport_has_led(idProduct))
 334                 toneport_update_led(&usbdev->dev);
 335 }
 336
 337 /*
 338          Try to init Toneport device.
 339 */
 340 static int toneport_try_init(struct usb_interface *interface,
 341                              struct usb_line6_toneport *toneport)
 342 {
 343         int err;
 344         struct usb_line6 *line6 = &toneport->line6;
 345         struct usb_device *usbdev = line6->usbdev;
 346         u16 idProduct = le16_to_cpu(usbdev->descriptor.idProduct);
 347
 348         if ((interface == NULL) || (toneport == NULL))
 349                 return -ENODEV;
 350
 351         /* initialize audio system: */
 352         err = line6_init_audio(line6);
 353         if (err < 0)
 354                 return err;
 355
 356         /* initialize PCM subsystem: */
 357         err = line6_init_pcm(line6, &toneport_pcm_properties);
 358         if (err < 0)
 359                 return err;
 360
 361         /* register monitor control: */
 362         err = snd_ctl_add(line6->card,
 363                           snd_ctl_new1(&toneport_control_monitor,
 364                                        line6->line6pcm));
 365         if (err < 0)
 366                 return err;
 367
 368         /* register source select control: */
 369         switch (le16_to_cpu(usbdev->descriptor.idProduct)) {
 370         case LINE6_DEVID_TONEPORT_UX1:
 371         case LINE6_DEVID_TONEPORT_UX2:
 372         case LINE6_DEVID_PODSTUDIO_UX1:
 373         case LINE6_DEVID_PODSTUDIO_UX2:
 374                 err =
 375                     snd_ctl_add(line6->card,
 376                                 snd_ctl_new1(&toneport_control_source,
 377                                              line6->line6pcm));
 378                 if (err < 0)
 379                         return err;
 380         }
 381
 382         /* register audio system: */
 383         err = line6_register_audio(line6);
 384         if (err < 0)
 385                 return err;
 386
 387         line6_read_serial_number(line6, &toneport->serial_number);
 388         line6_read_data(line6, 0x80c2, &toneport->firmware_version, 1);
 389
 390         if (toneport_has_led(idProduct)) {
 391                 CHECK_RETURN(device_create_file
 392                              (&interface->dev, &dev_attr_led_red));
 393                 CHECK_RETURN(device_create_file
 394                              (&interface->dev, &dev_attr_led_green));
 395         }
 396
 397         toneport_setup(toneport);
 398
 399         init_timer(&toneport->timer);
 400         toneport->timer.expires = jiffies + TONEPORT_PCM_DELAY * HZ;
 401         toneport->timer.function = toneport_start_pcm;
 402         toneport->timer.data = (unsigned long)toneport;
 403         add_timer(&toneport->timer);
 404
 405         return 0;
 406 }
 407
 408 /*
 409          Init Toneport device (and clean up in case of failure).
 410 */
 411 int line6_toneport_init(struct usb_interface *interface,
 412                         struct usb_line6_toneport *toneport)
 413 {
 414         int err = toneport_try_init(interface, toneport);
 415
 416         if (err < 0)
 417                 toneport_destruct(interface);
 418
 419         return err;
 420 }
 421
 422 /*
 423         Resume Toneport device after reset.
 424 */
 425 void line6_toneport_reset_resume(struct usb_line6_toneport *toneport)
 426 {
 427         toneport_setup(toneport);
 428 }
 429
 430 /*
 431         Toneport device disconnected.
 432 */
 433 void line6_toneport_disconnect(struct usb_interface *interface)
 434 {
 435         struct usb_line6_toneport *toneport;
 436         u16 idProduct;
 437
 438         if (interface == NULL)
 439                 return;
 440
 441         toneport = usb_get_intfdata(interface);
 442         del_timer_sync(&toneport->timer);
 443         idProduct = le16_to_cpu(toneport->line6.usbdev->descriptor.idProduct);
 444
 445         if (toneport_has_led(idProduct)) {
 446                 device_remove_file(&interface->dev, &dev_attr_led_red);
 447                 device_remove_file(&interface->dev, &dev_attr_led_green);
 448         }
 449
 450         if (toneport != NULL) {
 451                 struct snd_line6_pcm *line6pcm = toneport->line6.line6pcm;
 452
 453                 if (line6pcm != NULL) {
 454                         line6_pcm_release(line6pcm, LINE6_BITS_PCM_MONITOR);
 455                         line6_pcm_disconnect(line6pcm);
 456                 }
 457         }
 458
 459         toneport_destruct(interface);
 460 }