From 428f3d5b993f9a7dd2e6d65df5a5bf2d7dffab70 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ga=C3=ABl=20PORTAY?= <gael.portay@collabora.com>
Date: Wed, 15 Dec 2021 09:24:02 +0100
Subject: [PATCH] Add block size properties to FuCfiDevice

---
 libfwupdplugin/fu-cfi-device.c            | 46 +++++++++++++++++++++++
 libfwupdplugin/fu-cfi-device.h            |  5 +++
 libfwupdplugin/fu-self-test.c             |  1 +
 libfwupdplugin/fwupdplugin.map            |  2 +
 libfwupdplugin/tests/quirks.d/tests.quirk |  1 +
 5 files changed, 55 insertions(+)

diff --git a/libfwupdplugin/fu-cfi-device.c b/libfwupdplugin/fu-cfi-device.c
index b79696ea3..11c16f042 100644
--- a/libfwupdplugin/fu-cfi-device.c
+++ b/libfwupdplugin/fu-cfi-device.c
@@ -23,6 +23,7 @@ typedef struct {
 	guint8 cmd_read_id_sz;
 	guint32 page_size;
 	guint32 sector_size;
+	guint32 block_size;
 	FuCfiDeviceCmd cmds[FU_CFI_DEVICE_CMD_LAST];
 } FuCfiDevicePrivate;
 
@@ -303,6 +304,43 @@ fu_cfi_device_get_sector_size(FuCfiDevice *self)
 	return priv->sector_size;
 }
 
+/**
+ * fu_cfi_device_set_block_size:
+ * @self: a #FuCfiDevice
+ * @block_size: block size in bytes, or 0 if unknown
+ *
+ * Sets the chip block size. This is typically the largest erasable chunk size.
+ *
+ * Since: 1.7.4
+ **/
+void
+fu_cfi_device_set_block_size(FuCfiDevice *self, guint32 block_size)
+{
+	FuCfiDevicePrivate *priv = GET_PRIVATE(self);
+	g_return_if_fail(FU_IS_CFI_DEVICE(self));
+	priv->block_size = block_size;
+}
+
+/**
+ * fu_cfi_device_get_block_size:
+ * @self: a #FuCfiDevice
+ *
+ * Gets the chip block size. This is typically the largest erasable block size.
+ *
+ * This is typically set with the `CfiDeviceBlockSize` quirk key.
+ *
+ * Returns: block size in bytes, or 0 if unknown
+ *
+ * Since: 1.7.4
+ **/
+guint32
+fu_cfi_device_get_block_size(FuCfiDevice *self)
+{
+	FuCfiDevicePrivate *priv = GET_PRIVATE(self);
+	g_return_val_if_fail(FU_IS_CFI_DEVICE(self), G_MAXUINT32);
+	return priv->block_size;
+}
+
 /**
  * fu_cfi_device_set_sector_size:
  * @self: a #FuCfiDevice
@@ -393,6 +431,12 @@ fu_cfi_device_set_quirk_kv(FuDevice *device, const gchar *key, const gchar *valu
 		priv->sector_size = tmp;
 		return TRUE;
 	}
+	if (g_strcmp0(key, "CfiDeviceBlockSize") == 0) {
+		if (!fu_common_strtoull_full(value, &tmp, 0, G_MAXUINT32, error))
+			return FALSE;
+		priv->block_size = tmp;
+		return TRUE;
+	}
 	g_set_error_literal(error,
 			    FWUPD_ERROR,
 			    FWUPD_ERROR_NOT_SUPPORTED,
@@ -413,6 +457,8 @@ fu_cfi_device_to_string(FuDevice *device, guint idt, GString *str)
 		fu_common_string_append_kx(str, idt, "PageSize", priv->page_size);
 	if (priv->sector_size > 0)
 		fu_common_string_append_kx(str, idt, "SectorSize", priv->sector_size);
+	if (priv->block_size > 0)
+		fu_common_string_append_kx(str, idt, "BlockSize", priv->block_size);
 }
 
 static void
diff --git a/libfwupdplugin/fu-cfi-device.h b/libfwupdplugin/fu-cfi-device.h
index e891c27fd..8c52b0a2e 100644
--- a/libfwupdplugin/fu-cfi-device.h
+++ b/libfwupdplugin/fu-cfi-device.h
@@ -28,6 +28,7 @@ struct _FuCfiDeviceClass {
  * @FU_CFI_DEVICE_CMD_SECTOR_ERASE:	Sector erase
  * @FU_CFI_DEVICE_CMD_WRITE_EN:		Write enable
  * @FU_CFI_DEVICE_CMD_WRITE_STATUS:	Write status
+ * @FU_CFI_DEVICE_CMD_BLOCK_ERASE:	Block erase
  *
  * Commands used when calling fu_cfi_device_get_cmd().
  **/
@@ -62,5 +63,9 @@ guint32
 fu_cfi_device_get_sector_size(FuCfiDevice *self);
 void
 fu_cfi_device_set_sector_size(FuCfiDevice *self, guint32 sector_size);
+guint32
+fu_cfi_device_get_block_size(FuCfiDevice *self);
+void
+fu_cfi_device_set_block_size(FuCfiDevice *self, guint32 block_size);
 gboolean
 fu_cfi_device_get_cmd(FuCfiDevice *self, FuCfiDeviceCmd cmd, guint8 *value, GError **error);
diff --git a/libfwupdplugin/fu-self-test.c b/libfwupdplugin/fu-self-test.c
index 31b4babc3..14c1f144d 100644
--- a/libfwupdplugin/fu-self-test.c
+++ b/libfwupdplugin/fu-self-test.c
@@ -312,6 +312,7 @@ fu_device_cfi_device_func(void)
 	g_assert_cmpint(fu_cfi_device_get_size(cfi_device), ==, 0x10000);
 	g_assert_cmpint(fu_cfi_device_get_page_size(cfi_device), ==, 0x200);
 	g_assert_cmpint(fu_cfi_device_get_sector_size(cfi_device), ==, 0x2000);
+	g_assert_cmpint(fu_cfi_device_get_block_size(cfi_device), ==, 0x8000);
 }
 
 static void
diff --git a/libfwupdplugin/fwupdplugin.map b/libfwupdplugin/fwupdplugin.map
index 1e14bbe7c..d80d380af 100644
--- a/libfwupdplugin/fwupdplugin.map
+++ b/libfwupdplugin/fwupdplugin.map
@@ -980,6 +980,8 @@ LIBFWUPDPLUGIN_1.7.3 {
 
 LIBFWUPDPLUGIN_1.7.4 {
   global:
+    fu_cfi_device_get_block_size;
+    fu_cfi_device_set_block_size;
     fu_common_get_contents_stream;
     fu_memmem_safe;
   local: *;
diff --git a/libfwupdplugin/tests/quirks.d/tests.quirk b/libfwupdplugin/tests/quirks.d/tests.quirk
index f761f97f6..f7288ed53 100644
--- a/libfwupdplugin/tests/quirks.d/tests.quirk
+++ b/libfwupdplugin/tests/quirks.d/tests.quirk
@@ -22,4 +22,5 @@ CfiDeviceCmdChipErase = 0xc7
 CfiDeviceCmdSectorErase = 0x20
 CfiDevicePageSize = 0x200
 CfiDeviceSectorSize = 0x2000
+CfiDeviceBlockSize = 0x8000
 FirmwareSizeMax = 0x10000