<p>laforge has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/c/osmo-iuh/+/16371">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">Initial minimal OsmoHNBGW user manual<br><br>This adds a very basic OsmoHNBGW user manual with an "overview" and<br>"running" chapter.  It still misses any information on configuration.<br><br>Change-Id: I54825a4ce5a457f87b0618332347eed8ea54afcb<br>Closes: OS#2588<br>---<br>M .gitignore<br>M doc/manuals/Makefile.am<br>A doc/manuals/chapters/overview.adoc<br>A doc/manuals/chapters/running.adoc<br>A doc/manuals/osmohnbgw-usermanual-docinfo.xml<br>A doc/manuals/osmohnbgw-usermanual.adoc<br>6 files changed, 191 insertions(+), 0 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/osmo-iuh refs/changes/71/16371/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/.gitignore b/.gitignore</span><br><span>index f662e2a..49b2cfb 100644</span><br><span>--- a/.gitignore</span><br><span>+++ b/.gitignore</span><br><span>@@ -43,3 +43,8 @@</span><br><span> include/osmocom/rua/rua_ies_defs.h</span><br><span> include/osmocom/ranap/ranap_ies_defs.h</span><br><span> include/osmocom/sabp/sabp_ies_defs.h</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+doc/manuals/build</span><br><span style="color: hsl(120, 100%, 40%);">+doc/manuals/common</span><br><span style="color: hsl(120, 100%, 40%);">+doc/manuals/generated</span><br><span style="color: hsl(120, 100%, 40%);">+doc/manuals/*.pdf</span><br><span>diff --git a/doc/manuals/Makefile.am b/doc/manuals/Makefile.am</span><br><span>index 91aa8f8..7a76e90 100644</span><br><span>--- a/doc/manuals/Makefile.am</span><br><span>+++ b/doc/manuals/Makefile.am</span><br><span>@@ -1,9 +1,16 @@</span><br><span> EXTRA_DIST = \</span><br><span style="color: hsl(120, 100%, 40%);">+        osmohnbgw-usermanual.adoc \</span><br><span style="color: hsl(120, 100%, 40%);">+           osmohnbgw-usermanual-docinfo.xml \</span><br><span style="color: hsl(120, 100%, 40%);">+            chapters \</span><br><span>           osmohnbgw-vty-reference.xml \</span><br><span>        regen_doc.sh \</span><br><span>       vty</span><br><span> </span><br><span> if BUILD_MANUALS</span><br><span style="color: hsl(120, 100%, 40%);">+  ASCIIDOC = osmohnbgw-usermanual.adoc</span><br><span style="color: hsl(120, 100%, 40%);">+  ASCIIDOC_DEPS = $(srcdir)/chapters/*.adoc</span><br><span style="color: hsl(120, 100%, 40%);">+  include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span>   VTY_REFERENCE = osmohnbgw-vty-reference.xml</span><br><span>   include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc</span><br><span> </span><br><span>diff --git a/doc/manuals/chapters/overview.adoc b/doc/manuals/chapters/overview.adoc</span><br><span>new file mode 100644</span><br><span>index 0000000..2368b4f</span><br><span>--- /dev/null</span><br><span>+++ b/doc/manuals/chapters/overview.adoc</span><br><span>@@ -0,0 +1,56 @@</span><br><span style="color: hsl(120, 100%, 40%);">+[[overview]]</span><br><span style="color: hsl(120, 100%, 40%);">+== Overview</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+[[intro_overview]]</span><br><span style="color: hsl(120, 100%, 40%);">+=== About OsmoHNBGW</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+OsmoHNBGW implements the Home NodeB Gateway function in the 3G network architecture.  It serves </span><br><span style="color: hsl(120, 100%, 40%);">+as a gateway between the classic 3G core network (CN) domain with its IuCS and IuPS interface</span><br><span style="color: hsl(120, 100%, 40%);">+and the femtocell based RAN.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+A typical 3G network consisting of Osmocom components will look as illustrated in the following</span><br><span style="color: hsl(120, 100%, 40%);">+diagram:</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+[[fig-3g]]</span><br><span style="color: hsl(120, 100%, 40%);">+.Typical 3G network architecture used with OsmoHNBGW</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+        +------------+           +--------+          +----------+          +---------+</span><br><span style="color: hsl(120, 100%, 40%);">+ UE <-->| hNodeB     |<--Iuh---->| HNB-GW |<--IuCS-->| OsmoMSC  |<--GSUP-->| OsmoHLR |</span><br><span style="color: hsl(120, 100%, 40%);">+ UE <-->| femto cell |     ...-->|        |    ...-->|          |          |         |</span><br><span style="color: hsl(120, 100%, 40%);">+        |            |           |        |          +----------+          +---------|</span><br><span style="color: hsl(120, 100%, 40%);">+        +------------+<--GTP-U   |        |</span><br><span style="color: hsl(120, 100%, 40%);">+                              \  |        |          +------+           +------+</span><br><span style="color: hsl(120, 100%, 40%);">+                              |  |        |<--IuPS-->| SGSN |<--GTP-C-->| GGSN |</span><br><span style="color: hsl(120, 100%, 40%);">+                              |  +--------+    ...-->|      |   GTP-U-->|      |</span><br><span style="color: hsl(120, 100%, 40%);">+                              |                      +------+  /        +------+</span><br><span style="color: hsl(120, 100%, 40%);">+                              \_______________________________/</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The HNB-GW performs a translation interface between the IuCS/IuPS interfaces on the one hand</span><br><span style="color: hsl(120, 100%, 40%);">+side, and the Iuh interface on the or ther hand:</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+                      Iuh                         IuCS/IuPS</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+NAS                   +----+----+                 +----+----+</span><br><span style="color: hsl(120, 100%, 40%);">+Non-Access Stratum    | CC | MM |                 | CC | MM |</span><br><span style="color: hsl(120, 100%, 40%);">+- - - - - - - - - - - +----+----+-------+         +----+----+</span><br><span style="color: hsl(120, 100%, 40%);">+                      | RANAP   |       |    H    | RANAP   |</span><br><span style="color: hsl(120, 100%, 40%);">+Access Stratum        +---------+ HNBAP |    N    +---------+ - - SCCP USER SAP</span><br><span style="color: hsl(120, 100%, 40%);">+                      | RUA     |       |    B    | SUA     |  \</span><br><span style="color: hsl(120, 100%, 40%);">+                      +---------+-------+    -    +---------+  |</span><br><span style="color: hsl(120, 100%, 40%);">+                      |        SCTP     |    G    | SCTP    |  } SIGTRAN</span><br><span style="color: hsl(120, 100%, 40%);">+                      +-----------------+    W    +---------+  |</span><br><span style="color: hsl(120, 100%, 40%);">+                      |        IP       |         | IP      |  /</span><br><span style="color: hsl(120, 100%, 40%);">+                      +-----------------+         +---------+</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+On the femtocell (Home NodeB) side, OsmoHNBGW implements the Iuh interface as specified by 3GPP.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+=== The Iuh interface</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Iuh consists of the following sub-layers:</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+- HNBAP (Home NodeB Application Part)</span><br><span style="color: hsl(120, 100%, 40%);">+- RUA (RANAP User Adaptation, between RANAP and SCTP</span><br><span>diff --git a/doc/manuals/chapters/running.adoc b/doc/manuals/chapters/running.adoc</span><br><span>new file mode 100644</span><br><span>index 0000000..41909e2</span><br><span>--- /dev/null</span><br><span>+++ b/doc/manuals/chapters/running.adoc</span><br><span>@@ -0,0 +1,37 @@</span><br><span style="color: hsl(120, 100%, 40%);">+== Running OsmoHNBGW</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The OsmoHNBGW executable (`osmo-hnbgw`) offers the following command-line</span><br><span style="color: hsl(120, 100%, 40%);">+arguments:</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+=== SYNOPSIS</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+*osmo-hnbgw* [-h|-V] [-d 'DBGMASK'] [-D] [-c 'CONFIGFILE'] [-s] [-T] [-e 'LOGLEVEL']</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+=== OPTIONS</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+*-h, --help*::</span><br><span style="color: hsl(120, 100%, 40%);">+   Print a short help message about the supported options</span><br><span style="color: hsl(120, 100%, 40%);">+*-V, --version*::</span><br><span style="color: hsl(120, 100%, 40%);">+     Print the compile-time version number of the OsmoHNBGW program</span><br><span style="color: hsl(120, 100%, 40%);">+*-d, --debug 'DBGMASK','DBGLEVELS'*::</span><br><span style="color: hsl(120, 100%, 40%);">+ Set the log subsystems and levels for logging to stderr. This</span><br><span style="color: hsl(120, 100%, 40%);">+ has mostly been superseded by VTY-based logging configuration,</span><br><span style="color: hsl(120, 100%, 40%);">+        see <<logging>> for further information.</span><br><span style="color: hsl(120, 100%, 40%);">+*-D, --daemonize*::</span><br><span style="color: hsl(120, 100%, 40%);">+     Fork the process as a daemon into background.</span><br><span style="color: hsl(120, 100%, 40%);">+*-c, --config-file 'CONFIGFILE'*::</span><br><span style="color: hsl(120, 100%, 40%);">+     Specify the file and path name of the configuration file to be</span><br><span style="color: hsl(120, 100%, 40%);">+        used. If none is specified, use `osmo-msc.cfg` in the current</span><br><span style="color: hsl(120, 100%, 40%);">+ working directory.</span><br><span style="color: hsl(120, 100%, 40%);">+*-s, --disable-color*::</span><br><span style="color: hsl(120, 100%, 40%);">+   Disable colors for logging to stderr. This has mostly been</span><br><span style="color: hsl(120, 100%, 40%);">+    deprecated by VTY based logging configuration, see <<logging>></span><br><span style="color: hsl(120, 100%, 40%);">+    for more information.</span><br><span style="color: hsl(120, 100%, 40%);">+*-T, --timestamp*::</span><br><span style="color: hsl(120, 100%, 40%);">+    Enable time-stamping of log messages to stderr. This has mostly</span><br><span style="color: hsl(120, 100%, 40%);">+       been deprecated by VTY based logging configuration, see</span><br><span style="color: hsl(120, 100%, 40%);">+       <<logging>> for more information.</span><br><span style="color: hsl(120, 100%, 40%);">+*-e, --log-level 'LOGLEVEL'*::</span><br><span style="color: hsl(120, 100%, 40%);">+ Set the global log level for logging to stderr. This has mostly</span><br><span style="color: hsl(120, 100%, 40%);">+       been deprecated by VTY based logging configuration, see</span><br><span style="color: hsl(120, 100%, 40%);">+       <<logging>> for more information.</span><br><span>diff --git a/doc/manuals/osmohnbgw-usermanual-docinfo.xml b/doc/manuals/osmohnbgw-usermanual-docinfo.xml</span><br><span>new file mode 100644</span><br><span>index 0000000..404d2a1</span><br><span>--- /dev/null</span><br><span>+++ b/doc/manuals/osmohnbgw-usermanual-docinfo.xml</span><br><span>@@ -0,0 +1,51 @@</span><br><span style="color: hsl(120, 100%, 40%);">+<revhistory></span><br><span style="color: hsl(120, 100%, 40%);">+  <revision></span><br><span style="color: hsl(120, 100%, 40%);">+    <revnumber>1</revnumber></span><br><span style="color: hsl(120, 100%, 40%);">+    <date>November 30th, 2019</date></span><br><span style="color: hsl(120, 100%, 40%);">+    <authorinitials>HW</authorinitials></span><br><span style="color: hsl(120, 100%, 40%);">+    <revremark></span><br><span style="color: hsl(120, 100%, 40%);">+      Initial version</span><br><span style="color: hsl(120, 100%, 40%);">+    </revremark></span><br><span style="color: hsl(120, 100%, 40%);">+  </revision></span><br><span style="color: hsl(120, 100%, 40%);">+</revhistory></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+<authorgroup></span><br><span style="color: hsl(120, 100%, 40%);">+  <author></span><br><span style="color: hsl(120, 100%, 40%);">+    <firstname>Harald</firstname></span><br><span style="color: hsl(120, 100%, 40%);">+    <surname>Welte</surname></span><br><span style="color: hsl(120, 100%, 40%);">+    <email>hwelte@sysmocom.de</email></span><br><span style="color: hsl(120, 100%, 40%);">+    <authorinitials>HW</authorinitials></span><br><span style="color: hsl(120, 100%, 40%);">+    <affiliation></span><br><span style="color: hsl(120, 100%, 40%);">+      <shortaffil>sysmocom</shortaffil></span><br><span style="color: hsl(120, 100%, 40%);">+      <orgname>sysmocom - s.f.m.c. GmbH</orgname></span><br><span style="color: hsl(120, 100%, 40%);">+      <jobtitle>Managing Director</jobtitle></span><br><span style="color: hsl(120, 100%, 40%);">+    </affiliation></span><br><span style="color: hsl(120, 100%, 40%);">+  </author></span><br><span style="color: hsl(120, 100%, 40%);">+</authorgroup></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+<copyright></span><br><span style="color: hsl(120, 100%, 40%);">+  <year>2019</year></span><br><span style="color: hsl(120, 100%, 40%);">+  <holder>sysmocom - s.f.m.c. GmbH</holder></span><br><span style="color: hsl(120, 100%, 40%);">+</copyright></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+<legalnotice></span><br><span style="color: hsl(120, 100%, 40%);">+  <para></span><br><span style="color: hsl(120, 100%, 40%);">+       Permission is granted to copy, distribute and/or modify this</span><br><span style="color: hsl(120, 100%, 40%);">+  document under the terms of the GNU Free Documentation License,</span><br><span style="color: hsl(120, 100%, 40%);">+       Version 1.3 or any later version published by the Free Software</span><br><span style="color: hsl(120, 100%, 40%);">+       Foundation; with the Invariant Sections being just 'Foreword',</span><br><span style="color: hsl(120, 100%, 40%);">+        'Acknowledgements' and 'Preface', with no Front-Cover Texts,</span><br><span style="color: hsl(120, 100%, 40%);">+  and no Back-Cover Texts.  A copy of the license is included in</span><br><span style="color: hsl(120, 100%, 40%);">+        the section entitled "GNU Free Documentation License".</span><br><span style="color: hsl(120, 100%, 40%);">+  </para></span><br><span style="color: hsl(120, 100%, 40%);">+  <para></span><br><span style="color: hsl(120, 100%, 40%);">+     The Asciidoc source code of this manual can be found at</span><br><span style="color: hsl(120, 100%, 40%);">+       <ulink url="http://git.osmocom.org/osmo-hnbgw/"></span><br><span style="color: hsl(120, 100%, 40%);">+              http://git.osmocom.org/osmo-hnbgw/</span><br><span style="color: hsl(120, 100%, 40%);">+    </ulink></span><br><span style="color: hsl(120, 100%, 40%);">+        and of the common chapters at</span><br><span style="color: hsl(120, 100%, 40%);">+ <ulink url="http://git.osmocom.org/osmo-gsm-manuals/"></span><br><span style="color: hsl(120, 100%, 40%);">+                http://git.osmocom.org/osmo-gsm-manuals/</span><br><span style="color: hsl(120, 100%, 40%);">+      </ulink></span><br><span style="color: hsl(120, 100%, 40%);">+  </para></span><br><span style="color: hsl(120, 100%, 40%);">+</legalnotice></span><br><span>diff --git a/doc/manuals/osmohnbgw-usermanual.adoc b/doc/manuals/osmohnbgw-usermanual.adoc</span><br><span>new file mode 100644</span><br><span>index 0000000..3f3c9c3</span><br><span>--- /dev/null</span><br><span>+++ b/doc/manuals/osmohnbgw-usermanual.adoc</span><br><span>@@ -0,0 +1,35 @@</span><br><span style="color: hsl(120, 100%, 40%);">+:gfdl-enabled:</span><br><span style="color: hsl(120, 100%, 40%);">+:program-name: OsmoHNBGW</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+OsmoHNBGW User Manual</span><br><span style="color: hsl(120, 100%, 40%);">+=====================</span><br><span style="color: hsl(120, 100%, 40%);">+Harald Welte <hwelte@sysmocom.de></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+include::./common/chapters/preface.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+include::{srcdir}/chapters/overview.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+include::{srcdir}/chapters/running.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+// include::{srcdir}/chapters/control.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+// include::./common/chapters/counters-overview.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+// include::{srcdir}/chapters/counters.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+include::./common/chapters/vty.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+include::./common/chapters/logging.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+// include::{srcdir}/chapters/net.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+// include::./common/chapters/control_if.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+include::./common/chapters/port_numbers.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+include::./common/chapters/bibliography.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+include::./common/chapters/glossary.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+include::./common/chapters/gfdl.adoc[]</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/osmo-iuh/+/16371">change 16371</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/c/osmo-iuh/+/16371"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: osmo-iuh </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: I54825a4ce5a457f87b0618332347eed8ea54afcb </div>
<div style="display:none"> Gerrit-Change-Number: 16371 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: laforge <laforge@osmocom.org> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>