[BUG] make CONFIG_SOF_ZEPHYR_STRICT_HEADERS the default #9015

kv2019i · 2024-04-09T15:59:58Z

Describe the bug/enhancement
When rtos include layer was added in #6161 , CONFIG_SOF_ZEPHYR_STRICT_HEADERS was added as a transitory tool.

This is still in place and can cause confusing issues as both XTOS and Zephyr headers are added to the include path by default.

To Reproduce
Build target, check .config

Reproduction Rate
100%

Expected behavior
OS include paths not mixed in build.

Impact
Slows down development of new features.

Environment
SOF main as of 2024-04-09

Work breakdown

Following subtasks identified (breakdown started in v2.11 cycle):

Screenshots or console output

kv2019i · 2024-05-28T10:02:37Z

Not sure I can tackle this in time for v2.10, but assigning for myself, as nobody else is assigned.

kv2019i · 2024-06-05T15:01:26Z

Update for v2.10: spent some time on this trying to make one Intel target build in strict headers mode, but could not complete the task. There is still quite a lot of use of e..g sof/lib/mailbox.h and sof/lib/memory.h in surprising places in audio code that needs to be cleaned up first. Also we have some SOF side functions list SOF list.h and perf_cnt -- for these, move to some common header might be easier. For now moving to v2.11 -- might be able to complete some of this work in June, but won't backport to 2.10 release (as no functional benefit for the release).

kv2019i · 2024-09-10T13:10:28Z

Work breakdown added to the issue description with already done worked marked as done.

Implement sof/lib/dai.h for Zephyr build and do not rely o the xtos version for Zephyr builds. Add a warning to catch invalid build configurations. Link: thesofproject#9015 Signed-off-by: Kai Vehmanen <[email protected]>

Implement sof/lib/dai.h for Zephyr build and do not rely o the xtos version for Zephyr builds. Add a warning to catch invalid build configurations. Link: #9015 Signed-off-by: Kai Vehmanen <[email protected]>

Implement sof/lib/dai.h for Zephyr build and do not rely o the xtos version for Zephyr builds. Add a warning to catch invalid build configurations. Link: thesofproject#9015 Signed-off-by: Kai Vehmanen <[email protected]>

Remove the shim.h interface from RTOS layer as there is no use of this interface anymore in SOF codebase. Link: thesofproject#9015 Signed-off-by: Kai Vehmanen <[email protected]>

sof/list.h is a software interface used by the audio pipeline framework and should not be in the RTOS abstraction layer. Link: thesofproject#9015 Signed-off-by: Kai Vehmanen <[email protected]>

kv2019i · 2024-09-13T07:19:29Z

2.11 cutoff day. Some progress with this. Work breakdown has been done and shared as a task list in bug description. At end of 2.11 cycle, we have 23 out of 35 identified tasks completed. Pushing the remaining work to v2.12.

sof/list.h is a software interface used by the audio pipeline framework and should not be in the RTOS abstraction layer. Link: #9015 Signed-off-by: Kai Vehmanen <[email protected]>

Remove the shim.h interface from RTOS layer as there is no use of this interface anymore in SOF codebase. Link: #9015 Signed-off-by: Kai Vehmanen <[email protected]>

Introduce a separate file for Zephyr compiler_attributes.h and move all Zephyr-specific definitions to this file. This is a prerequisite to build with CONFIG_SOF_ZEPHYR_STRICT_HEADERS=y. Link: thesofproject#9015 Signed-off-by: Kai Vehmanen <[email protected]>

The SOF perf_cnt.h provides a simple performance counter interface that is used in SOF to track performance at audio module and pipeline level. Majority of the implementation is RTOS agnostic, relying on sof_cycle_get_64() to sample platform clock, and timer_get_system() for CPU clock, both defined in rtos/timer.h. There is however some conditional rules for Zephyr to use timing_counter_get() if SOF is built with CONFIG_TIMING_FUNCTIONS=y. The amount of RTOS variation does not seem to warrant branching the whole perf_cnt.h to RTOS layer. Move perf_cnt.h back to application interface, so the single implementation can be shared. Link: thesofproject#9015 Signed-off-by: Kai Vehmanen <[email protected]>

The SOF perf_cnt.h provides a simple performance counter interface that is used in SOF to track performance at audio module and pipeline level. Majority of the implementation is RTOS agnostic, relying on sof_cycle_get_64() to sample platform clock, and timer_get_system() for CPU clock, both defined in rtos/timer.h. There is however some conditional rules for Zephyr to use timing_counter_get() if SOF is built with CONFIG_TIMING_FUNCTIONS=y. The amount of RTOS variation does not seem to warrant branching the whole perf_cnt.h to RTOS layer. Move perf_cnt.h back to application interface, so the single implementation can be shared. Link: #9015 Signed-off-by: Kai Vehmanen <[email protected]>

Implement sof/lib/memory.h for Zephyr build and do not rely on the xtos version for Zephyr builds. Link: thesofproject#9015 Signed-off-by: Kai Vehmanen <[email protected]>

The SOF DMA RTOS interface is one of the largest and also one of the hardest to maintain, as it's used a lot in SOF, and there is unfortunate overlap in interface naming between Zephyr and XTOS. To get the cleanup work started, branch out the sof/lib/dma.h for Zephyr and remove the conditional definitions from both versions. This patch maintains support for all build variants, including building SOF with Zephyr but using XTOS drivers. Link: thesofproject#9015 Signed-off-by: Kai Vehmanen <[email protected]>

The SOF mailbox.h provides an interface to host-DSP mailboxes, which is used widely in SOF IPC and debug code. This interface is OS agnostistic and only relies on platform/lib/mailbox.h to define the mailbox locations, and rtos/cache.h to define portable cache primitives to invalidate/writeback mailbox data before/after use. The amount of RTOS variation does not seem to warrant branching the whole mailbox.h to RTOS layer. Move mailbox.h back to application interface, so the single implementation can be shared. Link: thesofproject#9015 Signed-off-by: Kai Vehmanen <[email protected]>

kv2019i · 2024-10-09T14:36:57Z

Added: xtos/sof/trace/preproc.h

Implement sof/lib/memory.h for Zephyr build and do not rely on the xtos version for Zephyr builds. Link: #9015 Signed-off-by: Kai Vehmanen <[email protected]>

The SOF DMA RTOS interface is one of the largest and also one of the hardest to maintain, as it's used a lot in SOF, and there is unfortunate overlap in interface naming between Zephyr and XTOS. To get the cleanup work started, branch out the sof/lib/dma.h for Zephyr and remove the conditional definitions from both versions. This patch maintains support for all build variants, including building SOF with Zephyr but using XTOS drivers. Link: #9015 Signed-off-by: Kai Vehmanen <[email protected]>

The SOF mailbox.h provides an interface to host-DSP mailboxes, which is used widely in SOF IPC and debug code. This interface is OS agnostistic and only relies on platform/lib/mailbox.h to define the mailbox locations, and rtos/cache.h to define portable cache primitives to invalidate/writeback mailbox data before/after use. The amount of RTOS variation does not seem to warrant branching the whole mailbox.h to RTOS layer. Move mailbox.h back to application interface, so the single implementation can be shared. Link: #9015 Signed-off-by: Kai Vehmanen <[email protected]>

Add Zephyr version of sof/init.h. This is used define main entry points to the SOF application. The arch_init() entry point is not needed on Zephyr. Link: thesofproject#9015 Signed-off-by: Kai Vehmanen <[email protected]>

Move the SOF trace implementation back to app level. While Zephyr logging is preferred solution for newer targets, the old sof-logger can be supported in Zephyr and code exists to support this usage. Move the trace preprocessor back to app level and allow it to be used if CONFIG_TRACE=y is set in the build. Link: thesofproject#9015 Signed-off-by: Kai Vehmanen <[email protected]>

Add Zephyr version of sof/init.h. This is used define main entry points to the SOF application. The arch_init() entry point is not needed on Zephyr. Link: thesofproject#9015 Signed-off-by: Kai Vehmanen <[email protected]>

Add Zephyr version of sof/trace/preproc.h interface. The full preproc.h interface needed for CONFIG_TRACE is not duplicated here, so this commit effectively prevents using CONFIG_TRACE in Zephyr. Link: thesofproject#9015 Signed-off-by: Kai Vehmanen <[email protected]>

Add Zephyr version of sof/init.h. This is used define main entry points to the SOF application. The arch_init() entry point is not needed on Zephyr. Link: thesofproject#9015 Signed-off-by: Kai Vehmanen <[email protected]>

Add Zephyr version of sof/init.h. This is used define main entry points to the SOF application. The arch_init() entry point is not needed on Zephyr. Link: #9015 Signed-off-by: Kai Vehmanen <[email protected]>

Add Zephyr version of sof/trace/preproc.h interface. The full preproc.h interface needed for CONFIG_TRACE is not duplicated here, so this commit effectively prevents using CONFIG_TRACE in Zephyr. Link: thesofproject#9015 Signed-off-by: Kai Vehmanen <[email protected]>

Add Zephyr version of sof/trace/preproc.h interface. The full preproc.h interface needed for CONFIG_TRACE is not duplicated here, so this commit effectively prevents using CONFIG_TRACE in Zephyr. Link: #9015 Signed-off-by: Kai Vehmanen <[email protected]>

Remove CONFIG_SOF_ZEPHYR_STRICT_HEADERS and make strict headers mode the only supported way to build SOF with Zephyr. This means SOF Zephyr builds do not use any headers from sof/xtos/include anymore. This change simplifies the SOF build as full RTOS adaptation is in sof/zephyr/include for Zephyr builds. Link: thesofproject#9015 Signed-off-by: Kai Vehmanen <[email protected]>

Remove CONFIG_SOF_ZEPHYR_STRICT_HEADERS and make strict headers mode the only supported way to build SOF with Zephyr. This means SOF Zephyr builds do not use any headers from sof/xtos/include anymore. This change simplifies the SOF build as full RTOS adaptation is in sof/zephyr/include for Zephyr builds. Link: #9015 Signed-off-by: Kai Vehmanen <[email protected]>

kv2019i · 2024-10-31T08:37:03Z

With #9627 all work for this done, marking this as closed.

kv2019i · 2024-11-29T17:32:34Z

@LaurentiuM1234 wrote:

@kv2019i wrote:

Another approach might be to improve and scale up the "adsp_host_ipc" DT interface used by zephyr/soc/intel/
intel_adsp/common/ipc.c . This is essentially the driver interface to talk to host and I think for longterm it would be

I like the idea of using a driver for the IPC stuff. One aparent flaw I've noticed with our current mailbox implementation
is that it's not really MMU friendly. On imx93 (ARM64 architecture, MMU enabled) we had to deal with this by adding
some static phys-virt mappings inside mmu_regions.c. I'm thinking that, ideally, this shouldn't be required. Instead, we

I filed now a proper enhancement ticket for this #9697
Rest of platform layer starts to be simplified now -- a few tough nuts to crack left, mailbox.h is one of them.

kv2019i added bug Something isn't working as expected Zephyr Issues only observed with Zephyr integrated labels Apr 9, 2024

kv2019i mentioned this issue Apr 9, 2024

[FEATURE][meta] Use Zephyr native interfaces #5794

Open

26 tasks

lgirdwood added this to the v2.10 milestone Apr 16, 2024

kv2019i self-assigned this May 28, 2024

kv2019i modified the milestones: v2.10, v2.11 Jun 5, 2024

This was referenced Sep 9, 2024

platform: intel: ace: remove redundant definitions from memory.h #9450

Merged

base_fw: move SRAM bank details to Intel specific code #9456

Merged

kv2019i added enhancement New feature or request and removed bug Something isn't working as expected labels Sep 10, 2024

kv2019i mentioned this issue Sep 10, 2024

rtos: add Zephyr implementation of sof/lib/dai.h #9457

Merged

kv2019i mentioned this issue Sep 11, 2024

platform/xtos: remove shim.h interface as it's no longer needed #9461

Merged

kv2019i mentioned this issue Sep 12, 2024

xtos: move list.h to application interface #9466

Merged

kv2019i modified the milestones: v2.11, v2.12 Sep 13, 2024

kv2019i added a commit that referenced this issue Sep 16, 2024

xtos: sof/lib/shim.h: remove header

8f3b12f

Remove the shim.h interface from RTOS layer as there is no use of this interface anymore in SOF codebase. Link: #9015 Signed-off-by: Kai Vehmanen <[email protected]>

kv2019i mentioned this issue Sep 18, 2024

zephyr: add rtos/mutex.h #9488

Merged

kv2019i mentioned this issue Sep 18, 2024

rtos: branch compiler_attributes.h for XTOS and Zephyr #9489

Merged

kv2019i mentioned this issue Oct 8, 2024

rtos: add Zephyr implementation of sof/lib/memory.h #9552

Merged

This was referenced Oct 9, 2024

rtos: branch out dma.h for Zephyr and XTOS #9560

Merged

[FEATURE] Clean up SOF DMA interface(s) #9561

Open

kv2019i mentioned this issue Oct 9, 2024

xtos: move sof/lib/mailbox.h to application interface #9562

Merged

kv2019i added a commit that referenced this issue Oct 10, 2024

rtos: add Zephyr implementation of sof/lib/memory.h

18c574c

Implement sof/lib/memory.h for Zephyr build and do not rely on the xtos version for Zephyr builds. Link: #9015 Signed-off-by: Kai Vehmanen <[email protected]>

kv2019i mentioned this issue Oct 17, 2024

zephyr: add Zephyr version of sof/init.h #9592

Merged

kv2019i mentioned this issue Oct 18, 2024

trace: move xtos/include/sof/trace/preproc*.h to app level (and change default for CONFIG_TRACE) (OPTION A) #9598

Closed

kv2019i mentioned this issue Oct 21, 2024

Zephyr preproc.h implementation (OPTION B) #9603

Merged

kv2019i mentioned this issue Oct 30, 2024

zephyr: move to strict headers builds for all targets #9627

Merged

kv2019i closed this as completed Oct 31, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[BUG] make CONFIG_SOF_ZEPHYR_STRICT_HEADERS the default #9015

[BUG] make CONFIG_SOF_ZEPHYR_STRICT_HEADERS the default #9015

kv2019i commented Apr 9, 2024 •

edited

Loading

kv2019i commented May 28, 2024

kv2019i commented Jun 5, 2024

kv2019i commented Sep 10, 2024

kv2019i commented Sep 13, 2024 •

edited

Loading

kv2019i commented Oct 9, 2024

kv2019i commented Oct 31, 2024

kv2019i commented Nov 29, 2024

[BUG] make CONFIG_SOF_ZEPHYR_STRICT_HEADERS the default #9015

[BUG] make CONFIG_SOF_ZEPHYR_STRICT_HEADERS the default #9015

Comments

kv2019i commented Apr 9, 2024 • edited Loading

kv2019i commented May 28, 2024

kv2019i commented Jun 5, 2024

kv2019i commented Sep 10, 2024

kv2019i commented Sep 13, 2024 • edited Loading

kv2019i commented Oct 9, 2024

kv2019i commented Oct 31, 2024

kv2019i commented Nov 29, 2024

kv2019i commented Apr 9, 2024 •

edited

Loading

kv2019i commented Sep 13, 2024 •

edited

Loading