sof/zephyr
Marc Herbert 4bdefd7e0a zephyr/docker-build.sh: explain why we autodetect with FindZephyr-sdk
Pure comment change, no code change.

Kudos to Stephanos Ioannidis for patiently explaining this to me on
Discord.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2024-02-19 14:20:07 +00:00
..
include zephyr: interrupt.h: conditionally include drivers/interrupt.h 2024-01-29 14:53:26 +00:00
lib lib: alloc: k_panic is not required in failure case 2024-02-14 14:56:39 +00:00
scripts xtensa-build-zephyr.py: add new rimage_west_configuration() 2023-05-26 10:47:51 +03:00
test vmh test: extend test for spanning 2023-12-08 15:29:06 +02:00
CMakeLists.txt lib-manager: fork a copy for LLEXT support 2024-01-26 17:56:14 +02:00
FindZephyr-sdk.cmake .github: de-hardcode zephyr SDK version in sparse build 2022-10-10 11:29:05 +01:00
Kconfig test: add boot-time ztest-based testing 2023-12-08 15:29:06 +02:00
README zephyr: replace obsolete README section with link to sof-docs 2022-02-07 10:43:28 +00:00
boot_test.c test: add boot-time ztest-based testing 2023-12-08 15:29:06 +02:00
docker-build.sh zephyr/docker-build.sh: explain why we autodetect with FindZephyr-sdk 2024-02-19 14:20:07 +00:00
docker-run.sh workflows: Upgrade docker container to v0.26.6 2023-12-14 11:34:12 +02:00
edf_schedule.c zephyr: edf-schedule: fix CONTAINER_OF type 2023-08-31 22:14:37 +03:00
lib.c zephyr: Add zephyr lib.c standalone file 2022-11-11 15:57:50 +02:00
module.yml zephyr: module: point to where the app is 2022-07-18 14:22:01 +01:00
schedule.c header: rtos: use rtos specific version of alloc.h 2022-09-12 11:44:27 +01:00
wrapper.c cleanup: remove direct inclusion of drivers/interrupt.h 2024-01-29 14:53:26 +00:00

README

SOF with Zephyr RTOS
====================

SOF currently uses the Cadence Xtos/HAL and it's own kernel functions as
its RTOS. SOF is moving to use Zephyr as it's RTOS in parallel to current
releases using xtos.

The initial "alpha" of SOF on Zephyr will use the Zephyr RTOS for boot, IRQs,
scheduling and memory allocation. Subsequent release will use more Zephyr
functionality as code is moved from SOF to Zephyr (i.e. EDF scheduler updates
copied from SOF to Zephyr).

Building SOF on Zephyr
======================

Section promoted to
https://thesofproject.github.io/latest/getting_started/build-guide/build-with-zephyr.html

Testing on Qemu
===============

Get the SOF qemu sof-v4.2 branch here.

git@github.com:thesofproject/qemu.git

Configure as

./configure' '--prefix=.' '--target-list=xtensa-softmmu,x86_64-softmmu' \
             '--enable-gtk' '--enable-sdl' '--enable-spice' \
             '--audio-drv-list=alsa' '--enable-libusb' \
             '--enable-usb-redir' '--enable-coroutine-pool' \
             '--disable-opengl' '--enable-fdt'

 Then run make.

FW can be tested as follows using the qemu helper script.

 ./xtensa-host.sh apl \
     -r ../../sof/sof/build_apl_gcc/src/arch/xtensa/rom-apl.bin \
     -k ../../zephyrproject/zephyr/build/zephyr/zephyr.ri

Where -r and -k are used to specify the ROM and kernel files.

The ROMS can be built from the SOF repo by running

./scripts/xtensa-build-all.sh  -r -a

Using console
-------------

Using logging and simulator backend with processing printk (LOG_PRINTK)
can bring console in qemu.

 - Enable xtensa simulator logging backend (LOG_BACKEND_XTENSA_SIM).
 - Enable printk processing(LOG_PRINTK)
 - Add "-semihosting" to qemu command line. Make sure it goes through scripts to real qemu.