Pigweed
 
Loading...
Searching...
No Matches
pw::clock_tree::ClockMcuxpressoAudioPll< ElementType > Class Template Reference

#include <clock_tree.h>

Inheritance diagram for pw::clock_tree::ClockMcuxpressoAudioPll< ElementType >:
pw::clock_tree::DependentElement< ElementType >

Public Member Functions

constexpr ClockMcuxpressoAudioPll (ElementType &source, const clock_audio_pll_config_t &config, uint8_t audio_pfd_divider)
 Constructor specifying the configuration for the enabled Audio PLL.
 
constexpr ClockMcuxpressoAudioPll (ElementType &source, audio_pll_src_t bypass_source)
 Constructor to place the Audio PLL into bypass mode.
 
- Public Member Functions inherited from pw::clock_tree::DependentElement< ElementType >
constexpr DependentElement (ElementType &source)
 Create a dependent clock tree element that depends on source.
 

Private Member Functions

Status DoEnable () override
 
Status DoDisable () override
 Disables the audio PLL logic.
 

Additional Inherited Members

- Protected Member Functions inherited from pw::clock_tree::DependentElement< ElementType >
Status UpdateSource (ElementType &new_source, bool permit_change_if_in_use)
 

Detailed Description

template<typename ElementType>
class pw::clock_tree::ClockMcuxpressoAudioPll< ElementType >

Class template implementing the audio pll clock element.

The Audio PLL can either operate in the enabled mode where the PLL and the phase fractional divider are enabled, or it can operate in bypass mode, where both PLL and phase fractional divider are clock gated. When the Audio PLL clock tree gets disabled, both PLL and phase fractional divider will be clock gated.

Template argument ElementType can be of class ElementBlocking or ElementNonBlockingCannotFail.

Member Function Documentation

◆ DoEnable()

template<typename ElementType >
Status pw::clock_tree::ClockMcuxpressoAudioPll< ElementType >::DoEnable ( )
inlineoverrideprivate

Configures and enables the audio PLL if config_ is set, otherwise places the audio PLL in bypass mode.


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