Go to file
Shreeya Patel 79b39ccc9b gen-doc.sh: Use getopts for parsing arguments
Use getopts to parse the arguments instead of manual parsing to leave no
room for errors, bugs, and inconsistent conventions introduced by custom
implementation.

Signed-off-by: Shreeya Patel <shreeya.patel23498@gmail.com>
2020-03-31 15:10:34 +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 tools: add support for static uuids section 2020-03-06 10:15:04 +01:00
scripts gen-doc.sh: Use getopts for parsing arguments 2020-03-31 15:10:34 +01:00
src src: Remove unneeded ret variable 2020-03-31 15:01:14 +01:00
test test: cmocka: Use ARRAY_SIZE 2020-03-31 15:01:14 +01:00
tools topology: cmake: silence super chatty alsatplg unless VERBOSE=1 2020-03-30 14:59:51 +01:00
.gitignore gitignore: Ignore cscope cache files 2019-12-04 15:41:33 +02:00
.travis.yml CI: travis: Add boot test for i.MX8M 2020-03-24 14:28:45 +00:00
CMakeLists.txt cmake: build option for clang static analyzer 2020-03-04 11:02:56 +01:00
CODEOWNERS Add CODEOWNERS for DCBlocker 2020-03-30 14:48:52 +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