[v4,1/6] Documentation: DT: Consolidate SP805 binding docs

Guenter Roeck
2018-06-29T02:55:01Z

On Mon, May 28, 2018 at 11:01:32AM -0700, Ray Jui wrote:
> Consolidate two SP805 binding documents "arm,sp805.txt" and
> "sp805-wdt.txt" into "arm,sp805.txt" that matches the naming of the
> desired compatible string to be used
>
> Signed-off-by: Ray Jui <ray.jui@broadcom.com>
> Reviewed-by: Rob Herring <robh@kernel.org>

For the record:

Reviewed-by: Guenter Roeck <linux@roeck-us.net>

> ---
> .../devicetree/bindings/watchdog/arm,sp805.txt | 27 ++++++++++++++-----
> .../devicetree/bindings/watchdog/sp805-wdt.txt | 31 ----------------------
> 2 files changed, 20 insertions(+), 38 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/watchdog/sp805-wdt.txt
>
> diff --git a/Documentation/devicetree/bindings/watchdog/arm,sp805.txt b/Documentation/devicetree/bindings/watchdog/arm,sp805.txt
> index ca99d64..0fa3629 100644
> --- a/Documentation/devicetree/bindings/watchdog/arm,sp805.txt
> +++ b/Documentation/devicetree/bindings/watchdog/arm,sp805.txt
> @@ -1,17 +1,30 @@
> ARM AMBA Primecell SP805 Watchdog
>
> +SP805 WDT is a ARM Primecell Peripheral and has a standard-id register that
> +can be used to identify the peripheral type, vendor, and revision.
> +This value can be used for driver matching.
> +
> +As SP805 WDT is a primecell IP, it follows the base bindings specified in
> +'arm/primecell.txt'
> +
> Required properties:
> -- compatible: Should be "arm,sp805" & "arm,primecell"
> -- reg: Should contain location and length for watchdog timer register.
> -- interrupts: Should contain the list of watchdog timer interrupts.
> -- clocks: clocks driving the watchdog timer hardware. This list should be 2
> - clocks. With 2 clocks, the order is wdogclk clock, apb_pclk.
> +- compatible: Should be "arm,sp805" & "arm,primecell"
> +- reg: Should contain location and length for watchdog timer register
> +- clocks: Clocks driving the watchdog timer hardware. This list should be
> + 2 clocks. With 2 clocks, the order is wdog_clk, apb_pclk
> + wdog_clk can be equal to or be a sub-multiple of the apb_pclk
> + frequency
> +- clock-names: Shall be "wdog_clk" for first clock and "apb_pclk" for the
> + second one
> +
> +Optional properties:
> +- interrupts: Should specify WDT interrupt number
>
> Example:
> watchdog at 66090000 {
> compatible = "arm,sp805", "arm,primecell";
> reg = <0x66090000 0x1000>;
> interrupts = <GIC_SPI 406 IRQ_TYPE_LEVEL_HIGH>;
> - clocks = <&apb_pclk>,<&apb_pclk>;
> - clock-names = "wdogclk", "apb_pclk";
> + clocks = <&wdt_clk>, <&apb_pclk>;
> + clock-names = "wdog_clk", "apb_pclk";
> };
> diff --git a/Documentation/devicetree/bindings/watchdog/sp805-wdt.txt b/Documentation/devicetree/bindings/watchdog/sp805-wdt.txt
> deleted file mode 100644
> index edc4f0e..0000000
> --- a/Documentation/devicetree/bindings/watchdog/sp805-wdt.txt
> +++ /dev/null
> @@ -1,31 +0,0 @@
> -* ARM SP805 Watchdog Timer (WDT) Controller
> -
> -SP805 WDT is a ARM Primecell Peripheral and has a standard-id register that
> -can be used to identify the peripheral type, vendor, and revision.
> -This value can be used for driver matching.
> -
> -As SP805 WDT is a primecell IP, it follows the base bindings specified in
> -'arm/primecell.txt'
> -
> -Required properties:
> -- compatible : Should be "arm,sp805-wdt", "arm,primecell"
> -- reg : Base address and size of the watchdog timer registers.
> -- clocks : From common clock binding.
> - First clock is PCLK and the second is WDOGCLK.
> - WDOGCLK can be equal to or be a sub-multiple of the PCLK frequency.
> -- clock-names : From common clock binding.
> - Shall be "apb_pclk" for first clock and "wdog_clk" for the
> - second one.
> -
> -Optional properties:
> -- interrupts : Should specify WDT interrupt number.
> -
> -Examples:
> -
> - cluster1_core0_watchdog: wdt at c000000 {
> - compatible = "arm,sp805-wdt", "arm,primecell";
> - reg = <0x0 0xc000000 0x0 0x1000>;
> - clocks = <&clockgen 4 3>, <&clockgen 4 3>;
> - clock-names = "apb_pclk", "wdog_clk";
> - };
> -