initial checkin of manuals to public repo
The manuals existed in different form for several years in an internal sysmocom repository. However, since they had just recently been converted from docboox-xml to asciidoc and all files have been re-shuffled for enabling the public release, there's not much point in keeping the history with git-filter-branch.
This commit is contained in:
Neels Hofmeyr
parent
a46eaef1be
commit
75c0e08acc
|
|
@ -0,0 +1,42 @@
|
|||
# XSL stylesheets downloaded from http://docbook.sourceforge.net/release/xsl/current/html/
|
||||
# Makefile from BitBake/OpenEmbedded manuals
|
||||
|
||||
|
||||
EXTRA_DEPS = gen-bsc-vty-docbook
|
||||
|
||||
topdir = .
|
||||
bsc_reference = $(topdir)/osmobsc-vty-reference.xml
|
||||
manuals = $(bsc_reference)
|
||||
# types = pdf txt rtf ps xhtml html man tex texi dvi
|
||||
# types = pdf txt
|
||||
types = $(docbooktotypes)
|
||||
docbooktotypes = pdf
|
||||
# htmlcssfile =
|
||||
# htmlcss =
|
||||
|
||||
TOPDIR := ..
|
||||
ASCIIDOCS := osmobsc-usermanual
|
||||
|
||||
include $(TOPDIR)/build/Makefile.asciidoc.inc
|
||||
include $(TOPDIR)/build/Makefile.inc
|
||||
|
||||
osmobsc-usermanual.pdf: chapters/*.adoc
|
||||
|
||||
clean:
|
||||
rm -rf $(cleanfiles)
|
||||
|
||||
gen-bsc-vty-docbook: FORCE
|
||||
$(call command,xsltproc -o generated/combined1.xml \
|
||||
--stringparam with $(PWD)/../common/vty_additions.xml \
|
||||
$(MERGE_DOC) vty/bsc_vty_reference.xml, \
|
||||
XSLTPROC,Merging Common VTY)
|
||||
$(call command,xsltproc -o generated/combined2.xml \
|
||||
--stringparam with $(PWD)/../common/bsc_vty_additions.xml \
|
||||
$(MERGE_DOC) generated/combined1.xml, \
|
||||
XSLTPROC,Merging Common BSC VTY)
|
||||
$(call command,xsltproc -o generated/combined3.xml \
|
||||
--stringparam with $(PWD)/vty/bsc_vty_additions.xml \
|
||||
$(MERGE_DOC) generated/combined2.xml, \
|
||||
XSLTPROC,Merging BSC VTY)
|
||||
$(call command,xsltproc ../vty_reference.xsl generated/combined3.xml > generated/docbook_vty.xml, \
|
||||
XSLTPROC,Converting BSC VTY to DocBook)
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
== A-link including SCCP/BSSAP/DTAP
|
||||
|
||||
OsmoBSC implements a minimal sub-set of the GSM A interface as specified
|
||||
in TS 08.08.
|
||||
|
||||
Unlike classic A interface implementations for E1 interfacs, OsmoBSC
|
||||
implements a variant of encapsulating the A interface over IP. To do
|
||||
so, the SCCP messages are wrapped in an IPA multiplex and then
|
||||
communicated over TCP. The audio channels are mapped to RTP streams.
|
||||
|
||||
This protcol stacking is sometimes called "SCCPlite".
|
||||
|
||||
===
|
||||
|
||||
FIXME
|
||||
|
|
@ -0,0 +1,69 @@
|
|||
[[overview]]
|
||||
== Overview
|
||||
|
||||
This manual should help you getting started with OsmoBSC. It will cover
|
||||
aspects of configuring and running the OsmoBSC.
|
||||
|
||||
[[intro_overview]]
|
||||
=== About OsmoBSC
|
||||
|
||||
OsmoBSC is one particular version of the OpenBSC software suite.
|
||||
|
||||
Unlike the highly integrated OmsoNITB, OsmoBSC impleents a more classic
|
||||
GSM Base Station Controller with A-bis interface towards BTSs and A
|
||||
interface towards a MSC.
|
||||
|
||||
|
||||
=== Software Components
|
||||
|
||||
OsmoBSC contains a variety of different software components, which
|
||||
we'll quickly describe in this section.
|
||||
|
||||
==== A-bis Implementation
|
||||
|
||||
OsmoBSC implements the ETSI/3GPP specified A-bis interface, including
|
||||
TS 08.56 (LAPD), TS 08.58 (RSL) and TS 12.21 (OML). In addition, it
|
||||
supports a variety of vendor-specific extensions and dialects in order
|
||||
to communicate with BTSs from Siemens, Nokia, Ericsson, ip.access and
|
||||
sysmocom.
|
||||
|
||||
For more information, see <<bts>> and <<bts-examples>>.
|
||||
|
||||
==== A Implementation
|
||||
|
||||
OsmoBSC implements a minimal sub-set of the GSM A interface as specified
|
||||
in TS 08.08.
|
||||
|
||||
Unlike classic A interface implementations for E1 interfacs, OsmoBSC
|
||||
implements a variant of encapsulating the A interface over IP. To do
|
||||
so, the SCCP messages are wrapped in an IPA multiplex and then
|
||||
communicated over TCP. The audio channels are mapped to RTP streams.
|
||||
|
||||
This protcol stacking is sometimes called "SCCPlite".
|
||||
|
||||
For more information, see <<alink>>.
|
||||
|
||||
|
||||
==== BSC Implementation
|
||||
|
||||
The BSC implementation covers the classic functionality of a GSM Base
|
||||
Station Controller, i.e.
|
||||
|
||||
* configuring and bringing up BTSs with their TRXs and TSs
|
||||
* implementing the A-bis interface / protocols for signalling and actual
|
||||
voice data (TRAU frames).
|
||||
* processing measurement results from the mobile stations in dedicated
|
||||
mode, performing hand-over decision and execution.
|
||||
* Terminating the TS 04.08 RR (Radio Resource) sub-layer from the MS.
|
||||
|
||||
For more information, see <<net>>, <<bts>> and <<bts-examples>>.
|
||||
|
||||
|
||||
==== TRAU mapper / E1 sub-channel muxer
|
||||
|
||||
Unlike classic GSM networks, OsmoBSC does not perform any transcoding.
|
||||
Rather, a compatible codec is selected for both legs of a call, and
|
||||
codec frames are passed through transparently. In order to achieve this
|
||||
with E1 based BTS, OsmoBSC contains a E1 sub-channel de- and
|
||||
re-multiplexer as well as a TRAU mapper that can map uplink to downlink
|
||||
frames and vice versa.
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
== Running OsmoBSC
|
||||
|
||||
The OsmoBSC executable (`osmo-bsc`) offers the following command-line
|
||||
arguments:
|
||||
|
||||
==== SYNOPSIS
|
||||
|
||||
*osmo-bsc* [-h|-V] [-d 'DBGMASK'] [-D] [-c 'CONFIGFILE'] [-s] [-T] [-e 'LOGLEVEL'] [-l 'IP'] [-r 'RFCTL']
|
||||
|
||||
==== OPTIONS
|
||||
|
||||
*-h, --help*::
|
||||
Print a short help message about the supported options
|
||||
*-V, --version*::
|
||||
Print the compile-time version number of the OsmoBTS 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 `openbsc.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 configu- ration, 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.
|
||||
*-l, --local='IP'*::
|
||||
Specify the local IP address of the OsmoBSC-MGCP
|
||||
*-r, --rf-ctl 'RFCTL'*::
|
||||
Offer a Unix domain socket for RF control at the path/filename
|
||||
'RFCTL' in the file system.
|
||||
|
|
@ -0,0 +1,52 @@
|
|||
<revhistory>
|
||||
<revision>
|
||||
<revnumber>1</revnumber>
|
||||
<date>February 2016</date>
|
||||
<authorinitials>HW</authorinitials>
|
||||
<revremark>
|
||||
Initial OsmoBSC manual, recycling OsmoNITB sections
|
||||
</revremark>
|
||||
</revision>
|
||||
</revhistory>
|
||||
|
||||
<authorgroup>
|
||||
<author>
|
||||
<firstname>Holger</firstname>
|
||||
<surname>Freyther</surname>
|
||||
<email>hfreyther@sysmocom.de</email>
|
||||
<authorinitials>HF</authorinitials>
|
||||
<affiliation>
|
||||
<shortaffil>sysmocom</shortaffil>
|
||||
<orgname>sysmocom - s.f.m.c. GmbH</orgname>
|
||||
<jobtitle>Managing Director</jobtitle>
|
||||
</affiliation>
|
||||
</author>
|
||||
<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>2012-2016</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>
|
||||
</legalnotice>
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
OsmoBSC User Manual
|
||||
===================
|
||||
Harald Welte <hwelte@sysmocom.de>
|
||||
|
||||
|
||||
include::../common/chapters/preface.adoc[]
|
||||
|
||||
include::chapters/overview.adoc[]
|
||||
|
||||
include::chapters/running.adoc[]
|
||||
|
||||
include::../common/chapters/vty.adoc[]
|
||||
|
||||
include::../common/chapters/logging.adoc[]
|
||||
|
||||
include::../common/chapters/bts.adoc[]
|
||||
|
||||
include::chapters/bts-examples.adoc[]
|
||||
|
||||
include::../common/chapters/bsc.adoc[]
|
||||
|
||||
include::../common/chapters/abis.adoc[]
|
||||
|
||||
#include::../common/chapters/alink.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[]
|
||||
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
<?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 V5.0//EN"
|
||||
"http://www.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>13th August 2012</date>
|
||||
<authorinitials>hf</authorinitials>
|
||||
<revremark>Initial</revremark>
|
||||
</revision>
|
||||
<revision>
|
||||
<revnumber>v2</revnumber>
|
||||
<date>5th March 2014</date>
|
||||
<authorinitials>hf</authorinitials>
|
||||
<revremark>Update to match osmo-bsc version 0.13.0-305</revremark>
|
||||
</revision>
|
||||
</revhistory>
|
||||
|
||||
<title>OsmoBSC VTY Reference</title>
|
||||
|
||||
<copyright>
|
||||
<year>2012-2014</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>
|
||||
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
<vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'>
|
||||
<node id='25'>
|
||||
<child_of nodeid='4' />
|
||||
<name>MSC Connection Commands</name>
|
||||
<description>This node allows to configure the MSC connection related
|
||||
settings.</description>
|
||||
</node>
|
||||
<node id='30'>
|
||||
<child_of nodeid='4' />
|
||||
<name>BSC Commands</name>
|
||||
<description>This node allows to configure the BSC connection related
|
||||
settings.</description>
|
||||
</node>
|
||||
</vtydoc>
|
||||
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue