drivers/staging/line6/playback.c

   1 /*
   2  * Line6 Linux USB driver - 0.8.0
   3  *
   4  * Copyright (C) 2004-2009 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 "driver.h"
  13
  14 #include <sound/core.h>
  15 #include <sound/pcm.h>
  16 #include <sound/pcm_params.h>
  17
  18 #include "audio.h"
  19 #include "pcm.h"
  20 #include "pod.h"
  21 #include "playback.h"
  22
  23 /*
  24         Software stereo volume control.
  25 */
  26 static void change_volume(struct urb *urb_out, int volume[],
  27                           int bytes_per_frame)
  28 {
  29         int chn = 0;
  30
  31         if (volume[0] == 256 && volume[1] == 256)
  32                 return;         /* maximum volume - no change */
  33
  34         if (bytes_per_frame == 4) {
  35                 short *p, *buf_end;
  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                 p = (unsigned char *)urb_out->transfer_buffer;
  46                 buf_end = p + urb_out->transfer_buffer_length;
  47
  48                 for (; p < buf_end; p += 3) {
  49                         int val;
  50                         val = p[0] + (p[1] << 8) + ((signed char)p[2] << 16);
  51                         val = (val * volume[chn & 1]) >> 8;
  52                         p[0] = val;
  53                         p[1] = val >> 8;
  54                         p[2] = val >> 16;
  55                         ++chn;
  56                 }
  57         }
  58 }
  59
  60 /*
  61         Find a free URB, prepare audio data, and submit URB.
  62 */
  63 static int submit_audio_out_urb(struct snd_pcm_substream *substream)
  64 {
  65         int index;
  66         unsigned long flags;
  67         int i, urb_size, urb_frames;
  68         struct snd_line6_pcm *line6pcm = snd_pcm_substream_chip(substream);
  69         const int bytes_per_frame = line6pcm->properties->bytes_per_frame;
  70         const int frame_increment =
  71             line6pcm->properties->snd_line6_rates.rats[0].num_min;
  72         const int frame_factor =
  73             line6pcm->properties->snd_line6_rates.rats[0].den *
  74             (USB_INTERVALS_PER_SECOND / LINE6_ISO_INTERVAL);
  75         struct snd_pcm_runtime *runtime = substream->runtime;
  76         struct urb *urb_out;
  77
  78         spin_lock_irqsave(&line6pcm->lock_audio_out, flags);
  79         index =
  80             find_first_zero_bit(&line6pcm->active_urb_out, LINE6_ISO_BUFFERS);
  81
  82         if (index < 0 || index >= LINE6_ISO_BUFFERS) {
  83                 spin_unlock_irqrestore(&line6pcm->lock_audio_out, flags);
  84                 dev_err(s2m(substream), "no free URB found\n");
  85                 return -EINVAL;
  86         }
  87
  88         urb_out = line6pcm->urb_audio_out[index];
  89         urb_size = 0;
  90
  91         for (i = 0; i < LINE6_ISO_PACKETS; ++i) {
  92                 /* compute frame size for given sampling rate */
  93                 int n, fs;
  94                 struct usb_iso_packet_descriptor *fout =
  95                     &urb_out->iso_frame_desc[i];
  96                 line6pcm->count_out += frame_increment;
  97                 n = line6pcm->count_out / frame_factor;
  98                 line6pcm->count_out -= n * frame_factor;
  99                 fs = n * bytes_per_frame;
 100                 fout->offset = urb_size;
 101                 fout->length = fs;
 102                 urb_size += fs;
 103         }
 104
 105         urb_frames = urb_size / bytes_per_frame;
 106
 107         if (test_bit(BIT_PAUSE_PLAYBACK, &line6pcm->flags)) {
 108                 urb_out->transfer_buffer = line6pcm->wrap_out;
 109                 memset(line6pcm->wrap_out, 0, urb_size);
 110         } else {
 111                 if (line6pcm->pos_out + urb_frames > runtime->buffer_size) {
 112                         /*
 113                            The transferred area goes over buffer boundary,
 114                            copy the data to the temp buffer.
 115                          */
 116                         int len;
 117                         len = runtime->buffer_size - line6pcm->pos_out;
 118                         urb_out->transfer_buffer = line6pcm->wrap_out;
 119
 120                         if (len > 0) {
 121                                 memcpy(line6pcm->wrap_out,
 122                                        runtime->dma_area +
 123                                        line6pcm->pos_out * bytes_per_frame,
 124                                        len * bytes_per_frame);
 125                                 memcpy(line6pcm->wrap_out +
 126                                        len * bytes_per_frame, runtime->dma_area,
 127                                        (urb_frames - len) * bytes_per_frame);
 128                         } else {
 129                                 /* this is somewhat paranoid */
 130                                 dev_err(s2m(substream),
 131                                         "driver bug: len = %d\n", len);
 132                         }
 133                 } else {
 134                         /* set the buffer pointer */
 135                         urb_out->transfer_buffer =
 136                             runtime->dma_area +
 137                             line6pcm->pos_out * bytes_per_frame;
 138                 }
 139         }
 140
 141         if ((line6pcm->pos_out += urb_frames) >= runtime->buffer_size)
 142                 line6pcm->pos_out -= runtime->buffer_size;
 143
 144         urb_out->transfer_buffer_length = urb_size;
 145         urb_out->context = substream;
 146         change_volume(urb_out, line6pcm->volume, bytes_per_frame);
 147
 148 #if DO_DUMP_PCM_SEND
 149         for (i = 0; i < LINE6_ISO_PACKETS; ++i) {
 150                 struct usb_iso_packet_descriptor *fout =
 151                     &urb_out->iso_frame_desc[i];
 152                 line6_write_hexdump(line6pcm->line6, 'P',
 153                                     urb_out->transfer_buffer + fout->offset,
 154                                     fout->length);
 155         }
 156 #endif
 157
 158         if (usb_submit_urb(urb_out, GFP_ATOMIC) == 0)
 159                 set_bit(index, &line6pcm->active_urb_out);
 160         else
 161                 dev_err(s2m(substream), "URB out #%d submission failed\n",
 162                         index);
 163
 164         spin_unlock_irqrestore(&line6pcm->lock_audio_out, flags);
 165         return 0;
 166 }
 167
 168 /*
 169         Submit all currently available playback URBs.
 170 */
 171 static int submit_audio_out_all_urbs(struct snd_pcm_substream *substream)
 172 {
 173         int ret, i;
 174
 175         for (i = 0; i < LINE6_ISO_BUFFERS; ++i) {
 176                 ret = submit_audio_out_urb(substream);
 177                 if (ret < 0)
 178                         return ret;
 179         }
 180
 181         return 0;
 182 }
 183
 184 /*
 185         Unlink all currently active playback URBs.
 186 */
 187 static void unlink_audio_out_urbs(struct snd_line6_pcm *line6pcm)
 188 {
 189         unsigned int i;
 190
 191         for (i = LINE6_ISO_BUFFERS; i--;) {
 192                 if (test_bit(i, &line6pcm->active_urb_out)) {
 193                         if (!test_and_set_bit(i, &line6pcm->unlink_urb_out)) {
 194                                 struct urb *u = line6pcm->urb_audio_out[i];
 195                                 usb_unlink_urb(u);
 196                         }
 197                 }
 198         }
 199 }
 200
 201 /*
 202    Wait until unlinking of all currently active playback URBs has been finished.
 203 */
 204 static void wait_clear_audio_out_urbs(struct snd_line6_pcm *line6pcm)
 205 {
 206         int timeout = HZ;
 207         unsigned int i;
 208         int alive;
 209
 210         do {
 211                 alive = 0;
 212                 for (i = LINE6_ISO_BUFFERS; i--;) {
 213                         if (test_bit(i, &line6pcm->active_urb_out))
 214                                 alive++;
 215                 }
 216                 if (!alive)
 217                         break;
 218                 set_current_state(TASK_UNINTERRUPTIBLE);
 219                 schedule_timeout(1);
 220         } while (--timeout > 0);
 221         if (alive)
 222                 snd_printk(KERN_ERR "timeout: still %d active urbs..\n", alive);
 223
 224         line6pcm->active_urb_out = 0;
 225         line6pcm->unlink_urb_out = 0;
 226 }
 227
 228 /*
 229         Unlink all currently active playback URBs, and wait for finishing.
 230 */
 231 void unlink_wait_clear_audio_out_urbs(struct snd_line6_pcm *line6pcm)
 232 {
 233         unlink_audio_out_urbs(line6pcm);
 234         wait_clear_audio_out_urbs(line6pcm);
 235 }
 236
 237 /*
 238         Callback for completed playback URB.
 239 */
 240 static void audio_out_callback(struct urb *urb)
 241 {
 242         int i, index, length = 0, shutdown = 0;
 243         unsigned long flags;
 244
 245         struct snd_pcm_substream *substream =
 246             (struct snd_pcm_substream *)urb->context;
 247         struct snd_line6_pcm *line6pcm = snd_pcm_substream_chip(substream);
 248         struct snd_pcm_runtime *runtime = substream->runtime;
 249
 250         /* find index of URB */
 251         for (index = LINE6_ISO_BUFFERS; index--;)
 252                 if (urb == line6pcm->urb_audio_out[index])
 253                         break;
 254
 255         if (index < 0)
 256                 return;         /* URB has been unlinked asynchronously */
 257
 258         for (i = LINE6_ISO_PACKETS; i--;)
 259                 length += urb->iso_frame_desc[i].length;
 260
 261         spin_lock_irqsave(&line6pcm->lock_audio_out, flags);
 262         line6pcm->pos_out_done +=
 263             length / line6pcm->properties->bytes_per_frame;
 264
 265         if (line6pcm->pos_out_done >= runtime->buffer_size)
 266                 line6pcm->pos_out_done -= runtime->buffer_size;
 267
 268         clear_bit(index, &line6pcm->active_urb_out);
 269
 270         for (i = LINE6_ISO_PACKETS; i--;)
 271                 if (urb->iso_frame_desc[i].status == -ESHUTDOWN) {
 272                         shutdown = 1;
 273                         break;
 274                 }
 275
 276         if (test_bit(index, &line6pcm->unlink_urb_out))
 277                 shutdown = 1;
 278
 279         spin_unlock_irqrestore(&line6pcm->lock_audio_out, flags);
 280
 281         if (!shutdown) {
 282                 submit_audio_out_urb(substream);
 283
 284                 if ((line6pcm->bytes_out += length) >= line6pcm->period_out) {
 285                         line6pcm->bytes_out -= line6pcm->period_out;
 286                         snd_pcm_period_elapsed(substream);
 287                 }
 288         }
 289 }
 290
 291 /* open playback callback */
 292 static int snd_line6_playback_open(struct snd_pcm_substream *substream)
 293 {
 294         int err;
 295         struct snd_pcm_runtime *runtime = substream->runtime;
 296         struct snd_line6_pcm *line6pcm = snd_pcm_substream_chip(substream);
 297
 298         err = snd_pcm_hw_constraint_ratdens(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
 299                                             (&line6pcm->properties->
 300                                              snd_line6_rates));
 301         if (err < 0)
 302                 return err;
 303
 304         runtime->hw = line6pcm->properties->snd_line6_playback_hw;
 305         return 0;
 306 }
 307
 308 /* close playback callback */
 309 static int snd_line6_playback_close(struct snd_pcm_substream *substream)
 310 {
 311         return 0;
 312 }
 313
 314 /* hw_params playback callback */
 315 static int snd_line6_playback_hw_params(struct snd_pcm_substream *substream,
 316                                         struct snd_pcm_hw_params *hw_params)
 317 {
 318         int ret;
 319         struct snd_line6_pcm *line6pcm = snd_pcm_substream_chip(substream);
 320
 321         /* -- Florian Demski [FD] */
 322         /* don't ask me why, but this fixes the bug on my machine */
 323         if (line6pcm == NULL) {
 324                 if (substream->pcm == NULL)
 325                         return -ENOMEM;
 326                 if (substream->pcm->private_data == NULL)
 327                         return -ENOMEM;
 328                 substream->private_data = substream->pcm->private_data;
 329                 line6pcm = snd_pcm_substream_chip(substream);
 330         }
 331         /* -- [FD] end */
 332
 333         ret = snd_pcm_lib_malloc_pages(substream,
 334                                        params_buffer_bytes(hw_params));
 335         if (ret < 0)
 336                 return ret;
 337
 338         line6pcm->period_out = params_period_bytes(hw_params);
 339         line6pcm->wrap_out = kmalloc(2 * LINE6_ISO_PACKET_SIZE_MAX, GFP_KERNEL);
 340
 341         if (!line6pcm->wrap_out) {
 342                 dev_err(s2m(substream), "cannot malloc wrap_out\n");
 343                 return -ENOMEM;
 344         }
 345
 346         return 0;
 347 }
 348
 349 /* hw_free playback callback */
 350 static int snd_line6_playback_hw_free(struct snd_pcm_substream *substream)
 351 {
 352         struct snd_line6_pcm *line6pcm = snd_pcm_substream_chip(substream);
 353         unlink_wait_clear_audio_out_urbs(line6pcm);
 354
 355         kfree(line6pcm->wrap_out);
 356         line6pcm->wrap_out = NULL;
 357
 358         return snd_pcm_lib_free_pages(substream);
 359 }
 360
 361 /* trigger playback callback */
 362 int snd_line6_playback_trigger(struct snd_pcm_substream *substream, int cmd)
 363 {
 364         struct snd_line6_pcm *line6pcm = snd_pcm_substream_chip(substream);
 365         int err;
 366         line6pcm->count_out = 0;
 367
 368         switch (cmd) {
 369         case SNDRV_PCM_TRIGGER_START:
 370                 if (!test_and_set_bit(BIT_RUNNING_PLAYBACK, &line6pcm->flags)) {
 371                         err = submit_audio_out_all_urbs(substream);
 372
 373                         if (err < 0) {
 374                                 clear_bit(BIT_RUNNING_PLAYBACK,
 375                                           &line6pcm->flags);
 376                                 return err;
 377                         }
 378                 }
 379
 380                 break;
 381
 382         case SNDRV_PCM_TRIGGER_STOP:
 383                 if (test_and_clear_bit(BIT_RUNNING_PLAYBACK, &line6pcm->flags))
 384                         unlink_audio_out_urbs(line6pcm);
 385
 386                 break;
 387
 388         case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
 389                 set_bit(BIT_PAUSE_PLAYBACK, &line6pcm->flags);
 390                 break;
 391
 392         case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
 393                 clear_bit(BIT_PAUSE_PLAYBACK, &line6pcm->flags);
 394                 break;
 395
 396         default:
 397                 return -EINVAL;
 398         }
 399
 400         return 0;
 401 }
 402
 403 /* playback pointer callback */
 404 static snd_pcm_uframes_t
 405 snd_line6_playback_pointer(struct snd_pcm_substream *substream)
 406 {
 407         struct snd_line6_pcm *line6pcm = snd_pcm_substream_chip(substream);
 408         return line6pcm->pos_out_done;
 409 }
 410
 411 /* playback operators */
 412 struct snd_pcm_ops snd_line6_playback_ops = {
 413         .open = snd_line6_playback_open,
 414         .close = snd_line6_playback_close,
 415         .ioctl = snd_pcm_lib_ioctl,
 416         .hw_params = snd_line6_playback_hw_params,
 417         .hw_free = snd_line6_playback_hw_free,
 418         .prepare = snd_line6_prepare,
 419         .trigger = snd_line6_trigger,
 420         .pointer = snd_line6_playback_pointer,
 421 };
 422
 423 int create_audio_out_urbs(struct snd_line6_pcm *line6pcm)
 424 {
 425         int i;
 426
 427         /* create audio URBs and fill in constant values: */
 428         for (i = 0; i < LINE6_ISO_BUFFERS; ++i) {
 429                 struct urb *urb;
 430
 431                 /* URB for audio out: */
 432                 urb = line6pcm->urb_audio_out[i] =
 433                     usb_alloc_urb(LINE6_ISO_PACKETS, GFP_KERNEL);
 434
 435                 if (urb == NULL) {
 436                         dev_err(line6pcm->line6->ifcdev, "Out of memory\n");
 437                         return -ENOMEM;
 438                 }
 439
 440                 urb->dev = line6pcm->line6->usbdev;
 441                 urb->pipe =
 442                     usb_sndisocpipe(line6pcm->line6->usbdev,
 443                                     line6pcm->
 444                                     ep_audio_write & USB_ENDPOINT_NUMBER_MASK);
 445                 urb->transfer_flags = URB_ISO_ASAP;
 446                 urb->start_frame = -1;
 447                 urb->number_of_packets = LINE6_ISO_PACKETS;
 448                 urb->interval = LINE6_ISO_INTERVAL;
 449                 urb->error_count = 0;
 450                 urb->complete = audio_out_callback;
 451         }
 452
 453         return 0;
 454 }