Commit | Line | Data |
---|---|---|
c30707be RSZ |
1 | /* |
2 | * drivers/staging/android/ion/ion_priv.h | |
3 | * | |
4 | * Copyright (C) 2011 Google, Inc. | |
5 | * | |
6 | * This software is licensed under the terms of the GNU General Public | |
7 | * License version 2, as published by the Free Software Foundation, and | |
8 | * may be copied, distributed, and modified under those terms. | |
9 | * | |
10 | * This program is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
13 | * GNU General Public License for more details. | |
14 | * | |
15 | */ | |
16 | ||
17 | #ifndef _ION_PRIV_H | |
18 | #define _ION_PRIV_H | |
19 | ||
e946b209 | 20 | #include <linux/dma-direction.h> |
c30707be RSZ |
21 | #include <linux/kref.h> |
22 | #include <linux/mm_types.h> | |
23 | #include <linux/mutex.h> | |
24 | #include <linux/rbtree.h> | |
5ad7bc3a | 25 | #include <linux/sched.h> |
0214c7f2 RSZ |
26 | #include <linux/shrinker.h> |
27 | #include <linux/types.h> | |
c30707be RSZ |
28 | |
29 | #include "ion.h" | |
30 | ||
c30707be RSZ |
31 | struct ion_buffer *ion_handle_buffer(struct ion_handle *handle); |
32 | ||
33 | /** | |
34 | * struct ion_buffer - metadata for a particular buffer | |
35 | * @ref: refernce count | |
36 | * @node: node in the ion_device buffers tree | |
37 | * @dev: back pointer to the ion_device | |
38 | * @heap: back pointer to the heap the buffer came from | |
39 | * @flags: buffer specific flags | |
40 | * @size: size of the buffer | |
41 | * @priv_virt: private data to the buffer representable as | |
42 | * a void * | |
43 | * @priv_phys: private data to the buffer representable as | |
44 | * an ion_phys_addr_t (and someday a phys_addr_t) | |
45 | * @lock: protects the buffers cnt fields | |
46 | * @kmap_cnt: number of times the buffer is mapped to the kernel | |
47 | * @vaddr: the kenrel mapping if kmap_cnt is not zero | |
48 | * @dmap_cnt: number of times the buffer is mapped for dma | |
4d5ca329 | 49 | * @sg_table: the sg table for the buffer if dmap_cnt is not zero |
c13bd1c4 RSZ |
50 | * @pages: flat array of pages in the buffer -- used by fault |
51 | * handler and only valid for buffers that are faulted in | |
5ad7bc3a RSZ |
52 | * @vmas: list of vma's mapping this buffer |
53 | * @handle_count: count of handles referencing this buffer | |
54 | * @task_comm: taskcomm of last client to reference this buffer in a | |
55 | * handle, used for debugging | |
56 | * @pid: pid of last client to reference this buffer in a | |
57 | * handle, used for debugging | |
c30707be RSZ |
58 | */ |
59 | struct ion_buffer { | |
60 | struct kref ref; | |
fe2faea7 RSZ |
61 | union { |
62 | struct rb_node node; | |
63 | struct list_head list; | |
64 | }; | |
c30707be RSZ |
65 | struct ion_device *dev; |
66 | struct ion_heap *heap; | |
67 | unsigned long flags; | |
68 | size_t size; | |
69 | union { | |
70 | void *priv_virt; | |
71 | ion_phys_addr_t priv_phys; | |
72 | }; | |
73 | struct mutex lock; | |
74 | int kmap_cnt; | |
75 | void *vaddr; | |
76 | int dmap_cnt; | |
4d5ca329 | 77 | struct sg_table *sg_table; |
c13bd1c4 | 78 | struct page **pages; |
56a7c185 | 79 | struct list_head vmas; |
5ad7bc3a RSZ |
80 | /* used to track orphaned buffers */ |
81 | int handle_count; | |
82 | char task_comm[TASK_COMM_LEN]; | |
83 | pid_t pid; | |
c30707be | 84 | }; |
ea313b5f | 85 | void ion_buffer_destroy(struct ion_buffer *buffer); |
c30707be RSZ |
86 | |
87 | /** | |
88 | * struct ion_heap_ops - ops to operate on a given heap | |
89 | * @allocate: allocate memory | |
90 | * @free: free memory | |
91 | * @phys get physical address of a buffer (only define on | |
92 | * physically contiguous heaps) | |
93 | * @map_dma map the memory for dma to a scatterlist | |
94 | * @unmap_dma unmap the memory for dma | |
95 | * @map_kernel map memory to the kernel | |
96 | * @unmap_kernel unmap memory to the kernel | |
97 | * @map_user map memory to userspace | |
9e907654 CC |
98 | * |
99 | * allocate, phys, and map_user return 0 on success, -errno on error. | |
100 | * map_dma and map_kernel return pointer on success, ERR_PTR on error. | |
c30707be RSZ |
101 | */ |
102 | struct ion_heap_ops { | |
103 | int (*allocate) (struct ion_heap *heap, | |
104 | struct ion_buffer *buffer, unsigned long len, | |
105 | unsigned long align, unsigned long flags); | |
106 | void (*free) (struct ion_buffer *buffer); | |
107 | int (*phys) (struct ion_heap *heap, struct ion_buffer *buffer, | |
108 | ion_phys_addr_t *addr, size_t *len); | |
4d5ca329 | 109 | struct sg_table *(*map_dma) (struct ion_heap *heap, |
c30707be RSZ |
110 | struct ion_buffer *buffer); |
111 | void (*unmap_dma) (struct ion_heap *heap, struct ion_buffer *buffer); | |
112 | void * (*map_kernel) (struct ion_heap *heap, struct ion_buffer *buffer); | |
113 | void (*unmap_kernel) (struct ion_heap *heap, struct ion_buffer *buffer); | |
114 | int (*map_user) (struct ion_heap *mapper, struct ion_buffer *buffer, | |
115 | struct vm_area_struct *vma); | |
116 | }; | |
117 | ||
fe2faea7 RSZ |
118 | /** |
119 | * heap flags - flags between the heaps and core ion code | |
120 | */ | |
121 | #define ION_HEAP_FLAG_DEFER_FREE (1 << 0) | |
122 | ||
c30707be RSZ |
123 | /** |
124 | * struct ion_heap - represents a heap in the system | |
125 | * @node: rb node to put the heap on the device's tree of heaps | |
126 | * @dev: back pointer to the ion_device | |
127 | * @type: type of heap | |
128 | * @ops: ops struct as above | |
fe2faea7 | 129 | * @flags: flags |
c30707be RSZ |
130 | * @id: id of heap, also indicates priority of this heap when |
131 | * allocating. These are specified by platform data and | |
132 | * MUST be unique | |
133 | * @name: used for debugging | |
ea313b5f RSZ |
134 | * @shrinker: a shrinker for the heap, if the heap caches system |
135 | * memory, it must define a shrinker to return it on low | |
136 | * memory conditions, this includes system memory cached | |
137 | * in the deferred free lists for heaps that support it | |
fe2faea7 | 138 | * @free_list: free list head if deferred free is used |
ea313b5f | 139 | * @free_list_size size of the deferred free list in bytes |
fe2faea7 RSZ |
140 | * @lock: protects the free list |
141 | * @waitqueue: queue to wait on from deferred free thread | |
142 | * @task: task struct of deferred free thread | |
45b17a80 RSZ |
143 | * @debug_show: called when heap debug file is read to add any |
144 | * heap specific debug info to output | |
c30707be RSZ |
145 | * |
146 | * Represents a pool of memory from which buffers can be made. In some | |
147 | * systems the only heap is regular system memory allocated via vmalloc. | |
148 | * On others, some blocks might require large physically contiguous buffers | |
149 | * that are allocated from a specially reserved heap. | |
150 | */ | |
151 | struct ion_heap { | |
cd69488c | 152 | struct plist_node node; |
c30707be RSZ |
153 | struct ion_device *dev; |
154 | enum ion_heap_type type; | |
155 | struct ion_heap_ops *ops; | |
fe2faea7 | 156 | unsigned long flags; |
cd69488c | 157 | unsigned int id; |
c30707be | 158 | const char *name; |
ea313b5f | 159 | struct shrinker shrinker; |
fe2faea7 | 160 | struct list_head free_list; |
ea313b5f | 161 | size_t free_list_size; |
fe2faea7 RSZ |
162 | struct rt_mutex lock; |
163 | wait_queue_head_t waitqueue; | |
164 | struct task_struct *task; | |
45b17a80 | 165 | int (*debug_show)(struct ion_heap *heap, struct seq_file *, void *); |
c30707be RSZ |
166 | }; |
167 | ||
45b17a80 RSZ |
168 | /** |
169 | * ion_buffer_cached - this ion buffer is cached | |
170 | * @buffer: buffer | |
171 | * | |
172 | * indicates whether this ion buffer is cached | |
173 | */ | |
174 | bool ion_buffer_cached(struct ion_buffer *buffer); | |
175 | ||
13ba7805 RSZ |
176 | /** |
177 | * ion_buffer_fault_user_mappings - fault in user mappings of this buffer | |
178 | * @buffer: buffer | |
179 | * | |
180 | * indicates whether userspace mappings of this buffer will be faulted | |
181 | * in, this can affect how buffers are allocated from the heap. | |
182 | */ | |
183 | bool ion_buffer_fault_user_mappings(struct ion_buffer *buffer); | |
184 | ||
c30707be RSZ |
185 | /** |
186 | * ion_device_create - allocates and returns an ion device | |
187 | * @custom_ioctl: arch specific ioctl function if applicable | |
188 | * | |
189 | * returns a valid device or -PTR_ERR | |
190 | */ | |
191 | struct ion_device *ion_device_create(long (*custom_ioctl) | |
192 | (struct ion_client *client, | |
193 | unsigned int cmd, | |
194 | unsigned long arg)); | |
195 | ||
196 | /** | |
197 | * ion_device_destroy - free and device and it's resource | |
198 | * @dev: the device | |
199 | */ | |
200 | void ion_device_destroy(struct ion_device *dev); | |
201 | ||
202 | /** | |
203 | * ion_device_add_heap - adds a heap to the ion device | |
204 | * @dev: the device | |
205 | * @heap: the heap to add | |
206 | */ | |
207 | void ion_device_add_heap(struct ion_device *dev, struct ion_heap *heap); | |
208 | ||
8898227e RSZ |
209 | /** |
210 | * some helpers for common operations on buffers using the sg_table | |
211 | * and vaddr fields | |
212 | */ | |
213 | void *ion_heap_map_kernel(struct ion_heap *, struct ion_buffer *); | |
214 | void ion_heap_unmap_kernel(struct ion_heap *, struct ion_buffer *); | |
215 | int ion_heap_map_user(struct ion_heap *, struct ion_buffer *, | |
216 | struct vm_area_struct *); | |
0b6b2cde | 217 | int ion_heap_buffer_zero(struct ion_buffer *buffer); |
8898227e | 218 | |
c13bd1c4 RSZ |
219 | /** |
220 | * ion_heap_alloc_pages - allocate pages from alloc_pages | |
221 | * @buffer: the buffer to allocate for, used to extract the flags | |
222 | * @gfp_flags: the gfp_t for the allocation | |
223 | * @order: the order of the allocatoin | |
224 | * | |
225 | * This funciton allocations from alloc pages and also does any other | |
226 | * necessary operations based on the buffer->flags. For buffers which | |
227 | * will be faulted in the pages are split using split_page | |
228 | */ | |
229 | struct page *ion_heap_alloc_pages(struct ion_buffer *buffer, gfp_t gfp_flags, | |
230 | unsigned int order); | |
231 | ||
ea313b5f RSZ |
232 | /** |
233 | * ion_heap_init_deferred_free -- initialize deferred free functionality | |
234 | * @heap: the heap | |
235 | * | |
236 | * If a heap sets the ION_HEAP_FLAG_DEFER_FREE flag this function will | |
237 | * be called to setup deferred frees. Calls to free the buffer will | |
238 | * return immediately and the actual free will occur some time later | |
239 | */ | |
240 | int ion_heap_init_deferred_free(struct ion_heap *heap); | |
241 | ||
242 | /** | |
243 | * ion_heap_freelist_add - add a buffer to the deferred free list | |
244 | * @heap: the heap | |
245 | * @buffer: the buffer | |
246 | * | |
247 | * Adds an item to the deferred freelist. | |
248 | */ | |
249 | void ion_heap_freelist_add(struct ion_heap *heap, struct ion_buffer *buffer); | |
250 | ||
251 | /** | |
252 | * ion_heap_freelist_drain - drain the deferred free list | |
253 | * @heap: the heap | |
254 | * @size: ammount of memory to drain in bytes | |
255 | * | |
256 | * Drains the indicated amount of memory from the deferred freelist immediately. | |
257 | * Returns the total amount freed. The total freed may be higher depending | |
258 | * on the size of the items in the list, or lower if there is insufficient | |
259 | * total memory on the freelist. | |
260 | */ | |
261 | size_t ion_heap_freelist_drain(struct ion_heap *heap, size_t size); | |
262 | ||
263 | /** | |
264 | * ion_heap_freelist_size - returns the size of the freelist in bytes | |
265 | * @heap: the heap | |
266 | */ | |
267 | size_t ion_heap_freelist_size(struct ion_heap *heap); | |
268 | ||
8898227e | 269 | |
c30707be RSZ |
270 | /** |
271 | * functions for creating and destroying the built in ion heaps. | |
272 | * architectures can add their own custom architecture specific | |
273 | * heaps as appropriate. | |
274 | */ | |
275 | ||
276 | struct ion_heap *ion_heap_create(struct ion_platform_heap *); | |
277 | void ion_heap_destroy(struct ion_heap *); | |
c30707be RSZ |
278 | struct ion_heap *ion_system_heap_create(struct ion_platform_heap *); |
279 | void ion_system_heap_destroy(struct ion_heap *); | |
280 | ||
281 | struct ion_heap *ion_system_contig_heap_create(struct ion_platform_heap *); | |
282 | void ion_system_contig_heap_destroy(struct ion_heap *); | |
283 | ||
284 | struct ion_heap *ion_carveout_heap_create(struct ion_platform_heap *); | |
285 | void ion_carveout_heap_destroy(struct ion_heap *); | |
e3c2eb7c RSZ |
286 | |
287 | struct ion_heap *ion_chunk_heap_create(struct ion_platform_heap *); | |
288 | void ion_chunk_heap_destroy(struct ion_heap *); | |
349c9e13 BG |
289 | struct ion_heap *ion_cma_heap_create(struct ion_platform_heap *); |
290 | void ion_cma_heap_destroy(struct ion_heap *); | |
291 | ||
c30707be RSZ |
292 | /** |
293 | * kernel api to allocate/free from carveout -- used when carveout is | |
294 | * used to back an architecture specific custom heap | |
295 | */ | |
296 | ion_phys_addr_t ion_carveout_allocate(struct ion_heap *heap, unsigned long size, | |
297 | unsigned long align); | |
298 | void ion_carveout_free(struct ion_heap *heap, ion_phys_addr_t addr, | |
299 | unsigned long size); | |
300 | /** | |
301 | * The carveout heap returns physical addresses, since 0 may be a valid | |
302 | * physical address, this is used to indicate allocation failed | |
303 | */ | |
304 | #define ION_CARVEOUT_ALLOCATE_FAIL -1 | |
305 | ||
0214c7f2 RSZ |
306 | /** |
307 | * functions for creating and destroying a heap pool -- allows you | |
308 | * to keep a pool of pre allocated memory to use from your heap. Keeping | |
309 | * a pool of memory that is ready for dma, ie any cached mapping have been | |
310 | * invalidated from the cache, provides a significant peformance benefit on | |
311 | * many systems */ | |
312 | ||
313 | /** | |
314 | * struct ion_page_pool - pagepool struct | |
0fb9b815 RSZ |
315 | * @high_count: number of highmem items in the pool |
316 | * @low_count: number of lowmem items in the pool | |
317 | * @high_items: list of highmem items | |
318 | * @low_items: list of lowmem items | |
0214c7f2 RSZ |
319 | * @shrinker: a shrinker for the items |
320 | * @mutex: lock protecting this struct and especially the count | |
321 | * item list | |
322 | * @alloc: function to be used to allocate pageory when the pool | |
323 | * is empty | |
324 | * @free: function to be used to free pageory back to the system | |
325 | * when the shrinker fires | |
326 | * @gfp_mask: gfp_mask to use from alloc | |
327 | * @order: order of pages in the pool | |
797a95c4 | 328 | * @list: plist node for list of pools |
0214c7f2 RSZ |
329 | * |
330 | * Allows you to keep a pool of pre allocated pages to use from your heap. | |
331 | * Keeping a pool of pages that is ready for dma, ie any cached mapping have | |
332 | * been invalidated from the cache, provides a significant peformance benefit | |
333 | * on many systems | |
334 | */ | |
335 | struct ion_page_pool { | |
0fb9b815 RSZ |
336 | int high_count; |
337 | int low_count; | |
338 | struct list_head high_items; | |
339 | struct list_head low_items; | |
0214c7f2 | 340 | struct mutex mutex; |
0214c7f2 RSZ |
341 | gfp_t gfp_mask; |
342 | unsigned int order; | |
797a95c4 | 343 | struct plist_node list; |
0214c7f2 RSZ |
344 | }; |
345 | ||
346 | struct ion_page_pool *ion_page_pool_create(gfp_t gfp_mask, unsigned int order); | |
347 | void ion_page_pool_destroy(struct ion_page_pool *); | |
348 | void *ion_page_pool_alloc(struct ion_page_pool *); | |
349 | void ion_page_pool_free(struct ion_page_pool *, struct page *); | |
350 | ||
ea313b5f RSZ |
351 | /** ion_page_pool_shrink - shrinks the size of the memory cached in the pool |
352 | * @pool: the pool | |
353 | * @gfp_mask: the memory type to reclaim | |
354 | * @nr_to_scan: number of items to shrink in pages | |
355 | * | |
356 | * returns the number of items freed in pages | |
357 | */ | |
358 | int ion_page_pool_shrink(struct ion_page_pool *pool, gfp_t gfp_mask, | |
359 | int nr_to_scan); | |
360 | ||
e946b209 CC |
361 | /** |
362 | * ion_pages_sync_for_device - cache flush pages for use with the specified | |
363 | * device | |
364 | * @dev: the device the pages will be used with | |
365 | * @page: the first page to be flushed | |
366 | * @size: size in bytes of region to be flushed | |
367 | * @dir: direction of dma transfer | |
368 | */ | |
369 | void ion_pages_sync_for_device(struct device *dev, struct page *page, | |
370 | size_t size, enum dma_data_direction dir); | |
371 | ||
c30707be | 372 | #endif /* _ION_PRIV_H */ |