NFC refactoring (#3050)

"A long time ago in a galaxy far, far away...." we started NFC subsystem refactoring. Starring: - @gornekich - NFC refactoring project lead, architect, senior developer - @gsurkov - architect, senior developer - @RebornedBrain - senior developer Supporting roles: - @skotopes, @DrZlo13, @hedger - general architecture advisors, code review - @Astrrra, @doomwastaken, @Hellitron, @ImagineVagon333 - quality assurance Special thanks: @bettse, @pcunning, @nxv, @noproto, @AloneLiberty and everyone else who has been helping us all this time and contributing valuable knowledges, ideas and source code.
2023-10-24 12:08:09 +09:00
parent 35c903494c
commit d92b0a82cc
514 changed files with 41487 additions and 68124 deletions
@@ -0,0 +1,144 @@
+#include "iso15693_3.h"
+#include "iso15693_3_render.h"
+
+#include <nfc/protocols/iso15693_3/iso15693_3_poller.h>
+#include <nfc/protocols/iso15693_3/iso15693_3_listener.h>
+
+#include "nfc/nfc_app_i.h"
+
+#include "../nfc_protocol_support_common.h"
+#include "../nfc_protocol_support_gui_common.h"
+
+static void nfc_scene_info_on_enter_iso15693_3(NfcApp* instance) {
+    const NfcDevice* device = instance->nfc_device;
+    const Iso15693_3Data* data = nfc_device_get_data(device, NfcProtocolIso15693_3);
+
+    FuriString* temp_str = furi_string_alloc();
+    furi_string_cat_printf(
+        temp_str, "\e#%s\n", nfc_device_get_name(device, NfcDeviceNameTypeFull));
+    nfc_render_iso15693_3_info(data, NfcProtocolFormatTypeFull, temp_str);
+
+    widget_add_text_scroll_element(
+        instance->widget, 0, 0, 128, 64, furi_string_get_cstr(temp_str));
+
+    furi_string_free(temp_str);
+}
+
+static NfcCommand nfc_scene_read_poller_callback_iso15693_3(NfcGenericEvent event, void* context) {
+    furi_assert(event.protocol == NfcProtocolIso15693_3);
+
+    NfcApp* instance = context;
+    const Iso15693_3PollerEvent* iso15693_3_event = event.event_data;
+
+    if(iso15693_3_event->type == Iso15693_3PollerEventTypeReady) {
+        nfc_device_set_data(
+            instance->nfc_device, NfcProtocolIso15693_3, nfc_poller_get_data(instance->poller));
+        view_dispatcher_send_custom_event(instance->view_dispatcher, NfcCustomEventPollerSuccess);
+        return NfcCommandStop;
+    }
+
+    return NfcCommandContinue;
+}
+
+static void nfc_scene_read_on_enter_iso15693_3(NfcApp* instance) {
+    UNUSED(instance);
+    nfc_poller_start(instance->poller, nfc_scene_read_poller_callback_iso15693_3, instance);
+}
+
+static void nfc_scene_read_success_on_enter_iso15693_3(NfcApp* instance) {
+    const NfcDevice* device = instance->nfc_device;
+    const Iso15693_3Data* data = nfc_device_get_data(device, NfcProtocolIso15693_3);
+
+    FuriString* temp_str = furi_string_alloc();
+    furi_string_cat_printf(
+        temp_str, "\e#%s\n", nfc_device_get_name(device, NfcDeviceNameTypeFull));
+    nfc_render_iso15693_3_info(data, NfcProtocolFormatTypeShort, temp_str);
+
+    widget_add_text_scroll_element(
+        instance->widget, 0, 0, 128, 52, furi_string_get_cstr(temp_str));
+
+    furi_string_free(temp_str);
+}
+
+static NfcCommand
+    nfc_scene_emulate_listener_callback_iso15693_3(NfcGenericEvent event, void* context) {
+    furi_assert(context);
+    furi_assert(event.protocol == NfcProtocolIso15693_3);
+    furi_assert(event.event_data);
+
+    NfcApp* nfc = context;
+    Iso15693_3ListenerEvent* iso15693_3_event = event.event_data;
+
+    if(iso15693_3_event->type == Iso15693_3ListenerEventTypeCustomCommand) {
+        if(furi_string_size(nfc->text_box_store) < NFC_LOG_SIZE_MAX) {
+            furi_string_cat_printf(nfc->text_box_store, "R:");
+            for(size_t i = 0; i < bit_buffer_get_size_bytes(iso15693_3_event->data->buffer); i++) {
+                furi_string_cat_printf(
+                    nfc->text_box_store,
+                    " %02X",
+                    bit_buffer_get_byte(iso15693_3_event->data->buffer, i));
+            }
+            furi_string_push_back(nfc->text_box_store, '\n');
+            view_dispatcher_send_custom_event(nfc->view_dispatcher, NfcCustomEventListenerUpdate);
+        }
+    }
+
+    return NfcCommandContinue;
+}
+
+static void nfc_scene_emulate_on_enter_iso15693_3(NfcApp* instance) {
+    const Iso15693_3Data* data = nfc_device_get_data(instance->nfc_device, NfcProtocolIso15693_3);
+
+    instance->listener = nfc_listener_alloc(instance->nfc, NfcProtocolIso15693_3, data);
+    nfc_listener_start(
+        instance->listener, nfc_scene_emulate_listener_callback_iso15693_3, instance);
+}
+
+static bool nfc_scene_saved_menu_on_event_iso15693_3(NfcApp* instance, uint32_t event) {
+    if(event == SubmenuIndexCommonEdit) {
+        scene_manager_next_scene(instance->scene_manager, NfcSceneSetUid);
+        return true;
+    }
+
+    return false;
+}
+
+const NfcProtocolSupportBase nfc_protocol_support_iso15693_3 = {
+    .features = NfcProtocolFeatureEmulateFull | NfcProtocolFeatureEditUid,
+
+    .scene_info =
+        {
+            .on_enter = nfc_scene_info_on_enter_iso15693_3,
+            .on_event = nfc_protocol_support_common_on_event_empty,
+        },
+    .scene_read =
+        {
+            .on_enter = nfc_scene_read_on_enter_iso15693_3,
+            .on_event = nfc_protocol_support_common_on_event_empty,
+        },
+    .scene_read_menu =
+        {
+            .on_enter = nfc_protocol_support_common_on_enter_empty,
+            .on_event = nfc_protocol_support_common_on_event_empty,
+        },
+    .scene_read_success =
+        {
+            .on_enter = nfc_scene_read_success_on_enter_iso15693_3,
+            .on_event = nfc_protocol_support_common_on_event_empty,
+        },
+    .scene_saved_menu =
+        {
+            .on_enter = nfc_protocol_support_common_on_enter_empty,
+            .on_event = nfc_scene_saved_menu_on_event_iso15693_3,
+        },
+    .scene_save_name =
+        {
+            .on_enter = nfc_protocol_support_common_on_enter_empty,
+            .on_event = nfc_protocol_support_common_on_event_empty,
+        },
+    .scene_emulate =
+        {
+            .on_enter = nfc_scene_emulate_on_enter_iso15693_3,
+            .on_event = nfc_protocol_support_common_on_event_empty,
+        },
+};
@@ -0,0 +1,5 @@
+#pragma once
+
+#include "../nfc_protocol_support_base.h"
+
+extern const NfcProtocolSupportBase nfc_protocol_support_iso15693_3;
@@ -0,0 +1,92 @@
+#include "iso15693_3_render.h"
+
+#define NFC_RENDER_ISO15693_3_MAX_BYTES (128U)
+
+void nfc_render_iso15693_3_info(
+    const Iso15693_3Data* data,
+    NfcProtocolFormatType format_type,
+    FuriString* str) {
+    if(format_type == NfcProtocolFormatTypeFull) {
+        furi_string_cat(str, "ISO15693-3 (NFC-V)\n");
+    }
+
+    nfc_render_iso15693_3_brief(data, str);
+
+    if(format_type == NfcProtocolFormatTypeFull) {
+        nfc_render_iso15693_3_extra(data, str);
+    }
+}
+
+void nfc_render_iso15693_3_brief(const Iso15693_3Data* data, FuriString* str) {
+    furi_string_cat_printf(str, "UID:");
+
+    size_t uid_len;
+    const uint8_t* uid = iso15693_3_get_uid(data, &uid_len);
+
+    for(size_t i = 0; i < uid_len; i++) {
+        furi_string_cat_printf(str, " %02X", uid[i]);
+    }
+
+    if(data->system_info.flags & ISO15693_3_SYSINFO_FLAG_MEMORY) {
+        const uint16_t block_count = iso15693_3_get_block_count(data);
+        const uint8_t block_size = iso15693_3_get_block_size(data);
+
+        furi_string_cat_printf(str, "Memory: %u bytes\n", block_count * block_size);
+        furi_string_cat_printf(str, "(%u blocks x %u bytes)", block_count, block_size);
+    }
+}
+
+void nfc_render_iso15693_3_extra(const Iso15693_3Data* data, FuriString* str) {
+    furi_string_cat(str, "\n\e#General info\n");
+    if(data->system_info.flags & ISO15693_3_SYSINFO_FLAG_DSFID) {
+        furi_string_cat_printf(str, "DSFID: %02X\n", data->system_info.ic_ref);
+    }
+
+    if(data->system_info.flags & ISO15693_3_SYSINFO_FLAG_AFI) {
+        furi_string_cat_printf(str, "AFI: %02X\n", data->system_info.afi);
+    }
+
+    if(data->system_info.flags & ISO15693_3_SYSINFO_FLAG_IC_REF) {
+        furi_string_cat_printf(str, "IC Reference: %02X\n", data->system_info.ic_ref);
+    }
+
+    furi_string_cat(str, "\e#Lock bits\n");
+
+    if(data->system_info.flags & ISO15693_3_SYSINFO_FLAG_DSFID) {
+        furi_string_cat_printf(
+            str, "DSFID: %s locked\n", data->settings.lock_bits.dsfid ? "" : "not");
+    }
+
+    if(data->system_info.flags & ISO15693_3_SYSINFO_FLAG_AFI) {
+        furi_string_cat_printf(
+            str, "AFI: %s locked\n", data->settings.lock_bits.dsfid ? "" : "not");
+    }
+
+    if(data->system_info.flags & ISO15693_3_SYSINFO_FLAG_MEMORY) {
+        furi_string_cat(str, "\e#Memory data\n\e*--------------------\n");
+
+        const uint16_t block_count = iso15693_3_get_block_count(data);
+        const uint8_t block_size = iso15693_3_get_block_size(data);
+        const uint16_t display_block_count =
+            MIN(NFC_RENDER_ISO15693_3_MAX_BYTES / block_size, block_count);
+
+        for(uint32_t i = 0; i < display_block_count; ++i) {
+            furi_string_cat(str, "\e*");
+
+            const uint8_t* block_data = iso15693_3_get_block_data(data, i);
+            for(uint32_t j = 0; j < block_size; ++j) {
+                furi_string_cat_printf(str, "%02X ", block_data[j]);
+            }
+
+            const char* lock_str = iso15693_3_is_block_locked(data, i) ? "[LOCK]" : "";
+            furi_string_cat_printf(str, "| %s\n", lock_str);
+        }
+
+        if(block_count != display_block_count) {
+            furi_string_cat_printf(
+                str,
+                "(Data is too big. Showing only the first %u bytes.)",
+                display_block_count * block_size);
+        }
+    }
+}
@@ -0,0 +1,14 @@
+#pragma once
+
+#include <nfc/protocols/iso15693_3/iso15693_3.h>
+
+#include "../nfc_protocol_support_render_common.h"
+
+void nfc_render_iso15693_3_info(
+    const Iso15693_3Data* data,
+    NfcProtocolFormatType format_type,
+    FuriString* str);
+
+void nfc_render_iso15693_3_brief(const Iso15693_3Data* data, FuriString* str);
+
+void nfc_render_iso15693_3_extra(const Iso15693_3Data* data, FuriString* str);