pf1550.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <array>
#include <cstddef>
#include <cstdint>
#include <span>
 
#include "pf1550_diagnostics.hpp"
#include "pf1550_i2c_interface.hpp"
#include "pf1550_profiles.hpp"
#include "pf1550_registers.hpp"
#include "pf1550_voltage_tables.hpp"
#include "pf1550_version.h"
 
namespace pf1550 {
 
template <typename BusType>
class PF1550 {
public:
  enum class Error : uint16_t {
    None             = 0,
    I2cWrite         = 1 << 0, 
    I2cRead          = 1 << 1, 
    InvalidParam     = 1 << 2, 
    DeviceNotFound   = 1 << 3, 
    NotInitialized   = 1 << 4, 
    WrongDeviceId    = 1 << 5, 
    ProfileApply     = 1 << 6, 
    DiagnosticRead   = 1 << 7, 
    SelfTestFailed   = 1 << 8, 
  };
 
  // ---------------------------------------------------------------------------
  // Construction / lifecycle
  // ---------------------------------------------------------------------------
 
  PF1550(BusType* bus, uint8_t address = kDefaultI2cAddress) noexcept;
 
  bool EnsureInitialized() noexcept;
 
  bool IsInitialized() const noexcept { return initialized_; }
 
  uint8_t GetI2cAddress() const noexcept { return address_; }
 
  // ---------------------------------------------------------------------------
  // Identity
  // ---------------------------------------------------------------------------
 
  bool ReadDeviceId(uint8_t& id) noexcept;
 
  bool VerifyDevice() noexcept;
 
  // ---------------------------------------------------------------------------
  // Raw register access
  // ---------------------------------------------------------------------------
 
  bool ReadRegister(Register reg, uint8_t& value) noexcept;
 
  bool WriteRegister(Register reg, uint8_t value) noexcept;
 
  // ---------------------------------------------------------------------------
  // Profile application
  // ---------------------------------------------------------------------------
 
  bool ApplyProfile(std::span<const profiles::RegisterWrite> profile) noexcept;
 
  bool ApplyPortentaH7DefaultProfile() noexcept;
 
  bool ApplyPortentaH7CarrierProfile() noexcept;
 
  // ---------------------------------------------------------------------------
  // Power mode / strap GPIOs
  // ---------------------------------------------------------------------------
 
  bool SetPowerMode(PowerMode mode) noexcept;
 
  bool SetUsbRails(bool vbus_en, bool otg_en) noexcept;
 
  // ---------------------------------------------------------------------------
  // Status / OTP
  // ---------------------------------------------------------------------------
 
  bool ReadPmicStatus(uint8_t& status) noexcept;
 
  bool ReadPmicState(PmicState& state) noexcept;
 
  bool ReadChargerState(ChargerState& state, uint8_t* raw_reg = nullptr) noexcept;
 
  bool ReadOtpByte(uint8_t otp_addr, uint8_t& value) noexcept;
 
  bool ReadOtpRegion(uint8_t* buffer, size_t len, uint8_t start = OtpRegion::kStart) noexcept;
 
  // ---------------------------------------------------------------------------
  // Voltage / current configuration
  // ---------------------------------------------------------------------------
 
  bool SetSwVoltage(uint8_t sw_index, SwVoltageCode run_code) noexcept;
  bool SetSwVoltageMv(uint8_t sw_index, uint16_t mv) noexcept;
 
  bool SetLdoVoltage(uint8_t ldo_index, LdoVoltageCode code) noexcept;
 
  bool SetVbusCurrentLimitMa(uint16_t limit_ma) noexcept;
 
  // ---------------------------------------------------------------------------
  // Interrupt management
  // ---------------------------------------------------------------------------
 
  bool ReadInterruptCategory(uint8_t& category) noexcept;
 
  bool ReadLatchedFaults(FaultFlags& faults) noexcept;
 
  bool ClearLatchedFaults() noexcept;
 
  bool SetInterruptMaskAll(bool masked) noexcept;
 
  // ---------------------------------------------------------------------------
  // Diagnostics / self-test
  // ---------------------------------------------------------------------------
 
  bool ReadDiagnosticSnapshot(DiagnosticSnapshot& out) noexcept;
 
  bool RefreshStatusSnapshot(DiagnosticSnapshot& snap) noexcept;
 
  bool RunPowerSelfTest(SelfTestResult& out) noexcept;
 
  // ---------------------------------------------------------------------------
  // Driver-internal error tracking
  // ---------------------------------------------------------------------------
 
  uint16_t GetErrorFlags() const noexcept { return error_flags_; }
 
  void ClearErrorFlags(uint16_t mask = 0xFFFF) noexcept {
    error_flags_ &= static_cast<uint16_t>(~mask);
  }
 
  void SetSwDvsEnabled(uint8_t sw_index, bool enabled) noexcept {
    if (sw_index == 1U || sw_index == 2U) {
      sw_dvs_enabled_[sw_index - 1U] = enabled;
    }
  }
 
  static constexpr const char* GetDriverVersion() noexcept { return HF_PF1550_VERSION; }
 
private:
  bool writeReg8(uint8_t reg, uint8_t value) noexcept;
  bool readReg8(uint8_t reg, uint8_t& value) noexcept;
  void setError(Error e) noexcept { error_flags_ |= static_cast<uint16_t>(e); }
 
  // Snapshot helpers (templated to keep the header-only interface tidy).
  bool fillRailSnapshot(DiagnosticSnapshot& snap) noexcept;
  bool fillFaultSnapshot(DiagnosticSnapshot& snap) noexcept;
 
  BusType* bus_;
  uint8_t  address_;
  bool     initialized_;
  uint16_t error_flags_;
  bool     sw_dvs_enabled_[2]{false, false};  
};
 
} // namespace pf1550
 
#include "../src/pf1550.ipp"