Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 39e999e9 authored by Eyal Lezmy's avatar Eyal Lezmy
Browse files

Precise command constants on adb/protoxol.txt 



Try to improve the documentation by adding, for each commands explained
on the adb/protocol.txt file (CONNECT, WRITE, AUTH, ...), the
corresponding constant used by the protocol (A_CNXN, A_WRTE,
A_AUTH, ...).

I've seen a few engineers having problems matching these both
information by simply reading the doc and they loose time before
getting it. Most of the time they understand it by finally reading the
source code.

By adding this simple information at the end of each command
description I'm sure it will help onboarding developers to
understand more quickly the way the ADB protocol works.

Change-Id: Ibb949fd6a6d34a2bc7f47f0e7af2f57138c9a369
Signed-off-by: default avatarEyal Lezmy <eyal.lezmy@gmail.com>
parent 87ef739d

adb/protocol.txt

+23 −10
Original line number Diff line number Diff line
@@ -29,7 +29,7 @@ header followed (optionally) by a payload. The header consists of 6 
32 bit words which are sent across the wire in little endian format.



struct message {

    unsigned command;       /* command identifier constant      */

    unsigned command;       /* command identifier constant (A_CNXN, ...) */

    unsigned arg0;          /* first argument                            */

    unsigned arg1;          /* second argument                           */

    unsigned data_length;   /* length of payload (0 is allowed)          */
@@ -55,6 +55,8 @@ reversed. 


--- CONNECT(version, maxdata, "system-identity-string") ----------------



Command constant: A_CNXN



The CONNECT message establishes the presence of a remote system.

The version is used to ensure protocol compatibility and maxdata

declares the maximum message body size that the remote system
@@ -80,6 +82,8 @@ or identifier string. The banner is used to transmit useful properties. 


--- AUTH(type, 0, "data") ----------------------------------------------



Command constant: A_AUTH



The AUTH message informs the recipient that authentication is required to

connect to the sender. If type is TOKEN(1), data is a random token that

the recipient can sign with a private key. The recipient replies with an
@@ -98,6 +102,8 @@ confirm they want to install the public key on the device. 


--- OPEN(local-id, 0, "destination") -----------------------------------



Command constant: A_OPEN



The OPEN message informs the recipient that the sender has a stream

identified by local-id that it wishes to connect to the named

destination in the message payload.  The local-id may not be zero.
@@ -120,6 +126,8 @@ Common destination naming conventions include: 


--- READY(local-id, remote-id, "") -------------------------------------



Command constant: A_OKAY



The READY message informs the recipient that the sender's stream

identified by local-id is ready for write messages and that it is

connected to the recipient's stream identified by remote-id.
@@ -135,9 +143,10 @@ is used to establish the connection). Nonetheless, the local-id MUST 
not change on later READY messages sent to the same stream.







--- WRITE(local-id, remote-id, "data") ---------------------------------



Command constant: A_WRTE



The WRITE message sends data to the recipient's stream identified by

remote-id.  The payload MUST be <= maxdata in length.
@@ -154,6 +163,8 @@ the connection. 


--- CLOSE(local-id, remote-id, "") -------------------------------------



Command constant: A_CLSE



The CLOSE message informs recipient that the connection between the

sender's stream (local-id) and the recipient's stream (remote-id) is

broken.  The remote-id MUST not be zero, but the local-id MAY be zero
@@ -170,6 +181,8 @@ requirement, since they will be ignored. 


--- SYNC(online, sequence, "") -----------------------------------------



Command constant: A_SYNC



The SYNC message is used by the io pump to make sure that stale

outbound messages are discarded when the connection to the remote side

is broken.  It is only used internally to the bridge and never valid