Go to file
Daniel Baluta 472b82bc1c README: Add IRC badge
This will help people reach #sof IRC channel easier.
Clicking on the badge will allow people to join IRC
chat via irccloud webclient or prompt for their local
IRC client.

Signed-off-by: Daniel Baluta <daniel.baluta@nxp.com>
2020-05-21 14:08: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@f23b2c2d07 Add rimage as a git submodule 2020-05-13 10:16:04 +01:00
scripts cmake: use SOF_ROOT_SOURCE_DIRECTORY for git submodule 2020-05-18 14:39:40 +01:00
smex cmake: use fw.h and manifest.h from rimage/ 2020-05-13 10:16:04 +01:00
src Audio: Add intermediate size SRC coefficients set 2020-05-21 09:37:36 +01:00
test trace: replace TRACE_CLASS_ by uuids 2020-04-30 11:39:37 +02:00
tools Topology: HDA-generic: Use +20 dB EQ gain for 16 kHz DMIC capture 2020-05-21 10:01:37 +01:00
zephyr zephyr: readme: add qemu instructions. 2020-04-21 20:34:34 +01:00
.gitignore Remove rimage from source tree 2020-05-13 10:16:04 +01:00
.gitmodules Add rimage as a git submodule 2020-05-13 10:16:04 +01:00
.travis.yml CI: Travis: enable host testbnech again 2020-05-13 10:38:12 +01:00
CMakeLists.txt cmake: merge BUILD_LIBRARY and CONFIG_LIBRARY 2020-05-18 13:25:28 +01:00
CODEOWNERS Remove rimage from source tree 2020-05-13 10:16:04 +01:00
Kconfig memory: change LP_SRAM to helper config 2020-02-04 11:30:02 +00:00
LICENCE Remove rimage from source tree 2020-05-13 10:16:04 +01:00
README.md README: Add IRC badge 2020-05-21 14:08:05 +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