diff mbox

[v3,1/3] dt-bindings: mfd: add lubbock-io binding

Message ID 1421406010-14851-1-git-send-email-robert.jarzmik@free.fr (mailing list archive)
State New, archived
Headers show

Commit Message

Robert Jarzmik Jan. 16, 2015, 11 a.m. UTC
Add a binding for lubbock motherboard IO board.

Signed-off-by: Robert Jarzmik <robert.jarzmik@free.fr>
---
 .../devicetree/bindings/mfd/lubbock-io.txt         | 26 ++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mfd/lubbock-io.txt

Comments

Lee Jones Jan. 19, 2015, 8:35 a.m. UTC | #1
On Fri, 16 Jan 2015, Robert Jarzmik wrote:

> Add a binding for lubbock motherboard IO board.
> 
> Signed-off-by: Robert Jarzmik <robert.jarzmik@free.fr>
> ---
>  .../devicetree/bindings/mfd/lubbock-io.txt         | 26 ++++++++++++++++++++++
>  1 file changed, 26 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/mfd/lubbock-io.txt
> 
> diff --git a/Documentation/devicetree/bindings/mfd/lubbock-io.txt b/Documentation/devicetree/bindings/mfd/lubbock-io.txt
> new file mode 100644
> index 0000000..33c9e21
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mfd/lubbock-io.txt
> @@ -0,0 +1,26 @@
> +Intel's pxa255 system development platform motherboard.

s/pxa25/PXA25/

"system development platform motherboard" doesn't quite sit right with me.

How about "Intel Xscale PXA255 development platform (Lubbock)"?

> +This is the motherboard, or IO board, of the pxa25x development system,
> +supporting a lubbock pxa25x SoC board.

Again, this sounds weird.

> +Required properties:
> +  - compatible : One of the following chip-specific strings:
> +        "intel,lubbock-io"

An odd thing to say with only one entry.

Also, please line it up to the right of the ':' above.

> +  - interrupts : The first interrupt is the line the /IRQ signal the IO board
> +                 multiplex is connected to. The only known case is GPIO0 on the
> +                 pxa25x SoC.

Can you get someone to help you re-word this into a more fluid
sentence?

> +Optional properties:
> +  - interrupts : The second optional interrupt is the base of the interrupts
> +                 multiplexed by the lubbock motherboard. If unspecified, the
> +                 range is fully dynamic, and the irqdomain will generate its
> +                 interrupt base on the fly.
> +
> +Example:
> +
> +mb: lubbock-mb@0 {
> +	compatible = "intel,lubbock-io";
> +	interrupts = <0 IRQ_TYPE_EDGE_FALLING 400 IRQ_TYPE_NONE>;
> +	#interrupt-cells = <2>;
> +        interrupt-parent = <&pxairq>;

Whitespace error.

> +};

I'm guessing mb means motherboard?  I think it's unusual for a
motherboard to have it's own driver.  Usually we provide drivers for
the individual components/peripherals situated on the board.
Robert Jarzmik Jan. 19, 2015, 7:29 p.m. UTC | #2
Lee Jones <lee.jones@linaro.org> writes:

> On Fri, 16 Jan 2015, Robert Jarzmik wrote:
>
>> Add a binding for lubbock motherboard IO board.
>> 
>> Signed-off-by: Robert Jarzmik <robert.jarzmik@free.fr>
>> ---
>>  .../devicetree/bindings/mfd/lubbock-io.txt         | 26 ++++++++++++++++++++++
>>  1 file changed, 26 insertions(+)
>>  create mode 100644 Documentation/devicetree/bindings/mfd/lubbock-io.txt
>> 
>> diff --git a/Documentation/devicetree/bindings/mfd/lubbock-io.txt b/Documentation/devicetree/bindings/mfd/lubbock-io.txt
>> new file mode 100644
>> index 0000000..33c9e21
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/mfd/lubbock-io.txt
>> @@ -0,0 +1,26 @@
>> +Intel's pxa255 system development platform motherboard.
>
> s/pxa25/PXA25/
Ok.
>
> "system development platform motherboard" doesn't quite sit right with me.
>
> How about "Intel Xscale PXA255 development platform (Lubbock)"?
OK.

>
>> +This is the motherboard, or IO board, of the pxa25x development system,
>> +supporting a lubbock pxa25x SoC board.
>
> Again, this sounds weird.
Would it sound better with :
  This regroups all the CPLDs on the Lubbock motherboard, providing interrupt
  muxing, leds handling, ...
>
>> +Required properties:
>> +  - compatible : One of the following chip-specific strings:
>> +        "intel,lubbock-io"
>
> An odd thing to say with only one entry.
Right, a simple "should be" would fit better.
>
>> +  - interrupts : The first interrupt is the line the /IRQ signal the IO board
>> +                 multiplex is connected to. The only known case is GPIO0 on the
>> +                 pxa25x SoC.
>
> Can you get someone to help you re-word this into a more fluid
> sentence?
Aouch, how about this :
interrupts : The first interrupt is the SoC input interrupt connected to the
             lubbock IO board interrupt multiplexer output. The only known
             working configuration is GPIO0 on the pxa25x SoC.

>
>> +Optional properties:
>> +  - interrupts : The second optional interrupt is the base of the interrupts
>> +                 multiplexed by the lubbock motherboard. If unspecified, the
>> +                 range is fully dynamic, and the irqdomain will generate its
>> +                 interrupt base on the fly.
>> +
>> +Example:
>> +
>> +mb: lubbock-mb@0 {
>> +	compatible = "intel,lubbock-io";
>> +	interrupts = <0 IRQ_TYPE_EDGE_FALLING 400 IRQ_TYPE_NONE>;
>> +	#interrupt-cells = <2>;
>> +        interrupt-parent = <&pxairq>;
>
> Whitespace error.
Right.

> I'm guessing mb means motherboard?  I think it's unusual for a
> motherboard to have it's own driver.  Usually we provide drivers for
> the individual components/peripherals situated on the board.
Yes, mb for motherboard. Well, this driver is actually for the CPLDs on the
motherboard.  Would "lubbock-cplds" be a better choice ?

Cheers.
Lee Jones Jan. 20, 2015, 10:18 a.m. UTC | #3
On Mon, 19 Jan 2015, Robert Jarzmik wrote:
> Lee Jones <lee.jones@linaro.org> writes:
> > On Fri, 16 Jan 2015, Robert Jarzmik wrote:
> >
> >> Add a binding for lubbock motherboard IO board.
> >> 
> >> Signed-off-by: Robert Jarzmik <robert.jarzmik@free.fr>
> >> ---
> >>  .../devicetree/bindings/mfd/lubbock-io.txt         | 26 ++++++++++++++++++++++
> >>  1 file changed, 26 insertions(+)
> >>  create mode 100644 Documentation/devicetree/bindings/mfd/lubbock-io.txt
> >> 
> >> diff --git a/Documentation/devicetree/bindings/mfd/lubbock-io.txt b/Documentation/devicetree/bindings/mfd/lubbock-io.txt
> >> new file mode 100644
> >> index 0000000..33c9e21
> >> --- /dev/null
> >> +++ b/Documentation/devicetree/bindings/mfd/lubbock-io.txt
> >> @@ -0,0 +1,26 @@

[...]

> >> +This is the motherboard, or IO board, of the pxa25x development system,
> >> +supporting a lubbock pxa25x SoC board.
> >
> > Again, this sounds weird.
> Would it sound better with :
>   This regroups all the CPLDs on the Lubbock motherboard, providing interrupt
>   muxing, leds handling, ...

Sounds a lot better, yes.

[...]

> >> +  - interrupts : The first interrupt is the line the /IRQ signal the IO board
> >> +                 multiplex is connected to. The only known case is GPIO0 on the
> >> +                 pxa25x SoC.
> >
> > Can you get someone to help you re-word this into a more fluid
> > sentence?
> Aouch, how about this :

:)

> interrupts : The first interrupt is the SoC input interrupt connected to the
>              lubbock IO board interrupt multiplexer output. The only known
>              working configuration is GPIO0 on the pxa25x SoC.

Perfect.

[...]

> > I'm guessing mb means motherboard?  I think it's unusual for a
> > motherboard to have it's own driver.  Usually we provide drivers for
> > the individual components/peripherals situated on the board.
> Yes, mb for motherboard. Well, this driver is actually for the CPLDs on the
> motherboard.  Would "lubbock-cplds" be a better choice ?

That would fit better with my current understanding of what requires a
driver and what does not.
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/mfd/lubbock-io.txt b/Documentation/devicetree/bindings/mfd/lubbock-io.txt
new file mode 100644
index 0000000..33c9e21
--- /dev/null
+++ b/Documentation/devicetree/bindings/mfd/lubbock-io.txt
@@ -0,0 +1,26 @@ 
+Intel's pxa255 system development platform motherboard.
+
+This is the motherboard, or IO board, of the pxa25x development system,
+supporting a lubbock pxa25x SoC board.
+
+Required properties:
+  - compatible : One of the following chip-specific strings:
+        "intel,lubbock-io"
+  - interrupts : The first interrupt is the line the /IRQ signal the IO board
+                 multiplex is connected to. The only known case is GPIO0 on the
+                 pxa25x SoC.
+
+Optional properties:
+  - interrupts : The second optional interrupt is the base of the interrupts
+                 multiplexed by the lubbock motherboard. If unspecified, the
+                 range is fully dynamic, and the irqdomain will generate its
+                 interrupt base on the fly.
+
+Example:
+
+mb: lubbock-mb@0 {
+	compatible = "intel,lubbock-io";
+	interrupts = <0 IRQ_TYPE_EDGE_FALLING 400 IRQ_TYPE_NONE>;
+	#interrupt-cells = <2>;
+        interrupt-parent = <&pxairq>;
+};