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_sem rx_sem;
        uint8_t *rx_ringbuf;
        uint32_t rx_ringbuf_sz;
        uint16_t rx_get, rx_put;
        int32_t rx_timeout;
 
        struct k_sem tx_sem;
        uint8_t *tx_ringbuf;
        uint32_t tx_ringbuf_sz;
        uint16_t tx_get, tx_put;
        int32_t tx_timeout;
};
 
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 = timeout;
}
 
static inline void tty_set_tx_timeout(struct tty_serial *tty, int32_t timeout)
{
        tty->tx_timeout = 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_ */