[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v9 5/9] docs/clocks: add device's clock documentation
From: |
Damien Hedde |
Subject: |
Re: [PATCH v9 5/9] docs/clocks: add device's clock documentation |
Date: |
Wed, 8 Apr 2020 12:06:10 +0200 |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.6.0 |
On 4/7/20 7:07 AM, Markus Armbruster wrote:
> Damien Hedde <address@hidden> 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 <address@hidden>
>> Reviewed-by: Alistair Francis <address@hidden>
>> Reviewed-by: Edgar E. Iglesias <address@hidden>
>> ---
>> 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``?
>
> [...]
>
Hi Markus,
*Clock* refer to the C type
> typedef struct Clock Clock;
I think I've put ``CLOCK`` in uppercase because, in practical, we only
use the upper case macro.
> #define TYPE_CLOCK "clock"
> #define CLOCK(obj) OBJECT_CHECK(Clock, (obj), TYPE_CLOCK)
I'm not sure what is the right terminology here. Maybe I can replace by
the following:
> The QOM name of a clock is ``"clock"`` (or the macro ``TYPE_CLOCK``).
The C type object is *Clock*.
Thanks,
Damien
- [PATCH v9 0/9] Clock framework API, Damien Hedde, 2020/04/06
- [PATCH v9 2/9] hw/core/clock-vmstate: define a vmstate entry for clock state, Damien Hedde, 2020/04/06
- [PATCH v9 3/9] qdev: add clock input&output support to devices., Damien Hedde, 2020/04/06
- [PATCH v9 1/9] hw/core/clock: introduce clock object, Damien Hedde, 2020/04/06
- [PATCH v9 4/9] qdev-clock: introduce an init array to ease the device construction, Damien Hedde, 2020/04/06
- [PATCH v9 5/9] docs/clocks: add device's clock documentation, Damien Hedde, 2020/04/06
- Re: [PATCH v9 5/9] docs/clocks: add device's clock documentation, Peter Maydell, 2020/04/17
- [PATCH v9 6/9] hw/misc/zynq_slcr: add clock generation for uarts, Damien Hedde, 2020/04/06
- [PATCH v9 9/9] qdev-monitor: print the device's clock with info qtree, Damien Hedde, 2020/04/06
- [PATCH v9 7/9] hw/char/cadence_uart: add clock support, Damien Hedde, 2020/04/06
- [PATCH v9 8/9] hw/arm/xilinx_zynq: connect uart clocks to slcr, Damien Hedde, 2020/04/06
- Re: [PATCH v9 0/9] Clock framework API, Peter Maydell, 2020/04/17