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 $
-#
-ARDUINO_DIR  = /usr/share/arduino
 
 TARGET	= logic_analyzer
-ARDUINO_LIBS = 
+FQBN	= arduino:avr:diecimila
+SERIAL	= /dev/ttyUSB*
 
-MCU          = atmega328p
-F_CPU        = 16000000
-ARDUINO_PORT = /dev/ttyUSB*
-AVRDUDE_ARD_BAUDRATE = 57600
-AVRDUDE_ARD_PROGRAMMER = arduino
 
-include /usr/share/arduino/Arduino.mk
+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
+#

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
@@ -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,18 +81,15 @@ 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)
  * PORTD support with triggers seems to work but needs more testing.
  */
 //#define USE_PORTD 1
-#if defined(USE_PORTD)
-#define SHIFTBITS 2
-#elif defined(__AVR_ATmega32U4__)
-#define SHIFTBITS 1
-#endif
 
 /*
  * Arduino device profile:      ols.profile-agla.cfg
@@ -119,15 +116,6 @@ void debugdump(void);
 #define CHAN5 7
 #else
 #define CHANPIN PINB
-#if defined(__AVR_ATmega32U4__)
-#define CHAN0 SCK
-#define CHAN1 MOSI
-#define CHAN2 MISO
-#define CHAN3 8
-#define CHAN4 9
-#define CHAN5 10
-#define CHAN6 11
-#else
 #define CHAN0 8
 #define CHAN1 9
 #define CHAN2 10
@@ -135,9 +123,8 @@ void debugdump(void);
 #define CHAN4 12
 /* Comment out CHAN5 if you don't want to use the LED pin for an input */
 #define CHAN5 13
-#endif /* AVR_ATmega32U4 */
 #endif /* USE_PORTD */
-#endif /* Mega1280 or Mega2560 */
+#endif
 #define ledPin 13
 
 /* XON/XOFF are not supported. */
@@ -170,8 +157,8 @@ void debugdump(void);
 #define DEBUG_CAPTURE_SIZE 7168
 #define CAPTURE_SIZE 7168
 #elif defined(__AVR_ATmega32U4__)
-#define DEBUG_CAPTURE_SIZE 1536
-#define CAPTURE_SIZE 1536
+#define DEBUG_CAPTURE_SIZE 2048
+#define CAPTURE_SIZE 2048
 #elif defined(__AVR_ATmega328P__)
 #define DEBUG_CAPTURE_SIZE 1024
 #define CAPTURE_SIZE 1024
@@ -188,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
@@ -223,10 +213,6 @@ boolean rleEnabled = 0;
 void setup()
 {
   Serial.begin(115200);
-  while (!Serial) {
-    ; // wait for serial port to connect. Needed for Leonardo only
-  }
-
 
   /*
    * set debug pin (digital pin 8) to output right away so it settles.
@@ -244,15 +230,14 @@ void setup()
 #ifdef CHAN5
   pinMode(CHAN5, INPUT);
 #endif
-#ifdef CHAN6
+#if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
   pinMode(CHAN6, INPUT);
-#endif
-#ifdef CHAN7
   pinMode(CHAN7, INPUT);
-#endif
+#else
 #ifndef CHAN5
   pinMode(ledPin, OUTPUT);
 #endif
+#endif /* Mega */
 
 #if 0
 
@@ -322,7 +307,7 @@ void loop()
       }
       else if (divider == 49) {
         /* 2.0MHz */
-#if defined(__AVR_ATmega168P__)
+#if !defined(__AVR_ATmega168__)
         captureInline2mhz();
 #endif
       }
@@ -344,8 +329,8 @@ void loop()
        * we can just use it directly as our trigger mask.
        */
       getCmd();
-#ifdef SHIFTBITS
-      trigger = cmdBytes[0] << SHIFTBITS;
+#ifdef USE_PORTD
+      trigger = cmdBytes[0] << 2;
 #else
       trigger = cmdBytes[0];
 #endif
@@ -356,8 +341,8 @@ void loop()
        * defines whether we're looking for it to be high or low.
        */
       getCmd();
-#ifdef SHIFTBITS
-      trigger_values = cmdBytes[0] << SHIFTBITS;
+#ifdef USE_PORTD
+      trigger_values = cmdBytes[0] << 2;
 #else
       trigger_values = cmdBytes[0];
 #endif
@@ -413,10 +398,23 @@ void loop()
     case SUMP_SELF_TEST:
       /* ignored. */
       break;
-#ifdef DEBUG
+#ifdef DEBUG_MENU
       /*
          * 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
@@ -437,13 +435,48 @@ void loop()
       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;
@@ -590,8 +623,8 @@ void captureMicro() {
    * is done for any triggers, this is effectively the 0/100 buffer split.
    */
   for (i = 0 ; i < readCount; i++) {
-#ifdef SHIFTBITS
-    Serial.write(logicdata[i] >> SHIFTBITS);
+#ifdef USE_PORTD
+    Serial.write(logicdata[i] >> 2);
 #else
     Serial.write(logicdata[i]);
 #endif
@@ -665,8 +698,8 @@ void captureMilli() {
     }
   }
   for (i = 0 ; i < readCount; i++) {
-#ifdef SHIFTBITS
-    Serial.write(logicdata[i] >> SHIFTBITS);
+#ifdef USE_PORTD
+    Serial.write(logicdata[i] >> 2);
 #else
     Serial.write(logicdata[i]);
 #endif
@@ -859,8 +892,8 @@ void triggerMicro() {
     if (logicIndex >= readCount) {
       logicIndex = 0;
     }
-#ifdef SHIFTBITS
-    Serial.write(logicdata[logicIndex++] >> SHIFTBITS);
+#ifdef USE_PORTD
+    Serial.write(logicdata[logicIndex++] >> 2);
 #else
     Serial.write(logicdata[logicIndex++]);
 #endif
@@ -906,8 +939,6 @@ void get_metadata() {
   Serial.write('A');
 #if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
   Serial.write('M');
-#elif defined(__AVR_ATmega32U4__)
-  Serial.write('L');
 #endif /* Mega */
   Serial.write('v');
   Serial.write('0');
@@ -918,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 */
@@ -929,10 +960,6 @@ void get_metadata() {
   /* 7168 bytes */
   Serial.write((uint8_t)0x1C);
   Serial.write((uint8_t)0x00);
-#elif defined(__AVR_ATmega32U4__)
-  /* 1024 bytes */
-  Serial.write((uint8_t)0x04);
-  Serial.write((uint8_t)0x00);
 #elif defined(__AVR_ATmega328P__)
   /* 1024 bytes */
   Serial.write((uint8_t)0x04);
@@ -952,15 +979,15 @@ void get_metadata() {
 
   /* number of probes (6 by default on Arduino, 8 on Mega) */
   Serial.write((uint8_t)0x40);
-#ifdef CHAN7
+#if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
   Serial.write((uint8_t)0x08);
-#elif CHAN6
-  Serial.write((uint8_t)0x07);
-#elif CHAN5
+#else
+#ifdef CHAN5
   Serial.write((uint8_t)0x06);
 #else
   Serial.write((uint8_t)0x05);
-#endif
+#endif /* CHAN5 */
+#endif /* Mega */
 
   /* protocol version (2) */
   Serial.write((uint8_t)0x41);
@@ -971,7 +998,7 @@ void get_metadata() {
 }
 
 /*
- * 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.
  *
  */
@@ -1012,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.
@@ -1023,8 +1052,8 @@ void debugdump() {
   Serial.print("\r\n");
 
   for (i = 0 ; i < MAX_CAPTURE_SIZE; i++) {
-#ifdef SHIFTBITS
-    Serial.print(logicdata[i] >> SHIFTBITS, HEX);
+#ifdef USE_PORTD
+    Serial.print(logicdata[i] >> 2, HEX);
 #else
     Serial.print(logicdata[i], HEX);
 #endif
@@ -1036,8 +1065,36 @@ 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,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

logic_analyzer/logic_analyzer_inline_4mhz.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

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
+#