blob: b63cc4c25f0ad9f83a3a9447e686ba50952eb14b [file] [log] [blame]
dburgessb3a0ca42011-10-12 07:44:40 +00001/*
2* Copyright 2008 Free Software Foundation, Inc.
3*
4* This software is distributed under multiple licenses; see the COPYING file in the main directory for licensing information for this specific distribuion.
5*
6* This use of this software may be subject to additional restrictions.
7* See the LEGAL file in the main directory for details.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12
13*/
14
15
16
17#include "sigProcLib.h"
18#include "GSMCommon.h"
19#include "LinkedLists.h"
20#include "radioDevice.h"
kurtis.heimerl8aea56e2011-11-26 03:18:30 +000021#include "radioVector.h"
22#include "radioClock.h"
Tom Tsou28670fb2015-08-21 19:32:58 -070023#include "radioBuffer.h"
Thomas Tsoue90a42b2013-11-13 23:38:09 -050024#include "Resampler.h"
Tom Tsou76764272016-06-24 14:25:39 -070025#include "Channelizer.h"
26#include "Synthesis.h"
dburgessb3a0ca42011-10-12 07:44:40 +000027
Alexander Chemerisd734e2d2013-06-16 14:30:58 +040028static const unsigned gSlotLen = 148; ///< number of symbols per slot, not counting guard periods
29
dburgessb3a0ca42011-10-12 07:44:40 +000030/** class to interface the transceiver with the USRP */
31class RadioInterface {
32
Thomas Tsoucb69f082013-04-08 14:18:26 -040033protected:
dburgessb3a0ca42011-10-12 07:44:40 +000034
35 Thread mAlignRadioServiceLoopThread; ///< thread that synchronizes transmit and receive sections
36
Thomas Tsou204a9f12013-10-29 18:34:16 -040037 std::vector<VectorFIFO> mReceiveFIFO; ///< FIFO that holds receive bursts
dburgessb3a0ca42011-10-12 07:44:40 +000038
39 RadioDevice *mRadio; ///< the USRP object
Thomas Tsouc1f7c422013-10-11 13:49:55 -040040
Thomas Tsou204a9f12013-10-29 18:34:16 -040041 size_t mSPSTx;
42 size_t mSPSRx;
43 size_t mChans;
Thomas Tsoue90a42b2013-11-13 23:38:09 -050044 size_t mMIMO;
45
Tom Tsou28670fb2015-08-21 19:32:58 -070046 std::vector<RadioBuffer *> sendBuffer;
47 std::vector<RadioBuffer *> recvBuffer;
dburgessb3a0ca42011-10-12 07:44:40 +000048
Thomas Tsou204a9f12013-10-29 18:34:16 -040049 std::vector<short *> convertRecvBuffer;
50 std::vector<short *> convertSendBuffer;
Thomas Tsoucb269a32013-11-15 14:15:47 -050051 std::vector<float> powerScaling;
dburgessb3a0ca42011-10-12 07:44:40 +000052 bool underrun; ///< indicates writes to USRP are too slow
53 bool overrun; ///< indicates reads from USRP are too slow
54 TIMESTAMP writeTimestamp; ///< sample timestamp of next packet written to USRP
55 TIMESTAMP readTimestamp; ///< sample timestamp of next packet read from USRP
56
57 RadioClock mClock; ///< the basestation clock!
58
dburgessb3a0ca42011-10-12 07:44:40 +000059 int receiveOffset; ///< offset b/w transmit and receive GSM timestamps, in timeslots
dburgessb3a0ca42011-10-12 07:44:40 +000060
61 bool mOn; ///< indicates radio is on
62
Thomas Tsoucb69f082013-04-08 14:18:26 -040063private:
64
Tom Tsou28670fb2015-08-21 19:32:58 -070065 /** format samples to USRP */
66 int radioifyVector(signalVector &wVector, size_t chan, bool zero);
dburgessb3a0ca42011-10-12 07:44:40 +000067
68 /** format samples from USRP */
Tom Tsou28670fb2015-08-21 19:32:58 -070069 int unRadioifyVector(signalVector *wVector, size_t chan);
dburgessb3a0ca42011-10-12 07:44:40 +000070
71 /** push GSM bursts into the transmit buffer */
Tom Tsou28670fb2015-08-21 19:32:58 -070072 virtual bool pushBuffer(void);
dburgessb3a0ca42011-10-12 07:44:40 +000073
74 /** pull GSM bursts from the receive buffer */
Thomas Tsoucb69f082013-04-08 14:18:26 -040075 virtual void pullBuffer(void);
dburgessb3a0ca42011-10-12 07:44:40 +000076
77public:
78
79 /** start the interface */
Tom Tsoueb54bdd2014-11-25 16:06:32 -080080 bool start();
81 bool stop();
dburgessb3a0ca42011-10-12 07:44:40 +000082
Thomas Tsou03e6ecf2013-08-20 20:54:54 -040083 /** intialization */
Thomas Tsoufe269fe2013-10-14 23:56:51 -040084 virtual bool init(int type);
Thomas Tsou03e6ecf2013-08-20 20:54:54 -040085 virtual void close();
86
dburgessb3a0ca42011-10-12 07:44:40 +000087 /** constructor */
88 RadioInterface(RadioDevice* wRadio = NULL,
Tom Tsou5cd70dc2016-03-06 01:28:40 -080089 size_t tx_sps = 4, size_t rx_sps = 1,
90 size_t chans = 1, size_t diversity = 1,
Thomas Tsoue90a42b2013-11-13 23:38:09 -050091 int receiveOffset = 3, GSM::Time wStartTime = GSM::Time(0));
Thomas Tsou204a9f12013-10-29 18:34:16 -040092
dburgessb3a0ca42011-10-12 07:44:40 +000093 /** destructor */
Thomas Tsou03e6ecf2013-08-20 20:54:54 -040094 virtual ~RadioInterface();
dburgessb3a0ca42011-10-12 07:44:40 +000095
dburgessb3a0ca42011-10-12 07:44:40 +000096 /** check for underrun, resets underrun value */
kurtis.heimerle724d6d2011-11-26 03:18:46 +000097 bool isUnderrun();
dburgessb3a0ca42011-10-12 07:44:40 +000098
99 /** return the receive FIFO */
Thomas Tsou204a9f12013-10-29 18:34:16 -0400100 VectorFIFO* receiveFIFO(size_t chan = 0);
dburgessb3a0ca42011-10-12 07:44:40 +0000101
102 /** return the basestation clock */
103 RadioClock* getClock(void) { return &mClock;};
104
dburgessb3a0ca42011-10-12 07:44:40 +0000105 /** set transmit frequency */
Tom Tsou76764272016-06-24 14:25:39 -0700106 virtual bool tuneTx(double freq, size_t chan = 0);
dburgessb3a0ca42011-10-12 07:44:40 +0000107
108 /** set receive frequency */
Thomas Tsoue90a42b2013-11-13 23:38:09 -0500109 virtual bool tuneRx(double freq, size_t chan = 0);
dburgessb3a0ca42011-10-12 07:44:40 +0000110
kurtis.heimerle724d6d2011-11-26 03:18:46 +0000111 /** set receive gain */
Thomas Tsou204a9f12013-10-29 18:34:16 -0400112 double setRxGain(double dB, size_t chan = 0);
kurtis.heimerle724d6d2011-11-26 03:18:46 +0000113
114 /** get receive gain */
Thomas Tsou204a9f12013-10-29 18:34:16 -0400115 double getRxGain(size_t chan = 0);
kurtis.heimerle724d6d2011-11-26 03:18:46 +0000116
dburgessb3a0ca42011-10-12 07:44:40 +0000117 /** drive transmission of GSM bursts */
Thomas Tsou204a9f12013-10-29 18:34:16 -0400118 void driveTransmitRadio(std::vector<signalVector *> &bursts,
119 std::vector<bool> &zeros);
dburgessb3a0ca42011-10-12 07:44:40 +0000120
121 /** drive reception of GSM bursts */
Thomas Tsou204a9f12013-10-29 18:34:16 -0400122 bool driveReceiveRadio();
dburgessb3a0ca42011-10-12 07:44:40 +0000123
Tom Tsoua4d1a412014-11-25 15:46:56 -0800124 int setPowerAttenuation(int atten, size_t chan = 0);
dburgessb3a0ca42011-10-12 07:44:40 +0000125
126 /** returns the full-scale transmit amplitude **/
127 double fullScaleInputValue();
128
129 /** returns the full-scale receive amplitude **/
130 double fullScaleOutputValue();
131
kurtis.heimerl6b495a52011-11-26 03:17:21 +0000132 /** set thread priority on current thread */
Thomas Tsou7553aa92013-11-08 12:50:03 -0500133 void setPriority(float prio = 0.5) { mRadio->setPriority(prio); }
dburgessb3a0ca42011-10-12 07:44:40 +0000134
Thomas Tsou02d88d12013-04-05 15:36:30 -0400135 /** get transport window type of attached device */
136 enum RadioDevice::TxWindowType getWindowType() { return mRadio->getWindowType(); }
kurtis.heimerle380af32011-11-26 03:18:55 +0000137
Thomas Tsouf2293b82013-04-08 13:35:36 -0400138#if USRP1
dburgessb3a0ca42011-10-12 07:44:40 +0000139protected:
140
141 /** drive synchronization of Tx/Rx of USRP */
142 void alignRadio();
143
dburgessb3a0ca42011-10-12 07:44:40 +0000144 friend void *AlignRadioServiceLoopAdapter(RadioInterface*);
Thomas Tsouf2293b82013-04-08 13:35:36 -0400145#endif
dburgessb3a0ca42011-10-12 07:44:40 +0000146};
147
Thomas Tsouf2293b82013-04-08 13:35:36 -0400148#if USRP1
dburgessb3a0ca42011-10-12 07:44:40 +0000149/** synchronization thread loop */
150void *AlignRadioServiceLoopAdapter(RadioInterface*);
Thomas Tsouf2293b82013-04-08 13:35:36 -0400151#endif
Thomas Tsoucb69f082013-04-08 14:18:26 -0400152
153class RadioInterfaceResamp : public RadioInterface {
Thomas Tsoucb69f082013-04-08 14:18:26 -0400154private:
Thomas Tsou03e6ecf2013-08-20 20:54:54 -0400155 signalVector *outerSendBuffer;
Thomas Tsou03e6ecf2013-08-20 20:54:54 -0400156 signalVector *outerRecvBuffer;
Thomas Tsoucb69f082013-04-08 14:18:26 -0400157
Tom Tsou28670fb2015-08-21 19:32:58 -0700158 bool pushBuffer();
Thomas Tsoucb69f082013-04-08 14:18:26 -0400159 void pullBuffer();
160
161public:
Thomas Tsoue90a42b2013-11-13 23:38:09 -0500162 RadioInterfaceResamp(RadioDevice* wRadio, size_t wSPS = 4, size_t chans = 1);
Thomas Tsou03e6ecf2013-08-20 20:54:54 -0400163 ~RadioInterfaceResamp();
164
Thomas Tsoufe269fe2013-10-14 23:56:51 -0400165 bool init(int type);
Thomas Tsou03e6ecf2013-08-20 20:54:54 -0400166 void close();
Thomas Tsoucb69f082013-04-08 14:18:26 -0400167};
Thomas Tsoue90a42b2013-11-13 23:38:09 -0500168
Tom Tsou76764272016-06-24 14:25:39 -0700169class RadioInterfaceMulti : public RadioInterface {
170private:
171 bool pushBuffer();
172 void pullBuffer();
173
174 signalVector *outerSendBuffer;
175 signalVector *outerRecvBuffer;
176 std::vector<signalVector *> history;
177 std::vector<bool> active;
178
179 Resampler *dnsampler;
180 Resampler *upsampler;
181 Channelizer *channelizer;
182 Synthesis *synthesis;
183
184public:
185 RadioInterfaceMulti(RadioDevice* radio, size_t tx_sps,
186 size_t rx_sps, size_t chans = 1);
187 ~RadioInterfaceMulti();
188
189 bool init(int type);
190 void close();
191
192 bool tuneTx(double freq, size_t chan);
193 bool tuneRx(double freq, size_t chan);
194 double setRxGain(double dB, size_t chan);
195};
196
Thomas Tsoue90a42b2013-11-13 23:38:09 -0500197class RadioInterfaceDiversity : public RadioInterface {
198public:
199 RadioInterfaceDiversity(RadioDevice* wRadio,
200 size_t sps = 4, size_t chans = 2);
201
202 ~RadioInterfaceDiversity();
203
204 bool init(int type);
205 void close();
206 bool tuneRx(double freq, size_t chan);
207
208private:
Tom Tsou28670fb2015-08-21 19:32:58 -0700209 Resampler *dnsampler;
Thomas Tsoue90a42b2013-11-13 23:38:09 -0500210 std::vector<float> phases;
211 signalVector *outerRecvBuffer;
212
213 bool mDiversity;
214 double mFreqSpacing;
215
216 bool setupDiversityChannels();
217 void pullBuffer();
218};