]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the PulseView project. | |
3 | * | |
4 | * Copyright (C) 2012-14 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 | #ifdef ENABLE_DECODE | |
22 | #include <libsigrokdecode/libsigrokdecode.h> | |
23 | #endif | |
24 | ||
25 | #include "session.hpp" | |
26 | ||
27 | #include "devicemanager.hpp" | |
28 | ||
29 | #include "data/analog.hpp" | |
30 | #include "data/analogsegment.hpp" | |
31 | #include "data/decoderstack.hpp" | |
32 | #include "data/logic.hpp" | |
33 | #include "data/logicsegment.hpp" | |
34 | #include "data/decode/decoder.hpp" | |
35 | ||
36 | #include "devices/hardwaredevice.hpp" | |
37 | #include "devices/sessionfile.hpp" | |
38 | ||
39 | #include "view/analogsignal.hpp" | |
40 | #include "view/decodetrace.hpp" | |
41 | #include "view/logicsignal.hpp" | |
42 | ||
43 | #include <cassert> | |
44 | #include <mutex> | |
45 | #include <stdexcept> | |
46 | ||
47 | #include <sys/stat.h> | |
48 | ||
49 | #include <QDebug> | |
50 | ||
51 | #include <libsigrokcxx/libsigrokcxx.hpp> | |
52 | ||
53 | using boost::shared_lock; | |
54 | using boost::shared_mutex; | |
55 | using boost::unique_lock; | |
56 | ||
57 | using std::dynamic_pointer_cast; | |
58 | using std::function; | |
59 | using std::lock_guard; | |
60 | using std::list; | |
61 | using std::map; | |
62 | using std::mutex; | |
63 | using std::recursive_mutex; | |
64 | using std::set; | |
65 | using std::shared_ptr; | |
66 | using std::string; | |
67 | using std::unordered_set; | |
68 | using std::vector; | |
69 | ||
70 | using sigrok::Analog; | |
71 | using sigrok::Channel; | |
72 | using sigrok::ChannelType; | |
73 | using sigrok::ConfigKey; | |
74 | using sigrok::DatafeedCallbackFunction; | |
75 | using sigrok::Error; | |
76 | using sigrok::Header; | |
77 | using sigrok::Logic; | |
78 | using sigrok::Meta; | |
79 | using sigrok::Packet; | |
80 | using sigrok::PacketPayload; | |
81 | using sigrok::Session; | |
82 | using sigrok::SessionDevice; | |
83 | ||
84 | using Glib::VariantBase; | |
85 | using Glib::Variant; | |
86 | ||
87 | namespace pv { | |
88 | Session::Session(DeviceManager &device_manager) : | |
89 | device_manager_(device_manager), | |
90 | capture_state_(Stopped), | |
91 | cur_samplerate_(0) | |
92 | { | |
93 | set_default_device(); | |
94 | } | |
95 | ||
96 | Session::~Session() | |
97 | { | |
98 | // Stop and join to the thread | |
99 | stop_capture(); | |
100 | } | |
101 | ||
102 | DeviceManager& Session::device_manager() | |
103 | { | |
104 | return device_manager_; | |
105 | } | |
106 | ||
107 | const DeviceManager& Session::device_manager() const | |
108 | { | |
109 | return device_manager_; | |
110 | } | |
111 | ||
112 | shared_ptr<sigrok::Session> Session::session() const | |
113 | { | |
114 | if (!device_) | |
115 | return shared_ptr<sigrok::Session>(); | |
116 | return device_->session(); | |
117 | } | |
118 | ||
119 | shared_ptr<devices::Device> Session::device() const | |
120 | { | |
121 | return device_; | |
122 | } | |
123 | ||
124 | void Session::set_device(shared_ptr<devices::Device> device) | |
125 | { | |
126 | assert(device); | |
127 | ||
128 | // Ensure we are not capturing before setting the device | |
129 | stop_capture(); | |
130 | ||
131 | device_ = std::move(device); | |
132 | device_->create(); | |
133 | device_->session()->add_datafeed_callback([=] | |
134 | (shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) { | |
135 | data_feed_in(device, packet); | |
136 | }); | |
137 | update_signals(); | |
138 | ||
139 | decode_traces_.clear(); | |
140 | ||
141 | device_selected(); | |
142 | } | |
143 | ||
144 | void Session::set_default_device() | |
145 | { | |
146 | const list< shared_ptr<devices::HardwareDevice> > &devices = | |
147 | device_manager_.devices(); | |
148 | ||
149 | if (devices.empty()) | |
150 | return; | |
151 | ||
152 | // Try and find the demo device and select that by default | |
153 | const auto iter = std::find_if(devices.begin(), devices.end(), | |
154 | [] (const shared_ptr<devices::HardwareDevice> &d) { | |
155 | return d->hardware_device()->driver()->name() == | |
156 | "demo"; }); | |
157 | set_device((iter == devices.end()) ? devices.front() : *iter); | |
158 | } | |
159 | ||
160 | Session::capture_state Session::get_capture_state() const | |
161 | { | |
162 | lock_guard<mutex> lock(sampling_mutex_); | |
163 | return capture_state_; | |
164 | } | |
165 | ||
166 | void Session::start_capture(function<void (const QString)> error_handler) | |
167 | { | |
168 | stop_capture(); | |
169 | ||
170 | // Check that at least one channel is enabled | |
171 | assert(device_); | |
172 | const std::shared_ptr<sigrok::Device> device = device_->device(); | |
173 | assert(device); | |
174 | auto channels = device->channels(); | |
175 | bool enabled = std::any_of(channels.begin(), channels.end(), | |
176 | [](shared_ptr<Channel> channel) { return channel->enabled(); }); | |
177 | ||
178 | if (!enabled) { | |
179 | error_handler(tr("No channels enabled.")); | |
180 | return; | |
181 | } | |
182 | ||
183 | // Begin the session | |
184 | sampling_thread_ = std::thread( | |
185 | &Session::sample_thread_proc, this, device_, | |
186 | error_handler); | |
187 | } | |
188 | ||
189 | void Session::stop_capture() | |
190 | { | |
191 | if (get_capture_state() != Stopped) | |
192 | device_->stop(); | |
193 | ||
194 | // Check that sampling stopped | |
195 | if (sampling_thread_.joinable()) | |
196 | sampling_thread_.join(); | |
197 | } | |
198 | ||
199 | set< shared_ptr<data::SignalData> > Session::get_data() const | |
200 | { | |
201 | shared_lock<shared_mutex> lock(signals_mutex_); | |
202 | set< shared_ptr<data::SignalData> > data; | |
203 | for (const shared_ptr<view::Signal> sig : signals_) { | |
204 | assert(sig); | |
205 | data.insert(sig->data()); | |
206 | } | |
207 | ||
208 | return data; | |
209 | } | |
210 | ||
211 | boost::shared_mutex& Session::signals_mutex() const | |
212 | { | |
213 | return signals_mutex_; | |
214 | } | |
215 | ||
216 | const unordered_set< shared_ptr<view::Signal> >& Session::signals() const | |
217 | { | |
218 | return signals_; | |
219 | } | |
220 | ||
221 | #ifdef ENABLE_DECODE | |
222 | bool Session::add_decoder(srd_decoder *const dec) | |
223 | { | |
224 | map<const srd_channel*, shared_ptr<view::LogicSignal> > channels; | |
225 | shared_ptr<data::DecoderStack> decoder_stack; | |
226 | ||
227 | try | |
228 | { | |
229 | lock_guard<boost::shared_mutex> lock(signals_mutex_); | |
230 | ||
231 | // Create the decoder | |
232 | decoder_stack = shared_ptr<data::DecoderStack>( | |
233 | new data::DecoderStack(*this, dec)); | |
234 | ||
235 | // Make a list of all the channels | |
236 | std::vector<const srd_channel*> all_channels; | |
237 | for(const GSList *i = dec->channels; i; i = i->next) | |
238 | all_channels.push_back((const srd_channel*)i->data); | |
239 | for(const GSList *i = dec->opt_channels; i; i = i->next) | |
240 | all_channels.push_back((const srd_channel*)i->data); | |
241 | ||
242 | // Auto select the initial channels | |
243 | for (const srd_channel *pdch : all_channels) | |
244 | for (shared_ptr<view::Signal> s : signals_) | |
245 | { | |
246 | shared_ptr<view::LogicSignal> l = | |
247 | dynamic_pointer_cast<view::LogicSignal>(s); | |
248 | if (l && QString::fromUtf8(pdch->name). | |
249 | toLower().contains( | |
250 | l->name().toLower())) | |
251 | channels[pdch] = l; | |
252 | } | |
253 | ||
254 | assert(decoder_stack); | |
255 | assert(!decoder_stack->stack().empty()); | |
256 | assert(decoder_stack->stack().front()); | |
257 | decoder_stack->stack().front()->set_channels(channels); | |
258 | ||
259 | // Create the decode signal | |
260 | shared_ptr<view::DecodeTrace> d( | |
261 | new view::DecodeTrace(*this, decoder_stack, | |
262 | decode_traces_.size())); | |
263 | decode_traces_.push_back(d); | |
264 | } | |
265 | catch(std::runtime_error e) | |
266 | { | |
267 | return false; | |
268 | } | |
269 | ||
270 | signals_changed(); | |
271 | ||
272 | // Do an initial decode | |
273 | decoder_stack->begin_decode(); | |
274 | ||
275 | return true; | |
276 | } | |
277 | ||
278 | vector< shared_ptr<view::DecodeTrace> > Session::get_decode_signals() const | |
279 | { | |
280 | shared_lock<shared_mutex> lock(signals_mutex_); | |
281 | return decode_traces_; | |
282 | } | |
283 | ||
284 | void Session::remove_decode_signal(view::DecodeTrace *signal) | |
285 | { | |
286 | for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++) | |
287 | if ((*i).get() == signal) | |
288 | { | |
289 | decode_traces_.erase(i); | |
290 | signals_changed(); | |
291 | return; | |
292 | } | |
293 | } | |
294 | #endif | |
295 | ||
296 | void Session::set_capture_state(capture_state state) | |
297 | { | |
298 | lock_guard<mutex> lock(sampling_mutex_); | |
299 | const bool changed = capture_state_ != state; | |
300 | capture_state_ = state; | |
301 | if(changed) | |
302 | capture_state_changed(state); | |
303 | } | |
304 | ||
305 | void Session::update_signals() | |
306 | { | |
307 | assert(device_); | |
308 | assert(capture_state_ == Stopped); | |
309 | ||
310 | const shared_ptr<sigrok::Device> sr_dev = device_->device(); | |
311 | if (!sr_dev) { | |
312 | signals_.clear(); | |
313 | logic_data_.reset(); | |
314 | return; | |
315 | } | |
316 | ||
317 | // Detect what data types we will receive | |
318 | auto channels = sr_dev->channels(); | |
319 | unsigned int logic_channel_count = std::count_if( | |
320 | channels.begin(), channels.end(), | |
321 | [] (shared_ptr<Channel> channel) { | |
322 | return channel->type() == ChannelType::LOGIC; }); | |
323 | ||
324 | // Create data containers for the logic data segments | |
325 | { | |
326 | lock_guard<recursive_mutex> data_lock(data_mutex_); | |
327 | ||
328 | if (logic_channel_count == 0) { | |
329 | logic_data_.reset(); | |
330 | } else if (!logic_data_ || | |
331 | logic_data_->num_channels() != logic_channel_count) { | |
332 | logic_data_.reset(new data::Logic( | |
333 | logic_channel_count)); | |
334 | assert(logic_data_); | |
335 | } | |
336 | } | |
337 | ||
338 | // Make the Signals list | |
339 | { | |
340 | unique_lock<shared_mutex> lock(signals_mutex_); | |
341 | ||
342 | unordered_set< shared_ptr<view::Signal> > prev_sigs(signals_); | |
343 | signals_.clear(); | |
344 | ||
345 | for (auto channel : sr_dev->channels()) { | |
346 | shared_ptr<view::Signal> signal; | |
347 | ||
348 | // Find the channel in the old signals | |
349 | const auto iter = std::find_if( | |
350 | prev_sigs.cbegin(), prev_sigs.cend(), | |
351 | [&](const shared_ptr<view::Signal> &s) { | |
352 | return s->channel() == channel; | |
353 | }); | |
354 | if (iter != prev_sigs.end()) { | |
355 | // Copy the signal from the old set to the new | |
356 | signal = *iter; | |
357 | auto logic_signal = dynamic_pointer_cast< | |
358 | view::LogicSignal>(signal); | |
359 | if (logic_signal) | |
360 | logic_signal->set_logic_data( | |
361 | logic_data_); | |
362 | } else { | |
363 | // Create a new signal | |
364 | switch(channel->type()->id()) { | |
365 | case SR_CHANNEL_LOGIC: | |
366 | signal = shared_ptr<view::Signal>( | |
367 | new view::LogicSignal(*this, | |
368 | device_, channel, | |
369 | logic_data_)); | |
370 | break; | |
371 | ||
372 | case SR_CHANNEL_ANALOG: | |
373 | { | |
374 | shared_ptr<data::Analog> data( | |
375 | new data::Analog()); | |
376 | signal = shared_ptr<view::Signal>( | |
377 | new view::AnalogSignal( | |
378 | *this, channel, data)); | |
379 | break; | |
380 | } | |
381 | ||
382 | default: | |
383 | assert(0); | |
384 | break; | |
385 | } | |
386 | } | |
387 | ||
388 | assert(signal); | |
389 | signals_.insert(signal); | |
390 | } | |
391 | } | |
392 | ||
393 | signals_changed(); | |
394 | } | |
395 | ||
396 | shared_ptr<view::Signal> Session::signal_from_channel( | |
397 | shared_ptr<Channel> channel) const | |
398 | { | |
399 | lock_guard<boost::shared_mutex> lock(signals_mutex_); | |
400 | for (shared_ptr<view::Signal> sig : signals_) { | |
401 | assert(sig); | |
402 | if (sig->channel() == channel) | |
403 | return sig; | |
404 | } | |
405 | return shared_ptr<view::Signal>(); | |
406 | } | |
407 | ||
408 | void Session::read_sample_rate(shared_ptr<sigrok::Device> device) | |
409 | { | |
410 | assert(device); | |
411 | map< const ConfigKey*, set<sigrok::Capability> > keys; | |
412 | ||
413 | try { | |
414 | keys = device->config_keys(ConfigKey::DEVICE_OPTIONS); | |
415 | } catch (const Error) {} | |
416 | ||
417 | const auto iter = keys.find(ConfigKey::SAMPLERATE); | |
418 | cur_samplerate_ = (iter != keys.end() && | |
419 | (*iter).second.find(sigrok::GET) != (*iter).second.end()) ? | |
420 | VariantBase::cast_dynamic<Variant<guint64>>( | |
421 | device->config_get(ConfigKey::SAMPLERATE)).get() : 0; | |
422 | } | |
423 | ||
424 | void Session::sample_thread_proc(shared_ptr<devices::Device> device, | |
425 | function<void (const QString)> error_handler) | |
426 | { | |
427 | assert(device); | |
428 | assert(error_handler); | |
429 | ||
430 | const std::shared_ptr<sigrok::Device> sr_dev = device->device(); | |
431 | assert(sr_dev); | |
432 | read_sample_rate(sr_dev); | |
433 | ||
434 | try { | |
435 | device_->session()->start(); | |
436 | } catch(Error e) { | |
437 | error_handler(e.what()); | |
438 | return; | |
439 | } | |
440 | ||
441 | set_capture_state(device_->session()->trigger() ? | |
442 | AwaitingTrigger : Running); | |
443 | ||
444 | device_->run(); | |
445 | set_capture_state(Stopped); | |
446 | ||
447 | // Confirm that SR_DF_END was received | |
448 | if (cur_logic_segment_) | |
449 | { | |
450 | qDebug("SR_DF_END was not received."); | |
451 | assert(0); | |
452 | } | |
453 | } | |
454 | ||
455 | void Session::feed_in_header() | |
456 | { | |
457 | read_sample_rate(device_->device()); | |
458 | } | |
459 | ||
460 | void Session::feed_in_meta(shared_ptr<Meta> meta) | |
461 | { | |
462 | for (auto entry : meta->config()) { | |
463 | switch (entry.first->id()) { | |
464 | case SR_CONF_SAMPLERATE: | |
465 | /// @todo handle samplerate changes | |
466 | break; | |
467 | default: | |
468 | // Unknown metadata is not an error. | |
469 | break; | |
470 | } | |
471 | } | |
472 | ||
473 | signals_changed(); | |
474 | } | |
475 | ||
476 | void Session::feed_in_frame_begin() | |
477 | { | |
478 | if (cur_logic_segment_ || !cur_analog_segments_.empty()) | |
479 | frame_began(); | |
480 | } | |
481 | ||
482 | void Session::feed_in_logic(shared_ptr<Logic> logic) | |
483 | { | |
484 | lock_guard<recursive_mutex> lock(data_mutex_); | |
485 | ||
486 | if (!logic_data_) | |
487 | { | |
488 | qDebug() << "Unexpected logic packet"; | |
489 | return; | |
490 | } | |
491 | ||
492 | if (!cur_logic_segment_) | |
493 | { | |
494 | // This could be the first packet after a trigger | |
495 | set_capture_state(Running); | |
496 | ||
497 | // Get sample limit. | |
498 | assert(device_); | |
499 | const std::shared_ptr<sigrok::Device> device = | |
500 | device_->device(); | |
501 | assert(device); | |
502 | const auto keys = device->config_keys( | |
503 | ConfigKey::DEVICE_OPTIONS); | |
504 | const auto iter = keys.find(ConfigKey::LIMIT_SAMPLES); | |
505 | const uint64_t sample_limit = (iter != keys.end() && | |
506 | (*iter).second.find(sigrok::GET) != | |
507 | (*iter).second.end()) ? | |
508 | VariantBase::cast_dynamic<Variant<guint64>>( | |
509 | device->config_get(ConfigKey::LIMIT_SAMPLES)).get() : 0; | |
510 | ||
511 | // Create a new data segment | |
512 | cur_logic_segment_ = shared_ptr<data::LogicSegment>( | |
513 | new data::LogicSegment( | |
514 | logic, cur_samplerate_, sample_limit)); | |
515 | logic_data_->push_segment(cur_logic_segment_); | |
516 | ||
517 | // @todo Putting this here means that only listeners querying | |
518 | // for logic will be notified. Currently the only user of | |
519 | // frame_began is DecoderStack, but in future we need to signal | |
520 | // this after both analog and logic sweeps have begun. | |
521 | frame_began(); | |
522 | } | |
523 | else | |
524 | { | |
525 | // Append to the existing data segment | |
526 | cur_logic_segment_->append_payload(logic); | |
527 | } | |
528 | ||
529 | data_received(); | |
530 | } | |
531 | ||
532 | void Session::feed_in_analog(shared_ptr<Analog> analog) | |
533 | { | |
534 | lock_guard<recursive_mutex> lock(data_mutex_); | |
535 | ||
536 | const vector<shared_ptr<Channel>> channels = analog->channels(); | |
537 | const unsigned int channel_count = channels.size(); | |
538 | const size_t sample_count = analog->num_samples() / channel_count; | |
539 | const float *data = analog->data_pointer(); | |
540 | bool sweep_beginning = false; | |
541 | ||
542 | for (auto channel : channels) | |
543 | { | |
544 | shared_ptr<data::AnalogSegment> segment; | |
545 | ||
546 | // Try to get the segment of the channel | |
547 | const map< shared_ptr<Channel>, shared_ptr<data::AnalogSegment> >:: | |
548 | iterator iter = cur_analog_segments_.find(channel); | |
549 | if (iter != cur_analog_segments_.end()) | |
550 | segment = (*iter).second; | |
551 | else | |
552 | { | |
553 | // If no segment was found, this means we havn't | |
554 | // created one yet. i.e. this is the first packet | |
555 | // in the sweep containing this segment. | |
556 | sweep_beginning = true; | |
557 | ||
558 | // Get sample limit. | |
559 | uint64_t sample_limit; | |
560 | try { | |
561 | assert(device_); | |
562 | const std::shared_ptr<sigrok::Device> device = | |
563 | device_->device(); | |
564 | assert(device); | |
565 | sample_limit = VariantBase::cast_dynamic<Variant<guint64>>( | |
566 | device->config_get(ConfigKey::LIMIT_SAMPLES)).get(); | |
567 | } catch (Error) { | |
568 | sample_limit = 0; | |
569 | } | |
570 | ||
571 | // Create a segment, keep it in the maps of channels | |
572 | segment = shared_ptr<data::AnalogSegment>( | |
573 | new data::AnalogSegment( | |
574 | cur_samplerate_, sample_limit)); | |
575 | cur_analog_segments_[channel] = segment; | |
576 | ||
577 | // Find the annalog data associated with the channel | |
578 | shared_ptr<view::AnalogSignal> sig = | |
579 | dynamic_pointer_cast<view::AnalogSignal>( | |
580 | signal_from_channel(channel)); | |
581 | assert(sig); | |
582 | ||
583 | shared_ptr<data::Analog> data(sig->analog_data()); | |
584 | assert(data); | |
585 | ||
586 | // Push the segment into the analog data. | |
587 | data->push_segment(segment); | |
588 | } | |
589 | ||
590 | assert(segment); | |
591 | ||
592 | // Append the samples in the segment | |
593 | segment->append_interleaved_samples(data++, sample_count, | |
594 | channel_count); | |
595 | } | |
596 | ||
597 | if (sweep_beginning) { | |
598 | // This could be the first packet after a trigger | |
599 | set_capture_state(Running); | |
600 | } | |
601 | ||
602 | data_received(); | |
603 | } | |
604 | ||
605 | void Session::data_feed_in(shared_ptr<sigrok::Device> device, | |
606 | shared_ptr<Packet> packet) | |
607 | { | |
608 | (void)device; | |
609 | ||
610 | assert(device); | |
611 | assert(device == device_->device()); | |
612 | assert(packet); | |
613 | ||
614 | switch (packet->type()->id()) { | |
615 | case SR_DF_HEADER: | |
616 | feed_in_header(); | |
617 | break; | |
618 | ||
619 | case SR_DF_META: | |
620 | feed_in_meta(dynamic_pointer_cast<Meta>(packet->payload())); | |
621 | break; | |
622 | ||
623 | case SR_DF_FRAME_BEGIN: | |
624 | feed_in_frame_begin(); | |
625 | break; | |
626 | ||
627 | case SR_DF_LOGIC: | |
628 | feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload())); | |
629 | break; | |
630 | ||
631 | case SR_DF_ANALOG: | |
632 | feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload())); | |
633 | break; | |
634 | ||
635 | case SR_DF_END: | |
636 | { | |
637 | { | |
638 | lock_guard<recursive_mutex> lock(data_mutex_); | |
639 | cur_logic_segment_.reset(); | |
640 | cur_analog_segments_.clear(); | |
641 | } | |
642 | frame_ended(); | |
643 | break; | |
644 | } | |
645 | default: | |
646 | break; | |
647 | } | |
648 | } | |
649 | ||
650 | } // namespace pv |