2 * drivers/staging/android/ion/ion_priv.h
4 * Copyright (C) 2011 Google, Inc.
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.
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.
20 #include <linux/device.h>
21 #include <linux/dma-direction.h>
22 #include <linux/kref.h>
23 #include <linux/mm_types.h>
24 #include <linux/mutex.h>
25 #include <linux/rbtree.h>
26 #include <linux/sched.h>
27 #include <linux/shrinker.h>
28 #include <linux/types.h>
32 struct ion_buffer *ion_handle_buffer(struct ion_handle *handle);
35 * struct ion_buffer - metadata for a particular buffer
36 * @ref: refernce count
37 * @node: node in the ion_device buffers tree
38 * @dev: back pointer to the ion_device
39 * @heap: back pointer to the heap the buffer came from
40 * @flags: buffer specific flags
41 * @size: size of the buffer
42 * @priv_virt: private data to the buffer representable as
44 * @priv_phys: private data to the buffer representable as
45 * an ion_phys_addr_t (and someday a phys_addr_t)
46 * @lock: protects the buffers cnt fields
47 * @kmap_cnt: number of times the buffer is mapped to the kernel
48 * @vaddr: the kenrel mapping if kmap_cnt is not zero
49 * @dmap_cnt: number of times the buffer is mapped for dma
50 * @sg_table: the sg table for the buffer if dmap_cnt is not zero
51 * @pages: flat array of pages in the buffer -- used by fault
52 * handler and only valid for buffers that are faulted in
53 * @vmas: list of vma's mapping this buffer
54 * @handle_count: count of handles referencing this buffer
55 * @task_comm: taskcomm of last client to reference this buffer in a
56 * handle, used for debugging
57 * @pid: pid of last client to reference this buffer in a
58 * handle, used for debugging
64 struct list_head list;
66 struct ion_device *dev;
67 struct ion_heap *heap;
72 ion_phys_addr_t priv_phys;
78 struct sg_table *sg_table;
80 struct list_head vmas;
81 /* used to track orphaned buffers */
83 char task_comm[TASK_COMM_LEN];
86 void ion_buffer_destroy(struct ion_buffer *buffer);
89 * struct ion_heap_ops - ops to operate on a given heap
90 * @allocate: allocate memory
92 * @phys get physical address of a buffer (only define on
93 * physically contiguous heaps)
94 * @map_dma map the memory for dma to a scatterlist
95 * @unmap_dma unmap the memory for dma
96 * @map_kernel map memory to the kernel
97 * @unmap_kernel unmap memory to the kernel
98 * @map_user map memory to userspace
100 * allocate, phys, and map_user return 0 on success, -errno on error.
101 * map_dma and map_kernel return pointer on success, ERR_PTR on error.
103 struct ion_heap_ops {
104 int (*allocate) (struct ion_heap *heap,
105 struct ion_buffer *buffer, unsigned long len,
106 unsigned long align, unsigned long flags);
107 void (*free) (struct ion_buffer *buffer);
108 int (*phys) (struct ion_heap *heap, struct ion_buffer *buffer,
109 ion_phys_addr_t *addr, size_t *len);
110 struct sg_table *(*map_dma) (struct ion_heap *heap,
111 struct ion_buffer *buffer);
112 void (*unmap_dma) (struct ion_heap *heap, struct ion_buffer *buffer);
113 void * (*map_kernel) (struct ion_heap *heap, struct ion_buffer *buffer);
114 void (*unmap_kernel) (struct ion_heap *heap, struct ion_buffer *buffer);
115 int (*map_user) (struct ion_heap *mapper, struct ion_buffer *buffer,
116 struct vm_area_struct *vma);
120 * heap flags - flags between the heaps and core ion code
122 #define ION_HEAP_FLAG_DEFER_FREE (1 << 0)
125 * struct ion_heap - represents a heap in the system
126 * @node: rb node to put the heap on the device's tree of heaps
127 * @dev: back pointer to the ion_device
128 * @type: type of heap
129 * @ops: ops struct as above
131 * @id: id of heap, also indicates priority of this heap when
132 * allocating. These are specified by platform data and
134 * @name: used for debugging
135 * @shrinker: a shrinker for the heap, if the heap caches system
136 * memory, it must define a shrinker to return it on low
137 * memory conditions, this includes system memory cached
138 * in the deferred free lists for heaps that support it
139 * @free_list: free list head if deferred free is used
140 * @free_list_size size of the deferred free list in bytes
141 * @lock: protects the free list
142 * @waitqueue: queue to wait on from deferred free thread
143 * @task: task struct of deferred free thread
144 * @debug_show: called when heap debug file is read to add any
145 * heap specific debug info to output
147 * Represents a pool of memory from which buffers can be made. In some
148 * systems the only heap is regular system memory allocated via vmalloc.
149 * On others, some blocks might require large physically contiguous buffers
150 * that are allocated from a specially reserved heap.
153 struct plist_node node;
154 struct ion_device *dev;
155 enum ion_heap_type type;
156 struct ion_heap_ops *ops;
160 struct shrinker shrinker;
161 struct list_head free_list;
162 size_t free_list_size;
163 spinlock_t free_lock;
164 wait_queue_head_t waitqueue;
165 struct task_struct *task;
166 int (*debug_show)(struct ion_heap *heap, struct seq_file *, void *);
170 * ion_buffer_cached - this ion buffer is cached
173 * indicates whether this ion buffer is cached
175 bool ion_buffer_cached(struct ion_buffer *buffer);
178 * ion_buffer_fault_user_mappings - fault in user mappings of this buffer
181 * indicates whether userspace mappings of this buffer will be faulted
182 * in, this can affect how buffers are allocated from the heap.
184 bool ion_buffer_fault_user_mappings(struct ion_buffer *buffer);
187 * ion_device_create - allocates and returns an ion device
188 * @custom_ioctl: arch specific ioctl function if applicable
190 * returns a valid device or -PTR_ERR
192 struct ion_device *ion_device_create(long (*custom_ioctl)
193 (struct ion_client *client,
198 * ion_device_destroy - free and device and it's resource
201 void ion_device_destroy(struct ion_device *dev);
204 * ion_device_add_heap - adds a heap to the ion device
206 * @heap: the heap to add
208 void ion_device_add_heap(struct ion_device *dev, struct ion_heap *heap);
211 * some helpers for common operations on buffers using the sg_table
214 void *ion_heap_map_kernel(struct ion_heap *, struct ion_buffer *);
215 void ion_heap_unmap_kernel(struct ion_heap *, struct ion_buffer *);
216 int ion_heap_map_user(struct ion_heap *, struct ion_buffer *,
217 struct vm_area_struct *);
218 int ion_heap_buffer_zero(struct ion_buffer *buffer);
219 int ion_heap_pages_zero(struct page *page, size_t size, pgprot_t pgprot);
222 * ion_heap_init_deferred_free -- initialize deferred free functionality
225 * If a heap sets the ION_HEAP_FLAG_DEFER_FREE flag this function will
226 * be called to setup deferred frees. Calls to free the buffer will
227 * return immediately and the actual free will occur some time later
229 int ion_heap_init_deferred_free(struct ion_heap *heap);
232 * ion_heap_freelist_add - add a buffer to the deferred free list
234 * @buffer: the buffer
236 * Adds an item to the deferred freelist.
238 void ion_heap_freelist_add(struct ion_heap *heap, struct ion_buffer *buffer);
241 * ion_heap_freelist_drain - drain the deferred free list
243 * @size: ammount of memory to drain in bytes
245 * Drains the indicated amount of memory from the deferred freelist immediately.
246 * Returns the total amount freed. The total freed may be higher depending
247 * on the size of the items in the list, or lower if there is insufficient
248 * total memory on the freelist.
250 size_t ion_heap_freelist_drain(struct ion_heap *heap, size_t size);
253 * ion_heap_freelist_size - returns the size of the freelist in bytes
256 size_t ion_heap_freelist_size(struct ion_heap *heap);
260 * functions for creating and destroying the built in ion heaps.
261 * architectures can add their own custom architecture specific
262 * heaps as appropriate.
265 struct ion_heap *ion_heap_create(struct ion_platform_heap *);
266 void ion_heap_destroy(struct ion_heap *);
267 struct ion_heap *ion_system_heap_create(struct ion_platform_heap *);
268 void ion_system_heap_destroy(struct ion_heap *);
270 struct ion_heap *ion_system_contig_heap_create(struct ion_platform_heap *);
271 void ion_system_contig_heap_destroy(struct ion_heap *);
273 struct ion_heap *ion_carveout_heap_create(struct ion_platform_heap *);
274 void ion_carveout_heap_destroy(struct ion_heap *);
276 struct ion_heap *ion_chunk_heap_create(struct ion_platform_heap *);
277 void ion_chunk_heap_destroy(struct ion_heap *);
278 struct ion_heap *ion_cma_heap_create(struct ion_platform_heap *);
279 void ion_cma_heap_destroy(struct ion_heap *);
282 * kernel api to allocate/free from carveout -- used when carveout is
283 * used to back an architecture specific custom heap
285 ion_phys_addr_t ion_carveout_allocate(struct ion_heap *heap, unsigned long size,
286 unsigned long align);
287 void ion_carveout_free(struct ion_heap *heap, ion_phys_addr_t addr,
290 * The carveout heap returns physical addresses, since 0 may be a valid
291 * physical address, this is used to indicate allocation failed
293 #define ION_CARVEOUT_ALLOCATE_FAIL -1
296 * functions for creating and destroying a heap pool -- allows you
297 * to keep a pool of pre allocated memory to use from your heap. Keeping
298 * a pool of memory that is ready for dma, ie any cached mapping have been
299 * invalidated from the cache, provides a significant peformance benefit on
303 * struct ion_page_pool - pagepool struct
304 * @high_count: number of highmem items in the pool
305 * @low_count: number of lowmem items in the pool
306 * @high_items: list of highmem items
307 * @low_items: list of lowmem items
308 * @shrinker: a shrinker for the items
309 * @mutex: lock protecting this struct and especially the count
311 * @alloc: function to be used to allocate pageory when the pool
313 * @free: function to be used to free pageory back to the system
314 * when the shrinker fires
315 * @gfp_mask: gfp_mask to use from alloc
316 * @order: order of pages in the pool
317 * @list: plist node for list of pools
319 * Allows you to keep a pool of pre allocated pages to use from your heap.
320 * Keeping a pool of pages that is ready for dma, ie any cached mapping have
321 * been invalidated from the cache, provides a significant peformance benefit
324 struct ion_page_pool {
327 struct list_head high_items;
328 struct list_head low_items;
332 struct plist_node list;
335 struct ion_page_pool *ion_page_pool_create(gfp_t gfp_mask, unsigned int order);
336 void ion_page_pool_destroy(struct ion_page_pool *);
337 void *ion_page_pool_alloc(struct ion_page_pool *);
338 void ion_page_pool_free(struct ion_page_pool *, struct page *);
340 /** ion_page_pool_shrink - shrinks the size of the memory cached in the pool
342 * @gfp_mask: the memory type to reclaim
343 * @nr_to_scan: number of items to shrink in pages
345 * returns the number of items freed in pages
347 int ion_page_pool_shrink(struct ion_page_pool *pool, gfp_t gfp_mask,
351 * ion_pages_sync_for_device - cache flush pages for use with the specified
353 * @dev: the device the pages will be used with
354 * @page: the first page to be flushed
355 * @size: size in bytes of region to be flushed
356 * @dir: direction of dma transfer
358 void ion_pages_sync_for_device(struct device *dev, struct page *page,
359 size_t size, enum dma_data_direction dir);
361 #endif /* _ION_PRIV_H */