[PATCH 01/10] Add documentation for the control interface protocol

This is merely a historical archive of years 2008-2021, before the migration to mailman3.

A maintained and still updated list archive can be found at https://lists.osmocom.org/hyperkitty/list/OpenBSC@lists.osmocom.org/.

Daniel Willmann daniel at totalueberwachung.de
Fri May 20 17:06:18 UTC 2011


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

diff --git a/openbsc/doc/control-interface.txt b/openbsc/doc/control-interface.txt
new file mode 100644
index 0000000..b43cafc
--- /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
-- 
1.7.5.rc3





More information about the OpenBSC mailing list