drivers/staging/android/ion/ion_priv.h

   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
  20 #include <linux/dma-direction.h>
  21 #include <linux/kref.h>
  22 #include <linux/mm_types.h>
  23 #include <linux/mutex.h>
  24 #include <linux/rbtree.h>
  25 #include <linux/sched.h>
  26 #include <linux/shrinker.h>
  27 #include <linux/types.h>
  28
  29 #include "ion.h"
  30
  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
  49  * @sg_table:           the sg table for the buffer if dmap_cnt is not zero
  50  * @pages:              flat array of pages in the buffer -- used by fault
  51  *                      handler and only valid for buffers that are faulted in
  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
  58 */
  59 struct ion_buffer {
  60         struct kref ref;
  61         union {
  62                 struct rb_node node;
  63                 struct list_head list;
  64         };
  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;
  77         struct sg_table *sg_table;
  78         struct page **pages;
  79         struct list_head vmas;
  80         /* used to track orphaned buffers */
  81         int handle_count;
  82         char task_comm[TASK_COMM_LEN];
  83         pid_t pid;
  84 };
  85 void ion_buffer_destroy(struct ion_buffer *buffer);
  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
  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.
 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);
 109         struct sg_table *(*map_dma) (struct ion_heap *heap,
 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
 118 /**
 119  * heap flags - flags between the heaps and core ion code
 120  */
 121 #define ION_HEAP_FLAG_DEFER_FREE (1 << 0)
 122
 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
 129  * @flags:              flags
 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
 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
 138  * @free_list:          free list head if deferred free is used
 139  * @free_list_size      size of the deferred free list in bytes
 140  * @lock:               protects the free list
 141  * @waitqueue:          queue to wait on from deferred free thread
 142  * @task:               task struct of deferred free thread
 143  * @debug_show:         called when heap debug file is read to add any
 144  *                      heap specific debug info to output
 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 {
 152         struct plist_node node;
 153         struct ion_device *dev;
 154         enum ion_heap_type type;
 155         struct ion_heap_ops *ops;
 156         unsigned long flags;
 157         unsigned int id;
 158         const char *name;
 159         struct shrinker shrinker;
 160         struct list_head free_list;
 161         size_t free_list_size;
 162         spinlock_t free_lock;
 163         wait_queue_head_t waitqueue;
 164         struct task_struct *task;
 165         int (*debug_show)(struct ion_heap *heap, struct seq_file *, void *);
 166 };
 167
 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
 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
 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
 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 *);
 217 int ion_heap_buffer_zero(struct ion_buffer *buffer);
 218 int ion_heap_pages_zero(struct page *page, size_t size, pgprot_t pgprot);
 219
 220 /**
 221  * ion_heap_init_deferred_free -- initialize deferred free functionality
 222  * @heap:               the heap
 223  *
 224  * If a heap sets the ION_HEAP_FLAG_DEFER_FREE flag this function will
 225  * be called to setup deferred frees. Calls to free the buffer will
 226  * return immediately and the actual free will occur some time later
 227  */
 228 int ion_heap_init_deferred_free(struct ion_heap *heap);
 229
 230 /**
 231  * ion_heap_freelist_add - add a buffer to the deferred free list
 232  * @heap:               the heap
 233  * @buffer:             the buffer
 234  *
 235  * Adds an item to the deferred freelist.
 236  */
 237 void ion_heap_freelist_add(struct ion_heap *heap, struct ion_buffer *buffer);
 238
 239 /**
 240  * ion_heap_freelist_drain - drain the deferred free list
 241  * @heap:               the heap
 242  * @size:               ammount of memory to drain in bytes
 243  *
 244  * Drains the indicated amount of memory from the deferred freelist immediately.
 245  * Returns the total amount freed.  The total freed may be higher depending
 246  * on the size of the items in the list, or lower if there is insufficient
 247  * total memory on the freelist.
 248  */
 249 size_t ion_heap_freelist_drain(struct ion_heap *heap, size_t size);
 250
 251 /**
 252  * ion_heap_freelist_size - returns the size of the freelist in bytes
 253  * @heap:               the heap
 254  */
 255 size_t ion_heap_freelist_size(struct ion_heap *heap);
 256
 257
 258 /**
 259  * functions for creating and destroying the built in ion heaps.
 260  * architectures can add their own custom architecture specific
 261  * heaps as appropriate.
 262  */
 263
 264 struct ion_heap *ion_heap_create(struct ion_platform_heap *);
 265 void ion_heap_destroy(struct ion_heap *);
 266 struct ion_heap *ion_system_heap_create(struct ion_platform_heap *);
 267 void ion_system_heap_destroy(struct ion_heap *);
 268
 269 struct ion_heap *ion_system_contig_heap_create(struct ion_platform_heap *);
 270 void ion_system_contig_heap_destroy(struct ion_heap *);
 271
 272 struct ion_heap *ion_carveout_heap_create(struct ion_platform_heap *);
 273 void ion_carveout_heap_destroy(struct ion_heap *);
 274
 275 struct ion_heap *ion_chunk_heap_create(struct ion_platform_heap *);
 276 void ion_chunk_heap_destroy(struct ion_heap *);
 277 struct ion_heap *ion_cma_heap_create(struct ion_platform_heap *);
 278 void ion_cma_heap_destroy(struct ion_heap *);
 279
 280 /**
 281  * kernel api to allocate/free from carveout -- used when carveout is
 282  * used to back an architecture specific custom heap
 283  */
 284 ion_phys_addr_t ion_carveout_allocate(struct ion_heap *heap, unsigned long size,
 285                                       unsigned long align);
 286 void ion_carveout_free(struct ion_heap *heap, ion_phys_addr_t addr,
 287                        unsigned long size);
 288 /**
 289  * The carveout heap returns physical addresses, since 0 may be a valid
 290  * physical address, this is used to indicate allocation failed
 291  */
 292 #define ION_CARVEOUT_ALLOCATE_FAIL -1
 293
 294 /**
 295  * functions for creating and destroying a heap pool -- allows you
 296  * to keep a pool of pre allocated memory to use from your heap.  Keeping
 297  * a pool of memory that is ready for dma, ie any cached mapping have been
 298  * invalidated from the cache, provides a significant peformance benefit on
 299  * many systems */
 300
 301 /**
 302  * struct ion_page_pool - pagepool struct
 303  * @high_count:         number of highmem items in the pool
 304  * @low_count:          number of lowmem items in the pool
 305  * @high_items:         list of highmem items
 306  * @low_items:          list of lowmem items
 307  * @shrinker:           a shrinker for the items
 308  * @mutex:              lock protecting this struct and especially the count
 309  *                      item list
 310  * @alloc:              function to be used to allocate pageory when the pool
 311  *                      is empty
 312  * @free:               function to be used to free pageory back to the system
 313  *                      when the shrinker fires
 314  * @gfp_mask:           gfp_mask to use from alloc
 315  * @order:              order of pages in the pool
 316  * @list:               plist node for list of pools
 317  *
 318  * Allows you to keep a pool of pre allocated pages to use from your heap.
 319  * Keeping a pool of pages that is ready for dma, ie any cached mapping have
 320  * been invalidated from the cache, provides a significant peformance benefit
 321  * on many systems
 322  */
 323 struct ion_page_pool {
 324         int high_count;
 325         int low_count;
 326         struct list_head high_items;
 327         struct list_head low_items;
 328         struct mutex mutex;
 329         gfp_t gfp_mask;
 330         unsigned int order;
 331         struct plist_node list;
 332 };
 333
 334 struct ion_page_pool *ion_page_pool_create(gfp_t gfp_mask, unsigned int order);
 335 void ion_page_pool_destroy(struct ion_page_pool *);
 336 void *ion_page_pool_alloc(struct ion_page_pool *);
 337 void ion_page_pool_free(struct ion_page_pool *, struct page *);
 338
 339 /** ion_page_pool_shrink - shrinks the size of the memory cached in the pool
 340  * @pool:               the pool
 341  * @gfp_mask:           the memory type to reclaim
 342  * @nr_to_scan:         number of items to shrink in pages
 343  *
 344  * returns the number of items freed in pages
 345  */
 346 int ion_page_pool_shrink(struct ion_page_pool *pool, gfp_t gfp_mask,
 347                           int nr_to_scan);
 348
 349 /**
 350  * ion_pages_sync_for_device - cache flush pages for use with the specified
 351  *                             device
 352  * @dev:                the device the pages will be used with
 353  * @page:               the first page to be flushed
 354  * @size:               size in bytes of region to be flushed
 355  * @dir:                direction of dma transfer
 356  */
 357 void ion_pages_sync_for_device(struct device *dev, struct page *page,
 358                 size_t size, enum dma_data_direction dir);
 359
 360 #endif /* _ION_PRIV_H */