Commit Graph

115 Commits

Author SHA1 Message Date
Oliver Smith 92cf519c8d GSUP: document inter-MSC handover additions
Message formats of the new messages look mostly the same (IMSI,
Message Class, Source Name, Destination Name, AN-APDU). That is, because
AN-APDU is storing results, error reasons etc. This can be seen clearly
in osmo-msc.git:
* src/libmsc/msc_a_remote.c:msc_a_remote_fsm_communicating()
* src/libmsc/msc_i_remote.c:msc_i_remote_fsm_ready()

The message squence charts in the E Procedures section are directly
based on Neels' interMSC_HO_GSUP_msgs.txt [1].

It seems that using AN-APDU made some other new IEs redundant: RR Cause,
BSSAP Cause, Session Management Cause had been added to GSUP for the MSC
handover, and are documented now, but they are currently not used in
osmo-msc.git. The new message OSMO_GSUP_MSGT_E_ABORT is not used either,
so I left a stub for it in the message format section.

I mentioned in the Source Name IE section, that source and destination
names are sent as nul-terminated strings. This is for legacy reasons,
Neels wrote a nice summary in the commit message of [2].

[1] https://osmocom.org/attachments/3720/interMSC_HO_GSUP_msgs.txt
[2] Change-Id: I9ca8c9eef104519ed1ea46e2fef46dcdc0d554eb (osmo-msc)

Related: OS#3774, OS#3619
Change-Id: I6b9f23d08cfe53c8b77f51c6afb900c2badc9e2c
2019-05-21 10:30:38 +00:00
Harald Welte 5c1ac995db port_numbers: Add VTY + CTRL port of upcoming OsmoCBC
Change-Id: I57d88f2bddedb7a97c3fc7bacfe978ed4557c4bf
2019-05-08 15:49:50 +02:00
Daniel Willmann 37a7ce7f1d Change VTY samples from OsmoNITB to OsmoMSC
Change-Id: I9fb3c43ea56087900eee4427f1ae50a7c9e84698
Related: OS#2299
2019-04-15 16:47:18 +02:00
Daniel Willmann 95be64fc37 Add a chapter to explain our different counters
Change-Id: I01b8529136450cb50e48b0fb5c17cb2daa5e24c3
2019-04-15 14:06:32 +00:00
Daniel Willmann ece90c1377 bts: Change VTY sample output from OpenBSC to OsmoBSC
Change-Id: Id473b625f47b3cf7ee10ced866d49eb678161719
2019-04-04 11:31:05 +02:00
Harald Welte 4c946ee293 fix typo: SIGTAN->SIGTRAN
Change-Id: I4b9ed7d61a23cf327889b3e513af74e8c86b161c
2019-03-13 07:59:41 +01:00
Oliver Smith 40c5c2827a chapters/gsup.adoc: move IMEI IEs to right place
Move the "IMEI" and "IMEI Check Result" IEs from the "Session
(transaction) management" chapter (which describes session IEs) to the
"Information Elements" chapter. Add a comment to prevent this mistake in
the future.

Related: OS#2541
Change-Id: I6fd66419350e018a763b8fac3daf567b339a2637
2019-02-22 13:20:11 +01:00
Harald Welte ac42b58909 chapters/gsup.adoc: add message sequence charts for SMS over GSUP
Change-Id: I9a0536f285f98f24fec4d7318f1923782ed2e18c
Related Change-Id: Ie0150756c33c1352bc4eb49421824542c711175c
Related Change-Id: I549b6c8840a1e86caac09e77fb8bc5042d939e62
2019-02-19 18:08:18 +00:00
Oliver Smith 68bbdc5f02 GSUP: message category indicated by last two bits
Make this part of the specification, so we can simplify libosmocore
code by knowing that error message is (request message | 0x000001).

Related: I46d9f2327791978710e2f90b4d28a3761d723d8f (libosmocore)
Change-Id: Iec1b4ce4b7d8eb157406f006e1c4241e8fba2cd6
2019-02-01 16:05:12 +01:00
Oliver Smith 2bca846fab common: extend glossary.adoc
Add EIR, IMEISV, LU, SS, TS, USSD, and VLR, clarify the difference
between IMEI and IMEISV.

Change-Id: I054a8599a78eb5e62ab7af914875e1c8a992af71
2019-01-21 15:08:39 +01:00
Oliver Smith 0f41399d36 chapters/gsup.adoc: document CHECK-IMEI
Related Change-Id: (core) I085819df0ea7f3bfeb0cabebb5fd1942a23c6155
Related: OS#3733
Change-Id: I51dd09cda3c595f1d252546285ced9f06c748617
2018-12-21 16:11:50 +01:00
Oliver Smith c7afad3f4e chapters/gsup.adoc: explain msg format columns
Explain the M, O, C and V, TLV letters in the presence and format
columns.

Change-Id: Idf8614d4d0f462174426fd3afdb34bedfb859951
2018-12-21 16:02:20 +01:00
Vadim Yanitskiy d1596fe75a chapters/gsup.adoc: document READY-FOR-SM message
Change-Id: I549b6c8840a1e86caac09e77fb8bc5042d939e62
Related Change-Id: (core) Ic37f3b2114b8095cfce22977e67133b9103942e3
Related Change-Id: (TTCN) If2256607527ecfcb10285583332fb8b0515d7c78
Related: OS#3587
2018-12-18 00:52:05 +07:00
Vadim Yanitskiy f26967aad5 chapters/gsup.adoc: document MO-/MT-forwardSM messages
Change-Id: Ie0150756c33c1352bc4eb49421824542c711175c
Related Change-Id: (core) Ibe325c64ae2d6c626b232533bb4cbc65fc2b5d71
Related Change-Id: (TTCN) Ibf49474a81235096c032ea21f217170f523bd94e
Related: OS#3587
2018-12-18 00:51:47 +07:00
Vadim Yanitskiy 01814068be chapters/gsup.adoc: fix direction for SS messages
Most likely, this was a copy-paste error. SGSN is not involved
in Supplemeptary Services handling, they are pure CS data.

Moreover, HLR is not the only entity that can initiate both
Process Supplementary Service Error and Response messages,
there is also EUSE (External USSD handling Entity).

Change-Id: I46ad7311747f2b392244c49d3df1e152e6f1bfe3
2018-12-03 07:40:14 +07:00
Max b9bf09ec19 ctrl: clarify use of id = 0
Change-Id: Ic00de5023e7a1ec6426a0178778d35b13c337271
2018-11-26 10:50:42 +01:00
Oliver Smith dc7c08ea08 *.adoc: include from ./common, not ../common
Change hardcoded ../common paths, which will break when moving the
project specific manuals in other repositories, to ./common so they
use the dynamically created symlink that always points to the right
path.

(moving manuals to project repositories 8/19)

Related: OS#3385
Change-Id: Id984f5e85481f7877567ee6d21f7ca455d773ef1
2018-11-21 14:29:11 +01:00
Daniel Willmann 6e5b7d3cdc Logging: Describe all log options, including set-all and force-all
Change-Id: Ica03c3ea08289314819448a22ae7ed38a7bd4f83
2018-11-18 20:06:00 +00:00
Daniel Willmann 987aa54d56 common/chapters/bts: Remove duplicate spaces in text
Change-Id: I38f3e94342461f494ef547bcdccd2594c30e679d
2018-11-18 20:06:00 +00:00
Daniel Willmann b7b5ce0a28 Change OpenBSC mentions to OsmoBSC where applicable
Change-Id: I4cc6874302b6089a54d44b09f08660a25e46d4dc
2018-11-18 20:06:00 +00:00
Daniel Willmann 4d3e83f785 VTY: Remove osmo-nitb VTY port number example
We reference the port list appendix where all the ports used by various
Osmocom projects are listed and it's unlikely that pointing out the
osmo-nitb port would significantly help the reader, so just remove the
reference.

Change-Id: I354d50314ba248835191fa3da122032201618a0e
2018-11-18 20:05:02 +00:00
Daniel Willmann 34837943d7 OsmoBTS: Print VTY command in fixed-width font
Surrounding with '@' didn't seem to yield the intended result, the
charactars appeared in the compiled document.

Change-Id: I66e7949fa4a6c2164bf9572a2beaf8ace169fa1c
2018-11-18 20:04:53 +00:00
Daniel Willmann a400b9598f Abis: Change abisip-find/ipaccess-config path to osmo-bsc repo
Change-Id: I4b92a611abd6e92ad69f77f8ec81a6501224afe5
2018-11-18 20:04:53 +00:00
Harald Welte aea2086fd4 add SGs / CSFB related dot + msc files
Those graphs + message sequence charts are not yet used by any
of our manuals, but they should become used by the OsmoMSC user
manual once SGs interface support is added.

Related: OS#2583
Change-Id: Idfd3a66c18131b5458d183b8e66f62eaaab65991
2018-10-05 23:42:49 +02:00
Philipp Maier 903e0f62a5 mncc: add note about DTMF considerations
Add an informative note on how DTMF signalling is done in mobile
networks and mention the limitations regarding DTMF, when internal MNCC
is used.

Change-Id: Iedcf4ad5e0e4697c6a05ebdd4f43173c14c7c448
Related: OS#2777
2018-10-01 16:50:01 +02:00
Philipp Maier 734e0ea24c mncc: add missing DTMF message types.
The list that describes the MNCC message types lacks the message types
used for DTMF.

Change-Id: I4251b296e043e7583518d6672e614b376331d25e
Related: OS#2777
2018-10-01 16:49:54 +02:00
Pau Espin a270d9375b osmotrx: Introduce code architecture chapter
Change-Id: I21084e6315d79a1adcb305e12343da218837dc31
2018-09-20 15:03:56 +02:00
Vadim Yanitskiy 54343caa9e common/gsup.adoc: document Supplementary Services extension
A while ago, we have introduced some new message types and IEs,
related to TCAP-like transaction management and Supplementary
Services. Let's document this extension.

Change-Id: Ib1331246097db736d98baf1a162574cadca9ee36
2018-06-17 06:06:30 +07:00
Daniel Willmann 39500bb143 port_numbers: Add osmo-gbproxy ctrl interface port
Change-Id: I2307a86c7c377ea3e6e8bf1333e283d5d3f67beb
2018-05-29 21:01:42 +02:00
Harald Welte d5b6a78b9f message sequence charts for GSM <-> SIP codec selection
Those diagrams represent the current design of the way how
GSM <-> SIP codec selection should work in the future.

Related: OS#1683
Change-Id: If92379b41d859bdf7be4b7689dc0bbca7cb6e682
2018-03-26 23:03:02 +02:00
Pau Espin 51a87cec2c common: logging: State we do support SIGHUP file rotation
This feature has been available since March 2013. It was introduced in
libosmocore 8e878738d16ad4f8776dc0130ebff78dea422ee7.

Change-Id: I650eb77d4b701a199a9e193cfb0e32565940a788
2018-03-19 12:01:37 +00:00
Pau Espin 9af4229dbe Introduce chapter trx_if.adoc and add it to OsmoTRX and OsmoBTS
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-03-06 17:50:28 +01:00
Pau Espin 4435f763d5 common: port_numbers: Add OsmoTRX and OsmoBTS missing ports
Change-Id: Idc34aa2d4241945e80c07e4e5660451a016f0117
2018-03-06 16:07:55 +01:00
Harald Welte 908b838366 GSUP: Change wording to cover both SGSN and MSC/VLR
Change-Id: I4b473e324e9314f4e9356a8bae6fbb48dbaaf58c
2018-01-26 11:30:44 +01:00
Harald Welte 66c6dcce3c share chapters/gsup.adoc from OsmoSGSN to OsmoMSC + OsmoHLR
Since the NITB split, GSUP is used in all three network elements, so
make the protocol a shared chapter

Change-Id: Id2d7c27ef16eb0ebe5f60d625a1fcf42f1603f4f
2018-01-26 11:17:25 +01:00
Max 88ef855d23 Document workaround for gsmtap logging
Document a way to minimize logging to stderr when gsmtap is used as a
log target.

Change-Id: I8e64a0075b5a4bad3f83660e0668e6de45b21008
2018-01-19 22:09:53 +00:00
Max f2f37e5b19 Clarify app-specific log filters
Change-Id: I53e8aed658774781a70fea0b46cafc55496925eb
2018-01-19 15:43:41 +00:00
Max 8452ddb66a Add note on vty logging
Change-Id: I2bb52feb37622d0ef35f6be172759adc3813f008
2018-01-18 15:30:23 +01:00
Max ff995e7d9c sigtran: fix typo
Change-Id: I02004ea55a00c55ee134d2c13e93614c3e1f06b3
2018-01-05 12:46:53 +00:00
Max 98bb147bbd Describe gsmtap log destination
Change-Id: If34e1640d1033daacc955f4285013b8c1be644d2
Fixes: OS#2608
2018-01-05 12:46:38 +00:00
Max a8d2935f83 Update path to ctrl scripts
Change-Id: Ib95e1ad33bbf115c8190f97210925549e6dc081a
Related: OS#2550
2018-01-04 14:58:12 +01:00
Neels Hofmeyr a13675c549 ports: add osmo-hnbgw as on port-numbers wiki page
Related: https://osmocom.org/projects/cellular-infrastructure/wiki/Port_Numbers
Related: Ife52a968a41cb286f640006587877971ff66c1a4 (libosmocore)
Change-Id: I28bd7a97d24455f88fadc6724d45c3264ba2fce4
2017-12-20 02:30:26 +01:00
Neels Hofmeyr 74b55d7457 common: ports: tweak OpenGGSN to osmo-ggsn as on port-numbers wiki page
Related: https://osmocom.org/projects/cellular-infrastructure/wiki/Port_Numbers
Change-Id: Ieaac06c9d914fc7481107ca8ebe6192b36b91bcd
2017-12-20 02:30:21 +01:00
Neels Hofmeyr 27e0735104 common: vty_additions: use proper node IDs, tweak node descriptions
Depends on the ENABLE and VIEW nodes to be named, as in a recent libosmocore
patch.

Depends: Iefb8b78094208a1a4c5d70bd6c69a3deca8da54f (libosmocore)
Change-Id: Ic2f3b18cced72db6fa5bad02ae58c602bb2c0213
2017-12-09 06:08:57 +01:00
Neels Hofmeyr 596c49fc39 common: preface: spectrum license: also mention UMTS
Change-Id: I496f56c05f873a7d9d1cdf2bc95231c7957cf51b
2017-12-07 22:32:14 +00:00
Neels Hofmeyr ac3414cc8a common: preface: minor tweaks
Change-Id: Icfc3dee5fa5e6cc0f6a6e80b122206deeceff102
2017-12-07 22:32:14 +00:00
Neels Hofmeyr a0ca649d40 common: adjust preface to mention the current state of the Osmocom art
Change-Id: I5690e7b5f0bd1483b5451f284a758b4b09c80d95
2017-12-07 22:32:14 +00:00
Neels Hofmeyr dcfbc8e249 common: bts: tweak BTS config example to show config, not telnet VTY
Change-Id: I9dda76cee8dfef6fc91099bcb3f90bed6c00b794
2017-12-07 22:30:42 +00:00
Neels Hofmeyr 96c8351fdc common: bts: add blank line to separate a code block
Change-Id: I6072253a9293e5000465039d7dcd0c6e2b9966a3
2017-12-07 22:30:42 +00:00
Neels Hofmeyr 5b02f9a092 common: bts: dyn ts: example: mention both osmo-bsc and osmo-nitb
Change-Id: Ie3218fd1449493a252a54f0b5356e8647df619e1
2017-12-07 22:30:42 +00:00