clocksource: sh_mtu2: Document r7s72100 binding
authorSimon Horman <horms+renesas@verge.net.au>
Wed, 27 Aug 2014 04:36:51 +0000 (13:36 +0900)
committerSimon Horman <horms+renesas@verge.net.au>
Fri, 5 Dec 2014 01:10:39 +0000 (10:10 +0900)
commitb6fff59c5b5648d663a2bfc90f36ad8a2cafbfb2
treebbbcc7f71963e9fb2b598dc17aef3a909266e1d0
parent3f24140ff66ec61af497d4fb6d9bae0d9ebf2aca
clocksource: sh_mtu2: Document r7s72100 binding

In general Renesas hardware is not documented to the extent
where the relationship between IP blocks on different SoCs can be assumed
although they may appear to operate the same way. Furthermore the
documentation typically does not specify a version for individual
IP blocks. For these reasons a convention of using the SoC name in place
of a version and providing SoC-specific compat strings has been adopted.

Although not universally liked this convention is used in the bindings
for a number of drivers for Renesas hardware. The purpose of this patch is
to update the Renesas R-Car Multi-Function Timer Pulse Unit 2 (MTU2) driver
to follow this convention.

Signed-off-by: Simon Horman <horms+renesas@verge.net.au>
Acked-by: Geert Uytterhoeven <geert+renesas@glider.be>
Acked-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
* I plan to follow up with a patch patch to use the new binding in the
  dtsi files for the r7s72100 SoC.

v2
* Suggestions by Mark Rutland and Sergei Shtylyov
  - Compatible strings should be "one or more" not "one" of those listed
  - Describe the generic binding as covering any MTU2 device
  - Re-order compat strings from most to least specific

v3
* Suggested by Laurent Pinchart
  - Reword compat documentation for consistency with a more extensive
    CMT change

(cherry picked from commit ffd24a543afe4c693d5c611ecfa01cc48e97f97d)
Signed-off-by: Simon Horman <horms+renesas@verge.net.au>
Documentation/devicetree/bindings/timer/renesas,mtu2.txt