aboutsummaryrefslogtreecommitdiffstats
path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
2021-01-07manual: Fix typo OsmTRX -> OsmoTRXHarald Welte1-1/+1
Change-Id: I4b3a76e41d4abbb08046a241ae9b7c079ce990ae
2020-11-04doc/manuals: generate XML VTY reference at build-timeVadim Yanitskiy4-1411/+64
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: I798ea3b7417b8ca3e9c7d50911158c5413526237 Depends: I6aac73d998c5937894233631e654a160d5623198 Related: SYS#4937, SYS#4910
2020-10-14Calculate RSSI offset based on RxGain configurationPau Espin Pedrol1-3/+0
Prior to this patch, osmo-trx relied totally on proper VTY configuration being set in "rssi-offset" together with the RxGain set through TRXC in order to provide correct Uplink RSSI measurements to bts-trx. With this patch, RSSI is now by default calculated (in LMS and UHD backends) based on the currently set RxGain, by providing empirically discovered values. Still, for backward compatibility, the old "rssi-offset" command will overwrite completely the per-default calculated rssi offset. A new optional parameter "relative" is added at the end of the "rssi-offset" VTY command to flag the value as relative to the newly per-default calculated value. This way specific setups (like adding a LNA / RF fronted) can still be expressed while still keeping the automatic per-default offset. Related: OS#4468 Change-Id: I8ef78fd20c22c60d61bfb18d80a4a36df4fd6c20
2020-08-25osmo-trx-ipcEric Wild2-0/+36
This adds a IPC backend that uses shared memory interface to communicate with (proprietary) devices. Requires config file option dev-args ipc_msock=/path/to/socket to specify the master socket the ipc backend should connect to. If UHD is avaialble the ipc-driver-test tool can be used to test the backend with a uhd device, this was so far only tested with a b2xx. Change-Id: Ice63d3499026293ade8aad675ff7a883bcdd5756
2020-07-31Use new libosmovty cpu sched config featuresPau Espin Pedrol5-5/+10
Using the new libosmovty features allow for: * Setting different cpu-affinity masks for each thread in the process, both at startup through .cfg file as well as changing it at runtime. * Unified VTY interface to change the scheduling policy of the process inherited by all osmocom processes enabling the feature. Depends: libosmocore.git Change-Id If76a4bd2cc7b3c7adf5d84790a944d78be70e10a Depends: osmo-gsm-masnuals.git Change-Id Icd75769ef630c3fa985fc5e2154d5521689cdd3c Related: SYS#4986 Change-Id: I3798603779b88ea37da03033cf7737a6e4751d6e
2020-07-01doc/manuals: Update thread documentation after dropping CTRL sock threadsPau Espin Pedrol1-10/+5
Per-ARFCN CTRL threads managing CTRL socket loops were dropped a while ago, but it was forgotten to udpate the documentation. Change-Id: I34d117325e60b04b075c205d21bb0b827a5e8c52
2020-05-23doc: switch log levels to noticePhilipp Maier4-4/+4
Some of the example configs have loglevels set to info. This is too verbose, lets make sure all loglevels are set to notice Change-Id: Ief82b85d9ff0e0e94eaabd255ebea961396fff32
2020-04-14doc: apply an rssi-offset of 28 by default.Philipp Maier1-0/+3
Set an rssi offset of 28 in the example configs to make sure that the power control loop gets RSSI values that match at least half way the reality when the 1800 Mhz band is used. For other bands the value will be different (See also related osmocom ticket) Change-Id: I62725fe454f54e2c7cb7550dadb1e6fc94337d78 Related: OS#4468
2020-04-01doc: do not set the base-port of the trxPhilipp Maier4-4/+0
In current config files a base port for osmo-trx is set. Lets remove this setting so that compiled-in default (which is the same value) is used. Change-Id: I105d1c51424836daa6893e83a81c83cc7ac6afd4
2020-01-07doc: Update vty reference xml filePau Espin Pedrol1-46/+135
Change-Id: Ib2707204cbba6df813ffc08d7098093cf4393da0
2020-01-07doc: clarify number of channels on B210 with multi-arfcn enabledPau Espin Pedrol1-4/+5
Change-Id: I082d4d8c346f1be1569fe63baa856029e439cb2c
2019-10-17Fix common misspellings and typosMartin Hauke3-3/+3
Change-Id: I4ec7accb1912c052b446be7c399bed32a8c62253
2019-08-01Move Transceiver52/README to UserManualPau Espin Pedrol1-0/+27
Change-Id: Ib5a56cfe0c27d027bc0c60abda89e646a80849de
2019-08-01Move inband-signaling-usb documentation to UserManualPau Espin Pedrol2-0/+305
Change-Id: I4d6ef1f54f3d6c5a73ce00dc4640bd698f96842b
2019-08-01lms: Drop rx_underruns rate ctr, add tx_drop_* rate ctrPau Espin Pedrol2-14/+25
After discussion in [1] and further look at the code, it became obvios rx_underrun events are not happening in general for any SDR (don't exist), so let's drop that counter. Instead, add Tx Dropped Packet counters, which were not accounted prior to this commit. [1] https://github.com/osmocom/osmo-trx/commit/bde55afd29fc9aae10eb11f6515821afa39b772d Change-Id: Iff1535c219a4695a511d383d7c4b06ef6eff959d
2019-07-24manuals/configuration.adoc: fix copy-paste error in config exampleVadim Yanitskiy1-1/+1
Change-Id: If9de32eed8170038c8c177c8996c78846dddb624
2019-06-17Add option to set stack size in config file, default == 0 == OS defaultEric Wild1-0/+6
Change-Id: Id752f6b5ce9a96a67cd1ff835687ce0e03d3a50d
2019-06-11Add VTY commands to set error ctr thresholdsPau Espin Pedrol3-4/+104
osmo-trx will validate over time that those thresholds are not reached. If they are reached, osmo-trx will die. As a result, osmo-bts-trx will notice and will end up notifying the BSC about it (for instance because it will also restart its process). For instance: """ ctr-error-threshold rx_drop_events 2 minute ctr-error-threshold rx_underruns 10 second """ In those cases above, osmo-trx will die if rate_ctr rx_drop_events went to a value higher than 2 per minute, or it will die to if rx_underruns went higher than 10 per second. Change-Id: I4bcf44dbf064e2e86dfc3b8a2ad18fea76fbd51a
2019-06-05doc: vty: Update trx_vty_reference.xmlPau Espin Pedrol1-43/+138
Change-Id: I2587cd47ee48e979de447f7a0f4d79bb5fac0592
2019-05-29debian: 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: I34858a18a34fc467f274ac164697a242f4cf0df8
2019-04-11doc/configuration.adoc: fix incorrect number of physical RF channels for B210Vadim Yanitskiy1-1/+1
Change-Id: I58e2bf5dd99e1655ebd2ad80f6ed2bb178f0e88d
2018-11-27build manuals moved here from osmo-gsm-manuals.gitOliver Smith5-29/+36
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: I2762171af0bf719a34ba12a0c2e4dcc206098beb
2018-11-27Merge history from osmo-gsm-manuals.gitNeels Hofmeyr16-0/+1820
2018-11-27osmotrx: Introduce code architecture chapterPau Espin Pedrol2-0/+143
Change-Id: I21084e6315d79a1adcb305e12343da218837dc31
2018-11-27osmotrx: Create a common chapter for section documenting backendsPau Espin Pedrol1-3/+6
Change-Id: I6bea1ccca4ce72b92641a36f9f5894ac9a6cae72
2018-11-27osmotrx: configuration: Add section to document multi-arfcn featurePau Espin Pedrol1-0/+49
Change-Id: Id04c7f7c36d8a8be8145ef8009ece26ef1a7cdff
2018-11-27osmotrx: Write initial documentation for several supported devicesPau Espin Pedrol2-1/+68
Change-Id: I902b01ca661416eb9705afac8a34ec8d2fb13789
2018-11-27osmotrx: Split Device specific section from backend onePau Espin Pedrol3-26/+27
Device specific sections will be added to this new chapter. Change-Id: Id96cbf857e2ef92d9ad2cb58fd18132f981447d7
2018-11-27trx: Add Hardware device support sectionPau Espin Pedrol2-0/+69
Change-Id: I87fc54cf1751f31a3e92d6503625e984f9a6130f
2018-11-27trx: Add Hardware architecture support sectionPau Espin Pedrol2-0/+36
Change-Id: I38388bcb2ea7c0481052d3bca589cb34965ea7fa
2018-11-27trx: Add reference to project wiki page in overfiew sectionPau Espin Pedrol1-0/+3
Change-Id: I83cbd67909c42f4ed4857834e23c07ad4e2e22aa
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-0/+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-27Introduce OsmoTRX manualPau Espin Pedrol12-0/+1447
Change-Id: I19ee9d6cda02fb7200c96c0ac129e69825b096cd
2018-10-05examples: Use logging level 'set-all' instead of 'all'Pau Espin Pedrol4-4/+4
Change-Id: Ic52ce0defc774acb8e24947ed22cf2a56b8b0bb0
2018-09-25ensure well-formed example config filesHarald Welte4-24/+24
Change-Id: I9be2bab3b88a96e94e463e5ab22f9814bd6de950
2018-09-12Install sample cfg file to /etc/osmocomPau Espin Pedrol3-1/+22
Change-Id: Ib871a3cd14386ef6e6b512a3d66e7e7a839295a5
2018-06-19debian: Add cfg file examples for osmo-trx-{lms,uhd}Pau Espin Pedrol6-0/+47
Sort cfg files according to their osmo-trx binary. Install them during make install. Add the installed cfg files to related debian packages. Change-Id: I905cdac30b441e4df0a3f5c0924d1637b9f67b90
2018-06-12examples: Set rt-prio 18 and print file basenamePau Espin Pedrol3-0/+5
Change-Id: I16fbdd46f2d9b6f3e79a4bb357f6a7fbed14244a
2018-05-04doc: examples: Add umtrx sample configPau Espin Pedrol1-0/+22
Change-Id: Id38de0bbbe75e5e6bbb0de2eecb7d1984786d528
2018-05-02doc: add example config for usrp B200 seriesPhilipp Maier1-0/+20
Change-Id: I1a80ddd9ca9b143e9c89618616f30fe3f3547d7b
2018-03-05doc: Add sample cfg file for LimeSDRPau Espin Pedrol1-0/+20
Change-Id: I16de70eac0fd79107b8317af37201e6da834c169