v0.14. Rearrange DEBUG functionality, disable by default.

v0.14. Add ‘DEBUG_MENU’ which can be uncommented to enable the basic
debug menu with the ability to run a capture / dump the data etc.
DEBUG and DEBUG_MENU are commented out by default to save RAM.

README

@@ -1,43 +1,28 @@
 SUMP compatible logic analyzer for Arduino
 ==========================================
 
-NOTE: NOTE: v0.09 switches the channels BACK to pins 8-13 for trigger reliability.
-      Please report any issues.  Uncomment USE_PORTD for pins 2-7.
-
 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/
 
+The alternative client version is highly recommended.  Download version
+"ols-0.9.7" or newer for built-in device profiles.
+
 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.
 
 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
+Pins 22-29 (Port A) are used by default.
-if something else works better for you.
-
-NOTE:
-If you are using the original SUMP client, or using the alternative client
-without the device profiles, 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.
-
-The device profiles should be included with this code.  Copy them to the
-'plugins' directory of the client.  The location varies depending on the
-platform, but on the mac it is here by default:
-/Applications/LogicSniffer.app/Contents/Resources/Java/plugins
 
 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:
    ATmega168:  532 (or lower)
@@ -51,8 +36,49 @@ 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.
 
-This master branch now supports Arduino 1.0 only.
+Debugging
-Checkout branch logic_analyzer_v0_5 for Arduino 22 support.
+=========
 
-Release: v0.09 June 22, 2013.
+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.
+
+Older Notes
+===========================================================================
+NOTE: With v0.11 you can now 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 to big for an ATmega168's flash.  You can comment
+      out either captureInline2mhz() or captureInline4mhz() and it will fit.
+      [ The code automatically skips the 2MHz code now, this isn't needed. ]
+
+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: The device profiles should be included with this code.  Copy them to the
+      'plugins' directory of the client.  The location varies depending on the
+      platform, but on the mac it is here by default:
+      /Applications/LogicSniffer.app/Contents/Resources/Java/plugins
+      [ These are included in ols-0.9.7 or newer so do not copy them. ]
+
+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. ]
+
+NOTE: This master branch now supports Arduino 1.0 only.
+      Checkout branch logic_analyzer_v0_5 for Arduino 22 support.
+
+
+Release: v0.14 December 16, 2015.
 

logic_analyzer.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 Andrew Gillham
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -29,7 +29,7 @@
  */
 
 /*
- * NOTE: v0.09 switches the channels BACK to pins 8-13 for trigger reliability.
+ * 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.
  *
  * This Arduino sketch implements a SUMP protocol compatible with the standard
@@ -44,26 +44,10 @@
  * Pins 22-29 (Port A) are used by default, you can change the 'CHANPIN' below
  * if something else works better for you.
  *
- * NOTE:
- * If you are using the original SUMP client, or using the alternative client
- * without the device profiles, 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 from here:
- *      http://www.lxtreme.nl/ols/
- *
- * The device profiles should be included with this code.  Copy them to the
- * 'plugins' directory of the client.  The location varies depending on the
- * platform, but on the mac it is here by default:
- * /Applications/LogicSniffer.app/Contents/Resources/Java/plugins
- *
  * 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:
  *    ATmega168:  532 (or lower)
@@ -78,7 +62,7 @@
  * until after the trigger fires.
  * Please try it out and report back.
  *
- * Release: v0.09 June 22, 2013.
+ * Release: v0.14 December 16, 2015.
  *
  */
 
@@ -97,6 +81,7 @@ void blinkled(void);
 void get_metadata(void);
 void debugprint(void);
 void debugdump(void);
+void prettydump(void);
 
 
 /*
@@ -186,8 +171,11 @@ void debugdump(void);
 #define DEBUG_ENABLE DDRD = DDRD | B10000000
 #define DEBUG_ON PORTD = B10000000
 #define DEBUG_OFF PORTD = B00000000
-#endif
+#endif /* USE_PORTD */
-#define DEBUG
+
+//#define DEBUG_MENU
+//#define DEBUG
+
 #ifdef DEBUG
 #define MAX_CAPTURE_SIZE DEBUG_CAPTURE_SIZE
 #else
@@ -246,6 +234,31 @@ void setup()
   pinMode(ledPin, OUTPUT);
 #endif
 #endif /* Mega */
+
+#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()
@@ -254,10 +267,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.
        */
@@ -271,33 +284,44 @@ 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().
        */
-      if (useMicro) {
+
+      if (divider == 24) {
+        /* 4.0MHz */
+        captureInline4mhz();
+      }
+      else if (divider == 49) {
+        /* 2.0MHz */
+#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();
@@ -309,7 +333,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();
@@ -325,7 +349,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();
@@ -338,7 +362,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
@@ -362,7 +386,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();
@@ -370,37 +394,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 = 1;
+      captureMicro();
+      Serial.println("");
+      Serial.println("500KHz capture done.");
+      break;
+#endif /* DEBUG_MENU */
     default:
       /* ignore any unrecognized bytes. */
       break;
@@ -457,7 +529,7 @@ void getCmd() {
  */
 
 void captureMicro() {
-  int i;
+  unsigned int i;
 
   /*
    * basic trigger, wait until all trigger conditions are met on port.
@@ -482,6 +554,7 @@ void captureMicro() {
    * Arduino digital pin 8 is being used here.
    */
   DEBUG_ENABLE;
+#ifdef DEBUG
   DEBUG_ON;
   delayMicroseconds(20);
   DEBUG_OFF;
@@ -490,6 +563,7 @@ void captureMicro() {
   delayMicroseconds(20);
   DEBUG_OFF;
   delayMicroseconds(20);
+#endif
 
   if (delayTime == 1) {
     /*
@@ -503,7 +577,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
@@ -520,7 +594,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
@@ -571,9 +645,9 @@ void captureMicro() {
  * this basic functionality.
  */
 void captureMilli() {
-  int i = 0;
+  unsigned int i = 0;
 
-  if(rleEnabled) {
+  if (rleEnabled) {
     /*
      * very basic trigger, just like in captureMicros() above.
      */
@@ -584,16 +658,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++;
@@ -605,7 +679,7 @@ void captureMilli() {
 
       i++;
     }
-  } 
+  }
   else {
     /*
      * very basic trigger, just like in captureMicros() above.
@@ -634,10 +708,10 @@ 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() {
-  int i = 0;
+  unsigned int i = 0;
 
   logicIndex = 0;
   triggerIndex = 0;
@@ -657,6 +731,7 @@ void triggerMicro() {
    * Arduino digital pin 8 is being used here.
    */
   DEBUG_ENABLE;
+#ifdef DEBUG
   DEBUG_ON;
   delayMicroseconds(20);
   DEBUG_OFF;
@@ -665,6 +740,7 @@ void triggerMicro() {
   delayMicroseconds(20);
   DEBUG_OFF;
   delayMicroseconds(20);
+#endif
 
   if (delayTime == 1) {
     /*
@@ -679,7 +755,7 @@ void triggerMicro() {
      * click stop.
      */
     return;
-  } 
+  }
   else if (delayTime == 2) {
     /*
      * 500KHz case.  We should be able to manage this in time.
@@ -708,7 +784,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.
@@ -738,7 +814,7 @@ void triggerMicro() {
     }
     DEBUG_OFF; /* debug timing measurement */
     delayMicroseconds(100);
-  } 
+  }
   else {
     /*
      * Less than 500KHz case.  This uses delayMicroseconds() and some padding
@@ -838,7 +914,7 @@ void setupDelay() {
   if (divider >= 1500000) {
     useMicro = 0;
     delayTime = (divider + 1) / 100000;
-  } 
+  }
   else {
     useMicro = 1;
     delayTime = (divider + 1) / 100;
@@ -868,8 +944,8 @@ void get_metadata() {
   Serial.write((uint8_t)0x02);
   Serial.write('0');
   Serial.write('.');
-  Serial.write('0');
+  Serial.write('1');
-  Serial.write('9');
+  Serial.write('3');
   Serial.write((uint8_t)0x00);
 
   /* sample memory */
@@ -890,12 +966,12 @@ void get_metadata() {
   Serial.write((uint8_t)0x14);
 #endif /* Mega */
 
-  /* sample rate (1MHz) */
+  /* sample rate (4MHz) */
   Serial.write((uint8_t)0x23);
   Serial.write((uint8_t)0x00);
-  Serial.write((uint8_t)0x0F);
+  Serial.write((uint8_t)0x3D);
-  Serial.write((uint8_t)0x42);
+  Serial.write((uint8_t)0x09);
-  Serial.write((uint8_t)0x40);
+  Serial.write((uint8_t)0x00);
 
   /* number of probes (6 by default on Arduino, 8 on Mega) */
   Serial.write((uint8_t)0x40);
@@ -914,11 +990,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.
  *
  */
@@ -950,7 +1026,7 @@ void debugprint() {
   for (i = 0 ; i < savecount; i++) {
     if (savebytes[i] == 0x20) {
       Serial.println();
-    } 
+    }
     else {
       Serial.print(savebytes[i], HEX);
       Serial.write(' ');
@@ -959,6 +1035,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.
@@ -983,7 +1061,41 @@ 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 */
+
+
+
+
+
 
 
 

ols.profile-agla.cfg

@@ -11,7 +11,7 @@ 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
@@ -39,7 +39,7 @@ 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 = 1500
+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)

ols.profile-aglam.cfg

@@ -11,7 +11,7 @@ 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