X-Git-Url: https://sigrok.org/gitweb/?p=pulseview.git;a=blobdiff_plain;f=pv%2Fdevicemanager.cpp;h=ca8f66bee5316e6116d4fb38afcbdd93ca78a24d;hp=36d6fb6a44f1d0c10ae05a234503e5347122a85c;hb=46ebcd3f6f85092a9eb6401f6f56cee8fa08131a;hpb=da30ecb7e72bd2547e524258efa5ec642988b70b diff --git a/pv/devicemanager.cpp b/pv/devicemanager.cpp index 36d6fb6a..ca8f66be 100644 --- a/pv/devicemanager.cpp +++ b/pv/devicemanager.cpp @@ -14,35 +14,38 @@ * 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 . */ #include "devicemanager.hpp" #include "session.hpp" #include -#include +#include +#include #include +#include #include -#include #include -#include +#include +#include +#include + #include #include +#include -using boost::algorithm::join; - -using std::dynamic_pointer_cast; +using std::bind; using std::list; using std::map; -using std::remove_if; -using std::runtime_error; +using std::placeholders::_1; +using std::placeholders::_2; using std::shared_ptr; using std::string; +using std::unique_ptr; using std::vector; using Glib::VariantBase; @@ -50,22 +53,102 @@ using Glib::VariantBase; using sigrok::ConfigKey; using sigrok::Context; using sigrok::Driver; -using sigrok::SessionDevice; namespace pv { -DeviceManager::DeviceManager(shared_ptr context) : +DeviceManager::DeviceManager(shared_ptr context, + std::string driver, bool do_scan) : context_(context) { - for (auto entry : context->drivers()) + unique_ptr progress(new QProgressDialog("", + QObject::tr("Cancel"), 0, context->drivers().size() + 1)); + progress->setWindowModality(Qt::WindowModal); + progress->setMinimumDuration(1); // To show the dialog immediately + + int entry_num = 1; + + /* + * Check the presence of an optional user spec for device scans. + * Determine the driver name and options (in generic format) when + * applicable. + */ + std::string user_name; + vector user_opts; + if (!driver.empty()) { + user_opts = pv::util::split_string(driver, ":"); + user_name = user_opts.front(); + user_opts.erase(user_opts.begin()); + } + + /* + * Scan for devices. No specific options apply here, this is + * best effort auto detection. + */ + for (auto entry : context->drivers()) { + if (!do_scan) + break; + + // Skip drivers we won't scan anyway + if (!driver_supported(entry.second)) + continue; + + progress->setLabelText(QObject::tr("Scanning for %1...") + .arg(QString::fromStdString(entry.first))); + + if (entry.first == user_name) + continue; driver_scan(entry.second, map()); -} -DeviceManager::~DeviceManager() -{ + progress->setValue(entry_num++); + QApplication::processEvents(); + if (progress->wasCanceled()) + break; + } + + /* + * Optionally run another scan with potentially more specific + * options when requested by the user. This is motivated by + * several different uses: It can find devices that are not + * covered by the above auto detection (UART, TCP). It can + * prefer one out of multiple found devices, and have this + * device pre-selected for new sessions upon user's request. + */ + user_spec_device_.reset(); + if (!driver.empty()) { + shared_ptr scan_drv; + map scan_opts; + + /* + * Lookup the device driver name. + */ + map> drivers = context->drivers(); + auto entry = drivers.find(user_name); + scan_drv = (entry != drivers.end()) ? entry->second : nullptr; + + /* + * Convert generic string representation of options + * to the driver specific data types. + */ + if (scan_drv && !user_opts.empty()) { + auto drv_opts = scan_drv->scan_options(); + scan_opts = drive_scan_options(user_opts, drv_opts); + } + + /* + * Run another scan for the specified driver, passing + * user provided scan options this time. + */ + list< shared_ptr > found; + if (scan_drv) { + found = driver_scan(scan_drv, scan_opts); + if (!found.empty()) + user_spec_device_ = found.front(); + } + } + progress->setValue(entry_num++); } -const std::shared_ptr& DeviceManager::context() const +const shared_ptr& DeviceManager::context() const { return context_; } @@ -81,6 +164,78 @@ DeviceManager::devices() const return devices_; } +/** + * Get the device that was detected with user provided scan options. + */ +shared_ptr +DeviceManager::user_spec_device() const +{ + return user_spec_device_; +} + +/** + * Convert generic options to data types that are specific to Driver::scan(). + * + * @param[in] user_spec Vector of tokenized words, string format. + * @param[in] driver_opts Driver's scan options, result of Driver::scan_options(). + * + * @return Map of options suitable for Driver::scan(). + */ +map +DeviceManager::drive_scan_options(vector user_spec, + set driver_opts) +{ + map result; + + for (auto entry : user_spec) { + /* + * Split key=value specs. Accept entries without separator + * (for simplified boolean specifications). + */ + string key, val; + size_t pos = entry.find("="); + if (pos == std::string::npos) { + key = entry; + val = ""; + } else { + key = entry.substr(0, pos); + val = entry.substr(pos + 1); + } + + /* + * Skip user specifications that are not a member of the + * driver's set of supported options. Have the text format + * input spec converted to the required driver specific type. + */ + const ConfigKey *cfg; + try { + cfg = ConfigKey::get_by_identifier(key); + if (!cfg) + continue; + if (driver_opts.find(cfg) == driver_opts.end()) + continue; + } catch (...) { + continue; + } + result[cfg] = cfg->parse_string(val); + } + + return result; +} + +bool DeviceManager::driver_supported(shared_ptr driver) const +{ + /* + * 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(); + + return keys.count(ConfigKey::LOGIC_ANALYZER) | keys.count(ConfigKey::OSCILLOSCOPE); +} + list< shared_ptr > DeviceManager::driver_scan( shared_ptr driver, map drvopts) @@ -89,6 +244,9 @@ DeviceManager::driver_scan( assert(driver); + if (!driver_supported(driver)) + return driver_devices; + // Remove any device instances from this driver from the device // list. They will not be valid after the scan. devices_.remove_if([&](shared_ptr device) { @@ -104,14 +262,11 @@ DeviceManager::driver_scan( driver_devices.push_back(d); } - for (shared_ptr device : driver_devices) - build_display_name(device); - devices_.insert(devices_.end(), driver_devices.begin(), driver_devices.end()); - devices_.sort([&](shared_ptr a, - shared_ptr b) - { return compare_devices(a, b); }); + devices_.sort(bind(&DeviceManager::compare_devices, this, _1, _2)); + driver_devices.sort(bind( + &DeviceManager::compare_devices, this, _1, _2)); return driver_devices; } @@ -150,10 +305,12 @@ const shared_ptr DeviceManager::find_device_from_info( // 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.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; + 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") @@ -187,80 +344,12 @@ const shared_ptr DeviceManager::find_device_from_info( return last_resort_dev; } -void DeviceManager::build_display_name(shared_ptr device) -{ - const shared_ptr sr_dev = device->device(); - auto session_device = dynamic_pointer_cast(sr_dev); - auto hardware_device = dynamic_pointer_cast(sr_dev); - - 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 parts = {sr_dev->vendor(), sr_dev->model(), - sr_dev->version(), sr_dev->serial_number()}; - - if (sr_dev->connection_id().length() > 0) - parts.push_back("("+sr_dev->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 dev) { - return (dev->device()->vendor() == hardware_device->vendor() && - dev->device()->model() == hardware_device->model()) && - dev != device; - } ); - - parts = {sr_dev->vendor(), sr_dev->model()}; - - if (multiple_dev) { - parts.push_back(sr_dev->version()); - parts.push_back(sr_dev->serial_number()); - - if ((sr_dev->serial_number().length() == 0) && - (sr_dev->connection_id().length() > 0)) - parts.push_back("("+sr_dev->connection_id()+")"); - } - - display_names_[device] = join(parts, " "); -} - -const std::string DeviceManager::get_display_name( - std::shared_ptr dev) -{ - return display_names_[dev]; -} - -const std::string DeviceManager::get_full_name( - std::shared_ptr dev) -{ - return full_names_[dev]; -} - -void DeviceManager::update_display_name( - std::shared_ptr dev) -{ - build_display_name(dev); -} - -bool DeviceManager::compare_devices( - shared_ptr a, shared_ptr b) +bool DeviceManager::compare_devices(shared_ptr a, + shared_ptr b) { assert(a); assert(b); - - return display_names_[a].compare(display_names_[b]) < 0; + return a->display_name(*this).compare(b->display_name(*this)) < 0; } } // namespace pv