1
0
mirror of git://projects.qi-hardware.com/ben-wpan.git synced 2024-12-28 13:57:41 +02:00
ben-wpan/tools/atrf-proxy/PROTOCOL
Werner Almesberger f4ca3aed63 tools/atrf-proxy/: make WAIT 0 wait forever
- PROTOCOL: corrected obsolete part of WAIT behaviour
- PROTOCOL: mention that WAIT 0 waits forever
- atrf-proxy.c (cmd_more): don't convert WAIT argument 0 to 1
2011-06-20 22:14:52 -03:00

90 lines
1.5 KiB
Plaintext

Protocol specification
======================
Messages
--------
<open TCP session>
+[greeting]
-message
SPEC
+driver_spec
-message
RESET
+[comment]
-message
RESET_RF
+[comment]
-message
TEST
+[comment]
-message
SLP_TR 0|1 0|1
+[comment]
-message
CLKM freq_mhz
+[comment]
-message
SET register value
+[comment]
-message
GET register
+value
-message
WRITE length raw-data
+[comment]
-message
READ
+length raw-data
-message
SETRAM addr value
+[comment]
-message
GETRAM addr
+value
-message
WAIT timeout_ms
+value
-message
Message format
--------------
Commands are not case-sensitive. Messages and comments consist of printable
ASCII characters and spaces.
Whitespace separating words is always exactly one space character.
Lines end with a * single newline, without trailing whitespace.
Numeric values are in C notation, i.e., 64, 0100, and 0x40 would all
represent the same value.
"raw-data" is a string of binary data of the indicated length. The other
formatting conventions remain valid after this string, i.e., it must be
followed by a single newline.
The device is implicitly opened when establishing a TCP session. The
device is implicitly closed when closing the TCP session.
Asynchrous interrupt notification
---------------------------------
The WAIT command is not answered until an interrupt or until a timeout.
A timeout value of 0 means infinite. WAIT returns the value of the
IRQ_STATUS register. If WAIT times out before receiving an interrupt,
it returns 0.