aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorPau Espin Pedrol <pespin@sysmocom.de>2018-09-19 16:36:31 +0200
committerNeels Hofmeyr <neels@hofmeyr.de>2018-11-27 18:36:18 +0100
commit39842562738953be688b35e087425e987204adad (patch)
tree567eeba47aa0117b2c37c7bf7fa55c6dd94da0cc /doc
parentd06172ce32207322bd082b91a0eb29f878d1d39b (diff)
osmotrx: Split Device specific section from backend one
Device specific sections will be added to this new chapter. Change-Id: Id96cbf857e2ef92d9ad2cb58fd18132f981447d7
Diffstat (limited to 'doc')
-rw-r--r--doc/manuals/chapters/trx-backends.adoc26
-rw-r--r--doc/manuals/chapters/trx-devices.adoc25
-rw-r--r--doc/manuals/osmotrx-usermanual.adoc2
3 files changed, 27 insertions, 26 deletions
diff --git a/doc/manuals/chapters/trx-backends.adoc b/doc/manuals/chapters/trx-backends.adoc
index 32ff82a..5da2e5c 100644
--- a/doc/manuals/chapters/trx-backends.adoc
+++ b/doc/manuals/chapters/trx-backends.adoc
@@ -1,29 +1,3 @@
-[[osmotrx_device_support]]
-== OsmoTRX hardware device support
-
-OsmoTRX consists of a _common_ part that applies to all TRX devices as well as
-_hardware-specific_ parts for each TRX device. The hardware-specific parts are
-usually provided by vendor-specific or device-specific libraries that are then
-handled by some OsmoTRX glue code presenting a unified interface towards the
-rest of the code by means of a _RadioDevice_ class.
-
-The common part includes the core TRX architecture as well as code for
-implementing the external interfaces such as the TRX Manager UDP socket,
-control, and VTY interfaces.
-
-The hardware-specific parts include support for driving one particular
-implementation of a radio modem. Such a physical layer
-implementation can come in many forms. Sometimes it runs on a general
-purpose CPU, sometimes on a dedicated ARM core, a dedicated DSP, a
-combination of DSP and FPGA.
-
-Joining the common part with each of the available backends results in a
-different binary with different suffix for each backend. For instance, when
-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.
-
== `osmo-trx-uhd` for UHD based Transceivers
This OsmoTRX model uses _libuhd_ (UHD, USRP Hardware Driver) to drive the
diff --git a/doc/manuals/chapters/trx-devices.adoc b/doc/manuals/chapters/trx-devices.adoc
new file mode 100644
index 0000000..08ef773
--- /dev/null
+++ b/doc/manuals/chapters/trx-devices.adoc
@@ -0,0 +1,25 @@
+[[osmotrx_device_support]]
+== OsmoTRX hardware device support
+
+OsmoTRX consists of a _common_ part that applies to all TRX devices as well as
+_hardware-specific_ parts for each TRX device. The hardware-specific parts are
+usually provided by vendor-specific or device-specific libraries that are then
+handled by some OsmoTRX glue code presenting a unified interface towards the
+rest of the code by means of a _RadioDevice_ class.
+
+The common part includes the core TRX architecture as well as code for
+implementing the external interfaces such as the TRX Manager UDP socket,
+control, and VTY interfaces.
+
+The hardware-specific parts include support for driving one particular
+implementation of a radio modem. Such a physical layer
+implementation can come in many forms. Sometimes it runs on a general
+purpose CPU, sometimes on a dedicated ARM core, a dedicated DSP, a
+combination of DSP and FPGA.
+
+Joining the common part with each of the available backends results in a
+different binary with different suffix for each backend. For instance, when
+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.
diff --git a/doc/manuals/osmotrx-usermanual.adoc b/doc/manuals/osmotrx-usermanual.adoc
index 7d04f78..a713e4a 100644
--- a/doc/manuals/osmotrx-usermanual.adoc
+++ b/doc/manuals/osmotrx-usermanual.adoc
@@ -25,6 +25,8 @@ include::chapters/configuration.adoc[]
include::chapters/trx-architectures.adoc[]
+include::chapters/trx-devices.adoc[]
+
include::chapters/trx-backends.adoc[]
include::../common/chapters/trx_if.adoc[]