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