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

@@ -36,6 +36,17 @@ 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.
+
 Older Notes
 ===========================================================================
 NOTE: With v0.11 you can now sample at 4MHz & 2MHz rates in addition to the 
@@ -69,5 +80,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.14 December 16, 2015.
 

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 Andrew Gillham
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -46,7 +46,7 @@
  *
  * To use this with the original or alternative SUMP clients,
  * use these settings:
- * 
+ *
  * Sampling rate: 4MHz (or lower) (no 2MHz on ATmega168)
  * Channel Groups: 0 (zero) only
  * Recording Size:
@@ -62,7 +62,7 @@
  * until after the trigger fires.
  * Please try it out and report back.
  *
- * Release: v0.12 September 6, 2013.
+ * Release: v0.14 December 16, 2015.
  *
  */
 
@@ -81,6 +81,7 @@ void blinkled(void);
 void get_metadata(void);
 void debugprint(void);
 void debugdump(void);
+void prettydump(void);
 
 
 /*
@@ -88,11 +89,6 @@ void debugdump(void);
  * 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 +115,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 +122,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. */
@@ -169,9 +155,6 @@ void debugdump(void);
 #if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
 #define DEBUG_CAPTURE_SIZE 7168
 #define CAPTURE_SIZE 7168
-#elif defined(__AVR_ATmega32U4__)
-#define DEBUG_CAPTURE_SIZE 1536
-#define CAPTURE_SIZE 1536
 #elif defined(__AVR_ATmega328P__)
 #define DEBUG_CAPTURE_SIZE 1024
 #define CAPTURE_SIZE 1024
@@ -188,8 +171,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 +209,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 +226,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
 
@@ -286,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.
        */
@@ -303,14 +284,14 @@ void loop()
       break;
     case SUMP_ARM:
       /*
-       * Zero out any previous samples before arming.
+         * Zero out any previous samples before arming.
        * Done here instead via reset due to spurious resets.
        */
       for (i = 0 ; i < MAX_CAPTURE_SIZE; i++) {
         logicdata[i] = 0;
       }
       /*
-       * depending on the sample rate we need to delay in microseconds
+         * depending on the sample rate we need to delay in microseconds
        * or milliseconds.  We can't do the complex trigger at 1MHz
        * so in that case (delayTime == 1 and triggers enabled) use
        * captureMicro() instead of triggerMicro().
@@ -319,45 +300,45 @@ void loop()
       if (divider == 24) {
         /* 4.0MHz */
         captureInline4mhz();
-      } 
+      }
       else if (divider == 49) {
         /* 2.0MHz */
-#if defined(__AVR_ATmega168P__)
+#if !defined(__AVR_ATmega168__)
         captureInline2mhz();
 #endif
-      } 
+      }
       else if (useMicro) {
         if (trigger && (delayTime != 1)) {
           triggerMicro();
-        } 
+        }
         else {
           captureMicro();
         }
-      } 
+      }
       else {
         captureMilli();
       }
       break;
     case SUMP_TRIGGER_MASK:
       /*
-       * the trigger mask byte has a '1' for each enabled trigger so
+         * the trigger mask byte has a '1' for each enabled trigger so
        * we can just use it directly as our trigger mask.
        */
       getCmd();
-#ifdef SHIFTBITS
-      trigger = cmdBytes[0] << SHIFTBITS;
+#ifdef USE_PORTD
+      trigger = cmdBytes[0] << 2;
 #else
       trigger = cmdBytes[0];
 #endif
       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();
-#ifdef SHIFTBITS
-      trigger_values = cmdBytes[0] << SHIFTBITS;
+#ifdef USE_PORTD
+      trigger_values = cmdBytes[0] << 2;
 #else
       trigger_values = cmdBytes[0];
 #endif
@@ -368,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();
@@ -381,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
@@ -405,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();
@@ -413,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;
@@ -548,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
@@ -565,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
@@ -590,8 +619,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
@@ -618,7 +647,7 @@ void captureMicro() {
 void captureMilli() {
   unsigned int i = 0;
 
-  if(rleEnabled) {
+  if (rleEnabled) {
     /*
      * very basic trigger, just like in captureMicros() above.
      */
@@ -629,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++;
@@ -650,7 +679,7 @@ void captureMilli() {
 
       i++;
     }
-  } 
+  }
   else {
     /*
      * very basic trigger, just like in captureMicros() above.
@@ -665,8 +694,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
@@ -679,7 +708,7 @@ void captureMilli() {
  * This works ok at 500KHz and lower sample rates.  We don't have enough time
  * with a 16MHz clock to sample at 1MHz into the circular buffer.  A 20MHz
  * clock might be ok but all of the timings would have to be redone.
- * 
+ *
  */
 void triggerMicro() {
   unsigned int i = 0;
@@ -726,7 +755,7 @@ void triggerMicro() {
      * click stop.
      */
     return;
-  } 
+  }
   else if (delayTime == 2) {
     /*
      * 500KHz case.  We should be able to manage this in time.
@@ -755,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.
@@ -785,7 +814,7 @@ void triggerMicro() {
     }
     DEBUG_OFF; /* debug timing measurement */
     delayMicroseconds(100);
-  } 
+  }
   else {
     /*
      * Less than 500KHz case.  This uses delayMicroseconds() and some padding
@@ -859,8 +888,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
@@ -885,7 +914,7 @@ void setupDelay() {
   if (divider >= 1500000) {
     useMicro = 0;
     delayTime = (divider + 1) / 100000;
-  } 
+  }
   else {
     useMicro = 1;
     delayTime = (divider + 1) / 100;
@@ -906,8 +935,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 +945,7 @@ void get_metadata() {
   Serial.write('0');
   Serial.write('.');
   Serial.write('1');
-  Serial.write('2');
+  Serial.write('3');
   Serial.write((uint8_t)0x00);
 
   /* sample memory */
@@ -929,10 +956,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,26 +975,26 @@ 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);
   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.
  *
  */
@@ -1003,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(' ');
@@ -1012,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.
@@ -1023,8 +1048,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 +1061,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_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 Andrew Gillham
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

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 Andrew Gillham
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without