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),
38 FLAT_BINDER_FLAG_PRIORITY_MASK = 0xff,
39 FLAT_BINDER_FLAG_ACCEPTS_FDS = 0x100,
43 * This is the flattened representation of a Binder object for transfer
44 * between processes. The 'offsets' supplied as part of a binder transaction
45 * contains offsets into the data where these structures occur. The Binder
46 * driver takes care of re-writing the structure type and data as it moves
49 struct flat_binder_object {
50 /* 8 bytes for large_flat_header. */
54 /* 8 bytes of data. */
56 void __user *binder; /* local object */
57 __u32 handle; /* remote object */
60 /* extra data associated with local object */
65 * On 64-bit platforms where user code may run in 32-bits the driver must
66 * translate the buffer (and local binder) addresses appropriately.
69 struct binder_write_read {
70 size_t write_size; /* bytes to write */
71 size_t write_consumed; /* bytes consumed by driver */
72 unsigned long write_buffer;
73 size_t read_size; /* bytes to read */
74 size_t read_consumed; /* bytes consumed by driver */
75 unsigned long read_buffer;
78 /* Use with BINDER_VERSION, driver fills in fields. */
79 struct binder_version {
80 /* driver protocol version -- increment with incompatible change */
81 __s32 protocol_version;
84 /* This is the current protocol version. */
85 #define BINDER_CURRENT_PROTOCOL_VERSION 7
87 #define BINDER_WRITE_READ _IOWR('b', 1, struct binder_write_read)
88 #define BINDER_SET_IDLE_TIMEOUT _IOW('b', 3, __s64)
89 #define BINDER_SET_MAX_THREADS _IOW('b', 5, __u32)
90 #define BINDER_SET_IDLE_PRIORITY _IOW('b', 6, __s32)
91 #define BINDER_SET_CONTEXT_MGR _IOW('b', 7, __s32)
92 #define BINDER_THREAD_EXIT _IOW('b', 8, __s32)
93 #define BINDER_VERSION _IOWR('b', 9, struct binder_version)
96 * NOTE: Two special error codes you should check for when calling
97 * in to the driver are:
99 * EINTR -- The operation has been interupted. This should be
100 * handled by retrying the ioctl() until a different error code
103 * ECONNREFUSED -- The driver is no longer accepting operations
104 * from your process. That is, the process is being destroyed.
105 * You should handle this by exiting from your process. Note
106 * that once this error code is returned, all further calls to
107 * the driver from any thread will return this same code.
110 enum transaction_flags {
111 TF_ONE_WAY = 0x01, /* this is a one-way call: async, no return */
112 TF_ROOT_OBJECT = 0x04, /* contents are the component's root object */
113 TF_STATUS_CODE = 0x08, /* contents are a 32-bit status code */
114 TF_ACCEPT_FDS = 0x10, /* allow replies with file descriptors */
117 struct binder_transaction_data {
118 /* The first two are only used for bcTRANSACTION and brTRANSACTION,
119 * identifying the target and contents of the transaction.
122 __u32 handle; /* target descriptor of command transaction */
123 void *ptr; /* target descriptor of return transaction */
125 void *cookie; /* target object cookie */
126 __u32 code; /* transaction command */
128 /* General information about the transaction. */
132 size_t data_size; /* number of bytes of data */
133 size_t offsets_size; /* number of bytes of offsets */
135 /* If this transaction is inline, the data immediately
136 * follows here; otherwise, it ends with a pointer to
141 /* transaction data */
142 const void __user *buffer;
143 /* offsets from buffer to flat_binder_object structs */
144 const void __user *offsets;
150 struct binder_ptr_cookie {
155 struct binder_pri_desc {
160 struct binder_pri_ptr_cookie {
166 enum binder_driver_return_protocol {
167 BR_ERROR = _IOR('r', 0, __s32),
175 BR_TRANSACTION = _IOR('r', 2, struct binder_transaction_data),
176 BR_REPLY = _IOR('r', 3, struct binder_transaction_data),
178 * binder_transaction_data: the received command.
181 BR_ACQUIRE_RESULT = _IOR('r', 4, __s32),
183 * not currently supported
184 * int: 0 if the last bcATTEMPT_ACQUIRE was not successful.
185 * Else the remote object has acquired a primary reference.
188 BR_DEAD_REPLY = _IO('r', 5),
190 * The target of the last transaction (either a bcTRANSACTION or
191 * a bcATTEMPT_ACQUIRE) is no longer with us. No parameters.
194 BR_TRANSACTION_COMPLETE = _IO('r', 6),
196 * No parameters... always refers to the last transaction requested
197 * (including replies). Note that this will be sent even for
198 * asynchronous transactions.
201 BR_INCREFS = _IOR('r', 7, struct binder_ptr_cookie),
202 BR_ACQUIRE = _IOR('r', 8, struct binder_ptr_cookie),
203 BR_RELEASE = _IOR('r', 9, struct binder_ptr_cookie),
204 BR_DECREFS = _IOR('r', 10, struct binder_ptr_cookie),
206 * void *: ptr to binder
207 * void *: cookie for binder
210 BR_ATTEMPT_ACQUIRE = _IOR('r', 11, struct binder_pri_ptr_cookie),
212 * not currently supported
214 * void *: ptr to binder
215 * void *: cookie for binder
218 BR_NOOP = _IO('r', 12),
220 * No parameters. Do nothing and examine the next command. It exists
221 * primarily so that we can replace it with a BR_SPAWN_LOOPER command.
224 BR_SPAWN_LOOPER = _IO('r', 13),
226 * No parameters. The driver has determined that a process has no
227 * threads waiting to service incoming transactions. When a process
228 * receives this command, it must spawn a new service thread and
229 * register it via bcENTER_LOOPER.
232 BR_FINISHED = _IO('r', 14),
234 * not currently supported
235 * stop threadpool thread
238 BR_DEAD_BINDER = _IOR('r', 15, void *),
242 BR_CLEAR_DEATH_NOTIFICATION_DONE = _IOR('r', 16, void *),
247 BR_FAILED_REPLY = _IO('r', 17),
249 * The the last transaction (either a bcTRANSACTION or
250 * a bcATTEMPT_ACQUIRE) failed (e.g. out of memory). No parameters.
254 enum binder_driver_command_protocol {
255 BC_TRANSACTION = _IOW('c', 0, struct binder_transaction_data),
256 BC_REPLY = _IOW('c', 1, struct binder_transaction_data),
258 * binder_transaction_data: the sent command.
261 BC_ACQUIRE_RESULT = _IOW('c', 2, __s32),
263 * not currently supported
264 * int: 0 if the last BR_ATTEMPT_ACQUIRE was not successful.
265 * Else you have acquired a primary reference on the object.
268 BC_FREE_BUFFER = _IOW('c', 3, void *),
270 * void *: ptr to transaction data received on a read
273 BC_INCREFS = _IOW('c', 4, __u32),
274 BC_ACQUIRE = _IOW('c', 5, __u32),
275 BC_RELEASE = _IOW('c', 6, __u32),
276 BC_DECREFS = _IOW('c', 7, __u32),
281 BC_INCREFS_DONE = _IOW('c', 8, struct binder_ptr_cookie),
282 BC_ACQUIRE_DONE = _IOW('c', 9, struct binder_ptr_cookie),
284 * void *: ptr to binder
285 * void *: cookie for binder
288 BC_ATTEMPT_ACQUIRE = _IOW('c', 10, struct binder_pri_desc),
290 * not currently supported
295 BC_REGISTER_LOOPER = _IO('c', 11),
298 * Register a spawned looper thread with the device.
301 BC_ENTER_LOOPER = _IO('c', 12),
302 BC_EXIT_LOOPER = _IO('c', 13),
305 * These two commands are sent as an application-level thread
306 * enters and exits the binder loop, respectively. They are
307 * used so the binder can have an accurate count of the number
308 * of looping threads it has available.
311 BC_REQUEST_DEATH_NOTIFICATION = _IOW('c', 14, struct binder_ptr_cookie),
313 * void *: ptr to binder
317 BC_CLEAR_DEATH_NOTIFICATION = _IOW('c', 15, struct binder_ptr_cookie),
319 * void *: ptr to binder
323 BC_DEAD_BINDER_DONE = _IOW('c', 16, void *),
329 #endif /* _UAPI_LINUX_BINDER_H */