uart.hpp

Go to the documentation of this file.

/*
 * Copyright (C) 2026 Kamil Lulko <kamil.lulko@gmail.com>
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 * This file is part of oveRTOS.
 */
 
#pragma once
 
#ifdef CONFIG_OVE_UART
 
#include <ove/uart.h>
#include <ove/types.hpp>
#include <ove/error.hpp>
 
namespace ove
{
 
template <size_t RxBufSize = 0> class Uart
{
      public:
    explicit Uart(const struct ove_uart_cfg &cfg)
        requires(RxBufSize > 0)
    {
#ifdef CONFIG_OVE_ZERO_HEAP
        static_assert(RxBufSize > 0, "RxBufSize must be > 0 in zero-heap mode");
        int err = ove_uart_init(&handle_, &storage_, rx_buf_, &cfg);
#else
        int err = ove_uart_create(&handle_, &cfg);
#endif
        OVE_STATIC_INIT_ASSERT(err == OVE_OK);
    }
 
    ~Uart() noexcept
    {
        if (!handle_)
            return;
#ifdef CONFIG_OVE_ZERO_HEAP
        ove_uart_deinit(handle_);
#else
        ove_uart_destroy(handle_);
#endif
    }
 
    Uart(const Uart &) = delete;
    Uart &operator=(const Uart &) = delete;
 
#ifdef CONFIG_OVE_ZERO_HEAP
    Uart(Uart &&) = delete;
    Uart &operator=(Uart &&) = delete;
#else
    Uart(Uart &&o) noexcept : handle_(o.handle_)
    {
        o.handle_ = nullptr;
    }
    Uart &operator=(Uart &&o) noexcept
    {
        if (this != &o) {
            if (handle_)
                ove_uart_destroy(handle_);
            handle_ = o.handle_;
            o.handle_ = nullptr;
        }
        return *this;
    }
#endif
 
    [[nodiscard]] Result<size_t> write(const void *data, size_t len,
                       std::chrono::nanoseconds timeout = wait_forever) noexcept
    {
        size_t bytes_written = 0;
        const int rc =
            ove_uart_write(handle_, data, len, to_timeout_ns(timeout), &bytes_written);
        return from_rc(rc, bytes_written);
    }
 
    [[nodiscard]] Result<size_t> read(void *buf, size_t len,
                      std::chrono::nanoseconds timeout = wait_forever) noexcept
    {
        size_t bytes_read = 0;
        const int rc =
            ove_uart_read(handle_, buf, len, to_timeout_ns(timeout), &bytes_read);
        return from_rc(rc, bytes_read);
    }
 
    size_t bytes_available() const
    {
        return ove_uart_bytes_available(handle_);
    }
 
    [[nodiscard]] Result<void> flush() noexcept
    {
        return from_rc(ove_uart_flush(handle_));
    }
 
    ove_uart_t handle() const
    {
        return handle_;
    }
 
      private:
    ove_uart_t handle_ = nullptr;
#ifdef CONFIG_OVE_ZERO_HEAP
    ove_uart_storage_t storage_{};
    uint8_t rx_buf_[RxBufSize > 0 ? RxBufSize : 1]{};
#endif
};
 
} /* namespace ove */
 
#endif /* CONFIG_OVE_UART */