PmicButtonBase Class Reference

#include <PmicButtonBase.hpp>

Inheritance diagram for PmicButtonBase:

Public Member Functions
virtual	~PmicButtonBase ()=default
	Virtual destructor.
virtual bool	setOnDurationMs (uint16_t ms)=0
	Set button power-on press duration.
virtual bool	getOnDurationMs (uint16_t &ms) const =0
	Get button power-on press duration.
virtual bool	setOffDurationMs (uint16_t ms)=0
	Set button power-off press duration.
virtual bool	getOffDurationMs (uint16_t &ms) const =0
	Get button power-off press duration.
virtual bool	setIrqDurationMs (uint16_t ms)=0
	Set button IRQ trigger duration.
virtual bool	getIrqDurationMs (uint16_t &ms) const =0
	Get button IRQ trigger duration.

Detailed Description

Definition at line 44 of file PmicButtonBase.hpp.

Constructor & Destructor Documentation

~PmicButtonBase()

virtual PmicButtonBase::~PmicButtonBase ( )

virtualdefault

Virtual destructor.

Member Function Documentation

getIrqDurationMs()

virtual bool PmicButtonBase::getIrqDurationMs ( uint16_t &  ms ) const

pure virtual

Get button IRQ trigger duration.

Retrieves the current button press duration configured for interrupt generation.

Parameters

[out]

ms

Output variable receiving the duration in milliseconds

Returns

true on success, false on failure

Implemented in AXP1xxPwron< Regs >, AXP1xxPwron< axp192_regs >, AXP1xxPwron< axp202_regs >, AXP2101Pwron, and AXP517Pwron.

getOffDurationMs()

virtual bool PmicButtonBase::getOffDurationMs ( uint16_t &  ms ) const

pure virtual

Get button power-off press duration.

Retrieves the current minimum button press duration required to trigger a power-off event.

Parameters

[out]

ms

Output variable receiving the duration in milliseconds

Returns

true on success, false on failure

Implemented in AXP1xxPwron< Regs >, AXP1xxPwron< axp192_regs >, AXP1xxPwron< axp202_regs >, AXP2101Pwron, and AXP517Pwron.

getOnDurationMs()

virtual bool PmicButtonBase::getOnDurationMs ( uint16_t &  ms ) const

pure virtual

Get button power-on press duration.

Retrieves the current minimum button press duration required to trigger a power-on event.

Parameters

[out]

ms

Output variable receiving the duration in milliseconds

Returns

true on success, false on failure

Implemented in AXP1xxPwron< Regs >, AXP1xxPwron< axp192_regs >, AXP1xxPwron< axp202_regs >, AXP2101Pwron, and AXP517Pwron.

setIrqDurationMs()

virtual bool PmicButtonBase::setIrqDurationMs ( uint16_t  ms )

pure virtual

Set button IRQ trigger duration.

Configures the duration for button-related interrupt generation. Some PMICs generate IRQs on button press, release, or both.

Parameters

ms	Duration in milliseconds (chip-specific valid range)

Returns

true on success, false on failure

Note

Valid range is chip-specific

Implemented in AXP1xxPwron< Regs >, AXP1xxPwron< axp192_regs >, AXP1xxPwron< axp202_regs >, AXP2101Pwron, and AXP517Pwron.

setOffDurationMs()

virtual bool PmicButtonBase::setOffDurationMs ( uint16_t  ms )

pure virtual

Set button power-off press duration.

Configures the minimum duration the button must be pressed (held low/active) to trigger a power-off event.

Parameters

ms	Duration in milliseconds (chip-specific valid range)

Returns

true on success, false on failure

Note

Valid range is chip-specific

Implemented in AXP1xxPwron< Regs >, AXP1xxPwron< axp192_regs >, AXP1xxPwron< axp202_regs >, AXP2101Pwron, and AXP517Pwron.

setOnDurationMs()

virtual bool PmicButtonBase::setOnDurationMs ( uint16_t  ms )

pure virtual

Set button power-on press duration.

Configures the minimum duration the button must be pressed (held low/active) to trigger a power-on event.

Parameters

ms	Duration in milliseconds (chip-specific valid range)

Returns

true on success, false on failure

Note

Valid range is chip-specific

Implemented in AXP1xxPwron< Regs >, AXP1xxPwron< axp192_regs >, AXP1xxPwron< axp202_regs >, AXP2101Pwron, and AXP517Pwron.

---

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

• PmicButtonBase.hpp