Commit Graph

209 Commits

Author SHA1 Message Date
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