Pigweed
C/C++ API Reference
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Loading...
Searching...
No Matches
Public Member Functions | List of all members
pw::clock_tree::ClockDivider Class Referenceabstract
Inheritance diagram for pw::clock_tree::ClockDivider:
pw::clock_tree::ClockDividerElement< ElementType > pw::clock_tree::ClockMcuxpressoDivider< ElementType >

Public Member Functions

constexpr ClockDivider (Element &element)
 
virtual Status Set (uint32_t divider)=0
 
Elementelement () const
 Return the element implementing this interface.
 

Detailed Description

Abstract class of the clock divider specific interface.

The clock divider interface allows APIs to accept a ClockDivider element, if they want to use the ClockTree's SetDividerValue method. They can use the element method to call the ClockTree's Acquire and Release methods.

Member Function Documentation

◆ Set()

virtual Status pw::clock_tree::ClockDivider::Set ( uint32_t  divider)
pure virtual

Set divider value.

The divider value will get updated as part of this method if the clock divider is currently active, otherwise the new divider value will be configured when the clock divider gets enabled next.

Implemented in pw::clock_tree::ClockDividerElement< ElementType >.


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