diff options
| author | Daniel Willmann <daniel@totalueberwachung.de> | 2011-01-06 09:31:14 +0100 |
|---|---|---|
| committer | Harald Welte <laforge@gnumonks.org> | 2011-07-13 14:06:18 +0200 |
| commit | 4bcc1c37b8832280540acd26c6a6135340188bfd (patch) | |
| tree | 05eb24c0386fa8e99f989da17c721c1599b3cbe0 /openbsc | |
| parent | 7d33bdf9626fc1edd2629d01f1b57b2e83e0e3d0 (diff) | |
Add documentation for the control interface protocol
Diffstat (limited to 'openbsc')
| -rw-r--r-- | openbsc/doc/control-interface.txt | 21 |
1 files changed, 21 insertions, 0 deletions
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 |