Add documentation for building and running SOF under Zephyr #297

lyakh · 2020-10-16T11:56:31Z

SOF can be built as a Zephyr application. This document describes the process.

lgirdwood · 2020-10-19T12:20:45Z

getting_started/build-guide/build-with-zephyr.rst

+   :depth: 3
+
+This guide describes the process of building and running |SOF| as a Zephyr
+application.


I would add a note here that it needs v1.6 onwards and is limited to some SOF platforms atm like CAVS.

@lgirdwood Sure, can add, but in fact west will make sure to check out a suitable SOF version, and if you choose to override that, well, you better know what you're doing :-)

aiChaoSONG · 2020-10-20T02:14:47Z

getting_started/build-guide/build-with-zephyr.rst

+.. code-block:: bash
+
+    west build -p -d build-apl -b up_squared_adsp zephyr/samples/audio/sof/ -- -DCMAKE_C_FLAGS=-Izephyr/lib/libc/minimal/include/
+    west sign -d build-apl -t rimage -- -k modules/audio/sof/keys/otc_private_key.pem


I got FATAL ERROR: rimage not found; either install it or provide --tool-path here, seem west doesn't help to build the rimage, I think you may also add some documentation here to describe how rimage is built.

rimage should be checked out by west ? @lyakh are we missing some init to put rimage in zephyr $PATH.

I mean, west build -p -d build-apl -b up_squared_adsp zephyr/samples/audio/sof/ -- -DCMAKE_C_FLAGS=-Izephyr/lib/libc/minimal/include/ this line doesn't help to build rimage, I think. Or I do have zephyr PATH issue, but there should be some docs to describe rimage

@aiChaoSONG there is a tool called west that should do this for you and check out rimage and install in your zephyr $PATH

@lgirdwood FWIW west isn't even fetching rimage for me, let alone building and installing it.

west doesn't support git submodules (which is quite understandable) so this guide is missing at least one git submodule --init update command.

Support for submodules has just been merged in west. To try it:

pip3 uninstall west git clone https://github.com/zephyrproject-rtos/west && \ (cd west && pip3 install --editable .)

Then add submodules: true in the SOF section, see incoming documentation at https://github.com/zephyrproject-rtos/zephyr/pull/31241/files"git submodules in projects"

lgirdwood · 2020-10-23T09:13:57Z

@lyakh ping are you able to fixup today for merge ?

lyakh · 2020-10-23T12:03:34Z

@lyakh ping are you able to fixup today for merge ?

@lgirdwood sure, could do, I wasn't updating this because the actual trees aren't in the state that we want to have them in. We want to only need to issue west init; west build; west sign So the documentation has to reflect the way you build Zephyr+SOF today but this is rather unreliable because the state changes daily, so what we document today will probably be outdated on Monday.
We could mitigate that a bit by pushing a branch to SOF's Zephyr clone and not touching it until upstreaming has completed. Shall I do that? Any preference for the branch name?

marc-hb · 2020-10-24T04:53:05Z

So the documentation has to reflect the way you build Zephyr+SOF today but this is rather unreliable because the state changes daily, so what we document today will probably be outdated on Monday.

In other words this should for now be in a wiki.

lyakh · 2020-10-27T16:05:27Z

@lyakh ping are you able to fixup today for merge ?

@lgirdwood updated. This is still a temporary version with workarounds for the current intermediate status. Please, have a look whether we want it in this form for now or we want to wait until it's all upstream and then basically just say: "follow zephyr guide with 'xxx-adsp-yyy' as a board, then copy the firmware under /lib/firmware/..." and that's it?

marc-hb · 2020-10-27T18:25:44Z

getting_started/build-guide/build-with-zephyr.rst

+    cd rimage/build
+    cmake ..
+    make
+    sudo make install


I never had to install rimage, this is weird.

~~Maybe also a short warning that Zephyr has its own, duplicate copy of rimage that is not used right now?~~ (it hasn't sorry for the noise) thesofproject/sof#3517

I never had to install rimage, this is weird.

@marc-hb I think SOF uses rimage directly from its build directory, whereas Zephyr calls rimage from its signing code by searching standard executable paths or using a command-line parameter

I just saw that west sign has a -p, --tool-path option. Can you try it and mention it as an alternative to sudo?

AFAIK neither Zephyr or SOF ever required root access to build anything (as they should) so this single sudo line would tear all that down. Security concerns aside, root access is a blocker for people using (powerful) shared systems - and you DO need powerful systems if you want to perform any kind of serious sanitycheck testing.

Repeatedly installing is also repetitive and error prone when testing full-of-crashes-rimage itself.

marc-hb · 2020-10-27T18:33:14Z

getting_started/build-guide/build-with-zephyr.rst

+
+    If you need a different SOF version than the one automatically checked out
+    by ``west``, you can change to ``modules/audio/sof`` and use ``git`` to
+    select your preferred version. You need at least version 1.6 to use it with


Add: "make sure you branch or tag your code in git otherwise west update may lose it. See the west user guide."

lgirdwood · 2021-01-12T20:42:38Z

@lyakh ping - can we merge this for v1.7

lgirdwood · 2021-01-18T16:15:01Z

@lyakh ping, can you fix any technical comments. Dont worry too much about grammar as @deb-intel can fix-up.

SOF can be built as a Zephyr application. This document describes the process. Signed-off-by: Guennadi Liakhovetski <[email protected]>

lyakh · 2021-01-20T10:12:33Z

The updated version needs thesofproject/sof#3764

lgirdwood

@deb-intel fyi - technical side good.

lgirdwood · 2021-01-22T16:39:35Z

@lyakh looks like the pR is failing CI

waiting for workers...
/home/travis/build/thesofproject/sof-docs/getting_started/build-guide/build-with-zephyr.rst:4: WARNING: Title underline too short.
Build SOF with `Zephyr <https://zephyrproject.org/>`__
#####################
/home/travis/build/thesofproject/sof-docs/getting_started/build-guide/build-with-zephyr.rst:50: WARNING: Content block expected for the "note" directive; none found.

Can you fix.

lyakh requested review from deb-intel, intelkevinputnam and lgirdwood as code owners October 16, 2020 11:56

lgirdwood requested changes Oct 19, 2020

View reviewed changes

aiChaoSONG reviewed Oct 20, 2020

View reviewed changes

lyakh force-pushed the zephyr branch from 9f7a25c to 615f181 Compare October 27, 2020 16:01

marc-hb reviewed Oct 27, 2020

View reviewed changes

Add documentation for building and running SOF under Zephyr

3ec3f18

SOF can be built as a Zephyr application. This document describes the process. Signed-off-by: Guennadi Liakhovetski <[email protected]>

lyakh force-pushed the zephyr branch from 615f181 to 3ec3f18 Compare January 20, 2021 10:11

lgirdwood approved these changes Jan 22, 2021

View reviewed changes

deb-intel merged commit 95979ba into thesofproject:master Jan 25, 2021

lyakh deleted the zephyr branch February 2, 2021 14:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation for building and running SOF under Zephyr #297

Add documentation for building and running SOF under Zephyr #297

lyakh commented Oct 16, 2020

lgirdwood Oct 19, 2020

lyakh Oct 20, 2020

aiChaoSONG Oct 20, 2020

lgirdwood Oct 20, 2020

aiChaoSONG Oct 20, 2020 •

edited

Loading

lgirdwood Oct 20, 2020

lyakh Oct 20, 2020

marc-hb Oct 23, 2020

marc-hb Jan 13, 2021

lgirdwood commented Oct 23, 2020

lyakh commented Oct 23, 2020

marc-hb commented Oct 24, 2020

lyakh commented Oct 27, 2020

marc-hb Oct 27, 2020 •

edited

Loading

lyakh Oct 28, 2020

marc-hb Oct 28, 2020 •

edited

Loading

marc-hb Oct 27, 2020

lgirdwood commented Jan 12, 2021

lgirdwood commented Jan 18, 2021

lyakh commented Jan 20, 2021

lgirdwood left a comment

lgirdwood commented Jan 22, 2021

Add documentation for building and running SOF under Zephyr #297

Add documentation for building and running SOF under Zephyr #297

Conversation

lyakh commented Oct 16, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aiChaoSONG Oct 20, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lgirdwood commented Oct 23, 2020

lyakh commented Oct 23, 2020

marc-hb commented Oct 24, 2020

lyakh commented Oct 27, 2020

marc-hb Oct 27, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marc-hb Oct 28, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lgirdwood commented Jan 12, 2021

lgirdwood commented Jan 18, 2021

lyakh commented Jan 20, 2021

lgirdwood left a comment

Choose a reason for hiding this comment

lgirdwood commented Jan 22, 2021

aiChaoSONG Oct 20, 2020 •

edited

Loading

marc-hb Oct 27, 2020 •

edited

Loading

marc-hb Oct 28, 2020 •

edited

Loading