CMake is to be used instead of autotools. So remove the autotools
files.

This revert commit f6bf4b0 and
commit 0d33e87

Signed-off-by: Daniel Leung <[email protected]>

This adds the necessary bits to allow building rimage
with CMake with similar configure options as the just
removed autotools files.

Also update README.md for new build instructions.

Signed-off-by: Daniel Leung <[email protected]>

This reflects the changes on SOF project commit
b3c1679.

Signed-off-by: Daniel Leung <[email protected]>

Since both fw.h and manifest.h are being used in the main SOF
repo and also here in the standalone rimage repo, to prevent
them getting out of sync, the SOF main repo is going to use
the ones coming from the rimage repo. So there is no need for
the option anymore.

Signed-off-by: Daniel Leung <[email protected]>

Code formatting should be consistent and function arguments
should be aligned to opening parenthesis.

Signed-off-by: Karol Trzcinski <[email protected]>

Unused arguments shouldn't be passed to function because it
makes code messy.

Signed-off-by: Karol Trzcinski <[email protected]>

This changes the LICENSE file to match the LICENSE file
from the main SOF repo, except they entries for the kconfig
scripts which are not here in this repo.

Signed-off-by: Daniel Leung <[email protected]>

Fixes following error when compiling code:
...
src/elf.c: In function ‘elf_find_section’:
src/elf.c:469:20: error: initialization discards ‘const’ qualifier
           from pointer target type [-Werror=discarded-qualifiers]
  469 |  Elf32_Ehdr *hdr = &module->hdr;
      |                    ^
cc1: all warnings being treated as errors
...

Signed-off-by: Andrei Emeltchenko <[email protected]>

Fixes issue ".init_array" is not copied to ri image making it zero
filled. This causes Zephyr crashing trying to execute functions from
this section.

Signed-off-by: Andrei Emeltchenko <[email protected]>

Enable simple build test for rimage.

Signed-off-by: Pan Xiuli <[email protected]>

In many functions there is need to read user section content
and check firmware version or write section content to some
manifest or dictionary. Previously to do it, in each function
was loop to search for proper section in proper module,
then allocate buffer, read content and check for possible error
between each step what is quite overwhelming. After change there
will be one function responsible for this task.

Signed-off-by: Karol Trzcinski <[email protected]>

Extended manifest is a place to store metadata about firmware, known during
compilation time - for example firmware version or used compiler.
Given information are read on host side before firmware startup.
This part of output binary is not signed.

Signed-off-by: Karol Trzcinski <[email protected]>

This name is used in different part of source code so should refer
to single place instead by copied.

Signed-off-by: Karol Trzcinski <[email protected]>

Such a solution improve code hermentization and flexibility.
Also such a solution is more relevant because of focus on particular
module during section reading, so there won't be possibility to
implicity scan section 'A' from first module and section 'B' from
second one.

Signed-off-by: Karol Trzcinski <[email protected]>

elf_read_section() returns section size when everything is ok,
so ret value should be reset to 0 after this function call

Signed-off-by: Karol Trzcinski <[email protected]>

Try to build extended manifest only when `e` flag will be set,
to prevent error and warning printing during creating optional
part of formware image.

Signed-off-by: Karol Trzcinski <[email protected]>

ret variable is always set in elf_read_section(), to initial value
is not important.

Signed-off-by: Karol Trzcinski <[email protected]>

This part of binary should contain valid firmware version.

Signed-off-by: Karol Trzcinski <[email protected]>

Sometimes they will be different and this will make developer
aware of the differences

Signed-off-by: Adrian Bonislawski <[email protected]>

some sections may use different lma than vma address,
in such case rimage needs to use lma

Signed-off-by: Adrian Bonislawski <[email protected]>

Generator is part of rimage tool and there is any reference to them
in kernel source code, so it should be moved out of kernel folder.

Signed-off-by: Karol Trzcinski <[email protected]>

Because there is possibility to reference headers from this repo
from another one, there is a need to put every header into rimage
namespace. Otherwise reference to headers from duplicated
namespace (like kernel) from external repo may be ambiguous.
Update guard ifdef/define/endif sequence value, to make it more
unique

Signed-off-by: Karol Trzcinski <[email protected]>

Path added to include should end at 'include' as usual, then
it is easy to see where specific headers comes from during reading
source code. It is especially important for projects composed from
a few parts, like firmware, driver, build and debug tools in this
project.
Moreover changed "" to <> in include directives because there is
specified full path to file from project include root and to be
aligned with code style from firmware repository,

Signed-off-by: Karol Trzcinski <[email protected]>

Unlike hardcoded target_compile_options(-g) can be overriden from the
command line, from the parent ExternalProject_Add(CMAKE_ARGS) (tested)
or from a CMake GUI (not tested).

Default to Debug because the time spent running rimage is negligible
compared to building the image to sign and because the time saved
learning CMake when it crashes can be huge for some people.

BTW -O2 -g is rarely ever useful.

Signed-off-by: Marc Herbert <[email protected]>

This makes the write_firmware NULL pointer added by commit
dd77445 and corresponding crash more user-friendly.
Before:

  Program received signal SIGSEGV, Segmentation fault.

After:

  rimage: src/rimage.c:197: main: Assertion `image.adsp->write_firmware'
  failed.

Signed-off-by: Marc Herbert <[email protected]>

This feature is not used by SOF anyway and only causes
FW load failures, we can set it to 0xffff so it will
work for ADL+ platforms.

Signed-off-by: Janusz Jankowski <[email protected]>

TOML aims to be a minimal configuration file format that's easy to read
due to obvious semantics. TOML is designed to map unambiguously to a hash table.

Signed-off-by: Karol Trzcinski <[email protected]>

This part should be moved to separate function,
to allow easily add another way of machine description.

Signed-off-by: Karol Trzcinski <[email protected]>

Exported function will be used in configuration parser, to
assign correct function version depending on manifest versiony

Signed-off-by: Karol Trzcinski <[email protected]>

This allow to add new platform with old version of rimage tool.
Default values are easily to define for any fields, so fields
duplication in config files should be reduced.

Signed-off-by: Karol Trzcinski <[email protected]>

Given config files may be used as template for new platforms.

Signed-off-by: Karol Trzcinski <[email protected]>

Used platform should be defined by config file, given in
-c option. Double ways of defining platform may lead to
missalignement, so old way should be removed.

Signed-off-by: Karol Trzcinski <[email protected]>

It allows to assure right version of chosen headers during
reading logs in verbose mode.

Signed-off-by: Karol Trzcinski <[email protected]>

This field left without possibility to set value from
config file.

Signed-off-by: Karol Trzcinski <[email protected]>

Memory clear allows to easily set seserved/padding fields to zero.

Signed-off-by: Karol Trzcinski <[email protected]>

Set right write function.

Signed-off-by: Karol Trzcinski <[email protected]>

Error codes like ENOKEY and EBADE are not provide for all windows
toolchains, so to immit possible build errors, some more standard
error codes should be used.
Detailed error message is printed in stderr, so end user still
will be well informed about error source.

Signed-off-by: Karol Trzcinski <[email protected]>

Warnings may point some fatal error in source code.

Signed-off-by: Karol Trzcinski <[email protected]>

Then each warning message should be addressed.

Signed-off-by: Karol Trzcinski <[email protected]>

Commit https://github.com/thesofproject/soft/commits/59d81995f6828 added
an -l option (for --liam? :-) which was never implemented. Remove it
because silently discarding user input is really not nice no matter how
wrong it is.

Signed-off-by: Marc Herbert <[email protected]>

Also rename elf_argc to first_non_opt because it's a position, not a
count.

Signed-off-by: Marc Herbert <[email protected]>

Passing a 64 bits ELF file by accident (for instance: '/usr/bin/openssl'
while messing up the command line options) caused an interesting cascade
of errors and memory corruption which are all caught in this commit.

This doesn't make rimage fuzz-proof far from it; only fool-proof which
is still useful.

In passing add some quotes so the error message when failing to find the
SHT_NULL section with an empty name is a little bit more readable.

Signed-off-by: Marc Herbert <[email protected]>

…ents

Caveat: this was just reported by valgrind. I did not test any actual
toml parsing error either (who tests error handling?) but this code
can't be worse than the previous one.

Signed-off-by: Marc Herbert <[email protected]>

It's encouraged to use version with $(...).
    Backtick command substitution `...` is legacy
    syntax with several issues.

   1. It has a series of undefined behaviors related to quoting in POSIX.
   2. It imposes a custom escaping mode with surprising results.
   3. It's exceptionally hard to nest.

   ~https://github.com/koalaman/shellcheck/wiki/SC2006

Signed-off-by: Karol Trzcinski <[email protected]>

Checkpatch is a tool which checks patch code style
alignment with Linux kernel code.
By the way print short graphs of used commits, to
show whats under test.
Checkpatch call is precede by `set -x`, to show used
arguments values, especially checked commits range.

Signed-off-by: Karol Trzcinski <[email protected]>

Does not solve thesofproject#3423 but
converts a buffer overflow and crash into a more usable assert.

Buffer overflow found by running rimage with valgrind and the binaries
provided by @singalsu

Signed-off-by: Marc Herbert <[email protected]>

manifest.c: assert buffer overflow in man_copy_sram()

ri_sha*() functions are often called with arguments calculated on
the fly, so at list basic assertion here may save debugging time
in the future.
Cast size to uint64_t to properly handle nagative sizes, casted to
uint32_t in argument list. Otherwise, sum size and offset may
overflow uint32_t and don't trigger assert.

Signed-off-by: Karol Trzcinski <[email protected]>

As suggested by Karol in the review of the next commit. Makes the
function call shorter and naming the parameters makes the code much more
readable. Can help for debugging too.

Absolutely zero change: the two CMAKE_BUILD_TYPE=Release rimage binaries
before and after this commit are actually identical.

In passing, replace void * arithmetic in that function
with char *. void * arithmetic is an actually illegal gcc
extension (not just "undefined").

Signed-off-by: Marc Herbert <[email protected]>

Found by chance and reproduced by making a typo in the key's filename.

Note there is already an (unchanged) error message:

 pkcs: signing with key sof/keys/otc_private_key_3k.pemX
 error: can't open file sof/keys/otc_private_key_3k.pemX -2
 Firmware manifest and signing completed !

But now rimage does not pretend success and the build does not keep
going with an unsigned image like nothing happened.

Signed-off-by: Marc Herbert <[email protected]>

This task is fully separatable from adsp_parse_config_fd(),
so should be done in separate function, to improve code readability.

Signed-off-by: Karol Trzcinski <[email protected]>

This approach allows to easily expand parsers list in future,
without harming code readability.

Signed-off-by: Karol Trzcinski <[email protected]>

Any generated file should be tracked by git to keep repositiry clean.
Such an file should be added to .gitignore to reduce possibility of
accidentally pushig this file to remote branches, eg. after typing
`git add *` before pushing changes.

Signed-off-by: Karol Trzcinski <[email protected]>

Also show useful "make help" that lists all targets.

Show -B option of CMake that avoids changing the current directory to
the build directory: especially inconvenient considering the
recommended, CMake way to clean is to delete this directory and the
recommended way to build multiple configurations is to use multiple
build directories.

-B was introduced in CMake 3.13 which has been released two years ago
now and CMake spoils its users with a choice of ways to upgrade:

https://cmake.org/download/
 https://apt.kitware.com/
 https://pypi.org/project/cmake/

This does _not_ imply CMakeLists.txt should drop backward compatibility
with CMake < 3.13. I only think a README.md file should not keep the
majority of users in the dark only for the convenience of a minority of
obsolete CMake users.

Signed-off-by: Marc Herbert <[email protected]>

Now aligns with actual offsets.

Signed-off-by: Liam Girdwood <[email protected]>

Header contests are the same but with bigger key.

Signed-off-by: Liam Girdwood <[email protected]>

Add simple crc32 function to calculate the checksum for v2.5 headers.
Implementation is very simple using shift register as we don't require
speed. Calculate the v2.5 header checksum with crc-32/iso-hdlc
parameters.

Signed-off-by: Jaska Uimonen <[email protected]>
Signed-off-by: Liam Girdwood <[email protected]>

cavs2.5 has different offsets and structures.

Signed-off-by: Liam Girdwood <[email protected]>

Signed-off-by: Liam Girdwood <[email protected]>

Add RSA PSS signing support for CAVS 2.5 platforms.

Signed-off-by: Liam Girdwood <[email protected]>

Used by other clients now.

Signed-off-by: Liam Girdwood <[email protected]>

cavs2.5 has different offsets for plat auth data.

Signed-off-by: Liam Girdwood <[email protected]>

cavs 2.5 uses a larger key and the RSA signing PSS mode.

Signed-off-by: Liam Girdwood <[email protected]>

This type was used by early versions of meu, but the hash is not
used in later versions. Leave the code in in case it has to come back.

Signed-off-by: Liam Girdwood <[email protected]>

Add support to verify signatures of cavs firmware binaries.

Signed-off-by: Liam Girdwood <[email protected]>

ICL and JSL is same DSP with differnt HW config.
They can share same toml file

Signed-off-by: Pan Xiuli <[email protected]>

Add tgl-h toml file to support sof-tgl-h.ri binary build

Signed-off-by: Pan Xiuli <[email protected]>

This comment is meant for "git grep salt", that's its main purpose.

Much more obvious timestamps aside, this new code is the only
non-deterministic part of rimage - learned the very hard way
(OpenSSL "documentation" calls it "sLen"...)

A/B testing of build system changes is much, much easier when
locally and temporarily making the build 100% deterministic.

Signed-off-by: Marc Herbert <[email protected]>

It wasn't exactly obvious who does what.

Signed-off-by: Marc Herbert <[email protected]>

Add support of cavs extended manifest and modules. Now
we will have another config tgl-cavs for tgl.

Signed-off-by: Rander Wang <[email protected]>

sec_buffer allocated inside elf_read_section()
was not being freed before and is freed now.

Signed-off-by: Karol Trzcinski <[email protected]>

Function parameters should be separated by ', '.

Signed-off-by: Karol Trzcinski <[email protected]>

'key' argument must describe 'key' which triggered error message
to keep stderr output helpful.

Signed-off-by: Karol Trzcinski <[email protected]>

cppcheck find

Signed-off-by: Curtis Malainey <[email protected]>

memory clearly has exit path through argument, factor out temporary
variable to silence cppcheck

Signed-off-by: Curtis Malainey <[email protected]>

found via cppcheck

Signed-off-by: Curtis Malainey <[email protected]>

CI saves lives

Signed-off-by: Curtis Malainey <[email protected]>

Issue detected by Klocwork

Signed-off-by: Slawomir Blauciak <[email protected]>

We have 46 bank HP and 1 bank LP SRAM on TGL, change to toml config file
to reflect that.

Signed-off-by: Keyon Jie <[email protected]>

We have 30 bank HP and 1 bank LP SRAM on TGL-H, change to toml config file
to reflect that.

Signed-off-by: Keyon Jie <[email protected]>

We have 47 bank HP and 1 bank LP SRAM on ICL, change to toml config file
to reflect that.

Signed-off-by: Keyon Jie <[email protected]>

We have 16 bank HP and 1 bank LP SRAM on JSL, change to toml config file
to reflect that.

Signed-off-by: Keyon Jie <[email protected]>

We have 47 bank HP and 1 bank LP SRAM on CNL, change to toml config file
to reflect that.

Signed-off-by: Keyon Jie <[email protected]>

We have 8 bank HP and 2 bank LP SRAM on APL, change to toml config file
to reflect that.

Signed-off-by: Keyon Jie <[email protected]>

Apply "config: tgl: change image_size to the real SRAM size"
(9e50a02) to tgl-cavs

Signed-off-by: Rander Wang <[email protected]>

We have 47 bank HP and 1 bank LP SRAM on Suecreek, change the toml config file
to reflect that.

Signed-off-by: Keyon Jie <[email protected]>

We have 30 bank HP and 2 bank LP SRAM on KBL, change to toml config file
to reflect that.

Signed-off-by: Keyon Jie <[email protected]>

We have 30 bank HP and 2 bank LP SRAM on SKL, change to toml config file
to reflect that.

Signed-off-by: Keyon Jie <[email protected]>

Add rn toml file to support sof-rn.ri binary build

Signed-off-by: Basavaraj Hiregoudar <[email protected]>
Signed-off-by: Anup Kulkarni <[email protected]>
Signed-off-by: balapati <[email protected]>

Add imx8ulp toml file to support sof-imx8ulp.ri binary build.

Signed-off-by: Zhang Peng <[email protected]>

This patch fixes the potential overflow which may happen during
conversion of signed long. On a platforms where signed long
is only 32 bits the address which is stored in temp_s will experience
overflow.

Signed-off-by: Marcin Rajwa <[email protected]>

Add mt8195.toml to support sof-mt8195.ri binary build.
Add mt8195 memory layout
Add mt8195 machine_id

Signed-off-by: YC Hung <[email protected]>
Signed-off-by: Allen-KH Cheng <[email protected]>