Sigrok based RDM sniffer

.gitignore

@@ -226,6 +226,8 @@ tools/e133/slp_sa_test
 tools/e133/slp_sa_test.exe
 tools/logic/logic_rdm_sniffer
 tools/logic/logic_rdm_sniffer.exe
+tools/logic/sigrok_rdm_sniffer
+tools/logic/sigrok_rdm_sniffer.exe
 tools/ola_trigger/config.tab.cpp
 tools/ola_trigger/config.tab.h
 tools/ola_trigger/lex.yy.cpp

.travis.yml

@@ -31,6 +31,7 @@ addons:
      - libavahi-glib1
      - libncurses5-dev
      - libmicrohttpd-dev
+     - libsigrok-dev
     packages: &core_build_gpp_latest
      - *core_build
      - g++-10
@@ -68,6 +69,7 @@ addons:
      # Looks like this is Python 3 only, so install via pip
      # - numpy
      - libusb
+     # Sigrok
     packages: &mac_cppunit_113
      # Installing via the addon isn't currently working so do it the old fashioned way below
      # - https://raw.githubusercontent.com/Homebrew/homebrew-core/e6e43cf6a3^/Formula/cppunit.rb # install a slightly older cppunit, as latest needs C++11 support

configure.ac

@@ -559,9 +559,29 @@ AS_IF([test "x$have_avahi" = xyes],
       [AC_DEFINE([HAVE_AVAHI], [1], [Defined to use Avahi])])
 AM_CONDITIONAL([HAVE_AVAHI], [test "x$have_avahi" = xyes])
 
-# Look for -lSaleaeDevice, if we have it we build the logic sniffer.
+# Look for -lSaleaeDevice, if we have it we build the Saleae logic sniffer.
 SALEAE_DEVICE
 
+# Look for -lsigrok, if we have it we build the sigrok logic sniffer.
+PKG_CHECK_MODULES([libsigrok], [libsigrok], [have_libsigrok="yes"], [have_libsigrok="no"])
+AM_CONDITIONAL([HAVE_LIBSIGROK],
+               [test "x$have_libsigrok" = xyes])
+
+have_libsigrok_context="no"
+AS_IF([test "x$have_libsigrok" != xno],
+      [PKG_CHECK_MODULES([libsigrok_context], [libsigrok >= 0.4.0],
+                         [have_libsigrok_context="yes"], [true])])
+AS_IF([test "x$have_libsigrok_context" = xyes],
+      [AC_DEFINE([HAVE_LIBSIGROK_CONTEXT], [1],
+                 [define if libsigrok is installed and uses it's context])])
+
+have_libsigrok_dev_inst_opaque="no"
+AS_IF([test "x$have_libsigrok" != xno],
+      [PKG_CHECK_MODULES([libsigrok_context], [libsigrok >= 0.4.0],
+                         [have_libsigrok_dev_inst_opaque="yes"], [true])])
+AS_IF([test "x$have_libsigrok_dev_inst_opaque" = xyes],
+      [AC_DEFINE([HAVE_LIBSIGROK_DEV_INST_OPAQUE], [1],
+                 [define if libsigrok is installed and the sr_dev_inst struct is opaque])])
 
 # Features
 #####################################################

man/Makefile.mk

@@ -27,4 +27,5 @@ dist_man_MANS += \
     man/rdm_responder_test.py.1 \
     man/rdm_test_server.py.1 \
     man/rdmpro_sniffer.1 \
+    man/sigrok_rdm_sniffer.1 \
     man/usbpro_firmware.1

man/sigrok_rdm_sniffer.1

@@ -0,0 +1,48 @@
+.TH sigrok_rdm_sniffer 1 "March 2021"
+.SH NAME
+sigrok_rdm_sniffer \- Decode DMX/RDM data from devices supported by sigrok
+.SH SYNOPSIS
+.B sigrok_rdm_sniffer
+[ options ]
+.SH DESCRIPTION
+.B sigrok_rdm_sniffer
+Decode DMX/RDM data from devices supported by sigrok
+.SH OPTIONS
+.IP "-d, --display-dmx"
+Display DMX Frames. Defaults to false.
+.IP "-h, --help"
+Display the help message
+.IP "-l, --log-level <int8_t>"
+Set the logging level 0 .. 4.
+.IP "-r, --full-rdm"
+Unpack RDM parameter data.
+.IP "-t, --timestamp"
+Include timestamps.
+.IP "-v, --version"
+Print
+.B sigrok_rdm_sniffer
+version information.
+.IP "--display-asc"
+Display non-RDM alternate start code frames.
+.IP "--dmx-slot-limit <uint16_t>"
+Only display the first N slots of DMX data.
+.IP "--no-use-epoll"
+Disable the use of epoll(), revert to select()
+.IP "--pid-location <string>"
+The directory containing the PID definitions.
+.IP "--sample-rate <uint32_t>"
+Sample rate in Hz.
+.IP "--scheduler-policy <string>"
+The thread scheduling policy, one of {fifo, rr}.
+.IP "--scheduler-priority <uint16_t>"
+The thread priority, only used if --scheduler-policy is set.
+.IP "--sigrok-device <string>"
+Set the sigrok device to use.
+.IP "--sigrok-log-level <uint32_t>"
+Set the sigrok logging level from 0 .. 5.
+.IP "--sigrok-samples <uint32_t>"
+Limit capture to this many samples.
+.IP "--sigrok-time <uint32_t>"
+Limit capture to this many ms.
+.IP "--syslog"
+Send to syslog rather than stderr.

tools/logic/DMXSignalProcessor.cpp

@@ -69,6 +69,7 @@ DMXSignalProcessor::DMXSignalProcessor(DataCallback *callback,
       m_ticks(0),
       m_may_be_in_break(false),
       m_ticks_in_break(0) {
+  OLA_DEBUG << "Microseconds per tick " << m_microseconds_per_tick;
   if (m_sample_rate % DMX_BITRATE) {
     OLA_WARN << "Sample rate is not a multiple of " << DMX_BITRATE;
   }
@@ -82,10 +83,11 @@ DMXSignalProcessor::DMXSignalProcessor(DataCallback *callback,
  * @param size the number of samples in the stream
  * @param mask the value to be AND'ed with each sample to determine if the
  *   signal is high or low.
+ * @param width the width (in bytes) of each sample within the stream
  */
 void DMXSignalProcessor::Process(uint8_t *ptr, unsigned int size,
-                                 uint8_t mask) {
-  for (unsigned int i = 0 ; i < size; i++) {
+                                 uint8_t mask, unsigned int width) {
+  for (unsigned int i = 0 ; i < size; i += width) {
     ProcessSample(ptr[i] & mask);
   }
 }
@@ -118,7 +120,7 @@ void DMXSignalProcessor::ProcessSample(bool bit) {
           SetState(MAB);
         } else {
           OLA_WARN << "Break too short, was " << TicksAsMicroSeconds()
-                   << " us";
+                   << " us (" << m_ticks << " ticks)";
           SetState(IDLE);
         }
       } else {
@@ -136,7 +138,8 @@ void DMXSignalProcessor::ProcessSample(bool bit) {
           // OLA_INFO << "In start bit!";
           SetState(START_BIT);
         } else {
-          OLA_WARN << "Mark too short, was " << TicksAsMicroSeconds() << "us";
+          OLA_WARN << "Mark too short, was " << TicksAsMicroSeconds() << "us ("
+                   << m_ticks << " ticks)";
           SetState(UNDEFINED);
         }
       }
@@ -222,7 +225,7 @@ void DMXSignalProcessor::ProcessBit(bool bit) {
       SetState(static_cast<State>(m_state + 1));
     } else {
       OLA_WARN << "Bit " << m_state << " was too short, was "
-               << TicksAsMicroSeconds() << "us";
+               << TicksAsMicroSeconds() << "us (" << m_ticks << " ticks)";
       SetState(UNDEFINED);
     }
   }
@@ -283,7 +286,7 @@ void DMXSignalProcessor::HandleFrame() {
  */
 void DMXSignalProcessor::SetState(State state, unsigned int ticks) {
   OLA_INFO << "Transition to " << state << ", prev duration was "
-           << TicksAsMicroSeconds();
+           << TicksAsMicroSeconds() << " us (" << m_ticks << " ticks)";
   m_state = state;
   m_ticks = ticks;
   if (state == UNDEFINED) {

tools/logic/DMXSignalProcessor.h

@@ -42,7 +42,8 @@ class DMXSignalProcessor {
     }
 
     // Process more data.
-    void Process(uint8_t *ptr, unsigned int size, uint8_t mask = 0xff);
+    void Process(uint8_t *ptr, unsigned int size, uint8_t mask = 0xff,
+                 unsigned int width = 1);
 
  private:
     enum State {

tools/logic/Makefile.mk

@@ -2,11 +2,24 @@ if HAVE_SALEAE_LOGIC
 bin_PROGRAMS += tools/logic/logic_rdm_sniffer
 endif
 
+if HAVE_LIBSIGROK
+bin_PROGRAMS += tools/logic/sigrok_rdm_sniffer
+endif
+
 tools_logic_logic_rdm_sniffer_SOURCES = \
     tools/logic/DMXSignalProcessor.cpp \
     tools/logic/DMXSignalProcessor.h \
     tools/logic/logic-rdm-sniffer.cpp
 tools_logic_logic_rdm_sniffer_LDADD = common/libolacommon.la \
                                       $(libSaleaeDevice_LIBS)
 
+tools_logic_sigrok_rdm_sniffer_SOURCES = \
+    tools/logic/DMXSignalProcessor.cpp \
+    tools/logic/DMXSignalProcessor.h \
+    tools/logic/sigrok-rdm-sniffer.cpp
+tools_logic_sigrok_rdm_sniffer_CXXFLAGS = $(COMMON_CXXFLAGS) \
+                                          $(libsigrok_CFLAGS)
+tools_logic_sigrok_rdm_sniffer_LDADD = common/libolacommon.la \
+                                       $(libsigrok_LIBS)
+
 EXTRA_DIST += tools/logic/README.md

tools/logic/logic-rdm-sniffer.cpp

@@ -90,6 +90,10 @@ DEFINE_s_default_bool(display_dmx, d, false,
 DEFINE_uint16(dmx_slot_limit, ola::DMX_UNIVERSE_SIZE,
               "Only display the first N slots of DMX data.");
 DEFINE_uint32(sample_rate, 4000000, "Sample rate in HZ.");
+// Set the sample rate.  Must be a supported value, i.e.:  24000000, 16000000,
+// 12000000, 8000000, 4000000, 2000000, 1000000, 500000, 250000, 200000,
+// 100000, 50000, 25000
+// TODO(Peter): Trap and report this, don't just crash
 DEFINE_string(pid_location, "",
               "The directory containing the PID definitions.");