diff mbox

[RESEND,2/2] DT: bindings: add missing Marvell Kirkwood SoC documentation

Message ID 1394054474-4310-3-git-send-email-andrew@lunn.ch (mailing list archive)
State New, archived
Headers show

Commit Message

Andrew Lunn March 5, 2014, 9:21 p.m. UTC 
Marvell Dove SoC binding was not documented, yet. Add the
documentation including the supported SoCs and boards.

Signed-off-by: Andrew Lunn <andrew@lunn.ch>
---
 .../devicetree/bindings/arm/marvell,kirkwood.txt   | 97 ++++++++++++++++++++++
 1 file changed, 97 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/arm/marvell,kirkwood.txt

Comments

Jason Cooper March 6, 2014, 12:23 p.m. UTC | #1 
On Wed, Mar 05, 2014 at 10:21:14PM +0100, Andrew Lunn wrote:
> Marvell Dove SoC binding was not documented, yet. Add the

s/Dove/Kirkwood/

> documentation including the supported SoCs and boards.
> 
> Signed-off-by: Andrew Lunn <andrew@lunn.ch>
> ---
>  .../devicetree/bindings/arm/marvell,kirkwood.txt   | 97 ++++++++++++++++++++++
>  1 file changed, 97 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/arm/marvell,kirkwood.txt
> 
> diff --git a/Documentation/devicetree/bindings/arm/marvell,kirkwood.txt b/Documentation/devicetree/bindings/arm/marvell,kirkwood.txt
> new file mode 100644
> index 000000000000..925ecbf6e7b7
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/arm/marvell,kirkwood.txt
> @@ -0,0 +1,97 @@
> +Marvell Kirkwood SoC Family Device Tree Bindings
> +------------------------------------------------
> +
> +Boards with a SoC of the Marvell Kirkwook family, eg 88f6281

s/Kirkwook/Kirkwood/

> +
> +* Required root node properties:
> +compatible: must contain "marvell,kirkwood"
> +
> +In addition, the above compatible shall be extended with the specific
> +SoC. Currently known SoC compatibles are:
> +
> +"marvell,kirkwood-88f6192"
> +"marvell,kirkwood-88f6281"
> +"marvell,kirkwood-88f6282"
> +"marvell,kirkwood-88f6283"
> +"marvell,kirkwood-88f6702"
> +"marvell,kirkwood-98DX4122"
> +
> +And in addition, the compatible shall be extended with the specific
> +board. Currently known boards are:

This is more a question for Grant and the other DT maintainers: Do we
really need this?  I understand documenting the manufacturer names, but
this looks like an unnecessary maintenance headache.

If the end goal of a separate devicetree repository includes the dts{i}
files and the binding docs in one repository, why do we need to maintain
this list?

thx,

Jason.

> +
> +"buffalo,lschlv2"
> +"buffalo,lsxhl"
> +"buffalo,lsxl"
> +"dlink,dns-320"
> +"dlink,dns-320-a1"
> +"dlink,dns-325"
> +"dlink,dns-325-a1"
> +"dlink,dns-kirkwood"
> +"excito,b3"
> +"globalscale,dreamplug-003-ds2001"
> +"globalscale,guruplug"
> +"globalscale,guruplug-server-plus"
> +"globalscale,sheevaplug"
> +"globalscale,sheevaplug"
> +"globalscale,sheevaplug-esata"
> +"globalscale,sheevaplug-esata-rev13"
> +"iom,iconnect"
> +"iom,iconnect-1.1"
> +"iom,ix2-200"
> +"keymile,km_kirkwood"
> +"lacie,cloudbox"
> +"lacie,inetspace_v2"
> +"lacie,laplug"
> +"lacie,netspace_lite_v2"
> +"lacie,netspace_max_v2"
> +"lacie,netspace_mini_v2"
> +"lacie,netspace_v2"
> +"marvell,db-88f6281-bp"
> +"marvell,db-88f6282-bp"
> +"marvell,mv88f6281gtw-ge"
> +"marvell,rd88f6281"
> +"marvell,rd88f6281"
> +"marvell,rd88f6281-a0"
> +"marvell,rd88f6281-a1"
> +"mpl,cec4"
> +"mpl,cec4-10"
> +"netgear,readynas"
> +"netgear,readynas"
> +"netgear,readynas-duo-v2"
> +"netgear,readynas-nv+-v2"
> +"plathome,openblocks-a6"
> +"plathome,openblocks-a7"
> +"raidsonic,ib-nas6210"
> +"raidsonic,ib-nas6210-b"
> +"raidsonic,ib-nas6220"
> +"raidsonic,ib-nas6220-b"
> +"raidsonic,ib-nas62x0"
> +"seagate,dockstar"
> +"seagate,goflexnet"
> +"synology,ds109"
> +"synology,ds110jv10"
> +"synology,ds110jv20"
> +"synology,ds110jv30"
> +"synology,ds111"
> +"synology,ds209"
> +"synology,ds210jv10"
> +"synology,ds210jv20"
> +"synology,ds212"
> +"synology,ds212jv10"
> +"synology,ds212jv20"
> +"synology,ds212pv10"
> +"synology,ds409"
> +"synology,ds409slim"
> +"synology,ds410j"
> +"synology,ds411"
> +"synology,ds411j"
> +"synology,ds411slim"
> +"synology,ds413jv10"
> +"synology,rs212"
> +"synology,rs409"
> +"synology,rs411"
> +"synology,rs812"
> +"usi,topkick"
> +"usi,topkick-1281P2"
> +"zyxel,nsa310"
> +"zyxel,nsa310a"
> -- 
> 1.9.0
>
Andrew Lunn March 6, 2014, 12:44 p.m. UTC | #2 
On Thu, Mar 06, 2014 at 07:23:00AM -0500, Jason Cooper wrote:
> On Wed, Mar 05, 2014 at 10:21:14PM +0100, Andrew Lunn wrote:
> > Marvell Dove SoC binding was not documented, yet. Add the
> 
> s/Dove/Kirkwood/

Doh. I cut/paste from the Dove file.
 
> > documentation including the supported SoCs and boards.
> > 
> > Signed-off-by: Andrew Lunn <andrew@lunn.ch>
> > ---
> >  .../devicetree/bindings/arm/marvell,kirkwood.txt   | 97 ++++++++++++++++++++++
> >  1 file changed, 97 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/arm/marvell,kirkwood.txt
> > 
> > diff --git a/Documentation/devicetree/bindings/arm/marvell,kirkwood.txt b/Documentation/devicetree/bindings/arm/marvell,kirkwood.txt
> > new file mode 100644
> > index 000000000000..925ecbf6e7b7
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/arm/marvell,kirkwood.txt
> > @@ -0,0 +1,97 @@
> > +Marvell Kirkwood SoC Family Device Tree Bindings
> > +------------------------------------------------
> > +
> > +Boards with a SoC of the Marvell Kirkwook family, eg 88f6281
> 
> s/Kirkwook/Kirkwood/

I really need to add Kirkwood to my dictionary.
 
> > +
> > +* Required root node properties:
> > +compatible: must contain "marvell,kirkwood"
> > +
> > +In addition, the above compatible shall be extended with the specific
> > +SoC. Currently known SoC compatibles are:
> > +
> > +"marvell,kirkwood-88f6192"
> > +"marvell,kirkwood-88f6281"
> > +"marvell,kirkwood-88f6282"
> > +"marvell,kirkwood-88f6283"
> > +"marvell,kirkwood-88f6702"
> > +"marvell,kirkwood-98DX4122"
> > +
> > +And in addition, the compatible shall be extended with the specific
> > +board. Currently known boards are:
> 
> This is more a question for Grant and the other DT maintainers: Do we
> really need this?

checkpatch.pl says yes, we need this. It gives warnings for every
unknown compatible string. I would say it is up to Grant and the other
DT maintainers to decide if checkpatch.pl is wrong.

       Andrew
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/arm/marvell,kirkwood.txt b/Documentation/devicetree/bindings/arm/marvell,kirkwood.txt
new file mode 100644
index 000000000000..925ecbf6e7b7
--- /dev/null
+++ b/Documentation/devicetree/bindings/arm/marvell,kirkwood.txt
@@ -0,0 +1,97 @@ 
+Marvell Kirkwood SoC Family Device Tree Bindings
+------------------------------------------------
+
+Boards with a SoC of the Marvell Kirkwook family, eg 88f6281
+
+* Required root node properties:
+compatible: must contain "marvell,kirkwood"
+
+In addition, the above compatible shall be extended with the specific
+SoC. Currently known SoC compatibles are:
+
+"marvell,kirkwood-88f6192"
+"marvell,kirkwood-88f6281"
+"marvell,kirkwood-88f6282"
+"marvell,kirkwood-88f6283"
+"marvell,kirkwood-88f6702"
+"marvell,kirkwood-98DX4122"
+
+And in addition, the compatible shall be extended with the specific
+board. Currently known boards are:
+
+"buffalo,lschlv2"
+"buffalo,lsxhl"
+"buffalo,lsxl"
+"dlink,dns-320"
+"dlink,dns-320-a1"
+"dlink,dns-325"
+"dlink,dns-325-a1"
+"dlink,dns-kirkwood"
+"excito,b3"
+"globalscale,dreamplug-003-ds2001"
+"globalscale,guruplug"
+"globalscale,guruplug-server-plus"
+"globalscale,sheevaplug"
+"globalscale,sheevaplug"
+"globalscale,sheevaplug-esata"
+"globalscale,sheevaplug-esata-rev13"
+"iom,iconnect"
+"iom,iconnect-1.1"
+"iom,ix2-200"
+"keymile,km_kirkwood"
+"lacie,cloudbox"
+"lacie,inetspace_v2"
+"lacie,laplug"
+"lacie,netspace_lite_v2"
+"lacie,netspace_max_v2"
+"lacie,netspace_mini_v2"
+"lacie,netspace_v2"
+"marvell,db-88f6281-bp"
+"marvell,db-88f6282-bp"
+"marvell,mv88f6281gtw-ge"
+"marvell,rd88f6281"
+"marvell,rd88f6281"
+"marvell,rd88f6281-a0"
+"marvell,rd88f6281-a1"
+"mpl,cec4"
+"mpl,cec4-10"
+"netgear,readynas"
+"netgear,readynas"
+"netgear,readynas-duo-v2"
+"netgear,readynas-nv+-v2"
+"plathome,openblocks-a6"
+"plathome,openblocks-a7"
+"raidsonic,ib-nas6210"
+"raidsonic,ib-nas6210-b"
+"raidsonic,ib-nas6220"
+"raidsonic,ib-nas6220-b"
+"raidsonic,ib-nas62x0"
+"seagate,dockstar"
+"seagate,goflexnet"
+"synology,ds109"
+"synology,ds110jv10"
+"synology,ds110jv20"
+"synology,ds110jv30"
+"synology,ds111"
+"synology,ds209"
+"synology,ds210jv10"
+"synology,ds210jv20"
+"synology,ds212"
+"synology,ds212jv10"
+"synology,ds212jv20"
+"synology,ds212pv10"
+"synology,ds409"
+"synology,ds409slim"
+"synology,ds410j"
+"synology,ds411"
+"synology,ds411j"
+"synology,ds411slim"
+"synology,ds413jv10"
+"synology,rs212"
+"synology,rs409"
+"synology,rs411"
+"synology,rs812"
+"usi,topkick"
+"usi,topkick-1281P2"
+"zyxel,nsa310"
+"zyxel,nsa310a"