michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: Edit common_kernel_clocks.rst

Browse source 
Corrected typos and added headings to API section to
enhance readability.

Change-Id: I5a43edfdd6a8ac7735d8f00823058f6a2661439f
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
This commit is contained in:
L.S. Cook 2016-02-22 12:27:30 -08:00 • committed by Gerrit Code Review
commit bebd38c8d1
1 changed files with 9 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

17
doc/kernel/common/common_kernel_clocks.rst
View file

@ -18,8 +18,8 @@ The kernel supports two distinct clocks.
* A 32-bit *hardware clock*, which is used as the source of the ticks * A 32-bit *hardware clock*, which is used as the source of the ticks
for the system clock. This clock is a counter measured in unspecified for the system clock. This clock is a counter measured in unspecified
units (called *cycles*), and increments at a frequency units (called *cycles*), and increments at a frequency determined by
determined by the soc.hardware. the hardware.
The kernel allows this clock to be accessed directly by reading The kernel allows this clock to be accessed directly by reading
the timer. the timer.
@ -107,7 +107,8 @@ between two points in time.
APIs APIs
**** ****
The following kernel clock APIs are provided by :file:`microkernel.h`: Kernel clock APIs provided by :file:`microkernel.h`
===================================================
:cpp:func:`sys_tick_get()`, :cpp:func:`sys_tick_get_32()` :cpp:func:`sys_tick_get()`, :cpp:func:`sys_tick_get_32()`
Read the system clock. Read the system clock.
@ -115,8 +116,8 @@ The following kernel clock APIs are provided by :file:`microkernel.h`:
:cpp:func:`sys_tick_delta()`, :cpp:func:`sys_tick_delta_32()` :cpp:func:`sys_tick_delta()`, :cpp:func:`sys_tick_delta_32()`
Compute the elapsed time since an earlier system clock reading. Compute the elapsed time since an earlier system clock reading.
The following kernel clock APIs are provided by :file:`microkernel.h` Kernel clock APIs common to both :file:`microkernel.h`and :file:`nanokernel.h`
and by :file:`nanokernel.h`: ==============================================================================
:cpp:func:`sys_tick_get()`, :cpp:func:`sys_tick_get_32()` :cpp:func:`sys_tick_get()`, :cpp:func:`sys_tick_get_32()`
Read the system clock. Read the system clock.
@ -125,10 +126,10 @@ and by :file:`nanokernel.h`:
Compute the elapsed time since an earlier system clock reading. Compute the elapsed time since an earlier system clock reading.
:cpp:func:`sys_cycle_get_32()` :cpp:func:`sys_cycle_get_32()`
Reads hardware clock. Read hardware clock.
The following kernel clock variables are provided by :file:`microkernel.h` Kernel clock variables common to both :file:`microkernel.h` and :file:`nanokernel.h`
and by :file:`nanokernel.h`: ====================================================================================
:c:data:`sys_clock_ticks_per_sec` :c:data:`sys_clock_ticks_per_sec`
The number of system clock ticks in a single second. The number of system clock ticks in a single second.