blob: 19c22e8eaeb47706c1b4f6317a29e78372383536 [file] [log] [blame]
Doug Zongker9270a202012-01-09 15:16:13 -08001/*
2 * Copyright (C) 2007 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef __ADB_H
18#define __ADB_H
19
20#include <limits.h>
21
22#include "transport.h" /* readx(), writex() */
23#include "fdevent.h"
24
25#define MAX_PAYLOAD 4096
26
27#define A_SYNC 0x434e5953
28#define A_CNXN 0x4e584e43
29#define A_OPEN 0x4e45504f
30#define A_OKAY 0x59414b4f
31#define A_CLSE 0x45534c43
32#define A_WRTE 0x45545257
33
34#define A_VERSION 0x01000000 // ADB protocol version
35
36#define ADB_VERSION_MAJOR 1 // Used for help/version information
37#define ADB_VERSION_MINOR 0 // Used for help/version information
38
39#define ADB_SERVER_VERSION 29 // Increment this when we want to force users to start a new adb server
40
41typedef struct amessage amessage;
42typedef struct apacket apacket;
43typedef struct asocket asocket;
Doug Zongker9270a202012-01-09 15:16:13 -080044typedef struct aservice aservice;
45typedef struct atransport atransport;
46typedef struct adisconnect adisconnect;
47typedef struct usb_handle usb_handle;
48
49struct amessage {
50 unsigned command; /* command identifier constant */
51 unsigned arg0; /* first argument */
52 unsigned arg1; /* second argument */
53 unsigned data_length; /* length of payload (0 is allowed) */
54 unsigned data_check; /* checksum of data payload */
55 unsigned magic; /* command ^ 0xffffffff */
56};
57
58struct apacket
59{
60 apacket *next;
61
62 unsigned len;
63 unsigned char *ptr;
64
65 amessage msg;
66 unsigned char data[MAX_PAYLOAD];
67};
68
69/* An asocket represents one half of a connection between a local and
70** remote entity. A local asocket is bound to a file descriptor. A
71** remote asocket is bound to the protocol engine.
72*/
73struct asocket {
74 /* chain pointers for the local/remote list of
75 ** asockets that this asocket lives in
76 */
77 asocket *next;
78 asocket *prev;
79
80 /* the unique identifier for this asocket
81 */
82 unsigned id;
83
84 /* flag: set when the socket's peer has closed
85 ** but packets are still queued for delivery
86 */
87 int closing;
88
89 /* the asocket we are connected to
90 */
91
92 asocket *peer;
93
94 /* For local asockets, the fde is used to bind
95 ** us to our fd event system. For remote asockets
96 ** these fields are not used.
97 */
98 fdevent fde;
99 int fd;
100
101 /* queue of apackets waiting to be written
102 */
103 apacket *pkt_first;
104 apacket *pkt_last;
105
106 /* enqueue is called by our peer when it has data
107 ** for us. It should return 0 if we can accept more
108 ** data or 1 if not. If we return 1, we must call
109 ** peer->ready() when we once again are ready to
110 ** receive data.
111 */
112 int (*enqueue)(asocket *s, apacket *pkt);
113
114 /* ready is called by the peer when it is ready for
115 ** us to send data via enqueue again
116 */
117 void (*ready)(asocket *s);
118
119 /* close is called by the peer when it has gone away.
120 ** we are not allowed to make any further calls on the
121 ** peer once our close method is called.
122 */
123 void (*close)(asocket *s);
124
125 /* socket-type-specific extradata */
126 void *extra;
127
128 /* A socket is bound to atransport */
129 atransport *transport;
130};
131
132
133/* the adisconnect structure is used to record a callback that
134** will be called whenever a transport is disconnected (e.g. by the user)
135** this should be used to cleanup objects that depend on the
Doug Zongker098d1f62012-03-20 09:40:04 -0700136** transport (e.g. remote sockets, etc...)
Doug Zongker9270a202012-01-09 15:16:13 -0800137*/
138struct adisconnect
139{
140 void (*func)(void* opaque, atransport* t);
141 void* opaque;
142 adisconnect* next;
143 adisconnect* prev;
144};
145
146
147/* a transport object models the connection to a remote device or emulator
148** there is one transport per connected device/emulator. a "local transport"
149** connects through TCP (for the emulator), while a "usb transport" through
150** USB (for real devices)
151**
152** note that kTransportHost doesn't really correspond to a real transport
153** object, it's a special value used to indicate that a client wants to
154** connect to a service implemented within the ADB server itself.
155*/
156typedef enum transport_type {
157 kTransportUsb,
158 kTransportLocal,
159 kTransportAny,
160 kTransportHost,
161} transport_type;
162
163struct atransport
164{
165 atransport *next;
166 atransport *prev;
167
168 int (*read_from_remote)(apacket *p, atransport *t);
169 int (*write_to_remote)(apacket *p, atransport *t);
170 void (*close)(atransport *t);
171 void (*kick)(atransport *t);
172
173 int fd;
174 int transport_socket;
175 fdevent transport_fde;
176 int ref_count;
177 unsigned sync_token;
178 int connection_state;
179 transport_type type;
180
181 /* usb handle or socket fd as needed */
182 usb_handle *usb;
183 int sfd;
184
185 /* used to identify transports for clients */
186 char *serial;
187 char *product;
188 int adb_port; // Use for emulators (local transport)
189
190 /* a list of adisconnect callbacks called when the transport is kicked */
191 int kicked;
192 adisconnect disconnects;
193};
194
195
Doug Zongker9270a202012-01-09 15:16:13 -0800196void print_packet(const char *label, apacket *p);
197
198asocket *find_local_socket(unsigned id);
199void install_local_socket(asocket *s);
200void remove_socket(asocket *s);
201void close_all_sockets(atransport *t);
202
203#define LOCAL_CLIENT_PREFIX "emulator-"
204
205asocket *create_local_socket(int fd);
206asocket *create_local_service_socket(const char *destination);
207
208asocket *create_remote_socket(unsigned id, atransport *t);
209void connect_to_remote(asocket *s, const char *destination);
210void connect_to_smartsocket(asocket *s);
211
212void fatal(const char *fmt, ...);
213void fatal_errno(const char *fmt, ...);
214
215void handle_packet(apacket *p, atransport *t);
216void send_packet(apacket *p, atransport *t);
217
218void get_my_path(char *s, size_t maxLen);
219int launch_server(int server_port);
Dees_Troy9a4b5692012-09-19 15:09:45 -0400220int adb_main(const char* path);
Doug Zongker9270a202012-01-09 15:16:13 -0800221
222
223/* transports are ref-counted
224** get_device_transport does an acquire on your behalf before returning
225*/
226void init_transport_registration(void);
227int list_transports(char *buf, size_t bufsize);
228void update_transports(void);
229
230asocket* create_device_tracker(void);
231
232/* Obtain a transport from the available transports.
233** If state is != CS_ANY, only transports in that state are considered.
234** If serial is non-NULL then only the device with that serial will be chosen.
235** If no suitable transport is found, error is set.
236*/
237atransport *acquire_one_transport(int state, transport_type ttype, const char* serial, char **error_out);
238void add_transport_disconnect( atransport* t, adisconnect* dis );
239void remove_transport_disconnect( atransport* t, adisconnect* dis );
240void run_transport_disconnects( atransport* t );
241void kick_transport( atransport* t );
242
243/* initialize a transport object's func pointers and state */
244#if ADB_HOST
245int get_available_local_transport_index();
246#endif
247int init_socket_transport(atransport *t, int s, int port, int local);
248void init_usb_transport(atransport *t, usb_handle *usb, int state);
249
250/* for MacOS X cleanup */
251void close_usb_devices();
252
253/* cause new transports to be init'd and added to the list */
254void register_socket_transport(int s, const char *serial, int port, int local);
255
256/* these should only be used for the "adb disconnect" command */
257void unregister_transport(atransport *t);
258void unregister_all_tcp_transports();
259
260void register_usb_transport(usb_handle *h, const char *serial, unsigned writeable);
261
262/* this should only be used for transports with connection_state == CS_NOPERM */
263void unregister_usb_transport(usb_handle *usb);
264
265atransport *find_transport(const char *serial);
266#if ADB_HOST
267atransport* find_emulator_transport_by_adb_port(int adb_port);
268#endif
269
270int service_to_fd(const char *name);
271#if ADB_HOST
272asocket *host_service_to_socket(const char* name, const char *serial);
273#endif
274
275#if !ADB_HOST
276typedef enum {
277 BACKUP,
278 RESTORE
279} BackupOperation;
280int backup_service(BackupOperation operation, char* args);
281void framebuffer_service(int fd, void *cookie);
282void log_service(int fd, void *cookie);
283void remount_service(int fd, void *cookie);
284char * get_log_file_path(const char * log_name);
285#endif
286
287/* packet allocator */
288apacket *get_apacket(void);
289void put_apacket(apacket *p);
290
291int check_header(apacket *p);
292int check_data(apacket *p);
293
294/* define ADB_TRACE to 1 to enable tracing support, or 0 to disable it */
295
296#define ADB_TRACE 1
297
298/* IMPORTANT: if you change the following list, don't
299 * forget to update the corresponding 'tags' table in
300 * the adb_trace_init() function implemented in adb.c
301 */
302typedef enum {
303 TRACE_ADB = 0, /* 0x001 */
304 TRACE_SOCKETS,
305 TRACE_PACKETS,
306 TRACE_TRANSPORT,
307 TRACE_RWX, /* 0x010 */
308 TRACE_USB,
309 TRACE_SYNC,
310 TRACE_SYSDEPS,
311 TRACE_JDWP, /* 0x100 */
312 TRACE_SERVICES,
313} AdbTrace;
314
315#if ADB_TRACE
316
317 extern int adb_trace_mask;
318 extern unsigned char adb_trace_output_count;
319 void adb_trace_init(void);
320
321# define ADB_TRACING ((adb_trace_mask & (1 << TRACE_TAG)) != 0)
322
323 /* you must define TRACE_TAG before using this macro */
324# define D(...) \
325 do { \
326 if (ADB_TRACING) { \
327 int save_errno = errno; \
328 adb_mutex_lock(&D_lock); \
329 fprintf(stderr, "%s::%s():", \
330 __FILE__, __FUNCTION__); \
331 errno = save_errno; \
332 fprintf(stderr, __VA_ARGS__ ); \
333 fflush(stderr); \
334 adb_mutex_unlock(&D_lock); \
335 errno = save_errno; \
336 } \
337 } while (0)
338# define DR(...) \
339 do { \
340 if (ADB_TRACING) { \
341 int save_errno = errno; \
342 adb_mutex_lock(&D_lock); \
343 errno = save_errno; \
344 fprintf(stderr, __VA_ARGS__ ); \
345 fflush(stderr); \
346 adb_mutex_unlock(&D_lock); \
347 errno = save_errno; \
348 } \
349 } while (0)
350#else
351# define D(...) ((void)0)
352# define DR(...) ((void)0)
353# define ADB_TRACING 0
354#endif
355
356
357#if !TRACE_PACKETS
358#define print_packet(tag,p) do {} while (0)
359#endif
360
361#if ADB_HOST_ON_TARGET
362/* adb and adbd are coexisting on the target, so use 5038 for adb
363 * to avoid conflicting with adbd's usage of 5037
364 */
365# define DEFAULT_ADB_PORT 5038
366#else
367# define DEFAULT_ADB_PORT 5037
368#endif
369
370#define DEFAULT_ADB_LOCAL_TRANSPORT_PORT 5555
371
372#define ADB_CLASS 0xff
373#define ADB_SUBCLASS 0x42
374#define ADB_PROTOCOL 0x1
375
376
377void local_init(int port);
378int local_connect(int port);
379int local_connect_arbitrary_ports(int console_port, int adb_port);
380
381/* usb host/client interface */
382void usb_init();
383void usb_cleanup();
384int usb_write(usb_handle *h, const void *data, int len);
385int usb_read(usb_handle *h, void *data, int len);
386int usb_close(usb_handle *h);
387void usb_kick(usb_handle *h);
388
389/* used for USB device detection */
390#if ADB_HOST
391int is_adb_interface(int vid, int pid, int usb_class, int usb_subclass, int usb_protocol);
392#endif
393
394unsigned host_to_le32(unsigned n);
395int adb_commandline(int argc, char **argv);
396
397int connection_state(atransport *t);
398
399#define CS_ANY -1
400#define CS_OFFLINE 0
401#define CS_BOOTLOADER 1
402#define CS_DEVICE 2
403#define CS_HOST 3
404#define CS_RECOVERY 4
405#define CS_NOPERM 5 /* Insufficient permissions to communicate with the device */
406#define CS_SIDELOAD 6
407
408extern int HOST;
409extern int SHELL_EXIT_NOTIFY_FD;
410
411#define CHUNK_SIZE (64*1024)
412
413int sendfailmsg(int fd, const char *reason);
414int handle_host_request(char *service, transport_type ttype, char* serial, int reply_fd, asocket *s);
415
Dees_Troy9a4b5692012-09-19 15:09:45 -0400416//#define ADB_SIDELOAD_FILENAME "/tmp/update.zip"
417extern char ADB_SIDELOAD_FILENAME[255];
Doug Zongker9270a202012-01-09 15:16:13 -0800418
419#endif