~thopiekar/arm-mali/libvdpau-sunxi

« back to all changes in this revision

Viewing changes to kernel-headers/ion.h

  • Committer: Jens Kuske
  • Date: 2016-02-16 13:12:22 UTC
  • Revision ID: git-v1:685769372a8281bf67046a958883323aaf14d232
Use libcedrus

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
/*
2
 
 * include/linux/ion.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 _LINUX_ION_H
18
 
#define _LINUX_ION_H
19
 
 
20
 
#include <stdlib.h>
21
 
#include <linux/types.h>
22
 
 
23
 
struct ion_handle;
24
 
/**
25
 
 * enum ion_heap_types - list of all possible types of heaps
26
 
 * @ION_HEAP_TYPE_SYSTEM:        memory allocated via vmalloc
27
 
 * @ION_HEAP_TYPE_SYSTEM_CONTIG: memory allocated via kmalloc
28
 
 * @ION_HEAP_TYPE_CARVEOUT:      memory allocated from a prereserved
29
 
 *                               carveout heap, allocations are physically
30
 
 *                               contiguous
31
 
 * @ION_HEAP_TYPE_DMA:           memory allocated via DMA API
32
 
 * @ION_NUM_HEAPS:               helper for iterating over heaps, a bit mask
33
 
 *                               is used to identify the heaps, so only 32
34
 
 *                               total heap types are supported
35
 
 */
36
 
enum ion_heap_type {
37
 
        ION_HEAP_TYPE_SYSTEM,
38
 
        ION_HEAP_TYPE_SYSTEM_CONTIG,
39
 
        ION_HEAP_TYPE_CARVEOUT,
40
 
        ION_HEAP_TYPE_CHUNK,
41
 
        ION_HEAP_TYPE_DMA,
42
 
        ION_HEAP_TYPE_CUSTOM, /* must be last so device specific heaps always
43
 
                                 are at the end of this enum */
44
 
        ION_NUM_HEAPS = 16,
45
 
};
46
 
 
47
 
#define ION_HEAP_SYSTEM_MASK            (1 << ION_HEAP_TYPE_SYSTEM)
48
 
#define ION_HEAP_SYSTEM_CONTIG_MASK     (1 << ION_HEAP_TYPE_SYSTEM_CONTIG)
49
 
#define ION_HEAP_CARVEOUT_MASK          (1 << ION_HEAP_TYPE_CARVEOUT)
50
 
#define ION_HEAP_TYPE_DMA_MASK          (1 << ION_HEAP_TYPE_DMA)
51
 
 
52
 
#define ION_NUM_HEAP_IDS                sizeof(unsigned int) * 8
53
 
 
54
 
/**
55
 
 * allocation flags - the lower 16 bits are used by core ion, the upper 16
56
 
 * bits are reserved for use by the heaps themselves.
57
 
 */
58
 
#define ION_FLAG_CACHED 1               /* mappings of this buffer should be
59
 
                                           cached, ion will do cache
60
 
                                           maintenance when the buffer is
61
 
                                           mapped for dma */
62
 
#define ION_FLAG_CACHED_NEEDS_SYNC 2    /* mappings of this buffer will created
63
 
                                           at mmap time, if this is set
64
 
                                           caches must be managed manually */
65
 
 
66
 
#ifdef __KERNEL__
67
 
struct ion_device;
68
 
struct ion_heap;
69
 
struct ion_mapper;
70
 
struct ion_client;
71
 
struct ion_buffer;
72
 
 
73
 
/* This should be removed some day when phys_addr_t's are fully
74
 
   plumbed in the kernel, and all instances of ion_phys_addr_t should
75
 
   be converted to phys_addr_t.  For the time being many kernel interfaces
76
 
   do not accept phys_addr_t's that would have to */
77
 
#define ion_phys_addr_t unsigned long
78
 
 
79
 
/**
80
 
 * struct ion_platform_heap - defines a heap in the given platform
81
 
 * @type:       type of the heap from ion_heap_type enum
82
 
 * @id:         unique identifier for heap.  When allocating higher numbers
83
 
 *              will be allocated from first.  At allocation these are passed
84
 
 *              as a bit mask and therefore can not exceed ION_NUM_HEAP_IDS.
85
 
 * @name:       used for debug purposes
86
 
 * @base:       base address of heap in physical memory if applicable
87
 
 * @size:       size of the heap in bytes if applicable
88
 
 * @align:      required alignment in physical memory if applicable
89
 
 * @priv:       private info passed from the board file
90
 
 *
91
 
 * Provided by the board file.
92
 
 */
93
 
struct ion_platform_heap {
94
 
        enum ion_heap_type type;
95
 
        unsigned int id;
96
 
        const char *name;
97
 
        ion_phys_addr_t base;
98
 
        size_t size;
99
 
        ion_phys_addr_t align;
100
 
        void *priv;
101
 
};
102
 
 
103
 
/**
104
 
 * struct ion_platform_data - array of platform heaps passed from board file
105
 
 * @nr:         number of structures in the array
106
 
 * @heaps:      array of platform_heap structions
107
 
 *
108
 
 * Provided by the board file in the form of platform data to a platform device.
109
 
 */
110
 
struct ion_platform_data {
111
 
        int nr;
112
 
        struct ion_platform_heap heaps[];
113
 
};
114
 
 
115
 
/**
116
 
 * ion_reserve() - reserve memory for ion heaps if applicable
117
 
 * @data:       platform data specifying starting physical address and
118
 
 *              size
119
 
 *
120
 
 * Calls memblock reserve to set aside memory for heaps that are
121
 
 * located at specific memory addresses or of specfic sizes not
122
 
 * managed by the kernel
123
 
 */
124
 
void ion_reserve(struct ion_platform_data *data);
125
 
 
126
 
/**
127
 
 * ion_client_create() -  allocate a client and returns it
128
 
 * @dev:                the global ion device
129
 
 * @heap_type_mask:     mask of heaps this client can allocate from
130
 
 * @name:               used for debugging
131
 
 */
132
 
struct ion_client *ion_client_create(struct ion_device *dev,
133
 
                                     const char *name);
134
 
 
135
 
/**
136
 
 * ion_client_destroy() -  free's a client and all it's handles
137
 
 * @client:     the client
138
 
 *
139
 
 * Free the provided client and all it's resources including
140
 
 * any handles it is holding.
141
 
 */
142
 
void ion_client_destroy(struct ion_client *client);
143
 
 
144
 
/**
145
 
 * ion_alloc - allocate ion memory
146
 
 * @client:             the client
147
 
 * @len:                size of the allocation
148
 
 * @align:              requested allocation alignment, lots of hardware blocks
149
 
 *                      have alignment requirements of some kind
150
 
 * @heap_id_mask:       mask of heaps to allocate from, if multiple bits are set
151
 
 *                      heaps will be tried in order from highest to lowest
152
 
 *                      id
153
 
 * @flags:              heap flags, the low 16 bits are consumed by ion, the
154
 
 *                      high 16 bits are passed on to the respective heap and
155
 
 *                      can be heap custom
156
 
 *
157
 
 * Allocate memory in one of the heaps provided in heap mask and return
158
 
 * an opaque handle to it.
159
 
 */
160
 
struct ion_handle *ion_alloc(struct ion_client *client, size_t len,
161
 
                             size_t align, unsigned int heap_id_mask,
162
 
                             unsigned int flags);
163
 
 
164
 
/**
165
 
 * ion_free - free a handle
166
 
 * @client:     the client
167
 
 * @handle:     the handle to free
168
 
 *
169
 
 * Free the provided handle.
170
 
 */
171
 
void ion_free(struct ion_client *client, struct ion_handle *handle);
172
 
 
173
 
/**
174
 
 * ion_phys - returns the physical address and len of a handle
175
 
 * @client:     the client
176
 
 * @handle:     the handle
177
 
 * @addr:       a pointer to put the address in
178
 
 * @len:        a pointer to put the length in
179
 
 *
180
 
 * This function queries the heap for a particular handle to get the
181
 
 * handle's physical address.  It't output is only correct if
182
 
 * a heap returns physically contiguous memory -- in other cases
183
 
 * this api should not be implemented -- ion_sg_table should be used
184
 
 * instead.  Returns -EINVAL if the handle is invalid.  This has
185
 
 * no implications on the reference counting of the handle --
186
 
 * the returned value may not be valid if the caller is not
187
 
 * holding a reference.
188
 
 */
189
 
int ion_phys(struct ion_client *client, struct ion_handle *handle,
190
 
             ion_phys_addr_t *addr, size_t *len);
191
 
 
192
 
/**
193
 
 * ion_map_dma - return an sg_table describing a handle
194
 
 * @client:     the client
195
 
 * @handle:     the handle
196
 
 *
197
 
 * This function returns the sg_table describing
198
 
 * a particular ion handle.
199
 
 */
200
 
struct sg_table *ion_sg_table(struct ion_client *client,
201
 
                              struct ion_handle *handle);
202
 
 
203
 
/**
204
 
 * ion_map_kernel - create mapping for the given handle
205
 
 * @client:     the client
206
 
 * @handle:     handle to map
207
 
 *
208
 
 * Map the given handle into the kernel and return a kernel address that
209
 
 * can be used to access this address.
210
 
 */
211
 
void *ion_map_kernel(struct ion_client *client, struct ion_handle *handle);
212
 
 
213
 
/**
214
 
 * ion_unmap_kernel() - destroy a kernel mapping for a handle
215
 
 * @client:     the client
216
 
 * @handle:     handle to unmap
217
 
 */
218
 
void ion_unmap_kernel(struct ion_client *client, struct ion_handle *handle);
219
 
 
220
 
/**
221
 
 * ion_share_dma_buf() - share buffer as dma-buf
222
 
 * @client:     the client
223
 
 * @handle:     the handle
224
 
 */
225
 
struct dma_buf *ion_share_dma_buf(struct ion_client *client,
226
 
                                                struct ion_handle *handle);
227
 
 
228
 
/**
229
 
 * ion_share_dma_buf_fd() - given an ion client, create a dma-buf fd
230
 
 * @client:     the client
231
 
 * @handle:     the handle
232
 
 */
233
 
int ion_share_dma_buf_fd(struct ion_client *client, struct ion_handle *handle);
234
 
 
235
 
/**
236
 
 * ion_import_dma_buf() - given an dma-buf fd from the ion exporter get handle
237
 
 * @client:     the client
238
 
 * @fd:         the dma-buf fd
239
 
 *
240
 
 * Given an dma-buf fd that was allocated through ion via ion_share_dma_buf,
241
 
 * import that fd and return a handle representing it.  If a dma-buf from
242
 
 * another exporter is passed in this function will return ERR_PTR(-EINVAL)
243
 
 */
244
 
struct ion_handle *ion_import_dma_buf(struct ion_client *client, int fd);
245
 
 
246
 
#endif /* __KERNEL__ */
247
 
 
248
 
/**
249
 
 * DOC: Ion Userspace API
250
 
 *
251
 
 * create a client by opening /dev/ion
252
 
 * most operations handled via following ioctls
253
 
 *
254
 
 */
255
 
 
256
 
/**
257
 
 * struct ion_allocation_data - metadata passed from userspace for allocations
258
 
 * @len:                size of the allocation
259
 
 * @align:              required alignment of the allocation
260
 
 * @heap_id_mask:       mask of heap ids to allocate from
261
 
 * @flags:              flags passed to heap
262
 
 * @handle:             pointer that will be populated with a cookie to use to
263
 
 *                      refer to this allocation
264
 
 *
265
 
 * Provided by userspace as an argument to the ioctl
266
 
 */
267
 
struct ion_allocation_data {
268
 
        size_t len;
269
 
        size_t align;
270
 
        unsigned int heap_id_mask;
271
 
        unsigned int flags;
272
 
        struct ion_handle *handle;
273
 
};
274
 
 
275
 
/**
276
 
 * struct ion_fd_data - metadata passed to/from userspace for a handle/fd pair
277
 
 * @handle:     a handle
278
 
 * @fd:         a file descriptor representing that handle
279
 
 *
280
 
 * For ION_IOC_SHARE or ION_IOC_MAP userspace populates the handle field with
281
 
 * the handle returned from ion alloc, and the kernel returns the file
282
 
 * descriptor to share or map in the fd field.  For ION_IOC_IMPORT, userspace
283
 
 * provides the file descriptor and the kernel returns the handle.
284
 
 */
285
 
struct ion_fd_data {
286
 
        struct ion_handle *handle;
287
 
        int fd;
288
 
};
289
 
 
290
 
/**
291
 
 * struct ion_handle_data - a handle passed to/from the kernel
292
 
 * @handle:     a handle
293
 
 */
294
 
struct ion_handle_data {
295
 
        struct ion_handle *handle;
296
 
};
297
 
 
298
 
/**
299
 
 * struct ion_custom_data - metadata passed to/from userspace for a custom ioctl
300
 
 * @cmd:        the custom ioctl function to call
301
 
 * @arg:        additional data to pass to the custom ioctl, typically a user
302
 
 *              pointer to a predefined structure
303
 
 *
304
 
 * This works just like the regular cmd and arg fields of an ioctl.
305
 
 */
306
 
struct ion_custom_data {
307
 
        unsigned int cmd;
308
 
        unsigned long arg;
309
 
};
310
 
 
311
 
#define ION_IOC_MAGIC           'I'
312
 
 
313
 
/**
314
 
 * DOC: ION_IOC_ALLOC - allocate memory
315
 
 *
316
 
 * Takes an ion_allocation_data struct and returns it with the handle field
317
 
 * populated with the opaque handle for the allocation.
318
 
 */
319
 
#define ION_IOC_ALLOC           _IOWR(ION_IOC_MAGIC, 0, \
320
 
                                      struct ion_allocation_data)
321
 
 
322
 
/**
323
 
 * DOC: ION_IOC_FREE - free memory
324
 
 *
325
 
 * Takes an ion_handle_data struct and frees the handle.
326
 
 */
327
 
#define ION_IOC_FREE            _IOWR(ION_IOC_MAGIC, 1, struct ion_handle_data)
328
 
 
329
 
/**
330
 
 * DOC: ION_IOC_MAP - get a file descriptor to mmap
331
 
 *
332
 
 * Takes an ion_fd_data struct with the handle field populated with a valid
333
 
 * opaque handle.  Returns the struct with the fd field set to a file
334
 
 * descriptor open in the current address space.  This file descriptor
335
 
 * can then be used as an argument to mmap.
336
 
 */
337
 
#define ION_IOC_MAP             _IOWR(ION_IOC_MAGIC, 2, struct ion_fd_data)
338
 
 
339
 
/**
340
 
 * DOC: ION_IOC_SHARE - creates a file descriptor to use to share an allocation
341
 
 *
342
 
 * Takes an ion_fd_data struct with the handle field populated with a valid
343
 
 * opaque handle.  Returns the struct with the fd field set to a file
344
 
 * descriptor open in the current address space.  This file descriptor
345
 
 * can then be passed to another process.  The corresponding opaque handle can
346
 
 * be retrieved via ION_IOC_IMPORT.
347
 
 */
348
 
#define ION_IOC_SHARE           _IOWR(ION_IOC_MAGIC, 4, struct ion_fd_data)
349
 
 
350
 
/**
351
 
 * DOC: ION_IOC_IMPORT - imports a shared file descriptor
352
 
 *
353
 
 * Takes an ion_fd_data struct with the fd field populated with a valid file
354
 
 * descriptor obtained from ION_IOC_SHARE and returns the struct with the handle
355
 
 * filed set to the corresponding opaque handle.
356
 
 */
357
 
#define ION_IOC_IMPORT          _IOWR(ION_IOC_MAGIC, 5, struct ion_fd_data)
358
 
 
359
 
/**
360
 
 * DOC: ION_IOC_SYNC - syncs a shared file descriptors to memory
361
 
 *
362
 
 * Deprecated in favor of using the dma_buf api's correctly (syncing
363
 
 * will happend automatically when the buffer is mapped to a device).
364
 
 * If necessary should be used after touching a cached buffer from the cpu,
365
 
 * this will make the buffer in memory coherent.
366
 
 */
367
 
#define ION_IOC_SYNC            _IOWR(ION_IOC_MAGIC, 7, struct ion_fd_data)
368
 
 
369
 
/**
370
 
 * DOC: ION_IOC_CUSTOM - call architecture specific ion ioctl
371
 
 *
372
 
 * Takes the argument of the architecture specific ioctl to call and
373
 
 * passes appropriate userdata for that ioctl
374
 
 */
375
 
#define ION_IOC_CUSTOM          _IOWR(ION_IOC_MAGIC, 6, struct ion_custom_data)
376
 
 
377
 
#endif /* _LINUX_ION_H */