pv/devicemanager.cpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2013 Joel Holdsworth <joel@airwebreathe.org.uk>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include "devicemanager.hpp"
  21 #include "session.hpp"
  22
  23 #include <cassert>
  24 #include <functional>
  25 #include <memory>
  26 #include <sstream>
  27 #include <stdexcept>
  28 #include <string>
  29
  30 #include <libsigrokcxx/libsigrokcxx.hpp>
  31
  32 #include <QApplication>
  33 #include <QObject>
  34 #include <QProgressDialog>
  35
  36 #include <boost/filesystem.hpp>
  37
  38 #include <pv/devices/hardwaredevice.hpp>
  39
  40 using std::bind;
  41 using std::list;
  42 using std::map;
  43 using std::placeholders::_1;
  44 using std::placeholders::_2;
  45 using std::shared_ptr;
  46 using std::string;
  47 using std::unique_ptr;
  48
  49 using Glib::VariantBase;
  50
  51 using sigrok::ConfigKey;
  52 using sigrok::Context;
  53 using sigrok::Driver;
  54
  55 namespace pv {
  56
  57 DeviceManager::DeviceManager(shared_ptr<Context> context) :
  58         context_(context)
  59 {
  60         unique_ptr<QProgressDialog> progress(new QProgressDialog("",
  61                 QObject::tr("Cancel"), 0, context->drivers().size()));
  62         progress->setWindowModality(Qt::WindowModal);
  63         progress->setMinimumDuration(1);  // To show the dialog immediately
  64
  65         int entry_num = 1;
  66
  67         for (auto entry : context->drivers()) {
  68                 progress->setLabelText(QObject::tr("Scanning for %1...")
  69                         .arg(QString::fromStdString(entry.first)));
  70
  71                 driver_scan(entry.second, map<const ConfigKey *, VariantBase>());
  72
  73                 progress->setValue(entry_num++);
  74                 QApplication::processEvents();
  75                 if (progress->wasCanceled())
  76                         break;
  77         }
  78 }
  79
  80 const shared_ptr<sigrok::Context>& DeviceManager::context() const
  81 {
  82         return context_;
  83 }
  84
  85 shared_ptr<Context> DeviceManager::context()
  86 {
  87         return context_;
  88 }
  89
  90 const list< shared_ptr<devices::HardwareDevice> >&
  91 DeviceManager::devices() const
  92 {
  93         return devices_;
  94 }
  95
  96 list< shared_ptr<devices::HardwareDevice> >
  97 DeviceManager::driver_scan(
  98         shared_ptr<Driver> driver, map<const ConfigKey *, VariantBase> drvopts)
  99 {
 100         list< shared_ptr<devices::HardwareDevice> > driver_devices;
 101
 102         assert(driver);
 103
 104         /*
 105          * We currently only support devices that can deliver samples at
 106          * a fixed samplerate (i.e. oscilloscopes and logic analysers).
 107          *
 108          * @todo Add support for non-monotonic devices (DMMs, sensors, etc).
 109          */
 110         const auto keys = driver->config_keys();
 111         bool supported_device = keys.count(ConfigKey::LOGIC_ANALYZER) |
 112                 keys.count(ConfigKey::OSCILLOSCOPE);
 113         if (!supported_device)
 114                 return driver_devices;
 115
 116         // Remove any device instances from this driver from the device
 117         // list. They will not be valid after the scan.
 118         devices_.remove_if([&](shared_ptr<devices::HardwareDevice> device) {
 119                 return device->hardware_device()->driver() == driver; });
 120
 121         // Do the scan
 122         auto devices = driver->scan(drvopts);
 123
 124         // Add the scanned devices to the main list, set display names and sort.
 125         for (shared_ptr<sigrok::HardwareDevice> device : devices) {
 126                 const shared_ptr<devices::HardwareDevice> d(
 127                         new devices::HardwareDevice(context_, device));
 128                 driver_devices.push_back(d);
 129         }
 130
 131         devices_.insert(devices_.end(), driver_devices.begin(),
 132                 driver_devices.end());
 133         devices_.sort(bind(&DeviceManager::compare_devices, this, _1, _2));
 134         driver_devices.sort(bind(
 135                 &DeviceManager::compare_devices, this, _1, _2));
 136
 137         return driver_devices;
 138 }
 139
 140 const map<string, string> DeviceManager::get_device_info(
 141         shared_ptr<devices::Device> device)
 142 {
 143         map<string, string> result;
 144
 145         assert(device);
 146
 147         const shared_ptr<sigrok::Device> sr_dev = device->device();
 148         if (sr_dev->vendor().length() > 0)
 149                 result["vendor"] = sr_dev->vendor();
 150         if (sr_dev->model().length() > 0)
 151                 result["model"] = sr_dev->model();
 152         if (sr_dev->version().length() > 0)
 153                 result["version"] = sr_dev->version();
 154         if (sr_dev->serial_number().length() > 0)
 155                 result["serial_num"] = sr_dev->serial_number();
 156         if (sr_dev->connection_id().length() > 0)
 157                 result["connection_id"] = sr_dev->connection_id();
 158
 159         return result;
 160 }
 161
 162 const shared_ptr<devices::HardwareDevice> DeviceManager::find_device_from_info(
 163         const map<string, string> search_info)
 164 {
 165         shared_ptr<devices::HardwareDevice> last_resort_dev;
 166         map<string, string> dev_info;
 167
 168         for (shared_ptr<devices::HardwareDevice> dev : devices_) {
 169                 assert(dev);
 170                 dev_info = get_device_info(dev);
 171
 172                 // If present, vendor and model always have to match.
 173                 if (dev_info.count("vendor") > 0 && search_info.count("vendor") > 0)
 174                         if (dev_info.at("vendor") != search_info.at("vendor"))
 175                                 continue;
 176
 177                 if (dev_info.count("model") > 0 && search_info.count("model") > 0)
 178                         if (dev_info.at("model") != search_info.at("model"))
 179                                 continue;
 180
 181                 // Most unique match: vendor/model/serial_num (but don't match a S/N of 0)
 182                 if ((dev_info.count("serial_num") > 0) && (dev_info.at("serial_num") != "0")
 183                                 && search_info.count("serial_num") > 0)
 184                         if (dev_info.at("serial_num") == search_info.at("serial_num") &&
 185                                         dev_info.at("serial_num") != "0")
 186                                 return dev;
 187
 188                 // Second best match: vendor/model/connection_id
 189                 if (dev_info.count("connection_id") > 0 &&
 190                         search_info.count("connection_id") > 0)
 191                         if (dev_info.at("connection_id") == search_info.at("connection_id"))
 192                                 return dev;
 193
 194                 // Last resort: vendor/model/version
 195                 if (dev_info.count("version") > 0 &&
 196                         search_info.count("version") > 0)
 197                         if (dev_info.at("version") == search_info.at("version") &&
 198                                         dev_info.at("version") != "0")
 199                                 return dev;
 200
 201                 // For this device, we merely have a vendor/model match.
 202                 last_resort_dev = dev;
 203         }
 204
 205         // If there wasn't even a vendor/model/version match, we end up here.
 206         // This is usually the case for devices with only vendor/model data.
 207         // The selected device may be wrong with multiple such devices attached
 208         // but it is the best we can do at this point. After all, there may be
 209         // only one such device and we do want to select it in this case.
 210         return last_resort_dev;
 211 }
 212
 213 bool DeviceManager::compare_devices(shared_ptr<devices::Device> a,
 214         shared_ptr<devices::Device> b)
 215 {
 216         assert(a);
 217         assert(b);
 218         return a->display_name(*this).compare(b->display_name(*this)) < 0;
 219 }
 220
 221 } // namespace pv