drivers/staging/line6/pcm.c

   1 /*
   2  * Line6 Linux USB driver - 0.9.1beta
   3  *
   4  * Copyright (C) 2004-2010 Markus Grabner (grabner@icg.tugraz.at)
   5  *
   6  *      This program is free software; you can redistribute it and/or
   7  *      modify it under the terms of the GNU General Public License as
   8  *      published by the Free Software Foundation, version 2.
   9  *
  10  */
  11
  12 #include <linux/slab.h>
  13 #include <sound/core.h>
  14 #include <sound/control.h>
  15 #include <sound/pcm.h>
  16 #include <sound/pcm_params.h>
  17
  18 #include "audio.h"
  19 #include "capture.h"
  20 #include "driver.h"
  21 #include "playback.h"
  22 #include "pod.h"
  23
  24 #ifdef CONFIG_LINE6_USB_IMPULSE_RESPONSE
  25
  26 static struct snd_line6_pcm *dev2pcm(struct device *dev)
  27 {
  28         struct usb_interface *interface = to_usb_interface(dev);
  29         struct usb_line6 *line6 = usb_get_intfdata(interface);
  30         struct snd_line6_pcm *line6pcm = line6->line6pcm;
  31         return line6pcm;
  32 }
  33
  34 /*
  35         "read" request on "impulse_volume" special file.
  36 */
  37 static ssize_t pcm_get_impulse_volume(struct device *dev,
  38                                       struct device_attribute *attr, char *buf)
  39 {
  40         return sprintf(buf, "%d\n", dev2pcm(dev)->impulse_volume);
  41 }
  42
  43 /*
  44         "write" request on "impulse_volume" special file.
  45 */
  46 static ssize_t pcm_set_impulse_volume(struct device *dev,
  47                                       struct device_attribute *attr,
  48                                       const char *buf, size_t count)
  49 {
  50         struct snd_line6_pcm *line6pcm = dev2pcm(dev);
  51         int value;
  52         int ret;
  53
  54         ret = kstrtoint(buf, 10, &value);
  55         if (ret < 0)
  56                 return ret;
  57
  58         line6pcm->impulse_volume = value;
  59
  60         if (value > 0)
  61                 line6_pcm_acquire(line6pcm, LINE6_BITS_PCM_IMPULSE);
  62         else
  63                 line6_pcm_release(line6pcm, LINE6_BITS_PCM_IMPULSE);
  64
  65         return count;
  66 }
  67
  68 /*
  69         "read" request on "impulse_period" special file.
  70 */
  71 static ssize_t pcm_get_impulse_period(struct device *dev,
  72                                       struct device_attribute *attr, char *buf)
  73 {
  74         return sprintf(buf, "%d\n", dev2pcm(dev)->impulse_period);
  75 }
  76
  77 /*
  78         "write" request on "impulse_period" special file.
  79 */
  80 static ssize_t pcm_set_impulse_period(struct device *dev,
  81                                       struct device_attribute *attr,
  82                                       const char *buf, size_t count)
  83 {
  84         int value;
  85         int ret;
  86
  87         ret = kstrtoint(buf, 10, &value);
  88         if (ret < 0)
  89                 return ret;
  90
  91         dev2pcm(dev)->impulse_period = value;
  92         return count;
  93 }
  94
  95 static DEVICE_ATTR(impulse_volume, S_IWUSR | S_IRUGO, pcm_get_impulse_volume,
  96                    pcm_set_impulse_volume);
  97 static DEVICE_ATTR(impulse_period, S_IWUSR | S_IRUGO, pcm_get_impulse_period,
  98                    pcm_set_impulse_period);
  99
 100 #endif
 101
 102 static bool test_flags(unsigned long flags0, unsigned long flags1,
 103                        unsigned long mask)
 104 {
 105         return ((flags0 & mask) == 0) && ((flags1 & mask) != 0);
 106 }
 107
 108 int line6_pcm_acquire(struct snd_line6_pcm *line6pcm, int channels)
 109 {
 110         unsigned long flags_old, flags_new, flags_final;
 111         int err;
 112
 113         do {
 114                 flags_old = ACCESS_ONCE(line6pcm->flags);
 115                 flags_new = flags_old | channels;
 116         } while (cmpxchg(&line6pcm->flags, flags_old, flags_new) != flags_old);
 117
 118         flags_final = flags_old;
 119
 120         line6pcm->prev_fbuf = NULL;
 121
 122         if (test_flags(flags_old, flags_new, LINE6_BITS_CAPTURE_BUFFER)) {
 123                 /* Invoked multiple times in a row so allocate once only */
 124                 if (!line6pcm->buffer_in) {
 125                         line6pcm->buffer_in =
 126                                 kmalloc(LINE6_ISO_BUFFERS * LINE6_ISO_PACKETS *
 127                                         line6pcm->max_packet_size, GFP_KERNEL);
 128                         if (!line6pcm->buffer_in) {
 129                                 err = -ENOMEM;
 130                                 goto pcm_acquire_error;
 131                         }
 132
 133                         flags_final |= channels & LINE6_BITS_CAPTURE_BUFFER;
 134                 }
 135         }
 136
 137         if (test_flags(flags_old, flags_new, LINE6_BITS_CAPTURE_STREAM)) {
 138                 /*
 139                    Waiting for completion of active URBs in the stop handler is
 140                    a bug, we therefore report an error if capturing is restarted
 141                    too soon.
 142                  */
 143                 if (line6pcm->active_urb_in | line6pcm->unlink_urb_in) {
 144                         dev_err(line6pcm->line6->ifcdev, "Device not yet ready\n");
 145                         return -EBUSY;
 146                 }
 147
 148                 line6pcm->count_in = 0;
 149                 line6pcm->prev_fsize = 0;
 150                 err = line6_submit_audio_in_all_urbs(line6pcm);
 151
 152                 if (err < 0)
 153                         goto pcm_acquire_error;
 154
 155                 flags_final |= channels & LINE6_BITS_CAPTURE_STREAM;
 156         }
 157
 158         if (test_flags(flags_old, flags_new, LINE6_BITS_PLAYBACK_BUFFER)) {
 159                 /* Invoked multiple times in a row so allocate once only */
 160                 if (!line6pcm->buffer_out) {
 161                         line6pcm->buffer_out =
 162                                 kmalloc(LINE6_ISO_BUFFERS * LINE6_ISO_PACKETS *
 163                                         line6pcm->max_packet_size, GFP_KERNEL);
 164                         if (!line6pcm->buffer_out) {
 165                                 err = -ENOMEM;
 166                                 goto pcm_acquire_error;
 167                         }
 168
 169                         flags_final |= channels & LINE6_BITS_PLAYBACK_BUFFER;
 170                 }
 171         }
 172
 173         if (test_flags(flags_old, flags_new, LINE6_BITS_PLAYBACK_STREAM)) {
 174                 /*
 175                   See comment above regarding PCM restart.
 176                 */
 177                 if (line6pcm->active_urb_out | line6pcm->unlink_urb_out) {
 178                         dev_err(line6pcm->line6->ifcdev, "Device not yet ready\n");
 179                         return -EBUSY;
 180                 }
 181
 182                 line6pcm->count_out = 0;
 183                 err = line6_submit_audio_out_all_urbs(line6pcm);
 184
 185                 if (err < 0)
 186                         goto pcm_acquire_error;
 187
 188                 flags_final |= channels & LINE6_BITS_PLAYBACK_STREAM;
 189         }
 190
 191         return 0;
 192
 193 pcm_acquire_error:
 194         /*
 195            If not all requested resources/streams could be obtained, release
 196            those which were successfully obtained (if any).
 197         */
 198         line6_pcm_release(line6pcm, flags_final & channels);
 199         return err;
 200 }
 201
 202 int line6_pcm_release(struct snd_line6_pcm *line6pcm, int channels)
 203 {
 204         unsigned long flags_old, flags_new;
 205
 206         do {
 207                 flags_old = ACCESS_ONCE(line6pcm->flags);
 208                 flags_new = flags_old & ~channels;
 209         } while (cmpxchg(&line6pcm->flags, flags_old, flags_new) != flags_old);
 210
 211         if (test_flags(flags_new, flags_old, LINE6_BITS_CAPTURE_STREAM))
 212                 line6_unlink_audio_in_urbs(line6pcm);
 213
 214         if (test_flags(flags_new, flags_old, LINE6_BITS_CAPTURE_BUFFER)) {
 215                 line6_wait_clear_audio_in_urbs(line6pcm);
 216                 line6_free_capture_buffer(line6pcm);
 217         }
 218
 219         if (test_flags(flags_new, flags_old, LINE6_BITS_PLAYBACK_STREAM))
 220                 line6_unlink_audio_out_urbs(line6pcm);
 221
 222         if (test_flags(flags_new, flags_old, LINE6_BITS_PLAYBACK_BUFFER)) {
 223                 line6_wait_clear_audio_out_urbs(line6pcm);
 224                 line6_free_playback_buffer(line6pcm);
 225         }
 226
 227         return 0;
 228 }
 229
 230 /* trigger callback */
 231 int snd_line6_trigger(struct snd_pcm_substream *substream, int cmd)
 232 {
 233         struct snd_line6_pcm *line6pcm = snd_pcm_substream_chip(substream);
 234         struct snd_pcm_substream *s;
 235         int err;
 236         unsigned long flags;
 237
 238         spin_lock_irqsave(&line6pcm->lock_trigger, flags);
 239         clear_bit(LINE6_INDEX_PREPARED, &line6pcm->flags);
 240
 241         snd_pcm_group_for_each_entry(s, substream) {
 242                 switch (s->stream) {
 243                 case SNDRV_PCM_STREAM_PLAYBACK:
 244                         err = snd_line6_playback_trigger(line6pcm, cmd);
 245
 246                         if (err < 0) {
 247                                 spin_unlock_irqrestore(&line6pcm->lock_trigger,
 248                                                        flags);
 249                                 return err;
 250                         }
 251
 252                         break;
 253
 254                 case SNDRV_PCM_STREAM_CAPTURE:
 255                         err = snd_line6_capture_trigger(line6pcm, cmd);
 256
 257                         if (err < 0) {
 258                                 spin_unlock_irqrestore(&line6pcm->lock_trigger,
 259                                                        flags);
 260                                 return err;
 261                         }
 262
 263                         break;
 264
 265                 default:
 266                         dev_err(line6pcm->line6->ifcdev,
 267                                 "Unknown stream direction %d\n", s->stream);
 268                 }
 269         }
 270
 271         spin_unlock_irqrestore(&line6pcm->lock_trigger, flags);
 272         return 0;
 273 }
 274
 275 /* control info callback */
 276 static int snd_line6_control_playback_info(struct snd_kcontrol *kcontrol,
 277                                            struct snd_ctl_elem_info *uinfo)
 278 {
 279         uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
 280         uinfo->count = 2;
 281         uinfo->value.integer.min = 0;
 282         uinfo->value.integer.max = 256;
 283         return 0;
 284 }
 285
 286 /* control get callback */
 287 static int snd_line6_control_playback_get(struct snd_kcontrol *kcontrol,
 288                                           struct snd_ctl_elem_value *ucontrol)
 289 {
 290         int i;
 291         struct snd_line6_pcm *line6pcm = snd_kcontrol_chip(kcontrol);
 292
 293         for (i = 2; i--;)
 294                 ucontrol->value.integer.value[i] = line6pcm->volume_playback[i];
 295
 296         return 0;
 297 }
 298
 299 /* control put callback */
 300 static int snd_line6_control_playback_put(struct snd_kcontrol *kcontrol,
 301                                           struct snd_ctl_elem_value *ucontrol)
 302 {
 303         int i, changed = 0;
 304         struct snd_line6_pcm *line6pcm = snd_kcontrol_chip(kcontrol);
 305
 306         for (i = 2; i--;)
 307                 if (line6pcm->volume_playback[i] !=
 308                     ucontrol->value.integer.value[i]) {
 309                         line6pcm->volume_playback[i] =
 310                             ucontrol->value.integer.value[i];
 311                         changed = 1;
 312                 }
 313
 314         return changed;
 315 }
 316
 317 /* control definition */
 318 static struct snd_kcontrol_new line6_control_playback = {
 319         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
 320         .name = "PCM Playback Volume",
 321         .index = 0,
 322         .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
 323         .info = snd_line6_control_playback_info,
 324         .get = snd_line6_control_playback_get,
 325         .put = snd_line6_control_playback_put
 326 };
 327
 328 /*
 329         Cleanup the PCM device.
 330 */
 331 static void line6_cleanup_pcm(struct snd_pcm *pcm)
 332 {
 333         int i;
 334         struct snd_line6_pcm *line6pcm = snd_pcm_chip(pcm);
 335
 336 #ifdef CONFIG_LINE6_USB_IMPULSE_RESPONSE
 337         device_remove_file(line6pcm->line6->ifcdev, &dev_attr_impulse_volume);
 338         device_remove_file(line6pcm->line6->ifcdev, &dev_attr_impulse_period);
 339 #endif
 340
 341         for (i = LINE6_ISO_BUFFERS; i--;) {
 342                 if (line6pcm->urb_audio_out[i]) {
 343                         usb_kill_urb(line6pcm->urb_audio_out[i]);
 344                         usb_free_urb(line6pcm->urb_audio_out[i]);
 345                 }
 346                 if (line6pcm->urb_audio_in[i]) {
 347                         usb_kill_urb(line6pcm->urb_audio_in[i]);
 348                         usb_free_urb(line6pcm->urb_audio_in[i]);
 349                 }
 350         }
 351 }
 352
 353 /* create a PCM device */
 354 static int snd_line6_new_pcm(struct snd_line6_pcm *line6pcm)
 355 {
 356         struct snd_pcm *pcm;
 357         int err;
 358
 359         err = snd_pcm_new(line6pcm->line6->card,
 360                           (char *)line6pcm->line6->properties->name,
 361                           0, 1, 1, &pcm);
 362         if (err < 0)
 363                 return err;
 364
 365         pcm->private_data = line6pcm;
 366         pcm->private_free = line6_cleanup_pcm;
 367         line6pcm->pcm = pcm;
 368         strcpy(pcm->name, line6pcm->line6->properties->name);
 369
 370         /* set operators */
 371         snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK,
 372                         &snd_line6_playback_ops);
 373         snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &snd_line6_capture_ops);
 374
 375         /* pre-allocation of buffers */
 376         snd_pcm_lib_preallocate_pages_for_all(pcm, SNDRV_DMA_TYPE_CONTINUOUS,
 377                                               snd_dma_continuous_data
 378                                               (GFP_KERNEL), 64 * 1024,
 379                                               128 * 1024);
 380
 381         return 0;
 382 }
 383
 384 /* PCM device destructor */
 385 static int snd_line6_pcm_free(struct snd_device *device)
 386 {
 387         return 0;
 388 }
 389
 390 /*
 391         Stop substream if still running.
 392 */
 393 static void pcm_disconnect_substream(struct snd_pcm_substream *substream)
 394 {
 395         if (substream->runtime && snd_pcm_running(substream))
 396                 snd_pcm_stop(substream, SNDRV_PCM_STATE_DISCONNECTED);
 397 }
 398
 399 /*
 400         Stop PCM stream.
 401 */
 402 void line6_pcm_disconnect(struct snd_line6_pcm *line6pcm)
 403 {
 404         pcm_disconnect_substream(get_substream
 405                                  (line6pcm, SNDRV_PCM_STREAM_CAPTURE));
 406         pcm_disconnect_substream(get_substream
 407                                  (line6pcm, SNDRV_PCM_STREAM_PLAYBACK));
 408         line6_unlink_wait_clear_audio_out_urbs(line6pcm);
 409         line6_unlink_wait_clear_audio_in_urbs(line6pcm);
 410 }
 411
 412 /*
 413         Create and register the PCM device and mixer entries.
 414         Create URBs for playback and capture.
 415 */
 416 int line6_init_pcm(struct usb_line6 *line6,
 417                    struct line6_pcm_properties *properties)
 418 {
 419         static struct snd_device_ops pcm_ops = {
 420                 .dev_free = snd_line6_pcm_free,
 421         };
 422
 423         int err;
 424         int ep_read = 0, ep_write = 0;
 425         struct snd_line6_pcm *line6pcm;
 426
 427         if (!(line6->properties->capabilities & LINE6_BIT_PCM))
 428                 return 0;       /* skip PCM initialization and report success */
 429
 430         /* initialize PCM subsystem based on product id: */
 431         switch (line6->product) {
 432         case LINE6_DEVID_BASSPODXT:
 433         case LINE6_DEVID_BASSPODXTLIVE:
 434         case LINE6_DEVID_BASSPODXTPRO:
 435         case LINE6_DEVID_PODXT:
 436         case LINE6_DEVID_PODXTLIVE:
 437         case LINE6_DEVID_PODXTPRO:
 438         case LINE6_DEVID_PODHD300:
 439                 ep_read = 0x82;
 440                 ep_write = 0x01;
 441                 break;
 442
 443         case LINE6_DEVID_PODHD500:
 444         case LINE6_DEVID_PODX3:
 445         case LINE6_DEVID_PODX3LIVE:
 446                 ep_read = 0x86;
 447                 ep_write = 0x02;
 448                 break;
 449
 450         case LINE6_DEVID_POCKETPOD:
 451                 ep_read = 0x82;
 452                 ep_write = 0x02;
 453                 break;
 454
 455         case LINE6_DEVID_GUITARPORT:
 456         case LINE6_DEVID_PODSTUDIO_GX:
 457         case LINE6_DEVID_PODSTUDIO_UX1:
 458         case LINE6_DEVID_PODSTUDIO_UX2:
 459         case LINE6_DEVID_TONEPORT_GX:
 460         case LINE6_DEVID_TONEPORT_UX1:
 461         case LINE6_DEVID_TONEPORT_UX2:
 462                 ep_read = 0x82;
 463                 ep_write = 0x01;
 464                 break;
 465
 466         /* this is for interface_number == 1:
 467         case LINE6_DEVID_TONEPORT_UX2:
 468         case LINE6_DEVID_PODSTUDIO_UX2:
 469                 ep_read  = 0x87;
 470                 ep_write = 0x00;
 471                 break; */
 472
 473         default:
 474                 MISSING_CASE;
 475         }
 476
 477         line6pcm = kzalloc(sizeof(struct snd_line6_pcm), GFP_KERNEL);
 478
 479         if (line6pcm == NULL)
 480                 return -ENOMEM;
 481
 482         line6pcm->volume_playback[0] = line6pcm->volume_playback[1] = 255;
 483         line6pcm->volume_monitor = 255;
 484         line6pcm->line6 = line6;
 485         line6pcm->ep_audio_read = ep_read;
 486         line6pcm->ep_audio_write = ep_write;
 487
 488         /* Read and write buffers are sized identically, so choose minimum */
 489         line6pcm->max_packet_size = min(
 490                         usb_maxpacket(line6->usbdev,
 491                                 usb_rcvisocpipe(line6->usbdev, ep_read), 0),
 492                         usb_maxpacket(line6->usbdev,
 493                                 usb_sndisocpipe(line6->usbdev, ep_write), 1));
 494
 495         line6pcm->properties = properties;
 496         line6->line6pcm = line6pcm;
 497
 498         /* PCM device: */
 499         err = snd_device_new(line6->card, SNDRV_DEV_PCM, line6, &pcm_ops);
 500         if (err < 0)
 501                 return err;
 502
 503         snd_card_set_dev(line6->card, line6->ifcdev);
 504
 505         err = snd_line6_new_pcm(line6pcm);
 506         if (err < 0)
 507                 return err;
 508
 509         spin_lock_init(&line6pcm->lock_audio_out);
 510         spin_lock_init(&line6pcm->lock_audio_in);
 511         spin_lock_init(&line6pcm->lock_trigger);
 512
 513         err = line6_create_audio_out_urbs(line6pcm);
 514         if (err < 0)
 515                 return err;
 516
 517         err = line6_create_audio_in_urbs(line6pcm);
 518         if (err < 0)
 519                 return err;
 520
 521         /* mixer: */
 522         err =
 523             snd_ctl_add(line6->card,
 524                         snd_ctl_new1(&line6_control_playback, line6pcm));
 525         if (err < 0)
 526                 return err;
 527
 528 #ifdef CONFIG_LINE6_USB_IMPULSE_RESPONSE
 529         /* impulse response test: */
 530         err = device_create_file(line6->ifcdev, &dev_attr_impulse_volume);
 531         if (err < 0)
 532                 return err;
 533
 534         err = device_create_file(line6->ifcdev, &dev_attr_impulse_period);
 535         if (err < 0)
 536                 return err;
 537
 538         line6pcm->impulse_period = LINE6_IMPULSE_DEFAULT_PERIOD;
 539 #endif
 540
 541         return 0;
 542 }
 543
 544 /* prepare pcm callback */
 545 int snd_line6_prepare(struct snd_pcm_substream *substream)
 546 {
 547         struct snd_line6_pcm *line6pcm = snd_pcm_substream_chip(substream);
 548
 549         switch (substream->stream) {
 550         case SNDRV_PCM_STREAM_PLAYBACK:
 551                 if ((line6pcm->flags & LINE6_BITS_PLAYBACK_STREAM) == 0)
 552                         line6_unlink_wait_clear_audio_out_urbs(line6pcm);
 553
 554                 break;
 555
 556         case SNDRV_PCM_STREAM_CAPTURE:
 557                 if ((line6pcm->flags & LINE6_BITS_CAPTURE_STREAM) == 0)
 558                         line6_unlink_wait_clear_audio_in_urbs(line6pcm);
 559
 560                 break;
 561
 562         default:
 563                 MISSING_CASE;
 564         }
 565
 566         if (!test_and_set_bit(LINE6_INDEX_PREPARED, &line6pcm->flags)) {
 567                 line6pcm->count_out = 0;
 568                 line6pcm->pos_out = 0;
 569                 line6pcm->pos_out_done = 0;
 570                 line6pcm->bytes_out = 0;
 571                 line6pcm->count_in = 0;
 572                 line6pcm->pos_in_done = 0;
 573                 line6pcm->bytes_in = 0;
 574         }
 575
 576         return 0;
 577 }