Skip to contentSkip to conversation

README: document the requirements for CONFIG_SYS_HZ

PATCH New Stephen Warren 3 participants 5 messages Mar 22, 2013 – Mar 27, 2013

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 README: document the requirements for CONFIG_SYS_HZ

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

---
 README |    6 ++++++
 1 file changed, 6 insertions(+)
README +6 -0
index 7f2506a..1871ada 100644
@@ -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
 
Signature · 1 line
1.7.10.4
#1 lore raw

PATCH 1/1 README: document the requirements for CONFIG_SYS_HZ

Dear Stephen,

Quoted 2 lines · In message <[email protected]> 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 ...

README The following options need to be configured: · line 502

Quoted 5 lines

+- CPU timer options:

README +4 -0
+		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

Signature · 5 lines
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
#2 lore raw

PATCH 1/1 README: document the requirements for CONFIG_SYS_HZ

Quoted 9 lines · Wolfgang Denk

Dear Stephen,

Quoted 2 lines · In message <[email protected]> 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.

Quoted 9 lines

README The following options need to be configured: · line 502

Quoted 5 lines

+- CPU timer options:

README +4 -0
+		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.

#3 lore raw

PATCH 1/1 README: document the requirements for CONFIG_SYS_HZ

Dear Stephen Warren,

Quoted 9 lines · In message <[email protected]> you wrote:
Quoted 7 lines

README The following options need to be configured: · line 502

Quoted 3 lines
README +2 -0
+		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

Signature · 5 lines
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.
#4 lore raw

PATCH 1/1 README: document the requirements for CONFIG_SYS_HZ

Quoted 11 lines · Wolfgang Denk

Dear Stephen Warren,

Quoted 8 lines · In message <[email protected]> you wrote:
Quoted 7 lines

README The following options need to be configured: · line 502

Quoted 3 lines
README +2 -0
+		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.

Quoted 3 lines
Quoted 1 line

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.

Signature · 8 lines
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>