<p>Pau Espin Pedrol <strong>merged</strong> this change.</p><p><a href="https://gerrit.osmocom.org/9895">View Change</a></p><div style="white-space:pre-wrap">Approvals:
  Jenkins Builder: Verified
  Harald Welte: Looks good to me, approved

</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">trx: Add Hardware device support section<br><br>Change-Id: I87fc54cf1751f31a3e92d6503625e984f9a6130f<br>---<br>A OsmoTRX/chapters/trx-backends.adoc<br>M OsmoTRX/osmotrx-usermanual.adoc<br>2 files changed, 69 insertions(+), 0 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/OsmoTRX/chapters/trx-backends.adoc b/OsmoTRX/chapters/trx-backends.adoc</span><br><span>new file mode 100644</span><br><span>index 0000000..32ff82a</span><br><span>--- /dev/null</span><br><span>+++ b/OsmoTRX/chapters/trx-backends.adoc</span><br><span>@@ -0,0 +1,67 @@</span><br><span style="color: hsl(120, 100%, 40%);">+[[osmotrx_device_support]]</span><br><span style="color: hsl(120, 100%, 40%);">+== OsmoTRX hardware device support</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+OsmoTRX consists of a _common_ part that applies to all TRX devices as well as</span><br><span style="color: hsl(120, 100%, 40%);">+_hardware-specific_ parts for each TRX device. The hardware-specific parts are</span><br><span style="color: hsl(120, 100%, 40%);">+usually provided by vendor-specific or device-specific libraries that are then</span><br><span style="color: hsl(120, 100%, 40%);">+handled by some OsmoTRX glue code presenting a unified interface towards the</span><br><span style="color: hsl(120, 100%, 40%);">+rest of the code by means of a _RadioDevice_ class.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The common part includes the core TRX architecture as well as code for</span><br><span style="color: hsl(120, 100%, 40%);">+implementing the external interfaces such as the TRX Manager UDP socket,</span><br><span style="color: hsl(120, 100%, 40%);">+control, and VTY interfaces.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The hardware-specific parts include support for driving one particular</span><br><span style="color: hsl(120, 100%, 40%);">+implementation of a radio modem.  Such a physical layer</span><br><span style="color: hsl(120, 100%, 40%);">+implementation can come in many forms.  Sometimes it runs on a general</span><br><span style="color: hsl(120, 100%, 40%);">+purpose CPU, sometimes on a dedicated ARM core, a dedicated DSP, a</span><br><span style="color: hsl(120, 100%, 40%);">+combination of DSP and FPGA.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Joining the common part with each of the available backends results in a</span><br><span style="color: hsl(120, 100%, 40%);">+different binary with different suffix for each backend. For instance, when</span><br><span style="color: hsl(120, 100%, 40%);">+OsmoTRX is built with UHD backend, an _osmo-trx-uhd_ binary is generated; when</span><br><span style="color: hsl(120, 100%, 40%);">+OsmoTRX is built with LimeSuite backend, an _osmo-trx-lms_ binary is generated.</span><br><span style="color: hsl(120, 100%, 40%);">+Build of different backend can be enabled and disabled by means of configure</span><br><span style="color: hsl(120, 100%, 40%);">+flags, which can be found in each subsection relative to each backend below.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+== `osmo-trx-uhd` for UHD based Transceivers</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+This OsmoTRX model uses _libuhd_ (UHD, USRP Hardware Driver) to drive the</span><br><span style="color: hsl(120, 100%, 40%);">+device, that is configuring it and reading/writing samples from/to it.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+So far, this backend has been mostly used to drive devices such as the Ettus</span><br><span style="color: hsl(120, 100%, 40%);">+B200 family and Fairwaves UmTRX family, and used to be the default backend used</span><br><span style="color: hsl(120, 100%, 40%);">+for legacy @osmo-trx@ binary when per-backend binaries didn't exist yet.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Any device providing generic support for UHD should theoretically be able to be</span><br><span style="color: hsl(120, 100%, 40%);">+run through this backend without much effort, but pracitcal experience showed</span><br><span style="color: hsl(120, 100%, 40%);">+that some devices don't play well with it, such as the LimeSDR family of</span><br><span style="color: hsl(120, 100%, 40%);">+devices, which showed far better results when using its native interface.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Related code can be found in the _Transceiver52M/device/uhd/_ directory in</span><br><span style="color: hsl(120, 100%, 40%);">+_osmo-trx.git_.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+== `osmo-trx-lms` for LimeSuite based Transceivers</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+This OsmoTRX model uses LimeSuite API and library to drive the device, that is</span><br><span style="color: hsl(120, 100%, 40%);">+configuring it and reading/writing samples from/to it.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+This backend was developed in order to be used together with LimeSDR-USB and</span><br><span style="color: hsl(120, 100%, 40%);">+LimeSDR-mini devices, due to to the poor results obtained with the UHD backend,</span><br><span style="color: hsl(120, 100%, 40%);">+and to simplify the stack.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Related code can be found in the _Transceiver52M/device/lms/_ directory in</span><br><span style="color: hsl(120, 100%, 40%);">+_osmo-trx.git_.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+== `osmo-trx-usrp1` for libusrp based Transceivers</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+This OsmoTRX model uses the legacy libusrp driver provided in GNU Radio 3.4.2.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+As this code was dropped from GNU Radio at some point and was found very</span><br><span style="color: hsl(120, 100%, 40%);">+difficult to build, some work was done to create a standalone libusrp which can</span><br><span style="color: hsl(120, 100%, 40%);">+be nowadays found as a separate git repository together with other osmocom git</span><br><span style="color: hsl(120, 100%, 40%);">+repositories, in https://git.osmocom.org/libusrp/</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Related code can be found in the _Transceiver52M/device/usrp1/_ directory in</span><br><span style="color: hsl(120, 100%, 40%);">+_osmo-trx.git_.</span><br><span>diff --git a/OsmoTRX/osmotrx-usermanual.adoc b/OsmoTRX/osmotrx-usermanual.adoc</span><br><span>index f2ccbaf..7d04f78 100644</span><br><span>--- a/OsmoTRX/osmotrx-usermanual.adoc</span><br><span>+++ b/OsmoTRX/osmotrx-usermanual.adoc</span><br><span>@@ -25,6 +25,8 @@</span><br><span> </span><br><span> include::chapters/trx-architectures.adoc[]</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+include::chapters/trx-backends.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> include::../common/chapters/trx_if.adoc[]</span><br><span> </span><br><span> include::../common/chapters/port_numbers.adoc[]</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/9895">change 9895</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/9895"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: osmo-gsm-manuals </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: merged </div>
<div style="display:none"> Gerrit-Change-Id: I87fc54cf1751f31a3e92d6503625e984f9a6130f </div>
<div style="display:none"> Gerrit-Change-Number: 9895 </div>
<div style="display:none"> Gerrit-PatchSet: 2 </div>
<div style="display:none"> Gerrit-Owner: Pau Espin Pedrol <pespin@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: Harald Welte <laforge@gnumonks.org> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder </div>
<div style="display:none"> Gerrit-Reviewer: Pau Espin Pedrol <pespin@sysmocom.de> </div>
<div style="display:none"> Gerrit-CC: Vadim Yanitskiy <axilirator@gmail.com> </div>