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

This ports the following dt-utils commit (as the actual code that is changed is
removed by the preprocesser when compiling barebox this patch is only of
cosmetic nature to keep both code bases in sync):

| commit 634317c
| Author: Kim Christensen <kch@skov.dk>
| Date:   Wed Sep 18 16:48:23 2019 +0200
|
|     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>

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

state: backend_bucket_circular: harmonize code with dt-utils ...

Comparing barebox' commit [1] with dt-utils' commit [2] it is obvious that
adjusting the return value has been forgotten in barebox - fix that.
(As the actual code that is changed is removed by the preprocesser when
compiling barebox this patch is only of cosmetic nature to keep both code bases
in sync).

[1] 9d6d91931afb ("state: Remove -EUCLEAN check from userspace tool")
[2] 791a2404116d ("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>

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>

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>

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>

common: state: harmonize code with dt-utils ...

Linux userspace needs sys/param.h to have the definition of roundup().

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

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

To harmonize the common codebase this ports the following dt-utils commit:

| commit 5588a6c
| Author: Ulrich Ölmann <u.oelmann@pengutronix.de>
| Date:   Sun Feb 3 22:48:07 2019 +0100
|
|     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>

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

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

To harmonize the common codebase this ports the following dt-utils commit:

| commit 89d0332
| Author: Ulrich Ölmann <u.oelmann@pengutronix.de>
| Date:   Sun Feb 3 22:48:06 2019 +0100
|
|     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>

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

common: state: fix compiler warnings about wrong type conversion in messages ...

To harmonize the common codebase this ports the remaining hunks of the following
dt-utils commit, as the residual hunks have independently already been done
before in barebox commit 1afbf6b5680e ("state: fix compile warnings for dev_err
expansion"):

| commit 9f1db73
| Author: Philipp Rosenberger <p.rosenberger@linutronix.de>
| Date:   Thu Oct 18 09:17:23 2018 +0200
|
|     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>

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

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>

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>

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>

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>

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>

Merge branch 'for-next/state'

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>

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>

Merge branch 'for-next/misc'

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>

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>

state: Remove -EUCLEAN check from userspace tool ...

The state code is used for the userspace tool aswell, kept in sync
manually. This patch only introduces a change for the userspace
tool, not for barebox.

In Linux userspace there is no direct possibility to check for -EUCLEAN.
To indirectly check for -EUCLEAN the state tool reads the number of
corrected bits before and after reading a block. Unfortunately it does
not take the number of acceptable bitflips into account, but instead
returns -EUCLEAN even when only a single bitflip occurred on a whole
page. To be correct the algorithm must be more complicated: We would
have to read the bitflip_threshold from sysfs. This value is per ECC
step (often 512 byte), not per page. We would have to read the page
in ECC step size chunks, testing for bitflips lower than the threshold
for each chunk. Even if we would do that, there's still another issue.
The eccstats ioctl delivers the eccstats for the whole device, so a
concurrent reader would falsify the result.

Let's decide that this is not worth the hassle and assume that no
device has enough uptime that a cleanup in barebox is not sufficient.

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

state: backend bucket circular: Explain metadata ...

Explain why we have metadata and where it is used.

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

state: backend_circular: Set minumum writesize to 8 ...

NOR flashes have a write size of 1. With this the metadata may
end up on non-4-byte-aligned offsets. Force the minimum writesize
to 8 so that the metadata is always at aligned offsets.

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: 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: 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: backend_circular: Read whole PEB ...

When the circular backend searches for the last page written in the
eraseblock, it iterates backwards pagewise from the end of the block.
This is ok for NAND flash, but on NOR flash, which does not have pages,
the code ends up iterating bytewise backwards, calling into mtd each
time. This is very time consuming, so optimize this by reading the whole
eraseblock once and just iterate over the buffer in memory.

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

state: backend circular: Fix wrong comment ...

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

state: bucket_circular: -EUCLEAN means data could be read ...

-EUCLEAN returned from state_mtd_peb_read() means that the
data shall still be used. This fixes initialization of buckets
which need cleanup

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