tty.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 Linaro Limited
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_CONSOLE_TTY_H_
#define ZEPHYR_INCLUDE_CONSOLE_TTY_H_
 
#include <sys/types.h>
#include <zephyr/types.h>
#include <zephyr/kernel.h>
 
#ifdef __cplusplus
extern "C" {
#endif

struct tty_serial {
        const struct device *uart_dev;
 
        struct k_event signal_event;
 
        struct ring_buf rx_buf;
        k_timeout_t rx_timeout;
 
        struct ring_buf tx_buf;
        k_timeout_t tx_timeout;
        atomic_t tx_busy;
};

int tty_init(struct tty_serial *tty, const struct device *uart_dev);

static inline void tty_set_rx_timeout(struct tty_serial *tty, int32_t timeout)
{
        tty->rx_timeout = SYS_TIMEOUT_MS(timeout);
}

static inline void tty_set_tx_timeout(struct tty_serial *tty, int32_t timeout)
{
        tty->tx_timeout = SYS_TIMEOUT_MS(timeout);
}

int tty_set_rx_buf(struct tty_serial *tty, void *buf, size_t size);

int tty_set_tx_buf(struct tty_serial *tty, void *buf, size_t size);

ssize_t tty_read(struct tty_serial *tty, void *buf, size_t size);

ssize_t tty_write(struct tty_serial *tty, const void *buf, size_t size);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_CONSOLE_TTY_H_ */