<p>pespin has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/c/osmo-trx/+/14985">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">Drop old README information, provide new updated README<br><br>Previous content in README file is actually a description of the TRXD<br>and TRXC protocols, and it has already been moved to the User Manual<br>some time ago. INSTALLATION contained README related information, but it<br>was really out of date.<br><br>So this commit basically drops those two files and provides a new README<br>with content taken from Osmocom's OsmoTRX project wiki page.<br><br>Change-Id: I3df00799ce80aa4af43225e69a408ba2cbc444db<br>---<br>D INSTALLATION<br>M Makefile.am<br>M README<br>3 files changed, 18 insertions(+), 132 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/osmo-trx refs/changes/85/14985/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/INSTALLATION b/INSTALLATION</span><br><span>deleted file mode 100644</span><br><span>index f87b6cc..0000000</span><br><span>--- a/INSTALLATION</span><br><span>+++ /dev/null</span><br><span>@@ -1,19 +0,0 @@</span><br><span style="color: hsl(0, 100%, 40%);">-Installation Requirements</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-osmo-trx compiles to a simple Unix binary and does not require special</span><br><span style="color: hsl(0, 100%, 40%);">-installation.</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-One some systems (Ubuntu), you will need to define LIBS = -lpthread prior to</span><br><span style="color: hsl(0, 100%, 40%);">-running configure.</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-To run osmo-trx, the following should be installed:</span><br><span style="color: hsl(0, 100%, 40%);">- libuhd (https://gnuradio.org).</span><br><span style="color: hsl(0, 100%, 40%);">- This is part of the GNURadio installation.</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-For information on specific executables, see tests/README.tests and</span><br><span style="color: hsl(0, 100%, 40%);">-apps/README.apps.</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-See https://osmocom.org/projects/osmotrx/wiki/OsmoTRX for more</span><br><span style="color: hsl(0, 100%, 40%);">-information.</span><br><span>diff --git a/Makefile.am b/Makefile.am</span><br><span>index 3e87200..ccc39a2 100644</span><br><span>--- a/Makefile.am</span><br><span>+++ b/Makefile.am</span><br><span>@@ -36,7 +36,6 @@</span><br><span> tests</span><br><span> </span><br><span> EXTRA_DIST = \</span><br><span style="color: hsl(0, 100%, 40%);">- INSTALLATION \</span><br><span> LEGAL \</span><br><span> COPYING \</span><br><span> README</span><br><span>diff --git a/README b/README</span><br><span>index 502d661..7747fc8 100644</span><br><span>--- a/README</span><br><span>+++ b/README</span><br><span>@@ -1,116 +1,22 @@</span><br><span style="color: hsl(0, 100%, 40%);">-This is the interface to the transcevier.</span><br><span style="color: hsl(120, 100%, 40%);">+About OsmTRX</span><br><span style="color: hsl(120, 100%, 40%);">+=============</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-Each TRX Manager UDP socket interface represents a single ARFCN.</span><br><span style="color: hsl(0, 100%, 40%);">-Each of these per-ARFCN interfaces is a pair of UDP sockets, one for control and one for data.</span><br><span style="color: hsl(0, 100%, 40%);">-Give a base port B (5700), the master clock interface is at port P=B.</span><br><span style="color: hsl(0, 100%, 40%);">-The TRX-side control interface for C(N) is on port P=B+2N+1 and the data interface is on an odd numbered port P=B+2N+2.</span><br><span style="color: hsl(0, 100%, 40%);">-The corresponding core-side interface for every socket is at P+100.</span><br><span style="color: hsl(0, 100%, 40%);">-For any given build, the number of ARFCN interfaces can be fixed.</span><br><span style="color: hsl(120, 100%, 40%);">+OsmoTRX is a software-defined radio transceiver that implements the Layer 1</span><br><span style="color: hsl(120, 100%, 40%);">+physical layer of a BTS comprising the following 3GPP specifications:</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+* TS 05.01 "Physical layer on the radio path"</span><br><span style="color: hsl(120, 100%, 40%);">+* TS 05.02 "Multiplexing and Multiple Access on the Radio Path"</span><br><span style="color: hsl(120, 100%, 40%);">+* TS 05.04 "Modulation"</span><br><span style="color: hsl(120, 100%, 40%);">+* TS 05.10 "Radio subsystem synchronization"</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+OsmoTRX is based on the transceiver code from the OpenBTS project, but setup to</span><br><span style="color: hsl(120, 100%, 40%);">+operate independently with the purpose of using with non-OpenBTS software and</span><br><span style="color: hsl(120, 100%, 40%);">+projects, while still maintaining backwards compatibility with OpenBTS when</span><br><span style="color: hsl(120, 100%, 40%);">+possible. Currently there are numerous features contained in OsmoTRX that extend</span><br><span style="color: hsl(120, 100%, 40%);">+the functionality of the OpenBTS transceiver. These features include enhanced</span><br><span style="color: hsl(120, 100%, 40%);">+support for various embedded platforms - notably ARM - and dual channel</span><br><span style="color: hsl(120, 100%, 40%);">+diversity support for the Fairwaves umtrx.</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-Indications on the Master Clock Interface</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-The master clock interface is output only (from the radio).</span><br><span style="color: hsl(0, 100%, 40%);">-Messages are "indications".</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-CLOCK gives the current value of the transceiver clock to be used by the core.</span><br><span style="color: hsl(0, 100%, 40%);">-This message is sent whenever a trasmission packet arrives that is too late or too early. The clock value is NOT the current transceiver time. It is a time setting the the core should use to give better packet arrival times.</span><br><span style="color: hsl(0, 100%, 40%);">-IND CLOCK <totalFrames></span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-Commands on the Per-ARFCN Control Interface</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-The per-ARFCN control interface uses a command-reponse protocol.</span><br><span style="color: hsl(0, 100%, 40%);">-Commands are NULL-terminated ASCII strings, one per UDP socket.</span><br><span style="color: hsl(0, 100%, 40%);">-Each command has a corresponding response.</span><br><span style="color: hsl(0, 100%, 40%);">-Every command is of the form:</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-CMD <cmdtype> [params]</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-The <cmdtype> is the actual command.</span><br><span style="color: hsl(0, 100%, 40%);">-Parameters are optional depending on the commands type.</span><br><span style="color: hsl(0, 100%, 40%);">-Every response is of the form:</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-RSP <cmdtype> <status> [result]</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-The <status> is 0 for success and a non-zero error code for failure.</span><br><span style="color: hsl(0, 100%, 40%);">-Successful responses may include results, depending on the command type.</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-Power Control</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-POWEROFF shuts off transmitter power and stops the demodulator.</span><br><span style="color: hsl(0, 100%, 40%);">-CMD POWEROFF</span><br><span style="color: hsl(0, 100%, 40%);">-RSP POWEROFF <status></span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-POWERON starts the transmitter and starts the demodulator. Initial power level is very low.</span><br><span style="color: hsl(0, 100%, 40%);">-This command fails if the transmitter and receiver are not yet tuned.</span><br><span style="color: hsl(0, 100%, 40%);">-This command fails if the transmit or receive frequency creates a conflict with another ARFCN that is already runnng.</span><br><span style="color: hsl(0, 100%, 40%);">-If the transceiver is already on, it response with success to this command.</span><br><span style="color: hsl(0, 100%, 40%);">-CMD POWERON</span><br><span style="color: hsl(0, 100%, 40%);">-RSP POWERON <status></span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-SETPOWER sets output power in dB wrt full scale.</span><br><span style="color: hsl(0, 100%, 40%);">-This command fails if the transmitter and receiver are not running.</span><br><span style="color: hsl(0, 100%, 40%);">-CMD SETPOWER <dB></span><br><span style="color: hsl(0, 100%, 40%);">-RSP SETPOWER <status> <dB></span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-ADJPOWER adjusts power by the given dB step. Response returns resulting power level wrt full scale.</span><br><span style="color: hsl(0, 100%, 40%);">-This command fails if the transmitter and receiver are not running.</span><br><span style="color: hsl(0, 100%, 40%);">-CMD ADJPOWER <dBStep></span><br><span style="color: hsl(0, 100%, 40%);">-RSP ADJPOWER <status> <dBLevel></span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-Tuning Control</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-RXTUNE tunes the receiver to a given frequency in kHz.</span><br><span style="color: hsl(0, 100%, 40%);">-This command fails if the receiver is already running.</span><br><span style="color: hsl(0, 100%, 40%);">-(To re-tune you stop the radio, re-tune, and restart.)</span><br><span style="color: hsl(0, 100%, 40%);">-This command fails if the transmit or receive frequency creates a conflict with another ARFCN that is already runnng.</span><br><span style="color: hsl(0, 100%, 40%);">-CMD RXTUNE <kHz></span><br><span style="color: hsl(0, 100%, 40%);">-RSP RXTUNE <status> <kHz></span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-TXTUNE tunes the transmitter to a given frequency in kHz.</span><br><span style="color: hsl(0, 100%, 40%);">-This command fails if the transmitter is already running.</span><br><span style="color: hsl(0, 100%, 40%);">-(To re-tune you stop the radio, re-tune, and restart.)</span><br><span style="color: hsl(0, 100%, 40%);">-This command fails if the transmit or receive frequency creates a conflict with another ARFCN that is already runnng.</span><br><span style="color: hsl(0, 100%, 40%);">-CMD TXTUNE <kHz></span><br><span style="color: hsl(0, 100%, 40%);">-RSP TXTUNE <status> <kHz></span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-Timeslot Control</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-SETSLOT sets the format of the uplink timeslots in the ARFCN.</span><br><span style="color: hsl(0, 100%, 40%);">-The <timeslot> indicates the timeslot of interest.</span><br><span style="color: hsl(0, 100%, 40%);">-The <chantype> indicates the type of channel that occupies the timeslot.</span><br><span style="color: hsl(0, 100%, 40%);">-A chantype of zero indicates the timeslot is off.</span><br><span style="color: hsl(0, 100%, 40%);">-CMD SETSLOT <timeslot> <chantype></span><br><span style="color: hsl(0, 100%, 40%);">-RSP SETSLOT <status> <timeslot> <chantype></span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-Messages on the per-ARFCN Data Interface</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-Messages on the data interface carry one radio burst per UDP message.</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-Received Data Burst</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-1 byte timeslot index</span><br><span style="color: hsl(0, 100%, 40%);">-4 bytes GSM frame number, big endian</span><br><span style="color: hsl(0, 100%, 40%);">-1 byte RSSI in -dBm</span><br><span style="color: hsl(0, 100%, 40%);">-2 bytes correlator timing offset in 1/256 symbol steps, 2's-comp, big endian</span><br><span style="color: hsl(0, 100%, 40%);">-148 bytes soft symbol estimates, 0 -> definite "0", 255 -> definite "1"</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-Transmit Data Burst</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-1 byte timeslot index</span><br><span style="color: hsl(0, 100%, 40%);">-4 bytes GSM frame number, big endian</span><br><span style="color: hsl(0, 100%, 40%);">-1 byte transmit level wrt ARFCN max, -dB (attenuation)</span><br><span style="color: hsl(0, 100%, 40%);">-148 bytes output symbol values, 0 & 1</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(120, 100%, 40%);">+Find OsmoTRX issue tracker and wiki online at</span><br><span style="color: hsl(120, 100%, 40%);">+https://osmocom.org/projects/osmotrx</span><br><span style="color: hsl(120, 100%, 40%);">+https://osmocom.org/projects/osmotrx/wiki/OsmoTRX</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/osmo-trx/+/14985">change 14985</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/c/osmo-trx/+/14985"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: osmo-trx </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: I3df00799ce80aa4af43225e69a408ba2cbc444db </div>
<div style="display:none"> Gerrit-Change-Number: 14985 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: pespin <pespin@sysmocom.de> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>