diff options
Diffstat (limited to 'doc/manuals/chapters/configuration.adoc')
| -rw-r--r-- | doc/manuals/chapters/configuration.adoc | 63 |
1 files changed, 41 insertions, 22 deletions
diff --git a/doc/manuals/chapters/configuration.adoc b/doc/manuals/chapters/configuration.adoc index 558bd4ba..f6ca75e1 100644 --- a/doc/manuals/chapters/configuration.adoc +++ b/doc/manuals/chapters/configuration.adoc @@ -14,12 +14,12 @@ OsmoBTS software. === Command Line Options -Ths OsmoBTS executables (`osmo-bts-sysmo`, `osmo-bts-trx`, +The OsmoBTS executables (`osmo-bts-sysmo`, `osmo-bts-trx`, `osmo-bts-octphy`, `osmo-bts-litecell15`, ...) share the following generic command line options: ==== SYNOPSIS -*osmo-bts-sysmo* [-h|-V] [-d 'DBGMASK'] [-D] [-c 'CONFIGFILE' ] [-s] [-T] [-e 'LOGLEVEL'] [-r 'PRIO'] [-i 'GSMTAP-IP'] [-t <1-255>] +*osmo-bts-sysmo* [-h|-V] [-d 'DBGMASK'] [-D] [-c 'CONFIGFILE' ] [-s] [-T] [-e 'LOGLEVEL'] ==== OPTIONS *-h, --help*:: @@ -48,16 +48,6 @@ generic command line options: Set the global log level for logging to stderr. This has mostly been deprecated by VTY based logging configuration, see <<logging>> for further information. -*-r, --realtime 'PRIO'*:: - Enable use of the Linux kernel realtime priority scheduler with - the specified priority. - It is recommended you use this option on low-performance - embedded systems or systems that encounter high non-GSM/GPRS - load. -*-i, --gsmtap-ip 'GSMTAP-IP'*:: - Specify the destination IP address for GSMTAP messages. -*-t, --trx-num <1-255>*:: - Specify the number of TRX supported by this BTS. There may be additional, hardware specific command line options by the different bts_model implementations. @@ -118,11 +108,22 @@ them via UDP/IP. At that point, they can be captured with utilities like *tcpdump* or *tshark* for further analysis by the *wireshark* protocol analyzer. -In order to activate this feature, you first need to make sure to start -OsmoBTS using the `-i` or `--gsmtap-ip` command line option, specifying -the destination IP address for the GSMTAP messages. In most cases, -using 127.0.0.1 for passing the messages over the loopback (`lo`) device -will be sufficient. +In order to activate this feature, you first need to make sure to specify +the remote address of _GSMTAP_ host in the configuration file. In most +cases, using 127.0.0.1 for passing the messages over the loopback (`lo`) +device will be sufficient: + +.Example: Enabling GSMTAP Um-frame logging to localhost +---- +bts 0 + gsmtap-remote-host 127.0.0.1 <1> +---- +<1> Destination address for _GSMTAP_ Um-frames + +NOTE: Changing this parameter at run-time will not affect the existing +_GSMTAP_ connection, full program restart is required. + +NOTE: Command line parameters `-i` and `--gsmtap-ip` have been deprecated. OsmoBTS can selectively trace such messages by their L1 SAPI, for both Rx and Tx. For a complete list of L1 SAPI values, please refer to the @@ -137,8 +138,7 @@ node of the OsmoBTS VTY. OsmoBTS> enable OsmoBTS# configure terminal OsmoBTS(config)# bts 0 -OsmoBTS(bts)# trx 0 -OsmoBTS(trx)# gsmtap-sapi sdcch +OsmoBTS(bts)# gsmtap-sapi sdcch OsmoBTS(trx)# write <1> ---- <1> the `write` command will make the configuration persistent in the @@ -146,18 +146,37 @@ configuration file. This is not required if you wish to enable GSMTAP only in the current session of OsmoBTS. De-activation can be performed similarly by using the `no gsmtap-sapi -sdcch` command at the `trx` node of the OsmoBTS VTY. +sdcch` command at the `bts` node of the OsmoBTS VTY. + +It may be useful to enable all SAPIs with a few exceptions, or vice versa +disable everything using one command. For this purpose, the VTY provides +`gsmtap-sapi enable-all` and `gsmtap-sapi disable-all` commands. + +.Example: Enabling all SAPIs except PDTCH and PTCCH +---- +bts 0 + gsmtap-sapi enable-all <1> + no gsmtap-sapi pdtch <2> + no gsmtap-sapi ptcch <2> +---- +<1> Enable all available SAPIs +<2> Exclude PDTCH and PTCCH SAPIs From the moment they are enabled via VTY, GSMTAP messages will be generated and sent in UDP encapsulation to the IANA-registered UDP port -for GSMTAP (4729) at the IP address specified in the command line -argument. +for GSMTAP (4729) of the specified remote address. ==== Configuring power ramping OsmoBTS can ramp up the power of its trx over time. This helps reduce cell congestion in busy environments. +Some models of OsmoBTS (such as osmo-bts-trx) also support ramping down the +transmit power over time until finally ceasing broadcast, for instance due to a +trx becoming administratively locked or due to the whole BTS being gracefully +shut down. This allows for mobile stations camping on the cell to gradually move +to other cells in the area once the signal drop is detected. + In this example, the trx starts with 5dBm output power which increases by 1dB every two seconds until it reaches nominal power. Power ramping can use the power-ramp commands at the CONFIG TRX node of the |