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