devicetree.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Sergei Shtylyov <sergei.shtylyov@cogentembedded.com>
To: Geert Uytterhoeven <geert@linux-m68k.org>
Cc: Rob Herring <robh+dt@kernel.org>, Pawel Moll <pawel.moll@arm.com>,
	Mark Rutland <mark.rutland@arm.com>,
	Ian Campbell <ijc+devicetree@hellion.org.uk>,
	galak@codeaurora.org,
	"devicetree@vger.kernel.org" <devicetree@vger.kernel.org>,
	Rob Landley <rob@landley.net>,
	"linux-doc@vger.kernel.org" <linux-doc@vger.kernel.org>,
	Max Filippov <jcmvbkbc@gmail.com>
Subject: Re: [PATCH v3] DT: net: document Ethernet bindings in one place
Date: Fri, 31 Jan 2014 23:54:14 +0300	[thread overview]
Message-ID: <52EC0D76.9020701@cogentembedded.com> (raw)
In-Reply-To: <CAMuHMdV6QNGAh8s40z766N6HMboUW_eO85Gs7p0JBAuZ6vW1Nw@mail.gmail.com>

Hello.

On 01/28/2014 11:26 AM, Geert Uytterhoeven wrote:

>> --- /dev/null
>> +++ net-next/Documentation/devicetree/bindings/net/ethernet.txt
>> @@ -0,0 +1,23 @@
>> +The following properties are common to the Ethernet controllers:
>> +
>> +- local-mac-address: array of 6 bytes, specifies the MAC address that was
>> +  assigned to the network device;
>> +- mac-address: array of 6 bytes, specifies the MAC address that was last used by
>> +  the boot program; should be used in cases where the MAC address assigned to
>> +  the device by the boot program is different from the "local-mac-address"
>> +  property;
>> +- max-speed: number, specifies maximum speed in Mbit/s supported by the device;
>> +- max-frame-size: number, maximum transfer unit (IEEE defined MTU), rather than
>> +  the maximum frame size (there's contradiction in ePAPR).
>> +- phy-mode: string, operation mode of the PHY interface; supported values are
>> +  "mii", "gmii", "sgmii", "tbi", "rev-mii", "rmii", "rgmii", "rgmii-id",
>> +  "rgmii-rxid", "rgmii-txid", "rtbi", "smii", "xgmii"; not recommended for new
>> +  bindings;
>> +- phy-connection-type: the same as "phy-mode" property but described in ePAPR;
>> +- phy-handle: phandle, specifies a reference to a node representing a PHY
>> +  device; this property is described in ePAPR and so preferred;
>> +- phy: the same as "phy-handle" property, not recommended for new bindings.

> I think it would be more clear to move the not recommended ones to a new
> paragraph, with a preamble stating they're not recommended for new bindings.

    In fact, at the moment, only "phy" prop can be named as not recommended, 
the "phy-mode" should better be described as de facto standard as it's 
mentioned even in ePAPR 1.1 examples (and of_get_phy_mode() patch to recognize 
"phy-connection-type" as well as "phy-mode" prop probably got lost somewhere). 
Thus I'm not sure it's worth creating separate paragraph for the sake of one 
prop is worth it now. Although there's also "phy-device" which I didn't 
mention here (and IIRC there's some more non-standard ways to address the PHY)...

WBR, Sergei


      reply	other threads:[~2014-01-31 20:54 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-01-28  0:16 [PATCH v3] DT: net: document Ethernet bindings in one place Sergei Shtylyov
2014-01-28  8:26 ` Geert Uytterhoeven
2014-01-31 20:54   ` Sergei Shtylyov [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=52EC0D76.9020701@cogentembedded.com \
    --to=sergei.shtylyov@cogentembedded.com \
    --cc=devicetree@vger.kernel.org \
    --cc=galak@codeaurora.org \
    --cc=geert@linux-m68k.org \
    --cc=ijc+devicetree@hellion.org.uk \
    --cc=jcmvbkbc@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=mark.rutland@arm.com \
    --cc=pawel.moll@arm.com \
    --cc=rob@landley.net \
    --cc=robh+dt@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).