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
@@ -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);
 
 
 /*
@@ -170,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
@@ -263,7 +267,7 @@ 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
@@ -299,7 +303,7 @@ void loop()
       }
       else if (divider == 49) {
         /* 2.0MHz */
-#if defined(__AVR_ATmega168P__)
+#if !defined(__AVR_ATmega168__)
         captureInline2mhz();
 #endif
       }
@@ -390,17 +394,30 @@ void loop()
     case SUMP_SELF_TEST:
       /* ignored. */
       break;
-#ifdef DEBUG
+#ifdef DEBUG_MENU
       /*
          * a couple of debug commands used during development.
        */
+    case '?':
+      Serial.println("");
+#ifdef DEBUG
+      Serial.println("0 = clear cmd buffer");
+      Serial.println("1 = print cmd buffer");
+#endif /* DEBUG */
+      Serial.println("2 = print data buffer");
+      Serial.println("3 = pretty print buffer");
+      Serial.println("4 = capture at 4MHz");
+      Serial.println("5 = capture at 1MHz");
+      Serial.println("6 = capture at 500KHz");
+      break;
+#ifdef DEBUG
     case '0':
       /*
          * This resets the debug buffer pointer, effectively clearing the
        * 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;
       }
@@ -414,13 +431,48 @@ void loop()
       blinkled();
       debugprint();
       break;
+#endif /* DEBUG */
     case '2':
       /*
-       * This dumps the sample data to the serial port.  Used for debugging.
+         * This dumps the sample data to the serial port.
        */
       debugdump();
       break;
-#endif /* DEBUG */
+    case '3':
+      /*
+         * Prints a visual representation of the data buffer.
+       */
+      prettydump();
+      break;
+    case '4':
+      /*
+         * This runs a sample capture at 4MHz.
+       */
+      captureInline4mhz();
+      Serial.println("");
+      Serial.println("4MHz capture done.");
+      break;
+    case '5':
+      /*
+         * This runs a sample capture at 1MHz.
+       * delayTime = 1ms for 1MHz sampling.
+       */
+      delayTime = 1;
+      captureMicro();
+      Serial.println("");
+      Serial.println("1MHz capture done.");
+      break;
+    case '6':
+      /*
+         * This runs a sample capture at 500KHz.
+       * delayTime = 2ms for 500KHz.
+       */
+      delayTime = 1;
+      captureMicro();
+      Serial.println("");
+      Serial.println("500KHz capture done.");
+      break;
+#endif /* DEBUG_MENU */
     default:
       /* ignore any unrecognized bytes. */
       break;
@@ -595,7 +647,7 @@ void captureMicro() {
 void captureMilli() {
   unsigned int i = 0;
 
-  if(rleEnabled) {
+  if (rleEnabled) {
     /*
      * very basic trigger, just like in captureMicros() above.
      */
@@ -606,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++;
@@ -893,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 */
@@ -942,7 +994,7 @@ void get_metadata() {
 }
 
 /*
- * This is used by the '0' debug command to dump the contents of some
+ * This is used by the '1' debug command to dump the contents of some
  * interesting variables and the debug buffer.
  *
  */
@@ -983,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.
@@ -1007,7 +1061,37 @@ 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 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 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