Commit Graph

76 Commits

Author SHA1 Message Date
Neels Hofmeyr 10983f206b manuals: generate vty reference xml at build time
Move 'doc' subdir further down to "make sure" the osmo-bsc binary is built
before the docs.

Remove bsc_vty_reference.xml from the source tree.

In manuals/Makefile.am use the new BUILT_REFERENCE_XML feature recently added
to osmo-gsm-manuals, and add a build target to generate the XML using the new
osmo-bsc --vty-ref-xml cmdline switch.

Depends: I613d692328050a036d05b49a436ab495fc2087ba (osmo-gsm-manuals)
Change-Id: I5dc872149154e1a949bb6a2b9bbc1461e0fc51f6
2020-06-16 10:16:30 +00:00
Vadim Yanitskiy 8519d50081 doc/manuals: regenerate the VTY reference file
Change-Id: I4f7bf671b7948d8c3771d33d40ab5e8cf209e2b2
2020-05-31 02:14:28 +07:00
Neels Hofmeyr 6a8955b741 drop all BSC originated USSD notification features
The BSC is the wrong network component to originate USSD messaging, as can be
seen in the hacks in the USSD code: for example, the BSC would send a CM
Service Accept message as if an MSC had accepted the connection, dispatch a
USSD and directly send some RR release message (without proper tear down
messaging like the lchan_fsm does these days). This made sense in the osmo-nitb
world, but by now we are aiming for solid 3GPP compliance. The BSC shall not
originate USSD messages.

Deprecate all VTY and CTRL commands related to USSD:
VTY
 [no] bsc-welcome-text
 [no] bsc-msc-lost-text
 [no] bsc-grace-text
 [no] missing-msc-text
 (the commands with 'no' are ignored, without 'no' lead to an error)
CTRL
 ussd-notify-v1

Drop (already unused) ussd.h.
Drop gsm_04_80.h, gsm_04_80_utils.c, and all calling code.

Drop "RF grace" notification, where osmo-bsc was able to notify active
subscribers that the RF was being turned off.

Change-Id: Iaef6f2e01b4dbf2bff0a0bb50d6851f50ae79f6a
2020-05-29 20:16:40 +00:00
Neels Hofmeyr c8f432a849 deprecate 'msc' / 'ip.access rtp-base <port>'
The bsc_msc_data->rtp_base has been unused ever since we introduced the exernal
MGW in osmo-bsc [1]. The vty command also still exists. Deprecate the vty
command, remove the member.

[1] "mgcp: use osmo-mgw to switch RTP streams"
    commit 39c609b7c9
    Change-Id Ia2882b7ca31a3219c676986e85045fa08a425d7a

Change-Id: Id14fa3066ca5d472a817593074a6222f159168a8
2020-05-19 20:31:29 +00:00
Neels Hofmeyr 7a4172fbc6 manuals: update bsc_vty_reference.xml
I notice that some merges seem to have missed updating the
bsc_vty_reference.xml file. Re-generating it from current master yields these
changes.

Change-Id: I75269cbed8dd62be23293fd2c1470af6f61e6ad2
2020-05-18 14:21:23 +02:00
Neels Hofmeyr 6e06bd3915 manual: fix config example typo 'msc-addr'
Change-Id: Ifb84d7ceddc772e3e1ae59c8d5859b6be6f1b4eb
2020-05-13 19:18:13 +02:00
Vadim Yanitskiy e981f17200 vty: clarify EGPRS Packet Channel Request message support
According to 3GPP TS 44.060, section 12.24, GPRS Cell Options IE
contains two parameters related to 11 bit Access Burst support:

  - ACCESS_BURST_TYPE - whether the 8 or 11 bit format shall be
    used in the PACKET CHANNEL REQUEST message, the PTCCH/U block,
    PACKET CONTROL ACKNOWLEDGMENT and the PS HANDOVER ACCESS
    messages on the PRACH (if present).

  - EGPRS_PACKET_CHANNEL_REQUEST - whether EGPRS capable MSs shall
    use EGPRS PACKET CHANNEL REQUEST message for Uplink TBF
    establishment on the RACH or on the PRACH (if present).

The VTY option 'gprs 11bit_rach_support_for_egprs' actually controls
the second parameter - EGPRS_PACKET_CHANNEL_REQUEST, though it may
be hard to understand this from its name and description.

This patch is actually a group of tightly related changes:

  - deprecate 'gprs 11bit_rach_support_for_egprs (0|1)':
    - update its description to avoid any possible confusion,
    - print a warning if it's used in non-EGPRS mode,
    - print a warning if it's still used;

  - introduce '[no] gprs egprs-packet-channel-request':
    - ensure that it can only set / printed in the EGPRS mode;

  - take a chance to clean-up / rename the related struct members:
    - 'supports_egprs_11bit_rach' -> bool 'egprs_pkt_chan_request',
    - remove 'supports_egprs_11bit_rach' from 'gprs_cell_options'
      because we already have 'ext_info.use_egprs_p_ch_req' there.

Change-Id: Ied5bd10a806aeeac65ef32339d4ab0e3700e5da9
2020-04-14 15:50:10 +00:00
Vadim Yanitskiy f06b9bf1c6 doc/manuals: remove deprecated DNAT from the VTY reference
Change-Id: Ib21c30041508a9ec9afda56bda95bddf4d665bc8
2020-04-05 00:39:45 +07:00
Neels Hofmeyr 6ab7a52b67 manual: add SCCPlite section
Change-Id: I8eddc47353d6afd756865321a9e97f6cee4ce2d7
2020-03-30 15:57:57 +00:00
Neels Hofmeyr b5a25b0137 manual: add SCCP/M3UA section from common chapters
Link to the osmo-gsm-manuals/common/cs7-config.adoc chapter to fully explain
the 'cs7' client configuration.

Related: OS#2767
Depends: Ia2508d4c7b0fef9cdc57e7e122799a480e340bf7 (osmo-gsm-manuals)
Change-Id: I5b4973901f02046322b852fd9862517982d21bd9
2020-03-30 15:57:57 +00:00
Oliver Smith b5bfa71aa2 VTY: regenerate bsc_vty_reference.xml
Change-Id: I27bcde8d36dcf8daa9d24b4b581c9526b73cb35e
2020-03-27 10:29:51 +01:00
Neels Hofmeyr 21a2c81da4 manual: add "Multiple Instances" section, akin to other manuals
Related: OS#2767
Change-Id: Ideb137f19d19144d35b05eb036098045bbb18d64
2020-03-22 19:23:55 +00:00
Oliver Smith f659f5e5b0 doc: osmux: use generated svg instead of pychart
Replace python 2 code using pychart to draw a graph in
osmux-reference.adoc with the generated svg file. The upstream of
pychart is dead, there is no python 3 version, and python 2 is EOL at
the end of 2019.

This is the only time we ever made use of pychart in osmo-gsm-manuals,
so with this change, we can just drop the dependency.

I've generated the chart by saving the python code in chart.py, then:
$ ./chart.py --format=svg --font-size=3 > chart.svg

Related: OS#2819, OS#4193
Depends: osmo-ci I754b133d77743582bd84c33c74ecc9eb9ca4c0ef
Change-Id: I36b721f895caee9766528e14d854b6aa2a2fac85
2019-12-05 17:53:52 +01:00
Harald Welte 16c8910c71 manual: Fix copy+paste error
Change-Id: I787c4bd4b30a6620a987efed4fd8b46e14a7ea64
2019-12-01 14:23:34 +01:00
Martin Hauke a29affda98 Fix some typos
Fix typos and common misspellings in code comments and in the manual.

Change-Id: I46fc9d424620c77ae9ccf78b58081bd303386d7c
2019-11-13 22:10:41 +01:00
Harald Welte d102832d9f manual: Update statements regarding SCCPlite
SCCPlite is long supported (again) by osmo-bsc, let's remove the
outdated pointers to osmo-bsc-sccplite.

Change-Id: Ia3d831aca7c3c7ef9f257e974faf6e8e360c59f5
2019-09-04 12:45:35 +02:00
Harald Welte 7104ed2e58 doc: update bsc_vty_reference.xml
Change-Id: I6244a0de8802f437b5b291c76b4fc7bd4262baf8
2019-09-02 12:06:25 +02:00
Harald Welte d41b7c7f83 Cell Broadcast: CBSP and CBCH scheduling support
This adds code to handle CBSP (Cell Broadcast Service Protocol)
from the CBC (Cell Broadcast Centre), as well as BSC-internal data
structures for scheduling the various SMSCB on the CBCH of each BTS.

There are currently one known shortcoming in the code: We don't yet
verify if keepalives are received within repetition period.

Change-Id: Ia0a0de862a104d0f447a5d6e56c7c83981b825c7
2019-09-02 12:06:25 +02:00
Pau Espin 3fb2359172 doc: Add Osmux documentation to User Manual
Depends: osmo-gsm-manuals.git f3a734e6777a902abfb03257277454c7a879aeb7
Change-Id: I75dcdddc713b0dc43e2ba577ca377c20fc511f38
2019-07-22 10:34:24 +02:00
Harald Welte 7fbcc2eb2c vty: Fix typo in VTY command descrption -> description
Let's add deprecated aliases for backwards compatibility

Change-Id: I0e5da9d702910cf2571486e22a56f3ec17d0d67b
2019-07-19 07:04:50 +02:00
Ruben Undheim 06e6f8a95e Fix some spelling errors found by lintian
Change-Id: I63a733f8bea69f355a6686d99c3aa194c8ac9012
2019-07-16 20:15:53 +00:00
Neels Hofmeyr 08371ecc01 doc/manuals, vty doc: more handover doc clarifications
Related: OS#3487
Change-Id: I1639efb2dbcca4f0e9c33a74f3067606ce5f4209
2019-07-09 15:42:38 +00:00
Neels Hofmeyr ad5b8ce326 doc/manuals: review and tweak handover docs
Change-Id: Ib25cee8fd8c243881b99173a9a3036ad19d0f8af
2019-06-18 23:39:14 +02:00
Daniel Willmann 6057632172 manuals: Add script to update vtr/counter documentation from docker
Run it like this:
COMMIT=master DOCKER_PLAYGROUND=~/scm/osmo/docker-playground OSMO_INTERACT_VTY=~/scm/osmo/osmo-python-tests/scripts/osmo_interact_vty.py ./regen_doc.sh

COMMIT will default to current HEAD.
Change-Id: Iedd1f55d021231d86c19b6f14ff296e3a55148c8
Related: OS#1700
2019-06-17 16:37:48 +02:00
Eric Wild 10def2cf1e vty: adjust config name for unit-id
Having different names for the same config setting is misleading, so
let's stick to the one used by osmo-bts.

Change-Id: Ide5ceb5db7403a70313405752579e30d7bb94eac
2019-06-06 19:46:20 +00:00
Daniel Willmann f450f442f3 manuals: Update generated VTY reference and counters
Change-Id: I9f75edf2e5b88ef8f4592fa89548f32e0a7df8d8
Related: OS#1700
2019-06-06 17:53:50 +02:00
Oliver Smith 3f1f857378 debian: create -doc subpackage with pdf manuals
I have verified, that the resulting debian packages build in my own OBS
namespace (see the -doc packages):
https://download.opensuse.org/repositories/home:/osmith42/Debian_9.0/all/
https://build.opensuse.org/project/show/home:osmith42

Depends: Ib7251cca9116151e473798879375cd5eb48ff3ad (osmo-ci)
Related: OS#3899
Change-Id: I8dfb5658e567978aa8fe82f45d8287dbd1df969c
2019-05-29 12:14:07 +02:00
Daniel Willmann 803a4dc76c manuals: Fix example config to reflect OsmoBSC commands
Change-Id: Ic38eec67a2cbbef57d1d6349f08249ec20ff7e8c
Related: OS#2299
2019-04-17 16:01:11 +00:00
Daniel Willmann f2572c4ff4 doc: Add generic counter chapter in manual
Depends: I01b8529136450cb50e48b0fb5c17cb2daa5e24c3 (osmo-gsm-manuals)
Change-Id: Ida53d79787aedc5b37a68e6795a863cb0b4a343a
2019-04-17 16:01:11 +00:00
Harald Welte d6e57e3471 manual: Remove bogus "Control interface" sub-section in overview
We meanwhile have chapters about the CTRL interface protocol as well
as the auto-generated list of CTRL interface commands/values, so
let's remove the somewhat redundant information.

Change-Id: I062d7eec3b3fc53c31726be3b3a407a2dd3b8b56
2019-02-05 14:45:29 +00:00
Harald Welte bec10b0938 manual: s/OsmoNITB/OsmoBSC/ in examples; remove E1 based BTSs
We still haven't re-introduced support for E1 based BTSs, so let's
remove the relevant chapters from the manuals.  Also, make sure
we don't call anything OsmoNITB in this manual anymore.

Change-Id: I834d65836731958b6be823a18e35407183398715
2019-02-05 14:45:29 +00:00
Harald Welte e26f0130e2 manual: Re-order chapters in more logical order
It makes a lot of sense to first describe the VTY interface before
going on using it to configure something.  Also, configuration related
topics relevant to operators/sysadmins should precede other content
only relevant to developers, like the details of the CTRL or Abis/IP
protocol.

Change-Id: I0872d072bbb06f9409a72b93133d136167f03b38
2019-02-05 14:45:26 +00:00
Harald Welte 9e437a746a manual: Add sections on 3G/4G neighbor cells
This adds some instructions on how to configure 3G/4G neighbor
cells within osmo-bsc.   I didn't want to add a new top-level
chapter but instead chose to add it to the handover section which
describes also the configuration of 2G neighbors.

Change-Id: I81df1a453858b6fca80c8adf234b1d5b8bf5283d
2019-02-05 14:45:26 +00:00
Harald Welte 9e276081db manual: It's not "A over SCCP" but "BSSAP over SCCP"
In GSM specs, the entire interface between two elements is designated
with some letter, like the A interface between BSC and MSC.  The
interface uses a variety of protocols stacked on each other.

In the specific case of A, there is no "A" on top of SCCP, but
there's "BSSAP" on top of SCCP.

This is followed somewhat un-orthodox by 3GPP, as "A over IP" is
a violation of that principle.  It should have been called "A utilizing
IP", "A based on IP", "A with IP" or something the like.

In any case, at no point do the specs ever claim that "A" is stacked
on top of SCCP, so let's fix this.

Change-Id: Ieb0d8f6c71debe1234aff343a994c2096326da1b
2019-02-05 14:45:26 +00:00
Oliver Smith 686deafa48 build manuals included from osmo-gsm-manuals.git
Moved to doc/manuals/, with full commit history, in preceding merge commit.
Now incorporate in local the build system.

Build with:

$ autoreconf -fi
$ ./configure --enable-manuals
$ make

Shared files from osmo-gsm-manuals.git are found automatically if
- the repository is checked out in ../osmo-gsm-manuals; or
- if it osmo-gsm-manuals was installed with "make install"; or
- OSMO_GSM_MANUALS_DIR is set.

Related: OS#3385
Change-Id: I92c0f771d4ffc2b0401d26e25cb0b3817e6f95ea
2018-11-27 17:33:29 +01:00
Oliver Smith 27683cbe13 copy NITB's osmobsc-usermanual.adoc to OsmoBSC
Includes from other projects don't work anymore when moving project
specific manuals into other repositories.

Related: OS#3385
Change-Id: I96933dd4dd6cac159847647f1c642215051a9aad
2018-11-27 17:12:40 +01:00
Neels Hofmeyr 39e1215cbc OsmoBSC: update VTY reference
Re-generate bsc_vty_reference.xml from osmo-bsc, including updates to:
- handover and neighbor config
- SCCP timers
- logging

Change-Id: Ia9ba8d5eba531b1156de57573ab42517e0c1ca15
2018-11-27 17:12:40 +01:00
Daniel Willmann 5397326b40 OsmoBSC/HLR/MSC: Fix default config file name
Mention that the default is not openbsc.cfg, but osmo-*.cfg

Change-Id: I139e6004e28d6f918f31792e634214a6153edd0e
2018-11-27 17:12:40 +01:00
Neels Hofmeyr c3d839390a author info: add "former" to Holger's job title
It doesn't seem to have an effect on the generated PDFs though.

Change-Id: I0556a3f8dafc051f20a3854fc9006edf4ec1a0d3
2018-11-27 17:12:40 +01:00
Neels Hofmeyr aa4a3e7259 bsc: handover: mention the need to resend SI for telnet neighbor cfg
Change-Id: I305ef558b75697015e2532aa7c135f7995662e0d
2018-11-27 17:12:40 +01:00
Neels Hofmeyr 4875848853 bsc: handover: clarify default of all-cells-are-neighbors
Change-Id: I61f877c7a60419132bdd27c1b4e64150c0520751
2018-11-27 17:12:40 +01:00
Neels Hofmeyr 8c14a942d2 bsc: document handover
Add chapter "Handover", explaining:
- intra- and
- inter-BSC handover,
- HO algorithm 1 and
- algorithm 2
- new neighbor configuration

Adjust copyright, add revision and add me as author.

Change-Id: I7afb3f66c98abda07fc8acc76e00c46091fe55e2
2018-11-27 17:12:40 +01:00
Harald Welte 8a357681d2 vty-ref: Update URI of docbook 5.0 schema
... to match the /etc/xml/catalog file on debian (no "www" in hostname)

Change-Id: Id9f3579c7f2bc3af13fe30b5268f249b6f59ed0d
2018-11-27 17:12:40 +01:00
Neels Hofmeyr 9f157571ad OsmoBSC: update VTY reference
This is the first update since the libosmocore changes to the 'show
online-help' generated output. Hence the produced document now benefits from
the structural improvements:
- not repeating common commands for every node;
- using section names that match the VTY prompt.

Update bsc_vty_additions.xml to match the new node ID scheme.

Change-Id: I0d856563eee88527fda4c6940aa6cea779175aaa
2018-11-27 17:12:40 +01:00
Harald Welte 3a6ad2a2a2 add message sequence chart MS/BTS/BSC/MSC for 3GPP aoIP MO call
Change-Id: I7e41234cfe1483bb73589dc959851a54f9aafa36
2018-11-27 17:12:40 +01:00
Neels Hofmeyr d22e31fc9b common / OsmoBSC: drop unused alink.adoc
Change-Id: Ia3219359be891c161d20eccb7bbcb65af35ef42b
2018-11-27 17:12:40 +01:00
Neels Hofmeyr 9d0e3a7f2d OsmoBSC: update overview to explain both SCCPlite and SCCP/M3UA
Change-Id: I1f105b3febd4f99f4491e217ff1b1d0b28912980
2018-11-27 17:12:40 +01:00
Alexander Couzens b4045a0c69 OsmoBSC: add rate counter documentation
Change-Id: Ia8711dd4bc9db36a7121552dc067c7afb1051b0a
2018-11-27 17:12:40 +01:00
Max cef1d72ba8 OsmoBSC: update CTRL docs
* use proper naming scheme for BTS-specific CTRL commands
* add/update oml-* commands

Change-Id: I5b2cd940b4d84c140fce871f236aeab091b27360
Related: OS#2486
2018-11-27 17:12:40 +01:00
Neels Hofmeyr ea9a44dade refactor Makefile build rules, don't use the FORCE
The initial goal was to make sure we don't have overall FORCE rules causing
unnecessary rebuilds -- annoying while writing documentation. As I looked
through possible dependencies, I finally understood what's going on here.

Remove code dup and nicely sort which belongs where in build/Makefile.*.inc. In
each, describe in a top comment how to use it, and also unify how they are
used:

- Rename Makefile.inc to Makefile.docbook.inc and refactor
- Add Makefile.vty-reference.inc
- Add Makefile.common.inc

Make sure that we accurately pick up all dependencies.

Drop use of the macro called 'command', that silenced the actual command lines
invoked and replaced them with short strings: it obscures what is actually
going on and makes the Makefiles hard to read and understand.

Each manual's makefile is greatly reduced to few definitions and a Makefile
include, e.g. one for asciidoc, one for VTY reference.

Move common/bsc_vty_additions.xml to OsmoBSC/vty/libbsc_vty_additions.xml, link
from OsmoNITB. It applies only to OsmoBSC and OsmoNITB.

Add a script that combines a VTY reference file with *all* additions files
found in a manual's vty/ dir. Call this from Makefile.vty-reference.inc.

Change-Id: I9758e04162a480e28c7dc83475b514cf7fd25ec0
2018-11-27 17:12:40 +01:00