Update to v0.08 and add note about channels changes.

Switch from PORTB to PORTD so that a full 6 channels can be used
without messing with the LED.  Per suggestion in issue #7.  I was
unable to find any issues with using PORTB.  During initial development
I ran into some noise & stability issues but I believe those were
solved later via allowing the ports to settle prior to beginning
sampling.
This allows for 6 channels, starting with digital pin 2 (next to the
UART TX pin) and ending at digital pin 7.
The debug pin is now digital pin 8.

README

@@ -1,6 +1,9 @@
 SUMP compatible logic analyzer for Arduino
 ==========================================
 
+NOTE: v0.08 switches the channels to pins 2-7 NOT 8-13 any longer.
+      Please report any issues.  For old behavior use v0.07.
+
 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/
@@ -51,5 +54,5 @@ Please try it out and report back.
 This master branch now supports Arduino 1.0 only.
 Checkout branch logic_analyzer_v0_5 for Arduino 22 support.
 
-Release: v0.06 November 4, 2011.
+Release: v0.08 February 8, 2013.
 

logic_analyzer.ino

@@ -2,7 +2,7 @@
  *
  * SUMP Protocol Implementation for Arduino boards.
  *
- * Copyright (c) 2011 Andrew Gillham
+ * Copyright (c) 2011,2012,2013 Andrew Gillham
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -25,21 +25,21 @@
  * (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.17 2011-08-04 02:31:01 gillham Exp $
+ *	$Id: logic_analyzer.ino,v 1.21 2012/02/27 20:19:44 gillham Exp $
  *
  */
 
 /*
+ * NOTE: v0.08 switches the channels to pins 2-7 NOT 8-13 any longer.
+ *       Please report any issues.  For old behavior use v0.07.
+ *
  * 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.
+ * 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
@@ -72,13 +72,14 @@
  *    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.06 November 4, 2011.
+ * Release: v0.08 February 8, 2013.
  *
  */
 
@@ -99,9 +100,6 @@ void debugprint(void);
 void debugdump(void);
 
 /*
- * Uncomment CHAN5 to use it as an additional input on a normal Arduino.
- * You'll need to change the number of channels in the device profile as well.
- *
  * Arduino device profile:      ols.profile-agla.cfg
  * Arduino Mega device profile: ols.profile-aglam.cfg
  */
@@ -116,13 +114,13 @@ void debugdump(void);
 #define CHAN6 28
 #define CHAN7 29
 #else
-#define CHANPIN PINB
-#define CHAN0 8
-#define CHAN1 9
-#define CHAN2 10
-#define CHAN3 11
-#define CHAN4 12
-//#define CHAN5 13
+#define CHANPIN PIND
+#define CHAN0 2
+#define CHAN1 3
+#define CHAN2 4
+#define CHAN3 5
+#define CHAN4 6
+#define CHAN5 7
 #endif
 #define ledPin 13
 
@@ -138,10 +136,11 @@ 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
@@ -152,16 +151,19 @@ void debugdump(void);
  * ATmega2560: 7168 (or lower)
  */
 #if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
-  #define DEBUG_CAPTURE_SIZE 7168
-  #define CAPTURE_SIZE 7168
+#define DEBUG_CAPTURE_SIZE 7168
+#define CAPTURE_SIZE 7168
 #elif defined(__AVR_ATmega328P__)
-  #define DEBUG_CAPTURE_SIZE 1024
-  #define CAPTURE_SIZE 1024
+#define DEBUG_CAPTURE_SIZE 1024
+#define CAPTURE_SIZE 1024
 #else
-  #define DEBUG_CAPTURE_SIZE 532
-  #define CAPTURE_SIZE 532
+#define DEBUG_CAPTURE_SIZE 532
+#define CAPTURE_SIZE 532
 #endif
 
+#define DEBUG_ENABLE DDRB = DDRB | B00000001
+#define DEBUG_ON PORTB = B00000001
+#define DEBUG_OFF PORTB = B00000000
 #define DEBUG
 #ifdef DEBUG
 #define MAX_CAPTURE_SIZE DEBUG_CAPTURE_SIZE
@@ -191,36 +193,31 @@ 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);
 
   /*
-   * 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);
   pinMode(CHAN2, INPUT);
   pinMode(CHAN3, INPUT);
   pinMode(CHAN4, INPUT);
-#if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
   pinMode(CHAN5, INPUT);
+#if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
   pinMode(CHAN6, INPUT);
   pinMode(CHAN7, INPUT);
-  pinMode(ledPin, OUTPUT);
-#else
-#ifdef CHAN5
-  pinMode(CHAN5, INPUT);
-#else
-  pinMode(ledPin, OUTPUT);
-#endif /* CHAN5 */
 #endif /* Mega */
+  pinMode(ledPin, OUTPUT);
 }
 
 void loop()
@@ -323,8 +320,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:
       /*
@@ -357,9 +355,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':
@@ -428,7 +424,7 @@ void captureMicro() {
   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) {
@@ -447,16 +443,16 @@ 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;
-  PORTD = B10000000;
+  DEBUG_ENABLE;
+  DEBUG_ON;
   delayMicroseconds(20);
-  PORTD = B00000000;
+  DEBUG_OFF;
   delayMicroseconds(20);
-  PORTD = B10000000;
+  DEBUG_ON;
   delayMicroseconds(20);
-  PORTD = B00000000;
+  DEBUG_OFF;
   delayMicroseconds(20);
 
   if (delayTime == 1) {
@@ -464,20 +460,20 @@ void captureMicro() {
      * 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] = 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] = CHANPIN;
       __asm__("nop\n\t""nop\n\t""nop\n\t""nop\n\t");
@@ -487,7 +483,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 {
     /*
@@ -496,13 +492,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] = 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. */
@@ -513,7 +509,7 @@ void captureMicro() {
    * is done for any triggers, this is effectively the 0/100 buffer split.
    */
   for (i = 0 ; i < readCount; i++) {
-    Serial.write(logicdata[i]);
+    Serial.write(logicdata[i] >> 2);
   }
 }
 
@@ -535,21 +531,56 @@ void captureMicro() {
  * this basic functionality.
  */
 void captureMilli() {
-  int i;
+  int i = 0;
 
-  /*
-   * very basic trigger, just like in captureMicros() above.
-   */
-  if (trigger) {
-    while ((trigger_values ^ CHANPIN) & trigger);
-  }
+  if(rleEnabled) {
+    /*
+     * very basic trigger, just like in captureMicros() above.
+     */
+    if (trigger) {
+      while ((trigger_values ^ (CHANPIN & B01111111)) & trigger);
+    }
 
-  for (i = 0 ; i < readCount; i++) {
-    logicdata[i] = CHANPIN;
-    delay(delayTime);
+    byte lastSample = 0;
+    byte sampleCount = 0;
+
+    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.write(logicdata[i]);
+    Serial.write(logicdata[i] >> 2);
   }
 }
 
@@ -579,16 +610,16 @@ 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;
-  PORTD = B10000000;
+  DEBUG_ENABLE;
+  DEBUG_ON;
   delayMicroseconds(20);
-  PORTD = B00000000;
+  DEBUG_OFF;
   delayMicroseconds(20);
-  PORTD = B10000000;
+  DEBUG_ON;
   delayMicroseconds(20);
-  PORTD = B00000000;
+  DEBUG_OFF;
   delayMicroseconds(20);
 
   if (delayTime == 1) {
@@ -613,9 +644,9 @@ void triggerMicro() {
      * 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] = CHANPIN)) & trigger) {
-      /* PORTD = B00000000; */
+      /* DEBUG_OFF; */
       /* increment index. */
       logicIndex++;
       if (logicIndex >= readCount) {
@@ -627,11 +658,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
@@ -646,7 +677,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)
@@ -661,7 +692,7 @@ void triggerMicro() {
       __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 {
@@ -674,17 +705,23 @@ void triggerMicro() {
      * and use it as a circular buffer
      *
      */
-    PORTD = B10000000; /* debug timing measurement */
+    DEBUG_ON; /* debug timing measurement */
     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;
@@ -693,10 +730,13 @@ 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;
@@ -707,7 +747,7 @@ void triggerMicro() {
       __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);
   }
 
@@ -728,7 +768,7 @@ void triggerMicro() {
     if (logicIndex >= readCount) {
       logicIndex = 0;
     }
-    Serial.write(logicdata[logicIndex++]);
+    Serial.write(logicdata[logicIndex++] >> 2);
   }
 }
 
@@ -776,6 +816,14 @@ void get_metadata() {
   Serial.write('0');
   Serial.write((uint8_t)0x00);
 
+  /* firmware version */
+  Serial.write((uint8_t)0x02);
+  Serial.write('0');
+  Serial.write('.');
+  Serial.write('0');
+  Serial.write('8');
+  Serial.write((uint8_t)0x00);
+
   /* sample memory */
   Serial.write((uint8_t)0x21);
   Serial.write((uint8_t)0x00);
@@ -801,16 +849,12 @@ void get_metadata() {
   Serial.write((uint8_t)0x42);
   Serial.write((uint8_t)0x40);
 
-  /* number of probes (5 by default on Arduino, 8 on Mega) */
+  /* number of probes (6 by default on Arduino, 8 on Mega) */
   Serial.write((uint8_t)0x40);
 #if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
   Serial.write((uint8_t)0x08);
 #else
-#ifdef CHAN5
   Serial.write((uint8_t)0x06);
-#else
-  Serial.write((uint8_t)0x05);
-#endif /* CHAN5 */
 #endif /* Mega */
 
   /* protocol version (2) */
@@ -846,6 +890,8 @@ void debugprint() {
   Serial.println(logicIndex, DEC);
   Serial.print("triggerIndex = ");
   Serial.println(triggerIndex, DEC);
+  Serial.print("rleEnabled = ");
+  Serial.println(rleEnabled, DEC);
 
   Serial.println("Bytes:");
 
@@ -872,7 +918,7 @@ void debugdump() {
   Serial.print("\r\n");
 
   for (i = 0 ; i < MAX_CAPTURE_SIZE; i++) {
-    Serial.print(logicdata[i], HEX);
+    Serial.print(logicdata[i] >> 2, HEX);
     Serial.print(" ");
     if (j == 32) {
       Serial.print("\r\n");
@@ -883,4 +929,3 @@ void debugdump() {
 }
 #endif /* DEBUG */
 
-

ols.profile-agla.cfg

@@ -7,7 +7,7 @@ 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
@@ -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 = 1500
+# 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
-device.samples.reverseOrder = false
+# In which order are samples sent back from the device? false = last sample first, true = first sample first
+device.samples.reverseOrder = true
 
 ###EOF###

ols.profile-aglam.cfg

@@ -7,7 +7,7 @@ device.description = Arduino Mega 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
@@ -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 = 1000
+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? true = last sample first, false = first sample first
-device.samples.reverseOrder = false
+# In which order are samples sent back from the device? false = last sample first, true = first sample first
+device.samples.reverseOrder = true
 
 ###EOF###