GNU Linux-libre 4.9.333-gnu1
[releases.git] / sound / core / memalloc.c
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 #include <linux/slab.h>
25 #include <linux/mm.h>
26 #include <linux/dma-mapping.h>
27 #include <linux/genalloc.h>
28 #include <sound/memalloc.h>
29
30 /*
31  *
32  *  Generic memory allocators
33  *
34  */
35
36 /**
37  * snd_malloc_pages - allocate pages with the given size
38  * @size: the size to allocate in bytes
39  * @gfp_flags: the allocation conditions, GFP_XXX
40  *
41  * Allocates the physically contiguous pages with the given size.
42  *
43  * Return: The pointer of the buffer, or %NULL if no enough memory.
44  */
45 void *snd_malloc_pages(size_t size, gfp_t gfp_flags)
46 {
47         int pg;
48
49         if (WARN_ON(!size))
50                 return NULL;
51         if (WARN_ON(!gfp_flags))
52                 return NULL;
53         gfp_flags |= __GFP_COMP;        /* compound page lets parts be mapped */
54         pg = get_order(size);
55         return (void *) __get_free_pages(gfp_flags, pg);
56 }
57
58 /**
59  * snd_free_pages - release the pages
60  * @ptr: the buffer pointer to release
61  * @size: the allocated buffer size
62  *
63  * Releases the buffer allocated via snd_malloc_pages().
64  */
65 void snd_free_pages(void *ptr, size_t size)
66 {
67         int pg;
68
69         if (ptr == NULL)
70                 return;
71         pg = get_order(size);
72         free_pages((unsigned long) ptr, pg);
73 }
74
75 /*
76  *
77  *  Bus-specific memory allocators
78  *
79  */
80
81 #ifdef CONFIG_HAS_DMA
82 /* allocate the coherent DMA pages */
83 static void *snd_malloc_dev_pages(struct device *dev, size_t size, dma_addr_t *dma)
84 {
85         int pg;
86         gfp_t gfp_flags;
87
88         if (WARN_ON(!dma))
89                 return NULL;
90         pg = get_order(size);
91         gfp_flags = GFP_KERNEL
92                 | __GFP_COMP    /* compound page lets parts be mapped */
93                 | __GFP_NORETRY /* don't trigger OOM-killer */
94                 | __GFP_NOWARN; /* no stack trace print - this call is non-critical */
95         return dma_alloc_coherent(dev, PAGE_SIZE << pg, dma, gfp_flags);
96 }
97
98 /* free the coherent DMA pages */
99 static void snd_free_dev_pages(struct device *dev, size_t size, void *ptr,
100                                dma_addr_t dma)
101 {
102         int pg;
103
104         if (ptr == NULL)
105                 return;
106         pg = get_order(size);
107         dma_free_coherent(dev, PAGE_SIZE << pg, ptr, dma);
108 }
109
110 #ifdef CONFIG_GENERIC_ALLOCATOR
111 /**
112  * snd_malloc_dev_iram - allocate memory from on-chip internal ram
113  * @dmab: buffer allocation record to store the allocated data
114  * @size: number of bytes to allocate from the iram
115  *
116  * This function requires iram phandle provided via of_node
117  */
118 static void snd_malloc_dev_iram(struct snd_dma_buffer *dmab, size_t size)
119 {
120         struct device *dev = dmab->dev.dev;
121         struct gen_pool *pool = NULL;
122
123         dmab->area = NULL;
124         dmab->addr = 0;
125
126         if (dev->of_node)
127                 pool = of_gen_pool_get(dev->of_node, "iram", 0);
128
129         if (!pool)
130                 return;
131
132         /* Assign the pool into private_data field */
133         dmab->private_data = pool;
134
135         dmab->area = gen_pool_dma_alloc(pool, size, &dmab->addr);
136 }
137
138 /**
139  * snd_free_dev_iram - free allocated specific memory from on-chip internal ram
140  * @dmab: buffer allocation record to store the allocated data
141  */
142 static void snd_free_dev_iram(struct snd_dma_buffer *dmab)
143 {
144         struct gen_pool *pool = dmab->private_data;
145
146         if (pool && dmab->area)
147                 gen_pool_free(pool, (unsigned long)dmab->area, dmab->bytes);
148 }
149 #endif /* CONFIG_GENERIC_ALLOCATOR */
150 #endif /* CONFIG_HAS_DMA */
151
152 /*
153  *
154  *  ALSA generic memory management
155  *
156  */
157
158
159 /**
160  * snd_dma_alloc_pages - allocate the buffer area according to the given type
161  * @type: the DMA buffer type
162  * @device: the device pointer
163  * @size: the buffer size to allocate
164  * @dmab: buffer allocation record to store the allocated data
165  *
166  * Calls the memory-allocator function for the corresponding
167  * buffer type.
168  *
169  * Return: Zero if the buffer with the given size is allocated successfully,
170  * otherwise a negative value on error.
171  */
172 int snd_dma_alloc_pages(int type, struct device *device, size_t size,
173                         struct snd_dma_buffer *dmab)
174 {
175         if (WARN_ON(!size))
176                 return -ENXIO;
177         if (WARN_ON(!dmab))
178                 return -ENXIO;
179
180         size = PAGE_ALIGN(size);
181         dmab->dev.type = type;
182         dmab->dev.dev = device;
183         dmab->bytes = 0;
184         switch (type) {
185         case SNDRV_DMA_TYPE_CONTINUOUS:
186                 dmab->area = snd_malloc_pages(size,
187                                         (__force gfp_t)(unsigned long)device);
188                 dmab->addr = 0;
189                 break;
190 #ifdef CONFIG_HAS_DMA
191 #ifdef CONFIG_GENERIC_ALLOCATOR
192         case SNDRV_DMA_TYPE_DEV_IRAM:
193                 snd_malloc_dev_iram(dmab, size);
194                 if (dmab->area)
195                         break;
196                 /* Internal memory might have limited size and no enough space,
197                  * so if we fail to malloc, try to fetch memory traditionally.
198                  */
199                 dmab->dev.type = SNDRV_DMA_TYPE_DEV;
200 #endif /* CONFIG_GENERIC_ALLOCATOR */
201         case SNDRV_DMA_TYPE_DEV:
202                 dmab->area = snd_malloc_dev_pages(device, size, &dmab->addr);
203                 break;
204 #endif
205 #ifdef CONFIG_SND_DMA_SGBUF
206         case SNDRV_DMA_TYPE_DEV_SG:
207                 snd_malloc_sgbuf_pages(device, size, dmab, NULL);
208                 break;
209 #endif
210         default:
211                 pr_err("snd-malloc: invalid device type %d\n", type);
212                 dmab->area = NULL;
213                 dmab->addr = 0;
214                 return -ENXIO;
215         }
216         if (! dmab->area)
217                 return -ENOMEM;
218         dmab->bytes = size;
219         return 0;
220 }
221
222 /**
223  * snd_dma_alloc_pages_fallback - allocate the buffer area according to the given type with fallback
224  * @type: the DMA buffer type
225  * @device: the device pointer
226  * @size: the buffer size to allocate
227  * @dmab: buffer allocation record to store the allocated data
228  *
229  * Calls the memory-allocator function for the corresponding
230  * buffer type.  When no space is left, this function reduces the size and
231  * tries to allocate again.  The size actually allocated is stored in
232  * res_size argument.
233  *
234  * Return: Zero if the buffer with the given size is allocated successfully,
235  * otherwise a negative value on error.
236  */
237 int snd_dma_alloc_pages_fallback(int type, struct device *device, size_t size,
238                                  struct snd_dma_buffer *dmab)
239 {
240         int err;
241
242         while ((err = snd_dma_alloc_pages(type, device, size, dmab)) < 0) {
243                 if (err != -ENOMEM)
244                         return err;
245                 if (size <= PAGE_SIZE)
246                         return -ENOMEM;
247                 size >>= 1;
248                 size = PAGE_SIZE << get_order(size);
249         }
250         if (! dmab->area)
251                 return -ENOMEM;
252         return 0;
253 }
254
255
256 /**
257  * snd_dma_free_pages - release the allocated buffer
258  * @dmab: the buffer allocation record to release
259  *
260  * Releases the allocated buffer via snd_dma_alloc_pages().
261  */
262 void snd_dma_free_pages(struct snd_dma_buffer *dmab)
263 {
264         switch (dmab->dev.type) {
265         case SNDRV_DMA_TYPE_CONTINUOUS:
266                 snd_free_pages(dmab->area, dmab->bytes);
267                 break;
268 #ifdef CONFIG_HAS_DMA
269 #ifdef CONFIG_GENERIC_ALLOCATOR
270         case SNDRV_DMA_TYPE_DEV_IRAM:
271                 snd_free_dev_iram(dmab);
272                 break;
273 #endif /* CONFIG_GENERIC_ALLOCATOR */
274         case SNDRV_DMA_TYPE_DEV:
275                 snd_free_dev_pages(dmab->dev.dev, dmab->bytes, dmab->area, dmab->addr);
276                 break;
277 #endif
278 #ifdef CONFIG_SND_DMA_SGBUF
279         case SNDRV_DMA_TYPE_DEV_SG:
280                 snd_free_sgbuf_pages(dmab);
281                 break;
282 #endif
283         default:
284                 pr_err("snd-malloc: invalid device type %d\n", dmab->dev.type);
285         }
286 }
287
288 /*
289  * exports
290  */
291 EXPORT_SYMBOL(snd_dma_alloc_pages);
292 EXPORT_SYMBOL(snd_dma_alloc_pages_fallback);
293 EXPORT_SYMBOL(snd_dma_free_pages);
294
295 EXPORT_SYMBOL(snd_malloc_pages);
296 EXPORT_SYMBOL(snd_free_pages);