AXP1xxPwron< Regs > Class Template Reference

#include <AXP1xxPwron.hpp>

Inheritance diagram for AXP1xxPwron< Regs >:

Public Member Functions
	AXP1xxPwron (SensorCommWrapper &core)
	Construct power-on key control interface.
bool	setOnDurationMs (uint16_t ms) override
	Set the power-on press duration threshold.
bool	getOnDurationMs (uint16_t &ms) const override
	Get the power-on press duration threshold.
bool	setOffDurationMs (uint16_t ms) override
	Set the power-off press duration threshold.
bool	getOffDurationMs (uint16_t &ms) const override
	Get the power-off press duration threshold.
bool	setIrqDurationMs (uint16_t ms) override
	Set the interrupt-trigger press duration threshold.
bool	getIrqDurationMs (uint16_t &ms) const override
	Get the interrupt-trigger press duration threshold.
Public Member Functions inherited from PmicButtonBase
virtual	~PmicButtonBase ()=default
	Virtual destructor.

Detailed Description

template<typename Regs>
class AXP1xxPwron< Regs >

Definition at line 45 of file AXP1xxPwron.hpp.

Constructor & Destructor Documentation

AXP1xxPwron()

template<typename Regs >

AXP1xxPwron< Regs >::AXP1xxPwron ( SensorCommWrapper &  core )

inlineexplicit

Construct power-on key control interface.

Parameters

core	Reference to the I2C communication wrapper.

Definition at line 52 of file AXP1xxPwron.hpp.

Member Function Documentation

getIrqDurationMs()

template<typename Regs >

bool AXP1xxPwron< Regs >::getIrqDurationMs ( uint16_t &  ms ) const

inlineoverridevirtual

Get the interrupt-trigger press duration threshold.

Parameters

[out]

ms

IRQ-level duration in milliseconds.

Return values

true	Value was read successfully.
false	I2C communication failed.

Implements PmicButtonBase.

Definition at line 144 of file AXP1xxPwron.hpp.

References SensorCommWrapper::readReg().

getOffDurationMs()

template<typename Regs >

bool AXP1xxPwron< Regs >::getOffDurationMs ( uint16_t &  ms ) const

inlineoverridevirtual

Get the power-off press duration threshold.

Parameters

[out]

ms

Off-level duration in milliseconds.

Return values

true	Value was read successfully.
false	I2C communication failed.

Implements PmicButtonBase.

Definition at line 111 of file AXP1xxPwron.hpp.

References SensorCommWrapper::readReg().

getOnDurationMs()

template<typename Regs >

bool AXP1xxPwron< Regs >::getOnDurationMs ( uint16_t &  ms ) const

inlineoverridevirtual

Get the power-on press duration threshold.

Parameters

[out]

ms

On-level duration in milliseconds.

Return values

true	Value was read successfully.
false	I2C communication failed.

Implements PmicButtonBase.

Definition at line 78 of file AXP1xxPwron.hpp.

References SensorCommWrapper::readReg().

setIrqDurationMs()

template<typename Regs >

bool AXP1xxPwron< Regs >::setIrqDurationMs ( uint16_t  ms )

inlineoverridevirtual

Set the interrupt-trigger press duration threshold.

Configures POK_SET bits 4-5. The closest valid value is selected.

Parameters

ms	Desired IRQ-level duration in milliseconds. Valid values: 1000, 1500, 2000, 2500.

Return values

true	IRQ-level was set successfully.
false	I2C communication failed.

Implements PmicButtonBase.

Definition at line 130 of file AXP1xxPwron.hpp.

References SensorCommWrapper::updateBits().

setOffDurationMs()

template<typename Regs >

bool AXP1xxPwron< Regs >::setOffDurationMs ( uint16_t  ms )

inlineoverridevirtual

Set the power-off press duration threshold.

Configures POK_SET bits 2-3. The closest valid value is selected.

Parameters

ms	Desired off-level duration in milliseconds. Valid values: 4000, 6000, 8000, 10000.

Return values

true	Off-level was set successfully.
false	I2C communication failed.

Implements PmicButtonBase.

Definition at line 97 of file AXP1xxPwron.hpp.

References SensorCommWrapper::updateBits().

setOnDurationMs()

template<typename Regs >

bool AXP1xxPwron< Regs >::setOnDurationMs ( uint16_t  ms )

inlineoverridevirtual

Set the power-on press duration threshold.

Configures POK_SET bits 0-1. The closest valid value is selected.

Parameters

ms	Desired on-level duration in milliseconds. Valid values: 128, 512, 1000, 2000.

Return values

true	On-level was set successfully.
false	I2C communication failed.

Implements PmicButtonBase.

Definition at line 64 of file AXP1xxPwron.hpp.

References SensorCommWrapper::updateBits().

---

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

• AXP1xxPwron.hpp