uhd

//

// Copyright 2010-2011 Ettus Research LLC

//

// This program is free software: you can redistribute it and/or modify

// it under the terms of the GNU 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 General Public License for more details.

//

// You should have received a copy of the GNU General Public License

// along with this program.  If not, see <http://www.gnu.org/licenses/>.

//

#include <uhd/utils/safe_main.hpp>

#include <uhd/device.hpp>

#include <uhd/types/ranges.hpp>

#include <uhd/property_tree.hpp>

#include <boost/algorithm/string.hpp> //for split

#include <uhd/usrp/dboard_id.hpp>

#include <uhd/usrp/mboard_eeprom.hpp>

#include <uhd/usrp/dboard_eeprom.hpp>

#include <boost/program_options.hpp>

#include <boost/format.hpp>

#include <boost/foreach.hpp>

#include <iostream>

#include <sstream>

#include <vector>

namespace po = boost::program_options;

using namespace uhd;

static std::string indent(size_t level){

    return (level)? (indent(level-1) + " ") : "";

}

static std::string make_border(const std::string &text){

    std::stringstream ss;

    ss << boost::format("  _____________________________________________________") << std::endl;

    ss << boost::format(" /") << std::endl;

    std::vector<std::string> lines; boost::split(lines, text, boost::is_any_of("\n"));

    while (lines.back().empty()) lines.pop_back(); //strip trailing newlines

    if (lines.size()) lines[0] = "    " + lines[0]; //indent the title line

    BOOST_FOREACH(const std::string &line, lines){

        ss << boost::format("|   %s") % line << std::endl;

    }

    //ss << boost::format(" \\_____________________________________________________") << std::endl;

    return ss.str();

}

static std::string get_dsp_pp_string(const std::string &type, property_tree::sptr tree, const property_tree::path_type &path){

    std::stringstream ss;

    ss << boost::format("%s DSP: %s") % type % path.leaf() << std::endl;

    //ss << std::endl;

    meta_range_t freq_range = tree->access<meta_range_t>(path / "freq/range").get();

    ss << boost::format("Freq range: %.3f to %.3f Mhz") % (freq_range.start()/1e6) % (freq_range.stop()/1e6) << std::endl;;

    return ss.str();

}

static std::string prop_names_to_pp_string(const std::vector<std::string> &prop_names){

    std::stringstream ss; size_t count = 0;

    BOOST_FOREACH(const std::string &prop_name, prop_names){

        ss << ((count++)? ", " : "") << prop_name;

    }

    return ss.str();

}

static std::string get_subdev_pp_string(const std::string &type, property_tree::sptr tree, const property_tree::path_type &path){

    std::stringstream ss;

    ss << boost::format("%s Subdev: %s") % type % path.leaf() << std::endl;

    //ss << std::endl;

    ss << boost::format("Name: %s") % (tree->access<std::string>(path / "name").get()) << std::endl;

    ss << boost::format("Antennas: %s") % prop_names_to_pp_string(tree->access<std::vector<std::string> >(path / "antenna/options").get()) << std::endl;

    ss << boost::format("Sensors: %s") % prop_names_to_pp_string(tree->list(path / "sensors")) << std::endl;

    meta_range_t freq_range = tree->access<meta_range_t>(path / "freq/range").get();

    ss << boost::format("Freq range: %.3f to %.3f Mhz") % (freq_range.start()/1e6) % (freq_range.stop()/1e6) << std::endl;

    std::vector<std::string> gain_names = tree->list(path / "gains");

    if (gain_names.size() == 0) ss << "Gain Elements: None" << std::endl;

    BOOST_FOREACH(const std::string &name, gain_names){

        meta_range_t gain_range = tree->access<meta_range_t>(path / "gains" / name / "range").get();

        ss << boost::format("Gain range %s: %.1f to %.1f step %.1f dB") % name % gain_range.start() % gain_range.stop() % gain_range.step() << std::endl;

    }

    ss << boost::format("Connection Type: %s") % (tree->access<std::string>(path / "connection").get()) << std::endl;

    ss << boost::format("Uses LO offset: %s") % ((tree->access<bool>(path / "use_lo_offset").get())? "Yes" : "No") << std::endl;

    return ss.str();

}

static std::string get_codec_pp_string(const std::string &type, property_tree::sptr tree, const property_tree::path_type &path){

    std::stringstream ss;

    ss << boost::format("%s Codec: %s") % type % path.leaf() << std::endl;

    //ss << std::endl;

    ss << boost::format("Name: %s") % (tree->access<std::string>(path / "name").get()) << std::endl;

    std::vector<std::string> gain_names = tree->list(path / "gains");

    if (gain_names.size() == 0) ss << "Gain Elements: None" << std::endl;

    BOOST_FOREACH(const std::string &name, gain_names){

        meta_range_t gain_range = tree->access<meta_range_t>(path / "gains" / name / "range").get();

        ss << boost::format("Gain range %s: %.1f to %.1f step %.1f dB") % name % gain_range.start() % gain_range.stop() % gain_range.step() << std::endl;

    }

    return ss.str();

}

static std::string get_dboard_pp_string(const std::string &type, property_tree::sptr tree, const property_tree::path_type &path){

    std::stringstream ss;

    ss << boost::format("%s Dboard: %s") % type % path.leaf() << std::endl;

    //ss << std::endl;

    const std::string prefix = (type == "RX")? "rx" : "tx";

    usrp::dboard_eeprom_t db_eeprom = tree->access<usrp::dboard_eeprom_t>(path / (prefix + "_eeprom")).get();

    if (db_eeprom.id != usrp::dboard_id_t::none()) ss << boost::format("ID: %s") % db_eeprom.id.to_pp_string() << std::endl;

    if (not db_eeprom.serial.empty()) ss << boost::format("Serial: %s") % db_eeprom.serial << std::endl;

    if (type == "TX"){

        usrp::dboard_eeprom_t gdb_eeprom = tree->access<usrp::dboard_eeprom_t>(path / "gdb_eeprom").get();

        if (gdb_eeprom.id != usrp::dboard_id_t::none()) ss << boost::format("ID: %s") % gdb_eeprom.id.to_pp_string() << std::endl;

        if (not gdb_eeprom.serial.empty()) ss << boost::format("Serial: %s") % gdb_eeprom.serial << std::endl;

    }

    BOOST_FOREACH(const std::string &name, tree->list(path / (prefix + "_frontends"))){

        ss << make_border(get_subdev_pp_string(type, tree, path / (prefix + "_frontends") / name));

    }

    ss << make_border(get_codec_pp_string(type, tree, path.branch_path().branch_path() / (prefix + "_codecs") / path.leaf()));

    return ss.str();

}

static std::string get_mboard_pp_string(property_tree::sptr tree, const property_tree::path_type &path){

    std::stringstream ss;

    ss << boost::format("Mboard: %s") % (tree->access<std::string>(path / "name").get()) << std::endl;

    //ss << std::endl;

    usrp::mboard_eeprom_t mb_eeprom = tree->access<usrp::mboard_eeprom_t>(path / "eeprom").get();

    BOOST_FOREACH(const std::string &key, mb_eeprom.keys()){

        if (not mb_eeprom[key].empty()) ss << boost::format("%s: %s") % key % mb_eeprom[key] << std::endl;

    }

    ss << std::endl;

    ss << "Time sources: " << prop_names_to_pp_string(tree->access<std::vector<std::string> >(path / "time_source" / "options").get()) << std::endl;

    ss << "Clock sources: " << prop_names_to_pp_string(tree->access<std::vector<std::string> >(path / "clock_source" / "options").get()) << std::endl;

    ss << "Sensors: " << prop_names_to_pp_string(tree->list(path / "sensors")) << std::endl;

    BOOST_FOREACH(const std::string &name, tree->list(path / "rx_dsps")){

        ss << make_border(get_dsp_pp_string("RX", tree, path / "rx_dsps" / name));

    }

    BOOST_FOREACH(const std::string &name, tree->list(path / "dboards")){

        ss << make_border(get_dboard_pp_string("RX", tree, path / "dboards" / name));

    }

    BOOST_FOREACH(const std::string &name, tree->list(path / "tx_dsps")){

        ss << make_border(get_dsp_pp_string("TX", tree, path / "tx_dsps" / name));

    }

    BOOST_FOREACH(const std::string &name, tree->list(path / "dboards")){

        ss << make_border(get_dboard_pp_string("TX", tree, path / "dboards" / name));

    }

    return ss.str();

}

static std::string get_device_pp_string(property_tree::sptr tree){

    std::stringstream ss;

    ss << boost::format("Device: %s") % (tree->access<std::string>("/name").get()) << std::endl;

    //ss << std::endl;

    BOOST_FOREACH(const std::string &name, tree->list("/mboards")){

        ss << make_border(get_mboard_pp_string(tree, "/mboards/" + name));

    }

    return ss.str();

}

void print_tree(const uhd::property_tree::path_type &path, uhd::property_tree::sptr tree){

    std::cout << path << std::endl;

    BOOST_FOREACH(const std::string &name, tree->list(path)){

        print_tree(path / name, tree);

    }

}

int UHD_SAFE_MAIN(int argc, char *argv[]){

    po::options_description desc("Allowed options");

    desc.add_options()

        ("help", "help message")

        ("args", po::value<std::string>()->default_value(""), "device address args")

        ("tree", "specify to print a complete property tree")

    ;

    po::variables_map vm;

    po::store(po::parse_command_line(argc, argv, desc), vm);

    po::notify(vm);

    //print the help message

    if (vm.count("help")){

        std::cout << boost::format("UHD USRP Probe %s") % desc << std::endl;

        return ~0;

    }

    device::sptr dev = device::make(vm["args"].as<std::string>());

    property_tree::sptr tree = (*dev)[0].as<property_tree::sptr>();

    if (vm.count("tree") != 0) print_tree("/", tree);

    else std::cout << make_border(get_device_pp_string(tree)) << std::endl;

    return 0;

}