Go to file
Marc Herbert e76ccbad59 scripts/xtensa-build-all.sh: clarify help of -c option
"Configure defconfig" misses the most important, interactive difference.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2020-06-16 09:04:05 +01:00
.github/ISSUE_TEMPLATE github: fix link to bug tracking docs 2020-01-09 11:24:06 +00:00
doc audio-stream: dox: add full api documentation 2020-03-28 13:04:55 +01:00
keys Move signing key pair from rimage/ up one level 2020-05-13 10:16:04 +01:00
rimage@9f3f2d7d71 rimage: Update to version with changed headers location 2020-05-29 11:15:22 +01:00
scripts scripts/xtensa-build-all.sh: clarify help of -c option 2020-06-16 09:04:05 +01:00
smex rimage: Update to version with changed headers location 2020-05-29 11:15:22 +01:00
src ext_man: Port SOF_IPC_EXT_WINDOW to extended manifest 2020-06-12 11:16:56 +01:00
test trace: Filter messages in runtime 2020-06-10 11:51:41 +01:00
tools topology: Add jsl+ MX98360a amp with ALC5682 Headset codec 2020-06-12 11:00:28 +01:00
zephyr zephyr: readme: add qemu instructions. 2020-04-21 20:34:34 +01:00
.gitignore .gitignore: don't ignore all .* hidden files in every subdirectory 2020-06-03 14:21:00 +03:00
.gitmodules Add rimage as a git submodule 2020-05-13 10:16:04 +01:00
.travis.yml .travis.yml: add IRC notifications 2020-06-11 18:57:42 +01:00
CMakeLists.txt rimage: Update to version with changed headers location 2020-05-29 11:15:22 +01:00
CODEOWNERS Remove rimage from source tree 2020-05-13 10:16:04 +01:00
Kconfig kconfig: remove cAVS menu 2020-06-10 10:40:02 +01:00
LICENCE Remove rimage from source tree 2020-05-13 10:16:04 +01:00
README.md README.md: fix Travis badge not to show the random PR of the moment 2020-06-10 10:56:24 +01:00

README.md

Sound Open Firmware

Status

Build Status Gitter chat IRC chat

Documentation

See docs

Prerequisites

  • Docker
  • CMake (version >= 3.10)

Build Instructions

  1. Create directory in checked out repo for build files:
mkdir build && cd build
  1. Run configuration for your toolchain:

Baytrail / Cherrytrail:

cmake -DTOOLCHAIN=xtensa-byt-elf -DROOT_DIR=`pwd`/../../xtensa-root/xtensa-byt-elf ..

Haswell / Broadwell:

cmake -DTOOLCHAIN=xtensa-hsw-elf -DROOT_DIR=`pwd`/../../xtensa-root/xtensa-hsw-elf ..

Apollolake:

cmake -DTOOLCHAIN=xtensa-apl-elf -DROOT_DIR=`pwd`/../../xtensa-root/xtensa-apl-elf ..

Cannonlake:

cmake -DTOOLCHAIN=xtensa-cnl-elf -DROOT_DIR=`pwd`/../../xtensa-root/xtensa-cnl-elf ..
  1. Apply default config for your platform.

Baytrail:

make baytrail_defconfig

Cherrytrail:

make cherrytrail_defconfig

Haswell:

make haswell_defconfig

Broadwell:

make broadwell_defconfig

Apollolake:

make apollolake_defconfig

Cannonlake:

make cannonlake_defconfig
  1. (Optional) Customize your configuration
make menuconfig
  1. Build firmware
make bin
# or `make bin -j<jobs>` for parallel build

Running the tests

See unit testing documentation

Deployment

TODO: Add additional notes about how to deploy this on a live system

Contributing

See Contributing to the Project

License

This project is licensed under the BSD Clause 3 - see the LICENCE file for details