adb.h revision 252586941934d23073a8d167ec240b221062505f 
1/*
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
24#define MAX_PAYLOAD 4096
25
26#define A_SYNC 0x434e5953
27#define A_CNXN 0x4e584e43
28#define A_OPEN 0x4e45504f
29#define A_OKAY 0x59414b4f
30#define A_CLSE 0x45534c43
31#define A_WRTE 0x45545257
32#define A_AUTH 0x48545541
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    31    // 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;
44typedef struct alistener alistener;
45typedef struct aservice aservice;
46typedef struct atransport atransport;
47typedef struct adisconnect  adisconnect;
48typedef struct usb_handle usb_handle;
49
50struct amessage {
51    unsigned command;       /* command identifier constant      */
52    unsigned arg0;          /* first argument                   */
53    unsigned arg1;          /* second argument                  */
54    unsigned data_length;   /* length of payload (0 is allowed) */
55    unsigned data_check;    /* checksum of data payload         */
56    unsigned magic;         /* command ^ 0xffffffff             */
57};
58
59struct apacket
60{
61    apacket *next;
62
63    unsigned len;
64    unsigned char *ptr;
65
66    amessage msg;
67    unsigned char data[MAX_PAYLOAD];
68};
69
70/* An asocket represents one half of a connection between a local and
71** remote entity.  A local asocket is bound to a file descriptor.  A
72** remote asocket is bound to the protocol engine.
73*/
74struct asocket {
75        /* chain pointers for the local/remote list of
76        ** asockets that this asocket lives in
77        */
78    asocket *next;
79    asocket *prev;
80
81        /* the unique identifier for this asocket
82        */
83    unsigned id;
84
85        /* flag: set when the socket's peer has closed
86        ** but packets are still queued for delivery
87        */
88    int    closing;
89
90        /* flag: quit adbd when both ends close the
91        ** local service socket
92        */
93    int    exit_on_close;
94
95        /* the asocket we are connected to
96        */
97
98    asocket *peer;
99
100        /* For local asockets, the fde is used to bind
101        ** us to our fd event system.  For remote asockets
102        ** these fields are not used.
103        */
104    fdevent fde;
105    int fd;
106
107        /* queue of apackets waiting to be written
108        */
109    apacket *pkt_first;
110    apacket *pkt_last;
111
112        /* enqueue is called by our peer when it has data
113        ** for us.  It should return 0 if we can accept more
114        ** data or 1 if not.  If we return 1, we must call
115        ** peer->ready() when we once again are ready to
116        ** receive data.
117        */
118    int (*enqueue)(asocket *s, apacket *pkt);
119
120        /* ready is called by the peer when it is ready for
121        ** us to send data via enqueue again
122        */
123    void (*ready)(asocket *s);
124
125        /* shutdown is called by the peer before it goes away.
126        ** the socket should not do any further calls on its peer.
127        ** Always followed by a call to close. Optional, i.e. can be NULL.
128        */
129    void (*shutdown)(asocket *s);
130
131        /* close is called by the peer when it has gone away.
132        ** we are not allowed to make any further calls on the
133        ** peer once our close method is called.
134        */
135    void (*close)(asocket *s);
136
137        /* A socket is bound to atransport */
138    atransport *transport;
139};
140
141
142/* the adisconnect structure is used to record a callback that
143** will be called whenever a transport is disconnected (e.g. by the user)
144** this should be used to cleanup objects that depend on the
145** transport (e.g. remote sockets, listeners, etc...)
146*/
147struct  adisconnect
148{
149    void        (*func)(void*  opaque, atransport*  t);
150    void*         opaque;
151    adisconnect*  next;
152    adisconnect*  prev;
153};
154
155
156/* a transport object models the connection to a remote device or emulator
157** there is one transport per connected device/emulator. a "local transport"
158** connects through TCP (for the emulator), while a "usb transport" through
159** USB (for real devices)
160**
161** note that kTransportHost doesn't really correspond to a real transport
162** object, it's a special value used to indicate that a client wants to
163** connect to a service implemented within the ADB server itself.
164*/
165typedef enum transport_type {
166        kTransportUsb,
167        kTransportLocal,
168        kTransportAny,
169        kTransportHost,
170} transport_type;
171
172#define TOKEN_SIZE 20
173
174struct atransport
175{
176    atransport *next;
177    atransport *prev;
178
179    int (*read_from_remote)(apacket *p, atransport *t);
180    int (*write_to_remote)(apacket *p, atransport *t);
181    void (*close)(atransport *t);
182    void (*kick)(atransport *t);
183
184    int fd;
185    int transport_socket;
186    fdevent transport_fde;
187    int ref_count;
188    unsigned sync_token;
189    int connection_state;
190    int online;
191    transport_type type;
192
193        /* usb handle or socket fd as needed */
194    usb_handle *usb;
195    int sfd;
196
197        /* used to identify transports for clients */
198    char *serial;
199    char *product;
200    char *model;
201    char *device;
202    char *devpath;
203    int adb_port; // Use for emulators (local transport)
204
205        /* a list of adisconnect callbacks called when the transport is kicked */
206    int          kicked;
207    adisconnect  disconnects;
208
209    void *key;
210    unsigned char token[TOKEN_SIZE];
211    fdevent auth_fde;
212    unsigned failed_auth_attempts;
213};
214
215
216/* A listener is an entity which binds to a local port
217** and, upon receiving a connection on that port, creates
218** an asocket to connect the new local connection to a
219** specific remote service.
220**
221** TODO: some listeners read from the new connection to
222** determine what exact service to connect to on the far
223** side.
224*/
225struct alistener
226{
227    alistener *next;
228    alistener *prev;
229
230    fdevent fde;
231    int fd;
232
233    const char *local_name;
234    const char *connect_to;
235    atransport *transport;
236    adisconnect  disconnect;
237};
238
239
240void print_packet(const char *label, apacket *p);
241
242asocket *find_local_socket(unsigned local_id, unsigned remote_id);
243void install_local_socket(asocket *s);
244void remove_socket(asocket *s);
245void close_all_sockets(atransport *t);
246
247#define  LOCAL_CLIENT_PREFIX  "emulator-"
248
249asocket *create_local_socket(int fd);
250asocket *create_local_service_socket(const char *destination);
251
252asocket *create_remote_socket(unsigned id, atransport *t);
253void connect_to_remote(asocket *s, const char *destination);
254void connect_to_smartsocket(asocket *s);
255
256void fatal(const char *fmt, ...);
257void fatal_errno(const char *fmt, ...);
258
259void handle_packet(apacket *p, atransport *t);
260void send_packet(apacket *p, atransport *t);
261
262void get_my_path(char *s, size_t maxLen);
263int launch_server(int server_port);
264int adb_main(int is_daemon, int server_port);
265
266
267/* transports are ref-counted
268** get_device_transport does an acquire on your behalf before returning
269*/
270void init_transport_registration(void);
271int  list_transports(char *buf, size_t  bufsize, int long_listing);
272void update_transports(void);
273
274asocket*  create_device_tracker(void);
275
276/* Obtain a transport from the available transports.
277** If state is != CS_ANY, only transports in that state are considered.
278** If serial is non-NULL then only the device with that serial will be chosen.
279** If no suitable transport is found, error is set.
280*/
281atransport *acquire_one_transport(int state, transport_type ttype, const char* serial, char **error_out);
282void   add_transport_disconnect( atransport*  t, adisconnect*  dis );
283void   remove_transport_disconnect( atransport*  t, adisconnect*  dis );
284void   run_transport_disconnects( atransport*  t );
285void   kick_transport( atransport*  t );
286
287/* initialize a transport object's func pointers and state */
288#if ADB_HOST
289int get_available_local_transport_index();
290#endif
291int  init_socket_transport(atransport *t, int s, int port, int local);
292void init_usb_transport(atransport *t, usb_handle *usb, int state);
293
294/* for MacOS X cleanup */
295void close_usb_devices();
296
297/* cause new transports to be init'd and added to the list */
298int register_socket_transport(int s, const char *serial, int port, int local);
299
300/* these should only be used for the "adb disconnect" command */
301void unregister_transport(atransport *t);
302void unregister_all_tcp_transports();
303
304void register_usb_transport(usb_handle *h, const char *serial, const char *devpath, unsigned writeable);
305
306/* this should only be used for transports with connection_state == CS_NOPERM */
307void unregister_usb_transport(usb_handle *usb);
308
309atransport *find_transport(const char *serial);
310#if ADB_HOST
311atransport* find_emulator_transport_by_adb_port(int adb_port);
312#endif
313
314int service_to_fd(const char *name);
315#if ADB_HOST
316asocket *host_service_to_socket(const char*  name, const char *serial);
317#endif
318
319#if !ADB_HOST
320int       init_jdwp(void);
321asocket*  create_jdwp_service_socket();
322asocket*  create_jdwp_tracker_service_socket();
323int       create_jdwp_connection_fd(int  jdwp_pid);
324#endif
325
326int handle_forward_request(const char* service, transport_type ttype, char* serial, int reply_fd);
327
328#if !ADB_HOST
329typedef enum {
330    BACKUP,
331    RESTORE
332} BackupOperation;
333int backup_service(BackupOperation operation, char* args);
334void framebuffer_service(int fd, void *cookie);
335void remount_service(int fd, void *cookie);
336#endif
337
338/* packet allocator */
339apacket *get_apacket(void);
340void put_apacket(apacket *p);
341
342int check_header(apacket *p);
343int check_data(apacket *p);
344
345/* define ADB_TRACE to 1 to enable tracing support, or 0 to disable it */
346
347#define  ADB_TRACE    1
348
349/* IMPORTANT: if you change the following list, don't
350 * forget to update the corresponding 'tags' table in
351 * the adb_trace_init() function implemented in adb.c
352 */
353typedef enum {
354    TRACE_ADB = 0,   /* 0x001 */
355    TRACE_SOCKETS,
356    TRACE_PACKETS,
357    TRACE_TRANSPORT,
358    TRACE_RWX,       /* 0x010 */
359    TRACE_USB,
360    TRACE_SYNC,
361    TRACE_SYSDEPS,
362    TRACE_JDWP,      /* 0x100 */
363    TRACE_SERVICES,
364    TRACE_AUTH,
365} AdbTrace;
366
367#if ADB_TRACE
368
369#if !ADB_HOST
370/*
371 * When running inside the emulator, guest's adbd can connect to 'adb-debug'
372 * qemud service that can display adb trace messages (on condition that emulator
373 * has been started with '-debug adb' option).
374 */
375
376/* Delivers a trace message to the emulator via QEMU pipe. */
377void adb_qemu_trace(const char* fmt, ...);
378/* Macro to use to send ADB trace messages to the emulator. */
379#define DQ(...)    adb_qemu_trace(__VA_ARGS__)
380#else
381#define DQ(...) ((void)0)
382#endif  /* !ADB_HOST */
383
384  extern int     adb_trace_mask;
385  extern unsigned char    adb_trace_output_count;
386  void    adb_trace_init(void);
387
388#  define ADB_TRACING  ((adb_trace_mask & (1 << TRACE_TAG)) != 0)
389
390  /* you must define TRACE_TAG before using this macro */
391#  define  D(...)                                      \
392        do {                                           \
393            if (ADB_TRACING) {                         \
394                int save_errno = errno;                \
395                adb_mutex_lock(&D_lock);               \
396                fprintf(stderr, "%s::%s():",           \
397                        __FILE__, __FUNCTION__);       \
398                errno = save_errno;                    \
399                fprintf(stderr, __VA_ARGS__ );         \
400                fflush(stderr);                        \
401                adb_mutex_unlock(&D_lock);             \
402                errno = save_errno;                    \
403           }                                           \
404        } while (0)
405#  define  DR(...)                                     \
406        do {                                           \
407            if (ADB_TRACING) {                         \
408                int save_errno = errno;                \
409                adb_mutex_lock(&D_lock);               \
410                errno = save_errno;                    \
411                fprintf(stderr, __VA_ARGS__ );         \
412                fflush(stderr);                        \
413                adb_mutex_unlock(&D_lock);             \
414                errno = save_errno;                    \
415           }                                           \
416        } while (0)
417#else
418#  define  D(...)          ((void)0)
419#  define  DR(...)         ((void)0)
420#  define  ADB_TRACING     0
421#endif
422
423
424#if !DEBUG_PACKETS
425#define print_packet(tag,p) do {} while (0)
426#endif
427
428#if ADB_HOST_ON_TARGET
429/* adb and adbd are coexisting on the target, so use 5038 for adb
430 * to avoid conflicting with adbd's usage of 5037
431 */
432#  define DEFAULT_ADB_PORT 5038
433#else
434#  define DEFAULT_ADB_PORT 5037
435#endif
436
437#define DEFAULT_ADB_LOCAL_TRANSPORT_PORT 5555
438
439#define ADB_CLASS              0xff
440#define ADB_SUBCLASS           0x42
441#define ADB_PROTOCOL           0x1
442
443
444void local_init(int port);
445int  local_connect(int  port);
446int  local_connect_arbitrary_ports(int console_port, int adb_port);
447
448/* usb host/client interface */
449void usb_init();
450void usb_cleanup();
451int usb_write(usb_handle *h, const void *data, int len);
452int usb_read(usb_handle *h, void *data, int len);
453int usb_close(usb_handle *h);
454void usb_kick(usb_handle *h);
455
456/* used for USB device detection */
457#if ADB_HOST
458int is_adb_interface(int vid, int pid, int usb_class, int usb_subclass, int usb_protocol);
459#endif
460
461unsigned host_to_le32(unsigned n);
462int adb_commandline(int argc, char **argv);
463
464int connection_state(atransport *t);
465
466#define CS_ANY       -1
467#define CS_OFFLINE    0
468#define CS_BOOTLOADER 1
469#define CS_DEVICE     2
470#define CS_HOST       3
471#define CS_RECOVERY   4
472#define CS_NOPERM     5 /* Insufficient permissions to communicate with the device */
473#define CS_SIDELOAD   6
474#define CS_UNAUTHORIZED 7
475
476extern int HOST;
477extern int SHELL_EXIT_NOTIFY_FD;
478
479#define CHUNK_SIZE (64*1024)
480
481#if !ADB_HOST
482#define USB_ADB_PATH     "/dev/android_adb"
483
484#define USB_FFS_ADB_PATH  "/dev/usb-ffs/adb/"
485#define USB_FFS_ADB_EP(x) USB_FFS_ADB_PATH#x
486
487#define USB_FFS_ADB_EP0   USB_FFS_ADB_EP(ep0)
488#define USB_FFS_ADB_OUT   USB_FFS_ADB_EP(ep1)
489#define USB_FFS_ADB_IN    USB_FFS_ADB_EP(ep2)
490#endif
491
492int sendfailmsg(int fd, const char *reason);
493int handle_host_request(char *service, transport_type ttype, char* serial, int reply_fd, asocket *s);
494
495#endif
496