]> sigrok.org Git - pulseview.git/blobdiff - pv/devicemanager.cpp
device manager: Move filter for supported devices to the scan routine
[pulseview.git] / pv / devicemanager.cpp
index 39c311c5a0e35726f4d38a1471af2d19bdaaf343..ac6ce6fb433da3fa29eefa9ba551c043c70f63b5 100644 (file)
  * 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
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "devicemanager.h"
-#include "devinst.h"
-#include "sigsession.h"
+#include "devicemanager.hpp"
+#include "session.hpp"
 
 #include <cassert>
+#include <functional>
+#include <memory>
+#include <sstream>
 #include <stdexcept>
 #include <string>
 
-#include <libsigrok/libsigrok.h>
+#include <libsigrokcxx/libsigrokcxx.hpp>
 
-using boost::shared_ptr;
+#include <QApplication>
+#include <QObject>
+#include <QProgressDialog>
+
+#include <boost/filesystem.hpp>
+
+#include <pv/devices/hardwaredevice.hpp>
+
+using std::bind;
 using std::list;
 using std::map;
-using std::ostringstream;
-using std::runtime_error;
+using std::placeholders::_1;
+using std::placeholders::_2;
+using std::shared_ptr;
 using std::string;
+using std::unique_ptr;
+
+using Glib::VariantBase;
+
+using sigrok::ConfigKey;
+using sigrok::Context;
+using sigrok::Driver;
 
 namespace pv {
 
-DeviceManager::DeviceManager(struct sr_context *sr_ctx) :
-       _sr_ctx(sr_ctx)
+DeviceManager::DeviceManager(shared_ptr<Context> context) :
+       context_(context)
 {
-       init_drivers();
-       scan_all_drivers();
-}
+       unique_ptr<QProgressDialog> progress(new QProgressDialog("",
+               QObject::tr("Cancel"), 0, context->drivers().size()));
+       progress->setWindowModality(Qt::WindowModal);
+       progress->setMinimumDuration(1);  // To show the dialog immediately
 
-DeviceManager::~DeviceManager()
-{
-       release_devices();
+       int entry_num = 1;
+
+       for (auto entry : context->drivers()) {
+               progress->setLabelText(QObject::tr("Scanning for %1...")
+                       .arg(QString::fromStdString(entry.first)));
+
+               driver_scan(entry.second, map<const ConfigKey *, VariantBase>());
+
+               progress->setValue(entry_num++);
+               QApplication::processEvents();
+               if (progress->wasCanceled())
+                       break;
+       }
 }
 
-const list< shared_ptr<pv::DevInst> >& DeviceManager::devices() const
+const shared_ptr<sigrok::Context>& DeviceManager::context() const
 {
-       return _devices;
+       return context_;
 }
 
-void DeviceManager::use_device(shared_ptr<DevInst> dev_inst, SigSession *owner)
+shared_ptr<Context> DeviceManager::context()
 {
-       assert(dev_inst);
-       assert(owner);
-
-       _used_devices[dev_inst] = owner;
-
-       sr_dev_open(dev_inst->dev_inst());
+       return context_;
 }
 
-void DeviceManager::release_device(shared_ptr<DevInst> dev_inst)
+const list< shared_ptr<devices::HardwareDevice> >&
+DeviceManager::devices() const
 {
-       assert(dev_inst);
-
-       // Notify the owner, and remove the device from the used device list
-       map< shared_ptr<DevInst>, pv::SigSession*>::const_iterator iter =
-               _used_devices.find(dev_inst);
-       assert(iter != _used_devices.end());
-
-       (*iter).second->release_device(dev_inst);
-       _used_devices.erase(dev_inst);
+       return devices_;
 }
 
-list< shared_ptr<DevInst> > DeviceManager::driver_scan(
-       struct sr_dev_driver *const driver, GSList *const drvopts)
+list< shared_ptr<devices::HardwareDevice> >
+DeviceManager::driver_scan(
+       shared_ptr<Driver> driver, map<const ConfigKey *, VariantBase> drvopts)
 {
-       list< shared_ptr<DevInst> > driver_devices;
+       list< shared_ptr<devices::HardwareDevice> > driver_devices;
 
        assert(driver);
 
+       /*
+        * We currently only support devices that can deliver samples at
+        * a fixed samplerate (i.e. oscilloscopes and logic analysers).
+        *
+        * @todo Add support for non-monotonic devices (DMMs, sensors, etc).
+        */
+       const auto keys = driver->config_keys();
+       bool supported_device = keys.count(ConfigKey::LOGIC_ANALYZER) |
+               keys.count(ConfigKey::OSCILLOSCOPE);
+       if (!supported_device)
+               return driver_devices;
+
        // Remove any device instances from this driver from the device
        // list. They will not be valid after the scan.
-       list< shared_ptr<DevInst> >::iterator i = _devices.begin();
-       while (i != _devices.end()) {
-               if ((*i)->dev_inst()->driver == driver)
-                       i = _devices.erase(i);
-               else
-                       i++;
-       }
-
-       // Release this driver and all it's attached devices
-       release_driver(driver);
+       devices_.remove_if([&](shared_ptr<devices::HardwareDevice> device) {
+               return device->hardware_device()->driver() == driver; });
 
        // Do the scan
-       GSList *const devices = sr_driver_scan(driver, drvopts);
-       for (GSList *l = devices; l; l = l->next)
-               driver_devices.push_back(shared_ptr<DevInst>(
-                       new DevInst((sr_dev_inst*)l->data)));
-       g_slist_free(devices);
-       driver_devices.sort(compare_devices);
-
-       // Add the scanned devices to the main list
-       _devices.insert(_devices.end(), driver_devices.begin(),
-               driver_devices.end());
-       _devices.sort(compare_devices);
-
-       return driver_devices;
-}
+       auto devices = driver->scan(drvopts);
 
-void DeviceManager::init_drivers()
-{
-       // Initialise all libsigrok drivers
-       sr_dev_driver **const drivers = sr_driver_list();
-       for (sr_dev_driver **driver = drivers; *driver; driver++) {
-               if (sr_driver_init(_sr_ctx, *driver) != SR_OK) {
-                       throw runtime_error(
-                               string("Failed to initialize driver ") +
-                               string((*driver)->name));
-               }
+       // 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);
        }
-}
 
-void DeviceManager::release_devices()
-{
-       // Release all the used devices
-       for (map<shared_ptr<DevInst>, SigSession*>::iterator i =
-               _used_devices.begin(); i != _used_devices.end(); i++)
-               release_device((*i).first);
-
-       _used_devices.clear();
+       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));
 
-       // Clear all the drivers
-       sr_dev_driver **const drivers = sr_driver_list();
-       for (sr_dev_driver **driver = drivers; *driver; driver++)
-               sr_dev_clear(*driver);
+       return driver_devices;
 }
 
-void DeviceManager::scan_all_drivers()
+const map<string, string> DeviceManager::get_device_info(
+       shared_ptr<devices::Device> device)
 {
-       // Scan all drivers for all devices.
-       struct sr_dev_driver **const drivers = sr_driver_list();
-       for (struct sr_dev_driver **driver = drivers; *driver; driver++)
-               driver_scan(*driver);
+       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;
 }
 
-void DeviceManager::release_driver(struct sr_dev_driver *const driver)
+const shared_ptr<devices::HardwareDevice> DeviceManager::find_device_from_info(
+       const map<string, string> search_info)
 {
-       assert(driver);
-       for (map<shared_ptr<DevInst>, SigSession*>::iterator i =
-               _used_devices.begin(); i != _used_devices.end(); i++)
-               if((*i).first->dev_inst()->driver == driver)
-               {
-                       // Notify the current owner of the device
-                       (*i).second->release_device((*i).first);
-
-                       // Remove it from the used device list
-                       _used_devices.erase(i);
-
-                       // Close the device instance
-                       sr_dev_close((*i).first->dev_inst());
-               }
-
-       // Clear all the old device instances from this driver
-       sr_dev_clear(driver);
+       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<DevInst> a,
-       shared_ptr<DevInst> b)
+bool DeviceManager::compare_devices(shared_ptr<devices::Device> a,
+       shared_ptr<devices::Device> b)
 {
        assert(a);
        assert(b);
-       return a->format_device_title().compare(b->format_device_title()) < 0;
+       return a->display_name(*this).compare(b->display_name(*this)) < 0;
 }
 
 } // namespace pv