Merge branch 'rhaberkorn-serial-mouse'

[tmk_firmware.git] / common / print.h

diff --git a/common/print.h b/common/print.h
index 686fa89accfb8af96991bb2b2b3c2dabe6f31d34..930e84be99d555871aec946f27cf2c49f909eb76 100644 (file)
--- a/common/print.h
+++ b/common/print.h
@@ -1,3 +1,4 @@
+/* Copyright 2012 Jun Wako <wakojun@gmail.com> */
 /* Very basic print functions, intended to be used with usb_debug_only.c
  * http://www.pjrc.com/teensy/
  * Copyright (c) 2008 PJRC.COM, LLC
@@ -27,19 +28,112 @@
 #include <stdint.h>
 #include <stdbool.h>
 #include <avr/pgmspace.h>
+#include "xprintf.h"
+#include "util.h"
 
 
-extern bool print_enable;
-
 // this macro allows you to write print("some text") and
 // the string is automatically placed into flash memory :)
-#define print(s) print_P(PSTR(s))
+// TODO: avoid collision with arduino/Print.h
+#ifndef __cplusplus
+#define print(s)                print_P(PSTR(s))
+#endif
+#define println(s)              print_P(PSTR(s "\n"))
+
+/* for old name */
+#define pdec(data)              print_dec(data)
+#define pdec16(data)            print_dec(data)
+#define phex(data)              print_hex8(data)
+#define phex16(data)            print_hex16(data)
+#define pbin(data)              print_bin8(data)
+#define pbin16(data)            print_bin16(data)
+#define pbin_reverse(data)      print_bin_reverse8(data)
+#define pbin_reverse16(data)    print_bin_reverse16(data)
+
+/* print value utility */
+#define print_val_dec(v)           xprintf(#v ": %u\n", v)
+#define print_val_decs(v)          xprintf(#v ": %d\n", v)
+#define print_val_hex8(v)          xprintf(#v ": %X\n", v)
+#define print_val_hex16(v)         xprintf(#v ": %02X\n", v)
+#define print_val_hex32(v)         xprintf(#v ": %04lX\n", v)
+#define print_val_bin8(v)          xprintf(#v ": %08b\n", v)
+#define print_val_bin16(v)         xprintf(#v ": %016b\n", v)
+#define print_val_bin32(v)         xprintf(#v ": %032lb\n", v)
+#define print_val_bin_reverse8(v)  xprintf(#v ": %08b\n", bitrev(v))
+#define print_val_bin_reverse16(v) xprintf(#v ": %016b\n", bitrev16(v))
+#define print_val_bin_reverse32(v) xprintf(#v ": %032lb\n", bitrev32(v))
+
+
+
+#ifndef NO_PRINT
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* function pointer of sendchar to be used by print utility */
+void print_set_sendchar(int8_t (*print_sendchar_func)(uint8_t));
+
+/* print string stored in data memory(SRAM)
+ *     print_S("hello world");
+ * This consumes precious SRAM memory space for string.
+ */
 void print_S(const char *s);
-void print_P(const char *s);
-void phex(unsigned char c);
-void phex16(unsigned int i);
-void pbin(unsigned char c);
-void pbin_reverse(unsigned char c);
+
+void print_lf(void);
+void print_crlf(void);
+
+
+/* print string stored in program memory(FLASH)
+ *     print_P(PSTR("hello world");
+ * This consumes relatively abundant FLASH memory area not SRAM.
+ */
+#define print_P(s)          xputs(s)
+
+/* decimal */
+#define print_dec(i)        xprintf("%u", i)
+#define print_decs(i)       xprintf("%d", i)
+
+/* hex */
+#define print_hex4(i)       xprintf("%X", i)
+#define print_hex8(i)       xprintf("%02X", i)
+#define print_hex16(i)      xprintf("%04X", i)
+#define print_hex32(i)      xprintf("%08lX", i)
+
+/* binary */
+#define print_bin4(i)       xprintf("%04b", i)
+#define print_bin8(i)       xprintf("%08b", i)
+#define print_bin16(i)      xprintf("%016b", i)
+#define print_bin32(i)      xprintf("%032lb", i)
+
+#define print_bin_reverse8(i)   xprintf("%08b", bitrev(i))
+#define print_bin_reverse16(i)  xprintf("%016b", bitrev16(i))
+#define print_bin_reverse32(i)  xprintf("%032lb", bitrev32(i))
+
+#ifdef __cplusplus
+}
+#endif
+
+#else
+
+#define print_set_sendchar(func)
+#define print_S(s)
+#define print_P(s)
+#define print_dec(data)
+#define print_decs(data)
+#define print_hex4(data)
+#define print_hex8(data)
+#define print_hex16(data)
+#define print_hex32(data)
+#define print_bin4(data)
+#define print_bin8(data)
+#define print_bin16(data)
+#define print_bin32(data)
+#define print_bin_reverse8(data)
+#define print_bin_reverse16(data)
+#define print_bin_reverse32(data)
+
+#endif
+
 
 #endif