matwey / libopenvizsla Goto Github PK

View Code? Open in Web Editor NEW

21.0 8.0 14.0 599 KB

Host applications for OpenVizsla USB tool

License: GNU Lesser General Public License v3.0

CMake 11.41% C 88.59%

usb fpga c openvizsla

libopenvizsla's Introduction

libopenvizsla

An attempt to reimplement OpenVizsla host software in plain C.

Getting Started

This section describes how to get started with OpenVizsla and Wireshark.

Linux

Build the project as described below
Copy the ovextcap executable to Wiresharks extcap directory
Run Wireshark and start capturing

Windows

Use Zadig to install the libusbK driver for OpenVizsla
Download Windows release
Extract and copy all files from bin directory to Wiresharks extcap directory
Run Wireshark and start capturing

Building

Following components are required to build libopenvizsla:

check - unit testing framework for C;
cmake - cross-platform open-source build system;
gperf - a perfect hash function generator;
libftdi - FTDI USB userspace driver;
libzip - C library for reading, creating, and modifying zip archives;

Then, the library can be compiled as the following:

mkdir build && cd build
cmake ..
make all test

Development

Any pull-requests to the project are always welcome.

libopenvizsla's People

Contributors

Stargazers

Watchers

Forkers

mwieder desowin hex55 fjolnir bmx laf0rge icodein mfkiwl 0xbadcoffe fvdpol xinghuaman fengqingxin jorgectf ibokhaled

libopenvizsla's Issues

Rework cha_loop_transfer

In 09629fb we had to fix race condition issues by disabling data acquisition and data parsing in parallel. We have to revert this behavior in a proper way to allow better performance.

Migrate appveyor mingw environments to vcpkg

mingw triplets are supported in vcpkg currently.
However, not all dependencies are installable for mingw triplets yet.

Coverity Scan

It would be good if libopenvizsla was registered at Coverity Scan. I am pretty sure that the retry decrement logic bug would be picked up by Coverity Scan as dead code.

This library is pretty much excellent choice for Wireshark extcap for OpenVizsla. I think so, because it should be possible to just compile a single executable that could simply be copied to Wireshark extcap directory.

As for actual options, I think we could have capture speed (low/full/high) and potentially FPGA firmware selection (use preloaded one, or a file selected by user).

Force FPGA firmware download?

Currently the ov_open() will skip firmware download based on the PORTB_INIT_BIT and PORTB_DONE_BIT state. While this is ok with pretty much the single firmware package floating around, it seems to me that it is prone to problems when (and if) we get multiple firmwares (e.g. with the NAK filter built in and/or streaming pcap directly).

The actual firmware download is pretty fast and I think we could just force FPGA reset and programming on every startup - that way the executable will always work with its bundled firmware package regardless of what other packages/versions might be there.

USB speed selection

Currently, USB speed is just hard coded. Unfortunately, the speed is not auto-detected by the hardware so the library interface should provide an option to specify the expected transfer speed.

Finalise library API

We need to finalise the library API somehow. Only ov_-prefixed functions should be exported. ov.h should be the single one required header file for applications.

Big-endian systems doesn't work correctly.

[  135s] 3/4 Test #2: test_decoder .....................***Failed    0.04 sec
[  135s] Running suite(s): decoder
[  135s] 42%: Checks: 7, Failures: 4, Errors: 0
[  135s] /home/abuild/rpmbuild/BUILD/libopenvizsla-0.1.0/test/decoder.c:36:F:Packet:test_packet_decoder1:0: Assertion 'p.packet.size == 1' failed: p.packet.size == 256, 1 == 1
[  135s] /home/abuild/rpmbuild/BUILD/libopenvizsla-0.1.0/test/decoder.c:46:F:Packet:test_packet_decoder2:0: Assertion 'p.packet.size == 1' failed: p.packet.size == 256, 1 == 1
[  135s] /home/abuild/rpmbuild/BUILD/libopenvizsla-0.1.0/test/decoder.c:62:F:Packet:test_packet_decoder4:0: Assertion 'p.packet.size == 3' failed: p.packet.size == 768, 3 == 3
[  135s] /home/abuild/rpmbuild/BUILD/libopenvizsla-0.1.0/test/decoder.c:73:F:Packet:test_packet_decoder5:0: Assertion 'p.packet.size == 3' failed: p.packet.size == 768, 3 == 3