include/sound/memalloc.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
   4  *                   Takashi Iwai <tiwai@suse.de>
   5  *
   6  *  Generic memory allocators
   7  */
   8
   9 #ifndef __SOUND_MEMALLOC_H
  10 #define __SOUND_MEMALLOC_H
  11
  12 #include <asm/page.h>
  13
  14 struct device;
  15
  16 /*
  17  * buffer device info
  18  */
  19 struct snd_dma_device {
  20         int type;                       /* SNDRV_DMA_TYPE_XXX */
  21         struct device *dev;             /* generic device */
  22 };
  23
  24 #define snd_dma_pci_data(pci)   (&(pci)->dev)
  25 #define snd_dma_continuous_data(x)      ((struct device *)(__force unsigned long)(x))
  26
  27
  28 /*
  29  * buffer types
  30  */
  31 #define SNDRV_DMA_TYPE_UNKNOWN          0       /* not defined */
  32 #define SNDRV_DMA_TYPE_CONTINUOUS       1       /* continuous no-DMA memory */
  33 #define SNDRV_DMA_TYPE_DEV              2       /* generic device continuous */
  34 #define SNDRV_DMA_TYPE_DEV_UC           5       /* continuous non-cahced */
  35 #ifdef CONFIG_SND_DMA_SGBUF
  36 #define SNDRV_DMA_TYPE_DEV_SG           3       /* generic device SG-buffer */
  37 #define SNDRV_DMA_TYPE_DEV_UC_SG        6       /* SG non-cached */
  38 #else
  39 #define SNDRV_DMA_TYPE_DEV_SG   SNDRV_DMA_TYPE_DEV /* no SG-buf support */
  40 #define SNDRV_DMA_TYPE_DEV_UC_SG        SNDRV_DMA_TYPE_DEV_UC
  41 #endif
  42 #ifdef CONFIG_GENERIC_ALLOCATOR
  43 #define SNDRV_DMA_TYPE_DEV_IRAM         4       /* generic device iram-buffer */
  44 #else
  45 #define SNDRV_DMA_TYPE_DEV_IRAM SNDRV_DMA_TYPE_DEV
  46 #endif
  47 #define SNDRV_DMA_TYPE_VMALLOC          7       /* vmalloc'ed buffer */
  48
  49 /*
  50  * info for buffer allocation
  51  */
  52 struct snd_dma_buffer {
  53         struct snd_dma_device dev;      /* device type */
  54         unsigned char *area;    /* virtual pointer */
  55         dma_addr_t addr;        /* physical address */
  56         size_t bytes;           /* buffer size in bytes */
  57         void *private_data;     /* private for allocator; don't touch */
  58 };
  59
  60 /*
  61  * return the pages matching with the given byte size
  62  */
  63 static inline unsigned int snd_sgbuf_aligned_pages(size_t size)
  64 {
  65         return (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
  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 physical address at the corresponding offset
  93  */
  94 static inline dma_addr_t snd_sgbuf_get_addr(struct snd_dma_buffer *dmab,
  95                                            size_t offset)
  96 {
  97         struct snd_sg_buf *sgbuf = dmab->private_data;
  98         dma_addr_t addr = sgbuf->table[offset >> PAGE_SHIFT].addr;
  99         addr &= ~((dma_addr_t)PAGE_SIZE - 1);
 100         return addr + offset % PAGE_SIZE;
 101 }
 102
 103 /*
 104  * return the virtual address at the corresponding offset
 105  */
 106 static inline void *snd_sgbuf_get_ptr(struct snd_dma_buffer *dmab,
 107                                      size_t offset)
 108 {
 109         struct snd_sg_buf *sgbuf = dmab->private_data;
 110         return sgbuf->table[offset >> PAGE_SHIFT].buf + offset % PAGE_SIZE;
 111 }
 112
 113 unsigned int snd_sgbuf_get_chunk_size(struct snd_dma_buffer *dmab,
 114                                       unsigned int ofs, unsigned int size);
 115 #else
 116 /* non-SG versions */
 117 static inline dma_addr_t snd_sgbuf_get_addr(struct snd_dma_buffer *dmab,
 118                                             size_t offset)
 119 {
 120         return dmab->addr + offset;
 121 }
 122
 123 static inline void *snd_sgbuf_get_ptr(struct snd_dma_buffer *dmab,
 124                                       size_t offset)
 125 {
 126         return dmab->area + offset;
 127 }
 128
 129 #define snd_sgbuf_get_chunk_size(dmab, ofs, size)       (size)
 130
 131 #endif /* CONFIG_SND_DMA_SGBUF */
 132
 133 /* allocate/release a buffer */
 134 int snd_dma_alloc_pages(int type, struct device *dev, size_t size,
 135                         struct snd_dma_buffer *dmab);
 136 int snd_dma_alloc_pages_fallback(int type, struct device *dev, size_t size,
 137                                  struct snd_dma_buffer *dmab);
 138 void snd_dma_free_pages(struct snd_dma_buffer *dmab);
 139
 140 #endif /* __SOUND_MEMALLOC_H */
 141