Commit Graph

512 Commits

Author SHA1 Message Date
Pau Espin 738c0840e0 Bump version: 1.1.0.18-cec5 → 1.2.0
Change-Id: Id9167fa8aa474bb6feb349a2dcecb015b2a1d3b4
2021-11-16 13:18:04 +01:00
Vadim Yanitskiy cec5b5d74d mncc: do not mention deprecated -m / --mncc-sock options
Change-Id: Icb18fb9e95c5a7f32a85a1b269185298c07354ee
2021-11-12 20:22:22 +03:00
Pau Espin b92c3ae264 cs7-config.adoc: Improve doc on default SS7 SCTP addresses
Related: OS#5186
Change-Id: Ic8d9c00ae50907f1adad8f70b773e7b1362c4f50
2021-10-05 17:25:28 +02:00
Oliver Smith 581ef10981 d/patches/build-for-debian8.patch: remove
Remove this workaround, as we are not building for debian 8 anymore.

Related: OS#5223
Depends: osmo-ci Ibe7ba124557969df62798ba49c4489e9606c2341
Change-Id: I8285b8c483fe2d136b83946414587fc993d5f489
2021-09-01 16:50:17 +02:00
Oliver Smith 1f1d93cf38 port_numbers: add osmo-pcap-client, -server
Related: OS#5203
Related: libosmocore I098f211370bba61995ce424ab64029bdd4c49e2d
Change-Id: Iebbb07bfa1ecb6597de9925f79eb8e0aff26ae4f
2021-08-05 19:17:27 +02:00
Vadim Yanitskiy 13f502bb6f TRXDv2: add primary/shadow classification for VAMOS PDUs
Introduce a new flag (1-bit field) indicating whether a VAMOS PDU
is for a _primary_ ('0'B) or for a _shadow_ ('1'B) timeslot.  This
field shall be present only in the Uplink VAMOS PDUs, which unlike
the Downlink (AQPSK) PDUs are sent separately.  This will simplify
routing of such PDUs in osmo-bts.

Change-Id: Ie00a12824938c6a65480bde1af364dcc9febb8f7
Related: SYS#4895, OS#4941, OS#4006
2021-06-02 04:36:42 +02:00
Harald Welte 5533b2ee48 glossary: fix various typos I introduced.
Change-Id: Iaf045bd20afb86384e00663df234197eed4d31c4
2021-04-28 17:38:15 +02:00
Harald Welte 2ee1a2f34d Add new common chapter about QoS, IP DSCP and IEEE 802.1q PCP
Related: SYS#5427
Change-Id: Id344c29eda2a9b3e36376302b425e9db1f6c0f28
2021-04-28 12:11:53 +02:00
Harald Welte e87733176f bibliography: Re-introduce RFC768 (UDP)
It's unclear why it was removed in I5fe6263ac666e41cbe34407f09e9023aafa57d2c
when common/chapters/glossary.adoc of this very same repository uses it.

Change-Id: Ib8d2f22450a84ed802b34845ad19a7af8d6b7968
2021-04-28 11:48:36 +02:00
Neels Hofmeyr 619c2cbfd8 bib: add reference to 3GPP TS 45.002, for Training Sequence definitions
Change-Id: I2d72bff8496d7b3a0ad59ce28d6be0fd3f842839
2021-04-22 18:48:55 +00:00
Harald Welte 811f3e8526 build: Switch from rita -> ftp.osmocom.org
We should use service-aliases and not the primary host name, as
that makes migration between machines hard.

Change-Id: Ie139a8cbf2aaa746c0edf6c90a567eb43bc51f45
2021-04-22 11:24:50 +02:00
Vadim Yanitskiy b9ed9473cc TRXD: add documentation for TRXDv2 protocol
Change-Id: I03b2beeb535848b31fd629ba3cd330b43072c08b
Related: SYS#4895, OS#4941, OS#4006
2021-04-15 22:22:36 +02:00
Vadim Yanitskiy 9936a9cbd9 TRXD: generalize description of the 'RFU' ('PAD') field
This field will also appear in TRXDv2 packet diagrams, in several
places.  Let's rename it to 'RFU', because it's actually something
that may want to use in the future, rather than just padding.

Change-Id: I9ac9d387325627d18811fae1d0d7930b69f08129
Related: SYS#4895, OS#4941, OS#4006
2021-04-14 14:59:52 +02:00
Vadim Yanitskiy c799a84974 TRXD: rework description of the NOPE / IDLE frame indication
* Add 'referred to as NOPE.ind', this is how we usueally call it;
 * Change 'IDLE / NOPE' to 'NOPE / IDLE', because:
 ** there can be 'IDLE TDMA frame', but not 'NOPE frame';
 * Avoid using 'high' and 'low' terms for bit values.
 * Introduce and use macros for '0'B and '1'B.

Change-Id: I72e0c785efb8a89b664486740ef312e77b81c01a
Related: SYS#4895, OS#4941, OS#4006
2021-04-14 01:31:33 +02:00
Vadim Yanitskiy 84338b5f76 TRXD: clarify modulation specific length of Soft-/Hard-bits
Change-Id: Icd807810060372c8f27d81f8a825ea9a5f384c1c
Related: SYS#4895, OS#4941, OS#4006
2021-04-13 22:56:10 +00:00
Alexander Couzens ed4f7f2783 common/chapters: extend gb/ns2 chapters
Merge gb-variants.adoc into gb-ns2.adoc
Add a general overview of the internal structure which is also used
by the vty.
Move the configuration into a seperate adoc to allow the PCU manual to skip
the part which doesn't apply for it.
Copy the timer configuration into gb.adoc to allow document newer
timers. All users of the NS2 code will use the timer sub-chapter.

Related: OS#5077
Change-Id: I902b850528cbc04bd469590babd84cccf64300e8
2021-04-12 08:25:19 +00:00
Vadim Yanitskiy 0a5a50b67b fix missing and/or non-existent linked references
Change-Id: I5fe6263ac666e41cbe34407f09e9023aafa57d2c
2021-04-10 05:31:07 +02:00
Vadim Yanitskiy a137f4a47c fix tests/Makefile.am: exclude file 'mgcp_extension_osmux.adoc'
This file is included by 'osmux.adoc', so we end up including it
twice in 'test-usermanual.adoc'.  This makes xsltproc complain:

  /build/tests/test-usermanual.xml:643: element section:
    validity error : ID mgcp-extension-osmux already defined

and sometimes causes sporadic build failures.  Exclude it.

Change-Id: I00efafc822f46126b59d20e86bb07ec991768c28
Related: OS#5112
2021-04-10 04:55:24 +02:00
Harald Welte a7e4cc79a3 add README.md to describe what this repo is about
Change-Id: Ic8d0ff5b81f701debad59b2ba701ff115c6574c3
2021-03-21 22:58:56 +01:00
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