PmicIrqBase Class Reference

#include <PmicIrqBase.hpp>

Inheritance diagram for PmicIrqBase:

Public Member Functions
virtual	~PmicIrqBase ()=default
virtual bool	enable (uint64_t mask)=0
	Enable interrupts.
virtual bool	disable (uint64_t mask)=0
	Disable interrupts.
virtual uint64_t	readStatus (bool clear=true)=0
	Read interrupt status.
virtual bool	clearStatus ()=0
	Clear interrupt status.

Detailed Description

Definition at line 41 of file PmicIrqBase.hpp.

Constructor & Destructor Documentation

~PmicIrqBase()

virtual PmicIrqBase::~PmicIrqBase ( )

virtualdefault

Member Function Documentation

clearStatus()

virtual bool PmicIrqBase::clearStatus ( )

pure virtual

Clear interrupt status.

Return values

True	on success, false on failure.

Implemented in AXP1xxIrq< Regs >, AXP1xxIrq< axp192_regs >, AXP1xxIrq< axp202_regs >, AXP2101Irq, and AXP517Irq.

disable()

virtual bool PmicIrqBase::disable ( uint64_t  mask )

pure virtual

Disable interrupts.

Note

The mask value is different for each chip and should be defined in the subclass.

Parameters

mask	Bitmask of interrupts to disable.

Return values

True	on success, false on failure.

Implemented in AXP1xxIrq< Regs >, AXP1xxIrq< axp192_regs >, AXP1xxIrq< axp202_regs >, AXP2101Irq, and AXP517Irq.

enable()

virtual bool PmicIrqBase::enable ( uint64_t  mask )

pure virtual

Enable interrupts.

Note

The mask value is different for each chip and should be defined in the subclass.

Parameters

mask	Bitmask of interrupts to enable.

Return values

True	on success, false on failure.

Implemented in AXP1xxIrq< Regs >, AXP1xxIrq< axp192_regs >, AXP1xxIrq< axp202_regs >, AXP2101Irq, and AXP517Irq.

readStatus()

virtual uint64_t PmicIrqBase::readStatus ( bool  clear = true )

pure virtual

Read interrupt status.

Parameters

clear

True to clear the status after reading, false to keep it.

Return values

Bitmask

of active interrupts.

Implemented in AXP1xxIrq< Regs >, AXP1xxIrq< axp192_regs >, AXP1xxIrq< axp202_regs >, AXP2101Irq, and AXP517Irq.

---

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

• PmicIrqBase.hpp