2 * Copyright (C) 2008 Google, Inc.
4 * Based on, but no longer compatible with, the original
5 * OpenBinder.org binder driver interface, which is:
7 * Copyright (c) 2005 Palmsource, Inc.
9 * This software is licensed under the terms of the GNU General Public
10 * License version 2, as published by the Free Software Foundation, and
11 * may be copied, distributed, and modified under those terms.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
20 #ifndef _UAPI_LINUX_BINDER_H
21 #define _UAPI_LINUX_BINDER_H
23 #include <linux/ioctl.h>
25 #define B_PACK_CHARS(c1, c2, c3, c4) \
26 ((((c1)<<24)) | (((c2)<<16)) | (((c3)<<8)) | (c4))
27 #define B_TYPE_LARGE 0x85
30 BINDER_TYPE_BINDER
= B_PACK_CHARS('s', 'b', '*', B_TYPE_LARGE
),
31 BINDER_TYPE_WEAK_BINDER
= B_PACK_CHARS('w', 'b', '*', B_TYPE_LARGE
),
32 BINDER_TYPE_HANDLE
= B_PACK_CHARS('s', 'h', '*', B_TYPE_LARGE
),
33 BINDER_TYPE_WEAK_HANDLE
= B_PACK_CHARS('w', 'h', '*', B_TYPE_LARGE
),
34 BINDER_TYPE_FD
= B_PACK_CHARS('f', 'd', '*', B_TYPE_LARGE
),
35 BINDER_TYPE_FDA
= B_PACK_CHARS('f', 'd', 'a', B_TYPE_LARGE
),
36 BINDER_TYPE_PTR
= B_PACK_CHARS('p', 't', '*', B_TYPE_LARGE
),
40 * enum flat_binder_object_shifts: shift values for flat_binder_object_flags
41 * @FLAT_BINDER_FLAG_SCHED_POLICY_SHIFT: shift for getting scheduler policy.
44 enum flat_binder_object_shifts
{
45 FLAT_BINDER_FLAG_SCHED_POLICY_SHIFT
= 9,
49 * enum flat_binder_object_flags - flags for use in flat_binder_object.flags
51 enum flat_binder_object_flags
{
53 * @FLAT_BINDER_FLAG_PRIORITY_MASK: bit-mask for min scheduler priority
55 * These bits can be used to set the minimum scheduler priority
56 * at which transactions into this node should run. Valid values
57 * in these bits depend on the scheduler policy encoded in
58 * @FLAT_BINDER_FLAG_SCHED_POLICY_MASK.
60 * For SCHED_NORMAL/SCHED_BATCH, the valid range is between [-20..19]
61 * For SCHED_FIFO/SCHED_RR, the value can run between [1..99]
63 FLAT_BINDER_FLAG_PRIORITY_MASK
= 0xff,
65 * @FLAT_BINDER_FLAG_ACCEPTS_FDS: whether the node accepts fds.
67 FLAT_BINDER_FLAG_ACCEPTS_FDS
= 0x100,
69 * @FLAT_BINDER_FLAG_SCHED_POLICY_MASK: bit-mask for scheduling policy
71 * These two bits can be used to set the min scheduling policy at which
72 * transactions on this node should run. These match the UAPI
73 * scheduler policy values, eg:
79 FLAT_BINDER_FLAG_SCHED_POLICY_MASK
=
80 3U << FLAT_BINDER_FLAG_SCHED_POLICY_SHIFT
,
83 * @FLAT_BINDER_FLAG_INHERIT_RT: whether the node inherits RT policy
85 * Only when set, calls into this node will inherit a real-time
86 * scheduling policy from the caller (for synchronous transactions).
88 FLAT_BINDER_FLAG_INHERIT_RT
= 0x800,
91 #ifdef BINDER_IPC_32BIT
92 typedef __u32 binder_size_t
;
93 typedef __u32 binder_uintptr_t
;
95 typedef __u64 binder_size_t
;
96 typedef __u64 binder_uintptr_t
;
100 * struct binder_object_header - header shared by all binder metadata objects.
101 * @type: type of the object
103 struct binder_object_header
{
108 * This is the flattened representation of a Binder object for transfer
109 * between processes. The 'offsets' supplied as part of a binder transaction
110 * contains offsets into the data where these structures occur. The Binder
111 * driver takes care of re-writing the structure type and data as it moves
114 struct flat_binder_object
{
115 struct binder_object_header hdr
;
118 /* 8 bytes of data. */
120 binder_uintptr_t binder
; /* local object */
121 __u32 handle
; /* remote object */
124 /* extra data associated with local object */
125 binder_uintptr_t cookie
;
129 * struct binder_fd_object - describes a filedescriptor to be fixed up.
130 * @hdr: common header structure
131 * @pad_flags: padding to remain compatible with old userspace code
132 * @pad_binder: padding to remain compatible with old userspace code
133 * @fd: file descriptor
134 * @cookie: opaque data, used by user-space
136 struct binder_fd_object
{
137 struct binder_object_header hdr
;
140 binder_uintptr_t pad_binder
;
144 binder_uintptr_t cookie
;
147 /* struct binder_buffer_object - object describing a userspace buffer
148 * @hdr: common header structure
149 * @flags: one or more BINDER_BUFFER_* flags
150 * @buffer: address of the buffer
151 * @length: length of the buffer
152 * @parent: index in offset array pointing to parent buffer
153 * @parent_offset: offset in @parent pointing to this buffer
155 * A binder_buffer object represents an object that the
156 * binder kernel driver can copy verbatim to the target
157 * address space. A buffer itself may be pointed to from
158 * within another buffer, meaning that the pointer inside
159 * that other buffer needs to be fixed up as well. This
160 * can be done by setting the BINDER_BUFFER_FLAG_HAS_PARENT
161 * flag in @flags, by setting @parent buffer to the index
162 * in the offset array pointing to the parent binder_buffer_object,
163 * and by setting @parent_offset to the offset in the parent buffer
164 * at which the pointer to this buffer is located.
166 struct binder_buffer_object
{
167 struct binder_object_header hdr
;
169 binder_uintptr_t buffer
;
170 binder_size_t length
;
171 binder_size_t parent
;
172 binder_size_t parent_offset
;
176 BINDER_BUFFER_FLAG_HAS_PARENT
= 0x01,
179 /* struct binder_fd_array_object - object describing an array of fds in a buffer
180 * @hdr: common header structure
181 * @num_fds: number of file descriptors in the buffer
182 * @parent: index in offset array to buffer holding the fd array
183 * @parent_offset: start offset of fd array in the buffer
185 * A binder_fd_array object represents an array of file
186 * descriptors embedded in a binder_buffer_object. It is
187 * different from a regular binder_buffer_object because it
188 * describes a list of file descriptors to fix up, not an opaque
189 * blob of memory, and hence the kernel needs to treat it differently.
191 * An example of how this would be used is with Android's
192 * native_handle_t object, which is a struct with a list of integers
193 * and a list of file descriptors. The native_handle_t struct itself
194 * will be represented by a struct binder_buffer_objct, whereas the
195 * embedded list of file descriptors is represented by a
196 * struct binder_fd_array_object with that binder_buffer_object as
199 struct binder_fd_array_object
{
200 struct binder_object_header hdr
;
201 binder_size_t num_fds
;
202 binder_size_t parent
;
203 binder_size_t parent_offset
;
207 * On 64-bit platforms where user code may run in 32-bits the driver must
208 * translate the buffer (and local binder) addresses appropriately.
211 struct binder_write_read
{
212 binder_size_t write_size
; /* bytes to write */
213 binder_size_t write_consumed
; /* bytes consumed by driver */
214 binder_uintptr_t write_buffer
;
215 binder_size_t read_size
; /* bytes to read */
216 binder_size_t read_consumed
; /* bytes consumed by driver */
217 binder_uintptr_t read_buffer
;
220 /* Use with BINDER_VERSION, driver fills in fields. */
221 struct binder_version
{
222 /* driver protocol version -- increment with incompatible change */
223 __s32 protocol_version
;
226 /* This is the current protocol version. */
227 #ifdef BINDER_IPC_32BIT
228 #define BINDER_CURRENT_PROTOCOL_VERSION 7
230 #define BINDER_CURRENT_PROTOCOL_VERSION 8
234 * Use with BINDER_GET_NODE_DEBUG_INFO, driver reads ptr, writes to all fields.
235 * Set ptr to NULL for the first call to get the info for the first node, and
236 * then repeat the call passing the previously returned value to get the next
237 * nodes. ptr will be 0 when there are no more nodes.
239 struct binder_node_debug_info
{
240 binder_uintptr_t ptr
;
241 binder_uintptr_t cookie
;
242 __u32 has_strong_ref
;
246 struct binder_node_info_for_ref
{
255 #define BINDER_WRITE_READ _IOWR('b', 1, struct binder_write_read)
256 #define BINDER_SET_IDLE_TIMEOUT _IOW('b', 3, __s64)
257 #define BINDER_SET_MAX_THREADS _IOW('b', 5, __u32)
258 #define BINDER_SET_IDLE_PRIORITY _IOW('b', 6, __s32)
259 #define BINDER_SET_CONTEXT_MGR _IOW('b', 7, __s32)
260 #define BINDER_THREAD_EXIT _IOW('b', 8, __s32)
261 #define BINDER_VERSION _IOWR('b', 9, struct binder_version)
262 #define BINDER_GET_NODE_DEBUG_INFO _IOWR('b', 11, struct binder_node_debug_info)
263 #define BINDER_GET_NODE_INFO_FOR_REF _IOWR('b', 12, struct binder_node_info_for_ref)
266 * NOTE: Two special error codes you should check for when calling
267 * in to the driver are:
269 * EINTR -- The operation has been interupted. This should be
270 * handled by retrying the ioctl() until a different error code
273 * ECONNREFUSED -- The driver is no longer accepting operations
274 * from your process. That is, the process is being destroyed.
275 * You should handle this by exiting from your process. Note
276 * that once this error code is returned, all further calls to
277 * the driver from any thread will return this same code.
280 enum transaction_flags
{
281 TF_ONE_WAY
= 0x01, /* this is a one-way call: async, no return */
282 TF_ROOT_OBJECT
= 0x04, /* contents are the component's root object */
283 TF_STATUS_CODE
= 0x08, /* contents are a 32-bit status code */
284 TF_ACCEPT_FDS
= 0x10, /* allow replies with file descriptors */
287 struct binder_transaction_data
{
288 /* The first two are only used for bcTRANSACTION and brTRANSACTION,
289 * identifying the target and contents of the transaction.
292 /* target descriptor of command transaction */
294 /* target descriptor of return transaction */
295 binder_uintptr_t ptr
;
297 binder_uintptr_t cookie
; /* target object cookie */
298 __u32 code
; /* transaction command */
300 /* General information about the transaction. */
304 binder_size_t data_size
; /* number of bytes of data */
305 binder_size_t offsets_size
; /* number of bytes of offsets */
307 /* If this transaction is inline, the data immediately
308 * follows here; otherwise, it ends with a pointer to
313 /* transaction data */
314 binder_uintptr_t buffer
;
315 /* offsets from buffer to flat_binder_object structs */
316 binder_uintptr_t offsets
;
322 struct binder_transaction_data_sg
{
323 struct binder_transaction_data transaction_data
;
324 binder_size_t buffers_size
;
327 struct binder_ptr_cookie
{
328 binder_uintptr_t ptr
;
329 binder_uintptr_t cookie
;
332 struct binder_handle_cookie
{
334 binder_uintptr_t cookie
;
335 } __attribute__((packed
));
337 struct binder_pri_desc
{
342 struct binder_pri_ptr_cookie
{
344 binder_uintptr_t ptr
;
345 binder_uintptr_t cookie
;
348 enum binder_driver_return_protocol
{
349 BR_ERROR
= _IOR('r', 0, __s32
),
357 BR_TRANSACTION
= _IOR('r', 2, struct binder_transaction_data
),
358 BR_REPLY
= _IOR('r', 3, struct binder_transaction_data
),
360 * binder_transaction_data: the received command.
363 BR_ACQUIRE_RESULT
= _IOR('r', 4, __s32
),
365 * not currently supported
366 * int: 0 if the last bcATTEMPT_ACQUIRE was not successful.
367 * Else the remote object has acquired a primary reference.
370 BR_DEAD_REPLY
= _IO('r', 5),
372 * The target of the last transaction (either a bcTRANSACTION or
373 * a bcATTEMPT_ACQUIRE) is no longer with us. No parameters.
376 BR_TRANSACTION_COMPLETE
= _IO('r', 6),
378 * No parameters... always refers to the last transaction requested
379 * (including replies). Note that this will be sent even for
380 * asynchronous transactions.
383 BR_INCREFS
= _IOR('r', 7, struct binder_ptr_cookie
),
384 BR_ACQUIRE
= _IOR('r', 8, struct binder_ptr_cookie
),
385 BR_RELEASE
= _IOR('r', 9, struct binder_ptr_cookie
),
386 BR_DECREFS
= _IOR('r', 10, struct binder_ptr_cookie
),
388 * void *: ptr to binder
389 * void *: cookie for binder
392 BR_ATTEMPT_ACQUIRE
= _IOR('r', 11, struct binder_pri_ptr_cookie
),
394 * not currently supported
396 * void *: ptr to binder
397 * void *: cookie for binder
400 BR_NOOP
= _IO('r', 12),
402 * No parameters. Do nothing and examine the next command. It exists
403 * primarily so that we can replace it with a BR_SPAWN_LOOPER command.
406 BR_SPAWN_LOOPER
= _IO('r', 13),
408 * No parameters. The driver has determined that a process has no
409 * threads waiting to service incoming transactions. When a process
410 * receives this command, it must spawn a new service thread and
411 * register it via bcENTER_LOOPER.
414 BR_FINISHED
= _IO('r', 14),
416 * not currently supported
417 * stop threadpool thread
420 BR_DEAD_BINDER
= _IOR('r', 15, binder_uintptr_t
),
424 BR_CLEAR_DEATH_NOTIFICATION_DONE
= _IOR('r', 16, binder_uintptr_t
),
429 BR_FAILED_REPLY
= _IO('r', 17),
431 * The the last transaction (either a bcTRANSACTION or
432 * a bcATTEMPT_ACQUIRE) failed (e.g. out of memory). No parameters.
436 enum binder_driver_command_protocol
{
437 BC_TRANSACTION
= _IOW('c', 0, struct binder_transaction_data
),
438 BC_REPLY
= _IOW('c', 1, struct binder_transaction_data
),
440 * binder_transaction_data: the sent command.
443 BC_ACQUIRE_RESULT
= _IOW('c', 2, __s32
),
445 * not currently supported
446 * int: 0 if the last BR_ATTEMPT_ACQUIRE was not successful.
447 * Else you have acquired a primary reference on the object.
450 BC_FREE_BUFFER
= _IOW('c', 3, binder_uintptr_t
),
452 * void *: ptr to transaction data received on a read
455 BC_INCREFS
= _IOW('c', 4, __u32
),
456 BC_ACQUIRE
= _IOW('c', 5, __u32
),
457 BC_RELEASE
= _IOW('c', 6, __u32
),
458 BC_DECREFS
= _IOW('c', 7, __u32
),
463 BC_INCREFS_DONE
= _IOW('c', 8, struct binder_ptr_cookie
),
464 BC_ACQUIRE_DONE
= _IOW('c', 9, struct binder_ptr_cookie
),
466 * void *: ptr to binder
467 * void *: cookie for binder
470 BC_ATTEMPT_ACQUIRE
= _IOW('c', 10, struct binder_pri_desc
),
472 * not currently supported
477 BC_REGISTER_LOOPER
= _IO('c', 11),
480 * Register a spawned looper thread with the device.
483 BC_ENTER_LOOPER
= _IO('c', 12),
484 BC_EXIT_LOOPER
= _IO('c', 13),
487 * These two commands are sent as an application-level thread
488 * enters and exits the binder loop, respectively. They are
489 * used so the binder can have an accurate count of the number
490 * of looping threads it has available.
493 BC_REQUEST_DEATH_NOTIFICATION
= _IOW('c', 14, struct binder_handle_cookie
),
499 BC_CLEAR_DEATH_NOTIFICATION
= _IOW('c', 15, struct binder_handle_cookie
),
505 BC_DEAD_BINDER_DONE
= _IOW('c', 16, binder_uintptr_t
),
510 BC_TRANSACTION_SG
= _IOW('c', 17, struct binder_transaction_data_sg
),
511 BC_REPLY_SG
= _IOW('c', 18, struct binder_transaction_data_sg
),
513 * binder_transaction_data_sg: the sent command.
517 #endif /* _UAPI_LINUX_BINDER_H */