OrgACRN
/
sof
mirror of https://github.com/thesofproject/sof.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
2,611 Commits 190 Branches 209 Tags 54 MiB
C 65.6%
M4 11.1%
Assembly 6.5%
Python 5.4%
MATLAB 5.1%
Other 6.2%
Go to file
Diana Ungureanu bdf5346cc6 rimage: Align block comments on each line 
Signed-off-by: Diana Ungureanu <diana-gabriela.ungureanu@nxp.com>
 		2019-03-14 10:29:17 +00:00
doc dox: reformatted documentation for component and ipc control 2019-02-04 12:42:03 +00:00
rimage rimage: Align block comments on each line 2019-03-14 10:29:17 +00:00
scripts scripts: clean up the build dir for tools 2019-03-11 20:49:40 +00:00
src dmic: improve readability 2019-03-14 10:13:22 +00:00
test memory: prework for memcpy calls change 2019-03-14 10:05:47 +00:00
tools tools: fix a typo 2019-03-14 10:13:22 +00:00
.gitignore cmake: doc build files added to gitignore 2019-01-29 11:43:56 +01:00
.travis.yml CI: travis: update the docker hub organization 2019-01-31 20:35:44 +00:00
CMakeLists.txt cmake: add build counter 2019-02-11 11:53:32 +00:00
CODEOWNERS CODEOWNERS: add mrajwa as code owner of kpb and gdb files 2019-03-10 17:50:55 +01:00
Kconfig platform: make IOMUX, SPI, DW_GPIO a Kconfig option 2019-03-04 17:52:36 +01:00
LICENCE licence: update for kconfig and elf.h 2019-02-01 11:12:36 +00:00
README.md readme: update for cmake 2019-01-23 20:11:00 +00: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:

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

Cherrytrail:

cmake -DTOOLCHAIN=xtensa-cht-elf -DROOT_DIR=`pwd`/../../xtensa-root/xtensa-cht-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