devicemanager.cpp

Go to the documentation of this file.

/*
 * This file is part of the PulseView project.
 *
 * Copyright (C) 2013 Joel Holdsworth <joel@airwebreathe.org.uk>
 *
 * 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 2 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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#include "devicemanager.hpp"
#include "session.hpp"

#include <cassert>
#include <functional>
#include <stdexcept>
#include <sstream>
#include <string>
#include <vector>

#include <libsigrokcxx/libsigrokcxx.hpp>

#include <boost/algorithm/string/join.hpp>
#include <boost/filesystem.hpp>

#include <pv/devices/hardwaredevice.hpp>

using boost::algorithm::join;

using std::bind;
using std::dynamic_pointer_cast;
using std::list;
using std::map;
using std::placeholders::_1;
using std::placeholders::_2;
using std::remove_if;
using std::runtime_error;
using std::shared_ptr;
using std::string;
using std::vector;

using Glib::VariantBase;

using sigrok::ConfigKey;
using sigrok::Context;
using sigrok::Driver;
using sigrok::SessionDevice;

namespace pv {

DeviceManager::DeviceManager(shared_ptr<Context> context) :
    context_(context)
{
    for (auto entry : context->drivers())
        driver_scan(entry.second, map<const ConfigKey *, VariantBase>());
}

DeviceManager::~DeviceManager()
{
}

const std::shared_ptr<sigrok::Context>& DeviceManager::context() const
{
    return context_;
}

shared_ptr<Context> DeviceManager::context()
{
    return context_;
}

const list< shared_ptr<devices::HardwareDevice> >&
DeviceManager::devices() const
{
    return devices_;
}

list< shared_ptr<devices::HardwareDevice> >
DeviceManager::driver_scan(
    shared_ptr<Driver> driver, map<const ConfigKey *, VariantBase> drvopts)
{
    list< shared_ptr<devices::HardwareDevice> > driver_devices;

    assert(driver);

    // Remove any device instances from this driver from the device
    // list. They will not be valid after the scan.
    devices_.remove_if([&](shared_ptr<devices::HardwareDevice> device) {
        return device->hardware_device()->driver() == driver; });

    // Do the scan
    auto devices = driver->scan(drvopts);

    // Add the scanned devices to the main list, set display names and sort.
    for (shared_ptr<sigrok::HardwareDevice> device : devices) {
        const shared_ptr<devices::HardwareDevice> d(
            new devices::HardwareDevice(context_, device));
        driver_devices.push_back(d);
    }

    devices_.insert(devices_.end(), driver_devices.begin(),
        driver_devices.end());
    devices_.sort(bind(&DeviceManager::compare_devices, this, _1, _2));
    driver_devices.sort(bind(
        &DeviceManager::compare_devices, this, _1, _2));

    return driver_devices;
}

const map<string, string> DeviceManager::get_device_info(
    shared_ptr<devices::Device> device)
{
    map<string, string> result;

    assert(device);

    const shared_ptr<sigrok::Device> sr_dev = device->device();
    if (sr_dev->vendor().length() > 0)
        result["vendor"] = sr_dev->vendor();
    if (sr_dev->model().length() > 0)
        result["model"] = sr_dev->model();
    if (sr_dev->version().length() > 0)
        result["version"] = sr_dev->version();
    if (sr_dev->serial_number().length() > 0)
        result["serial_num"] = sr_dev->serial_number();
    if (sr_dev->connection_id().length() > 0)
        result["connection_id"] = sr_dev->connection_id();

    return result;
}

const shared_ptr<devices::HardwareDevice> DeviceManager::find_device_from_info(
    const map<string, string> search_info)
{
    shared_ptr<devices::HardwareDevice> last_resort_dev;
    map<string, string> dev_info;

    for (shared_ptr<devices::HardwareDevice> dev : devices_) {
        assert(dev);
        dev_info = get_device_info(dev);

        // If present, vendor and model always have to match.
        if (dev_info.count("vendor") > 0 && search_info.count("vendor") > 0)
            if (dev_info.at("vendor") != search_info.at("vendor"))
                continue;

        if (dev_info.count("model") > 0 && search_info.count("model") > 0)
            if (dev_info.at("model") != search_info.at("model"))
                continue;

        // Most unique match: vendor/model/serial_num (but don't match a S/N of 0)
        if ((dev_info.count("serial_num") > 0) && (dev_info.at("serial_num") != "0")
                && search_info.count("serial_num") > 0)
            if (dev_info.at("serial_num") == search_info.at("serial_num") &&
                    dev_info.at("serial_num") != "0")
                return dev;

        // Second best match: vendor/model/connection_id
        if (dev_info.count("connection_id") > 0 &&
            search_info.count("connection_id") > 0)
            if (dev_info.at("connection_id") == search_info.at("connection_id"))
                return dev;

        // Last resort: vendor/model/version
        if (dev_info.count("version") > 0 &&
            search_info.count("version") > 0)
            if (dev_info.at("version") == search_info.at("version") &&
                    dev_info.at("version") != "0")
                return dev;

        // For this device, we merely have a vendor/model match.
        last_resort_dev = dev;
    }

    // If there wasn't even a vendor/model/version match, we end up here.
    // This is usually the case for devices with only vendor/model data.
    // The selected device may be wrong with multiple such devices attached
    // but it is the best we can do at this point. After all, there may be
    // only one such device and we do want to select it in this case.
    return last_resort_dev;
}

bool DeviceManager::compare_devices(shared_ptr<devices::Device> a,
    shared_ptr<devices::Device> b)
{
    assert(a);
    assert(b);
    return a->display_name(*this).compare(b->display_name(*this)) < 0;
}

} // namespace pv