116 lines
3.5 KiB
C
116 lines
3.5 KiB
C
|
/*
|
||
|
* 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 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 __RADIO_DEVICE_H__
|
||
|
#define __RADIO_DEVICE_H__
|
||
|
|
||
|
|
||
|
#ifdef HAVE_CONFIG_H
|
||
|
#include "config.h"
|
||
|
#endif
|
||
|
|
||
|
/** a 64-bit virtual timestamp for radio data */
|
||
|
typedef unsigned long long TIMESTAMP;
|
||
|
|
||
|
/** A class to handle a USRP rev 4, with a two RFX900 daughterboards */
|
||
|
class RadioDevice {
|
||
|
|
||
|
public:
|
||
|
|
||
|
/** Start the USRP */
|
||
|
virtual bool start()=0;
|
||
|
|
||
|
/** Stop the USRP */
|
||
|
virtual bool stop()=0;
|
||
|
|
||
|
/**
|
||
|
Read samples from the radio.
|
||
|
@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 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(short *buf, int len, bool *overrun,
|
||
|
TIMESTAMP timestamp,
|
||
|
bool *underrun,
|
||
|
unsigned *RSSI=NULL)=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(short *buf, int len, bool *underrun,
|
||
|
TIMESTAMP timestamp,
|
||
|
bool isControl=false)=0;
|
||
|
|
||
|
/** Update the alignment between the read and write timestamps */
|
||
|
virtual bool updateAlignment(TIMESTAMP timestamp)=0;
|
||
|
|
||
|
/** Set the transmitter frequency */
|
||
|
virtual bool setTxFreq(double wFreq)=0;
|
||
|
|
||
|
/** Set the receiver frequency */
|
||
|
virtual bool setRxFreq(double wFreq)=0;
|
||
|
|
||
|
/** Returns the starting write Timestamp*/
|
||
|
virtual TIMESTAMP initialWriteTimestamp(void)=0;
|
||
|
|
||
|
/** Returns the starting read Timestamp*/
|
||
|
virtual TIMESTAMP initialReadTimestamp(void)=0;
|
||
|
|
||
|
/** returns the full-scale transmit amplitude **/
|
||
|
virtual double fullScaleInputValue()=0;
|
||
|
|
||
|
/** returns the full-scale receive amplitude **/
|
||
|
virtual double fullScaleOutputValue()=0;
|
||
|
|
||
|
/** sets the receive chan gain, returns the gain setting **/
|
||
|
virtual double setRxGain(double dB)=0;
|
||
|
|
||
|
/** gets the current receive gain **/
|
||
|
virtual double getRxGain(void)=0;
|
||
|
|
||
|
/** return maximum Rx Gain **/
|
||
|
virtual double maxRxGain(void) = 0;
|
||
|
|
||
|
/** return minimum Rx Gain **/
|
||
|
virtual double minRxGain(void) = 0;
|
||
|
|
||
|
/** sets the transmit chan gain, returns the gain setting **/
|
||
|
virtual double setTxGain(double dB)=0;
|
||
|
|
||
|
/** return maximum Tx Gain **/
|
||
|
virtual double maxTxGain(void) = 0;
|
||
|
|
||
|
/** return minimum Tx Gain **/
|
||
|
virtual double minTxGain(void) = 0;
|
||
|
|
||
|
/** Return internal status values */
|
||
|
virtual double getTxFreq()=0;
|
||
|
virtual double getRxFreq()=0;
|
||
|
virtual double getSampleRate()=0;
|
||
|
virtual double numberRead()=0;
|
||
|
virtual double numberWritten()=0;
|
||
|
|
||
|
};
|
||
|
|
||
|
#endif
|