Skip to content

GoPerry/sof

Repository files navigation

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

About

Sound Open Firmware

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C60.6%
  • Assembly7.7%
  • M46.2%
  • Python6.1%
  • C++5.8%
  • MATLAB4.6%
  • Other9.0%