aboutsummaryrefslogtreecommitdiffstats
path: root/Transceiver52M/osmo-trx.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'Transceiver52M/osmo-trx.cpp')
-rw-r--r--Transceiver52M/osmo-trx.cpp412
1 files changed, 412 insertions, 0 deletions
diff --git a/Transceiver52M/osmo-trx.cpp b/Transceiver52M/osmo-trx.cpp
new file mode 100644
index 0000000..3135dc6
--- /dev/null
+++ b/Transceiver52M/osmo-trx.cpp
@@ -0,0 +1,412 @@
+/*
+ * Copyright (C) 2013 Thomas Tsou <tom@tsou.cc>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include "Transceiver.h"
+#include "radioDevice.h"
+
+#include <time.h>
+#include <signal.h>
+#include <stdlib.h>
+#include <unistd.h>
+
+#include <GSMCommon.h>
+#include <Logger.h>
+#include <Configuration.h>
+
+#define CONFIGDB "/etc/OpenBTS/OpenBTS.db"
+
+/* Samples-per-symbol for downlink path
+ * 4 - Uses precision modulator (more computation, less distortion)
+ * 1 - Uses minimized modulator (less computation, more distortion)
+ *
+ * Other values are invalid. Receive path (uplink) is always
+ * downsampled to 1 sps. Default to 4 sps for all cases except for
+ * ARM and non-SIMD enabled architectures.
+ */
+#if defined(HAVE_NEON) || !defined(HAVE_SSE3)
+#define DEFAULT_SPS 1
+#else
+#define DEFAULT_SPS 4
+#endif
+
+/* Default configuration parameters
+ * Note that these values are only used if the particular key does not
+ * exist in the configuration database. IP port and address values will
+ * typically be overwritten by the OpenBTS.db values. Other values will
+ * not be in the database by default.
+ */
+#define DEFAULT_TRX_PORT 5700
+#define DEFAULT_TRX_IP "127.0.0.1"
+#define DEFAULT_EXTREF false
+#define DEFAULT_DIVERSITY false
+#define DEFAULT_CHANS 1
+
+struct trx_config {
+ std::string log_level;
+ std::string addr;
+ std::string dev_args;
+ unsigned port;
+ unsigned sps;
+ unsigned chans;
+ bool extref;
+ bool diversity;
+};
+
+ConfigurationTable gConfig(CONFIGDB);
+
+volatile bool gshutdown = false;
+
+/* Run sanity check on configuration table
+ * The global table constructor cannot provide notification in the
+ * event of failure. Make sure that we can open the database file,
+ * write to it, and that it contains the bare minimum required keys.
+ */
+bool testConfig(const char *filename)
+{
+ int rc, val = 9999;
+ sqlite3 *db;
+ std::string test = "asldfkjsaldkf";
+ const char *key = "Log.Level";
+
+ /* Try to open the database */
+ rc = sqlite3_open(filename, &db);
+ if (rc || !db) {
+ std::cerr << std::endl;
+ std::cerr << "Config: Database could not be opened - "
+ << "check that database exists with read access"
+ << std::endl;
+ return false;
+ } else {
+ sqlite3_close(db);
+ }
+
+ /* Attempt to set a test value in the global config */
+ if (!gConfig.set(test, val)) {
+ std::cerr << std::endl;
+ std::cerr << "Config: Failed to set test key - "
+ << "permission to write to database directory?"
+ << std::endl;
+ return false;
+ } else {
+ gConfig.remove(test);
+ }
+
+ /* Attempt to query */
+ try {
+ gConfig.getStr(key);
+ } catch (...) {
+ std::cerr << std::endl;
+ std::cerr << "Config: Failed query required key " << key
+ << std::endl;
+ return false;
+ }
+
+ return true;
+}
+
+/* Setup configuration values
+ * Don't query the existence of the Log.Level because it's a
+ * mandatory value. That is, if it doesn't exist, the configuration
+ * table will crash or will have already crashed. So we check for
+ * it in the initial database sanity check. Everything else we can
+ * survive without and use default values if the database entries
+ * are empty.
+ */
+bool trx_setup_config(struct trx_config *config)
+{
+ std::string refstr, divstr;
+
+ if (!testConfig(CONFIGDB))
+ return false;
+
+ if (config->log_level == "")
+ config->log_level = gConfig.getStr("Log.Level");
+
+ if (!config->port) {
+ if (gConfig.defines("TRX.Port"))
+ config->port = gConfig.getNum("TRX.Port");
+ else
+ config->port = DEFAULT_TRX_PORT;
+ }
+
+ if (config->addr == "") {
+ if (gConfig.defines("TRX.IP"))
+ config->addr = gConfig.getStr("TRX.IP");
+ else
+ config->addr = DEFAULT_TRX_IP;
+ }
+
+ if (!config->extref) {
+ if (gConfig.defines("TRX.Reference"))
+ config->extref = gConfig.getNum("TRX.Reference");
+ else
+ config->extref = DEFAULT_EXTREF;
+ }
+
+ if (!config->diversity) {
+ if (gConfig.defines("TRX.Diversity"))
+ config->diversity = gConfig.getNum("TRX.Diversity");
+ else
+ config->diversity = DEFAULT_DIVERSITY;
+ }
+
+ if (!config->sps)
+ config->sps = DEFAULT_SPS;
+
+ if (!config->chans)
+ config->chans = DEFAULT_CHANS;
+
+ /* Diversity only supported on 2 channels */
+ if (config->diversity)
+ config->chans = 2;
+
+ refstr = config->extref ? "Enabled" : "Disabled";
+ divstr = config->diversity ? "Enabled" : "Disabled";
+
+ std::ostringstream ost("");
+ ost << "Config Settings" << std::endl;
+ ost << " Log Level............... " << config->log_level << std::endl;
+ ost << " Device args............. " << config->dev_args << std::endl;
+ ost << " TRX Base Port........... " << config->port << std::endl;
+ ost << " TRX Address............. " << config->addr << std::endl;
+ ost << " Channels................ " << config->chans << std::endl;
+ ost << " Samples-per-Symbol...... " << config->sps << std::endl;
+ ost << " External Reference...... " << refstr << std::endl;
+ ost << " Diversity............... " << divstr << std::endl;
+ std::cout << ost << std::endl;
+
+ return true;
+}
+
+/* Create radio interface
+ * The interface consists of sample rate changes, frequency shifts,
+ * channel multiplexing, and other conversions. The transceiver core
+ * accepts input vectors sampled at multiples of the GSM symbol rate.
+ * The radio interface connects the main transceiver with the device
+ * object, which may be operating some other rate.
+ */
+RadioInterface *makeRadioInterface(struct trx_config *config,
+ RadioDevice *usrp, int type)
+{
+ RadioInterface *radio = NULL;
+
+ switch (type) {
+ case RadioDevice::NORMAL:
+ radio = new RadioInterface(usrp, config->sps, config->chans);
+ break;
+ case RadioDevice::RESAMP_64M:
+ case RadioDevice::RESAMP_100M:
+ radio = new RadioInterfaceResamp(usrp,
+ config->sps, config->chans);
+ break;
+ case RadioDevice::DIVERSITY:
+ radio = new RadioInterfaceDiversity(usrp,
+ config->sps, config->chans);
+ break;
+ default:
+ LOG(ALERT) << "Unsupported radio interface configuration";
+ return NULL;
+ }
+
+ if (!radio->init(type)) {
+ LOG(ALERT) << "Failed to initialize radio interface";
+ return NULL;
+ }
+
+ return radio;
+}
+
+/* Create transceiver core
+ * The multi-threaded modem core operates at multiples of the GSM rate of
+ * 270.8333 ksps and consists of GSM specific modulation, demodulation,
+ * and decoding schemes. Also included are the socket interfaces for
+ * connecting to the upper layer stack.
+ */
+Transceiver *makeTransceiver(struct trx_config *config, RadioInterface *radio)
+{
+ Transceiver *trx;
+ VectorFIFO *fifo;
+
+ trx = new Transceiver(config->port, config->addr.c_str(), config->sps,
+ config->chans, GSM::Time(3,0), radio);
+ if (!trx->init()) {
+ LOG(ALERT) << "Failed to initialize transceiver";
+ delete trx;
+ return NULL;
+ }
+
+ for (size_t i = 0; i < config->chans; i++) {
+ fifo = radio->receiveFIFO(i);
+ if (fifo && trx->receiveFIFO(fifo, i))
+ continue;
+
+ LOG(ALERT) << "Could not attach FIFO to channel " << i;
+ delete trx;
+ return NULL;
+ }
+
+ return trx;
+}
+
+static void sig_handler(int signo)
+{
+ fprintf(stdout, "Received shutdown signal");
+ gshutdown = true;
+}
+
+static void setup_signal_handlers()
+{
+ if (signal(SIGINT, sig_handler) == SIG_ERR) {
+ fprintf(stderr, "Failed to install SIGINT signal handler\n");
+ exit(EXIT_FAILURE);
+ }
+ if (signal(SIGTERM, sig_handler) == SIG_ERR) {
+ fprintf(stderr, "Couldn't install SIGTERM signal handler\n");
+ exit( EXIT_FAILURE);
+ }
+}
+
+static void print_help()
+{
+ fprintf(stdout, "Options:\n"
+ " -h This text\n"
+ " -a UHD device args\n"
+ " -l Logging level (%s)\n"
+ " -i IP address of GSM core\n"
+ " -p Base port number\n"
+ " -d Enable dual channel diversity receiver\n"
+ " -x Enable external 10 MHz reference\n"
+ " -s Samples-per-symbol (1 or 4)\n"
+ " -c Number of ARFCN channels (default=1)\n",
+ "EMERG, ALERT, CRT, ERR, WARNING, NOTICE, INFO, DEBUG");
+}
+
+static void handle_options(int argc, char **argv, struct trx_config *config)
+{
+ int option;
+
+ config->port = 0;
+ config->sps = 0;
+ config->chans = 0;
+ config->extref = false;
+ config->diversity = false;
+
+ while ((option = getopt(argc, argv, "ha:l:i:p:c:dxs:")) != -1) {
+ switch (option) {
+ case 'h':
+ print_help();
+ exit(0);
+ break;
+ case 'a':
+ config->dev_args = optarg;
+ break;
+ case 'l':
+ config->log_level = optarg;
+ break;
+ case 'i':
+ config->addr = optarg;
+ break;
+ case 'p':
+ config->port = atoi(optarg);
+ break;
+ case 'c':
+ config->chans = atoi(optarg);
+ break;
+ case 'd':
+ config->diversity = true;
+ break;
+ case 'x':
+ config->extref = true;
+ break;
+ case 's':
+ config->sps = atoi(optarg);
+ if ((config->sps != 1) && (config->sps != 4)) {
+ printf("Unsupported samples-per-symbol\n\n");
+ print_help();
+ exit(0);
+ }
+ break;
+ default:
+ print_help();
+ exit(0);
+ }
+ }
+}
+
+int main(int argc, char *argv[])
+{
+ int type, chans;
+ RadioDevice *usrp;
+ RadioInterface *radio = NULL;
+ Transceiver *trx = NULL;
+ struct trx_config config;
+
+ handle_options(argc, argv, &config);
+
+ setup_signal_handlers();
+
+ /* Check database sanity */
+ if (!trx_setup_config(&config)) {
+ std::cerr << "Config: Database failure - exiting" << std::endl;
+ return EXIT_FAILURE;
+ }
+
+ gLogInit("transceiver", config.log_level.c_str(), LOG_LOCAL7);
+
+ srandom(time(NULL));
+
+ /* Create the low level device object */
+ usrp = RadioDevice::make(config.sps, config.chans, config.diversity);
+ type = usrp->open(config.dev_args, config.extref);
+ if (type < 0) {
+ LOG(ALERT) << "Failed to create radio device" << std::endl;
+ goto shutdown;
+ }
+
+ /* Setup the appropriate device interface */
+ radio = makeRadioInterface(&config, usrp, type);
+ if (!radio)
+ goto shutdown;
+
+ /* Create the transceiver core */
+ trx = makeTransceiver(&config, radio);
+ if (!trx)
+ goto shutdown;
+
+ trx->start();
+
+ chans = trx->numChans();
+ std::cout << "-- Transceiver active with "
+ << chans << " channel(s)" << std::endl;
+
+ while (!gshutdown)
+ sleep(1);
+
+shutdown:
+ std::cout << "Shutting down transceiver..." << std::endl;
+
+ delete trx;
+ delete radio;
+ delete usrp;
+
+ return 0;
+}