subject:"osmo\-gsm\-manuals\[master\]\: Introduce OsmoTRX manual"

[MERGED] osmo-gsm-manuals[master]: Introduce OsmoTRX manual

2018-03-06 Thread Harald Welte

Harald Welte has submitted this change and it was merged.

Change subject: Introduce OsmoTRX manual
..


Introduce OsmoTRX manual

Change-Id: I19ee9d6cda02fb7200c96c0ac129e69825b096cd
---
M Makefile
A OsmoTRX/Makefile
A OsmoTRX/chapters/configuration.adoc
A OsmoTRX/chapters/control.adoc
A OsmoTRX/chapters/counters.adoc
A OsmoTRX/chapters/counters_generated.adoc
A OsmoTRX/chapters/overview.adoc
A OsmoTRX/chapters/running.adoc
A OsmoTRX/osmotrx-usermanual-docinfo.xml
A OsmoTRX/osmotrx-usermanual.adoc
A OsmoTRX/osmotrx-vty-reference.xml
A OsmoTRX/vty/trx_vty_additions.xml
A OsmoTRX/vty/trx_vty_reference.xml
13 files changed, 1,451 insertions(+), 0 deletions(-)

Approvals:
  Harald Welte: Looks good to me, approved
  Jenkins Builder: Verified



diff --git a/Makefile b/Makefile
index 45fe129..4e821f5 100644
--- a/Makefile
+++ b/Makefile
@@ -15,6 +15,7 @@
cd OsmoSTP; $(MAKE)
cd OsmocomBB; $(MAKE)
cd OsmoMGW; $(MAKE)
+   cd OsmoTRX; $(MAKE)
 
 clean:
cd OsmoBTS; $(MAKE) clean
@@ -31,6 +32,7 @@
cd OsmoSTP; $(MAKE) clean
cd OsmocomBB; $(MAKE) clean
cd OsmoMGW; $(MAKE) clean
+   cd OsmoTRX; $(MAKE) clean
 
 upload:
cd OsmoBTS; $(MAKE) upload
@@ -47,6 +49,7 @@
cd OsmoSTP; $(MAKE) upload
cd OsmocomBB; $(MAKE) upload
cd OsmoMGW; $(MAKE) upload
+   cd OsmoTRX; $(MAKE) upload
 
 check:
cd OsmoBTS; $(MAKE) check
@@ -65,6 +68,7 @@
cd OsmoHLR; $(MAKE) check
cd OsmoSTP; $(MAKE) check
cd OsmocomBB; $(MAKE) check
+   cd OsmoTRX; $(MAKE) check
 
 define check_dep_bin
 @type $(1) >/dev/null 2>&1 || { echo >&2 "Binary '$(1)' not found in path, 
please install $(2)."; exit 1; }
diff --git a/OsmoTRX/Makefile b/OsmoTRX/Makefile
new file mode 100644
index 000..81aec9a
--- /dev/null
+++ b/OsmoTRX/Makefile
@@ -0,0 +1,10 @@
+TOPDIR = ..
+
+ASCIIDOC = osmotrx-usermanual.adoc
+ASCIIDOC_DEPS = chapters/*.adoc
+include $(TOPDIR)/build/Makefile.asciidoc.inc
+
+VTY_REFERENCE = osmotrx-vty-reference.xml
+include $(TOPDIR)/build/Makefile.vty-reference.inc
+
+include $(TOPDIR)/build/Makefile.common.inc
diff --git a/OsmoTRX/chapters/configuration.adoc 
b/OsmoTRX/chapters/configuration.adoc
new file mode 100644
index 000..cdde366
--- /dev/null
+++ b/OsmoTRX/chapters/configuration.adoc
@@ -0,0 +1,36 @@
+== Configuring OsmTRX
+
+OsmoTRX will read the configuration at startup time and configure the
+transceiver accordingly after validating the configuration.
+
+OsmoTRX can handle several TRX channels, but at least one must be configured in
+order to be able to start it successfully. Channels must be present in the
+configuration file in incremental order, starting from 0 and be consecutive.
+
+Example configuration files for different devices and setups can be found in
+`doc/examples/` in 'osmo-trx' git repository.
+
+=== Documented example
+
+.Example: Static GGSN/APN configuration (single catch-all GGSN)
+
+trx
+ bind-ip 127.0.0.1 <1>
+ remote-ip 127.0.0.1 <2>
+ base-port 5700 <3>
+ egprs disable <4>
+ tx-sps 4 <5>
+ rx-sps 4 <6>
+ chan 0 <7>
+  tx-path BAND1 <8>
+  rx-path LNAW <9>
+
+<1> Configure the local IP address at the TRX used for the connection against 
`osmo-bts-trx`.
+<2> Specify the IP address of `osmo-bts-trx` to connect to.
+<3> Specify the reference base UDP port to use for communication.
+<4> Don't enable EDGE support.
+<5> Use 4 TX samples per symbol. This is device specific.
+<6> Use 4 RX samples per symbol. This is device specific.
+<7> Configure the first channel. As no other channels are specified, 
`osmo-trx` assumes it is using only one channel.
+<8> Configure the device to use `BAND1` Tx antenna path from all the available 
ones (device specific).
+<9> Configure the device to use `LNAW` Rx antenna path from all the available 
ones (device specific).
diff --git a/OsmoTRX/chapters/control.adoc b/OsmoTRX/chapters/control.adoc
new file mode 100644
index 000..168769a
--- /dev/null
+++ b/OsmoTRX/chapters/control.adoc
@@ -0,0 +1,12 @@
+[[control]]
+== Control interface
+
+The actual protocol is described in <>, the variables
+common to all programs using it are described in <>. Here we
+describe variables specific to OsmoTRX.
+
+.Variables available over control interface
+[options="header",width="100%",cols="20%,5%,5%,50%,20%"]
+|===
+|Name|Access|Trap|Value|Comment
+|===
diff --git a/OsmoTRX/chapters/counters.adoc b/OsmoTRX/chapters/counters.adoc
new file mode 100644
index 000..7fbb10c
--- /dev/null
+++ b/OsmoTRX/chapters/counters.adoc
@@ -0,0 +1,4 @@
+[[counters]]
+== Counters
+
+include::./counters_generated.adoc[]
diff --git a/OsmoTRX/chapters/counters_generated.adoc 
b/OsmoTRX/chapters/counters_generated.adoc
new file mode 100644
index 000..b40dc37
--- /dev/null
+++ b/OsmoTRX/chapters/counters_generated.adoc
@@ -0,0 +1,7 @@
+// autogenerated by show asciidoc counters
+These counters and

osmo-gsm-manuals[master]: Introduce OsmoTRX manual

2018-03-06 Thread Harald Welte


Patch Set 2: Code-Review+2

-- 
To view, visit https://gerrit.osmocom.org/7139
To unsubscribe, visit https://gerrit.osmocom.org/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: I19ee9d6cda02fb7200c96c0ac129e69825b096cd
Gerrit-PatchSet: 2
Gerrit-Project: osmo-gsm-manuals
Gerrit-Branch: master
Gerrit-Owner: Pau Espin Pedrol 
Gerrit-Reviewer: Harald Welte 
Gerrit-Reviewer: Jenkins Builder
Gerrit-HasComments: No

[PATCH] osmo-gsm-manuals[master]: Introduce OsmoTRX manual

2018-03-06 Thread Pau Espin Pedrol

Hello Jenkins Builder,

I'd like you to reexamine a change.  Please visit

https://gerrit.osmocom.org/7139

to look at the new patch set (#2).

Introduce OsmoTRX manual

Change-Id: I19ee9d6cda02fb7200c96c0ac129e69825b096cd
---
M Makefile
A OsmoTRX/Makefile
A OsmoTRX/chapters/configuration.adoc
A OsmoTRX/chapters/control.adoc
A OsmoTRX/chapters/counters.adoc
A OsmoTRX/chapters/counters_generated.adoc
A OsmoTRX/chapters/overview.adoc
A OsmoTRX/chapters/running.adoc
A OsmoTRX/osmotrx-usermanual-docinfo.xml
A OsmoTRX/osmotrx-usermanual.adoc
A OsmoTRX/osmotrx-vty-reference.xml
A OsmoTRX/vty/trx_vty_additions.xml
A OsmoTRX/vty/trx_vty_reference.xml
13 files changed, 1,451 insertions(+), 0 deletions(-)


  git pull ssh://gerrit.osmocom.org:29418/osmo-gsm-manuals 
refs/changes/39/7139/2

diff --git a/Makefile b/Makefile
index 45fe129..4e821f5 100644
--- a/Makefile
+++ b/Makefile
@@ -15,6 +15,7 @@
cd OsmoSTP; $(MAKE)
cd OsmocomBB; $(MAKE)
cd OsmoMGW; $(MAKE)
+   cd OsmoTRX; $(MAKE)
 
 clean:
cd OsmoBTS; $(MAKE) clean
@@ -31,6 +32,7 @@
cd OsmoSTP; $(MAKE) clean
cd OsmocomBB; $(MAKE) clean
cd OsmoMGW; $(MAKE) clean
+   cd OsmoTRX; $(MAKE) clean
 
 upload:
cd OsmoBTS; $(MAKE) upload
@@ -47,6 +49,7 @@
cd OsmoSTP; $(MAKE) upload
cd OsmocomBB; $(MAKE) upload
cd OsmoMGW; $(MAKE) upload
+   cd OsmoTRX; $(MAKE) upload
 
 check:
cd OsmoBTS; $(MAKE) check
@@ -65,6 +68,7 @@
cd OsmoHLR; $(MAKE) check
cd OsmoSTP; $(MAKE) check
cd OsmocomBB; $(MAKE) check
+   cd OsmoTRX; $(MAKE) check
 
 define check_dep_bin
 @type $(1) >/dev/null 2>&1 || { echo >&2 "Binary '$(1)' not found in path, 
please install $(2)."; exit 1; }
diff --git a/OsmoTRX/Makefile b/OsmoTRX/Makefile
new file mode 100644
index 000..81aec9a
--- /dev/null
+++ b/OsmoTRX/Makefile
@@ -0,0 +1,10 @@
+TOPDIR = ..
+
+ASCIIDOC = osmotrx-usermanual.adoc
+ASCIIDOC_DEPS = chapters/*.adoc
+include $(TOPDIR)/build/Makefile.asciidoc.inc
+
+VTY_REFERENCE = osmotrx-vty-reference.xml
+include $(TOPDIR)/build/Makefile.vty-reference.inc
+
+include $(TOPDIR)/build/Makefile.common.inc
diff --git a/OsmoTRX/chapters/configuration.adoc 
b/OsmoTRX/chapters/configuration.adoc
new file mode 100644
index 000..cdde366
--- /dev/null
+++ b/OsmoTRX/chapters/configuration.adoc
@@ -0,0 +1,36 @@
+== Configuring OsmTRX
+
+OsmoTRX will read the configuration at startup time and configure the
+transceiver accordingly after validating the configuration.
+
+OsmoTRX can handle several TRX channels, but at least one must be configured in
+order to be able to start it successfully. Channels must be present in the
+configuration file in incremental order, starting from 0 and be consecutive.
+
+Example configuration files for different devices and setups can be found in
+`doc/examples/` in 'osmo-trx' git repository.
+
+=== Documented example
+
+.Example: Static GGSN/APN configuration (single catch-all GGSN)
+
+trx
+ bind-ip 127.0.0.1 <1>
+ remote-ip 127.0.0.1 <2>
+ base-port 5700 <3>
+ egprs disable <4>
+ tx-sps 4 <5>
+ rx-sps 4 <6>
+ chan 0 <7>
+  tx-path BAND1 <8>
+  rx-path LNAW <9>
+
+<1> Configure the local IP address at the TRX used for the connection against 
`osmo-bts-trx`.
+<2> Specify the IP address of `osmo-bts-trx` to connect to.
+<3> Specify the reference base UDP port to use for communication.
+<4> Don't enable EDGE support.
+<5> Use 4 TX samples per symbol. This is device specific.
+<6> Use 4 RX samples per symbol. This is device specific.
+<7> Configure the first channel. As no other channels are specified, 
`osmo-trx` assumes it is using only one channel.
+<8> Configure the device to use `BAND1` Tx antenna path from all the available 
ones (device specific).
+<9> Configure the device to use `LNAW` Rx antenna path from all the available 
ones (device specific).
diff --git a/OsmoTRX/chapters/control.adoc b/OsmoTRX/chapters/control.adoc
new file mode 100644
index 000..168769a
--- /dev/null
+++ b/OsmoTRX/chapters/control.adoc
@@ -0,0 +1,12 @@
+[[control]]
+== Control interface
+
+The actual protocol is described in <>, the variables
+common to all programs using it are described in <>. Here we
+describe variables specific to OsmoTRX.
+
+.Variables available over control interface
+[options="header",width="100%",cols="20%,5%,5%,50%,20%"]
+|===
+|Name|Access|Trap|Value|Comment
+|===
diff --git a/OsmoTRX/chapters/counters.adoc b/OsmoTRX/chapters/counters.adoc
new file mode 100644
index 000..7fbb10c
--- /dev/null
+++ b/OsmoTRX/chapters/counters.adoc
@@ -0,0 +1,4 @@
+[[counters]]
+== Counters
+
+include::./counters_generated.adoc[]
diff --git a/OsmoTRX/chapters/counters_generated.adoc 
b/OsmoTRX/chapters/counters_generated.adoc
new file mode 100644
index 000..b40dc37
--- /dev/null
+++ b/OsmoTRX/chapters/counters_generated.adoc
@@ -0,0 +1,7 @@
+// autogenerated by show asciidoc counters
+These counters and their description based on

[PATCH] osmo-gsm-manuals[master]: Introduce OsmoTRX manual

2018-03-06 Thread Pau Espin Pedrol


Review at  https://gerrit.osmocom.org/7139

Introduce OsmoTRX manual

Change-Id: I19ee9d6cda02fb7200c96c0ac129e69825b096cd
---
M Makefile
A OsmoTRX/Makefile
A OsmoTRX/chapters/configuration.adoc
A OsmoTRX/chapters/control.adoc
A OsmoTRX/chapters/counters.adoc
A OsmoTRX/chapters/counters_generated.adoc
A OsmoTRX/chapters/overview.adoc
A OsmoTRX/chapters/running.adoc
A OsmoTRX/osmotrx-usermanual-docinfo.xml
A OsmoTRX/osmotrx-usermanual.adoc
A OsmoTRX/osmotrx-vty-reference.xml
A OsmoTRX/vty/trx_vty_additions.xml
A OsmoTRX/vty/trx_vty_reference.xml
13 files changed, 1,451 insertions(+), 0 deletions(-)


  git pull ssh://gerrit.osmocom.org:29418/osmo-gsm-manuals 
refs/changes/39/7139/1

diff --git a/Makefile b/Makefile
index 45fe129..4e821f5 100644
--- a/Makefile
+++ b/Makefile
@@ -15,6 +15,7 @@
cd OsmoSTP; $(MAKE)
cd OsmocomBB; $(MAKE)
cd OsmoMGW; $(MAKE)
+   cd OsmoTRX; $(MAKE)
 
 clean:
cd OsmoBTS; $(MAKE) clean
@@ -31,6 +32,7 @@
cd OsmoSTP; $(MAKE) clean
cd OsmocomBB; $(MAKE) clean
cd OsmoMGW; $(MAKE) clean
+   cd OsmoTRX; $(MAKE) clean
 
 upload:
cd OsmoBTS; $(MAKE) upload
@@ -47,6 +49,7 @@
cd OsmoSTP; $(MAKE) upload
cd OsmocomBB; $(MAKE) upload
cd OsmoMGW; $(MAKE) upload
+   cd OsmoTRX; $(MAKE) upload
 
 check:
cd OsmoBTS; $(MAKE) check
@@ -65,6 +68,7 @@
cd OsmoHLR; $(MAKE) check
cd OsmoSTP; $(MAKE) check
cd OsmocomBB; $(MAKE) check
+   cd OsmoTRX; $(MAKE) check
 
 define check_dep_bin
 @type $(1) >/dev/null 2>&1 || { echo >&2 "Binary '$(1)' not found in path, 
please install $(2)."; exit 1; }
diff --git a/OsmoTRX/Makefile b/OsmoTRX/Makefile
new file mode 100644
index 000..81aec9a
--- /dev/null
+++ b/OsmoTRX/Makefile
@@ -0,0 +1,10 @@
+TOPDIR = ..
+
+ASCIIDOC = osmotrx-usermanual.adoc
+ASCIIDOC_DEPS = chapters/*.adoc
+include $(TOPDIR)/build/Makefile.asciidoc.inc
+
+VTY_REFERENCE = osmotrx-vty-reference.xml
+include $(TOPDIR)/build/Makefile.vty-reference.inc
+
+include $(TOPDIR)/build/Makefile.common.inc
diff --git a/OsmoTRX/chapters/configuration.adoc 
b/OsmoTRX/chapters/configuration.adoc
new file mode 100644
index 000..5a93e75
--- /dev/null
+++ b/OsmoTRX/chapters/configuration.adoc
@@ -0,0 +1,36 @@
+== Configuring OsmTRX
+
+OsmoTRX will read the configuration at startup time and configure the
+transceiver accordingly after validating the configuration.
+
+OsmoTRX can handle several TRX channels, but at least one must be configured in
+order to be able to start it successfully. Channels must be present in the
+configuration file in incremental order, starting from 0 and be consecutive.
+
+Example configuration files for different devices and setups can be found in
+`doc/examples/` in 'osmo-trx' git repository.
+
+ Documented example
+
+.Example: Static GGSN/APN configuration (single catch-all GGSN)
+
+trx
+ bind-ip 127.0.0.1 <1>
+ remote-ip 127.0.0.1 <2>
+ base-port 5700 <3>
+ egprs disable <4>
+ tx-sps 4 <5>
+ rx-sps 4 <6>
+ chan 0 <7>
+  tx-path BAND1 <8>
+  rx-path LNAW <9>
+
+<1> Configure the local IP address at the TRX used for the connection against 
`osmo-bts-trx`.
+<2> Specify the IP address of `osmo-bts-trx` to connect to.
+<3> Specify the reference base UDP port to use for communication.
+<4> Don't enable EDGE support.
+<5> Use 4 TX samples per symbol. This is device specific.
+<6> Use 4 RX samples per symbol. This is device specific.
+<7> Configure the first channel. As no other channels are specified, 
`osmo-trx` assumes it is using only one channel.
+<8> Configure the device to use `BAND1` Tx antenna path from all the available 
ones (device specific).
+<9> Configure the device to use `LNAW` Rx antenna path from all the available 
ones (device specific).
diff --git a/OsmoTRX/chapters/control.adoc b/OsmoTRX/chapters/control.adoc
new file mode 100644
index 000..168769a
--- /dev/null
+++ b/OsmoTRX/chapters/control.adoc
@@ -0,0 +1,12 @@
+[[control]]
+== Control interface
+
+The actual protocol is described in <>, the variables
+common to all programs using it are described in <>. Here we
+describe variables specific to OsmoTRX.
+
+.Variables available over control interface
+[options="header",width="100%",cols="20%,5%,5%,50%,20%"]
+|===
+|Name|Access|Trap|Value|Comment
+|===
diff --git a/OsmoTRX/chapters/counters.adoc b/OsmoTRX/chapters/counters.adoc
new file mode 100644
index 000..7fbb10c
--- /dev/null
+++ b/OsmoTRX/chapters/counters.adoc
@@ -0,0 +1,4 @@
+[[counters]]
+== Counters
+
+include::./counters_generated.adoc[]
diff --git a/OsmoTRX/chapters/counters_generated.adoc 
b/OsmoTRX/chapters/counters_generated.adoc
new file mode 100644
index 000..b40dc37
--- /dev/null
+++ b/OsmoTRX/chapters/counters_generated.adoc
@@ -0,0 +1,7 @@
+// autogenerated by show asciidoc counters
+These counters and their description based on OsmoTRX 0.2.0.61-408f (OsmoTRX).
+
+// generating tables for rate_ctr_group
+// generating tables for

[MERGED] osmo-gsm-manuals[master]: Introduce OsmoTRX manual

osmo-gsm-manuals[master]: Introduce OsmoTRX manual

[PATCH] osmo-gsm-manuals[master]: Introduce OsmoTRX manual

[PATCH] osmo-gsm-manuals[master]: Introduce OsmoTRX manual

4 matches

Site Navigation

Mail list logo

Footer information