]>
Commit | Line | Data |
---|---|---|
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 | #include <pv/util.hpp> | |
40 | ||
41 | using std::bind; | |
42 | using std::list; | |
43 | using std::map; | |
44 | using std::placeholders::_1; | |
45 | using std::placeholders::_2; | |
46 | using std::shared_ptr; | |
47 | using std::string; | |
48 | using std::unique_ptr; | |
49 | using std::vector; | |
50 | ||
51 | using Glib::ustring; | |
52 | using Glib::Variant; | |
53 | using Glib::VariantBase; | |
54 | ||
55 | using sigrok::ConfigKey; | |
56 | using sigrok::Context; | |
57 | using sigrok::Driver; | |
58 | ||
59 | namespace pv { | |
60 | ||
61 | DeviceManager::DeviceManager(shared_ptr<Context> context, std::string driver) : | |
62 | context_(context) | |
63 | { | |
64 | unique_ptr<QProgressDialog> progress(new QProgressDialog("", | |
65 | QObject::tr("Cancel"), 0, context->drivers().size() + 1)); | |
66 | progress->setWindowModality(Qt::WindowModal); | |
67 | progress->setMinimumDuration(1); // To show the dialog immediately | |
68 | ||
69 | int entry_num = 1; | |
70 | ||
71 | /* | |
72 | * Check the presence of an optional user spec for device scans. | |
73 | * Determine the driver name and options (in generic format) when | |
74 | * applicable. | |
75 | */ | |
76 | std::string user_name; | |
77 | vector<std::string> user_opts; | |
78 | if (!driver.empty()) { | |
79 | user_opts = pv::util::split_string(driver, ":"); | |
80 | user_name = user_opts.front(); | |
81 | user_opts.erase(user_opts.begin()); | |
82 | } | |
83 | ||
84 | /* | |
85 | * Scan for devices. No specific options apply here, this is | |
86 | * best effort auto detection. | |
87 | */ | |
88 | for (auto entry : context->drivers()) { | |
89 | progress->setLabelText(QObject::tr("Scanning for %1...") | |
90 | .arg(QString::fromStdString(entry.first))); | |
91 | ||
92 | if (entry.first == user_name) | |
93 | continue; | |
94 | driver_scan(entry.second, map<const ConfigKey *, VariantBase>()); | |
95 | ||
96 | progress->setValue(entry_num++); | |
97 | QApplication::processEvents(); | |
98 | if (progress->wasCanceled()) | |
99 | break; | |
100 | } | |
101 | ||
102 | /* | |
103 | * Optionally run another scan with potentially more specific | |
104 | * options when requested by the user. This is motivated by | |
105 | * several different uses: It can find devices that are not | |
106 | * covered by the above auto detection (UART, TCP). It can | |
107 | * prefer one out of multiple found devices, and have this | |
108 | * device pre-selected for new sessions upon user's request. | |
109 | */ | |
110 | user_spec_device_.reset(); | |
111 | if (!driver.empty()) { | |
112 | shared_ptr<sigrok::Driver> scan_drv; | |
113 | map<const ConfigKey *, VariantBase> scan_opts; | |
114 | ||
115 | /* | |
116 | * Lookup the device driver name. | |
117 | */ | |
118 | map<string, shared_ptr<Driver>> drivers = context->drivers(); | |
119 | auto entry = drivers.find(user_name); | |
120 | scan_drv = (entry != drivers.end()) ? entry->second : nullptr; | |
121 | ||
122 | /* | |
123 | * Convert generic string representation of options | |
124 | * to the driver specific data types. | |
125 | */ | |
126 | if (scan_drv && !user_opts.empty()) { | |
127 | auto drv_opts = scan_drv->scan_options(); | |
128 | scan_opts = drive_scan_options(user_opts, drv_opts); | |
129 | } | |
130 | ||
131 | /* | |
132 | * Run another scan for the specified driver, passing | |
133 | * user provided scan options this time. | |
134 | */ | |
135 | list< shared_ptr<devices::HardwareDevice> > found; | |
136 | if (scan_drv) { | |
137 | found = driver_scan(scan_drv, scan_opts); | |
138 | if (!found.empty()) | |
139 | user_spec_device_ = found.front(); | |
140 | } | |
141 | } | |
142 | progress->setValue(entry_num++); | |
143 | } | |
144 | ||
145 | const shared_ptr<sigrok::Context>& DeviceManager::context() const | |
146 | { | |
147 | return context_; | |
148 | } | |
149 | ||
150 | shared_ptr<Context> DeviceManager::context() | |
151 | { | |
152 | return context_; | |
153 | } | |
154 | ||
155 | const list< shared_ptr<devices::HardwareDevice> >& | |
156 | DeviceManager::devices() const | |
157 | { | |
158 | return devices_; | |
159 | } | |
160 | ||
161 | /** | |
162 | * Get the device that was detected with user provided scan options. | |
163 | */ | |
164 | shared_ptr<devices::HardwareDevice> | |
165 | DeviceManager::user_spec_device() const | |
166 | { | |
167 | return user_spec_device_; | |
168 | } | |
169 | ||
170 | /** | |
171 | * Convert generic options to data types that are specific to Driver::scan(). | |
172 | * | |
173 | * @param[in] user_spec Vector of tokenized words, string format. | |
174 | * @param[in] driver_opts Driver's scan options, result of Driver::scan_options(). | |
175 | * | |
176 | * @return Map of options suitable for Driver::scan(). | |
177 | */ | |
178 | map<const ConfigKey *, Glib::VariantBase> | |
179 | DeviceManager::drive_scan_options(vector<string> user_spec, | |
180 | set<const ConfigKey *> driver_opts) | |
181 | { | |
182 | map<const ConfigKey *, Glib::VariantBase> result; | |
183 | ||
184 | for (auto entry : user_spec) { | |
185 | /* | |
186 | * Split key=value specs. Accept entries without separator | |
187 | * (for simplified boolean specifications). | |
188 | */ | |
189 | string key, val; | |
190 | size_t pos = entry.find("="); | |
191 | if (pos == std::string::npos) { | |
192 | key = entry; | |
193 | val = ""; | |
194 | } else { | |
195 | key = entry.substr(0, pos); | |
196 | val = entry.substr(pos + 1); | |
197 | } | |
198 | ||
199 | /* | |
200 | * Skip user specifications that are not a member of the | |
201 | * driver's set of supported options. Have the text format | |
202 | * input spec converted to the required driver specific type. | |
203 | */ | |
204 | const ConfigKey *cfg; | |
205 | try { | |
206 | cfg = ConfigKey::get_by_identifier(key); | |
207 | if (!cfg) | |
208 | continue; | |
209 | if (driver_opts.find(cfg) == driver_opts.end()) | |
210 | continue; | |
211 | } catch (...) { | |
212 | continue; | |
213 | } | |
214 | result[cfg] = cfg->parse_string(val); | |
215 | } | |
216 | ||
217 | return result; | |
218 | } | |
219 | ||
220 | list< shared_ptr<devices::HardwareDevice> > | |
221 | DeviceManager::driver_scan( | |
222 | shared_ptr<Driver> driver, map<const ConfigKey *, VariantBase> drvopts) | |
223 | { | |
224 | list< shared_ptr<devices::HardwareDevice> > driver_devices; | |
225 | ||
226 | assert(driver); | |
227 | ||
228 | /* | |
229 | * We currently only support devices that can deliver samples at | |
230 | * a fixed samplerate (i.e. oscilloscopes and logic analysers). | |
231 | * | |
232 | * @todo Add support for non-monotonic devices (DMMs, sensors, etc). | |
233 | */ | |
234 | const auto keys = driver->config_keys(); | |
235 | bool supported_device = keys.count(ConfigKey::LOGIC_ANALYZER) | | |
236 | keys.count(ConfigKey::OSCILLOSCOPE); | |
237 | if (!supported_device) | |
238 | return driver_devices; | |
239 | ||
240 | // Remove any device instances from this driver from the device | |
241 | // list. They will not be valid after the scan. | |
242 | devices_.remove_if([&](shared_ptr<devices::HardwareDevice> device) { | |
243 | return device->hardware_device()->driver() == driver; }); | |
244 | ||
245 | // Do the scan | |
246 | auto devices = driver->scan(drvopts); | |
247 | ||
248 | // Add the scanned devices to the main list, set display names and sort. | |
249 | for (shared_ptr<sigrok::HardwareDevice> device : devices) { | |
250 | const shared_ptr<devices::HardwareDevice> d( | |
251 | new devices::HardwareDevice(context_, device)); | |
252 | driver_devices.push_back(d); | |
253 | } | |
254 | ||
255 | devices_.insert(devices_.end(), driver_devices.begin(), | |
256 | driver_devices.end()); | |
257 | devices_.sort(bind(&DeviceManager::compare_devices, this, _1, _2)); | |
258 | driver_devices.sort(bind( | |
259 | &DeviceManager::compare_devices, this, _1, _2)); | |
260 | ||
261 | return driver_devices; | |
262 | } | |
263 | ||
264 | const map<string, string> DeviceManager::get_device_info( | |
265 | shared_ptr<devices::Device> device) | |
266 | { | |
267 | map<string, string> result; | |
268 | ||
269 | assert(device); | |
270 | ||
271 | const shared_ptr<sigrok::Device> sr_dev = device->device(); | |
272 | if (sr_dev->vendor().length() > 0) | |
273 | result["vendor"] = sr_dev->vendor(); | |
274 | if (sr_dev->model().length() > 0) | |
275 | result["model"] = sr_dev->model(); | |
276 | if (sr_dev->version().length() > 0) | |
277 | result["version"] = sr_dev->version(); | |
278 | if (sr_dev->serial_number().length() > 0) | |
279 | result["serial_num"] = sr_dev->serial_number(); | |
280 | if (sr_dev->connection_id().length() > 0) | |
281 | result["connection_id"] = sr_dev->connection_id(); | |
282 | ||
283 | return result; | |
284 | } | |
285 | ||
286 | const shared_ptr<devices::HardwareDevice> DeviceManager::find_device_from_info( | |
287 | const map<string, string> search_info) | |
288 | { | |
289 | shared_ptr<devices::HardwareDevice> last_resort_dev; | |
290 | map<string, string> dev_info; | |
291 | ||
292 | for (shared_ptr<devices::HardwareDevice> dev : devices_) { | |
293 | assert(dev); | |
294 | dev_info = get_device_info(dev); | |
295 | ||
296 | // If present, vendor and model always have to match. | |
297 | if (dev_info.count("vendor") > 0 && search_info.count("vendor") > 0) | |
298 | if (dev_info.at("vendor") != search_info.at("vendor")) | |
299 | continue; | |
300 | ||
301 | if (dev_info.count("model") > 0 && search_info.count("model") > 0) | |
302 | if (dev_info.at("model") != search_info.at("model")) | |
303 | continue; | |
304 | ||
305 | // Most unique match: vendor/model/serial_num (but don't match a S/N of 0) | |
306 | if ((dev_info.count("serial_num") > 0) && (dev_info.at("serial_num") != "0") | |
307 | && search_info.count("serial_num") > 0) | |
308 | if (dev_info.at("serial_num") == search_info.at("serial_num") && | |
309 | dev_info.at("serial_num") != "0") | |
310 | return dev; | |
311 | ||
312 | // Second best match: vendor/model/connection_id | |
313 | if (dev_info.count("connection_id") > 0 && | |
314 | search_info.count("connection_id") > 0) | |
315 | if (dev_info.at("connection_id") == search_info.at("connection_id")) | |
316 | return dev; | |
317 | ||
318 | // Last resort: vendor/model/version | |
319 | if (dev_info.count("version") > 0 && | |
320 | search_info.count("version") > 0) | |
321 | if (dev_info.at("version") == search_info.at("version") && | |
322 | dev_info.at("version") != "0") | |
323 | return dev; | |
324 | ||
325 | // For this device, we merely have a vendor/model match. | |
326 | last_resort_dev = dev; | |
327 | } | |
328 | ||
329 | // If there wasn't even a vendor/model/version match, we end up here. | |
330 | // This is usually the case for devices with only vendor/model data. | |
331 | // The selected device may be wrong with multiple such devices attached | |
332 | // but it is the best we can do at this point. After all, there may be | |
333 | // only one such device and we do want to select it in this case. | |
334 | return last_resort_dev; | |
335 | } | |
336 | ||
337 | bool DeviceManager::compare_devices(shared_ptr<devices::Device> a, | |
338 | shared_ptr<devices::Device> b) | |
339 | { | |
340 | assert(a); | |
341 | assert(b); | |
342 | return a->display_name(*this).compare(b->display_name(*this)) < 0; | |
343 | } | |
344 | ||
345 | } // namespace pv |