path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
2018-11-27build manuals included from osmo-gsm-manuals.gitOliver Smith6-33/+47
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-27Merge history from osmo-gsm-manuals.gitNeels Hofmeyr35-0/+8016
Change-Id: I9ff481784ba8c6334b1e57b1f64dfc9262e6d0e2
2018-11-27copy NITB's osmobsc-usermanual.adoc to OsmoBSCOliver Smith2-1/+282
Includes from other projects don't work anymore when moving project specific manuals into other repositories. Related: OS#3385 Change-Id: I96933dd4dd6cac159847647f1c642215051a9aad
2018-11-27OsmoBSC: update VTY referenceNeels Hofmeyr1-447/+505
Re-generate bsc_vty_reference.xml from osmo-bsc, including updates to: - handover and neighbor config - SCCP timers - logging Change-Id: Ia9ba8d5eba531b1156de57573ab42517e0c1ca15
2018-11-27OsmoBSC/HLR/MSC: Fix default config file nameDaniel Willmann1-1/+1
Mention that the default is not openbsc.cfg, but osmo-*.cfg Change-Id: I139e6004e28d6f918f31792e634214a6153edd0e
2018-11-27author info: add "former" to Holger's job titleNeels Hofmeyr2-2/+2
It doesn't seem to have an effect on the generated PDFs though. Change-Id: I0556a3f8dafc051f20a3854fc9006edf4ec1a0d3
2018-11-27bsc: handover: mention the need to resend SI for telnet neighbor cfgNeels Hofmeyr1-0/+9
Change-Id: I305ef558b75697015e2532aa7c135f7995662e0d
2018-11-27bsc: handover: clarify default of all-cells-are-neighborsNeels Hofmeyr1-0/+16
Change-Id: I61f877c7a60419132bdd27c1b4e64150c0520751
2018-11-27bsc: document handoverNeels Hofmeyr6-2/+642
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-27vty-ref: Update URI of docbook 5.0 schemaHarald Welte1-2/+2
... to match the /etc/xml/catalog file on debian (no "www" in hostname) Change-Id: Id9f3579c7f2bc3af13fe30b5268f249b6f59ed0d
2018-11-27OsmoBSC: update VTY referenceNeels Hofmeyr2-3065/+4790
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-27add message sequence chart MS/BTS/BSC/MSC for 3GPP aoIP MO callHarald Welte1-0/+146
Change-Id: I7e41234cfe1483bb73589dc959851a54f9aafa36
2018-11-27common / OsmoBSC: drop unused alink.adocNeels Hofmeyr2-17/+0
Change-Id: Ia3219359be891c161d20eccb7bbcb65af35ef42b
2018-11-27OsmoBSC: update overview to explain both SCCPlite and SCCP/M3UANeels Hofmeyr1-77/+91
Change-Id: I1f105b3febd4f99f4491e217ff1b1d0b28912980
2018-11-27OsmoBSC: add rate counter documentationAlexander Couzens3-0/+82
Change-Id: Ia8711dd4bc9db36a7121552dc067c7afb1051b0a
2018-11-27OsmoBSC: update CTRL docsMax1-13/+14
* use proper naming scheme for BTS-specific CTRL commands * add/update oml-* commands Change-Id: I5b2cd940b4d84c140fce871f236aeab091b27360 Related: OS#2486
2018-11-27refactor Makefile build rules, don't use the FORCENeels Hofmeyr2-49/+250
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-27Allow easily disabling GFDL referencesPau Espin Pedrol1-0/+2
All parts referencing GFDL can be easily disabled by removing the 'gfdl-enabled' attribute from the document. Change-Id: I2489726ad2e90301bceadfada926e31ae0f85986
2018-11-27MGW: Include MGCP endpoint naming scheme of old IPA/SCCPlite approachHarald Welte1-8/+8
Change-Id: Ib1fe96f0041534fa027b70ee67978cb7c6bc5207
2018-11-27mgw: Fix endpoint names for new MGWHarald Welte2-16/+16
According to RFC3435, an RTP bridge forrwarding packets, transcoding or otherwise, is a single endpoint with two connections. Let's treat it as such. We introduce the "rtpbridge/" prefix to identify such special RTP endpoints. Change-Id: Id1f079307225faf05d298dcb12aa1c421bfa680a
2018-11-27osmux: Fix description for Dummy frames FT fieldPau Espin Pedrol1-3/+3
Change-Id: Ia421655bd1be45101da3db2a0af44fbb3cc111c1
2018-11-27osmux-reference-docinfo: Add latest changes to revhistoryPau Espin Pedrol1-0/+8
Change-Id: I01e513a71a3f830d393c57c43678d7e4c8d2d151
2018-11-27osmux-reference: Add traffic saving plotPau Espin Pedrol1-79/+55
Change-Id: I8fa60c1f95436c39fd1ff9424a907876d367484e
2018-11-27osmux-reference: Add sequence chartsPau Espin Pedrol1-0/+189
Change-Id: Ic2c63e4d9e67b877dc06a206ec7f07d0704329a5
2018-11-27osmux-reference: Use packetdiag to draw packet header structuresPau Espin Pedrol2-16/+50
Change-Id: Id75152278f41d56b7bd2e652b9947e33d6523c64
2018-11-27BSC: Add series of message sequence charts about MGCP handlingHarald Welte7-1/+353
Change-Id: Id5948677d23a58ce112b57f91bea953a93baab4c
2018-11-27Add chapter on Cell Broadcast Support in Osmocom (to BSC+NITB manual)Harald Welte1-0/+2
Change-Id: I2c621def499dc0564d31eb9440e22e79948a5466
2018-11-27Add osmux-reference documentPau Espin Pedrol3-1/+488
Change-Id: I4d19df98af84560c147a637bc42ebe570bb280aa
2018-11-27BSC,BTS: add diagrams of PCU-BTS-NITB-SGSN relationshipsIvaylo Kostov1-0/+69
Change-Id: I0eb09706efb768fa4f6810872fb6568cbc9838cb
2018-11-27fix 'make clean': shell glob, ignore failureNeels Hofmeyr1-2/+4
Unfortunately a glob like osmo-x__*.{svg,png} doesn't work, so have the suffixes in separate globs. Add dashes to indicate that failure should be ignored. Change-Id: I6bc4d9ea72b43a573acbc860c23397f748de2c7b
2018-11-27OsmoBSC: include bts-examples.adoc from OsmoNITBNeels Hofmeyr1-1/+1
Change-Id: I6b6d8c413762c710453b228f846216961b578597
2018-11-27OsmoBSC+NITB/running: fix title levels, one too deepNeels Hofmeyr1-2/+2
Change-Id: If81e44c9a0774e5de39cc536989cef5cb214a224
2018-11-27add 'make check' targetNeels Hofmeyr1-1/+1
Generate *.check files from asciidoc output and grep for WARNINGs. Add *.check files to gitignore and to 'make clean'. Change-Id: Ibccc83a3415930a528f2e8e4e4dda3b81c6d0b64
2018-11-27make clean: also remove generated image filesNeels Hofmeyr1-0/+1
Change-Id: I80798e79b4ccee64f26f58f9754de02b2958e33e
2018-11-27OM2000 MSC: Fix spellingHarald Welte1-1/+1
2018-11-27OM2000 message sequence charts: specify MO in node nameHarald Welte7-7/+7
2018-11-27add Ericsson OM2000 message sequence charts (one for each MO)Harald Welte10-0/+237
2018-11-27Add OsmoBSC control interface descriptionMax2-0/+101
2018-11-27minor tweakNeels Hofmeyr1-1/+1
2018-11-27fix various typos across all manualsJonathan Brielmaier2-4/+4
2018-11-27Add OsmoBSC control interface descriptionMax1-0/+22
2018-11-27Add link to Asciidoc source code of manualHarald Welte1-0/+6
2018-11-27initial checkin of manuals to public repoHarald Welte9-0/+3372
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.
2018-11-20bsc: Enable force-combined-si on nanoBTS by defaultPau Espin Pedrol2-2/+0
Some nanoBTS firmwares (if not all) are known to not work properly with SI2ter. If BSC enables SI2ter through RSL, SI3 bit announcing SI2ter available will be forwarded by nanoBTS to MS, but will still only send SI2 message instead of expected SI2ter during TC=5 (see GSM 05.02 sec 6.3.4 "Mapping of BCCH data"). As a result, some MS won't allow registering to the network. To avoid this kind of scenario, enable force-combined-si by default on nanoBTS while still allowing to overwrite the feature through VTY. Other BTS models are kept with force-combined-si disabled by default as usually, since they seems to be working fine when SI2ter is enabled. Related: OS#3063 Change-Id: Ide6e8967de0eedc9e2bcaf4414aaa537b009d72d
2018-11-16examples: Remove neighbor-list invalid for default setupPau Espin Pedrol2-10/+0
In default example network, there's no cells with those arfcn. Furthermore, having those seem to prevent some MS to register against nanoBTS configured by a BSC using those lines. Related: OS#3063 Change-Id: Iebe972da3a8442b6ded6d7f9e61a03b9144a843c
2018-09-13Install sample cfg file to /etc/osmocomPau Espin Pedrol1-0/+8
Change-Id: I87bc40fafa6269d99ccbfe49a61fc7ae4da62e80
2018-08-13doc: update mgw settings in example config filePhilipp Maier1-0/+1
The example config file lacks a default port setting for the local mgcp client port. Lets update that. Change-Id: I6b1c5097d98ec2ab97d51f99b1105db3de85c75f Related: OS#2874
2018-07-28doc: update/fix FSM chartsNeels Hofmeyr23-848/+816
These reflect the plan for refactoring, and will be implemented by I82e3f918295daa83274a4cf803f046979f284366 and Id7a4407d9b63be05ce63f5f2768b7d7e3d5c86fb Change-Id: I29e31b753e23a4207662e0e385a337e7df836f45
2018-06-08doc: charts: illustrate new plan for ts and lchansNeels Hofmeyr12-465/+1097
Add lchan and timeslot FSM charts to illustrate planning of how osmo-bsc should handle lchan assignment and release. Modify assignment, handover, lchan-release charts according to the new plan. Change-Id: I18d60de5ee932c962aad0a532965a55d570bb936
2018-06-08doc: add ms-channel-request.mscNeels Hofmeyr2-0/+64
Change-Id: Iab22b8ae85a1a54d2f4002733e6068356368101b