No functional runtime change, but changes to rtos partitioning and the
layout of headers .
This patch creates RTOS specifc header paths and updates spinlock.h
and kernel.h to show the new usage. Other headers will incrementally follow.
It reuses the current zephyr topleve directory and creates a new
toplevel xtos directory for xtos specific files.
Due to the mixing of RTOS, driver and library headers at the top level include
directory it was necessary to create rtos specific header directories i.e.
src/include/rtos-xtos
src/include/rtos-zephyr
These RTOS include directories will eventually contain RTOS specific headers
whilst common logic and structures will be placed in non RTOS directories.
This will also mean
"#include <sof/spinlock.h>"
will become
"#include <rtos/spinlock.h>"
and will allow easier visualisation of where and why RTOS headers are being used.
This will help to eliminate cross usage of headers between RTOSes.
Subsequqnt patches will move more headers and rtos specific wrppaer
source files into rtos specific locations.
Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
Stop ignoring most comments in the trace.h file.
Confusingly, only comments in trace.c were considered because unlike
trace.h, trace.c is not turned off by the preprocessor but by CMake
instead.
Signed-off-by: Marc Herbert <marc.herbert@intel.com>
Lets try and keep 3rd party codec headers as-is without any modifications.
This include doxygen as some references may be in closed headers.
Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
Makes it possible to place the build directory anywhere.
This directory does not seem in use any more; fixing it does not change
the doxygen output. However this does silence a doxygen error message
when the build directory is not in the usual place.
Signed-off-by: Marc Herbert <marc.herbert@intel.com>
Audio stream is an important piece used by components
therefore full documentation is required by component
developers to operate on source and sink buffers
attached ot their components.
Signed-off-by: Marcin Maka <marcin.maka@linux.intel.com>
Some of interface headers are not needed by kernel,
but are needed by user-space applications, so we can split them
into multiple directories that indicate their purpose.
Signed-off-by: Janusz Jankowski <janusz.jankowski@linux.intel.com>
- There is too much undocumented code, so warn about syntax errors
in the existing dox only.
- Breathe does not understand __attribute__, so preproc this out.
Signed-off-by: Marcin Maka <marcin.maka@linux.intel.com>
Integration with sof-docs and breathe does not require
to split the output. So write to a single one and refer
later by doxygen groups.
Signed-off-by: Marcin Maka <marcin.maka@linux.intel.com>
Liam Girdwood