Add empty LogicAnalyzer.h for arduino-lint.

Wrong delayTime in 500KHz menu

LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2011,2012,2013,2014,2015,2016,2017,2018,2019,2020,2021,2022,2023 Andrew Gillham
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY ANDREW GILLHAM ``AS IS'' AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL ANDREW GILLHAM BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Makefile

@@ -1,19 +1,24 @@
 #
-# Makefile for an Arduino based logic analyzer using the 'arduino-core'
+# Makefile for an Arduino based logic analyzer using the arduino-cli
-# package and makefiles.
 #
-#	$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

@@ -1,37 +0,0 @@
-SUMP compatible logic analyzer for Arduino
-==========================================
-
-This Arduino sketch implements a SUMP protocol compatible with the standard
-SUMP client as well as the alternative client from here:
-	http://www.lxtreme.nl/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)
-of PORTB. Arduino pin 13 / bit 5 is the Arduino LED, bits 6 & 7 are the
-crystal oscillator pins.
-Uncomment CHAN5 below if you want to use the LED pin as an input and have
-6 channels.
-
-NOTE:
-You must DISABLE the Arduino auto reset feature to use this logic analyzer
-code. There are various methods to do this, some boards have a jumper,
-others require you to cut a trace.  You may also install a *precisely*
-120 Ohm resistor between the reset & 5V piins.  Make sure it is really
-120 Ohm or you may damage your board.
-
-To use this with the original or alternative SUMP clients,
-use these settings:
-
-Sampling rate: 1MHz (or lower)
-Channel Groups: 0 (zero) only
-Recording Size: 1024 (or lower)
-Noise Filter: doesn't matter
-RLE: disabled (unchecked)
-
-Triggering is still a work in progress, but generally works for samples
-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.
-
-Release: v0.03 March 7, 2011.
-

README.md

@@ -0,0 +1,142 @@
+SUMP compatible logic analyzer for Arduino
+==========================================
+
+This Arduino sketch implements a SUMP protocol compatible logic analyzer.
+This implementation is compatible with the standard SUMP client as well as
+an alternative OLS client.  More recently support has been added to Sigrok.
+
+This logic analyzer for Arduino supports 6 channels consisting of digital
+pins 8-13, which are the first 6 bits (0-5) of PORTB.
+Arduino pin 13 / bit 5 is the Arduino LED, bits 6 & 7 are the crystal
+oscillator pins. Comment out CHAN5 if you don't want to use the
+LED pin for an input.
+
+On the Arduino Mega board 8 channels are supported and 7k of samples.
+Pins 22-29 (Port A) are used by default.
+
+Installation
+============
+
+You can use the GitHub 'Download ZIP' feature to get an installable "library"
+for use with the Arduino IDE.  Select 'Sketch -> Include Library -> Add .ZIP Libary'
+from the Arduino IDE 2.x and select the zip file you downloaded from GitHub, then select open.
+
+Once installed you can use the 'File -> Examples -> LogicAnalyzer' menu to find
+different versions of the sketches.  You might want to start with `logic_analyzer_sigrok`
+and use PulseView.
+
+Client Software
+===============
+
+Sigrok support via the 'ols' device configuration has been added. This
+mostly involved returning the capture buffer in the reverse order.
+
+Use the `logic_analyzer_sigrok` sketch.  Since the OLS alternative client
+mentioned below has some issues with newer Java versions, Sigrok is currently
+the only practical way to use this logic analyzer.  If you use an older machine
+with an older operating system and older Java you can probably use the OLS client.
+
+Sigrok support seems to work fairly well so I would currently recommend it for
+anyone interested in trying this sketch.
+
+Run PulseView like this on Linux: (I'll add Windows options after more testing)
+```
+PulseView --driver=ols:conn=/dev/ttyUSB0 --dont-scan
+```
+
+It may be necessary to exit and relaunch PulseView to get it to recognize the device.
+An easy way to test the device is using the `sigrok-cli` utility. The command below
+samples channel 2 at 1MHz.  If you get a device not found error, but /dev/ttyUSB0 exists,
+run this command a couple times and usually it will start working. Due to the way opening
+the serial port resets the Arduino there are some issues/bugs to work out yet.
+```
+sigrok-cli --driver=ols:conn=/dev/ttyUSB0 --config samplerate=1Mhz --config pattern=External --samples 1024 --channels 2
+```
+
+The OLS alternative client hasn't had an official release recently so you will
+need to compile it yourself.
+
+Follow the build instructions here: https://github.com/jawi/ols
+
+
+Older details on the OLS client is available at the project page:
+https://lxtreme.nl/projects/ols/
+
+Direct link to older releases of the OLS alternative client:
+http://www.lxtreme.nl/ols/
+
+The alternative client version is highly recommended.  You can tried the older
+release ols-0.9.7.2 but most likely need to build it yourself. Use "ols-0.9.7"
+or newer for built-in device profiles.
+
+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:
+   ATmega168:  532 (or lower)
+   ATmega328:  1024 (or lower)
+   ATmega2560: 7168 (or lower)
+Noise Filter: doesn't matter
+RLE: disabled (unchecked)
+```
+
+Using the Logic Analyzer
+========================
+Triggering is still a work in progress, but generally works for samples
+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.  Please provide a detailed bug report
+if you file an issue.
+
+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-cli` tool to compile this using the Makefile,
+you'll need to install the tool first following instructions here:
+https://arduino.github.io/arduino-cli/
+
+Once installed you can simple type `make` and you should get some simple help:
+```bash
+$ make
+---> run 'make build' to compile for Arduino Duemilanove
+---> run 'make upload' to upload to /dev/ttyUSB*
+```
+
+
+Other Notes
+===========================================================================
+```
+NOTE: Starting with v0.11 you can sample at 4MHz & 2MHz rates in addition to the 
+      previous 1MHz and lower rates.  This is done via unrolled loops which
+      makes the source code huge and the binary takes much more of the flash.
+      v0.11 is just slightly too big for an ATmega168's flash. The code 
+      automatically skips the 2MHz code on ATmega168
+
+NOTE: v0.09 switched the channels BACK to pins 8-13 for trigger reliability.
+      Please report any issues.  Uncomment USE_PORTD for pins 2-7.
+
+NOTE: If you are using the original SUMP client, then you will get a
+      "device not found" error.
+      You must DISABLE the Arduino auto reset feature to use this logic analyzer
+      code. There are various methods to do this, some boards have a jumper,
+      others require you to cut a trace.  You may also install a *precisely*
+      120 Ohm resistor between the reset & 5V piins.  Make sure it is really
+      120 Ohm or you may damage your board.  It is much easier to use the
+      alternative SUMP client referenced above.
+      [ This is not needed with ols-0.9.7 or newer. ]
+      [ DO NOT use this resistor unless absolutely necessary on old clients. ]
+```

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

examples/logic_analyzer_leonardo/logic_analyzer_leonardo.ino

@@ -2,7 +2,7 @@
  *
  * SUMP Protocol Implementation for Arduino boards.
  *
- * Copyright (c) 2011 Andrew Gillham
+ * Copyright (c) 2011,2012,2013,2014,2015,2016,2017,2018,2019,2020,2021,2022,2023 Andrew Gillham
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -25,40 +25,44 @@
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
- *	$Id: logic_analyzer.pde,v 1.14 2011-03-08 07:14:42 gillham Exp $
  *
  */
 
 /*
- * This SUMP protocol compatible logic analyzer for the Arduino board supports
+ * NOTE: v0.09 switched the channels BACK to pins 8-13 for trigger reliability.
- * 5 channels consisting of digital pins 8-12, which are the first 5 bits (0-4)
+ *       Please report any issues.  Uncomment USE_PORTD for pins 2-7.
- * of PORTB. Arduino pin 13 / bit 5 is the Arduino LED, bits 6 & 7 are the
- * crystal oscillator pins.
- * Uncomment CHAN5 below if you want to use the LED pin as an input and have
- * 6 channels.
  *
- * NOTE:
+ * This Arduino sketch implements a SUMP protocol compatible with the standard
- * You must DISABLE the Arduino auto reset feature to use this logic analyzer
+ * SUMP client as well as the alternative client from here:
- * code. There are various methods to do this, some boards have a jumper,
+ *	http://www.lxtreme.nl/ols/
- * others require you to cut a trace.  You may also install a *precisely*
+ *
- * 120 Ohm resistor between the reset & 5V piins.  Make sure it is really
+ * This SUMP protocol compatible logic analyzer for the Arduino board supports
- * 120 Ohm or you may damage your board.
+ * 6 channels consisting of digital pins 2-7, which are the last 6 bits (2-7)
+ * of PORTD.  Bits 0 & 1 are the UART RX/TX pins.
+ *
+ * On the Arduino Mega board 8 channels are supported and 7k of samples.
+ * Pins 22-29 (Port A) are used by default, you can change the 'CHANPIN' below
+ * if something else works better for you.
  *
  * To use this with the original or alternative SUMP clients,
  * use these settings:
  * 
- * Sampling rate: 1MHz (or lower)
+ * Sampling rate: 4MHz (or lower) (no 2MHz on ATmega168)
  * Channel Groups: 0 (zero) only
- * Recording Size: 1024 (or lower)
+ * Recording Size:
+ *    ATmega168:  532 (or lower)
+ *    ATmega328:  1024 (or lower)
+ *    ATmega2560: 7168 (or lower)
  * Noise Filter: doesn't matter
  * RLE: disabled (unchecked)
+ *    NOTE: Preliminary RLE support for 50Hz or less exists, please test it.
  *
  * Triggering is still a work in progress, but generally works for samples
  * 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.
  *
- * Release: v0.02 February 28, 2011.
+ * Release: v0.17 October 5, 2023.
  *
  */
 
@@ -78,16 +82,62 @@ void get_metadata(void);
 void debugprint(void);
 void debugdump(void);
 
+
 /*
- * Uncomment CHAN5 to use it as an additional input.
+ * Should we use PORTD or PORTB?  (default is PORTB)
- * You'll need to change the number of channels in the device profile as well.
+ * 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
+ * Arduino Mega device profile: ols.profile-aglam.cfg
+ */
+#if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
+#define CHANPIN PINA
+#define CHAN0 22
+#define CHAN1 23
+#define CHAN2 24
+#define CHAN3 25
+#define CHAN4 26
+#define CHAN5 27
+#define CHAN6 28
+#define CHAN7 29
+#else
+#if defined(USE_PORTD)
+#define CHANPIN PIND
+#define CHAN0 2
+#define CHAN1 3
+#define CHAN2 4
+#define CHAN3 5
+#define CHAN4 6
+#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
 #define CHAN3 11
 #define CHAN4 12
-//#define CHAN5 13
+/* 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 */
 #define ledPin 13
 
 /* XON/XOFF are not supported. */
@@ -102,24 +152,48 @@ void debugdump(void);
 #define SUMP_TRIGGER_VALUES 0xC1
 #define SUMP_TRIGGER_CONFIG 0xC2
 
-/* flags are ignored. */
+/* Most flags (except RLE) are ignored. */
 #define SUMP_SET_DIVIDER 0x80
 #define SUMP_SET_READ_DELAY_COUNT 0x81
 #define SUMP_SET_FLAGS 0x82
+#define SUMP_SET_RLE 0x0100
 
 /* extended commands -- self-test unsupported, but metadata is returned. */
 #define SUMP_SELF_TEST 0x03
 #define SUMP_GET_METADATA 0x04
 
-/*
+/* ATmega168:  532 (or lower)
- * Capture size of 1024 bytes works on the ATmega328.
+ * ATmega328:  1024 (or lower)
- *
+ * ATmega2560: 7168 (or lower)
  */
+#if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
+#define DEBUG_CAPTURE_SIZE 7168
+#define CAPTURE_SIZE 7168
+#elif defined(__AVR_ATmega32U4__)
+#define DEBUG_CAPTURE_SIZE 1536
+#define CAPTURE_SIZE 1536
+#elif defined(__AVR_ATmega328P__)
+#define DEBUG_CAPTURE_SIZE 1024
+#define CAPTURE_SIZE 1024
+#else
+#define DEBUG_CAPTURE_SIZE 532
+#define CAPTURE_SIZE 532
+#endif
+
+#ifdef USE_PORTD
+#define DEBUG_ENABLE DDRB = DDRB | B00000001
+#define DEBUG_ON PORTB = B00000001
+#define DEBUG_OFF PORTB = B00000000
+#else
+#define DEBUG_ENABLE DDRD = DDRD | B10000000
+#define DEBUG_ON PORTD = B10000000
+#define DEBUG_OFF PORTD = B00000000
+#endif
 #define DEBUG
 #ifdef DEBUG
-#define MAX_CAPTURE_SIZE 1024
+#define MAX_CAPTURE_SIZE DEBUG_CAPTURE_SIZE
 #else
-#define MAX_CAPTURE_SIZE 1024
+#define MAX_CAPTURE_SIZE CAPTURE_SIZE
 #endif /* DEBUG */
 
 /*
@@ -144,18 +218,23 @@ unsigned int trigger_values = 0;
 unsigned int useMicro = 0;
 unsigned int delayTime = 0;
 unsigned long divider = 0;
+boolean rleEnabled = 0;
 
 void setup()
 {
   Serial.begin(115200);
+  while (!Serial) {
+    ; // wait for serial port to connect. Needed for Leonardo only
+  }
+
 
   /*
-   * set debug pin to output right away so it settles.
+   * set debug pin (digital pin 8) to output right away so it settles.
    * this gets toggled during sampling as a way to measure
    * the sample time.  this is used during development to
    * properly pad out the sampling routines.
    */
-  DDRD = DDRD | B10000000; /* debug measurement pin */
+  DEBUG_ENABLE; /* debug measurement pin */
 
   pinMode(CHAN0, INPUT);
   pinMode(CHAN1, INPUT);
@@ -164,9 +243,41 @@ void setup()
   pinMode(CHAN4, INPUT);
 #ifdef CHAN5
   pinMode(CHAN5, INPUT);
-#else
+#endif
+#ifdef CHAN6
+  pinMode(CHAN6, INPUT);
+#endif
+#ifdef CHAN7
+  pinMode(CHAN7, INPUT);
+#endif
+#ifndef CHAN5
   pinMode(ledPin, OUTPUT);
-#endif /* CHAN5 */
+#endif
+
+#if 0
+
+  /*
+   * This sets up timer2 at 100KHz to toggle a pin.  This is useful
+   * for debugging as it gives an internally precise signal source.
+   * This doesn't work on the Arduino Mega.  Use on the Uno or older.
+   * We're using the same clock source for the timer & our sampling.
+   */
+
+  /* Set OC2A (digital pin 11) to output so we can toggle it. */
+  pinMode(11, OUTPUT);
+
+  /* reset timer to zero */
+  TCNT2 = 0;
+  TCCR2A = 0;
+  TCCR2B = 0;
+  OCR2A = 0;
+
+  /* Set CTC mode and toggle on compare. */
+  TCCR2A = _BV (COM2A0) | _BV (WGM21);
+  /* 79 = 100KHz, 15 = 500KHz, 7 = 1MHz */
+  OCR2A = 79;
+  TCCR2B = _BV (CS20);
+#endif
 }
 
 void loop()
@@ -185,10 +296,10 @@ void loop()
       break;
     case SUMP_QUERY:
       /* return the expected bytes. */
-      Serial.print('1', BYTE);
+      Serial.write('1');
-      Serial.print('A', BYTE);
+      Serial.write('A');
-      Serial.print('L', BYTE);
+      Serial.write('L');
-      Serial.print('S', BYTE);
+      Serial.write('S');
       break;
     case SUMP_ARM:
       /*
@@ -204,7 +315,18 @@ void loop()
        * so in that case (delayTime == 1 and triggers enabled) use
        * captureMicro() instead of triggerMicro().
        */
-      if (useMicro) {
+
+      if (divider == 24) {
+        /* 4.0MHz */
+        captureInline4mhz();
+      } 
+      else if (divider == 49) {
+        /* 2.0MHz */
+#if defined(__AVR_ATmega168P__)
+        captureInline2mhz();
+#endif
+      } 
+      else if (useMicro) {
         if (trigger && (delayTime != 1)) {
           triggerMicro();
         } 
@@ -222,7 +344,11 @@ void loop()
        * we can just use it directly as our trigger mask.
        */
       getCmd();
+#ifdef SHIFTBITS
+      trigger = cmdBytes[0] << SHIFTBITS;
+#else
       trigger = cmdBytes[0];
+#endif
       break;
     case SUMP_TRIGGER_VALUES:
       /*
@@ -230,7 +356,11 @@ void loop()
        * defines whether we're looking for it to be high or low.
        */
       getCmd();
+#ifdef SHIFTBITS
+      trigger_values = cmdBytes[0] << SHIFTBITS;
+#else
       trigger_values = cmdBytes[0];
+#endif
       break;
     case SUMP_TRIGGER_CONFIG:
       /* read the rest of the command bytes, but ignore them. */
@@ -269,8 +399,9 @@ void loop()
         delayCount = MAX_CAPTURE_SIZE;
       break;
     case SUMP_SET_FLAGS:
-      /* read the rest of the command bytes, but ignore them. */
+      /* read the rest of the command bytes and check if RLE is enabled. */
       getCmd();
+      rleEnabled = ((cmdBytes[1] & B1000000) != 0);
       break;
     case SUMP_GET_METADATA:
       /*
@@ -303,9 +434,7 @@ void loop()
        * you can use the Arduino serial monitor and send a '1' and get
        * a debug printout.  useless except for development.
        */
-#ifndef CHAN5
       blinkled();
-#endif /* !CHAN5 */
       debugprint();
       break;
     case '2':
@@ -322,14 +451,12 @@ void loop()
   }
 }
 
-#ifndef CHAN5
 void blinkled() {
   digitalWrite(ledPin, HIGH);
   delay(200);
   digitalWrite(ledPin, LOW);
   delay(200);
 }
-#endif /* !CHAN5 */
 
 /*
  * Extended SUMP commands are 5 bytes.  A command byte followed by 4 bytes
@@ -373,14 +500,14 @@ void getCmd() {
  */
 
 void captureMicro() {
-  int i;
+  unsigned int i;
 
   /*
-   * basic trigger, wait until all trigger conditions are met on port B.
+   * basic trigger, wait until all trigger conditions are met on port.
    * this needs further testing, but basic tests work as expected.
    */
   if (trigger) {
-    while ((trigger_values ^ PINB) & trigger);
+    while ((trigger_values ^ CHANPIN) & trigger);
   }
 
   /*
@@ -395,39 +522,41 @@ void captureMicro() {
    * this is used during development to measure the sample intervals.
    * it is best to just leave the toggling in place so we don't alter
    * any timing unexpectedly.
-   * Arduino pin 7 is being used here.
+   * Arduino digital pin 8 is being used here.
    */
-  DDRD = DDRD | B10000000;
+  DEBUG_ENABLE;
-  PORTD = B10000000;
+#ifdef DEBUG
+  DEBUG_ON;
   delayMicroseconds(20);
-  PORTD = B00000000;
+  DEBUG_OFF;
   delayMicroseconds(20);
-  PORTD = B10000000;
+  DEBUG_ON;
   delayMicroseconds(20);
-  PORTD = B00000000;
+  DEBUG_OFF;
   delayMicroseconds(20);
+#endif
 
   if (delayTime == 1) {
     /*
      * 1MHz sample rate = 1 uS delay so we can't use delayMicroseconds
      * since our loop takes some time.  The delay is padded out by hand.
      */
-    PORTD = B10000000; /* debug timing measurement */
+    DEBUG_ON; /* debug timing measurement */
     for (i = 0 ; i < readCount; i++) {
-      logicdata[i] = PINB;
+      logicdata[i] = CHANPIN;
       __asm__("nop\n\t""nop\n\t""nop\n\t""nop\n\t""nop\n\t");
       __asm__("nop\n\t""nop\n\t""nop\n\t""nop\n\t");
     }
-    PORTD = B00000000; /* debug timing measurement */
+    DEBUG_OFF; /* debug timing measurement */
   } 
   else if (delayTime == 2) {
     /*
      * 500KHz sample rate = 2 uS delay, still pretty fast so we pad this
      * one by hand too.
      */
-    PORTD = B10000000; /* debug timing measurement */
+    DEBUG_ON; /* debug timing measurement */
     for (i = 0 ; i < readCount; i++) {
-      logicdata[i] = PINB;
+      logicdata[i] = CHANPIN;
       __asm__("nop\n\t""nop\n\t""nop\n\t""nop\n\t");
       __asm__("nop\n\t""nop\n\t""nop\n\t""nop\n\t");
       __asm__("nop\n\t""nop\n\t""nop\n\t""nop\n\t");
@@ -435,7 +564,7 @@ void captureMicro() {
       __asm__("nop\n\t""nop\n\t""nop\n\t""nop\n\t");
       __asm__("nop\n\t""nop\n\t""nop\n\t""nop\n\t");
     }
-    PORTD = B00000000; /* debug timing measurement */
+    DEBUG_OFF; /* debug timing measurement */
   } 
   else {
     /*
@@ -444,13 +573,13 @@ void captureMicro() {
      * a better logic analyzer)
      * start of real measurement
      */
-    PORTD = B10000000; /* debug timing measurement */
+    DEBUG_ON; /* debug timing measurement */
     for (i = 0 ; i < readCount; i++) {
-      logicdata[i] = PINB;
+      logicdata[i] = CHANPIN;
       delayMicroseconds(delayTime - 1);
       __asm__("nop\n\t""nop\n\t");
     }
-    PORTD = B00000000; /* debug timing measurement */
+    DEBUG_OFF; /* debug timing measurement */
   }
 
   /* re-enable interrupts now that we're done sampling. */
@@ -461,7 +590,11 @@ void captureMicro() {
    * is done for any triggers, this is effectively the 0/100 buffer split.
    */
   for (i = 0 ; i < readCount; i++) {
-    Serial.print(logicdata[i], BYTE);
+#ifdef SHIFTBITS
+    Serial.write(logicdata[i] >> SHIFTBITS);
+#else
+    Serial.write(logicdata[i]);
+#endif
   }
 }
 
@@ -483,21 +616,60 @@ void captureMicro() {
  * this basic functionality.
  */
 void captureMilli() {
-  int i;
+  unsigned int i = 0;
 
-  /*
+  if(rleEnabled) {
-   * very basic trigger, just like in captureMicros() above.
+    /*
-   */
+     * very basic trigger, just like in captureMicros() above.
-  if (trigger) {
+     */
-    while ((trigger_values ^ PINB) & trigger);
+    if (trigger) {
-  }
+      while ((trigger_values ^ (CHANPIN & B01111111)) & trigger);
+    }
 
-  for (i = 0 ; i < readCount; i++) {
+    byte lastSample = 0;
-    logicdata[i] = PINB;
+    byte sampleCount = 0;
-    delay(delayTime);
+
+    while(i < readCount) {
+      /*
+       * Implementation of the RLE unlimited protocol: timings might be off a little
+       */
+      if(lastSample == (CHANPIN & B01111111) && sampleCount < 127) {
+        sampleCount++;
+        delay(delayTime);
+        continue;
+      }
+      if(sampleCount != 0) {
+        logicdata[i] = B10000000 | sampleCount;
+        sampleCount = 0;
+        i++;
+        continue;
+      }
+      logicdata[i] = (CHANPIN & B01111111);
+      lastSample = (CHANPIN & B01111111);
+      delay(delayTime);
+
+      i++;
+    }
+  } 
+  else {
+    /*
+     * very basic trigger, just like in captureMicros() above.
+     */
+    if (trigger) {
+      while ((trigger_values ^ CHANPIN) & trigger);
+    }
+
+    for (i = 0 ; i < readCount; i++) {
+      logicdata[i] = CHANPIN;
+      delay(delayTime);
+    }
   }
   for (i = 0 ; i < readCount; i++) {
-    Serial.print(logicdata[i], BYTE);
+#ifdef SHIFTBITS
+    Serial.write(logicdata[i] >> SHIFTBITS);
+#else
+    Serial.write(logicdata[i]);
+#endif
   }
 }
 
@@ -510,7 +682,7 @@ void captureMilli() {
  * 
  */
 void triggerMicro() {
-  int i = 0;
+  unsigned int i = 0;
 
   logicIndex = 0;
   triggerIndex = 0;
@@ -527,17 +699,19 @@ void triggerMicro() {
    * this is used during development to measure the sample intervals.
    * it is best to just leave the toggling in place so we don't alter
    * any timing unexpectedly.
-   * Arduino pin 7 is being used here.
+   * Arduino digital pin 8 is being used here.
    */
-  DDRD = DDRD | B10000000;
+  DEBUG_ENABLE;
-  PORTD = B10000000;
+#ifdef DEBUG
+  DEBUG_ON;
   delayMicroseconds(20);
-  PORTD = B00000000;
+  DEBUG_OFF;
   delayMicroseconds(20);
-  PORTD = B10000000;
+  DEBUG_ON;
   delayMicroseconds(20);
-  PORTD = B00000000;
+  DEBUG_OFF;
   delayMicroseconds(20);
+#endif
 
   if (delayTime == 1) {
     /*
@@ -557,13 +731,13 @@ void triggerMicro() {
     /*
      * 500KHz case.  We should be able to manage this in time.
      *
-     * busy loop reading PINB until we trigger.
+     * busy loop reading CHANPIN until we trigger.
      * we always start capturing at the start of the buffer
      * and use it as a circular buffer
      */
-    PORTD = B10000000; /* debug timing measurement */
+    DEBUG_ON; /* debug timing measurement */
-    while ((trigger_values ^ (logicdata[logicIndex] = PINB)) & trigger) {
+    while ((trigger_values ^ (logicdata[logicIndex] = CHANPIN)) & trigger) {
-      /* PORTD = B00000000; */
+      /* DEBUG_OFF; */
       /* increment index. */
       logicIndex++;
       if (logicIndex >= readCount) {
@@ -575,11 +749,11 @@ void triggerMicro() {
        * __asm__("nop\n\t""nop\n\t""nop\n\t");
        */
       __asm__("nop\n\t");
-      /* PORTD = B10000000; */
+      /* DEBUG_ON; */
     }
     /* this pads the immediate trigger case to 2.0 uS, just as an example. */
     __asm__("nop\n\t""nop\n\t""nop\n\t""nop\n\t");
-    PORTD = B00000000; /* debug timing measurement */
+    DEBUG_OFF; /* debug timing measurement */
 
     /* 
      * One sample size delay. ends up being 2 uS combined with assignment
@@ -594,7 +768,7 @@ void triggerMicro() {
     triggerIndex = logicIndex;
 
     /* keep sampling for delayCount after trigger */
-    PORTD = B10000000; /* debug timing measurement */
+    DEBUG_ON; /* debug timing measurement */
     /*
      * this is currently taking:
      * 1025.5 uS for 512 samples. (512 samples, 0/100 split)
@@ -604,12 +778,12 @@ void triggerMicro() {
       if (logicIndex >= readCount) {
         logicIndex = 0;
       }
-      logicdata[logicIndex++] = PINB;
+      logicdata[logicIndex++] = CHANPIN;
       __asm__("nop\n\t""nop\n\t""nop\n\t""nop\n\t""nop\n\t");
       __asm__("nop\n\t""nop\n\t""nop\n\t""nop\n\t""nop\n\t");
       __asm__("nop\n\t""nop\n\t""nop\n\t""nop\n\t");
     }
-    PORTD = B00000000; /* debug timing measurement */
+    DEBUG_OFF; /* debug timing measurement */
     delayMicroseconds(100);
   } 
   else {
@@ -617,22 +791,28 @@ void triggerMicro() {
      * Less than 500KHz case.  This uses delayMicroseconds() and some padding
      * to get precise timing, at least for the after trigger samples.
      *
-     * busy loop reading PINB until we trigger.
+     * busy loop reading CHANPIN until we trigger.
      * we always start capturing at the start of the buffer
      * and use it as a circular buffer
      *
      */
-    PORTD = B10000000; /* debug timing measurement */
+    DEBUG_ON; /* debug timing measurement */
-    while ((trigger_values ^ (logicdata[logicIndex] = PINB)) & trigger) {
+    while ((trigger_values ^ (logicdata[logicIndex] = CHANPIN)) & trigger) {
-      /* PORTD = B00000000; */
+      /* DEBUG_OFF; */
       /* increment index. */
       logicIndex++;
       if (logicIndex >= readCount) {
         logicIndex = 0;
       }
-      /* PORTD = B10000000; */
+      else {
+        /* pad the same number of cycles as the above assignment (needs verification) */
+        __asm__("nop\n\t""nop\n\t""nop\n\t""nop\n\t");
+      }
+      delayMicroseconds(delayTime - 3);
+      __asm__("nop\n\t""nop\n\t""nop\n\t""nop\n\t""nop\n\t");
+      /* DEBUG_ON; */
     }
-    PORTD = B00000000; /* debug timing measurement */
+    DEBUG_OFF; /* debug timing measurement */
 
     /* 'logicIndex' now points to trigger sample, keep track of it */
     triggerIndex = logicIndex;
@@ -641,21 +821,24 @@ void triggerMicro() {
      * This needs adjustment so that we have the right spacing between the
      * before trigger samples and the after trigger samples.
      */
-    delayMicroseconds(delayTime);
+    delayMicroseconds(delayTime - 2);
+    __asm__("nop\n\t""nop\n\t""nop\n\t""nop\n\t");
+    __asm__("nop\n\t""nop\n\t""nop\n\t""nop\n\t");
+    __asm__("nop\n\t""nop\n\t""nop\n\t");
 
     /* keep sampling for delayCount after trigger */
-    PORTD = B10000000; /* debug timing measurement */
+    DEBUG_ON; /* debug timing measurement */
     for (i = 0 ; i < delayCount; i++) {
       if (logicIndex >= readCount) {
         logicIndex = 0;
       }
-      logicdata[logicIndex++] = PINB;
+      logicdata[logicIndex++] = CHANPIN;
       delayMicroseconds(delayTime - 3);
       __asm__("nop\n\t""nop\n\t""nop\n\t""nop\n\t");
       __asm__("nop\n\t""nop\n\t""nop\n\t""nop\n\t");
       __asm__("nop\n\t""nop\n\t""nop\n\t");
     }
-    PORTD = B00000000; /* debug timing measurement */
+    DEBUG_OFF; /* debug timing measurement */
     delayMicroseconds(100);
   }
 
@@ -676,7 +859,11 @@ void triggerMicro() {
     if (logicIndex >= readCount) {
       logicIndex = 0;
     }
-    Serial.print(logicdata[logicIndex++], BYTE);
+#ifdef SHIFTBITS
+    Serial.write(logicdata[logicIndex++] >> SHIFTBITS);
+#else
+    Serial.write(logicdata[logicIndex++]);
+#endif
   }
 }
 
@@ -712,43 +899,75 @@ void setupDelay() {
  */
 void get_metadata() {
   /* device name */
-  Serial.print(0x01, BYTE);
+  Serial.write((uint8_t)0x01);
-  Serial.print('A', BYTE);
+  Serial.write('A');
-  Serial.print('G', BYTE);
+  Serial.write('G');
-  Serial.print('L', BYTE);
+  Serial.write('L');
-  Serial.print('A', BYTE);
+  Serial.write('A');
-  Serial.print('v', BYTE);
+#if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
-  Serial.print('0', BYTE);
+  Serial.write('M');
-  Serial.print(0x00, BYTE);
+#elif defined(__AVR_ATmega32U4__)
+  Serial.write('L');
+#endif /* Mega */
+  Serial.write('v');
+  Serial.write('0');
+  Serial.write((uint8_t)0x00);
 
-  /* sample memory (1024) */
+  /* firmware version */
-  Serial.print(0x21, BYTE);
+  Serial.write((uint8_t)0x02);
-  Serial.print(0x00, BYTE);
+  Serial.write('0');
-  Serial.print(0x00, BYTE);
+  Serial.write('.');
-  Serial.print(0x04, BYTE);
+  Serial.write('1');
-  Serial.print(0x00, BYTE);
+  Serial.write('7');
+  Serial.write((uint8_t)0x00);
 
-  /* sample rate (1MHz) */
+  /* sample memory */
-  Serial.print(0x23, BYTE);
+  Serial.write((uint8_t)0x21);
-  Serial.print(0x00, BYTE);
+  Serial.write((uint8_t)0x00);
-  Serial.print(0x0F, BYTE);
+  Serial.write((uint8_t)0x00);
-  Serial.print(0x42, BYTE);
+#if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
-  Serial.print(0x40, BYTE);
+  /* 7168 bytes */
-
+  Serial.write((uint8_t)0x1C);
-  /* number of probes (5 by default) */
+  Serial.write((uint8_t)0x00);
-  Serial.print(0x40, BYTE);
+#elif defined(__AVR_ATmega32U4__)
-#ifdef CHAN5
+  /* 1024 bytes */
-  Serial.print(0x06, BYTE);
+  Serial.write((uint8_t)0x04);
+  Serial.write((uint8_t)0x00);
+#elif defined(__AVR_ATmega328P__)
+  /* 1024 bytes */
+  Serial.write((uint8_t)0x04);
+  Serial.write((uint8_t)0x00);
 #else
-  Serial.print(0x05, BYTE);
+  /* 532 bytes */
-#endif /* CHAN5 */
+  Serial.write((uint8_t)0x02);
+  Serial.write((uint8_t)0x14);
+#endif /* Mega */
+
+  /* sample rate (4MHz) */
+  Serial.write((uint8_t)0x23);
+  Serial.write((uint8_t)0x00);
+  Serial.write((uint8_t)0x3D);
+  Serial.write((uint8_t)0x09);
+  Serial.write((uint8_t)0x00);
+
+  /* number of probes (6 by default on Arduino, 8 on Mega) */
+  Serial.write((uint8_t)0x40);
+#ifdef CHAN7
+  Serial.write((uint8_t)0x08);
+#elif CHAN6
+  Serial.write((uint8_t)0x07);
+#elif CHAN5
+  Serial.write((uint8_t)0x06);
+#else
+  Serial.write((uint8_t)0x05);
+#endif
 
   /* protocol version (2) */
-  Serial.print(0x41, BYTE);
+  Serial.write((uint8_t)0x41);
-  Serial.print(0x02, BYTE);
+  Serial.write((uint8_t)0x02);
 
   /* end of data */
-  Serial.print(0x00, BYTE);  
+  Serial.write((uint8_t)0x00);  
 }
 
 /*
@@ -776,6 +995,8 @@ void debugprint() {
   Serial.println(logicIndex, DEC);
   Serial.print("triggerIndex = ");
   Serial.println(triggerIndex, DEC);
+  Serial.print("rleEnabled = ");
+  Serial.println(rleEnabled, DEC);
 
   Serial.println("Bytes:");
 
@@ -785,7 +1006,7 @@ void debugprint() {
     } 
     else {
       Serial.print(savebytes[i], HEX);
-      Serial.print(' ', BYTE);
+      Serial.write(' ');
     }
   }
   Serial.println("done...");
@@ -802,7 +1023,11 @@ void debugdump() {
   Serial.print("\r\n");
 
   for (i = 0 ; i < MAX_CAPTURE_SIZE; i++) {
+#ifdef SHIFTBITS
+    Serial.print(logicdata[i] >> SHIFTBITS, HEX);
+#else
     Serial.print(logicdata[i], HEX);
+#endif
     Serial.print(" ");
     if (j == 32) {
       Serial.print("\r\n");
@@ -814,3 +1039,14 @@ void debugdump() {
 #endif /* DEBUG */
 
 
+
+
+
+
+
+
+
+
+
+
+

extras/ols.profile-agla.cfg

@@ -7,11 +7,11 @@ device.description = Arduino Generic Logic Analyzer
 # The device interface, SERIAL only
 device.interface = SERIAL
 # The device's native clockspeed, in Hertz.
-device.clockspeed = 100000000
+device.clockspeed = 16000000
 # Whether or not double-data-rate is supported by the device (also known as the "demux"-mode).
 device.supports_ddr = false
 # Supported sample rates in Hertz, separated by comma's
-device.samplerates = 10, 20, 50, 100, 200, 500, 1000, 2000, 5000, 10000, 20000, 50000, 100000, 200000, 500000, 1000000
+device.samplerates = 10, 20, 50, 100, 200, 500, 1000, 2000, 5000, 10000, 20000, 50000, 100000, 200000, 500000, 1000000, 2000000, 4000000
 # What capture clocks are supported
 device.captureclock = INTERNAL
 # The supported capture sizes, in bytes
@@ -19,7 +19,7 @@ device.capturesizes = 64, 128, 256, 512, 1024
 # Whether or not the noise filter is supported
 device.feature.noisefilter = false
 # Whether or not Run-Length encoding is supported
-device.feature.rle = false
+device.feature.rle = true
 # Whether or not a testing mode is supported
 device.feature.testmode = false
 # Whether or not triggers are supported
@@ -30,7 +30,7 @@ device.trigger.stages = 1
 device.trigger.complex = false
 
 # The total number of channels usable for capturing
-device.channel.count = 5
+device.channel.count = 6
 # The number of channels groups, together with the channel count determines the channels per group
 device.channel.groups = 1
 # Whether the capture size is limited by the enabled channel groups
@@ -39,13 +39,15 @@ device.capturesize.bound = false
 device.channel.numberingschemes = DEFAULT
 
 # Is a delay after opening the port and device detection needed? (0 = no delay, >0 = delay in milliseconds)
-device.open.portdelay = 500
+device.open.portdelay = 2000
+# The receive timeout for the device (in milliseconds, 100 = default, <=0 = no timeout)
+device.receive.timeout = 100
 # Does the device need a high or low DTR-line to operate correctly? (high = true, low = false)
 device.open.portdtr = true
 # Which metadata keys correspond to this device profile? Value is a comma-separated list of (double quoted) names...
 device.metadata.keys = "AGLAv0"
 
-# In which order are samples sent back from the device? true = last sample first, false = first sample first
+# In which order are samples sent back from the device? false = last sample first, true = first sample first
-device.samples.reverseOrder = false
+device.samples.reverseOrder = true
 
 ###EOF###

extras/ols.profile-aglam.cfg

@@ -0,0 +1,53 @@
+# Configuration for Arduino Mega Logic Analyzer profile
+
+# The short (single word) type of the device described in this profile
+device.type = AGLAM
+# A longer description of the device
+device.description = Arduino Mega Logic Analyzer
+# The device interface, SERIAL only
+device.interface = SERIAL
+# The device's native clockspeed, in Hertz.
+device.clockspeed = 16000000
+# Whether or not double-data-rate is supported by the device (also known as the "demux"-mode).
+device.supports_ddr = false
+# Supported sample rates in Hertz, separated by comma's
+device.samplerates = 10, 20, 50, 100, 200, 500, 1000, 2000, 5000, 10000, 20000, 50000, 100000, 200000, 500000, 1000000, 2000000, 4000000
+# What capture clocks are supported
+device.captureclock = INTERNAL
+# The supported capture sizes, in bytes
+device.capturesizes = 64, 128, 256, 512, 1024, 2048, 4096, 7168
+# Whether or not the noise filter is supported
+device.feature.noisefilter = false
+# Whether or not Run-Length encoding is supported
+device.feature.rle = false
+# Whether or not a testing mode is supported
+device.feature.testmode = false
+# Whether or not triggers are supported
+device.feature.triggers = true
+# The number of trigger stages
+device.trigger.stages = 1
+# Whether or not "complex" triggers are supported
+device.trigger.complex = false
+
+# The total number of channels usable for capturing
+device.channel.count = 8
+# The number of channels groups, together with the channel count determines the channels per group
+device.channel.groups = 1
+# Whether the capture size is limited by the enabled channel groups
+device.capturesize.bound = false
+# Which numbering does the device support
+device.channel.numberingschemes = DEFAULT
+
+# Is a delay after opening the port and device detection needed? (0 = no delay, >0 = delay in milliseconds)
+device.open.portdelay = 2000
+# The receive timeout for the device (in milliseconds, 100 = default, <=0 = no timeout)
+device.receive.timeout = 100
+# Does the device need a high or low DTR-line to operate correctly? (high = true, low = false)
+device.open.portdtr = true
+# Which metadata keys correspond to this device profile? Value is a comma-separated list of (double quoted) names...
+device.metadata.keys = "AGLAMv0"
+
+# In which order are samples sent back from the device? false = last sample first, true = first sample first
+device.samples.reverseOrder = true
+
+###EOF###

library.properties

@@ -0,0 +1,9 @@
+name=LogicAnalyzer
+version=0.17.0
+author=Andrew Gillham <gillham@roadsign.com>
+maintainer=Andrew Gillham <gillham@roadsign.com>
+sentence=A SUMP protocol compatible logic analyzer firmware
+paragraph=These firmware sketches provide a 6 channel logic analyzer for use with the SUMP protocol based OLS clients. There is also a Sigrok compatible firmware using the OpenBench Logic Sniffer (ols) driver .
+category=Signal Input/Output
+url=https://github.com/gillham/logic_analyzer
+architectures=avr

src/use_examples_for_logic_analyzer.h

@@ -0,0 +1,2 @@
+// This is a placeholder. Use File->Examples->LogicAnalyzer menu
+// for the logic analyzer sketches.