diff mbox

[2/4,v3] dt/bindings: Add binding for BCM2835 mailbox driver

Message ID 1426213936-4139-2-git-send-email-eric@anholt.net
State Needs Review / ACK, archived
Headers show

Checks

Context Check Description
robh/checkpatch warning total: 1 errors, 0 warnings, 0 lines checked
robh/patch-applied success

Commit Message

Eric Anholt March 13, 2015, 2:32 a.m. UTC
From: Lubomir Rintel <lkundrak@v3.sk>

Signed-off-by: Lubomir Rintel <lkundrak@v3.sk>
Signed-off-by: Craig McGeachie <slapdau@yahoo.com.au>
Signed-off-by: Eric Anholt <eric@anholt.net>
---


v2: Split into a separate patch for submitting to the devicetree list.
    Consistently start node docs with a capital letter. device's
    address in the example shouldn't have "0x". Drop machine-specific
    interrupt numbers from the docs.  (changes by anholt).

v3: Move the file to just bcm2835-mbox.txt, clean up formatting
    (changes by anholt, from review by Lee Jones).

.../devicetree/bindings/mailbox/bcm2835-mbox.txt      | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt

Comments

Lee Jones March 17, 2015, 5:27 p.m. UTC | #1
On Thu, 12 Mar 2015, Eric Anholt wrote:

> From: Lubomir Rintel <lkundrak@v3.sk>
> 
> Signed-off-by: Lubomir Rintel <lkundrak@v3.sk>
> Signed-off-by: Craig McGeachie <slapdau@yahoo.com.au>
> Signed-off-by: Eric Anholt <eric@anholt.net>
> ---
> 
> 
> v2: Split into a separate patch for submitting to the devicetree list.
>     Consistently start node docs with a capital letter. device's
>     address in the example shouldn't have "0x". Drop machine-specific
>     interrupt numbers from the docs.  (changes by anholt).
> 
> v3: Move the file to just bcm2835-mbox.txt, clean up formatting
>     (changes by anholt, from review by Lee Jones).

Thanks for fixing up.

> .../devicetree/bindings/mailbox/bcm2835-mbox.txt      | 19 +++++++++++++++++++
>  1 file changed, 19 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt

I don't see any unruliness or causes of controversy.

Acked-by: Lee Jones <lee.jones@linaro.org>

> diff --git a/Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt b/Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt
> new file mode 100644
> index 0000000..0bb2b9d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt
> @@ -0,0 +1,19 @@
> +Broadcom BCM2835 VideoCore mailbox IPC
> +
> +Required properties:
> +
> +- compatible:	Should be "brcm,bcm2835-mbox"
> +- reg:		Specifies base physical address and size of the registers
> +- interrupts:	The interrupt number
> +		  See bindings/interrupt-controller/brcm,bcm2835-armctrl-ic.txt
> +- #mbox-cells:	Specifies the number of cells needed to encode a mailbox
> +		  channel. The value shall be 1
> +
> +Example:
> +
> +mailbox: mailbox@7e00b800 {
> +	compatible = "brcm,bcm2835-mbox";
> +	reg = <0x7e00b880 0x40>;
> +	interrupts = <0 1>;
> +	#mbox-cells = <1>;
> +};
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Scott Branden March 17, 2015, 10:14 p.m. UTC | #2
Hi Lubomir,


On 15-03-17 10:27 AM, Lee Jones wrote:
> On Thu, 12 Mar 2015, Eric Anholt wrote:
>
>> From: Lubomir Rintel <lkundrak@v3.sk>
>>
>> Signed-off-by: Lubomir Rintel <lkundrak@v3.sk>
>> Signed-off-by: Craig McGeachie <slapdau@yahoo.com.au>
>> Signed-off-by: Eric Anholt <eric@anholt.net>
>> ---
>>
>>
>> v2: Split into a separate patch for submitting to the devicetree list.
>>      Consistently start node docs with a capital letter. device's
>>      address in the example shouldn't have "0x". Drop machine-specific
>>      interrupt numbers from the docs.  (changes by anholt).
>>
>> v3: Move the file to just bcm2835-mbox.txt, clean up formatting
>>      (changes by anholt, from review by Lee Jones).
>
> Thanks for fixing up.
>
>> .../devicetree/bindings/mailbox/bcm2835-mbox.txt      | 19 +++++++++++++++++++
>>   1 file changed, 19 insertions(+)
>>   create mode 100644 Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt
>
> I don't see any unruliness or causes of controversy.
>
> Acked-by: Lee Jones <lee.jones@linaro.org>
>
>> diff --git a/Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt b/Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt
>> new file mode 100644
>> index 0000000..0bb2b9d
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt
I am trying to standarize all broadcom device tree bindings in the 
format "brcm,binding.txt".

Could you please rename this file to brcm,bcm2835-mbox.txt for 
consistency in bindings?

Regards,
  Scott
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Eric Anholt March 18, 2015, 1:34 a.m. UTC | #3
Scott Branden <sbranden@broadcom.com> writes:

> Hi Lubomir,
>
>
> On 15-03-17 10:27 AM, Lee Jones wrote:
>> On Thu, 12 Mar 2015, Eric Anholt wrote:
>>> diff --git a/Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt b/Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt
>>> new file mode 100644
>>> index 0000000..0bb2b9d
>>> --- /dev/null
>>> +++ b/Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt
> I am trying to standarize all broadcom device tree bindings in the 
> format "brcm,binding.txt".
>
> Could you please rename this file to brcm,bcm2835-mbox.txt for 
> consistency in bindings?

The filename was at the request of Lee Jones, to match the convention of
the other mailbox drivers.  I don't care what the filename is as long as
people can get agreement on what it should be.

(Right now it seems to be 2:1 in favor of using the compatible string?)
Lee Jones March 18, 2015, 8:23 a.m. UTC | #4
On Tue, 17 Mar 2015, Scott Branden wrote:
> On 15-03-17 10:27 AM, Lee Jones wrote:
> >On Thu, 12 Mar 2015, Eric Anholt wrote:
> >
> >>From: Lubomir Rintel <lkundrak@v3.sk>
> >>
> >>Signed-off-by: Lubomir Rintel <lkundrak@v3.sk>
> >>Signed-off-by: Craig McGeachie <slapdau@yahoo.com.au>
> >>Signed-off-by: Eric Anholt <eric@anholt.net>
> >>---
> >>
> >>
> >>v2: Split into a separate patch for submitting to the devicetree list.
> >>     Consistently start node docs with a capital letter. device's
> >>     address in the example shouldn't have "0x". Drop machine-specific
> >>     interrupt numbers from the docs.  (changes by anholt).
> >>
> >>v3: Move the file to just bcm2835-mbox.txt, clean up formatting
> >>     (changes by anholt, from review by Lee Jones).
> >
> >Thanks for fixing up.
> >
> >>.../devicetree/bindings/mailbox/bcm2835-mbox.txt      | 19 +++++++++++++++++++
> >>  1 file changed, 19 insertions(+)
> >>  create mode 100644 Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt
> >
> >I don't see any unruliness or causes of controversy.
> >
> >Acked-by: Lee Jones <lee.jones@linaro.org>
> >
> >>diff --git a/Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt b/Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt
> >>new file mode 100644
> >>index 0000000..0bb2b9d
> >>--- /dev/null
> >>+++ b/Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt
> I am trying to standarize all broadcom device tree bindings in the
> format "brcm,binding.txt".
> 
> Could you please rename this file to brcm,bcm2835-mbox.txt for
> consistency in bindings?

The file name is governed by the maintainer of the subsystem you're
applying documentation for.  If this were an MFD submission, I would
not accept a the format matching the compatible string for instance.
I like consistency and commas in file names creeps me out.

This however, is Jassi's call.
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Jassi Brar March 18, 2015, 8:40 a.m. UTC | #5
On Wed, Mar 18, 2015 at 1:53 PM, Lee Jones <lee@kernel.org> wrote:
> On Tue, 17 Mar 2015, Scott Branden wrote:
>> On 15-03-17 10:27 AM, Lee Jones wrote:
>> >On Thu, 12 Mar 2015, Eric Anholt wrote:
>> >
>> >>From: Lubomir Rintel <lkundrak@v3.sk>
>> >>
>> >>Signed-off-by: Lubomir Rintel <lkundrak@v3.sk>
>> >>Signed-off-by: Craig McGeachie <slapdau@yahoo.com.au>
>> >>Signed-off-by: Eric Anholt <eric@anholt.net>
>> >>---
>> >>
>> >>
>> >>v2: Split into a separate patch for submitting to the devicetree list.
>> >>     Consistently start node docs with a capital letter. device's
>> >>     address in the example shouldn't have "0x". Drop machine-specific
>> >>     interrupt numbers from the docs.  (changes by anholt).
>> >>
>> >>v3: Move the file to just bcm2835-mbox.txt, clean up formatting
>> >>     (changes by anholt, from review by Lee Jones).
>> >
>> >Thanks for fixing up.
>> >
>> >>.../devicetree/bindings/mailbox/bcm2835-mbox.txt      | 19 +++++++++++++++++++
>> >>  1 file changed, 19 insertions(+)
>> >>  create mode 100644 Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt
>> >
>> >I don't see any unruliness or causes of controversy.
>> >
>> >Acked-by: Lee Jones <lee.jones@linaro.org>
>> >
>> >>diff --git a/Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt b/Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt
>> >>new file mode 100644
>> >>index 0000000..0bb2b9d
>> >>--- /dev/null
>> >>+++ b/Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt
>> I am trying to standarize all broadcom device tree bindings in the
>> format "brcm,binding.txt".
>>
>> Could you please rename this file to brcm,bcm2835-mbox.txt for
>> consistency in bindings?
>
> The file name is governed by the maintainer of the subsystem you're
> applying documentation for.  If this were an MFD submission, I would
> not accept a the format matching the compatible string for instance.
> I like consistency and commas in file names creeps me out.
>
> This however, is Jassi's call.
>
I don't really have a strong opinion here. I tend to respect Broadcom
platforms' convention of using "brcm,binding.txt"
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Lee Jones March 18, 2015, 9:15 a.m. UTC | #6
On Wed, 18 Mar 2015, Jassi Brar wrote:
> On Wed, Mar 18, 2015 at 1:53 PM, Lee Jones <lee@kernel.org> wrote:
> > On Tue, 17 Mar 2015, Scott Branden wrote:
> >> On 15-03-17 10:27 AM, Lee Jones wrote:
> >> >On Thu, 12 Mar 2015, Eric Anholt wrote:
> >> >
> >> >>From: Lubomir Rintel <lkundrak@v3.sk>
> >> >>
> >> >>Signed-off-by: Lubomir Rintel <lkundrak@v3.sk>
> >> >>Signed-off-by: Craig McGeachie <slapdau@yahoo.com.au>
> >> >>Signed-off-by: Eric Anholt <eric@anholt.net>
> >> >>---
> >> >>
> >> >>
> >> >>v2: Split into a separate patch for submitting to the devicetree list.
> >> >>     Consistently start node docs with a capital letter. device's
> >> >>     address in the example shouldn't have "0x". Drop machine-specific
> >> >>     interrupt numbers from the docs.  (changes by anholt).
> >> >>
> >> >>v3: Move the file to just bcm2835-mbox.txt, clean up formatting
> >> >>     (changes by anholt, from review by Lee Jones).
> >> >
> >> >Thanks for fixing up.
> >> >
> >> >>.../devicetree/bindings/mailbox/bcm2835-mbox.txt      | 19 +++++++++++++++++++
> >> >>  1 file changed, 19 insertions(+)
> >> >>  create mode 100644 Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt
> >> >
> >> >I don't see any unruliness or causes of controversy.
> >> >
> >> >Acked-by: Lee Jones <lee.jones@linaro.org>
> >> >
> >> >>diff --git a/Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt b/Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt
> >> >>new file mode 100644
> >> >>index 0000000..0bb2b9d
> >> >>--- /dev/null
> >> >>+++ b/Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt
> >> I am trying to standarize all broadcom device tree bindings in the
> >> format "brcm,binding.txt".
> >>
> >> Could you please rename this file to brcm,bcm2835-mbox.txt for
> >> consistency in bindings?
> >
> > The file name is governed by the maintainer of the subsystem you're
> > applying documentation for.  If this were an MFD submission, I would
> > not accept a the format matching the compatible string for instance.
> > I like consistency and commas in file names creeps me out.
> >
> > This however, is Jassi's call.
> >
> I don't really have a strong opinion here. I tend to respect Broadcom
> platforms' convention of using "brcm,binding.txt"

I'm fine with this Eric.

If you change it back my Ack can reside.
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt b/Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt
new file mode 100644
index 0000000..0bb2b9d
--- /dev/null
+++ b/Documentation/devicetree/bindings/mailbox/bcm2835-mbox.txt
@@ -0,0 +1,19 @@ 
+Broadcom BCM2835 VideoCore mailbox IPC
+
+Required properties:
+
+- compatible:	Should be "brcm,bcm2835-mbox"
+- reg:		Specifies base physical address and size of the registers
+- interrupts:	The interrupt number
+		  See bindings/interrupt-controller/brcm,bcm2835-armctrl-ic.txt
+- #mbox-cells:	Specifies the number of cells needed to encode a mailbox
+		  channel. The value shall be 1
+
+Example:
+
+mailbox: mailbox@7e00b800 {
+	compatible = "brcm,bcm2835-mbox";
+	reg = <0x7e00b880 0x40>;
+	interrupts = <0 1>;
+	#mbox-cells = <1>;
+};