printk.h

Go to the documentation of this file.

/* printk.h - low-level debug output */
 
/*
 * Copyright (c) 2010-2012, 2014 Wind River Systems, Inc.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#ifndef ZEPHYR_INCLUDE_SYS_PRINTK_H_
#define ZEPHYR_INCLUDE_SYS_PRINTK_H_
 
#include <zephyr/toolchain.h>
#include <stddef.h>
#include <stdarg.h>
#include <inttypes.h>
 
#ifdef CONFIG_LOG_PRINTK_STATIC
#include <zephyr/logging/log_core.h>
#endif
 
#ifdef __cplusplus
extern "C" {
#endif

#if defined(CONFIG_PRINTK) || defined(__DOXYGEN__)
 
#ifdef CONFIG_LOG_PRINTK_STATIC
/* If printk is redirected to the logging use the macro which allow build time
 * logging message creation which is faster and allows format string stripping in
 * case of dictionary based logging.
 */
#define printk(...) Z_LOG_PRINTK(0, __VA_ARGS__)
#else
__printf_like(1, 2) void printk(const char *fmt, ...);
#endif /* CONFIG_LOG_PRINTK_STATIC */

__printf_like(1, 0) void vprintk(const char *fmt, va_list ap);

__printf_like(1, 2) void printk_unlocked(const char *fmt, ...);

__printf_like(1, 0) void vprintk_unlocked(const char *fmt, va_list ap);

void printk_panic(void);
 
#else
static inline __printf_like(1, 2) void printk(const char *fmt, ...)
{
        ARG_UNUSED(fmt);
}
 
static inline __printf_like(1, 0) void vprintk(const char *fmt, va_list ap)
{
        ARG_UNUSED(fmt);
        ARG_UNUSED(ap);
}
 
static inline __printf_like(1, 2) void printk_unlocked(const char *fmt, ...)
{
        ARG_UNUSED(fmt);
}
 
static inline __printf_like(1, 0) void vprintk_unlocked(const char *fmt, va_list ap)
{
        ARG_UNUSED(fmt);
        ARG_UNUSED(ap);
}
 
static inline void printk_panic(void)
{
}
#endif /* defined(CONFIG_PRINTK) || defined(__DOXYGEN__) */
 
#ifdef CONFIG_PICOLIBC
 
#include <stdio.h>
 
#define snprintk(...) snprintf(__VA_ARGS__)
#define vsnprintk(str, size, fmt, ap) vsnprintf(str, size, fmt, ap)
 
#else

__printf_like(3, 4) int snprintk(char *str, size_t size,
                                        const char *fmt, ...);

__printf_like(3, 0) int vsnprintk(char *str, size_t size,
                                          const char *fmt, va_list ap);
 
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif