PF1550 Driver
API reference
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
pf1550::FaultFlags Struct Reference

Bitset of latched fault flags. More...

#include <pf1550_diagnostics.hpp>

Public Member Functions

constexpr bool Any () const noexcept
 
constexpr bool Has (uint32_t mask) const noexcept
 
constexpr void Set (uint32_t mask) noexcept
 
constexpr void Clear (uint32_t mask) noexcept
 

Public Attributes

uint32_t value {0}
 

Static Public Attributes

static constexpr uint32_t kSw1Ls = 1u << 0
 
static constexpr uint32_t kSw1Hs = 1u << 1
 
static constexpr uint32_t kSw2Ls = 1u << 2
 
static constexpr uint32_t kSw2Hs = 1u << 3
 
static constexpr uint32_t kSw3Ls = 1u << 4
 
static constexpr uint32_t kSw3Hs = 1u << 5
 
static constexpr uint32_t kLdo1Fault = 1u << 8
 
static constexpr uint32_t kLdo2Fault = 1u << 9
 
static constexpr uint32_t kLdo3Fault = 1u << 10
 
static constexpr uint32_t kTempWarn = 1u << 12
 THERM110I: die crossed 110 °C.
 
static constexpr uint32_t kTempShdn = 1u << 13
 THERM125I: die crossed 125 °C.
 
static constexpr uint32_t kPwrOn = 1u << 16
 PWRON_I: power-on button event.
 
static constexpr uint32_t kVsysLow = 1u << 17
 LOW_SYS_WARN_I: VSYS crossed LOW_SYS_WARN.
 
static constexpr uint32_t kVsysOv = 1u << 18
 SYS_OVLO_I: VSYS crossed SYS_OVLO.
 
static constexpr uint32_t kWdiAssert = 1u << 19
 Never set: the PF1550 has no WDI interrupt bit.
 
static constexpr uint32_t kResetBmcu = 1u << 20
 Never set: the PF1550 has no RESETBMCU interrupt bit.
 
static constexpr uint32_t kChgFault = 1u << 24
 
static constexpr uint32_t kVbusInval = 1u << 25
 
static constexpr uint32_t kBattOv = 1u << 26
 
static constexpr uint32_t kI2cReadFail = 1u << 30
 
static constexpr uint32_t kI2cWriteFail = 1u << 31
 

Detailed Description

Bitset of latched fault flags.

Mirrors the union of all per-category STAT registers, normalised to a single 32-bit value for IPC and logging. Layout is stable — never reorder; append-only.

Member Function Documentation

◆ Any()

constexpr bool pf1550::FaultFlags::Any ( ) const
inlineconstexprnoexcept

◆ Clear()

constexpr void pf1550::FaultFlags::Clear ( uint32_t  mask)
inlineconstexprnoexcept

◆ Has()

constexpr bool pf1550::FaultFlags::Has ( uint32_t  mask) const
inlineconstexprnoexcept

◆ Set()

constexpr void pf1550::FaultFlags::Set ( uint32_t  mask)
inlineconstexprnoexcept

Member Data Documentation

◆ kBattOv

constexpr uint32_t pf1550::FaultFlags::kBattOv = 1u << 26
staticconstexpr

◆ kChgFault

constexpr uint32_t pf1550::FaultFlags::kChgFault = 1u << 24
staticconstexpr

◆ kI2cReadFail

constexpr uint32_t pf1550::FaultFlags::kI2cReadFail = 1u << 30
staticconstexpr

◆ kI2cWriteFail

constexpr uint32_t pf1550::FaultFlags::kI2cWriteFail = 1u << 31
staticconstexpr

◆ kLdo1Fault

constexpr uint32_t pf1550::FaultFlags::kLdo1Fault = 1u << 8
staticconstexpr

◆ kLdo2Fault

constexpr uint32_t pf1550::FaultFlags::kLdo2Fault = 1u << 9
staticconstexpr

◆ kLdo3Fault

constexpr uint32_t pf1550::FaultFlags::kLdo3Fault = 1u << 10
staticconstexpr

◆ kPwrOn

constexpr uint32_t pf1550::FaultFlags::kPwrOn = 1u << 16
staticconstexpr

PWRON_I: power-on button event.

◆ kResetBmcu

constexpr uint32_t pf1550::FaultFlags::kResetBmcu = 1u << 20
staticconstexpr

Never set: the PF1550 has no RESETBMCU interrupt bit.

◆ kSw1Hs

constexpr uint32_t pf1550::FaultFlags::kSw1Hs = 1u << 1
staticconstexpr

◆ kSw1Ls

constexpr uint32_t pf1550::FaultFlags::kSw1Ls = 1u << 0
staticconstexpr

◆ kSw2Hs

constexpr uint32_t pf1550::FaultFlags::kSw2Hs = 1u << 3
staticconstexpr

◆ kSw2Ls

constexpr uint32_t pf1550::FaultFlags::kSw2Ls = 1u << 2
staticconstexpr

◆ kSw3Hs

constexpr uint32_t pf1550::FaultFlags::kSw3Hs = 1u << 5
staticconstexpr

◆ kSw3Ls

constexpr uint32_t pf1550::FaultFlags::kSw3Ls = 1u << 4
staticconstexpr

◆ kTempShdn

constexpr uint32_t pf1550::FaultFlags::kTempShdn = 1u << 13
staticconstexpr

THERM125I: die crossed 125 °C.

◆ kTempWarn

constexpr uint32_t pf1550::FaultFlags::kTempWarn = 1u << 12
staticconstexpr

THERM110I: die crossed 110 °C.

◆ kVbusInval

constexpr uint32_t pf1550::FaultFlags::kVbusInval = 1u << 25
staticconstexpr

◆ kVsysLow

constexpr uint32_t pf1550::FaultFlags::kVsysLow = 1u << 17
staticconstexpr

LOW_SYS_WARN_I: VSYS crossed LOW_SYS_WARN.

◆ kVsysOv

constexpr uint32_t pf1550::FaultFlags::kVsysOv = 1u << 18
staticconstexpr

SYS_OVLO_I: VSYS crossed SYS_OVLO.

◆ kWdiAssert

constexpr uint32_t pf1550::FaultFlags::kWdiAssert = 1u << 19
staticconstexpr

Never set: the PF1550 has no WDI interrupt bit.

◆ value

uint32_t pf1550::FaultFlags::value {0}

The documentation for this struct was generated from the following file: