aboutsummaryrefslogtreecommitdiffstats
path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
2018-11-27OsmoBTS: Fix typoDaniel Willmann1-1/+1
Change-Id: I0a4c9f052f14816e88ed0a4a5fff9b3854da195a
2018-11-27OsmoBTS: Print VTY command in fixed-width fontDaniel Willmann1-1/+1
Surrounding with '@' didn't seem to yield the intended result, the charactars appeared in the compiled document. Change-Id: I66e7949fa4a6c2164bf9572a2beaf8ace169fa1c
2018-11-27bts: Fix typoPau Espin Pedrol1-1/+1
Change-Id: I47758acec07a587730552a9c46dc02976c807d9a
2018-11-27vty-ref: Update URI of docbook 5.0 schemaHarald Welte1-2/+2
... to match the /etc/xml/catalog file on debian (no "www" in hostname) Change-Id: Id9f3579c7f2bc3af13fe30b5268f249b6f59ed0d
2018-11-27Introduce chapter trx_if.adoc and add it to OsmoTRX and OsmoBTSPau Espin Pedrol1-1/+2
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-11-27OsmoBTS: bts-models: Add Lime Microsystems devices as supported osmo-trxPau Espin Pedrol1-5/+5
Also take the chance to remove uneeded extra whitespace in surrounding text. Change-Id: I739e4dfba7c649a74cf67d6bbe6f74b22e7e24f0
2018-11-27refactor Makefile build rules, don't use the FORCENeels Hofmeyr1-45/+7
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
2018-11-27Allow easily disabling GFDL referencesPau Espin Pedrol2-0/+4
All parts referencing GFDL can be easily disabled by removing the 'gfdl-enabled' attribute from the document. Change-Id: I2489726ad2e90301bceadfada926e31ae0f85986
2018-11-27update osmo-bts-virtual documentation, now that code is mergedHarald Welte1-12/+41
Change-Id: Icd8706d29ca0e96cb89b7736dbb62f9ce159382d
2018-11-27rtp-amr: Fix typo and trailing whitespacePau Espin Pedrol1-2/+2
Change-Id: I8efda2387e0e5e95700b070dab8f8dd427fa562d
2018-11-27rtp-amr: Describe requirement to recieve all PH-DATA.ind eventsPau Espin Pedrol2-35/+59
Change-Id: I4a78b3398c36a8107fa1809ba9b89235980f0e4f
2018-11-27OsmoBTS: Update osmotrx ip to diff between local and remotePau Espin Pedrol1-2/+8
Change Id of the code implementation: I0bd34b7b02c1a9b0c6f6f89f327b486e5620c8d5 Change-Id: Ia4c70b3b8436e2647fc35d579a302dfbf32a83f0
2018-11-27OsmoBTS/chapters/configuration.adoc: Add bts index in examplePau Espin Pedrol1-2/+2
Change-Id: If13643cdfa59c50b6af8ab0657635fed2ca219f0
2018-11-27Sync DTX FSM with OsmoBTS codeMax2-35/+70
Change-Id: I050a07db99bc0038cfd2a9646a450f714653d804
2018-11-27Describe how to run multiple instances of osmo-nitb and osmo-btsPhilipp1-0/+29
Change-Id: I69adeef85adda6f08b31b7d176f51e16968c1435
2018-11-27BSC,BTS: add diagrams of PCU-BTS-NITB-SGSN relationshipsIvaylo Kostov1-0/+26
Change-Id: I0eb09706efb768fa4f6810872fb6568cbc9838cb
2018-11-27dynamic timeslots: add BSC level config instructionsNeels Hofmeyr1-3/+6
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
2018-11-27Add DTX implementation details to RTP AMRMax3-0/+102
Add FSM and description. Change-Id: Ib37cb6e4038f970070c1715269961db7172ce377
2018-11-27Move RTP AMR doc to top levelMax3-1/+49
Add it to Makefile with proper docinfo so it's build automatically alongside with other documentation. Change-Id: Iacd7fadc003ce0f9ffd20aa5b36c7d598b04f882
2018-11-27rtp-amr.adoc: Fixes to Message Sequence ChartsHarald Welte1-71/+188
Nutaq added these clarifications/extensions/fixes tothe message sequence charts. Change-Id: Ic699bda828947ff616c3d80783026e21d853f962
2018-11-27rtp-amr.adoc: New TCH/AHS downlink chaptersHarald Welte1-4/+107
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
2018-11-27rtp-amr: TCH/AHS Uplink: FACCH/H During DTXHarald Welte1-1/+48
New chapter contributed by Nutaq: * TCH/AHS Uplink: FACCH/H During DTX operation Change-Id: I4a9c58e02dcfeb388ff3a30ba321ea3cec325518
2018-11-27rtp-amr.adoc: TCH/AFS Downlink: InhibitingHarald Welte1-4/+85
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
2018-11-27rtp-amr.adoc: TCH/AFS UplinkHarald Welte1-12/+119
Add new chapter by Nutaq for Speech Frame Following a SID_FIRST frame Change-Id: Ib7cfb07525ea311d9dac051a6e139b0ae0549504
2018-11-27Documentation on AMR RTP in case of DTXHarald Welte1-0/+858
Change-Id: I394f405b441c1eb000759151bd8350d5b3a84a0b
2018-11-27fix build: abis: re-add dependenciesNeels Hofmeyr1-0/+1
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: 05f5adbe837f2cbfb9301cdb8c9b454ca0bfc825 "OsmoBTS: add vty reference documentation" Half-fix: 707827196f0734eefa74ce0c35c2ab2fe754cc4c "OsmoBTS: generate osmobts-abis.pdf again" Change-Id: Id2ee8177cfb8eb58409d164bdd994ef5e86ad82b
2018-11-27OsmoBTS/abis/rsl: split dyn TS ladder diagrams to fit on pageNeels Hofmeyr5-46/+68
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
2018-11-27OsmoBTS: generate osmobts-abis.pdf againAlexander Couzens1-1/+1
broken by 05f5adbe837f2cbfb9301cdb8c9b454ca0bfc825 Change-Id: I7ca18e3d7fa3a5a6eac0590b919b4c664f73671c
2018-11-27fix 'make clean': shell glob, ignore failureNeels Hofmeyr1-3/+7
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
2018-11-27OsmoBTS/abis/rsl: combine separate dyn ts sectionsNeels Hofmeyr1-79/+77
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
2018-11-27add 'make check' targetNeels Hofmeyr1-2/+2
Generate *.check files from asciidoc output and grep for WARNINGs. Add *.check files to gitignore and to 'make clean'. Change-Id: Ibccc83a3415930a528f2e8e4e4dda3b81c6d0b64
2018-11-27make clean: also remove generated image filesNeels Hofmeyr1-1/+2
Change-Id: I80798e79b4ccee64f26f58f9754de02b2958e33e
2018-11-27OsmoBTS/abis/rsl: add missing info for Osmocom Dyn ChannelsNeels Hofmeyr1-6/+29
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
2018-11-27OsmoBTS/abis/rsl: cosmetic: 'IPA style'Neels Hofmeyr1-13/+15
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
2018-11-27OsmoBTS/chapters/configuration.adoc: fix index numberingNeels Hofmeyr1-1/+1
Change-Id: Ibe507fe36e0130377dec361d56fd75596ca64e75
2018-11-27osmobts-usermanual.adoc: fix link to abis.adoc chapterNeels Hofmeyr1-1/+1
The chapter is in ../common/chapters, not in ./chapters Change-Id: I698d83e96cb77900b99a0bd383587b1b68182efb
2018-11-27OsmoBTS/chapters/dynamic-timeslots.adoc: Remove obsolete linksNeels Hofmeyr1-4/+0
Those file never existed and the ladder diagrams are instead at OsmoBTS/abis/dyn_ts*msc. Change-Id: Icbae85b959e80afe7f272a11f33064a3e594da53
2018-11-27OsmoBTS/abis/rsl.adoc: fix missing section headerNeels Hofmeyr1-0/+1
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
2018-11-27OsmoBTS: add vty reference documentationAlexander Couzens4-5/+1705
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
2018-11-27OsmoBTS/abis/dyn_ts_osmocom_style.msc: adjust PDCH Act ackNeels Hofmeyr1-1/+1
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.
2018-11-27OsmoBTS/abis/rsl: fix subtitle for ladder diagram of osmo dyn switchoverNeels Hofmeyr1-1/+1
2018-11-27Add section about configuring power-rampingDaniel Willmann1-0/+27
2018-11-27osmobts-abis: Add Revision log regarding dynamic cannelsHarald Welte1-0/+9
2018-11-27spelling: message discriminator, not descriminatorHarald Welte1-1/+1
2018-11-27Document dynamic channels on Abis, both IPA and Osmocom styleNeels Hofmeyr7-7/+366
Based in ladder diagram and WIP wording for IPA style from Neels Hofmeyr, completed by me.
2018-11-27OsmoBTS: hardware support: remove dup, tweak wordingNeels Hofmeyr1-3/+3
Don't mention the common part twice. Use plural for hw specific parts. No commata before 'and'.
2018-11-27OsmoBTS: wording tweakNeels Hofmeyr1-3/+3
2018-11-27OsmoBTS: typosNeels Hofmeyr1-2/+2
'3GPP specified': when talking about written information, one usually uses the present tense '3GPP specifies'.
2018-11-27abis/oml.doc: remove duplicate sentence partNeels Hofmeyr1-4/+3
2018-11-27Add OsmoBTS control interface descriptionMax2-0/+26
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-19 00:26:52 +0000