xref: /aosp_15_r20/external/pigweed/pw_clock_tree/api.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1*61c4878aSAndroid Build Coastguard Worker.. _module-pw_clock_tree-reference:
2*61c4878aSAndroid Build Coastguard Worker
3*61c4878aSAndroid Build Coastguard Worker----
4*61c4878aSAndroid Build Coastguard WorkerAPIs
5*61c4878aSAndroid Build Coastguard Worker----
6*61c4878aSAndroid Build Coastguard Worker.. pigweed-module-subpage::
7*61c4878aSAndroid Build Coastguard Worker   :name: pw_clock_tree
8*61c4878aSAndroid Build Coastguard Worker
9*61c4878aSAndroid Build Coastguard Worker.. _module-pw_clock_tree-references:
10*61c4878aSAndroid Build Coastguard Worker
11*61c4878aSAndroid Build Coastguard WorkerClockTree
12*61c4878aSAndroid Build Coastguard Worker=========
13*61c4878aSAndroid Build Coastguard Worker.. doxygenclass:: pw::clock_tree::ClockTree
14*61c4878aSAndroid Build Coastguard Worker   :members:
15*61c4878aSAndroid Build Coastguard Worker
16*61c4878aSAndroid Build Coastguard Worker
17*61c4878aSAndroid Build Coastguard WorkerElement
18*61c4878aSAndroid Build Coastguard Worker=======
19*61c4878aSAndroid Build Coastguard Worker.. doxygenclass:: pw::clock_tree::Element
20*61c4878aSAndroid Build Coastguard Worker   :members:
21*61c4878aSAndroid Build Coastguard Worker   :protected-members:
22*61c4878aSAndroid Build Coastguard Worker
23*61c4878aSAndroid Build Coastguard WorkerElementBlocking
24*61c4878aSAndroid Build Coastguard Worker===============
25*61c4878aSAndroid Build Coastguard Worker.. doxygenclass:: pw::clock_tree::ElementBlocking
26*61c4878aSAndroid Build Coastguard Worker   :members:
27*61c4878aSAndroid Build Coastguard Worker
28*61c4878aSAndroid Build Coastguard WorkerElementNonBlockingCannotFail
29*61c4878aSAndroid Build Coastguard Worker============================
30*61c4878aSAndroid Build Coastguard Worker.. doxygenclass:: pw::clock_tree::ElementNonBlockingCannotFail
31*61c4878aSAndroid Build Coastguard Worker   :members:
32*61c4878aSAndroid Build Coastguard Worker
33*61c4878aSAndroid Build Coastguard WorkerElementNonBlockingMightFail
34*61c4878aSAndroid Build Coastguard Worker===========================
35*61c4878aSAndroid Build Coastguard Worker.. doxygenclass:: pw::clock_tree::ElementNonBlockingMightFail
36*61c4878aSAndroid Build Coastguard Worker   :members:
37*61c4878aSAndroid Build Coastguard Worker
38*61c4878aSAndroid Build Coastguard WorkerClockSource
39*61c4878aSAndroid Build Coastguard Worker===========
40*61c4878aSAndroid Build Coastguard Worker.. doxygenclass:: pw::clock_tree::ClockSource
41*61c4878aSAndroid Build Coastguard Worker   :members:
42*61c4878aSAndroid Build Coastguard Worker
43*61c4878aSAndroid Build Coastguard WorkerClockSourceNoOp
44*61c4878aSAndroid Build Coastguard Worker===============
45*61c4878aSAndroid Build Coastguard Worker.. doxygenclass:: pw::clock_tree::ClockSourceNoOp
46*61c4878aSAndroid Build Coastguard Worker
47*61c4878aSAndroid Build Coastguard WorkerDependentElement
48*61c4878aSAndroid Build Coastguard Worker================
49*61c4878aSAndroid Build Coastguard Worker.. doxygenclass:: pw::clock_tree::DependentElement
50*61c4878aSAndroid Build Coastguard Worker   :members:
51*61c4878aSAndroid Build Coastguard Worker   :protected-members:
52*61c4878aSAndroid Build Coastguard Worker
53*61c4878aSAndroid Build Coastguard WorkerClockDivider
54*61c4878aSAndroid Build Coastguard Worker============
55*61c4878aSAndroid Build Coastguard Worker.. doxygenclass:: pw::clock_tree::ClockDivider
56*61c4878aSAndroid Build Coastguard Worker   :members:
57*61c4878aSAndroid Build Coastguard Worker
58*61c4878aSAndroid Build Coastguard WorkerClockDividerElement
59*61c4878aSAndroid Build Coastguard Worker===================
60*61c4878aSAndroid Build Coastguard Worker.. doxygenclass:: pw::clock_tree::ClockDividerElement
61*61c4878aSAndroid Build Coastguard Worker   :members:
62*61c4878aSAndroid Build Coastguard Worker   :protected-members:
63*61c4878aSAndroid Build Coastguard Worker
64*61c4878aSAndroid Build Coastguard WorkerElementController
65*61c4878aSAndroid Build Coastguard Worker=================
66*61c4878aSAndroid Build Coastguard Worker.. doxygenclass:: pw::clock_tree::ElementController
67*61c4878aSAndroid Build Coastguard Worker   :members:
68