/**
 * Serial.h
 *
 * Copyright 2022 mikee47 <mike@sillyhouse.net>
 *
 * This file is part of the IOControl Library
 *
 * This library is free software: you can redistribute it and/or modify it under the terms of the
 * GNU General Public License as published by the Free Software Foundation, version 3 or later.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with this library.
 * If not, see <https://www.gnu.org/licenses/>.
 *
 ****/

#pragma once

#include "Error.h"
#include <driver/uart.h>

namespace IO
{
/**
 * @brief Wrapper class for the UART driver
 *
 * RS485 requires efficient burst transfer access to the serial hardware, so uses the UART driver directly.
 */
class Serial
{
public:
	struct Config {
		uint32_t baudrate;
		smg_uart_format_t format;

		bool operator==(const Config& other) const
		{
			return baudrate == other.baudrate && format == other.format;
		}
	};

	virtual ~Serial()
	{
		close();
	}

	/**
	 * @brief Initialise the serial port with a default configuration
	 */
	ErrorCode open(uint8_t uart_nr, uint8_t txPin = UART_PIN_DEFAULT, uint8_t rxPin = UART_PIN_DEFAULT);

	/**
	 * @brief Close the port
	 */
	void close();

	/**
	 * @brief Set required buffer sizes
	 *
	 * Serial buffers are expanded if required, but not reduced.
	 *
	 * @param rxSize
	 * @param txSize
	 * @retval bool true on success
	 */
	bool resizeBuffers(size_t rxSize, size_t txSize);

	void setCallback(smg_uart_callback_t callback, void* param)
	{
		smg_uart_set_callback(uart, callback, param);
	}

	void setBreak(bool state)
	{
		smg_uart_set_break(uart, state);
	}

	size_t available() const
	{
		return smg_uart_rx_available(uart);
	}

	size_t read(void* buffer, size_t size)
	{
		return smg_uart_read(uart, buffer, size);
	}

	size_t write(const void* data, size_t len)
	{
		return smg_uart_write(uart, data, len);
	}

	void swap(uint8_t txPin = 1)
	{
		smg_uart_swap(uart, txPin);
	}

	void clear(smg_uart_mode_t mode = UART_FULL)
	{
		smg_uart_flush(uart, mode);
	}

	const Config& getConfig() const
	{
		return activeConfig;
	}

	void setConfig(const Config& cfg);

private:
	Config activeConfig{9600, UART_8N1};
	smg_uart_t* uart{nullptr};
};

} // namespace IO