[U-Boot] [PATCH] README: document the requirements for CONFIG_SYS_HZ

[U-Boot] [PATCH] README: document the requirements for CONFIG_SYS_HZ

[Stephen Warren]

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

Signed-off-by: Stephen Warren <swarren@wwwdotorg.org>
---
 README |    6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/README b/README
index 7f2506a..1871ada 100644
--- a/README
+++ b/README
@@ -495,6 +495,12 @@ 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(). This value
+		MUST be 1000.
+
 - Linux Kernel Interface:
 		CONFIG_CLOCKS_IN_MHZ
 
-- 
1.7.10.4

[U-Boot] [PATCH] README: document the requirements for CONFIG_SYS_HZ

[Wolfgang Denk]

Dear Stephen,

In message <1363923692-12748-1-git-send-email-swarren@wwwdotorg.org> you wrote:
> CONFIG_SYS_HZ must be 1000, and get_timer() must therefore return mS.
> Document this.

"must return mS" ? "mS" means Milli-Siemens, which is a unit of
electric conductance and electric admittance.  You mean "ms" =
milliseconds ...

> +- CPU timer options:
> +		CONFIG_SYS_HZ
> +
> +		The frequency of the timer returned by get_timer(). This value
> +		MUST be 1000.

This is misleading, or even incorrect.  If I read this, I would expect
that get_timer() returns 1000. Obviously, this is incorrect.  Instead,
get_timer() returns timestamp information in millisecond resolution.


Best regards,

Wolfgang Denk

-- 
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: wd at denx.de
Crash programs fail because they are based on the theory  that,  with
nine women pregnant, you can get a baby a month.  - Wernher von Braun

[U-Boot] [PATCH] README: document the requirements for CONFIG_SYS_HZ

[Stephen Warren]

On 03/22/2013 03:12 PM, Wolfgang Denk wrote:
> Dear Stephen,
> 
> In message <1363923692-12748-1-git-send-email-swarren@wwwdotorg.org> you wrote:
>> CONFIG_SYS_HZ must be 1000, and get_timer() must therefore return mS.
>> Document this.
> 
> "must return mS" ? "mS" means Milli-Siemens, which is a unit of
> electric conductance and electric admittance.  You mean "ms" =
> milliseconds ...

It seems that's true.

>> +- CPU timer options:
>> +		CONFIG_SYS_HZ
>> +
>> +		The frequency of the timer returned by get_timer(). This value
>> +		MUST be 1000.
> 
> This is misleading, or even incorrect.  If I read this, I would expect
> that get_timer() returns 1000. Obviously, this is incorrect.  Instead,
> get_timer() returns timestamp information in millisecond resolution.

That is not what that sentence means.

[U-Boot] [PATCH] README: document the requirements for CONFIG_SYS_HZ

[Wolfgang Denk]

Dear Stephen Warren,

In message <514CCAAE.6020909@wwwdotorg.org> you wrote:
>
> >> +		The frequency of the timer returned by get_timer(). This value
> >> +		MUST be 1000.
> > 
> > This is misleading, or even incorrect.  If I read this, I would expect
> > that get_timer() returns 1000. Obviously, this is incorrect.  Instead,
> > get_timer() returns timestamp information in millisecond resolution.
> 
> That is not what that sentence means.

Yes, I know.  But it can be easily misinterpreted.

Best regards,

Wolfgang Denk

-- 
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: wd at denx.de
I have a theory that it's impossible to prove anything, but  I  can't
prove it.

[U-Boot] [PATCH] README: document the requirements for CONFIG_SYS_HZ

[Tom Rini]

On Fri, Mar 22, 2013 at 10:41:53PM +0100, Wolfgang Denk wrote:
> Dear Stephen Warren,
> 
> In message <514CCAAE.6020909@wwwdotorg.org> you wrote:
> >
> > >> +		The frequency of the timer returned by get_timer(). This value
> > >> +		MUST be 1000.
> > > 
> > > This is misleading, or even incorrect.  If I read this, I would expect
> > > that get_timer() returns 1000. Obviously, this is incorrect.  Instead,
> > > get_timer() returns timestamp information in millisecond resolution.
> > 
> > That is not what that sentence means.
> 
> Yes, I know.  But it can be easily misinterpreted.

How about:
The frequency of the timer returned by get_timer().  get_timer() must
operate in milliseconds and this CONFIG option must be set to 1000.

-- 
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 836 bytes
Desc: Digital signature
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20130327/a547d207/attachment.pgp>