diff mbox series

[1/3] devicetree: document the BCM63XX gated clock bindings

Message ID 20190502122657.15577-2-jonas.gorski@gmail.com
State Not Applicable, archived
Headers show
Series MIPS: BMIPS: add support for gated clock controller | expand

Checks

Context Check Description
robh/checkpatch success

Commit Message

Jonas Gorski May 2, 2019, 12:26 p.m. UTC
Add binding documentation for the gated clock controller found on MIPS
based BCM63XX SoCs.

Signed-off-by: Jonas Gorski <jonas.gorski@gmail.com>
---
 .../bindings/clock/brcm,bcm63xx-clocks.txt         | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/clock/brcm,bcm63xx-clocks.txt

Comments

Florian Fainelli May 3, 2019, 1:44 a.m. UTC | #1
On 5/2/2019 5:26 AM, Jonas Gorski wrote:
> Add binding documentation for the gated clock controller found on MIPS
> based BCM63XX SoCs.
> 
> Signed-off-by: Jonas Gorski <jonas.gorski@gmail.com>

Reviewed-by: Florian Fainelli <f.fainelli@gmail.com>

> ---
>  .../bindings/clock/brcm,bcm63xx-clocks.txt         | 22 ++++++++++++++++++++++
>  1 file changed, 22 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/clock/brcm,bcm63xx-clocks.txt
> 
> diff --git a/Documentation/devicetree/bindings/clock/brcm,bcm63xx-clocks.txt b/Documentation/devicetree/bindings/clock/brcm,bcm63xx-clocks.txt
> new file mode 100644
> index 000000000000..3041657e2f96
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/clock/brcm,bcm63xx-clocks.txt
> @@ -0,0 +1,22 @@
> +Gated Clock Controller Bindings for MIPS based BCM63XX SoCs
> +
> +Required properties:
> +- compatible: must be one of:
> +	 "brcm,bcm3368-clocks"
> +	 "brcm,bcm6328-clocks"
> +	 "brcm,bcm6358-clocks"
> +	 "brcm,bcm6362-clocks"
> +	 "brcm,bcm6368-clocks"
> +	 "brcm,bcm63268-clocks"

We could always add 6348/6338 to that list later one.

> +
> +- reg: Address and length of the register set
> +- #clock-cells: must be <1>
> +
> +
> +Example:
> +
> +clkctl: clock-controller@10000004 {
> +	compatible = "brcm,bcm6328-clocks";
> +	reg = <0x10000004 0x4>;
> +	#clock-cells = <1>;
> +};
>
Jonas Gorski May 3, 2019, 9:47 a.m. UTC | #2
On Fri, 3 May 2019 at 03:44, Florian Fainelli <f.fainelli@gmail.com> wrote:
>
>
>
> On 5/2/2019 5:26 AM, Jonas Gorski wrote:
> > Add binding documentation for the gated clock controller found on MIPS
> > based BCM63XX SoCs.
> >
> > Signed-off-by: Jonas Gorski <jonas.gorski@gmail.com>
>
> Reviewed-by: Florian Fainelli <f.fainelli@gmail.com>

Thanks!

>
> > ---
> >  .../bindings/clock/brcm,bcm63xx-clocks.txt         | 22 ++++++++++++++++++++++
> >  1 file changed, 22 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/clock/brcm,bcm63xx-clocks.txt
> >
> > diff --git a/Documentation/devicetree/bindings/clock/brcm,bcm63xx-clocks.txt b/Documentation/devicetree/bindings/clock/brcm,bcm63xx-clocks.txt
> > new file mode 100644
> > index 000000000000..3041657e2f96
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/clock/brcm,bcm63xx-clocks.txt
> > @@ -0,0 +1,22 @@
> > +Gated Clock Controller Bindings for MIPS based BCM63XX SoCs
> > +
> > +Required properties:
> > +- compatible: must be one of:
> > +      "brcm,bcm3368-clocks"
> > +      "brcm,bcm6328-clocks"
> > +      "brcm,bcm6358-clocks"
> > +      "brcm,bcm6362-clocks"
> > +      "brcm,bcm6368-clocks"
> > +      "brcm,bcm63268-clocks"
>
> We could always add 6348/6338 to that list later one.

That's the plan*. But currently neither one is supported by
BMIPS_GENERIC, which was my starting point. And making BCM63XX use the
driver is ... complicated, due to (important) consumers not being
platform drivers (the MPI/PCIe controller codes). And they can't be
just converted to platform drivers, as they should then be non-legacy
PCI controller drivers, so a full rewrite is needed.

So let's stick with BMIPS_GENERIC first, else we never get anything
done ;-). In the end BCM63XX should go away anyway, once BMIPS_GENERIC
has reached feature parity.


Regards
Jonas

* if it even makes sense, as these are quite old, and systems will
quite struggle running a modern kernel/OS.

Jonas
Philippe Mathieu-Daudé May 3, 2019, 2:36 p.m. UTC | #3
Hi Jonas,

On 5/2/19 2:26 PM, Jonas Gorski wrote:
> Add binding documentation for the gated clock controller found on MIPS
> based BCM63XX SoCs.

I'd have ordered this patch after the #2 of this series, or eventually
squashed both together. It is weird to document an unexistant feature
then implement it, while the opposite looks more natural.
(If you agree, maybe Paul can invert those when applying this series).

Anyway:
Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org>

> 
> Signed-off-by: Jonas Gorski <jonas.gorski@gmail.com>
> ---
>  .../bindings/clock/brcm,bcm63xx-clocks.txt         | 22 ++++++++++++++++++++++
>  1 file changed, 22 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/clock/brcm,bcm63xx-clocks.txt
> 
> diff --git a/Documentation/devicetree/bindings/clock/brcm,bcm63xx-clocks.txt b/Documentation/devicetree/bindings/clock/brcm,bcm63xx-clocks.txt
> new file mode 100644
> index 000000000000..3041657e2f96
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/clock/brcm,bcm63xx-clocks.txt
> @@ -0,0 +1,22 @@
> +Gated Clock Controller Bindings for MIPS based BCM63XX SoCs
> +
> +Required properties:
> +- compatible: must be one of:
> +	 "brcm,bcm3368-clocks"
> +	 "brcm,bcm6328-clocks"
> +	 "brcm,bcm6358-clocks"
> +	 "brcm,bcm6362-clocks"
> +	 "brcm,bcm6368-clocks"
> +	 "brcm,bcm63268-clocks"
> +
> +- reg: Address and length of the register set
> +- #clock-cells: must be <1>
> +
> +
> +Example:
> +
> +clkctl: clock-controller@10000004 {
> +	compatible = "brcm,bcm6328-clocks";
> +	reg = <0x10000004 0x4>;
> +	#clock-cells = <1>;
> +};
>
Jonas Gorski May 5, 2019, 6:57 p.m. UTC | #4
Hi Philippe,

On Fri, 3 May 2019 at 16:36, Philippe Mathieu-Daudé <f4bug@amsat.org> wrote:
>
> Hi Jonas,
>
> On 5/2/19 2:26 PM, Jonas Gorski wrote:
> > Add binding documentation for the gated clock controller found on MIPS
> > based BCM63XX SoCs.
>
> I'd have ordered this patch after the #2 of this series, or eventually
> squashed both together. It is weird to document an unexistant feature
> then implement it, while the opposite looks more natural.
> (If you agree, maybe Paul can invert those when applying this series).
>
> Anyway:
> Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org>

You are documenting hardware, not a driver/feature. :-)

The binding is supposed to be a separate patch [1]. The natural order
is to first describe the hardware (with the binding documentation),
then add the actual driver making use of the binding. Checkpatch.pl
will also warn if you use a compatible that isn't documented, which
happens (shortly) if you first add the driver.


Regards
Jonas

[1] https://elixir.bootlin.com/linux/latest/source/Documentation/devicetree/bindings/submitting-patches.txt#L8
Philippe Mathieu-Daudé May 5, 2019, 11:26 p.m. UTC | #5
On 5/5/19 8:57 PM, Jonas Gorski wrote:
> Hi Philippe,
> 
> On Fri, 3 May 2019 at 16:36, Philippe Mathieu-Daudé <f4bug@amsat.org> wrote:
>>
>> Hi Jonas,
>>
>> On 5/2/19 2:26 PM, Jonas Gorski wrote:
>>> Add binding documentation for the gated clock controller found on MIPS
>>> based BCM63XX SoCs.
>>
>> I'd have ordered this patch after the #2 of this series, or eventually
>> squashed both together. It is weird to document an unexistant feature
>> then implement it, while the opposite looks more natural.
>> (If you agree, maybe Paul can invert those when applying this series).
>>
>> Anyway:
>> Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
> 
> You are documenting hardware, not a driver/feature. :-)
> 
> The binding is supposed to be a separate patch [1]. The natural order
> is to first describe the hardware (with the binding documentation),
> then add the actual driver making use of the binding. Checkpatch.pl
> will also warn if you use a compatible that isn't documented, which
> happens (shortly) if you first add the driver.

Oh, thanks for the pointer, this is my first DT review ;)

> Regards
> Jonas
> 
> [1] https://elixir.bootlin.com/linux/latest/source/Documentation/devicetree/bindings/submitting-patches.txt#L8
>
Rob Herring May 14, 2019, 8:33 p.m. UTC | #6
On Thu,  2 May 2019 14:26:55 +0200, Jonas Gorski wrote:
> Add binding documentation for the gated clock controller found on MIPS
> based BCM63XX SoCs.
> 
> Signed-off-by: Jonas Gorski <jonas.gorski@gmail.com>
> ---
>  .../bindings/clock/brcm,bcm63xx-clocks.txt         | 22 ++++++++++++++++++++++
>  1 file changed, 22 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/clock/brcm,bcm63xx-clocks.txt
> 

Reviewed-by: Rob Herring <robh@kernel.org>
Stephen Boyd June 27, 2019, 8:36 p.m. UTC | #7
Quoting Jonas Gorski (2019-05-02 05:26:55)
> Add binding documentation for the gated clock controller found on MIPS
> based BCM63XX SoCs.
> 
> Signed-off-by: Jonas Gorski <jonas.gorski@gmail.com>
> ---

Applied to clk-next
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/clock/brcm,bcm63xx-clocks.txt b/Documentation/devicetree/bindings/clock/brcm,bcm63xx-clocks.txt
new file mode 100644
index 000000000000..3041657e2f96
--- /dev/null
+++ b/Documentation/devicetree/bindings/clock/brcm,bcm63xx-clocks.txt
@@ -0,0 +1,22 @@ 
+Gated Clock Controller Bindings for MIPS based BCM63XX SoCs
+
+Required properties:
+- compatible: must be one of:
+	 "brcm,bcm3368-clocks"
+	 "brcm,bcm6328-clocks"
+	 "brcm,bcm6358-clocks"
+	 "brcm,bcm6362-clocks"
+	 "brcm,bcm6368-clocks"
+	 "brcm,bcm63268-clocks"
+
+- reg: Address and length of the register set
+- #clock-cells: must be <1>
+
+
+Example:
+
+clkctl: clock-controller@10000004 {
+	compatible = "brcm,bcm6328-clocks";
+	reg = <0x10000004 0x4>;
+	#clock-cells = <1>;
+};