Commit Graph

59 Commits

Author SHA1 Message Date
Oliver Smith dec39cdea9 s/TOPDIR/OSMO_GSM_MANUALS_DIR/g
Replace TOPDIR with OSMO_GSM_MANUALS_DIR. When the project specific
manuals will be built out of this repository, we still need to refer to
the top directory of the shared content. But it will be in another
repository, so we need to rename the variable to avoid confusion.

(moving manuals to project repositories 3/19)

Related: OS#3385
Change-Id: I2af797546de048a6ab19a5cbc755e5e15575d7ab
2018-11-20 17:13:25 +01:00
Daniel Willmann 94b857aac7 OsmoBTS: Fix typo
Change-Id: I0a4c9f052f14816e88ed0a4a5fff9b3854da195a
2018-11-18 20:05:12 +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
Pau Espin 21c0bf08eb bts: Fix typo
Change-Id: I47758acec07a587730552a9c46dc02976c807d9a
2018-07-05 18:20:57 +02:00
Harald Welte 904e792fa4 vty-ref: Update URI of docbook 5.0 schema
... to match the /etc/xml/catalog file on debian (no "www" in hostname)

Change-Id: Id9f3579c7f2bc3af13fe30b5268f249b6f59ed0d
2018-03-17 14:30:49 +01: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 30b6052e02 OsmoBTS: bts-models: Add Lime Microsystems devices as supported osmo-trx
Also take the chance to remove uneeded extra whitespace in surrounding
text.

Change-Id: I739e4dfba7c649a74cf67d6bbe6f74b22e7e24f0
2018-03-06 14:45:12 +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
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 45a83d5cfa update osmo-bts-virtual documentation, now that code is merged
Change-Id: Icd8706d29ca0e96cb89b7736dbb62f9ce159382d
2017-07-20 16:59:19 +00:00
Pau Espin 725b3521a3 rtp-amr: Fix typo and trailing whitespace
Change-Id: I8efda2387e0e5e95700b070dab8f8dd427fa562d
2017-07-18 14:27:54 +00:00
Pau Espin b052cb0499 rtp-amr: Describe requirement to recieve all PH-DATA.ind events
Change-Id: I4a78b3398c36a8107fa1809ba9b89235980f0e4f
2017-07-18 14:20:49 +00:00
Pau Espin f5ac2b913c OsmoBTS: Update osmotrx ip to diff between local and remote
Change Id of the code implementation: I0bd34b7b02c1a9b0c6f6f89f327b486e5620c8d5

Change-Id: Ia4c70b3b8436e2647fc35d579a302dfbf32a83f0
2017-06-18 09:07:33 +00:00
Pau Espin d06ff6426e OsmoBTS/chapters/configuration.adoc: Add bts index in example
Change-Id: If13643cdfa59c50b6af8ab0657635fed2ca219f0
2017-05-08 07:35:00 +00:00
Max a81db8c7d0 Sync DTX FSM with OsmoBTS code
Change-Id: I050a07db99bc0038cfd2a9646a450f714653d804
2017-02-07 00:40:16 +00:00
Philipp Maier c122abf12d Describe how to run multiple instances of osmo-nitb and osmo-bts
Change-Id: I69adeef85adda6f08b31b7d176f51e16968c1435
2017-01-10 15:06:19 +01:00
Ivaylo Kostov deeadd7d43 BSC,BTS: add diagrams of PCU-BTS-NITB-SGSN relationships
Change-Id: I0eb09706efb768fa4f6810872fb6568cbc9838cb
2017-01-05 14:19:01 +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
Max 547da0ab35 Add DTX implementation details to RTP AMR
Add FSM and description.

Change-Id: Ib37cb6e4038f970070c1715269961db7172ce377
2016-11-03 16:54:10 +01:00
Max 05a503f4dc Move RTP AMR doc to top level
Add it to Makefile with proper docinfo so it's build automatically
alongside with other documentation.

Change-Id: Iacd7fadc003ce0f9ffd20aa5b36c7d598b04f882
2016-11-03 16:53:59 +01:00
Harald Welte 411e4b0921 rtp-amr.adoc: Fixes to Message Sequence Charts
Nutaq added these clarifications/extensions/fixes tothe message sequence
charts.

Change-Id: Ic699bda828947ff616c3d80783026e21d853f962
2016-11-03 14:21:37 +01:00
Harald Welte ffd4a22a93 rtp-amr.adoc: New TCH/AHS downlink chapters
Nutaq contributed the following chapters:
* TCH/AHS Downlink: FACCH/H During DTX Operation
* TCH/AHS Downlink: Inhibited SID_UPDATE
* TCH/AHS Downlink: Inhibited SID_FIRST_P1

Change-Id: I55d8e9f98694b39514d1f31c517a80050103fdd6
2016-11-03 14:14:20 +01:00
Harald Welte 8d2b6b858f rtp-amr: TCH/AHS Uplink: FACCH/H During DTX
New chapter contributed by Nutaq:
* TCH/AHS Uplink: FACCH/H During DTX operation

Change-Id: I4a9c58e02dcfeb388ff3a30ba321ea3cec325518
2016-11-03 14:12:08 +01:00
Harald Welte 073cfa3c49 rtp-amr.adoc: TCH/AFS Downlink: Inhibiting
Add two new chapters contributed by Nutaq:
* TCH/AFS Downlink: Inhibiting a SID_FIRST frame
* TCH/AFS Downlink: FACCH/F During DTX Operation

Change-Id: Ic39d035f9d17bd0634c2df78ae3359a5eb7dfd46
2016-11-03 14:09:09 +01:00
Harald Welte 0b0205e6f4 rtp-amr.adoc: TCH/AFS Uplink
Add new chapter by Nutaq for Speech Frame Following a SID_FIRST frame

Change-Id: Ib7cfb07525ea311d9dac051a6e139b0ae0549504
2016-11-03 14:06:13 +01:00
Harald Welte b21df2df9b Documentation on AMR RTP in case of DTX
Change-Id: I394f405b441c1eb000759151bd8350d5b3a84a0b
2016-11-03 12:30:04 +00:00
Neels Hofmeyr c067b44353 fix build: abis: re-add dependencies
Below commit accidentally removed osmobts-abis.pdf from the Makefile entirely.
The pdf was re-added, but the dependencies are still missing, so that
osmobts-abis.pdf is not rebuilt when abis/* is newer. Fix that.

Culprit: 05f5adbe83
"OsmoBTS: add vty reference documentation"

Half-fix: 707827196f
"OsmoBTS: generate osmobts-abis.pdf again"

Change-Id: Id2ee8177cfb8eb58409d164bdd994ef5e86ad82b
2016-11-03 13:16:23 +01:00
Neels Hofmeyr 027dcc3e55 OsmoBTS/abis/rsl: split dyn TS ladder diagrams to fit on page
Split both of the lengthy mscgen generated ladder diagrams in two so that the
diagrams are split over two pages and don't bleed into the page footer.

Change-Id: If90250123a85cd275f07c69ee64c6e10a7269f06
2016-11-02 09:32:04 +00:00
Alexander Couzens 707827196f OsmoBTS: generate osmobts-abis.pdf again
broken by 05f5adbe83

Change-Id: I7ca18e3d7fa3a5a6eac0590b919b4c664f73671c
2016-10-25 03:53:29 +02:00
Neels Hofmeyr 722c2fd579 fix 'make clean': shell glob, ignore failure
Unfortunately a glob like osmo-x__*.{svg,png} doesn't work, so have the
suffixes in separate globs.

Add dashes to indicate that failure should be ignored.

Change-Id: I6bc4d9ea72b43a573acbc860c23397f748de2c7b
2016-10-21 02:22:02 +02:00
Neels Hofmeyr 9b1cdce0f6 OsmoBTS/abis/rsl: combine separate dyn ts sections
There were two separate sections saying basically the same. Move the
entire 'Dynamic Channel Combinations' section further above and combine
with the 'IPA Style PDCH Management' section to avoid repetition.

Change-Id: Ic370ba34de5cb14f0194ff8c8661e45d7ca98e2b
2016-10-18 17:11:22 +02:00
Neels Hofmeyr b156e76469 add 'make check' target
Generate *.check files from asciidoc output and grep for WARNINGs.
Add *.check files to gitignore and to 'make clean'.

Change-Id: Ibccc83a3415930a528f2e8e4e4dda3b81c6d0b64
2016-10-18 17:11:21 +02:00
Neels Hofmeyr 4dba500ed5 make clean: also remove generated image files
Change-Id: I80798e79b4ccee64f26f58f9754de02b2958e33e
2016-10-18 17:10:51 +02:00
Neels Hofmeyr 690178bc1a OsmoBTS/abis/rsl: add missing info for Osmocom Dyn Channels
The section 'Osmocom Style Dynamic Channels' ended in mid-sentence without
naming any of the hard facts. Complete that.

Add section links.

Change-Id: Ib92895fe1bb89fb1b14dc8fcbd88b98bbb6edeee
2016-10-18 17:08:49 +02:00
Neels Hofmeyr 43f69acdde OsmoBTS/abis/rsl: cosmetic: 'IPA style'
Consistently name the PDCH act methid 'IPA style', name ip.access only once
in the 'IPA Style Dynamic Channels' section.

Consistently write 'IPA style' without hyphen (not 'IPA-style').

Capitalize section headers ('IPA Style').

Change-Id: I91112c2d8af9424ebe7e1972fd4ef9c77d24a7b4
2016-10-18 17:08:49 +02:00
Neels Hofmeyr eda597fee0 OsmoBTS/chapters/configuration.adoc: fix index numbering
Change-Id: Ibe507fe36e0130377dec361d56fd75596ca64e75
2016-10-18 17:08:49 +02:00
Neels Hofmeyr 098baa4960 osmobts-usermanual.adoc: fix link to abis.adoc chapter
The chapter is in ../common/chapters, not in ./chapters

Change-Id: I698d83e96cb77900b99a0bd383587b1b68182efb
2016-10-18 17:08:49 +02:00
Neels Hofmeyr 1c6aba60ad OsmoBTS/chapters/dynamic-timeslots.adoc: Remove obsolete links
Those file never existed and the ladder diagrams are instead at
OsmoBTS/abis/dyn_ts*msc.

Change-Id: Icbae85b959e80afe7f272a11f33064a3e594da53
2016-10-18 17:08:49 +02:00
Neels Hofmeyr a74318b506 OsmoBTS/abis/rsl.adoc: fix missing section header
In effect, this fixes the dangling references from the table of RSL messages
with additions/limitations to the Chan Act message description.

Change-Id: Ic6f83f016ce9ec90af7eb0af1b1f71a10263915d
2016-10-18 17:08:49 +02:00
Alexander Couzens 05f5adbe83 OsmoBTS: add vty reference documentation
Including the required changes of the Makefile which is now simliar
as the other projects Makefile's.
Based on: OsmoBTS 0.3.0.283-f869

Change-Id: Id7362ce1c584b1926330b93770d68453e091c71c
2016-10-18 13:52:15 +00:00
Neels Hofmeyr d363b3964a OsmoBTS/abis/dyn_ts_osmocom_style.msc: adjust PDCH Act ack
The act ack for switchover to PDCH is now issued immediately, after
commit 'dyn TS: if PCU is not connected, allow operation as TCH'.
Adjust the chart accordingly.
2016-08-23 01:12:22 +02:00
Neels Hofmeyr 41fba3d1e9 OsmoBTS/abis/rsl: fix subtitle for ladder diagram of osmo dyn switchover 2016-08-22 17:36:28 +02:00
Daniel Willmann 09eea26c83 Add section about configuring power-ramping 2016-08-08 17:03:39 +02:00
Harald Welte 63548b94c4 osmobts-abis: Add Revision log regarding dynamic cannels 2016-07-31 21:53:33 +02:00
Harald Welte 84e3a9e060 spelling: message discriminator, not descriminator 2016-07-31 21:46:35 +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 f5fb7e847c OsmoBTS: hardware support: remove dup, tweak wording
Don't mention the common part twice.
Use plural for hw specific parts.
No commata before 'and'.
2016-07-26 13:16:31 +02:00
Neels Hofmeyr d809dd5843 OsmoBTS: wording tweak 2016-07-26 12:50:39 +02:00
Neels Hofmeyr 180c6dd4b5 OsmoBTS: typos
'3GPP specified': when talking about written information, one usually uses
the present tense '3GPP specifies'.
2016-07-26 12:46:33 +02:00
Neels Hofmeyr 293cb9f2fe abis/oml.doc: remove duplicate sentence part 2016-06-27 17:42:53 +02:00