C/C++ API Reference
Loading...
Searching...
No Matches
pw::clock_tree::ClockMcuxpressoFro Class Referencefinal

Overview

Class implementing an FRO clock source.

Inheritance diagram for pw::clock_tree::ClockMcuxpressoFro:
pw::clock_tree::ClockSource< ElementNonBlockingCannotFail > pw::clock_tree::ElementNonBlockingCannotFail pw::clock_tree::ElementNonBlockingMightFail pw::clock_tree::Element

Public Member Functions

constexpr ClockMcuxpressoFro (clock_fro_output_en_t fro_output)
 Constructor specifying the FRO divider output to manage.
 
- Public Member Functions inherited from pw::clock_tree::ElementNonBlockingCannotFail
void Acquire ()
 Acquire a reference to this clock tree element.
 
void Release ()
 Release a reference to this clock tree element.
 
- Public Member Functions inherited from pw::clock_tree::Element
constexpr Element (bool may_block)
 
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
 
Elementoperator= (const Element &)=delete
 
Elementoperator= (const Element &&)=delete
 
Status Acquire ()
 
Status Release ()
 
Status AcquireWith (Element &element_with)
 

Private Member Functions

Status DoEnable () final
 Enable this FRO divider.
 
Status DoDisable () final
 Disable this FRO divider.
 

Additional Inherited Members

- Static Public Attributes inherited from pw::clock_tree::ElementNonBlockingCannotFail
static constexpr bool kMayFail = false
 
- Static Public Attributes inherited from pw::clock_tree::ElementNonBlockingMightFail
static constexpr bool kMayBlock = false
 
static constexpr bool kMayFail = true
 
- Protected Member Functions inherited from pw::clock_tree::ElementNonBlockingMightFail
sync::InterruptSpinLocklock ()
 
- Protected Member Functions inherited from pw::clock_tree::Element
virtual Status DoAcquireLocked ()=0
 
virtual Status DoReleaseLocked ()=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 ()
 

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