Doc: dt: arch_timer: discourage clock-frequency use
authorMark Rutland <mark.rutland@arm.com>
Fri, 20 Mar 2015 17:57:47 +0000 (17:57 +0000)
committerRob Herring <robh@kernel.org>
Thu, 16 Apr 2015 14:08:45 +0000 (09:08 -0500)
commit4155fc07fa9fd691d424e7f8fb64591cccb88788
tree3089c227e3acae3fa2bf6f7ceb9bb3681dc9bf48
parent492a22aceb75e34e7b1c1b300ecc8bef2a2f42dc
Doc: dt: arch_timer: discourage clock-frequency use

The ARM Generic Timer (AKA the architected timer, arm_arch_timer)
features a CPU register (CNTFRQ) which firmware is intended to
initialize, and non-secure software can read to determine the frequency
of the timer. On CPUs with secure state, this register cannot be written
from non-secure states.

The firmware of early SoCs featuring the timer did not correctly
initialize CNTFRQ correctly on all CPUs, requiring the frequency to be
described in DT as a workaround. This workaround is not complete however
as it is exposed to all software in a privileged non-secure mode
(including guests running under a hypervisor). The firmware and DTs for
recent SoCs have followed the example set by these early SoCs.

This patch updates the arch timer binding documentation to make it
clearer that the use of the clock-frequency property is a poor
work-around. The MMIO generic timer binding is similarly updated, though
this is less of a concern as there is generally no need to expose the
MMIO timers to guest OSs.

Signed-off-by: Mark Rutland <mark.rutland@arm.com>
Acked-by: Catalin Marinas <catalin.marinas@arm.com>
Acked-by: Marc Zyngier <marc.zyngier@arm.com>
Acked-by: Olof Johansson <olof@lixom.net>
Acked-by: Stephen Boyd <sboyd@codeaurora.org>
Cc: Rob Herring <robh+dt@kernel.org>
Cc: Will Deacon <will.deacon@arm.com>
Signed-off-by: Rob Herring <robh@kernel.org>
Documentation/devicetree/bindings/arm/arch_timer.txt