dburgess | b3a0ca4 | 2011-10-12 07:44:40 +0000 | [diff] [blame] | 1 | /* |
| 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 | |
ttsou | f60dafa | 2012-10-22 00:07:14 +0000 | [diff] [blame] | 18 | #include <string> |
Thomas Tsou | 204a9f1 | 2013-10-29 18:34:16 -0400 | [diff] [blame] | 19 | #include <vector> |
dburgess | b3a0ca4 | 2011-10-12 07:44:40 +0000 | [diff] [blame] | 20 | |
Pau Espin Pedrol | efac20b | 2018-02-21 14:59:19 +0100 | [diff] [blame] | 21 | extern "C" { |
| 22 | #include "config_defs.h" |
| 23 | } |
| 24 | |
dburgess | b3a0ca4 | 2011-10-12 07:44:40 +0000 | [diff] [blame] | 25 | #ifdef HAVE_CONFIG_H |
| 26 | #include "config.h" |
| 27 | #endif |
| 28 | |
Alexander Chemeris | f931cf2 | 2016-06-18 10:42:33 +0300 | [diff] [blame] | 29 | #define GSMRATE (1625e3/6) |
Tom Tsou | 7676427 | 2016-06-24 14:25:39 -0700 | [diff] [blame] | 30 | #define MCBTS_SPACING 800000.0 |
Thomas Tsou | cb69f08 | 2013-04-08 14:18:26 -0400 | [diff] [blame] | 31 | |
dburgess | b3a0ca4 | 2011-10-12 07:44:40 +0000 | [diff] [blame] | 32 | /** a 64-bit virtual timestamp for radio data */ |
| 33 | typedef unsigned long long TIMESTAMP; |
| 34 | |
| 35 | /** A class to handle a USRP rev 4, with a two RFX900 daughterboards */ |
| 36 | class RadioDevice { |
| 37 | |
| 38 | public: |
kurtis.heimerl | e380af3 | 2011-11-26 03:18:55 +0000 | [diff] [blame] | 39 | /* Available transport bus types */ |
Thomas Tsou | 02d88d1 | 2013-04-05 15:36:30 -0400 | [diff] [blame] | 40 | enum TxWindowType { TX_WINDOW_USRP1, TX_WINDOW_FIXED }; |
kurtis.heimerl | e380af3 | 2011-11-26 03:18:55 +0000 | [diff] [blame] | 41 | |
Thomas Tsou | cb69f08 | 2013-04-08 14:18:26 -0400 | [diff] [blame] | 42 | /* Radio interface types */ |
Tom Tsou | 05c6feb | 2016-06-22 16:09:44 -0700 | [diff] [blame] | 43 | enum InterfaceType { |
| 44 | NORMAL, |
| 45 | RESAMP_64M, |
| 46 | RESAMP_100M, |
Tom Tsou | 7676427 | 2016-06-24 14:25:39 -0700 | [diff] [blame] | 47 | MULTI_ARFCN, |
Tom Tsou | 05c6feb | 2016-06-22 16:09:44 -0700 | [diff] [blame] | 48 | }; |
Thomas Tsou | cb69f08 | 2013-04-08 14:18:26 -0400 | [diff] [blame] | 49 | |
Tom Tsou | 05c6feb | 2016-06-22 16:09:44 -0700 | [diff] [blame] | 50 | static RadioDevice *make(size_t tx_sps, size_t rx_sps, InterfaceType type, |
Pau Espin Pedrol | 77ce99a | 2018-02-05 13:05:06 +0100 | [diff] [blame] | 51 | size_t chans = 1, double offset = 0.0, |
| 52 | const std::vector<std::string>& tx_paths = std::vector<std::string>(1, ""), |
| 53 | const std::vector<std::string>& rx_paths = std::vector<std::string>(1, "")); |
kurtis.heimerl | 965e757 | 2011-11-26 03:16:54 +0000 | [diff] [blame] | 54 | |
kurtis.heimerl | db2aae5 | 2011-11-26 03:17:13 +0000 | [diff] [blame] | 55 | /** Initialize the USRP */ |
Tom Tsou | 2f3e60b | 2016-07-17 19:29:08 -0700 | [diff] [blame] | 56 | virtual int open(const std::string &args, int ref, bool swap_channels)=0; |
dburgess | b3a0ca4 | 2011-10-12 07:44:40 +0000 | [diff] [blame] | 57 | |
Thomas Tsou | 8c33679 | 2013-11-15 16:26:05 -0500 | [diff] [blame] | 58 | virtual ~RadioDevice() { } |
| 59 | |
dburgess | b3a0ca4 | 2011-10-12 07:44:40 +0000 | [diff] [blame] | 60 | /** Start the USRP */ |
| 61 | virtual bool start()=0; |
| 62 | |
| 63 | /** Stop the USRP */ |
| 64 | virtual bool stop()=0; |
| 65 | |
Thomas Tsou | 02d88d1 | 2013-04-05 15:36:30 -0400 | [diff] [blame] | 66 | /** Get the Tx window type */ |
| 67 | virtual enum TxWindowType getWindowType()=0; |
kurtis.heimerl | e380af3 | 2011-11-26 03:18:55 +0000 | [diff] [blame] | 68 | |
kurtis.heimerl | db2aae5 | 2011-11-26 03:17:13 +0000 | [diff] [blame] | 69 | /** Enable thread priority */ |
Thomas Tsou | 7553aa9 | 2013-11-08 12:50:03 -0500 | [diff] [blame] | 70 | virtual void setPriority(float prio = 0.5) = 0; |
kurtis.heimerl | db2aae5 | 2011-11-26 03:17:13 +0000 | [diff] [blame] | 71 | |
dburgess | b3a0ca4 | 2011-10-12 07:44:40 +0000 | [diff] [blame] | 72 | /** |
| 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 Tsou | 204a9f1 | 2013-10-29 18:34:16 -0400 | [diff] [blame] | 82 | virtual int readSamples(std::vector<short *> &bufs, int len, bool *overrun, |
| 83 | TIMESTAMP timestamp = 0xffffffff, bool *underrun = 0, |
| 84 | unsigned *RSSI = 0) = 0; |
dburgess | b3a0ca4 | 2011-10-12 07:44:40 +0000 | [diff] [blame] | 85 | /** |
| 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 Tsou | 204a9f1 | 2013-10-29 18:34:16 -0400 | [diff] [blame] | 94 | virtual int writeSamples(std::vector<short *> &bufs, int len, bool *underrun, |
| 95 | TIMESTAMP timestamp, bool isControl = false) = 0; |
| 96 | |
dburgess | b3a0ca4 | 2011-10-12 07:44:40 +0000 | [diff] [blame] | 97 | /** Update the alignment between the read and write timestamps */ |
| 98 | virtual bool updateAlignment(TIMESTAMP timestamp)=0; |
Thomas Tsou | 204a9f1 | 2013-10-29 18:34:16 -0400 | [diff] [blame] | 99 | |
dburgess | b3a0ca4 | 2011-10-12 07:44:40 +0000 | [diff] [blame] | 100 | /** Set the transmitter frequency */ |
Thomas Tsou | 204a9f1 | 2013-10-29 18:34:16 -0400 | [diff] [blame] | 101 | virtual bool setTxFreq(double wFreq, size_t chan = 0) = 0; |
dburgess | b3a0ca4 | 2011-10-12 07:44:40 +0000 | [diff] [blame] | 102 | |
| 103 | /** Set the receiver frequency */ |
Thomas Tsou | 204a9f1 | 2013-10-29 18:34:16 -0400 | [diff] [blame] | 104 | virtual bool setRxFreq(double wFreq, size_t chan = 0) = 0; |
dburgess | b3a0ca4 | 2011-10-12 07:44:40 +0000 | [diff] [blame] | 105 | |
| 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 Tsou | 204a9f1 | 2013-10-29 18:34:16 -0400 | [diff] [blame] | 119 | virtual double setRxGain(double dB, size_t chan = 0) = 0; |
dburgess | b3a0ca4 | 2011-10-12 07:44:40 +0000 | [diff] [blame] | 120 | |
| 121 | /** gets the current receive gain **/ |
Thomas Tsou | 204a9f1 | 2013-10-29 18:34:16 -0400 | [diff] [blame] | 122 | virtual double getRxGain(size_t chan = 0) = 0; |
dburgess | b3a0ca4 | 2011-10-12 07:44:40 +0000 | [diff] [blame] | 123 | |
| 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 Tsou | 204a9f1 | 2013-10-29 18:34:16 -0400 | [diff] [blame] | 131 | virtual double setTxGain(double dB, size_t chan = 0) = 0; |
dburgess | b3a0ca4 | 2011-10-12 07:44:40 +0000 | [diff] [blame] | 132 | |
| 133 | /** return maximum Tx Gain **/ |
| 134 | virtual double maxTxGain(void) = 0; |
| 135 | |
| 136 | /** return minimum Tx Gain **/ |
| 137 | virtual double minTxGain(void) = 0; |
| 138 | |
Pau Espin Pedrol | 77ce99a | 2018-02-05 13:05:06 +0100 | [diff] [blame] | 139 | /** sets the RX path to use, returns true if successful and false otherwise */ |
| 140 | virtual bool setRxAntenna(const std::string &ant, size_t chan = 0) = 0; |
| 141 | |
| 142 | /** return the used RX path */ |
| 143 | virtual std::string getRxAntenna(size_t chan = 0) = 0; |
| 144 | |
| 145 | /** sets the RX path to use, returns true if successful and false otherwise */ |
| 146 | virtual bool setTxAntenna(const std::string &ant, size_t chan = 0) = 0; |
| 147 | |
| 148 | /** return the used RX path */ |
| 149 | virtual std::string getTxAntenna(size_t chan = 0) = 0; |
| 150 | |
Pau Espin Pedrol | 0fc20d1 | 2018-04-24 17:48:52 +0200 | [diff] [blame^] | 151 | /** return whether user drives synchronization of Tx/Rx of USRP */ |
| 152 | virtual bool requiresRadioAlign() = 0; |
| 153 | |
dburgess | b3a0ca4 | 2011-10-12 07:44:40 +0000 | [diff] [blame] | 154 | /** Return internal status values */ |
Thomas Tsou | 204a9f1 | 2013-10-29 18:34:16 -0400 | [diff] [blame] | 155 | virtual double getTxFreq(size_t chan = 0) = 0; |
| 156 | virtual double getRxFreq(size_t chan = 0) = 0; |
dburgess | b3a0ca4 | 2011-10-12 07:44:40 +0000 | [diff] [blame] | 157 | virtual double getSampleRate()=0; |
| 158 | virtual double numberRead()=0; |
| 159 | virtual double numberWritten()=0; |
| 160 | |
| 161 | }; |
| 162 | |
| 163 | #endif |