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: 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: 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: 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: 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>

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>

state: Allow to load without authentification ...

Sometimes it's useful to be able to load a state even when it
can't be authentificated. Add an option for this.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

state: backend_storage: rename more variables ...

Use "buckets" rather than "copies" in variable names.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

state: backend_storage: make locally used variable static ...

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

state: backend_storage: rewrite function doc ...

The function documentation for state_storage_file_buckets_init() is not
very accurate. Rewrite it.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

state: backend_storage: Rename variable desired_copies to desired_buckets ...

We defined what a bucket is, so rename the variable that holds the
number of desired buckets from desired_copies to desired_buckets.

While at it, make locally used variable static.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

state: backend_storage: Rename variable nr_copies to n_buckets ...

We defined what a bucket is, so use n_buckets when counting buckets,
and not nr_copies.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

state: backend_circular: rewrite function doc ...

The commment talks about copies where buckets are meant and also
claims we start at offset 0, which may not be true. Rewrite comment.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

state: backend_circular: default to circular storage ...

Default to the new circular storage format which saves erase
cycles. The old format can still be selected with
backend-storage-type = "noncircular".

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

state: backend: Add some documentation ...

Write some sentences to make the concepts clearer.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

state: backend_circular: remove unnecessary warning ...

It's expected that NAND flashes contain bad blocks, do not warn
about them.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

state: backend: Add more fields to struct state_backend_storage ...

To save a few function arguments.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

state: bucket: Make output more informative ...

Print offset and number of the bucket along with the bucket
specific messages to give a hint which bucket a message is for.

Also it's pretty much expected that buckets sometimes have no
data or need cleanup, so instead of complaining loudly, only
write which bucket is used and which buckets are cleaned up.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

state: Drop cache bucket ...

The cache bucket sits between the storage functions and the backend
storage. We only read from the storage once, so there is no need to cache
anything. The real purpose of the cache bucket is to keep the -EUCLEAN
information when a NAND block needs to be rewritten and to keep the read
buffers as long as the backend iterates over all buckets trying to find
the one we want to use.

This can be coded easier and more obvious in the backend code, so drop
the cache bucket.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

state: Convert all bufs to void * ...

A void * is a much better type for a buffer than a u8 * as it
can be casted to any other type implicitly. Convert all buffers
used by the state framework to void *.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

state: replace len_hint logic ...

The len_hint mechanism is rather hard to understand as it's not clear
from where to where the hint is passed and also it's not clear what
happens if the hint is empty or wrong.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

state: simplify direct backend ...

- drop support for regular files. This, if at all, is only useful for
  debugging. For the debugging case still a file of sufficient size
  can be created manually.
- make stridesize mandatory. Makes the code simpler.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

state: drop lazy_init ...

lazy_init is an optimization that makes it possible to read only up to
the first valid bucket when starting. However, when restoring consistency,
immediately afterwards we have we have to initialize all buckets anyway,
so being lazy doesn't give us any gain. Remove it to simplify the code.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

state: storage: initialize variable once outside loop ...

writesize is initialized with the same value in each loop iteration,
Instead, initialize it once outside the loop.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

state: pass struct state * to storage functions ...

We can get a state_backend_storage * and the device * from struct state,
so pass this to the storage functions rather than the two pointers.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

state: backend: remove len_hint argument from state_storage_read ...

The argument is 0 in the only caller, so remove the argument.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>