shell_fprintf.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_SHELL_FPRINTF_H_
#define ZEPHYR_INCLUDE_SHELL_FPRINTF_H_
 
#include <zephyr/kernel.h>
#include <stdbool.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef void (*shell_fprintf_fwrite)(const void *user_ctx,
                                     const char *data,
                                     size_t length);
 
struct shell_fprintf_control_block {
        size_t buffer_cnt;
        bool autoflush;
};
struct shell_fprintf {
        uint8_t *buffer;
        size_t buffer_size;
        shell_fprintf_fwrite fwrite;
        const void *user_ctx;
        struct shell_fprintf_control_block *ctrl_blk;
};
 
#define Z_SHELL_FPRINTF_DEFINE(_name, _user_ctx, _buf, _size,   \
                            _autoflush, _fwrite)                \
        static struct shell_fprintf_control_block               \
                                _name##_shell_fprintf_ctx = {   \
                .autoflush = _autoflush,                        \
                .buffer_cnt = 0                                 \
        };                                                      \
        static const struct shell_fprintf _name = {             \
                .buffer = _buf,                                 \
                .buffer_size = _size,                           \
                .fwrite = _fwrite,                              \
                .user_ctx = _user_ctx,                          \
                .ctrl_blk = &_name##_shell_fprintf_ctx          \
        }
 
void z_shell_fprintf_fmt(const struct shell_fprintf *sh_fprintf,
                         char const *fmt, va_list args);
 
void z_shell_fprintf_buffer_flush(const struct shell_fprintf *sh_fprintf);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_SHELL_FPRINTF_H_ */