pw::clock_tree::ClockSourceNoOp Class Reference

#include <clock_tree.h>

Inheritance diagram for pw::clock_tree::ClockSourceNoOp:

Private Member Functions
pw::Status	DoEnable () final
	Function called when the clock tree element needs to get enabled.
pw::Status	DoDisable () final

Additional Inherited Members
Public Member Functions inherited from pw::clock_tree::Element
constexpr	Element (bool may_block=false)
uint32_t	ref_count () const
	Get reference count for this clock tree element.
bool	may_block () const
	Check whether acquiring or releasing the element may block.
	Element (const Element &)=delete
	Element (const Element &&)=delete
Element &	operator= (const Element &)=delete
Element &	operator= (const Element &&)=delete
Protected Member Functions inherited from pw::clock_tree::Element
virtual Status	Acquire ()=0
virtual Status	Release ()=0
uint32_t	IncRef ()
	Increment reference count and return incremented value.
uint32_t	DecRef ()
	Decrement reference count and return decremented value.
virtual Status	DoEnable ()=0
	Function called when the clock tree element needs to get enabled.
virtual Status	DoDisable ()

Detailed Description

Class that represents a no-op clock source clock tree element that can be used to satisfy the dependent source clock tree element dependency for clock source classes that expect a source clock tree element.

Member Function Documentation

DoDisable()

pw::Status pw::clock_tree::ClockSourceNoOp::DoDisable ( )

inlinefinalprivatevirtual

Function called when the clock tree element can get disabled.

Can be overridden by child class in case the clock tree element can be disabled to save power.

Reimplemented from pw::clock_tree::Element.

DoEnable()

pw::Status pw::clock_tree::ClockSourceNoOp::DoEnable ( )

inlinefinalprivatevirtual

Function called when the clock tree element needs to get enabled.

Implements pw::clock_tree::Element.

---

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

• pw_clock_tree/public/pw_clock_tree/clock_tree.h