blob: 3624c58588ed852d98cb87d9f63ab7c55d96459d [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#ifndef __RADIO_DEVICE_H__
16#define __RADIO_DEVICE_H__
17
ttsouf60dafa2012-10-22 00:07:14 +000018#include <string>
Thomas Tsou204a9f12013-10-29 18:34:16 -040019#include <vector>
dburgessb3a0ca42011-10-12 07:44:40 +000020
21#ifdef HAVE_CONFIG_H
22#include "config.h"
23#endif
24
Alexander Chemerisf931cf22016-06-18 10:42:33 +030025#define GSMRATE (1625e3/6)
Tom Tsou76764272016-06-24 14:25:39 -070026#define MCBTS_SPACING 800000.0
Thomas Tsoucb69f082013-04-08 14:18:26 -040027
dburgessb3a0ca42011-10-12 07:44:40 +000028/** a 64-bit virtual timestamp for radio data */
29typedef unsigned long long TIMESTAMP;
30
31/** A class to handle a USRP rev 4, with a two RFX900 daughterboards */
32class RadioDevice {
33
34 public:
kurtis.heimerle380af32011-11-26 03:18:55 +000035 /* Available transport bus types */
Thomas Tsou02d88d12013-04-05 15:36:30 -040036 enum TxWindowType { TX_WINDOW_USRP1, TX_WINDOW_FIXED };
kurtis.heimerle380af32011-11-26 03:18:55 +000037
Thomas Tsoucb69f082013-04-08 14:18:26 -040038 /* Radio interface types */
Tom Tsou05c6feb2016-06-22 16:09:44 -070039 enum InterfaceType {
40 NORMAL,
41 RESAMP_64M,
42 RESAMP_100M,
Tom Tsou76764272016-06-24 14:25:39 -070043 MULTI_ARFCN,
Tom Tsou05c6feb2016-06-22 16:09:44 -070044 };
Thomas Tsoucb69f082013-04-08 14:18:26 -040045
Tom Tsou2f3e60b2016-07-17 19:29:08 -070046 enum ReferenceType {
47 REF_INTERNAL,
48 REF_EXTERNAL,
49 REF_GPS,
50 };
51
Tom Tsou05c6feb2016-06-22 16:09:44 -070052 static RadioDevice *make(size_t tx_sps, size_t rx_sps, InterfaceType type,
53 size_t chans = 1, double offset = 0.0);
kurtis.heimerl965e7572011-11-26 03:16:54 +000054
kurtis.heimerldb2aae52011-11-26 03:17:13 +000055 /** Initialize the USRP */
Tom Tsou2f3e60b2016-07-17 19:29:08 -070056 virtual int open(const std::string &args, int ref, bool swap_channels)=0;
dburgessb3a0ca42011-10-12 07:44:40 +000057
Thomas Tsou8c336792013-11-15 16:26:05 -050058 virtual ~RadioDevice() { }
59
dburgessb3a0ca42011-10-12 07:44:40 +000060 /** Start the USRP */
61 virtual bool start()=0;
62
63 /** Stop the USRP */
64 virtual bool stop()=0;
65
Thomas Tsou02d88d12013-04-05 15:36:30 -040066 /** Get the Tx window type */
67 virtual enum TxWindowType getWindowType()=0;
kurtis.heimerle380af32011-11-26 03:18:55 +000068
kurtis.heimerldb2aae52011-11-26 03:17:13 +000069 /** Enable thread priority */
Thomas Tsou7553aa92013-11-08 12:50:03 -050070 virtual void setPriority(float prio = 0.5) = 0;
kurtis.heimerldb2aae52011-11-26 03:17:13 +000071
dburgessb3a0ca42011-10-12 07:44:40 +000072 /**
73 Read samples from the radio.
74 @param buf preallocated buf to contain read result
75 @param len number of samples desired
76 @param overrun Set if read buffer has been overrun, e.g. data not being read fast enough
77 @param timestamp The timestamp of the first samples to be read
78 @param underrun Set if radio does not have data to transmit, e.g. data not being sent fast enough
79 @param RSSI The received signal strength of the read result
80 @return The number of samples actually read
81 */
Thomas Tsou204a9f12013-10-29 18:34:16 -040082 virtual int readSamples(std::vector<short *> &bufs, int len, bool *overrun,
83 TIMESTAMP timestamp = 0xffffffff, bool *underrun = 0,
84 unsigned *RSSI = 0) = 0;
dburgessb3a0ca42011-10-12 07:44:40 +000085 /**
86 Write samples to the radio.
87 @param buf Contains the data to be written.
88 @param len number of samples to write.
89 @param underrun Set if radio does not have data to transmit, e.g. data not being sent fast enough
90 @param timestamp The timestamp of the first sample of the data buffer.
91 @param isControl Set if data is a control packet, e.g. a ping command
92 @return The number of samples actually written
93 */
Thomas Tsou204a9f12013-10-29 18:34:16 -040094 virtual int writeSamples(std::vector<short *> &bufs, int len, bool *underrun,
95 TIMESTAMP timestamp, bool isControl = false) = 0;
96
dburgessb3a0ca42011-10-12 07:44:40 +000097 /** Update the alignment between the read and write timestamps */
98 virtual bool updateAlignment(TIMESTAMP timestamp)=0;
Thomas Tsou204a9f12013-10-29 18:34:16 -040099
dburgessb3a0ca42011-10-12 07:44:40 +0000100 /** Set the transmitter frequency */
Thomas Tsou204a9f12013-10-29 18:34:16 -0400101 virtual bool setTxFreq(double wFreq, size_t chan = 0) = 0;
dburgessb3a0ca42011-10-12 07:44:40 +0000102
103 /** Set the receiver frequency */
Thomas Tsou204a9f12013-10-29 18:34:16 -0400104 virtual bool setRxFreq(double wFreq, size_t chan = 0) = 0;
dburgessb3a0ca42011-10-12 07:44:40 +0000105
106 /** Returns the starting write Timestamp*/
107 virtual TIMESTAMP initialWriteTimestamp(void)=0;
108
109 /** Returns the starting read Timestamp*/
110 virtual TIMESTAMP initialReadTimestamp(void)=0;
111
112 /** returns the full-scale transmit amplitude **/
113 virtual double fullScaleInputValue()=0;
114
115 /** returns the full-scale receive amplitude **/
116 virtual double fullScaleOutputValue()=0;
117
118 /** sets the receive chan gain, returns the gain setting **/
Thomas Tsou204a9f12013-10-29 18:34:16 -0400119 virtual double setRxGain(double dB, size_t chan = 0) = 0;
dburgessb3a0ca42011-10-12 07:44:40 +0000120
121 /** gets the current receive gain **/
Thomas Tsou204a9f12013-10-29 18:34:16 -0400122 virtual double getRxGain(size_t chan = 0) = 0;
dburgessb3a0ca42011-10-12 07:44:40 +0000123
124 /** return maximum Rx Gain **/
125 virtual double maxRxGain(void) = 0;
126
127 /** return minimum Rx Gain **/
128 virtual double minRxGain(void) = 0;
129
130 /** sets the transmit chan gain, returns the gain setting **/
Thomas Tsou204a9f12013-10-29 18:34:16 -0400131 virtual double setTxGain(double dB, size_t chan = 0) = 0;
dburgessb3a0ca42011-10-12 07:44:40 +0000132
133 /** return maximum Tx Gain **/
134 virtual double maxTxGain(void) = 0;
135
136 /** return minimum Tx Gain **/
137 virtual double minTxGain(void) = 0;
138
139 /** Return internal status values */
Thomas Tsou204a9f12013-10-29 18:34:16 -0400140 virtual double getTxFreq(size_t chan = 0) = 0;
141 virtual double getRxFreq(size_t chan = 0) = 0;
dburgessb3a0ca42011-10-12 07:44:40 +0000142 virtual double getSampleRate()=0;
143 virtual double numberRead()=0;
144 virtual double numberWritten()=0;
145
146};
147
148#endif