Damien Hedde <damien.he...@greensocs.com> writes: > Add the documentation about the clock inputs and outputs in devices. > > This is based on the original work of Frederic Konrad. > > Signed-off-by: Damien Hedde <damien.he...@greensocs.com> > Reviewed-by: Alistair Francis <alistair.fran...@wdc.com> > Reviewed-by: Edgar E. Iglesias <edgar.igles...@xilinx.com> > --- > v9: > + fix a few typos (Alistair) > > v8: > + fix list indentation > + reduce title size > > v7: > + update ClockIn/Out types > + switch to rst format > --- > docs/devel/clocks.rst | 360 ++++++++++++++++++++++++++++++++++++++++++ > docs/devel/index.rst | 1 + > 2 files changed, 361 insertions(+) > create mode 100644 docs/devel/clocks.rst > > diff --git a/docs/devel/clocks.rst b/docs/devel/clocks.rst > new file mode 100644 > index 0000000000..ead9f55561 > --- /dev/null > +++ b/docs/devel/clocks.rst > @@ -0,0 +1,360 @@ > +Modeling a clock tree in QEMU > +============================= > + > +What are clocks > +--------------- > + > +Clocks are QOM objects developed for the purpose of modeling the > +distribution of clocks in QEMU. > + > +They allow us to model the clock distribution of a platform and detect > +configuration errors in the clock tree such as badly configured PLL, clock > +source selection or disabled clock. > + > +The object is *Clock* and its QOM name is ``CLOCK``.
PATCH 1 has #define TYPE_CLOCK "clock" Ignorant question: how is this related to *Clock* and ``CLOCK``? [...]