Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bring SDRPlay gain handling in line with SoapySDR abstractions. #61

Closed
wants to merge 4 commits into from
Closed

Bring SDRPlay gain handling in line with SoapySDR abstractions. #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0058697
Override setGain and getGainRange to avoid changing RFGR.
dlaw Nov 3, 2019
6a9dd8a
Rename IFGR to IF gain, and negate it.
dlaw Nov 4, 2019
6bba968
Remove RF gain unless it is specified as build option.
dlaw Nov 5, 2019
8a598d5
Make the overall system gain mirror the IF gain.
dlaw Nov 3, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,12 @@ if(CMAKE_COMPILER_IS_GNUCXX)

endif(CMAKE_COMPILER_IS_GNUCXX)

# Configurable feature set
SET (RF_GAIN_IN_MENU ON CACHE BOOL "Add Rf gain as a setting, additionally to the IFGR gain control")
# The SDRPlay LNA state, aka "RF gain", is more properly a setting than a gain.
# However, some users may prefer to also expose it as a SoapySDR gain.
SET (LNA_STATE_AS_GAIN OFF CACHE BOOL "Duplicate the lna_state setting as a SoapySDR gain.")

IF(RF_GAIN_IN_MENU)
ADD_DEFINITIONS( -DRF_GAIN_IN_MENU=1 )
IF(LNA_STATE_AS_GAIN)
ADD_DEFINITIONS( -DLNA_STATE_AS_GAIN=1 )
ENDIF()

SOAPY_SDR_MODULE_UTIL(
Expand Down
217 changes: 74 additions & 143 deletions Settings.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ SoapySDRPlay::SoapySDRPlay(const SoapySDR::Kwargs &args)
if (devIdx == MAX_RSP_DEVICES) throw std::runtime_error("no sdrplay device matches");

hwVer = rspDevs[devIdx].hwVer;
maxLnaState = 3; // RSP1 / default
if (hwVer == 2) maxLnaState = 8; // RSP2
if (hwVer == 3) maxLnaState = 9; // RSPduo
if (hwVer > 253) maxLnaState = 9; // RSP1a

mir_sdr_ApiVersion(&ver);
if (ver != MIR_SDR_API_VERSION)
Expand Down Expand Up @@ -357,8 +361,10 @@ std::vector<std::string> SoapySDRPlay::listGains(const int direction, const size
//the functions below have a "name" parameter
std::vector<std::string> results;

results.push_back("IFGR");
results.push_back("RFGR");
#ifdef LNA_STATE_AS_GAIN
results.push_back("RF");
#endif
results.push_back("IF");

return results;
}
Expand Down Expand Up @@ -395,71 +401,82 @@ void SoapySDRPlay::setGain(const int direction, const size_t channel, const std:

bool doUpdate = false;

if (name == "IFGR")
if (name == "IF")
{
//Depending of the previously used AGC context, the real applied
// gain may be either gRdB or current_gRdB, so apply the change if required value is different
//from one of them.
if ((gRdB != (int)value) || (current_gRdB != (int)value))
// gRdB is a gain *reduction*, so we negate the SoapySDR "IF gain"
// in order to obtain the new gRdB.
int new_gRdB = -((int)value);
// Depending of the previously used AGC context, the real
// applied gain may be either gRdB or current_gRdB, so apply the
// change if the required value is different from one of them.
if ((gRdB != new_gRdB) || (current_gRdB != new_gRdB))
{
gRdB = (int)value;
current_gRdB = (int)value;
gRdB = new_gRdB;
current_gRdB = new_gRdB;
doUpdate = true;
}
}
else if (name == "RFGR")
#ifdef LNA_STATE_AS_GAIN
else if (name == "RF")
{
if (lnaState != (int)value) {

lnaState = (int)value;
// The RF gain is negated to obtain the LNA state.
int newLnaState = -((int)value);
if (lnaState != newLnaState) {
lnaState = newLnaState;
doUpdate = true;
}
}
if ((doUpdate == true) && (streamActive))
#endif
if (doUpdate && streamActive)
{
mir_sdr_Reinit(&gRdB, 0.0, 0.0, mir_sdr_BW_Undefined, mir_sdr_IF_Undefined, mir_sdr_LO_Undefined, lnaState, &gRdBsystem, mir_sdr_USE_RSP_SET_GR, &sps, mir_sdr_CHANGE_GR);
}
}

void SoapySDRPlay::setGain(const int direction, const size_t channel, const double value)
{
// Only IF should be used for adjusting the overall system gain.
this->setGain(direction, channel, "IF", value);
}

double SoapySDRPlay::getGain(const int direction, const size_t channel, const std::string &name) const
{
std::lock_guard <std::mutex> lock(_general_state_mutex);

if (name == "IFGR")
if (name == "IF")
{
return current_gRdB;
// gRdB is a gain *reduction*, so we negate it to obtain the SoapySDR "IF gain".
return -current_gRdB;
}
else if (name == "RFGR")
#ifdef LNA_STATE_AS_GAIN
else if (name == "RF")
{
return lnaState;
// LNA state 0 is the minimum numeric value but corresponds to maximum gain.
// We define the RF gain as the negative of the LNA state so that any gain
// adjustment controls (e.g. CubicSDR sliders) operate in the correct direction.
return -lnaState;
}
#endif

return 0;
}

SoapySDR::Range SoapySDRPlay::getGainRange(const int direction, const size_t channel, const std::string &name) const
{
if (name == "IFGR")
#ifdef LNA_STATE_AS_GAIN
if (name == "RF")
{
return SoapySDR::Range(20, 59);
return SoapySDR::Range(-maxLnaState, 0);
}
else if ((name == "RFGR") && (hwVer == 1))
{
return SoapySDR::Range(0, 3);
}
else if ((name == "RFGR") && (hwVer == 2))
{
return SoapySDR::Range(0, 8);
}
else if ((name == "RFGR") && (hwVer == 3))
{
return SoapySDR::Range(0, 9);
}
else if ((name == "RFGR") && (hwVer > 253))
{
return SoapySDR::Range(0, 9);
}
return SoapySDR::Range(20, 59);
#endif
// IF gain
return SoapySDR::Range(-59, -20);
}

SoapySDR::Range SoapySDRPlay::getGainRange(const int direction, const size_t channel) const
{
// Only IF should be used for adjusting the overall system gain.
return this->getGainRange(direction, channel, "IF");
}

/*******************************************************************
Expand Down Expand Up @@ -795,83 +812,18 @@ std::string SoapySDRPlay::IFtoString(mir_sdr_If_kHzT ifkHzT)
SoapySDR::ArgInfoList SoapySDRPlay::getSettingInfo(void) const
{
SoapySDR::ArgInfoList setArgs;

#ifdef RF_GAIN_IN_MENU
if (hwVer == 2)
{
SoapySDR::ArgInfo RfGainArg;
RfGainArg.key = "rfgain_sel";
RfGainArg.value = "4";
RfGainArg.name = "RF Gain Select";
RfGainArg.description = "RF Gain Select";
RfGainArg.type = SoapySDR::ArgInfo::STRING;
RfGainArg.options.push_back("0");
RfGainArg.options.push_back("1");
RfGainArg.options.push_back("2");
RfGainArg.options.push_back("3");
RfGainArg.options.push_back("4");
RfGainArg.options.push_back("5");
RfGainArg.options.push_back("6");
RfGainArg.options.push_back("7");
RfGainArg.options.push_back("8");
setArgs.push_back(RfGainArg);
}
else if (hwVer == 3)
{
SoapySDR::ArgInfo RfGainArg;
RfGainArg.key = "rfgain_sel";
RfGainArg.value = "4";
RfGainArg.name = "RF Gain Select";
RfGainArg.description = "RF Gain Select";
RfGainArg.type = SoapySDR::ArgInfo::STRING;
RfGainArg.options.push_back("0");
RfGainArg.options.push_back("1");
RfGainArg.options.push_back("2");
RfGainArg.options.push_back("3");
RfGainArg.options.push_back("4");
RfGainArg.options.push_back("5");
RfGainArg.options.push_back("6");
RfGainArg.options.push_back("7");
RfGainArg.options.push_back("8");
RfGainArg.options.push_back("9");
setArgs.push_back(RfGainArg);
}
else if (hwVer > 253)
{
SoapySDR::ArgInfo RfGainArg;
RfGainArg.key = "rfgain_sel";
RfGainArg.value = "4";
RfGainArg.name = "RF Gain Select";
RfGainArg.description = "RF Gain Select";
RfGainArg.type = SoapySDR::ArgInfo::STRING;
RfGainArg.options.push_back("0");
RfGainArg.options.push_back("1");
RfGainArg.options.push_back("2");
RfGainArg.options.push_back("3");
RfGainArg.options.push_back("4");
RfGainArg.options.push_back("5");
RfGainArg.options.push_back("6");
RfGainArg.options.push_back("7");
RfGainArg.options.push_back("8");
RfGainArg.options.push_back("9");
setArgs.push_back(RfGainArg);
}
else
{
SoapySDR::ArgInfo RfGainArg;
RfGainArg.key = "rfgain_sel";
RfGainArg.value = "1";
RfGainArg.name = "RF Gain Select";
RfGainArg.description = "RF Gain Select";
RfGainArg.type = SoapySDR::ArgInfo::STRING;
RfGainArg.options.push_back("0");
RfGainArg.options.push_back("1");
RfGainArg.options.push_back("2");
RfGainArg.options.push_back("3");
setArgs.push_back(RfGainArg);

SoapySDR::ArgInfo LnaStateArg;
LnaStateArg.key = "lna_state";
LnaStateArg.value = std::to_string(maxLnaState / 2);
LnaStateArg.name = "RF Gain Select";
LnaStateArg.description = "SDRPlay LNA State";
LnaStateArg.type = SoapySDR::ArgInfo::STRING;
for (int i = 0; i <= maxLnaState; i++) {
LnaStateArg.options.push_back(std::to_string(i));
}
#endif
setArgs.push_back(LnaStateArg);

SoapySDR::ArgInfo AIFArg;
AIFArg.key = "if_mode";
AIFArg.value = IFtoString(ifMode);
Expand Down Expand Up @@ -995,19 +947,12 @@ void SoapySDRPlay::writeSetting(const std::string &key, const std::string &value
{
std::lock_guard <std::mutex> lock(_general_state_mutex);

#ifdef RF_GAIN_IN_MENU
if (key == "rfgain_sel")
if (key == "lna_state")
{
if (value == "0") lnaState = 0;
else if (value == "1") lnaState = 1;
else if (value == "2") lnaState = 2;
else if (value == "3") lnaState = 3;
else if (value == "4") lnaState = 4;
else if (value == "5") lnaState = 5;
else if (value == "6") lnaState = 6;
else if (value == "7") lnaState = 7;
else if (value == "8") lnaState = 8;
else lnaState = 9;
int newLnaState = std::stoi(value);
if (newLnaState >= 0 && newLnaState <= maxLnaState) {
lnaState = newLnaState;
}
if (agcMode != mir_sdr_AGC_DISABLE)
{
mir_sdr_AgcControl(agcMode, setPoint, 0, 0, 0, 0, lnaState);
Expand All @@ -1017,9 +962,7 @@ void SoapySDRPlay::writeSetting(const std::string &key, const std::string &value
mir_sdr_Reinit(&gRdB, 0.0, 0.0, mir_sdr_BW_Undefined, mir_sdr_IF_Undefined, mir_sdr_LO_Undefined, lnaState, &gRdBsystem, mir_sdr_USE_RSP_SET_GR, &sps, mir_sdr_CHANGE_GR);
}
}
else
#endif
if (key == "if_mode")
else if (key == "if_mode")
{
if (ifMode != stringToIF(value))
{
Expand Down Expand Up @@ -1085,23 +1028,11 @@ std::string SoapySDRPlay::readSetting(const std::string &key) const
{
std::lock_guard <std::mutex> lock(_general_state_mutex);

#ifdef RF_GAIN_IN_MENU
if (key == "rfgain_sel")
if (key == "lna_state")
{
if (lnaState == 0) return "0";
else if (lnaState == 1) return "1";
else if (lnaState == 2) return "2";
else if (lnaState == 3) return "3";
else if (lnaState == 4) return "4";
else if (lnaState == 5) return "5";
else if (lnaState == 6) return "6";
else if (lnaState == 7) return "7";
else if (lnaState == 8) return "8";
else return "9";
return std::to_string(lnaState);
}
else
#endif
if (key == "if_mode")
else if (key == "if_mode")
{
return IFtoString(ifMode);
}
Expand Down
5 changes: 5 additions & 0 deletions SoapySDRPlay.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,10 +153,14 @@ class SoapySDRPlay: public SoapySDR::Device

void setGain(const int direction, const size_t channel, const std::string &name, const double value);

void setGain(const int direction, const size_t channel, const double value);

double getGain(const int direction, const size_t channel, const std::string &name) const;

SoapySDR::Range getGainRange(const int direction, const size_t channel, const std::string &name) const;

SoapySDR::Range getGainRange(const int direction, const size_t channel) const;

/*******************************************************************
* Frequency API
******************************************************************/
Expand Down Expand Up @@ -254,6 +258,7 @@ class SoapySDRPlay: public SoapySDR::Device
int gRdBsystem;
int sps;
int lnaState;
int maxLnaState;
int hwVer;

//cached settings
Expand Down