xref: /openbmc/linux/include/sound/memalloc.h (revision 2c684d89)
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 #ifdef CONFIG_GENERIC_ALLOCATOR
56 #define SNDRV_DMA_TYPE_DEV_IRAM		4	/* generic device iram-buffer */
57 #else
58 #define SNDRV_DMA_TYPE_DEV_IRAM	SNDRV_DMA_TYPE_DEV
59 #endif
60 
61 /*
62  * info for buffer allocation
63  */
64 struct snd_dma_buffer {
65 	struct snd_dma_device dev;	/* device type */
66 	unsigned char *area;	/* virtual pointer */
67 	dma_addr_t addr;	/* physical address */
68 	size_t bytes;		/* buffer size in bytes */
69 	void *private_data;	/* private for allocator; don't touch */
70 };
71 
72 #ifdef CONFIG_SND_DMA_SGBUF
73 /*
74  * Scatter-Gather generic device pages
75  */
76 void *snd_malloc_sgbuf_pages(struct device *device,
77 			     size_t size, struct snd_dma_buffer *dmab,
78 			     size_t *res_size);
79 int snd_free_sgbuf_pages(struct snd_dma_buffer *dmab);
80 
81 struct snd_sg_page {
82 	void *buf;
83 	dma_addr_t addr;
84 };
85 
86 struct snd_sg_buf {
87 	int size;	/* allocated byte size */
88 	int pages;	/* allocated pages */
89 	int tblsize;	/* allocated table size */
90 	struct snd_sg_page *table;	/* address table */
91 	struct page **page_table;	/* page table (for vmap/vunmap) */
92 	struct device *dev;
93 };
94 
95 /*
96  * return the pages matching with the given byte size
97  */
98 static inline unsigned int snd_sgbuf_aligned_pages(size_t size)
99 {
100 	return (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
101 }
102 
103 /*
104  * return the physical address at the corresponding offset
105  */
106 static inline dma_addr_t snd_sgbuf_get_addr(struct snd_dma_buffer *dmab,
107 					   size_t offset)
108 {
109 	struct snd_sg_buf *sgbuf = dmab->private_data;
110 	dma_addr_t addr = sgbuf->table[offset >> PAGE_SHIFT].addr;
111 	addr &= ~((dma_addr_t)PAGE_SIZE - 1);
112 	return addr + offset % PAGE_SIZE;
113 }
114 
115 /*
116  * return the virtual address at the corresponding offset
117  */
118 static inline void *snd_sgbuf_get_ptr(struct snd_dma_buffer *dmab,
119 				     size_t offset)
120 {
121 	struct snd_sg_buf *sgbuf = dmab->private_data;
122 	return sgbuf->table[offset >> PAGE_SHIFT].buf + offset % PAGE_SIZE;
123 }
124 
125 unsigned int snd_sgbuf_get_chunk_size(struct snd_dma_buffer *dmab,
126 				      unsigned int ofs, unsigned int size);
127 #else
128 /* non-SG versions */
129 static inline dma_addr_t snd_sgbuf_get_addr(struct snd_dma_buffer *dmab,
130 					    size_t offset)
131 {
132 	return dmab->addr + offset;
133 }
134 
135 static inline void *snd_sgbuf_get_ptr(struct snd_dma_buffer *dmab,
136 				      size_t offset)
137 {
138 	return dmab->area + offset;
139 }
140 
141 #define snd_sgbuf_get_chunk_size(dmab, ofs, size)	(size)
142 
143 #endif /* CONFIG_SND_DMA_SGBUF */
144 
145 /* allocate/release a buffer */
146 int snd_dma_alloc_pages(int type, struct device *dev, size_t size,
147 			struct snd_dma_buffer *dmab);
148 int snd_dma_alloc_pages_fallback(int type, struct device *dev, size_t size,
149                                  struct snd_dma_buffer *dmab);
150 void snd_dma_free_pages(struct snd_dma_buffer *dmab);
151 
152 /* basic memory allocation functions */
153 void *snd_malloc_pages(size_t size, gfp_t gfp_flags);
154 void snd_free_pages(void *ptr, size_t size);
155 
156 #endif /* __SOUND_MEMALLOC_H */
157 
158