feat(esp_ext_part_tables): Add support for BDL

Author: adokitkat

esp_ext_part_tables/CMakeLists.txt

@@ -2,6 +2,12 @@ set(srcs "src/esp_ext_part_tables.c"
          "src/esp_mbr.c"
          "src/esp_mbr_utils.c")
 
+set(requires "log" "esp_common")
+
+if("${IDF_VERSION_MAJOR}.${IDF_VERSION_MINOR}" VERSION_GREATER_EQUAL "6.0")
+    list(APPEND requires "esp_blockdev")
+endif()
+
 idf_component_register(SRCS ${srcs}
                     INCLUDE_DIRS "include"
-                    REQUIRES "log" "esp_common")
+                    REQUIRES ${requires})

esp_ext_part_tables/idf_component.yml

@@ -1,4 +1,4 @@
-version: "0.1.1"
+version: "0.2.0"
 description: ESP External Partition Tables
 url: https://github.com/espressif/idf-extra-components/tree/master/esp_ext_part_tables
 issues: https://github.com/espressif/idf-extra-components/issues

esp_ext_part_tables/include/esp_ext_part_tables.h

@@ -10,6 +10,11 @@
 #include <stdbool.h>
 #include <stddef.h>
 #include "esp_err.h"
+#include "esp_idf_version.h"
+
+#if (ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(6, 0, 0))
+#include "esp_blockdev.h"
+#endif // (ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(6, 0, 0))
 
 #if __has_include(<bsd/sys/queue.h>)
 #include <bsd/sys/queue.h>
@@ -209,6 +214,54 @@ esp_err_t esp_ext_part_list_signature_get(esp_ext_part_list_t *part_list, void *
  */
 esp_err_t esp_ext_part_list_signature_set(esp_ext_part_list_t *part_list, const void *signature, esp_ext_part_signature_type_t type);
 
+#if (ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(6, 0, 0))
+/**
+ * @brief Read a aprtition table and from a block device handle and parse it.
+ *
+ * This function reads the partition table from the specified block device and populates the provided partition list structure.
+ * The type of partition table to read is specified by the 'type' parameter.
+ * Additional arguments for parsing can be provided through the 'extra_args' parameter.
+ *
+ * @note This function is not thread-safe.
+ *
+ * @param[in] handle       Block device handle to read from.
+ * @param[out] part_list   Pointer to the partition list structure to populate from the partition table.
+ * @param[in] type         Type of partition table to read (e.g., MBR).
+ * @param[in] extra_args   Pointer to additional arguments for parsing dependent on the partition type (optional, can be NULL).
+ *
+ * @return
+ *     - ESP_OK: Partition list was successfully loaded.
+ *     - ESP_ERR_INVALID_ARG: `handle` or `part_list` is NULL.
+ *     - ESP_ERR_NOT_SUPPORTED: Unsupported partition table type.
+ *     - ESP_ERR_NO_MEM: Memory allocation failed.
+ *     - propagated errors from BDL operations or partition table parsing functions.
+ */
+esp_err_t esp_ext_part_list_read(esp_blockdev_handle_t handle, esp_ext_part_list_t *part_list, esp_ext_part_signature_type_t type, void *extra_args);
+
+/**
+ * @brief Generate a partition table and write it to a block device handle.
+ *
+ * This function writes the provided partition list to the specified block device.
+ * The type of partition table to write is specified by the 'type' parameter.
+ * Additional arguments for generation can be provided through the 'extra_args' parameter.
+ *
+ * @note This function is not thread-safe.
+ *
+ * @param[in] handle       Block device handle to write to.
+ * @param[in] part_list    Pointer to the partition list structure generate the partition table from.
+ * @param[in] type         Type of partition table to write (e.g., MBR).
+ * @param[in] extra_args   Pointer to additional arguments for generation dependent on the partition type (optional, can be NULL).
+ *
+ * @return
+ *     - ESP_OK: Partition list was successfully written.
+ *     - ESP_ERR_INVALID_ARG: `handle` or `part_list` is NULL.
+ *     - ESP_ERR_NOT_SUPPORTED: Unsupported partition table type.
+ *     - ESP_ERR_NO_MEM: Memory allocation failed.
+ *     - propagated errors from BDL operations or partition table generation functions.
+ */
+esp_err_t esp_ext_part_list_write(esp_blockdev_handle_t handle, esp_ext_part_list_t *part_list, esp_ext_part_signature_type_t type, void *extra_args);
+#endif // (ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(6, 0, 0))
+
 #ifdef __cplusplus
 }
 #endif

esp_ext_part_tables/src/esp_ext_part_tables.c

@@ -9,8 +9,14 @@
 #include "freertos/FreeRTOS.h"
 #include "esp_err.h"
 #include "esp_log.h"
+#include "esp_idf_version.h"
+
+#if (ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(6, 0, 0))
+#include "esp_blockdev.h"
+#endif // (ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(6, 0, 0))
 
 #include "esp_ext_part_tables.h"
+#include "esp_mbr.h"
 
 #if __has_include(<bsd/sys/queue.h>)
 #include <bsd/sys/queue.h>
@@ -153,3 +159,73 @@ esp_err_t esp_ext_part_list_signature_set(esp_ext_part_list_t *part_list, const
     }
     return ESP_OK;
 }
+
+#if (ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(6, 0, 0))
+esp_err_t esp_ext_part_list_read(esp_blockdev_handle_t handle, esp_ext_part_list_t *part_list, esp_ext_part_signature_type_t type, void *extra_args)
+{
+    if (handle == NULL || part_list == NULL) {
+        return ESP_ERR_INVALID_ARG;
+    }
+
+    esp_err_t err = ESP_OK;
+    uint8_t *buf = NULL;
+
+    switch (type) {
+    case ESP_EXT_PART_LIST_SIGNATURE_MBR:
+        buf = malloc(MBR_SIZE);
+        if (buf == NULL) {
+            return ESP_ERR_NO_MEM;
+        }
+
+        err = handle->ops->read(handle, buf, MBR_SIZE, 0, MBR_SIZE);
+        if (err != ESP_OK) {
+            free(buf);
+            return err;
+        }
+
+        err = esp_mbr_parse(buf, part_list, (esp_mbr_parse_extra_args_t *) extra_args);
+        free(buf);
+        break;
+
+    default:
+        err = ESP_ERR_NOT_SUPPORTED; // Unsupported signature type
+        break;
+    }
+
+    return err;
+}
+
+esp_err_t esp_ext_part_list_write(esp_blockdev_handle_t handle, esp_ext_part_list_t *part_list, esp_ext_part_signature_type_t type, void *extra_args)
+{
+    if (handle == NULL || part_list == NULL) {
+        return ESP_ERR_INVALID_ARG;
+    }
+
+    esp_err_t err = ESP_OK;
+    uint8_t *buf = NULL;
+
+    switch (type) {
+    case ESP_EXT_PART_LIST_SIGNATURE_MBR:
+        buf = malloc(MBR_SIZE);
+        if (buf == NULL) {
+            return ESP_ERR_NO_MEM;
+        }
+
+        err = esp_mbr_generate((mbr_t *) buf, part_list, (esp_mbr_generate_extra_args_t *) extra_args);
+        if (err != ESP_OK) {
+            free(buf);
+            return err;
+        }
+
+        err = handle->ops->write(handle, buf, 0, MBR_SIZE);
+        free(buf);
+        break;
+
+    default:
+        err = ESP_ERR_NOT_SUPPORTED; // Unsupported signature type
+        break;
+    }
+
+    return err;
+}
+#endif // (ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(6, 0, 0))

esp_ext_part_tables/test_apps/main/CMakeLists.txt

@@ -1,4 +1,10 @@
+set(priv_requires "unity")
+
+if("${IDF_VERSION_MAJOR}.${IDF_VERSION_MINOR}" VERSION_GREATER_EQUAL "6.0")
+    list(APPEND priv_requires "esp_blockdev")
+endif()
+
 idf_component_register(SRCS "test_esp_ext_part.c"
                     INCLUDE_DIRS "."
-                    PRIV_REQUIRES "unity"
+                    PRIV_REQUIRES ${priv_requires}
                     WHOLE_ARCHIVE)