Pileus Git - ~andy/linux/blob - sound/soc/soc-generic-dmaengine-pcm.c

   1 /*
   2  *  Copyright (C) 2013, Analog Devices Inc.
   3  *      Author: Lars-Peter Clausen <lars@metafoo.de>
   4  *
   5  *  This program is free software; you can redistribute it and/or modify it
   6  *  under  the terms of the GNU General  Public License as published by the
   7  *  Free Software Foundation;  either version 2 of the License, or (at your
   8  *  option) any later version.
   9  *
  10  *  You should have received a copy of the GNU General Public License along
  11  *  with this program; if not, write to the Free Software Foundation, Inc.,
  12  *  675 Mass Ave, Cambridge, MA 02139, USA.
  13  *
  14  */
  15 #include <linux/module.h>
  16 #include <linux/init.h>
  17 #include <linux/dmaengine.h>
  18 #include <linux/slab.h>
  19 #include <sound/pcm.h>
  20 #include <sound/pcm_params.h>
  21 #include <sound/soc.h>
  22 #include <linux/dma-mapping.h>
  23 #include <linux/of.h>
  24
  25 #include <sound/dmaengine_pcm.h>
  26
  27 struct dmaengine_pcm {
  28         struct dma_chan *chan[SNDRV_PCM_STREAM_LAST + 1];
  29         const struct snd_dmaengine_pcm_config *config;
  30         struct snd_soc_platform platform;
  31         unsigned int flags;
  32 };
  33
  34 static struct dmaengine_pcm *soc_platform_to_pcm(struct snd_soc_platform *p)
  35 {
  36         return container_of(p, struct dmaengine_pcm, platform);
  37 }
  38
  39 static struct device *dmaengine_dma_dev(struct dmaengine_pcm *pcm,
  40         struct snd_pcm_substream *substream)
  41 {
  42         if (!pcm->chan[substream->stream])
  43                 return NULL;
  44
  45         return pcm->chan[substream->stream]->device->dev;
  46 }
  47
  48 /**
  49  * snd_dmaengine_pcm_prepare_slave_config() - Generic prepare_slave_config callback
  50  * @substream: PCM substream
  51  * @params: hw_params
  52  * @slave_config: DMA slave config to prepare
  53  *
  54  * This function can be used as a generic prepare_slave_config callback for
  55  * platforms which make use of the snd_dmaengine_dai_dma_data struct for their
  56  * DAI DMA data. Internally the function will first call
  57  * snd_hwparams_to_dma_slave_config to fill in the slave config based on the
  58  * hw_params, followed by snd_dmaengine_set_config_from_dai_data to fill in the
  59  * remaining fields based on the DAI DMA data.
  60  */
  61 int snd_dmaengine_pcm_prepare_slave_config(struct snd_pcm_substream *substream,
  62         struct snd_pcm_hw_params *params, struct dma_slave_config *slave_config)
  63 {
  64         struct snd_soc_pcm_runtime *rtd = substream->private_data;
  65         struct snd_dmaengine_dai_dma_data *dma_data;
  66         int ret;
  67
  68         dma_data = snd_soc_dai_get_dma_data(rtd->cpu_dai, substream);
  69
  70         ret = snd_hwparams_to_dma_slave_config(substream, params, slave_config);
  71         if (ret)
  72                 return ret;
  73
  74         snd_dmaengine_pcm_set_config_from_dai_data(substream, dma_data,
  75                 slave_config);
  76
  77         return 0;
  78 }
  79 EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_prepare_slave_config);
  80
  81 static int dmaengine_pcm_hw_params(struct snd_pcm_substream *substream,
  82         struct snd_pcm_hw_params *params)
  83 {
  84         struct snd_soc_pcm_runtime *rtd = substream->private_data;
  85         struct dmaengine_pcm *pcm = soc_platform_to_pcm(rtd->platform);
  86         struct dma_chan *chan = snd_dmaengine_pcm_get_chan(substream);
  87         int (*prepare_slave_config)(struct snd_pcm_substream *substream,
  88                         struct snd_pcm_hw_params *params,
  89                         struct dma_slave_config *slave_config);
  90         struct dma_slave_config slave_config;
  91         int ret;
  92
  93         memset(&slave_config, 0, sizeof(slave_config));
  94
  95         if (!pcm->config)
  96                 prepare_slave_config = snd_dmaengine_pcm_prepare_slave_config;
  97         else
  98                 prepare_slave_config = pcm->config->prepare_slave_config;
  99
 100         if (prepare_slave_config) {
 101                 ret = prepare_slave_config(substream, params, &slave_config);
 102                 if (ret)
 103                         return ret;
 104
 105                 ret = dmaengine_slave_config(chan, &slave_config);
 106                 if (ret)
 107                         return ret;
 108         }
 109
 110         return snd_pcm_lib_malloc_pages(substream, params_buffer_bytes(params));
 111 }
 112
 113 static int dmaengine_pcm_set_runtime_hwparams(struct snd_pcm_substream *substream)
 114 {
 115         struct snd_soc_pcm_runtime *rtd = substream->private_data;
 116         struct dmaengine_pcm *pcm = soc_platform_to_pcm(rtd->platform);
 117         struct device *dma_dev = dmaengine_dma_dev(pcm, substream);
 118         struct dma_chan *chan = pcm->chan[substream->stream];
 119         struct snd_dmaengine_dai_dma_data *dma_data;
 120         struct dma_slave_caps dma_caps;
 121         struct snd_pcm_hardware hw;
 122         int ret;
 123
 124         if (pcm->config && pcm->config->pcm_hardware)
 125                 return snd_soc_set_runtime_hwparams(substream,
 126                                 pcm->config->pcm_hardware);
 127
 128         dma_data = snd_soc_dai_get_dma_data(rtd->cpu_dai, substream);
 129
 130         memset(&hw, 0, sizeof(hw));
 131         hw.info = SNDRV_PCM_INFO_MMAP | SNDRV_PCM_INFO_MMAP_VALID |
 132                         SNDRV_PCM_INFO_INTERLEAVED;
 133         hw.periods_min = 2;
 134         hw.periods_max = UINT_MAX;
 135         hw.period_bytes_min = 256;
 136         hw.period_bytes_max = dma_get_max_seg_size(dma_dev);
 137         hw.buffer_bytes_max = SIZE_MAX;
 138         hw.fifo_size = dma_data->fifo_size;
 139
 140         if (pcm->flags & SND_DMAENGINE_PCM_FLAG_NO_RESIDUE)
 141                 hw.info |= SNDRV_PCM_INFO_BATCH;
 142
 143         ret = dma_get_slave_caps(chan, &dma_caps);
 144         if (ret == 0) {
 145                 if (dma_caps.cmd_pause)
 146                         hw.info |= SNDRV_PCM_INFO_PAUSE | SNDRV_PCM_INFO_RESUME;
 147                 if (dma_caps.residue_granularity <= DMA_RESIDUE_GRANULARITY_SEGMENT)
 148                         hw.info |= SNDRV_PCM_INFO_BATCH;
 149         }
 150
 151         return snd_soc_set_runtime_hwparams(substream, &hw);
 152 }
 153
 154 static int dmaengine_pcm_open(struct snd_pcm_substream *substream)
 155 {
 156         struct snd_soc_pcm_runtime *rtd = substream->private_data;
 157         struct dmaengine_pcm *pcm = soc_platform_to_pcm(rtd->platform);
 158         struct dma_chan *chan = pcm->chan[substream->stream];
 159         int ret;
 160
 161         ret = dmaengine_pcm_set_runtime_hwparams(substream);
 162         if (ret)
 163                 return ret;
 164
 165         return snd_dmaengine_pcm_open(substream, chan);
 166 }
 167
 168 static void dmaengine_pcm_free(struct snd_pcm *pcm)
 169 {
 170         snd_pcm_lib_preallocate_free_for_all(pcm);
 171 }
 172
 173 static struct dma_chan *dmaengine_pcm_compat_request_channel(
 174         struct snd_soc_pcm_runtime *rtd,
 175         struct snd_pcm_substream *substream)
 176 {
 177         struct dmaengine_pcm *pcm = soc_platform_to_pcm(rtd->platform);
 178         struct snd_dmaengine_dai_dma_data *dma_data;
 179
 180         dma_data = snd_soc_dai_get_dma_data(rtd->cpu_dai, substream);
 181
 182         if ((pcm->flags & SND_DMAENGINE_PCM_FLAG_HALF_DUPLEX) && pcm->chan[0])
 183                 return pcm->chan[0];
 184
 185         if (pcm->config->compat_request_channel)
 186                 return pcm->config->compat_request_channel(rtd, substream);
 187
 188         return snd_dmaengine_pcm_request_channel(pcm->config->compat_filter_fn,
 189                                                  dma_data->filter_data);
 190 }
 191
 192 static bool dmaengine_pcm_can_report_residue(struct dma_chan *chan)
 193 {
 194         struct dma_slave_caps dma_caps;
 195         int ret;
 196
 197         ret = dma_get_slave_caps(chan, &dma_caps);
 198         if (ret != 0)
 199                 return true;
 200
 201         if (dma_caps.residue_granularity == DMA_RESIDUE_GRANULARITY_DESCRIPTOR)
 202                 return false;
 203
 204         return true;
 205 }
 206
 207 static int dmaengine_pcm_new(struct snd_soc_pcm_runtime *rtd)
 208 {
 209         struct dmaengine_pcm *pcm = soc_platform_to_pcm(rtd->platform);
 210         const struct snd_dmaengine_pcm_config *config = pcm->config;
 211         struct device *dev = rtd->platform->dev;
 212         struct snd_dmaengine_dai_dma_data *dma_data;
 213         struct snd_pcm_substream *substream;
 214         size_t prealloc_buffer_size;
 215         size_t max_buffer_size;
 216         unsigned int i;
 217         int ret;
 218
 219         if (config && config->prealloc_buffer_size) {
 220                 prealloc_buffer_size = config->prealloc_buffer_size;
 221                 max_buffer_size = config->pcm_hardware->buffer_bytes_max;
 222         } else {
 223                 prealloc_buffer_size = 512 * 1024;
 224                 max_buffer_size = SIZE_MAX;
 225         }
 226
 227
 228         for (i = SNDRV_PCM_STREAM_PLAYBACK; i <= SNDRV_PCM_STREAM_CAPTURE; i++) {
 229                 substream = rtd->pcm->streams[i].substream;
 230                 if (!substream)
 231                         continue;
 232
 233                 dma_data = snd_soc_dai_get_dma_data(rtd->cpu_dai, substream);
 234
 235                 if (!pcm->chan[i] &&
 236                     (pcm->flags & SND_DMAENGINE_PCM_FLAG_CUSTOM_CHANNEL_NAME))
 237                         pcm->chan[i] = dma_request_slave_channel(dev,
 238                                 dma_data->chan_name);
 239
 240                 if (!pcm->chan[i] && (pcm->flags & SND_DMAENGINE_PCM_FLAG_COMPAT)) {
 241                         pcm->chan[i] = dmaengine_pcm_compat_request_channel(rtd,
 242                                 substream);
 243                 }
 244
 245                 if (!pcm->chan[i]) {
 246                         dev_err(rtd->platform->dev,
 247                                 "Missing dma channel for stream: %d\n", i);
 248                         ret = -EINVAL;
 249                         goto err_free;
 250                 }
 251
 252                 ret = snd_pcm_lib_preallocate_pages(substream,
 253                                 SNDRV_DMA_TYPE_DEV_IRAM,
 254                                 dmaengine_dma_dev(pcm, substream),
 255                                 prealloc_buffer_size,
 256                                 max_buffer_size);
 257                 if (ret)
 258                         goto err_free;
 259
 260                 /*
 261                  * This will only return false if we know for sure that at least
 262                  * one channel does not support residue reporting. If the DMA
 263                  * driver does not implement the slave_caps API we rely having
 264                  * the NO_RESIDUE flag set manually in case residue reporting is
 265                  * not supported.
 266                  */
 267                 if (!dmaengine_pcm_can_report_residue(pcm->chan[i]))
 268                         pcm->flags |= SND_DMAENGINE_PCM_FLAG_NO_RESIDUE;
 269         }
 270
 271         return 0;
 272
 273 err_free:
 274         dmaengine_pcm_free(rtd->pcm);
 275         return ret;
 276 }
 277
 278 static snd_pcm_uframes_t dmaengine_pcm_pointer(
 279         struct snd_pcm_substream *substream)
 280 {
 281         struct snd_soc_pcm_runtime *rtd = substream->private_data;
 282         struct dmaengine_pcm *pcm = soc_platform_to_pcm(rtd->platform);
 283
 284         if (pcm->flags & SND_DMAENGINE_PCM_FLAG_NO_RESIDUE)
 285                 return snd_dmaengine_pcm_pointer_no_residue(substream);
 286         else
 287                 return snd_dmaengine_pcm_pointer(substream);
 288 }
 289
 290 static const struct snd_pcm_ops dmaengine_pcm_ops = {
 291         .open           = dmaengine_pcm_open,
 292         .close          = snd_dmaengine_pcm_close,
 293         .ioctl          = snd_pcm_lib_ioctl,
 294         .hw_params      = dmaengine_pcm_hw_params,
 295         .hw_free        = snd_pcm_lib_free_pages,
 296         .trigger        = snd_dmaengine_pcm_trigger,
 297         .pointer        = dmaengine_pcm_pointer,
 298 };
 299
 300 static const struct snd_soc_platform_driver dmaengine_pcm_platform = {
 301         .ops            = &dmaengine_pcm_ops,
 302         .pcm_new        = dmaengine_pcm_new,
 303         .pcm_free       = dmaengine_pcm_free,
 304         .probe_order    = SND_SOC_COMP_ORDER_LATE,
 305 };
 306
 307 static const char * const dmaengine_pcm_dma_channel_names[] = {
 308         [SNDRV_PCM_STREAM_PLAYBACK] = "tx",
 309         [SNDRV_PCM_STREAM_CAPTURE] = "rx",
 310 };
 311
 312 static int dmaengine_pcm_request_chan_of(struct dmaengine_pcm *pcm,
 313         struct device *dev, const struct snd_dmaengine_pcm_config *config)
 314 {
 315         unsigned int i;
 316         const char *name;
 317         struct dma_chan *chan;
 318
 319         if ((pcm->flags & (SND_DMAENGINE_PCM_FLAG_NO_DT |
 320                            SND_DMAENGINE_PCM_FLAG_CUSTOM_CHANNEL_NAME)) ||
 321             !dev->of_node)
 322                 return 0;
 323
 324         if (config && config->dma_dev) {
 325                 /*
 326                  * If this warning is seen, it probably means that your Linux
 327                  * device structure does not match your HW device structure.
 328                  * It would be best to refactor the Linux device structure to
 329                  * correctly match the HW structure.
 330                  */
 331                 dev_warn(dev, "DMA channels sourced from device %s",
 332                          dev_name(config->dma_dev));
 333                 dev = config->dma_dev;
 334         }
 335
 336         for (i = SNDRV_PCM_STREAM_PLAYBACK; i <= SNDRV_PCM_STREAM_CAPTURE;
 337              i++) {
 338                 if (pcm->flags & SND_DMAENGINE_PCM_FLAG_HALF_DUPLEX)
 339                         name = "rx-tx";
 340                 else
 341                         name = dmaengine_pcm_dma_channel_names[i];
 342                 if (config && config->chan_names[i])
 343                         name = config->chan_names[i];
 344                 chan = dma_request_slave_channel_reason(dev, name);
 345                 if (IS_ERR(chan)) {
 346                         if (PTR_ERR(chan) == -EPROBE_DEFER)
 347                                 return -EPROBE_DEFER;
 348                         pcm->chan[i] = NULL;
 349                 } else {
 350                         pcm->chan[i] = chan;
 351                 }
 352                 if (pcm->flags & SND_DMAENGINE_PCM_FLAG_HALF_DUPLEX)
 353                         break;
 354         }
 355
 356         if (pcm->flags & SND_DMAENGINE_PCM_FLAG_HALF_DUPLEX)
 357                 pcm->chan[1] = pcm->chan[0];
 358
 359         return 0;
 360 }
 361
 362 static void dmaengine_pcm_release_chan(struct dmaengine_pcm *pcm)
 363 {
 364         unsigned int i;
 365
 366         for (i = SNDRV_PCM_STREAM_PLAYBACK; i <= SNDRV_PCM_STREAM_CAPTURE;
 367              i++) {
 368                 if (!pcm->chan[i])
 369                         continue;
 370                 dma_release_channel(pcm->chan[i]);
 371                 if (pcm->flags & SND_DMAENGINE_PCM_FLAG_HALF_DUPLEX)
 372                         break;
 373         }
 374 }
 375
 376 /**
 377  * snd_dmaengine_pcm_register - Register a dmaengine based PCM device
 378  * @dev: The parent device for the PCM device
 379  * @config: Platform specific PCM configuration
 380  * @flags: Platform specific quirks
 381  */
 382 int snd_dmaengine_pcm_register(struct device *dev,
 383         const struct snd_dmaengine_pcm_config *config, unsigned int flags)
 384 {
 385         struct dmaengine_pcm *pcm;
 386         int ret;
 387
 388         pcm = kzalloc(sizeof(*pcm), GFP_KERNEL);
 389         if (!pcm)
 390                 return -ENOMEM;
 391
 392         pcm->config = config;
 393         pcm->flags = flags;
 394
 395         ret = dmaengine_pcm_request_chan_of(pcm, dev, config);
 396         if (ret)
 397                 goto err_free_dma;
 398
 399         ret = snd_soc_add_platform(dev, &pcm->platform,
 400                 &dmaengine_pcm_platform);
 401         if (ret)
 402                 goto err_free_dma;
 403
 404         return 0;
 405
 406 err_free_dma:
 407         dmaengine_pcm_release_chan(pcm);
 408         kfree(pcm);
 409         return ret;
 410 }
 411 EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_register);
 412
 413 /**
 414  * snd_dmaengine_pcm_unregister - Removes a dmaengine based PCM device
 415  * @dev: Parent device the PCM was register with
 416  *
 417  * Removes a dmaengine based PCM device previously registered with
 418  * snd_dmaengine_pcm_register.
 419  */
 420 void snd_dmaengine_pcm_unregister(struct device *dev)
 421 {
 422         struct snd_soc_platform *platform;
 423         struct dmaengine_pcm *pcm;
 424
 425         platform = snd_soc_lookup_platform(dev);
 426         if (!platform)
 427                 return;
 428
 429         pcm = soc_platform_to_pcm(platform);
 430
 431         snd_soc_remove_platform(platform);
 432         dmaengine_pcm_release_chan(pcm);
 433         kfree(pcm);
 434 }
 435 EXPORT_SYMBOL_GPL(snd_dmaengine_pcm_unregister);
 436
 437 MODULE_LICENSE("GPL");