tangara-fw/src/drivers/include/samd.hpp

/*
 * Copyright 2023 jacqueline <me@jacqueline.id.au>
 *
 * SPDX-License-Identifier: GPL-3.0-only
 */

#pragma once

#include <optional>

namespace drivers {

class Samd {
 public:
  static auto Create() -> Samd* { return new Samd(); }

  Samd();
  ~Samd();

  enum class ChargeStatus {
    // There is no battery plugged into the device.
    kNoBattery,
    // The battery is discharging, and the current voltage level is very low.
    kBatteryCritical,
    // The battery is discharging.
    kDischarging,
    // The battery is charging over a low-current USB connection
    kChargingRegular,
    // The battery is charging over a high-current USB connection
    kChargingFast,
    // The battery is full charged, and we are still plugged in.
    kFullCharge,
  };

  auto ReadChargeStatus() -> std::optional<ChargeStatus>;

  enum class UsbStatus {
    // There is no compatible usb host attached.
    kDetached,
    // There is a compatible usb host attached, but USB MSC is not currently
    // in use by the SAMD.
    kAttachedIdle,
    // The SAMD is currently exposing the SD card via USB MSC.
    kAttachedMounted,
  };

  auto ReadUsbStatus() -> UsbStatus;

  auto ResetToFlashSamd() -> void;
};

}  // namespace drivers