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>

state: add debugging help ...

This ports the following barebox commit:

| commit b6a3532
| Author: Juergen Borleis <jbe@pengutronix.de>
| Date:   Tue Aug 15 15:46:35 2017 +0200
|
|     state: add debugging help
|
|     While working on the state documentation it turns out to be helpful to have
|     more debug messages while a developer implements a 'state' variable set
|     and tries to configure it correctly.
|
|     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: backend_storage: remove unreachable error message ...

This ports the following barebox commit:

| commit e197305
| Author: Philipp Zabel <p.zabel@pengutronix.de>
| Date:   Tue Jul 18 15:15:34 2017 +0200
|
|     state: backend_storage: remove unreachable error message
|
|     This looks like a leftover.
|
|     Signed-off-by: Philipp Zabel <p.zabel@pengutronix.de>
|     Signed-off-by: Lucas Stach <l.stach@pengutronix.de>

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

state: backend_bucket_circular: promote old state debug message to info ...

This ports the following barebox commit:

| commit 0f5ecaf
| Author: Philipp Zabel <p.zabel@pengutronix.de>
| Date:   Tue Jul 18 15:15:23 2017 +0200
|
|     state: backend_bucket_circular: promote old state debug message to info
|
|     A report about the changed on-storage state format might be interesting
|     to the user.
|
|     Signed-off-by: Philipp Zabel <p.zabel@pengutronix.de>
|     Signed-off-by: Lucas Stach <l.stach@pengutronix.de>

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

state: backend_bucket_circular: fix old state reads ...

This ports the following barebox commit:

| commit a0c2642
| Author: Philipp Zabel <p.zabel@pengutronix.de>
| Date:   Tue Jul 18 15:14:45 2017 +0200
|
|     state: backend_bucket_circular: fix old state reads
|
|     When the circular bucket meta magic was not found, it is assumed that
|     the whole written state is in the old on-storage format. In that case,
|     the size of the circular bucket meta must not be subtracted from the
|     read length, or the (complete_len > len) check in the raw backend's
|     verify function will fail:
|
|         state: Error, invalid data_len 16 in header, have data of len 24
|
|     Signed-off-by: Philipp Zabel <p.zabel@pengutronix.de>
|     Signed-off-by: Lucas Stach <l.stach@pengutronix.de>

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

state: backend: always pass backend type to Linux dtb ...

This ports the following barebox commit:

| commit 119f92b
| Author: Sascha Hauer <s.hauer@pengutronix.de>
| Date:   Fri Jun 23 12:43:14 2017 +0200
|
|     state: backend: always pass backend type to Linux dtb
|
|     When the "backend-storage-type" property is unset in the barebox dtb
|     then barebox will use the default. Instead of leaving the property
|     unset in the Linux dtb, set it to the value we used as default. By
|     making the default explicit to Linux we force Linux to the same backend
|     type, even when the defaults may differ.
|
|     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: do not complain about missing backend-storage-type ...

This ports the following barebox commit:

| commit 02a0af2
| Author: Sascha Hauer <s.hauer@pengutronix.de>
| Date:   Tue May 23 09:31:29 2017 +0200
|
|     state: do not complain about missing backend-storage-type
|
|     backend-storage-type is irrelevant for mtd devices, so do not
|     complain about this option missing. The mtd backend will print
|     messages if necessary.
|
|     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 variables ...

This ports the following barebox commit:

| commit d528a3b
| Author: Sascha Hauer <s.hauer@pengutronix.de>
| Date:   Thu May 11 10:06:24 2017 +0200
|
|     state: remove unused variables
|
|     There's no need to check for the existence of the backend property as
|     this is done implicitly later anyway. With this check removed of_path
|     is only assigned, but never used. Remove the unused code.
|
|     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: Create alias in of_state_fixup() ...

This ports the following barebox commit:

| commit 70ea799
| Author: Sascha Hauer <s.hauer@pengutronix.de>
| Date:   Thu May 4 12:50:59 2017 +0200
|
|     state: Create alias in of_state_fixup()
|
|     When the kernel device tree is fixed up we assume that it doesn't
|     have a state node, so we must also assume that it doesn't have
|     a alias. Create 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: Make an alias mandatory ...

This ports the following barebox commit:

| commit 4983191
| Author: Sascha Hauer <s.hauer@pengutronix.de>
| Date:   Thu May 4 12:27:21 2017 +0200
|
|     state: Make an alias mandatory
|
|     The userspace barebox-state utility gets confused when no alias exists.
|     Make the alias mandatory, so that people make it right^tm without having
|     to ask.
|
|     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: warn when a state node will be overwritten ...

This ports the following barebox commit:

| commit b30047b
| Author: Sascha Hauer <s.hauer@pengutronix.de>
| Date:   Thu May 4 11:58:23 2017 +0200
|
|     state: warn when a state node will be overwritten
|
|     People do not seem to know that a state node in the kernel
|     device tree will be overwritten by barebox. Print a warning
|     when this happens so that people can get an idea why changes
|     in the kernel device tree state node do not have any effect.
|
|     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: make parameter functions more consistent ...

This replaces a dummy version dev_add_param_int() by a dummy version of
dev_add_param_uint32() to make the compiler happy and ports the following
barebox commit:

| commit c5d95eb
| Author: Sascha Hauer <s.hauer@pengutronix.de>
| Date:   Fri Apr 7 11:57:08 2017 +0200
|
|     param: make parameter functions more consistent
|
|     This patch creates a consitent set of device parameter functions.
|
|     With this we have: dev_add_param_<type><access>
|
|     "type" is one of: int32, uint32, int64, uint64, string, mac, ipv4, enum,
|     bitmask
|     The improvement here is that we now can exactly specify the width of the
|     int type parameters and also correctly distinguish between signed and
|     unsigned variables which means that a variable no longer ends up with
|     INT_MAX when it's assigned -1.
|
|     "access" can be empty for regular read/write parameter, "_ro" for readonly
|     parameters which get their value from a variable pointer in the
|     background or "_fixed" for parameters which are set to a fixed value
|     (without a pointer in the background).
|
|     Some more exotic types are not (yet) implemented, like
|     dev_add_param_ip_ro.
|
|     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: drop unused free_pattern constant ...

This ports the following barebox commit:

| commit b876c2b
| Author: Antony Pavlov <antonynpavlov@gmail.com>
| Date:   Wed May 3 14:41:18 2017 +0300
|
|     state: backend_bucket_circular: drop unused free_pattern constant
|
|     Signed-off-by: Antony Pavlov <antonynpavlov@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 "pack" returning freed data for DTB backend ...

This ports the following barebox commit:

| commit ec01cbc
| Author: Ian Abbott <abbotti@mev.co.uk>
| Date:   Fri Apr 21 10:53:25 2017 +0100
|
|     state: Fix "pack" returning freed data for DTB backend
|
|     `state_backend_format_dtb_pack()` passes a buffer containing state
|     packed in flattened DTB format back to its caller via its `buf`
|     parameter.  It then frees the buffer before returning.  This means the
|     caller (`state_save()`) will be working on freed buffer contents before
|     freeing the buffer a second time itself.  Fix it by removing the
|     spurious call to `free()`.
|
|     This should fix a bug reported by Norbert Wiedmann in
|     <http://lists.infradead.org/pipermail/barebox/2017-April/029980.html>.
|
|     Cc: Norbert Wiedmann <info@n-wiedmann.de>
|     Signed-off-by: Ian Abbott <abbotti@mev.co.uk>
|     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 error return value ...

This ports the following barebox commit:

| commit d11584d
| Author: Sascha Hauer <s.hauer@pengutronix.de>
| Date:   Wed Apr 19 14:34:30 2017 +0200
|
|     state: Fix error return value
|
|     When the backend phandle cannot be resolved we jump to the error
|     return path without initializing ret. Fix this.
|
|     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_storage: Set needs_refresh back to 0 after refreshing ...

This ports the following barebox commit:

| commit 275f354
| Author: Sascha Hauer <s.hauer@pengutronix.de>
| Date:   Wed Apr 19 10:18:42 2017 +0200
|
|     state: backend_storage: Set needs_refresh back to 0 after refreshing
|
|     Set needs_refresh back to 0 after refreshing so that we do not refresh
|     it again without need. This would only happen when we read the state
|     from the storage multiple times, which normally is not the case.
|     However, it's more consistent like this.
|
|     Reported-by: Sam Ravnborg <sam@ravnborg.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: backend_bucket_circular: Do not leak memory ...

This ports the following barebox commit:

| commit af18710
| Author: Sascha Hauer <s.hauer@pengutronix.de>
| Date:   Wed Apr 19 10:13:58 2017 +0200
|
|     state: backend_bucket_circular: Do not leak memory
|
|     buf was just allocated, free it before returning an error.
|
|     Reported-by: Sam Ravnborg <sam@ravnborg.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: find device node from device path, not from device node path ...

This adds a dummy version of of_find_node_by_devpath() to make the linker happy
and ports the following barebox commit:

| commit e627903
| Author: Sascha Hauer <s.hauer@pengutronix.de>
| Date:   Thu Mar 30 16:33:26 2017 +0200
|
|     state: find device node from device path, not from device node path
|
|     The device node path may change from the internal device tree to the
|     one Linux is started with, so using this path to fixup the tree is
|     not very robust. Instead, use of_find_node_by_devpath() which has
|     been created for exactly this purpose.
|
|     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: Make pointing to the backend using a phandle the only supported method ...

This ports the following barebox commit and removes the now no longer used noop
definition of of_find_path():

| commit 99020ca
| Author: Sascha Hauer <s.hauer@pengutronix.de>
| Date:   Tue Mar 21 13:57:51 2017 +0100
|
|     state: Make pointing to the backend using a phandle the only supported method
|
|     All other methods are broken for some time already: When starting the
|     kernel the state code rewrites the state node in the device tree and
|     replaced the "backend" property with a phandle - even when the target
|     can't be described as a phandle. Since using phandles is the nicest way
|     to point to the storage device anyway remove the other methods.
|
|     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>

treewide: Use of_property_write_string() where appropriate ...

This ports the following barebox commit:

| commit b608918
| Author: Sascha Hauer <s.hauer@pengutronix.de>
| Date:   Thu Mar 30 10:38:19 2017 +0200
|
|     treewide: Use of_property_write_string() where appropriate
|
|     Replace users which use of_set_property() to set a property to a string
|     with of_property_write_string().
|
|     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>

libdt: add of_property_write_string() ...

This ports the following barebox commits:

| commit 2d36433
| Author: Sascha Hauer <s.hauer@pengutronix.de>
| Date:   Thu Mar 30 10:36:58 2017 +0200
|
|     of: Add of_property_write_string()
|
|     Setting a property to a string is used many times. Create a convenience
|     function for it.
|
|     Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

| commit 4da7cf0
| Author: Ulrich Ölmann <u.oelmann@pengutronix.de>
| Date:   Fri Oct 19 06:33:11 2018 +0200
|
|     of: base: 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>

backend_storage: remove fs.h ...

Starting with commit e790822a6676 ("state: simplify direct backend") the ioctl
BLKGETSIZE64 is no longer used so there is no need for fs.h anymore (included
since commit bbafbee71370 ("backend_storage: add fs.h for BLKGETSIZE64")).

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

Fix compiler warnings about wrong type conversion in messages. ...

These warning were observed with gcc-6.3 on x86-64.

Signed-off-by: Philipp Rosenberger <p.rosenberger@linutronix.de>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

src: fix compilation for glibc version 2.27.9000-36.fc29 and newer ...

As recent glibc versions (>= 2.27.9000-36.fc29) also define 'struct
statx' which is also defined in linux/stat.h, compilation fails with
error:

| In file included from ../dt-utils-2018.05.0/src/crypto/digest.c:24:
| [..]/usr/include/linux/stat.h:56:8: error: redefinition of 'struct statx_timestamp'
|  struct statx_timestamp {
|         ^~~~~~~~~~~~~~~
| In file included from [..]/usr/include/sys/stat.h:446,
|                  from ../dt-utils-2018.05.0/src/dt/common.h:15,
|                  from ../dt-utils-2018.05.0/src/crypto/digest.c:19:
| [..]/usr/include/bits/statx.h:25:8: note: originally defined here
|  struct statx_timestamp
|         ^~~~~~~~~~~~~~~
| In file included from ../dt-utils-2018.05.0/src/crypto/digest.c:24:
| [..]/usr/include/linux/stat.h:99:8: error: redefinition of 'struct statx'
|  struct statx {
|         ^~~~~
| In file included from [..]/usr/include/sys/stat.h:446,
|                  from ../dt-utils-2018.05.0/src/dt/common.h:15,
|                  from ../dt-utils-2018.05.0/src/crypto/digest.c:19:
| [..]/usr/include/bits/statx.h:36:8: note: originally defined here
|  struct statx
|         ^~~~~

The linux/stat.h originates from the code that was copied from barebox
but is not explicitly required to be linux/stat.h instead of sys/stat.h
and we do not actually use struct statx.

Thus it is safe to simply replace occurrences of linux/stat.h by
sys/stat.h to fix compilation.

Signed-off-by: Enrico Joerns <ejo@pengutronix.de>

barebox-state: block while waiting for file lock ...

In multi-processes environment, it can happen that barebox-state is
called concurrently. Since barebox-state usually only runs for at most a
few seconds, it is probably okay for the second process to block while
wait for the file lock, so the calling entity (user or script) doesn't
have to do error handling itself.

Signed-off-by: Roland Hieber <r.hieber@pengutronix.de>

barebox-state: Fail for unhandled arguments ...

When passing unhandled arguments as in

  % barebox-state foo

these will be silently ignored. This may lead to misunderstandings and
unintended behavior, thus the user should be informed and the programm
should exit with an error in these cases.

Signed-off-by: Enrico Jorns <ejo@pengutronix.de>
Acked-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>

barebox-state: fix termination of long_options[] ...

From the getopt_long() documentation:

| The argument longopts must be an array of these structures, one for each
| long option. Terminate the array with an element containing all zeros.

Otherwise barebox-state will segfault for unknown options:

  % ./barebox-state --foo
  [1]    17946 segmentation fault (core dumped)  ./barebox-state --foo

Signed-off-by: Enrico Jorns <ejo@pengutronix.de>
Acked-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>

common: Include sys/types.h header ...

Build with musl library fails with following error:

In file included from src/crypto/sha1.c:21:0:
./src/digest.h:95:10: error: unknown type name ‘ulong’
          ulong start, ulong size);
...

Fix that by including sys/types.h header in common.h, so ulong type
is defined with musl library.

Signed-off-by: Marcin Niestroj <m.niestroj@grinn-global.com>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

common: Rename strlcpy to DT_strlcpy ...

strlcpy function is defined in uClibc library, causing "static
declaration of ‘strlcpy’ follows non-static declaration" build
errors.

Rename internal strlcpy function to DT_strlcpy to avoid conflicts.

Signed-off-by: Marcin Niestroj <m.niestroj@grinn-global.com>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>