drivers: bootcount: Add support for ANY filesystem
authorVasileios Amoiridis <vassilisamir@gmail.com>
Fri, 28 Jun 2024 17:35:41 +0000 (19:35 +0200)
committerTom Rini <trini@konsulko.com>
Tue, 16 Jul 2024 18:46:34 +0000 (12:46 -0600)
Add support to save boot count variable in ANY filesystem. Tested with
FAT and EXT.

Reviewed-by: Tom Rini <trini@konsulko.com>
Reviewed-by: Heiko Schocher <hs@denx.de>
Reviewed-by: Philip Oberfichtner <pro@denx.de>
Signed-off-by: Vasileios Amoiridis <vasileios.amoiridis@cern.ch>
doc/README.bootcount
drivers/bootcount/Kconfig
drivers/bootcount/Makefile
drivers/bootcount/bootcount_ext.c [deleted file]
drivers/bootcount/bootcount_fs.c [new file with mode: 0644]

index f6c5f82f985b93f3c281767f5663b0eecb0163ab..0f4ffb68285eeb0dadb7fdc48c113db86612d251 100644 (file)
@@ -23,15 +23,15 @@ It is the responsibility of some application code (typically a Linux
 application) to reset the variable "bootcount" to 0 when the system booted
 successfully, thus allowing for more boot cycles.
 
-CONFIG_BOOTCOUNT_EXT
+CONFIG_BOOTCOUNT_FS
 --------------------
 
-This adds support for maintaining boot count in a file on an EXT filesystem.
-The file to use is defined by:
+This adds support for maintaining boot count in a file on a filesystem.
+Supported filesystems are FAT and EXT. The file to use is defined by:
 
-CONFIG_SYS_BOOTCOUNT_EXT_INTERFACE
-CONFIG_SYS_BOOTCOUNT_EXT_DEVPART
-CONFIG_SYS_BOOTCOUNT_EXT_NAME
+CONFIG_SYS_BOOTCOUNT_FS_INTERFACE
+CONFIG_SYS_BOOTCOUNT_FS_DEVPART
+CONFIG_SYS_BOOTCOUNT_FS_NAME
 
 The format of the file is:
 
index 3c56253b1eaa2113a9139d424912e34576ebc169..fbf3c56b41e47b08effa6366cb771052636371e1 100644 (file)
@@ -25,13 +25,13 @@ config BOOTCOUNT_GENERIC
            Set to the address where the bootcount and bootcount magic
            will be stored.
 
-config BOOTCOUNT_EXT
-       bool "Boot counter on EXT filesystem"
-       depends on FS_EXT4
-       select EXT4_WRITE
+config BOOTCOUNT_FS
+       bool "Boot counter on a filesystem"
        help
-         Add support for maintaining boot count in a file on an EXT
-         filesystem.
+         Add support for maintaining boot count in a file on a filesystem.
+         This requires that you have enabled write support for the filesystem
+         that you will be used by the partition that you configure this feature
+         for.
 
 config BOOTCOUNT_AM33XX
        bool "Boot counter in AM33XX RTC IP block"
@@ -184,26 +184,26 @@ config SYS_BOOTCOUNT_SINGLEWORD
          This option enables packing boot count magic value and boot count
          into single word (32 bits).
 
-config SYS_BOOTCOUNT_EXT_INTERFACE
-       string "Interface on which to find boot counter EXT filesystem"
+config SYS_BOOTCOUNT_FS_INTERFACE
+       string "Interface on which to find boot counter filesystem"
        default "mmc"
-       depends on BOOTCOUNT_EXT
+       depends on BOOTCOUNT_FS
        help
          Set the interface to use when locating the filesystem to use for the
          boot counter.
 
-config SYS_BOOTCOUNT_EXT_DEVPART
-       string "Partition of the boot counter EXT filesystem"
+config SYS_BOOTCOUNT_FS_DEVPART
+       string "Partition of the boot counter filesystem"
        default "0:1"
-       depends on BOOTCOUNT_EXT
+       depends on BOOTCOUNT_FS
        help
          Set the partition to use when locating the filesystem to use for the
          boot counter.
 
-config SYS_BOOTCOUNT_EXT_NAME
-       string "Path and filename of the EXT filesystem based boot counter"
+config SYS_BOOTCOUNT_FS_NAME
+       string "Path and filename of the FS filesystem based boot counter"
        default "/boot/failures"
-       depends on BOOTCOUNT_EXT
+       depends on BOOTCOUNT_FS
        help
          Set the filename and path of the file used to store the boot counter.
 
@@ -211,18 +211,18 @@ config SYS_BOOTCOUNT_ADDR
        hex "RAM address used for reading and writing the boot counter"
        default 0x44E3E000 if BOOTCOUNT_AM33XX || BOOTCOUNT_AM33XX_NVMEM
        default 0xE0115FF8 if ARCH_LS1043A || ARCH_LS1021A
-       depends on BOOTCOUNT_AM33XX || BOOTCOUNT_GENERIC || BOOTCOUNT_EXT || \
+       depends on BOOTCOUNT_AM33XX || BOOTCOUNT_GENERIC || BOOTCOUNT_FS || \
                   BOOTCOUNT_AM33XX_NVMEM
        help
          Set the address used for reading and writing the boot counter.
 
 config SYS_BOOTCOUNT_MAGIC
        hex "Magic value for the boot counter"
-       default 0xB001C041 if BOOTCOUNT_GENERIC || BOOTCOUNT_EXT || \
+       default 0xB001C041 if BOOTCOUNT_GENERIC || BOOTCOUNT_FS || \
                              BOOTCOUNT_AM33XX || BOOTCOUNT_ENV || \
                              BOOTCOUNT_RAM || BOOTCOUNT_AT91 || DM_BOOTCOUNT
        default 0xB0 if BOOTCOUNT_AM33XX_NVMEM
-       depends on BOOTCOUNT_GENERIC || BOOTCOUNT_EXT || \
+       depends on BOOTCOUNT_GENERIC || BOOTCOUNT_FS || \
                   BOOTCOUNT_AM33XX || BOOTCOUNT_ENV || \
                   BOOTCOUNT_RAM || BOOTCOUNT_AT91 || DM_BOOTCOUNT || \
                   BOOTCOUNT_AM33XX_NVMEM
index e7771f5b36d69371fa392e63f5c60f45d86b79ca..245f87963377bbb4a4c97a7481fc7b6cc58d1d66 100644 (file)
@@ -6,7 +6,7 @@ obj-$(CONFIG_BOOTCOUNT_AT91)    += bootcount_at91.o
 obj-$(CONFIG_BOOTCOUNT_AM33XX) += bootcount_davinci.o
 obj-$(CONFIG_BOOTCOUNT_RAM)    += bootcount_ram.o
 obj-$(CONFIG_BOOTCOUNT_ENV)    += bootcount_env.o
-obj-$(CONFIG_BOOTCOUNT_EXT)    += bootcount_ext.o
+obj-$(CONFIG_BOOTCOUNT_FS)     += bootcount_fs.o
 obj-$(CONFIG_BOOTCOUNT_AM33XX_NVMEM)   += bootcount_nvmem.o
 
 obj-$(CONFIG_DM_BOOTCOUNT)      += bootcount-uclass.o
diff --git a/drivers/bootcount/bootcount_ext.c b/drivers/bootcount/bootcount_ext.c
deleted file mode 100644 (file)
index 9639e63..0000000
+++ /dev/null
@@ -1,83 +0,0 @@
-// SPDX-License-Identifier: GPL-2.0+
-/*
- * Copyright (c) 2017 General Electric Company. All rights reserved.
- */
-
-#include <bootcount.h>
-#include <fs.h>
-#include <mapmem.h>
-
-#define BC_MAGIC       0xbd
-#define BC_VERSION     1
-
-typedef struct {
-       u8 magic;
-       u8 version;
-       u8 bootcount;
-       u8 upgrade_available;
-} bootcount_ext_t;
-
-static u8 upgrade_available = 1;
-
-void bootcount_store(ulong a)
-{
-       bootcount_ext_t *buf;
-       loff_t len;
-       int ret;
-
-       if (fs_set_blk_dev(CONFIG_SYS_BOOTCOUNT_EXT_INTERFACE,
-                          CONFIG_SYS_BOOTCOUNT_EXT_DEVPART, FS_TYPE_EXT)) {
-               puts("Error selecting device\n");
-               return;
-       }
-
-       /* Only update bootcount during upgrade process */
-       if (!upgrade_available)
-               return;
-
-       buf = map_sysmem(CONFIG_SYS_BOOTCOUNT_ADDR, sizeof(bootcount_ext_t));
-       buf->magic = BC_MAGIC;
-       buf->version = BC_VERSION;
-       buf->bootcount = (a & 0xff);
-       buf->upgrade_available = upgrade_available;
-       unmap_sysmem(buf);
-
-       ret = fs_write(CONFIG_SYS_BOOTCOUNT_EXT_NAME,
-                      CONFIG_SYS_BOOTCOUNT_ADDR, 0, sizeof(bootcount_ext_t),
-                      &len);
-       if (ret != 0)
-               puts("Error storing bootcount\n");
-}
-
-ulong bootcount_load(void)
-{
-       bootcount_ext_t *buf;
-       loff_t len_read;
-       int ret;
-
-       if (fs_set_blk_dev(CONFIG_SYS_BOOTCOUNT_EXT_INTERFACE,
-                          CONFIG_SYS_BOOTCOUNT_EXT_DEVPART, FS_TYPE_EXT)) {
-               puts("Error selecting device\n");
-               return 0;
-       }
-
-       ret = fs_read(CONFIG_SYS_BOOTCOUNT_EXT_NAME, CONFIG_SYS_BOOTCOUNT_ADDR,
-                     0, sizeof(bootcount_ext_t), &len_read);
-       if (ret != 0 || len_read != sizeof(bootcount_ext_t)) {
-               puts("Error loading bootcount\n");
-               return 0;
-       }
-
-       buf = map_sysmem(CONFIG_SYS_BOOTCOUNT_ADDR, sizeof(bootcount_ext_t));
-       if (buf->magic == BC_MAGIC && buf->version == BC_VERSION) {
-               upgrade_available = buf->upgrade_available;
-               if (upgrade_available)
-                       ret = buf->bootcount;
-       } else {
-               puts("Incorrect bootcount file\n");
-       }
-
-       unmap_sysmem(buf);
-
-       return ret;
-}
diff --git a/drivers/bootcount/bootcount_fs.c b/drivers/bootcount/bootcount_fs.c
new file mode 100644 (file)
index 0000000..569592d
--- /dev/null
@@ -0,0 +1,83 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * Copyright (c) 2017 General Electric Company. All rights reserved.
+ */
+
+#include <bootcount.h>
+#include <fs.h>
+#include <mapmem.h>
+
+#define BC_MAGIC       0xbd
+#define BC_VERSION     1
+
+typedef struct {
+       u8 magic;
+       u8 version;
+       u8 bootcount;
+       u8 upgrade_available;
+} bootcount_ext_t;
+
+static u8 upgrade_available = 1;
+
+void bootcount_store(ulong a)
+{
+       bootcount_ext_t *buf;
+       loff_t len;
+       int ret;
+
+       if (fs_set_blk_dev(CONFIG_SYS_BOOTCOUNT_FS_INTERFACE,
+                          CONFIG_SYS_BOOTCOUNT_FS_DEVPART, FS_TYPE_ANY)) {
+               puts("Error selecting device\n");
+               return;
+       }
+
+       /* Only update bootcount during upgrade process */
+       if (!upgrade_available)
+               return;
+
+       buf = map_sysmem(CONFIG_SYS_BOOTCOUNT_ADDR, sizeof(bootcount_ext_t));
+       buf->magic = BC_MAGIC;
+       buf->version = BC_VERSION;
+       buf->bootcount = (a & 0xff);
+       buf->upgrade_available = upgrade_available;
+       unmap_sysmem(buf);
+
+       ret = fs_write(CONFIG_SYS_BOOTCOUNT_FS_NAME,
+                      CONFIG_SYS_BOOTCOUNT_ADDR, 0, sizeof(bootcount_ext_t),
+                      &len);
+       if (ret != 0)
+               puts("Error storing bootcount\n");
+}
+
+ulong bootcount_load(void)
+{
+       bootcount_ext_t *buf;
+       loff_t len_read;
+       int ret;
+
+       if (fs_set_blk_dev(CONFIG_SYS_BOOTCOUNT_FS_INTERFACE,
+                          CONFIG_SYS_BOOTCOUNT_FS_DEVPART, FS_TYPE_ANY)) {
+               puts("Error selecting device\n");
+               return 0;
+       }
+
+       ret = fs_read(CONFIG_SYS_BOOTCOUNT_FS_NAME, CONFIG_SYS_BOOTCOUNT_ADDR,
+                     0, sizeof(bootcount_ext_t), &len_read);
+       if (ret != 0 || len_read != sizeof(bootcount_ext_t)) {
+               puts("Error loading bootcount\n");
+               return 0;
+       }
+
+       buf = map_sysmem(CONFIG_SYS_BOOTCOUNT_ADDR, sizeof(bootcount_ext_t));
+       if (buf->magic == BC_MAGIC && buf->version == BC_VERSION) {
+               upgrade_available = buf->upgrade_available;
+               if (upgrade_available)
+                       ret = buf->bootcount;
+       } else {
+               puts("Incorrect bootcount file\n");
+       }
+
+       unmap_sysmem(buf);
+
+       return ret;
+}