aboutsummaryrefslogtreecommitdiffstats
path: root/Transceiver52M/device/xtrx/XTRXDevice.h
blob: d4810e4665aaa2106294a3dfd2b32c73fc2326fc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
#ifndef _XTRX_DEVICE_H_
#define _XTRX_DEVICE_H_

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "radioDevice.h"

#include <stdint.h>
#include <sys/time.h>
#include <string>
#include <iostream>

#include "Threads.h"
#include <xtrx_api.h>

class XTRXDevice: public RadioDevice {
private:
	int txsps;
	int rxsps;
	double actualTXSampleRate;	///< the actual XTRX sampling rate
	double actualRXSampleRate;	///< the actual XTRX sampling rate
	//unsigned int decimRate;	///< the XTRX decimation rate
	//unsigned int interRate;	///< the XTRX decimation rate

	unsigned long long samplesRead;	///< number of samples read from XTRX
	unsigned long long samplesWritten;	///< number of samples sent to XTRX

	bool started;			///< flag indicates XTRX has started

	short *data;
	unsigned long dataStart;
	unsigned long dataEnd;
	TIMESTAMP timeStart;
	TIMESTAMP timeEnd;

	TIMESTAMP timeRx;
	bool isAligned;

	Mutex writeLock;

	short *currData;		///< internal data buffer when reading from XTRX
	TIMESTAMP currTimestamp;	///< timestamp of internal data buffer
	unsigned currLen;		///< size of internal data buffer

	TIMESTAMP timestampOffset;       ///< timestamp offset b/w Tx and Rx blocks
	TIMESTAMP latestWriteTimestamp;  ///< timestamp of most recent ping command
	TIMESTAMP pingTimestamp;	   ///< timestamp of most recent ping response

	unsigned long hi32Timestamp;
	unsigned long lastPktTimestamp;

	double rxGain;
	double txGain;
	bool loopback;

	xtrx_dev* device;
public:

	/** Object constructor */
	XTRXDevice(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);

	~XTRXDevice();

	/** Instantiate the XTRX */
	int open(const std::string &args, int ref, bool swap_channels);

	/** Start the XTRX */
	bool start();

	/** Stop the XTRX */
	bool stop();

	/** Set priority not supported */
	void setPriority(float prio = 0.5) { }

	enum TxWindowType getWindowType() { return TX_WINDOW_FIXED; }

	/**
	Read samples from the XTRX.
	@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 XTRX 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);
	/**
		Write samples to the XTRX.
		@param buf Contains the data to be written.
		@param len number of samples to write.
		@param underrun Set if XTRX 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);

	/** 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);

	/** Returns the starting read Timestamp*/
	TIMESTAMP initialReadTimestamp(void) { return 20000;}

	/** returns the full-scale transmit amplitude **/
	double fullScaleInputValue() {return (double) 32767*0.7;}

	/** returns the full-scale receive amplitude **/
	double fullScaleOutputValue() {return (double) 32767;}

	/** 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 rxGain; }

	/** 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);

	/** gets the current 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 actualTXSampleRate; }
	inline double numberRead() { return samplesRead; }
	inline double numberWritten() { return samplesWritten; }

};

#endif // _XTRX_DEVICE_H_