drivers/staging/line6/playback.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/pcm.h>
  15 #include <sound/pcm_params.h>
  16
  17 #include "audio.h"
  18 #include "capture.h"
  19 #include "driver.h"
  20 #include "pcm.h"
  21 #include "pod.h"
  22 #include "playback.h"
  23
  24 /*
  25         Software stereo volume control.
  26 */
  27 static void change_volume(struct urb *urb_out, int volume[],
  28                           int bytes_per_frame)
  29 {
  30         int chn = 0;
  31
  32         if (volume[0] == 256 && volume[1] == 256)
  33                 return;         /* maximum volume - no change */
  34
  35         if (bytes_per_frame == 4) {
  36                 short *p, *buf_end;
  37                 p = (short *)urb_out->transfer_buffer;
  38                 buf_end = p + urb_out->transfer_buffer_length / sizeof(*p);
  39
  40                 for (; p < buf_end; ++p) {
  41                         *p = (*p * volume[chn & 1]) >> 8;
  42                         ++chn;
  43                 }
  44         } else if (bytes_per_frame == 6) {
  45                 unsigned char *p, *buf_end;
  46                 p = (unsigned char *)urb_out->transfer_buffer;
  47                 buf_end = p + urb_out->transfer_buffer_length;
  48
  49                 for (; p < buf_end; p += 3) {
  50                         int val;
  51                         val = p[0] + (p[1] << 8) + ((signed char)p[2] << 16);
  52                         val = (val * volume[chn & 1]) >> 8;
  53                         p[0] = val;
  54                         p[1] = val >> 8;
  55                         p[2] = val >> 16;
  56                         ++chn;
  57                 }
  58         }
  59 }
  60
  61 #ifdef CONFIG_LINE6_USB_IMPULSE_RESPONSE
  62
  63 /*
  64         Create signal for impulse response test.
  65 */
  66 static void create_impulse_test_signal(struct snd_line6_pcm *line6pcm,
  67                                        struct urb *urb_out, int bytes_per_frame)
  68 {
  69         int frames = urb_out->transfer_buffer_length / bytes_per_frame;
  70
  71         if (bytes_per_frame == 4) {
  72                 int i;
  73                 short *pi = (short *)line6pcm->prev_fbuf;
  74                 short *po = (short *)urb_out->transfer_buffer;
  75
  76                 for (i = 0; i < frames; ++i) {
  77                         po[0] = pi[0];
  78                         po[1] = 0;
  79                         pi += 2;
  80                         po += 2;
  81                 }
  82         } else if (bytes_per_frame == 6) {
  83                 int i, j;
  84                 unsigned char *pi = line6pcm->prev_fbuf;
  85                 unsigned char *po = urb_out->transfer_buffer;
  86
  87                 for (i = 0; i < frames; ++i) {
  88                         for (j = 0; j < bytes_per_frame / 2; ++j)
  89                                 po[j] = pi[j];
  90
  91                         for (; j < bytes_per_frame; ++j)
  92                                 po[j] = 0;
  93
  94                         pi += bytes_per_frame;
  95                         po += bytes_per_frame;
  96                 }
  97         }
  98         if (--line6pcm->impulse_count <= 0) {
  99                 ((unsigned char *)(urb_out->transfer_buffer))[bytes_per_frame -
 100                                                               1] =
 101                     line6pcm->impulse_volume;
 102                 line6pcm->impulse_count = line6pcm->impulse_period;
 103         }
 104 }
 105
 106 #endif
 107
 108 /*
 109         Add signal to buffer for software monitoring.
 110 */
 111 static void add_monitor_signal(struct urb *urb_out, unsigned char *signal,
 112                                int volume, int bytes_per_frame)
 113 {
 114         if (volume == 0)
 115                 return;         /* zero volume - no change */
 116
 117         if (bytes_per_frame == 4) {
 118                 short *pi, *po, *buf_end;
 119                 pi = (short *)signal;
 120                 po = (short *)urb_out->transfer_buffer;
 121                 buf_end = po + urb_out->transfer_buffer_length / sizeof(*po);
 122
 123                 for (; po < buf_end; ++pi, ++po)
 124                         *po += (*pi * volume) >> 8;
 125         }
 126
 127         /*
 128            We don't need to handle devices with 6 bytes per frame here
 129            since they all support hardware monitoring.
 130          */
 131 }
 132
 133 /*
 134         Find a free URB, prepare audio data, and submit URB.
 135 */
 136 static int submit_audio_out_urb(struct snd_line6_pcm *line6pcm)
 137 {
 138         int index;
 139         unsigned long flags;
 140         int i, urb_size, urb_frames;
 141         int ret;
 142         const int bytes_per_frame = line6pcm->properties->bytes_per_frame;
 143         const int frame_increment =
 144             line6pcm->properties->snd_line6_rates.rats[0].num_min;
 145         const int frame_factor =
 146             line6pcm->properties->snd_line6_rates.rats[0].den *
 147             (USB_INTERVALS_PER_SECOND / LINE6_ISO_INTERVAL);
 148         struct urb *urb_out;
 149
 150         spin_lock_irqsave(&line6pcm->lock_audio_out, flags);
 151         index =
 152             find_first_zero_bit(&line6pcm->active_urb_out, LINE6_ISO_BUFFERS);
 153
 154         if (index < 0 || index >= LINE6_ISO_BUFFERS) {
 155                 spin_unlock_irqrestore(&line6pcm->lock_audio_out, flags);
 156                 dev_err(line6pcm->line6->ifcdev, "no free URB found\n");
 157                 return -EINVAL;
 158         }
 159
 160         urb_out = line6pcm->urb_audio_out[index];
 161         urb_size = 0;
 162
 163         for (i = 0; i < LINE6_ISO_PACKETS; ++i) {
 164                 /* compute frame size for given sampling rate */
 165                 int fsize = 0;
 166                 struct usb_iso_packet_descriptor *fout =
 167                     &urb_out->iso_frame_desc[i];
 168
 169                 if (line6pcm->flags & LINE6_BITS_CAPTURE_STREAM)
 170                         fsize = line6pcm->prev_fsize;
 171
 172                 if (fsize == 0) {
 173                         int n;
 174                         line6pcm->count_out += frame_increment;
 175                         n = line6pcm->count_out / frame_factor;
 176                         line6pcm->count_out -= n * frame_factor;
 177                         fsize = n * bytes_per_frame;
 178                 }
 179
 180                 fout->offset = urb_size;
 181                 fout->length = fsize;
 182                 urb_size += fsize;
 183         }
 184
 185         if (urb_size == 0) {
 186                 /* can't determine URB size */
 187                 spin_unlock_irqrestore(&line6pcm->lock_audio_out, flags);
 188                 dev_err(line6pcm->line6->ifcdev, "driver bug: urb_size = 0\n");
 189                 return -EINVAL;
 190         }
 191
 192         urb_frames = urb_size / bytes_per_frame;
 193         urb_out->transfer_buffer =
 194             line6pcm->buffer_out +
 195             index * LINE6_ISO_PACKETS * line6pcm->max_packet_size;
 196         urb_out->transfer_buffer_length = urb_size;
 197         urb_out->context = line6pcm;
 198
 199         if (test_bit(LINE6_INDEX_PCM_ALSA_PLAYBACK_STREAM, &line6pcm->flags) &&
 200             !test_bit(LINE6_INDEX_PAUSE_PLAYBACK, &line6pcm->flags)) {
 201                 struct snd_pcm_runtime *runtime =
 202                     get_substream(line6pcm, SNDRV_PCM_STREAM_PLAYBACK)->runtime;
 203
 204                 if (line6pcm->pos_out + urb_frames > runtime->buffer_size) {
 205                         /*
 206                            The transferred area goes over buffer boundary,
 207                            copy the data to the temp buffer.
 208                          */
 209                         int len;
 210                         len = runtime->buffer_size - line6pcm->pos_out;
 211
 212                         if (len > 0) {
 213                                 memcpy(urb_out->transfer_buffer,
 214                                        runtime->dma_area +
 215                                        line6pcm->pos_out * bytes_per_frame,
 216                                        len * bytes_per_frame);
 217                                 memcpy(urb_out->transfer_buffer +
 218                                        len * bytes_per_frame, runtime->dma_area,
 219                                        (urb_frames - len) * bytes_per_frame);
 220                         } else
 221                                 dev_err(line6pcm->line6->ifcdev, "driver bug: len = %d\n",
 222                                         len);
 223                 } else {
 224                         memcpy(urb_out->transfer_buffer,
 225                                runtime->dma_area +
 226                                line6pcm->pos_out * bytes_per_frame,
 227                                urb_out->transfer_buffer_length);
 228                 }
 229
 230                 line6pcm->pos_out += urb_frames;
 231                 if (line6pcm->pos_out >= runtime->buffer_size)
 232                         line6pcm->pos_out -= runtime->buffer_size;
 233         } else {
 234                 memset(urb_out->transfer_buffer, 0,
 235                        urb_out->transfer_buffer_length);
 236         }
 237
 238         change_volume(urb_out, line6pcm->volume_playback, bytes_per_frame);
 239
 240         if (line6pcm->prev_fbuf != NULL) {
 241 #ifdef CONFIG_LINE6_USB_IMPULSE_RESPONSE
 242                 if (line6pcm->flags & LINE6_BITS_PCM_IMPULSE) {
 243                         create_impulse_test_signal(line6pcm, urb_out,
 244                                                    bytes_per_frame);
 245                         if (line6pcm->flags & LINE6_BIT_PCM_ALSA_CAPTURE_STREAM) {
 246                                 line6_capture_copy(line6pcm,
 247                                                    urb_out->transfer_buffer,
 248                                                    urb_out->
 249                                                    transfer_buffer_length);
 250                                 line6_capture_check_period(line6pcm,
 251                                                            urb_out->transfer_buffer_length);
 252                         }
 253                 } else {
 254 #endif
 255                         if (!
 256                             (line6pcm->line6->
 257                              properties->capabilities & LINE6_BIT_HWMON)
 258                             && (line6pcm->flags & LINE6_BITS_PLAYBACK_STREAM)
 259                             && (line6pcm->flags & LINE6_BITS_CAPTURE_STREAM))
 260                                 add_monitor_signal(urb_out, line6pcm->prev_fbuf,
 261                                                    line6pcm->volume_monitor,
 262                                                    bytes_per_frame);
 263 #ifdef CONFIG_LINE6_USB_IMPULSE_RESPONSE
 264                 }
 265 #endif
 266         }
 267
 268         ret = usb_submit_urb(urb_out, GFP_ATOMIC);
 269
 270         if (ret == 0)
 271                 set_bit(index, &line6pcm->active_urb_out);
 272         else
 273                 dev_err(line6pcm->line6->ifcdev,
 274                         "URB out #%d submission failed (%d)\n", index, ret);
 275
 276         spin_unlock_irqrestore(&line6pcm->lock_audio_out, flags);
 277         return 0;
 278 }
 279
 280 /*
 281         Submit all currently available playback URBs.
 282 */
 283 int line6_submit_audio_out_all_urbs(struct snd_line6_pcm *line6pcm)
 284 {
 285         int ret, i;
 286
 287         for (i = 0; i < LINE6_ISO_BUFFERS; ++i) {
 288                 ret = submit_audio_out_urb(line6pcm);
 289                 if (ret < 0)
 290                         return ret;
 291         }
 292
 293         return 0;
 294 }
 295
 296 /*
 297         Unlink all currently active playback URBs.
 298 */
 299 void line6_unlink_audio_out_urbs(struct snd_line6_pcm *line6pcm)
 300 {
 301         unsigned int i;
 302
 303         for (i = LINE6_ISO_BUFFERS; i--;) {
 304                 if (test_bit(i, &line6pcm->active_urb_out)) {
 305                         if (!test_and_set_bit(i, &line6pcm->unlink_urb_out)) {
 306                                 struct urb *u = line6pcm->urb_audio_out[i];
 307                                 usb_unlink_urb(u);
 308                         }
 309                 }
 310         }
 311 }
 312
 313 /*
 314         Wait until unlinking of all currently active playback URBs has been
 315         finished.
 316 */
 317 void line6_wait_clear_audio_out_urbs(struct snd_line6_pcm *line6pcm)
 318 {
 319         int timeout = HZ;
 320         unsigned int i;
 321         int alive;
 322
 323         do {
 324                 alive = 0;
 325                 for (i = LINE6_ISO_BUFFERS; i--;) {
 326                         if (test_bit(i, &line6pcm->active_urb_out))
 327                                 alive++;
 328                 }
 329                 if (!alive)
 330                         break;
 331                 set_current_state(TASK_UNINTERRUPTIBLE);
 332                 schedule_timeout(1);
 333         } while (--timeout > 0);
 334         if (alive)
 335                 snd_printk(KERN_ERR "timeout: still %d active urbs..\n", alive);
 336 }
 337
 338 /*
 339         Unlink all currently active playback URBs, and wait for finishing.
 340 */
 341 void line6_unlink_wait_clear_audio_out_urbs(struct snd_line6_pcm *line6pcm)
 342 {
 343         line6_unlink_audio_out_urbs(line6pcm);
 344         line6_wait_clear_audio_out_urbs(line6pcm);
 345 }
 346
 347 void line6_free_playback_buffer(struct snd_line6_pcm *line6pcm)
 348 {
 349         kfree(line6pcm->buffer_out);
 350         line6pcm->buffer_out = NULL;
 351 }
 352
 353 /*
 354         Callback for completed playback URB.
 355 */
 356 static void audio_out_callback(struct urb *urb)
 357 {
 358         int i, index, length = 0, shutdown = 0;
 359         unsigned long flags;
 360
 361         struct snd_line6_pcm *line6pcm = (struct snd_line6_pcm *)urb->context;
 362         struct snd_pcm_substream *substream =
 363             get_substream(line6pcm, SNDRV_PCM_STREAM_PLAYBACK);
 364
 365 #if USE_CLEAR_BUFFER_WORKAROUND
 366         memset(urb->transfer_buffer, 0, urb->transfer_buffer_length);
 367 #endif
 368
 369         line6pcm->last_frame_out = urb->start_frame;
 370
 371         /* find index of URB */
 372         for (index = LINE6_ISO_BUFFERS; index--;)
 373                 if (urb == line6pcm->urb_audio_out[index])
 374                         break;
 375
 376         if (index < 0)
 377                 return;         /* URB has been unlinked asynchronously */
 378
 379         for (i = LINE6_ISO_PACKETS; i--;)
 380                 length += urb->iso_frame_desc[i].length;
 381
 382         spin_lock_irqsave(&line6pcm->lock_audio_out, flags);
 383
 384         if (test_bit(LINE6_INDEX_PCM_ALSA_PLAYBACK_STREAM, &line6pcm->flags)) {
 385                 struct snd_pcm_runtime *runtime = substream->runtime;
 386                 line6pcm->pos_out_done +=
 387                     length / line6pcm->properties->bytes_per_frame;
 388
 389                 if (line6pcm->pos_out_done >= runtime->buffer_size)
 390                         line6pcm->pos_out_done -= runtime->buffer_size;
 391         }
 392
 393         clear_bit(index, &line6pcm->active_urb_out);
 394
 395         for (i = LINE6_ISO_PACKETS; i--;)
 396                 if (urb->iso_frame_desc[i].status == -EXDEV) {
 397                         shutdown = 1;
 398                         break;
 399                 }
 400
 401         if (test_and_clear_bit(index, &line6pcm->unlink_urb_out))
 402                 shutdown = 1;
 403
 404         spin_unlock_irqrestore(&line6pcm->lock_audio_out, flags);
 405
 406         if (!shutdown) {
 407                 submit_audio_out_urb(line6pcm);
 408
 409                 if (test_bit(LINE6_INDEX_PCM_ALSA_PLAYBACK_STREAM,
 410                              &line6pcm->flags)) {
 411                         line6pcm->bytes_out += length;
 412                         if (line6pcm->bytes_out >= line6pcm->period_out) {
 413                                 line6pcm->bytes_out %= line6pcm->period_out;
 414                                 snd_pcm_period_elapsed(substream);
 415                         }
 416                 }
 417         }
 418 }
 419
 420 /* open playback callback */
 421 static int snd_line6_playback_open(struct snd_pcm_substream *substream)
 422 {
 423         int err;
 424         struct snd_pcm_runtime *runtime = substream->runtime;
 425         struct snd_line6_pcm *line6pcm = snd_pcm_substream_chip(substream);
 426
 427         err = snd_pcm_hw_constraint_ratdens(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
 428                                             (&line6pcm->
 429                                              properties->snd_line6_rates));
 430         if (err < 0)
 431                 return err;
 432
 433         runtime->hw = line6pcm->properties->snd_line6_playback_hw;
 434         return 0;
 435 }
 436
 437 /* close playback callback */
 438 static int snd_line6_playback_close(struct snd_pcm_substream *substream)
 439 {
 440         return 0;
 441 }
 442
 443 /* hw_params playback callback */
 444 static int snd_line6_playback_hw_params(struct snd_pcm_substream *substream,
 445                                         struct snd_pcm_hw_params *hw_params)
 446 {
 447         int ret;
 448         struct snd_line6_pcm *line6pcm = snd_pcm_substream_chip(substream);
 449
 450         /* -- Florian Demski [FD] */
 451         /* don't ask me why, but this fixes the bug on my machine */
 452         if (line6pcm == NULL) {
 453                 if (substream->pcm == NULL)
 454                         return -ENOMEM;
 455                 if (substream->pcm->private_data == NULL)
 456                         return -ENOMEM;
 457                 substream->private_data = substream->pcm->private_data;
 458                 line6pcm = snd_pcm_substream_chip(substream);
 459         }
 460         /* -- [FD] end */
 461
 462         ret = line6_pcm_acquire(line6pcm, LINE6_BIT_PCM_ALSA_PLAYBACK_BUFFER);
 463
 464         if (ret < 0)
 465                 return ret;
 466
 467         ret = snd_pcm_lib_malloc_pages(substream,
 468                                        params_buffer_bytes(hw_params));
 469         if (ret < 0) {
 470                 line6_pcm_release(line6pcm, LINE6_BIT_PCM_ALSA_PLAYBACK_BUFFER);
 471                 return ret;
 472         }
 473
 474         line6pcm->period_out = params_period_bytes(hw_params);
 475         return 0;
 476 }
 477
 478 /* hw_free playback callback */
 479 static int snd_line6_playback_hw_free(struct snd_pcm_substream *substream)
 480 {
 481         struct snd_line6_pcm *line6pcm = snd_pcm_substream_chip(substream);
 482         line6_pcm_release(line6pcm, LINE6_BIT_PCM_ALSA_PLAYBACK_BUFFER);
 483         return snd_pcm_lib_free_pages(substream);
 484 }
 485
 486 /* trigger playback callback */
 487 int snd_line6_playback_trigger(struct snd_line6_pcm *line6pcm, int cmd)
 488 {
 489         int err;
 490
 491         switch (cmd) {
 492         case SNDRV_PCM_TRIGGER_START:
 493 #ifdef CONFIG_PM
 494         case SNDRV_PCM_TRIGGER_RESUME:
 495 #endif
 496                 err = line6_pcm_acquire(line6pcm,
 497                                         LINE6_BIT_PCM_ALSA_PLAYBACK_STREAM);
 498
 499                 if (err < 0)
 500                         return err;
 501
 502                 break;
 503
 504         case SNDRV_PCM_TRIGGER_STOP:
 505 #ifdef CONFIG_PM
 506         case SNDRV_PCM_TRIGGER_SUSPEND:
 507 #endif
 508                 err = line6_pcm_release(line6pcm,
 509                                         LINE6_BIT_PCM_ALSA_PLAYBACK_STREAM);
 510
 511                 if (err < 0)
 512                         return err;
 513
 514                 break;
 515
 516         case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
 517                 set_bit(LINE6_INDEX_PAUSE_PLAYBACK, &line6pcm->flags);
 518                 break;
 519
 520         case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
 521                 clear_bit(LINE6_INDEX_PAUSE_PLAYBACK, &line6pcm->flags);
 522                 break;
 523
 524         default:
 525                 return -EINVAL;
 526         }
 527
 528         return 0;
 529 }
 530
 531 /* playback pointer callback */
 532 static snd_pcm_uframes_t
 533 snd_line6_playback_pointer(struct snd_pcm_substream *substream)
 534 {
 535         struct snd_line6_pcm *line6pcm = snd_pcm_substream_chip(substream);
 536         return line6pcm->pos_out_done;
 537 }
 538
 539 /* playback operators */
 540 struct snd_pcm_ops snd_line6_playback_ops = {
 541         .open = snd_line6_playback_open,
 542         .close = snd_line6_playback_close,
 543         .ioctl = snd_pcm_lib_ioctl,
 544         .hw_params = snd_line6_playback_hw_params,
 545         .hw_free = snd_line6_playback_hw_free,
 546         .prepare = snd_line6_prepare,
 547         .trigger = snd_line6_trigger,
 548         .pointer = snd_line6_playback_pointer,
 549 };
 550
 551 int line6_create_audio_out_urbs(struct snd_line6_pcm *line6pcm)
 552 {
 553         int i;
 554
 555         /* create audio URBs and fill in constant values: */
 556         for (i = 0; i < LINE6_ISO_BUFFERS; ++i) {
 557                 struct urb *urb;
 558
 559                 /* URB for audio out: */
 560                 urb = line6pcm->urb_audio_out[i] =
 561                     usb_alloc_urb(LINE6_ISO_PACKETS, GFP_KERNEL);
 562
 563                 if (urb == NULL) {
 564                         dev_err(line6pcm->line6->ifcdev, "Out of memory\n");
 565                         return -ENOMEM;
 566                 }
 567
 568                 urb->dev = line6pcm->line6->usbdev;
 569                 urb->pipe =
 570                     usb_sndisocpipe(line6pcm->line6->usbdev,
 571                                     line6pcm->ep_audio_write &
 572                                     USB_ENDPOINT_NUMBER_MASK);
 573                 urb->transfer_flags = URB_ISO_ASAP;
 574                 urb->start_frame = -1;
 575                 urb->number_of_packets = LINE6_ISO_PACKETS;
 576                 urb->interval = LINE6_ISO_INTERVAL;
 577                 urb->error_count = 0;
 578                 urb->complete = audio_out_callback;
 579         }
 580
 581         return 0;
 582 }