From 4bcc1c37b8832280540acd26c6a6135340188bfd Mon Sep 17 00:00:00 2001
From: Daniel Willmann <daniel@totalueberwachung.de>
Date: Thu, 6 Jan 2011 09:31:14 +0100
Subject: Add documentation for the control interface protocol

---
 openbsc/doc/control-interface.txt | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 openbsc/doc/control-interface.txt

(limited to 'openbsc')

diff --git a/openbsc/doc/control-interface.txt b/openbsc/doc/control-interface.txt
new file mode 100644
index 000000000..b43cafc35
--- /dev/null
+++ b/openbsc/doc/control-interface.txt
@@ -0,0 +1,21 @@
+The protocol for the control interface is wrapped inside the ip.access header
+with the IPAC_PROTO_OSMO protocol ID (0xee). Inside the ip.access header is
+a struct ipaccess_head_ext with protocol ID 0x00 which indicates the control
+interface.
+
+After that the actual protocol is text based:
+
+* Getting the value of a variable
+-> GET <id> <var>
+<- GET_REPLY <id> <var> <val>
+or ERROR <id> <reason>
+
+* Setting the value of a variable
+-> SET <id> <var> <val>
+<- SET_REPLY <id> <var> <val>
+or ERROR <id> <reason>
+
+* A value changes which triggers a trap
+<- TRAP <var> <val>
+
+<id> needs to be unique within a connection. '0' is not allowed
-- 
cgit v1.2.3