diff options
authorPau Espin Pedrol <pespin@sysmocom.de>2018-09-19 17:05:30 +0200
committerNeels Hofmeyr <neels@hofmeyr.de>2018-11-27 18:36:18 +0100
commit6b50b62b120049a4346420ed4088316962b79200 (patch)
parent39842562738953be688b35e087425e987204adad (diff)
osmotrx: Write initial documentation for several supported devices
2 files changed, 68 insertions, 1 deletions
diff --git a/doc/manuals/chapters/trx-backends.adoc b/doc/manuals/chapters/trx-backends.adoc
index 5da2e5c..e801886 100644
--- a/doc/manuals/chapters/trx-backends.adoc
+++ b/doc/manuals/chapters/trx-backends.adoc
@@ -1,3 +1,4 @@
== `osmo-trx-uhd` for UHD based Transceivers
This OsmoTRX model uses _libuhd_ (UHD, USRP Hardware Driver) to drive the
@@ -15,6 +16,7 @@ devices, which showed far better results when using its native interface.
Related code can be found in the _Transceiver52M/device/uhd/_ directory in
== `osmo-trx-lms` for LimeSuite based Transceivers
This OsmoTRX model uses LimeSuite API and library to drive the device, that is
@@ -27,7 +29,7 @@ and to simplify the stack.
Related code can be found in the _Transceiver52M/device/lms/_ directory in
== `osmo-trx-usrp1` for libusrp based Transceivers
This OsmoTRX model uses the legacy libusrp driver provided in GNU Radio 3.4.2.
diff --git a/doc/manuals/chapters/trx-devices.adoc b/doc/manuals/chapters/trx-devices.adoc
index 08ef773..10c8529 100644
--- a/doc/manuals/chapters/trx-devices.adoc
+++ b/doc/manuals/chapters/trx-devices.adoc
@@ -23,3 +23,68 @@ OsmoTRX is built with UHD backend, an _osmo-trx-uhd_ binary is generated; when
OsmoTRX is built with LimeSuite backend, an _osmo-trx-lms_ binary is generated.
Build of different backend can be enabled and disabled by means of configure
flags, which can be found in each subsection relative to each backend below.
+=== Ettus USRP1
+The binary _osmo-trx-usrp1_ is used to drive this device, see <<backend_usrp1>>.
+=== Ettus B200
+The binary _osmo-trx-uhd_ is used to drive this device, see <<backend_uhd>>.
+Comes only with 1 RF channel. It can still be used in a multi-TRX setup by using
+the <<multiarfcn_mode>> feature. By using this feature, one can drive up to 3
+TRX (with the restrictions explained there).
+=== Ettus B210
+The binary _osmo-trx-uhd_ is used to drive this device, see <<backend_uhd>>.
+Comes with 2 RF channels, which can be used to set up a multi-TRX BTS. However,
+due to a shared local oscillator for both RF channels, ARFCN separation can be
+up about 25 MHz.
+This device also supports the <<multiarfcn_mode>> feature. By using this
+feature, one can drive up to 3 TRX (with the restrictions explained there).
+Please note that the above configurations cannot be combined, which means
+maximum number of TRX one can achieve is 2 by using separate physical RF
+channels, or 3 by using multi-ARFCN method. You cannot support, for example, 6
+ARFCN operation on B210 using 3 TRX on side A and another 3 TRX on side B.
+=== LimeSDR-USB
+The binary _osmo-trx-lms_ is used to drive this device, see <<backend_lms>>.
+This device comes with 2 RF channels, so it should theoretically be possible to
+run a multi-TRX setup with it, but there are yet no records that this kind of
+setup was tested with this device.
+This device has 3 different Rx paths with different antenna connectors in the
+PCB, each with a different frequency and bandwidth range. One should make sure
+the physical antenna is connected to the correct connector matching the Rx path
+you want to use. If one wants to be able to use the device in both 900 and 1800
+MHz GSM bands and easily switch between them, then Rx Path `LNAW` should be used
+,since it is the only one covering both bands, and the antenna physically plugged
+accordingly. Following example shows how to then configure _osmo-trx-lms_ to use
+that Rx path to read samples.
+.Example: Configure osmo-trx-lms to use LNAW as Rx path and BAND1 as Tx Path
+ ...
+ chan 0
+ tx-path BAND1
+ rx-path LNAW
+=== LimeSDR-mini
+The binary _osmo-trx-lms_ is used to drive this device, see <<backend_lms>>.
+As a smaller brother of the [[dev_limesdr_usb]], this device comes only with 1
+RF channel. As a result, it can only hold 1 TRX as of today.