Bump the metadata version to 0.15 also.

Wrong delayTime in 500KHz menu

Makefile

@@ -1,19 +1,24 @@
 #
-# Makefile for an Arduino based logic analyzer using the 'arduino-core'
-# package and makefiles.
+# Makefile for an Arduino based logic analyzer using the arduino-cli
 #
-#	$Id: Makefile,v 1.3 2011-03-07 02:47:26 gillham Exp $
+
+TARGET	= logic_analyzer
+FQBN	= arduino:avr:diecimila
+SERIAL	= /dev/ttyUSB*
+
+
+all:
+	@echo ""
+	@echo "---> run 'make build' to compile for Arduino Duemilanove"
+	@echo "---> run 'make upload' to upload to /dev/ttyUSB*"
+	@echo ""
+
+build:
+	arduino-cli compile --fqbn $(FQBN) $(TARGET)
+
+upload:
+	arduino-cli upload --fqbn $(FQBN) --port $(SERIAL) $(TARGET)
+
+#
+# end-of-file
 #
-ARDUINO_DIR  = /usr/share/arduino
-
-TARGET       = logic_analyzer
-ARDUINO_LIBS = 
-
-MCU          = atmega328p
-F_CPU        = 16000000
-ARDUINO_PORT = /dev/ttyUSB*
-AVRDUDE_ARD_BAUDRATE = 57600
-AVRDUDE_ARD_PROGRAMMER = arduino
-
-include /usr/share/arduino/Arduino.mk
-

README

@@ -7,6 +7,9 @@ SUMP client as well as the alternative client from here:
 
 The alternative client version is highly recommended.  Download version
 "ols-0.9.7" or newer for built-in device profiles.
+NOTE: The latest officially released version of ols (0.9.7.2) does not work
+      with modern Java runtimes.  You will need to build it yourself.
+      Follow the build instructions here: https://github.com/jawi/ols
 
 This SUMP protocol compatible logic analyzer for the Arduino board supports
 5 channels consisting of digital pins 8-12, which are the first 5 bits (0-4)
@@ -36,6 +39,35 @@ below 1MHz.  1MHz works for a basic busy wait trigger that doesn't store
 until after the trigger fires.
 Please try it out and report back.
 
+Debugging
+=========
+
+You can uncomment the '#define DEBUG_MENU' line to add some diagnostic menu
+options for capturing or dumping the capture buffer.
+You can uncomment the '#define DEBUG' and '#define DEBUG_MENU' for a couple
+extra menu options and logging of the received commands.  The DEBUG option
+is generally only useful for development, while the DEBUG_MENU option is
+good for troubleshooting when the logic_analyzer sketch isn't working for you.
+Both are disabled by default to conserve RAM for improved stability.
+
+CLI compiling
+=============
+
+If you want to use the 'arduino-mk' package (on Debian for example ) to compile
+this using the Makefile, you'll need to make a couple of changes since the
+Makefile only supports a single .ino file.  Basically you just need to append
+the other two files to the main .ino and then remove them.
+
+$ cat logic_analyzer_inline_4mhz.ino >> logic_analyzer.ino
+$ cat logic_analyzer_inline_2mhz.ino >> logic_analyzer.ino
+$ rm logic_analyzer_inline_4mhz.ino logic_analyzer_inline_2mhz.ino
+$ make
+
+This will make GIT unhappy so if you need to revert it to run 'git pull' do
+this:
+$ git reset --hard origin/master
+
+
 Older Notes
 ===========================================================================
 NOTE: With v0.11 you can now sample at 4MHz & 2MHz rates in addition to the 
@@ -69,5 +101,5 @@ NOTE: This master branch now supports Arduino 1.0 only.
       Checkout branch logic_analyzer_v0_5 for Arduino 22 support.
 
 
-Release: v0.12 September 6, 2013.
+Release: v0.15 December 21, 2021.
 

logic_analyzer/logic_analyzer.ino

@@ -2,7 +2,7 @@
  *
  * SUMP Protocol Implementation for Arduino boards.
  *
- * Copyright (c) 2011,2012,2013,2014 Andrew Gillham
+ * Copyright (c) 2011,2012,2013,2014,2015,2016,2017,2018,2019,2020,2021 Andrew Gillham
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -46,7 +46,7 @@
  *
  * To use this with the original or alternative SUMP clients,
  * use these settings:
- * 
+ *
  * Sampling rate: 4MHz (or lower) (no 2MHz on ATmega168)
  * Channel Groups: 0 (zero) only
  * Recording Size:
@@ -62,7 +62,7 @@
  * until after the trigger fires.
  * Please try it out and report back.
  *
- * Release: v0.12 September 6, 2013.
+ * Release: v0.15 December 21, 2021.
  *
  */
 
@@ -81,7 +81,9 @@ void blinkled(void);
 void get_metadata(void);
 void debugprint(void);
 void debugdump(void);
-
+void prettydump(void);
+void captureInline4mhz(void);
+void captureInline2mhz(void);
 
 /*
  * Should we use PORTD or PORTB?  (default is PORTB)
@@ -154,6 +156,9 @@ void debugdump(void);
 #if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
 #define DEBUG_CAPTURE_SIZE 7168
 #define CAPTURE_SIZE 7168
+#elif defined(__AVR_ATmega32U4__)
+#define DEBUG_CAPTURE_SIZE 2048
+#define CAPTURE_SIZE 2048
 #elif defined(__AVR_ATmega328P__)
 #define DEBUG_CAPTURE_SIZE 1024
 #define CAPTURE_SIZE 1024
@@ -170,8 +175,11 @@ void debugdump(void);
 #define DEBUG_ENABLE DDRD = DDRD | B10000000
 #define DEBUG_ON PORTD = B10000000
 #define DEBUG_OFF PORTD = B00000000
-#endif
-#define DEBUG
+#endif /* USE_PORTD */
+
+//#define DEBUG_MENU
+//#define DEBUG
+
 #ifdef DEBUG
 #define MAX_CAPTURE_SIZE DEBUG_CAPTURE_SIZE
 #else
@@ -263,10 +271,10 @@ void loop()
 
   if (Serial.available() > 0) {
     cmdByte = Serial.read();
-    switch(cmdByte) {
+    switch (cmdByte) {
     case SUMP_RESET:
       /*
-       * We don't do anything here as some unsupported extended commands have
+         * We don't do anything here as some unsupported extended commands have
        * zero bytes and are mistaken as resets.  This can trigger false resets
        * so we don't erase the data or do anything for a reset.
        */
@@ -280,14 +288,14 @@ void loop()
       break;
     case SUMP_ARM:
       /*
-       * Zero out any previous samples before arming.
+         * Zero out any previous samples before arming.
        * Done here instead via reset due to spurious resets.
        */
       for (i = 0 ; i < MAX_CAPTURE_SIZE; i++) {
         logicdata[i] = 0;
       }
       /*
-       * depending on the sample rate we need to delay in microseconds
+         * depending on the sample rate we need to delay in microseconds
        * or milliseconds.  We can't do the complex trigger at 1MHz
        * so in that case (delayTime == 1 and triggers enabled) use
        * captureMicro() instead of triggerMicro().
@@ -296,28 +304,28 @@ void loop()
       if (divider == 24) {
         /* 4.0MHz */
         captureInline4mhz();
-      } 
+      }
       else if (divider == 49) {
         /* 2.0MHz */
-#if defined(__AVR_ATmega168P__)
+#if !defined(__AVR_ATmega168__)
         captureInline2mhz();
 #endif
-      } 
+      }
       else if (useMicro) {
         if (trigger && (delayTime != 1)) {
           triggerMicro();
-        } 
+        }
         else {
           captureMicro();
         }
-      } 
+      }
       else {
         captureMilli();
       }
       break;
     case SUMP_TRIGGER_MASK:
       /*
-       * the trigger mask byte has a '1' for each enabled trigger so
+         * the trigger mask byte has a '1' for each enabled trigger so
        * we can just use it directly as our trigger mask.
        */
       getCmd();
@@ -329,7 +337,7 @@ void loop()
       break;
     case SUMP_TRIGGER_VALUES:
       /*
-       * trigger_values can be used directly as the value of each bit
+         * trigger_values can be used directly as the value of each bit
        * defines whether we're looking for it to be high or low.
        */
       getCmd();
@@ -345,7 +353,7 @@ void loop()
       break;
     case SUMP_SET_DIVIDER:
       /*
-       * the shifting needs to be done on the 32bit unsigned long variable
+         * the shifting needs to be done on the 32bit unsigned long variable
        * so that << 16 doesn't end up as zero.
        */
       getCmd();
@@ -358,7 +366,7 @@ void loop()
       break;
     case SUMP_SET_READ_DELAY_COUNT:
       /*
-       * this just sets up how many samples there should be before
+         * this just sets up how many samples there should be before
        * and after the trigger fires.  The readCount is total samples
        * to return and delayCount number of samples after the trigger.
        * this sets the buffer splits like 0/100, 25/75, 50/50
@@ -382,7 +390,7 @@ void loop()
       break;
     case SUMP_GET_METADATA:
       /*
-       * We return a description of our capabilities.
+         * We return a description of our capabilities.
        * Check the function's comments below.
        */
       get_metadata();
@@ -390,37 +398,85 @@ void loop()
     case SUMP_SELF_TEST:
       /* ignored. */
       break;
-#ifdef DEBUG
+#ifdef DEBUG_MENU
       /*
-       * a couple of debug commands used during development.
+         * a couple of debug commands used during development.
        */
+    case '?':
+      Serial.println("");
+#ifdef DEBUG
+      Serial.println("0 = clear cmd buffer");
+      Serial.println("1 = print cmd buffer");
+#endif /* DEBUG */
+      Serial.println("2 = print data buffer");
+      Serial.println("3 = pretty print buffer");
+      Serial.println("4 = capture at 4MHz");
+      Serial.println("5 = capture at 1MHz");
+      Serial.println("6 = capture at 500KHz");
+      break;
+#ifdef DEBUG
     case '0':
       /*
-       * This resets the debug buffer pointer, effectively clearing the
+         * This resets the debug buffer pointer, effectively clearing the
        * previous commands out of the buffer. Clear the sample data as well.
        * Just send a '0' from the Arduino IDE's Serial Monitor.
        */
-      savecount=0;
+      savecount = 0;
       for (i = 0 ; i < MAX_CAPTURE_SIZE; i++) {
         logicdata[i] = 0;
       }
       break;
     case '1':
       /*
-       * This is used to see what commands were sent to the device.
+         * This is used to see what commands were sent to the device.
        * you can use the Arduino serial monitor and send a '1' and get
        * a debug printout.  useless except for development.
        */
       blinkled();
       debugprint();
       break;
+#endif /* DEBUG */
     case '2':
       /*
-       * This dumps the sample data to the serial port.  Used for debugging.
+         * This dumps the sample data to the serial port.
        */
       debugdump();
       break;
-#endif /* DEBUG */
+    case '3':
+      /*
+         * Prints a visual representation of the data buffer.
+       */
+      prettydump();
+      break;
+    case '4':
+      /*
+         * This runs a sample capture at 4MHz.
+       */
+      captureInline4mhz();
+      Serial.println("");
+      Serial.println("4MHz capture done.");
+      break;
+    case '5':
+      /*
+         * This runs a sample capture at 1MHz.
+       * delayTime = 1ms for 1MHz sampling.
+       */
+      delayTime = 1;
+      captureMicro();
+      Serial.println("");
+      Serial.println("1MHz capture done.");
+      break;
+    case '6':
+      /*
+         * This runs a sample capture at 500KHz.
+       * delayTime = 2ms for 500KHz.
+       */
+      delayTime = 2;
+      captureMicro();
+      Serial.println("");
+      Serial.println("500KHz capture done.");
+      break;
+#endif /* DEBUG_MENU */
     default:
       /* ignore any unrecognized bytes. */
       break;
@@ -525,7 +581,7 @@ void captureMicro() {
       __asm__("nop\n\t""nop\n\t""nop\n\t""nop\n\t");
     }
     DEBUG_OFF; /* debug timing measurement */
-  } 
+  }
   else if (delayTime == 2) {
     /*
      * 500KHz sample rate = 2 uS delay, still pretty fast so we pad this
@@ -542,7 +598,7 @@ void captureMicro() {
       __asm__("nop\n\t""nop\n\t""nop\n\t""nop\n\t");
     }
     DEBUG_OFF; /* debug timing measurement */
-  } 
+  }
   else {
     /*
      * not 1MHz or 500KHz; delayMicroseconds(delay - 1) works fine here
@@ -595,7 +651,7 @@ void captureMicro() {
 void captureMilli() {
   unsigned int i = 0;
 
-  if(rleEnabled) {
+  if (rleEnabled) {
     /*
      * very basic trigger, just like in captureMicros() above.
      */
@@ -606,16 +662,16 @@ void captureMilli() {
     byte lastSample = 0;
     byte sampleCount = 0;
 
-    while(i < readCount) {
+    while (i < readCount) {
       /*
        * Implementation of the RLE unlimited protocol: timings might be off a little
        */
-      if(lastSample == (CHANPIN & B01111111) && sampleCount < 127) {
+      if (lastSample == (CHANPIN & B01111111) && sampleCount < 127) {
         sampleCount++;
         delay(delayTime);
         continue;
       }
-      if(sampleCount != 0) {
+      if (sampleCount != 0) {
         logicdata[i] = B10000000 | sampleCount;
         sampleCount = 0;
         i++;
@@ -627,7 +683,7 @@ void captureMilli() {
 
       i++;
     }
-  } 
+  }
   else {
     /*
      * very basic trigger, just like in captureMicros() above.
@@ -656,7 +712,7 @@ void captureMilli() {
  * This works ok at 500KHz and lower sample rates.  We don't have enough time
  * with a 16MHz clock to sample at 1MHz into the circular buffer.  A 20MHz
  * clock might be ok but all of the timings would have to be redone.
- * 
+ *
  */
 void triggerMicro() {
   unsigned int i = 0;
@@ -703,7 +759,7 @@ void triggerMicro() {
      * click stop.
      */
     return;
-  } 
+  }
   else if (delayTime == 2) {
     /*
      * 500KHz case.  We should be able to manage this in time.
@@ -732,7 +788,7 @@ void triggerMicro() {
     __asm__("nop\n\t""nop\n\t""nop\n\t""nop\n\t");
     DEBUG_OFF; /* debug timing measurement */
 
-    /* 
+    /*
      * One sample size delay. ends up being 2 uS combined with assignment
      * below.  This padding is so we have a consistent timing interval
      * between the trigger point and the subsequent samples.
@@ -762,7 +818,7 @@ void triggerMicro() {
     }
     DEBUG_OFF; /* debug timing measurement */
     delayMicroseconds(100);
-  } 
+  }
   else {
     /*
      * Less than 500KHz case.  This uses delayMicroseconds() and some padding
@@ -862,7 +918,7 @@ void setupDelay() {
   if (divider >= 1500000) {
     useMicro = 0;
     delayTime = (divider + 1) / 100000;
-  } 
+  }
   else {
     useMicro = 1;
     delayTime = (divider + 1) / 100;
@@ -893,7 +949,7 @@ void get_metadata() {
   Serial.write('0');
   Serial.write('.');
   Serial.write('1');
-  Serial.write('2');
+  Serial.write('5');
   Serial.write((uint8_t)0x00);
 
   /* sample memory */
@@ -938,11 +994,11 @@ void get_metadata() {
   Serial.write((uint8_t)0x02);
 
   /* end of data */
-  Serial.write((uint8_t)0x00);  
+  Serial.write((uint8_t)0x00);
 }
 
 /*
- * This is used by the '0' debug command to dump the contents of some
+ * This is used by the '1' debug command to dump the contents of some
  * interesting variables and the debug buffer.
  *
  */
@@ -974,7 +1030,7 @@ void debugprint() {
   for (i = 0 ; i < savecount; i++) {
     if (savebytes[i] == 0x20) {
       Serial.println();
-    } 
+    }
     else {
       Serial.print(savebytes[i], HEX);
       Serial.write(' ');
@@ -983,6 +1039,8 @@ void debugprint() {
   Serial.println("done...");
 }
 
+#endif /* DEBUG */
+#ifdef DEBUG_MENU
 /*
  * This is used by the '2' debug command to dump the contents
  * of the sample buffer.
@@ -1007,7 +1065,37 @@ void debugdump() {
     j++;
   }
 }
-#endif /* DEBUG */
+
+/*
+ * This is used by the '3' debugs command to dump the first 64 bytes
+ * of the sample buffer.
+ * It prints the data in a graphical representation.
+ */
+void prettydump() {
+  int i;
+  byte j;
+  byte k;
+
+  Serial.print("\r\n");
+
+  for (i = 0 ; i < 64; i++) {
+#ifdef USE_PORTD
+    k = logicdata[i] >> 2;
+#else
+    k = logicdata[i];
+#endif
+    for (j = 0; j < 8; j++) {
+      if (k & 0x01)
+        Serial.print("| ");
+      else
+        Serial.print(" |");
+      k = k >> 1;
+    }
+    Serial.print("\r\n");
+  }
+}
+#endif /* DEBUG_MENU */
+
 
 
 

logic_analyzer/logic_analyzer_inline_2mhz.ino

@@ -2,7 +2,7 @@
  *
  * SUMP Protocol Implementation for Arduino boards.
  *
- * Copyright (c) 2011,2012,2013 Andrew Gillham
+ * Copyright (c) 2011,2012,2013,2014,2015,2016,2017,2018,2019,2020,2021 Andrew Gillham
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

logic_analyzer/logic_analyzer_inline_4mhz.ino

@@ -2,7 +2,7 @@
  *
  * SUMP Protocol Implementation for Arduino boards.
  *
- * Copyright (c) 2011,2012,2013 Andrew Gillham
+ * Copyright (c) 2011,2012,2013,2014,2015,2016,2017,2018,2019,2020,2021 Andrew Gillham
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

logic_analyzer_leonardo/Makefile

@@ -0,0 +1,24 @@
+#
+# Makefile for an Arduino based logic analyzer using the arduino-cli
+#
+
+TARGET	= logic_analyzer_leonardo
+FQBN	= arduino:avr:leonardo
+SERIAL	= /dev/ttyUSB*
+
+
+all:
+	@echo ""
+	@echo "---> run 'make build' to compile for Arduino Leonardo"
+	@echo "---> run 'make upload' to upload to /dev/ttyUSB*"
+	@echo ""
+
+build:
+	arduino-cli compile --fqbn $(FQBN) $(TARGET)
+
+upload:
+	arduino-cli upload --fqbn $(FQBN) --port $(SERIAL) $(TARGET)
+
+#
+# end-of-file
+#