Zephyr printk实现介绍

zephyr printk的实现分为两步：

1、字符输出函数console_out()的实现

2、printk()的实现

printk()通过格式化字符串，并调用console_out()实现了打印的效果。

 

以下详细说明：

一、字符输出函数console_out()的实现

1、初始化uart作为log输出的物理接口。（device_get_binding初始化外设属于设备树模型，以后会写另一篇博客详细介绍，此处只要知道该API初始化了uart即可）

static int uart_console_init(const struct device *arg)
{

    ARG_UNUSED(arg);

    /* Claim console device */
    uart_console_dev = device_get_binding(CONFIG_UART_CONSOLE_ON_DEV_NAME);

    uart_console_hook_install();

    return 0;
}

 

2、字符发送API：console_out被注册到printk.c文件夹下的_char_out函数。（注意：_char_out最终会被printk调用）

//drivers/console/uart_console.c

static void uart_console_hook_install(void)
{
    __stdout_hook_install(console_out);
    __printk_hook_install(console_out);
}

 6 //lib/os/printk.c
 7 void __printk_hook_install(int (*fn)(int))
 8 {
 9     _char_out = fn;   //_char_out  = console_out
10 }

//console_out（）调用串口API:uart_poll_out发送字符

static int console_out(int c)
{
#ifdef CONFIG_UART_CONSOLE_DEBUG_SERVER_HOOKS

    int handled_by_debug_server = HANDLE_DEBUG_HOOK_OUT(c);

    if (handled_by_debug_server) {
        return c;
    }

#endif  /* CONFIG_UART_CONSOLE_DEBUG_SERVER_HOOKS */

    if ('\n' == c) {
        uart_poll_out(uart_console_dev, '\r');
    }
    uart_poll_out(uart_console_dev, c);

    return c;
}

 

二、printk()的实现

_char_out是发送字符的函数，被注册到char_out中了。

cbvprintf调用char_out发送字符。printk逐级调用到cbvprintf。

void printk(const char *fmt, ...)
{
    va_list ap;

    va_start(ap, fmt);

    if (IS_ENABLED(CONFIG_LOG_PRINTK)) {
        log_printk(fmt, ap);
    } else {
        vprintk(fmt, ap);
    }
    va_end(ap);
}

void vprintk(const char *fmt, va_list ap)
{
    struct out_context ctx = { 0 };
#ifdef CONFIG_PRINTK_SYNC
    k_spinlock_key_t key = k_spin_lock(&lock);
#endif

    cbvprintf(char_out, &ctx, fmt, ap);

#ifdef CONFIG_PRINTK_SYNC
    k_spin_unlock(&lock, key);
#endif
}

static int char_out(int c, void *ctx_p)
{
    struct out_context *ctx = ctx_p;

    ctx->count++;
    return _char_out(c);
}