aboutsummaryrefslogtreecommitdiffstats
path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
2020-11-27rsl.adoc: update documentation for RSL_IE_OSMO_REP_ACCH_CAPPhilipp Maier1-4/+20
The recently added IE (RSL_IE_OSMO_REP_ACCH_CAP) has been extended with more options, update the documentation as well. Change-Id: I3d95da588e863185bb62e92898c285d52bce9af4 Related: SYS#5114, OS#4796, OS#4794, OS#4795
2020-11-10rsl.adoc: add info about RSL_IE_OSMO_REP_ACCH_CAPPhilipp Maier1-0/+10
The RSL documentation should reflect some explanatory info about the recently added RSL_IE_OSMO_REP_ACCH_CAP IE. Depends: libosmocore I61ea6bf54ea90bd69b73ea0f0f3dc19a4214207b Change-Id: I1d70846c2c184f7a189074c51137bc1f38fb3859 Related: OS#4796 SYS#5114
2020-11-05doc/manuals: move osmobts-vty-reference.xml to vty/Vadim Yanitskiy3-2/+1
This way we have everything VTY specific in a single directory. Change-Id: Iaba5c42b39fa764cd38c903486617c3d9f9cdebb Related: SYS#4937, OS#3036
2020-11-05doc/manuals: also generate VTY reference for osmo-bts-virtualVadim Yanitskiy1-1/+2
Change-Id: I12ac8cc13ce0caea2b63f94c407c01b4f00845e5 Related: SYS#4937, OS#3036
2020-11-05doc/manuals: generate XML VTY reference at build-timeVadim Yanitskiy4-2022/+71
Unfortunately, we cannot re-use the existing Makefile rules from: $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc because they do not allow to generate the list of $(DOCBOOKS) from a template, and require the project to store everything in separate folders with specific names. Also, those rules expect that the target PDFs contain only a single word in their names (for example, 'osmoapp-vty-reference', not 'osmo-app-vty-reference'), while in a project with multiple similarly named targets this would reduce readability (imagine 'osmotrxuhd-vty-reference'). Change-Id: Idba84164b90e3d183a20b5eb69cbfe15745e447c Depends: I6aac73d998c5937894233631e654a160d5623198 Related: SYS#4937, SYS#4910, OS#3036
2020-08-17osmo-bts-trx: Use much lower clock advance values towards PCU and TRXDaniel Willmann1-3/+2
osmotrx fn-advance (which is the clock_advance variable here) and osmotrx rts-advance together make up the minimum delay the BTS can react to a channel request, etc. The default of 20 are around 92ms which is clearly too much. With modern hardware and using SCHED_RR a lower value should not be an issue. See OS#4487 for some related measurements on more CPU-limited devices like a LimeNet-micro3. Fixes: OS#4487 Fixes: SYS#4885 Related: SYS#4881 Change-Id: I7da3d0948f38e12342fb714b29f8edc5e9d0933d
2020-08-10common: Support setting rt prio through new libosmovty sched VTY cmdsPau Espin Pedrol1-0/+2
We gain other features from libosmovty for free, like configuring cpu-affinity of the only thread in the process. Depends: libosmocore.git Change-Id If76a4bd2cc7b3c7adf5d84790a944d78be70e10a Depends: osmo-gsm-masnuals.git Change-Id Icd75769ef630c3fa985fc5e2154d5521689cdd3c Related: SYS#4986 Change-Id: Ice46e406b84fa11afcc7ba31e521e7677df73cf3
2020-07-28doc: configuration.adoc: Document ramping down featurePau Espin Pedrol1-0/+6
Change-Id: I3c7df0d914587bdde2aef9919f75d507a0e5884b
2020-06-16doc: Fix typos in bts-models.adocPau Espin Pedrol1-3/+3
Change-Id: I05c9eb9b0edda528363a16d27dbf683994d9ab62
2020-06-05doc/examples: remove virtual/openbsc-virtual.cfgVadim Yanitskiy2-153/+1
This is not the right place to ship configuration examples for other projects, and definitely not for abandoned ones. Change-Id: Ib165b16f948126df8023bb42ad5d6d4b2fc11e6a
2020-06-01doc: Update vty reference xml filePau Espin Pedrol1-4/+280
Change-Id: I26c6522e6b5b87030dde61afacd637ff38b12303
2020-05-31doc/manuals: fix typo in interfaces.adoc: s/Omsocom/Osmocom/gVadim Yanitskiy1-1/+1
Change-Id: I28d914f89a6de82a8e226a9772984cb0c9d8869a
2020-03-23osmo-bts-trx: do not set rx-gain to 1 by defaultPhilipp Maier2-2/+0
The sample configs supplied within the doc/trx directory set the rx-gain parameter to 1. A low value like this may cause a noticeable degration of rx performance (For an USRP B200 an rx-gain of 38dbm is recommended). Lets remove this seting from the sample configuration to allow the default settings in osmo-trx to be applied. Change-Id: I76be1739b638b3c1b0de5ac667eed53397631caa Related: OS#4467
2020-02-25cosmetic: Fix some typos with codespellPau Espin Pedrol1-2/+2
Change-Id: I1bbb4871f764816dcbba86d833194be601fa9228
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
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-25 07:59:08 +0000