FreeCalypso > hg > freecalypso-sw

comparison rvinterf/include/localsock.h @ 256:2f285f20d617

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
rvinterf: *.h moved into include subdir
author Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
date Tue, 04 Feb 2014 05:03:57 +0000
parents rvinterf/localsock.h@7ab6b29e76bb
children cb833ff54d88
comparison
equal deleted inserted replaced
255:c33fb341faeb 256:2f285f20d617
1 /*
2 * This header defines and describes (through comments) the local UNIX domain
3 * socket interface implemented between rvinterf and its clients like fc-tmsh.
4 *
5 * The UNIX domain sockets used for this ad hoc interface are of the
6 * SOCK_STREAM kind, but the true nature of the communication is message-based.
7 * We use the same trick that is used for DNS over TCP: every message in each
8 * direction is preceded by a 2-byte length. This length is sent MSB first
9 * just like in DNS over TCP. The limit on the size of these messages
10 * (for sizing buffers etc) is:
11 */
12
13 #define LOCALSOCK_MAX_MSG 1024
14
15 /*
16 * Each message in the client->rvinterf direction (can be seen as command)
17 * begins (after the length) with an opcode byte as follows:
18 */
19
20 #define CLI2RVI_WANT_RVTRACE 0x00
21 #define CLI2RVI_WANT_MUXPROTO 0x01
22 #define CLI2RVI_PKT_TO_TARGET 0x02
23 #define CLI2RVI_RAWBYTES_TO_TARGET 0x03
24
25 /*
26 * The first two commands (CLI2RVI_WANT_RVTRACE and CLI2RVI_WANT_MUXPROTO)
27 * are the means by which client programs inform rvinterf that they are
28 * interested in receiving copies of certain packets coming from the target.
29 *
30 * The CLI2RVI_WANT_RVTRACE opcode needs to be followed by a USEID mask value
31 * and a USEID match value, both in the network byte order, i.e., MSB first,
32 * for a total message length of 9 bytes. For every RV trace message received
33 * from the target, rvinterf will iterate through all active clients to see who
34 * is interested: if the received USEID ANDed with the mask equals the match
35 * value, the message will be forwarded to that client.
36 *
37 * The CLI2RVI_WANT_MUXPROTO opcode needs to be followed by one byte
38 * identifying the RVTMUX protocol of interest, i.e., the first byte of the
39 * packets exchanged between the host and the target, e.g., 0x12 for L1 traces
40 * as defined in pktmux.h, for a total message length of 2 bytes.
41 *
42 * The last two commands (CLI2RVI_PKT_TO_TARGET and CLI2RVI_RAWBYTES_TO_TARGET)
43 * cause data payload to be sent to the target serial port. Payload following
44 * CLI2RVI_PKT_TO_TARGET (must not exceed MAX_PKT_TO_TARGET) is sent with the
45 * proper packet encapsulation per TI; bytes following
46 * CLI2RVI_RAWBYTES_TO_TARGET are sent raw.
47 */
48
49 /*
50 * Each message in the rvinterf->client direction begins (after the length)
51 * with a message type byte as follows:
52 */
53
54 #define RVI2CLI_PKT_FROM_TARGET 0x00
55 #define RVI2CLI_LOCAL_CMD_RESP 0x01
56
57 /*
58 * Messages beginning with RVI2CLI_PKT_FROM_TARGET are packets received
59 * from the target GSM device; the byte following this type code is the
60 * first byte of the packet from the target, e.g., 0x11 for RV traces or
61 * 0x12 for L1 traces. Rvinterf will only start sending these messages
62 * to a client after that client has expressed interest in receiving
63 * target->host packets of a particular type.
64 *
65 * Messages beginning with RVI2CLI_LOCAL_CMD_RESP are generated locally
66 * by rvinterf itself as responses to commands, currently as responses to
67 * CLI2RVI_WANT_{RVTRACE,MUXPROTO}. The byte following the
68 * RVT2CLI_LOCAL_CMD_RESP type code is ASCII '+' or ASCII '-', indicating
69 * success or error, respectively. Any remaining bytes form a message
70 * for the user.
71 */