sound/firewire/motu/motu-pcm.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * motu-pcm.c - a part of driver for MOTU FireWire series
   4  *
   5  * Copyright (c) 2015-2017 Takashi Sakamoto <o-takashi@sakamocchi.jp>
   6  */
   7
   8 #include <sound/pcm_params.h>
   9 #include "motu.h"
  10
  11 static int motu_rate_constraint(struct snd_pcm_hw_params *params,
  12                                 struct snd_pcm_hw_rule *rule)
  13 {
  14         struct snd_motu_packet_format *formats = rule->private;
  15
  16         const struct snd_interval *c =
  17                 hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_CHANNELS);
  18         struct snd_interval *r =
  19                 hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
  20         struct snd_interval rates = {
  21                 .min = UINT_MAX, .max = 0, .integer = 1
  22         };
  23         unsigned int i, pcm_channels, rate, mode;
  24
  25         for (i = 0; i < ARRAY_SIZE(snd_motu_clock_rates); ++i) {
  26                 rate = snd_motu_clock_rates[i];
  27                 mode = i / 2;
  28
  29                 pcm_channels = formats->fixed_part_pcm_chunks[mode] +
  30                                formats->differed_part_pcm_chunks[mode];
  31                 if (!snd_interval_test(c, pcm_channels))
  32                         continue;
  33
  34                 rates.min = min(rates.min, rate);
  35                 rates.max = max(rates.max, rate);
  36         }
  37
  38         return snd_interval_refine(r, &rates);
  39 }
  40
  41 static int motu_channels_constraint(struct snd_pcm_hw_params *params,
  42                                     struct snd_pcm_hw_rule *rule)
  43 {
  44         struct snd_motu_packet_format *formats = rule->private;
  45
  46         const struct snd_interval *r =
  47                 hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_RATE);
  48         struct snd_interval *c =
  49                 hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
  50         struct snd_interval channels = {
  51                 .min = UINT_MAX, .max = 0, .integer = 1
  52         };
  53         unsigned int i, pcm_channels, rate, mode;
  54
  55         for (i = 0; i < ARRAY_SIZE(snd_motu_clock_rates); ++i) {
  56                 rate = snd_motu_clock_rates[i];
  57                 mode = i / 2;
  58
  59                 if (!snd_interval_test(r, rate))
  60                         continue;
  61
  62                 pcm_channels = formats->fixed_part_pcm_chunks[mode] +
  63                                formats->differed_part_pcm_chunks[mode];
  64                 channels.min = min(channels.min, pcm_channels);
  65                 channels.max = max(channels.max, pcm_channels);
  66         }
  67
  68         return snd_interval_refine(c, &channels);
  69 }
  70
  71 static void limit_channels_and_rates(struct snd_motu *motu,
  72                                      struct snd_pcm_runtime *runtime,
  73                                      struct snd_motu_packet_format *formats)
  74 {
  75         struct snd_pcm_hardware *hw = &runtime->hw;
  76         unsigned int i, pcm_channels, rate, mode;
  77
  78         hw->channels_min = UINT_MAX;
  79         hw->channels_max = 0;
  80
  81         for (i = 0; i < ARRAY_SIZE(snd_motu_clock_rates); ++i) {
  82                 rate = snd_motu_clock_rates[i];
  83                 mode = i / 2;
  84
  85                 pcm_channels = formats->fixed_part_pcm_chunks[mode] +
  86                                formats->differed_part_pcm_chunks[mode];
  87                 if (pcm_channels == 0)
  88                         continue;
  89
  90                 hw->rates |= snd_pcm_rate_to_rate_bit(rate);
  91                 hw->channels_min = min(hw->channels_min, pcm_channels);
  92                 hw->channels_max = max(hw->channels_max, pcm_channels);
  93         }
  94
  95         snd_pcm_limit_hw_rates(runtime);
  96 }
  97
  98 static int init_hw_info(struct snd_motu *motu,
  99                         struct snd_pcm_substream *substream)
 100 {
 101         struct snd_pcm_runtime *runtime = substream->runtime;
 102         struct snd_pcm_hardware *hw = &runtime->hw;
 103         struct amdtp_stream *stream;
 104         struct snd_motu_packet_format *formats;
 105         int err;
 106
 107         if (substream->stream == SNDRV_PCM_STREAM_CAPTURE) {
 108                 hw->formats = SNDRV_PCM_FMTBIT_S32;
 109                 stream = &motu->tx_stream;
 110                 formats = &motu->tx_packet_formats;
 111         } else {
 112                 hw->formats = SNDRV_PCM_FMTBIT_S32;
 113                 stream = &motu->rx_stream;
 114                 formats = &motu->rx_packet_formats;
 115         }
 116
 117         limit_channels_and_rates(motu, runtime, formats);
 118
 119         err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
 120                                   motu_rate_constraint, formats,
 121                                   SNDRV_PCM_HW_PARAM_CHANNELS, -1);
 122         if (err < 0)
 123                 return err;
 124         err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
 125                                   motu_channels_constraint, formats,
 126                                   SNDRV_PCM_HW_PARAM_RATE, -1);
 127         if (err < 0)
 128                 return err;
 129
 130         return amdtp_motu_add_pcm_hw_constraints(stream, runtime);
 131 }
 132
 133 static int pcm_open(struct snd_pcm_substream *substream)
 134 {
 135         struct snd_motu *motu = substream->private_data;
 136         const struct snd_motu_protocol *const protocol = motu->spec->protocol;
 137         struct amdtp_domain *d = &motu->domain;
 138         enum snd_motu_clock_source src;
 139         int err;
 140
 141         err = snd_motu_stream_lock_try(motu);
 142         if (err < 0)
 143                 return err;
 144
 145         mutex_lock(&motu->mutex);
 146
 147         err = snd_motu_stream_cache_packet_formats(motu);
 148         if (err < 0)
 149                 goto err_locked;
 150
 151         err = init_hw_info(motu, substream);
 152         if (err < 0)
 153                 goto err_locked;
 154
 155         err = protocol->get_clock_source(motu, &src);
 156         if (err < 0)
 157                 goto err_locked;
 158
 159         // When source of clock is not internal or any stream is reserved for
 160         // transmission of PCM frames, the available sampling rate is limited
 161         // at current one.
 162         if (src != SND_MOTU_CLOCK_SOURCE_INTERNAL ||
 163             (motu->substreams_counter > 0 && d->events_per_period > 0)) {
 164                 unsigned int frames_per_period = d->events_per_period;
 165                 unsigned int rate;
 166
 167                 err = protocol->get_clock_rate(motu, &rate);
 168                 if (err < 0)
 169                         goto err_locked;
 170
 171                 substream->runtime->hw.rate_min = rate;
 172                 substream->runtime->hw.rate_max = rate;
 173
 174                 if (frames_per_period > 0) {
 175                         err = snd_pcm_hw_constraint_minmax(substream->runtime,
 176                                         SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
 177                                         frames_per_period, frames_per_period);
 178                         if (err < 0) {
 179                                 mutex_unlock(&motu->mutex);
 180                                 goto err_locked;
 181                         }
 182                 }
 183         }
 184
 185         snd_pcm_set_sync(substream);
 186
 187         mutex_unlock(&motu->mutex);
 188
 189         return 0;
 190 err_locked:
 191         mutex_unlock(&motu->mutex);
 192         snd_motu_stream_lock_release(motu);
 193         return err;
 194 }
 195
 196 static int pcm_close(struct snd_pcm_substream *substream)
 197 {
 198         struct snd_motu *motu = substream->private_data;
 199
 200         snd_motu_stream_lock_release(motu);
 201
 202         return 0;
 203 }
 204
 205 static int pcm_hw_params(struct snd_pcm_substream *substream,
 206                          struct snd_pcm_hw_params *hw_params)
 207 {
 208         struct snd_motu *motu = substream->private_data;
 209         int err;
 210
 211         err = snd_pcm_lib_alloc_vmalloc_buffer(substream,
 212                                                params_buffer_bytes(hw_params));
 213         if (err < 0)
 214                 return err;
 215
 216         if (substream->runtime->status->state == SNDRV_PCM_STATE_OPEN) {
 217                 unsigned int rate = params_rate(hw_params);
 218                 unsigned int frames_per_period = params_period_size(hw_params);
 219
 220                 mutex_lock(&motu->mutex);
 221                 err = snd_motu_stream_reserve_duplex(motu, rate,
 222                                                      frames_per_period);
 223                 if (err >= 0)
 224                         ++motu->substreams_counter;
 225                 mutex_unlock(&motu->mutex);
 226         }
 227
 228         return err;
 229 }
 230
 231 static int pcm_hw_free(struct snd_pcm_substream *substream)
 232 {
 233         struct snd_motu *motu = substream->private_data;
 234
 235         mutex_lock(&motu->mutex);
 236
 237         if (substream->runtime->status->state != SNDRV_PCM_STATE_OPEN)
 238                 --motu->substreams_counter;
 239
 240         snd_motu_stream_stop_duplex(motu);
 241
 242         mutex_unlock(&motu->mutex);
 243
 244         return snd_pcm_lib_free_vmalloc_buffer(substream);
 245 }
 246
 247 static int capture_prepare(struct snd_pcm_substream *substream)
 248 {
 249         struct snd_motu *motu = substream->private_data;
 250         int err;
 251
 252         mutex_lock(&motu->mutex);
 253         err = snd_motu_stream_start_duplex(motu);
 254         mutex_unlock(&motu->mutex);
 255         if (err >= 0)
 256                 amdtp_stream_pcm_prepare(&motu->tx_stream);
 257
 258         return 0;
 259 }
 260 static int playback_prepare(struct snd_pcm_substream *substream)
 261 {
 262         struct snd_motu *motu = substream->private_data;
 263         int err;
 264
 265         mutex_lock(&motu->mutex);
 266         err = snd_motu_stream_start_duplex(motu);
 267         mutex_unlock(&motu->mutex);
 268         if (err >= 0)
 269                 amdtp_stream_pcm_prepare(&motu->rx_stream);
 270
 271         return err;
 272 }
 273
 274 static int capture_trigger(struct snd_pcm_substream *substream, int cmd)
 275 {
 276         struct snd_motu *motu = substream->private_data;
 277
 278         switch (cmd) {
 279         case SNDRV_PCM_TRIGGER_START:
 280                 amdtp_stream_pcm_trigger(&motu->tx_stream, substream);
 281                 break;
 282         case SNDRV_PCM_TRIGGER_STOP:
 283                 amdtp_stream_pcm_trigger(&motu->tx_stream, NULL);
 284                 break;
 285         default:
 286                 return -EINVAL;
 287         }
 288
 289         return 0;
 290 }
 291 static int playback_trigger(struct snd_pcm_substream *substream, int cmd)
 292 {
 293         struct snd_motu *motu = substream->private_data;
 294
 295         switch (cmd) {
 296         case SNDRV_PCM_TRIGGER_START:
 297                 amdtp_stream_pcm_trigger(&motu->rx_stream, substream);
 298                 break;
 299         case SNDRV_PCM_TRIGGER_STOP:
 300                 amdtp_stream_pcm_trigger(&motu->rx_stream, NULL);
 301                 break;
 302         default:
 303                 return -EINVAL;
 304         }
 305
 306         return 0;
 307 }
 308
 309 static snd_pcm_uframes_t capture_pointer(struct snd_pcm_substream *substream)
 310 {
 311         struct snd_motu *motu = substream->private_data;
 312
 313         return amdtp_stream_pcm_pointer(&motu->tx_stream);
 314 }
 315 static snd_pcm_uframes_t playback_pointer(struct snd_pcm_substream *substream)
 316 {
 317         struct snd_motu *motu = substream->private_data;
 318
 319         return amdtp_stream_pcm_pointer(&motu->rx_stream);
 320 }
 321
 322 static int capture_ack(struct snd_pcm_substream *substream)
 323 {
 324         struct snd_motu *motu = substream->private_data;
 325
 326         return amdtp_stream_pcm_ack(&motu->tx_stream);
 327 }
 328
 329 static int playback_ack(struct snd_pcm_substream *substream)
 330 {
 331         struct snd_motu *motu = substream->private_data;
 332
 333         return amdtp_stream_pcm_ack(&motu->rx_stream);
 334 }
 335
 336 int snd_motu_create_pcm_devices(struct snd_motu *motu)
 337 {
 338         static const struct snd_pcm_ops capture_ops = {
 339                 .open      = pcm_open,
 340                 .close     = pcm_close,
 341                 .ioctl     = snd_pcm_lib_ioctl,
 342                 .hw_params = pcm_hw_params,
 343                 .hw_free   = pcm_hw_free,
 344                 .prepare   = capture_prepare,
 345                 .trigger   = capture_trigger,
 346                 .pointer   = capture_pointer,
 347                 .ack       = capture_ack,
 348                 .page      = snd_pcm_lib_get_vmalloc_page,
 349         };
 350         static const struct snd_pcm_ops playback_ops = {
 351                 .open      = pcm_open,
 352                 .close     = pcm_close,
 353                 .ioctl     = snd_pcm_lib_ioctl,
 354                 .hw_params = pcm_hw_params,
 355                 .hw_free   = pcm_hw_free,
 356                 .prepare   = playback_prepare,
 357                 .trigger   = playback_trigger,
 358                 .pointer   = playback_pointer,
 359                 .ack       = playback_ack,
 360                 .page      = snd_pcm_lib_get_vmalloc_page,
 361         };
 362         struct snd_pcm *pcm;
 363         int err;
 364
 365         err = snd_pcm_new(motu->card, motu->card->driver, 0, 1, 1, &pcm);
 366         if (err < 0)
 367                 return err;
 368         pcm->private_data = motu;
 369         strcpy(pcm->name, motu->card->shortname);
 370
 371         snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &capture_ops);
 372         snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK, &playback_ops);
 373
 374         return 0;
 375 }