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 <linux/dma-direction.h>
  13 #include <asm/page.h>
  14
  15 struct device;
  16 struct vm_area_struct;
  17 struct sg_table;
  18
  19 /*
  20  * buffer device info
  21  */
  22 struct snd_dma_device {
  23         int type;                       /* SNDRV_DMA_TYPE_XXX */
  24         enum dma_data_direction dir;    /* DMA direction */
  25         bool need_sync;                 /* explicit sync needed? */
  26         struct device *dev;             /* generic device */
  27 };
  28
  29 #define snd_dma_continuous_data(x)      ((struct device *)(__force unsigned long)(x))
  30
  31
  32 /*
  33  * buffer types
  34  */
  35 #define SNDRV_DMA_TYPE_UNKNOWN          0       /* not defined */
  36 #define SNDRV_DMA_TYPE_CONTINUOUS       1       /* continuous no-DMA memory */
  37 #define SNDRV_DMA_TYPE_DEV              2       /* generic device continuous */
  38 #define SNDRV_DMA_TYPE_DEV_WC           5       /* continuous write-combined */
  39 #ifdef CONFIG_GENERIC_ALLOCATOR
  40 #define SNDRV_DMA_TYPE_DEV_IRAM         4       /* generic device iram-buffer */
  41 #else
  42 #define SNDRV_DMA_TYPE_DEV_IRAM SNDRV_DMA_TYPE_DEV
  43 #endif
  44 #define SNDRV_DMA_TYPE_VMALLOC          7       /* vmalloc'ed buffer */
  45 #define SNDRV_DMA_TYPE_NONCONTIG        8       /* non-coherent SG buffer */
  46 #define SNDRV_DMA_TYPE_NONCOHERENT      9       /* non-coherent buffer */
  47 #ifdef CONFIG_SND_DMA_SGBUF
  48 #define SNDRV_DMA_TYPE_DEV_SG           SNDRV_DMA_TYPE_NONCONTIG
  49 #define SNDRV_DMA_TYPE_DEV_WC_SG        6       /* SG write-combined */
  50 #else
  51 #define SNDRV_DMA_TYPE_DEV_SG   SNDRV_DMA_TYPE_DEV /* no SG-buf support */
  52 #define SNDRV_DMA_TYPE_DEV_WC_SG        SNDRV_DMA_TYPE_DEV_WC
  53 #endif
  54
  55 /*
  56  * info for buffer allocation
  57  */
  58 struct snd_dma_buffer {
  59         struct snd_dma_device dev;      /* device type */
  60         unsigned char *area;    /* virtual pointer */
  61         dma_addr_t addr;        /* physical address */
  62         size_t bytes;           /* buffer size in bytes */
  63         void *private_data;     /* private for allocator; don't touch */
  64 };
  65
  66 /*
  67  * return the pages matching with the given byte size
  68  */
  69 static inline unsigned int snd_sgbuf_aligned_pages(size_t size)
  70 {
  71         return (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
  72 }
  73
  74 /* allocate/release a buffer */
  75 int snd_dma_alloc_dir_pages(int type, struct device *dev,
  76                             enum dma_data_direction dir, size_t size,
  77                             struct snd_dma_buffer *dmab);
  78
  79 static inline int snd_dma_alloc_pages(int type, struct device *dev,
  80                                       size_t size, struct snd_dma_buffer *dmab)
  81 {
  82         return snd_dma_alloc_dir_pages(type, dev, DMA_BIDIRECTIONAL, size, dmab);
  83 }
  84
  85 int snd_dma_alloc_pages_fallback(int type, struct device *dev, size_t size,
  86                                  struct snd_dma_buffer *dmab);
  87 void snd_dma_free_pages(struct snd_dma_buffer *dmab);
  88 int snd_dma_buffer_mmap(struct snd_dma_buffer *dmab,
  89                         struct vm_area_struct *area);
  90
  91 enum snd_dma_sync_mode { SNDRV_DMA_SYNC_CPU, SNDRV_DMA_SYNC_DEVICE };
  92 #ifdef CONFIG_HAS_DMA
  93 void snd_dma_buffer_sync(struct snd_dma_buffer *dmab,
  94                          enum snd_dma_sync_mode mode);
  95 #else
  96 static inline void snd_dma_buffer_sync(struct snd_dma_buffer *dmab,
  97                                        enum snd_dma_sync_mode mode) {}
  98 #endif
  99
 100 dma_addr_t snd_sgbuf_get_addr(struct snd_dma_buffer *dmab, size_t offset);
 101 struct page *snd_sgbuf_get_page(struct snd_dma_buffer *dmab, size_t offset);
 102 unsigned int snd_sgbuf_get_chunk_size(struct snd_dma_buffer *dmab,
 103                                       unsigned int ofs, unsigned int size);
 104
 105 /* device-managed memory allocator */
 106 struct snd_dma_buffer *snd_devm_alloc_dir_pages(struct device *dev, int type,
 107                                                 enum dma_data_direction dir,
 108                                                 size_t size);
 109
 110 static inline struct snd_dma_buffer *
 111 snd_devm_alloc_pages(struct device *dev, int type, size_t size)
 112 {
 113         return snd_devm_alloc_dir_pages(dev, type, DMA_BIDIRECTIONAL, size);
 114 }
 115
 116 static inline struct sg_table *
 117 snd_dma_noncontig_sg_table(struct snd_dma_buffer *dmab)
 118 {
 119         return dmab->private_data;
 120 }
 121
 122 #endif /* __SOUND_MEMALLOC_H */
 123