* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
-#include "devicemanager.h"
-#include "device/device.h"
-#include "sigsession.h"
+#include "devicemanager.hpp"
+#include "session.hpp"
#include <cassert>
#include <stdexcept>
+#include <sstream>
#include <string>
+#include <vector>
-#include <libsigrok/libsigrok.h>
+#include <libsigrokcxx/libsigrokcxx.hpp>
-using boost::shared_ptr;
+#include <boost/algorithm/string/join.hpp>
+#include <boost/filesystem.hpp>
+
+using boost::algorithm::join;
+
+using std::dynamic_pointer_cast;
using std::list;
using std::map;
-using std::ostringstream;
+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::Device;
+using sigrok::HardwareDevice;
+using sigrok::SessionDevice;
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();
+ for (auto entry : context->drivers())
+ driver_scan(entry.second, map<const ConfigKey *, VariantBase>());
}
DeviceManager::~DeviceManager()
{
- release_devices();
}
-const list< shared_ptr<pv::device::Device> >& DeviceManager::devices() const
+const std::shared_ptr<sigrok::Context>& DeviceManager::context() const
{
- return _devices;
+ return context_;
}
-void DeviceManager::use_device(shared_ptr<device::Device> 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<device::Device> dev_inst)
+const list< shared_ptr<HardwareDevice> >& DeviceManager::devices() const
{
- assert(dev_inst);
-
- // Notify the owner, and remove the device from the used device list
- map< shared_ptr<device::Device>, 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<device::Device> > DeviceManager::driver_scan(
- struct sr_dev_driver *const driver, GSList *const drvopts)
+list< shared_ptr<HardwareDevice> > DeviceManager::driver_scan(
+ shared_ptr<Driver> driver, map<const ConfigKey *, VariantBase> drvopts)
{
- list< shared_ptr<device::Device> > driver_devices;
+ list< shared_ptr<HardwareDevice> > driver_devices;
assert(driver);
// Remove any device instances from this driver from the device
// list. They will not be valid after the scan.
- list< shared_ptr<device::Device> >::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<HardwareDevice> device) {
+ return 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<device::Device>(
- new device::Device((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(),
+ auto devices = driver->scan(drvopts);
+ driver_devices.insert(driver_devices.end(), devices.begin(), devices.end());
+
+ // Add the scanned devices to the main list, set display names and sort.
+ devices_.insert(devices_.end(), driver_devices.begin(),
driver_devices.end());
- _devices.sort(compare_devices);
+
+ for (shared_ptr<Device> device : devices_)
+ build_display_name(device);
+
+ devices_.sort([&](shared_ptr<Device> a, shared_ptr<Device> b)
+ { return compare_devices(a, b); });
+
+ // As the display names depend on the complete devices_ list,
+ // we need to recompute them. However, there is no need to
+ // recomute all names of the devices_ list since only the
+ // devices that use the given driver can be affected.
+ for (shared_ptr<Device> device : driver_devices)
+ build_display_name(device);
+
+ driver_devices.sort([&](shared_ptr<Device> a, shared_ptr<Device> b)
+ { return compare_devices(a, b); });
return driver_devices;
}
-void DeviceManager::init_drivers()
+const map<string, string> DeviceManager::get_device_info(
+ shared_ptr<Device> device)
{
- // 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));
- }
+ map<string, string> result;
+
+ assert(device);
+
+ if (device->vendor().length() > 0)
+ result["vendor"] = device->vendor();
+ if (device->model().length() > 0)
+ result["model"] = device->model();
+ if (device->version().length() > 0)
+ result["version"] = device->version();
+ if (device->serial_number().length() > 0)
+ result["serial_num"] = device->serial_number();
+ if (device->connection_id().length() > 0)
+ result["connection_id"] = device->connection_id();
+
+ return result;
+}
+
+const shared_ptr<HardwareDevice> DeviceManager::find_device_from_info(
+ const map<string, string> search_info)
+{
+ shared_ptr<HardwareDevice> last_resort_dev;
+ map<string, string> dev_info;
+
+ last_resort_dev = NULL;
+
+ for (shared_ptr<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;
}
-void DeviceManager::release_devices()
+void DeviceManager::build_display_name(shared_ptr<Device> device)
{
- // Release all the used devices
- for (map<shared_ptr<device::Device>, SigSession*>::iterator i =
- _used_devices.begin(); i != _used_devices.end(); i++)
- release_device((*i).first);
+ auto session_device = dynamic_pointer_cast<SessionDevice>(device);
+ auto hardware_device = dynamic_pointer_cast<HardwareDevice>(device);
+
+ if (session_device) {
+ full_names_[device] = display_names_[device] =
+ boost::filesystem::path(
+ session_device->parent()->filename()).filename().string();
+ return;
+ }
+
+ // First, build the device's full name. It always contains all
+ // possible information.
+ vector<string> parts = {device->vendor(), device->model(),
+ device->version(), device->serial_number()};
+
+ if (device->connection_id().length() > 0)
+ parts.push_back("("+device->connection_id()+")");
+
+ full_names_[device] = join(parts, " ");
+
+ // Next, build the display name. It only contains fields as required.
+
+ // If we can find another device with the same model/vendor then
+ // we have at least two such devices and need to distinguish them.
+ const bool multiple_dev = hardware_device && any_of(
+ devices_.begin(), devices_.end(),
+ [&](shared_ptr<HardwareDevice> dev) {
+ return (dev->vendor() == hardware_device->vendor() &&
+ dev->model() == hardware_device->model()) &&
+ dev != hardware_device;
+ } );
- _used_devices.clear();
+ parts = {device->vendor(), device->model()};
- // Clear all the drivers
- sr_dev_driver **const drivers = sr_driver_list();
- for (sr_dev_driver **driver = drivers; *driver; driver++)
- sr_dev_clear(*driver);
+ if (multiple_dev) {
+ parts.push_back(device->version());
+ parts.push_back(device->serial_number());
+
+ if ((device->serial_number().length() == 0) &&
+ (device->connection_id().length() > 0))
+ parts.push_back("("+device->connection_id()+")");
+ }
+
+ display_names_[device] = join(parts, " ");
}
-void DeviceManager::scan_all_drivers()
+const std::string DeviceManager::get_display_name(std::shared_ptr<sigrok::Device> dev)
{
- // 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);
+ return display_names_[dev];
}
-void DeviceManager::release_driver(struct sr_dev_driver *const driver)
+const std::string DeviceManager::get_full_name(std::shared_ptr<sigrok::Device> dev)
{
- assert(driver);
- for (map<shared_ptr<device::Device>, 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);
+ return full_names_[dev];
}
-bool DeviceManager::compare_devices(shared_ptr<device::Device> a,
- shared_ptr<device::Device> b)
+void DeviceManager::update_display_name(std::shared_ptr<sigrok::Device> dev)
+{
+ build_display_name(dev);
+}
+
+bool DeviceManager::compare_devices(shared_ptr<Device> a,
+ shared_ptr<Device> b)
{
assert(a);
assert(b);
- return a->format_device_title().compare(b->format_device_title()) < 0;
+
+ return display_names_[a].compare(display_names_[b]) < 0;
}
} // namespace pv