michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: remove unused CONFIG_ options, fix x-ref to existing ones

Browse source 
Config options KERNEL_EVENT_{INTERRUPT, CONTEXT, SLEEP} don't exist
any more, removed.

Move to use :option:`CONFIG_XYZ` vs :option:`XYZ` to generate propert
links and avoid warnings about unexistant targets.

Change-Id: Ibafa155f474a05329a8cac7bff5c55800d9f31a4
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
This commit is contained in:
Inaky Perez-Gonzalez 2016-06-13 17:35:59 -07:00 • committed by Anas Nashif
commit 88322e4382
1 changed files with 5 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

29
doc/kernel/nanokernel/nanokernel_kernel_event_logger.rst
View file

@ -24,38 +24,19 @@ These options can be found in the following path :file:`kernel/Kconfig`.
General kernel event logger configuration: General kernel event logger configuration:
* :option:`KERNEL_EVENT_LOGGER_BUFFER_SIZE` * :option:`CONFIG_KERNEL_EVENT_LOGGER_BUFFER_SIZE`
Default size: 128 words, 32-bit length. Default size: 128 words, 32-bit length.
Profiling points configuration: Profiling points configuration:
* :option:`KERNEL_EVENT_INTERRUPT` * :option:`CONFIG_KERNEL_EVENT_LOGGER_DYNAMIC`
Enables recording of interrupt-driven events by providing timestamp information.
* :option:`KERNEL_EVENT_SLEEP`
Enables recording of sleep events:
* Timestamp when the CPU went to sleep mode.
* Timestamp when the CPU woke up.
* The interrupt Id that woke the CPU up.
* :option:`KERNEL_EVENT_CONTEXT`
Enables recording of context-switching events. Details include:
* Which thread is leaving the CPU.
* Timestamp when the event has occurred.
* :option:`KERNEL_EVENT_LOGGER_DYNAMIC`
Allows modifying at runtime the events to record. At boot no event is recorded if enabled Allows modifying at runtime the events to record. At boot no event is recorded if enabled
This flag adds functions allowing to enable/disable recoding of kernel event logger and This flag adds functions allowing to enable/disable recoding of kernel event logger and
task monitor events. task monitor events.
* :option:`KERNEL_EVENT_LOGGER_CUSTOM_TIMESTAMP` * :option:`CONFIG_KERNEL_EVENT_LOGGER_CUSTOM_TIMESTAMP`
Enables the possibility to set the timer function to be used to populate kernel event logger Enables the possibility to set the timer function to be used to populate kernel event logger
timestamp. This has to be done at runtime by calling sys_k_event_logger_set_timer and providing timestamp. This has to be done at runtime by calling sys_k_event_logger_set_timer and providing
@ -120,13 +101,13 @@ The timestamp used by the kernel event logger is 32-bit LSB of platform HW timer
Lakemont APIC timer for Quark SE). This timer period is very small and leads to timestamp Lakemont APIC timer for Quark SE). This timer period is very small and leads to timestamp
wraparound happening quite often (e.g. every 134s for Quark SE). wraparound happening quite often (e.g. every 134s for Quark SE).
see :option:`SYS_CLOCK_HW_CYCLES_PER_SEC` see :option:`CONFIG_SYS_CLOCK_HW_CYCLES_PER_SEC`
This wraparound must be considered when analyzing kernel event logger data and care must be This wraparound must be considered when analyzing kernel event logger data and care must be
taken when tickless idle is enabled and sleep duration can exceed maximum HW timer value. taken when tickless idle is enabled and sleep duration can exceed maximum HW timer value.
Timestamp used by the kernel event logger can be customized by enabling following option: Timestamp used by the kernel event logger can be customized by enabling following option:
:option:`KERNEL_EVENT_LOGGER_CUSTOM_TIMESTAMP` :option:`CONFIG_KERNEL_EVENT_LOGGER_CUSTOM_TIMESTAMP`
In case this option is enabled, a callback function returning a 32-bit timestamp must In case this option is enabled, a callback function returning a 32-bit timestamp must
be provided to the kernel event logger by calling the following function at runtime: be provided to the kernel event logger by calling the following function at runtime: