[Tinyos-2-commits] CVS: tinyos-2.x/doc/txt tep102.txt, 1.1.2.7, 1.1.2.8

[Cory Sharp]

Update of /cvsroot/tinyos/tinyos-2.x/doc/txt
In directory sc8-pr-cvs10.sourceforge.net:/tmp/cvs-serv5231

Modified Files:
      Tag: tinyos-2_0_devel-BRANCH
	tep102.txt 
Log Message:

* Make it more obvious that all precisions are in binary units, effectively
creating a "table" by adding appropriate comments after the timer tag
definitions.

* Fix small typographical error



Index: tep102.txt
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/doc/txt/tep102.txt,v
retrieving revision 1.1.2.7
retrieving revision 1.1.2.8
diff -C2 -d -r1.1.2.7 -r1.1.2.8
*** tep102.txt	18 Oct 2006 17:27:17 -0000	1.1.2.7
--- tep102.txt	18 Oct 2006 17:51:30 -0000	1.1.2.8
***************
*** 79,87 ****
  
  Examples of precision are millisecond, a cycle of a 32kHz clock, and
! microseconds.  All precisions are in "binary" units with respect to
! one second.  That is, one second contains 1024 binary milliseconds,
! 32768 32kHz ticks, or 1048576 microseconds.  This TEP emphasizes
! millisecond and 32kHz tick precisions while reasonably accommodating
! other precisions.
  
  Examples of widths are 8-bit, 16-bit, 32-bit, and 64-bit.  The width
--- 79,87 ----
  
  Examples of precision are millisecond, a cycle of a 32kHz clock, and
! microseconds.  All precisions presented in this TEP are in "binary"
! units with respect to one second.  That is, one second contains 1024
! binary milliseconds, 32768 32kHz ticks, or 1048576 microseconds.
! This TEP emphasizes millisecond and 32kHz tick precisions while
! reasonably accommodating other precisions.
  
  Examples of widths are 8-bit, 16-bit, 32-bit, and 64-bit.  The width
***************
*** 113,119 ****
  TMicro -- written in the standard Timer.h header like this::
  
!   typedef struct { } TMilli;
!   typedef struct { } T32khz;
!   typedef struct { } TMicro;
  
  Note that the precision names are expressed as either frequency or
--- 113,119 ----
  TMicro -- written in the standard Timer.h header like this::
  
!   typedef struct { } TMilli; // 1024 ticks per second
!   typedef struct { } T32khz; // 32768 ticks per second
!   typedef struct { } TMicro; // 1048576 ticks per second
  
  Note that the precision names are expressed as either frequency or
***************
*** 160,169 ****
  
  isOverflowPending() 
- 
    return TRUE if the overflow flag is set for this counter, i.e., if and
    only if an overflow interrupt will occur after the outermost atomic
    block exits.  Return FALSE otherwise.  This command only returns the
    state of the overflow flag and causes no side effect.  It is expected
!   that the underlying hardware platforms sets the overflow flag when
    appropriate.
  
--- 160,168 ----
  
  isOverflowPending() 
    return TRUE if the overflow flag is set for this counter, i.e., if and
    only if an overflow interrupt will occur after the outermost atomic
    block exits.  Return FALSE otherwise.  This command only returns the
    state of the overflow flag and causes no side effect.  It is expected
!   that the underlying hardware platform sets the overflow flag when
    appropriate.