1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ 2 /* 3 * drivers/staging/android/uapi/ion.h 4 * 5 * Copyright (C) 2011 Google, Inc. 6 */ 7 8 #ifndef _UAPI_LINUX_ION_H 9 #define _UAPI_LINUX_ION_H 10 11 #include <linux/ioctl.h> 12 #include <linux/types.h> 13 14 /** 15 * ion_heap_types - list of all possible types of heaps that Android can use 16 * 17 * @ION_HEAP_TYPE_SYSTEM: Reserved heap id for ion heap that allocates 18 * memory using alloc_page(). Also, supports 19 * deferred free and allocation pools. 20 * @ION_HEAP_TYPE_SYSTEM_CONTIG: Reserved heap id for ion heap that is the same 21 * as SYSTEM_HEAP, except doesn't support 22 * allocation pools. 23 * @ION_HEAP_TYPE_CARVEOUT: Reserved heap id for ion heap that allocates 24 * memory from a pre-reserved memory region 25 * aka 'carveout'. 26 * @ION_HEAP_TYPE_DMA: Reserved heap id for ion heap that manages 27 * single CMA (contiguous memory allocator) 28 * region. Uses standard DMA APIs for 29 * managing memory within the CMA region. 30 */ 31 enum ion_heap_type { 32 ION_HEAP_TYPE_SYSTEM = 0, 33 ION_HEAP_TYPE_SYSTEM_CONTIG = 1, 34 ION_HEAP_TYPE_CARVEOUT = 2, 35 ION_HEAP_TYPE_CHUNK = 3, 36 ION_HEAP_TYPE_DMA = 4, 37 /* reserved range for future standard heap types */ 38 ION_HEAP_TYPE_CUSTOM = 16, 39 ION_HEAP_TYPE_MAX = 31, 40 }; 41 42 /** 43 * ion_heap_id - list of standard heap ids that Android can use 44 * 45 * @ION_HEAP_SYSTEM Id for the ION_HEAP_TYPE_SYSTEM 46 * @ION_HEAP_SYSTEM_CONTIG Id for the ION_HEAP_TYPE_SYSTEM_CONTIG 47 * @ION_HEAP_CHUNK Id for the ION_HEAP_TYPE_CHUNK 48 * @ION_HEAP_CARVEOUT_START Start of reserved id range for heaps of type 49 * ION_HEAP_TYPE_CARVEOUT 50 * @ION_HEAP_CARVEOUT_END End of reserved id range for heaps of type 51 * ION_HEAP_TYPE_CARVEOUT 52 * @ION_HEAP_DMA_START Start of reserved id range for heaps of type 53 * ION_HEAP_TYPE_DMA 54 * @ION_HEAP_DMA_END End of reserved id range for heaps of type 55 * ION_HEAP_TYPE_DMA 56 * @ION_HEAP_CUSTOM_START Start of reserved id range for heaps of custom 57 * type 58 * @ION_HEAP_CUSTOM_END End of reserved id range for heaps of custom 59 * type 60 */ 61 enum ion_heap_id { 62 ION_HEAP_SYSTEM = (1 << ION_HEAP_TYPE_SYSTEM), 63 ION_HEAP_SYSTEM_CONTIG = (ION_HEAP_SYSTEM << 1), 64 ION_HEAP_CARVEOUT_START = (ION_HEAP_SYSTEM_CONTIG << 1), 65 ION_HEAP_CARVEOUT_END = (ION_HEAP_CARVEOUT_START << 4), 66 ION_HEAP_CHUNK = (ION_HEAP_CARVEOUT_END << 1), 67 ION_HEAP_DMA_START = (ION_HEAP_CHUNK << 1), 68 ION_HEAP_DMA_END = (ION_HEAP_DMA_START << 7), 69 ION_HEAP_CUSTOM_START = (ION_HEAP_DMA_END << 1), 70 ION_HEAP_CUSTOM_END = (ION_HEAP_CUSTOM_START << 15), 71 }; 72 73 #define ION_NUM_MAX_HEAPS (32) 74 75 /** 76 * allocation flags - the lower 16 bits are used by core ion, the upper 16 77 * bits are reserved for use by the heaps themselves. 78 */ 79 80 /* 81 * mappings of this buffer should be cached, ion will do cache maintenance 82 * when the buffer is mapped for dma 83 */ 84 #define ION_FLAG_CACHED 1 85 86 /** 87 * DOC: Ion Userspace API 88 * 89 * create a client by opening /dev/ion 90 * most operations handled via following ioctls 91 * 92 */ 93 94 /** 95 * struct ion_allocation_data - metadata passed from userspace for allocations 96 * @len: size of the allocation 97 * @heap_id_mask: mask of heap ids to allocate from 98 * @flags: flags passed to heap 99 * @handle: pointer that will be populated with a cookie to use to 100 * refer to this allocation 101 * 102 * Provided by userspace as an argument to the ioctl 103 */ 104 struct ion_allocation_data { 105 __u64 len; 106 __u32 heap_id_mask; 107 __u32 flags; 108 __u32 fd; 109 __u32 unused; 110 }; 111 112 #define MAX_HEAP_NAME 32 113 114 /** 115 * struct ion_heap_data - data about a heap 116 * @name - first 32 characters of the heap name 117 * @type - heap type 118 * @heap_id - heap id for the heap 119 */ 120 struct ion_heap_data { 121 char name[MAX_HEAP_NAME]; 122 __u32 type; 123 __u32 heap_id; 124 __u32 reserved0; 125 __u32 reserved1; 126 __u32 reserved2; 127 }; 128 129 /** 130 * struct ion_heap_query - collection of data about all heaps 131 * @cnt - total number of heaps to be copied 132 * @heaps - buffer to copy heap data 133 */ 134 struct ion_heap_query { 135 __u32 cnt; /* Total number of heaps to be copied */ 136 __u32 reserved0; /* align to 64bits */ 137 __u64 heaps; /* buffer to be populated */ 138 __u32 reserved1; 139 __u32 reserved2; 140 }; 141 142 #define ION_IOC_MAGIC 'I' 143 144 /** 145 * DOC: ION_IOC_ALLOC - allocate memory 146 * 147 * Takes an ion_allocation_data struct and returns it with the handle field 148 * populated with the opaque handle for the allocation. 149 */ 150 #define ION_IOC_ALLOC _IOWR(ION_IOC_MAGIC, 0, \ 151 struct ion_allocation_data) 152 153 /** 154 * DOC: ION_IOC_HEAP_QUERY - information about available heaps 155 * 156 * Takes an ion_heap_query structure and populates information about 157 * available Ion heaps. 158 */ 159 #define ION_IOC_HEAP_QUERY _IOWR(ION_IOC_MAGIC, 8, \ 160 struct ion_heap_query) 161 162 /** 163 * DOC: ION_IOC_HEAP_ABI_VERSION - return ABI version 164 * 165 * Returns ABI version for this driver 166 */ 167 #define ION_IOC_ABI_VERSION _IOR(ION_IOC_MAGIC, 9, \ 168 __u32) 169 #endif /* _UAPI_LINUX_ION_H */ 170