Fix inconsistent declaration parameter names.
[pulseview.git] / 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, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
19  */
20
21 #include "devicemanager.hpp"
22 #include "session.hpp"
23
24 #include <cassert>
25 #include <functional>
26 #include <stdexcept>
27 #include <sstream>
28 #include <string>
29 #include <vector>
30
31 #include <libsigrokcxx/libsigrokcxx.hpp>
32
33 #include <boost/algorithm/string/join.hpp>
34 #include <boost/filesystem.hpp>
35
36 #include <pv/devices/hardwaredevice.hpp>
37
38 using boost::algorithm::join;
39
40 using std::bind;
41 using std::dynamic_pointer_cast;
42 using std::list;
43 using std::map;
44 using std::placeholders::_1;
45 using std::placeholders::_2;
46 using std::remove_if;
47 using std::runtime_error;
48 using std::shared_ptr;
49 using std::string;
50 using std::vector;
51
52 using Glib::VariantBase;
53
54 using sigrok::ConfigKey;
55 using sigrok::Context;
56 using sigrok::Driver;
57 using sigrok::SessionDevice;
58
59 namespace pv {
60
61 DeviceManager::DeviceManager(shared_ptr<Context> context) :
62         context_(context)
63 {
64         for (auto entry : context->drivers())
65                 driver_scan(entry.second, map<const ConfigKey *, VariantBase>());
66 }
67
68 DeviceManager::~DeviceManager()
69 {
70 }
71
72 const std::shared_ptr<sigrok::Context>& DeviceManager::context() const
73 {
74         return context_;
75 }
76
77 shared_ptr<Context> DeviceManager::context()
78 {
79         return context_;
80 }
81
82 const list< shared_ptr<devices::HardwareDevice> >&
83 DeviceManager::devices() const
84 {
85         return devices_;
86 }
87
88 list< shared_ptr<devices::HardwareDevice> >
89 DeviceManager::driver_scan(
90         shared_ptr<Driver> driver, map<const ConfigKey *, VariantBase> drvopts)
91 {
92         list< shared_ptr<devices::HardwareDevice> > driver_devices;
93
94         assert(driver);
95
96         // Remove any device instances from this driver from the device
97         // list. They will not be valid after the scan.
98         devices_.remove_if([&](shared_ptr<devices::HardwareDevice> device) {
99                 return device->hardware_device()->driver() == driver; });
100
101         // Do the scan
102         auto devices = driver->scan(drvopts);
103
104         // Add the scanned devices to the main list, set display names and sort.
105         for (shared_ptr<sigrok::HardwareDevice> device : devices) {
106                 const shared_ptr<devices::HardwareDevice> d(
107                         new devices::HardwareDevice(context_, device));
108                 driver_devices.push_back(d);
109         }
110
111         devices_.insert(devices_.end(), driver_devices.begin(),
112                 driver_devices.end());
113         devices_.sort(bind(&DeviceManager::compare_devices, this, _1, _2));
114         driver_devices.sort(bind(
115                 &DeviceManager::compare_devices, this, _1, _2));
116
117         return driver_devices;
118 }
119
120 const map<string, string> DeviceManager::get_device_info(
121         shared_ptr<devices::Device> device)
122 {
123         map<string, string> result;
124
125         assert(device);
126
127         const shared_ptr<sigrok::Device> sr_dev = device->device();
128         if (sr_dev->vendor().length() > 0)
129                 result["vendor"] = sr_dev->vendor();
130         if (sr_dev->model().length() > 0)
131                 result["model"] = sr_dev->model();
132         if (sr_dev->version().length() > 0)
133                 result["version"] = sr_dev->version();
134         if (sr_dev->serial_number().length() > 0)
135                 result["serial_num"] = sr_dev->serial_number();
136         if (sr_dev->connection_id().length() > 0)
137                 result["connection_id"] = sr_dev->connection_id();
138
139         return result;
140 }
141
142 const shared_ptr<devices::HardwareDevice> DeviceManager::find_device_from_info(
143         const map<string, string> search_info)
144 {
145         shared_ptr<devices::HardwareDevice> last_resort_dev;
146         map<string, string> dev_info;
147
148         for (shared_ptr<devices::HardwareDevice> dev : devices_) {
149                 assert(dev);
150                 dev_info = get_device_info(dev);
151
152                 // If present, vendor and model always have to match.
153                 if (dev_info.count("vendor") > 0 && search_info.count("vendor") > 0)
154                         if (dev_info.at("vendor") != search_info.at("vendor"))
155                                 continue;
156
157                 if (dev_info.count("model") > 0 && search_info.count("model") > 0)
158                         if (dev_info.at("model") != search_info.at("model"))
159                                 continue;
160
161                 // Most unique match: vendor/model/serial_num (but don't match a S/N of 0)
162                 if ((dev_info.count("serial_num") > 0) && (dev_info.at("serial_num") != "0")
163                                 && search_info.count("serial_num") > 0)
164                         if (dev_info.at("serial_num") == search_info.at("serial_num") &&
165                                         dev_info.at("serial_num") != "0")
166                                 return dev;
167
168                 // Second best match: vendor/model/connection_id
169                 if (dev_info.count("connection_id") > 0 &&
170                         search_info.count("connection_id") > 0)
171                         if (dev_info.at("connection_id") == search_info.at("connection_id"))
172                                 return dev;
173
174                 // Last resort: vendor/model/version
175                 if (dev_info.count("version") > 0 &&
176                         search_info.count("version") > 0)
177                         if (dev_info.at("version") == search_info.at("version") &&
178                                         dev_info.at("version") != "0")
179                                 return dev;
180
181                 // For this device, we merely have a vendor/model match.
182                 last_resort_dev = dev;
183         }
184
185         // If there wasn't even a vendor/model/version match, we end up here.
186         // This is usually the case for devices with only vendor/model data.
187         // The selected device may be wrong with multiple such devices attached
188         // but it is the best we can do at this point. After all, there may be
189         // only one such device and we do want to select it in this case.
190         return last_resort_dev;
191 }
192
193 bool DeviceManager::compare_devices(shared_ptr<devices::Device> a,
194         shared_ptr<devices::Device> b)
195 {
196         assert(a);
197         assert(b);
198         return a->display_name(*this).compare(b->display_name(*this)) < 0;
199 }
200
201 } // namespace pv