Commit Graph

238 Commits

Author SHA1 Message Date
Vadim Yanitskiy b01306c59a GSUP: fix E-Routing-Error: both session state / ID IEs are optional
If a message that has triggered the E-Routing-Error contains no
session related IEs, they will also be absent in the error message.

Change-Id: Iaf9d8e77c8734672cfd8a265b8cfdb3bc929a31b
2020-04-19 19:45:17 +07:00
Vadim Yanitskiy 49ab1cb2fc port_numbers: fix: GSMTAP has noting to do with port 2427/udp
Change-Id: Ic37ee2e2da290521ac226a9720d48fbbe0883f3d
2020-04-17 02:05:47 +07:00
Vadim Yanitskiy 0d72300779 logging: fix section 6.5.3: logging level s/all/force-all/ fatal
The special 'all' keyword has been deprecated a long time ago
due to its ambiguity, and replaced by 'force-all'.

Change-Id: I759d96716e964d499c0724d481b2f3e5062fb052
2020-04-17 01:05:44 +07:00
Neels Hofmeyr fef7b5173d add common/chapters/cs7-config
This will be used by the manuals of osmo-bsc, osmo-hnbgw, osmo-msc, osmo-sgsn.

Related: OS#2767
Change-Id: Ia2508d4c7b0fef9cdc57e7e122799a480e340bf7
2020-03-19 19:00:27 +01:00
Harald Welte f29a9f2329 port_numbers: Add missing mDNS port for D-GSM / osmo-hlr
Somehow despite all the warnings everywhere about keeping wiki + code
in sync, this didn't get updated :(

Change-Id: I37e4ea4e6ac8291a36761ecc1849f06847a69557
2020-03-08 10:44:52 +01:00
Harald Welte d8b01c4460 port_numbers: Add osmo-mgw CTRL port
Change-Id: I41de762bbceeaf219d00bdc4e4f2c46c3b11c436
Related: OS#4441
2020-03-08 10:44:04 +01:00
Daniel Willmann 2dc172cff6 bts.adoc: Add information about RACH tuning parameters
Related: OS#2722
Change-Id: I9a6b84cb988be2143672b954e7c6827f691f4a01
2020-01-09 10:55:49 +01:00
Daniel Willmann c2fb037017 bts: Document access control classes and acc ramping
Change-Id: Ia6fbd2da0d03dd372f3d1a34fbed8ac6fc7ed08c
Related: OS#2722
2020-01-06 16:37:50 +01:00
Vadim Yanitskiy 258bbad921 chapters/gsup.adoc: fix message definitions containing gsup-ie-pdpinfo
Change-Id: I7713635e15c1d0680fd8d8c11703683710d9c457
2020-01-03 12:51:35 +01:00
Vadim Yanitskiy d8dd8a7355 chapters/gsup.adoc: further documentation for SM-RP-DA/OA IE coding
Change-Id: I315ae412c83de80f09284c8c1f28faf360ac4662
Related: OS#4324
2020-01-03 12:51:35 +01:00
Harald Welte 293b0faaed Add GPRS
Change-Id: Ib3218c035445875a079f3ef3aa72bbf6d8c668b6
2019-12-26 08:38:14 +01:00
Neels Hofmeyr 117844bc8a D-GSM biblio entries
Change-Id: Ief8dd1998e2445aea41fe9f0c8a98d6cd515c8a5
2019-12-09 13:37:02 +01:00
Harald Welte f1499959dd gsup: Fix description of Purge MS procedure
Change-Id: I5386e438a12edbc6c2ffa3e63400dd2756bb1be6
Closes: OS#1921
2019-12-01 10:18:07 +01:00
Pau Espin b34ffdd069 trx_if.adoc: Fix typo and formatting of bullet list
Change-Id: I45c3ea655139d4777100af02d6b0d9cbf25b02e5
2019-11-22 16:29:58 +01:00
Harald Welte 6084c89831 some more missing items from glossary.
Change-Id: I5b1b06342517042b77a42a57d506c8826b556267
2019-11-20 11:06:27 +01:00
Harald Welte 135fd1159d missing glossary items; mostly MSC/3G related
Change-Id: I61a03badbd63b211821f01ec16f64c28ac495952
2019-11-20 11:03:11 +01:00
Harald Welte 9a47d43e2d typo / stylistic fixes by Tom Tessier
Change-Id: Id3009c0c34dd84ab86ce9d34e7a94e0d1003c1ff
2019-11-20 11:02:52 +01:00
Martin Hauke 6239015e03 Fix some typos
Change-Id: Idd9f9640101816ab979b11cc13ffa12d2245108d
2019-11-11 22:08:00 +01:00
Pau Espin 7758a7fedb sigtran-osmocom.adoc: Fix typos
Change-Id: I31314dd36bac202103483bc93350736bfbc76be1
2019-10-09 18:40:24 +02:00
Pau Espin 35ca68b762 common: trx_if.adoc: Add documentation about TRXDv1 and SETFORMAT
Change-Id: I320539fc9ffb7dd0f09ec18892299bd603cd7a85
2019-07-31 13:13:38 +02:00
Pau Espin c7fb3f28f4 common: trx_if.adoc: Improve documentation
Several fixes and improvements to the documentation.
This documentation still doesn't contain infrmation about TRXDv1, it
will be added in a follow-up commit.

Change-Id: I36e6206b90435964842f9f1ebd982cdaf9777018
2019-07-31 13:13:34 +02:00
Daniel Willmann abadcd5f8a counters-overview: Add a section about the stats reporter
Fixes: OS#3768
Change-Id: Ia338409e6cb1b1478429e3a99158b9d8255dbb2c
2019-07-25 17:26:25 +02:00
Pau Espin 061cca4d73 common: Introduce Osmux documentation
Change-Id: I182d94c63f7d74ef882b77be59a95b1b7d8a4e5e
2019-07-22 10:14:36 +02:00
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
Neels Hofmeyr 7b06baccd6 common: bts: dyn ts: explain dyn_ts_allow_tch_f from OsmoBSC viewpoint
Change-Id: If9425b16216f353515890a7b2de8590bdfa1ff38
2017-12-07 22:30:42 +00:00
Neels Hofmeyr da63831ef9 common: bts: dyn ts: mark octasic as supported
Supported since osmo-bts 69ec4a419edee4f00a104c59a78b530eaf85382a /
Ia109d4bfade7bc28442127581f4bb0289146ea71

Change-Id: Iab21573ab308b1e243bd6b56c9e3b1977a7f69fe
2017-12-07 22:30:41 +00:00
Neels Hofmeyr 2f9403f727 common: bts: dyn ts: drop special meaning for OsmoBSC vs OsmoNITB
Change-Id: I70da58bee08e531babfe78852cc82a1177f9b7b2
2017-12-07 22:30:41 +00:00
Max cef03ec36d CTRL: add rate counter dumper to examples
This describe rate counter dumper added to osmo-python-tests in
I12b369434e4ee9b38f92872f297e1f3d4f0698c2

Change-Id: I52d735f373f2e7aa1f12941fc450c0e9740ccdeb
Related: OS#2550
2017-12-07 16:48:37 +01:00
Max 3d2f7ffe40 Update CTRL example
Use proper script new and repository location.

Change-Id: I3c16f38ade6fcfadffd8d2573f71828119da055c
2017-12-07 15:56:25 +01:00
Max 91c4274c7d rate_ctr: clarify ctrl interface
Clarify introspection over ctrl interface and request for individual
rate counter.

Change-Id: I3d258aaafc381644be2f16b51e4dc655c1fb9b26
2017-11-28 19:04:22 +01:00
Max bb466ee020 Update rate_ctr description
* use example new counter names with ':' separator
* mention that 'counter' is obsolete
* mention group name and index
* use bold and monospace fonts to improve visibility

Change-Id: Ia962367bb93cb826002db6c950d23ae2102ac713
Related: OS#2550
2017-11-27 16:44:06 +00:00
Philipp Maier df58937574 common: add osmo-mgw to mgcp
Add osmo-mgw to the list of programs which use the MGCP port IETF

Change-Id: Idfd0340297ddb15494b4b20d776e89e6288107e1
2017-11-24 10:24:23 +01:00
Philipp Maier f9fbe955af common: add VTY port number of osmo-mgw
osmo-mgw currently uses the VTY port constant of
osmo-bsc_mgcp. We decided to re use the same port
number for osmo-mgw, this is not mentioned in the
manuals yet.

Add the port number of osmo-mgw to the manuals
(common)

Change-Id: I41f7f2a7f850613707eddea610557b688de7a904
2017-11-24 10:24:23 +01:00
Philipp Maier 4e24daf908 Revert "common: add VTY port number for osmo-mgw"
We agreed to re-use the port of osmo-bsc-mgcp, so there is
no need for this patch anymore.

This reverts commit ad4a01e2a4.

Change-Id: I8629db5e975cc218c80c747a39c0fdca5f5d6e10
2017-11-24 10:24:23 +01:00
Harald Welte 9518d10734 STP: State actual vty commands for dynamic RKM registration
Change-Id: I639dc271dd7f5bea1f6cb8b070990c7c15a39dba
2017-11-12 08:01:39 +09:00
Harald Welte 93643560dc STP: cosmetic fixes/improvements
Change-Id: I1c1c7bb122e9cf9b707feb8e6617a03d15043089
2017-11-12 08:01:22 +09:00
Harald Welte a410c43ab8 First step towards an OsmoSTP manual
Change-Id: I450bfac7444ac9cb7f50c086d87cf7157c2e2a31
2017-11-12 04:34:00 +09:00
Philipp Maier ad4a01e2a4 common: add VTY port number for osmo-mgw
Change-Id: Ifa7eec30ccc5a0beb26c9ec50492d4637cd1d0a5
2017-11-10 10:58:19 +01:00
Neels Hofmeyr c481a988e3 refactor Makefile build rules, don't use the FORCE
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
2017-10-25 16:51:55 +00:00
Neels Hofmeyr f2252db133 common/vty: minor wording tweaks and typo fixes
Change-Id: I5eb1ea0d3de883ff5e9742f77e7ef4be0482852d
2017-10-18 00:31:41 +02:00
Neels Hofmeyr 75b442450a common/vty: explain difference between telnet and config file
- Mention that the CONFIG node is used to parse config files.
- Mention that it is not well defined whether CONFIG node items have immediate
  effect.
- Add a 'telnet' here and there to clarify.

Change-Id: I882346c69f12c67d0e41d563c99d4de4efd8b8f6
2017-10-18 00:19:07 +02:00
Neels Hofmeyr 8d607a7900 common/vty: "programs should not use the telnet VTY"
Change-Id: Ic7e8c3663a2bfaf8dcb5752bf55ccb822b111c31
2017-10-18 00:19:07 +02:00
Neels Hofmeyr 4538d2d67f common/vty: fix: CONFIG entered from ENABLE, not VIEW node
Change-Id: I892081f9452f8923441913f978a3be542a3c53d0
2017-10-18 00:19:07 +02:00
Max 6c3abbe655 logging: document alarms target
Add subsection describing "log alarms" target.

Change-Id: I95ce5f3db38616608590e02ee79eb3a7e6e4ea14
Fixes: OS#1913
2017-10-09 12:29:18 +02:00
Max ed8284ac6b logging: restructure sections
The basic logging concepts like filters and levels which are
target-independent. It's counter-intuitive that they are described
inside vty target section.

* fix that by putting them in separate sections which are referenced
  from target sections as necessary
* move all targets into subsections under "Log targets" section

Change-Id: I5acde815c66eb3d57e06ecd8dc65fe338216fe63
Related: OS#1913
2017-10-06 19:52:52 +02:00
Max 5f8413c282 logging: replace OpenBSC -> OsmoBSC in examples
Change-Id: Id55dcd41b0d2b3408969d1858e925da55fb5427c
2017-10-06 19:09:18 +02:00
Neels Hofmeyr 03739af1c5 mncc: not 'TCHF', rather 'TCH'
Change-Id: I0edf1763122f182c66ad4c7155ddd4bea0c1d608
2017-10-02 16:31:13 +02:00
Neels Hofmeyr b459f4dbad add OsmoMSC manual
Add OsmoMSC and OsmoHLR to bibliography (even though the OsmoHLR manual does
not yet exist, a reference to it has been added in OsmoMSC's manual).

Change-Id: I9ecff2837fbf5fdc19675a726f6d70c21eb178ee
2017-10-02 16:31:13 +02:00
Neels Hofmeyr 1310fa82e9 move smpp.adoc to common chapters, generalize
OsmoMSC will need the same SMPP chapter as OsmoNITB.

In smpp.adoc, replace program name with parameter, add parameter to
OsmoNITB's main adoc and move smpp.adoc to common/chapters.

Change-Id: I15febdea6569316dad3eed5f9dc7158adb5b078c
2017-10-02 14:27:04 +00:00
Neels Hofmeyr 6e55bc1361 mncc.adoc: clarify MNCC_BRIDGE, with future outlook
Change-Id: Ic71a83d71f2da87e1066fcc060b2b942643eddbc
2017-09-28 18:09:07 +02:00
Neels Hofmeyr 40abc7a217 tweak common/mncc.adoc: use variable for program name
Change-Id: I993a3c3bf617b9823f49898364b5f728a4549330
2017-09-28 18:09:07 +02:00
Neels Hofmeyr f56996aa41 move mncc.adoc to common chapters
Upcoming OsmoMSC will reference the same, hence MNCC becomes a common chapter.

Move the file and adjust various wording to include OsmoMSC.

Change-Id: I404758ff7f1372e841ffe33c75455f513fff3caf
2017-09-25 16:42:01 +02:00
Max 271f5b4081 Expand OsmoGGSN manual
* add cross-references
* add example of running without root priviledges

Change-Id: I1743f370ee2b351d2847f2e29e0f59f35cd401f4
2017-09-25 08:29:28 +00:00
Neels Hofmeyr 52136c3ae3 fix various grammar and typos in: preface, cell-broadcast
Change-Id: I0c61ad0e824b0d62bb9332f2208b247d3852dbb5
2017-09-24 22:35:00 +02:00
Pau Espin b1503f04bf Allow easily disabling GFDL references
All parts referencing GFDL can be easily disabled by removing the
'gfdl-enabled' attribute from the document.

Change-Id: I2489726ad2e90301bceadfada926e31ae0f85986
2017-09-01 09:43:23 +02:00
Harald Welte 8be8ec61a2 Add VTY port number for GGSN
Change-Id: I199f0d10b819215442885629ffc9955c949133ca
2017-08-16 23:43:26 +02:00
Harald Welte da7adb3bba rf.adoc: Fix table rendering for path loss models
Change-Id: Ia36c5ecf943b978d846884a1c4b638dccd89da3b
2017-08-08 20:07:46 +02:00
Harald Welte 3bcb9f4c15 Add Message Sequence Chart for MO call with ext. MNCC in OsmoMSC
We simply talk to the MGW instead of the BTS, everything else should
remain identical.

Change-Id: I5c249cc2144276a25dba4d7bcb086a34b52d6334
2017-07-11 17:42:04 +02:00
Harald Welte e62d414c0c Add Message Sequence Chart for a MO calls with ext. MNCC handler
Change-Id: Ida10fc7ccb345b8cd084c4ecc5f4f7d4ce6c98a0
2017-07-11 17:39:27 +02:00
Max ad61fb82e6 Remove currently broken everything logging option
Change-Id: I52e370d59274e29502cd23690f0d5c73aa3a4cc7
Related: OS#71
2017-07-08 10:44:11 +00:00
Harald Welte 8e23a8e3ab Add chapter on Cell Broadcast Support in Osmocom (to BSC+NITB manual)
Change-Id: I2c621def499dc0564d31eb9440e22e79948a5466
2017-05-29 20:52:02 +02:00
Harald Welte fd52dcd020 port_numbers.adoc: Add VTY port number for STP
Change-Id: If812e0d6818ed704f0b75a9bc3e07dddfba37081
2017-04-08 09:34:54 +02:00
Pau Espin 1e5f03d7e9 gb.adoc: Add info to NS-over-UDP example
Change-Id: I5b6d2fb284336614da28e0d1b01c7e8c26725f81
2017-04-04 16:07:19 +02:00
Harald Welte 0823a32297 bibliography: Add TES 35.205 on MILENAGE
Change-Id: Ifd4eee72b1dc7bf2a993670e28f6c8adb51ab00f
2017-03-05 13:17:52 +01:00
Neels Hofmeyr 93479e3b0e ports: rename CSCN to MSC
See OS#1958 and https://gerrit.osmocom.org/1884

Change-Id: Iac081f5b92f66df68932350492687933c47e4f95
2017-02-24 16:35:14 +01:00
Max 424a2c3c69 Add CTRL port for OsmoHLR
Change-Id: Ic39e48cec9615faaa31079b0faec6ebd7e706b4f
Related: OS#1645
2017-02-14 14:12:24 +01:00
ikostov 4e42509a8f GSUP, OAP: fix AUTS length to 14, not 16
https://gerrit.osmocom.org/1731

Change-Id: Id33d300c4985be5f2602703a6d4dc83032f0a926
2017-02-04 05:07:27 +00:00
ikostov cf961ee39e SGSN: editing OAP as per os#1874
Change-Id: Idab734e8dff947496cd0ce27c9c44bc7ef5a139e
2017-02-02 18:13:54 +01:00
Neels Hofmeyr 660affb342 common/port_numbers: place comment to remind of syncing ports lists
Change-Id: Ib99271bfb435ef59fcfc0a2ac198d26770199344
2017-01-30 13:09:45 +01:00
Neels Hofmeyr 65fb8d60de common/port_numbers: add osmo-hlr VTY port 4258
Change-Id: Ibf66a7c31d1b48b002c25bb55784c99f54dad3a0
2017-01-30 13:08:14 +01:00
Harald Welte 0f5c98054a Add ETSI TS 101 220 for AID numbering in smart cards
Change-Id: If3d04546f6d68e2947705c252464a0ed71377f44
2017-01-25 20:15:08 +01:00
ikostov b28c11a87a Abis: add abisip-find and ipaccess-config tools
Change-Id: Ief893a89ff9f307b2a240ec76bb48c9bcd64dedc
2017-01-23 13:31:35 +00:00
ikostov 8e01a9d06f SGSN: add Auth. policy, NS Statistics and BSSGP state examples, tweaks
Add semicoli in fig-gprs-pcubts digraph.

Remove section from GMM Implementation about non-existence of HLR.
The SGSN can access osmo-hlr via GSUP (and will have to do so in the
libvlr future).

Change-Id: I0164f418e453672321eed00bbc454c1e223ea158
2017-01-10 23:27:28 +00:00
Neels Hofmeyr ed395e5377 dynamic timeslots: add BSC level config instructions
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
2016-12-01 03:03:44 +01:00
Neels Hofmeyr bf471a0517 common: port_numbers.adoc: sync with wiki page
https://osmocom.org/projects/cellular-infrastructure/wiki/PortNumbers
2016-09-09 17:01:23 +02:00
Neels Hofmeyr c743fd5812 Document dynamic channels on Abis, both IPA and Osmocom style
Based in ladder diagram and WIP wording for IPA style from Neels
Hofmeyr, completed by me.
2016-07-31 21:46:28 +02:00
Neels Hofmeyr adbc4f301c bibliography: fix spelling of my surname 2016-07-26 12:52:24 +02:00
Max 887839f0e4 Expand common control interface description
Add variables common to all osmocom programs which are using control
interface.
2016-06-07 23:16:01 +02:00
Jonathan Brielmaier 56cdbf359c fix various typos across all manuals 2016-05-25 15:01:28 +02:00
Harald Welte 53a3f350fb bibliography: Add SIM/USIM card related spec references 2016-05-22 20:21:20 +02:00
Harald Welte e5d8884cb7 Add SIM/USIM related terminology to glossary 2016-05-20 10:59:19 +02:00
Neels Hofmeyr f4a9a47019 glossary: some fixes, unify style, streamline language
Fix A5 description concerning A5/2 (not in use).
Fix UICC: 'Circuit Card', not 'Chip Circuit', and replace 'FIXME'.
NITB: like OsmoNITB just without Osmo, reference OsmoNITB.

Add some words/explanations (FPGA, MSC, OXCO, UICC, VTY).

Fix minor typos ('Freee', 'usees', over-eager dashes '-',
capitalisation).
Use 'an' before acronyms pronounced starting with a vocal ('S', 'M').
Use 'a' before 'U'.

Unify style:
Use semicoli ';' instead of periods '.' or commas ',' where appropriate.
Use lower case letters after semicoli.
2016-03-22 08:43:59 +01:00
Harald Welte 54a74d77fc OAP: Fix overlapping table headings 2016-02-20 18:39:56 +01:00
Harald Welte c3356ebd7e preface: Slightly re-structure section nesting + rephrase getting help 2016-02-20 18:28:46 +01:00
Harald Welte 1cf89d115a fix some broken references to the bibliography 2016-02-20 18:28:46 +01:00
Harald Welte 079ebf8a08 Add Section "Endorsements" and one sentence about contributions 2016-02-20 18:28:46 +01:00
Harald Welte fbec34a20f Add links to Osmocom PDF manuals in bibliography 2016-02-20 18:28:46 +01:00
Harald Welte 593eaf6173 glossary: Fix 'FIXME' for UICC and replace with actual ETSI reference 2016-02-20 15:29:08 +01:00
Harald Welte 37ba7a9825 initial checkin of manuals to public repo
The manuals existed in different form for several years in an internal
sysmocom repository.  However, since they had just recently been
converted from docboox-xml to asciidoc and all files have been
re-shuffled for enabling the public release, there's not much point in
keeping the history with git-filter-branch.
2016-02-20 15:01:50 +01:00