Added printing of extra family IDs

Author: oyama

flash/partition_info/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_executable(partition_info partition_info.c)
+add_executable(partition_info partition_info.c uf2_family_ids.c)
 
 target_link_libraries(partition_info PRIVATE
         pico_stdlib

flash/partition_info/partition_info.c

@@ -9,13 +9,15 @@
 #include "pico/bootrom.h"
 #include "boot/picobin.h"
 #include "hardware/flash.h"
+#include "uf2_family_ids.h"
 
 #define PART_LOC_FIRST(x) ( ((x) & PICOBIN_PARTITION_LOCATION_FIRST_SECTOR_BITS) >> PICOBIN_PARTITION_LOCATION_FIRST_SECTOR_LSB )
 #define PART_LOC_LAST(x)  ( ((x) & PICOBIN_PARTITION_LOCATION_LAST_SECTOR_BITS)  >> PICOBIN_PARTITION_LOCATION_LAST_SECTOR_LSB )
 
 #define PARTITION_LOCATION_AND_FLAGS_SIZE  2
 #define PARTITION_ID_SIZE                  2
 #define PARTITION_NAME_MAX                 127
+#define PARTITION_EXTRA_FAMILY_ID_MAX      3
 #define PARTITION_TABLE_FIXED_INFO_SIZE    (4 + PARTITION_TABLE_MAX_PARTITIONS * (PARTITION_LOCATION_AND_FLAGS_SIZE + PARTITION_ID_SIZE))
 
 /*
@@ -43,6 +45,8 @@ typedef struct {
     uint32_t flags_and_permissions;
     uint64_t partition_id;
     char name[PARTITION_NAME_MAX + 1];  // name length is indicated by 7 bits
+    uint32_t extra_family_id_count;
+    uint32_t extra_family_ids[PARTITION_EXTRA_FAMILY_ID_MAX];
 } pico_partition_t;
 
 
@@ -101,25 +105,34 @@ bool read_next_partition(pico_partition_table_t *pt, pico_partition_t *p) {
     }
     pt->pos = pos;
 
-    if (p->flags_and_permissions & PICOBIN_PARTITION_FLAGS_HAS_NAME_BITS) {
+    p->extra_family_id_count = (p->flags_and_permissions & PICOBIN_PARTITION_FLAGS_ACCEPTS_NUM_EXTRA_FAMILIES_BITS)
+                                   >> PICOBIN_PARTITION_FLAGS_ACCEPTS_NUM_EXTRA_FAMILIES_LSB;
+    if (p->extra_family_id_count | (p->flags_and_permissions & PICOBIN_PARTITION_FLAGS_HAS_NAME_BITS)) {
         // Read variable length fields
-        uint32_t name_buf[((PARTITION_NAME_MAX + 1) / sizeof(uint32_t)) + 1] = {0};
-        uint32_t flags = PT_INFO_SINGLE_PARTITION | PT_INFO_PARTITION_NAME;
-        int rc = rom_get_partition_table_info(name_buf, sizeof(name_buf),
+        uint32_t extra_family_id_and_name[PARTITION_EXTRA_FAMILY_ID_MAX + (((PARTITION_NAME_MAX + 1) / sizeof(uint32_t)) + 1)];
+        uint32_t flags = PT_INFO_SINGLE_PARTITION | PT_INFO_PARTITION_FAMILY_IDS | PT_INFO_PARTITION_NAME;
+        int rc = rom_get_partition_table_info(extra_family_id_and_name, sizeof(extra_family_id_and_name),
                                               (pt->current_partition << 24 | flags));
         if (rc < 0) {
             pt->status = rc;
             return false;
         }
-        uint32_t __attribute__((unused)) fields = name_buf[0];
+        size_t pos = 0;
+        uint32_t __attribute__((unused)) fields = extra_family_id_and_name[pos++];
         assert(fields == flags);
-        uint8_t *name_buf_u8 = (uint8_t *)&name_buf[1];
-        uint8_t name_length = *name_buf_u8++ & 0x7F;
-        memcpy(p->name, name_buf_u8, name_length);
-        p->name[name_length] = '\0';
-    } else {
-        p->name[0] = '\0';
+        for (size_t i = 0; i < p->extra_family_id_count; i++, pos++) {
+            p->extra_family_ids[i] = extra_family_id_and_name[pos];
+        }
+
+        if (p->flags_and_permissions & PICOBIN_PARTITION_FLAGS_HAS_NAME_BITS) {
+            uint8_t *name_buf = (uint8_t *)&extra_family_id_and_name[pos];
+            uint8_t name_length = *name_buf++ & 0x7F;
+            memcpy(p->name, name_buf, name_length);
+            p->name[name_length] = '\0';
+        }
     }
+    if (!(p->flags_and_permissions & PICOBIN_PARTITION_FLAGS_HAS_NAME_BITS))
+         p->name[0] = '\0';
 
     pt->current_partition++;
     return true;
@@ -139,13 +152,20 @@ int main() {
     } else if (pt.partition_count == 0) {
         printf("the partition table is empty\n");
     }
-    printf("un-partitioned_space: S(%s%s) NSBOOT(%s%s) NS(%s%s)\n",
+
+    uf2_family_ids_t *family_ids = uf2_family_ids_new();
+    uf2_family_ids_add_default_families(family_ids, pt.flags_and_permissions);
+    char *str_family_ids = uf2_family_ids_join(family_ids, ", ");
+    printf("un-partitioned_space: S(%s%s) NSBOOT(%s%s) NS(%s%s) uf2 { %s }\n",
            (pt.flags_and_permissions & PICOBIN_PARTITION_PERMISSION_S_R_BITS ? "r" : ""),
            (pt.flags_and_permissions & PICOBIN_PARTITION_PERMISSION_S_W_BITS ? "w" : ""),
            (pt.flags_and_permissions & PICOBIN_PARTITION_PERMISSION_NSBOOT_R_BITS ? "r" : ""),
            (pt.flags_and_permissions & PICOBIN_PARTITION_PERMISSION_NSBOOT_W_BITS ? "w" : ""),
            (pt.flags_and_permissions & PICOBIN_PARTITION_PERMISSION_NS_R_BITS ? "r" : ""),
-           (pt.flags_and_permissions & PICOBIN_PARTITION_PERMISSION_NS_W_BITS ? "w" : ""));
+           (pt.flags_and_permissions & PICOBIN_PARTITION_PERMISSION_NS_W_BITS ? "w" : ""),
+           str_family_ids);
+    free(str_family_ids);
+    uf2_family_ids_free(family_ids);
 
     if (pt.partition_count == 0) {
         return 0;
@@ -154,6 +174,7 @@ int main() {
     pico_partition_t p;
     while (read_next_partition(&pt, &p)) {
         printf("%3d:", pt.current_partition - 1);
+
         printf("    %08x->%08x S(%s%s) NSBOOT(%s%s) NS(%s%s)",
                p.first_sector * FLASH_SECTOR_SIZE, (p.last_sector + 1) * FLASH_SECTOR_SIZE,
                (p.flags_and_permissions & PICOBIN_PARTITION_PERMISSION_S_R_BITS ? "r" : ""),
@@ -168,6 +189,18 @@ int main() {
         if (p.flags_and_permissions & PICOBIN_PARTITION_FLAGS_HAS_NAME_BITS) {
             printf(", \"%s\"", p.name);
         }
+
+        // print UF2 family ID
+        family_ids = uf2_family_ids_new();
+        uf2_family_ids_add_default_families(family_ids, p.flags_and_permissions);
+        for (size_t i = 0; i < p.extra_family_id_count; i++) {
+            uf2_family_ids_add_extra_family_id(family_ids, p.extra_family_ids[i]);
+        }
+        str_family_ids = uf2_family_ids_join(family_ids, ", ");
+        printf(", uf2 { %s }", str_family_ids);
+        uf2_family_ids_free(family_ids);
+        free(str_family_ids);
+
         printf("\n");
     }
     if (pt.status != 0) {

flash/partition_info/uf2_family_ids.c

@@ -0,0 +1,75 @@
+#include "uf2_family_ids.h"
+
+#define UF2_FAMILY_ID_HEX_SIZE   (2 + 8 * 2 + 1)
+
+uf2_family_ids_t *uf2_family_ids_new(void) {
+    uf2_family_ids_t *ids = malloc(sizeof(uf2_family_ids_t));
+    ids->count = 0;
+    ids->items = NULL;
+    return ids;
+}
+
+void uf2_family_ids_add(uf2_family_ids_t *ids, const char *str) {
+    ids->items = realloc(ids->items, (ids->count + 1) * sizeof(char *));
+    ids->items[ids->count] = strdup(str);
+    if (ids->items[ids->count] == NULL) {
+        perror("strdup");
+        return;
+    }
+    ids->count++;
+}
+
+char *uf2_family_ids_join(const uf2_family_ids_t *ids, const char *sep) {
+    size_t total_length = 0;
+    size_t sep_length = strlen(sep);
+
+    for (size_t i = 0; i < ids->count; i++) {
+        total_length += strlen(ids->items[i]);
+        if (i < ids->count - 1)
+            total_length += sep_length;
+    }
+
+    char *result = calloc(1, total_length + 1);
+    if (!result) {
+        perror("calloc");
+        return NULL;
+    }
+
+    result[0] = '\0';
+    for (size_t i = 0; i < ids->count; i++) {
+        strcat(result, ids->items[i]);
+        if (i < ids->count - 1)
+            strcat(result, sep);
+    }
+
+    return result;
+}
+
+void uf2_family_ids_free(uf2_family_ids_t *ids) {
+    for (size_t i = 0; i < ids->count; i++) {
+        free(ids->items[i]);
+    }
+    free(ids->items);
+    free(ids);
+}
+
+void uf2_family_ids_add_default_families(uf2_family_ids_t *ids, uint32_t flags) {
+    if (flags & PICOBIN_PARTITION_FLAGS_ACCEPTS_DEFAULT_FAMILY_ABSOLUTE_BITS)
+        uf2_family_ids_add(ids, "absolute");
+    if (flags & PICOBIN_PARTITION_FLAGS_ACCEPTS_DEFAULT_FAMILY_RP2040_BITS)
+        uf2_family_ids_add(ids, "rp2040");
+    if (flags & PICOBIN_PARTITION_FLAGS_ACCEPTS_DEFAULT_FAMILY_RP2350_ARM_S_BITS)
+        uf2_family_ids_add(ids, "rp2350-arm-s");
+    if (flags & PICOBIN_PARTITION_FLAGS_ACCEPTS_DEFAULT_FAMILY_RP2350_ARM_NS_BITS)
+        uf2_family_ids_add(ids, "rp2350-arm-ns");
+    if (flags & PICOBIN_PARTITION_FLAGS_ACCEPTS_DEFAULT_FAMILY_RP2350_RISCV_BITS)
+        uf2_family_ids_add(ids, "rp2350-riscv");
+    if (flags & PICOBIN_PARTITION_FLAGS_ACCEPTS_DEFAULT_FAMILY_DATA_BITS)
+        uf2_family_ids_add(ids, "data");
+}
+
+void uf2_family_ids_add_extra_family_id(uf2_family_ids_t *ids, uint32_t family_id) {
+    char hex_id[UF2_FAMILY_ID_HEX_SIZE];
+    sprintf(hex_id, "0x%08x", family_id);
+    uf2_family_ids_add(ids, hex_id);
+}

flash/partition_info/uf2_family_ids.h

@@ -0,0 +1,23 @@
+#pragma once
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+#include "pico/stdlib.h"
+#include "boot/picobin.h"
+
+
+typedef struct {
+    size_t count;
+    char **items;
+} uf2_family_ids_t;
+
+
+uf2_family_ids_t *uf2_family_ids_new(void);
+void uf2_family_ids_add(uf2_family_ids_t *ids, const char *str);
+char *uf2_family_ids_join(const uf2_family_ids_t *ids, const char *sep);
+void uf2_family_ids_free(uf2_family_ids_t *ids);
+
+void uf2_family_ids_add_default_families(uf2_family_ids_t *ids, uint32_t flags);
+void uf2_family_ids_add_extra_family_id(uf2_family_ids_t *ids, uint32_t family_id);