Add metadata info for partition tables

Author: will-v-pi

bintool/metadata.h

@@ -225,8 +225,55 @@ struct partition_table_item : public single_byte_size_item {
     partition_table_item() = default;
 
     explicit partition_table_item(uint32_t unpartitioned_flags, bool singleton) : unpartitioned_flags(unpartitioned_flags), singleton(singleton) {}
-    template <typename I> static std::shared_ptr<item> parse(I it, I end, uint32_t header) {
-        return nullptr;
+    template <typename I> static std::shared_ptr<item> parse(I& it, I end, uint32_t header) {
+        uint32_t size = decode_size(header);
+        uint8_t singleton_count = header >> 24;
+        bool singleton = singleton_count & 0x80;
+        uint8_t partition_count = singleton_count & 0x0f;
+        uint32_t unpartitioned_flags = *it++;
+
+        auto pt = std::make_shared<partition_table_item>(unpartitioned_flags, singleton);
+
+        std::vector<uint32_t> data;
+        for (unsigned int i=2; i < size; i++) {
+            data.push_back(*it++);
+        }
+        int i=0;
+        while (i < data.size()) {
+            partition new_p;
+            uint32_t permissions_locations = data[i++];
+            new_p.permissions = (permissions_locations & PICOBIN_PARTITION_PERMISSIONS_BITS) >> PICOBIN_PARTITION_PERMISSIONS_LSB;
+            new_p.first_sector = (permissions_locations & PICOBIN_PARTITION_LOCATION_FIRST_SECTOR_BITS) >> PICOBIN_PARTITION_LOCATION_FIRST_SECTOR_LSB;
+            new_p.last_sector = (permissions_locations & PICOBIN_PARTITION_LOCATION_LAST_SECTOR_BITS) >> PICOBIN_PARTITION_LOCATION_LAST_SECTOR_LSB;
+
+            uint32_t permissions_flags = data[i++];
+            uint8_t permissions2 = (permissions_flags & PICOBIN_PARTITION_PERMISSIONS_BITS) >> PICOBIN_PARTITION_PERMISSIONS_LSB;
+            if (new_p.permissions != permissions2) {
+                printf("Permissions mismatch %02x %02x\n", new_p.permissions, permissions2);
+                assert(false);
+            }
+            new_p.flags = permissions_flags & (~PICOBIN_PARTITION_PERMISSIONS_BITS);
+
+            if (new_p.flags & PICOBIN_PARTITION_FLAGS_HAS_ID_BITS) {
+                new_p.id = (uint64_t)data[i++] | ((uint64_t)data[i++] << 32);
+            }
+
+            uint8_t num_extra_families = (new_p.flags & PICOBIN_PARTITION_FLAGS_ACCEPTS_NUM_EXTRA_FAMILIES_BITS) >> PICOBIN_PARTITION_FLAGS_ACCEPTS_NUM_EXTRA_FAMILIES_LSB;
+            for (int fam=0; fam < num_extra_families; fam++) {
+                new_p.extra_families.push_back(data[i++]);
+            }
+
+            if (new_p.flags & PICOBIN_PARTITION_FLAGS_HAS_NAME_BITS) {
+                auto bytes = words_to_lsb_bytes(data.begin() + i++, data.end());
+                int name_size = bytes[0];
+                // This works neatly - accounts for the size byte at the start
+                i += name_size / 4;
+                new_p.name = std::string((char*)(bytes.data() + 1), name_size);
+            }
+
+            pt->partitions.push_back(new_p);
+        }
+        return pt;
     }
 
     std::vector<uint32_t> to_words(item_writer_context& ctx) const override {
@@ -574,7 +621,7 @@ struct block {
                     i = image_type_item::parse(it, end, header);
                     break;
                 case PICOBIN_BLOCK_ITEM_PARTITION_TABLE:
-                    i = ignored_item::parse(it, end, header);
+                    i = partition_table_item::parse(it, end, header);
                     break;
                 case PICOBIN_BLOCK_ITEM_1BS_VECTOR_TABLE:
                     i = vector_table_item::parse(it, end, header);

main.cpp

@@ -876,9 +876,6 @@ struct partition_info_command : public cmd {
     string get_doc() const override {
         return "Print the device's partition table.";
     }
-
-    void print_permissions(unsigned int p) const;
-    void insert_default_families(uint32_t flags_and_permissions, vector<std::string> &family_ids) const;
 };
 #endif
 
@@ -923,9 +920,6 @@ struct partition_create_command : public cmd {
     string get_doc() const override {
         return "Create a partition table from json";
     }
-
-    void print_permissions(unsigned int p) const;
-    void insert_default_families(uint32_t flags_and_permissions, vector<std::string> &family_ids) const;
 };
 
 
@@ -2922,6 +2916,39 @@ std::shared_ptr<memory_access> get_bi_access(memory_access &raw_access) {
     return std::make_shared<remapped_memory_access>(raw_access, rmap);
 }
 
+string str_permissions(unsigned int p) {
+    static_assert(PICOBIN_PARTITION_PERMISSION_S_R_BITS == (1u << 26), "");
+    static_assert(PICOBIN_PARTITION_PERMISSION_S_W_BITS == (1u << 27), "");
+    static_assert(PICOBIN_PARTITION_PERMISSION_NS_W_BITS == (1u << 29), "");
+    static_assert(PICOBIN_PARTITION_PERMISSION_NSBOOT_W_BITS == (1u << 31), "");
+
+    std::stringstream ss;
+    ss << " S(";
+    unsigned int r = (p >> 26) & 3;
+    if (r & 1) ss << "r";
+    if (r & 2) ss << "w"; else if (!r) ss << "-";
+    ss << ") NSBOOT(";
+    r = (p >> 30) & 3;
+    if (r & 1) ss << "r";
+    if (r & 2) ss << "w"; else if (!r) ss << "-";
+    ss << ") NS(";
+    r = (p >> 28) & 3;
+    if (r & 1) ss << "r";
+    if (r & 2) ss << "w"; else if (!r) ss << "-";
+    ss << ")";
+
+    return ss.str();
+}
+
+void insert_default_families(uint32_t flags_and_permissions, vector<std::string> &family_ids) {
+    if (flags_and_permissions & PICOBIN_PARTITION_FLAGS_ACCEPTS_DEFAULT_FAMILY_ABSOLUTE_BITS) family_ids.emplace_back(absolute_family_name);
+    if (flags_and_permissions & PICOBIN_PARTITION_FLAGS_ACCEPTS_DEFAULT_FAMILY_RP2040_BITS) family_ids.emplace_back(rp2040_family_name);
+    if (flags_and_permissions & PICOBIN_PARTITION_FLAGS_ACCEPTS_DEFAULT_FAMILY_RP2350_ARM_S_BITS) family_ids.emplace_back(rp2350_arm_s_family_name);
+    if (flags_and_permissions & PICOBIN_PARTITION_FLAGS_ACCEPTS_DEFAULT_FAMILY_RP2350_ARM_NS_BITS) family_ids.emplace_back(rp2350_arm_ns_family_name);
+    if (flags_and_permissions & PICOBIN_PARTITION_FLAGS_ACCEPTS_DEFAULT_FAMILY_RP2350_RISCV_BITS) family_ids.emplace_back(rp2350_riscv_family_name);
+    if (flags_and_permissions & PICOBIN_PARTITION_FLAGS_ACCEPTS_DEFAULT_FAMILY_DATA_BITS) family_ids.emplace_back(data_family_name);
+}
+
 #if HAS_LIBUSB
 void info_guts(memory_access &raw_access, picoboot::connection *con) {
 #else
@@ -3006,6 +3033,61 @@ void info_guts(memory_access &raw_access, void *con) {
                 }
             }
 
+            // Partition Table
+            auto partition_table = best_block->get_item<partition_table_item>();
+            if (partition_table != nullptr) {
+                info_pair("partition table", partition_table->singleton ? "singleton" : "non-singleton");
+                std::stringstream unpartitioned;
+                unpartitioned << str_permissions(partition_table->unpartitioned_flags);
+                std::vector<std::string> family_ids;
+                insert_default_families(partition_table->unpartitioned_flags, family_ids);
+                unpartitioned << ", uf2 { " << cli::join(family_ids, ", ") << " }";
+                info_pair("un-partitioned space", unpartitioned.str());
+
+                for (int i=0; i < partition_table->partitions.size(); i++) {
+                    std::stringstream pstring;
+                    std::stringstream pname;
+                    auto partition = partition_table->partitions[i];
+                    uint32_t flags = partition.flags;
+                    uint64_t id = partition.id;
+                    pname << "partition " << i;
+                    if ((flags & PICOBIN_PARTITION_FLAGS_LINK_TYPE_BITS) ==
+                        PICOBIN_PARTITION_FLAGS_LINK_TYPE_AS_BITS(A_PARTITION)) {
+                        pname << " (B w/ " << ((flags & PICOBIN_PARTITION_FLAGS_LINK_VALUE_BITS)
+                                            >> PICOBIN_PARTITION_FLAGS_LINK_VALUE_LSB)
+                           << ")";
+                    } else if ((flags & PICOBIN_PARTITION_FLAGS_LINK_TYPE_BITS) ==
+                            PICOBIN_PARTITION_FLAGS_LINK_TYPE_AS_BITS(OWNER_PARTITION)) {
+                            pname << " (A ob/ " << ((flags & PICOBIN_PARTITION_FLAGS_LINK_VALUE_BITS)
+                                                 >> PICOBIN_PARTITION_FLAGS_LINK_VALUE_LSB)
+                               << ")";
+                    } else {
+                        pname << " (A)";
+                    }
+                    pstring << hex_string(partition.first_sector * 4096, 8, false) << "->" << hex_string((partition.last_sector + 1) * 4096, 8, false);
+                    unsigned int p = partition.permissions;
+                    pstring << str_permissions(p << PICOBIN_PARTITION_PERMISSIONS_LSB);
+                    if (flags & PICOBIN_PARTITION_FLAGS_HAS_ID_BITS) {
+                        pstring << ", id=" << hex_string(id, 16, false);
+                    }
+                    uint32_t num_extra_families = partition.extra_families.size();
+                    family_ids.clear();
+                    insert_default_families(flags, family_ids);
+                    for (auto family : partition.extra_families) {
+                        family_ids.emplace_back(hex_string(family));
+                    }
+                    if (flags & PICOBIN_PARTITION_FLAGS_HAS_NAME_BITS) {
+                        pstring << ", \"";
+                        pstring << partition.name;
+                        pstring << '"';
+                    }
+                    pstring << ", uf2 { " << cli::join(family_ids, ", ") << " }";
+                    pstring << ", arm_boot " << !(flags & PICOBIN_PARTITION_FLAGS_IGNORED_DURING_ARM_BOOT_BITS);
+                    pstring << ", riscv_boot " << !(flags & PICOBIN_PARTITION_FLAGS_IGNORED_DURING_RISCV_BOOT_BITS);
+                    info_pair(pname.str(), pstring.str());
+                }
+            }
+
             // Version
             auto version = best_block->get_item<version_item>();
             if (version != nullptr) {
@@ -5606,7 +5688,7 @@ bool partition_info_command::execute(device_map &devices) {
         printf("the partition table is empty\n");
     }
     printf("un-partitioned_space : ");
-    print_permissions(unpartitioned.permissions_and_flags);
+    fos << str_permissions(unpartitioned.permissions_and_flags);
     std::vector<std::string> family_ids;
     insert_default_families(unpartitioned.permissions_and_flags, family_ids);
     printf(", uf2 { %s }\n", cli::join(family_ids, ", ").c_str());
@@ -5646,7 +5728,7 @@ bool partition_info_command::execute(device_map &devices) {
                 return -1;
             }
             unsigned int p = location_and_permissions & flags_and_permissions;
-            print_permissions(p);
+            fos << str_permissions(p);
             if (flags_and_permissions & PICOBIN_PARTITION_FLAGS_HAS_ID_BITS) {
                 printf(", id=%016" PRIx64, id);
             }
@@ -6714,35 +6796,6 @@ bool coprodis_command::execute(device_map &devices) {
 
 
 #if HAS_LIBUSB
-void partition_info_command::insert_default_families(uint32_t flags_and_permissions, vector<std::string> &family_ids) const {
-    if (flags_and_permissions & PICOBIN_PARTITION_FLAGS_ACCEPTS_DEFAULT_FAMILY_ABSOLUTE_BITS) family_ids.emplace_back(absolute_family_name);
-    if (flags_and_permissions & PICOBIN_PARTITION_FLAGS_ACCEPTS_DEFAULT_FAMILY_RP2040_BITS) family_ids.emplace_back(rp2040_family_name);
-    if (flags_and_permissions & PICOBIN_PARTITION_FLAGS_ACCEPTS_DEFAULT_FAMILY_RP2350_ARM_S_BITS) family_ids.emplace_back(rp2350_arm_s_family_name);
-    if (flags_and_permissions & PICOBIN_PARTITION_FLAGS_ACCEPTS_DEFAULT_FAMILY_RP2350_ARM_NS_BITS) family_ids.emplace_back(rp2350_arm_ns_family_name);
-    if (flags_and_permissions & PICOBIN_PARTITION_FLAGS_ACCEPTS_DEFAULT_FAMILY_RP2350_RISCV_BITS) family_ids.emplace_back(rp2350_riscv_family_name);
-    if (flags_and_permissions & PICOBIN_PARTITION_FLAGS_ACCEPTS_DEFAULT_FAMILY_DATA_BITS) family_ids.emplace_back(data_family_name);
-}
-
-void partition_info_command::print_permissions(unsigned int p) const {
-    static_assert(PICOBIN_PARTITION_PERMISSION_S_R_BITS == (1u << 26), "");
-    static_assert(PICOBIN_PARTITION_PERMISSION_S_W_BITS == (1u << 27), "");
-    static_assert(PICOBIN_PARTITION_PERMISSION_NS_W_BITS == (1u << 29), "");
-    static_assert(PICOBIN_PARTITION_PERMISSION_NSBOOT_W_BITS == (1u << 31), "");
-    printf(" S(");
-    unsigned int r = (p >> 26) & 3;
-    if (r & 1) printf("r");
-    if (r & 2) printf("w"); else if (!r) printf("-");
-    printf(") NSBOOT(");
-    r = (p >> 30) & 3;
-    if (r & 1) printf("r");
-    if (r & 2) printf("w"); else if (!r) printf("-");
-    printf(") NS(");
-    r = (p >> 28) & 3;
-    if (r & 1) printf("r");
-    if (r & 2) printf("w"); else if (!r) printf("-");
-    printf(")");
-}
-
 static void check_otp_write_error(picoboot::command_failure &e, bool ecc) {
     if (e.get_code() == PICOBOOT_UNSUPPORTED_MODIFICATION) {
         if (ecc) fail(ERROR_NOT_POSSIBLE, "Attempted to modify OTP ECC row(s)\n");