mirror of https://github.com/thesofproject/sof.git
d98a7ed103
checkpatch is currently checking for changes that need ABI updates and actual ABI changes in the same loop in process(). So if some file that needs an ABI change comes first, a WARNING will be issued. Look for an actual ABI change before starting to crunch the entire patch line by line. Signed-off-by: Dragos Tarcatu <dragos_tarcatu@mentor.com> |
||
---|---|---|
.github/ISSUE_TEMPLATE | ||
doc | ||
rimage | ||
scripts | ||
src | ||
test | ||
tools | ||
.gitignore | ||
.travis.yml | ||
CMakeLists.txt | ||
CODEOWNERS | ||
Kconfig | ||
LICENCE | ||
README.md |
README.md
Sound Open Firmware
Status
Documentation
See docs
Prerequisites
- Docker
- CMake (version >= 3.10)
Build Instructions
- Create directory in checked out repo for build files:
mkdir build && cd build
- 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 ..
- 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
- (Optional) Customize your configuration
make menuconfig
- 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