Add 4/4 Tx/Rx SPS definition for OCR01

This patch forward ports the relevant parts of a patch
from OpenCellular for osmo-trx versions previous to commit
1fb0ce67d8
so that osmo-trx-uhd recognizes the hardware, somewhat documented here:

https://github.com/Telecominfraproject/OpenCellular/blob/master/electronics/radio/SDR/

Note: I'm not very familiar with the hardware. It requires a patch to the
Ettus UHD driver to load the correct FPGA fw in which one call to
check_fpga_compat() is commented.
Otherwise mostly changes identifiers and log messages to "OCR01".

The usb device is reported as Vid:2500 Pid:0020 (Ettus,B200) but
I'm not sure how compatible it is. The fpga FW is different.

.gitignore

@@ -2,20 +2,23 @@
 *.o
 *.lo
 *.la
-Transceiver52M/osmo-trx
+Transceiver52M/osmo-trx-uhd
+Transceiver52M/osmo-trx-usrp1
+Transceiver52M/osmo-trx-lms
 
 # tests
-CommonLibs/BitVectorTest
-CommonLibs/ConfigurationTest
-CommonLibs/F16Test
-CommonLibs/InterthreadTest
-CommonLibs/LogTest
-CommonLibs/RegexpTest
-CommonLibs/SocketsTest
-CommonLibs/TimevalTest
-CommonLibs/URLEncodeTest
-CommonLibs/VectorTest
-CommonLibs/PRBSTest
+tests/CommonLibs/BitVectorTest
+tests/CommonLibs/F16Test
+tests/CommonLibs/InterthreadTest
+tests/CommonLibs/LogTest
+tests/CommonLibs/RegexpTest
+tests/CommonLibs/SocketsTest
+tests/CommonLibs/TimevalTest
+tests/CommonLibs/URLEncodeTest
+tests/CommonLibs/VectorTest
+tests/CommonLibs/PRBSTest
+tests/Transceiver52M/convolve_test
+tests/Transceiver52M/LMSDeviceTest
 
 # automake/autoconf
 *.in
@@ -41,6 +44,22 @@ ltmain.sh
 missing
 stamp-h1
 INSTALL
+tests/package.m4
+tests/testsuite
+tests/atconfig
+tests/testsuite.dir
+tests/testsuite.log
 
 # vim
 *.sw?
+
+# manuals
+doc/manuals/*.html
+doc/manuals/*.svg
+doc/manuals/*.pdf
+doc/manuals/*__*.png
+doc/manuals/*.check
+doc/manuals/generated/
+doc/manuals/osmomsc-usermanual.xml
+doc/manuals/common
+doc/manuals/build

AUTHORS

@@ -1,192 +0,0 @@
-#
-# Copyright 2008, 2009 Free Software Foundation, Inc.
-# 
-# This file is part of GNU Radio
-# 
-# GNU Radio is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 3, or (at your option)
-# any later version.
-# 
-# GNU Radio 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 General Public License for more details.
-# 
-# You should have received a copy of the GNU General Public License along
-# with this program; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-#
-
-David A. Burgess, dburgess@kestrelsp.com:
-    CLI/CLI.cpp
-    CLI/CLI.h
-    CommonLibs/Assert.h
-    CommonLibs/BitVector.cpp
-    CommonLibs/BitVectorTest.cpp
-    CommonLibs/Configuration.cpp
-    CommonLibs/Configuration.h
-    CommonLibs/ConfigurationTest.cpp
-    CommonLibs/Interthread.h
-    CommonLibs/InterthreadTest.cpp
-    CommonLibs/LinkedLists.cpp
-    CommonLibs/LinkedLists.h
-    CommonLibs/Regexp.h
-    CommonLibs/RegexpTest.cpp
-    CommonLibs/Sockets.cpp
-    CommonLibs/Sockets.h
-    CommonLibs/SocketsTest.cpp
-    CommonLibs/Threads.cpp
-    CommonLibs/Threads.h
-    CommonLibs/Timeval.cpp
-    CommonLibs/Timeval.h
-    CommonLibs/TimevalTest.cpp
-    CommonLibs/Vector.h
-    CommonLibs/VectorTest.cpp
-    Control/CallControl.cpp
-    Control/ControlCommon.cpp
-    Control/ControlCommon.h
-    Control/FACCHDispatch.cpp
-    Control/MobilityManagement.cpp
-    Control/PagerTest.cpp
-    Control/RadioResource.cpp
-    Control/SDCCHDispatch.cpp
-    GSM/GSM610Tables.cpp
-    GSM/GSM610Tables.h
-    GSM/GSMCommon.cpp
-    GSM/GSMCommon.h
-    GSM/GSMConfig.h
-    GSM/GSML1FEC.cpp
-    GSM/GSML1FEC.h
-    GSM/GSML2LAPDm.cpp
-    GSM/GSML2LAPDm.h
-    GSM/GSML3CCElements.cpp
-    GSM/GSML3CCElements.h
-    GSM/GSML3CCMessages.cpp
-    GSM/GSML3CCMessages.h
-    GSM/GSML3CommonElements.cpp
-    GSM/GSML3CommonElements.h
-    GSM/GSML3MMElements.cpp
-    GSM/GSML3MMElements.h
-    GSM/GSML3MMMessages.cpp
-    GSM/GSML3MMMessages.h
-    GSM/GSML3Message.cpp
-    GSM/GSML3Message.h
-    GSM/GSML3RRElements.cpp
-    GSM/GSML3RRElements.h
-    GSM/GSML3RRMessages.cpp
-    GSM/GSML3RRMessages.h
-    GSM/GSMLogicalChannel.h
-    GSM/GSMTDMA.cpp
-    GSM/GSMTDMA.h
-    GSM/GSMTransfer.cpp
-    GSM/GSMTransfer.h
-    LICENSEBLOCK
-    SIP/SIPEngine.h
-    SIP/SIPInterface.h
-    SMS/SMSMessages.cpp
-    SMS/SMSMessages.h
-    SMS/SMSTransfer.cpp
-    SMS/SMSTransfer.h
-    TRXManager/TRXManager.cpp
-    Transceiver/Complex.h
-    apps/OpenBTS900.cpp
-    apps/OpenBTS850.cpp
-    apps/OpenBTS25c3.cpp
-    tests/AGCHTest.cpp
-    tests/BeaconTest.cpp
-    tests/CallTest.cpp
-    tests/CallTest2.cpp
-    tests/LAPDmTest.cpp
-    tests/LoopbackTest.cpp
-    tests/RegistrationTest.cpp
-    tests/TRXSimulator.cpp
-
-Harvind S. Samra, hssamra@kestrelsp.com:
-    Control/PagerTest.cpp
-    Control/RadioResource.cpp
-    GSM/GSMConfig.h
-    GSM/GSMTransfer.h
-    LICENSEBLOCK
-    Transceiver/ComplexTest.cpp
-    Transceiver/Transceiver.cpp
-    Transceiver/Transceiver.h
-    Transceiver/USRPDevice.cpp
-    Transceiver/USRPDevice.h
-    Transceiver/USRPping.cpp
-    Transceiver/radioInterface.cpp
-    Transceiver/radioInterface.h
-    Transceiver/rcvLPF_651.h
-    Transceiver/runTransceiver.cpp
-    Transceiver/sendLPF_961.h
-    Transceiver/sigProcLib.cpp
-    Transceiver/sigProcLib.h
-    Transceiver/sigProcLibTest.cpp
-    Transceiver/sweepGenerator.cpp
-    Transceiver/testRadio.cpp
-
-Raffi Sevlian, raffisev@gmail.com:
-    Control/CallControl.cpp
-    Control/ControlCommon.cpp
-    Control/ControlCommon.h
-    Control/FACCHDispatch.cpp
-    Control/MobilityManagement.cpp
-    Control/PagerTest.cpp
-    Control/RadioResource.cpp
-    GSM/GSMCommon.h
-    GSM/GSMConfig.h
-    GSM/GSML1FEC.h
-    GSM/GSML3CCElements.cpp
-    GSM/GSML3CCElements.h
-    GSM/GSML3CCMessages.cpp
-    GSM/GSML3CCMessages.h
-    GSM/GSML3CommonElements.cpp
-    GSM/GSML3CommonElements.h
-    GSM/GSML3MMElements.cpp
-    GSM/GSML3MMElements.h
-    GSM/GSML3MMMessages.cpp
-    GSM/GSML3MMMessages.h
-    GSM/GSML3Message.cpp
-    GSM/GSML3Message.h
-    GSM/GSML3RRElements.cpp
-    GSM/GSML3RRElements.h
-    GSM/GSML3RRMessages.cpp
-    GSM/GSML3RRMessages.h
-    GSM/GSMLogicalChannel.h
-    GSM/GSMSAPMux.cpp
-    GSM/GSMSAPMux.h
-    GSM/GSMTransfer.h
-    LICENSEBLOCK
-    SIP/SIPEngine.cpp
-    SIP/SIPInterface.cpp
-    SIP/SIPInterface.h
-    SIP/SIPMessage.cpp
-    SIP/SIPMessage.h
-    SIP/SIPUtility.cpp
-    SIP/SIPUtility.h
-    SMS/CMMessage.cpp
-    SMS/CMMessage.h
-    SMS/CMProcessor.cpp
-    SMS/CMProcessor.h
-    SMS/CMTest.cpp
-    SMS/RLMessage.cpp
-    SMS/RLMessage.h
-    SMS/RLProcessor.cpp
-    SMS/RLProcessor.h
-    SMS/SMSMessages.cpp
-    SMS/SMSMessages.h
-    SMS/SMSProcessors.cpp
-    SMS/SMSProcessors.h
-    SMS/SMSTransfer.cpp
-    SMS/SMSTransfer.h
-    SMS/TLMessage.cpp
-    SMS/TLMessage.h
-    SMS/TLProcessor.cpp
-    SMS/TLProcessor.h
-    TRXManager/TRXManager.h
-
-Alon Levy, alonlevy1@gmail.com
-    RRLPMessages.cpp
-    RRLPMessages.h
-    RRLPTest.cpp
-

COPYING

@@ -666,23 +666,23 @@ For more information on this, and how to apply and follow the GNU AGPL, see
 =========================================================================
 
 This marks the end of the AGPLv3 text.  The following text is appended to the
-same file for convience but constituting a distinct document, not part of the
+same file for convenience but constituting a distinct document, not part of the
 actual AGPL text and not part of an attempt to create a deriviative work based
 on the AGPLv3 text.
 
 =========================================================================
 
 
-ADDITIONAL TERMS TO THE AGPLv3 LICENSE FOR OPENBTS
+ADDITIONAL TERMS TO THE AGPLv3 LICENSE FOR OsmoTRX
 
 
 Permissive Terms Supplementing the License
 
 1. Remote Interaction Through IP Networks.
 
-OpenBTS includes an implementation of the GSM network cellular air interface,
+OsmoTRX is an implementation of the GSM network cellular air interface,
 as well as other interfaces to IP networks.  The interaction of cellular
-handsets with the OpenBTS software is considered "remote network interaction"
+handsets with the OsmoTRX software is considered "remote network interaction"
 for the purposes of the Affero General Public License and cellular users are
 subject to the source code access requirements of Section 13 of AGPLv3 ("Remote
 Network Interaction; Use with the GNU General Public License").
@@ -694,17 +694,6 @@ interfaces other than the GSM air interface from the requirements of Section 13
 is an additional permission granted to you.  
 
 
-Non-Permissive Terms Supplementing The License
-
-1. Trademarks.
-
-"OpenBTS" is a trademark of Range Networks, Inc., registered with
-the US Patent and Trademark Office.  Your use of OpenBTS software under a GPL
-license does not include the right to use the OpenBTS trademark in commerce.
-This additional non-permissive term is consistent with Section 7 of the AGPLv3
-license.
-
-
 END OF ADDITIONAL TERMS
 
 
@@ -712,13 +701,8 @@ END OF ADDITIONAL TERMS
 How to comply with Section 13 of the AGPLv3 license.
 
 The recommended method for compliance with Section 13 of the AGPLv3 license is
-to deliver a text message to each handset that attaches to the OpenBTS cellular
-network.  At a minimum, that text message should include the string "OpenBTS
-AGPLv3" and a URL that can be used to access the OpenBTS source code.  This
+to deliver a text message to each handset that attaches to the cellular
+network which uses OsmoTRX.  At a minimum, that text message should include the string
+"OsmoTRX AGPLv3" and a URL that can be used to access the OsmoBTS source code.  This
 message need not be delivered to handsets that are denied registration with the
 network, since those handsets have been denied service.
-
-In OpenBTS 2.6, such text messages can be delivered with the "Welcome Message"
-feature.  See the OpenBTS.config.example file for more information on the use of
-this feature for AGPLv3 compliance.
-

CommonLibs/BitVector.cpp

@@ -1,6 +1,7 @@
 /*
 * Copyright 2008, 2009 Free Software Foundation, Inc.
 *
+* SPDX-License-Identifier: AGPL-3.0+
 *
 * This software is distributed under the terms of the GNU Affero Public License.
 * See the COPYING file in the main directory for details.
@@ -36,7 +37,7 @@ using namespace std;
 
 
 /**
-  Apply a Galois polymonial to a binary seqeunce.
+  Apply a Galois polymonial to a binary sequence.
   @param val The input sequence.
   @param poly The polynomial.
   @param order The order of the polynomial.

CommonLibs/BitVector.h

@@ -1,6 +1,8 @@
 /*
 * Copyright 2008, 2009 Free Software Foundation, Inc.
 *
+* SPDX-License-Identifier: AGPL-3.0+
+*
 * This software is distributed under the terms of the GNU Affero Public License.
 * See the COPYING file in the main directory for details.
 *

CommonLibs/Configuration.h

@@ -1,422 +0,0 @@
-/*
-* Copyright 2009, 2010 Free Software Foundation, Inc.
-* Copyright 2010 Kestrel Signal Processing, Inc.
-* Copyright 2011, 2012 Range Networks, Inc.
-*
-* This software is distributed under the terms of the GNU Affero Public License.
-* See the COPYING file in the main directory for details.
-*
-* This use of this software may be subject to additional restrictions.
-* See the LEGAL file in the main directory for details.
-
-	This program is free software: you can redistribute it and/or modify
-	it under the terms of the GNU Affero General Public License as published by
-	the Free Software Foundation, either version 3 of the License, or
-	(at your option) any later version.
-
-	This program 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 Affero General Public License for more details.
-
-	You should have received a copy of the GNU Affero General Public License
-	along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-*/
-
-
-#ifndef CONFIGURATION_H
-#define CONFIGURATION_H
-
-
-#include "sqlite3util.h"
-
-#include <assert.h>
-#include <stdlib.h>
-#include <netinet/in.h>
-#include <arpa/inet.h>
-#include <regex.h>
-
-#include <map>
-#include <vector>
-#include <string>
-#include <sstream>
-#include <iostream>
-
-#include <Threads.h>
-#include <stdint.h>
-
-
-/** A class for configuration file errors. */
-class ConfigurationTableError {};
-extern char gCmdName[];	// Gotta be global, gotta be char*, gotta love it.
-
-/** An exception thrown when a given config key isn't found. */
-class ConfigurationTableKeyNotFound : public ConfigurationTableError {
-
-	private:
-
-	std::string mKey;
-
-	public:
-
-	ConfigurationTableKeyNotFound(const std::string& wKey)
-		:mKey(wKey)
-	{ }
-
-	const std::string& key() const { return mKey; }
-
-};
-
-
-class ConfigurationRecord {
-
-	private:
-
-	std::string mValue;
-	long mNumber;
-	bool mDefined;
-
-	public:
-
-	ConfigurationRecord(bool wDefined=true):
-		mDefined(wDefined)
-	{ }
-
-	ConfigurationRecord(const std::string& wValue):
-		mValue(wValue),
-		mNumber(strtol(wValue.c_str(),NULL,0)),
-		mDefined(true)
-	{ }
-
-	ConfigurationRecord(const char* wValue):
-		mValue(std::string(wValue)),
-		mNumber(strtol(wValue,NULL,0)),
-		mDefined(true)
-	{ }
-
-
-	const std::string& value() const { return mValue; }
-	long number() const { return mNumber; }
-	bool defined() const { return mDefined; }
-
-	float floatNumber() const;
-
-};
-
-
-/** A string class that uses a hash function for comparison. */
-class HashString : public std::string {
-
-
-	protected:
-
-	uint64_t mHash;
-
-	void computeHash();
-
-
-	public:
-
-	HashString(const char* src)
-		:std::string(src)
-	{
-		computeHash();
-	}
-
-	HashString(const std::string& src)
-		:std::string(src)
-	{
-		computeHash();
-	}
-
-	HashString()
-	{
-		mHash=0;
-	}
-
-	HashString& operator=(std::string& src)
-	{
-		std::string::operator=(src);
-		computeHash();
-		return *this;
-	}
-
-	HashString& operator=(const char* src)
-	{
-		std::string::operator=(src);
-		computeHash();
-		return *this;
-	}
-
-	bool operator==(const HashString& other)
-	{
-		return mHash==other.mHash;
-	}
-
-	bool operator<(const HashString& other)
-	{
-		return mHash<other.mHash;
-	}
-
-	bool operator>(const HashString& other)
-	{
-		return mHash<other.mHash;
-	}
-
-	uint64_t hash() const { return mHash; }
-
-};
-
-
-typedef std::map<std::string, ConfigurationRecord> ConfigurationRecordMap;
-typedef std::map<HashString, ConfigurationRecord> ConfigurationMap;
-class ConfigurationKey;
-typedef std::map<std::string, ConfigurationKey> ConfigurationKeyMap;
-
-/**
-	A class for maintaining a configuration key-value table,
-	based on sqlite3 and a local map-based cache.
-	Thread-safe, too.
-*/
-class ConfigurationTable {
-
-	private:
-
-	sqlite3* mDB;				///< database connection
-	ConfigurationMap mCache;	///< cache of recently access configuration values
-	mutable Mutex mLock;		///< control for multithreaded access to the cache
-	std::vector<std::string> (*mCrossCheck)(const std::string&);	///< cross check callback pointer
-
-	public:
-
-	ConfigurationKeyMap mSchema;///< definition of configuration default values and validation logic
-
-	ConfigurationTable(const char* filename = ":memory:", const char *wCmdName = 0, ConfigurationKeyMap wSchema = ConfigurationKeyMap());
-
-	/** Generate an up-to-date example sql file for new installs. */
-	std::string getDefaultSQL(const std::string& program, const std::string& version);
-
-	/** Generate an up-to-date TeX snippet. */
-	std::string getTeX(const std::string& program, const std::string& version);
-
-	/** Return true if the key is used in the table.  */
-	bool defines(const std::string& key);
-
-	/** Return true if the application's schema knows about this key. */
-	bool keyDefinedInSchema(const std::string& name);
-
-	/** Return true if the provided value validates correctly against the defined schema. */
-	bool isValidValue(const std::string& name, const std::string& val);
-
-	/** Return true if the provided value validates correctly against the defined schema. */
-	bool isValidValue(const std::string& name, const int val) { std::stringstream ss; ss << val; return isValidValue(name, ss.str()); }
-
-	/** Return a map of all similar keys in the defined schema. */
-	ConfigurationKeyMap getSimilarKeys(const std::string& snippet);
-
-	/** Return true if this key is identified as static. */
-	bool isStatic(const std::string& key);
-
-	/**
-		Get a string parameter from the table.
-		Throw ConfigurationTableKeyNotFound if not found.
-	*/
-	std::string getStr(const std::string& key);
-
-
-	/**
-		Get a boolean from the table.
-		Return false if NULL or 0, true otherwise.
-	*/
-	bool getBool(const std::string& key);
-
-	/**
-		Get a numeric parameter from the table.
-		Throw ConfigurationTableKeyNotFound if not found.
-	*/
-	long getNum(const std::string& key);
-
-	/**
-		Get a vector of strings from the table.
-	*/
-	std::vector<std::string> getVectorOfStrings(const std::string& key);
-
-	/**
-		Get a float from the table.
-		Throw ConfigurationTableKeyNotFound if not found.
-	*/
-	float getFloat(const std::string& key);
-
-	/**
-		Get a numeric vector from the table.
-	*/
-	std::vector<unsigned> getVector(const std::string& key);
-
-	/** Get length of a vector */
-	unsigned getVectorLength(const std::string &key) 
-		{ return getVector(key).size(); }
-
-	/** Set or change a value in the table.  */
-	bool set(const std::string& key, const std::string& value);
-
-	/** Set or change a value in the table.  */
-	bool set(const std::string& key, long value);
-
-	/** Create an entry in the table, no value though. */
-	bool set(const std::string& key);
-
-	/**
-		Remove an entry from the table.
-		Will not alter required values.
-		@param key The key of the item to be removed.
-		@return true if anything was actually removed.
-	*/
-	bool remove(const std::string& key);
-
-	/** Search the table, dumping to a stream. */
-	void find(const std::string& pattern, std::ostream&) const;
-
-	/** Return all key/value pairs stored in the ConfigurationTable */
-	ConfigurationRecordMap getAllPairs() const;
-
-	/** Define the callback to purge the cache whenever the database changes. */
-	void setUpdateHook(void(*)(void *,int ,char const *,char const *,sqlite3_int64));
-
-	/** Define the callback for cross checking. */
-	void setCrossCheckHook(std::vector<std::string> (*wCrossCheck)(const std::string&));
-
-	/** Execute the application specific value cross checking logic. */
-	std::vector<std::string> crossCheck(const std::string& key);
-
-	/** purege cache if it exceeds a certain age */
-	void checkCacheAge();
-
-	/** Delete all records from the cache. */
-	void purge();
-
-
-	private:
-
-	/**
-		Attempt to lookup a record, cache if needed.
-		Throw ConfigurationTableKeyNotFound if not found.
-		Caller should hold mLock because the returned reference points into the cache.
-	*/
-	const ConfigurationRecord& lookup(const std::string& key);
-
-};
-
-
-typedef std::map<HashString, std::string> HashStringMap;
-
-class SimpleKeyValue {
-
-	protected:
-
-	HashStringMap mMap;
-
-	public:
-
-	/** Take a C string "A=B" and set map["A"]="B". */
-	void addItem(const char*);
-
-	/** Take a C string "A=B C=D E=F ..." and add all of the pairs to the map. */
-	void addItems(const char*s);
-
-	/** Return a reference to the string at map["key"]. */
-	const char* get(const char*) const;
-};
-
-
-class ConfigurationKey {
-
-	public:
-
-	enum VisibilityLevel
-	{
-		CUSTOMER,
-		CUSTOMERSITE,
-		CUSTOMERTUNE,
-		CUSTOMERWARN,
-		DEVELOPER,
-		FACTORY
-	};
-
-	enum Type
-	{
-		BOOLEAN,
-		CHOICE_OPT,
-		CHOICE,
-		CIDR_OPT,
-		CIDR,
-		FILEPATH_OPT,
-		FILEPATH,
-		IPADDRESS_OPT,
-		IPADDRESS,
-		IPANDPORT,
-		MIPADDRESS_OPT,
-		MIPADDRESS,
-		PORT_OPT,
-		PORT,
-		REGEX_OPT,
-		REGEX,
-		STRING_OPT,
-		STRING,
-		VALRANGE
-	};
-
-	private:
-
-	std::string mName;
-	std::string mDefaultValue;
-	std::string mUnits;
-	VisibilityLevel mVisibility;
-	Type mType;
-	std::string mValidValues;
-	bool mIsStatic;
-	std::string mDescription;
-
-
-	public:
-
-	ConfigurationKey(const std::string& wName, const std::string& wDefaultValue, const std::string& wUnits, const VisibilityLevel wVisibility, const Type wType, const std::string& wValidValues, bool wIsStatic, const std::string& wDescription):
-		mName(wName),
-		mDefaultValue(wDefaultValue),
-		mUnits(wUnits),
-		mVisibility(wVisibility),
-		mType(wType),
-		mValidValues(wValidValues),
-		mIsStatic(wIsStatic),
-		mDescription(wDescription)
-	{ }
-
-	ConfigurationKey()
-	{ }
-
-	const std::string& getName() const { return mName; }
-	const std::string& getDefaultValue() const { return mDefaultValue; }
-	void updateDefaultValue(const std::string& newValue) { mDefaultValue = newValue; }
-	void updateDefaultValue(const int newValue) { std::stringstream ss; ss << newValue; updateDefaultValue(ss.str()); }
-	const std::string& getUnits() const { return mUnits; }
-	const VisibilityLevel& getVisibility() const { return mVisibility; }
-	const Type& getType() const { return mType; }
-	const std::string& getValidValues() const { return mValidValues; }
-	bool isStatic() const { return mIsStatic; }
-	const std::string& getDescription() const { return mDescription; }
-
-	static bool isValidIP(const std::string& ip);
-	static void getMinMaxStepping(const ConfigurationKey &key, std::string &min, std::string &max, std::string &stepping);
-	template<class T> static bool isInValRange(const ConfigurationKey &key, const std::string& val, const bool isInteger);
-	static const std::string visibilityLevelToString(const VisibilityLevel& visibility);
-	static const std::string typeToString(const ConfigurationKey::Type& type);
-	static void printKey(const ConfigurationKey &key, const std::string& currentValue, std::ostream& os);
-	static void printDescription(const ConfigurationKey &key, std::ostream& os);
-	static const std::string getARFCNsString();
-};
-
-
-#endif
-
-
-// vim: ts=4 sw=4

CommonLibs/ConfigurationTest.cpp

@@ -1,149 +0,0 @@
-/*
-* Copyright 2009, 2010 Free Software Foundation, Inc.
-* Copyright 2010 Kestrel Signal Processing, Inc.
-*
-*
-* This software is distributed under the terms of the GNU Affero Public License.
-* See the COPYING file in the main directory for details.
-*
-* This use of this software may be subject to additional restrictions.
-* See the LEGAL file in the main directory for details.
-
-	This program is free software: you can redistribute it and/or modify
-	it under the terms of the GNU Affero General Public License as published by
-	the Free Software Foundation, either version 3 of the License, or
-	(at your option) any later version.
-
-	This program 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 Affero General Public License for more details.
-
-	You should have received a copy of the GNU Affero General Public License
-	along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-*/
-
-
-
-#include "Configuration.h"
-#include <iostream>
-#include <string>
-
-using namespace std;
-
-ConfigurationKeyMap getConfigurationKeys();
-ConfigurationTable gConfig("exampleconfig.db","test", getConfigurationKeys());
-
-void purgeConfig(void*,int,char const*, char const*, sqlite3_int64)
-{
-	//cout << "update hook" << endl;
-	gConfig.purge();
-}
-
-
-int main(int argc, char *argv[])
-{
-
-	gConfig.setUpdateHook(purgeConfig);
-
-	const char *keys[5] = {"key1", "key2", "key3", "key4", "key5"};
-
-	for (int i=0; i<5; i++) {
-		gConfig.set(keys[i],i);
-	}
-
-	for (int i=0; i<5; i++) {
-		cout << "table[" << keys[i] << "]=" << gConfig.getStr(keys[i]) <<  endl;
-		cout << "table[" << keys[i] << "]=" << gConfig.getNum(keys[i]) <<  endl;
-	}
-
-	for (int i=0; i<5; i++) {
-		cout << "defined table[" << keys[i] << "]=" << gConfig.defines(keys[i]) <<  endl;
-	}
-
-	gConfig.set("key5","100 200 300  400 ");
-	std::vector<unsigned> vect = gConfig.getVector("key5");
-	cout << "vect length " << vect.size() << ": ";
-	for (unsigned i=0; i<vect.size(); i++) cout << " " << vect[i];
-	cout << endl;
-	std::vector<string> svect = gConfig.getVectorOfStrings("key5");
-	cout << "vect length " << svect.size() << ": ";
-	for (unsigned i=0; i<svect.size(); i++) cout << " " << svect[i] << ":";
-	cout << endl;
-
-	cout << "bool " << gConfig.getBool("booltest") << endl;
-	gConfig.set("booltest",1);
-	cout << "bool " << gConfig.getBool("booltest") << endl;
-	gConfig.set("booltest",0);
-	cout << "bool " << gConfig.getBool("booltest") << endl;
-
-	gConfig.getStr("newstring");
-	gConfig.getNum("numnumber");
-
-
-	SimpleKeyValue pairs;
-	pairs.addItems(" a=1 b=34 dd=143 ");
-	cout<< pairs.get("a") << endl;
-	cout<< pairs.get("b") << endl;
-	cout<< pairs.get("dd") << endl;
-
-	gConfig.set("fkey","123.456");
-	float fval = gConfig.getFloat("fkey");
-	cout << "fkey " << fval << endl;
-
-	cout << "search fkey:" << endl;
-	gConfig.find("fkey",cout);
-	cout << "search fkey:" << endl;
-	gConfig.find("fkey",cout);
-	gConfig.remove("fkey");
-	cout << "search fkey:" << endl;
-	gConfig.find("fkey",cout);
-
-	try {
-		gConfig.getNum("supposedtoabort");
-	} catch (ConfigurationTableKeyNotFound) {
-		cout << "ConfigurationTableKeyNotFound exception successfully caught." << endl;
-	}
-}
-
-ConfigurationKeyMap getConfigurationKeys()
-{
-	ConfigurationKeyMap map;
-	ConfigurationKey *tmp;
-
-	tmp = new ConfigurationKey("booltest","0",
-		"",
-		ConfigurationKey::DEVELOPER,
-		ConfigurationKey::BOOLEAN,
-		"",
-		false,
-		""
-	);
-	map[tmp->getName()] = *tmp;
-	free(tmp);
-
-	tmp = new ConfigurationKey("numnumber","42",
-		"",
-		ConfigurationKey::DEVELOPER,
-		ConfigurationKey::VALRANGE,
-		"0-100",
-		false,
-		""
-	);
-	map[tmp->getName()] = *tmp;
-	free(tmp);
-
-	tmp = new ConfigurationKey("newstring","new string value",
-		"",
-		ConfigurationKey::DEVELOPER,
-		ConfigurationKey::STRING,
-		"",
-		false,
-		""
-	);
-	map[tmp->getName()] = *tmp;
-	free(tmp);
-
-	return map;
-}

CommonLibs/Interthread.h

@@ -1,6 +1,8 @@
 /*
 * Copyright 2008, 2011 Free Software Foundation, Inc.
 *
+* SPDX-License-Identifier: AGPL-3.0+
+*
 * This software is distributed under the terms of the GNU Affero Public License.
 * See the COPYING file in the main directory for details.
 *
@@ -45,7 +47,7 @@
 // (pat) The elements in the queue are type T*, and
 // the Fifo class implements the underlying queue.
 // The default is class PointerFIFO, which does not place any restrictions on the type of T,
-// and is implemented by allocating auxilliary structures for the queue,
+// and is implemented by allocating auxiliary structures for the queue,
 // or SingleLinkedList, which implements the queue using an internal pointer in type T,
 // which must implement the functional interface of class SingleLinkListNode,
 // namely: functions T*next() and void setNext(T*).
@@ -53,7 +55,7 @@ template <class T, class Fifo=PointerFIFO> class InterthreadQueue {
 
 	protected:
 
-	Fifo mQ;	
+	Fifo mQ;
 	mutable Mutex mLock;
 	mutable Signal mWriteSignal;
 
@@ -160,7 +162,7 @@ template <class T, class Fifo=PointerFIFO> class InterthreadQueue2 {
 
 	protected:
 
-	Fifo mQ;	
+	Fifo mQ;
 	mutable Mutex mLock;
 	mutable Signal mWriteSignal;
 
@@ -256,7 +258,7 @@ template <class T, class Fifo=PointerFIFO> class InterthreadQueue2 {
 		// This recurs (and the InterthreadQueue fills up with data)
 		// until the read thread's accumulated temporary priority causes it to
 		// get a second pre-emptive activation over the writing thread,
-		// resulting in bursts of activity by the read thread. 
+		// resulting in bursts of activity by the read thread.
 		{ ScopedLock lock(mLock);
 		  mQ.put(val);
 		}
@@ -281,7 +283,7 @@ template <class T> class InterthreadQueueWithWait {
 
 	protected:
 
-	PointerFIFO mQ;	
+	PointerFIFO mQ;
 	mutable Mutex mLock;
 	mutable Signal mWriteSignal;
 	mutable Signal mReadSignal;

CommonLibs/LinkedLists.cpp

@@ -1,6 +1,7 @@
 /*
 * Copyright 2008 Free Software Foundation, Inc.
 *
+* SPDX-License-Identifier: AGPL-3.0+
 *
 * This software is distributed under the terms of the GNU Affero Public License.
 * See the COPYING file in the main directory for details.
@@ -29,6 +30,25 @@
 #include "LinkedLists.h"
 
 
+PointerFIFO::~PointerFIFO()
+{
+	ListNode *node, *next;
+
+	node = mHead;
+	while (node != NULL) {
+		next = node->next();
+		delete node;
+		node = next;
+	}
+
+	node = mFreeList;
+	while (node != NULL) {
+		next = node->next();
+		delete node;
+		node = next;
+	}
+}
+
 void PointerFIFO::push_front(void* val)	// by pat
 {
 	// Pat added this routine for completeness, but never used or tested.

CommonLibs/LinkedLists.h

@@ -1,7 +1,10 @@
 /*
 * Copyright 2008 Free Software Foundation, Inc.
 *
-* This software is distributed under multiple licenses; see the COPYING file in the main directory for licensing information for this specific distribuion.
+* SPDX-License-Identifier: AGPL-3.0+
+*
+* This software is distributed under multiple licenses; see the COPYING file in
+* the main directory for licensing information for this specific distribution.
 *
 * This software is distributed under the terms of the GNU Affero Public License.
 * See the COPYING file in the main directory for details.
@@ -70,6 +73,7 @@ class PointerFIFO {
 		:mHead(NULL),mTail(NULL),mFreeList(NULL),
 		mSize(0)
 	{}
+	~PointerFIFO();
 
 	unsigned size() const { return mSize; }
 	unsigned totalSize() const { return 0; }	// Not used in this version.

CommonLibs/Logger.cpp

@@ -1,8 +1,7 @@
 /*
-* Copyright 2009, 2010 Free Software Foundation, Inc.
-* Copyright 2010 Kestrel Signal Processing, Inc.
-* Copyright 2011, 2012 Range Networks, Inc.
+* Copyright (C) 2018 sysmocom - s.f.m.c. GmbH
 *
+* SPDX-License-Identifier: AGPL-3.0+
 *
 * This software is distributed under the terms of the GNU Affero Public License.
 * See the COPYING file in the main directory for details.
@@ -32,300 +31,33 @@
 #include <stdarg.h>
 #include <sys/time.h>	// For gettimeofday
 
-#include "Configuration.h"
 #include "Logger.h"
 #include "Threads.h"	// pat added
 
-
 using namespace std;
 
-// Switches to enable/disable logging targets
-// MUST BE DEFINED BEFORE gConfig FOR gLogEarly() TO WORK CORRECTLY
-bool gLogToConsole = true;
-bool gLogToSyslog = false;
-FILE *gLogToFile = NULL;
-Mutex gLogToLock;
-
-
-// Reference to a global config table, used all over the system.
-extern ConfigurationTable gConfig;
-
-
-/**@ The global alarms table. */
-//@{
-Mutex           alarmsLock;
-list<string>    alarmsList;
-void            addAlarm(const string&);
-//@}
-
-
-
-// (pat) If Log messages are printed before the classes in this module are inited
-// (which happens when static classes have constructors that do work)
-// the OpenBTS just crashes.
-// Prevent that by setting sLoggerInited to true when this module is inited.
-static bool sLoggerInited = 0;
-static struct CheckLoggerInitStatus {
-	CheckLoggerInitStatus() { sLoggerInited = 1; }
-} sCheckloggerInitStatus;
-
-
-
-/** Names of the logging levels. */
-const char *levelNames[] = {
-	"EMERG", "ALERT", "CRIT", "ERR", "WARNING", "NOTICE", "INFO", "DEBUG"
-};
-int numLevels = 8;
-
-
-int levelStringToInt(const string& name)
-{
-	// Reverse search, since the numerically larger levels are more common.
-	for (int i=numLevels-1; i>=0; i--) {
-		if (name == levelNames[i]) return i;
-	}
-
-	// Common substitutions.
-	if (name=="INFORMATION") return 6;
-	if (name=="WARN") return 4;
-	if (name=="ERROR") return 3;
-	if (name=="CRITICAL") return 2;
-	if (name=="EMERGENCY") return 0;
-
-	// Unknown level.
-	return -1;
-}
-
-/** Given a string, return the corresponding level name. */
-int lookupLevel(const string& key)
-{
-	string val = gConfig.getStr(key);
-	int level = levelStringToInt(val);
-
-	if (level == -1) {
-		string defaultLevel = gConfig.mSchema["Log.Level"].getDefaultValue();
-		level = levelStringToInt(defaultLevel);
-		_LOG(CRIT) << "undefined logging level (" << key << " = \"" << val << "\") defaulting to \"" << defaultLevel << ".\" Valid levels are: EMERG, ALERT, CRIT, ERR, WARNING, NOTICE, INFO or DEBUG";
-		gConfig.set(key, defaultLevel);
-	}
-
-	return level;
-}
-
-static std::string format(const char *fmt, ...)
-{
-	va_list ap;
-	char buf[300];
-	va_start(ap,fmt);
-	int n = vsnprintf(buf,300,fmt,ap);
-	va_end(ap);
-	if (n >= (300-4)) { strcpy(&buf[(300-4)],"..."); }
-	return std::string(buf);
-}
-
-const std::string timestr()
-{
-	struct timeval tv;
-	struct tm tm;
-	gettimeofday(&tv,NULL);
-	localtime_r(&tv.tv_sec,&tm);
-	unsigned tenths = tv.tv_usec / 100000;	// Rounding down is ok.
-	return format(" %02d:%02d:%02d.%1d",tm.tm_hour,tm.tm_min,tm.tm_sec,tenths);
-}
-
 std::ostream& operator<<(std::ostream& os, std::ostringstream& ss)
 {
 	return os << ss.str();
 }
 
-int getLoggingLevel(const char* filename)
-{
-	// Default level?
-	if (!filename) return lookupLevel("Log.Level");
-
-	// This can afford to be inefficient since it is not called that often.
-	const string keyName = string("Log.Level.") + string(filename);
-	if (gConfig.defines(keyName)) return lookupLevel(keyName);
-	return lookupLevel("Log.Level");
-}
-
-
-
-int gGetLoggingLevel(const char* filename)
-{
-	// This is called a lot and needs to be efficient.
-
-	static Mutex sLogCacheLock;
-	static map<uint64_t,int>  sLogCache;
-	static unsigned sCacheCount;
-	static const unsigned sCacheRefreshCount = 1000;
-
-	if (filename==NULL) return gGetLoggingLevel("");
-
-	HashString hs(filename);
-	uint64_t key = hs.hash();
-
-	sLogCacheLock.lock();
-	// Time for a cache flush?
-	if (sCacheCount>sCacheRefreshCount) {
-		sLogCache.clear();
-		sCacheCount=0;
-	}
-	// Is it cached already?
-	map<uint64_t,int>::const_iterator where = sLogCache.find(key);
-	sCacheCount++;
-	if (where!=sLogCache.end()) {
-		int retVal = where->second;
-		sLogCacheLock.unlock();
-		return retVal;
-	}
-	// Look it up in the config table and cache it.
-	// FIXME: Figure out why unlock and lock below fix the config table deadlock.
-	// (pat) Probably because getLoggingLevel may call LOG recursively via lookupLevel().
-	sLogCacheLock.unlock();
-	int level = getLoggingLevel(filename);
-	sLogCacheLock.lock();
-	sLogCache.insert(pair<uint64_t,int>(key,level));
-	sLogCacheLock.unlock();
-	return level;
-}
-
-
-
-
-
-// copies the alarm list and returns it. list supposed to be small.
-list<string> gGetLoggerAlarms()
-{
-    alarmsLock.lock();
-    list<string> ret;
-    // excuse the "complexity", but to use std::copy with a list you need
-    // an insert_iterator - copy technically overwrites, doesn't insert.
-    insert_iterator< list<string> > ii(ret, ret.begin());
-    copy(alarmsList.begin(), alarmsList.end(), ii);
-    alarmsLock.unlock();
-    return ret;
-}
-
-/** Add an alarm to the alarm list. */
-void addAlarm(const string& s)
-{
-    alarmsLock.lock();
-    alarmsList.push_back(s);
-	unsigned maxAlarms = gConfig.getNum("Log.Alarms.Max");
-    while (alarmsList.size() > maxAlarms) alarmsList.pop_front();
-    alarmsLock.unlock();
-}
-
-
 Log::~Log()
 {
-	if (mDummyInit) return;
-	// Anything at or above LOG_CRIT is an "alarm".
-	// Save alarms in the local list and echo them to stderr.
-	if (mPriority <= LOG_ERR) {
-		if (sLoggerInited) addAlarm(mStream.str().c_str());
-		cerr << mStream.str() << endl;
-	}
-	// Current logging level was already checked by the macro. So just log.
-	// Log to syslog
-	if (gLogToSyslog) {
-		syslog(mPriority, "%s", mStream.str().c_str());
-	}
-	// Log to file and console
-	if (gLogToConsole||gLogToFile) {
-		int mlen = mStream.str().size();
-		int neednl = (mlen==0 || mStream.str()[mlen-1] != '\n');
-		ScopedLock lock(gLogToLock);
-		if (gLogToConsole) {
-			// The COUT() macro prevents messages from stomping each other but adds uninteresting thread numbers,
-			// so just use std::cout.
-			std::cout << mStream.str();
-			if (neednl) std::cout<<"\n";
-		}
-		if (gLogToFile) {
-			fputs(mStream.str().c_str(),gLogToFile);
-			if (neednl) {fputc('\n',gLogToFile);}
-			fflush(gLogToFile);
-		}
-	}
+	int old_state;
+	int mlen = mStream.str().size();
+	int neednl = (mlen==0 || mStream.str()[mlen-1] != '\n');
+	const char *fmt = neednl ? "%s\n" : "%s";
+
+	/* print related function called inside a C++ destructor, use pthread_setcancelstate() APIs.
+	   See osmo-trx commit 86be40b4eb762d5c12e8e3f7388ca9f254e77b36 for more information */
+	pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &old_state);
+	LOGPSRC(mCategory, mPriority, filename, line, fmt, mStream.str().c_str());
+	pthread_setcancelstate(old_state, NULL);
 }
 
-
-Log::Log(const char* name, const char* level, int facility)
-{
-	mDummyInit = true;
-	gLogInit(name, level, facility);
-}
-
-
 ostringstream& Log::get()
 {
-	assert(mPriority<numLevels);
-	mStream << levelNames[mPriority] <<  ' ';
 	return mStream;
 }
 
-
-
-void gLogInit(const char* name, const char* level, int facility)
-{
-	// Set the level if one has been specified.
-	if (level) {
-		gConfig.set("Log.Level",level);
-	}
-
-	// Both the transceiver and OpenBTS use this same facility, but only OpenBTS/OpenNodeB may use this log file:
-	string str = gConfig.getStr("Log.File");
-	if (gLogToFile==NULL && str.length() && 0==strncmp(gCmdName,"Open",4)) {
-		const char *fn = str.c_str();
-		if (fn && *fn && strlen(fn)>3) {	// strlen because a garbage char is getting in sometimes.
-			gLogToFile = fopen(fn,"w"); // New log file each time we start.
-			if (gLogToFile) {
-				time_t now;
-				time(&now);
-				fprintf(gLogToFile,"Starting at %s",ctime(&now));
-				fflush(gLogToFile);
-				std::cout << "Logging to file: " << fn << "\n";
-			}
-		}
-	}
-
-	// Open the log connection.
-	openlog(name,0,facility);
-}
-
-
-void gLogEarly(int level, const char *fmt, ...)
-{
-	va_list args;
-
-	va_start(args, fmt);
-
-	if (gLogToSyslog) {
-		va_list args_copy;
-		va_copy(args_copy, args);
-		vsyslog(level | LOG_USER, fmt, args_copy);
-		va_end(args_copy);
-	}
-
-	if (gLogToConsole) {
-		va_list args_copy;
-		va_copy(args_copy, args);
-		vprintf(fmt, args_copy);
-		printf("\n");
-		va_end(args_copy);
-	}
-
-	if (gLogToFile) {
-		va_list args_copy;
-		va_copy(args_copy, args);
-		vfprintf(gLogToFile, fmt, args_copy);
-		fprintf(gLogToFile, "\n");
-		va_end(args_copy);
-	}
-
-	va_end(args);
-}
-
 // vim: ts=4 sw=4

CommonLibs/Logger.h

@@ -2,6 +2,8 @@
 * Copyright 2009, 2010 Free Software Foundation, Inc.
 * Copyright 2010 Kestrel Signal Processing, Inc.
 *
+* SPDX-License-Identifier: AGPL-3.0+
+*
 * This software is distributed under the terms of the GNU Affero Public License.
 * See the COPYING file in the main directory for details.
 *
@@ -23,71 +25,47 @@
 
 */
 
-// (pat) WARNING is stupidly defined in /usr/local/include/osipparser2/osip_const.h.
-// This must be outside the #ifndef LOGGER_H to fix it as long as Logger.h included after the above file.
-#ifdef WARNING
-#undef WARNING
-#endif
-
 #ifndef LOGGER_H
 #define LOGGER_H
 
-#include <syslog.h>
 #include <stdint.h>
 #include <stdio.h>
 #include <sstream>
-#include <list>
-#include <map>
 #include <string>
 
-#define _LOG(level) \
-	Log(LOG_##level).get() << pthread_self() \
-	<< timestr() << " " __FILE__  ":"  << __LINE__ << ":" << __FUNCTION__ << ": "
+extern "C" {
+#include <osmocom/core/logging.h>
+#include "debug.h"
+}
 
-#define IS_LOG_LEVEL(wLevel) (gGetLoggingLevel(__FILE__)>=LOG_##wLevel)
-
-#ifdef NDEBUG
-#define LOG(wLevel) \
-	if (LOG_##wLevel!=LOG_DEBUG && IS_LOG_LEVEL(wLevel)) _LOG(wLevel)
-#else
-#define LOG(wLevel) \
-	if (IS_LOG_LEVEL(wLevel)) _LOG(wLevel)
+/* Translation for old log statements */
+#ifndef LOGL_ALERT
+#define LOGL_ALERT LOGL_FATAL
+#endif
+#ifndef LOGL_ERR
+#define LOGL_ERR LOGL_ERROR
+#endif
+#ifndef LOGL_WARNING
+#define LOGL_WARNING LOGL_NOTICE
 #endif
 
-// pat: And for your edification here are the 'levels' as defined in syslog.h:
-// LOG_EMERG   0  system is unusable
-// LOG_ALERT   1  action must be taken immediately
-// LOG_CRIT    2  critical conditions
-// LOG_ERR     3  error conditions
-// LOG_WARNING 4  warning conditions
-// LOG_NOTICE  5  normal, but significant, condition
-// LOG_INFO    6  informational message
-// LOG_DEBUG   7  debug-level message
+#define LOG(level) \
+	Log(DMAIN, LOGL_##level, __BASE_FILE__, __LINE__).get() <<  "[tid=" << pthread_self() << "] "
 
-// (pat) added - print out a var and its name.
-// Use like this: int descriptive_name; LOG(INFO)<<LOGVAR(descriptive_name);
-#define LOGVAR2(name,val) " " << name << "=" << (val)
-#define LOGVAR(var) (" " #var "=") << var
-#define LOGHEX(var) (" " #var "=0x") << hex << ((unsigned)var) << dec
-#define LOGHEX2(name,val) " " << name << "=0x" << hex << ((unsigned)(val)) << dec
-// These are kind of cheesy, but you can use for bitvector
-#define LOGBV2(name,val) " " << name << "=(" << val<<" size:"<<val.size()<<")"
-#define LOGBV(bv) LOGBV2(#bv,bv)
-#define LOGVARRANGE(name,cur,lo,hi) " "<<name <<"=("<<(cur) << " range:"<<(lo) << " to "<<(hi) <<")"
+#define LOGC(category, level) \
+	Log(category, LOGL_##level, __BASE_FILE__, __LINE__).get() <<  "[tid=" << pthread_self() << "] "
 
+#define LOGLV(category, level) \
+	Log(category, level, __BASE_FILE__, __LINE__).get() <<  "[tid=" << pthread_self() << "] "
 
-#define OBJLOG(wLevel) \
-	LOG(wLevel) << "obj: " << this << ' '
+#define LOGSRC(category, level, file, line) \
+	Log(category, level, file, line).get() <<  "[tid=" << pthread_self() << "] "
 
-#define LOG_ASSERT(x) { if (!(x)) LOG(EMERG) << "assertion " #x " failed"; } assert(x);
-
-
-#include "Threads.h"		// must be after defines above, if these files are to be allowed to use LOG()
+#define LOGCHAN(chan, category, level) \
+	Log(category, LOGL_##level, __BASE_FILE__, __LINE__).get() <<  "[tid=" << pthread_self() << "][chan=" << chan << "] "
 
 /**
 	A C++ stream-based thread-safe logger.
-	Derived from Dr. Dobb's Sept. 2007 issue.
-	Updated to use syslog.
 	This object is NOT the global logger;
 	every log record is an object of this class.
 */
@@ -97,45 +75,28 @@ class Log {
 
 	protected:
 
-	std::ostringstream mStream;		///< This is where we buffer up the log entry.
-	int mPriority;					///< Priority of current report.
-	bool mDummyInit;
+	std::ostringstream mStream;	///< This is where we buffer up the log entry.
+	int mCategory;			///< Priority of current report.
+	int mPriority;			///< Category of current report.
+	const char *filename;		///< Source File Name of current report.
+	int line;			///< Line number in source file of current report.
 
 	public:
 
-	Log(int wPriority)
-		:mPriority(wPriority), mDummyInit(false)
+	Log(int wCategory, int wPriority, const char* filename, int line)
+		: mCategory(wCategory), mPriority(wPriority),
+		  filename(filename), line(line)
 	{ }
 
-	Log(const char* name, const char* level=NULL, int facility=LOG_USER);
-
 	// Most of the work is in the destructor.
 	/** The destructor actually generates the log entry. */
 	~Log();
 
 	std::ostringstream& get();
 };
-extern bool gLogToConsole;	// Output log messages to stdout
-extern bool gLogToSyslog;	// Output log messages to syslog
 
-
-
-std::list<std::string> gGetLoggerAlarms();		///< Get a copy of the recent alarm list.
-
-const std::string timestr();		// A timestamp to print in messages.
 std::ostream& operator<<(std::ostream& os, std::ostringstream& ss);
 
-/**@ Global control and initialization of the logging system. */
-//@{
-/** Initialize the global logging system. */
-void gLogInit(const char* name, const char* level=NULL, int facility=LOG_USER);
-/** Get the logging level associated with a given file. */
-int gGetLoggingLevel(const char *filename=NULL);
-/** Allow early logging when still in constructors */
-void gLogEarly(int level, const char *fmt, ...) __attribute__((format(printf, 2, 3)));
-//@}
-
-
 #endif
 
 // vim: ts=4 sw=4

CommonLibs/Makefile.am

@@ -22,77 +22,35 @@
 include $(top_srcdir)/Makefile.common
 
 AM_CPPFLAGS = $(STD_DEFINES_AND_INCLUDES)
-AM_CXXFLAGS = -Wall -O3 -g -ldl -lpthread
-
-EXTRA_DIST = \
-	example.config \
-	README.common
+AM_CXXFLAGS = -Wall -O3 -g -lpthread $(LIBOSMOCORE_CFLAGS) $(LIBOSMOCTRL_CFLAGS) $(LIBOSMOVTY_CFLAGS)
+AM_CFLAGS = $(LIBOSMOCORE_CFLAGS) $(LIBOSMOCTRL_CFLAGS) $(LIBOSMOVTY_CFLAGS)
 
 noinst_LTLIBRARIES = libcommon.la
 
 libcommon_la_SOURCES = \
 	BitVector.cpp \
 	LinkedLists.cpp \
-	Sockets.cpp \
 	Threads.cpp \
 	Timeval.cpp \
 	Logger.cpp \
-	Configuration.cpp \
-	sqlite3util.cpp
-
-noinst_PROGRAMS = \
-	BitVectorTest \
-	PRBSTest \
-	InterthreadTest \
-	SocketsTest \
-	TimevalTest \
-	VectorTest \
-	ConfigurationTest \
-	LogTest
-
-#	ReportingTest 
+	Utils.cpp \
+	trx_rate_ctr.cpp \
+	trx_vty.c \
+	debug.c
+libcommon_la_LIBADD = $(LIBOSMOCORE_LIBS) $(LIBOSMOCTRL_LIBS) $(LIBOSMOVTY_LIBS)
 
 noinst_HEADERS = \
 	BitVector.h \
 	PRBS.h \
 	Interthread.h \
 	LinkedLists.h \
-	Sockets.h \
 	Threads.h \
 	Timeval.h \
 	Vector.h \
-	Configuration.h \
 	Logger.h \
-	sqlite3util.h
-
-BitVectorTest_SOURCES = BitVectorTest.cpp
-BitVectorTest_LDADD = libcommon.la $(SQLITE3_LIBS)
-
-PRBSTest_SOURCES = PRBSTest.cpp
-
-InterthreadTest_SOURCES = InterthreadTest.cpp
-InterthreadTest_LDADD = libcommon.la
-InterthreadTest_LDFLAGS = -lpthread
-
-SocketsTest_SOURCES = SocketsTest.cpp
-SocketsTest_LDADD = libcommon.la
-SocketsTest_LDFLAGS = -lpthread
-
-TimevalTest_SOURCES = TimevalTest.cpp
-TimevalTest_LDADD = libcommon.la
-
-VectorTest_SOURCES = VectorTest.cpp
-VectorTest_LDADD = libcommon.la $(SQLITE3_LIBS)
-
-ConfigurationTest_SOURCES = ConfigurationTest.cpp
-ConfigurationTest_LDADD = libcommon.la 	$(SQLITE3_LIBS)
-
-# ReportingTest_SOURCES = ReportingTest.cpp
-# ReportingTest_LDADD = libcommon.la $(SQLITE_LA)
-
-LogTest_SOURCES = LogTest.cpp
-LogTest_LDADD = libcommon.la $(SQLITE3_LIBS)
-
-MOSTLYCLEANFILES += testSource testDestination
-
-
+	Utils.h \
+	trx_rate_ctr.h \
+	trx_vty.h \
+	debug.h \
+	osmo_signal.h \
+	config_defs.h

CommonLibs/PRBS.h

@@ -1,6 +1,8 @@
 /*
  * Copyright (C) 2017 Alexander Chemeris <Alexander.Chemeris@fairwaves.co>
  *
+ * SPDX-License-Identifier: LGPL-2.1+
+ *
  * 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

CommonLibs/Sockets.cpp

@@ -1,333 +0,0 @@
-/*
-* Copyright 2008, 2010 Free Software Foundation, Inc.
-*
-*
-* This software is distributed under the terms of the GNU Affero Public License.
-* See the COPYING file in the main directory for details.
-*
-* This use of this software may be subject to additional restrictions.
-* See the LEGAL file in the main directory for details.
-
-	This program is free software: you can redistribute it and/or modify
-	it under the terms of the GNU Affero General Public License as published by
-	the Free Software Foundation, either version 3 of the License, or
-	(at your option) any later version.
-
-	This program 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 Affero General Public License for more details.
-
-	You should have received a copy of the GNU Affero General Public License
-	along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-*/
-
-
-
-#include <config.h>
-#include <unistd.h>
-#include <fcntl.h>
-#include <cstdio>
-#include <sys/select.h>
-
-#include "Threads.h"
-#include "Sockets.h"
-#include <stdio.h>
-#include <unistd.h>
-#include <fcntl.h>
-
-#include <string.h>
-#include <stdlib.h>
-
-
-
-
-
-
-bool resolveAddress(struct sockaddr_in *address, const char *hostAndPort)
-{
-	assert(address);
-	assert(hostAndPort);
-	char *copy = strdup(hostAndPort);
-	char *colon = strchr(copy,':');
-	if (!colon) return false;
-	*colon = '\0';
-	char *host = copy;
-	unsigned port = strtol(colon+1,NULL,10);
-	bool retVal = resolveAddress(address,host,port);
-	free(copy);
-	return retVal;
-}
-
-bool resolveAddress(struct sockaddr_in *address, const char *host, unsigned short port)
-{
-	assert(address);
-	assert(host);
-	// FIXME -- Need to ignore leading/trailing spaces in hostname.
-	struct hostent *hp;
-	int h_errno_local;
-#ifdef HAVE_GETHOSTBYNAME2_R
-	struct hostent hostData;
-	char tmpBuffer[2048];
-
-	// There are different flavors of gethostbyname_r(), but
-	// latest Linux use the following form:
-	if (gethostbyname2_r(host, AF_INET, &hostData, tmpBuffer, sizeof(tmpBuffer), &hp, &h_errno_local)!=0) {
-		CERR("WARNING -- gethostbyname2_r() failed for " << host << ", " << hstrerror(h_errno_local));
-		return false;
-	}
-#else
-	static Mutex sGethostbynameMutex;
-	// gethostbyname() is NOT thread-safe, so we should use a mutex here.
-	// Ideally it should be a global mutex for all non thread-safe socket
-	// operations and it should protect access to variables such as
-	// global h_errno.
-	sGethostbynameMutex.lock();
-	hp = gethostbyname(host);
-	h_errno_local = h_errno;
-	sGethostbynameMutex.unlock();
-#endif
- 	if (hp==NULL) {
-		CERR("WARNING -- gethostbyname() failed for " << host << ", " << hstrerror(h_errno_local));
-		return false;
-	}
-	if (hp->h_addrtype != AF_INET) {
-		CERR("WARNING -- gethostbyname() resolved " << host << " to something other then AF_INET");
- 		return false;
- 	}
-	address->sin_family = hp->h_addrtype;
-	assert(sizeof(address->sin_addr) == hp->h_length);
-	memcpy(&(address->sin_addr), hp->h_addr_list[0], hp->h_length);
-	address->sin_port = htons(port);
-	return true;
-}
-
-
-
-DatagramSocket::DatagramSocket()
-{
-	memset(mDestination, 0, sizeof(mDestination));
-}
-
-
-
-
-
-void DatagramSocket::nonblocking()
-{
-	fcntl(mSocketFD,F_SETFL,O_NONBLOCK);
-}
-
-void DatagramSocket::blocking()
-{
-	fcntl(mSocketFD,F_SETFL,0);
-}
-
-void DatagramSocket::close()
-{
-	::close(mSocketFD);
-}
-
-
-DatagramSocket::~DatagramSocket()
-{
-	close();
-}
-
-
-
-
-
-int DatagramSocket::write( const char * message, size_t length )
-{
-	assert(length<=MAX_UDP_LENGTH);
-	int retVal = sendto(mSocketFD, message, length, 0,
-		(struct sockaddr *)mDestination, addressSize());
-	if (retVal == -1 ) perror("DatagramSocket::write() failed");
-	return retVal;
-}
-
-int DatagramSocket::writeBack( const char * message, size_t length )
-{
-	assert(length<=MAX_UDP_LENGTH);
-	int retVal = sendto(mSocketFD, message, length, 0,
-		(struct sockaddr *)mSource, addressSize());
-	if (retVal == -1 ) perror("DatagramSocket::write() failed");
-	return retVal;
-}
-
-
-
-int DatagramSocket::write( const char * message)
-{
-	size_t length=strlen(message)+1;
-	return write(message,length);
-}
-
-int DatagramSocket::writeBack( const char * message)
-{
-	size_t length=strlen(message)+1;
-	return writeBack(message,length);
-}
-
-
-
-int DatagramSocket::send(const struct sockaddr* dest, const char * message, size_t length )
-{
-	assert(length<=MAX_UDP_LENGTH);
-	int retVal = sendto(mSocketFD, message, length, 0, dest, addressSize());
-	if (retVal == -1 ) perror("DatagramSocket::send() failed");
-	return retVal;
-}
-
-int DatagramSocket::send(const struct sockaddr* dest, const char * message)
-{
-	size_t length=strlen(message)+1;
-	return send(dest,message,length);
-}
-
-int DatagramSocket::read(char* buffer, size_t length)
-{
-	socklen_t addr_len = sizeof(mSource);
-	int rd_length = recvfrom(mSocketFD, (void *) buffer, length, 0,
-		(struct sockaddr*) &mSource, &addr_len);
-
-	if ((rd_length==-1) && (errno!=EAGAIN)) {
-		perror("DatagramSocket::read() failed");
-		throw SocketError();
-	}
-	return rd_length;
-}
-
-int DatagramSocket::read(char* buffer, size_t length, unsigned timeout)
-{
-	fd_set fds;
-	FD_ZERO(&fds);
-	FD_SET(mSocketFD,&fds);
-	struct timeval tv;
-	tv.tv_sec = timeout/1000;
-	tv.tv_usec = (timeout%1000)*1000;
-	int sel = select(mSocketFD+1,&fds,NULL,NULL,&tv);
-	if (sel<0) {
-		perror("DatagramSocket::read() select() failed");
-		throw SocketError();
-	}
-	if (sel==0) return -1;
-	if (FD_ISSET(mSocketFD,&fds)) return read(buffer, length);
-	return -1;
-}
-
-
-
-
-
-
-UDPSocket::UDPSocket(const char *wSrcIP, unsigned short wSrcPort)
-	:DatagramSocket()
-{
-	open(wSrcPort, wSrcIP);
-}
-
-
-UDPSocket::UDPSocket(const char *wSrcIP, unsigned short wSrcPort,
-		     const char *wDestIP, unsigned short wDestPort)
-	:DatagramSocket()
-{
-	open(wSrcPort, wSrcIP);
-	destination(wDestPort, wDestIP);
-}
-
-
-
-void UDPSocket::destination( unsigned short wDestPort, const char * wDestIP )
-{
-	resolveAddress((sockaddr_in*)mDestination, wDestIP, wDestPort );
-}
-
-
-void UDPSocket::open(unsigned short localPort, const char *wlocalIP)
-{
-	// create
-	mSocketFD = socket(AF_INET,SOCK_DGRAM,0);
-	if (mSocketFD<0) {
-		perror("socket() failed");
-		throw SocketError();
-	}
-
-	// pat added: This lets the socket be reused immediately, which is needed if OpenBTS crashes.
-	int on = 1;
-	setsockopt(mSocketFD, SOL_SOCKET, SO_REUSEADDR, &on, sizeof(on));
-
-
-	// bind
-	struct sockaddr_in address;
-	size_t length = sizeof(address);
-	bzero(&address,length);
-	address.sin_family = AF_INET;
-	address.sin_addr.s_addr = inet_addr(wlocalIP);
-	address.sin_port = htons(localPort);
-	if (bind(mSocketFD,(struct sockaddr*)&address,length)<0) {
-		perror("bind() failed");
-		throw SocketError();
-	}
-}
-
-
-
-unsigned short UDPSocket::port() const
-{
-	struct sockaddr_in name;
-	socklen_t nameSize = sizeof(name);
-	int retVal = getsockname(mSocketFD, (struct sockaddr*)&name, &nameSize);
-	if (retVal==-1) throw SocketError();
-	return ntohs(name.sin_port);
-}
-
-
-
-
-
-UDDSocket::UDDSocket(const char* localPath, const char* remotePath)
-	:DatagramSocket()
-{
-	if (localPath!=NULL) open(localPath);
-	if (remotePath!=NULL) destination(remotePath);
-}
-
-
-
-void UDDSocket::open(const char* localPath)
-{
-	// create
-	mSocketFD = socket(AF_UNIX,SOCK_DGRAM,0);
-	if (mSocketFD<0) {
-		perror("socket() failed");
-		throw SocketError();
-	}
-
-	// bind
-	struct sockaddr_un address;
-	size_t length = sizeof(address);
-	bzero(&address,length);
-	address.sun_family = AF_UNIX;
-	strcpy(address.sun_path,localPath);
-	unlink(localPath);
-	if (bind(mSocketFD,(struct sockaddr*)&address,length)<0) {
-		perror("bind() failed");
-		throw SocketError();
-	}
-}
-
-
-
-void UDDSocket::destination(const char* remotePath)
-{
-	struct sockaddr_un* unAddr = (struct sockaddr_un*)mDestination;
-	strcpy(unAddr->sun_path,remotePath);
-}
-
-
-
-
-// vim:ts=4:sw=4

CommonLibs/Sockets.h

@@ -1,193 +0,0 @@
-/*
-* Copyright 2008, 2010 Free Software Foundation, Inc.
-*
-* This software is distributed under the terms of the GNU Affero Public License.
-* See the COPYING file in the main directory for details.
-*
-* This use of this software may be subject to additional restrictions.
-* See the LEGAL file in the main directory for details.
-
-	This program is free software: you can redistribute it and/or modify
-	it under the terms of the GNU Affero General Public License as published by
-	the Free Software Foundation, either version 3 of the License, or
-	(at your option) any later version.
-
-	This program 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 Affero General Public License for more details.
-
-	You should have received a copy of the GNU Affero General Public License
-	along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-*/
-
-
-#ifndef SOCKETS_H
-#define SOCKETS_H
-
-#include <arpa/inet.h>
-#include <netdb.h>
-#include <sys/socket.h>
-#include <sys/types.h>
-#include <sys/un.h>
-#include <errno.h>
-#include <list>
-#include <assert.h>
-#include <stdint.h>
-#include <stdio.h>
-
-
-
-
-
-#define MAX_UDP_LENGTH 1500
-
-/** A function to resolve IP host names. */
-bool resolveAddress(struct sockaddr_in *address, const char *host, unsigned short port);
-
-/** Resolve an address of the form "<host>:<port>". */
-bool resolveAddress(struct sockaddr_in *address, const char *hostAndPort);
-
-/** An exception to throw when a critical socket operation fails. */
-class SocketError {};
-#define SOCKET_ERROR {throw SocketError(); }
-
-/** Abstract class for connectionless sockets. */
-class DatagramSocket {
-
-protected:
-
-	int mSocketFD;				///< underlying file descriptor
-	char mDestination[256];		///< address to which packets are sent
-	char mSource[256];		///< return address of most recent received packet
-
-public:
-
-	/** An almost-does-nothing constructor. */
-	DatagramSocket();
-
-	virtual ~DatagramSocket();
-
-	/** Return the address structure size for this socket type. */
-	virtual size_t addressSize() const = 0;
-
-	/**
-		Send a binary packet.
-		@param buffer The data bytes to send to mDestination.
-		@param length Number of bytes to send, or strlen(buffer) if defaulted to -1.
-		@return number of bytes written, or -1 on error.
-	*/
-	int write( const char * buffer, size_t length);
-
-	/**
-		Send a C-style string packet.
-		@param buffer The data bytes to send to mDestination.
-		@return number of bytes written, or -1 on error.
-	*/
-	int write( const char * buffer);
-
-	/**
-		Send a binary packet.
-		@param buffer The data bytes to send to mSource.
-		@param length Number of bytes to send, or strlen(buffer) if defaulted to -1.
-		@return number of bytes written, or -1 on error.
-	*/
-	int writeBack(const char * buffer, size_t length);
-
-	/**
-		Send a C-style string packet.
-		@param buffer The data bytes to send to mSource.
-		@return number of bytes written, or -1 on error.
-	*/
-	int writeBack(const char * buffer);
-
-
-	/**
-		Receive a packet.
-		@param buffer A char[MAX_UDP_LENGTH] procured by the caller.
-		@return The number of bytes received or -1 on non-blocking pass.
-	*/
-	int read(char* buffer, size_t length);
-
-	/**
-		Receive a packet with a timeout.
-		@param buffer A char[MAX_UDP_LENGTH] procured by the caller.
-		@param maximum wait time in milliseconds
-		@return The number of bytes received or -1 on timeout.
-	*/
-	int read(char* buffer, size_t length, unsigned timeout);
-
-
-	/** Send a packet to a given destination, other than the default. */
-	int send(const struct sockaddr *dest, const char * buffer, size_t length);
-
-	/** Send a C-style string to a given destination, other than the default. */
-	int send(const struct sockaddr *dest, const char * buffer);
-
-	/** Make the socket non-blocking. */
-	void nonblocking();
-
-	/** Make the socket blocking (the default). */
-	void blocking();
-
-	/** Close the socket. */
-	void close();
-
-};
-
-
-
-/** UDP/IP User Datagram Socket */
-class UDPSocket : public DatagramSocket {
-
-public:
-
-	/** Open a USP socket with an OS-assigned port and no default destination. */
-	UDPSocket(const char *localIP, unsigned short localPort);
-
-	/** Given a full specification, open the socket and set the dest address. */
-	UDPSocket(const char *localIP, unsigned short localPort,
-		  const char *remoteIP, unsigned short remotePort);
-
-	/** Set the destination port. */
-	void destination( unsigned short wDestPort, const char * wDestIP );
-
-	/** Return the actual port number in use. */
-	unsigned short port() const;
-
-	/** Open and bind the UDP socket to a local port. */
-	void open(unsigned short localPort=0, const char *wlocalIP="127.0.0.1");
-
-	/** Give the return address of the most recently received packet. */
-	const struct sockaddr_in* source() const { return (const struct sockaddr_in*)mSource; }
-
-	size_t addressSize() const { return sizeof(struct sockaddr_in); }
-
-};
-
-
-/** Unix Domain Datagram Socket */
-class UDDSocket : public DatagramSocket {
-
-public:
-
-	UDDSocket(const char* localPath=NULL, const char* remotePath=NULL);
-
-	void destination(const char* remotePath);
-
-	void open(const char* localPath);
-
-	/** Give the return address of the most recently received packet. */
-	const struct sockaddr_un* source() const { return (const struct sockaddr_un*)mSource; }
-
-	size_t addressSize() const { return sizeof(struct sockaddr_un); }
-
-};
-
-
-#endif
-
-
-
-// vim:ts=4:sw=4

CommonLibs/SocketsTest.cpp

@@ -1,103 +0,0 @@
-/*
-* Copyright 2008 Free Software Foundation, Inc.
-*
-*
-* This software is distributed under the terms of the GNU Affero Public License.
-* See the COPYING file in the main directory for details.
-*
-* This use of this software may be subject to additional restrictions.
-* See the LEGAL file in the main directory for details.
-
-	This program is free software: you can redistribute it and/or modify
-	it under the terms of the GNU Affero General Public License as published by
-	the Free Software Foundation, either version 3 of the License, or
-	(at your option) any later version.
-
-	This program 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 Affero General Public License for more details.
-
-	You should have received a copy of the GNU Affero General Public License
-	along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-*/
-
-
-
-
-#include "Sockets.h"
-#include "Threads.h"
-#include <stdio.h>
-#include <stdlib.h>
-
-
-static const int gNumToSend = 10;
-
-
-void *testReaderIP(void *)
-{
-	UDPSocket readSocket("127.0.0.1", 5934, "localhost", 5061);
-	readSocket.nonblocking();
-	int rc = 0;
-	while (rc<gNumToSend) {
-		char buf[MAX_UDP_LENGTH];
-		int count = readSocket.read(buf, MAX_UDP_LENGTH);
-		if (count>0) {
-			COUT("read: " << buf);
-			rc++;
-		} else {
-			sleep(2);
-		}
-	}
-	return NULL;
-}
-
-
-
-void *testReaderUnix(void *)
-{
-	UDDSocket readSocket("testDestination");
-	readSocket.nonblocking();
-	int rc = 0;
-	while (rc<gNumToSend) {
-		char buf[MAX_UDP_LENGTH];
-		int count = readSocket.read(buf, MAX_UDP_LENGTH);
-		if (count>0) {
-			COUT("read: " << buf);
-			rc++;
-		} else {
-			sleep(2);
-		}
-	}
-	return NULL;
-}
-
-
-int main(int argc, char * argv[] )
-{
-
-  Thread readerThreadIP;
-  readerThreadIP.start(testReaderIP,NULL);
-  Thread readerThreadUnix;
-  readerThreadUnix.start(testReaderUnix,NULL);
-
-  UDPSocket socket1("127.0.0.1", 5061, "127.0.0.1", 5934);
-  UDDSocket socket1U("testSource","testDestination");
-  
-  COUT("socket1: " << socket1.port());
-
-  // give the readers time to open
-  sleep(1);
-
-  for (int i=0; i<gNumToSend; i++) {
-    socket1.write("Hello IP land");	
-	socket1U.write("Hello Unix domain");
-	sleep(1);
-  }
-
-  readerThreadIP.join();
-  readerThreadUnix.join();
-}
-
-// vim: ts=4 sw=4

CommonLibs/Threads.cpp

@@ -1,6 +1,7 @@
 /*
 * Copyright 2008 Free Software Foundation, Inc.
 *
+* SPDX-License-Identifier: AGPL-3.0+
 *
 * This software is distributed under the terms of the GNU Affero Public License.
 * See the COPYING file in the main directory for details.
@@ -24,16 +25,24 @@
 */
 
 
-
-
+#include <string.h>
+#include <sys/types.h>
 
 #include "Threads.h"
 #include "Timeval.h"
+#include "Logger.h"
+
+#ifndef gettid
+#include <sys/syscall.h>
+#define gettid() syscall(SYS_gettid)
+#endif
 
 
 using namespace std;
 
-
+#ifndef HAVE_ATOMIC_OPS
+	pthread_mutex_t atomic_ops_mutex = PTHREAD_MUTEX_INITIALIZER;
+#endif
 
 
 Mutex gStreamLock;		///< Global lock to control access to cout and cerr.
@@ -102,6 +111,25 @@ void Signal::wait(Mutex& wMutex, unsigned timeout) const
 	pthread_cond_timedwait(&mSignal,&wMutex.mMutex,&waitTime);
 }
 
+void set_selfthread_name(const char *name)
+{
+	pthread_t selfid = pthread_self();
+	pid_t tid = gettid();
+	if (pthread_setname_np(selfid, name) == 0) {
+		LOG(INFO) << "Thread "<< selfid << " (task " << tid << ") set name: " << name;
+	} else {
+		char buf[256];
+		int err = errno;
+		char* err_str = strerror_r(err, buf, sizeof(buf));
+		LOG(NOTICE) << "Thread "<< selfid << " (task " << tid << ") set name \"" << name << "\" failed: (" << err << ") " << err_str;
+	}
+}
+
+void thread_enable_cancel(bool cancel)
+{
+	cancel ? pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL) :
+		 pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL);
+}
 
 void Thread::start(void *(*task)(void*), void *arg)
 {
@@ -110,8 +138,10 @@ void Thread::start(void *(*task)(void*), void *arg)
 	// (pat) Moved initialization to constructor to avoid crash in destructor.
 	//res = pthread_attr_init(&mAttrib);
 	//assert(!res);
-	res = pthread_attr_setstacksize(&mAttrib, mStackSize);
-	assert(!res);
+	if (mStackSize != 0) {
+		res = pthread_attr_setstacksize(&mAttrib, mStackSize);
+		assert(!res);
+	}
 	res = pthread_create(&mThread, &mAttrib, task, arg);
 	assert(!res);
 }

CommonLibs/Threads.h

@@ -1,6 +1,8 @@
 /*
 * Copyright 2008, 2011 Free Software Foundation, Inc.
 *
+* SPDX-License-Identifier: AGPL-3.0+
+*
 * This software is distributed under the terms of the GNU Affero Public License.
 * See the COPYING file in the main directory for details.
 *
@@ -26,6 +28,8 @@
 #ifndef THREADS_H
 #define THREADS_H
 
+#include "config.h"
+
 #include <pthread.h>
 #include <iostream>
 #include <assert.h>
@@ -55,7 +59,7 @@ void unlockCout();		///< call after writing cout
 #define OBJDCOUT(text) {}
 #else
 #define DCOUT(text) { COUT(__FILE__ << ":" << __LINE__ << " " << text); }
-#define OBJDCOUT(text) { DCOUT(this << " " << text); } 
+#define OBJDCOUT(text) { DCOUT(this << " " << text); }
 #endif
 //@}
 //@}
@@ -141,6 +145,9 @@ class Signal {
 #define START_THREAD(thread,function,argument) \
 	thread.start((void *(*)(void*))function, (void*)argument);
 
+void set_selfthread_name(const char *name);
+void thread_enable_cancel(bool cancel);
+
 /** A C++ wrapper for pthread threads.  */
 class Thread {
 
@@ -150,12 +157,12 @@ class Thread {
 	pthread_attr_t mAttrib;
 	// FIXME -- Can this be reduced now?
 	size_t mStackSize;
-	
+
 
 	public:
 
 	/** Create a thread in a non-running state. */
-	Thread(size_t wStackSize = (65536*4)):mThread((pthread_t)0) {
+	Thread(size_t wStackSize = 0):mThread((pthread_t)0) {
 		pthread_attr_init(&mAttrib);	// (pat) moved this here.
 		mStackSize=wStackSize;
 	}
@@ -179,12 +186,34 @@ class Thread {
 		}
 	}
 
-	/** Send cancelation to thread */
+	/** Send cancellation to thread */
 	void cancel() { pthread_cancel(mThread); }
 };
 
+#ifdef HAVE_ATOMIC_OPS
+#define osmo_trx_sync_fetch_and_and(ptr, value) __sync_fetch_and_and((ptr), (value))
+#define osmo_trx_sync_or_and_fetch(ptr, value) __sync_or_and_fetch((ptr), (value))
+#else
+extern pthread_mutex_t atomic_ops_mutex;
+static inline int osmo_trx_sync_fetch_and_and(int *ptr, int value)
+{
+	pthread_mutex_lock(&atomic_ops_mutex);
+	int tmp = *ptr;
+	*ptr &= value;
+	pthread_mutex_unlock(&atomic_ops_mutex);
+	return tmp;
+}
 
-
+static inline int osmo_trx_sync_or_and_fetch(int *ptr, int value)
+{
+	int tmp;
+	pthread_mutex_lock(&atomic_ops_mutex);
+	*ptr |= value;
+	tmp = *ptr;
+	pthread_mutex_unlock(&atomic_ops_mutex);
+	return tmp;
+}
+#endif
 
 #endif
 // vim: ts=4 sw=4

CommonLibs/Timeval.cpp

@@ -1,6 +1,7 @@
 /*
 * Copyright 2008 Free Software Foundation, Inc.
 *
+* SPDX-License-Identifier: AGPL-3.0+
 *
 * This software is distributed under the terms of the GNU Affero Public License.
 * See the COPYING file in the main directory for details.
@@ -27,43 +28,49 @@
 
 #include "Timeval.h"
 
+extern "C" {
+#include <osmocom/core/timer.h>
+}
+
 using namespace std;
 
+void Timeval::now()
+{
+	osmo_clock_gettime(CLOCK_REALTIME, &mTimespec);
+}
+
 void Timeval::future(unsigned offset)
 {
 	now();
 	unsigned sec = offset/1000;
 	unsigned msec = offset%1000;
-	mTimeval.tv_usec += msec*1000;
-	mTimeval.tv_sec += sec;
-	if (mTimeval.tv_usec>1000000) {
-		mTimeval.tv_usec -= 1000000;
-		mTimeval.tv_sec += 1;
+	mTimespec.tv_nsec += msec*1000*1000;
+	mTimespec.tv_sec += sec;
+	if (mTimespec.tv_nsec > 1000*1000*1000) {
+		mTimespec.tv_nsec -= 1000*1000*1000;
+		mTimespec.tv_sec += 1;
 	}
 }
 
 
 struct timespec Timeval::timespec() const
 {
-	struct timespec retVal;
-	retVal.tv_sec = mTimeval.tv_sec;
-	retVal.tv_nsec = 1000 * (long)mTimeval.tv_usec;
-	return retVal;
+	return mTimespec;
 }
 
 
 bool Timeval::passed() const
 {
 	Timeval nowTime;
-	if (nowTime.mTimeval.tv_sec < mTimeval.tv_sec) return false;
-	if (nowTime.mTimeval.tv_sec > mTimeval.tv_sec) return true;
-	if (nowTime.mTimeval.tv_usec > mTimeval.tv_usec) return true;
+	if (nowTime.mTimespec.tv_sec < mTimespec.tv_sec) return false;
+	if (nowTime.mTimespec.tv_sec > mTimespec.tv_sec) return true;
+	if (nowTime.mTimespec.tv_nsec >= mTimespec.tv_nsec) return true;
 	return false;
 }
 
 double Timeval::seconds() const
 {
-	return ((double)mTimeval.tv_sec) + 1e-6*((double)mTimeval.tv_usec);
+	return ((double)mTimespec.tv_sec) + 1e-9*((double)mTimespec.tv_nsec);
 }
 
 
@@ -72,24 +79,25 @@ long Timeval::delta(const Timeval& other) const
 {
 	// 2^31 milliseconds is just over 4 years.
 	int32_t deltaS = other.sec() - sec();
-	int32_t deltaUs = other.usec() - usec();
-	return 1000*deltaS + deltaUs/1000;
+	int32_t deltaNs = other.nsec() - nsec();
+	return 1000*deltaS + deltaNs/1000000;
 }
-	
+
 
 
 
 ostream& operator<<(ostream& os, const Timeval& tv)
 {
-	os.setf( ios::fixed, ios::floatfield );
+	ios_base::fmtflags flags_backup = os.setf( ios::fixed, ios::floatfield );
 	os << tv.seconds();
+	os.flags( flags_backup );
 	return os;
 }
 
 
 ostream& operator<<(ostream& os, const struct timespec& ts)
 {
-	os << ts.tv_sec << "," << ts.tv_nsec;
+	os << ts.tv_sec << "," << ts.tv_nsec/1000;
 	return os;
 }
 

CommonLibs/Timeval.h

@@ -1,6 +1,8 @@
 /*
 * Copyright 2008 Free Software Foundation, Inc.
 *
+* SPDX-License-Identifier: AGPL-3.0+
+*
 * This software is distributed under the terms of the GNU Affero Public License.
 * See the COPYING file in the main directory for details.
 *
@@ -42,12 +44,12 @@ class Timeval {
 
 	private:
 
-	struct timeval mTimeval;
+	struct timespec mTimespec;
 
 	public:
 
-	/** Set the value to gettimeofday. */
-	void now() { gettimeofday(&mTimeval,NULL); }
+	/** Set the value to current time. */
+	void now();
 
 	/** Set the value to gettimeofday plus an offset. */
 	void future(unsigned ms);
@@ -55,16 +57,18 @@ class Timeval {
 	//@{
 	Timeval(unsigned sec, unsigned usec)
 	{
-		mTimeval.tv_sec = sec;
-		mTimeval.tv_usec = usec;
+		mTimespec.tv_sec = sec;
+		mTimespec.tv_nsec = usec*1000;
 	}
 
 	Timeval(const struct timeval& wTimeval)
-		:mTimeval(wTimeval)
-	{}
+	{
+		mTimespec.tv_sec = wTimeval.tv_sec;
+		mTimespec.tv_nsec = wTimeval.tv_sec*1000;
+	}
 
 	/**
-		Create a Timeval offset into the future.
+		Create a Timespec offset into the future.
 		@param offset milliseconds
 	*/
 	Timeval(unsigned offset=0) { future(offset); }
@@ -76,10 +80,11 @@ class Timeval {
 	/** Return total seconds. */
 	double seconds() const;
 
-	uint32_t sec() const { return mTimeval.tv_sec; }
-	uint32_t usec() const { return mTimeval.tv_usec; }
+	uint32_t sec() const { return mTimespec.tv_sec; }
+	uint32_t usec() const { return mTimespec.tv_nsec / 1000; }
+	uint32_t nsec() const { return mTimespec.tv_nsec; }
 
-	/** Return differnce from other (other-self), in ms. */
+	/** Return difference from other (other-self), in ms. */
 	long delta(const Timeval& other) const;
 
 	/** Elapsed time in ms. */
@@ -88,11 +93,11 @@ class Timeval {
 	/** Remaining time in ms. */
 	long remaining() const { return -elapsed(); }
 
-	/** Return true if the time has passed, as per gettimeofday. */
+	/** Return true if the time has passed, as per clock_gettime(CLOCK_REALTIME). */
 	bool passed() const;
 
 	/** Add a given number of minutes to the time. */
-	void addMinutes(unsigned minutes) { mTimeval.tv_sec += minutes*60; }
+	void addMinutes(unsigned minutes) { mTimespec.tv_sec += minutes*60; }
 
 };
 

CommonLibs/TimevalTest.cpp

@@ -1,45 +0,0 @@
-/*
-* Copyright 2008 Free Software Foundation, Inc.
-*
-*
-* This software is distributed under the terms of the GNU Affero Public License.
-* See the COPYING file in the main directory for details.
-*
-* This use of this software may be subject to additional restrictions.
-* See the LEGAL file in the main directory for details.
-
-	This program is free software: you can redistribute it and/or modify
-	it under the terms of the GNU Affero General Public License as published by
-	the Free Software Foundation, either version 3 of the License, or
-	(at your option) any later version.
-
-	This program 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 Affero General Public License for more details.
-
-	You should have received a copy of the GNU Affero General Public License
-	along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-*/
-
-
-
-
-#include "Timeval.h"
-#include <iostream>
-
-using namespace std;
-
-int main(int argc, char *argv[])
-{
-
-	Timeval then(10000);
-	cout << then.elapsed() << endl;
-
-	while (!then.passed()) {
-		cout << "now: " << Timeval() << " then: " << then << " remaining: " << then.remaining() << endl;
-		usleep(500000);
-	}
-	cout << "now: " << Timeval() << " then: " << then << " remaining: " << then.remaining() << endl;
-}

CommonLibs/Utils.cpp

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2018 sysmocom - s.f.m.c. GmbH
+ *
+ * SPDX-License-Identifier: LGPL-2.1+
+ *
+ * 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
+ */
+
+#include <vector>
+#include <string>
+#include <sstream>
+
+std::vector<std::string> comma_delimited_to_vector(const char* opt)
+{
+	std::string str = std::string(opt);
+	std::vector<std::string> result;
+	std::stringstream ss(str);
+
+	while( ss.good() )
+	{
+	    std::string substr;
+	    getline(ss, substr, ',');
+	    result.push_back(substr);
+	}
+	return result;
+}

CommonLibs/Utils.h

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2018 sysmocom - s.f.m.c. GmbH
+ *
+ * SPDX-License-Identifier: LGPL-2.1+
+ *
+ * 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
+ */
+
+#pragma once
+
+#include <vector>
+#include <string>
+
+std::vector<std::string> comma_delimited_to_vector(const char* opt);

CommonLibs/Vector.h

@@ -2,6 +2,8 @@
 /*
 * Copyright 2008 Free Software Foundation, Inc.
 *
+* SPDX-License-Identifier: AGPL-3.0+
+*
 * This software is distributed under the terms of the GNU Affero Public License.
 * See the COPYING file in the main directory for details.
 *
@@ -32,11 +34,14 @@
 #include <string.h>
 #include <iostream>
 #include <assert.h>
-// We cant use Logger.h in this file...
+#include <stdlib.h>
+
+// We can't use Logger.h in this file...
 extern int gVectorDebug;
 #define BVDEBUG(msg) if (gVectorDebug) {std::cout << msg;}
 
-
+typedef void (*vector_free_func)(void* wData);
+typedef void *(*vector_alloc_func)(size_t newSize);
 
 /**
 	A simplified Vector template with aliases.
@@ -60,6 +65,8 @@ template <class T> class Vector {
 	T* mData;		///< allocated data block, if any
 	T* mStart;		///< start of useful data
 	T* mEnd;		///< end of useful data + 1
+	vector_alloc_func mAllocFunc; ///< function used to alloc new mData during resize.
+	vector_free_func mFreeFunc; ///< function used to free mData.
 
 	public:
 
@@ -85,9 +92,19 @@ template <class T> class Vector {
 	/** Change the size of the Vector, discarding content. */
 	void resize(size_t newSize)
 	{
-		if (mData!=NULL) delete[] mData;
+		if (mData!=NULL) {
+			if (mFreeFunc)
+				mFreeFunc(mData);
+			else
+				delete[] mData;
+		}
 		if (newSize==0) mData=NULL;
-		else mData = new T[newSize];
+		else {
+			if (mAllocFunc)
+				mData = (T*) mAllocFunc(newSize);
+			else
+				mData = new T[newSize];
+		}
 		mStart = mData;
 		mEnd = mStart + newSize;
 	}
@@ -107,7 +124,7 @@ template <class T> class Vector {
 	void clone(const Vector<T>& other)
 	{
 		resize(other.size());
-		memcpy(mData,other.mStart,other.bytes());
+		other.copyTo(*this);
 	}
 
 
@@ -116,29 +133,31 @@ template <class T> class Vector {
 	//@{
 
 	/** Build an empty Vector of a given size. */
-	Vector(size_t wSize=0):mData(NULL) { resize(wSize); }
+	Vector(size_t wSize=0, vector_alloc_func wAllocFunc=NULL, vector_free_func wFreeFunc=NULL)
+		:mData(NULL), mAllocFunc(wAllocFunc), mFreeFunc(wFreeFunc)
+	{ resize(wSize); }
 
 	/** Build a Vector by moving another. */
 	Vector(Vector<T>&& other)
-		:mData(other.mData),mStart(other.mStart),mEnd(other.mEnd)
+		:mData(other.mData),mStart(other.mStart),mEnd(other.mEnd), mAllocFunc(other.mAllocFunc),  mFreeFunc(other.mFreeFunc)
 	{ other.mData=NULL; }
 
 	/** Build a Vector by copying another. */
-	Vector(const Vector<T>& other):mData(NULL) { clone(other); }
+	Vector(const Vector<T>& other):mData(NULL), mAllocFunc(other.mAllocFunc), mFreeFunc(other.mFreeFunc) { clone(other); }
 
 	/** Build a Vector with explicit values. */
-	Vector(T* wData, T* wStart, T* wEnd)
-		:mData(wData),mStart(wStart),mEnd(wEnd)
+	Vector(T* wData, T* wStart, T* wEnd, vector_alloc_func wAllocFunc=NULL, vector_free_func wFreeFunc=NULL)
+		:mData(wData),mStart(wStart),mEnd(wEnd), mAllocFunc(wAllocFunc), mFreeFunc(wFreeFunc)
 	{ }
 
 	/** Build a vector from an existing block, NOT to be deleted upon destruction. */
-	Vector(T* wStart, size_t span)
-		:mData(NULL),mStart(wStart),mEnd(wStart+span)
+	Vector(T* wStart, size_t span, vector_alloc_func wAllocFunc=NULL, vector_free_func wFreeFunc=NULL)
+		:mData(NULL),mStart(wStart),mEnd(wStart+span),mAllocFunc(wAllocFunc), mFreeFunc(wFreeFunc)
 	{ }
 
 	/** Build a Vector by concatenation. */
-	Vector(const Vector<T>& other1, const Vector<T>& other2)
-		:mData(NULL)
+	Vector(const Vector<T>& other1, const Vector<T>& other2, vector_alloc_func wAllocFunc=NULL, vector_free_func wFreeFunc=NULL)
+		:mData(NULL), mAllocFunc(wAllocFunc), mFreeFunc(wFreeFunc)
 	{
 		resize(other1.size()+other2.size());
 		memcpy(mStart, other1.mStart, other1.bytes());
@@ -162,6 +181,8 @@ template <class T> class Vector {
 		mData=other.mData;
 		mStart=other.mStart;
 		mEnd=other.mEnd;
+		mAllocFunc=other.mAllocFunc;
+		mFreeFunc=other.mFreeFunc;
 		other.mData=NULL;
 	}
 
@@ -204,10 +225,15 @@ template <class T> class Vector {
 	*/
 	void copyToSegment(Vector<T>& other, size_t start, size_t span) const
 	{
-		T* base = other.mStart + start;
-		assert(base+span<=other.mEnd);
+		unsigned int i;
+		T* dst = other.mStart + start;
+		T* src = mStart;
+		assert(dst+span<=other.mEnd);
 		assert(mStart+span<=mEnd);
-		memcpy(base,mStart,span*sizeof(T));
+		for (i = 0; i < span; i++, src++, dst++)
+			*dst = *src;
+		/*TODO if not non-trivially copiable type class, optimize:
+		memcpy(dst,mStart,span*sizeof(T)); */
 	}
 
 	/** Copy all of this Vector to a segment of another Vector. */
@@ -282,7 +308,7 @@ template <class T> class Vector {
 	T* end() { return mEnd; }
 	bool isOwner() { return !!mData; }	// Do we own any memory ourselves?
 	//@}
-	
+
 
 };
 

CommonLibs/config_defs.h

@@ -0,0 +1,20 @@
+#pragma once
+
+/*
+ * This file contains structures used by both VTY (C, dir CommonLibs) and
+ * osmo-trx (CXX, dir Transceiver52)
+ */
+
+enum FillerType {
+  FILLER_DUMMY,
+  FILLER_ZERO,
+  FILLER_NORM_RAND,
+  FILLER_EDGE_RAND,
+  FILLER_ACCESS_RAND,
+};
+
+enum ReferenceType {
+  REF_INTERNAL,
+  REF_EXTERNAL,
+  REF_GPS,
+};

CommonLibs/debug.c

@@ -0,0 +1,101 @@
+/*
+ * Copyright (C) 2018-2019 sysmocom - s.f.m.c. GmbH
+ * All Rights Reserved
+ *
+ * SPDX-License-Identifier: AGPL-3.0+
+ *
+ * Author: Pau Espin Pedrol <pespin@sysmocom.de>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * See the COPYING file in the main directory for details.
+ */
+
+#include "config.h"
+
+/* If HAVE_GETTID, then "_GNU_SOURCE" may need to be defined to use gettid() */
+#if HAVE_GETTID
+#define _GNU_SOURCE
+#endif
+
+#include <sys/types.h>
+#include <unistd.h>
+#include <sys/syscall.h>
+#include "config.h"
+
+#include <osmocom/core/logging.h>
+#include <osmocom/core/utils.h>
+#include "debug.h"
+
+/* default categories */
+static const struct log_info_cat default_categories[] = {
+	[DMAIN] = {
+		.name = "DMAIN",
+		.description = "Main generic category",
+		.color = NULL,
+		.enabled = 1, .loglevel = LOGL_NOTICE,
+	},
+	[DTRXCLK] = {
+			.name = "DTRXCLK",
+			.description = "TRX Master Clock",
+			.color = NULL,
+			.enabled = 1, .loglevel = LOGL_NOTICE,
+	},
+	[DTRXCTRL] = {
+			.name = "DTRXCTRL",
+			.description = "TRX CTRL interface",
+			.color = "\033[1;33m",
+			.enabled = 1, .loglevel = LOGL_NOTICE,
+	},
+	[DTRXDDL] = {
+			.name = "DTRXDDL",
+			.description = "TRX Data interface Downlink",
+			.color = NULL,
+			.enabled = 1, .loglevel = LOGL_NOTICE,
+	},
+	[DTRXDUL] = {
+			.name = "DTRXDUL",
+			.description = "TRX CTRL interface Uplink",
+			.color = NULL,
+			.enabled = 1, .loglevel = LOGL_NOTICE,
+	},
+	[DDEV] = {
+		.name = "DDEV",
+		.description = "Device/Driver specific code",
+		.color = NULL,
+		.enabled = 1, .loglevel = LOGL_INFO,
+	},
+	[DDEVDRV] = {
+		.name = "DDEVDRV",
+		.description = "Logging from external device driver library implementing lower level specifics",
+		.color = NULL,
+		.enabled = 1, .loglevel = LOGL_NOTICE,
+	},
+};
+
+const struct log_info log_info = {
+	.cat = default_categories,
+	.num_cat = ARRAY_SIZE(default_categories),
+};
+
+pid_t my_gettid(void)
+{
+#if HAVE_GETTID
+	return gettid();
+#elif defined(LINUX) && defined(__NR_gettid)
+	return (pid_t) syscall(__NR_gettid);
+#else
+	#pragma message ("use pid as tid")
+	return getpid();
+#endif
+}

CommonLibs/debug.h

@@ -0,0 +1,29 @@
+#pragma once
+
+#include <stdbool.h>
+#include <sys/types.h>
+
+#include <osmocom/core/logging.h>
+
+extern const struct log_info log_info;
+
+/* Debug Areas of the code */
+enum {
+	DMAIN,
+	DTRXCLK,
+	DTRXCTRL,
+	DTRXDDL,
+	DTRXDUL,
+	DDEV,
+	DDEVDRV,
+};
+
+pid_t my_gettid(void);
+
+#define CLOGC(category, level, fmt, args...) do { \
+	LOGP(category, level, "[tid=%ld] " fmt, (long int) my_gettid(), ##args);  \
+} while(0)
+
+#define CLOGCHAN(chan, category, level, fmt, args...) do { \
+	LOGP(category, level, "[tid=%ld][chan=%zu] " fmt, (long int) my_gettid(), chan, ##args);  \
+} while(0)

CommonLibs/osmo_signal.h

@@ -0,0 +1,57 @@
+/* Generic signalling/notification infrastructure */
+/* (C) 2018 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
+ *
+ * Author: Pau Espin Pedrol <pespin@sysmocom.de>
+ *
+ * All Rights Reserved
+ *
+ * SPDX-License-Identifier: AGPL-3.0+
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#pragma once
+
+#include <osmocom/core/signal.h>
+
+/* Signalling subsystems */
+enum signal_subsystems {
+	SS_MAIN,
+	SS_DEVICE,
+};
+
+/* SS_MAIN signals */
+enum SS_MAIN {
+	S_MAIN_STOP_REQUIRED, /* TRX fatal error, it should be stopped */
+};
+
+/* SS_DEVICE signals */
+enum SS_DEVICE {
+	/* Device internal counters changed. Counters are provided as cb data
+	   (struct device_counters). Must be sent with PTHREAD_CANCEL_DISABLE
+	   to avoid deadlocks in case osmo-trx process is asked to exit. */
+	S_DEVICE_COUNTER_CHANGE,
+};
+
+/* signal cb for signal <SS_DEVICE,S_DEVICE_COUNTER_CHANGE> */
+struct device_counters {
+	size_t chan;
+	unsigned int rx_overruns;
+	unsigned int tx_underruns;
+	unsigned int rx_dropped_events;
+	unsigned int rx_dropped_samples;
+	unsigned int tx_dropped_events;
+	unsigned int tx_dropped_samples;
+};

CommonLibs/sqlite3util.cpp

@@ -1,154 +0,0 @@
-/*
-* Copyright 2010 Kestrel Signal Processing, Inc.
-* All rights reserved.
-*/
-
-
-#include <sqlite3.h>
-#include "sqlite3util.h"
-
-#include <string.h>
-#include <unistd.h>
-#include <stdio.h>
-
-
-// Wrappers to sqlite operations.
-// These will eventually get moved to commonlibs.
-
-int sqlite3_prepare_statement(sqlite3* DB, sqlite3_stmt **stmt, const char* query)
-{
-        int src = SQLITE_BUSY;
-        while (src==SQLITE_BUSY) {
-                src = sqlite3_prepare_v2(DB,query,strlen(query),stmt,NULL);
-                if (src==SQLITE_BUSY) {
-                        usleep(100000);
-                }
-        }
-        if (src) {
-                fprintf(stderr,"sqlite3_prepare_v2 failed for \"%s\": %s\n",query,sqlite3_errmsg(DB));
-                sqlite3_finalize(*stmt);
-        }
-        return src;
-}
-
-int sqlite3_run_query(sqlite3* DB, sqlite3_stmt *stmt)
-{
-	int src = SQLITE_BUSY;
-	while (src==SQLITE_BUSY) {
-		src = sqlite3_step(stmt);
-		if (src==SQLITE_BUSY) {
-			usleep(100000);
-		}
-	}
-	if ((src!=SQLITE_DONE) && (src!=SQLITE_ROW)) {
-		fprintf(stderr,"sqlite3_run_query failed: %s: %s\n", sqlite3_sql(stmt), sqlite3_errmsg(DB));
-	}
-	return src;
-}
-
-
-bool sqlite3_exists(sqlite3* DB, const char *tableName,
-		const char* keyName, const char* keyData)
-{
-	size_t stringSize = 100 + strlen(tableName) + strlen(keyName) + strlen(keyData);
-	char query[stringSize];
-	sprintf(query,"SELECT * FROM %s WHERE %s == \"%s\"",tableName,keyName,keyData);
-	// Prepare the statement.
-	sqlite3_stmt *stmt;
-	if (sqlite3_prepare_statement(DB,&stmt,query)) return false;
-	// Read the result.
-	int src = sqlite3_run_query(DB,stmt);
-	sqlite3_finalize(stmt);
-	// Anything there?
-	return (src == SQLITE_ROW);
-}
-
-
-
-bool sqlite3_single_lookup(sqlite3* DB, const char *tableName,
-		const char* keyName, const char* keyData,
-		const char* valueName, unsigned &valueData)
-{
-	size_t stringSize = 100 + strlen(valueName) + strlen(tableName) + strlen(keyName) + strlen(keyData);
-	char query[stringSize];
-	sprintf(query,"SELECT %s FROM %s WHERE %s == \"%s\"",valueName,tableName,keyName,keyData);
-	// Prepare the statement.
-	sqlite3_stmt *stmt;
-	if (sqlite3_prepare_statement(DB,&stmt,query)) return false;
-	// Read the result.
-	int src = sqlite3_run_query(DB,stmt);
-	bool retVal = false;
-	if (src == SQLITE_ROW) {
-		valueData = (unsigned)sqlite3_column_int64(stmt,0);
-		retVal = true;
-	}
-	sqlite3_finalize(stmt);
-	return retVal;
-}
-
-
-// This function returns an allocated string that must be free'd by the caller.
-bool sqlite3_single_lookup(sqlite3* DB, const char* tableName,
-		const char* keyName, const char* keyData,
-		const char* valueName, char* &valueData)
-{
-	valueData=NULL;
-	size_t stringSize = 100 + strlen(valueName) + strlen(tableName) + strlen(keyName) + strlen(keyData);
-	char query[stringSize];
-	sprintf(query,"SELECT %s FROM %s WHERE %s == \"%s\"",valueName,tableName,keyName,keyData);
-	// Prepare the statement.
-	sqlite3_stmt *stmt;
-	if (sqlite3_prepare_statement(DB,&stmt,query)) return false;
-	// Read the result.
-	int src = sqlite3_run_query(DB,stmt);
-	bool retVal = false;
-	if (src == SQLITE_ROW) {
-		const char* ptr = (const char*)sqlite3_column_text(stmt,0);
-		if (ptr) valueData = strdup(ptr);
-		retVal = true;
-	}
-	sqlite3_finalize(stmt);
-	return retVal;
-}
-
-
-// This function returns an allocated string that must be free'd by tha caller.
-bool sqlite3_single_lookup(sqlite3* DB, const char* tableName,
-		const char* keyName, unsigned keyData,
-		const char* valueName, char* &valueData)
-{
-	valueData=NULL;
-	size_t stringSize = 100 + strlen(valueName) + strlen(tableName) + strlen(keyName) + 20;
-	char query[stringSize];
-	sprintf(query,"SELECT %s FROM %s WHERE %s == %u",valueName,tableName,keyName,keyData);
-	// Prepare the statement.
-	sqlite3_stmt *stmt;
-	if (sqlite3_prepare_statement(DB,&stmt,query)) return false;
-	// Read the result.
-	int src = sqlite3_run_query(DB,stmt);
-	bool retVal = false;
-	if (src == SQLITE_ROW) {
-		const char* ptr = (const char*)sqlite3_column_text(stmt,0);
-		if (ptr) valueData = strdup(ptr);
-		retVal = true;
-	}
-	sqlite3_finalize(stmt);
-	return retVal;
-}
-
-
-
-
-bool sqlite3_command(sqlite3* DB, const char* query)
-{
-	// Prepare the statement.
-	sqlite3_stmt *stmt;
-	if (sqlite3_prepare_statement(DB,&stmt,query)) return false;
-	// Run the query.
-	int src = sqlite3_run_query(DB,stmt);
-	sqlite3_finalize(stmt);
-	return src==SQLITE_DONE;
-}
-
-
-

CommonLibs/sqlite3util.h

@@ -1,29 +0,0 @@
-#ifndef SQLITE3UTIL_H
-#define SQLITE3UTIL_H
-
-#include <sqlite3.h>
-
-int sqlite3_prepare_statement(sqlite3* DB, sqlite3_stmt **stmt, const char* query);
-
-int sqlite3_run_query(sqlite3* DB, sqlite3_stmt *stmt);
-
-bool sqlite3_single_lookup(sqlite3* DB, const char *tableName,
-		const char* keyName, const char* keyData,
-		const char* valueName, unsigned &valueData);
-
-bool sqlite3_single_lookup(sqlite3* DB, const char* tableName,
-		const char* keyName, const char* keyData,
-		const char* valueName, char* &valueData);
-
-// This function returns an allocated string that must be free'd by the caller.
-bool sqlite3_single_lookup(sqlite3* DB, const char* tableName,
-		const char* keyName, unsigned keyData,
-		const char* valueName, char* &valueData);
-
-bool sqlite3_exists(sqlite3* DB, const char* tableName,
-		const char* keyName, const char* keyData);
-
-/** Run a query, ignoring the result; return true on success. */
-bool sqlite3_command(sqlite3* DB, const char* query);
-
-#endif

CommonLibs/trx_rate_ctr.cpp

@@ -0,0 +1,336 @@
+/*
+ * Copyright (C) 2019 sysmocom - s.f.m.c. GmbH
+ * All Rights Reserved
+ *
+ * SPDX-License-Identifier: AGPL-3.0+
+ *
+ * Author: Pau Espin Pedrol <pespin@sysmocom.de>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * See the COPYING file in the main directory for details.
+ */
+
+/*
+ * rate_ctr API uses several osmocom select loop features, and as a result,
+ * calls to it must be done through the main thread (the one running the osmocom
+ * loop in osmo-trx).
+ * Since read/write from/to SDR is done in separate threads (even read and write
+ * each use a different thread), we must use some sort of message passing system
+ * between main thread feeding rate_ctr structures and the Rx/Tx threads
+ * generating the events.
+ * The idea is that upon read/write issues, lower layers (SDR APIs) provide us with
+ * underrun/overrun/droppedPackets information, and in that case we pass that up
+ * the stack through signal <SS_DEVICE,S_DEVICE_COUNTER_CHANGE> with signal_cb
+ * being a pointer to a "struct device_counters" structure, which contains
+ * device (implementation agnostic) statful counters for different kind of
+ * statistics.
+ * That signal is processed here in device_sig_cb, where a copy of the "struct
+ * device_counters" structure is held and the main thread is instructed through
+ * a timerfd to update rate_ctr APIs against this copy. All this is done inside
+ * a mutex to avoid different race conditions (between Rx andTx threads, and
+ * between Rx/Tx and main thread). For the same reason, callers of signal
+ * <SS_DEVICE,S_DEVICE_COUNTER_CHANGE> (device_sig_cb), that is Rx/Tx threads,
+ * must do so with PTHREAD_CANCEL_DISABLE, in order to avoid possible deadlocks
+ * in case the main thread decides to cancel other threads due to a shutdown
+ * operation (fi SIGKILL received)
+ */
+
+#include <string.h>
+#include <stdint.h>
+#include <inttypes.h>
+#include <netinet/in.h>
+#include <arpa/inet.h>
+
+extern "C" {
+#include <osmocom/core/talloc.h>
+#include <osmocom/core/utils.h>
+#include <osmocom/core/rate_ctr.h>
+#include <osmocom/core/select.h>
+#include <osmocom/core/stats.h>
+#include <osmocom/core/timer.h>
+
+#include "osmo_signal.h"
+#include "trx_vty.h"
+#include "trx_rate_ctr.h"
+}
+#include "Threads.h"
+#include "Logger.h"
+
+/* Used in ctrs_pending, when set it means that channel slot contains unused
+   (non-pending) counter data */
+#define PENDING_CHAN_NONE SIZE_MAX
+
+static void *trx_rate_ctr_ctx;
+
+static struct rate_ctr_group** rate_ctrs;
+static struct device_counters* ctrs_pending;
+static size_t chan_len;
+static struct osmo_fd rate_ctr_timerfd;
+static Mutex rate_ctr_mutex;
+
+struct osmo_timer_list threshold_timer;
+static LLIST_HEAD(threshold_list);
+static int threshold_timer_sched_secs;
+static bool threshold_initied;
+
+const struct value_string rate_ctr_intv[] = {
+	{ RATE_CTR_INTV_SEC,	"per-second" },
+	{ RATE_CTR_INTV_MIN,	"per-minute" },
+	{ RATE_CTR_INTV_HOUR,	"per-hour" },
+	{ RATE_CTR_INTV_DAY, 	"per-day" },
+	{ 0, NULL }
+};
+
+const struct value_string trx_chan_ctr_names[] = {
+	{ TRX_CTR_RX_OVERRUNS,	"rx_overruns" },
+	{ TRX_CTR_TX_UNDERRUNS,	"tx_underruns" },
+	{ TRX_CTR_RX_DROP_EV,	"rx_drop_events" },
+	{ TRX_CTR_RX_DROP_SMPL,	"rx_drop_samples" },
+	{ TRX_CTR_TX_DROP_EV,	"tx_drop_events" },
+	{ TRX_CTR_TX_DROP_SMPL,	"tx_drop_samples" },
+	{ 0, NULL }
+};
+
+static const struct rate_ctr_desc trx_chan_ctr_desc[] = {
+	[TRX_CTR_RX_OVERRUNS]		= { "device:rx_overruns",	"Number of Rx overruns in FIFO queue" },
+	[TRX_CTR_TX_UNDERRUNS]		= { "device:tx_underruns",	"Number of Tx underruns in FIFO queue" },
+	[TRX_CTR_RX_DROP_EV]		= { "device:rx_drop_events",	"Number of times Rx samples were dropped by HW" },
+	[TRX_CTR_RX_DROP_SMPL]		= { "device:rx_drop_samples",	"Number of Rx samples dropped by HW" },
+	[TRX_CTR_TX_DROP_EV]		= { "device:tx_drop_events",	"Number of times Tx samples were dropped by HW" },
+	[TRX_CTR_TX_DROP_SMPL]		= { "device:tx_drop_samples",	"Number of Tx samples dropped by HW" }
+};
+
+static const struct rate_ctr_group_desc trx_chan_ctr_group_desc = {
+	.group_name_prefix		= "trx:chan",
+	.group_description		= "osmo-trx statistics",
+	.class_id			= OSMO_STATS_CLASS_GLOBAL,
+	.num_ctr			= ARRAY_SIZE(trx_chan_ctr_desc),
+	.ctr_desc			= trx_chan_ctr_desc,
+};
+
+static int rate_ctr_timerfd_cb(struct osmo_fd *ofd, unsigned int what) {
+	size_t chan;
+	struct rate_ctr *ctr;
+	LOGC(DMAIN, NOTICE) << "Main thread is updating counters";
+	rate_ctr_mutex.lock();
+	for (chan = 0; chan < chan_len; chan++) {
+		if (ctrs_pending[chan].chan == PENDING_CHAN_NONE)
+			continue;
+		LOGCHAN(chan, DMAIN, INFO) << "rate_ctr update";
+		ctr = &rate_ctrs[chan]->ctr[TRX_CTR_RX_OVERRUNS];
+		rate_ctr_add(ctr, ctrs_pending[chan].rx_overruns - ctr->current);
+		ctr = &rate_ctrs[chan]->ctr[TRX_CTR_TX_UNDERRUNS];
+		rate_ctr_add(ctr, ctrs_pending[chan].tx_underruns - ctr->current);
+		ctr = &rate_ctrs[chan]->ctr[TRX_CTR_RX_DROP_EV];
+		rate_ctr_add(ctr, ctrs_pending[chan].rx_dropped_events - ctr->current);
+		ctr = &rate_ctrs[chan]->ctr[TRX_CTR_RX_DROP_SMPL];
+		rate_ctr_add(ctr, ctrs_pending[chan].rx_dropped_samples - ctr->current);
+		ctr = &rate_ctrs[chan]->ctr[TRX_CTR_TX_DROP_EV];
+		rate_ctr_add(ctr, ctrs_pending[chan].tx_dropped_events - ctr->current);
+		ctr = &rate_ctrs[chan]->ctr[TRX_CTR_TX_DROP_SMPL];
+		rate_ctr_add(ctr, ctrs_pending[chan].tx_dropped_samples - ctr->current);
+
+		/* Mark as done */
+		ctrs_pending[chan].chan = PENDING_CHAN_NONE;
+	}
+	if (osmo_timerfd_disable(&rate_ctr_timerfd) < 0)
+		LOGC(DMAIN, ERROR) << "Failed to disable timerfd";
+	rate_ctr_mutex.unlock();
+	return 0;
+}
+
+/* Callback function to be called every time we receive a signal from DEVICE */
+static int device_sig_cb(unsigned int subsys, unsigned int signal,
+			 void *handler_data, void *signal_data)
+{
+	struct device_counters *ctr;
+	/* Delay sched around 20 ms, in case we receive several calls from several
+	 * channels batched */
+	struct timespec next_sched = {.tv_sec = 0, .tv_nsec = 20*1000*1000};
+	/* no automatic re-trigger */
+	struct timespec intv_sched = {.tv_sec = 0, .tv_nsec = 0};
+
+	switch (signal) {
+	case S_DEVICE_COUNTER_CHANGE:
+		ctr = (struct device_counters *)signal_data;
+		LOGCHAN(ctr->chan, DMAIN, NOTICE) << "Received counter change from radioDevice";
+		rate_ctr_mutex.lock();
+		ctrs_pending[ctr->chan] = *ctr;
+		if (osmo_timerfd_schedule(&rate_ctr_timerfd, &next_sched, &intv_sched) < 0) {
+			LOGC(DMAIN, ERROR) << "Failed to schedule timerfd: " << errno << " = "<< strerror(errno);
+		}
+		rate_ctr_mutex.unlock();
+		break;
+	default:
+		break;
+	}
+	return 0;
+}
+
+/************************************
+ * ctr_threshold  APIs
+ ************************************/
+static const char* ctr_threshold_2_vty_str(struct ctr_threshold *ctr)
+{
+	static char buf[256];
+	int rc = 0;
+	rc += snprintf(buf, sizeof(buf), "ctr-error-threshold %s", get_value_string(trx_chan_ctr_names, ctr->ctr_id));
+	rc += snprintf(buf + rc, sizeof(buf) - rc, " %d %s", ctr->val, get_value_string(rate_ctr_intv, ctr->intv));
+	return buf;
+}
+
+static void threshold_timer_cb(void *data)
+{
+	struct ctr_threshold *ctr_thr;
+	struct rate_ctr *rate_ctr;
+	size_t chan;
+	LOGC(DMAIN, DEBUG) << "threshold_timer_cb fired!";
+
+	llist_for_each_entry(ctr_thr, &threshold_list, list) {
+		for (chan = 0; chan < chan_len; chan++) {
+			rate_ctr = &rate_ctrs[chan]->ctr[ctr_thr->ctr_id];
+			LOGCHAN(chan, DMAIN, INFO) << "checking threshold: " << ctr_threshold_2_vty_str(ctr_thr)
+						   << " ("<< rate_ctr->intv[ctr_thr->intv].rate << " vs " << ctr_thr->val << ")";
+			if (rate_ctr->intv[ctr_thr->intv].rate >= ctr_thr->val) {
+				LOGCHAN(chan, DMAIN, FATAL) << "threshold reached, stopping! " << ctr_threshold_2_vty_str(ctr_thr)
+							   << " ("<< rate_ctr->intv[ctr_thr->intv].rate << " vs " << ctr_thr->val << ")";
+				osmo_signal_dispatch(SS_MAIN, S_MAIN_STOP_REQUIRED, NULL);
+				return;
+			}
+		}
+	}
+	osmo_timer_schedule(&threshold_timer, threshold_timer_sched_secs, 0);
+}
+
+static size_t ctr_threshold_2_seconds(struct ctr_threshold *ctr)
+{
+	size_t mult = 0;
+	switch (ctr->intv) {
+	case RATE_CTR_INTV_SEC:
+		mult = 1;
+		break;
+	case RATE_CTR_INTV_MIN:
+		mult = 60;
+		break;
+	case RATE_CTR_INTV_HOUR:
+		mult = 60*60;
+		break;
+	case RATE_CTR_INTV_DAY:
+		mult = 60*60*24;
+		break;
+	default:
+		OSMO_ASSERT(false);
+	}
+	return mult;
+}
+
+static void threshold_timer_update_intv() {
+	struct ctr_threshold *ctr, *min_ctr;
+	size_t secs, min_secs;
+
+	/* Avoid scheduling timer until itself and other structures are prepared
+	   by trx_rate_ctr_init */
+	if (!threshold_initied)
+		return;
+
+	if (llist_empty(&threshold_list)) {
+		if (osmo_timer_pending(&threshold_timer))
+			osmo_timer_del(&threshold_timer);
+		return;
+	}
+
+	min_ctr = llist_first_entry(&threshold_list, struct ctr_threshold, list);
+	min_secs = ctr_threshold_2_seconds(min_ctr);
+
+	llist_for_each_entry(ctr, &threshold_list, list) {
+		secs = ctr_threshold_2_seconds(ctr);
+		if( min_secs > secs)
+			min_secs = secs;
+	}
+
+
+	threshold_timer_sched_secs = OSMO_MAX(min_secs / 2 - 1, 1);
+	LOGC(DMAIN, INFO) << "New ctr-error-threshold check interval: "
+			  << threshold_timer_sched_secs << " seconds";
+	osmo_timer_schedule(&threshold_timer, threshold_timer_sched_secs, 0);
+}
+
+/* Init rate_ctr subsystem. Expected to be called during process start by main thread before VTY is ready */
+void trx_rate_ctr_init(void *ctx, struct trx_ctx* trx_ctx)
+{
+	size_t  i;
+	trx_rate_ctr_ctx = ctx;
+	chan_len = trx_ctx->cfg.num_chans;
+	ctrs_pending = (struct device_counters*) talloc_zero_size(ctx, chan_len * sizeof(struct device_counters));
+	rate_ctrs = (struct rate_ctr_group**) talloc_zero_size(ctx, chan_len * sizeof(struct rate_ctr_group*));
+
+	for (i = 0; i < chan_len; i++) {
+		ctrs_pending[i].chan = PENDING_CHAN_NONE;
+		rate_ctrs[i] = rate_ctr_group_alloc(ctx, &trx_chan_ctr_group_desc, i);
+		if (!rate_ctrs[i]) {
+			LOGCHAN(i, DMAIN, ERROR) << "Failed to allocate rate ctr";
+			exit(1);
+		}
+	}
+	rate_ctr_timerfd.fd = -1;
+	if (osmo_timerfd_setup(&rate_ctr_timerfd, rate_ctr_timerfd_cb, NULL) < 0) {
+		LOGC(DMAIN, ERROR) << "Failed to setup timerfd";
+		exit(1);
+	}
+	osmo_signal_register_handler(SS_DEVICE, device_sig_cb, NULL);
+
+	/* Now set up threshold checks */
+	threshold_initied = true;
+	osmo_timer_setup(&threshold_timer, threshold_timer_cb, NULL);
+	threshold_timer_update_intv();
+}
+
+void trx_rate_ctr_threshold_add(struct ctr_threshold *ctr)
+{
+	struct ctr_threshold *new_ctr;
+
+	new_ctr = talloc_zero(trx_rate_ctr_ctx, struct ctr_threshold);
+	*new_ctr = *ctr;
+	LOGC(DMAIN, NOTICE) << "Adding new threshold check: " << ctr_threshold_2_vty_str(new_ctr);
+	llist_add(&new_ctr->list, &threshold_list);
+	threshold_timer_update_intv();
+}
+
+int trx_rate_ctr_threshold_del(struct ctr_threshold *del_ctr)
+{
+	struct ctr_threshold *ctr;
+
+	llist_for_each_entry(ctr, &threshold_list, list) {
+		if (ctr->intv != del_ctr->intv ||
+		    ctr->ctr_id != del_ctr->ctr_id ||
+		    ctr->val != del_ctr->val)
+			continue;
+
+		LOGC(DMAIN, NOTICE) << "Deleting threshold check: " << ctr_threshold_2_vty_str(del_ctr);
+		llist_del(&ctr->list);
+		talloc_free(ctr);
+		threshold_timer_update_intv();
+		return 0;
+	}
+	return -1;
+}
+
+void trx_rate_ctr_threshold_write_config(struct vty *vty, char *indent_prefix)
+{
+	struct ctr_threshold *ctr;
+
+	llist_for_each_entry(ctr, &threshold_list, list) {
+		vty_out(vty, "%s%s%s", indent_prefix, ctr_threshold_2_vty_str(ctr), VTY_NEWLINE);
+	}
+}

CommonLibs/trx_rate_ctr.h

@@ -0,0 +1,30 @@
+#pragma once
+
+#include <osmocom/core/rate_ctr.h>
+#include <osmocom/vty/command.h>
+
+enum TrxCtr {
+	TRX_CTR_RX_OVERRUNS,
+	TRX_CTR_TX_UNDERRUNS,
+	TRX_CTR_RX_DROP_EV,
+	TRX_CTR_RX_DROP_SMPL,
+	TRX_CTR_TX_DROP_EV,
+	TRX_CTR_TX_DROP_SMPL,
+};
+
+struct ctr_threshold {
+	/*! Linked list of all counter groups in the system */
+	struct llist_head list;
+	enum rate_ctr_intv intv;
+	enum TrxCtr ctr_id;
+	uint32_t val;
+};
+
+extern const struct value_string rate_ctr_intv[];
+extern const struct value_string trx_chan_ctr_names[];
+
+struct trx_ctx;
+void trx_rate_ctr_init(void *ctx, struct trx_ctx* trx_ctx);
+void trx_rate_ctr_threshold_add(struct ctr_threshold *ctr);
+int trx_rate_ctr_threshold_del(struct ctr_threshold *del_ctr);
+void trx_rate_ctr_threshold_write_config(struct vty *vty, char *indent_prefix);

CommonLibs/trx_vty.c

@@ -0,0 +1,738 @@
+/*
+ * Copyright (C) 2018-2019 sysmocom - s.f.m.c. GmbH
+ * All Rights Reserved
+ *
+ * SPDX-License-Identifier: AGPL-3.0+
+ *
+ * Author: Pau Espin Pedrol <pespin@sysmocom.de>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * See the COPYING file in the main directory for details.
+ */
+
+#include <string.h>
+#include <stdint.h>
+#include <inttypes.h>
+#include <netinet/in.h>
+#include <arpa/inet.h>
+
+#include <osmocom/core/talloc.h>
+#include <osmocom/core/utils.h>
+#include <osmocom/core/rate_ctr.h>
+
+#include <osmocom/vty/command.h>
+#include <osmocom/vty/logging.h>
+#include <osmocom/vty/vty.h>
+#include <osmocom/vty/misc.h>
+
+#include "trx_rate_ctr.h"
+#include "trx_vty.h"
+#include "../config.h"
+
+static struct trx_ctx* g_trx_ctx;
+
+const struct value_string clock_ref_names[] = {
+	{ REF_INTERNAL,	"internal" },
+	{ REF_EXTERNAL,	"external" },
+	{ REF_GPS,	"gpsdo" },
+	{ 0,		NULL }
+};
+
+const struct value_string filler_names[] = {
+	{ FILLER_DUMMY,		"Dummy bursts (C0 only)" },
+	{ FILLER_ZERO,		"Empty bursts" },
+	{ FILLER_NORM_RAND,	"GMSK Normal Bursts with random payload" },
+	{ FILLER_EDGE_RAND,	"8-PSK Normal Bursts with random payload" },
+	{ FILLER_ACCESS_RAND,	"Access Bursts with random payload" },
+	{ 0,			NULL }
+};
+
+static const struct value_string filler_types[] = {
+	{ FILLER_DUMMY,		"dummy" },
+	{ FILLER_ZERO,		"zero" },
+	{ FILLER_NORM_RAND,	"random-nb-gmsk" },
+	{ FILLER_EDGE_RAND,	"random-nb-8psk" },
+	{ FILLER_ACCESS_RAND,	"random-ab" },
+	{ 0,			NULL }
+};
+
+
+struct trx_ctx *trx_from_vty(struct vty *v)
+{
+        /* It can't hurt to force callers to continue to pass the vty instance
+         * to this function, in case we'd like to retrieve the global
+         * trx instance from the vty at some point in the future. But
+         * until then, just return the global pointer, which should have been
+         * initialized by trx_vty_init().
+         */
+        OSMO_ASSERT(g_trx_ctx);
+        return g_trx_ctx;
+}
+
+enum trx_vty_node {
+	TRX_NODE = _LAST_OSMOVTY_NODE + 1,
+	CHAN_NODE,
+};
+
+static struct cmd_node trx_node = {
+	TRX_NODE,
+	"%s(config-trx)# ",
+	1,
+};
+
+static struct cmd_node chan_node = {
+	CHAN_NODE,
+	"%s(config-trx-chan)# ",
+	1,
+};
+
+DEFUN(cfg_trx, cfg_trx_cmd,
+	"trx",
+	"Configure the TRX\n")
+{
+	struct trx_ctx *trx = trx_from_vty(vty);
+
+	if (!trx)
+		return CMD_WARNING;
+
+	vty->node = TRX_NODE;
+
+	return CMD_SUCCESS;
+}
+
+DEFUN(cfg_bind_ip, cfg_bind_ip_cmd,
+	"bind-ip A.B.C.D",
+	"Set the IP address for the local bind\n"
+	"IPv4 Address\n")
+{
+	struct trx_ctx *trx = trx_from_vty(vty);
+
+	osmo_talloc_replace_string(trx, &trx->cfg.bind_addr, argv[0]);
+
+	return CMD_SUCCESS;
+}
+
+DEFUN(cfg_remote_ip, cfg_remote_ip_cmd,
+	"remote-ip A.B.C.D",
+	"Set the IP address for the remote BTS\n"
+	"IPv4 Address\n")
+{
+	struct trx_ctx *trx = trx_from_vty(vty);
+
+	osmo_talloc_replace_string(trx, &trx->cfg.remote_addr, argv[0]);
+
+	return CMD_SUCCESS;
+}
+
+DEFUN(cfg_base_port, cfg_base_port_cmd,
+	"base-port <1-65535>",
+	"Set the TRX Base Port\n"
+	"TRX Base Port\n")
+{
+	struct trx_ctx *trx = trx_from_vty(vty);
+
+	trx->cfg.base_port = atoi(argv[0]);
+
+	return CMD_SUCCESS;
+}
+
+DEFUN(cfg_dev_args, cfg_dev_args_cmd,
+	"dev-args DESC",
+	"Set the device-specific arguments to pass to the device\n"
+	"Device-specific arguments\n")
+{
+	struct trx_ctx *trx = trx_from_vty(vty);
+
+	osmo_talloc_replace_string(trx, &trx->cfg.dev_args, argv[0]);
+
+	return CMD_SUCCESS;
+}
+
+DEFUN(cfg_tx_sps, cfg_tx_sps_cmd,
+	"tx-sps (1|4)",
+	"Set the Tx Samples-per-Symbol\n"
+	"Tx Samples-per-Symbol\n")
+{
+	struct trx_ctx *trx = trx_from_vty(vty);
+
+	trx->cfg.tx_sps = atoi(argv[0]);
+
+	return CMD_SUCCESS;
+}
+
+DEFUN(cfg_rx_sps, cfg_rx_sps_cmd,
+	"rx-sps (1|4)",
+	"Set the Rx Samples-per-Symbol\n"
+	"Rx Samples-per-Symbol\n")
+{
+	struct trx_ctx *trx = trx_from_vty(vty);
+
+	trx->cfg.rx_sps = atoi(argv[0]);
+
+	return CMD_SUCCESS;
+}
+
+DEFUN(cfg_clock_ref, cfg_clock_ref_cmd,
+	"clock-ref (internal|external|gpsdo)",
+	"Set the Reference Clock\n"
+	"Enable internal reference (default)\n"
+	"Enable external 10 MHz reference\n"
+	"Enable GPSDO reference\n")
+{
+	struct trx_ctx *trx = trx_from_vty(vty);
+
+	trx->cfg.clock_ref = get_string_value(clock_ref_names, argv[0]);
+
+	return CMD_SUCCESS;
+}
+
+DEFUN(cfg_multi_arfcn, cfg_multi_arfcn_cmd,
+	"multi-arfcn (disable|enable)",
+	"Enable multi-ARFCN transceiver (default=disable)\n")
+{
+	struct trx_ctx *trx = trx_from_vty(vty);
+
+	if (strcmp("disable", argv[0]) == 0) {
+		trx->cfg.multi_arfcn = false;
+		return CMD_SUCCESS;
+	}
+
+	if (trx->cfg.num_chans > TRX_MCHAN_MAX) {
+		vty_out(vty, "Up to %i channels are supported for multi-TRX mode%s",
+			TRX_MCHAN_MAX, VTY_NEWLINE);
+		return CMD_WARNING;
+	}
+
+	trx->cfg.multi_arfcn = true;
+	return CMD_SUCCESS;
+}
+
+DEFUN(cfg_offset, cfg_offset_cmd,
+	"offset FLOAT",
+	"Set the baseband frequency offset (default=0, auto)\n"
+	"Baseband Frequency Offset\n")
+{
+	struct trx_ctx *trx = trx_from_vty(vty);
+
+	trx->cfg.offset = atof(argv[0]);
+
+	return CMD_SUCCESS;
+}
+
+DEFUN(cfg_rssi_offset, cfg_rssi_offset_cmd,
+	"rssi-offset FLOAT",
+	"Set the RSSI to dBm offset in dB (default=0)\n"
+	"RSSI to dBm offset in dB\n")
+{
+	struct trx_ctx *trx = trx_from_vty(vty);
+
+	trx->cfg.rssi_offset = atof(argv[0]);
+
+	return CMD_SUCCESS;
+}
+
+DEFUN(cfg_swap_channels, cfg_swap_channels_cmd,
+	"swap-channels (disable|enable)",
+	"Swap channels (default=disable)\n")
+{
+	struct trx_ctx *trx = trx_from_vty(vty);
+
+	if (strcmp("disable", argv[0]) == 0) {
+		trx->cfg.swap_channels = false;
+	} else if (strcmp("enable", argv[0]) == 0) {
+		trx->cfg.swap_channels = true;
+	} else {
+		return CMD_WARNING;
+	}
+
+	return CMD_SUCCESS;
+}
+
+DEFUN(cfg_egprs, cfg_egprs_cmd,
+	"egprs (disable|enable)",
+	"Enable EDGE receiver (default=disable)\n")
+{
+	struct trx_ctx *trx = trx_from_vty(vty);
+
+	if (strcmp("disable", argv[0]) == 0) {
+		trx->cfg.egprs = false;
+	} else if (strcmp("enable", argv[0]) == 0) {
+		trx->cfg.egprs = true;
+	} else {
+		return CMD_WARNING;
+	}
+
+	return CMD_SUCCESS;
+}
+
+DEFUN(cfg_ext_rach, cfg_ext_rach_cmd,
+	"ext-rach (disable|enable)",
+	"Enable extended (11-bit) RACH (default=disable)\n")
+{
+	struct trx_ctx *trx = trx_from_vty(vty);
+
+	if (strcmp("disable", argv[0]) == 0)
+		trx->cfg.ext_rach = false;
+
+	if (strcmp("enable", argv[0]) == 0)
+		trx->cfg.ext_rach = true;
+
+	return CMD_SUCCESS;
+}
+
+DEFUN(cfg_rt_prio, cfg_rt_prio_cmd,
+	"rt-prio <1-32>",
+	"Set the SCHED_RR real-time priority\n"
+	"Real time priority\n")
+{
+	struct trx_ctx *trx = trx_from_vty(vty);
+
+	trx->cfg.sched_rr = atoi(argv[0]);
+
+	return CMD_SUCCESS;
+}
+
+DEFUN(cfg_stack_size, cfg_stack_size_cmd,
+	"stack-size <0-2147483647>",
+	"Set the stack size per thread in BYTE, 0 = OS default\n"
+	"Stack size per thread in BYTE\n")
+{
+	struct trx_ctx *trx = trx_from_vty(vty);
+
+	trx->cfg.stack_size = atoi(argv[0]);
+
+	return CMD_SUCCESS;
+}
+
+DEFUN(cfg_filler, cfg_filler_type_cmd,
+	"filler type (zero|dummy|random-nb-gmsk|random-nb-8psk|random-ab)",
+	"Filler burst settings\n"
+	"Filler burst type (default=zero)\n"
+	"Send an empty burst when there is nothing to send (default)\n"
+	"Send a dummy burst when there is nothing to send on C0 (TRX0) and empty burst on other channels."
+	" Use for OpenBTS compatibility only, don't use with OsmoBTS as it breaks encryption.\n"
+	"Send a GMSK modulated Normal Burst with random bits when there is nothing to send."
+	" Use for spectrum mask testing. Configure 'filler tsc' to set training sequence.\n"
+	"Send an 8-PSK modulated Normal Burst with random bits when there is nothing to send."
+	" Use for spectrum mask testing. Configure 'filler tsc' to set training sequence.\n"
+	"Send an Access Burst with random bits when there is nothing to send. Use for Rx/Tx alignment."
+	" Configure 'filler access-burst-delay' to introduce artificial delay.\n"
+)
+{
+	struct trx_ctx *trx = trx_from_vty(vty);
+	// trx->cfg.filler is unsigned, so we need an interim int var to detect errors
+	int type = get_string_value(filler_types, argv[0]);
+
+	if (type < 0) {
+		trx->cfg.filler = FILLER_ZERO;
+		return CMD_WARNING;
+	}
+	trx->cfg.filler = type;
+
+	return CMD_SUCCESS;
+}
+
+DEFUN(cfg_test_rtsc, cfg_filler_tsc_cmd,
+	"filler tsc <0-7>",
+	"Filler burst settings\n"
+	"Set the TSC for GMSK/8-PSK Normal Burst random fillers. Used only with 'random-nb-gmsk' and"
+	" 'random-nb-8psk' filler types. (default=0)\n"
+	"TSC\n")
+{
+	struct trx_ctx *trx = trx_from_vty(vty);
+
+	trx->cfg.rtsc = atoi(argv[0]);
+
+	return CMD_SUCCESS;
+}
+
+DEFUN(cfg_test_rach_delay, cfg_filler_rach_delay_cmd,
+	"filler access-burst-delay <0-68>",
+	"Filler burst settings\n"
+	"Set the delay for Access Burst random fillers. Used only with 'random-ab' filler type. (default=0)\n"
+	"RACH delay in symbols\n")
+{
+	struct trx_ctx *trx = trx_from_vty(vty);
+
+	trx->cfg.rach_delay = atoi(argv[0]);
+
+	return CMD_SUCCESS;
+}
+
+static int vty_ctr_name_2_id(const char* str) {
+	size_t i;
+	for (i = 0; trx_chan_ctr_names[i].str; i++) {
+		if (strstr(trx_chan_ctr_names[i].str, str)) {
+			return i;
+		}
+	}
+	return -1;
+}
+
+static int vty_intv_name_2_id(const char* str) {
+	size_t i;
+	for (i = 0; rate_ctr_intv[i].str; i++) {
+		if (strcmp(rate_ctr_intv[i].str, str) == 0) {
+			return i;
+		}
+	}
+	return -1;
+}
+
+#define THRESHOLD_ARGS "(rx_overruns|tx_underruns|rx_drop_events|rx_drop_samples|tx_drop_events|tx_drop_samples)"
+#define THRESHOLD_STR_VAL(s) "Set threshold value for rate_ctr device:" OSMO_STRINGIFY_VAL(s) "\n"
+#define THRESHOLD_STRS \
+	THRESHOLD_STR_VAL(rx_overruns) \
+	THRESHOLD_STR_VAL(tx_underruns) \
+	THRESHOLD_STR_VAL(rx_drop_events) \
+	THRESHOLD_STR_VAL(rx_drop_samples) \
+	THRESHOLD_STR_VAL(tx_drop_events) \
+	THRESHOLD_STR_VAL(tx_drop_samples)
+#define INTV_ARGS "(per-second|per-minute|per-hour|per-day)"
+#define INTV_STR_VAL(s) "Threshold value sampled " OSMO_STRINGIFY_VAL(s) "\n"
+#define INTV_STRS \
+	INTV_STR_VAL(per-second) \
+	INTV_STR_VAL(per-minute) \
+	INTV_STR_VAL(per-hour) \
+	INTV_STR_VAL(per-day)
+
+DEFUN(cfg_ctr_error_threshold, cfg_ctr_error_threshold_cmd,
+	"ctr-error-threshold " THRESHOLD_ARGS " <0-65535> " INTV_ARGS,
+	"Threshold rate for error counter\n"
+	THRESHOLD_STRS
+	"Value to set for threshold\n"
+	INTV_STRS)
+{
+	int rc;
+	struct ctr_threshold ctr;
+
+	struct trx_ctx *trx = trx_from_vty(vty);
+	rc = vty_ctr_name_2_id(argv[0]);
+	if (rc < 0) {
+		vty_out(vty, "No valid ctr_name found for ctr-error-threshold %s%s",
+			argv[0], VTY_NEWLINE);
+		return CMD_WARNING;
+	}
+	ctr.ctr_id = (enum TrxCtr)rc;
+	ctr.val = atoi(argv[1]);
+	rc = vty_intv_name_2_id(argv[2]);
+	if (rc < 0) {
+		vty_out(vty, "No valid time frame found for ctr-error-threshold %s %d %s%s",
+			argv[0], ctr.val, argv[2], VTY_NEWLINE);
+		return CMD_WARNING;
+	}
+	ctr.intv = (enum rate_ctr_intv) rc;
+	trx_rate_ctr_threshold_add(&ctr);
+
+	return CMD_SUCCESS;
+}
+
+DEFUN(cfg_no_ctr_error_threshold, cfg_no_ctr_error_threshold_cmd,
+	"no ctr-error-threshold " THRESHOLD_ARGS " <0-65535> " INTV_ARGS,
+	NO_STR "Threshold rate for error counter\n"
+	THRESHOLD_STRS
+	"Value to set for threshold\n"
+	INTV_STRS)
+{
+	int rc;
+	struct ctr_threshold ctr;
+
+	struct trx_ctx *trx = trx_from_vty(vty);
+	rc = vty_ctr_name_2_id(argv[0]);
+	if (rc < 0) {
+		vty_out(vty, "No valid ctr_name found for ctr-error-threshold %s%s",
+			argv[0], VTY_NEWLINE);
+		return CMD_WARNING;
+	}
+	ctr.ctr_id = (enum TrxCtr)rc;
+	ctr.val = atoi(argv[1]);
+	rc = vty_intv_name_2_id(argv[2]);
+	if (rc < 0) {
+		vty_out(vty, "No valid time frame found for ctr-error-threshold %s %d %s%s",
+			argv[0], ctr.val, argv[2], VTY_NEWLINE);
+		return CMD_WARNING;
+	}
+	ctr.intv = (enum rate_ctr_intv) rc;
+	if (trx_rate_ctr_threshold_del(&ctr) < 0) {
+		vty_out(vty, "no ctr-error-threshold: Entry to delete not found%s", VTY_NEWLINE);
+		return CMD_WARNING;
+	}
+
+	return CMD_SUCCESS;
+}
+
+DEFUN(cfg_chan, cfg_chan_cmd,
+	"chan <0-100>",
+	"Select a channel to configure\n"
+	"Channel index\n")
+{
+	struct trx_ctx *trx = trx_from_vty(vty);
+	int idx = atoi(argv[0]);
+
+	if (idx >= TRX_CHAN_MAX) {
+		vty_out(vty, "Chan list full.%s", VTY_NEWLINE);
+		return CMD_WARNING;
+	} else if (trx->cfg.multi_arfcn && trx->cfg.num_chans >= TRX_MCHAN_MAX) {
+		vty_out(vty, "Up to %i channels are supported for multi-TRX mode%s",
+			TRX_MCHAN_MAX, VTY_NEWLINE);
+		return CMD_WARNING;
+	}
+
+	if (trx->cfg.num_chans < idx) { /* Unexisting or creating non-consecutive */
+		vty_out(vty, "Non-existent or non-consecutive chan %d.%s",
+				idx, VTY_NEWLINE);
+		return CMD_WARNING;
+	} else if (trx->cfg.num_chans == idx)  { /* creating it */
+		trx->cfg.num_chans++;
+		trx->cfg.chans[idx].trx = trx;
+		trx->cfg.chans[idx].idx = idx;
+	}
+
+	vty->node = CHAN_NODE;
+	vty->index = &trx->cfg.chans[idx];
+
+	return CMD_SUCCESS;
+}
+
+DEFUN(cfg_chan_rx_path, cfg_chan_rx_path_cmd,
+	"rx-path NAME",
+	"Set the Rx Path\n"
+	"Rx Path name\n")
+{
+	struct trx_chan *chan = vty->index;
+
+	osmo_talloc_replace_string(chan->trx, &chan->rx_path, argv[0]);
+
+	return CMD_SUCCESS;
+}
+
+DEFUN(cfg_chan_tx_path, cfg_chan_tx_path_cmd,
+	"tx-path NAME",
+	"Set the Tx Path\n"
+	"Tx Path name\n")
+{
+	struct trx_chan *chan = vty->index;
+
+	osmo_talloc_replace_string(chan->trx, &chan->tx_path, argv[0]);
+
+	return CMD_SUCCESS;
+}
+
+static int dummy_config_write(struct vty *v)
+{
+	return CMD_SUCCESS;
+}
+
+static int config_write_trx(struct vty *vty)
+{
+	struct trx_chan *chan;
+	int i;
+	struct trx_ctx *trx = trx_from_vty(vty);
+
+	vty_out(vty, "trx%s", VTY_NEWLINE);
+	if (trx->cfg.bind_addr)
+		vty_out(vty, " bind-ip %s%s", trx->cfg.bind_addr, VTY_NEWLINE);
+	if (trx->cfg.remote_addr)
+		vty_out(vty, " remote-ip %s%s", trx->cfg.remote_addr, VTY_NEWLINE);
+	if (trx->cfg.base_port != DEFAULT_TRX_PORT)
+		vty_out(vty, " base-port %u%s", trx->cfg.base_port, VTY_NEWLINE);
+	if (trx->cfg.dev_args)
+		vty_out(vty, " dev-args %s%s", trx->cfg.dev_args, VTY_NEWLINE);
+	if (trx->cfg.tx_sps != DEFAULT_TX_SPS)
+		vty_out(vty, " tx-sps %u%s", trx->cfg.tx_sps, VTY_NEWLINE);
+	if (trx->cfg.rx_sps != DEFAULT_RX_SPS)
+		vty_out(vty, " rx-sps %u%s", trx->cfg.rx_sps, VTY_NEWLINE);
+	if (trx->cfg.clock_ref != REF_INTERNAL)
+		vty_out(vty, " clock-ref %s%s", get_value_string(clock_ref_names, trx->cfg.clock_ref), VTY_NEWLINE);
+	vty_out(vty, " multi-arfcn %s%s", trx->cfg.multi_arfcn ? "enable" : "disable", VTY_NEWLINE);
+	if (trx->cfg.offset != 0)
+		vty_out(vty, " offset %f%s", trx->cfg.offset, VTY_NEWLINE);
+	if (trx->cfg.rssi_offset != 0)
+		vty_out(vty, " rssi-offset %f%s", trx->cfg.rssi_offset, VTY_NEWLINE);
+	vty_out(vty, " swap-channels %s%s", trx->cfg.swap_channels ? "enable" : "disable", VTY_NEWLINE);
+	vty_out(vty, " egprs %s%s", trx->cfg.egprs ? "enable" : "disable", VTY_NEWLINE);
+	vty_out(vty, " ext-rach %s%s", trx->cfg.ext_rach ? "enable" : "disable", VTY_NEWLINE);
+	if (trx->cfg.sched_rr != 0)
+		vty_out(vty, " rt-prio %u%s", trx->cfg.sched_rr, VTY_NEWLINE);
+	if (trx->cfg.filler != FILLER_ZERO)
+		vty_out(vty, " filler type %s%s", get_value_string(filler_types, trx->cfg.filler), VTY_NEWLINE);
+	if (trx->cfg.rtsc > 0)
+		vty_out(vty, " filler tsc %u%s", trx->cfg.rtsc, VTY_NEWLINE);
+	if (trx->cfg.rach_delay > 0)
+		vty_out(vty, " filler access-burst-delay %u%s", trx->cfg.rach_delay, VTY_NEWLINE);
+	if (trx->cfg.stack_size != 0)
+		vty_out(vty, " stack-size %u%s", trx->cfg.stack_size, VTY_NEWLINE);
+	trx_rate_ctr_threshold_write_config(vty, " ");
+
+	for (i = 0; i < trx->cfg.num_chans; i++) {
+		chan = &trx->cfg.chans[i];
+		vty_out(vty, " chan %u%s", chan->idx, VTY_NEWLINE);
+		if (chan->rx_path)
+			vty_out(vty, "  rx-path %s%s", chan->rx_path, VTY_NEWLINE);
+		if (chan->tx_path)
+			vty_out(vty, "  tx-path %s%s", chan->tx_path, VTY_NEWLINE);
+	}
+
+	return CMD_SUCCESS;
+}
+
+static void trx_dump_vty(struct vty *vty, struct trx_ctx *trx)
+{
+	struct trx_chan *chan;
+	int i;
+	vty_out(vty, "TRX Config:%s", VTY_NEWLINE);
+	vty_out(vty, " Local IP: %s%s", trx->cfg.bind_addr, VTY_NEWLINE);
+	vty_out(vty, " Remote IP: %s%s", trx->cfg.remote_addr, VTY_NEWLINE);
+	vty_out(vty, " TRX Base Port: %u%s", trx->cfg.base_port, VTY_NEWLINE);
+	vty_out(vty, " Device args: %s%s", trx->cfg.dev_args, VTY_NEWLINE);
+	vty_out(vty, " Tx Samples-per-Symbol: %u%s", trx->cfg.tx_sps, VTY_NEWLINE);
+	vty_out(vty, " Rx Samples-per-Symbol: %u%s", trx->cfg.rx_sps, VTY_NEWLINE);
+	vty_out(vty, " Filler Burst Type: %s%s", get_value_string(filler_names, trx->cfg.filler), VTY_NEWLINE);
+	vty_out(vty, " Filler Burst TSC: %u%s", trx->cfg.rtsc, VTY_NEWLINE);
+	vty_out(vty, " Filler Burst RACH Delay: %u%s", trx->cfg.rach_delay, VTY_NEWLINE);
+	vty_out(vty, " Clock Reference: %s%s", get_value_string(clock_ref_names, trx->cfg.clock_ref), VTY_NEWLINE);
+	vty_out(vty, " Multi-Carrier: %s%s", trx->cfg.multi_arfcn ? "Enabled" : "Disabled", VTY_NEWLINE);
+	vty_out(vty, " Tuning offset: %f%s", trx->cfg.offset, VTY_NEWLINE);
+	vty_out(vty, " RSSI to dBm offset: %f%s", trx->cfg.rssi_offset, VTY_NEWLINE);
+	vty_out(vty, " Swap channels: %s%s", trx->cfg.swap_channels ? "Enabled" : "Disabled", VTY_NEWLINE);
+	vty_out(vty, " EDGE support: %s%s", trx->cfg.egprs ? "Enabled" : "Disabled", VTY_NEWLINE);
+	vty_out(vty, " Extended RACH support: %s%s", trx->cfg.ext_rach ? "Enabled" : "Disabled", VTY_NEWLINE);
+	vty_out(vty, " Real Time Priority: %u (%s)%s", trx->cfg.sched_rr,
+		trx->cfg.sched_rr ? "Enabled" : "Disabled", VTY_NEWLINE);
+	vty_out(vty, " Stack size per Thread in BYTE (0 = OS default): %u%s", trx->cfg.stack_size, VTY_NEWLINE);
+	vty_out(vty, " Channels: %u%s", trx->cfg.num_chans, VTY_NEWLINE);
+	for (i = 0; i < trx->cfg.num_chans; i++) {
+		chan = &trx->cfg.chans[i];
+		vty_out(vty, "  Channel %u:%s", chan->idx, VTY_NEWLINE);
+		if (chan->rx_path)
+			vty_out(vty, "   Rx Path: %s%s", chan->rx_path, VTY_NEWLINE);
+		if (chan->tx_path)
+			vty_out(vty, "   Tx Path: %s%s", chan->tx_path, VTY_NEWLINE);
+	}
+}
+
+DEFUN(show_trx, show_trx_cmd,
+	"show trx",
+	SHOW_STR "Display information on the TRX\n")
+{
+	struct trx_ctx *trx = trx_from_vty(vty);
+
+	trx_dump_vty(vty, trx);
+
+	return CMD_SUCCESS;
+}
+
+static int trx_vty_is_config_node(struct vty *vty, int node)
+{
+	switch (node) {
+	case TRX_NODE:
+	case CHAN_NODE:
+		return 1;
+	default:
+		return 0;
+	}
+}
+
+static int trx_vty_go_parent(struct vty *vty)
+{
+	switch (vty->node) {
+	case TRX_NODE:
+		vty->node = CONFIG_NODE;
+		vty->index = NULL;
+		vty->index_sub = NULL;
+		break;
+	case CHAN_NODE:
+		vty->node = TRX_NODE;
+		vty->index = NULL;
+		vty->index_sub = NULL;
+		break;
+	default:
+		vty->node = CONFIG_NODE;
+		vty->index = NULL;
+		vty->index_sub = NULL;
+	}
+
+	return vty->node;
+}
+
+static const char trx_copyright[] =
+	"Copyright (C) 2007-2014 Free Software Foundation, Inc.\r\n"
+	"Copyright (C) 2013 Thomas Tsou <tom@tsou.cc>\r\n"
+	"Copyright (C) 2013-2019 Fairwaves, Inc.\r\n"
+	"Copyright (C) 2015 Ettus Research LLC\r\n"
+	"Copyright (C) 2017-2018 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>\r\n"
+	"License AGPLv3+: GNU AGPL version 3 or later <http://gnu.org/licenses/agpl-3.0.html>\r\n"
+	"This is free software: you are free to change and redistribute it.\r\n"
+	"There is NO WARRANTY, to the extent permitted by law.\r\n";
+
+struct vty_app_info g_vty_info = {
+	.name		= "OsmoTRX",
+	.version	= PACKAGE_VERSION,
+	.copyright	= trx_copyright,
+	.go_parent_cb	= trx_vty_go_parent,
+	.is_config_node	= trx_vty_is_config_node,
+};
+
+struct trx_ctx *vty_trx_ctx_alloc(void *talloc_ctx)
+{
+	struct trx_ctx * trx = talloc_zero(talloc_ctx, struct trx_ctx);
+
+	trx->cfg.bind_addr =  talloc_strdup(trx, DEFAULT_TRX_IP);
+	trx->cfg.remote_addr = talloc_strdup(trx, DEFAULT_TRX_IP);
+	trx->cfg.base_port = DEFAULT_TRX_PORT;
+	trx->cfg.tx_sps = DEFAULT_TX_SPS;
+	trx->cfg.rx_sps = DEFAULT_RX_SPS;
+	trx->cfg.filler = FILLER_ZERO;
+
+	return trx;
+}
+
+int trx_vty_init(struct trx_ctx* trx)
+{
+	g_trx_ctx = trx;
+	install_element_ve(&show_trx_cmd);
+
+	install_element(CONFIG_NODE, &cfg_trx_cmd);
+
+	install_node(&trx_node, config_write_trx);
+	install_element(TRX_NODE, &cfg_bind_ip_cmd);
+	install_element(TRX_NODE, &cfg_remote_ip_cmd);
+	install_element(TRX_NODE, &cfg_base_port_cmd);
+	install_element(TRX_NODE, &cfg_dev_args_cmd);
+	install_element(TRX_NODE, &cfg_tx_sps_cmd);
+	install_element(TRX_NODE, &cfg_rx_sps_cmd);
+	install_element(TRX_NODE, &cfg_clock_ref_cmd);
+	install_element(TRX_NODE, &cfg_multi_arfcn_cmd);
+	install_element(TRX_NODE, &cfg_offset_cmd);
+	install_element(TRX_NODE, &cfg_rssi_offset_cmd);
+	install_element(TRX_NODE, &cfg_swap_channels_cmd);
+	install_element(TRX_NODE, &cfg_egprs_cmd);
+	install_element(TRX_NODE, &cfg_ext_rach_cmd);
+	install_element(TRX_NODE, &cfg_rt_prio_cmd);
+	install_element(TRX_NODE, &cfg_filler_type_cmd);
+	install_element(TRX_NODE, &cfg_filler_tsc_cmd);
+	install_element(TRX_NODE, &cfg_filler_rach_delay_cmd);
+	install_element(TRX_NODE, &cfg_ctr_error_threshold_cmd);
+	install_element(TRX_NODE, &cfg_no_ctr_error_threshold_cmd);
+	install_element(TRX_NODE, &cfg_stack_size_cmd);
+
+	install_element(TRX_NODE, &cfg_chan_cmd);
+	install_node(&chan_node, dummy_config_write);
+	install_element(CHAN_NODE, &cfg_chan_rx_path_cmd);
+	install_element(CHAN_NODE, &cfg_chan_tx_path_cmd);
+
+	logging_vty_add_deprecated_subsys(g_trx_ctx, "lms");
+
+	return 0;
+}

CommonLibs/trx_vty.h

@@ -0,0 +1,73 @@
+#pragma once
+
+#include <osmocom/vty/command.h>
+
+#include "config_defs.h"
+
+extern struct vty_app_info g_vty_info;
+extern const struct value_string clock_ref_names[];
+extern const struct value_string filler_names[];
+
+/* Maximum number of physical RF channels */
+#define TRX_CHAN_MAX 8
+/* Maximum number of carriers in multi-ARFCN mode */
+#define TRX_MCHAN_MAX 3
+
+/* 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.
+ */
+#define DEFAULT_TX_SPS		4
+
+/*
+ * Samples-per-symbol for uplink (receiver) path
+ *     Do not modify this value. EDGE configures 4 sps automatically on
+ *     B200/B210 devices only. Use of 4 sps on the receive path for other
+ *     configurations is not supported.
+ */
+#define DEFAULT_RX_SPS		1
+
+/* Default configuration parameters */
+#define DEFAULT_TRX_PORT	5700
+#define DEFAULT_TRX_IP		"127.0.0.1"
+#define DEFAULT_CHANS		1
+
+struct trx_ctx;
+
+struct trx_chan {
+	struct trx_ctx *trx; /* backpointer */
+	unsigned int idx; /* channel index */
+	char *rx_path;
+	char *tx_path;
+};
+
+struct trx_ctx {
+	struct {
+		char *bind_addr;
+		char *remote_addr;
+		char *dev_args;
+		unsigned int base_port;
+		unsigned int tx_sps;
+		unsigned int rx_sps;
+		unsigned int rtsc;
+		unsigned int rach_delay;
+		enum ReferenceType clock_ref;
+		enum FillerType filler;
+		bool multi_arfcn;
+		double offset;
+		double rssi_offset;
+		bool swap_channels;
+		bool ext_rach;
+		bool egprs;
+		unsigned int sched_rr;
+		unsigned int stack_size;
+		unsigned int num_chans;
+		struct trx_chan chans[TRX_CHAN_MAX];
+	} cfg;
+};
+
+int trx_vty_init(struct trx_ctx* trx);
+struct trx_ctx *vty_trx_ctx_alloc(void *talloc_ctx);

GSM/GSMCommon.cpp

@@ -2,6 +2,8 @@
 * Copyright 2008 Free Software Foundation, Inc.
 * Copyright 2011 Range Networks, Inc.
 *
+* SPDX-License-Identifier: AGPL-3.0+
+*
 * This software is distributed under the terms of the GNU Affero Public License.
 * See the COPYING file in the main directory for details.
 *
@@ -54,7 +56,10 @@ const BitVector GSM::gEdgeTrainingSequence[] = {
 
 const BitVector GSM::gDummyBurst("0001111101101110110000010100100111000001001000100000001111100011100010111000101110001010111010010100011001100111001111010011111000100101111101010000");
 
-const BitVector GSM::gRACHSynchSequence("01001011011111111001100110101010001111000");
+/* 3GPP TS 05.02, section 5.2.7 "Access burst (AB)", synch. sequence bits */
+const BitVector GSM::gRACHSynchSequenceTS0("01001011011111111001100110101010001111000");  /* GSM, GMSK (default) */
+const BitVector GSM::gRACHSynchSequenceTS1("01010100111110001000011000101111001001101");  /* EGPRS, 8-PSK */
+const BitVector GSM::gRACHSynchSequenceTS2("11101111001001110101011000001101101110111");  /* EGPRS, GMSK */
 
 //                               |-head-||---------midamble----------------------||--------------data----------------||t|
 const BitVector GSM::gRACHBurst("0011101001001011011111111001100110101010001111000110111101111110000111001001010110011000");

GSM/GSMCommon.h

@@ -2,6 +2,8 @@
 /*
 * Copyright 2008-2011 Free Software Foundation, Inc.
 *
+* SPDX-License-Identifier: AGPL-3.0+
+*
 * This software is distributed under the terms of the GNU Affero Public License.
 * See the COPYING file in the main directory for details.
 *
@@ -52,7 +54,9 @@ extern const BitVector gEdgeTrainingSequence[];
 extern const BitVector gDummyBurst;
 
 /** Random access burst synch. sequence */
-extern const BitVector gRACHSynchSequence;
+extern const BitVector gRACHSynchSequenceTS0;
+extern const BitVector gRACHSynchSequenceTS1;
+extern const BitVector gRACHSynchSequenceTS2;
 /** Random access burst synch. sequence, GSM 05.02 5.2.7 */
 extern const BitVector gRACHBurst;
 
@@ -164,7 +168,7 @@ class Time {
         unsigned newTN = (mTN + other.mTN) % 8;
 		uint64_t newFN = (mFN+other.mFN + (mTN + other.mTN)/8) % gHyperframe;
         return Time(newFN,newTN);
-    } 
+    }
 
 	int operator-(const Time& other) const
 	{

INSTALLATION

@@ -1,33 +0,0 @@
-Installation Requirements
-
-
-
-OpenBTS compiles to a simple Unix binary and does not require special
-installation.
-
-One some systems (Ubuntu), you will need to define LIBS = -lpthread prior to
-running configure.
-
-To run OpenBTS, the following should be installed:
-
-	Asterisk (http://www.asterisk.org), running SIP on port 5060.
-
-	libosip2 (http://www.gnu.org/software/osip/)
-
-	libortp (http://freshmeat.net/projects/ortp/)
-
-	libusrp (http://gnuradio.org).
-	This is part of the GNURadio installation.
-	It is the only part used by OpenBTS.
-
-
-OpenBTS logs to syslogd as facility LOG_LOCAL7.  Please set your /etc/syslog.conf
-accordingly.
-
-
-For information on specific executables, see tests/README.tests and
-apps/README.apps.
-
-See http://gnuradio.org/redmine/wiki/gnuradio/OpenBTS/BuildingAndRunning for more
-information.
-

LEGAL

@@ -1,5 +1,8 @@
 OpenBTS
 
+The OsmoTRX project is direved from OpenBTS transceiver code. See http://openbts.org/ for details.
+
+The related copyrights:
 Most parts copyright 2008-2011 Free Software Foundation.
 Some parts copyright 2010 Kestrel Signal Processing, Inc.
 Some parts copyright 2011 Range Networks, Inc.
@@ -12,17 +15,9 @@ patented technologies.  The user of this software is required to take whatever
 actions are necessary to avoid patent infringement.
 
 
-Trademark
-
-"OpenBTS" is a registered trademark of Range Networks, Inc. (Range), a
-California corporation.  Range reserves the right to control the use of this 
-trademark.  Do not use this trademark in commerce without permission and do not
-rebrand OpenBTS under a different trademark.
-
-
 Telecom and Radio Spectrum Laws
 
-The primary function of OpenBTS is the provision of telecommunications service
+The primary function of OsmoTRX is the provision of telecommunications service
 over a radio link.  This activity is heavily regulated nearly everywhere in
 the world.  Users of this software are expected to comply with local and national
 regulations in the jurisdictions where this sortware is used with radio equipment.
@@ -39,7 +34,7 @@ The legal restrictions listed here are not necessarily exhaustive.
 
 Note to US Government Users
 
-The OpenBTS software applications and associated documentation are "Commercial
+The OsmoTRX software applications and associated documentation are "Commercial
 Item(s)," as that term is defined at 48 C.F.R. Section 2.101, consisting of
 "Commercial Computer Software" and "Commercial Computer Software Documentation,"
 as such terms are used in 48 C.F.R. 12.212 or 48 C.F.R. 227.7202, as
@@ -54,13 +49,12 @@ and AGPLv3.
 Note to US Government Contractors
 
 GPL is not compatible with "government purpose rights" (GPR).  If you receive
-OpenBTS software under a GPL and deliver it under GPR, you will be in violation
+OsmoTRX software under a GPL and deliver it under GPR, you will be in violation
 of GPL and possibly subject to enforcement actions by the original authors and
 copyright holders, including the Free Software Foundation, Inc.
 
 
 Software Licensing and Distribution
 
-A subset of OpenBTS is distributed publicly under AGPLv3.  Range reserves the right to
-distribute most of this source code other licenses as well.  See the COPYING file
+The OsmoTRX is distributed publicly under AGPLv3. See the COPYING file
 for more information on the license for this distribution.

Makefile.am

@@ -21,23 +21,29 @@
 include $(top_srcdir)/Makefile.common
 
 ACLOCAL_AMFLAGS = -I config
-AM_CPPFLAGS = $(STD_DEFINES_AND_INCLUDES) $(USB_INCLUDES) $(WITH_INCLUDES) $(SQLITE3_CFLAGS)
-AM_CXXFLAGS = -Wall -pthread -ldl
-#AM_CXXFLAGS = -Wall -O2 -NDEBUG -pthread -ldl
-#AM_CFLAGS = -Wall -O2 -NDEBUG -pthread -ldl
+AM_CPPFLAGS = $(STD_DEFINES_AND_INCLUDES) $(USB_INCLUDES) $(WITH_INCLUDES)
+AM_CXXFLAGS = -Wall -pthread
+#AM_CXXFLAGS = -Wall -O2 -NDEBUG -pthread
+#AM_CFLAGS = -Wall -O2 -NDEBUG -pthread
 
 # Order must be preserved
 SUBDIRS = \
+	doc \
 	CommonLibs \
 	GSM \
-	Transceiver52M
+	Transceiver52M \
+	contrib \
+	tests
 
 EXTRA_DIST = \
-	autogen.sh \
-	INSTALLATION \
 	LEGAL \
 	COPYING \
-	README
+	README.md
+
+AM_DISTCHECK_CONFIGURE_FLAGS = \
+	--with-systemdsystemunitdir=$$dc_install_base/$(systemdsystemunitdir)
+
+.PHONY: release
 
 @RELMAKE@
 

Makefile.common

@@ -18,9 +18,6 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-top_srcdir = $(abs_top_srcdir)
-top_builddir = $(abs_top_builddir)
-
 COMMON_INCLUDEDIR = $(top_srcdir)/CommonLibs
 GSM_INCLUDEDIR = $(top_srcdir)/GSM
 
@@ -32,4 +29,10 @@ STD_DEFINES_AND_INCLUDES = \
 COMMON_LA = $(top_builddir)/CommonLibs/libcommon.la
 GSM_LA = $(top_builddir)/GSM/libGSM.la
 
+if ARCH_ARM
+ARCH_LA = $(top_builddir)/Transceiver52M/arch/arm/libarch.la
+else
+ARCH_LA = $(top_builddir)/Transceiver52M/arch/x86/libarch.la
+endif
+
 MOSTLYCLEANFILES = *~

README

@@ -1,116 +0,0 @@
-This is the interface to the transcevier.
-
-Each TRX Manager UDP socket interface represents a single ARFCN.
-Each of these per-ARFCN interfaces is a pair of UDP sockets, one for control and one for data.
-Give a base port B (5700), the master clock interface is at port P=B.
-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.
-The corresponding core-side interface for every socket is at P+100.
-For any given build, the number of ARFCN interfaces can be fixed.
-
-
-
-Indications on the Master Clock Interface
-
-The master clock interface is output only (from the radio).
-Messages are "indications".
-
-CLOCK gives the current value of the transceiver clock to be used by the core.
-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.
-IND CLOCK <totalFrames>
-
-
-
-Commands on the Per-ARFCN Control Interface
-
-The per-ARFCN control interface uses a command-reponse protocol.
-Commands are NULL-terminated ASCII strings, one per UDP socket.
-Each command has a corresponding response.
-Every command is of the form:
-
-CMD <cmdtype> [params]
-
-The <cmdtype> is the actual command.
-Parameters are optional depending on the commands type.
-Every response is of the form:
-
-RSP <cmdtype> <status> [result]
-
-The <status> is 0 for success and a non-zero error code for failure.
-Successful responses may include results, depending on the command type.
-
-
-Power Control
-
-POWEROFF shuts off transmitter power and stops the demodulator.
-CMD POWEROFF
-RSP POWEROFF <status>
-
-POWERON starts the transmitter and starts the demodulator.  Initial power level is very low.
-This command fails if the transmitter and receiver are not yet tuned.
-This command fails if the transmit or receive frequency creates a conflict with another ARFCN that is already runnng.
-If the transceiver is already on, it response with success to this command.
-CMD POWERON
-RSP POWERON <status>
-
-SETPOWER sets output power in dB wrt full scale.
-This command fails if the transmitter and receiver are not running.
-CMD SETPOWER <dB>
-RSP SETPOWER <status> <dB>
-
-ADJPOWER adjusts power by the given dB step.  Response returns resulting power level wrt full scale.
-This command fails if the transmitter and receiver are not running.
-CMD ADJPOWER <dBStep>
-RSP ADJPOWER <status> <dBLevel>
-
-
-Tuning Control
-
-RXTUNE tunes the receiver to a given frequency in kHz.
-This command fails if the receiver is already running.
-(To re-tune you stop the radio, re-tune, and restart.)
-This command fails if the transmit or receive frequency creates a conflict with another ARFCN that is already runnng.
-CMD RXTUNE <kHz>
-RSP RXTUNE <status> <kHz>
-
-TXTUNE tunes the transmitter to a given frequency in kHz.
-This command fails if the transmitter is already running.
-(To re-tune you stop the radio, re-tune, and restart.)
-This command fails if the transmit or receive frequency creates a conflict with another ARFCN that is already runnng.
-CMD TXTUNE <kHz>
-RSP TXTUNE <status> <kHz>
-
-
-Timeslot Control
-
-SETSLOT sets the format of the uplink timeslots in the ARFCN.
-The <timeslot> indicates the timeslot of interest.
-The <chantype> indicates the type of channel that occupies the timeslot.
-A chantype of zero indicates the timeslot is off.
-CMD SETSLOT <timeslot> <chantype>
-RSP SETSLOT <status> <timeslot> <chantype>
-
-
-Messages on the per-ARFCN Data Interface
-
-Messages on the data interface carry one radio burst per UDP message.
-
-
-Received Data Burst
-
-1 byte timeslot index
-4 bytes GSM frame number, big endian
-1 byte RSSI in -dBm
-2 bytes correlator timing offset in 1/256 symbol steps, 2's-comp, big endian
-148 bytes soft symbol estimates, 0 -> definite "0", 255 -> definite "1"
-
-
-Transmit Data Burst
-
-1 byte timeslot index
-4 bytes GSM frame number, big endian
-1 byte transmit level wrt ARFCN max, -dB (attenuation)
-148 bytes output symbol values, 0 & 1
-
-
-
-

README.md

@@ -0,0 +1,66 @@
+About OsmTRX
+============
+
+OsmoTRX is a software-defined radio transceiver that implements the Layer 1
+physical layer of a BTS comprising the following 3GPP specifications:
+
+* TS 05.01 "Physical layer on the radio path"
+* TS 05.02 "Multiplexing and Multiple Access on the Radio Path"
+* TS 05.04 "Modulation"
+* TS 05.10 "Radio subsystem synchronization"
+
+OsmoTRX is based on the transceiver code from the
+[OpenBTS](https://osmocom.org/projects/osmobts/wiki/OpenBTS) project, but setup
+to operate independently with the purpose of using with non-OpenBTS software and
+projects, while still maintaining backwards compatibility with OpenBTS when
+possible. Currently there are numerous features contained in OsmoTRX that extend
+the functionality of the OpenBTS transceiver. These features include enhanced
+support for various embedded platforms - notably ARM - and dual channel
+diversity support for the Fairwaves umtrx.
+
+Homepage
+--------
+
+The official homepage of the project is
+<https://osmocom.org/projects/osmotrx/wiki/OsmoTRX>
+
+GIT Repository
+--------------
+
+You can clone from the official osmo-trx.git repository using
+
+        git clone git://git.osmocom.org/osmo-trx.git
+
+There is a cgit interface at <http://git.osmocom.org/osmo-trx/>
+
+Documentation
+-------------
+
+Doxygen-generated API documentation is generated during the build process, but
+also available online for each of the sub-libraries at User Manual for OsmoTRX
+can be generated during the build process, and is also available online at
+<http://ftp.osmocom.org/docs/latest/osmotrx-usermanual.pdf>.
+
+Mailing List
+------------
+
+Discussions related to OsmoTRX are happening on the openbsc@lists.osmocom.org
+mailing list, please see <https://lists.osmocom.org/mailman/listinfo/openbsc>
+for subscription options and the list archive.
+
+Please observe the [Osmocom Mailing List
+Rules](https://osmocom.org/projects/cellular-infrastructure/wiki/Mailing_List_Rules)
+when posting.
+
+Contributing
+------------
+
+Our coding standards are described at
+<https://osmocom.org/projects/cellular-infrastructure/wiki/Coding_standards>
+
+We us a gerrit based patch submission/review process for managing contributions.
+Please see <https://osmocom.org/projects/cellular-infrastructure/wiki/Gerrit>
+for more details
+
+The current patch queue for OsmoTRX can be seen at
+<https://gerrit.osmocom.org/q/project:osmo-trx+status:open>

Transceiver52M/Channelizer.cpp

@@ -1,9 +1,11 @@
 /*
  * Polyphase channelizer
- * 
+ *
  * Copyright (C) 2012-2014 Tom Tsou <tom@tsou.cc>
  * Copyright (C) 2015 Ettus Research LLC
  *
+ * SPDX-License-Identifier: AGPL-3.0+
+ *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
@@ -25,12 +27,11 @@
 #include <string.h>
 #include <cstdio>
 
-#include "Logger.h"
 #include "Channelizer.h"
 
 extern "C" {
-#include "common/fft.h"
-#include "common/convolve.h"
+#include "fft.h"
+#include "convolve.h"
 }
 
 static void deinterleave(const float *in, size_t ilen,
@@ -64,7 +65,7 @@ float *Channelizer::outputBuffer(size_t chan) const
 	return hInputs[chan];
 }
 
-/* 
+/*
  * Implementation based on material found in:
  *
  * "harris, fred, Multirate Signal Processing, Upper Saddle River, NJ,
@@ -79,8 +80,8 @@ bool Channelizer::rotate(const float *in, size_t len)
 
 	deinterleave(in, len, hInputs, blockLen, m);
 
-	/* 
-	 * Convolve through filterbank while applying and saving sample history 
+	/*
+	 * Convolve through filterbank while applying and saving sample history
 	 */
 	for (size_t i = 0; i < m; i++) {
 		memcpy(&hInputs[i][2 * -hLen], hist[i], hSize);
@@ -89,7 +90,7 @@ bool Channelizer::rotate(const float *in, size_t len)
 		convolve_real(hInputs[i], blockLen,
 			      subFilters[i], hLen,
 			      hOutputs[i], blockLen,
-			      0, blockLen, 1, 0);
+			      0, blockLen);
 	}
 
 	cxvec_fft(fftHandle);
@@ -97,7 +98,7 @@ bool Channelizer::rotate(const float *in, size_t len)
 	return true;
 }
 
-/* Setup channelizer paramaters */
+/* Setup channelizer parameters */
 Channelizer::Channelizer(size_t m, size_t blockLen, size_t hLen)
 	: ChannelizerBase(m, blockLen, hLen)
 {

Transceiver52M/ChannelizerBase.cpp

@@ -1,8 +1,10 @@
 /*
  * Polyphase channelizer
- * 
+ *
  * Copyright (C) 2012-2014 Tom Tsou <tom@tsou.cc>
- * Copyright (C) 2015 Ettus Research LLC 
+ * Copyright (C) 2015 Ettus Research LLC
+ *
+ * SPDX-License-Identifier: AGPL-3.0+
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published by
@@ -29,7 +31,7 @@
 #include "ChannelizerBase.h"
 
 extern "C" {
-#include "common/fft.h"
+#include "fft.h"
 }
 
 static float sinc(float x)
@@ -55,10 +57,10 @@ static void reverse(float *buf, size_t len)
 	}
 }
 
-/* 
+/*
  * Create polyphase filterbank
  *
- * Implementation based material found in, 
+ * Implementation based material found in,
  *
  * "harris, fred, Multirate Signal Processing, Upper Saddle River, NJ,
  *     Prentice Hall, 2006."
@@ -70,7 +72,7 @@ bool ChannelizerBase::initFilters()
 	float sum = 0.0f, scale = 0.0f;
 	float midpt = (float) (protoLen - 1.0) / 2.0;
 
-	/* 
+	/*
 	 * Allocate 'M' partition filters and the temporary prototype
 	 * filter. Coefficients are real only and must be 16-byte memory
 	 * aligned for SSE usage.
@@ -90,7 +92,7 @@ bool ChannelizerBase::initFilters()
 				memalign(16, hLen * 2 * sizeof(float));
 	}
 
-	/* 
+	/*
 	 * Generate the prototype filter with a Blackman-harris window.
 	 * Scale coefficients with DC filter gain set to unity divided
 	 * by the number of channels.
@@ -110,7 +112,7 @@ bool ChannelizerBase::initFilters()
 	}
 	scale = (float) m / sum;
 
-	/* 
+	/*
 	 * Populate partition filters and reverse the coefficients per
 	 * convolution requirements.
 	 */
@@ -174,7 +176,7 @@ bool ChannelizerBase::mapBuffers()
 	return true;
 }
 
-/* 
+/*
  * Setup filterbank internals
  */
 bool ChannelizerBase::init()
@@ -222,11 +224,12 @@ bool ChannelizerBase::checkLen(size_t innerLen, size_t outerLen)
 	return true;
 }
 
-/* 
- * Setup channelizer paramaters
+/*
+ * Setup channelizer parameters
  */
 ChannelizerBase::ChannelizerBase(size_t m, size_t blockLen, size_t hLen)
-	: fftInput(NULL), fftOutput(NULL), fftHandle(NULL)
+	: subFilters(NULL), hInputs(NULL), hOutputs(NULL), hist(NULL),
+	  fftInput(NULL), fftOutput(NULL), fftHandle(NULL)
 {
 	this->m = m;
 	this->hLen = hLen;
@@ -239,7 +242,7 @@ ChannelizerBase::~ChannelizerBase()
 
 	for (size_t i = 0; i < m; i++) {
 		free(subFilters[i]);
-		delete hist[i];
+		delete[] hist[i];
 	}
 
 	fft_free(fftInput);

Transceiver52M/ChannelizerBase.h

@@ -32,7 +32,7 @@ protected:
 	/* Buffer length validity checking */
 	bool checkLen(size_t innerLen, size_t outerLen);
 public:
-	/* Initilize channelizer/synthesis filter internals */
+	/* Initialize channelizer/synthesis filter internals */
 	bool init();
 };
 

Transceiver52M/Complex.h

@@ -5,7 +5,7 @@ unlike the built-in complex<> templates, these inline most operations for speed
 /*
 * Copyright 2008 Free Software Foundation, Inc.
 *
-* This software is distributed under multiple licenses; see the COPYING file in the main directory for licensing information for this specific distribuion.
+* This software is distributed under multiple licenses; see the COPYING file in the main directory for licensing information for this specific distribution.
 *
 * This use of this software may be subject to additional restrictions.
 * See the LEGAL file in the main directory for details.

Transceiver52M/Makefile.am

@@ -21,34 +21,13 @@
 
 include $(top_srcdir)/Makefile.common
 
-AM_CPPFLAGS = -Wall $(STD_DEFINES_AND_INCLUDES) -I${srcdir}/common
-AM_CXXFLAGS = -ldl -lpthread
+SUBDIRS = arch device
 
-SUBDIRS = arm x86
+AM_CPPFLAGS = -Wall $(STD_DEFINES_AND_INCLUDES) -I${srcdir}/arch/common -I${srcdir}/device/common
+AM_CXXFLAGS = -lpthread $(LIBOSMOCORE_CFLAGS) $(LIBOSMOCTRL_CFLAGS) $(LIBOSMOVTY_CFLAGS)
+AM_CFLAGS = -lpthread $(LIBOSMOCORE_CFLAGS) $(LIBOSMOCTRL_CFLAGS) $(LIBOSMOVTY_CFLAGS)
 
-if ARCH_ARM
-ARCH_LA = arm/libarch.la
-else
-ARCH_LA = x86/libarch.la
-endif
-
-if USRP1 
-AM_CPPFLAGS += $(USRP_CFLAGS)
-else
-AM_CPPFLAGS += $(UHD_CFLAGS)
-endif
-
-rev2dir = $(datadir)/usrp/rev2
-rev4dir = $(datadir)/usrp/rev4
-
-dist_rev2_DATA = std_inband.rbf
-dist_rev4_DATA = std_inband.rbf
-
-EXTRA_DIST = \
-	README \
-	README.Talgorithm
-
-noinst_LTLIBRARIES = libtransceiver.la
+noinst_LTLIBRARIES = libtransceiver_common.la
 
 COMMON_SOURCES = \
 	radioInterface.cpp \
@@ -61,48 +40,67 @@ COMMON_SOURCES = \
 	ChannelizerBase.cpp \
 	Channelizer.cpp \
 	Synthesis.cpp \
-	common/fft.c
+	proto_trxd.c
 
-libtransceiver_la_SOURCES = \
+libtransceiver_common_la_SOURCES = \
 	$(COMMON_SOURCES) \
 	Resampler.cpp \
 	radioInterfaceResamp.cpp \
 	radioInterfaceMulti.cpp
 
-bin_PROGRAMS = osmo-trx
-
 noinst_HEADERS = \
 	Complex.h \
 	radioInterface.h \
 	radioVector.h \
 	radioClock.h \
-	radioDevice.h \
 	radioBuffer.h \
 	sigProcLib.h \
 	signalVector.h \
 	Transceiver.h \
-	USRPDevice.h \
 	Resampler.h \
 	ChannelizerBase.h \
 	Channelizer.h \
 	Synthesis.h \
-	common/convolve.h \
-	common/convert.h \
-	common/scale.h \
-	common/mult.h \
-	common/fft.h
+	proto_trxd.h
 
-osmo_trx_SOURCES = osmo-trx.cpp
-osmo_trx_LDADD = \
-	libtransceiver.la \
+COMMON_LDADD = \
+	libtransceiver_common.la \
 	$(ARCH_LA) \
 	$(GSM_LA) \
-	$(COMMON_LA) $(SQLITE3_LIBS)
+	$(COMMON_LA) \
+	$(FFTWF_LIBS) \
+	$(LIBOSMOCORE_LIBS) \
+	$(LIBOSMOCTRL_LIBS) \
+	$(LIBOSMOVTY_LIBS)
 
-if USRP1 
-libtransceiver_la_SOURCES += USRPDevice.cpp
-osmo_trx_LDADD += $(USRP_LIBS)
-else
-libtransceiver_la_SOURCES += UHDDevice.cpp
-osmo_trx_LDADD += $(UHD_LIBS) $(FFTWF_LIBS)
+bin_PROGRAMS =
+
+if DEVICE_UHD
+bin_PROGRAMS += osmo-trx-uhd
+osmo_trx_uhd_SOURCES = osmo-trx.cpp
+osmo_trx_uhd_LDADD = \
+	$(builddir)/device/uhd/libdevice.la \
+	$(COMMON_LDADD) \
+	$(UHD_LIBS)
+osmo_trx_uhd_CPPFLAGS  = $(AM_CPPFLAGS) $(UHD_CFLAGS)
+endif
+
+if DEVICE_USRP1
+bin_PROGRAMS += osmo-trx-usrp1
+osmo_trx_usrp1_SOURCES = osmo-trx.cpp
+osmo_trx_usrp1_LDADD = \
+	$(builddir)/device/usrp1/libdevice.la \
+	$(COMMON_LDADD) \
+	$(USRP_LIBS)
+osmo_trx_usrp1_CPPFLAGS  = $(AM_CPPFLAGS) $(USRP_CFLAGS)
+endif
+
+if DEVICE_LMS
+bin_PROGRAMS += osmo-trx-lms
+osmo_trx_lms_SOURCES = osmo-trx.cpp
+osmo_trx_lms_LDADD = \
+	$(builddir)/device/lms/libdevice.la \
+	$(COMMON_LDADD) \
+	$(LMS_LIBS)
+osmo_trx_lms_CPPFLAGS  = $(AM_CPPFLAGS) $(LMS_CFLAGS)
 endif

Transceiver52M/README

@@ -1,35 +0,0 @@
-The Transceiver
-
-The transceiver consists of three modules:
-   --- transceiver
-   --- radioInterface
-   --- USRPDevice
-
-The USRPDevice module is basically a driver that reads/writes
-packets to a USRP with two RFX900 daughterboards, board 
-A is the Tx chain and board B is the Rx chain.  
-
-The radioInterface module is basically an interface b/w the
-transceiver and the USRP.   It operates the basestation clock
-based upon the sample count of received USRP samples.  Packets 
-from the USRP are queued and segmented into GSM bursts that are
-passed up to the transceiver; bursts from the transceiver are
-passed down to the USRP. 
-
-The transceiver basically operates "layer 0" of the GSM stack,
-performing the modulation, detection, and demodulation of GSM 
-bursts.  It communicates with the GSM stack via three UDP sockets,
-one socket for data, one for control messages, and one socket to
-pass clocking information.  The transceiver contains a priority
-queue to sort to-be-transmitted bursts, and a filler table to fill
-in timeslots that do not have bursts in the priority queue.  The
-transceiver tries to stay ahead of the basestation clock, adapting 
-its latency when underruns are reported by the radioInterface/USRP.
-Received bursts (from the radioInterface) pass through a simple 
-energy detector, a RACH or midamble correlator, and a DFE-based demodulator.
-
-NOTE: There's a SWLOOPBACK #define statement, where the USRP is replaced
-with a memory buffer.  In this mode, data written to the USRP is actually stored 
-in a buffer, and read commands to the USRP simply pull data from this buffer.
-This was very useful in early testing, and still may be useful in testing basic
-Transceiver and radioInterface functionality. 

Transceiver52M/Resampler.cpp

@@ -2,6 +2,8 @@
  * Rational Sample Rate Conversion
  * Copyright (C) 2012, 2013  Thomas Tsou <tom@tsou.cc>
  *
+ * SPDX-License-Identifier: LGPL-2.1+
+ *
  * 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
@@ -51,7 +53,7 @@ void Resampler::initFilters(float bw)
 	float cutoff;
 	float sum = 0.0f, scale = 0.0f;
 
-	/* 
+	/*
 	 * Allocate partition filters and the temporary prototype filter
 	 * according to numerator of the rational rate. Coefficients are
 	 * real only and must be 16-byte memory aligned for SSE usage.
@@ -60,10 +62,10 @@ void Resampler::initFilters(float bw)
 	for (auto &part : partitions)
 		part = (complex<float> *) memalign(16, filt_len * sizeof(complex<float>));
 
-	/* 
+	/*
 	 * Generate the prototype filter with a Blackman-harris window.
 	 * Scale coefficients with DC filter gain set to unity divided
-	 * by the number of filter partitions. 
+	 * by the number of filter partitions.
 	 */
 	float a0 = 0.35875;
 	float a1 = 0.48829;
@@ -137,13 +139,13 @@ int Resampler::rotate(const float *in, size_t in_len, float *out, size_t out_len
 
 	/* Generate output from precomputed input/output paths */
 	for (size_t i = 0; i < out_len; i++) {
-		n = in_index[i]; 
-		path = out_path[i]; 
+		n = in_index[i];
+		path = out_path[i];
 
 		convolve_real(in, in_len,
 			      reinterpret_cast<float *>(partitions[path]),
 			      filt_len, &out[2 * i], out_len - i,
-			      n, 1, 1, 0);
+			      n, 1);
 	}
 
 	return out_len;

Transceiver52M/Resampler.h

@@ -2,6 +2,8 @@
  * Rational Sample Rate Conversion
  * Copyright (C) 2012, 2013  Thomas Tsou <tom@tsou.cc>
  *
+ * SPDX-License-Identifier: LGPL-2.1+
+ *
  * 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
@@ -28,17 +30,17 @@ public:
 	/* Constructor for rational sample rate conversion
 	 *   @param p numerator of resampling ratio
 	 *   @param q denominator of resampling ratio
-	 *   @param filt_len length of each polyphase subfilter 
+	 *   @param filt_len length of each polyphase subfilter
 	 */
 	Resampler(size_t p, size_t q, size_t filt_len = 16);
 	~Resampler();
 
-	/* Initilize resampler filterbank.
+	/* Initialize resampler filterbank.
 	 *   @param bw bandwidth factor on filter generation (pre-window)
 	 *   @return false on error, zero otherwise
 	 *
 	 * Automatic setting is to compute the filter to prevent aliasing with
-	 * a Blackman-Harris window. Adjustment is made through a bandwith
+	 * a Blackman-Harris window. Adjustment is made through a bandwidth
 	 * factor to shift the cutoff and/or the constituent filter lengths.
 	 * Calculation of specific rolloff factors or 3-dB cutoff points is
 	 * left as an excersize for the reader.
@@ -58,7 +60,7 @@ public:
 	int rotate(const float *in, size_t in_len, float *out, size_t out_len);
 
 	/* Get filter length
-	 *   @return number of taps in each filter partition 
+	 *   @return number of taps in each filter partition
 	 */
 	size_t len();
 

Transceiver52M/Synthesis.cpp

@@ -1,9 +1,11 @@
 /*
  * Polyphase synthesis filter
- * 
+ *
  * Copyright (C) 2012-2014 Tom Tsou <tom@tsou.cc>
  * Copyright (C) 2015 Ettus Research LLC
  *
+ * SPDX-License-Identifier: AGPL-3.0+
+ *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
@@ -24,13 +26,13 @@
 #include <assert.h>
 #include <string.h>
 #include <cstdio>
+#include <iostream>
 
-#include "Logger.h"
 #include "Synthesis.h"
 
 extern "C" {
-#include "common/fft.h"
-#include "common/convolve.h"
+#include "fft.h"
+#include "convolve.h"
 }
 
 static void interleave(float **in, size_t ilen,
@@ -74,7 +76,7 @@ bool Synthesis::resetBuffer(size_t chan)
 	return true;
 }
 
-/* 
+/*
  * Implementation based on material found in:
  *
  * "harris, fred, Multirate Signal Processing, Upper Saddle River, NJ,
@@ -92,8 +94,8 @@ bool Synthesis::rotate(float *out, size_t len)
 
 	cxvec_fft(fftHandle);
 
-	/* 
-	 * Convolve through filterbank while applying and saving sample history 
+	/*
+	 * Convolve through filterbank while applying and saving sample history
 	 */
 	for (size_t i = 0; i < m; i++) {
 		memcpy(&hInputs[i][2 * -hLen], hist[i], hSize);
@@ -102,7 +104,7 @@ bool Synthesis::rotate(float *out, size_t len)
 		convolve_real(hInputs[i], blockLen,
 			      subFilters[i], hLen,
 			      hOutputs[i], blockLen,
-			      0, blockLen, 1, 0);
+			      0, blockLen);
 	}
 
 	/* Interleave into output vector */

Transceiver52M/Transceiver.h

@@ -1,6 +1,8 @@
 /*
 * Copyright 2008 Free Software Foundation, Inc.
 *
+* SPDX-License-Identifier: GPL-3.0+
+*
 * This software is distributed under the terms of the GNU Public License.
 * See the COPYING file in the main directory for details.
 *
@@ -25,27 +27,21 @@
 #include "radioInterface.h"
 #include "Interthread.h"
 #include "GSMCommon.h"
-#include "Sockets.h"
 
 #include <sys/types.h>
 #include <sys/socket.h>
 
+extern "C" {
+#include <osmocom/core/signal.h>
+#include "config_defs.h"
+}
+
 class Transceiver;
 
 /** Channel descriptor for transceiver object and channel number pair */
-struct TransceiverChannel {
-  TransceiverChannel(Transceiver *trx, int num)
-  {
-    this->trx = trx;
-    this->num = num;
-  }
-
-  ~TransceiverChannel()
-  {
-  }
-
-  Transceiver *trx;
-  size_t num;
+struct TrxChanThParams {
+	Transceiver *trx;
+	size_t num;
 };
 
 /** Internal transceiver state variables */
@@ -54,7 +50,7 @@ struct TransceiverState {
   ~TransceiverState();
 
   /* Initialize a multiframe slot in the filler table */
-  bool init(int filler, size_t sps, float scale, size_t rtsc, unsigned rach_delay);
+  bool init(FillerType filler, size_t sps, float scale, size_t rtsc, unsigned rach_delay);
 
   int chanType[8];
 
@@ -103,13 +99,14 @@ public:
               size_t tx_sps, size_t rx_sps, size_t chans,
               GSM::Time wTransmitLatency,
               RadioInterface *wRadioInterface,
-              double wRssiOffset);
+              double wRssiOffset, int stackSize);
 
   /** Destructor */
   ~Transceiver();
 
   /** Start the control loop */
-  bool init(int filler, size_t rtsc, unsigned rach_delay, bool edge);
+  bool init(FillerType filler, size_t rtsc, unsigned rach_delay,
+            bool edge, bool ext_rach);
 
   /** attach the radioInterface receive FIFO */
   bool receiveFIFO(VectorFIFO *wFIFO, size_t chan)
@@ -144,22 +141,14 @@ public:
     LOOPBACK            ///< similar go VII, used in loopback testing
   } ChannelCombination;
 
-  enum FillerType {
-    FILLER_DUMMY,
-    FILLER_ZERO,
-    FILLER_NORM_RAND,
-    FILLER_EDGE_RAND,
-    FILLER_ACCESS_RAND,
-  };
-
 private:
   int mBasePort;
   std::string mLocalAddr;
   std::string mRemoteAddr;
 
-  std::vector<UDPSocket *> mDataSockets;  ///< socket for writing to/reading from GSM core
-  std::vector<UDPSocket *> mCtrlSockets;  ///< socket for writing/reading control commands from GSM core
-  UDPSocket mClockSocket;                 ///< socket for writing clock updates to GSM core
+  std::vector<int> mDataSockets;  ///< socket for writing to/reading from GSM core
+  std::vector<int> mCtrlSockets;  ///< socket for writing/reading control commands from GSM core
+  int mClockSocket;               ///< socket for writing clock updates to GSM core
 
   std::vector<VectorQueue> mTxPriorityQueues;   ///< priority queue of transmit bursts received from GSM core
   std::vector<VectorFIFO *>  mReceiveFIFO;      ///< radioInterface FIFO of receive bursts
@@ -180,6 +169,7 @@ private:
   double rxFullScale;                     ///< full scale output to radio
 
   double rssiOffset;                      ///< RSSI to dBm conversion offset
+  int stackSize;                      ///< stack size for threads, 0 = OS default
 
   /** modulate and add a burst to the transmit queue */
   void addRadioVector(size_t chan, BitVector &bits,
@@ -192,9 +182,7 @@ private:
   void pushRadioVector(GSM::Time &nowTime);
 
   /** Pull and demodulate a burst from the receive FIFO */
-  SoftVector *pullRadioVector(GSM::Time &wTime, double &RSSI, bool &isRssiValid,
-                              double &timingOffset, double &noise,
-                              size_t chan = 0);
+  int pullRadioVector(size_t chan, struct trx_ul_burst_ind *ind);
 
   /** Set modulus for specific timeslot */
   void setModulus(size_t timeslot, size_t chan);
@@ -203,12 +191,13 @@ private:
   CorrType expectedCorrType(GSM::Time currTime, size_t chan);
 
   /** send messages over the clock socket */
-  void writeClockInterface(void);
+  bool writeClockInterface(void);
 
   int mSPSTx;                          ///< number of samples per Tx symbol
   int mSPSRx;                          ///< number of samples per Rx symbol
   size_t mChans;
 
+  bool mExtRACH;
   bool mEdge;
   bool mOn;	                           ///< flag to indicate that transceiver is powered on
   bool mForceClockInterface;           ///< flag to indicate whether IND CLOCK shall be sent unconditionally after transceiver is started
@@ -220,27 +209,28 @@ private:
   unsigned mMaxExpectedDelayNB;        ///< maximum expected time-of-arrival offset in GSM symbols for Normal Bursts
   unsigned mWriteBurstToDiskMask;      ///< debug: bitmask to indicate which timeslots to dump to disk
 
+  std::vector<unsigned> mVersionTRXD;  ///< Format version to use for TRXD protocol communication, per channel
   std::vector<TransceiverState> mStates;
 
   /** Start and stop I/O threads through the control socket API */
   bool start();
   void stop();
 
-  /** Protect destructor accessable stop call */
+  /** Protect destructor accessible stop call */
   Mutex mLock;
 
 protected:
   /** drive lower receive I/O and burst generation */
-  void driveReceiveRadio();
+  bool driveReceiveRadio();
 
   /** drive demodulation of GSM bursts */
-  void driveReceiveFIFO(size_t chan);
+  bool driveReceiveFIFO(size_t chan);
 
   /** drive transmission of GSM bursts */
   void driveTxFIFO();
 
   /** drive handling of control messages from GSM core */
-  void driveControl(size_t chan);
+  bool driveControl(size_t chan);
 
   /**
     drive modulation and sorting of GSM bursts from GSM core
@@ -248,34 +238,26 @@ protected:
   */
   bool driveTxPriorityQueue(size_t chan);
 
-  friend void *RxUpperLoopAdapter(TransceiverChannel *);
-
-  friend void *TxUpperLoopAdapter(TransceiverChannel *);
-
-  friend void *RxLowerLoopAdapter(Transceiver *);
-
-  friend void *TxLowerLoopAdapter(Transceiver *);
-
-  friend void *ControlServiceLoopAdapter(TransceiverChannel *);
+  friend void *RxUpperLoopAdapter(TrxChanThParams *params);
+  friend void *TxUpperLoopAdapter(TrxChanThParams *params);
+  friend void *RxLowerLoopAdapter(Transceiver *transceiver);
+  friend void *TxLowerLoopAdapter(Transceiver *transceiver);
+  friend void *ControlServiceLoopAdapter(TrxChanThParams *params);
 
 
   void reset();
 
-  /** set priority on current thread */
-  void setPriority(float prio = 0.5) { mRadioInterface->setPriority(prio); }
-
-  void logRxBurst(size_t chan, SoftVector *burst, GSM::Time time, double dbm,
-                  double rssi, double noise, double toa);
+  void logRxBurst(size_t chan, const struct trx_ul_burst_ind *bi);
 };
 
-void *RxUpperLoopAdapter(TransceiverChannel *);
+void *RxUpperLoopAdapter(TrxChanThParams *params);
 
 /** Main drive threads */
-void *RxLowerLoopAdapter(Transceiver *);
-void *TxLowerLoopAdapter(Transceiver *);
+void *RxLowerLoopAdapter(Transceiver *transceiver);
+void *TxLowerLoopAdapter(Transceiver *transceiver);
 
 /** control message handler thread loop */
-void *ControlServiceLoopAdapter(TransceiverChannel *);
+void *ControlServiceLoopAdapter(TrxChanThParams *params);
 
 /** transmit queueing thread loop */
-void *TxUpperLoopAdapter(TransceiverChannel *);
+void *TxUpperLoopAdapter(TrxChanThParams *params);

Transceiver52M/arch/Makefile.am

@@ -0,0 +1,8 @@
+include $(top_srcdir)/Makefile.common
+
+SUBDIRS = common
+if ARCH_ARM
+SUBDIRS += arm
+else
+SUBDIRS += x86
+endif

Transceiver52M/arch/arm/Makefile.am

@@ -1,17 +1,17 @@
-if ARCH_ARM
 if ARCH_ARM_A15
 ARCH_FLAGS = -mfpu=neon-vfpv4
 else
 ARCH_FLAGS = -mfpu=neon
 endif
 
-AM_CFLAGS = -Wall $(ARCH_FLAGS) -std=gnu99 -I../common
+AM_CFLAGS = -Wall $(ARCH_FLAGS) -std=gnu99 -I${srcdir}/../common
 AM_CCASFLAGS = $(ARCH_FLAGS)
 
 noinst_LTLIBRARIES = libarch.la
 
+libarch_la_LIBADD = $(top_builddir)/Transceiver52M/arch/common/libarch_common.la
+
 libarch_la_SOURCES = \
-	../common/convolve_base.c \
 	convert.c \
 	convert_neon.S \
 	convolve.c \
@@ -20,4 +20,3 @@ libarch_la_SOURCES = \
 	scale_neon.S \
 	mult.c \
 	mult_neon.S
-endif

Transceiver52M/arch/arm/convert.c

@@ -2,6 +2,8 @@
  * NEON type conversions
  * Copyright (C) 2012, 2013 Thomas Tsou <tom@tsou.cc>
  *
+ * SPDX-License-Identifier: LGPL-2.1+
+ *
  * 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
@@ -28,6 +30,9 @@
 void neon_convert_ps_si16_4n(short *, const float *, const float *, int);
 void neon_convert_si16_ps_4n(float *, const short *, int);
 
+void convert_init(void) {
+}
+
 /* 4*N 16-bit signed integer conversion with remainder */
 static void neon_convert_si16_ps(float *out,
 				 const short *in,
@@ -54,7 +59,6 @@ static void neon_convert_ps_si16(short *out,
 	for (int i = 0; i < len % 4; i++)
 		out[start + i] = (short) (in[start + i] * (*scale));
 }
-#endif
 
 void convert_float_short(short *out, const float *in, float scale, int len)
 {

Transceiver52M/arch/arm/convert_neon.S

@@ -2,6 +2,8 @@
  * NEON type conversions
  * Copyright (C) 2012, 2013 Thomas Tsou <tom@tsou.cc>
  *
+ * SPDX-License-Identifier: LGPL-2.1+
+ *
  * 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

Transceiver52M/arch/arm/convolve.c

@@ -2,6 +2,8 @@
  * NEON Convolution
  * Copyright (C) 2012, 2013 Thomas Tsou <tom@tsou.cc>
  *
+ * SPDX-License-Identifier: LGPL-2.1+
+ *
  * 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
@@ -29,17 +31,15 @@
 int _base_convolve_real(float *x, int x_len,
 			float *h, int h_len,
 			float *y, int y_len,
-			int start, int len,
-			int step, int offset);
+			int start, int len);
 
 int _base_convolve_complex(float *x, int x_len,
 			   float *h, int h_len,
 			   float *y, int y_len,
-			   int start, int len,
-			   int step, int offset);
+			   int start, int len);
 
 int bounds_check(int x_len, int h_len, int y_len,
-		 int start, int len, int step);
+		 int start, int len);
 
 #ifdef HAVE_NEON
 /* Calls into NEON assembler */
@@ -58,7 +58,7 @@ static void neon_conv_cmplx_4n(float *x, float *h, float *y, int h_len, int len)
 }
 #endif
 
-/* API: Initalize convolve module */
+/* API: Initialize convolve module */
 void convolve_init(void)
 {
 	/* Stub */
@@ -69,35 +69,32 @@ void convolve_init(void)
 int convolve_real(float *x, int x_len,
 		  float *h, int h_len,
 		  float *y, int y_len,
-		  int start, int len,
-		  int step, int offset)
+		  int start, int len)
 {
 	void (*conv_func)(float *, float *, float *, int) = NULL;
 
-	if (bounds_check(x_len, h_len, y_len, start, len, step) < 0)
+	if (bounds_check(x_len, h_len, y_len, start, len) < 0)
 		return -1;
 
 	memset(y, 0, len * 2 * sizeof(float));
 
 #ifdef HAVE_NEON
-	if (step <= 4) {
-		switch (h_len) {
-		case 4:
-			conv_func = neon_conv_real4;
-			break;
-		case 8:
-			conv_func = neon_conv_real8;
-			break;
-		case 12:
-			conv_func = neon_conv_real12;
-			break;
-		case 16:
-			conv_func = neon_conv_real16;
-			break;
-		case 20:
-			conv_func = neon_conv_real20;
-			break;
-		}
+	switch (h_len) {
+	case 4:
+		conv_func = neon_conv_real4;
+		break;
+	case 8:
+		conv_func = neon_conv_real8;
+		break;
+	case 12:
+		conv_func = neon_conv_real12;
+		break;
+	case 16:
+		conv_func = neon_conv_real16;
+		break;
+	case 20:
+		conv_func = neon_conv_real20;
+		break;
 	}
 #endif
 	if (conv_func) {
@@ -107,7 +104,7 @@ int convolve_real(float *x, int x_len,
 		_base_convolve_real(x, x_len,
 				    h, h_len,
 				    y, y_len,
-				    start, len, step, offset);
+				    start, len);
 	}
 
 	return len;
@@ -118,18 +115,17 @@ int convolve_real(float *x, int x_len,
 int convolve_complex(float *x, int x_len,
 		     float *h, int h_len,
 		     float *y, int y_len,
-		     int start, int len,
-		     int step, int offset)
+		     int start, int len)
 {
 	void (*conv_func)(float *, float *, float *, int, int) = NULL;
 
-	if (bounds_check(x_len, h_len, y_len, start, len, step) < 0)
+	if (bounds_check(x_len, h_len, y_len, start, len) < 0)
 		return -1;
 
 	memset(y, 0, len * 2 * sizeof(float));
 
 #ifdef HAVE_NEON
-	if (step <= 4 && !(h_len % 4))
+	if (!(h_len % 4))
 		conv_func = neon_conv_cmplx_4n;
 #endif
 	if (conv_func) {
@@ -139,7 +135,7 @@ int convolve_complex(float *x, int x_len,
 		_base_convolve_complex(x, x_len,
 				       h, h_len,
 				       y, y_len,
-				       start, len, step, offset);
+				       start, len);
 	}
 
 	return len;

Transceiver52M/arch/arm/convolve_neon.S

@@ -2,6 +2,8 @@
  * NEON Convolution
  * Copyright (C) 2012, 2013 Thomas Tsou <tom@tsou.cc>
  *
+ * SPDX-License-Identifier: LGPL-2.1+
+ *
  * 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
@@ -92,8 +94,8 @@ neon_conv_real12:
 	vld2.32     {q8-q9}, [r4], r6
 	vld2.32   {q10-q11}, [r5], r6
 #ifdef HAVE_NEON_FMA
-	vfma.f32         q1,   q6, q0
-	vfma.f32         q3,   q7, q0
+	vmul.f32         q1,   q6, q0
+	vmul.f32         q3,   q7, q0
 	vfma.f32         q1,   q8, q2
 	vfma.f32         q3,   q9, q2
 	vfma.f32         q1,  q10, q4

Transceiver52M/arch/arm/mult.c

@@ -2,6 +2,8 @@
  * NEON scaling
  * Copyright (C) 2012,2013 Thomas Tsou <tom@tsou.cc>
  *
+ * SPDX-License-Identifier: LGPL-2.1+
+ *
  * 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

Transceiver52M/arch/arm/mult_neon.S

@@ -1,7 +1,9 @@
 /*
- * NEON complex multiplication 
+ * NEON complex multiplication
  * Copyright (C) 2012,2013 Thomas Tsou <tom@tsou.cc>
  *
+ * SPDX-License-Identifier: LGPL-2.1+
+ *
  * 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

Transceiver52M/arch/arm/scale.c

@@ -2,6 +2,8 @@
  * NEON scaling
  * Copyright (C) 2012,2013 Thomas Tsou <tom@tsou.cc>
  *
+ * SPDX-License-Identifier: LGPL-2.1+
+ *
  * 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

Transceiver52M/arch/arm/scale_neon.S

@@ -2,6 +2,8 @@
  * ARM NEON Scaling
  * Copyright (C) 2013 Thomas Tsou <tom@tsou.cc>
  *
+ * SPDX-License-Identifier: LGPL-2.1+
+ *
  * 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

Transceiver52M/arch/common/Makefile.am

@@ -0,0 +1,15 @@
+AM_CFLAGS = -Wall -std=gnu99
+
+noinst_LTLIBRARIES = libarch_common.la
+
+noinst_HEADERS = \
+        convolve.h \
+        convert.h \
+        scale.h \
+        mult.h \
+        fft.h
+
+libarch_common_la_SOURCES = \
+        convolve_base.c \
+        convert_base.c \
+        fft.c

Transceiver52M/arch/common/convert_base.c

@@ -2,6 +2,8 @@
  * Conversion
  * Copyright (C) 2012, 2013 Thomas Tsou <tom@tsou.cc>
  *
+ * SPDX-License-Identifier: LGPL-2.1+
+ *
  * 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
@@ -31,4 +33,3 @@ void base_convert_short_float(float *out, const short *in, int len)
 	for (int i = 0; i < len; i++)
 		out[i] = in[i];
 }
-

Transceiver52M/arch/common/convolve.h

@@ -1,31 +1,27 @@
 #ifndef _CONVOLVE_H_
 #define _CONVOLVE_H_
 
-void *convolve_h_alloc(int num);
+void *convolve_h_alloc(size_t num);
 
 int convolve_real(const float *x, int x_len,
 		  const float *h, int h_len,
 		  float *y, int y_len,
-		  int start, int len,
-		  int step, int offset);
+		  int start, int len);
 
 int convolve_complex(const float *x, int x_len,
 		     const float *h, int h_len,
 		     float *y, int y_len,
-		     int start, int len,
-		     int step, int offset);
+		     int start, int len);
 
 int base_convolve_real(const float *x, int x_len,
 		       const float *h, int h_len,
 		       float *y, int y_len,
-		       int start, int len,
-		       int step, int offset);
+		       int start, int len);
 
 int base_convolve_complex(const float *x, int x_len,
 			  const float *h, int h_len,
 			  float *y, int y_len,
-			  int start, int len,
-			  int step, int offset);
+			  int start, int len);
 
 void convolve_init(void);
 

Transceiver52M/arch/common/convolve_base.c

@@ -2,6 +2,8 @@
  * Convolution
  * Copyright (C) 2012, 2013 Thomas Tsou <tom@tsou.cc>
  *
+ * SPDX-License-Identifier: LGPL-2.1+
+ *
  * 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
@@ -41,17 +43,17 @@ static void mac_cmplx(const float *x, const float *h, float *y)
 
 /* Base vector complex-complex multiply and accumulate */
 static void mac_real_vec_n(const float *x, const float *h, float *y,
-			   int len, int step, int offset)
+			   int len)
 {
-	for (int i = offset; i < len; i += step)
+	for (int i=0; i<len; i++)
 		mac_real(&x[2 * i], &h[2 * i], y);
 }
 
 /* Base vector complex-complex multiply and accumulate */
 static void mac_cmplx_vec_n(const float *x, const float *h, float *y,
-			    int len, int step, int offset)
+			    int len)
 {
-	for (int i = offset; i < len; i += step)
+	for (int i=0; i<len; i++)
 		mac_cmplx(&x[2 * i], &h[2 * i], y);
 }
 
@@ -59,14 +61,12 @@ static void mac_cmplx_vec_n(const float *x, const float *h, float *y,
 int _base_convolve_real(const float *x, int x_len,
 			const float *h, int h_len,
 			float *y, int y_len,
-			int start, int len,
-			int step, int offset)
+			int start, int len)
 {
 	for (int i = 0; i < len; i++) {
 		mac_real_vec_n(&x[2 * (i - (h_len - 1) + start)],
 			       h,
-			       &y[2 * i], h_len,
-			       step, offset);
+			       &y[2 * i], h_len);
 	}
 
 	return len;
@@ -76,14 +76,13 @@ int _base_convolve_real(const float *x, int x_len,
 int _base_convolve_complex(const float *x, int x_len,
 			   const float *h, int h_len,
 			   float *y, int y_len,
-			   int start, int len,
-			   int step, int offset)
+			   int start, int len)
 {
 	for (int i = 0; i < len; i++) {
 		mac_cmplx_vec_n(&x[2 * (i - (h_len - 1) + start)],
 				h,
 				&y[2 * i],
-				h_len, step, offset);
+				h_len);
 	}
 
 	return len;
@@ -91,10 +90,10 @@ int _base_convolve_complex(const float *x, int x_len,
 
 /* Buffer validity checks */
 int bounds_check(int x_len, int h_len, int y_len,
-		 int start, int len, int step)
+		 int start, int len)
 {
 	if ((x_len < 1) || (h_len < 1) ||
-	    (y_len < 1) || (len < 1) || (step < 1)) {
+	    (y_len < 1) || (len < 1)) {
 		fprintf(stderr, "Convolve: Invalid input\n");
 		return -1;
 	}
@@ -113,10 +112,9 @@ int bounds_check(int x_len, int h_len, int y_len,
 int base_convolve_real(const float *x, int x_len,
 		       const float *h, int h_len,
 		       float *y, int y_len,
-		       int start, int len,
-		       int step, int offset)
+		       int start, int len)
 {
-	if (bounds_check(x_len, h_len, y_len, start, len, step) < 0)
+	if (bounds_check(x_len, h_len, y_len, start, len) < 0)
 		return -1;
 
 	memset(y, 0, len * 2 * sizeof(float));
@@ -124,17 +122,16 @@ int base_convolve_real(const float *x, int x_len,
 	return _base_convolve_real(x, x_len,
 				   h, h_len,
 				   y, y_len,
-				   start, len, step, offset);
+				   start, len);
 }
 
 /* API: Non-aligned (no SSE) complex-complex */
 int base_convolve_complex(const float *x, int x_len,
 			  const float *h, int h_len,
 			  float *y, int y_len,
-			  int start, int len,
-			  int step, int offset)
+			  int start, int len)
 {
-	if (bounds_check(x_len, h_len, y_len, start, len, step) < 0)
+	if (bounds_check(x_len, h_len, y_len, start, len) < 0)
 		return -1;
 
 	memset(y, 0, len * 2 * sizeof(float));
@@ -142,11 +139,11 @@ int base_convolve_complex(const float *x, int x_len,
 	return _base_convolve_complex(x, x_len,
 				      h, h_len,
 				      y, y_len,
-				      start, len, step, offset);
+				      start, len);
 }
 
 /* Aligned filter tap allocation */
-void *convolve_h_alloc(int len)
+void *convolve_h_alloc(size_t len)
 {
 #ifdef HAVE_SSE3
 	return memalign(16, len * 2 * sizeof(float));

Transceiver52M/arch/common/fft.c

@@ -1,18 +1,20 @@
 /*
- * Fast Fourier transform 
+ * Fast Fourier transform
  *
  * Copyright (C) 2012 Tom Tsou <tom@tsou.cc>
- * 
+ *
+ * SPDX-License-Identifier: LGPL-2.1+
+ *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
- * 
+ *
  * This program 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 Affero General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU Affero General Public License
  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  * See the COPYING file in the main directory for details.
@@ -32,9 +34,9 @@ struct fft_hdl {
 	fftwf_plan fft_plan;
 };
 
-/*! \brief Initialize FFT backend 
+/*! \brief Initialize FFT backend
  *  \param[in] reverse FFT direction
- *  \param[in] m FFT length 
+ *  \param[in] m FFT length
  *  \param[in] istride input stride count
  *  \param[in] ostride output stride count
  *  \param[in] in input buffer (FFTW aligned)
@@ -92,7 +94,7 @@ void fft_free(void *ptr)
 	free(ptr);
 }
 
-/*! \brief Free FFT backend resources 
+/*! \brief Free FFT backend resources
  */
 void free_fft(struct fft_hdl *hdl)
 {
@@ -101,7 +103,7 @@ void free_fft(struct fft_hdl *hdl)
 }
 
 /*! \brief Run multiple DFT operations with the initialized plan
- *  \param[in] hdl handle to an intitialized fft struct
+ *  \param[in] hdl handle to an initialized fft struct
  *
  * Input and output buffers are configured with init_fft().
  */

Transceiver52M/arch/x86/Makefile.am

@@ -1,11 +1,15 @@
-if !ARCH_ARM
 AM_CFLAGS = -Wall -std=gnu99 -I${srcdir}/../common
 
 noinst_LTLIBRARIES = libarch.la
 noinst_LTLIBRARIES += libarch_sse_3.la
 noinst_LTLIBRARIES += libarch_sse_4_1.la
 
-libarch_la_LIBADD =
+noinst_HEADERS = \
+	convert_sse_3.h \
+	convert_sse_4_1.h \
+	convolve_sse_3.h
+
+libarch_la_LIBADD = $(top_builddir)/Transceiver52M/arch/common/libarch_common.la
 
 # SSE 3 specific code
 if HAVE_SSE3
@@ -25,8 +29,5 @@ libarch_la_LIBADD += libarch_sse_4_1.la
 endif
 
 libarch_la_SOURCES = \
-	../common/convolve_base.c \
-	../common/convert_base.c \
 	convert.c \
 	convolve.c
-endif

Transceiver52M/arch/x86/convert.c

@@ -27,7 +27,7 @@
 #include "config.h"
 #endif
 
-/* Architecture dependant function pointers */
+/* Architecture dependent function pointers */
 struct convert_cpu_context {
 	void (*convert_si16_ps_16n) (float *, const short *, int);
 	void (*convert_si16_ps) (float *, const short *, int);

Transceiver52M/arch/x86/convolve.c

@@ -27,28 +27,28 @@
 #include "config.h"
 #endif
 
-/* Architecture dependant function pointers */
+/* Architecture dependent function pointers */
 struct convolve_cpu_context {
 	void (*conv_cmplx_4n) (const float *, int, const float *, int, float *,
-			       int, int, int, int, int);
+			       int, int, int);
 	void (*conv_cmplx_8n) (const float *, int, const float *, int, float *,
-			       int, int, int, int, int);
+			       int, int, int);
 	void (*conv_cmplx) (const float *, int, const float *, int, float *,
-			    int, int, int, int, int);
+			    int, int, int);
 	void (*conv_real4) (const float *, int, const float *, int, float *,
-			    int, int, int, int, int);
+			    int, int, int);
 	void (*conv_real8) (const float *, int, const float *, int, float *,
-			    int, int, int, int, int);
+			    int, int, int);
 	void (*conv_real12) (const float *, int, const float *, int, float *,
-			     int, int, int, int, int);
+			     int, int, int);
 	void (*conv_real16) (const float *, int, const float *, int, float *,
-			     int, int, int, int, int);
+			     int, int, int);
 	void (*conv_real20) (const float *, int, const float *, int, float *,
-			     int, int, int, int, int);
+			     int, int, int);
 	void (*conv_real4n) (const float *, int, const float *, int, float *,
-			     int, int, int, int, int);
+			     int, int, int);
 	void (*conv_real) (const float *, int, const float *, int, float *, int,
-			   int, int, int, int);
+			   int, int);
 };
 static struct convolve_cpu_context c;
 
@@ -56,19 +56,17 @@ static struct convolve_cpu_context c;
 int _base_convolve_real(const float *x, int x_len,
 			const float *h, int h_len,
 			float *y, int y_len,
-			int start, int len,
-			int step, int offset);
+			int start, int len);
 
 int _base_convolve_complex(const float *x, int x_len,
 			   const float *h, int h_len,
 			   float *y, int y_len,
-			   int start, int len,
-			   int step, int offset);
+			   int start, int len);
 
 int bounds_check(int x_len, int h_len, int y_len,
-		 int start, int len, int step);
+		 int start, int len);
 
-/* API: Initalize convolve module */
+/* API: Initialize convolve module */
 void convolve_init(void)
 {
 	c.conv_cmplx_4n = (void *)_base_convolve_complex;
@@ -99,46 +97,37 @@ void convolve_init(void)
 /* API: Aligned complex-real */
 int convolve_real(const float *x, int x_len,
 		  const float *h, int h_len,
-		  float *y, int y_len, int start, int len, int step, int offset)
+		  float *y, int y_len, int start, int len)
 {
-	if (bounds_check(x_len, h_len, y_len, start, len, step) < 0)
+	if (bounds_check(x_len, h_len, y_len, start, len) < 0)
 		return -1;
 
 	memset(y, 0, len * 2 * sizeof(float));
 
-	if (step <= 4) {
-		switch (h_len) {
-		case 4:
-			c.conv_real4(x, x_len, h, h_len, y, y_len, start, len,
-				     step, offset);
-			break;
-		case 8:
-			c.conv_real8(x, x_len, h, h_len, y, y_len, start, len,
-				     step, offset);
-			break;
-		case 12:
-			c.conv_real12(x, x_len, h, h_len, y, y_len, start, len,
-				      step, offset);
-			break;
-		case 16:
-			c.conv_real16(x, x_len, h, h_len, y, y_len, start, len,
-				      step, offset);
-			break;
-		case 20:
-			c.conv_real20(x, x_len, h, h_len, y, y_len, start, len,
-				      step, offset);
-			break;
-		default:
-			if (!(h_len % 4))
-				c.conv_real4n(x, x_len, h, h_len, y, y_len,
-					      start, len, step, offset);
-			else
-				c.conv_real(x, x_len, h, h_len, y, y_len, start,
-					    len, step, offset);
-		}
-	} else
-		c.conv_real(x, x_len, h, h_len, y, y_len, start, len, step,
-			    offset);
+	switch (h_len) {
+	case 4:
+		c.conv_real4(x, x_len, h, h_len, y, y_len, start, len);
+		break;
+	case 8:
+		c.conv_real8(x, x_len, h, h_len, y, y_len, start, len);
+		break;
+	case 12:
+		c.conv_real12(x, x_len, h, h_len, y, y_len, start, len);
+		break;
+	case 16:
+		c.conv_real16(x, x_len, h, h_len, y, y_len, start, len);
+		break;
+	case 20:
+		c.conv_real20(x, x_len, h, h_len, y, y_len, start, len);
+		break;
+	default:
+		if (!(h_len % 4))
+			c.conv_real4n(x, x_len, h, h_len, y, y_len,
+				      start, len);
+		else
+			c.conv_real(x, x_len, h, h_len, y, y_len, start,
+				    len);
+	}
 
 	return len;
 }
@@ -147,26 +136,19 @@ int convolve_real(const float *x, int x_len,
 int convolve_complex(const float *x, int x_len,
 		     const float *h, int h_len,
 		     float *y, int y_len,
-		     int start, int len, int step, int offset)
+		     int start, int len)
 {
-	if (bounds_check(x_len, h_len, y_len, start, len, step) < 0)
+	if (bounds_check(x_len, h_len, y_len, start, len) < 0)
 		return -1;
 
 	memset(y, 0, len * 2 * sizeof(float));
 
-	if (step <= 4) {
-		if (!(h_len % 8))
-			c.conv_cmplx_8n(x, x_len, h, h_len, y, y_len, start,
-					len, step, offset);
-		else if (!(h_len % 4))
-			c.conv_cmplx_4n(x, x_len, h, h_len, y, y_len, start,
-					len, step, offset);
-		else
-			c.conv_cmplx(x, x_len, h, h_len, y, y_len, start, len,
-				     step, offset);
-	} else
-		c.conv_cmplx(x, x_len, h, h_len, y, y_len, start, len, step,
-			     offset);
+	if (!(h_len % 8))
+		c.conv_cmplx_8n(x, x_len, h, h_len, y, y_len, start, len);
+	else if (!(h_len % 4))
+		c.conv_cmplx_4n(x, x_len, h, h_len, y, y_len, start, len);
+	else
+		c.conv_cmplx(x, x_len, h, h_len, y, y_len, start, len);
 
 	return len;
 }

Transceiver52M/arch/x86/convolve_sse_3.c

@@ -34,12 +34,12 @@
 void sse_conv_real4(const float *x, int x_len,
 		    const float *h, int h_len,
 		    float *y, int y_len,
-		    int start, int len, int step, int offset)
+		    int start, int len)
 {
 	/* NOTE: The parameter list of this function has to match the parameter
 	 * list of _base_convolve_real() in convolve_base.c. This specific
 	 * implementation, ignores some of the parameters of
-	 * _base_convolve_complex(), which are: x_len, y_len, offset, step */
+	 * _base_convolve_complex(), which are: x_len, y_len. */
 
 	__m128 m0, m1, m2, m3, m4, m5, m6, m7;
 
@@ -75,7 +75,7 @@ void sse_conv_real4(const float *x, int x_len,
 void sse_conv_real8(const float *x, int x_len,
 		    const float *h, int h_len,
 		    float *y, int y_len,
-		    int start, int len, int step, int offset)
+		    int start, int len)
 {
 	/* See NOTE in sse_conv_real4() */
 
@@ -126,7 +126,7 @@ void sse_conv_real8(const float *x, int x_len,
 void sse_conv_real12(const float *x, int x_len,
 		     const float *h, int h_len,
 		     float *y, int y_len,
-		     int start, int len, int step, int offset)
+		     int start, int len)
 {
 	/* See NOTE in sse_conv_real4() */
 
@@ -192,7 +192,7 @@ void sse_conv_real12(const float *x, int x_len,
 void sse_conv_real16(const float *x, int x_len,
 		     const float *h, int h_len,
 		     float *y, int y_len,
-		     int start, int len, int step, int offset)
+		     int start, int len)
 {
 	/* See NOTE in sse_conv_real4() */
 
@@ -271,7 +271,7 @@ void sse_conv_real16(const float *x, int x_len,
 void sse_conv_real20(const float *x, int x_len,
 		     const float *h, int h_len,
 		     float *y, int y_len,
-		     int start, int len, int step, int offset)
+		     int start, int len)
 {
 	/* See NOTE in sse_conv_real4() */
 
@@ -361,7 +361,7 @@ void sse_conv_real20(const float *x, int x_len,
 void sse_conv_real4n(const float *x, int x_len,
 		     const float *h, int h_len,
 		     float *y, int y_len,
-		     int start, int len, int step, int offset)
+		     int start, int len)
 {
 	/* See NOTE in sse_conv_real4() */
 
@@ -408,12 +408,12 @@ void sse_conv_real4n(const float *x, int x_len,
 void sse_conv_cmplx_4n(const float *x, int x_len,
 		       const float *h, int h_len,
 		       float *y, int y_len,
-		       int start, int len, int step, int offset)
+		       int start, int len)
 {
 	/* NOTE: The parameter list of this function has to match the parameter
 	 * list of _base_convolve_complex() in convolve_base.c. This specific
 	 * implementation, ignores some of the parameters of
-	 * _base_convolve_complex(), which are: x_len, y_len, offset, step. */
+	 * _base_convolve_complex(), which are: x_len, y_len. */
 
 	__m128 m0, m1, m2, m3, m4, m5, m6, m7;
 
@@ -466,7 +466,7 @@ void sse_conv_cmplx_4n(const float *x, int x_len,
 void sse_conv_cmplx_8n(const float *x, int x_len,
 		       const float *h, int h_len,
 		       float *y, int y_len,
-		       int start, int len, int step, int offset)
+		       int start, int len)
 {
 	/* See NOTE in sse_conv_cmplx_4n() */
 

Transceiver52M/arch/x86/convolve_sse_3.h

@@ -23,46 +23,46 @@
 void sse_conv_real4(const float *x, int x_len,
 		    const float *h, int h_len,
 		    float *y, int y_len,
-		    int start, int len, int step, int offset);
+		    int start, int len);
 
 /* 8-tap SSE complex-real convolution */
 void sse_conv_real8(const float *x, int x_len,
 		    const float *h, int h_len,
 		    float *y, int y_len,
-		    int start, int len, int step, int offset);
+		    int start, int len);
 
 /* 12-tap SSE complex-real convolution */
 void sse_conv_real12(const float *x, int x_len,
 		     const float *h, int h_len,
 		     float *y, int y_len,
-		     int start, int len, int step, int offset);
+		     int start, int len);
 
 /* 16-tap SSE complex-real convolution */
 void sse_conv_real16(const float *x, int x_len,
 		     const float *h, int h_len,
 		     float *y, int y_len,
-		     int start, int len, int step, int offset);
+		     int start, int len);
 
 /* 20-tap SSE complex-real convolution */
 void sse_conv_real20(const float *x, int x_len,
 		     const float *h, int h_len,
 		     float *y, int y_len,
-		     int start, int len, int step, int offset);
+		     int start, int len);
 
 /* 4*N-tap SSE complex-real convolution */
 void sse_conv_real4n(const float *x, int x_len,
 		     const float *h, int h_len,
 		     float *y, int y_len,
-		     int start, int len, int step, int offset);
+		     int start, int len);
 
 /* 4*N-tap SSE complex-complex convolution */
 void sse_conv_cmplx_4n(const float *x, int x_len,
 		       const float *h, int h_len,
 		       float *y, int y_len,
-		       int start, int len, int step, int offset);
+		       int start, int len);
 
 /* 8*N-tap SSE complex-complex convolution */
 void sse_conv_cmplx_8n(const float *x, int x_len,
 		       const float *h, int h_len,
 		       float *y, int y_len,
-		       int start, int len, int step, int offset);
+		       int start, int len);

Transceiver52M/device/Makefile.am

@@ -0,0 +1,15 @@
+include $(top_srcdir)/Makefile.common
+
+SUBDIRS = common
+
+if DEVICE_USRP1
+SUBDIRS += usrp1
+endif
+
+if DEVICE_UHD
+SUBDIRS += uhd
+endif
+
+if DEVICE_LMS
+SUBDIRS += lms
+endif

Transceiver52M/device/common/Makefile.am

@@ -0,0 +1,12 @@
+include $(top_srcdir)/Makefile.common
+
+AM_CPPFLAGS = -Wall $(STD_DEFINES_AND_INCLUDES)
+AM_CXXFLAGS = -lpthread $(LIBOSMOCORE_CFLAGS) $(LIBOSMOCTRL_CFLAGS) $(LIBOSMOVTY_CFLAGS) $(LMS_CFLAGS)
+
+
+noinst_HEADERS = radioDevice.h smpl_buf.h
+
+noinst_LTLIBRARIES = libdevice_common.la
+
+libdevice_common_la_SOURCES = \
+	smpl_buf.cpp

Transceiver52M/device/common/radioDevice.h

@@ -1,7 +1,7 @@
 /*
 * Copyright 2008 Free Software Foundation, Inc.
 *
-* This software is distributed under multiple licenses; see the COPYING file in the main directory for licensing information for this specific distribuion.
+* This software is distributed under multiple licenses; see the COPYING file in the main directory for licensing information for this specific distribution.
 *
 * This use of this software may be subject to additional restrictions.
 * See the LEGAL file in the main directory for details.
@@ -18,6 +18,14 @@
 #include <string>
 #include <vector>
 
+#include "GSMCommon.h"
+#include "Logger.h"
+
+extern "C" {
+#include "config_defs.h"
+#include "osmo_signal.h"
+}
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
@@ -33,7 +41,7 @@ class RadioDevice {
 
   public:
   /* Available transport bus types */
-  enum TxWindowType { TX_WINDOW_USRP1, TX_WINDOW_FIXED };
+  enum TxWindowType { TX_WINDOW_USRP1, TX_WINDOW_FIXED, TX_WINDOW_LMS1 };
 
   /* Radio interface types */
   enum InterfaceType {
@@ -43,14 +51,10 @@ class RadioDevice {
     MULTI_ARFCN,
   };
 
-  enum ReferenceType {
-    REF_INTERNAL,
-    REF_EXTERNAL,
-    REF_GPS,
-  };
-
   static RadioDevice *make(size_t tx_sps, size_t rx_sps, InterfaceType type,
-                           size_t chans = 1, double offset = 0.0);
+                           size_t chans = 1, double offset = 0.0,
+                           const std::vector<std::string>& tx_paths = std::vector<std::string>(1, ""),
+                           const std::vector<std::string>& rx_paths = std::vector<std::string>(1, ""));
 
   /** Initialize the USRP */
   virtual int open(const std::string &args, int ref, bool swap_channels)=0;
@@ -66,9 +70,6 @@ class RadioDevice {
   /** Get the Tx window type */
   virtual enum TxWindowType getWindowType()=0;
 
-  /** Enable thread priority */
-  virtual void setPriority(float prio = 0.5) = 0;
-
   /**
 	Read samples from the radio.
 	@param buf preallocated buf to contain read result
@@ -76,23 +77,20 @@ class RadioDevice {
 	@param overrun Set if read buffer has been overrun, e.g. data not being read fast enough
 	@param timestamp The timestamp of the first samples to be read
 	@param underrun Set if radio does not have data to transmit, e.g. data not being sent fast enough
-	@param RSSI The received signal strength of the read result
 	@return The number of samples actually read
   */
   virtual int readSamples(std::vector<short *> &bufs, int len, bool *overrun,
-                          TIMESTAMP timestamp = 0xffffffff, bool *underrun = 0,
-                          unsigned *RSSI = 0) = 0;
+                          TIMESTAMP timestamp = 0xffffffff, bool *underrun = 0) = 0;
   /**
         Write samples to the radio.
         @param buf Contains the data to be written.
         @param len number of samples to write.
         @param underrun Set if radio does not have data to transmit, e.g. data not being sent fast enough
         @param timestamp The timestamp of the first sample of the data buffer.
-        @param isControl Set if data is a control packet, e.g. a ping command
         @return The number of samples actually written
   */
   virtual int writeSamples(std::vector<short *> &bufs, int len, bool *underrun,
-                           TIMESTAMP timestamp, bool isControl = false) = 0;
+                           TIMESTAMP timestamp) = 0;
 
   /** Update the alignment between the read and write timestamps */
   virtual bool updateAlignment(TIMESTAMP timestamp)=0;
@@ -130,18 +128,90 @@ class RadioDevice {
   /** sets the transmit chan gain, returns the gain setting **/
   virtual double setTxGain(double dB, size_t chan = 0) = 0;
 
+  /** get transmit gain */
+  virtual double getTxGain(size_t chan = 0) = 0;
+
   /** return maximum Tx Gain **/
   virtual double maxTxGain(void) = 0;
 
   /** return minimum Tx Gain **/
   virtual double minTxGain(void) = 0;
 
+  /** sets the RX path to use, returns true if successful and false otherwise */
+  virtual bool setRxAntenna(const std::string &ant, size_t chan = 0) = 0;
+
+  /** return the used RX path */
+  virtual std::string getRxAntenna(size_t chan = 0) = 0;
+
+  /** sets the RX path to use, returns true if successful and false otherwise */
+  virtual bool setTxAntenna(const std::string &ant, size_t chan = 0) = 0;
+
+  /** return the used RX path */
+  virtual std::string getTxAntenna(size_t chan = 0) = 0;
+
+  /** return whether user drives synchronization of Tx/Rx of USRP */
+  virtual bool requiresRadioAlign() = 0;
+
+  /** Minimum latency that the device can achieve */
+  virtual GSM::Time minLatency() = 0;
+
   /** Return internal status values */
   virtual double getTxFreq(size_t chan = 0) = 0;
   virtual double getRxFreq(size_t chan = 0) = 0;
   virtual double getSampleRate()=0;
-  virtual double numberRead()=0;
-  virtual double numberWritten()=0;
+
+  protected:
+  size_t tx_sps, rx_sps;
+  InterfaceType iface;
+  size_t chans;
+  double lo_offset;
+  std::vector<std::string> tx_paths, rx_paths;
+  std::vector<struct device_counters> m_ctr;
+
+  RadioDevice(size_t tx_sps, size_t rx_sps, InterfaceType type, size_t chan_num, double offset,
+              const std::vector<std::string>& tx_paths,
+              const std::vector<std::string>& rx_paths):
+		tx_sps(tx_sps), rx_sps(rx_sps), iface(type), chans(chan_num), lo_offset(offset),
+		tx_paths(tx_paths), rx_paths(rx_paths)
+	{
+		if (iface == MULTI_ARFCN) {
+			LOGC(DDEV, INFO) << "Multi-ARFCN: "<< chan_num << " logical chans -> 1 physical chans";
+			chans = 1;
+		}
+
+		m_ctr.resize(chans);
+		for (size_t i = 0; i < chans; i++) {
+			memset(&m_ctr[i], 0, sizeof(m_ctr[i]));
+			m_ctr[i].chan = i;
+		}
+	}
+
+  bool set_antennas() {
+	unsigned int i;
+
+	for (i = 0; i < tx_paths.size(); i++) {
+		if (tx_paths[i] == "")
+			continue;
+		LOGCHAN(i, DDEV, DEBUG) << "Configuring Tx antenna " << tx_paths[i];
+		if (!setTxAntenna(tx_paths[i], i)) {
+			LOGCHAN(i, DDEV, ALERT) << "Failed configuring Tx antenna " << tx_paths[i];
+			return false;
+		}
+	}
+
+	for (i = 0; i < rx_paths.size(); i++) {
+		if (rx_paths[i] == "")
+			continue;
+		LOGCHAN(i, DDEV, DEBUG) << "Configuring Rx antenna " << rx_paths[i];
+		if (!setRxAntenna(rx_paths[i], i)) {
+			LOGCHAN(i, DDEV, ALERT) << "Failed configuring Rx antenna " << rx_paths[i];
+			return false;
+		}
+	}
+	LOG(INFO) << "Antennas configured successfully";
+	return true;
+  }
+
 
 };
 

Transceiver52M/device/common/smpl_buf.cpp

@@ -0,0 +1,173 @@
+/*
+ * Sample Buffer - Allows reading and writing of timed samples
+ *
+ * Copyright 2010,2011 Free Software Foundation, Inc.
+ * Copyright (C) 2015 Ettus Research LLC
+ * Copyright 2019 sysmocom - s.f.m.c. GmbH <info@sysmocom.de>
+ *
+ * Author: Tom Tsou <tom.tsou@ettus.com>
+ *
+ * SPDX-License-Identifier: AGPL-3.0+
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * See the COPYING file in the main directory for details.
+ */
+
+#include "smpl_buf.h"
+#include <inttypes.h>
+
+smpl_buf::smpl_buf(size_t len)
+	: buf_len(len), time_start(0), time_end(0),
+	  data_start(0), data_end(0)
+{
+	data = new uint32_t[len];
+}
+
+smpl_buf::~smpl_buf()
+{
+	delete[] data;
+}
+
+ssize_t smpl_buf::avail_smpls(TIMESTAMP timestamp) const
+{
+	if (timestamp < time_start)
+		return ERROR_TIMESTAMP;
+	else if (timestamp >= time_end)
+		return 0;
+	else
+		return time_end - timestamp;
+}
+
+ssize_t smpl_buf::read(void *buf, size_t len, TIMESTAMP timestamp)
+{
+	int type_sz = 2 * sizeof(short);
+
+	// Check for valid read
+	if (timestamp < time_start)
+		return ERROR_TIMESTAMP;
+	if (timestamp >= time_end)
+		return 0;
+	if (len >= buf_len)
+		return ERROR_READ;
+
+	// How many samples should be copied
+	size_t num_smpls = time_end - timestamp;
+	if (num_smpls > len)
+		num_smpls = len;
+
+	// Starting index
+	size_t read_start = (data_start + (timestamp - time_start)) % buf_len;
+
+	// Read it
+	if (read_start + num_smpls < buf_len) {
+		size_t numBytes = len * type_sz;
+		memcpy(buf, data + read_start, numBytes);
+	} else {
+		size_t first_cp = (buf_len - read_start) * type_sz;
+		size_t second_cp = len * type_sz - first_cp;
+
+		memcpy(buf, data + read_start, first_cp);
+		memcpy((char*) buf + first_cp, data, second_cp);
+	}
+
+	data_start = (read_start + len) % buf_len;
+	time_start = timestamp + len;
+
+	if (time_start > time_end)
+		return ERROR_READ;
+	else
+		return num_smpls;
+}
+
+ssize_t smpl_buf::write(void *buf, size_t len, TIMESTAMP timestamp)
+{
+	int type_sz = 2 * sizeof(short);
+
+	// Check for valid write
+	if ((len == 0) || (len >= buf_len))
+		return ERROR_WRITE;
+	if ((timestamp + len) <= time_end)
+		return ERROR_TIMESTAMP;
+
+	if (timestamp < time_end) {
+		LOGC(DDEV, ERR) << "Overwriting old buffer data: timestamp="
+				<< timestamp << " time_end=" << time_end;
+		// Do not return error here, because it's a rounding error and is not fatal
+	}
+	if (timestamp > time_end && time_end != 0) {
+		LOGC(DDEV, ERR) << "Skipping buffer data: timestamp="
+				<< timestamp << " time_end=" << time_end;
+		// Do not return error here, because it's a rounding error and is not fatal
+	}
+
+	// Starting index
+	size_t write_start = (data_start + (timestamp - time_start)) % buf_len;
+
+	// Write it
+	if ((write_start + len) < buf_len) {
+		size_t numBytes = len * type_sz;
+		memcpy(data + write_start, buf, numBytes);
+	} else {
+		size_t first_cp = (buf_len - write_start) * type_sz;
+		size_t second_cp = len * type_sz - first_cp;
+
+		memcpy(data + write_start, buf, first_cp);
+		memcpy(data, (char*) buf + first_cp, second_cp);
+	}
+
+	data_end = (write_start + len) % buf_len;
+	time_end = timestamp + len;
+
+	if (!data_start)
+		data_start = write_start;
+
+	if (((write_start + len) > buf_len) && (data_end > data_start))
+		return ERROR_OVERFLOW;
+	else if (time_end <= time_start)
+		return ERROR_WRITE;
+	else
+		return len;
+}
+
+std::string smpl_buf::str_status(TIMESTAMP timestamp) const
+{
+	std::ostringstream ost("Sample buffer: ");
+
+	ost << "timestamp = " << timestamp;
+	ost << ", length = " << buf_len;
+	ost << ", time_start = " << time_start;
+	ost << ", time_end = " << time_end;
+	ost << ", data_start = " << data_start;
+	ost << ", data_end = " << data_end;
+
+	return ost.str();
+}
+
+std::string smpl_buf::str_code(int code)
+{
+	switch (code) {
+	case ERROR_TIMESTAMP:
+		return "Sample buffer: Requested timestamp is not valid";
+	case ERROR_READ:
+		return "Sample buffer: Read error";
+	case ERROR_WRITE:
+		return "Sample buffer: Write error";
+	case ERROR_OVERFLOW:
+		return "Sample buffer: Overrun";
+	default:
+		std::stringstream ss;
+		ss << "Sample buffer: Unknown error " << code;
+		return ss.str();
+	}
+}

Transceiver52M/device/common/smpl_buf.h

@@ -0,0 +1,89 @@
+/*
+ * Sample Buffer - Allows reading and writing of timed samples
+ *
+ * Copyright 2010,2011 Free Software Foundation, Inc.
+ * Copyright (C) 2015 Ettus Research LLC
+ * Copyright 2019 sysmocom - s.f.m.c. GmbH <info@sysmocom.de>
+ *
+ * Author: Tom Tsou <tom.tsou@ettus.com>
+ *
+ * SPDX-License-Identifier: AGPL-3.0+
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * See the COPYING file in the main directory for details.
+ */
+
+#pragma once
+
+#include <unistd.h>
+
+#include "radioDevice.h"
+
+/*
+    Sample Buffer - Allows reading and writing of timed samples using osmo-trx
+                    timestamps. Time conversions are handled
+                    internally or accessible through the static convert calls.
+*/
+class smpl_buf {
+public:
+	/** Sample buffer constructor
+	    @param len number of 32-bit samples the buffer should hold
+	    @param timestamp
+	*/
+	smpl_buf(size_t len);
+	~smpl_buf();
+
+	/** Query number of samples available for reading
+	    @param timestamp time of first sample
+	    @return number of available samples or error
+	*/
+	ssize_t avail_smpls(TIMESTAMP timestamp) const;
+
+	/** Read and write
+	    @param buf pointer to buffer
+	    @param len number of samples desired to read or write
+	    @param timestamp time of first stample
+	    @return number of actual samples read or written or error
+	*/
+	ssize_t read(void *buf, size_t len, TIMESTAMP timestamp);
+	ssize_t write(void *buf, size_t len, TIMESTAMP timestamp);
+
+	/** Buffer status string
+	    @return a formatted string describing internal buffer state
+	*/
+	std::string str_status(TIMESTAMP timestamp) const;
+
+	/** Formatted error string
+	    @param code an error code
+	    @return a formatted error string
+	*/
+	static std::string str_code(int code);
+
+	enum err_code {
+		ERROR_TIMESTAMP = -1,
+		ERROR_READ = -2,
+		ERROR_WRITE = -3,
+		ERROR_OVERFLOW = -4
+	};
+
+private:
+	uint32_t *data;
+	size_t buf_len;
+
+	TIMESTAMP time_start;
+	TIMESTAMP time_end;
+
+	size_t data_start;
+	size_t data_end;
+};

Transceiver52M/device/lms/LMSDevice.cpp

@@ -0,0 +1,935 @@
+/*
+* Copyright 2018 sysmocom - s.f.m.c. GmbH
+*
+* SPDX-License-Identifier: AGPL-3.0+
+*
+	This program is free software: you can redistribute it and/or modify
+	it under the terms of the GNU Affero General Public License as published by
+	the Free Software Foundation, either version 3 of the License, or
+	(at your option) any later version.
+
+	This program 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 Affero General Public License for more details.
+
+	You should have received a copy of the GNU Affero General Public License
+	along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#include <stdint.h>
+#include <string.h>
+#include <stdlib.h>
+
+#include <map>
+
+#include "trx_vty.h"
+#include "Logger.h"
+#include "Threads.h"
+#include "LMSDevice.h"
+#include "Utils.h"
+
+#include <lime/LimeSuite.h>
+
+extern "C" {
+#include "osmo_signal.h"
+#include <osmocom/core/utils.h>
+}
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+using namespace std;
+
+#define MAX_ANTENNA_LIST_SIZE 10
+#define GSM_CARRIER_BW 270000.0 /* 270kHz */
+#define LMS_MIN_BW_SUPPORTED 2.5e6 /* 2.5mHz, minimum supported by LMS */
+#define LMS_CALIBRATE_BW_HZ OSMO_MAX(GSM_CARRIER_BW, LMS_MIN_BW_SUPPORTED)
+#define SAMPLE_BUF_SZ    (1 << 20) /* Size of Rx timestamp based Ring buffer, in bytes */
+
+
+/* Device Name Prefixes as presented by LimeSuite API LMS_GetDeviceInfo(): */
+#define LMS_DEV_SDR_USB_PREFIX_NAME "LimeSDR-USB"
+#define LMS_DEV_SDR_MINI_PREFIX_NAME "LimeSDR-Mini"
+#define LMS_DEV_NET_MICRO_PREFIX_NAME "LimeNET-Micro"
+
+/* Device parameter descriptor */
+struct dev_desc {
+	/* Does LimeSuite allow switching the clock source for this device?
+	 * LimeSDR-Mini does not have switches but needs soldering to select
+	 * external/internal clock. Any call to LMS_SetClockFreq() will fail.
+	 */
+	bool clock_src_switchable;
+	/* Does LimeSuite allow using REF_INTERNAL for this device?
+	 * LimeNET-Micro does not like selecting internal clock
+	 */
+	bool clock_src_int_usable;
+	/* Device specific maximum tx levels selected by phasenoise measurements, in dB */
+	double max_tx_gain;
+	/* Sample rate coef (without having TX/RX samples per symbol into account) */
+	double rate;
+	/* Sample rate coef (without having TX/RX samples per symbol into account), if multi-arfcn is enabled */
+	double rate_multiarfcn;
+	/* Coefficient multiplied by TX sample rate in order to shift Tx time */
+	double ts_offset_coef;
+	/* Coefficient multiplied by TX sample rate in order to shift Tx time, if multi-arfcn is enabled */
+	double ts_offset_coef_multiarfcn;
+	/* Device Name Prefix as presented by LimeSuite API LMS_GetDeviceInfo() */
+	std::string name_prefix;
+};
+
+static const std::map<enum lms_dev_type, struct dev_desc> dev_param_map {
+	{ LMS_DEV_SDR_USB,   { true,  true,  73.0, GSMRATE, MCBTS_SPACING, 8.9e-5, 7.9e-5, LMS_DEV_SDR_USB_PREFIX_NAME } },
+	{ LMS_DEV_SDR_MINI,  { false, true,  66.0, GSMRATE, MCBTS_SPACING, 8.9e-5, 8.2e-5, LMS_DEV_SDR_MINI_PREFIX_NAME } },
+	{ LMS_DEV_NET_MICRO, { true,  false, 71.0, GSMRATE, MCBTS_SPACING, 8.9e-5, 7.9e-5, LMS_DEV_NET_MICRO_PREFIX_NAME } },
+	{ LMS_DEV_UNKNOWN,   { true,  true,  73.0, GSMRATE, MCBTS_SPACING, 8.9e-5, 7.9e-5, "UNKNOWN" } },
+};
+
+static enum lms_dev_type parse_dev_type(lms_device_t *m_lms_dev)
+{
+	std::map<enum lms_dev_type, struct dev_desc>::const_iterator it = dev_param_map.begin();
+
+	const lms_dev_info_t* device_info = LMS_GetDeviceInfo(m_lms_dev);
+
+	while (it != dev_param_map.end())
+	{
+		enum lms_dev_type dev_type = it->first;
+		struct dev_desc desc = it->second;
+
+		if (strncmp(device_info->deviceName, desc.name_prefix.c_str(), desc.name_prefix.length()) == 0) {
+			LOGC(DDEV, INFO) << "Device identified as " << desc.name_prefix;
+			return dev_type;
+		}
+		it++;
+	}
+	return LMS_DEV_UNKNOWN;
+}
+
+LMSDevice::LMSDevice(size_t tx_sps, size_t rx_sps, InterfaceType iface, size_t chan_num, double lo_offset,
+		     const std::vector<std::string>& tx_paths,
+		     const std::vector<std::string>& rx_paths):
+	RadioDevice(tx_sps, rx_sps, iface, chan_num, lo_offset, tx_paths, rx_paths),
+	m_lms_dev(NULL), started(false), m_dev_type(LMS_DEV_UNKNOWN)
+{
+	LOGC(DDEV, INFO) << "creating LMS device...";
+
+	m_lms_stream_rx.resize(chans);
+	m_lms_stream_tx.resize(chans);
+	rx_gains.resize(chans);
+	tx_gains.resize(chans);
+
+	rx_buffers.resize(chans);
+
+	/* Set up per-channel Rx timestamp based Ring buffers */
+	for (size_t i = 0; i < rx_buffers.size(); i++)
+		rx_buffers[i] = new smpl_buf(SAMPLE_BUF_SZ / sizeof(uint32_t));
+
+}
+
+LMSDevice::~LMSDevice()
+{
+	unsigned int i;
+	LOGC(DDEV, INFO) << "Closing LMS device";
+	if (m_lms_dev) {
+		/* disable all channels */
+		for (i=0; i<chans; i++) {
+			LMS_EnableChannel(m_lms_dev, LMS_CH_RX, i, false);
+			LMS_EnableChannel(m_lms_dev, LMS_CH_TX, i, false);
+		}
+		LMS_Close(m_lms_dev);
+		m_lms_dev = NULL;
+	}
+
+	for (size_t i = 0; i < rx_buffers.size(); i++)
+		delete rx_buffers[i];
+}
+
+static void lms_log_callback(int lvl, const char *msg)
+{
+	/* map lime specific log levels */
+	static const int lvl_map[5] = {
+		[0] = LOGL_FATAL,
+		[LMS_LOG_ERROR] = LOGL_ERROR,
+		[LMS_LOG_WARNING] = LOGL_NOTICE,
+		[LMS_LOG_INFO] = LOGL_INFO,
+		[LMS_LOG_DEBUG] = LOGL_DEBUG,
+	};
+	/* protect against future higher log level values (lower importance) */
+	if ((unsigned int) lvl >= ARRAY_SIZE(lvl_map))
+		lvl = ARRAY_SIZE(lvl_map)-1;
+
+	LOGLV(DDEVDRV, lvl_map[lvl]) << msg;
+}
+
+static void print_range(const char* name, lms_range_t *range)
+{
+	LOGC(DDEV, INFO) << name << ": Min=" << range->min << " Max=" << range->max
+		   << " Step=" << range->step;
+}
+
+/*! Find the device string that matches all filters from \a args.
+ *  \param[in] info_list device addresses found by LMS_GetDeviceList()
+ *  \param[in] count length of info_list
+ *  \param[in] args dev-args value from osmo-trx.cfg, containing comma separated key=value pairs
+ *  \return index of first matching device or -1 (no match) */
+int info_list_find(lms_info_str_t* info_list, unsigned int count, const std::string &args)
+{
+	unsigned int i, j;
+	std::vector<string> filters;
+
+	filters = comma_delimited_to_vector(args.c_str());
+
+	/* iterate over device addresses */
+	for (i=0; i < count; i++) {
+		/* check if all filters match */
+		bool match = true;
+		for (j=0; j < filters.size(); j++) {
+			if (!strstr(info_list[i], filters[j].c_str())) {
+				match = false;
+				break;
+			}
+		}
+
+		if (match)
+			return i;
+	}
+	return -1;
+}
+
+int LMSDevice::open(const std::string &args, int ref, bool swap_channels)
+{
+	lms_info_str_t* info_list;
+	lms_range_t range_sr;
+	float_type sr_host, sr_rf;
+	unsigned int i, n;
+	int rc, dev_id;
+	struct dev_desc dev_desc;
+
+	LOGC(DDEV, INFO) << "Opening LMS device..";
+
+	LMS_RegisterLogHandler(&lms_log_callback);
+
+	if ((n = LMS_GetDeviceList(NULL)) < 0)
+		LOGC(DDEV, ERROR) << "LMS_GetDeviceList(NULL) failed";
+	LOGC(DDEV, INFO) << "Devices found: " << n;
+	if (n < 1)
+	    return -1;
+
+	info_list = new lms_info_str_t[n];
+
+	if (LMS_GetDeviceList(info_list) < 0)
+		LOGC(DDEV, ERROR) << "LMS_GetDeviceList(info_list) failed";
+
+	for (i = 0; i < n; i++)
+		LOGC(DDEV, INFO) << "Device [" << i << "]: " << info_list[i];
+
+	dev_id = info_list_find(info_list, n, args);
+	if (dev_id == -1) {
+		LOGC(DDEV, ERROR) << "No LMS device found with address '" << args << "'";
+		delete[] info_list;
+		return -1;
+	}
+
+	LOGC(DDEV, INFO) << "Using device[" << dev_id << "]";
+	rc = LMS_Open(&m_lms_dev, info_list[dev_id], NULL);
+	if (rc != 0) {
+		LOGC(DDEV, ERROR) << "LMS_GetDeviceList() failed)";
+		delete [] info_list;
+		return -1;
+	}
+
+	delete [] info_list;
+
+	m_dev_type = parse_dev_type(m_lms_dev);
+	dev_desc = dev_param_map.at(m_dev_type);
+
+	if ((ref != REF_EXTERNAL) && (ref != REF_INTERNAL)){
+		LOGC(DDEV, ERROR) << "Invalid reference type";
+		goto out_close;
+	}
+
+	/* if reference clock is external, setup must happen _before_ calling LMS_Init */
+	if (ref == REF_EXTERNAL) {
+		LOGC(DDEV, INFO) << "Setting External clock reference to 10MHz";
+		/* FIXME: Assume an external 10 MHz reference clock. make
+		   external reference frequency configurable */
+		if (!do_clock_src_freq(REF_EXTERNAL, 10000000.0))
+			goto out_close;
+	}
+
+	LOGC(DDEV, INFO) << "Init LMS device";
+	if (LMS_Init(m_lms_dev) != 0) {
+		LOGC(DDEV, ERROR) << "LMS_Init() failed";
+		goto out_close;
+	}
+
+	/* if reference clock is internal, setup must happen _after_ calling LMS_Init */
+	if (ref == REF_INTERNAL) {
+		LOGC(DDEV, INFO) << "Setting Internal clock reference";
+		/* Internal freq param is not used */
+		if (!do_clock_src_freq(REF_INTERNAL, 0))
+			goto out_close;
+	}
+
+	/* enable all used channels */
+	for (i=0; i<chans; i++) {
+		if (LMS_EnableChannel(m_lms_dev, LMS_CH_RX, i, true) < 0)
+			goto out_close;
+		if (LMS_EnableChannel(m_lms_dev, LMS_CH_TX, i, true) < 0)
+			goto out_close;
+	}
+
+	/* set samplerate */
+	if (LMS_GetSampleRateRange(m_lms_dev, LMS_CH_RX, &range_sr))
+		goto out_close;
+	print_range("Sample Rate", &range_sr);
+
+	if (iface == MULTI_ARFCN)
+		sr_host = dev_desc.rate_multiarfcn * tx_sps;
+	else
+		sr_host = dev_desc.rate * tx_sps;
+	LOGC(DDEV, INFO) << "Setting sample rate to " << sr_host << " " << tx_sps;
+	if (LMS_SetSampleRate(m_lms_dev, sr_host, 32) < 0)
+		goto out_close;
+
+	if (LMS_GetSampleRate(m_lms_dev, LMS_CH_RX, 0, &sr_host, &sr_rf))
+		goto out_close;
+	LOGC(DDEV, INFO) << "Sample Rate: Host=" << sr_host << " RF=" << sr_rf;
+
+	if (iface == MULTI_ARFCN)
+		ts_offset = static_cast<TIMESTAMP>(dev_desc.ts_offset_coef_multiarfcn * sr_host);
+	else
+		ts_offset = static_cast<TIMESTAMP>(dev_desc.ts_offset_coef * sr_host);
+
+	/* configure antennas */
+	if (!set_antennas()) {
+		LOGC(DDEV, FATAL) << "LMS antenna setting failed";
+		goto out_close;
+	}
+
+	return iface == MULTI_ARFCN ? MULTI_ARFCN : NORMAL;
+
+out_close:
+	LOGC(DDEV, FATAL) << "Error in LMS open, closing: " << LMS_GetLastErrorMessage();
+	LMS_Close(m_lms_dev);
+	m_lms_dev = NULL;
+	return -1;
+}
+
+bool LMSDevice::start()
+{
+	LOGC(DDEV, INFO) << "starting LMS...";
+
+	unsigned int i;
+
+	if (started) {
+		LOGC(DDEV, ERR) << "Device already started";
+		return false;
+	}
+
+	/* configure the channels/streams */
+	for (i=0; i<chans; i++) {
+		/* Set gains for calibration/filter setup */
+		/* TX gain to maximum */
+		setTxGain(maxTxGain(), i);
+		/* RX gain to midpoint */
+		setRxGain((minRxGain() + maxRxGain()) / 2, i);
+
+		/* set up Rx and Tx filters */
+		if (!do_filters(i))
+			return false;
+		/* Perform Rx and Tx calibration */
+		if (!do_calib(i))
+			return false;
+
+		/* configure Streams */
+		m_lms_stream_rx[i] = {};
+		m_lms_stream_rx[i].isTx = false;
+		m_lms_stream_rx[i].channel = i;
+		m_lms_stream_rx[i].fifoSize = 1024 * 1024;
+		m_lms_stream_rx[i].throughputVsLatency = 0.3;
+		m_lms_stream_rx[i].dataFmt = lms_stream_t::LMS_FMT_I16;
+
+		m_lms_stream_tx[i] = {};
+		m_lms_stream_tx[i].isTx = true;
+		m_lms_stream_tx[i].channel = i;
+		m_lms_stream_tx[i].fifoSize = 1024 * 1024;
+		m_lms_stream_tx[i].throughputVsLatency = 0.3;
+		m_lms_stream_tx[i].dataFmt = lms_stream_t::LMS_FMT_I16;
+
+		if (LMS_SetupStream(m_lms_dev, &m_lms_stream_rx[i]) < 0)
+			return false;
+
+		if (LMS_SetupStream(m_lms_dev, &m_lms_stream_tx[i]) < 0)
+			return false;
+	}
+
+	/* now start the streams in a second loop, as we can no longer call
+	 * LMS_SetupStream() after LMS_StartStream() of the first stream */
+	for (i = 0; i < chans; i++) {
+		if (LMS_StartStream(&m_lms_stream_rx[i]) < 0)
+			return false;
+
+		if (LMS_StartStream(&m_lms_stream_tx[i]) < 0)
+			return false;
+	}
+
+	flush_recv(10);
+
+	started = true;
+	return true;
+}
+
+bool LMSDevice::stop()
+{
+	unsigned int i;
+
+	if (!started)
+		return true;
+
+	for (i=0; i<chans; i++) {
+		LMS_StopStream(&m_lms_stream_tx[i]);
+		LMS_StopStream(&m_lms_stream_rx[i]);
+	}
+
+	for (i=0; i<chans; i++) {
+		LMS_DestroyStream(m_lms_dev, &m_lms_stream_tx[i]);
+		LMS_DestroyStream(m_lms_dev, &m_lms_stream_rx[i]);
+	}
+
+	started = false;
+	return true;
+}
+
+bool LMSDevice::do_clock_src_freq(enum ReferenceType ref, double freq)
+{
+	struct dev_desc dev_desc = dev_param_map.at(m_dev_type);
+	size_t lms_clk_id;
+
+	switch (ref) {
+	case REF_EXTERNAL:
+		lms_clk_id = LMS_CLOCK_EXTREF;
+		break;
+	case REF_INTERNAL:
+		if (!dev_desc.clock_src_int_usable) {
+			LOGC(DDEV, ERROR) << "Device type " << dev_desc.name_prefix
+					  << " doesn't support internal reference clock";
+			return false;
+		}
+		/* According to lms using LMS_CLOCK_EXTREF with a
+		   frequency <= 0 is the correct way to set clock to
+		   internal reference */
+		lms_clk_id = LMS_CLOCK_EXTREF;
+		freq = -1;
+		break;
+	default:
+		LOGC(DDEV, ERROR) << "Invalid reference type " << get_value_string(clock_ref_names, ref);
+		return false;
+	}
+
+	if (dev_desc.clock_src_switchable) {
+		if (LMS_SetClockFreq(m_lms_dev, lms_clk_id, freq) < 0)
+			return false;
+	} else {
+		LOGC(DDEV, INFO) << "Device type " << dev_desc.name_prefix
+				 << " doesn't support switching clock source through SW";
+	}
+
+	return true;
+}
+
+/* do rx/tx calibration - depends on gain, freq and bw */
+bool LMSDevice::do_calib(size_t chan)
+{
+	LOGCHAN(chan, DDEV, INFO) << "Calibrating";
+	if (LMS_Calibrate(m_lms_dev, LMS_CH_RX, chan, LMS_CALIBRATE_BW_HZ, 0) < 0)
+		return false;
+	if (LMS_Calibrate(m_lms_dev, LMS_CH_TX, chan, LMS_CALIBRATE_BW_HZ, 0) < 0)
+		return false;
+	return true;
+}
+
+/* do rx/tx filter config - depends on bw only? */
+bool LMSDevice::do_filters(size_t chan)
+{
+	lms_range_t range_lpfbw_rx, range_lpfbw_tx;
+	float_type lpfbw_rx, lpfbw_tx;
+
+	LOGCHAN(chan, DDEV, INFO) << "Setting filters";
+	if (LMS_GetLPFBWRange(m_lms_dev, LMS_CH_RX, &range_lpfbw_rx))
+		return false;
+	print_range("LPFBWRange Rx", &range_lpfbw_rx);
+	if (LMS_GetLPFBWRange(m_lms_dev, LMS_CH_RX, &range_lpfbw_tx))
+		return false;
+	print_range("LPFBWRange Tx", &range_lpfbw_tx);
+
+	lpfbw_rx = OSMO_MIN(OSMO_MAX(1.4001e6, range_lpfbw_rx.min), range_lpfbw_rx.max);
+	lpfbw_tx = OSMO_MIN(OSMO_MAX(5.2e6, range_lpfbw_tx.min), range_lpfbw_tx.max);
+
+	LOGCHAN(chan, DDEV, INFO) << "LPFBW: Rx=" << lpfbw_rx << " Tx=" << lpfbw_tx;
+
+	LOGCHAN(chan, DDEV, INFO) << "Setting LPFBW";
+	if (LMS_SetLPFBW(m_lms_dev, LMS_CH_RX, chan, lpfbw_rx) < 0)
+		return false;
+	if (LMS_SetLPFBW(m_lms_dev, LMS_CH_TX, chan, lpfbw_tx) < 0)
+		return false;
+	return true;
+}
+
+
+double LMSDevice::maxTxGain()
+{
+	return dev_param_map.at(m_dev_type).max_tx_gain;
+}
+
+double LMSDevice::minTxGain()
+{
+	return 0.0;
+}
+
+double LMSDevice::maxRxGain()
+{
+	return 73.0;
+}
+
+double LMSDevice::minRxGain()
+{
+	return 0.0;
+}
+
+double LMSDevice::setTxGain(double dB, size_t chan)
+{
+	if (dB > maxTxGain())
+		dB = maxTxGain();
+	if (dB < minTxGain())
+		dB = minTxGain();
+
+	LOGCHAN(chan, DDEV, NOTICE) << "Setting TX gain to " << dB << " dB";
+
+	if (LMS_SetGaindB(m_lms_dev, LMS_CH_TX, chan, dB) < 0)
+		LOGCHAN(chan, DDEV, ERR) << "Error setting TX gain to " << dB << " dB";
+	else
+		tx_gains[chan] = dB;
+	return tx_gains[chan];
+}
+
+double LMSDevice::setRxGain(double dB, size_t chan)
+{
+	if (dB > maxRxGain())
+		dB = maxRxGain();
+	if (dB < minRxGain())
+		dB = minRxGain();
+
+	LOGCHAN(chan, DDEV, NOTICE) << "Setting RX gain to " << dB << " dB";
+
+	if (LMS_SetGaindB(m_lms_dev, LMS_CH_RX, chan, dB) < 0)
+		LOGCHAN(chan, DDEV, ERR) << "Error setting RX gain to " << dB << " dB";
+	else
+		rx_gains[chan] = dB;
+	return rx_gains[chan];
+}
+
+void LMSDevice::log_ant_list(bool dir_tx, size_t chan, std::ostringstream& os)
+{
+	lms_name_t name_list[MAX_ANTENNA_LIST_SIZE]; /* large enough list for antenna names. */
+	int num_names;
+	int i;
+
+	num_names = LMS_GetAntennaList(m_lms_dev, dir_tx, chan, name_list);
+	for (i = 0; i < num_names; i++) {
+		if (i)
+			os << ", ";
+		os << "'" << name_list[i] << "'";
+	}
+}
+
+int LMSDevice::get_ant_idx(const std::string & name, bool dir_tx, size_t chan)
+{
+	lms_name_t name_list[MAX_ANTENNA_LIST_SIZE]; /* large enough list for antenna names. */
+	const char* c_name = name.c_str();
+	int num_names;
+	int i;
+
+	num_names = LMS_GetAntennaList(m_lms_dev, dir_tx, chan, name_list);
+	for (i = 0; i < num_names; i++) {
+		if (!strcmp(c_name, name_list[i]))
+			return i;
+	}
+	return -1;
+}
+
+bool LMSDevice::flush_recv(size_t num_pkts)
+{
+	#define CHUNK 625
+	int len = CHUNK * tx_sps;
+	short *buffer = (short*) alloca(sizeof(short) * len * 2);
+	int rc;
+	lms_stream_meta_t rx_metadata = {};
+	rx_metadata.flushPartialPacket = false;
+	rx_metadata.waitForTimestamp = false;
+
+	ts_initial = 0;
+
+	while (!ts_initial || (num_pkts-- > 0)) {
+		rc = LMS_RecvStream(&m_lms_stream_rx[0], &buffer[0], len, &rx_metadata, 100);
+		LOGC(DDEV, DEBUG) << "Flush: Recv buffer of len " << rc << " at " << std::hex << rx_metadata.timestamp;
+		if (rc != len) {
+			LOGC(DDEV, ERROR) << "Flush: Device receive timed out";
+			return false;
+		}
+
+		ts_initial = rx_metadata.timestamp + len;
+	}
+
+	LOGC(DDEV, INFO) << "Initial timestamp " << ts_initial << std::endl;
+	return true;
+}
+
+bool LMSDevice::setRxAntenna(const std::string & ant, size_t chan)
+{
+	int idx;
+
+	if (chan >= rx_paths.size()) {
+		LOGC(DDEV, ERROR) << "Requested non-existent channel " << chan;
+		return false;
+	}
+
+	idx = get_ant_idx(ant, LMS_CH_RX, chan);
+	if (idx < 0) {
+		std::ostringstream os;
+		LOGCHAN(chan, DDEV, ERROR) << "Invalid Rx Antenna: " << ant;
+		log_ant_list(LMS_CH_RX, chan, os);
+		LOGCHAN(chan, DDEV, NOTICE) << "Available Rx Antennas: " << os;
+		return false;
+	}
+
+	if (LMS_SetAntenna(m_lms_dev, LMS_CH_RX, chan, idx) < 0) {
+		LOGCHAN(chan, DDEV, ERROR) << "Unable to set Rx Antenna";
+	}
+
+	return true;
+}
+
+std::string LMSDevice::getRxAntenna(size_t chan)
+{
+	lms_name_t name_list[MAX_ANTENNA_LIST_SIZE]; /* large enough list for antenna names. */
+	int idx;
+
+	if (chan >= rx_paths.size()) {
+		LOGC(DDEV, ERROR) << "Requested non-existent channel " << chan;
+		return "";
+	}
+
+	idx = LMS_GetAntenna(m_lms_dev, LMS_CH_RX, chan);
+	if (idx < 0) {
+		LOGCHAN(chan, DDEV, ERROR) << "Error getting Rx Antenna";
+		return "";
+	}
+
+	if (LMS_GetAntennaList(m_lms_dev, LMS_CH_RX, chan, name_list) < idx) {
+		LOGCHAN(chan, DDEV, ERROR) << "Error getting Rx Antenna List";
+		return "";
+	}
+
+	return name_list[idx];
+}
+
+bool LMSDevice::setTxAntenna(const std::string & ant, size_t chan)
+{
+	int idx;
+
+	if (chan >= tx_paths.size()) {
+		LOGC(DDEV, ERROR) << "Requested non-existent channel " << chan;
+		return false;
+	}
+
+	idx = get_ant_idx(ant, LMS_CH_TX, chan);
+	if (idx < 0) {
+		std::ostringstream os;
+		LOGCHAN(chan, DDEV, ERROR) << "Invalid Tx Antenna: " << ant;
+		log_ant_list(LMS_CH_TX, chan, os);
+		LOGCHAN(chan, DDEV, NOTICE) << "Available Tx Antennas: " << os;
+		return false;
+	}
+
+	if (LMS_SetAntenna(m_lms_dev, LMS_CH_TX, chan, idx) < 0) {
+		LOGCHAN(chan, DDEV, ERROR) << "Unable to set Rx Antenna";
+	}
+
+	return true;
+}
+
+std::string LMSDevice::getTxAntenna(size_t chan)
+{
+	lms_name_t name_list[MAX_ANTENNA_LIST_SIZE]; /* large enough list for antenna names. */
+	int idx;
+
+	if (chan >= tx_paths.size()) {
+		LOGC(DDEV, ERROR) << "Requested non-existent channel " << chan;
+		return "";
+	}
+
+	idx = LMS_GetAntenna(m_lms_dev, LMS_CH_TX, chan);
+	if (idx < 0) {
+		LOGCHAN(chan, DDEV, ERROR) << "Error getting Tx Antenna";
+		return "";
+	}
+
+	if (LMS_GetAntennaList(m_lms_dev, LMS_CH_TX, chan, name_list) < idx) {
+		LOGCHAN(chan, DDEV, ERROR) << "Error getting Tx Antenna List";
+		return "";
+	}
+
+	return name_list[idx];
+}
+
+bool LMSDevice::requiresRadioAlign()
+{
+	return false;
+}
+
+GSM::Time LMSDevice::minLatency() {
+	/* UNUSED on limesdr (only used on usrp1/2) */
+	return GSM::Time(0,0);
+}
+/*!
+ * Issue tracking description of several events: https://github.com/myriadrf/LimeSuite/issues/265
+ */
+void LMSDevice::update_stream_stats_rx(size_t chan, bool *overrun)
+{
+	lms_stream_status_t status;
+	bool changed = false;
+
+	if (LMS_GetStreamStatus(&m_lms_stream_rx[chan], &status) != 0) {
+		LOGCHAN(chan, DDEV, ERROR) << "Rx LMS_GetStreamStatus failed";
+		return;
+	}
+
+	/* FIFO overrun is counted when Rx FIFO is full but new data comes from
+	   the board and oldest samples in FIFO are overwritte. Value count
+	   since the last call to LMS_GetStreamStatus(stream). */
+	if (status.overrun) {
+		changed = true;
+		*overrun = true;
+		LOGCHAN(chan, DDEV, ERROR) << "Rx Overrun! ("
+					   << m_ctr[chan].rx_overruns << " -> "
+					   << status.overrun << ")";
+	}
+	m_ctr[chan].rx_overruns += status.overrun;
+
+	/* Dropped packets in Rx are counted when gaps in Rx timestamps are
+	   detected (likely because buffer overflow in hardware). Value count
+	   since the last call to LMS_GetStreamStatus(stream). */
+	if (status.droppedPackets) {
+		changed = true;
+		LOGCHAN(chan, DDEV, ERROR) << "Rx Dropped packets by HW! ("
+					   << m_ctr[chan].rx_dropped_samples << " -> "
+					   << m_ctr[chan].rx_dropped_samples +
+					      status.droppedPackets
+					   << ")";
+		m_ctr[chan].rx_dropped_events++;
+	}
+	m_ctr[chan].rx_dropped_samples += status.droppedPackets;
+
+	if (changed)
+		osmo_signal_dispatch(SS_DEVICE, S_DEVICE_COUNTER_CHANGE, &m_ctr[chan]);
+
+}
+
+// NOTE: Assumes sequential reads
+int LMSDevice::readSamples(std::vector < short *>&bufs, int len, bool * overrun,
+			   TIMESTAMP timestamp, bool * underrun)
+{
+	int rc, num_smpls, expect_smpls;
+	ssize_t avail_smpls;
+	TIMESTAMP expect_timestamp;
+	unsigned int i;
+	lms_stream_meta_t rx_metadata = {};
+	rx_metadata.flushPartialPacket = false;
+	rx_metadata.waitForTimestamp = false;
+	rx_metadata.timestamp = 0;
+
+	if (bufs.size() != chans) {
+		LOGC(DDEV, ERROR) << "Invalid channel combination " << bufs.size();
+		return -1;
+	}
+
+	*overrun = false;
+	*underrun = false;
+
+	/* Check that timestamp is valid */
+	rc = rx_buffers[0]->avail_smpls(timestamp);
+	if (rc < 0) {
+		LOGC(DDEV, ERROR) << rx_buffers[0]->str_code(rc);
+		LOGC(DDEV, ERROR) << rx_buffers[0]->str_status(timestamp);
+		return 0;
+	}
+
+	for (i = 0; i<chans; i++) {
+		/* Receive samples from HW until we have enough */
+		while ((avail_smpls = rx_buffers[i]->avail_smpls(timestamp)) < len) {
+			thread_enable_cancel(false);
+			num_smpls = LMS_RecvStream(&m_lms_stream_rx[i], bufs[i], len - avail_smpls, &rx_metadata, 100);
+			update_stream_stats_rx(i, overrun);
+			thread_enable_cancel(true);
+			if (num_smpls <= 0) {
+				LOGCHAN(i, DDEV, ERROR) << "Device receive timed out (" << rc << " vs exp " << len << ").";
+				return -1;
+			}
+
+			LOGCHAN(i, DDEV, DEBUG) "Received timestamp = " << (TIMESTAMP)rx_metadata.timestamp << " (" << num_smpls << ")";
+
+			expect_smpls = len - avail_smpls;
+			if (expect_smpls != num_smpls)
+				LOGCHAN(i, DDEV, NOTICE) << "Unexpected recv buffer len: expect "
+							 << expect_smpls << " got " << num_smpls
+							 << ", diff=" << expect_smpls - num_smpls;
+
+			expect_timestamp = timestamp + avail_smpls;
+			if (expect_timestamp != (TIMESTAMP)rx_metadata.timestamp)
+				LOGCHAN(i, DDEV, ERROR) << "Unexpected recv buffer timestamp: expect "
+							<< expect_timestamp << " got " << (TIMESTAMP)rx_metadata.timestamp
+							<< ", diff=" << rx_metadata.timestamp - expect_timestamp;
+
+			rc = rx_buffers[i]->write(bufs[i], num_smpls, (TIMESTAMP)rx_metadata.timestamp);
+			if (rc < 0) {
+				LOGCHAN(i, DDEV, ERROR) << rx_buffers[i]->str_code(rc);
+				LOGCHAN(i, DDEV, ERROR) << rx_buffers[i]->str_status(timestamp);
+				if (rc != smpl_buf::ERROR_OVERFLOW)
+					return 0;
+			}
+		}
+	}
+
+	/* We have enough samples */
+	for (size_t i = 0; i < rx_buffers.size(); i++) {
+		rc = rx_buffers[i]->read(bufs[i], len, timestamp);
+		if ((rc < 0) || (rc != len)) {
+			LOGCHAN(i, DDEV, ERROR) << rx_buffers[i]->str_code(rc) << ". "
+						<< rx_buffers[i]->str_status(timestamp)
+						<< ", (len=" << len << ")";
+			return 0;
+		}
+	}
+
+	return len;
+}
+
+void LMSDevice::update_stream_stats_tx(size_t chan, bool *underrun)
+{
+	lms_stream_status_t status;
+	bool changed = false;
+
+	if (LMS_GetStreamStatus(&m_lms_stream_tx[chan], &status) != 0) {
+		LOGCHAN(chan, DDEV, ERROR) << "Tx LMS_GetStreamStatus failed";
+		return;
+	}
+
+	/* FIFO underrun is counted when Tx is running but FIFO is empty for
+	   >100 ms (500ms in older versions). Value count since the last call to
+	   LMS_GetStreamStatus(stream). */
+	if (status.underrun) {
+		changed = true;
+		*underrun = true;
+		LOGCHAN(chan, DDEV, ERROR) << "Tx Underrun! ("
+					   << m_ctr[chan].tx_underruns << " -> "
+					   << status.underrun << ")";
+	}
+	m_ctr[chan].tx_underruns += status.underrun;
+
+	/* Dropped packets in Tx are counted only when timestamps are enabled
+	   and SDR drops packet because of late timestamp. Value count since the
+	   last call to LMS_GetStreamStatus(stream). */
+	if (status.droppedPackets) {
+		changed = true;
+		LOGCHAN(chan, DDEV, ERROR) << "Tx Dropped packets by HW! ("
+					   << m_ctr[chan].tx_dropped_samples << " -> "
+					   << m_ctr[chan].tx_dropped_samples +
+					      status.droppedPackets
+					   << ")";
+		m_ctr[chan].tx_dropped_events++;
+	}
+	m_ctr[chan].tx_dropped_samples += status.droppedPackets;
+
+	if (changed)
+		osmo_signal_dispatch(SS_DEVICE, S_DEVICE_COUNTER_CHANGE, &m_ctr[chan]);
+
+}
+
+int LMSDevice::writeSamples(std::vector < short *>&bufs, int len,
+			    bool * underrun, unsigned long long timestamp)
+{
+	int rc = 0;
+	unsigned int i;
+	lms_stream_meta_t tx_metadata = {};
+	tx_metadata.flushPartialPacket = false;
+	tx_metadata.waitForTimestamp = true;
+	tx_metadata.timestamp = timestamp - ts_offset;	/* Shift Tx time by offset */
+
+	if (bufs.size() != chans) {
+		LOGC(DDEV, ERROR) << "Invalid channel combination " << bufs.size();
+		return -1;
+	}
+
+	*underrun = false;
+
+	for (i = 0; i<chans; i++) {
+		LOGCHAN(i, DDEV, DEBUG) << "send buffer of len " << len << " timestamp " << std::hex << tx_metadata.timestamp;
+		thread_enable_cancel(false);
+		rc = LMS_SendStream(&m_lms_stream_tx[i], bufs[i], len, &tx_metadata, 100);
+		update_stream_stats_tx(i, underrun);
+		thread_enable_cancel(true);
+		if (rc != len) {
+			LOGCHAN(i, DDEV, ERROR) << "LMS: Device Tx timed out (" << rc << " vs exp " << len << ").";
+			return -1;
+		}
+	}
+
+	return rc;
+}
+
+bool LMSDevice::updateAlignment(TIMESTAMP timestamp)
+{
+	return true;
+}
+
+bool LMSDevice::setTxFreq(double wFreq, size_t chan)
+{
+	LOGCHAN(chan, DDEV, NOTICE) << "Setting Tx Freq to " << wFreq << " Hz";
+
+	if (LMS_SetLOFrequency(m_lms_dev, LMS_CH_TX, chan, wFreq) < 0) {
+		LOGCHAN(chan, DDEV, ERROR) << "Error setting Tx Freq to " << wFreq << " Hz";
+		return false;
+	}
+
+	return true;
+}
+
+bool LMSDevice::setRxFreq(double wFreq, size_t chan)
+{
+	LOGCHAN(chan, DDEV, NOTICE) << "Setting Rx Freq to " << wFreq << " Hz";
+
+	if (LMS_SetLOFrequency(m_lms_dev, LMS_CH_RX, chan, wFreq) < 0) {
+		LOGCHAN(chan, DDEV, ERROR) << "Error setting Rx Freq to " << wFreq << " Hz";
+		return false;
+	}
+
+	return true;
+}
+
+RadioDevice *RadioDevice::make(size_t tx_sps, size_t rx_sps,
+			       InterfaceType iface, size_t chans, double lo_offset,
+			       const std::vector < std::string > &tx_paths,
+			       const std::vector < std::string > &rx_paths)
+{
+	if (tx_sps != rx_sps) {
+		LOGC(DDEV, ERROR) << "LMS Requires tx_sps == rx_sps";
+		return NULL;
+	}
+	if (lo_offset != 0.0) {
+		LOGC(DDEV, ERROR) << "LMS doesn't support lo_offset";
+		return NULL;
+	}
+	return new LMSDevice(tx_sps, rx_sps, iface, chans, lo_offset, tx_paths, rx_paths);
+}

Transceiver52M/device/lms/LMSDevice.h

@@ -0,0 +1,212 @@
+/*
+* Copyright 2018 sysmocom - s.f.m.c. GmbH
+*
+* SPDX-License-Identifier: AGPL-3.0+
+*
+* This software is distributed under multiple licenses; see the COPYING file in
+* the main directory for licensing information for this specific distribution.
+*
+* This use of this software may be subject to additional restrictions.
+* See the LEGAL file in the main directory for details.
+
+    This program 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.
+
+*/
+
+#ifndef _LMS_DEVICE_H_
+#define _LMS_DEVICE_H_
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include "radioDevice.h"
+#include "smpl_buf.h"
+
+#include <sys/time.h>
+#include <math.h>
+#include <limits.h>
+#include <string>
+#include <iostream>
+#include <lime/LimeSuite.h>
+
+/* Definition of LIMESDR_TX_AMPL limits maximum amplitude of I and Q
+ * channels separately. Hence LIMESDR_TX_AMPL value must be 1/sqrt(2) =
+ * 0.7071.... to get an amplitude of 1 of the complex signal:
+ * 	A^2 = I^2 + Q^2
+ * 	A^2 = (1/sqrt(2))^2 + (1/sqrt(2))^2
+ * 	A^2 = 1/2 + 1/2
+ * 	A^2 = 1 */
+#define LIMESDR_TX_AMPL  0.707
+
+enum lms_dev_type {
+	LMS_DEV_SDR_USB,   /* LimeSDR-USB */
+	LMS_DEV_SDR_MINI,  /* LimeSDR-Mini */
+	LMS_DEV_NET_MICRO, /* LimeNet-micro */
+	LMS_DEV_UNKNOWN,
+};
+
+/** A class to handle a LimeSuite supported device */
+class LMSDevice:public RadioDevice {
+
+private:
+	lms_device_t *m_lms_dev;
+	std::vector<lms_stream_t> m_lms_stream_rx;
+	std::vector<lms_stream_t> m_lms_stream_tx;
+
+	std::vector<smpl_buf *> rx_buffers;
+
+	double actualSampleRate;	///< the actual USRP sampling rate
+
+	bool started;		///< flag indicates LMS has started
+	bool skipRx;		///< set if LMS is transmit-only.
+
+	TIMESTAMP ts_initial, ts_offset;
+
+	std::vector<double> tx_gains, rx_gains;
+
+	enum lms_dev_type m_dev_type;
+
+	bool do_calib(size_t chan);
+	bool do_filters(size_t chan);
+	void log_ant_list(bool dir_tx, size_t chan, std::ostringstream& os);
+	int get_ant_idx(const std::string & name, bool dir_tx, size_t chan);
+	bool flush_recv(size_t num_pkts);
+	void update_stream_stats_rx(size_t chan, bool *overrun);
+	void update_stream_stats_tx(size_t chan, bool *underrun);
+	bool do_clock_src_freq(enum ReferenceType ref, double freq);
+
+public:
+
+	/** Object constructor */
+	LMSDevice(size_t tx_sps, size_t rx_sps, InterfaceType iface, size_t chan_num, double lo_offset,
+		  const std::vector<std::string>& tx_paths,
+		  const std::vector<std::string>& rx_paths);
+	~LMSDevice();
+
+	/** Instantiate the LMS */
+	int open(const std::string &args, int ref, bool swap_channels);
+
+	/** Start the LMS */
+	bool start();
+
+	/** Stop the LMS */
+	bool stop();
+
+	enum TxWindowType getWindowType() {
+		return TX_WINDOW_LMS1;
+	}
+
+	/**
+	Read samples from the LMS.
+	@param buf preallocated buf to contain read result
+	@param len number of samples desired
+	@param overrun Set if read buffer has been overrun, e.g. data not being read fast enough
+	@param timestamp The timestamp of the first samples to be read
+	@param underrun Set if LMS does not have data to transmit, e.g. data not being sent fast enough
+	@return The number of samples actually read
+	*/
+	int readSamples(std::vector < short *>&buf, int len, bool * overrun,
+			TIMESTAMP timestamp = 0xffffffff, bool * underrun =
+			NULL);
+	/**
+	Write samples to the LMS.
+	@param buf Contains the data to be written.
+	@param len number of samples to write.
+	@param underrun Set if LMS does not have data to transmit, e.g. data not being sent fast enough
+	@param timestamp The timestamp of the first sample of the data buffer.
+	@return The number of samples actually written
+	*/
+	int writeSamples(std::vector < short *>&bufs, int len, bool * underrun,
+			 TIMESTAMP timestamp = 0xffffffff);
+
+	/** Update the alignment between the read and write timestamps */
+	bool updateAlignment(TIMESTAMP timestamp);
+
+	/** Set the transmitter frequency */
+	bool setTxFreq(double wFreq, size_t chan = 0);
+
+	/** Set the receiver frequency */
+	bool setRxFreq(double wFreq, size_t chan = 0);
+
+	/** Returns the starting write Timestamp*/
+	TIMESTAMP initialWriteTimestamp(void) {
+		return ts_initial;
+	}
+
+	/** Returns the starting read Timestamp*/
+	TIMESTAMP initialReadTimestamp(void) {
+		return ts_initial;
+	}
+
+	/** returns the full-scale transmit amplitude **/
+	double fullScaleInputValue() {
+		return(double) SHRT_MAX * LIMESDR_TX_AMPL;
+	}
+
+	/** returns the full-scale receive amplitude **/
+	double fullScaleOutputValue() {
+		return (double) SHRT_MAX;
+	}
+
+	/** sets the receive chan gain, returns the gain setting **/
+	double setRxGain(double dB, size_t chan = 0);
+
+	/** get the current receive gain */
+	double getRxGain(size_t chan = 0) {
+		return rx_gains[chan];
+	}
+
+	/** return maximum Rx Gain **/
+	double maxRxGain(void);
+
+	/** return minimum Rx Gain **/
+	double minRxGain(void);
+
+	/** sets the transmit chan gain, returns the gain setting **/
+	double setTxGain(double dB, size_t chan = 0);
+
+	/** get transmit gain */
+	double getTxGain(size_t chan = 0) {
+		return tx_gains[chan];
+	}
+
+	/** return maximum Tx Gain **/
+	double maxTxGain(void);
+
+	/** return minimum Rx Gain **/
+	double minTxGain(void);
+
+	/** sets the RX path to use, returns true if successful and false otherwise */
+	bool setRxAntenna(const std::string & ant, size_t chan = 0);
+
+	/* return the used RX path */
+	std::string getRxAntenna(size_t chan = 0);
+
+	/** sets the RX path to use, returns true if successful and false otherwise */
+	bool setTxAntenna(const std::string & ant, size_t chan = 0);
+
+	/* return the used RX path */
+	std::string getTxAntenna(size_t chan = 0);
+
+	/** return whether user drives synchronization of Tx/Rx of USRP */
+        bool requiresRadioAlign();
+
+        /** return whether user drives synchronization of Tx/Rx of USRP */
+        virtual GSM::Time minLatency();
+
+	/** Return internal status values */
+	inline double getTxFreq(size_t chan = 0) {
+		return 0;
+	}
+	inline double getRxFreq(size_t chan = 0) {
+		return 0;
+	}
+	inline double getSampleRate() {
+		return actualSampleRate;
+	}
+};
+
+#endif // _LMS_DEVICE_H_

Transceiver52M/device/lms/Makefile.am

@@ -0,0 +1,11 @@
+include $(top_srcdir)/Makefile.common
+
+AM_CPPFLAGS = -Wall $(STD_DEFINES_AND_INCLUDES) -I${srcdir}/../common
+AM_CXXFLAGS = -lpthread $(LIBOSMOCORE_CFLAGS) $(LIBOSMOCTRL_CFLAGS) $(LIBOSMOVTY_CFLAGS) $(LMS_CFLAGS)
+
+noinst_HEADERS = LMSDevice.h
+
+noinst_LTLIBRARIES = libdevice.la
+
+libdevice_la_SOURCES = LMSDevice.cpp
+libdevice_la_LIBADD = $(top_builddir)/Transceiver52M/device/common/libdevice_common.la

Transceiver52M/device/uhd/Makefile.am

@@ -0,0 +1,11 @@
+include $(top_srcdir)/Makefile.common
+
+AM_CPPFLAGS = -Wall $(STD_DEFINES_AND_INCLUDES) -I${srcdir}/../common
+AM_CXXFLAGS = -lpthread $(LIBOSMOCORE_CFLAGS) $(LIBOSMOCTRL_CFLAGS) $(LIBOSMOVTY_CFLAGS) $(UHD_CFLAGS)
+
+noinst_HEADERS = UHDDevice.h
+
+noinst_LTLIBRARIES = libdevice.la
+
+libdevice_la_SOURCES = UHDDevice.cpp
+libdevice_la_LIBADD = $(top_builddir)/Transceiver52M/device/common/libdevice_common.la

Transceiver52M/device/uhd/UHDDevice.h

@@ -0,0 +1,176 @@
+/*
+ * Device support for Ettus Research UHD driver
+ *
+ * Copyright 2010,2011 Free Software Foundation, Inc.
+ * Copyright (C) 2015 Ettus Research LLC
+ * Copyright 2019 sysmocom - s.f.m.c. GmbH <info@sysmocom.de>
+ *
+ * Author: Tom Tsou <tom.tsou@ettus.com>
+ *
+ * SPDX-License-Identifier: AGPL-3.0+
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * See the COPYING file in the main directory for details.
+ */
+
+#pragma once
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include "radioDevice.h"
+#include "smpl_buf.h"
+
+#include <uhd/version.hpp>
+#include <uhd/property_tree.hpp>
+#include <uhd/usrp/multi_usrp.hpp>
+
+
+enum uhd_dev_type {
+	USRP1,
+	USRP2,
+	B100,
+	B200,
+	B210,
+	B2XX_MCBTS,
+	E1XX,
+	E3XX,
+	X3XX,
+	UMTRX,
+	LIMESDR,
+	OCR01,
+};
+
+/*
+    uhd_device - UHD implementation of the Device interface. Timestamped samples
+                are sent to and received from the device. An intermediate buffer
+                on the receive side collects and aligns packets of samples.
+                Events and errors such as underruns are reported asynchronously
+                by the device and received in a separate thread.
+*/
+class uhd_device : public RadioDevice {
+public:
+	uhd_device(size_t tx_sps, size_t rx_sps, InterfaceType type,
+		   size_t chan_num, double offset,
+		   const std::vector<std::string>& tx_paths,
+		   const std::vector<std::string>& rx_paths);
+	~uhd_device();
+
+	int open(const std::string &args, int ref, bool swap_channels);
+	bool start();
+	bool stop();
+	bool restart();
+	enum TxWindowType getWindowType() { return tx_window; }
+
+	int readSamples(std::vector<short *> &bufs, int len, bool *overrun,
+			TIMESTAMP timestamp, bool *underrun);
+
+	int writeSamples(std::vector<short *> &bufs, int len, bool *underrun,
+			 TIMESTAMP timestamp);
+
+	bool updateAlignment(TIMESTAMP timestamp);
+
+	bool setTxFreq(double wFreq, size_t chan);
+	bool setRxFreq(double wFreq, size_t chan);
+
+	TIMESTAMP initialWriteTimestamp();
+	TIMESTAMP initialReadTimestamp();
+
+	double fullScaleInputValue();
+	double fullScaleOutputValue();
+
+	double setRxGain(double db, size_t chan);
+	double getRxGain(size_t chan);
+	double maxRxGain(void) { return rx_gain_max; }
+	double minRxGain(void) { return rx_gain_min; }
+
+	double setTxGain(double db, size_t chan);
+	double getTxGain(size_t chan = 0);
+	double maxTxGain(void) { return tx_gain_max; }
+	double minTxGain(void) { return tx_gain_min; }
+
+	double getTxFreq(size_t chan);
+	double getRxFreq(size_t chan);
+	double getRxFreq();
+
+	bool setRxAntenna(const std::string &ant, size_t chan);
+	std::string getRxAntenna(size_t chan);
+	bool setTxAntenna(const std::string &ant, size_t chan);
+	std::string getTxAntenna(size_t chan);
+
+	bool requiresRadioAlign();
+
+	GSM::Time minLatency();
+
+	inline double getSampleRate() { return tx_rate; }
+
+	/** Receive and process asynchronous message
+	    @return true if message received or false on timeout or error
+	*/
+	bool recv_async_msg();
+
+	enum err_code {
+		ERROR_TIMING = -1,
+		ERROR_TIMEOUT = -2,
+		ERROR_UNRECOVERABLE = -3,
+		ERROR_UNHANDLED = -4,
+	};
+
+private:
+	uhd::usrp::multi_usrp::sptr usrp_dev;
+	uhd::tx_streamer::sptr tx_stream;
+	uhd::rx_streamer::sptr rx_stream;
+	enum TxWindowType tx_window;
+	enum uhd_dev_type dev_type;
+
+	double tx_rate, rx_rate;
+
+	double tx_gain_min, tx_gain_max;
+	double rx_gain_min, rx_gain_max;
+
+	std::vector<double> tx_gains, rx_gains;
+	std::vector<double> tx_freqs, rx_freqs;
+	size_t tx_spp, rx_spp;
+
+	bool started;
+	bool aligned;
+
+	size_t drop_cnt;
+	uhd::time_spec_t prev_ts;
+
+	TIMESTAMP ts_initial, ts_offset;
+	std::vector<smpl_buf *> rx_buffers;
+	/* Sample buffers used to receive samples from UHD: */
+	std::vector<std::vector<short> > pkt_bufs;
+	/* Used to call UHD API: Buffer pointer of each elem in pkt_ptrs will
+	   point to corresponding buffer of vector pkt_bufs. */
+	std::vector<short *> pkt_ptrs;
+
+	void init_gains();
+	void set_channels(bool swap);
+	void set_rates();
+	bool parse_dev_type();
+	bool flush_recv(size_t num_pkts);
+	int check_rx_md_err(uhd::rx_metadata_t &md, ssize_t num_smpls);
+
+	std::string str_code(uhd::rx_metadata_t metadata);
+	std::string str_code(uhd::async_metadata_t metadata);
+
+	uhd::tune_request_t select_freq(double wFreq, size_t chan, bool tx);
+	bool set_freq(double freq, size_t chan, bool tx);
+
+	Thread *async_event_thrd;
+	Mutex tune_lock;
+};

Transceiver52M/device/usrp1/Makefile.am

@@ -0,0 +1,16 @@
+include $(top_srcdir)/Makefile.common
+
+AM_CPPFLAGS = -Wall $(STD_DEFINES_AND_INCLUDES) -I${srcdir}/../common
+AM_CXXFLAGS = -lpthread $(LIBOSMOCORE_CFLAGS) $(LIBOSMOCTRL_CFLAGS) $(LIBOSMOVTY_CFLAGS) $(USRP_CFLAGS)
+
+rev2dir = $(datadir)/usrp/rev2
+rev4dir = $(datadir)/usrp/rev4
+
+dist_rev2_DATA = std_inband.rbf
+dist_rev4_DATA = std_inband.rbf
+
+noinst_HEADERS = USRPDevice.h
+
+noinst_LTLIBRARIES = libdevice.la
+
+libdevice_la_SOURCES = USRPDevice.cpp

Transceiver52M/device/usrp1/USRPDevice.cpp

@@ -1,6 +1,8 @@
 /*
 * Copyright 2008, 2009 Free Software Foundation, Inc.
 *
+* SPDX-License-Identifier: AGPL-3.0+
+*
 * This software is distributed under the terms of the GNU Affero Public License.
 * See the COPYING file in the main directory for details.
 *
@@ -27,17 +29,16 @@
 	Compilation Flags
 
 	SWLOOPBACK	compile for software loopback testing
-*/ 
+*/
 
 
 #include <stdint.h>
 #include <string.h>
 #include <stdlib.h>
+#include "Logger.h"
 #include "Threads.h"
 #include "USRPDevice.h"
 
-#include <Logger.h>
-
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
@@ -59,14 +60,18 @@ const dboardConfigType dboardConfig = TXA_RXB;
 
 const double USRPDevice::masterClockRate = 52.0e6;
 
-USRPDevice::USRPDevice(size_t sps)
+USRPDevice::USRPDevice(size_t tx_sps, size_t rx_sps, InterfaceType iface,
+		       size_t chan_num, double lo_offset,
+		       const std::vector<std::string>& tx_paths,
+		       const std::vector<std::string>& rx_paths):
+		RadioDevice(tx_sps, rx_sps, iface, chan_num, lo_offset, tx_paths, rx_paths)
 {
-  LOG(INFO) << "creating USRP device...";
+  LOGC(DDEV, INFO) << "creating USRP device...";
 
-  this->sps = sps;
-  decimRate = (unsigned int) round(masterClockRate/((GSMRATE) * (double) sps));
+  decimRate = (unsigned int) round(masterClockRate/((GSMRATE) * (double) tx_sps));
   actualSampleRate = masterClockRate/decimRate;
   rxGain = 0;
+  txGain = 0;
 
   /*
    * Undetermined delay b/w ping response timestamp and true
@@ -74,14 +79,14 @@ USRPDevice::USRPDevice(size_t sps)
    * split sample rate Tx/Rx - 4/1 sps we need to need to
    * compensate for advance rather than delay.
    */
-  if (sps == 1)
+  if (tx_sps == 1)
     pingOffset = 272;
-  else if (sps == 4)
+  else if (tx_sps == 4)
     pingOffset = 269 - 7500;
   else
     pingOffset = 0;
 
-#ifdef SWLOOPBACK 
+#ifdef SWLOOPBACK
   samplePeriod = 1.0e6/actualSampleRate;
   loopbackBufferSize = 0;
   gettimeofday(&lastReadTime,NULL);
@@ -93,34 +98,32 @@ int USRPDevice::open(const std::string &, int, bool)
 {
   writeLock.unlock();
 
-  LOG(INFO) << "opening USRP device..";
-#ifndef SWLOOPBACK 
+  LOGC(DDEV, INFO) << "opening USRP device..";
+#ifndef SWLOOPBACK
   string rbf = "std_inband.rbf";
-  //string rbf = "inband_1rxhb_1tx.rbf"; 
+  //string rbf = "inband_1rxhb_1tx.rbf";
   m_uRx.reset();
-  if (!skipRx) {
   try {
     m_uRx = usrp_standard_rx_sptr(usrp_standard_rx::make(
-                                        0, decimRate * sps, 1, -1,
+                                        0, decimRate * tx_sps, 1, -1,
                                         usrp_standard_rx::FPGA_MODE_NORMAL,
                                         1024, 16 * 8, rbf));
     m_uRx->set_fpga_master_clock_freq(masterClockRate);
   }
 
   catch(...) {
-    LOG(ALERT) << "make failed on Rx";
+    LOGC(DDEV, ALERT) << "make failed on Rx";
     m_uRx.reset();
     return -1;
   }
 
   if (m_uRx->fpga_master_clock_freq() != masterClockRate)
   {
-    LOG(ALERT) << "WRONG FPGA clock freq = " << m_uRx->fpga_master_clock_freq()
+    LOGC(DDEV, ALERT) << "WRONG FPGA clock freq = " << m_uRx->fpga_master_clock_freq()
                << ", desired clock freq = " << masterClockRate;
     m_uRx.reset();
     return -1;
   }
-  }
 
   try {
     m_uTx = usrp_standard_tx_sptr(usrp_standard_tx::make(
@@ -130,22 +133,22 @@ int USRPDevice::open(const std::string &, int, bool)
   }
 
   catch(...) {
-    LOG(ALERT) << "make failed on Tx";
+    LOGC(DDEV, ALERT) << "make failed on Tx";
     m_uTx.reset();
     return -1;
   }
 
   if (m_uTx->fpga_master_clock_freq() != masterClockRate)
   {
-    LOG(ALERT) << "WRONG FPGA clock freq = " << m_uTx->fpga_master_clock_freq()
+    LOGC(DDEV, ALERT) << "WRONG FPGA clock freq = " << m_uTx->fpga_master_clock_freq()
                << ", desired clock freq = " << masterClockRate;
     m_uTx.reset();
     return -1;
   }
 
-  if (!skipRx) m_uRx->stop();
+  m_uRx->stop();
   m_uTx->stop();
-  
+
 #endif
 
   switch (dboardConfig) {
@@ -173,23 +176,21 @@ int USRPDevice::open(const std::string &, int, bool)
   m_dbTx = m_uTx->selected_subdev(txSubdevSpec);
   m_dbRx = m_uRx->selected_subdev(rxSubdevSpec);
 
-  samplesRead = 0;
-  samplesWritten = 0;
   started = false;
-  
+
   return NORMAL;
 }
 
 
 
-bool USRPDevice::start() 
+bool USRPDevice::start()
 {
-  LOG(INFO) << "starting USRP...";
-#ifndef SWLOOPBACK 
-  if (!m_uRx && !skipRx) return false;
+  LOGC(DDEV, INFO) << "starting USRP...";
+#ifndef SWLOOPBACK
+  if (!m_uRx) return false;
   if (!m_uTx) return false;
-  
-  if (!skipRx) m_uRx->stop();
+
+  m_uRx->stop();
   m_uTx->stop();
 
   writeLock.lock();
@@ -218,11 +219,8 @@ bool USRPDevice::start()
   hi32Timestamp = 0;
   isAligned = false;
 
- 
-  if (!skipRx) 
+
   started = (m_uRx->start() && m_uTx->start());
-  else
-  started = m_uTx->start();
   return started;
 #else
   gettimeofday(&lastReadTime,NULL);
@@ -230,14 +228,14 @@ bool USRPDevice::start()
 #endif
 }
 
-bool USRPDevice::stop() 
+bool USRPDevice::stop()
 {
-#ifndef SWLOOPBACK 
+#ifndef SWLOOPBACK
   if (!m_uRx) return false;
   if (!m_uTx) return false;
-  
+
   delete[] currData;
-  
+
   started = !(m_uRx->stop() && m_uTx->stop());
   return !started;
 #else
@@ -258,7 +256,7 @@ double USRPDevice::minTxGain()
 double USRPDevice::maxRxGain()
 {
   return m_dbRx->gain_max();
-} 
+}
 
 double USRPDevice::minRxGain()
 {
@@ -268,7 +266,7 @@ double USRPDevice::minRxGain()
 double USRPDevice::setTxGain(double dB, size_t chan)
 {
   if (chan) {
-    LOG(ALERT) << "Invalid channel " << chan;
+    LOGC(DDEV, ALERT) << "Invalid channel " << chan;
     return 0.0;
   }
 
@@ -278,21 +276,22 @@ double USRPDevice::setTxGain(double dB, size_t chan)
   if (dB < minTxGain())
     dB = minTxGain();
 
-  LOG(NOTICE) << "Setting TX gain to " << dB << " dB.";
+  LOGC(DDEV, NOTICE) << "Setting TX gain to " << dB << " dB.";
 
   if (!m_dbTx->set_gain(dB))
-    LOG(ERR) << "Error setting TX gain";
-
+    LOGC(DDEV, ERR) << "Error setting TX gain";
+  else
+    txGain = dB;
   writeLock.unlock();
 
-  return dB;
+  return txGain;
 }
 
 
 double USRPDevice::setRxGain(double dB, size_t chan)
 {
   if (chan) {
-    LOG(ALERT) << "Invalid channel " << chan;
+    LOGC(DDEV, ALERT) << "Invalid channel " << chan;
     return 0.0;
   }
 
@@ -304,38 +303,87 @@ double USRPDevice::setRxGain(double dB, size_t chan)
   if (dB < minRxGain())
     dB = minRxGain();
 
-  LOG(NOTICE) << "Setting RX gain to " << dB << " dB.";
+  LOGC(DDEV, NOTICE) << "Setting RX gain to " << dB << " dB.";
 
   if (!m_dbRx->set_gain(dB))
-    LOG(ERR) << "Error setting RX gain";
-
+    LOGC(DDEV, ERR) << "Error setting RX gain";
+  else
+    rxGain = dB;
   writeLock.unlock();
 
-  return dB;
+  return rxGain;
 }
 
+bool USRPDevice::setRxAntenna(const std::string &ant, size_t chan)
+{
+	if (chan >= rx_paths.size()) {
+		LOGC(DDEV, ALERT) << "Requested non-existent channel " << chan;
+		return false;
+	}
+	LOGC(DDEV, ALERT) << "Not implemented";
+	return true;
+}
+
+std::string USRPDevice::getRxAntenna(size_t chan)
+{
+	if (chan >= rx_paths.size()) {
+		LOGC(DDEV, ALERT) << "Requested non-existent channel " << chan;
+		return "";
+	}
+	LOGC(DDEV, ALERT) << "Not implemented";
+	return "";
+}
+
+bool USRPDevice::setTxAntenna(const std::string &ant, size_t chan)
+{
+	if (chan >= tx_paths.size()) {
+		LOGC(DDEV, ALERT) << "Requested non-existent channel " << chan;
+		return false;
+	}
+	LOGC(DDEV, ALERT) << "Not implemented";
+	return true;
+}
+
+std::string USRPDevice::getTxAntenna(size_t chan)
+{
+	if (chan >= tx_paths.size()) {
+		LOGC(DDEV, ALERT) << "Requested non-existent channel " << chan;
+		return "";
+	}
+	LOGC(DDEV, ALERT) << "Not implemented";
+	return "";
+}
+
+bool USRPDevice::requiresRadioAlign()
+{
+	return true;
+}
+
+GSM::Time USRPDevice::minLatency() {
+	return GSM::Time(1,1);
+}
 
 // NOTE: Assumes sequential reads
 int USRPDevice::readSamples(std::vector<short *> &bufs, int len, bool *overrun,
-                            TIMESTAMP timestamp, bool *underrun, unsigned *RSSI)
+                            TIMESTAMP timestamp, bool *underrun)
 {
-#ifndef SWLOOPBACK 
+#ifndef SWLOOPBACK
   if (!m_uRx)
     return 0;
 
   short *buf = bufs[0];
 
   timestamp += timestampOffset;
-  
+
   if (timestamp + len < timeStart) {
     memset(buf,0,len*2*sizeof(short));
     return len;
   }
 
-  if (underrun) *underrun = false;
- 
+  *underrun = false;
+
   uint32_t readBuf[2000];
- 
+
   while (1) {
     //guestimate USB read size
     int readLen=0;
@@ -345,21 +393,21 @@ int USRPDevice::readSamples(std::vector<short *> &bufs, int len, bool *overrun,
       readLen = 512 * ((int) ceil((float) numSamplesNeeded/126.0));
       if (readLen > 8000) readLen= (8000/512)*512;
     }
-    
+
     // read USRP packets, parse and save A/D data as needed
     readLen = m_uRx->read((void *)readBuf,readLen,overrun);
-    for(int pktNum = 0; pktNum < (readLen/512); pktNum++) {
+    for (int pktNum = 0; pktNum < (readLen/512); pktNum++) {
       // tmpBuf points to start of a USB packet
       uint32_t* tmpBuf = (uint32_t *) (readBuf+pktNum*512/4);
       TIMESTAMP pktTimestamp = usrp_to_host_u32(tmpBuf[1]);
       uint32_t word0 = usrp_to_host_u32(tmpBuf[0]);
       uint32_t chan = (word0 >> 16) & 0x1f;
       unsigned payloadSz = word0 & 0x1ff;
-      LOG(DEBUG) << "first two bytes: " << hex << word0 << " " << dec << pktTimestamp;
+      LOGC(DDEV, DEBUG) << "first two bytes: " << hex << word0 << " " << dec << pktTimestamp;
 
       bool incrementHi32 = ((lastPktTimestamp & 0x0ffffffffll) > pktTimestamp);
       if (incrementHi32 && (timeStart!=0)) {
-           LOG(DEBUG) << "high 32 increment!!!";
+           LOGC(DDEV, DEBUG) << "high 32 increment!!!";
            hi32Timestamp++;
       }
       pktTimestamp = (((TIMESTAMP) hi32Timestamp) << 32) | pktTimestamp;
@@ -371,24 +419,26 @@ int USRPDevice::readSamples(std::vector<short *> &bufs, int len, bool *overrun,
 	if ((word2 >> 16) == ((0x01 << 8) | 0x02)) {
           timestamp -= timestampOffset;
 	  timestampOffset = pktTimestamp - pingTimestamp + pingOffset;
-	  LOG(DEBUG) << "updating timestamp offset to: " << timestampOffset;
+	  LOGC(DDEV, DEBUG) << "updating timestamp offset to: " << timestampOffset;
           timestamp += timestampOffset;
 	  isAligned = true;
 	}
 	continue;
       }
       if (chan != 0) {
-	LOG(DEBUG) << "chan: " << chan << ", timestamp: " << pktTimestamp << ", sz:" << payloadSz;
+	LOGC(DDEV, DEBUG) << "chan: " << chan << ", timestamp: " << pktTimestamp << ", sz:" << payloadSz;
 	continue;
       }
       if ((word0 >> 28) & 0x04) {
-	if (underrun) *underrun = true; 
-	LOG(DEBUG) << "UNDERRUN in TRX->USRP interface";
+	*underrun = true;
+	LOGC(DDEV, DEBUG) << "UNDERRUN in TRX->USRP interface";
       }
-      if (RSSI) *RSSI = (word0 >> 21) & 0x3f;
-      
+#if 0
+      /* FIXME: Do something with this ? */
+      unsigned RSSI = (word0 >> 21) & 0x3f;
+#endif
       if (!isAligned) continue;
-      
+
       unsigned cursorStart = pktTimestamp - timeStart + dataStart;
       while (cursorStart*2 > currDataSize) {
 	cursorStart -= currDataSize/2;
@@ -401,25 +451,25 @@ int USRPDevice::readSamples(std::vector<short *> &bufs, int len, bool *overrun,
       else {
 	memcpy(data+cursorStart*2,tmpBuf+2,payloadSz);
       }
-      if (pktTimestamp + payloadSz/2/sizeof(short) > timeEnd) 
+      if (pktTimestamp + payloadSz/2/sizeof(short) > timeEnd)
 	timeEnd = pktTimestamp+payloadSz/2/sizeof(short);
 
-      LOG(DEBUG) << "timeStart: " << timeStart << ", timeEnd: " << timeEnd << ", pktTimestamp: " << pktTimestamp;
+      LOGC(DDEV, DEBUG) << "timeStart: " << timeStart << ", timeEnd: " << timeEnd << ", pktTimestamp: " << pktTimestamp;
+
+    }
+  }
 
-    }	
-  }     
- 
   // copy desired data to buf
   unsigned bufStart = dataStart+(timestamp-timeStart);
-  if (bufStart + len < currDataSize/2) { 
-    LOG(DEBUG) << "bufStart: " << bufStart;
+  if (bufStart + len < currDataSize/2) {
+    LOGC(DDEV, DEBUG) << "bufStart: " << bufStart;
     memcpy(buf,data+bufStart*2,len*2*sizeof(short));
     memset(data+bufStart*2,0,len*2*sizeof(short));
   }
   else {
-    LOG(DEBUG) << "len: " << len << ", currDataSize/2: " << currDataSize/2 << ", bufStart: " << bufStart;
+    LOGC(DDEV, DEBUG) << "len: " << len << ", currDataSize/2: " << currDataSize/2 << ", bufStart: " << bufStart;
     unsigned firstLength = (currDataSize/2-bufStart);
-    LOG(DEBUG) << "firstLength: " << firstLength;
+    LOGC(DDEV, DEBUG) << "firstLength: " << firstLength;
     memcpy(buf,data+bufStart*2,firstLength*2*sizeof(short));
     memset(data+bufStart*2,0,firstLength*2*sizeof(short));
     memcpy(buf+firstLength*2,data,(len-firstLength)*2*sizeof(short));
@@ -429,21 +479,21 @@ int USRPDevice::readSamples(std::vector<short *> &bufs, int len, bool *overrun,
   timeStart = timestamp + len;
 
   return len;
-  
+
 #else
   if (loopbackBufferSize < 2) return 0;
   int numSamples = 0;
   struct timeval currTime;
   gettimeofday(&currTime,NULL);
-  double timeElapsed = (currTime.tv_sec - lastReadTime.tv_sec)*1.0e6 + 
+  double timeElapsed = (currTime.tv_sec - lastReadTime.tv_sec)*1.0e6 +
     (currTime.tv_usec - lastReadTime.tv_usec);
   if (timeElapsed < samplePeriod) {return 0;}
   int numSamplesToRead = (int) floor(timeElapsed/samplePeriod);
   if (numSamplesToRead < len) return 0;
-  
+
   if (numSamplesToRead > len) numSamplesToRead = len;
   if (numSamplesToRead > loopbackBufferSize/2) {
-    firstRead =false; 
+    firstRead =false;
     numSamplesToRead = loopbackBufferSize/2;
   }
   memcpy(buf,loopbackBuffer,sizeof(short)*2*numSamplesToRead);
@@ -460,19 +510,17 @@ int USRPDevice::readSamples(std::vector<short *> &bufs, int len, bool *overrun,
     gettimeofday(&lastReadTime,NULL);
     firstRead = true;
   }
-  samplesRead += numSamples;
-  
+
   return numSamples;
 #endif
 }
 
-int USRPDevice::writeSamples(std::vector<short *> &bufs, int len,
-                             bool *underrun, unsigned long long timestamp,
-                             bool isControl)
+int USRPDevice::writeSamplesControl(std::vector<short *> &bufs, int len,
+                             bool *underrun, unsigned long long timestamp, bool isControl)
 {
   writeLock.lock();
 
-#ifndef SWLOOPBACK 
+#ifndef SWLOOPBACK
   if (!m_uTx)
     return 0;
 
@@ -510,30 +558,34 @@ int USRPDevice::writeSamples(std::vector<short *> &bufs, int len,
   }
   m_uTx->write((const void*) outPkt,sizeof(uint32_t)*128*numPkts,NULL);
 
-  samplesWritten += len/2/sizeof(short);
   writeLock.unlock();
 
   return len/2/sizeof(short);
 #else
   int retVal = len;
   memcpy(loopbackBuffer+loopbackBufferSize,buf,sizeof(short)*2*len);
-  samplesWritten += retVal;
   loopbackBufferSize += retVal*2;
-   
+
   return retVal;
 #endif
 }
 
-bool USRPDevice::updateAlignment(TIMESTAMP timestamp) 
+int USRPDevice::writeSamples(std::vector<short *> &bufs, int len,
+                             bool *underrun, unsigned long long timestamp)
 {
-#ifndef SWLOOPBACK 
+  return writeSamplesControl(bufs, len, underrun, timestamp, false);
+}
+
+bool USRPDevice::updateAlignment(TIMESTAMP timestamp)
+{
+#ifndef SWLOOPBACK
   short data[] = {0x00,0x02,0x00,0x00};
   uint32_t *wordPtr = (uint32_t *) data;
   *wordPtr = host_to_usrp_u32(*wordPtr);
   bool tmpUnderrun;
 
   std::vector<short *> buf(1, data);
-  if (writeSamples(buf, 1, &tmpUnderrun, timestamp & 0x0ffffffffll, true)) {
+  if (writeSamplesControl(buf, 1, &tmpUnderrun, timestamp & 0x0ffffffffll, true)) {
     pingTimestamp = timestamp;
     return true;
   }
@@ -543,25 +595,25 @@ bool USRPDevice::updateAlignment(TIMESTAMP timestamp)
 #endif
 }
 
-#ifndef SWLOOPBACK 
+#ifndef SWLOOPBACK
 bool USRPDevice::setTxFreq(double wFreq, size_t chan)
 {
   usrp_tune_result result;
 
   if (chan) {
-    LOG(ALERT) << "Invalid channel " << chan;
+    LOGC(DDEV, ALERT) << "Invalid channel " << chan;
     return false;
   }
 
   if (m_uTx->tune(txSubdevSpec.side, m_dbTx, wFreq, &result)) {
-    LOG(INFO) << "set TX: " << wFreq << std::endl
+    LOGC(DDEV, INFO) << "set TX: " << wFreq << std::endl
               << "    baseband freq: " << result.baseband_freq << std::endl
               << "    DDC freq:      " << result.dxc_freq << std::endl
               << "    residual freq: " << result.residual_freq;
     return true;
   }
   else {
-    LOG(ALERT) << "set TX: " << wFreq << "failed" << std::endl
+    LOGC(DDEV, ALERT) << "set TX: " << wFreq << " failed" << std::endl
                << "    baseband freq: " << result.baseband_freq << std::endl
                << "    DDC freq:      " << result.dxc_freq << std::endl
                << "    residual freq: " << result.residual_freq;
@@ -574,19 +626,19 @@ bool USRPDevice::setRxFreq(double wFreq, size_t chan)
   usrp_tune_result result;
 
   if (chan) {
-    LOG(ALERT) << "Invalid channel " << chan;
+    LOGC(DDEV, ALERT) << "Invalid channel " << chan;
     return false;
   }
 
   if (m_uRx->tune(0, m_dbRx, wFreq, &result)) {
-    LOG(INFO) << "set RX: " << wFreq << std::endl
+    LOGC(DDEV, INFO) << "set RX: " << wFreq << std::endl
               << "    baseband freq: " << result.baseband_freq << std::endl
               << "    DDC freq:      " << result.dxc_freq << std::endl
               << "    residual freq: " << result.residual_freq;
     return true;
   }
   else {
-    LOG(ALERT) << "set RX: " << wFreq << "failed" << std::endl
+    LOGC(DDEV, ALERT) << "set RX: " << wFreq << " failed" << std::endl
                << "    baseband freq: " << result.baseband_freq << std::endl
                << "    DDC freq:      " << result.dxc_freq << std::endl
                << "    residual freq: " << result.residual_freq;
@@ -601,7 +653,21 @@ bool USRPDevice::setRxFreq(double wFreq) { return true;};
 #endif
 
 RadioDevice *RadioDevice::make(size_t tx_sps, size_t rx_sps,
-			       size_t chans, double)
+			       InterfaceType iface, size_t chans, double lo_offset,
+			       const std::vector<std::string>& tx_paths,
+			       const std::vector<std::string>& rx_paths)
 {
-	return new USRPDevice(tx_sps);
+	if (tx_sps != rx_sps) {
+		LOGC(DDEV, ERROR) << "USRP1 requires tx_sps == rx_sps";
+		return NULL;
+	}
+	if (chans != 1) {
+		LOGC(DDEV, ERROR) << "USRP1 supports only 1 channel";
+		return NULL;
+	}
+	if (lo_offset != 0.0) {
+		LOGC(DDEV, ERROR) << "USRP1 doesn't support lo_offset";
+		return NULL;
+	}
+	return new USRPDevice(tx_sps, rx_sps, iface, chans, lo_offset, tx_paths, rx_paths);
 }

Transceiver52M/device/usrp1/USRPDevice.h

@@ -1,7 +1,10 @@
 /*
 * Copyright 2008 Free Software Foundation, Inc.
 *
-* This software is distributed under multiple licenses; see the COPYING file in the main directory for licensing information for this specific distribuion.
+* SPDX-License-Identifier: AGPL-3.0+
+*
+* This software is distributed under multiple licenses; see the COPYING file in
+* the main directory for licensing information for this specific distribution.
 *
 * This use of this software may be subject to additional restrictions.
 * See the LEGAL file in the main directory for details.
@@ -48,15 +51,10 @@ private:
   usrp_subdev_spec rxSubdevSpec;
   usrp_subdev_spec txSubdevSpec;
 
-  int sps;
   double actualSampleRate;	///< the actual USRP sampling rate
   unsigned int decimRate;	///< the USRP decimation rate
 
-  unsigned long long samplesRead;	///< number of samples read from USRP
-  unsigned long long samplesWritten;	///< number of samples sent to USRP
-
   bool started;			///< flag indicates USRP has started
-  bool skipRx;			///< set if USRP is transmit-only.
 
   static const unsigned int currDataSize_log2 = 21;
   static const unsigned long currDataSize = (1 << currDataSize_log2);
@@ -82,11 +80,15 @@ private:
   unsigned long lastPktTimestamp;
 
   double rxGain;
+  double txGain;
 
-#ifdef SWLOOPBACK 
+  int writeSamplesControl(std::vector<short *> &bufs, int len, bool *underrun,
+                   TIMESTAMP timestamp = 0xffffffff, bool isControl = false);
+
+#ifdef SWLOOPBACK
   short loopbackBuffer[1000000];
   int loopbackBufferSize;
-  double samplePeriod; 
+  double samplePeriod;
 
   struct timeval startTime;
   struct timeval lastReadTime;
@@ -96,7 +98,9 @@ private:
  public:
 
   /** Object constructor */
-  USRPDevice(size_t sps);
+  USRPDevice(size_t tx_sps, size_t rx_sps, InterfaceType iface, size_t chan_num, double lo_offset,
+		const std::vector<std::string>& tx_paths,
+		const std::vector<std::string>& rx_paths);
 
   /** Instantiate the USRP */
   int open(const std::string &, int, bool);
@@ -107,9 +111,6 @@ private:
   /** Stop the USRP */
   bool stop();
 
-  /** Set priority not supported */
-  void setPriority(float prio = 0.5) { }
-
   enum TxWindowType getWindowType() { return TX_WINDOW_USRP1; }
 
   /**
@@ -119,23 +120,20 @@ private:
 	@param overrun Set if read buffer has been overrun, e.g. data not being read fast enough
 	@param timestamp The timestamp of the first samples to be read
 	@param underrun Set if USRP does not have data to transmit, e.g. data not being sent fast enough
-	@param RSSI The received signal strength of the read result
 	@return The number of samples actually read
   */
   int readSamples(std::vector<short *> &buf, int len, bool *overrun,
-                  TIMESTAMP timestamp = 0xffffffff, bool *underrun = NULL,
-                  unsigned *RSSI = NULL);
+                  TIMESTAMP timestamp = 0xffffffff, bool *underrun = NULL);
   /**
         Write samples to the USRP.
         @param buf Contains the data to be written.
         @param len number of samples to write.
         @param underrun Set if USRP does not have data to transmit, e.g. data not being sent fast enough
         @param timestamp The timestamp of the first sample of the data buffer.
-        @param isControl Set if data is a control packet, e.g. a ping command
         @return The number of samples actually written
   */
   int writeSamples(std::vector<short *> &bufs, int len, bool *underrun,
-                   TIMESTAMP timestamp = 0xffffffff, bool isControl = false);
+                   TIMESTAMP timestamp = 0xffffffff);
 
   /** Update the alignment between the read and write timestamps */
   bool updateAlignment(TIMESTAMP timestamp);
@@ -173,20 +171,37 @@ private:
   /** sets the transmit chan gain, returns the gain setting **/
   double setTxGain(double dB, size_t chan = 0);
 
+  /** get transmit gain */
+  double getTxGain(size_t chan = 0) { return txGain; }
+
   /** return maximum Tx Gain **/
   double maxTxGain(void);
 
   /** return minimum Rx Gain **/
   double minTxGain(void);
 
+  /** sets the RX path to use, returns true if successful and false otherwise */
+  bool setRxAntenna(const std::string &ant, size_t chan = 0);
+
+  /* return the used RX path */
+  std::string getRxAntenna(size_t chan = 0);
+
+  /** sets the RX path to use, returns true if successful and false otherwise */
+  bool setTxAntenna(const std::string &ant, size_t chan = 0);
+
+  /* return the used RX path */
+  std::string getTxAntenna(size_t chan = 0);
+
+  /** return whether user drives synchronization of Tx/Rx of USRP */
+  bool requiresRadioAlign();
+
+  /** return whether user drives synchronization of Tx/Rx of USRP */
+  virtual GSM::Time minLatency();
+
   /** Return internal status values */
   inline double getTxFreq(size_t chan = 0) { return 0; }
   inline double getRxFreq(size_t chan = 0) { return 0; }
   inline double getSampleRate() { return actualSampleRate; }
-  inline double numberRead() { return samplesRead; }
-  inline double numberWritten() { return samplesWritten; }
-
 };
 
 #endif // _USRP_DEVICE_H_
-

Transceiver52M/inband-signaling-usb

@@ -1,314 +0,0 @@
-This file specifies the format of USB packets used for in-band data
-transmission and signaling on the USRP.  All packets are 512-byte long,
-and are transfered using USB "bulk" transfers.
-
-IN packets are sent towards the host.
-OUT packets are sent away from the host.
-
-The layout is 32-bits wide.  All data is transmitted in little-endian
-format across the USB.
-
-
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |O|U|D|S|E|   RSSI    |  Chan   | mbz |  Tag  |   Payload Len   |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |                           Timestamp                           |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |                                                               |
-   +                                                               +
-   |                            Payload                            |
-   .                                                               .
-   .                                                               .
-   .                                                               .
-   |                                                               |
-   +             +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |      ...    |                                                 .
-   +-+-+-+-+-+-+-+                                                 .
-   .                                                               .
-   .                            Padding                            .
-   .                                                               .
-   |                                                               |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   
-
-  mbz   Must be Zero: these bits must be zero in both IN and OUT packets.
-
-  O     Overrun Flag: set in an IN packet if an overrun condition was
-        detected.  Must be zero in OUT packets.  Overrun occurs when
-        the FPGA has data to transmit to the host and there is no
-        buffer space available.  This generally indicates a problem on
-        the host.  Either it is not keeping up, or it has configured
-        the FPGA to transmit data at a higher rate than the transport
-        (USB) can support.
-
-  U     Underrun Flag: set in an IN packet if an underrun condition
-        was detected.  Must be zero in OUT packets.  Underrun occurs
-        when the FPGA runs out of samples, and it's not between
-        bursts.  See the "End of Burst flag" below.
-
-  D     Dropped Packet Flag: Set in an IN packet if the FPGA
-	discarded an OUT packet because its timestamp had already
-	passed.
-
-  S     Start of Burst Flag:  Set in an OUT packet if the data is the
-        first segment of what is logically a continuous burst of data.
-        Must be zero in IN packets.
-
-  E     End of Burst Flag:  Set in an OUT packet if the data is the
-        last segment of what is logically a continuous burst of data.
-        Must be zero in IN packets.  Underruns are not reported
-        when the FPGA runs out of samples between bursts.
-
-
-  RSSI  6-bit Received Strength Signal Indicator:  Must be zero in OUT
-        packets.  In IN packets, indicates RSSI as reported by front end.
-	FIXME The format and interpretation are to be determined.
-
-  Chan  5-bit logical channel number.  Channel number 0x1f is reserved
-        for control information.  See "Control Channel" below.  Other
-        channels are "data channels."  Each data channel is logically
-        independent of the others.  A data channel payload field
-        contains a sequence of homogeneous samples.  The format of the
-        samples is determined by the configuration associated with the
-        given channel.  It is often the case that the payload field
-        contains 32-bit complex samples, each containing 16-bit real
-        and imaginary components.
-
-  Tag   4-bit tag for matching IN packets with OUT packets.
-        [FIXME, write more...]
-
-  Payload Len: 9-bit field that specifies the length of the payload
-        field in bytes.  Must be in the range 0 to 504 inclusive.
-
-  Timestamp: 32-bit timestamp.
-	On IN packets, the timestamp indicates the time at which the
-	first sample of the packet was produced by the A/D converter(s)
-        for that channel.  On OUT packets, the timestamp specifies the
-        time at which the first sample in the packet should go out the
-        D/A converter(s) for that channel.  If a packet reaches the
-	head of the transmit queue, and the current time is later than
-	the timestamp, an error is assumed to have occurred and the
-	packet is discarded.  As a special case, the timestamp
-	0xffffffff is interpreted as "Now".
-
-	The time base is a free running 32-bit counter that is
-	incremented by the A/D sample-clock.
-
-  Payload: Variable length field.  Length is specified by the
-        Payload Len field.
-
-  Padding: This field is 504 - Payload Len bytes long, and its content
-        is unspecified.  This field pads the packet out to a constant
-        512 bytes.
-
-
-
-"Data Channel" payload format:
--------------------------------
-
-If Chan != 0x1f, the packet is a "data packet" and the payload is a
-sequence of homogeneous samples.  The format of the samples is
-determined by the configuration associated with the given channel.  
-It is often the case that the payload field contains 32-bit complex
-samples, each containing 16-bit real and imaginary components.
-
-
-"Control Channel" payload format:
----------------------------------
-
-If Chan == 0x1f, the packet is a "control packet".  The control channel
-payload consists of a sequence of 0 or more sub-packets.
-
-Each sub-packet starts on a 32-bit boundary, and consists of an 8-bit
-Opcode field, an 8-bit Length field, Length bytes of arguments, and 0,
-1, 2 or 3 bytes of padding to align the tail of the sub-packet to
-a 32-bit boundary.
-
-Control channel packets shall be processed at the head of the queue,
-and shall observe the timestamp semantics described above.
-
-
-General sub-packet format:
---------------------------
-
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-//-+-+-+-+-+-+-+-+
-   |     Opcode    |    Length     |        <length bytes> ...    |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-//-+-+-+-+-+-+-+-+
-
-
-Specific sub-packet formats:
-----------------------------
-
-  RID: 6-bit Request-ID. Copied from request sub-packet into corresponding
-       reply sub-packet.  RID allows the host to match requests and replies.
-
-  Reg Number: 10-bit Register Number.
-
-
-
-Ping Fixed Length:
-
-    Opcode:	OP_PING_FIXED
-
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |     Opcode    |       2       |    RID    |     Ping Value    |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-
-
-Ping Fixed Length Reply:
-
-    Opcode:	OP_PING_FIXED_REPLY
-
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |     Opcode    |       2       |    RID    |     Ping Value    |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-
-
-Write Register:
-
-    Opcode:	OP_WRITE_REG
-
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |     Opcode    |       6       |    mbz    |     Reg Number    |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |                        Register Value                         |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-
-
-Write Register Masked:
-
-    Opcode:	OP_WRITE_REG_MASKED
-
-    REG[Num] = (REG[Num] & ~Mask) | (Value & Mask)
-
-    That is, only the register bits that correspond to 1's in the
-    mask are written with the new value.
-
-
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |     Opcode    |      10       |    mbz    |     Reg Number    |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |                         Register Value                        |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |                           Mask Value                          |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-
-
-Read Register:
-
-    Opcode:	OP_READ_REG
-
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |     Opcode    |       2       |    RID    |     Reg Number    |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-
-
-Read Register Reply:
-
-    Opcode:	OP_READ_REG_REPLY
-
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |     Opcode    |       6       |    RID    |     Reg Number    |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |                        Register Value                         |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-
-
-I2C Write:
-
-    Opcode:	OP_I2C_WRITE
-    I2C Addr:   7-bit I2C address
-    Data:	The bytes to write to the I2C bus
-    Length:     Length of Data + 2
-
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |     Opcode    |    Length     |       mbz       |   I2C Addr  |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |    Data ...			                           .
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-
-
-I2C Read:
-
-    Opcode:	OP_I2C_READ
-    I2C Addr:	7-bit I2C address
-    Nbytes:	Number of bytes to read from I2C bus
-
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |     Opcode    |       3       |    RID    | mbz |   I2C Addr  |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |     Nbytes    |              unspecified padding              |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-
-
-I2C Read Reply:
-
-    Opcode:	OP_I2C_READ_REPLY
-    I2C Addr:	7-bit I2C address
-    Data:	Length - 2 bytes of data read from I2C bus.
-
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |     Opcode    |     Length    |    RID    | mbz |   I2C Addr  |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |    Data ...			                           .
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-
-
-SPI Write:
-
-    Opcode:	      OP_SPI_WRITE
-    Enables:	      Which SPI enables to assert (mask)
-    Format:	      Specifies format of SPI data and Opt Header Bytes
-    Opt Header Bytes: 2-byte field containing optional Tx bytes; see Format
-    Data:	      The bytes to write to the SPI bus
-    Length:	      Length of Data + 6
-
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |     Opcode    |    Length     |              mbz              |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |    Enables    |    Format     |        Opt Header Bytes       |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |    Data ...			                           .
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-
-
-SPI Read:
-
-    Opcode:	      OP_SPI_READ
-    Enables:	      Which SPI enables to assert (mask)
-    Format:	      Specifies format of SPI data and Opt Header Bytes
-    Opt Header Bytes: 2-byte field containing optional Tx bytes; see Format
-    Nbytes:	      Number of bytes to read from SPI bus.
-
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |     Opcode    |       7       |    RID    |        mbz        |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |    Enables    |    Format     |        Opt Header Bytes       |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |     Nbytes    |              unspecified padding              |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-
-
-SPI Read Reply:
-
-    Opcode:   OP_SPI_READ_REPLY
-    Data:     Length - 2 bytes of data read from SPI bus.
-
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |     Opcode    |     Length    |    RID    |        mbz        |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |    Data ...			                           .
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-
-
-Delay:
-
-    Opcode:	OP_DELAY
-    Ticks:	16-bit unsigned delay count
-
-    Delay Ticks clock ticks before executing next operation.
-
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |     Opcode    |       2       |            Ticks              |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-