aboutsummaryrefslogtreecommitdiffstats
path: root/common
AgeCommit message (Collapse)AuthorFilesLines
2018-11-21*.adoc: include from ./common, not ../commonOliver Smith1-1/+1
Change hardcoded ../common paths, which will break when moving the project specific manuals in other repositories, to ./common so they use the dynamically created symlink that always points to the right path. (moving manuals to project repositories 8/19) Related: OS#3385 Change-Id: Id984f5e85481f7877567ee6d21f7ca455d773ef1
2018-11-18Logging: Describe all log options, including set-all and force-allDaniel Willmann1-0/+47
Change-Id: Ica03c3ea08289314819448a22ae7ed38a7bd4f83
2018-11-18common/chapters/bts: Remove duplicate spaces in textDaniel Willmann1-21/+21
Change-Id: I38f3e94342461f494ef547bcdccd2594c30e679d
2018-11-18Change OpenBSC mentions to OsmoBSC where applicableDaniel Willmann1-1/+1
Change-Id: I4cc6874302b6089a54d44b09f08660a25e46d4dc
2018-11-18VTY: Remove osmo-nitb VTY port number exampleDaniel Willmann1-1/+1
We reference the port list appendix where all the ports used by various Osmocom projects are listed and it's unlikely that pointing out the osmo-nitb port would significantly help the reader, so just remove the reference. Change-Id: I354d50314ba248835191fa3da122032201618a0e
2018-11-18OsmoBTS: Print VTY command in fixed-width fontDaniel Willmann1-1/+1
Surrounding with '@' didn't seem to yield the intended result, the charactars appeared in the compiled document. Change-Id: I66e7949fa4a6c2164bf9572a2beaf8ace169fa1c
2018-11-18Abis: Change abisip-find/ipaccess-config path to osmo-bsc repoDaniel Willmann1-4/+7
Change-Id: I4b92a611abd6e92ad69f77f8ec81a6501224afe5
2018-10-05add SGs / CSFB related dot + msc filesHarald Welte2-0/+42
Those graphs + message sequence charts are not yet used by any of our manuals, but they should become used by the OsmoMSC user manual once SGs interface support is added. Related: OS#2583 Change-Id: Idfd3a66c18131b5458d183b8e66f62eaaab65991
2018-10-01mncc: add note about DTMF considerationsPhilipp Maier1-0/+26
Add an informative note on how DTMF signalling is done in mobile networks and mention the limitations regarding DTMF, when internal MNCC is used. Change-Id: Iedcf4ad5e0e4697c6a05ebdd4f43173c14c7c448 Related: OS#2777
2018-10-01mncc: add missing DTMF message types.Philipp Maier1-0/+30
The list that describes the MNCC message types lacks the message types used for DTMF. Change-Id: I4251b296e043e7583518d6672e614b376331d25e Related: OS#2777
2018-09-20osmotrx: Introduce code architecture chapterPau Espin Pedrol1-0/+2
Change-Id: I21084e6315d79a1adcb305e12343da218837dc31
2018-06-17common/gsup.adoc: document Supplementary Services extensionVadim Yanitskiy1-0/+95
A while ago, we have introduced some new message types and IEs, related to TCAP-like transaction management and Supplementary Services. Let's document this extension. Change-Id: Ib1331246097db736d98baf1a162574cadca9ee36
2018-05-29port_numbers: Add osmo-gbproxy ctrl interface portDaniel Willmann1-0/+1
Change-Id: I2307a86c7c377ea3e6e8bf1333e283d5d3f67beb
2018-03-26message sequence charts for GSM <-> SIP codec selectionHarald Welte3-0/+211
Those diagrams represent the current design of the way how GSM <-> SIP codec selection should work in the future. Related: OS#1683 Change-Id: If92379b41d859bdf7be4b7689dc0bbca7cb6e682
2018-03-19common: logging: State we do support SIGHUP file rotationPau Espin Pedrol1-4/+3
This feature has been available since March 2013. It was introduced in libosmocore 8e878738d16ad4f8776dc0130ebff78dea422ee7. Change-Id: I650eb77d4b701a199a9e193cfb0e32565940a788
2018-03-06Introduce chapter trx_if.adoc and add it to OsmoTRX and OsmoBTSPau Espin Pedrol1-0/+156
This chapter defines the protocol used between osmo-trx and osmo-bts-trx. Most of the text comes originally from osmo-trx.git/README, as it's the only known documentation of the protocol other than the code itself. Change-Id: I56c418eef0f826ae1aadbed5b151fbed241c7885
2018-03-06common: port_numbers: Add OsmoTRX and OsmoBTS missing portsPau Espin Pedrol1-0/+3
Change-Id: Idc34aa2d4241945e80c07e4e5660451a016f0117
2018-01-26GSUP: Change wording to cover both SGSN and MSC/VLRHarald Welte1-48/+48
Change-Id: I4b473e324e9314f4e9356a8bae6fbb48dbaaf58c
2018-01-26share chapters/gsup.adoc from OsmoSGSN to OsmoMSC + OsmoHLRHarald Welte1-0/+859
Since the NITB split, GSUP is used in all three network elements, so make the protocol a shared chapter Change-Id: Id2d7c27ef16eb0ebe5f60d625a1fcf42f1603f4f
2018-01-19Document workaround for gsmtap loggingMax1-1/+8
Document a way to minimize logging to stderr when gsmtap is used as a log target. Change-Id: I8e64a0075b5a4bad3f83660e0668e6de45b21008
2018-01-19Clarify app-specific log filtersMax1-1/+4
Change-Id: I53e8aed658774781a70fea0b46cafc55496925eb
2018-01-18Add note on vty loggingMax1-0/+4
Change-Id: I2bb52feb37622d0ef35f6be172759adc3813f008
2018-01-05sigtran: fix typoMax1-1/+1
Change-Id: I02004ea55a00c55ee134d2c13e93614c3e1f06b3
2018-01-05Describe gsmtap log destinationMax2-0/+25
Change-Id: If34e1640d1033daacc955f4285013b8c1be644d2 Fixes: OS#2608
2018-01-04Update path to ctrl scriptsMax1-3/+3
Change-Id: Ib95e1ad33bbf115c8190f97210925549e6dc081a Related: OS#2550
2017-12-20ports: add osmo-hnbgw as on port-numbers wiki pageNeels Hofmeyr1-0/+2
Related: https://osmocom.org/projects/cellular-infrastructure/wiki/Port_Numbers Related: Ife52a968a41cb286f640006587877971ff66c1a4 (libosmocore) Change-Id: I28bd7a97d24455f88fadc6724d45c3264ba2fce4
2017-12-20common: ports: tweak OpenGGSN to osmo-ggsn as on port-numbers wiki pageNeels Hofmeyr1-2/+2
Related: https://osmocom.org/projects/cellular-infrastructure/wiki/Port_Numbers Change-Id: Ieaac06c9d914fc7481107ca8ebe6192b36b91bcd
2017-12-09common: vty_additions: use proper node IDs, tweak node descriptionsNeels Hofmeyr1-21/+31
Depends on the ENABLE and VIEW nodes to be named, as in a recent libosmocore patch. Depends: Iefb8b78094208a1a4c5d70bd6c69a3deca8da54f (libosmocore) Change-Id: Ic2f3b18cced72db6fa5bad02ae58c602bb2c0213
2017-12-07common: preface: spectrum license: also mention UMTSNeels Hofmeyr1-3/+3
Change-Id: I496f56c05f873a7d9d1cdf2bc95231c7957cf51b
2017-12-07common: preface: minor tweaksNeels Hofmeyr1-3/+4
Change-Id: Icfc3dee5fa5e6cc0f6a6e80b122206deeceff102
2017-12-07common: adjust preface to mention the current state of the Osmocom artNeels Hofmeyr1-7/+14
Change-Id: I5690e7b5f0bd1483b5451f284a758b4b09c80d95
2017-12-07common: bts: tweak BTS config example to show config, not telnet VTYNeels Hofmeyr1-38/+38
Change-Id: I9dda76cee8dfef6fc91099bcb3f90bed6c00b794
2017-12-07common: bts: add blank line to separate a code blockNeels Hofmeyr1-0/+1
Change-Id: I6072253a9293e5000465039d7dcd0c6e2b9966a3
2017-12-07common: bts: dyn ts: example: mention both osmo-bsc and osmo-nitbNeels Hofmeyr1-1/+1
Change-Id: Ie3218fd1449493a252a54f0b5356e8647df619e1
2017-12-07common: bts: dyn ts: explain dyn_ts_allow_tch_f from OsmoBSC viewpointNeels Hofmeyr1-3/+14
Change-Id: If9425b16216f353515890a7b2de8590bdfa1ff38
2017-12-07common: bts: dyn ts: mark octasic as supportedNeels Hofmeyr1-1/+1
Supported since osmo-bts 69ec4a419edee4f00a104c59a78b530eaf85382a / Ia109d4bfade7bc28442127581f4bb0289146ea71 Change-Id: Iab21573ab308b1e243bd6b56c9e3b1977a7f69fe
2017-12-07common: bts: dyn ts: drop special meaning for OsmoBSC vs OsmoNITBNeels Hofmeyr1-2/+1
Change-Id: I70da58bee08e531babfe78852cc82a1177f9b7b2
2017-12-07CTRL: add rate counter dumper to examplesMax1-1/+31
This describe rate counter dumper added to osmo-python-tests in I12b369434e4ee9b38f92872f297e1f3d4f0698c2 Change-Id: I52d735f373f2e7aa1f12941fc450c0e9740ccdeb Related: OS#2550
2017-12-07Update CTRL exampleMax1-10/+10
Use proper script new and repository location. Change-Id: I3c16f38ade6fcfadffd8d2573f71828119da055c
2017-11-28rate_ctr: clarify ctrl interfaceMax1-1/+4
Clarify introspection over ctrl interface and request for individual rate counter. Change-Id: I3d258aaafc381644be2f16b51e4dc655c1fb9b26
2017-11-27Update rate_ctr descriptionMax1-8/+19
* use example new counter names with ':' separator * mention that 'counter' is obsolete * mention group name and index * use bold and monospace fonts to improve visibility Change-Id: Ia962367bb93cb826002db6c950d23ae2102ac713 Related: OS#2550
2017-11-24common: add osmo-mgw to mgcpPhilipp Maier1-1/+1
Add osmo-mgw to the list of programs which use the MGCP port IETF Change-Id: Idfd0340297ddb15494b4b20d776e89e6288107e1
2017-11-24common: add VTY port number of osmo-mgwPhilipp Maier1-1/+1
osmo-mgw currently uses the VTY port constant of osmo-bsc_mgcp. We decided to re use the same port number for osmo-mgw, this is not mentioned in the manuals yet. Add the port number of osmo-mgw to the manuals (common) Change-Id: I41f7f2a7f850613707eddea610557b688de7a904
2017-11-24Revert "common: add VTY port number for osmo-mgw"Philipp Maier1-1/+0
We agreed to re-use the port of osmo-bsc-mgcp, so there is no need for this patch anymore. This reverts commit ad4a01e2a4674caf1f3d5680f825177e659254f0. Change-Id: I8629db5e975cc218c80c747a39c0fdca5f5d6e10
2017-11-12STP: State actual vty commands for dynamic RKM registrationHarald Welte1-0/+10
Change-Id: I639dc271dd7f5bea1f6cb8b070990c7c15a39dba
2017-11-12STP: cosmetic fixes/improvementsHarald Welte2-13/+16
Change-Id: I1c1c7bb122e9cf9b707feb8e6617a03d15043089
2017-11-12First step towards an OsmoSTP manualHarald Welte6-0/+852
Change-Id: I450bfac7444ac9cb7f50c086d87cf7157c2e2a31
2017-11-10common: add VTY port number for osmo-mgwPhilipp Maier1-0/+1
Change-Id: Ifa7eec30ccc5a0beb26c9ec50492d4637cd1d0a5
2017-10-25refactor Makefile build rules, don't use the FORCENeels Hofmeyr1-244/+0
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
2017-10-18common/vty: minor wording tweaks and typo fixesNeels Hofmeyr1-41/+40
Change-Id: I5eb1ea0d3de883ff5e9742f77e7ef4be0482852d