sound/core/pcm_memory.c

   1 /*
   2  *  Digital Audio (PCM) abstract layer
   3  *  Copyright (c) by Jaroslav Kysela <perex@suse.cz>
   4  *
   5  *
   6  *   This program is free software; you can redistribute it and/or modify
   7  *   it under the terms of the GNU General Public License as published by
   8  *   the Free Software Foundation; either version 2 of the License, or
   9  *   (at your option) any later version.
  10  *
  11  *   This program is distributed in the hope that it will be useful,
  12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *   GNU General Public License for more details.
  15  *
  16  *   You should have received a copy of the GNU General Public License
  17  *   along with this program; if not, write to the Free Software
  18  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19  *
  20  */
  21
  22 #include <sound/driver.h>
  23 #include <asm/io.h>
  24 #include <linux/time.h>
  25 #include <linux/init.h>
  26 #include <linux/moduleparam.h>
  27 #include <sound/core.h>
  28 #include <sound/pcm.h>
  29 #include <sound/info.h>
  30 #include <sound/initval.h>
  31
  32 static int preallocate_dma = 1;
  33 module_param(preallocate_dma, int, 0444);
  34 MODULE_PARM_DESC(preallocate_dma, "Preallocate DMA memory when the PCM devices are initialized.");
  35
  36 static int maximum_substreams = 4;
  37 module_param(maximum_substreams, int, 0444);
  38 MODULE_PARM_DESC(maximum_substreams, "Maximum substreams with preallocated DMA memory.");
  39
  40 static const size_t snd_minimum_buffer = 16384;
  41
  42
  43 /*
  44  * try to allocate as the large pages as possible.
  45  * stores the resultant memory size in *res_size.
  46  *
  47  * the minimum size is snd_minimum_buffer.  it should be power of 2.
  48  */
  49 static int preallocate_pcm_pages(struct snd_pcm_substream *substream, size_t size)
  50 {
  51         struct snd_dma_buffer *dmab = &substream->dma_buffer;
  52         int err;
  53
  54         snd_assert(size > 0, return -EINVAL);
  55
  56         /* already reserved? */
  57         if (snd_dma_get_reserved_buf(dmab, substream->dma_buf_id) > 0) {
  58                 if (dmab->bytes >= size)
  59                         return 0; /* yes */
  60                 /* no, free the reserved block */
  61                 snd_dma_free_pages(dmab);
  62                 dmab->bytes = 0;
  63         }
  64
  65         do {
  66                 if ((err = snd_dma_alloc_pages(dmab->dev.type, dmab->dev.dev,
  67                                                size, dmab)) < 0) {
  68                         if (err != -ENOMEM)
  69                                 return err; /* fatal error */
  70                 } else
  71                         return 0;
  72                 size >>= 1;
  73         } while (size >= snd_minimum_buffer);
  74         dmab->bytes = 0; /* tell error */
  75         return 0;
  76 }
  77
  78 /*
  79  * release the preallocated buffer if not yet done.
  80  */
  81 static void snd_pcm_lib_preallocate_dma_free(struct snd_pcm_substream *substream)
  82 {
  83         if (substream->dma_buffer.area == NULL)
  84                 return;
  85         if (substream->dma_buf_id)
  86                 snd_dma_reserve_buf(&substream->dma_buffer, substream->dma_buf_id);
  87         else
  88                 snd_dma_free_pages(&substream->dma_buffer);
  89         substream->dma_buffer.area = NULL;
  90 }
  91
  92 /**
  93  * snd_pcm_lib_preallocate_free - release the preallocated buffer of the specified substream.
  94  * @substream: the pcm substream instance
  95  *
  96  * Releases the pre-allocated buffer of the given substream.
  97  *
  98  * Returns zero if successful, or a negative error code on failure.
  99  */
 100 int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream)
 101 {
 102         snd_pcm_lib_preallocate_dma_free(substream);
 103 #ifdef CONFIG_SND_VERBOSE_PROCFS
 104         snd_info_unregister(substream->proc_prealloc_entry);
 105         substream->proc_prealloc_entry = NULL;
 106 #endif
 107         return 0;
 108 }
 109
 110 /**
 111  * snd_pcm_lib_preallocate_free_for_all - release all pre-allocated buffers on the pcm
 112  * @pcm: the pcm instance
 113  *
 114  * Releases all the pre-allocated buffers on the given pcm.
 115  *
 116  * Returns zero if successful, or a negative error code on failure.
 117  */
 118 int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm)
 119 {
 120         struct snd_pcm_substream *substream;
 121         int stream;
 122
 123         for (stream = 0; stream < 2; stream++)
 124                 for (substream = pcm->streams[stream].substream; substream; substream = substream->next)
 125                         snd_pcm_lib_preallocate_free(substream);
 126         return 0;
 127 }
 128
 129 EXPORT_SYMBOL(snd_pcm_lib_preallocate_free_for_all);
 130
 131 #ifdef CONFIG_SND_VERBOSE_PROCFS
 132 /*
 133  * read callback for prealloc proc file
 134  *
 135  * prints the current allocated size in kB.
 136  */
 137 static void snd_pcm_lib_preallocate_proc_read(struct snd_info_entry *entry,
 138                                               struct snd_info_buffer *buffer)
 139 {
 140         struct snd_pcm_substream *substream = entry->private_data;
 141         snd_iprintf(buffer, "%lu\n", (unsigned long) substream->dma_buffer.bytes / 1024);
 142 }
 143
 144 /*
 145  * write callback for prealloc proc file
 146  *
 147  * accepts the preallocation size in kB.
 148  */
 149 static void snd_pcm_lib_preallocate_proc_write(struct snd_info_entry *entry,
 150                                                struct snd_info_buffer *buffer)
 151 {
 152         struct snd_pcm_substream *substream = entry->private_data;
 153         char line[64], str[64];
 154         size_t size;
 155         struct snd_dma_buffer new_dmab;
 156
 157         if (substream->runtime) {
 158                 buffer->error = -EBUSY;
 159                 return;
 160         }
 161         if (!snd_info_get_line(buffer, line, sizeof(line))) {
 162                 snd_info_get_str(str, line, sizeof(str));
 163                 size = simple_strtoul(str, NULL, 10) * 1024;
 164                 if ((size != 0 && size < 8192) || size > substream->dma_max) {
 165                         buffer->error = -EINVAL;
 166                         return;
 167                 }
 168                 if (substream->dma_buffer.bytes == size)
 169                         return;
 170                 memset(&new_dmab, 0, sizeof(new_dmab));
 171                 new_dmab.dev = substream->dma_buffer.dev;
 172                 if (size > 0) {
 173                         if (snd_dma_alloc_pages(substream->dma_buffer.dev.type,
 174                                                 substream->dma_buffer.dev.dev,
 175                                                 size, &new_dmab) < 0) {
 176                                 buffer->error = -ENOMEM;
 177                                 return;
 178                         }
 179                         substream->buffer_bytes_max = size;
 180                 } else {
 181                         substream->buffer_bytes_max = UINT_MAX;
 182                 }
 183                 if (substream->dma_buffer.area)
 184                         snd_dma_free_pages(&substream->dma_buffer);
 185                 substream->dma_buffer = new_dmab;
 186         } else {
 187                 buffer->error = -EINVAL;
 188         }
 189 }
 190
 191 static inline void preallocate_info_init(struct snd_pcm_substream *substream)
 192 {
 193         struct snd_info_entry *entry;
 194
 195         if ((entry = snd_info_create_card_entry(substream->pcm->card, "prealloc", substream->proc_root)) != NULL) {
 196                 entry->c.text.read = snd_pcm_lib_preallocate_proc_read;
 197                 entry->c.text.write = snd_pcm_lib_preallocate_proc_write;
 198                 entry->mode |= S_IWUSR;
 199                 entry->private_data = substream;
 200                 if (snd_info_register(entry) < 0) {
 201                         snd_info_free_entry(entry);
 202                         entry = NULL;
 203                 }
 204         }
 205         substream->proc_prealloc_entry = entry;
 206 }
 207
 208 #else /* !CONFIG_SND_VERBOSE_PROCFS */
 209 #define preallocate_info_init(s)
 210 #endif /* CONFIG_SND_VERBOSE_PROCFS */
 211
 212 /*
 213  * pre-allocate the buffer and create a proc file for the substream
 214  */
 215 static int snd_pcm_lib_preallocate_pages1(struct snd_pcm_substream *substream,
 216                                           size_t size, size_t max)
 217 {
 218
 219         if (size > 0 && preallocate_dma && substream->number < maximum_substreams)
 220                 preallocate_pcm_pages(substream, size);
 221
 222         if (substream->dma_buffer.bytes > 0)
 223                 substream->buffer_bytes_max = substream->dma_buffer.bytes;
 224         substream->dma_max = max;
 225         preallocate_info_init(substream);
 226         return 0;
 227 }
 228
 229
 230 /**
 231  * snd_pcm_lib_preallocate_pages - pre-allocation for the given DMA type
 232  * @substream: the pcm substream instance
 233  * @type: DMA type (SNDRV_DMA_TYPE_*)
 234  * @data: DMA type dependant data
 235  * @size: the requested pre-allocation size in bytes
 236  * @max: the max. allowed pre-allocation size
 237  *
 238  * Do pre-allocation for the given DMA buffer type.
 239  *
 240  * When substream->dma_buf_id is set, the function tries to look for
 241  * the reserved buffer, and the buffer is not freed but reserved at
 242  * destruction time.  The dma_buf_id must be unique for all systems
 243  * (in the same DMA buffer type) e.g. using snd_dma_pci_buf_id().
 244  *
 245  * Returns zero if successful, or a negative error code on failure.
 246  */
 247 int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
 248                                   int type, struct device *data,
 249                                   size_t size, size_t max)
 250 {
 251         substream->dma_buffer.dev.type = type;
 252         substream->dma_buffer.dev.dev = data;
 253         return snd_pcm_lib_preallocate_pages1(substream, size, max);
 254 }
 255
 256 EXPORT_SYMBOL(snd_pcm_lib_preallocate_pages);
 257
 258 /**
 259  * snd_pcm_lib_preallocate_pages_for_all - pre-allocation for continous memory type (all substreams)
 260  * @pcm: the pcm instance
 261  * @type: DMA type (SNDRV_DMA_TYPE_*)
 262  * @data: DMA type dependant data
 263  * @size: the requested pre-allocation size in bytes
 264  * @max: the max. allowed pre-allocation size
 265  *
 266  * Do pre-allocation to all substreams of the given pcm for the
 267  * specified DMA type.
 268  *
 269  * Returns zero if successful, or a negative error code on failure.
 270  */
 271 int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
 272                                           int type, void *data,
 273                                           size_t size, size_t max)
 274 {
 275         struct snd_pcm_substream *substream;
 276         int stream, err;
 277
 278         for (stream = 0; stream < 2; stream++)
 279                 for (substream = pcm->streams[stream].substream; substream; substream = substream->next)
 280                         if ((err = snd_pcm_lib_preallocate_pages(substream, type, data, size, max)) < 0)
 281                                 return err;
 282         return 0;
 283 }
 284
 285 EXPORT_SYMBOL(snd_pcm_lib_preallocate_pages_for_all);
 286
 287 /**
 288  * snd_pcm_sgbuf_ops_page - get the page struct at the given offset
 289  * @substream: the pcm substream instance
 290  * @offset: the buffer offset
 291  *
 292  * Returns the page struct at the given buffer offset.
 293  * Used as the page callback of PCM ops.
 294  */
 295 struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream, unsigned long offset)
 296 {
 297         struct snd_sg_buf *sgbuf = snd_pcm_substream_sgbuf(substream);
 298
 299         unsigned int idx = offset >> PAGE_SHIFT;
 300         if (idx >= (unsigned int)sgbuf->pages)
 301                 return NULL;
 302         return sgbuf->page_table[idx];
 303 }
 304
 305 EXPORT_SYMBOL(snd_pcm_sgbuf_ops_page);
 306
 307 /**
 308  * snd_pcm_lib_malloc_pages - allocate the DMA buffer
 309  * @substream: the substream to allocate the DMA buffer to
 310  * @size: the requested buffer size in bytes
 311  *
 312  * Allocates the DMA buffer on the BUS type given earlier to
 313  * snd_pcm_lib_preallocate_xxx_pages().
 314  *
 315  * Returns 1 if the buffer is changed, 0 if not changed, or a negative
 316  * code on failure.
 317  */
 318 int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size)
 319 {
 320         struct snd_pcm_runtime *runtime;
 321         struct snd_dma_buffer *dmab = NULL;
 322
 323         snd_assert(substream->dma_buffer.dev.type != SNDRV_DMA_TYPE_UNKNOWN, return -EINVAL);
 324         snd_assert(substream != NULL, return -EINVAL);
 325         runtime = substream->runtime;
 326         snd_assert(runtime != NULL, return -EINVAL);
 327
 328         if (runtime->dma_buffer_p) {
 329                 /* perphaps, we might free the large DMA memory region
 330                    to save some space here, but the actual solution
 331                    costs us less time */
 332                 if (runtime->dma_buffer_p->bytes >= size) {
 333                         runtime->dma_bytes = size;
 334                         return 0;       /* ok, do not change */
 335                 }
 336                 snd_pcm_lib_free_pages(substream);
 337         }
 338         if (substream->dma_buffer.area != NULL &&
 339             substream->dma_buffer.bytes >= size) {
 340                 dmab = &substream->dma_buffer; /* use the pre-allocated buffer */
 341         } else {
 342                 dmab = kzalloc(sizeof(*dmab), GFP_KERNEL);
 343                 if (! dmab)
 344                         return -ENOMEM;
 345                 dmab->dev = substream->dma_buffer.dev;
 346                 if (snd_dma_alloc_pages(substream->dma_buffer.dev.type,
 347                                         substream->dma_buffer.dev.dev,
 348                                         size, dmab) < 0) {
 349                         kfree(dmab);
 350                         return -ENOMEM;
 351                 }
 352         }
 353         snd_pcm_set_runtime_buffer(substream, dmab);
 354         runtime->dma_bytes = size;
 355         return 1;                       /* area was changed */
 356 }
 357
 358 EXPORT_SYMBOL(snd_pcm_lib_malloc_pages);
 359
 360 /**
 361  * snd_pcm_lib_free_pages - release the allocated DMA buffer.
 362  * @substream: the substream to release the DMA buffer
 363  *
 364  * Releases the DMA buffer allocated via snd_pcm_lib_malloc_pages().
 365  *
 366  * Returns zero if successful, or a negative error code on failure.
 367  */
 368 int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream)
 369 {
 370         struct snd_pcm_runtime *runtime;
 371
 372         snd_assert(substream != NULL, return -EINVAL);
 373         runtime = substream->runtime;
 374         snd_assert(runtime != NULL, return -EINVAL);
 375         if (runtime->dma_area == NULL)
 376                 return 0;
 377         if (runtime->dma_buffer_p != &substream->dma_buffer) {
 378                 /* it's a newly allocated buffer.  release it now. */
 379                 snd_dma_free_pages(runtime->dma_buffer_p);
 380                 kfree(runtime->dma_buffer_p);
 381         }
 382         snd_pcm_set_runtime_buffer(substream, NULL);
 383         return 0;
 384 }
 385
 386 EXPORT_SYMBOL(snd_pcm_lib_free_pages);