Drop osmo-hnbgw

OsmoHNBGW is now available in its own repository osmo-hnbgw.git.

Change-Id: I4e17c578b432f0c997ea4e13b1c468b112278854

12 files changed, 0 insertions, 460 deletions

diff --git a/doc/Makefile.am b/doc/Makefile.am
index eeed875..e8a44b9 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,6 +1,4 @@
 SUBDIRS = \
-	  examples \
-	  manuals \
 	  $(NULL)
 
 EXTRA_DIST = \
@@ -11,5 +9,4 @@ EXTRA_DIST = \
   hnb_cs_mt_sms.msc \
   hnb_ps_lu.msc \
   hnb_ps_pdp_act.msc \
-  protocols_around_hnbgw.txt \
   README
diff --git a/doc/examples/Makefile.am b/doc/examples/Makefile.am
deleted file mode 100644
index 7441d48..0000000
--- a/doc/examples/Makefile.am
+++ /dev/null
@@ -1,27 +0,0 @@
-osmoconfdir = $(sysconfdir)/osmocom
-osmoconf_DATA = osmo-hnbgw.cfg
-
-EXTRA_DIST = osmo-hnbgw.cfg
-
-CFG_FILES = find $(srcdir) -name '*.cfg*' | sed -e 's,^$(srcdir),,'
-
-dist-hook:
-	for f in $$($(CFG_FILES)); do \
-		j="$(distdir)/$$f" && \
-		mkdir -p "$$(dirname $$j)" && \
-		$(INSTALL_DATA) $(srcdir)/$$f $$j; \
-	done
-
-install-data-hook:
-	for f in $$($(CFG_FILES)); do \
-		j="$(DESTDIR)$(docdir)/examples/$$f" && \
-		mkdir -p "$$(dirname $$j)" && \
-		$(INSTALL_DATA) $(srcdir)/$$f $$j; \
-	done
-
-uninstall-hook:
-	@$(PRE_UNINSTALL)
-	for f in $$($(CFG_FILES)); do \
-		j="$(DESTDIR)$(docdir)/examples/$$f" && \
-		$(RM) $$j; \
-	done
diff --git a/doc/examples/osmo-hnbgw.cfg b/doc/examples/osmo-hnbgw.cfg
deleted file mode 100644
index 9286b2a..0000000
--- a/doc/examples/osmo-hnbgw.cfg
+++ /dev/null
@@ -1,25 +0,0 @@
-!
-! OsmoHNBGW (0) configuration saved from vty
-!!
-!
-log stderr
- logging filter all 1
- logging color 1
- logging print category 1
- logging timestamp 1
- logging print extended-timestamp 1
- logging level all debug
- logging level lglobal notice
- logging level llapd notice
- logging level linp notice
- logging level lmux notice
- logging level lmi notice
- logging level lmib notice
- logging level lsms notice
- logging level lctrl notice
- logging level lgtp notice
- logging level lstats notice
-hnbgw
- iuh
-  local-ip 0.0.0.0
-  hnbap-allow-tmsi 1
diff --git a/doc/manuals/Makefile.am b/doc/manuals/Makefile.am
deleted file mode 100644
index 595f157..0000000
--- a/doc/manuals/Makefile.am
+++ /dev/null
@@ -1,25 +0,0 @@
-EXTRA_DIST = \
-	     osmohnbgw-usermanual.adoc \
-	     osmohnbgw-usermanual-docinfo.xml \
-	     chapters \
-	     osmohnbgw-vty-reference.xml \
-	     regen_doc.sh \
-	     vty
-
-if BUILD_MANUALS
-  ASCIIDOC = osmohnbgw-usermanual.adoc
-  ASCIIDOC_DEPS = $(srcdir)/chapters/*.adoc
-  include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc
-
-  VTY_REFERENCE = osmohnbgw-vty-reference.xml
-
-  BUILT_REFERENCE_XML = $(builddir)/vty/hnbgw_vty_reference.xml
-  $(builddir)/vty/hnbgw_vty_reference.xml: $(top_builddir)/src/osmo-hnbgw
-	mkdir -p $(builddir)/vty
-	$(top_builddir)/src/osmo-hnbgw --vty-ref-xml > $@
-
-  include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc
-
-  OSMO_REPOSITORY = osmo-hnbgw
-  include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc
-endif
diff --git a/doc/manuals/chapters/overview.adoc b/doc/manuals/chapters/overview.adoc
deleted file mode 100644
index 2368b4f..0000000
--- a/doc/manuals/chapters/overview.adoc
+++ /dev/null
@@ -1,56 +0,0 @@
-[[overview]]
-== Overview
-
-
-[[intro_overview]]
-=== About OsmoHNBGW
-
-OsmoHNBGW implements the Home NodeB Gateway function in the 3G network architecture.  It serves 
-as a gateway between the classic 3G core network (CN) domain with its IuCS and IuPS interface
-and the femtocell based RAN.
-
-A typical 3G network consisting of Osmocom components will look as illustrated in the following
-diagram:
-
-[[fig-3g]]
-.Typical 3G network architecture used with OsmoHNBGW
-----
-        +------------+           +--------+          +----------+          +---------+
- UE <-->| hNodeB     |<--Iuh---->| HNB-GW |<--IuCS-->| OsmoMSC  |<--GSUP-->| OsmoHLR |
- UE <-->| femto cell |     ...-->|        |    ...-->|          |          |         |
-        |            |           |        |          +----------+          +---------|
-        +------------+<--GTP-U   |        |
-                              \  |        |          +------+           +------+
-                              |  |        |<--IuPS-->| SGSN |<--GTP-C-->| GGSN |
-                              |  +--------+    ...-->|      |   GTP-U-->|      |
-                              |                      +------+  /        +------+
-                              \_______________________________/
-----
-
-The HNB-GW performs a translation interface between the IuCS/IuPS interfaces on the one hand
-side, and the Iuh interface on the or ther hand:
-
-----
-                      Iuh                         IuCS/IuPS
-
-NAS                   +----+----+                 +----+----+
-Non-Access Stratum    | CC | MM |                 | CC | MM |
-- - - - - - - - - - - +----+----+-------+         +----+----+
-                      | RANAP   |       |    H    | RANAP   |
-Access Stratum        +---------+ HNBAP |    N    +---------+ - - SCCP USER SAP
-                      | RUA     |       |    B    | SUA     |  \
-                      +---------+-------+    -    +---------+  |
-                      |        SCTP     |    G    | SCTP    |  } SIGTRAN
-                      +-----------------+    W    +---------+  |
-                      |        IP       |         | IP      |  /
-                      +-----------------+         +---------+
-----
-
-On the femtocell (Home NodeB) side, OsmoHNBGW implements the Iuh interface as specified by 3GPP.
-
-=== The Iuh interface
-
-Iuh consists of the following sub-layers:
-
-- HNBAP (Home NodeB Application Part)
-- RUA (RANAP User Adaptation, between RANAP and SCTP
diff --git a/doc/manuals/chapters/running.adoc b/doc/manuals/chapters/running.adoc
deleted file mode 100644
index f40027a..0000000
--- a/doc/manuals/chapters/running.adoc
+++ /dev/null
@@ -1,119 +0,0 @@
-== Running OsmoHNBGW
-
-The OsmoHNBGW executable (`osmo-hnbgw`) offers the following command-line
-arguments:
-
-=== SYNOPSIS
-
-*osmo-hnbgw* [-h|-V] [-d 'DBGMASK'] [-D] [-c 'CONFIGFILE'] [-s] [-T] [-e 'LOGLEVEL']
-
-=== OPTIONS
-
-*-h, --help*::
-	Print a short help message about the supported options
-*-V, --version*::
-	Print the compile-time version number of the OsmoHNBGW program
-*-d, --debug 'DBGMASK','DBGLEVELS'*::
-	Set the log subsystems and levels for logging to stderr. This
-	has mostly been superseded by VTY-based logging configuration,
-	see <<logging>> for further information.
-*-D, --daemonize*::
-	Fork the process as a daemon into background.
-*-c, --config-file 'CONFIGFILE'*::
-	Specify the file and path name of the configuration file to be
-	used. If none is specified, use `osmo-msc.cfg` in the current
-	working directory.
-*-s, --disable-color*::
-	Disable colors for logging to stderr. This has mostly been
-	deprecated by VTY based logging configuration, see <<logging>>
-	for more information.
-*-T, --timestamp*::
-	Enable time-stamping of log messages to stderr. This has mostly
-	been deprecated by VTY based logging configuration, see
-	<<logging>> for more information.
-*-e, --log-level 'LOGLEVEL'*::
-	Set the global log level for logging to stderr. This has mostly
-	been deprecated by VTY based logging configuration, see
-	<<logging>> for more information.
-
-
-=== Multiple instances
-
-Running multiple instances of `osmo-hnbgw` on the same computer is possible if
-all interfaces (VTY, CTRL, Iuh) are separated using the appropriate
-configuration options. The IP based interfaces are binding to local host by
-default. In order to separate the processes, the user has to bind those
-services to specific but different IP addresses and/or ports.
-
-The VTY and the Control interface can be bound to IP addresses from the loopback
-address range, for example:
-
-----
-line vty
- bind 127.0.0.2
-ctrl
- bind 127.0.0.2
-----
-
-The Iuh interface can be bound to an individual port:
-
-----
-hnbgw
- iuh
-  local-ip 0.0.0.0
-  local-port 29169
-----
-
-For the following links, OsmoHNBGW acts as a client and does not listen/bind to a
-specific interface, and will hence not encounter conflicts for multiple instances
-running on the same interface:
-
-- The SCCP/M3UA links are established by OsmoHNBGW contacting an STP.
-
-To run multiple OsmoHNBGW instances on the same SCCP routing, each HNBGW has to
-configure a distinct point-code, see <<configure_iucs_iups>>.
-
-
-=== Configuring Primary Links
-
-[[configure_iucs_iups]]
-==== Configure SCCP/M3UA to connect to an MSC's _IuCS_ and an SGSN's _IuPS_ interface
-
-OsmoHNBGW acts as client to contact an STP instance and establish an SCCP/M3UA
-link.
-
-An example configuration of OsmoHNBGW's SCCP link:
-
-----
-cs7 instance 0
- point-code 0.23.5
- asp asp-clnt-OsmoHNBGW 2905 0 m3ua
-  remote-ip 127.0.0.1
-  sctp-role client
- sccp-address msc
-  routing-indicator PC
-  point-code 0.23.1
- sccp-address sgsn
-  routing-indicator PC
-  point-code 0.23.2
-hnbgw
- iucs
-  remote-addr msc
- iups
-  remote-addr sgsn
-----
-
-This configuration is explained in detail in <<cs7_config>>.
-
-==== Configure RUA to accept Iuh connections from hNodeB
-
-OsmoHNBGW acts as server to accept Iuh connections from hNodeB devices.
-
-An example configuration for OsmoHNBGW's RUA server:
-
-----
-hnbgw
- iuh
-  local-ip 10.9.8.7
-  local-port 29169
-----
diff --git a/doc/manuals/osmohnbgw-usermanual-docinfo.xml b/doc/manuals/osmohnbgw-usermanual-docinfo.xml
deleted file mode 100644
index 404d2a1..0000000
--- a/doc/manuals/osmohnbgw-usermanual-docinfo.xml
+++ /dev/null
@@ -1,51 +0,0 @@
-<revhistory>
-  <revision>
-    <revnumber>1</revnumber>
-    <date>November 30th, 2019</date>
-    <authorinitials>HW</authorinitials>
-    <revremark>
-      Initial version
-    </revremark>
-  </revision>
-</revhistory>
-
-<authorgroup>
-  <author>
-    <firstname>Harald</firstname>
-    <surname>Welte</surname>
-    <email>hwelte@sysmocom.de</email>
-    <authorinitials>HW</authorinitials>
-    <affiliation>
-      <shortaffil>sysmocom</shortaffil>
-      <orgname>sysmocom - s.f.m.c. GmbH</orgname>
-      <jobtitle>Managing Director</jobtitle>
-    </affiliation>
-  </author>
-</authorgroup>
-
-<copyright>
-  <year>2019</year>
-  <holder>sysmocom - s.f.m.c. GmbH</holder>
-</copyright>
-
-<legalnotice>
-  <para>
-	Permission is granted to copy, distribute and/or modify this
-	document under the terms of the GNU Free Documentation License,
-	Version 1.3 or any later version published by the Free Software
-	Foundation; with the Invariant Sections being just 'Foreword',
-	'Acknowledgements' and 'Preface', with no Front-Cover Texts,
-	and no Back-Cover Texts.  A copy of the license is included in
-	the section entitled "GNU Free Documentation License".
-  </para>
-  <para>
-	The Asciidoc source code of this manual can be found at
-	<ulink url="http://git.osmocom.org/osmo-hnbgw/">
-		http://git.osmocom.org/osmo-hnbgw/
-	</ulink>
-	and of the common chapters at
-	<ulink url="http://git.osmocom.org/osmo-gsm-manuals/">
-		http://git.osmocom.org/osmo-gsm-manuals/
-	</ulink>
-  </para>
-</legalnotice>
diff --git a/doc/manuals/osmohnbgw-usermanual.adoc b/doc/manuals/osmohnbgw-usermanual.adoc
deleted file mode 100644
index 21faed7..0000000
--- a/doc/manuals/osmohnbgw-usermanual.adoc
+++ /dev/null
@@ -1,37 +0,0 @@
-:gfdl-enabled:
-:program-name: OsmoHNBGW
-
-OsmoHNBGW User Manual
-=====================
-Harald Welte <hwelte@sysmocom.de>
-
-
-include::./common/chapters/preface.adoc[]
-
-include::{srcdir}/chapters/overview.adoc[]
-
-include::{srcdir}/chapters/running.adoc[]
-
-// include::{srcdir}/chapters/control.adoc[]
-
-// include::./common/chapters/counters-overview.adoc[]
-
-// include::{srcdir}/chapters/counters.adoc[]
-
-include::./common/chapters/vty.adoc[]
-
-include::./common/chapters/logging.adoc[]
-
-include::./common/chapters/cs7-config.adoc[]
-
-// include::{srcdir}/chapters/net.adoc[]
-
-// include::./common/chapters/control_if.adoc[]
-
-include::./common/chapters/port_numbers.adoc[]
-
-include::./common/chapters/bibliography.adoc[]
-
-include::./common/chapters/glossary.adoc[]
-
-include::./common/chapters/gfdl.adoc[]
diff --git a/doc/manuals/osmohnbgw-vty-reference.xml b/doc/manuals/osmohnbgw-vty-reference.xml
deleted file mode 100644
index cd69333..0000000
--- a/doc/manuals/osmohnbgw-vty-reference.xml
+++ /dev/null
@@ -1,38 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-  ex:ts=2:sw=42sts=2:et
-  -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*-
--->
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML 5.0//EN"
-"http://docbook.org/xml/5.0/dtd/docbook.dtd" [
-<!ENTITY chapter-vty      SYSTEM      "./common/chapters/vty.xml" >
-<!ENTITY sections-vty     SYSTEM      "generated/docbook_vty.xml"  >
-]>
-
-<book>
-  <info>
-    <revhistory>
-        <revision>
-            <revnumber>v1</revnumber>
-            <date>29th July 2019</date>
-            <authorinitials>dw</authorinitials>
-            <revremark>Initial</revremark>
-        </revision>
-    </revhistory>
-
-    <title>OsmoHNBGW VTY Reference</title>
-
-    <copyright>
-      <year>2019</year>
-    </copyright>
-
-    <legalnotice>
-      <para>This work is copyright by <orgname>sysmocom - s.f.m.c. GmbH</orgname>. All rights reserved.
-      </para>
-    </legalnotice>
-  </info>
-
-  <!-- Main chapters-->
-  &chapter-vty;
-</book>
-
diff --git a/doc/manuals/regen_doc.sh b/doc/manuals/regen_doc.sh
deleted file mode 100755
index 39dd9ee..0000000
--- a/doc/manuals/regen_doc.sh
+++ /dev/null
@@ -1,17 +0,0 @@
-#!/bin/sh -x
-
-if [ -z "$DOCKER_PLAYGROUND" ]; then
-	echo "You need to set DOCKER_PLAYGROUND"
-	exit 1
-fi
-
-SCRIPT=$(realpath "$0")
-MANUAL_DIR=$(dirname "$SCRIPT")
-
-COMMIT=${COMMIT:-$(git log -1 --format=format:%H)}
-
-cd "$DOCKER_PLAYGROUND/scripts" || exit 1
-
-OSMO_SGSN_BRANCH=$COMMIT ./regen_doc.sh osmo-hnbgw 4261 \
-	"$MANUAL_DIR/chapters/counters_generated.adoc" \
-	"$MANUAL_DIR/vty/hnbgw_vty_reference.xml"
diff --git a/doc/manuals/vty/hnbgw_vty_additions.xml b/doc/manuals/vty/hnbgw_vty_additions.xml
deleted file mode 100644
index a4c675e..0000000
--- a/doc/manuals/vty/hnbgw_vty_additions.xml
+++ /dev/null
@@ -1,2 +0,0 @@
-<vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'>
-</vtydoc>
diff --git a/doc/protocols_around_hnbgw.txt b/doc/protocols_around_hnbgw.txt
deleted file mode 100644
index 3eef155..0000000
--- a/doc/protocols_around_hnbgw.txt
+++ /dev/null
@@ -1,60 +0,0 @@
-Protocols Around the Home Node B Gateway
-========================================
-
-                                 +--------+
-                             ,-->| Osmo   |
-                            /    | MGCPGW |
-                            |    |        |<--MGCP
-                            |    +--------+       \
-                            /                     |
-        +------------+<--RTP     +--------+       `->+----------+
- UE <-->| hNodeB     |           | Osmo   |          | OsmoMSC  |        +------+
- UE <-->| femto cell |<--Iuh---->| HNB-GW |<--IuCS-->|          |        | Osmo |
-        |            |           |        |          |     (VLR)|<-GSUP->| HLR  |
-        |            |           |        |          +----------+  GSUP->+------+
-        +------------+<--GTP-U   |        |                       /
-                              \  |        |          +------+<---'       +------+
-                              |  |        |<--IuPS-->| Osmo |<--GTP-C--->| Open |
-                              |  +--------+          | SGSN |   GTP-U--->| GGSN |
-                              |                      +------+  /         +------+
-                              \_______________________________/
-
-
-
-                      Iuh                         IuCS/IuPS
-
-NAS                   +----+----+                 +----+----+
-Non-Access Stratum    | CC | MM |                 | CC | MM |
-- - - - - - - - - - - +----+----+-------+         +----+----+
-                      | RANAP   |       |    H    | RANAP   |
-Access Stratum        +---------+ HNBAP |    N    +---------+ - - SCCP USER SAP
-                      | RUA     |       |    B    | SUA     |  \
-                      +---------+-------+    -    +---------+  |
-                      |        SCTP     |    G    | SCTP    |  } SIGTRAN
-                      +-----------------+    W    +---------+  |
-                      |        IP       |         | IP      |  /
-                      +-----------------+         +---------+
-
-
-Various SIGTRAN implementations:
-
-                IuCS/IuPS
-                  usual
-                   |     simplest
-                   |       |
-                   v       v
-  +------+------+------+-----+
-  | SCCP | SCCP |      |     |
-  +------+------+ SCCP |     |
-  | MTP3 | MTP3 |      |     |
-  +------+------+------+ SUA |
-  | MTP2 |      |      |     |
-  +------+ M2UA | M3UA |     |
-  | M2PA |      |      |     |
-  +------+------+------+-----+
-  |           SCTP           |
-  +--------------------------+
-  |            IP            |
-  +--------------------------+
-
-UE (User Endpoint) == MS (Mobile Subscriber) == mobile device