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