From: Stephen Warren <swarren@wwwdotorg.org>
Date: Wed, 27 Mar 2013 17:06:41 +0000 (+0000)
Subject: README: document the requirements for CONFIG_SYS_HZ
X-Git-Tag: v2013.04-rc2~5
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=795659dc1ce275fcc39d6501affa0c03fd663038;p=u-boot

README: document the requirements for CONFIG_SYS_HZ

CONFIG_SYS_HZ must be 1000, and get_timer() must therefore return ms.
Document this.

README text provided by Tom Rini.

Signed-off-by: Stephen Warren <swarren@wwwdotorg.org>
---

diff --git a/README b/README
index 1d51828252..57010161f5 100644
--- a/README
+++ b/README
@@ -496,6 +496,13 @@ The following options need to be configured:
 		exists, unlike the similar options in the Linux kernel. Do not
 		set these options unless they apply!
 
+- CPU timer options:
+		CONFIG_SYS_HZ
+
+		The frequency of the timer returned by get_timer().
+		get_timer() must operate in milliseconds and this CONFIG
+		option must be set to 1000.
+
 - Linux Kernel Interface:
 		CONFIG_CLOCKS_IN_MHZ