aboutsummaryrefslogtreecommitdiffstats
path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
2024-02-08tweak example osmo-msc.cfg: 001 01Neels Hofmeyr1-2/+2
We have support for leading zeros there, so let's show it off. Change-Id: I96c3495d0ab098535e34915f13979fb82b2e85cb
2023-12-01Use uniform log format for default config filesAndreas Eversberg3-0/+24
Related: OS#6272 Change-Id: Ic710873f9203414b343b216097785cef36ca05a9
2023-10-30manuals: add section about the SGs interface.Philipp Maier3-9/+59
The SGs interface is currently only casually mentioned in the chapter running, even though the SGs interface is a prominent and often requested feature. Let's give the SGs interface its own section so that users can find the info about it quicker. Related: OS#6008 Change-Id: Ic7c17511ee19cb7f6d5069b27beb661ecb4b0be8
2023-06-08Write explicit role & sctp-role fields in ASP configurationsPau Espin Pedrol3-1/+12
Change-Id: I4901ea309cd5975117480642d068df3ca2f73662
2023-05-26UserManual: Include sigtran*.adoc from osmo-gsm-manuals.gitPau Espin Pedrol1-0/+4
They were only included in osmo-stp so far. Change-Id: I37e36e7919d6996a79533b62564c5d82908b57f7
2023-03-18do CN CRCX firstNeels Hofmeyr2-49/+49
In order to send the MSC's RTP endpoint IP address+port in the initial SDP, move the MGCP CRCX up to an earlier point in the sequence of establishing a voice call. Update the voice call sequence chart to show the effects. Though the semantic change is rather simple, the patch is rather huge -- things have to happen in a different order, and async waits have to happen at different times. The new codec filter helps to carry codec resolution information across the newly arranged code paths. Related: SYS#5066 Change-Id: Ie433db1ba0c46d4b97538a969233c155cefac21c
2023-03-09add voice_call_internal_mncc.mscNeels Hofmeyr2-0/+130
Same as voice_call_external_mncc.msc, but run with internal MNCC. Shows some curious differences like the MNCC_LCHAN_MODIFY that internal MNCC sends, but external doesn't. Change-Id: Ic003322dc4e3fce24a8413688cfe18198a4dc08a
2023-03-09update doc/sequence_charts/voice_call_external_mncc.mscNeels Hofmeyr1-46/+47
Re-run the msc_log_to_ladder.py on an actual 2G-2G voice call log, to see if anything changed in the meantime, to prepare for upcoming changes to the sequencing of establishing voice calls. Also shows recent improvements on picking up RTP ports from MGCP and MNCC. Change-Id: I9dcf980ad24d5921c291c9aada211b37f6f3db7f
2023-03-09charts: Rename voice_call_full.msc to voice_call_external_mncc.mscNeels Hofmeyr2-1/+1
Because I will soon add an _internal_mncc one as well. Change-Id: Ic90a93d749ea936a632a45e615007a58104eeedd
2023-03-09msc_log_to_ladder.py: various tweaksNeels Hofmeyr1-18/+47
(multiple changes in one patch because who cares about this script) tweak regexes -- they worked ok, but some of the '[^:]' should really be '[^:)]', and they also look happier that way. don't skip RAN=NONE, so we also see messages before Complete Layer 3. s/sip/mncc, to generally be valid for both internal and external MNCC. pick up RTP port information from MGCP OK pick up RTP port information from MNCC rx and tx add --verbose flag, to be able to check whether the regex rules are still working (getting any hits). fix rule_imsi_detach: should return True to be counted in --verbose. tweak comment 'Generated by...' to include the full git path. Change-Id: If619182ba76c6b238a1fa105a3c3449d7f473dd1
2023-03-09make: doc/sequence_charts: use wildcards for EXTRA_DIST and CLEANFILESNeels Hofmeyr1-8/+2
Both EXTRA_DIST and CLEANFILES had missing entries. It is easy to forget to keep them up to date. Rather use wildcards to always pick up all relevant files. (Not adding *.dot because there are no .dot charts here, yet.) Change-Id: I3a18e4608a310169d7c9cd9c1b8ac9015a990920
2022-10-20doc: Include mgwpool.adoc from osmo-gsm-manualsPau Espin Pedrol2-0/+5
This way we document the recently gained support for MGW pooling. Related: SYS#5987 Depends: osmo-gsm-manuals.git Change-Id Ieda0d4bfe6fc90da6e19c791d8ec2da89427ba3b Change-Id: I9d8116a74a63591599c4cbafa60f9a313e6ab19c
2022-10-19Use new mgcp-client VTY commands under mgw nodePau Espin Pedrol4-12/+12
New VTY commands have been added recently to the "mgw" node which drop the redundant "mgw" prefix on each fo them. Change-Id: I8ac11388e9493416b644812638e1374251725584 Depends: osmo-mgw.git Change-Id: Id55af13d2ecde49d968b9dca6a2f8108a17ec484 Related: SYS#5987
2022-10-19Introduce support for libosmo-mgcp-client MGW poolingPau Espin Pedrol4-13/+28
Large RAN installations may benefit from distributing the RTP voice stream load over multiple media gateways. libosmo-mgcp-client supports MGW pooling since version 1.8.0 (more than one year ago). OsmoBSC has already been making use of it since then (see osmo-bsc.git 8d22e6870637ed6d392a8a77aeaebc51b23a8a50); lets use this feature in osmo-msc too. This commit is also part of a series of patches cleaning up libosmo-mgcp-client and slowly getting rid of the old non-mgw-pooled VTY configuration, in order to keep only 1 way to configure libosmo-mgcp-client through VTY. Related: SYS#5091 Related: SYS#5987 Change-Id: I7670ba56fe989706579224a364595fdd4b4708ff
2021-11-12Do not mention deprecated -l / --database optionsVadim Yanitskiy1-3/+1
Change-Id: I47fe7e64126710db34c49f48ea9e8f8d46662e4b
2021-11-12Do not mention deprecated -M / --mncc-sock-path optionsVadim Yanitskiy1-6/+1
Change-Id: I34387f561446aa5bf5db5264f0aca6bf6469d0e5
2021-11-12manuals: remove deprecated -C / --no-dbcounter optionsVadim Yanitskiy1-4/+1
Change-Id: I0a7bc537ed84c5f3e203d106893b1cf1ee8b599a
2021-08-03running.adoc: add section about MGCP configurationPhilipp Maier1-0/+18
The manual seems to lack a section about how the MGW is set up. In the osmo-bsc manual we have a "Configure MGCP to connect to an MGW" section under the "Configure primary links" section. We should have the same thing in the osmo-msc manual as well. Change-Id: I5501739e63860c436ff606bc2758b495258cd2b9 Depends: osmo-mgw I47e7ff858d5067b46d52329be5f362ff61c0dff8
2021-07-28add sequence_charts/call_reestablishment.mscNeels Hofmeyr2-0/+35
Change-Id: I6ebc3a0555ef82e1c027ca75b45f8147a3e07ee6
2020-08-20Support setting rt-prio and cpu-affinity mask through VTYPau Espin Pedrol1-0/+2
Change-Id: I40cf8a86961c1e350b5cd74d6e2cf64a22b7a2b1 Depends: libosmocore.git Change-Id If76a4bd2cc7b3c7adf5d84790a944d78be70e10a Depends: osmo-gsm-masnuals.git Change-Id Icd75769ef630c3fa985fc5e2154d5521689cdd3c Related: SYS#4986
2020-07-12manuals: generate vty reference xml at build timeNeels Hofmeyr2-3254/+5
Move 'doc' subdir further down to "make sure" the osmo-msc binary is built before the docs. Remove msc_vty_reference.xml from the source tree. In manuals/Makefile.am use the new BUILT_REFERENCE_XML feature recently added to osmo-gsm-manuals, and add a build target to generate the XML using the new osmo-msc --vty-ref-xml cmdline switch. Depends: I613d692328050a036d05b49a436ab495fc2087ba (osmo-gsm-manuals) Change-Id: Ib872e7979c5b5a9da1347a3f326307844cf76536
2020-06-03manual: link to new common cs7-config.adoc, remove some dup of thatNeels Hofmeyr2-23/+11
Related: OS#2767 Depends: Ia2508d4c7b0fef9cdc57e7e122799a480e340bf7 (osmo-gsm-manuals) Change-Id: Ie88dd2c7f7318a31ae04fbd6930346d92141fde5
2020-05-26manual: Multiple Instances: tweak MNCC, add missing SGs docNeels Hofmeyr1-3/+19
Change-Id: Ice610e3db132dc50b7ddc3f3e324e8ad1bba5864
2020-04-14doc: do not use random ip-address for MGWPhilipp Maier3-3/+3
The example configs suggest to use a random ip-address as MGW address. Lets use a loopback address here. This will suit the usual case where MGW and MSC run together on the same machine. Change-Id: Ie2b2094fdcfed45353d9ba22cb07eed626fd143c
2020-03-18manual: add missing mention of MGCP in "Multiple instances"Neels Hofmeyr1-0/+1
Change-Id: I91d06921e4dca08428bf45fc1a3fd6e124599371
2020-01-25libmsc: move subscriber expiration timer T3212 to libvlrVadim Yanitskiy1-16/+0
Since the split of OsmoNiTB, OsmoMSC does not deal with the radio access network directly. Therefore the only purpose of T3212 is to control subscriber expiration in the local VLR. The timeout value indicated in System Information Type 3 needs to be configured separately in the BSC/RNC. This means that we don't need to store it in deci-hours anymore. Let's move T3212 to the group of VLR specific timers, so it can be configured and introspected using the generic 'timer' command, and deprecate the old '[no] periodic location update' command. It should be also noted that in the old code subscriber expiration timeout was actually set to twice the T3212 value plus one minute. After this change, we apply the configured value 'as-is', but keep the old behaviour for 'periodic location update' command. Change-Id: I9b12066599a7c834a53a93acf5902d91273bc74f
2020-01-25libvlr: use generic osmo_tdef API for T3250, T3260, and T3270Vadim Yanitskiy1-3/+6
These timers so far were implemented as a list of unsigned integers, which has never been initialized to any reasonable defaults. Since they are used as state timeouts in several FSMs, we might end up staying in some state forever. Let's migrate to generic osmo_tdef API and use default values from table 11.2 of 3GPP TS 24.008. This way the user can introspect and change their values from the VTY / configuration file. Change-Id: Ia8cf98da0aea0e626c5ff088a833d7359c43847f Related: OS#4368
2020-01-25VTY: add osmo_tdef introspection and configuration commandsVadim Yanitskiy1-0/+40
This change introduces several new VTY commands letting the user a possibility to introspect and reconfigure some of the existing timers implemented using libosmocore's osmo_tdef API. At the moment this covers the following timers: - MGW specific timers: - X1 - MGCP response timeout, - X2 - RTP stream establishing timeout, - RAN specific timers (same names for GERAN and UTRAN): - X1 - Authentication and Ciphering timeout, - X2 - RAN connection release sanity timeout, - X3 - Handover procedure timeout. The following commands are introduced: - 'enable' node: - show timer [(mgw|mncc|sccp|geran|utran|sgs)] [TNNNN] - 'config-msc' node: - timer [(mgw|mncc|sccp|geran|utran|sgs)] [TNNNN] [(<0-2147483647>|default)] Both MNCC and SCCP related timer definitions are empty at the moment. Achieved by using osmo_tdef_group API of libosmovty. Change-Id: I6024c104b6101666c8aa1108a043910eb75db9a5 Related: OS#4368
2020-01-25VTY: mark 'subscriber create imsi' command as deprecatedVadim Yanitskiy1-16/+0
Neither it should appear in the interactive VTY nor in documentation. Change-Id: I208faab69a40948af5d081edbeaf75f586dfb2e4
2020-01-18manuals/vty: update the VTY reference to reflect recent changesVadim Yanitskiy1-37/+439
Change-Id: I14a5c9adff649406b4a079a75f86167ae6b95db4
2019-12-02counters: polish documentation of cm_service_request / paging_respVadim Yanitskiy1-4/+4
Change-Id: I273bc4165c70cd54ed94ff5f99377189f3306f51
2019-12-02counters: clarify documentation for MSC_CTR_CALL_* entriesVadim Yanitskiy1-7/+7
Change-Id: Iad1ef917a229c3be51bd8fbe155f009f81e7d72a
2019-12-02counters: clarify documentation for MSC_CTR_LOC_UPDATE_* entriesVadim Yanitskiy1-6/+6
Change-Id: I4f4a0d644db0a2dd7c8eefd846ea6913c0b780ce
2019-12-02counters: clarify documentation for MSC_CTR_SMS_* entriesVadim Yanitskiy1-6/+6
Please note that counter "sms:delivered" assumes "Delivered MT SMS", but actually counts total number MT SMS delivery attempts. This change describes its _actual_ (erroneous) behaviour. Change-Id: I081cf962ce2658ceab02699f3cdee19658d00939 Related: OS#4273
2019-12-01manual: Fix copy+paste errorHarald Welte1-1/+1
Change-Id: I2c03d8424c218155dae9038dd7cc5660a290c5c8
2019-11-19Fix some typosMartin Hauke3-3/+3
Fix typos and common misspellings in code comments and log messages. Change-Id: Ie66b89065f2100c1d2125ce5a6c9b1d58df7c8ad
2019-11-01charts: add full MO and MT voice call diagramNeels Hofmeyr2-1/+126
Add voice_call_full.msc, generated from a real 2G<->3G voice call log fed to msc_log_to_ladder.py. The idea is to document how the voice call sequence of events changes in upcoming patches. Change-Id: I8a907d6a4ece1f3ad78da75a8c3e3e76afd5418d
2019-11-01add msc_log_to_ladder.pyNeels Hofmeyr1-0/+724
Add script that reads in an osmo-msc log output and extracts the interesting information for displaying a sequence chart of voice call log, in mscgen format. I want to visualize how the sequence of messages changes across patches. It is error prone to do it manually, and re-doing the sequence chart for every patch (and patch rework) would be prohibitively time consuming. Change-Id: I2e4d8778f7b83dee558517a9b23450b817ee325d
2019-08-13add 'encryption uea 1 2' cfg / fix ttcn3 iu testsNeels Hofmeyr1-6/+17
Recently, the ability to run UTRAN without encryption was added, but the config for it was tied to the A5 GERAN encryption configuration. This affected osmo-msc's default behavior of Iu, breaking osmo-msc ttcn3 Iu tests: the ttcn3 test suite sets A5 to 0 (no encryption) but still expects Iu to enable air encryption. Fix this "regression". Add a separate vty config option for UEA encryption, even if it does not provide full granularity to select individual UEA algorithms yet. As a result, Iu default behavior remains to enable encryption regardless of the A5 config. UTRAN encryption can be disabled by the new cfg option "encryption uea 0" alone. Even though the new vty command already allows passing various combinations of the UEA algorithm numbers, only '0' and '1 2' are accepted as valid combinations, to reflect current osmo-msc capabilities. Revert most changes to the msc_vlr test suite in commit "do not force encryption on UTRAN" (I04ecd7a3b1cc603b2e3feb630e8c7c93fc36ccd7): use new net->iu_encryption instead of net->a5_encryption_mask. Adjust/add to test_nodes.vty transcript tests. Related: OS#4144 Change-Id: Ie138f2fcb105533f7bc06a6d2e6deccf6faccc5b
2019-08-05doc/sequence_charts: fix naming of mncc_fsm to mncc_callNeels Hofmeyr2-14/+14
mncc_fsm.[hc] were renamed to mncc_call.[hc] during patch review, which failed to carry through to this sequence chart. Also fix the MNCC_ST_* to MNCC_CALL_ST_* and MNCC_EV_* to MNCC_CALL_EV_*. Change-Id: I03ee1b43ab95dca3c43fdb9e92dc158aad5a4203
2019-08-05doc/sequence_charts/mncc_fsm.msc: add SIP messages, tweakNeels Hofmeyr1-35/+55
- add SIP messages, taken from OS#1683 - change some wording and clarify some message ordering - have a separate sipcon1 and sipcon2 for the MO and MT sides Change-Id: I6782e416dbd8ee88d093cbef722b0c5084f3865c
2019-08-05do not force encryption on UTRANNeels Hofmeyr1-1/+5
Remove the conditions that always enable encryption on UTRAN. We so far lack an explicit configuration for UTRAN encryption, and this patch does not add any either. Instead, whether UTRAN encryption is enabled is simply triggered on whether GERAN has A5 encryption enabled (A5/n with n > 0). Though GERAN and UTRAN encryption are not technically related at all, this makes UTRAN behave like GERAN for now, until we implement a proper separate configuration for UTRAN encryption. Adjust the msc_vlr_test_* configuration by setting the net->a5_encryption_mask such that the expected output remains unchanged. A subsequent patch (I54227f1f08c38c0bf69b9c48924669c4829b04b9) will add more tests, particularly cases of UTRAN without encryption. Adjust manual and vty doc. Related: OS#2783 Change-Id: I04ecd7a3b1cc603b2e3feb630e8c7c93fc36ccd7
2019-08-05manual: adjust and fix auth and ciph docsNeels Hofmeyr1-14/+54
Change-Id: Iffe159d4c0e0e9439f8719e0ddd28f06d4c80d9f
2019-07-25doc: Add Osmux documentation to User ManualPau Espin Pedrol2-1/+67
Depends: osmo-gsm-manuals.git f3a734e6777a902abfb03257277454c7a879aeb7 Change-Id: I70c488c3d9b05599b834a8608e6361c8aa43ef31
2019-07-16fix spelling detected by lintianThorsten Alteholz1-1/+1
Change-Id: I01e54b5cf111677079a8ad57645d3ceb7834702a
2019-06-18manuals: Include overview chapter about countersDaniel Willmann1-0/+2
Change-Id: I8c3e8bcda27f35118ab0e3d75621a02eec86f15c
2019-06-18manuals: Update counter/vty documentationDaniel Willmann2-28/+199
Change-Id: I1ef0e8ae166d7fdc5e85716a961e8387d26bdd2c Related: OS#1700
2019-06-18manuals: Add script to update vty/counter documentation from dockerDaniel Willmann2-0/+18
Change-Id: I3f5573f81460b40d4606fbcf0febcfd078a7bdca Related: OS#1700
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: Iafa9fba60b3ad4478ec24d6ba8538ec80ce99f52
2019-05-15remove msc specific db countersAlexander Couzens1-2/+2
DB counters has been used to save osmo_counters & osmo_rate_ctr to a local sqlite databases every 60 seconds. This is quite slow e.g. 1000 subscriber might slow the msc down. Change-Id: Id64f1839a55b5326f74ec04b7a5dbed9d269b89c
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-26 14:54:48 +0000