<p>Pau Espin Pedrol <strong>merged</strong> this change.</p><p><a href="https://gerrit.osmocom.org/9894">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 architecture support section<br><br>Change-Id: I38388bcb2ea7c0481052d3bca589cb34965ea7fa<br>---<br>A OsmoTRX/chapters/trx-architectures.adoc<br>M OsmoTRX/osmotrx-usermanual.adoc<br>2 files changed, 36 insertions(+), 0 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/OsmoTRX/chapters/trx-architectures.adoc b/OsmoTRX/chapters/trx-architectures.adoc</span><br><span>new file mode 100644</span><br><span>index 0000000..66eae5e</span><br><span>--- /dev/null</span><br><span>+++ b/OsmoTRX/chapters/trx-architectures.adoc</span><br><span>@@ -0,0 +1,34 @@</span><br><span style="color: hsl(120, 100%, 40%);">+[[osmotrx_arch_support]]</span><br><span style="color: hsl(120, 100%, 40%);">+== OsmoTRX hardware architecture support</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+OsmoTRX comes out-of-the-box with several algorithms and operations</span><br><span style="color: hsl(120, 100%, 40%);">+optimized for certain instruction-set architectures, as well as non-optimized</span><br><span style="color: hsl(120, 100%, 40%);">+fall-back algorithms in case required instruction sets are not supported by the</span><br><span style="color: hsl(120, 100%, 40%);">+compiler at compile time or by the executing machine at run-time. Support for</span><br><span style="color: hsl(120, 100%, 40%);">+these optimized algorithms can be enabled and disabled by means of configure</span><br><span style="color: hsl(120, 100%, 40%);">+flags. Accelerated operations include pulse shape filtering, resampling,</span><br><span style="color: hsl(120, 100%, 40%);">+sequence correlation, and many other signal processing operations.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+On Intel processors, OsmoTRX makes heavy use of the Streaming SIMD Extensions</span><br><span style="color: hsl(120, 100%, 40%);">+(SSE) instruction set.  SSE3 is the minimum requirement for accelerated use.</span><br><span style="color: hsl(120, 100%, 40%);">+SSE3 is present in the majority of Intel processors since later versions of the</span><br><span style="color: hsl(120, 100%, 40%);">+Pentium 4 architecture and is also present on low power Atom processors. Support</span><br><span style="color: hsl(120, 100%, 40%);">+is automatically detected at build time. SSE4.1 instruction set is supported</span><br><span style="color: hsl(120, 100%, 40%);">+too. This feature is enabled by default unless explicitly disabled by passing</span><br><span style="color: hsl(120, 100%, 40%);">+the configure flag _--with-sse=no_. When enabled, the compiler will build an</span><br><span style="color: hsl(120, 100%, 40%);">+extra version of each of the supported algorithms using each of the supported</span><br><span style="color: hsl(120, 100%, 40%);">+mentioned instruction sets. Then, at run-time, OsmoTRX will auto-detect</span><br><span style="color: hsl(120, 100%, 40%);">+capabilities of the executing machine and enable an optimized algorithm using</span><br><span style="color: hsl(120, 100%, 40%);">+the most suitable available (previously compiled) instruction set.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+On ARM processors, NEON and NEON FMA are supported. Different to the x86, there</span><br><span style="color: hsl(120, 100%, 40%);">+is no auto-detection in this case, nor difference between compile and runtime.</span><br><span style="color: hsl(120, 100%, 40%);">+NEON support is disabled by default and can be enabled by passing the flag</span><br><span style="color: hsl(120, 100%, 40%);">+_--with-neon=yes_ to the configure script; the used compiler must support NEON</span><br><span style="color: hsl(120, 100%, 40%);">+instruction set and the resulting binary will only run fine on an ARM board</span><br><span style="color: hsl(120, 100%, 40%);">+supporting NEON extensions. Running OsmoTRX built with flag _--with-neon_ on a</span><br><span style="color: hsl(120, 100%, 40%);">+board without NEON instruction set support, will most probably end up in the</span><br><span style="color: hsl(120, 100%, 40%);">+process being killed with a _SIGILL_ Illegal Instruction signal by the operating</span><br><span style="color: hsl(120, 100%, 40%);">+system. NEON FMA (Fused Multiply-Add) is an extension to the NEON instruction</span><br><span style="color: hsl(120, 100%, 40%);">+set, and its use in OsmoTRX can be enabled by passing the _--with_neon_vfpv4_</span><br><span style="color: hsl(120, 100%, 40%);">+flag, which will also implicitly enable NEON support (_--with_neon_).</span><br><span>diff --git a/OsmoTRX/osmotrx-usermanual.adoc b/OsmoTRX/osmotrx-usermanual.adoc</span><br><span>index 3b2e991..f2ccbaf 100644</span><br><span>--- a/OsmoTRX/osmotrx-usermanual.adoc</span><br><span>+++ b/OsmoTRX/osmotrx-usermanual.adoc</span><br><span>@@ -23,6 +23,8 @@</span><br><span> </span><br><span> include::chapters/configuration.adoc[]</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+include::chapters/trx-architectures.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/9894">change 9894</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/9894"/><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: I38388bcb2ea7c0481052d3bca589cb34965ea7fa </div>
<div style="display:none"> Gerrit-Change-Number: 9894 </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>