michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: Various corrections to Kernel Primer

Browse source 
* Ensures all references to kernel functions are correctly
  tagged so they will auto-link to the API guide.

* Adds references to a few functions and macros that were
  omitted.

Change-Id: I26ccd9c29ea123db2807f2df4d05d574932c6849
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
This commit is contained in:
Allan Stephens 2016-11-15 14:37:27 -05:00 • committed by Anas Nashif
commit d423cd3c0f
12 changed files with 45 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc/kernel_v2/other/float.rst
View file

@ -106,19 +106,19 @@ pre-tag a thread using one of the techniques listed below.
* A dynamically-spawned x86 thread can be pre-tagged by passing the
:c:macro:`K_FP_REGS` or :c:macro:`K_SSE_REGS` option to
:c:func:`k_thread_spawn()`.
:cpp:func:`k_thread_spawn()`.
* An already-spawned x86 thread can pre-tag itself once it has started
by passing the :c:macro:`K_FP_REGS` or :c:macro:`K_SSE_REGS` option to
:c:func:`k_float_enable()`.
:cpp:func:`k_float_enable()`.
If an x86 thread uses the floating point registers infrequently it can call
:c:func:`k_float_disable()` to remove its tagging as an FPU user or SSE user.
:cpp:func:`k_float_disable()` to remove its tagging as an FPU user or SSE user.
This eliminates the need for the kernel to take steps to preserve
the contents of the floating point registers during context switches
when there is no need to do so.
When the thread again needs to use the floating point registers it can re-tag
itself as an FPU user or SSE user by calling :c:func:`k_float_enable()`.
itself as an FPU user or SSE user by calling :cpp:func:`k_float_enable()`.
Implementation
**************