- Added a "User:" debug level. These are messages that are intended for the user...

[openocd.git] / src / helper / log.h

diff --git a/src/helper/log.h b/src/helper/log.h
index 34646e70217374539ef21dee2e1c57554333d8c4..ab32760a96b3c7e2190d8856d7874d76b24deae6 100644 (file)
--- a/src/helper/log.h
+++ b/src/helper/log.h
@@ -26,6 +26,9 @@
 #include <stdarg.h>
 
 /* logging priorities 
+ * LOG_USER - user messages. Could be anything from information 
+ *            to progress messags. These messages do not represent
+ *            incorrect or unexpected behaviour, just normal execution. 
  * LOG_ERROR - fatal errors, that are likely to cause program abort
  * LOG_WARNING - non-fatal errors, that may be resolved later
  * LOG_INFO - state information, etc.
@@ -33,6 +36,7 @@
  */
 enum log_levels
 {
+       LOG_USER = -1,
        LOG_ERROR = 0,
        LOG_WARNING = 1,
        LOG_INFO = 2,
@@ -46,20 +50,23 @@ extern int log_register_commands(struct command_context_s *cmd_ctx);
 extern int log_init(struct command_context_s *cmd_ctx);
 extern int set_log_output(struct command_context_s *cmd_ctx, FILE *output);
 
-typedef void (*logCallback)(void *privData, const char *file, int line, 
+typedef void (*logCallback)(void *priv, const char *file, int line, 
                const char *function, const char *format, va_list args);
 
-void log_setCallback(logCallback callback, void *privData);            
+extern void log_setCallback(logCallback callback, void *priv);         
 
 extern int debug_level;
 
+/* Avoid fn call and building parameter list if we're not outputting the information.
+ * Matters on feeble CPUs for DEBUG/INFO statements that are involved frequently */
+
 #define DEBUG(expr ...) \
-       do { \
+       do { if (debug_level >= LOG_DEBUG) \
                log_printf (LOG_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr); \
        } while(0)
 
 #define INFO(expr ...) \
-       do { \
+       do { if (debug_level >= LOG_INFO) \
                log_printf (LOG_INFO, __FILE__, __LINE__, __FUNCTION__, expr); \
        } while(0)
 
@@ -73,6 +80,11 @@ extern int debug_level;
                log_printf (LOG_ERROR, __FILE__, __LINE__, __FUNCTION__, expr); \
        } while(0)
 
+#define USER(expr ...) \
+       do { \
+               log_printf (LOG_USER, __FILE__, __LINE__, __FUNCTION__, expr); \
+       } while(0)
+
 
 /* general failures
  * error codes < 100
@@ -84,5 +96,4 @@ extern int debug_level;
 
 char *allocPrintf(const char *fmt, va_list ap);
 
-
 #endif /* LOG_H */