sound/usb/line6/playback.c

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