Merge tag 'efi-2020-01-rc2' of https://gitlab.denx.de/u-boot/custodians/u-boot-efi

[oweals/u-boot.git] / include / log.h

diff --git a/include/log.h b/include/log.h
index a872fc6ef5fd67a337827762607c5db93c291d5a..d8f18a6afdf38b7fb7fe0782337880af61f699db 100644 (file)
--- a/include/log.h
+++ b/include/log.h
@@ -14,7 +14,7 @@
 
 /** Log levels supported, ranging from most to least important */
 enum log_level_t {
-       LOGL_EMERG = 0,         /*U-Boot is unstable */
+       LOGL_EMERG = 0,         /* U-Boot is unstable */
        LOGL_ALERT,             /* Action must be taken immediately */
        LOGL_CRIT,              /* Critical conditions */
        LOGL_ERR,               /* Error that prevents something from working */
@@ -47,6 +47,8 @@ enum log_category_t {
        LOGC_DT,        /* Device-tree */
        LOGC_EFI,       /* EFI implementation */
        LOGC_ALLOC,     /* Memory allocation */
+       LOGC_SANDBOX,   /* Related to the sandbox board */
+       LOGC_BLOBLIST,  /* Bloblist */
 
        LOGC_COUNT,     /* Number of log categories */
        LOGC_END,       /* Sentinel value for a list of log categories */
@@ -71,7 +73,20 @@ static inline int log_uc_cat(enum uclass_id id)
  * @return 0 if log record was emitted, -ve on error
  */
 int _log(enum log_category_t cat, enum log_level_t level, const char *file,
-        int line, const char *func, const char *fmt, ...);
+        int line, const char *func, const char *fmt, ...)
+               __attribute__ ((format (__printf__, 6, 7)));
+
+static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
+                          const char *file, int line, const char *func,
+                          const char *fmt, ...)
+               __attribute__ ((format (__printf__, 6, 7)));
+
+static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
+                          const char *file, int line, const char *func,
+                          const char *fmt, ...)
+{
+       return 0;
+}
 
 /* Define this at the top of a file to add a prefix to debug messages */
 #ifndef pr_fmt
@@ -98,23 +113,40 @@ int _log(enum log_category_t cat, enum log_level_t level, const char *file,
 #define log_io(_fmt...)                log(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt)
 #else
 #define _LOG_MAX_LEVEL LOGL_INFO
-#define log_err(_fmt...)
-#define log_warning(_fmt...)
-#define log_notice(_fmt...)
-#define log_info(_fmt...)
-#define log_debug(_fmt...)
-#define log_content(_fmt...)
-#define log_io(_fmt...)
+#define log_err(_fmt...)       log_nop(LOG_CATEGORY, LOGL_ERR, ##_fmt)
+#define log_warning(_fmt...)   log_nop(LOG_CATEGORY, LOGL_WARNING, ##_fmt)
+#define log_notice(_fmt...)    log_nop(LOG_CATEGORY, LOGL_NOTICE, ##_fmt)
+#define log_info(_fmt...)      log_nop(LOG_CATEGORY, LOGL_INFO, ##_fmt)
+#define log_debug(_fmt...)     log_nop(LOG_CATEGORY, LOGL_DEBUG, ##_fmt)
+#define log_content(_fmt...)   log_nop(LOG_CATEGORY, \
+                                       LOGL_DEBUG_CONTENT, ##_fmt)
+#define log_io(_fmt...)                log_nop(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt)
+#endif
+
+#if CONFIG_IS_ENABLED(LOG)
+#ifdef LOG_DEBUG
+#define _LOG_DEBUG     1
+#else
+#define _LOG_DEBUG     0
 #endif
 
 /* Emit a log record if the level is less that the maximum */
 #define log(_cat, _level, _fmt, _args...) ({ \
        int _l = _level; \
-       if (_l <= _LOG_MAX_LEVEL) \
+       if (CONFIG_IS_ENABLED(LOG) && (_l <= _LOG_MAX_LEVEL || _LOG_DEBUG)) \
                _log((enum log_category_t)(_cat), _l, __FILE__, __LINE__, \
                      __func__, \
                      pr_fmt(_fmt), ##_args); \
        })
+#else
+#define log(_cat, _level, _fmt, _args...)
+#endif
+
+#define log_nop(_cat, _level, _fmt, _args...) ({ \
+       int _l = _level; \
+       _log_nop((enum log_category_t)(_cat), _l, __FILE__, __LINE__, \
+                     __func__, pr_fmt(_fmt), ##_args); \
+})
 
 #ifdef DEBUG
 #define _DEBUG 1
@@ -170,11 +202,32 @@ int _log(enum log_category_t cat, enum log_level_t level, const char *file,
  */
 void __assert_fail(const char *assertion, const char *file, unsigned int line,
                   const char *function);
+
+/**
+ * assert() - assert expression is true
+ *
+ * If the expression x evaluates to false and _DEBUG evaluates to true, a panic
+ * message is written and the system stalls. The value of _DEBUG is set to true
+ * if DEBUG is defined before including common.h.
+ *
+ * The expression x is always executed irrespective of the value of _DEBUG.
+ *
+ * @x:         expression to test
+ */
 #define assert(x) \
        ({ if (!(x) && _DEBUG) \
                __assert_fail(#x, __FILE__, __LINE__, __func__); })
 
-#ifdef CONFIG_LOG_ERROR_RETURN
+#if CONFIG_IS_ENABLED(LOG) && defined(CONFIG_LOG_ERROR_RETURN)
+/*
+ * Log an error return value, possibly with a message. Usage:
+ *
+ *     return log_ret(fred_call());
+ *
+ * or:
+ *
+ *     return log_msg_ret("fred failed", fred_call());
+ */
 #define log_ret(_ret) ({ \
        int __ret = (_ret); \
        if (__ret < 0) \
@@ -189,8 +242,9 @@ void __assert_fail(const char *assertion, const char *file, unsigned int line,
        __ret; \
        })
 #else
+/* Non-logging versions of the above which just return the error code */
 #define log_ret(_ret) (_ret)
-#define log_msg_ret(_msg, _ret) (_ret)
+#define log_msg_ret(_msg, _ret) ((void)(_msg), _ret)
 #endif
 
 /**