ds3231/ds3231.hpp

#pragma once

#include "../clock.hpp"

#include <stddef.h>

#include "../i2c/i2c.hpp"
#include "../type/type.hpp"

#include "registers.hpp"

namespace rtc {

struct Date {
	uint16_t year;
	uint8_t month;
	uint8_t day;
};

struct Time {
	uint8_t hour;
	uint8_t minute;
	uint8_t second;
};

struct DateTime : Date, Time {
};

template <typename I2cDriver, bool SetDayOfWeek = true>
class DS3231 {
  public:
	static constexpr auto I2C_ADDRESS = 0x68;

	static constexpr auto TIME_REG_ADDR = 0x00;
	static constexpr auto ALARM1_REG_ADDR = 0x07;
	static constexpr auto ALARM2_REG_ADDR = 0x0B;
	static constexpr auto CONTROL_REG_ADDR = 0x0E;
	static constexpr auto CONTROL_STATUS_REG_ADDR = 0x0F;
	static constexpr auto AGING_OFFSET_REG_ADDR = 0x10;
	static constexpr auto TEMP_REG_ADDR = 0x11;

	// Construction does not call init and is only available for convenience
	DS3231() = default;

	// Moving and copying ds3231 objects is not supported
	DS3231(const DS3231 &) = delete;
	DS3231(DS3231 &&) = delete;
	DS3231 &operator=(const DS3231 &) = delete;
	DS3231 &operator=(DS3231 &&) = delete;

	static inline void init()
	{
		I2cDriver::init();
	}

	static auto getDate()
	{
		const auto timeReg = readRegister<TIME_REG_ADDR>();

		Date date;
		date.year = timeReg.getYear();
		date.month = timeReg.getMonth();
		date.day = timeReg.getDate();
		return date;
	}
	static auto getTime()
	{
		const auto timeReg = readRegister<TIME_REG_ADDR>();

		Time time;
		time.hour = timeReg.getHours();
		time.minute = timeReg.getMinutes();
		time.second = timeReg.getSeconds();
		return time;
	}
	static auto getDateTime()
	{
		const auto timeReg = readRegister<TIME_REG_ADDR>();

		DateTime dateTime;
		dateTime.year = timeReg.getYear();
		dateTime.month = timeReg.getMonth();
		dateTime.day = timeReg.getDate();
		dateTime.hour = timeReg.getHours();
		dateTime.minute = timeReg.getMinutes();
		dateTime.second = timeReg.getSeconds();
		return dateTime;
	}

	static void setDate(const Date &date)
	{
		detail::TimeReg timeReg;
		timeReg.setYear(date.year);
		timeReg.setMonth(date.month);
		timeReg.setDate(date.day);
		if constexpr (SetDayOfWeek)
			timeReg.setDay(calcDayOfWeek(date.year, date.month, date.day) + 1);

		constexpr auto DATE_START_OFFSET = offsetof(detail::TimeReg, day);
		constexpr auto DATE_END_OFFSET = offsetof(detail::TimeReg, year);

		writePartialRegister<TIME_REG_ADDR, DATE_START_OFFSET, DATE_END_OFFSET>(timeReg);
	}
	static void setTime(const Time &time) {}
	static void setDateTime(const DateTime &dateTime) {}

  private:
	template <uint8_t Address, typename Register>
	static Register readRegisterHelper()
	{
		I2cDriver::template start<I2C_ADDRESS>(false);
		I2cDriver::write(Address);
		I2cDriver::stop();

		Register reg;
		I2cDriver::template start<I2C_ADDRESS>(true);
		I2cDriver::template readBytes<sizeof(Register)>(reinterpret_cast<uint8_t *>(&reg));
		I2cDriver::stop();
		return reg;
	}

	template <uint8_t Address>
	static auto readRegister()
	{
		if constexpr (Address == TIME_REG_ADDR) {
			return readRegisterHelper<Address, detail::TimeReg>();
		} else if constexpr (Address == ALARM1_REG_ADDR) {
			return readRegisterHelper<Address, detail::Alarm1Reg>();
		} else if constexpr (Address == ALARM2_REG_ADDR) {
			return readRegisterHelper<Address, detail::Alarm2Reg>();
		} else if constexpr (Address == CONTROL_REG_ADDR) {
			return readRegisterHelper<Address, detail::ControlReg>();
		} else if constexpr (Address == CONTROL_STATUS_REG_ADDR) {
			return readRegisterHelper<Address, detail::ControlStatusReg>();
		} else if constexpr (Address == AGING_OFFSET_REG_ADDR) {
			return readRegisterHelper<Address, detail::AgingOffsetReg>();
		} else if constexpr (Address == TEMP_REG_ADDR) {
			return readRegisterHelper<Address, detail::TempReg>();
		} else {
			static_assert(type::always_false_v<decltype(Address)>, "Invalid register address");
		}
	}

	template <uint8_t Address, uint8_t StartOffset, uint8_t EndOffset, typename Register>
	static void writePartialRegister(const Register &reg)
	{
		static_assert(StartOffset <= EndOffset, "Invalid offset range");
		static_assert(StartOffset < sizeof(Register), "Start offset out of bounds");
		static_assert(EndOffset < sizeof(Register), "End offset out of bounds");

		constexpr auto WRITE_SIZE = EndOffset + 1 - StartOffset;
		static_assert(StartOffset + WRITE_SIZE <= sizeof(Register), "Writing out of bounds");

		if constexpr (Address == TIME_REG_ADDR) {
			static_assert(type::is_same_v<Register, detail::TimeReg>, "Invalid register type");
		} else if constexpr (Address == ALARM1_REG_ADDR) {
			static_assert(type::is_same_v<Register, detail::Alarm1Reg>, "Invalid register type");
		} else if constexpr (Address == ALARM2_REG_ADDR) {
			static_assert(type::is_same_v<Register, detail::Alarm2Reg>, "Invalid register type");
		} else if constexpr (Address == CONTROL_REG_ADDR) {
			static_assert(type::is_same_v<Register, detail::ControlReg>, "Invalid register type");
		} else if constexpr (Address == CONTROL_STATUS_REG_ADDR) {
			static_assert(type::is_same_v<Register, detail::ControlStatusReg>, "Invalid register type");
		} else if constexpr (Address == AGING_OFFSET_REG_ADDR) {
			static_assert(type::is_same_v<Register, detail::AgingOffsetReg>, "Invalid register type");
		} else if constexpr (Address == TEMP_REG_ADDR) {
			static_assert(type::is_same_v<Register, detail::TempReg>, "Invalid register type");
		} else {
			static_assert(type::always_false_v<Register>, "Invalid register address");
		}

		I2cDriver::template start<I2C_ADDRESS>(false);
		I2cDriver::write(Address + StartOffset);
		I2cDriver::template writeBytes<WRITE_SIZE>(reinterpret_cast<const uint8_t *>(&reg) + StartOffset);
		I2cDriver::stop();
	}

	static uint8_t calcDayOfWeek(uint16_t year, uint8_t month, uint16_t day)
	{
		day += month < 3 ? year-- : year - 2;
		const auto dayOfWeek = (23 * month / 9 + day + 4 + year / 4 - year / 100 + year / 400);
		return dayOfWeek % 7;
	}
};

} // namespace rtc