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>

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>
Stephen Warren · Tom Rini
1 parent b343bbb528
Showing 1 changed file with 7 additions and 0 deletions Side-by-side Diff
README
@@ -496,6 +496,13 @@
 		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
...	...	@@ -496,6 +496,13 @@
496	496	exists, unlike the similar options in the Linux kernel. Do not
497	497	set these options unless they apply!
498	498
	499	+- CPU timer options:
	500	+ CONFIG_SYS_HZ
	501	+
	502	+ The frequency of the timer returned by get_timer().
	503	+ get_timer() must operate in milliseconds and this CONFIG
	504	+ option must be set to 1000.
	505	+
499	506	- Linux Kernel Interface:
500	507	CONFIG_CLOCKS_IN_MHZ
501	508