state: backend_storage: harmonize code with barebox ...

This ports the following barebox commit:

| commit f389531
| Author: Lucas Stach <l.stach@pengutronix.de>
| Date:   Fri Jul 22 15:00:19 2016 +0200
|
|     state: only build circular backend if MTD is enabled
|
|     The circular backend depends on MTD symbols and is only useful
|     if MTD is present. Exclude it from the build if MTD is not enabled.
|
|     Signed-off-by: Lucas Stach <l.stach@pengutronix.de>
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>

state: keep backward compatibility ...

Introduce the new build time option '--enable-state-backward-compatibility' to
port the following barebox commit.

NOTE: This changes barebox-state's default behaviour.

| commit 480cde1
| Author: Juergen Borleis <jbe@pengutronix.de>
| Date:   Tue Aug 15 15:46:31 2017 +0200
|
|     state: keep backward compatibility
|
|     Previous 'state' variable set variants do not know and use metadata. The
|     'direct' storage backend's read function honors this, but not its
|     counterpart the write function. This makes an update of the 'state'
|     variable set impossible.
|     This change makes backward compatibility explicit, else it complains in
|     the read function as well. With some more debug output it helps the
|     developer to do things right.
|
|     Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>

state: drop unused code and declarations for non-existing functions ...

This ports the following barebox commit:

| commit 452a994
| Author: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
| Date:   Wed Sep 11 21:27:37 2019 +0200
|
|     state: drop unused code and declarations for non-existing functions
|
|     state_get_name() is not used and so can be removed.
|     state_backend_dtb_file() and state_backend_raw_file() were dropped in
|     c999b507da98 ("state: Refactor state framework").
|
|     Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>

state: backend_bucket_circular: mark block as bad if mtd_peb_torture() failed ...

This ports the following barebox commit:

| commit 3b68dbc
| Author: Sascha Hauer <s.hauer@pengutronix.de>
| Date:   Mon Jul 15 15:28:55 2019 +0200
|
|     mtd: peb: Do not mark as bad in mtd_peb_torture()
|
|     Both the Kernel and mtd-utils have peb torture functions and both
|     do not mark the block as bad automatically. Instead, the caller
|     must mark the block as bad when -EIO is returned from the torture
|     function. Do the same in barebox. This is necessary as the UBI code
|     otherwise may mark a block as bad twice: Once indirectly in
|     mtd_peb_torture() and then directly afterwards.
|
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>

state: check length ...

This ports the following barebox commit:

| commit 9271182
| Author: Jan Remmet <j.remmet@phytec.de>
| Date:   Thu May 23 09:49:00 2019 +0200
|
|     common: state: check length
|
|     if written_length is read from a partial written bucket it may be to
|     big and xmalloc will panic barebox.
|
|     Check if the value is sane. Make read_len unsigned to avoid negative
|     values.
|
|     Signed-off-by: Jan Remmet <j.remmet@phytec.de>
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>

state: Fix lseek error check in state_mtd_peb_write() ...

This ports the following barebox commit:

| commit 5eadd11
| Author: Andrey Smirnov <andrew.smirnov@gmail.com>
| Date:   Wed Mar 6 23:49:24 2019 -0800
|
|     state: Fix lseek error check in state_mtd_peb_write()
|
|     Don't use 'int' to store lseek()'s return value to avoid problems with
|     large seek offsets. While at it, make sure to populate return error
|     code from 'errno'.
|
|     Signed-off-by: Andrey Smirnov <andrew.smirnov@gmail.com>
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>

state: Fix lseek error check in state_mtd_peb_read() ...

This ports the following barebox commit:

| commit 8a6a9fb
| Author: Andrey Smirnov <andrew.smirnov@gmail.com>
| Date:   Wed Mar 6 23:49:23 2019 -0800
|
|     state: Fix lseek error check in state_mtd_peb_read()
|
|     Don't use 'int' to store lseek()'s return value to avoid problems with
|     large seek offsets. While at it, make sure to populate return error
|     code from 'errno'.
|
|     Signed-off-by: Andrey Smirnov <andrew.smirnov@gmail.com>
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>

state: Fix lseek error check in state_backend_bucket_direct_write() ...

This ports the following barebox commit:

| commit ec25ecf
| Author: Andrey Smirnov <andrew.smirnov@gmail.com>
| Date:   Wed Mar 6 23:49:22 2019 -0800
|
|     state: Fix lseek error check in state_backend_bucket_direct_write()
|
|     Don't use 'int' to store lseek()'s return value to avoid problems with
|     large seek offsets. While at it, make sure to populate return error
|     code from 'errno'.
|
|     Signed-off-by: Andrey Smirnov <andrew.smirnov@gmail.com>
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>

state: Fix lseek error check in state_backend_bucket_direct_read() ...

This ports the following barebox commit:

| commit 219b954
| Author: Andrey Smirnov <andrew.smirnov@gmail.com>
| Date:   Wed Mar 6 23:49:21 2019 -0800
|
|     state: Fix lseek error check in state_backend_bucket_direct_read()
|
|     Don't use 'int' to store lseek()'s return value to avoid problems with
|     large seek offsets. While at it, make sure to populate return error
|     code from 'errno'.
|
|     Signed-off-by: Andrey Smirnov <andrew.smirnov@gmail.com>
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>

state: backend_bucket_circular: fix double free() ...

The function state_mtd_peb_read() is only a user of buf and not its owner, hence
it may not deallocate it.

Signed-off-by: Kim Christensen <kch@skov.dk>
Reviewed-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Reviewed-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
Signed-off-by: Roland Hieber <rhi@pengutronix.de>

state: fix formatting of "uint32_t" variables ...

The format specifier "%zd" is for "size_t" typed variables and produces a
warning with gcc, so use "%u" instead.

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Signed-off-by: Roland Hieber <rhi@pengutronix.de>

state: fix formatting of "off_t" variables ...

Explicitely casting an "off_t" variable to "long long" and formatting it via
"%lld" or "%llx" respectively makes 32- as well as 64-bit compilers
happy (tested with gcc-8.2.1 and clang-7.0.1).

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Signed-off-by: Roland Hieber <rhi@pengutronix.de>

state: fix typo ...

This ports the following barebox commit:

| commit 69b16bc
| Author: Ulrich Ölmann <u.oelmann@pengutronix.de>
| Date:   Wed Feb 6 11:34:02 2019 +0100
|
|     common: state: fix typo
|
|     Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
|
| M       common/state/backend_format_raw.c
| M       common/state/state.c
| M       common/state/state.h

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Signed-off-by: Roland Hieber <rhi@pengutronix.de>

Introduce dev_set_name() ...

This ports the following barebox commit:

| commit 0568376
| Author: Andrey Smirnov <andrew.smirnov@gmail.com>
| Date:   Tue Oct 16 12:15:40 2018 -0700
|
|     drivers: Introduce dev_set_name()
|
|     Introduce dev_set_name() in order to hide implementation details of
|     setting device's name so it'd be easier to change it.
|
|     Signed-off-by: Andrey Smirnov <andrew.smirnov@gmail.com>
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Signed-off-by: Roland Hieber <rhi@pengutronix.de>

state: fix documentation of state_new_from_node() ...

This ports the following barebox commit:

| commit 63b9aad
| Author: Ulrich Ölmann <u.oelmann@pengutronix.de>
| Date:   Fri Oct 12 08:48:48 2018 +0200
|
|     state: fix documentation of state_new_from_node()
|
|     Commit a66a8d79871c ("state: remove unused arguments from
|     state_new_from_node()") removed a little bit too much.
|
|     Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Signed-off-by: Roland Hieber <rhi@pengutronix.de>

backend_bucket_circular: remove unused variables ...

This ports the following barebox commit:

| commit 0d0a472
| Author: Ulrich Ölmann <u.oelmann@pengutronix.de>
| Date:   Wed Oct 10 14:23:40 2018 +0200
|
|     state: backend_bucket_circular: remove unused variables
|
|     This has been forgotten in commit 9d6d91931afb ("state: Remove -EUCLEAN
|     check
|     from userspace tool").
|
|     Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Signed-off-by: Roland Hieber <rhi@pengutronix.de>

state: fix typo ...

This ports the following barebox commit:

| commit f6a47cc
| Author: Ulrich Ölmann <u.oelmann@pengutronix.de>
| Date:   Mon Oct 8 20:02:06 2018 +0200
|
|     common: state: fix typo
|
|     Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Signed-off-by: Roland Hieber <rhi@pengutronix.de>

state: backend_bucket_circular: fix memory leak ...

This ports the following barebox commit:

| commit 87a0df3
| Author: Ulrich Ölmann <u.oelmann@pengutronix.de>
| Date:   Mon Oct 8 19:45:23 2018 +0200
|
|     state: backend_bucket_circular: fix memory leak
|
|     Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Signed-off-by: Roland Hieber <rhi@pengutronix.de>

state: backend_bucket_circular: fix for non power of 2 writesize ...

This includes sys/param.h to have the definition of roundup() and ports the
following barebox commit:

| commit f701414
| Author: Ladislav Michl <ladis@linux-mips.org>
| Date:   Tue Sep 25 12:58:45 2018 +0200
|
|     state: backend_bucket_circular: fix for non power of 2 writesize
|
|     backend_bucket_circular currently assumes writesize is power of 2,
|     which makes it fail on dataflash devices, where this assumption
|     is false.
|
|     Signed-off-by: Ladislav Michl <ladis@linux-mips.org>
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Signed-off-by: Roland Hieber <rhi@pengutronix.de>

state: Add property to protect existing data ...

This ports the following barebox commit:

| commit 67c1c08
| Author: Daniel Schultz <d.schultz@phytec.de>
| Date:   Thu Apr 12 11:13:01 2018 +0200
|
|     common: state: Add property to protect existing data
|
|     After an update to a newer barebox version with an enabled state
|     framework, existing data in storage memories could be overwritten.
|
|     Add a new property to check in front of every write task, if the meta
|     magic field only contains the magic number, zeros or ones.
|
|     Signed-off-by: Daniel Schultz <d.schultz@phytec.de>
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Signed-off-by: Roland Hieber <rhi@pengutronix.de>

state: find backend node with its reproducible name ...

This ports the following barebox commit and removes the now no longer used noop
definition of of_find_node_by_devpath() that was introduced in commit "state:
find device node from device path, not from device node path":

| commit 1eddb0d
| Author: Sascha Hauer <s.hauer@pengutronix.de>
| Date:   Tue Feb 20 12:41:26 2018 +0100
|
|     state: find backend node with its reproducible name
|
|     When fixing up the kernels state nodes we depended on the full node path
|     of the input device tree. This does not work when the kernel device tree
|     has different names. This has happened lately when the i.MX6 device
|     trees got their leading zeroes removed from the node names.
|
|     Use of_find_node_by_reproducible_name() to find the node corresponding
|     to the storage backend node in the kernel device tree.
|
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Signed-off-by: Roland Hieber <rhi@pengutronix.de>

state: remove unused arguments from state_new_from_node() ...

Other than in barebox the offset and size of a state's backend device do not
necessarily equal zero in Linux userspace (EEPROMs & block devices). So we have
to consider that and differentiate between both usecases here while porting the
following barebox commit and removing the now no longer used noop definition of
of_find_path_by_node():

| commit a66a8d7
| Author: Sascha Hauer <s.hauer@pengutronix.de>
| Date:   Tue Feb 20 12:21:00 2018 +0100
|
|     state: remove unused arguments from state_new_from_node()
|
|     state_new_from_node() has arguments describing the backend path. These
|     are never used in barebox, the backend path is always derived from the
|     device nodes backend description. Remove these arguments.
|
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
[rhi: fixed tabs vs. spaces indentation in state_new_from_node()]
Signed-off-by: Roland Hieber <rhi@pengutronix.de>

state: Add 'init_from_defaults' parameter ...

This ports the following barebox commit:

| commit 6a77d1c
| Author: Sascha Hauer <s.hauer@pengutronix.de>
| Date:   Wed May 4 12:01:05 2016 +0200
|
|     state: Add 'init_from_defaults' parameter
|
|     The init_from_defaults parameter allows to detect if a state has been
|     initialized from default values, i.e. state_load failed.
|
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Signed-off-by: Roland Hieber <rhi@pengutronix.de>

state: refuse to set dirty parameter via setenv ...

This ports the following barebox commit:

| commit 6d3e10c
| Author: Sascha Hauer <s.hauer@pengutronix.de>
| Date:   Wed May 4 11:59:59 2016 +0200
|
|     state: refuse to set dirty parameter via setenv
|
|     The dirty parameter is readonly, so refuse to set it.
|
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Signed-off-by: Roland Hieber <rhi@pengutronix.de>

state: Add function to read state MAC ...

This ports the following barebox commit:

| commit 09f15cd
| Author: Daniel Schultz <d.schultz@phytec.de>
| Date:   Fri Nov 3 11:48:28 2017 +0100
|
|     common: state: Add function to read state MAC
|
|     This API function allows to receive a copy of a MAC address from
|     variables in a state.
|
|     Signed-off-by: Daniel Schultz <d.schultz@phytec.de>
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Signed-off-by: Roland Hieber <rhi@pengutronix.de>

state: refactor variable type ...

This ports the following barebox commits and adjusts the handling of type
information of state variables in barebox-state:

| commit 7b3d284
| Author: Sascha Hauer <s.hauer@pengutronix.de>
| Date:   Mon Apr 3 22:51:58 2017 +0200
|
|     state: remove unused variable type
|
|     enum state_variable_type is never used. Remove it.
|
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

| commit 7126dff
| Author: Daniel Schultz <d.schultz@phytec.de>
| Date:   Fri Nov 3 11:48:26 2017 +0100
|
|     common: state: Add variable_type to state_variable
|
|     Add a pointer in state_variable to the corresponding variable_type array
|     element.
|
|     Signed-off-by: Daniel Schultz <d.schultz@phytec.de>
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

| commit dc74265
| Author: Daniel Schultz <d.schultz@phytec.de>
| Date:   Fri Nov 3 11:48:27 2017 +0100
|
|     common: state: Add variable type as enum
|
|     The variable_type struct holds a name of its type. Checking the type of
|     a variable with this string needs much resources.
|
|     This patch introduce a enum of the variable type for better type
|     checking.
|
|     Signed-off-by: Daniel Schultz <d.schultz@phytec.de>
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
[rhi: fixed function parameter alignment in common/state/state_variables.c,
  and submitted those changes as patches for barebox:
  https://www.mail-archive.com/barebox@lists.infradead.org/msg29427.html
  https://www.mail-archive.com/barebox@lists.infradead.org/msg29462.html ]
Signed-off-by: Roland Hieber <rhi@pengutronix.de>

state: remove checks for xzalloc() returning NULL ...

This ports the following barebox commit:

| commit 25e67cb
| Author: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
| Date:   Mon Sep 25 12:02:35 2017 +0200
|
|     remove checks for xzalloc() returning NULL
|
|     xzalloc() either returns memory or panics, so checking for NULL is useless.
|
|     Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Signed-off-by: Roland Hieber <rhi@pengutronix.de>

state: don't use uninitialized variable ...

This ports the following barebox commit:

| commit b67b8d9
| Author: Juergen Borleis <jbe@pengutronix.de>
| Date:   Thu Aug 17 11:32:33 2017 +0200
|
|     state: don't use uninitialized variable
|
|     Printing 'ret' makes no sense.
|
|     Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Signed-off-by: Roland Hieber <rhi@pengutronix.de>

state: use the given backend storage type name ...

This ports the following barebox commit:

| commit 84ec155
| Author: Juergen Borleis <jbe@pengutronix.de>
| Date:   Thu Aug 17 11:32:32 2017 +0200
|
|     state: use the given backend storage type name
|
|     Change 119f92b already tried to fix it, but
|     forgets the 'direct' usecase.
|
|     The 'backend-storage-type' node is optional. Its default depends on the
|     capability of the used backend memory, which means "circular" or NULL.
|     The latter defaults to 'direct' in the routines.
|     If it is NULL, the devicetree fixup routine skips exporting a
|     'backend-storage-type' node to the kernel's devicetree.
|
|     But currently if the 'backend-storage-type' node is explicitly given as
|     'direct', it will be skipped silently and set to NULL instead. In this
|     case the user of the 'barebox-state' tool then ends up with the warning:
|
|     "No backend-storage-type found, using default"
|
|     which is annoying, because it was given.
|
|     Storing the given value will still use a NULL if the
|     'backend-storage-type' node isn't defined, but stores everything else if
|     it is defined. Then the 'backend-storage-type' node is present in the
|     kernel's devicetree as well.
|
|     Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Signed-off-by: Roland Hieber <rhi@pengutronix.de>

state: provide an error message when an error occurs ...

This ports the following barebox commit:

| commit 8db7a23
| Author: Juergen Borleis <jbe@pengutronix.de>
| Date:   Wed Aug 16 14:27:07 2017 +0200
|
|     state: provide an error message when an error occurs
|
|     A simple typo makes the state framework fail, but without an error
|     message the developer is lost in the dark.
|
|     Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Signed-off-by: Roland Hieber <rhi@pengutronix.de>