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