Re: [PATCH v13 02/13] doc: Add doc for the Ingenic TCU hardware

From: Thomas Gleixner
Date: Tue Jun 25 2019 - 02:44:44 EST


Paul,

On Tue, 25 Jun 2019, Paul Cercueil wrote:

> Add a documentation file about the Timer/Counter Unit (TCU) present in

s/Add a /Add /

> the Ingenic JZ47xx SoCs.
>
> diff --git a/Documentation/mips/ingenic-tcu.txt b/Documentation/mips/ingenic-tcu.txt
> new file mode 100644
> index 000000000000..1a753805779c
> --- /dev/null
> +++ b/Documentation/mips/ingenic-tcu.txt

There is a massive effort to convert the whole Documentation tree to rst
format. Please do not introduce new txt files.

Also documentation wants a SPDX license identifier.

> +Implementation
> +--------------
> +
> +The functionalities of the TCU hardware are spread across multiple drivers:
> +- boilerplate: drivers/mfd/ingenic-tcu.c
> +- clocks: drivers/clk/ingenic/tcu.c
> +- interrupts: drivers/irqchip/irq-ingenic-tcu.c
> +- timers: drivers/clocksource/ingenic-timer.c
> +- PWM: drivers/pwm/pwm-jz4740.c
> +- watchdog: drivers/watchdog/jz4740_wdt.c
> +- OST: drivers/clocksource/ingenic-ost.c

Hrm. These file names are going to be stale over time, but I have no better
idea either.

Thanks,

tglx