Commit Graph

493 Commits

Author SHA1 Message Date
Pau Espin 940eee143b Bump version: 1.0.0.17-b83a-dirty → 1.1.0
Change-Id: I19eb9c7df3f374a6ccd23638f389e1682549a12d
2021-02-23 12:59:20 +01:00
Vadim Yanitskiy b83aa8aa4d logging: add documentation for 'systemd-journal' target
Change-Id: I04c9f81b10ac56c020f537c3ad52026733b5c620
2021-02-13 08:18:52 +00:00
Vadim Yanitskiy b98c5d6c34 TRXD: more information on PDU versioning and some highlights
Change-Id: Idac4a1c73cc92bf030ea80474c71688bfb706421
Related: SYS#4895, OS#4941, OS#4006
2021-02-12 00:08:22 +01:00
Vadim Yanitskiy ebf6a72346 TRXD: clarify description of NOPE / IDLE indications
Change-Id: Idaa1c597cbfd198a0f1802ac01b210d42369ee95
Related: SYS#4895, OS#4941, OS#4006
2021-02-12 00:07:48 +01:00
Vadim Yanitskiy 5b44519fd3 TRXD: rework description of the 'Training Sequence Code' field
The way how the indicated Training Sequence Code is supposed to be
used by the BTS is behind the scope of this protocol specification.

Change-Id: Ibcb0b6bfff0aa80ed2de563b5e749b7811e7a5c2
Related: SYS#4895, OS#4941, OS#4006
2021-02-12 00:07:48 +01:00
Vadim Yanitskiy ede6098381 TRXD: reserve a combination for Access Bursts on PACCH
Change-Id: I84c68ab899aea2bbc013f98cb41082ab076308a5
Related: SYS#4895, OS#4941, OS#4006
2021-02-12 00:07:48 +01:00
Vadim Yanitskiy f14fb4b949 TRXD: use different coding for AQPSK in the 'MTC' field
AQPSK is used exclusively on Downlink in VAMOS mode.  An AQPSK burst
is basically a combination of two Normal Bursts.  Each of these two
bursts has the same length as defined for GMSK, while both must be
using Training Sequences from different sets.

Four different sets are defined in 3GPP 45.002, section 5.2.3.1.
Therefore we need *two* bits to encode all possible values.  Let's
rearrange the existing combinations and use '11XX'B for AQPSK.  The
old combination '011X'B becomes reserved and can be re-purposed.

This change is considered to be safe, given that no implementations
are known to support AQPSK at the moment of making this change.

Change-Id: Ie9b419e4a70fa0eb2888c326ac50d2d40a67a29c
Related: SYS#4895, OS#4941, OS#4006
2021-02-12 00:07:48 +01:00
Vadim Yanitskiy f09107c5b0 TRXD: clarify the meaning of field 'PWR' in Downlink messages
Change-Id: Idb2a987f9692f0bdc84b40223d5cec2ba3247b9d
Related: SYS#4895, OS#4941, OS#4006
2021-02-12 00:07:48 +01:00
Vadim Yanitskiy 8015ea832b TRXD: cosmetic: clarify soft-/hard-bits on packet diagrams
Change-Id: Ieeb21e07865ab7bf2ac50f908ca50410141e012f
Related: SYS#4895, OS#4941, OS#4006
2021-02-12 00:07:48 +01:00
Vadim Yanitskiy 5d842d41b8 TRXD: fix optional padding length: bits vs bytes
Change-Id: I30327e56558729cccbf627a7fcba04a9f6ac09f1
Related: SYS#4895, OS#4941, OS#4006
2021-02-12 00:07:48 +01:00
Vadim Yanitskiy 9454038f7e TRXC: introduce VAMOS enabled channel combinations
Change-Id: Ic7d4d90df752ded8c778c7b16b22d4d346bf1c9c
Related: SYS#4895, OS#4941, OS#4006
2021-02-12 00:07:48 +01:00
Vadim Yanitskiy 0ab9490f9c TRXC: add proposal for multiple Training Sequences
Change-Id: I621e46edac5d748472fd645f81876116904e260c
Related: SYS#4895, OS#4941, OS#4006
2021-02-11 22:31:27 +01:00
Vadim Yanitskiy d18f31465a TRXC: add missing description of the 'SETTSC' command
Change-Id: I3d62da53101ec9c22d9742932bd9bb6f151545e0
Related: SYS#4895, OS#4941, OS#4006
2021-02-11 21:59:31 +01:00
Vadim Yanitskiy f720da86f1 TRXC: use monospace formatting (the backticks) for 'SETFORMAT'
Change-Id: I3fe1f3ab9c9b614cb5f229ca042021642b154a0b
Related: SYS#4895, OS#4941, OS#4006
2021-02-11 21:59:31 +01:00
Vadim Yanitskiy db66389648 glossary.adoc: add brief definitions of AQPSK and VAMOS
Change-Id: I6e0b4d2baea22dc69274280719bcb24f1a0b8127
Related: SYS#4895, OS#4941
2021-02-02 14:42:47 +00:00
Harald Welte ee37483661 cs7-config: Describe special meaning of M3UA routing context '0'
Osmocom has a special interpretation of the routing-context '0'.

Let's document that.

Change-Id: Iac0bc1e754d04b2e798263bfa029d26376e4e92f
2021-01-28 23:36:45 +01:00
Harald Welte ae95711860 bibliography: https everywhere.
Change-Id: Id3f66521c8f03d0d26b9f48abfd02408d27fc5fd
2021-01-27 20:31:24 +01:00
Harald Welte 9a71e79c01 bibliography: Add more user manuals
Change-Id: I3eb5f34a095d1c32aa218995f1ef3d4c1aa46e05
2021-01-27 20:29:08 +01:00
Harald Welte 8433f027da Bump version: 0.3.0.6-f29a → 1.0.0
Change-Id: Idcf75e78cac8aed49aefa871f1fc34f2c44f87e9
2021-01-06 17:21:50 +01:00
Harald Welte c1ef1ade56 Add common chapters on GB interface variants and SGSN pool
The chapters are not 100% finished, as there is still some
implementation work going on in terms of the libosmogb 'ns2' code
as well as the introduction of the SGSN pool feature to osmo-gbproxy.

Change-Id: I0ba2ed2a72db52a7282f4f1055812644421b2a98
2020-12-13 11:08:25 +01:00
Harald Welte c507529358 cs7-config: Reference the OsmoSTP user manual for more info on SS7
Change-Id: I2ae95e41ac7c3f7219b353ec1968ac5f5772a5f0
2020-11-20 17:04:16 +01:00
Harald Welte 6da11244b0 cs7-config: Explain that A/Iu/Lb interfaces are reouted via STP
Change-Id: Iabba390b41b9d2ad9c3975a6e6cc504a56e59d0b
2020-11-20 17:01:55 +01:00
Harald Welte 46f610b3b4 cs7-config: Mention OsmoSMLC
Change-Id: I07ec996393c00f13a73eddb3503c019418523ee6
2020-11-20 16:55:53 +01:00
Harald Welte 9c3c942721 sigtran: Describe sctp/m3ua role, multi-homing, traffic-modes
Change-Id: I4c54dbde5a0b0f6ae38efdd047b17b4dbaae12c3
2020-11-20 16:50:16 +01:00
Harald Welte 30c22d11c6 sigtran: Mention that M3UA was chosen by 3GPP
Change-Id: I2bc7cfdcada9e524f0fa6d7fe98f4bed8614363d
2020-11-20 16:50:16 +01:00
Vadim Yanitskiy ff86b25a5d Makefile.common.inc: make 'publish' target use $(UPLOAD_FILES)
In some projects, the VTY reference PDFs may be located in sub-
directories.  Let's use $(UPLOAD_FILES), it already contains
the list of all *.pdf files to be uploaded / published.

Change-Id: I7d46dc3b67dee1a91f3ade5a166d833df816abd4
Related: SYS#4937
2020-11-06 17:09:39 +07:00
Vadim Yanitskiy 345738508e Makefile.docbook.inc: generate *.pdf in the given directory
Change-Id: If6d19dd0359239582d41ab3577c4b8bada4c81b8
Related: SYS#4937
2020-11-03 02:55:46 +07:00
Vadim Yanitskiy 2e039c9c12 vty_reference_combine.sh: print the final result to stdout
This is a follow-up change for [1], making this script more
flexible.  It's now a task of the caller to store the merge
results to a file.  This approach allows to merge several
*.xml files and store all the results in a single directory.

Unfortunately, it's impossible to pass the same file as both
input and output to xsltproc, because it would immediately
overwrite its input.  To work this around, create two
temporary files and remove them at the end of the script.

[1] Iabe729af22c235cf9c4b252acda99b43ebcae20c

Change-Id: I6aac73d998c5937894233631e654a160d5623198
Related: SYS#4937
2020-11-02 17:56:52 +00:00
Vadim Yanitskiy 2e5dd3cd3f Makefile.docbook.inc: allow to re-define the include directory
Change-Id: I08481319bbe14c3f45bf38bafa478de239751400
Related: SYS#4937
2020-11-02 17:56:31 +00:00
Vadim Yanitskiy 5be5350c8d Makefile.vty-reference.inc: create 'generated' in this file
Ideally, 'vty_reference_combine.sh' should not create any files
nor directories on its own; it should do exactly what its name
suggests - combine several XML files into a single one.

Let's first make the target directory ('generated') creation a
task of 'Makefile.vty-reference.inc', and then make it output
the results to stdout in a follow-up change.

Change-Id: Iabe729af22c235cf9c4b252acda99b43ebcae20c
Related: SYS#4937
2020-11-02 09:29:59 +00:00
Vadim Yanitskiy 16236cfd4c Makefile.docbook.inc: fix incorrect variable name in documentation
Change-Id: I1d451820fdf8b7d4dd1b48065eaa7617919af392
2020-11-02 09:29:59 +00:00
Vadim Yanitskiy db907f40d0 chapters/vty: add in-place comments to the attribute examples
Change-Id: Ic68ca1de32e6ceceb75039045bf28d6680a59287
Related: SYS#4937
2020-10-30 06:07:06 +07:00
Vadim Yanitskiy 8ca4ca87b4 chapters/vty: add documentation for the expert mode
Change-Id: Ic43fbef8df77ad5561ca4521a29bc9f60bd3d7ac
Related: SYS#4910
2020-10-30 06:06:47 +07:00
Vadim Yanitskiy aa366dd619 chapters/vty: add IPv4/mask and IPv6/mask examples
Change-Id: I0946cf8629c4a77dfa8e9be90da85c2988ecef38
2020-10-24 05:52:02 +07:00
Harald Welte 48e7e3ff7d biblio: Add 3GPP TS 31.103 (ISIM)
Change-Id: I7ca068ff5cb8a21b1a48f95b8b7b660ae0f0dae0
2020-10-14 20:31:35 +02:00
Philipp Maier fcafb7a297 vty: explain how command attributes are used
The VTY features a method to associate commands with certain
attrubutes. Tell the VTY user how to use the help to display the
attributes and their meaning.

Change-Id: If03e07f1f8e7e3c0166a00e3f395e2a46a9a7713
Related: SYS#4937, OS#1601
2020-10-09 18:44:04 +02:00
Vadim Yanitskiy 204550e124 vty_reference.xsl: also handle 'global' and 'library' attributes
Unfortunately, there is no xsl:function support in XSL 1.0, so
we have to duplicate the existing code :/

For more details about the attribute scopes / types, see:

https://lists.osmocom.org/pipermail/openbsc/2020-October/013278.html

Change-Id: I7f7e6e32c156de24dcc80166a29119e6dda8c169
Related: SYS#4937
2020-10-07 15:09:00 +07:00
Vadim Yanitskiy d3ac855a38 vty_reference.xsl: handle application specific attributes
Change-Id: I17794b2cb476bd54c7b35a1e23c0727352c3a2a9
Related: SYS#4937
2020-09-21 14:12:38 +00:00
Pau Espin 0ef694525c trx_if.adoc: Document RFMUTE TRXC command
Change-Id: Id7031b52639f55d36d1589a786e0d29ebb5def53
2020-08-26 16:04:43 +02:00
Harald Welte 2944c5cda6 port_numbers: Add port numbers for upcoming OsmoSMLC
Change-Id: I09c9a2141dda266999b89513f1faa86adfca8e6a
2020-08-21 18:00:47 +02:00
Pau Espin f9e914f956 chapters: Introduce vty_cpu_sched.adoc chapter
Documents new features added in libosmocore.git Change-Id
If76a4bd2cc7b3c7adf5d84790a944d78be70e10a.

This file will be imported in user manuals of programs using the
mentioned libosmovty features.

Related: SYS#4986
Change-Id: Icd75769ef630c3fa985fc5e2154d5521689cdd3c
2020-08-10 14:34:58 +00:00
Pau Espin c8fcb80aed Drop common/chapters/{bts,bsc}.adoc
Those files were only used by osmo-bsc.git and openbsc.git, the later
being depreacted and not maintained. Hence, new features are added to
the first one only, and documentation diverges over time, so it makes no
sense to keep it shared.

Files were copied over in:
openbsc.git Change-Id Ic3b4192238be3147f61779845521eae84511fb7e
osmo-bsc.git Change-Id I20aa60d2f4111d66e922f3e2a73a20352ec1f7e4

Change-Id: I4d98049f6b49871bf5aabe4392da7a608fbc1fe9
2020-07-20 13:19:16 +02:00
Harald Welte 96b325b735 synchronize port_numbers.adoc with wiki
The osmo-uecups related ports were not added at the time, and the
upcoming osmo-e1d VTY port had to be added, too.

Change-Id: If4128991efdba3a1c3c38e6cd688593a212346f6
2020-06-29 10:45:12 +02:00
Neels Hofmeyr 6a13b246e0 bibliography, glossary: add MSC pooling related bits
Add 3GPP TS 23.236, "NRI" and "MSC pool".

Depends: Ia60afc8a91189c9de0d8e8065781ed463bf18d7e (osmo-bsc)
Change-Id: I0640db26dc85ab7723c7160e405fc73f412fd706
2020-06-18 11:23:09 +00:00
Neels Hofmeyr d2c6806b0a vty reference: allow reference XML generated at build time
Add variable BUILT_REFERENCE_XML for callers to indicate dependencies for the
VTY reference.

Add script find_existing_path.sh to pick a given path from either builddir or
srcdir, whichever exists.

In Makefile.vty-reference.inc, use find_existing_path.sh to make the VTY
reference build rules work no matter whether the reference.xml is built in
builddir or committed in srcdir.

Change-Id: I613d692328050a036d05b49a436ab495fc2087ba
2020-06-08 11:57:54 +02:00
Pau Espin b076dc585c trx_if.adoc: Document cmd NOMTXPOWER
TRXC message is implemented in:
osmo-bts.git I682211f3d664c21f923ca4a530e0464ca383b6d9
osmo-trx.git I1d7efe56e008d8d60e23f9a85aa40809f7f84d9c

Change-Id: Idb5bb56fc039c7393922243c761f3395a094a55b
2020-06-02 14:29:59 +02:00
Pau Espin d78c670ee9 trx_if: Clarify {SET;ADJ}POWER TRXC commands
Change-Id: I4f1986a1ace3fc9cbef10fc0508407a3d608670b
2020-06-02 14:26:15 +02:00
Vadim Yanitskiy b01306c59a GSUP: fix E-Routing-Error: both session state / ID IEs are optional
If a message that has triggered the E-Routing-Error contains no
session related IEs, they will also be absent in the error message.

Change-Id: Iaf9d8e77c8734672cfd8a265b8cfdb3bc929a31b
2020-04-19 19:45:17 +07:00
Vadim Yanitskiy 49ab1cb2fc port_numbers: fix: GSMTAP has noting to do with port 2427/udp
Change-Id: Ic37ee2e2da290521ac226a9720d48fbbe0883f3d
2020-04-17 02:05:47 +07:00
Vadim Yanitskiy 0d72300779 logging: fix section 6.5.3: logging level s/all/force-all/ fatal
The special 'all' keyword has been deprecated a long time ago
due to its ambiguity, and replaced by 'force-all'.

Change-Id: I759d96716e964d499c0724d481b2f3e5062fb052
2020-04-17 01:05:44 +07:00