Message-ID: <CAKh23FmFe+5Bn2=OD=GNgzCu9Sqd5Sx=P0_UC=UBvkeMihnhhQ@mail.gmail.com>
Date:	Mon, 2 Jun 2014 11:33:09 -0700
From:	Iyappan Subramanian <isubramanian@....com>
To:	Florian Fainelli <f.fainelli@...il.com>
Cc:	David Miller <davem@...emloft.net>,
	netdev <netdev@...r.kernel.org>,
	"devicetree@...r.kernel.org" <devicetree@...r.kernel.org>,
	"jcm@...hat.com" <jcm@...hat.com>,
	Greg KH <gregkh@...uxfoundation.org>,
	patches <patches@....com>,
	"linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>,
	Keyur Chudgar <kchudgar@....com>,
	"linux-arm-kernel@...ts.infradead.org" 
	<linux-arm-kernel@...ts.infradead.org>,
	Ravi Patel <rapatel@....com>
Subject: Re: [PATCH v4 2/4] Documentation: dts: Add bindings for APM X-Gene
 SoC ethernet driver

On Mon, May 5, 2014 at 2:57 PM, Florian Fainelli <f.fainelli@...il.com> wrote:
> 2014-05-05 14:47 GMT-07:00 Iyappan Subramanian <isubramanian@....com>:
>> This patch adds documentation for APM X-Gene SoC ethernet DTS binding.
>>
>> Signed-off-by: Iyappan Subramanian <isubramanian@....com>
>> Signed-off-by: Ravi Patel <rapatel@....com>
>> Signed-off-by: Keyur Chudgar <kchudgar@....com>
>> ---
>>  .../devicetree/bindings/net/apm-xgene-enet.txt     |   66 ++++++++++++++++++++
>>  1 file changed, 66 insertions(+)
>>  create mode 100644 Documentation/devicetree/bindings/net/apm-xgene-enet.txt
>>
>> diff --git a/Documentation/devicetree/bindings/net/apm-xgene-enet.txt b/Documentation/devicetree/bindings/net/apm-xgene-enet.txt
>> new file mode 100644
>> index 0000000..9ad6fe1
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/net/apm-xgene-enet.txt
>> @@ -0,0 +1,66 @@
>> +APM X-Gene SoC Ethernet nodes
>> +
>> +Ethernet nodes are defined to describe on-chip ethernet interfaces in
>> +APM X-Gene SoC.
>> +
>> +Required properties:
>> +- compatible:          Should be "apm,xgene-enet"
>> +- reg:                 First resource is the ethernet base register set
>> +                       Second resource is the ring base register set
>> +                       Third resource is the ring command register set
>> +- interrupts:          Ethernet main interrupt
>> +- clocks:              Reference to the clock entry.
>> +- local-mac-address:   Ethernet MAC address.
>> +- phy-connection-type: Ethernet MII mode.
>
> - phy-handle is not listed anywhere, yet, present in the example you give.

I will add phy-handle information under required properties.

>
>> +
>> +- mdio device tree subnode: When the X-Gene SoC has a phy connected to its local
>> +               mdio, there must be device tree subnode with the following
>> +               required properties:
>
> In that specific case, 'phy-handle' becomes an optional property.
>
>> +
>> +       - compatible: Must be "apm,xgene-mdio".
>> +       - #address-cells: Must be <1>.
>> +       - #size-cells: Must be <0>.
>> +
>> +       For the phy on the mdio bus, there must be a node with the following
>> +       fields:
>> +
>> +       - reg: phy id used to communicate to phy.
>
> Better refer to Documentation/devicetree/bindings/ethernet/phy.txt
> which contains a more exhaustive binding description for Ethernet PHY
> nodes.
>
>> +
>> +Optional properties:
>> +- status               : Should be "ok" or "disabled" for enabled/disabled.
>> +                         Default is "ok".
>> +
>> +Example:
>> +       menetclk: menetclk {
>> +               compatible = "apm,xgene-device-clock";
>> +               clock-output-names = "menetclk";
>> +               status = "ok";
>> +       };
>> +
>> +       menet: ethernet@...20000 {
>> +               compatible = "apm,xgene-enet";
>> +               status = "disabled";
>> +               reg = <0x0 0x17020000 0x0 0xd100>,
>> +                     <0x0 0X17030000 0x0 0X400>,
>> +                     <0x0 0X10000000 0x0 0X200>;
>
> Since you have mutliple values in your 'reg' property, you could also
> provide an optional 'reg-names' which documents what the register
> ranges are about.

I will add reg-names supplemental property.

>
>> +               interrupts = <0x0 0x3c 0x4>;
>> +               clocks = <&menetclk 0>;
>> +               local-mac-address = [00 01 73 00 00 01];
>> +               phy-connection-type = "rgmii";
>> +               phy-handle = <&menetphy>;
>> +               mdio {
>> +                       compatible = "apm,xgene-mdio";
>> +                       #address-cells = <1>;
>> +                       #size-cells = <0>;
>> +                       menetphy: menetphy@3 {
>
> This PHY node is missing a compatible string as described in
> Documentation/devicetree/bindings/net/ethernet/phy.txt. Your binding
> should also link to that documentation for

I will add the compatible property as per the phy.txt recommendations.

>
>> +                               reg = <0x3>;
>> +                       };
>> +
>> +               };
>> +       };
>> +
>> +/* Board-specific peripheral configurations */
>> +
>> +&menet {
>> +        status = "ok";
>> +};
>> --
>> 1.7.9.5
>>
>>
>> _______________________________________________
>> linux-arm-kernel mailing list
>> linux-arm-kernel@...ts.infradead.org
>> http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
>
>
>
> --
> Florian
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/

Powered by blists - more mailing lists