laforge
/
openbts-osmo
Archived
1
0
Fork 0
This repository has been archived on 2022-03-30. You can view files and clone it, but cannot push or open issues or pull requests.
openbts-osmo/public-trunk/Transceiver52M/radioDevice.h

139 lines
4.3 KiB
C++

/*
* Copyright 2008 Free Software Foundation, Inc.
*
* This software is distributed under the terms of the GNU Affero Public License.
* See the COPYING file in the main directory for details.
*
* This use of this software may be subject to additional restrictions.
* See the LEGAL file in the main directory for details.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
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. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#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:
/* Available transport bus types */
enum busType { USB, NET };
static RadioDevice *make(double desiredSampleRate, bool skipRx = false);
/** Initialize the USRP */
virtual bool open()=0;
/** Start the USRP */
virtual bool start()=0;
/** Stop the USRP */
virtual bool stop()=0;
/** Get the bus type */
virtual enum busType getBus()=0;
/** Enable thread priority */
virtual void setPriority()=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 = 0xffffffff,
bool *underrun = 0,
unsigned *RSSI = 0)=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