1
0
mirror of git://projects.qi-hardware.com/ben-wpan.git synced 2024-11-25 23:39:22 +02:00
ben-wpan/tools/atrf-proxy/PROTOCOL
Werner Almesberger 668d8c61cf tools/: added interrupt_wait support to atnet and atrf-proxy (untested)
- atrf-proxy/PROTOCOL: WAIT is now implemented and takes a timeout
  argument
- atrf-proxy/atrf-proxy.c (cmd_more): implemented WAIT command using
  atrf_interrupt_wait
- lib/atnet.c (atnet_interrupt_wait, atnet_driver): added
  interrupt_wait (using WAIT)
2011-06-20 17:42:48 -03:00

93 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
POLL
+0|1
-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 another command is
received. WAIT returns the value of the IRQ_STATUS register. If WAIT
times out before receiving an interrupt, it returns 0.