clocksource: sh_tmu: Document r8a7779 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:58 +0000 (10:10 +0900)
commit0ad5adc42f4d7630394fa542ce87fb94a919ad48
treeb283fbb7e04809919bba76dc9a8977aea7705c3b
parent3f24140ff66ec61af497d4fb6d9bae0d9ebf2aca
clocksource: sh_tmu: Document r8a7779 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 Timer Unit (TMU) 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 r8a7779 SoC.
commit 471269b790aec03385dc4fb127ed7094ff83c16d

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 in keeping with a similar though more extensive patch for CMT

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