OrgACRN
/
sof
mirror of https://github.com/thesofproject/sof.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
4,891 Commits 191 Branches 212 Tags 54 MiB
C 65.6%
M4 11.1%
Assembly 6.5%
Python 5.4%
MATLAB 5.1%
Other 6.2%
Go to file
Marc Herbert d92d3e9883 CI: travis: add doxygen stage 
Before this new stage, doxygen was run only in a completely different
repo (sof-docs). So it was possible to submit totally broken doxygen
changes and get no doxygen feedback at all from CI before merge.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
 		2020-04-08 10:53:21 +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
rimage rimage: Remove ldc generation ability 2020-04-03 16:27:04 +01:00
scripts cmake: add *_overridedefconfig targets 2020-04-03 20:20:43 +01:00
smex smex: Add elf modules content validation 2020-04-03 16:27:04 +01:00
src buffer: tell realloc to not copy the old content 2020-04-08 10:51:37 +01:00
test alloc: fix potential oob in rbrealloc 2020-04-08 10:51:37 +01:00
tools alloc: fix potential oob in rbrealloc 2020-04-08 10:51:37 +01:00
.gitignore gitignore: Ignore cscope cache files 2019-12-04 15:41:33 +02:00
.travis.yml CI: travis: add doxygen stage 2020-04-08 10:53:21 +01:00
CMakeLists.txt cmake: build option for clang static analyzer 2020-03-04 11:02:56 +01:00
CODEOWNERS CODEOWNERS: scripts/ += marc-hb 2020-04-04 20:06:49 +01:00
Kconfig memory: change LP_SRAM to helper config 2020-02-04 11:30:02 +00:00
LICENCE licence: update for kconfig and elf.h 2019-02-01 11:12:36 +00:00
README.md Updated Readme for cht configuration 2019-04-26 10:42:41 +01:00

README.md

Sound Open Firmware

Status

Build Status

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