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 & MASK_CAPTURE)
 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"); /* this is somewhat paranoid */
 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(BIT_PCM_ALSA_PLAYBACK, &line6pcm->flags) &&
 200             !test_bit(BIT_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", len);        /* this is somewhat paranoid */
 222                 } else {
 223                         memcpy(urb_out->transfer_buffer,
 224                                runtime->dma_area +
 225                                line6pcm->pos_out * bytes_per_frame,
 226                                urb_out->transfer_buffer_length);
 227                 }
 228
 229                 line6pcm->pos_out += urb_frames;
 230                 if (line6pcm->pos_out >= runtime->buffer_size)
 231                         line6pcm->pos_out -= runtime->buffer_size;
 232         } else {
 233                 memset(urb_out->transfer_buffer, 0,
 234                        urb_out->transfer_buffer_length);
 235         }
 236
 237         change_volume(urb_out, line6pcm->volume_playback, bytes_per_frame);
 238
 239         if (line6pcm->prev_fbuf != NULL) {
 240 #ifdef CONFIG_LINE6_USB_IMPULSE_RESPONSE
 241                 if (line6pcm->flags & MASK_PCM_IMPULSE) {
 242                         create_impulse_test_signal(line6pcm, urb_out,
 243                                                    bytes_per_frame);
 244                         if (line6pcm->flags & MASK_PCM_ALSA_CAPTURE) {
 245                                 line6_capture_copy(line6pcm,
 246                                                    urb_out->transfer_buffer,
 247                                                    urb_out->
 248                                                    transfer_buffer_length);
 249                                 line6_capture_check_period(line6pcm,
 250                                                            urb_out->transfer_buffer_length);
 251                         }
 252                 } else {
 253 #endif
 254                         if (!
 255                             (line6pcm->line6->
 256                              properties->capabilities & LINE6_BIT_HWMON)
 257 && (line6pcm->flags & MASK_PLAYBACK)
 258 && (line6pcm->flags & MASK_CAPTURE))
 259                                 add_monitor_signal(urb_out, line6pcm->prev_fbuf,
 260                                                    line6pcm->volume_monitor,
 261                                                    bytes_per_frame);
 262 #ifdef CONFIG_LINE6_USB_IMPULSE_RESPONSE
 263                 }
 264 #endif
 265         }
 266 #ifdef CONFIG_LINE6_USB_DUMP_PCM
 267         for (i = 0; i < LINE6_ISO_PACKETS; ++i) {
 268                 struct usb_iso_packet_descriptor *fout =
 269                     &urb_out->iso_frame_desc[i];
 270                 line6_write_hexdump(line6pcm->line6, 'P',
 271                                     urb_out->transfer_buffer + fout->offset,
 272                                     fout->length);
 273         }
 274 #endif
 275
 276         ret = usb_submit_urb(urb_out, GFP_ATOMIC);
 277
 278         if (ret == 0)
 279                 set_bit(index, &line6pcm->active_urb_out);
 280         else
 281                 dev_err(line6pcm->line6->ifcdev,
 282                         "URB out #%d submission failed (%d)\n", index, ret);
 283
 284         spin_unlock_irqrestore(&line6pcm->lock_audio_out, flags);
 285         return 0;
 286 }
 287
 288 /*
 289         Submit all currently available playback URBs.
 290 */
 291 int line6_submit_audio_out_all_urbs(struct snd_line6_pcm *line6pcm)
 292 {
 293         int ret, i;
 294
 295         for (i = 0; i < LINE6_ISO_BUFFERS; ++i) {
 296                 ret = submit_audio_out_urb(line6pcm);
 297                 if (ret < 0)
 298                         return ret;
 299         }
 300
 301         return 0;
 302 }
 303
 304 /*
 305         Unlink all currently active playback URBs.
 306 */
 307 void line6_unlink_audio_out_urbs(struct snd_line6_pcm *line6pcm)
 308 {
 309         unsigned int i;
 310
 311         for (i = LINE6_ISO_BUFFERS; i--;) {
 312                 if (test_bit(i, &line6pcm->active_urb_out)) {
 313                         if (!test_and_set_bit(i, &line6pcm->unlink_urb_out)) {
 314                                 struct urb *u = line6pcm->urb_audio_out[i];
 315                                 usb_unlink_urb(u);
 316                         }
 317                 }
 318         }
 319 }
 320
 321 /*
 322         Wait until unlinking of all currently active playback URBs has been finished.
 323 */
 324 static void wait_clear_audio_out_urbs(struct snd_line6_pcm *line6pcm)
 325 {
 326         int timeout = HZ;
 327         unsigned int i;
 328         int alive;
 329
 330         do {
 331                 alive = 0;
 332                 for (i = LINE6_ISO_BUFFERS; i--;) {
 333                         if (test_bit(i, &line6pcm->active_urb_out))
 334                                 alive++;
 335                 }
 336                 if (!alive)
 337                         break;
 338                 set_current_state(TASK_UNINTERRUPTIBLE);
 339                 schedule_timeout(1);
 340         } while (--timeout > 0);
 341         if (alive)
 342                 snd_printk(KERN_ERR "timeout: still %d active urbs..\n", alive);
 343 }
 344
 345 /*
 346         Unlink all currently active playback URBs, and wait for finishing.
 347 */
 348 void line6_unlink_wait_clear_audio_out_urbs(struct snd_line6_pcm *line6pcm)
 349 {
 350         line6_unlink_audio_out_urbs(line6pcm);
 351         wait_clear_audio_out_urbs(line6pcm);
 352 }
 353
 354 int line6_alloc_playback_buffer(struct snd_line6_pcm *line6pcm)
 355 {
 356         /* We may be invoked multiple times in a row so allocate once only */
 357         if (line6pcm->buffer_out)
 358                 return 0;
 359
 360         line6pcm->buffer_out =
 361                 kmalloc(LINE6_ISO_BUFFERS * LINE6_ISO_PACKETS *
 362                         line6pcm->max_packet_size, GFP_KERNEL);
 363
 364         if (!line6pcm->buffer_out) {
 365                 dev_err(line6pcm->line6->ifcdev,
 366                         "cannot malloc playback buffer\n");
 367                 return -ENOMEM;
 368         }
 369
 370         return 0;
 371 }
 372
 373 void line6_free_playback_buffer(struct snd_line6_pcm *line6pcm)
 374 {
 375         kfree(line6pcm->buffer_out);
 376         line6pcm->buffer_out = NULL;
 377 }
 378
 379 /*
 380         Callback for completed playback URB.
 381 */
 382 static void audio_out_callback(struct urb *urb)
 383 {
 384         int i, index, length = 0, shutdown = 0;
 385         unsigned long flags;
 386
 387         struct snd_line6_pcm *line6pcm = (struct snd_line6_pcm *)urb->context;
 388         struct snd_pcm_substream *substream =
 389             get_substream(line6pcm, SNDRV_PCM_STREAM_PLAYBACK);
 390
 391 #if USE_CLEAR_BUFFER_WORKAROUND
 392         memset(urb->transfer_buffer, 0, urb->transfer_buffer_length);
 393 #endif
 394
 395         line6pcm->last_frame_out = urb->start_frame;
 396
 397         /* find index of URB */
 398         for (index = LINE6_ISO_BUFFERS; index--;)
 399                 if (urb == line6pcm->urb_audio_out[index])
 400                         break;
 401
 402         if (index < 0)
 403                 return;         /* URB has been unlinked asynchronously */
 404
 405         for (i = LINE6_ISO_PACKETS; i--;)
 406                 length += urb->iso_frame_desc[i].length;
 407
 408         spin_lock_irqsave(&line6pcm->lock_audio_out, flags);
 409
 410         if (test_bit(BIT_PCM_ALSA_PLAYBACK, &line6pcm->flags)) {
 411                 struct snd_pcm_runtime *runtime = substream->runtime;
 412                 line6pcm->pos_out_done +=
 413                     length / line6pcm->properties->bytes_per_frame;
 414
 415                 if (line6pcm->pos_out_done >= runtime->buffer_size)
 416                         line6pcm->pos_out_done -= runtime->buffer_size;
 417         }
 418
 419         clear_bit(index, &line6pcm->active_urb_out);
 420
 421         for (i = LINE6_ISO_PACKETS; i--;)
 422                 if (urb->iso_frame_desc[i].status == -EXDEV) {
 423                         shutdown = 1;
 424                         break;
 425                 }
 426
 427         if (test_and_clear_bit(index, &line6pcm->unlink_urb_out))
 428                 shutdown = 1;
 429
 430         spin_unlock_irqrestore(&line6pcm->lock_audio_out, flags);
 431
 432         if (!shutdown) {
 433                 submit_audio_out_urb(line6pcm);
 434
 435                 if (test_bit(BIT_PCM_ALSA_PLAYBACK, &line6pcm->flags)) {
 436                         line6pcm->bytes_out += length;
 437                         if (line6pcm->bytes_out >= line6pcm->period_out) {
 438                                 line6pcm->bytes_out %= line6pcm->period_out;
 439                                 snd_pcm_period_elapsed(substream);
 440                         }
 441                 }
 442         }
 443 }
 444
 445 /* open playback callback */
 446 static int snd_line6_playback_open(struct snd_pcm_substream *substream)
 447 {
 448         int err;
 449         struct snd_pcm_runtime *runtime = substream->runtime;
 450         struct snd_line6_pcm *line6pcm = snd_pcm_substream_chip(substream);
 451
 452         err = snd_pcm_hw_constraint_ratdens(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
 453                                             (&line6pcm->
 454                                              properties->snd_line6_rates));
 455         if (err < 0)
 456                 return err;
 457
 458         runtime->hw = line6pcm->properties->snd_line6_playback_hw;
 459         return 0;
 460 }
 461
 462 /* close playback callback */
 463 static int snd_line6_playback_close(struct snd_pcm_substream *substream)
 464 {
 465         return 0;
 466 }
 467
 468 /* hw_params playback callback */
 469 static int snd_line6_playback_hw_params(struct snd_pcm_substream *substream,
 470                                         struct snd_pcm_hw_params *hw_params)
 471 {
 472         int ret;
 473         struct snd_line6_pcm *line6pcm = snd_pcm_substream_chip(substream);
 474
 475         /* -- Florian Demski [FD] */
 476         /* don't ask me why, but this fixes the bug on my machine */
 477         if (line6pcm == NULL) {
 478                 if (substream->pcm == NULL)
 479                         return -ENOMEM;
 480                 if (substream->pcm->private_data == NULL)
 481                         return -ENOMEM;
 482                 substream->private_data = substream->pcm->private_data;
 483                 line6pcm = snd_pcm_substream_chip(substream);
 484         }
 485         /* -- [FD] end */
 486
 487         if ((line6pcm->flags & MASK_PLAYBACK) == 0) {
 488                 ret = line6_alloc_playback_buffer(line6pcm);
 489
 490                 if (ret < 0)
 491                         return ret;
 492         }
 493
 494         ret = snd_pcm_lib_malloc_pages(substream,
 495                                        params_buffer_bytes(hw_params));
 496         if (ret < 0)
 497                 return ret;
 498
 499         line6pcm->period_out = params_period_bytes(hw_params);
 500         return 0;
 501 }
 502
 503 /* hw_free playback callback */
 504 static int snd_line6_playback_hw_free(struct snd_pcm_substream *substream)
 505 {
 506         struct snd_line6_pcm *line6pcm = snd_pcm_substream_chip(substream);
 507
 508         if ((line6pcm->flags & MASK_PLAYBACK) == 0) {
 509                 line6_unlink_wait_clear_audio_out_urbs(line6pcm);
 510                 line6_free_playback_buffer(line6pcm);
 511         }
 512
 513         return snd_pcm_lib_free_pages(substream);
 514 }
 515
 516 /* trigger playback callback */
 517 int snd_line6_playback_trigger(struct snd_line6_pcm *line6pcm, int cmd)
 518 {
 519         int err;
 520
 521         switch (cmd) {
 522         case SNDRV_PCM_TRIGGER_START:
 523 #ifdef CONFIG_PM
 524         case SNDRV_PCM_TRIGGER_RESUME:
 525 #endif
 526                 err = line6_pcm_start(line6pcm, MASK_PCM_ALSA_PLAYBACK);
 527
 528                 if (err < 0)
 529                         return err;
 530
 531                 break;
 532
 533         case SNDRV_PCM_TRIGGER_STOP:
 534 #ifdef CONFIG_PM
 535         case SNDRV_PCM_TRIGGER_SUSPEND:
 536 #endif
 537                 err = line6_pcm_stop(line6pcm, MASK_PCM_ALSA_PLAYBACK);
 538
 539                 if (err < 0)
 540                         return err;
 541
 542                 break;
 543
 544         case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
 545                 set_bit(BIT_PAUSE_PLAYBACK, &line6pcm->flags);
 546                 break;
 547
 548         case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
 549                 clear_bit(BIT_PAUSE_PLAYBACK, &line6pcm->flags);
 550                 break;
 551
 552         default:
 553                 return -EINVAL;
 554         }
 555
 556         return 0;
 557 }
 558
 559 /* playback pointer callback */
 560 static snd_pcm_uframes_t
 561 snd_line6_playback_pointer(struct snd_pcm_substream *substream)
 562 {
 563         struct snd_line6_pcm *line6pcm = snd_pcm_substream_chip(substream);
 564         return line6pcm->pos_out_done;
 565 }
 566
 567 /* playback operators */
 568 struct snd_pcm_ops snd_line6_playback_ops = {
 569         .open = snd_line6_playback_open,
 570         .close = snd_line6_playback_close,
 571         .ioctl = snd_pcm_lib_ioctl,
 572         .hw_params = snd_line6_playback_hw_params,
 573         .hw_free = snd_line6_playback_hw_free,
 574         .prepare = snd_line6_prepare,
 575         .trigger = snd_line6_trigger,
 576         .pointer = snd_line6_playback_pointer,
 577 };
 578
 579 int line6_create_audio_out_urbs(struct snd_line6_pcm *line6pcm)
 580 {
 581         int i;
 582
 583         /* create audio URBs and fill in constant values: */
 584         for (i = 0; i < LINE6_ISO_BUFFERS; ++i) {
 585                 struct urb *urb;
 586
 587                 /* URB for audio out: */
 588                 urb = line6pcm->urb_audio_out[i] =
 589                     usb_alloc_urb(LINE6_ISO_PACKETS, GFP_KERNEL);
 590
 591                 if (urb == NULL) {
 592                         dev_err(line6pcm->line6->ifcdev, "Out of memory\n");
 593                         return -ENOMEM;
 594                 }
 595
 596                 urb->dev = line6pcm->line6->usbdev;
 597                 urb->pipe =
 598                     usb_sndisocpipe(line6pcm->line6->usbdev,
 599                                     line6pcm->ep_audio_write &
 600                                     USB_ENDPOINT_NUMBER_MASK);
 601                 urb->transfer_flags = URB_ISO_ASAP;
 602                 urb->start_frame = -1;
 603                 urb->number_of_packets = LINE6_ISO_PACKETS;
 604                 urb->interval = LINE6_ISO_INTERVAL;
 605                 urb->error_count = 0;
 606                 urb->complete = audio_out_callback;
 607         }
 608
 609         return 0;
 610 }