ipm_console.h

Go to the documentation of this file.

/* ipm_console.c - Console messages to/from another processor */
 
/*
 * Copyright (c) 2015 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DRIVERS_CONSOLE_IPM_CONSOLE_H_
#define ZEPHYR_INCLUDE_DRIVERS_CONSOLE_IPM_CONSOLE_H_
 
#include <zephyr/kernel.h>
#include <zephyr/device.h>
#include <zephyr/sys/ring_buffer.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define IPM_CONSOLE_STDOUT      (BIT(0))
#define IPM_CONSOLE_PRINTK      (BIT(1))
 
/*
 * Good way to determine these numbers other than trial-and-error?
 * using printf() in the thread seems to require a lot more stack space
 */
#define IPM_CONSOLE_STACK_SIZE          CONFIG_IPM_CONSOLE_STACK_SIZE
#define IPM_CONSOLE_PRI                 2
 
struct ipm_console_receiver_config_info {
        char *bind_to;
 
        k_thread_stack_t *thread_stack;
 
        uint32_t *ring_buf_data;
 
        unsigned int rb_size32;
 
        char *line_buf;
 
        unsigned int lb_size;
 
        unsigned int flags;
};
 
struct ipm_console_receiver_runtime_data {
        struct ring_buf rb;
 
        struct k_sem sem;
 
        const struct device *ipm_device;
 
        int channel_disabled;
 
        struct k_thread rx_thread;
};
 
struct ipm_console_sender_config_info {
        char *bind_to;
 
        int flags;
};
 
#if CONFIG_IPM_CONSOLE_RECEIVER
int ipm_console_receiver_init(const struct device *d);
#endif
 
#if CONFIG_IPM_CONSOLE_SENDER
int ipm_console_sender_init(const struct device *d);
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_CONSOLE_IPM_CONSOLE_H_ */