sound/usb/line6/pcm.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 <linux/export.h>
  14 #include <sound/core.h>
  15 #include <sound/control.h>
  16 #include <sound/pcm.h>
  17 #include <sound/pcm_params.h>
  18
  19 #include "capture.h"
  20 #include "driver.h"
  21 #include "playback.h"
  22
  23 /* impulse response volume controls */
  24 static int snd_line6_impulse_volume_info(struct snd_kcontrol *kcontrol,
  25                                          struct snd_ctl_elem_info *uinfo)
  26 {
  27         uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
  28         uinfo->count = 1;
  29         uinfo->value.integer.min = 0;
  30         uinfo->value.integer.max = 255;
  31         return 0;
  32 }
  33
  34 static int snd_line6_impulse_volume_get(struct snd_kcontrol *kcontrol,
  35                                         struct snd_ctl_elem_value *ucontrol)
  36 {
  37         struct snd_line6_pcm *line6pcm = snd_kcontrol_chip(kcontrol);
  38
  39         ucontrol->value.integer.value[0] = line6pcm->impulse_volume;
  40         return 0;
  41 }
  42
  43 static int snd_line6_impulse_volume_put(struct snd_kcontrol *kcontrol,
  44                                         struct snd_ctl_elem_value *ucontrol)
  45 {
  46         struct snd_line6_pcm *line6pcm = snd_kcontrol_chip(kcontrol);
  47         int value = ucontrol->value.integer.value[0];
  48
  49         if (line6pcm->impulse_volume == value)
  50                 return 0;
  51
  52         line6pcm->impulse_volume = value;
  53         if (value > 0)
  54                 line6_pcm_acquire(line6pcm, LINE6_BITS_PCM_IMPULSE);
  55         else
  56                 line6_pcm_release(line6pcm, LINE6_BITS_PCM_IMPULSE);
  57         return 1;
  58 }
  59
  60 /* impulse response period controls */
  61 static int snd_line6_impulse_period_info(struct snd_kcontrol *kcontrol,
  62                                          struct snd_ctl_elem_info *uinfo)
  63 {
  64         uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
  65         uinfo->count = 1;
  66         uinfo->value.integer.min = 0;
  67         uinfo->value.integer.max = 2000;
  68         return 0;
  69 }
  70
  71 static int snd_line6_impulse_period_get(struct snd_kcontrol *kcontrol,
  72                                         struct snd_ctl_elem_value *ucontrol)
  73 {
  74         struct snd_line6_pcm *line6pcm = snd_kcontrol_chip(kcontrol);
  75
  76         ucontrol->value.integer.value[0] = line6pcm->impulse_period;
  77         return 0;
  78 }
  79
  80 static int snd_line6_impulse_period_put(struct snd_kcontrol *kcontrol,
  81                                         struct snd_ctl_elem_value *ucontrol)
  82 {
  83         struct snd_line6_pcm *line6pcm = snd_kcontrol_chip(kcontrol);
  84         int value = ucontrol->value.integer.value[0];
  85
  86         if (line6pcm->impulse_period == value)
  87                 return 0;
  88
  89         line6pcm->impulse_period = value;
  90         return 1;
  91 }
  92
  93 static bool test_flags(unsigned long flags0, unsigned long flags1,
  94                        unsigned long mask)
  95 {
  96         return ((flags0 & mask) == 0) && ((flags1 & mask) != 0);
  97 }
  98
  99 int line6_pcm_acquire(struct snd_line6_pcm *line6pcm, int channels)
 100 {
 101         unsigned long flags_old, flags_new, flags_final;
 102         int err;
 103
 104         do {
 105                 flags_old = ACCESS_ONCE(line6pcm->flags);
 106                 flags_new = flags_old | channels;
 107         } while (cmpxchg(&line6pcm->flags, flags_old, flags_new) != flags_old);
 108
 109         flags_final = 0;
 110
 111         line6pcm->prev_fbuf = NULL;
 112
 113         if (test_flags(flags_old, flags_new, LINE6_BITS_CAPTURE_BUFFER)) {
 114                 /* Invoked multiple times in a row so allocate once only */
 115                 if (!line6pcm->in.buffer) {
 116                         line6pcm->in.buffer =
 117                                 kmalloc(LINE6_ISO_BUFFERS * LINE6_ISO_PACKETS *
 118                                         line6pcm->max_packet_size, GFP_KERNEL);
 119                         if (!line6pcm->in.buffer) {
 120                                 err = -ENOMEM;
 121                                 goto pcm_acquire_error;
 122                         }
 123                 }
 124
 125                 flags_final |= channels & LINE6_BITS_CAPTURE_BUFFER;
 126         }
 127
 128         if (test_flags(flags_old, flags_new, LINE6_BITS_CAPTURE_STREAM)) {
 129                 /*
 130                    Waiting for completion of active URBs in the stop handler is
 131                    a bug, we therefore report an error if capturing is restarted
 132                    too soon.
 133                  */
 134                 if (line6pcm->in.active_urbs || line6pcm->in.unlink_urbs) {
 135                         dev_err(line6pcm->line6->ifcdev, "Device not yet ready\n");
 136                         err = -EBUSY;
 137                         goto pcm_acquire_error;
 138                 }
 139
 140                 line6pcm->in.count = 0;
 141                 line6pcm->prev_fsize = 0;
 142                 err = line6_submit_audio_in_all_urbs(line6pcm);
 143
 144                 if (err < 0)
 145                         goto pcm_acquire_error;
 146
 147                 flags_final |= channels & LINE6_BITS_CAPTURE_STREAM;
 148         }
 149
 150         if (test_flags(flags_old, flags_new, LINE6_BITS_PLAYBACK_BUFFER)) {
 151                 /* Invoked multiple times in a row so allocate once only */
 152                 if (!line6pcm->out.buffer) {
 153                         line6pcm->out.buffer =
 154                                 kmalloc(LINE6_ISO_BUFFERS * LINE6_ISO_PACKETS *
 155                                         line6pcm->max_packet_size, GFP_KERNEL);
 156                         if (!line6pcm->out.buffer) {
 157                                 err = -ENOMEM;
 158                                 goto pcm_acquire_error;
 159                         }
 160                 }
 161
 162                 flags_final |= channels & LINE6_BITS_PLAYBACK_BUFFER;
 163         }
 164
 165         if (test_flags(flags_old, flags_new, LINE6_BITS_PLAYBACK_STREAM)) {
 166                 /*
 167                   See comment above regarding PCM restart.
 168                 */
 169                 if (line6pcm->out.active_urbs || line6pcm->out.unlink_urbs) {
 170                         dev_err(line6pcm->line6->ifcdev, "Device not yet ready\n");
 171                         return -EBUSY;
 172                 }
 173
 174                 line6pcm->out.count = 0;
 175                 err = line6_submit_audio_out_all_urbs(line6pcm);
 176
 177                 if (err < 0)
 178                         goto pcm_acquire_error;
 179
 180                 flags_final |= channels & LINE6_BITS_PLAYBACK_STREAM;
 181         }
 182
 183         return 0;
 184
 185 pcm_acquire_error:
 186         /*
 187            If not all requested resources/streams could be obtained, release
 188            those which were successfully obtained (if any).
 189         */
 190         line6_pcm_release(line6pcm, flags_final);
 191         return err;
 192 }
 193 EXPORT_SYMBOL_GPL(line6_pcm_acquire);
 194
 195 int line6_pcm_release(struct snd_line6_pcm *line6pcm, int channels)
 196 {
 197         unsigned long flags_old, flags_new;
 198
 199         do {
 200                 flags_old = ACCESS_ONCE(line6pcm->flags);
 201                 flags_new = flags_old & ~channels;
 202         } while (cmpxchg(&line6pcm->flags, flags_old, flags_new) != flags_old);
 203
 204         if (test_flags(flags_new, flags_old, LINE6_BITS_CAPTURE_STREAM))
 205                 line6_unlink_audio_in_urbs(line6pcm);
 206
 207         if (test_flags(flags_new, flags_old, LINE6_BITS_CAPTURE_BUFFER)) {
 208                 line6_wait_clear_audio_in_urbs(line6pcm);
 209                 line6_free_capture_buffer(line6pcm);
 210         }
 211
 212         if (test_flags(flags_new, flags_old, LINE6_BITS_PLAYBACK_STREAM))
 213                 line6_unlink_audio_out_urbs(line6pcm);
 214
 215         if (test_flags(flags_new, flags_old, LINE6_BITS_PLAYBACK_BUFFER)) {
 216                 line6_wait_clear_audio_out_urbs(line6pcm);
 217                 line6_free_playback_buffer(line6pcm);
 218         }
 219
 220         return 0;
 221 }
 222 EXPORT_SYMBOL_GPL(line6_pcm_release);
 223
 224 /* trigger callback */
 225 int snd_line6_trigger(struct snd_pcm_substream *substream, int cmd)
 226 {
 227         struct snd_line6_pcm *line6pcm = snd_pcm_substream_chip(substream);
 228         struct snd_pcm_substream *s;
 229         int err = 0;
 230
 231         clear_bit(LINE6_INDEX_PREPARED, &line6pcm->flags);
 232
 233         snd_pcm_group_for_each_entry(s, substream) {
 234                 if (s->pcm->card != substream->pcm->card)
 235                         continue;
 236                 switch (s->stream) {
 237                 case SNDRV_PCM_STREAM_PLAYBACK:
 238                         err = snd_line6_playback_trigger(line6pcm, cmd);
 239                         break;
 240
 241                 case SNDRV_PCM_STREAM_CAPTURE:
 242                         err = snd_line6_capture_trigger(line6pcm, cmd);
 243                         break;
 244
 245                 default:
 246                         dev_err(line6pcm->line6->ifcdev,
 247                                 "Unknown stream direction %d\n", s->stream);
 248                         err = -EINVAL;
 249                         break;
 250                 }
 251                 if (err < 0)
 252                         break;
 253         }
 254
 255         return err;
 256 }
 257
 258 /* control info callback */
 259 static int snd_line6_control_playback_info(struct snd_kcontrol *kcontrol,
 260                                            struct snd_ctl_elem_info *uinfo)
 261 {
 262         uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
 263         uinfo->count = 2;
 264         uinfo->value.integer.min = 0;
 265         uinfo->value.integer.max = 256;
 266         return 0;
 267 }
 268
 269 /* control get callback */
 270 static int snd_line6_control_playback_get(struct snd_kcontrol *kcontrol,
 271                                           struct snd_ctl_elem_value *ucontrol)
 272 {
 273         int i;
 274         struct snd_line6_pcm *line6pcm = snd_kcontrol_chip(kcontrol);
 275
 276         for (i = 0; i < 2; i++)
 277                 ucontrol->value.integer.value[i] = line6pcm->volume_playback[i];
 278
 279         return 0;
 280 }
 281
 282 /* control put callback */
 283 static int snd_line6_control_playback_put(struct snd_kcontrol *kcontrol,
 284                                           struct snd_ctl_elem_value *ucontrol)
 285 {
 286         int i, changed = 0;
 287         struct snd_line6_pcm *line6pcm = snd_kcontrol_chip(kcontrol);
 288
 289         for (i = 0; i < 2; i++)
 290                 if (line6pcm->volume_playback[i] !=
 291                     ucontrol->value.integer.value[i]) {
 292                         line6pcm->volume_playback[i] =
 293                             ucontrol->value.integer.value[i];
 294                         changed = 1;
 295                 }
 296
 297         return changed;
 298 }
 299
 300 /* control definition */
 301 static struct snd_kcontrol_new line6_controls[] = {
 302         {
 303                 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
 304                 .name = "PCM Playback Volume",
 305                 .info = snd_line6_control_playback_info,
 306                 .get = snd_line6_control_playback_get,
 307                 .put = snd_line6_control_playback_put
 308         },
 309         {
 310                 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
 311                 .name = "Impulse Response Volume",
 312                 .info = snd_line6_impulse_volume_info,
 313                 .get = snd_line6_impulse_volume_get,
 314                 .put = snd_line6_impulse_volume_put
 315         },
 316         {
 317                 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
 318                 .name = "Impulse Response Period",
 319                 .info = snd_line6_impulse_period_info,
 320                 .get = snd_line6_impulse_period_get,
 321                 .put = snd_line6_impulse_period_put
 322         },
 323 };
 324
 325 /*
 326         Cleanup the PCM device.
 327 */
 328 static void line6_cleanup_pcm(struct snd_pcm *pcm)
 329 {
 330         int i;
 331         struct snd_line6_pcm *line6pcm = snd_pcm_chip(pcm);
 332
 333         for (i = 0; i < LINE6_ISO_BUFFERS; i++) {
 334                 if (line6pcm->out.urbs[i]) {
 335                         usb_kill_urb(line6pcm->out.urbs[i]);
 336                         usb_free_urb(line6pcm->out.urbs[i]);
 337                 }
 338                 if (line6pcm->in.urbs[i]) {
 339                         usb_kill_urb(line6pcm->in.urbs[i]);
 340                         usb_free_urb(line6pcm->in.urbs[i]);
 341                 }
 342         }
 343         kfree(line6pcm);
 344 }
 345
 346 /* create a PCM device */
 347 static int snd_line6_new_pcm(struct usb_line6 *line6, struct snd_pcm **pcm_ret)
 348 {
 349         struct snd_pcm *pcm;
 350         int err;
 351
 352         err = snd_pcm_new(line6->card, (char *)line6->properties->name,
 353                           0, 1, 1, pcm_ret);
 354         if (err < 0)
 355                 return err;
 356         pcm = *pcm_ret;
 357         strcpy(pcm->name, line6->properties->name);
 358
 359         /* set operators */
 360         snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK,
 361                         &snd_line6_playback_ops);
 362         snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &snd_line6_capture_ops);
 363
 364         /* pre-allocation of buffers */
 365         snd_pcm_lib_preallocate_pages_for_all(pcm, SNDRV_DMA_TYPE_CONTINUOUS,
 366                                               snd_dma_continuous_data
 367                                               (GFP_KERNEL), 64 * 1024,
 368                                               128 * 1024);
 369         return 0;
 370 }
 371
 372 /*
 373         Sync with PCM stream stops.
 374 */
 375 void line6_pcm_disconnect(struct snd_line6_pcm *line6pcm)
 376 {
 377         line6_unlink_wait_clear_audio_out_urbs(line6pcm);
 378         line6_unlink_wait_clear_audio_in_urbs(line6pcm);
 379 }
 380
 381 /*
 382         Create and register the PCM device and mixer entries.
 383         Create URBs for playback and capture.
 384 */
 385 int line6_init_pcm(struct usb_line6 *line6,
 386                    struct line6_pcm_properties *properties)
 387 {
 388         int i, err;
 389         unsigned ep_read = line6->properties->ep_audio_r;
 390         unsigned ep_write = line6->properties->ep_audio_w;
 391         struct snd_pcm *pcm;
 392         struct snd_line6_pcm *line6pcm;
 393
 394         if (!(line6->properties->capabilities & LINE6_CAP_PCM))
 395                 return 0;       /* skip PCM initialization and report success */
 396
 397         err = snd_line6_new_pcm(line6, &pcm);
 398         if (err < 0)
 399                 return err;
 400
 401         line6pcm = kzalloc(sizeof(*line6pcm), GFP_KERNEL);
 402         if (!line6pcm)
 403                 return -ENOMEM;
 404
 405         line6pcm->pcm = pcm;
 406         line6pcm->properties = properties;
 407         line6pcm->volume_playback[0] = line6pcm->volume_playback[1] = 255;
 408         line6pcm->volume_monitor = 255;
 409         line6pcm->line6 = line6;
 410
 411         /* Read and write buffers are sized identically, so choose minimum */
 412         line6pcm->max_packet_size = min(
 413                         usb_maxpacket(line6->usbdev,
 414                                 usb_rcvisocpipe(line6->usbdev, ep_read), 0),
 415                         usb_maxpacket(line6->usbdev,
 416                                 usb_sndisocpipe(line6->usbdev, ep_write), 1));
 417
 418         spin_lock_init(&line6pcm->out.lock);
 419         spin_lock_init(&line6pcm->in.lock);
 420         line6pcm->impulse_period = LINE6_IMPULSE_DEFAULT_PERIOD;
 421
 422         line6->line6pcm = line6pcm;
 423
 424         pcm->private_data = line6pcm;
 425         pcm->private_free = line6_cleanup_pcm;
 426
 427         err = line6_create_audio_out_urbs(line6pcm);
 428         if (err < 0)
 429                 return err;
 430
 431         err = line6_create_audio_in_urbs(line6pcm);
 432         if (err < 0)
 433                 return err;
 434
 435         /* mixer: */
 436         for (i = 0; i < ARRAY_SIZE(line6_controls); i++) {
 437                 err = snd_ctl_add(line6->card,
 438                                   snd_ctl_new1(&line6_controls[i], line6pcm));
 439                 if (err < 0)
 440                         return err;
 441         }
 442
 443         return 0;
 444 }
 445 EXPORT_SYMBOL_GPL(line6_init_pcm);
 446
 447 /* prepare pcm callback */
 448 int snd_line6_prepare(struct snd_pcm_substream *substream)
 449 {
 450         struct snd_line6_pcm *line6pcm = snd_pcm_substream_chip(substream);
 451
 452         switch (substream->stream) {
 453         case SNDRV_PCM_STREAM_PLAYBACK:
 454                 if ((line6pcm->flags & LINE6_BITS_PLAYBACK_STREAM) == 0)
 455                         line6_unlink_wait_clear_audio_out_urbs(line6pcm);
 456
 457                 break;
 458
 459         case SNDRV_PCM_STREAM_CAPTURE:
 460                 if ((line6pcm->flags & LINE6_BITS_CAPTURE_STREAM) == 0)
 461                         line6_unlink_wait_clear_audio_in_urbs(line6pcm);
 462
 463                 break;
 464         }
 465
 466         if (!test_and_set_bit(LINE6_INDEX_PREPARED, &line6pcm->flags)) {
 467                 line6pcm->out.count = 0;
 468                 line6pcm->out.pos = 0;
 469                 line6pcm->out.pos_done = 0;
 470                 line6pcm->out.bytes = 0;
 471                 line6pcm->in.count = 0;
 472                 line6pcm->in.pos_done = 0;
 473                 line6pcm->in.bytes = 0;
 474         }
 475
 476         return 0;
 477 }