mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-08-25 06:35:22 +00:00
128dcbbe13
By default, kernel event logger is using the system timer. But on some platforms where the timer driver maintains the system timer cycle accumulator in software, such as ones using the LOAPIC timer, the system timer behavior leads to timestamp errors. For example, the timer interrupt is logged with a wrong timestamp since the HW timer value has been reset (periodic mode) but accumulated value not updated yet (done later in the ISR). This patch is adding the possibility to register a timer callback function that will be used by the kernel event logger. For example, on Quark SE, this allows using RTC or AON counter which accuracy is sufficient and behavior more straight forward compared to system timer. Change-Id: I754c7557350ef29fc10701e62a35a5425e035f11 Signed-off-by: Fabrice Olivero <fabrice.olivero@intel.com> |
||
|---|---|---|
| .. | ||
| api | ||
| application | ||
| bluetooth | ||
| board | ||
| contribute | ||
| crypto | ||
| drivers | ||
| getting_started | ||
| kernel | ||
| porting | ||
| reference | ||
| scripts/genrest | ||
| subsystems | ||
| themes/zephyr | ||
| about_zephyr.rst | ||
| conf.py | ||
| doxygen.config | ||
| index.rst | ||
| Makefile | ||
| README.rst | ||
| substitutions.rst | ||
Welcome to Zephyr Kernel ######################## .. This document is in Restructured Text Format. Find more information regarding the ReST markup in the `ReST documentation`_. This is a comment that won't show up in formatted output Welcome to the Zephyr Project. Thank you for your interest in the Zephyr Project. These instructions are designed to walk you through generating the Zephyr Project's documentation. Documentation Notes ******************* The project's documentation currently comprises the following items: * An Installation Guide for Linux host systems * A set of Collaboration Guidelines for the project. * Doxygen output from the code base for all APIs. Installing the documentation processors *************************************** Install the current version of ``Sphinx``, type: .. code-block:: bash $ git clone https://github.com/sphinx-doc/sphinx.git sphinx $ cd sphinx $ sudo -E python setup.py install $ cd .. $ git clone https://github.com/michaeljones/breathe.git breathe $ cd breathe $ sudo -E python setup.py install .. note:: Make sure that ``Doxygen`` is installed in your system. The installation of Doxygen is beyond the scope of this document. Running the Documentation Generators ************************************ Assuming that the Zephyr Project tree with the doc directory is in ``DIRECTORY``, type: .. code-block:: bash $ cd DIRECTORY/doc $ make doxy html Find the output in ``DIRECTORY/doc/_build/html/index.html`` Review the available formats with: .. code-block:: bash $ make -C DIRECTORY/doc doxy html If you want the LaTeX PDF output, you need to install all the Latex packages first. That installation is beyond the scope of this document. .. _ReST documentation: http://sphinx-doc.org/rest.html