aboutsummaryrefslogtreecommitdiffstats
path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
2019-11-19osmo-bts-virtual.cfg: ms-power-control dsp -> osmoOliver Smith1-1/+1
Fix error while starting osmo-bts-virtual with the example config: "This BTS model has no DSP/HW MS Power Control support" Fixes: c693067b7e99a643da673cb3e2a36162cbd0f59c ("Introduce BTS feature BTS_FEAT_MS_PWR_CTRL_DSP") Change-Id: I4f9a06e85d58294719a24197eb1c42a69fbd03d6
2019-10-17Fix common misspellings and typosMartin Hauke7-87/+87
Change-Id: I403b9029f57fec3fdec2c1e2cbeac0f6eab53f24
2019-09-19doc: bts-models.adoc: Fix typos in rts-advance sectionPau Espin Pedrol1-2/+2
Change-Id: I37ba104ec0538f8eb9345ff880660aefbdaa44ca
2019-09-07doc: Update Abis manual RSL section with ETWS related infomrationHarald Welte1-0/+48
Change-Id: I969153a204c167783ba394c9a911ff4484ded759
2019-07-24manuals: Update vty documentationDaniel Willmann1-1633/+1742
This documentation only includes commands for osmo-bts-virtual Change-Id: Icc0c96d173f31f2eb5fcb6385525a17f94ead852 Related: OS#1700
2019-07-21Clarify and refactor link quality (C/I) handlingVadim Yanitskiy1-4/+4
The radio link quality is defined by C/I (Carrier-to-Interference ratio), which is computed from the training sequence of each received burst, by comparing the "ideal" training sequence with the actual (received) one. Link quality measurements are used by L1SAP to filter out "ghost" Access Bursts, and by the link quality adaptation algorithms. One can define minimum link quality values using the VTY interface. On the VTY interface we expect integer C/I values in centiBels (cB, 10e-2 B), while the internal structures are using float values in deciBels (dB, 10e-1 B). Some PHYs (sysmo, octphy, oc2g, and litecell15) expose C/I measurements in deciBels, while on the L1SAP interface we finally send then in centiBels. Let's avoid this confusion and stick to a single format, that will be used by the internal logic of OsmoBTS - integer values (int16_t) in centiBels. This will give us the range of: -32768 .. 32767 centiBels, or -3276.8 .. 3276.7 deciBels, which is certainly sufficient. Change-Id: If624d6fdc0270e6813af8700d95f1345903c8a01
2019-07-18manuals: Add counter documentationDaniel Willmann3-0/+72
Change-Id: I994ad6aae7f409e0f15ff1d388127e16243b378a Related: OS#1700
2019-06-19manuals: Add script to regenerate counter/vty documentationDaniel Willmann2-0/+18
This will generate the VTY/counter documentation for osmo-bts-virtual so it will be missing documentation for device-specific commands/counters. Change-Id: Idebb099b69924d6212db119f7a2f2861d4150d7e Related: OS#1700
2019-06-03trx: Update documentation for fn-advance and rts-advanceHarald Welte1-2/+45
Change-Id: I83eff296bfb7acff9d8560b5346bd9791fe6e7d9 Related: OS#4036
2019-05-31debian: create -doc subpackage with pdf manualsOliver Smith1-0/+1
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: I6d7a182d0a668693a5014aca0edc50ada9ac0d0f
2019-05-24rsl: Implement parsing of BS Power Control messageHarald Welte1-1/+1
Change-Id: Id144a7e468f730e3cdaefa4cf2ad51c6106310a2
2019-05-24rsl.adoc: DELETE INDICATION is implemented since Feb '18Harald Welte1-1/+1
In the following commit, we introduced transmitting the RSL DELETE INDICATION on AGCH overflow: commit 19da7fdea8912831b19d9aeed51cd2226f342283 Author: Harald Welte <laforge@gnumonks.org> Date: Sat Feb 24 04:32:29 2018 +0100 So let's sync the manual with the code. Change-Id: I988778bdb83271355dc11b1a30a59e1a5dba5fb2 Related: OS#2990
2019-05-21manual: SMSCB BROADCAST COMMAND has no limitations anymoreHarald Welte1-13/+1
We meanwhile support the SMSCB Channel Indicator IE and hence can send SMSCB on both BASIC as well as EXTENDED CBCH Change-Id: I63cc9c8c4c8c80440a61a0687e1f0cb97cc723b7
2019-05-21manual: We now support RSL CBCH LOAD INDICATIONHarald Welte1-1/+1
Change-Id: Iad7c364863b4de34bcded9f3c1e737ae0ed8e407
2019-05-20Revert "debian: create -doc subpackage with pdf manuals"Oliver Smith1-1/+0
This reverts commit ad7b8bee71e78e5a046b65898e181b8c48be3974. Unfortunately the osmo-gsm-manuals-dev package isn't working properly yet, therefore osmo-bts fails to build on nightly OBS now. My apologies for not testing enough in my own OBS namespace, before merging. I'll do that in the future. I'm reverting the patch now, so osmo-bts isn't missing from the nightly repository until I've fixed the osmo-gsm-manuals package. Change-Id: I89c2b92c8ae6331d6fff95a378fb58d82059af13
2019-05-20debian: create -doc subpackage with pdf manualsOliver Smith1-0/+1
Related: OS#3899 Depends: I7edb5093e5b58eb3b0f7af2376476db4026db735 (osmo-gsm-manuals.git) Depends: Ideeae4f7846fa5626fe2c1f5a77e07a3c6e626fe (osmo-ci.git) Change-Id: I4c184c62804c0b805a0a2425a5bd0312e94e49ab
2019-01-30doc/examples: Install OC2G config files with autotoolsdaniel/oc2gDaniel Willmann1-0/+9
Change-Id: I2fd587e91b5e0e4cd1b8ffa781f65dbfd4484f19
2019-01-17Rename oc2g config file to match new naming schemeDaniel Willmann1-0/+0
examples/oc2g/osmo-bts.cfg->examples/oc2g/osmo-bts-oc2g.cfg Change-Id: Ie49d5695ea78da2995252c56c75ce42e6cec0e9c Related: SYS#4444
2018-11-27build manuals moved here from osmo-gsm-manuals.gitOliver Smith7-39/+52
Moved to doc/manuals/, with full commit history, in preceding merge commit. Now incorporate in 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: I728ebb56ade6dda079a0744c4e592284e1bea4f6
2018-11-27Merge history from osmo-gsm-manuals.gitNeels Hofmeyr38-0/+7041
Change-Id: Ib62d046bd84204b902cac3fe8c0765e32da0a0c6
2018-11-27OsmoBTS: Fix typoDaniel Willmann1-1/+1
Change-Id: I0a4c9f052f14816e88ed0a4a5fff9b3854da195a
2018-11-27OsmoBTS: 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-27bts: Fix typoPau Espin Pedrol1-1/+1
Change-Id: I47758acec07a587730552a9c46dc02976c807d9a
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-27Introduce chapter trx_if.adoc and add it to OsmoTRX and OsmoBTSPau Espin Pedrol1-1/+2
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-11-27OsmoBTS: bts-models: Add Lime Microsystems devices as supported osmo-trxPau Espin Pedrol1-5/+5
Also take the chance to remove uneeded extra whitespace in surrounding text. Change-Id: I739e4dfba7c649a74cf67d6bbe6f74b22e7e24f0
2018-11-27refactor Makefile build rules, don't use the FORCENeels Hofmeyr1-45/+7
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 Pedrol2-0/+4
All parts referencing GFDL can be easily disabled by removing the 'gfdl-enabled' attribute from the document. Change-Id: I2489726ad2e90301bceadfada926e31ae0f85986
2018-11-27update osmo-bts-virtual documentation, now that code is mergedHarald Welte1-12/+41
Change-Id: Icd8706d29ca0e96cb89b7736dbb62f9ce159382d
2018-11-27rtp-amr: Fix typo and trailing whitespacePau Espin Pedrol1-2/+2
Change-Id: I8efda2387e0e5e95700b070dab8f8dd427fa562d
2018-11-27rtp-amr: Describe requirement to recieve all PH-DATA.ind eventsPau Espin Pedrol2-35/+59
Change-Id: I4a78b3398c36a8107fa1809ba9b89235980f0e4f
2018-11-27OsmoBTS: Update osmotrx ip to diff between local and remotePau Espin Pedrol1-2/+8
Change Id of the code implementation: I0bd34b7b02c1a9b0c6f6f89f327b486e5620c8d5 Change-Id: Ia4c70b3b8436e2647fc35d579a302dfbf32a83f0
2018-11-27OsmoBTS/chapters/configuration.adoc: Add bts index in examplePau Espin Pedrol1-2/+2
Change-Id: If13643cdfa59c50b6af8ab0657635fed2ca219f0
2018-11-27Sync DTX FSM with OsmoBTS codeMax2-35/+70
Change-Id: I050a07db99bc0038cfd2a9646a450f714653d804
2018-11-27Describe how to run multiple instances of osmo-nitb and osmo-btsPhilipp1-0/+29
Change-Id: I69adeef85adda6f08b31b7d176f51e16968c1435
2018-11-27BSC,BTS: add diagrams of PCU-BTS-NITB-SGSN relationshipsIvaylo Kostov1-0/+26
Change-Id: I0eb09706efb768fa4f6810872fb6568cbc9838cb
2018-11-27dynamic timeslots: add BSC level config instructionsNeels Hofmeyr1-3/+6
Add high level description on and a config example for dynamic timeslots in a new chapter featured in the OsmoBSC and OsmoNITB manuals. From the OsmoBTS manual's chapter on dynamic timeslots, add references to the above. Change-Id: I44ff1e4c2340c65ff23e85408fc6d6a45ea9e046
2018-11-27Add DTX implementation details to RTP AMRMax3-0/+102
Add FSM and description. Change-Id: Ib37cb6e4038f970070c1715269961db7172ce377
2018-11-27Move RTP AMR doc to top levelMax3-1/+49
Add it to Makefile with proper docinfo so it's build automatically alongside with other documentation. Change-Id: Iacd7fadc003ce0f9ffd20aa5b36c7d598b04f882
2018-11-27rtp-amr.adoc: Fixes to Message Sequence ChartsHarald Welte1-71/+188
Nutaq added these clarifications/extensions/fixes tothe message sequence charts. Change-Id: Ic699bda828947ff616c3d80783026e21d853f962
2018-11-27rtp-amr.adoc: New TCH/AHS downlink chaptersHarald Welte1-4/+107
Nutaq contributed the following chapters: * TCH/AHS Downlink: FACCH/H During DTX Operation * TCH/AHS Downlink: Inhibited SID_UPDATE * TCH/AHS Downlink: Inhibited SID_FIRST_P1 Change-Id: I55d8e9f98694b39514d1f31c517a80050103fdd6
2018-11-27rtp-amr: TCH/AHS Uplink: FACCH/H During DTXHarald Welte1-1/+48
New chapter contributed by Nutaq: * TCH/AHS Uplink: FACCH/H During DTX operation Change-Id: I4a9c58e02dcfeb388ff3a30ba321ea3cec325518
2018-11-27rtp-amr.adoc: TCH/AFS Downlink: InhibitingHarald Welte1-4/+85
Add two new chapters contributed by Nutaq: * TCH/AFS Downlink: Inhibiting a SID_FIRST frame * TCH/AFS Downlink: FACCH/F During DTX Operation Change-Id: Ic39d035f9d17bd0634c2df78ae3359a5eb7dfd46
2018-11-27rtp-amr.adoc: TCH/AFS UplinkHarald Welte1-12/+119
Add new chapter by Nutaq for Speech Frame Following a SID_FIRST frame Change-Id: Ib7cfb07525ea311d9dac051a6e139b0ae0549504
2018-11-27Documentation on AMR RTP in case of DTXHarald Welte1-0/+858
Change-Id: I394f405b441c1eb000759151bd8350d5b3a84a0b
2018-11-27fix build: abis: re-add dependenciesNeels Hofmeyr1-0/+1
Below commit accidentally removed osmobts-abis.pdf from the Makefile entirely. The pdf was re-added, but the dependencies are still missing, so that osmobts-abis.pdf is not rebuilt when abis/* is newer. Fix that. Culprit: 05f5adbe837f2cbfb9301cdb8c9b454ca0bfc825 "OsmoBTS: add vty reference documentation" Half-fix: 707827196f0734eefa74ce0c35c2ab2fe754cc4c "OsmoBTS: generate osmobts-abis.pdf again" Change-Id: Id2ee8177cfb8eb58409d164bdd994ef5e86ad82b
2018-11-27OsmoBTS/abis/rsl: split dyn TS ladder diagrams to fit on pageNeels Hofmeyr5-46/+68
Split both of the lengthy mscgen generated ladder diagrams in two so that the diagrams are split over two pages and don't bleed into the page footer. Change-Id: If90250123a85cd275f07c69ee64c6e10a7269f06
2018-11-27OsmoBTS: generate osmobts-abis.pdf againAlexander Couzens1-1/+1
broken by 05f5adbe837f2cbfb9301cdb8c9b454ca0bfc825 Change-Id: I7ca18e3d7fa3a5a6eac0590b919b4c664f73671c
2018-11-27fix 'make clean': shell glob, ignore failureNeels Hofmeyr1-3/+7
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-27OsmoBTS/abis/rsl: combine separate dyn ts sectionsNeels Hofmeyr1-79/+77
There were two separate sections saying basically the same. Move the entire 'Dynamic Channel Combinations' section further above and combine with the 'IPA Style PDCH Management' section to avoid repetition. Change-Id: Ic370ba34de5cb14f0194ff8c8661e45d7ca98e2b