diff mbox

[2/5] Documentation: dt-bindings: document the Armada 375 USB cluster binding

Message ID 1400257376-13251-2-git-send-email-gregory.clement@free-electrons.com
State Superseded, archived
Headers show

Commit Message

Gregory CLEMENT May 16, 2014, 4:22 p.m. UTC
Armada 375 comes with an USB2 host and device controller and an USB3
controller. The USB cluster control register allows to manage common
features of both USB controllers. This commit adds the Device Tree
binding documentation for this piece of hardware.

Signed-off-by: Gregory CLEMENT <gregory.clement@free-electrons.com>
---
 .../bindings/phy/armada-375-usb-phy-cluster.txt      | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/phy/armada-375-usb-phy-cluster.txt

Comments

Kishon Vijay Abraham I May 23, 2014, 9:24 a.m. UTC | #1
Hi,

On Friday 16 May 2014 09:52 PM, Gregory CLEMENT wrote:
> Armada 375 comes with an USB2 host and device controller and an USB3
> controller. The USB cluster control register allows to manage common
> features of both USB controllers. This commit adds the Device Tree
> binding documentation for this piece of hardware.

Pls re-order so that the Documentation patch comes before the driver patch..
> 
> Signed-off-by: Gregory CLEMENT <gregory.clement@free-electrons.com>
> ---
>  .../bindings/phy/armada-375-usb-phy-cluster.txt      | 20 ++++++++++++++++++++
>  1 file changed, 20 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/phy/armada-375-usb-phy-cluster.txt
> 
> diff --git a/Documentation/devicetree/bindings/phy/armada-375-usb-phy-cluster.txt b/Documentation/devicetree/bindings/phy/armada-375-usb-phy-cluster.txt

simpler file name? armada-phy?

Thanks
Kishon
--
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
Andrew Lunn May 23, 2014, 1:21 p.m. UTC | #2
On Fri, May 23, 2014 at 02:54:02PM +0530, Kishon Vijay Abraham I wrote:
> Hi,
> 
> On Friday 16 May 2014 09:52 PM, Gregory CLEMENT wrote:
> > Armada 375 comes with an USB2 host and device controller and an USB3
> > controller. The USB cluster control register allows to manage common
> > features of both USB controllers. This commit adds the Device Tree
> > binding documentation for this piece of hardware.
> 
> Pls re-order so that the Documentation patch comes before the driver patch..
> > 
> > Signed-off-by: Gregory CLEMENT <gregory.clement@free-electrons.com>
> > ---
> >  .../bindings/phy/armada-375-usb-phy-cluster.txt      | 20 ++++++++++++++++++++
> >  1 file changed, 20 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/phy/armada-375-usb-phy-cluster.txt
> > 
> > diff --git a/Documentation/devicetree/bindings/phy/armada-375-usb-phy-cluster.txt b/Documentation/devicetree/bindings/phy/armada-375-usb-phy-cluster.txt
> 
> simpler file name? armada-phy?

Armada is a collection of families of SoCs. This driver is very
specific to one SoC, in one family of SoCs.

Do you want one .txt file per driver, or can we combine binding
documentations into one file? There should already be a mvebu-phy.txt,
which contains the sata phy usable on some of the Armada SoC families.
This binding could be appended to it.

      Andrew
--
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
Gregory CLEMENT May 23, 2014, 1:24 p.m. UTC | #3
Hi Kishon,

On 23/05/2014 11:24, Kishon Vijay Abraham I wrote:
> Hi,
> 
> On Friday 16 May 2014 09:52 PM, Gregory CLEMENT wrote:
>> Armada 375 comes with an USB2 host and device controller and an USB3
>> controller. The USB cluster control register allows to manage common
>> features of both USB controllers. This commit adds the Device Tree
>> binding documentation for this piece of hardware.
> 
> Pls re-order so that the Documentation patch comes before the driver patch..

OK I will do it

>>
>> Signed-off-by: Gregory CLEMENT <gregory.clement@free-electrons.com>
>> ---
>>  .../bindings/phy/armada-375-usb-phy-cluster.txt      | 20 ++++++++++++++++++++
>>  1 file changed, 20 insertions(+)
>>  create mode 100644 Documentation/devicetree/bindings/phy/armada-375-usb-phy-cluster.txt
>>
>> diff --git a/Documentation/devicetree/bindings/phy/armada-375-usb-phy-cluster.txt b/Documentation/devicetree/bindings/phy/armada-375-usb-phy-cluster.txt
> 
> simpler file name? armada-phy?

I can remove the "cluster" part but not the 375, there are many SoCs
from Marvell called Armada, and some of then have nearly nothing in
common, so I prefer keep this name. If your intent is to have a file
with all the PHY binding related to an SoC family, then we should call it
mvebu-phy.


Thanks for your review,

Gregory
Andrew Lunn May 23, 2014, 1:36 p.m. UTC | #4
> Do you want one .txt file per driver, or can we combine binding
> documentations into one file? There should already be a mvebu-phy.txt,
> which contains the sata phy usable on some of the Armada SoC families.
> This binding could be appended to it.

Ah. Humm, well! It seems the patch adding the mvebu-phy.txt fell
through a crack when adding the driver.

Kishon could you take
http://www.spinics.net/lists/devicetree/msg17018.html into your tree?
It should of been taken the same time you took the actual driver,
http://www.spinics.net/lists/devicetree/msg17011.html into your tree.

I can resend that one missing patch if you want.

  Andrew
--
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
Kishon Vijay Abraham I May 23, 2014, 1:50 p.m. UTC | #5
Hi,

On Friday 23 May 2014 06:51 PM, Andrew Lunn wrote:
> On Fri, May 23, 2014 at 02:54:02PM +0530, Kishon Vijay Abraham I wrote:
>> Hi,
>>
>> On Friday 16 May 2014 09:52 PM, Gregory CLEMENT wrote:
>>> Armada 375 comes with an USB2 host and device controller and an USB3
>>> controller. The USB cluster control register allows to manage common
>>> features of both USB controllers. This commit adds the Device Tree
>>> binding documentation for this piece of hardware.
>>
>> Pls re-order so that the Documentation patch comes before the driver patch..
>>>
>>> Signed-off-by: Gregory CLEMENT <gregory.clement@free-electrons.com>
>>> ---
>>>  .../bindings/phy/armada-375-usb-phy-cluster.txt      | 20 ++++++++++++++++++++
>>>  1 file changed, 20 insertions(+)
>>>  create mode 100644 Documentation/devicetree/bindings/phy/armada-375-usb-phy-cluster.txt
>>>
>>> diff --git a/Documentation/devicetree/bindings/phy/armada-375-usb-phy-cluster.txt b/Documentation/devicetree/bindings/phy/armada-375-usb-phy-cluster.txt
>>
>> simpler file name? armada-phy?
> 
> Armada is a collection of families of SoCs. This driver is very
> specific to one SoC, in one family of SoCs.
> 
> Do you want one .txt file per driver, or can we combine binding
> documentations into one file? There should already be a mvebu-phy.txt,
> which contains the sata phy usable on some of the Armada SoC families.
> This binding could be appended to it.

So far we've been creating Documentation file per manufacturer (ti-phy.txt,
samsung-phy.txt..), so would prefer if you could combine binding documentation
in a single file.

Thanks
Kishon
--
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
Kishon Vijay Abraham I May 23, 2014, 1:52 p.m. UTC | #6
hI,

On Friday 23 May 2014 07:06 PM, Andrew Lunn wrote:
>> Do you want one .txt file per driver, or can we combine binding
>> documentations into one file? There should already be a mvebu-phy.txt,
>> which contains the sata phy usable on some of the Armada SoC families.
>> This binding could be appended to it.
> 
> Ah. Humm, well! It seems the patch adding the mvebu-phy.txt fell
> through a crack when adding the driver.
> 
> Kishon could you take
> http://www.spinics.net/lists/devicetree/msg17018.html into your tree?
> It should of been taken the same time you took the actual driver,
> http://www.spinics.net/lists/devicetree/msg17011.html into your tree.
> 
> I can resend that one missing patch if you want.

yes please. But it's already too late to go in the next merge window.

-Kishon
--
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
Andrew Lunn May 23, 2014, 1:59 p.m. UTC | #7
On Fri, May 23, 2014 at 07:22:48PM +0530, Kishon Vijay Abraham I wrote:
> hI,
> 
> On Friday 23 May 2014 07:06 PM, Andrew Lunn wrote:
> >> Do you want one .txt file per driver, or can we combine binding
> >> documentations into one file? There should already be a mvebu-phy.txt,
> >> which contains the sata phy usable on some of the Armada SoC families.
> >> This binding could be appended to it.
> > 
> > Ah. Humm, well! It seems the patch adding the mvebu-phy.txt fell
> > through a crack when adding the driver.
> > 
> > Kishon could you take
> > http://www.spinics.net/lists/devicetree/msg17018.html into your tree?
> > It should of been taken the same time you took the actual driver,
> > http://www.spinics.net/lists/devicetree/msg17011.html into your tree.
> > 
> > I can resend that one missing patch if you want.
> 
> yes please. But it's already too late to go in the next merge window.

Gregory, could you pick it up and append your 375 binding to it? We
can avoid merge conflicts that way.

Thanks
	Andrew
--
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
Gregory CLEMENT May 23, 2014, 9:25 p.m. UTC | #8
On 23/05/2014 15:59, Andrew Lunn wrote:
> On Fri, May 23, 2014 at 07:22:48PM +0530, Kishon Vijay Abraham I wrote:
>> hI,
>>
>> On Friday 23 May 2014 07:06 PM, Andrew Lunn wrote:
>>>> Do you want one .txt file per driver, or can we combine binding
>>>> documentations into one file? There should already be a mvebu-phy.txt,
>>>> which contains the sata phy usable on some of the Armada SoC families.
>>>> This binding could be appended to it.
>>>
>>> Ah. Humm, well! It seems the patch adding the mvebu-phy.txt fell
>>> through a crack when adding the driver.
>>>
>>> Kishon could you take
>>> http://www.spinics.net/lists/devicetree/msg17018.html into your tree?
>>> It should of been taken the same time you took the actual driver,
>>> http://www.spinics.net/lists/devicetree/msg17011.html into your tree.
>>>
>>> I can resend that one missing patch if you want.
>>
>> yes please. But it's already too late to go in the next merge window.
> 
> Gregory, could you pick it up and append your 375 binding to it? We
> can avoid merge conflicts that way.

yes sure, I will do it

> 
> Thanks
> 	Andrew
>
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/phy/armada-375-usb-phy-cluster.txt b/Documentation/devicetree/bindings/phy/armada-375-usb-phy-cluster.txt
new file mode 100644
index 000000000000..9bd1502e1f33
--- /dev/null
+++ b/Documentation/devicetree/bindings/phy/armada-375-usb-phy-cluster.txt
@@ -0,0 +1,20 @@ 
+Armada 375 USB cluster
+----------------------
+
+Armada 375 comes with an USB2 host and device controller and an USB3
+controller. The USB cluster control register allows to manage common
+features of both USB controllers.
+
+Required properties:
+
+- compatible: "marvell,armada-375-usb-cluster"
+- reg: Should contain usb cluster register location and length.
+- #phy-cells : from the generic phy bindings, must be 1. Possible
+values are 0 (USB2), 1 (USB3).
+
+Example:
+	usbcluster: usb-cluster@18400 {
+		compatible = "marvell,armada-375-usb-cluster";
+		reg = <0x18400 0x4>;
+		#phy-cells = <1>
+	};