Skip to content

Add continuous mode support to Sipeed SLogic Analyzer #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Shoaibashk wants to merge 1 commit into
base: slogic-dev
Choose a base branch
from
Open

Add continuous mode support to Sipeed SLogic Analyzer #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
200 changes: 109 additions & 91 deletions README
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
-------------------------------------------------------------------------------
README
-------------------------------------------------------------------------------
---

---

Comment on lines 1 to 6

Copilot AI Mar 25, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The README changes (Markdown-style headings, horizontal rules at the top, and a new Windows build section) are unrelated to the PR description about SLogic continuous mode support. Please either move these documentation edits to a separate PR, or update the PR description to explicitly include them and ensure the README formatting is intentional/consistent (e.g., consider README.md if switching to Markdown).

Copilot uses AI. Check for mistakes.
The sigrok project aims at creating a portable, cross-platform,
Free/Libre/Open-Source signal analysis software suite that supports various
Expand All @@ -10,9 +12,7 @@ libsigrok is a shared library written in C which provides the basic API
for talking to hardware and reading/writing the acquired data into various
input/output file formats.


Status
------
## Status

libsigrok is in a usable state and has had official tarball releases.

Expand All @@ -23,117 +23,142 @@ in the shared library / libtool / .so-file version numbers.
However, there are _NO_ guarantees at all for stable APIs in git snapshots!
Distro packagers should only use released tarballs (no git snapshots).


Requirements
------------
## Requirements

Requirements for the C library:

- git (only needed when building from git)
- gcc (>= 4.0) or clang
- make
- autoconf >= 2.63 (only needed when building from git)
- automake >= 1.11 (only needed when building from git)
- libtool (only needed when building from git)
- pkg-config >= 0.22
- libglib >= 2.32.0
- zlib (optional, used for CRC32 calculation in STF input)
- libzip >= 0.11
- libtirpc (optional, used by VXI, fallback when glibc >= 2.26)
- libserialport >= 0.1.1 (optional, used by some drivers)
- librevisa >= 0.0.20130412 (optional, used by some drivers)
- libusb-1.0 >= 1.0.16 (optional, used by some drivers)
- hidapi >= 0.8.0 (optional, used for some HID based "serial cables")
- bluez/libbluetooth >= 4.0 (optional, used for Bluetooth/BLE communication)
- libftdi1 >= 1.0 (optional, used by some drivers)
- libgpib (optional, used by some drivers)
- libieee1284 (optional, used by some drivers)
- libgio >= 2.32.0 (optional, used by some drivers)
- nettle (optional, used by some drivers)
- check >= 0.9.4 (optional, only needed to run unit tests)
- doxygen (optional, only needed for the C API docs)
- graphviz (optional, only needed for the C API docs)
- git (only needed when building from git)
- gcc (>= 4.0) or clang
- make
- autoconf >= 2.63 (only needed when building from git)
- automake >= 1.11 (only needed when building from git)
- libtool (only needed when building from git)
- pkg-config >= 0.22
- libglib >= 2.32.0
- zlib (optional, used for CRC32 calculation in STF input)
- libzip >= 0.11
- libtirpc (optional, used by VXI, fallback when glibc >= 2.26)
- libserialport >= 0.1.1 (optional, used by some drivers)
- librevisa >= 0.0.20130412 (optional, used by some drivers)
- libusb-1.0 >= 1.0.16 (optional, used by some drivers)
- hidapi >= 0.8.0 (optional, used for some HID based "serial cables")
- bluez/libbluetooth >= 4.0 (optional, used for Bluetooth/BLE communication)
- libftdi1 >= 1.0 (optional, used by some drivers)
- libgpib (optional, used by some drivers)
- libieee1284 (optional, used by some drivers)
- libgio >= 2.32.0 (optional, used by some drivers)
- nettle (optional, used by some drivers)
- check >= 0.9.4 (optional, only needed to run unit tests)
- doxygen (optional, only needed for the C API docs)
- graphviz (optional, only needed for the C API docs)

Requirements for the C++ bindings:

- libsigrok >= 0.4.0 (the libsigrok C library, see above)
- A C++ compiler with C++11 support (-std=c++11 option), e.g.
- g++ (>= 4.8.1)
- clang++ (>= 3.3)
- autoconf-archive (only needed when building from git)
- doxygen (required for building the bindings, not only for C++ API docs!)
- graphviz (optional, only needed for the C++ API docs)
- Python 3 executable (development files are not needed)
- glibmm-2.4 (>= 2.32.0) or glibmm-2.68 (>= 2.68.0)
- libsigrok >= 0.4.0 (the libsigrok C library, see above)
- A C++ compiler with C++11 support (-std=c++11 option), e.g.
- g++ (>= 4.8.1)
- clang++ (>= 3.3)
- autoconf-archive (only needed when building from git)
- doxygen (required for building the bindings, not only for C++ API docs!)
- graphviz (optional, only needed for the C++ API docs)
- Python 3 executable (development files are not needed)
- glibmm-2.4 (>= 2.32.0) or glibmm-2.68 (>= 2.68.0)

Requirements for the Python bindings:

- libsigrokcxx >= 0.4.0 (the libsigrok C++ bindings, see above)
- SWIG >= 2.0.0
- Python >= 3 (including development files!)
- Python setuptools
- pygobject >= 3.0.0, a.k.a python-gi
- numpy
- doxygen (optional, only needed for the Python API docs)
- graphviz (optional, only needed for the Python API docs)
- doxypy (optional, only needed for the Python API docs)
- libsigrokcxx >= 0.4.0 (the libsigrok C++ bindings, see above)
- SWIG >= 2.0.0
- Python >= 3 (including development files!)
- Python setuptools
- pygobject >= 3.0.0, a.k.a python-gi
- numpy
- doxygen (optional, only needed for the Python API docs)
- graphviz (optional, only needed for the Python API docs)
- doxypy (optional, only needed for the Python API docs)

Requirements for the Ruby bindings:

- libsigrokcxx >= 0.4.0 (the libsigrok C++ bindings, see above)
- Ruby >= 2.5.0 (including development files!)
- SWIG >= 3.0.8
- YARD (optional, only needed for the Ruby API docs)
- libsigrokcxx >= 0.4.0 (the libsigrok C++ bindings, see above)
- Ruby >= 2.5.0 (including development files!)
- SWIG >= 3.0.8
- YARD (optional, only needed for the Ruby API docs)

Requirements for the Java bindings:

- libsigrokcxx >= 0.4.0 (the libsigrok C++ bindings, see above)
- SWIG >= 2.0.0
- Java JDK (for JNI includes and the javac/jar binaries)
- doxygen (optional, only needed for the Java API docs)
- graphviz (optional, only needed for the Java API docs)
- libsigrokcxx >= 0.4.0 (the libsigrok C++ bindings, see above)
- SWIG >= 2.0.0
- Java JDK (for JNI includes and the javac/jar binaries)
- doxygen (optional, only needed for the Java API docs)
- graphviz (optional, only needed for the Java API docs)


Building and installing
-----------------------
## Building and installing

In order to get the libsigrok source code and build it, run:

$ git clone git://sigrok.org/libsigrok
$ cd libsigrok
$ ./autogen.sh
$ ./configure
$ make
$ git clone git://sigrok.org/libsigrok
$ cd libsigrok
$ ./autogen.sh
$ ./configure
$ make

For installing libsigrok:

$ make install
$ make install

See INSTALL or the following wiki page for more (OS-specific) instructions:

http://sigrok.org/wiki/Building
http://sigrok.org/wiki/Building

Please also check the following wiki page in case you encounter any issues:

http://sigrok.org/wiki/Building#FAQ


Device-specific issues
----------------------
http://sigrok.org/wiki/Building#FAQ

## Windows (MSYS2/MinGW-w64)

The supported Windows build path is MSYS2 with a MinGW-w64 shell. Install the
matching toolchain for your shell (for example mingw64 or ucrt64), plus the
Autotools and pkg-config stack and the runtime libraries you want enabled.

Typical packages are:

- autoconf
- automake
- libtool
- pkgconf
- make
- git
- gcc and g++ from the matching mingw-w64 toolchain
- glib2
- libzip
- libusb
- zlib
- hidapi
- libftdi
- libserialport

Then build from the MSYS2 MinGW shell that matches your target:
$ msys2
$ ./autogen.sh
$ ./configure --disable-java --disable-ruby
$ make
$ make install

The configure script will select the Windows-specific code paths automatically,
including the MinGW-specific libusb and Winsock settings. If you need USB
device access at runtime, assign the device to a WinUSB/libusb-compatible
driver first; see README.devices for the Windows driver notes.

## Device-specific issues

Please check README.devices for some notes and hints about device- or
driver-specific issues to be aware of.


Firmware
--------
## Firmware

Some devices supported by libsigrok need a firmware to be uploaded before the
device can be used. See README.devices for details.


Copyright and license
---------------------
## Copyright and license

libsigrok is licensed under the terms of the GNU General Public License
(GPL), version 3 or later.
Expand All @@ -144,21 +169,14 @@ the library as a whole is licensed under the terms of the GPLv3+.

Please see the individual source files for the full list of copyright holders.

## Mailing list

Mailing list
------------

https://lists.sourceforge.net/lists/listinfo/sigrok-devel
https://lists.sourceforge.net/lists/listinfo/sigrok-devel


IRC
---
## IRC

You can find the sigrok developers in the #sigrok IRC channel on Libera.Chat.

## Website

Website
-------

http://sigrok.org/wiki/Libsigrok

http://sigrok.org/wiki/Libsigrok
1 change: 1 addition & 0 deletions make-cxx.exit
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
0

Copilot AI Mar 25, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make-cxx.exit looks like a generated build artifact (exit code file). It’s usually better not to commit this kind of build output; consider removing it from the PR and ignoring it via .gitignore if it’s produced locally.

Suggested change
0
This file is intentionally tracked and does not store a generated exit code; it should not be treated as a build artifact.

Copilot uses AI. Check for mistakes.
Loading
Loading