include/sound/memalloc.h

   1 /*
   2  *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
   3  *                   Takashi Iwai <tiwai@suse.de>
   4  *
   5  *  Generic memory allocators
   6  *
   7  *
   8  *   This program is free software; you can redistribute it and/or modify
   9  *   it under the terms of the GNU General Public License as published by
  10  *   the Free Software Foundation; either version 2 of the License, or
  11  *   (at your option) any later version.
  12  *
  13  *   This program is distributed in the hope that it will be useful,
  14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *   GNU General Public License for more details.
  17  *
  18  *   You should have received a copy of the GNU General Public License
  19  *   along with this program; if not, write to the Free Software
  20  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  21  *
  22  */
  23
  24 #ifndef __SOUND_MEMALLOC_H
  25 #define __SOUND_MEMALLOC_H
  26
  27 struct device;
  28
  29 /*
  30  * buffer device info
  31  */
  32 struct snd_dma_device {
  33         int type;                       /* SNDRV_DMA_TYPE_XXX */
  34         struct device *dev;             /* generic device */
  35 };
  36
  37 #ifndef snd_dma_pci_data
  38 #define snd_dma_pci_data(pci)   (&(pci)->dev)
  39 #define snd_dma_isa_data()      NULL
  40 #define snd_dma_continuous_data(x)      ((struct device *)(__force unsigned long)(x))
  41 #endif
  42
  43
  44 /*
  45  * buffer types
  46  */
  47 #define SNDRV_DMA_TYPE_UNKNOWN          0       /* not defined */
  48 #define SNDRV_DMA_TYPE_CONTINUOUS       1       /* continuous no-DMA memory */
  49 #define SNDRV_DMA_TYPE_DEV              2       /* generic device continuous */
  50 #ifdef CONFIG_SND_DMA_SGBUF
  51 #define SNDRV_DMA_TYPE_DEV_SG           3       /* generic device SG-buffer */
  52 #else
  53 #define SNDRV_DMA_TYPE_DEV_SG   SNDRV_DMA_TYPE_DEV /* no SG-buf support */
  54 #endif
  55 #define SNDRV_DMA_TYPE_DEV_IRAM         4       /* generic device iram-buffer */
  56
  57 /*
  58  * info for buffer allocation
  59  */
  60 struct snd_dma_buffer {
  61         struct snd_dma_device dev;      /* device type */
  62         unsigned char *area;    /* virtual pointer */
  63         dma_addr_t addr;        /* physical address */
  64         size_t bytes;           /* buffer size in bytes */
  65         void *private_data;     /* private for allocator; don't touch */
  66 };
  67
  68 #ifdef CONFIG_SND_DMA_SGBUF
  69 /*
  70  * Scatter-Gather generic device pages
  71  */
  72 void *snd_malloc_sgbuf_pages(struct device *device,
  73                              size_t size, struct snd_dma_buffer *dmab,
  74                              size_t *res_size);
  75 int snd_free_sgbuf_pages(struct snd_dma_buffer *dmab);
  76
  77 struct snd_sg_page {
  78         void *buf;
  79         dma_addr_t addr;
  80 };
  81
  82 struct snd_sg_buf {
  83         int size;       /* allocated byte size */
  84         int pages;      /* allocated pages */
  85         int tblsize;    /* allocated table size */
  86         struct snd_sg_page *table;      /* address table */
  87         struct page **page_table;       /* page table (for vmap/vunmap) */
  88         struct device *dev;
  89 };
  90
  91 /*
  92  * return the pages matching with the given byte size
  93  */
  94 static inline unsigned int snd_sgbuf_aligned_pages(size_t size)
  95 {
  96         return (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
  97 }
  98
  99 /*
 100  * return the physical address at the corresponding offset
 101  */
 102 static inline dma_addr_t snd_sgbuf_get_addr(struct snd_dma_buffer *dmab,
 103                                            size_t offset)
 104 {
 105         struct snd_sg_buf *sgbuf = dmab->private_data;
 106         dma_addr_t addr = sgbuf->table[offset >> PAGE_SHIFT].addr;
 107         addr &= PAGE_MASK;
 108         return addr + offset % PAGE_SIZE;
 109 }
 110
 111 /*
 112  * return the virtual address at the corresponding offset
 113  */
 114 static inline void *snd_sgbuf_get_ptr(struct snd_dma_buffer *dmab,
 115                                      size_t offset)
 116 {
 117         struct snd_sg_buf *sgbuf = dmab->private_data;
 118         return sgbuf->table[offset >> PAGE_SHIFT].buf + offset % PAGE_SIZE;
 119 }
 120
 121 unsigned int snd_sgbuf_get_chunk_size(struct snd_dma_buffer *dmab,
 122                                       unsigned int ofs, unsigned int size);
 123 #else
 124 /* non-SG versions */
 125 static inline dma_addr_t snd_sgbuf_get_addr(struct snd_dma_buffer *dmab,
 126                                             size_t offset)
 127 {
 128         return dmab->addr + offset;
 129 }
 130
 131 static inline void *snd_sgbuf_get_ptr(struct snd_dma_buffer *dmab,
 132                                       size_t offset)
 133 {
 134         return dmab->area + offset;
 135 }
 136
 137 #define snd_sgbuf_get_chunk_size(dmab, ofs, size)       (size)
 138
 139 #endif /* CONFIG_SND_DMA_SGBUF */
 140
 141 /* allocate/release a buffer */
 142 int snd_dma_alloc_pages(int type, struct device *dev, size_t size,
 143                         struct snd_dma_buffer *dmab);
 144 int snd_dma_alloc_pages_fallback(int type, struct device *dev, size_t size,
 145                                  struct snd_dma_buffer *dmab);
 146 void snd_dma_free_pages(struct snd_dma_buffer *dmab);
 147
 148 /* buffer-preservation managements */
 149
 150 #define snd_dma_pci_buf_id(pci) (((unsigned int)(pci)->vendor << 16) | (pci)->device)
 151
 152 size_t snd_dma_get_reserved_buf(struct snd_dma_buffer *dmab, unsigned int id);
 153 int snd_dma_reserve_buf(struct snd_dma_buffer *dmab, unsigned int id);
 154
 155 /* basic memory allocation functions */
 156 void *snd_malloc_pages(size_t size, gfp_t gfp_flags);
 157 void snd_free_pages(void *ptr, size_t size);
 158
 159 #endif /* __SOUND_MEMALLOC_H */
 160