1
0
mirror of git://projects.qi-hardware.com/ben-wpan.git synced 2024-11-09 22:21:53 +02:00
ben-wpan/tools/atrf-proxy/PROTOCOL
Werner Almesberger 2961482cac tools: atrf-id option -s to retrieve driver spec, with necessary infrastructure
- include/atrf.h (atrf_driver_spec), lib/atrf.c (atrf_driver_spec):
  new function to retrieve the local or remote/final driver spec
- lib/atrf.c (struct atrf_dsc, atrf_open, atrf_close): record the local
  driver spec
- lib/driver.h (struct atrf_driver): new driver function "driver_spec"
  to retrieve the driver spec
- lib/atnet.c (struct atnet_dsc, atnet_open, atnet_close): maintain a
  cache for the driver spec
- lib/atnet.c (atnet_driver_spec, atnet_driver): added support for the
  "driver_spec" function
- atrf-proxy/PROTOCOL, atrf-proxy/atrf-proxy.c (cmd_zero): added command
  SPEC to retrieve the (final) driver spec
- atrf-id/atrf-id.c (usage, main): added option -s to retrieve the
  driver spec. One -s retrieves the local spec, -s -s the remote/final.
2011-04-20 08:58:17 -03:00

84 lines
1.3 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
+[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
POLL
+0|1
-message
WAIT
+0|1
-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 (not implemented yet)
---------------------------------
The WAIT command is not answered until an interrupt or another command is
received. WAIT returns the interrupt status, just like POLL.