[FL-3453] NFC Logger

applications/main/nfc/application.fam

@@ -255,3 +255,41 @@ App(
     sources=["nfc_cli.c"],
     order=30,
 )
+
+App(
+    appid="nfc_logger_formatter",
+    apptype=FlipperAppType.PLUGIN,
+    entry_point="formatter_plugin_ep",
+    targets=["f7"],
+    requires=["nfc"],
+    sources=[
+        "plugins/logger/formatter/nfc_formatter.c",
+        "plugins/logger/formatter/common/nfc_history_formatter.c",
+        "plugins/logger/formatter/common/nfc_transaction_formatter.c",
+        "plugins/logger/formatter/helpers/nfc_transaction_string.c",
+        "plugins/logger/formatter/helpers/table.c",
+        "plugins/logger/formatter/protocols/nfc_protocol_formatters.c",
+        "plugins/logger/formatter/protocols/felica/felica_listener_data_formatter.c",
+        "plugins/logger/formatter/protocols/felica/felica_poller_data_formatter.c",
+        "plugins/logger/formatter/protocols/iso14443_3a/iso14443_3a_listener_data_formatter.c",
+        "plugins/logger/formatter/protocols/iso14443_3a/iso14443_3a_poller_data_formatter.c",
+        "plugins/logger/formatter/protocols/iso14443_3b/iso14443_3b_poller_data_formatter.c",
+        "plugins/logger/formatter/protocols/iso14443_4a/iso14443_4a_listener_data_formatter.c",
+        "plugins/logger/formatter/protocols/iso14443_4a/iso14443_4a_poller_data_formatter.c",
+        "plugins/logger/formatter/protocols/iso14443_4b/iso14443_4b_poller_data_formatter.c",
+        "plugins/logger/formatter/protocols/iso15693_3/iso15693_3_error_formatter.c",
+        "plugins/logger/formatter/protocols/iso15693_3/iso15693_3_listener_data_formatter.c",
+        "plugins/logger/formatter/protocols/iso15693_3/iso15693_3_poller_data_formatter.c",
+        "plugins/logger/formatter/protocols/mf_desfire/mf_desfire_poller_data_formatter.c",
+        "plugins/logger/formatter/protocols/mf_plus/mf_plus_poller_data_formatter.c",
+        "plugins/logger/formatter/protocols/mf_ultralight/mf_ultralight_listener_data_formatter.c",
+        "plugins/logger/formatter/protocols/mf_ultralight/mf_ultralight_poller_data_formatter.c",
+        "plugins/logger/formatter/protocols/mf_classic/mf_classic_listener_data_formatter.c",
+        "plugins/logger/formatter/protocols/mf_classic/mf_classic_poller_data_formatter.c",
+        "plugins/logger/formatter/protocols/nfc_hal/nfc_hal_formatter.c",
+        "plugins/logger/formatter/protocols/slix/slix_error_formatter.c",
+        "plugins/logger/formatter/protocols/slix/slix_listener_data_formatter.c",
+        "plugins/logger/formatter/protocols/slix/slix_poller_data_formatter.c",
+        "plugins/logger/formatter/protocols/st25tb/st25tb_poller_data_formatter.c",
+    ],
+)

applications/main/nfc/helpers/logger_formatter.c

@@ -0,0 +1,52 @@
+#include "logger_formatter.h"
+
+#include <flipper_application/flipper_application.h>
+#include <flipper_application/plugins/plugin_manager.h>
+#include <flipper_application/plugins/composite_resolver.h>
+#include <loader/firmware_api/firmware_api.h>
+
+#include "../plugins/logger/nfc_logger_formatter_plugin.h"
+
+#define TAG "LogFormatPluginLoader"
+
+void nfc_logger_format(Nfc* nfc, const NfcLoggerFormatterConfig* config) {
+    furi_assert(nfc);
+    furi_assert(config);
+
+    Storage* storage = furi_record_open(RECORD_STORAGE);
+
+    FlipperApplication* app = flipper_application_alloc(storage, firmware_api_interface);
+
+    do {
+        FlipperApplicationPreloadStatus preload_res =
+            flipper_application_preload(app, APP_DATA_PATH("plugins/nfc_logger_formatter.fal"));
+
+        if(preload_res != FlipperApplicationPreloadStatusSuccess) {
+            FURI_LOG_E(TAG, "Failed to preload plugin");
+            break;
+        }
+
+        if(!flipper_application_is_plugin(app)) {
+            FURI_LOG_E(TAG, "Plugin file is not a library");
+            break;
+        }
+
+        FlipperApplicationLoadStatus load_status = flipper_application_map_to_memory(app);
+        if(load_status != FlipperApplicationLoadStatusSuccess) {
+            FURI_LOG_E(TAG, "Failed to load plugin file");
+            break;
+        }
+
+        const FlipperAppPluginDescriptor* app_descriptor =
+            flipper_application_plugin_get_descriptor(app);
+
+        furi_check(app_descriptor->ep_api_version == 1);
+        furi_check(strcmp(app_descriptor->appid, NFC_LOGGER_FORMATTER_PLUGIN_APP_ID) == 0);
+
+        const NfcLoggerFormatterPlugin* plugin = app_descriptor->entry_point;
+        plugin->format(nfc, config);
+    } while(false);
+    flipper_application_free(app);
+
+    furi_record_close(RECORD_STORAGE);
+}

applications/main/nfc/helpers/logger_formatter.h

@@ -0,0 +1,16 @@
+#pragma once
+
+#include <core/string.h>
+
+#include <nfc/nfc.h>
+#include "plugins/logger/nfc_logger_config_data_type.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+void nfc_logger_format(Nfc* nfc, const NfcLoggerFormatterConfig* config);
+
+#ifdef __cplusplus
+}
+#endif

applications/main/nfc/helpers/nfc_supported_cards.c

@@ -160,7 +160,7 @@ static const NfcSupportedCardsPlugin* nfc_supported_cards_get_next_plugin(
                &instance->file_name[suffix_start_pos],
                NFC_SUPPORTED_CARDS_PLUGIN_SUFFIX,
                suffix_len) != 0) //-V1051
-            break;
+            continue; //Continue scanning plugin forlder because now there can be not only '_parser.fal' plugins
 
         // Trim suffix from file_name to save memory. The suffix will be concatenated on plugin load.
         instance->file_name[suffix_start_pos] = '\0';

applications/main/nfc/helpers/protocol_support/nfc_protocol_support.c

@@ -11,7 +11,7 @@
 
 #include "nfc_protocol_support_defs.h"
 #include "nfc_protocol_support_gui_common.h"
-
+#include "helpers/logger_formatter.h"
 /**
  * @brief Common scene entry handler.
  *
@@ -150,6 +150,8 @@ static void nfc_protocol_support_scene_read_on_enter(NfcApp* instance) {
 
     view_dispatcher_switch_to_view(instance->view_dispatcher, NfcViewPopup);
 
+    nfc_logger_config(nfc_get_logger(instance->nfc), instance->logger_enabled, NFC_LOG_FOLDER);
+
     const NfcProtocol protocol = nfc_detected_protocols_get_selected(instance->detected_protocols);
     instance->poller = nfc_poller_alloc(instance->nfc, protocol);
 
@@ -321,6 +323,10 @@ static void nfc_protocol_support_scene_read_success_on_enter(NfcApp* instance) {
         nfc_protocol_support[protocol]->scene_read_success.on_enter(instance);
     }
 
+    if(instance->logger_enabled) {
+        nfc_logger_format(instance->nfc, &instance->logger_config);
+    }
+
     furi_string_free(temp_str);
 
     widget_add_button_element(
@@ -608,6 +614,7 @@ static void nfc_protocol_support_scene_emulate_on_enter(NfcApp* instance) {
     text_box_set_focus(text_box, TextBoxFocusEnd);
     furi_string_reset(instance->text_box_store);
 
+    nfc_logger_config(nfc_get_logger(instance->nfc), instance->logger_enabled, NFC_LOG_FOLDER);
     // instance->listener is allocated in the respective on_enter() handler
     nfc_protocol_support[protocol]->scene_emulate.on_enter(instance);
 
@@ -674,6 +681,10 @@ static void nfc_protocol_support_scene_emulate_stop_listener(NfcApp* instance) {
         }
     }
 
+    if(instance->logger_enabled) {
+        nfc_logger_format(instance->nfc, &instance->logger_config);
+    }
+
     nfc_listener_free(instance->listener);
 }
 

applications/main/nfc/nfc_app.c

@@ -49,6 +49,10 @@ NfcApp* nfc_app_alloc(void) {
 
     instance->nfc = nfc_alloc();
 
+    instance->logger_enabled = false;
+    instance->logger_config.history_filter = NfcLoggerHistoryLayerFilterAll;
+    instance->logger_config.transaction_filter = NfcLoggerTransactionFilterAll;
+
     instance->detected_protocols = nfc_detected_protocols_alloc();
     instance->felica_auth = felica_auth_alloc();
     instance->mf_ul_auth = mf_ultralight_auth_alloc();

applications/main/nfc/nfc_app_i.h

@@ -36,6 +36,8 @@
 #include "helpers/felica_auth.h"
 #include "helpers/slix_unlock.h"
 
+#include "plugins/logger/nfc_logger_config_data_type.h"
+
 #include <dialogs/dialogs.h>
 #include <storage/storage.h>
 #include <toolbox/path.h>
@@ -67,6 +69,7 @@
 #define NFC_BYTE_INPUT_STORE_SIZE 10
 #define NFC_LOG_SIZE_MAX          (1024)
 #define NFC_APP_FOLDER            EXT_PATH("nfc")
+#define NFC_LOG_FOLDER            (NFC_APP_FOLDER "/log")
 #define NFC_APP_EXTENSION         ".nfc"
 #define NFC_APP_SHADOW_EXTENSION  ".shd"
 #define NFC_APP_FILENAME_PREFIX   "NFC"
@@ -116,6 +119,8 @@ struct NfcApp {
     char text_store[NFC_TEXT_STORE_SIZE + 1];
     FuriString* text_box_store;
     uint8_t byte_input_store[NFC_BYTE_INPUT_STORE_SIZE];
+    bool logger_enabled;
+    NfcLoggerFormatterConfig logger_config;
 
     NfcDetectedProtocols* detected_protocols;
 

applications/main/nfc/plugins/logger/formatter/common/nfc_history_formatter.c

@@ -0,0 +1,123 @@
+#include "nfc_history_formatter.h"
+#include "../protocols/nfc_hal/nfc_hal_formatter.h"
+#include "../protocols/nfc_protocol_formatters.h"
+#include <nfc/helpers/logger/history/nfc_history_chain_data_type.h>
+
+#define TAG "NfcHistoryFormatter"
+
+static bool
+    nfc_history_layer_filter_skip(const NfcFormatter* instance, const NfcProtocol item_protocol) {
+    const NfcLoggerHistoryLayerFilter filter = instance->config->history_filter;
+
+    return (
+        (filter == NfcLoggerHistoryLayerFilterTopProtocol ||
+         filter == NfcLoggerHistoryLayerFilterTopProtocolSimplified) &&
+        item_protocol != instance->protocol);
+}
+
+static void nfc_history_format_hal_item(const FuriHalNfcEvent nfc_event, FuriString* output) {
+    FuriString* layer_parsed_str = furi_string_alloc();
+    nfc_hal_data_format_hal_event_type(nfc_event, layer_parsed_str);
+    furi_string_printf(output, "L0(%s)", furi_string_get_cstr(layer_parsed_str));
+    furi_string_free(layer_parsed_str);
+}
+
+static NfcHistoryItemDataFormatCallback nfc_history_get_item_format_callback(
+    const NfcProtocol protocol,
+    const NfcMode mode,
+    const NfcLoggerHistoryLayerFilter filter) {
+    NfcHistoryItemDataFormatCallback callback = NULL;
+    do {
+        const NfcProtocolFormatterBase* protocol_formatter =
+            nfc_protocol_formatter_get(protocol, mode);
+        if(!protocol_formatter) break;
+
+        if(filter == NfcLoggerHistoryLayerFilterAll ||
+           filter == NfcLoggerHistoryLayerFilterTopProtocol) {
+            callback = protocol_formatter->format_history;
+        } else if(filter == NfcLoggerHistoryLayerFilterTopProtocolSimplified) {
+            callback = protocol_formatter->format_history_simplified;
+            if(callback == NULL) {
+                FURI_LOG_W(TAG, "Simplified formatting not implemented for protocol %d", protocol);
+            }
+        }
+    } while(false);
+    return callback;
+}
+
+static void nfc_history_format_item(
+    const NfcFormatter* instance,
+    const NfcPacket* request,
+    const NfcHistoryItem* item,
+    FuriString* output) {
+    do {
+        NfcHistoryItemDataFormatCallback callback = nfc_history_get_item_format_callback(
+            item->base.protocol, instance->mode, instance->config->history_filter);
+
+        if(callback == NULL) {
+            furi_string_printf(output, "Not implemented");
+            break;
+        }
+
+        callback(request, &item->data, output);
+    } while(false);
+}
+
+static void nfc_history_format_layer(
+    const size_t layer_num,
+    const NfcLoggerHistoryLayerFilter filter,
+    const FuriString* formatted_item,
+    FuriString* annotation) {
+    if(filter == NfcLoggerHistoryLayerFilterAll ||
+       filter == NfcLoggerHistoryLayerFilterTopProtocol) {
+        const char* format = (filter == NfcLoggerHistoryLayerFilterTopProtocol) ? "L%d(%s)" :
+                                                                                  "->L%d(%s)";
+        furi_string_cat_printf(
+            annotation, format, layer_num, furi_string_get_cstr(formatted_item));
+    } else if(filter == NfcLoggerHistoryLayerFilterTopProtocolSimplified) {
+        furi_string_printf(annotation, "%s", furi_string_get_cstr(formatted_item));
+    }
+}
+
+void nfc_histroy_format_annotation(
+    const NfcFormatter* instance,
+    const NfcPacket* request,
+    const NfcHistory* history,
+    const FuriHalNfcEvent nfc_event,
+    FuriString* annotation) {
+    furi_assert(instance);
+    furi_assert(history);
+    furi_assert(annotation);
+
+    const NfcLoggerHistoryLayerFilter filter = instance->config->history_filter;
+
+    if(filter == NfcLoggerHistoryLayerFilterAll) {
+        nfc_history_format_hal_item(nfc_event, annotation);
+    }
+
+    FuriString* layer_parsed_str = furi_string_alloc();
+    for(size_t i = 0; i < history->base.chain_count; i++) {
+        for(size_t j = 0; j < history->chains[i].length; j++) {
+            furi_string_reset(layer_parsed_str);
+            const NfcHistoryItem* item = &(history->chains[i].items[j]);
+
+            if(nfc_history_layer_filter_skip(instance, item->base.protocol)) continue;
+            nfc_history_format_item(instance, request, item, layer_parsed_str);
+            nfc_history_format_layer(j + 1, filter, layer_parsed_str, annotation);
+        }
+    }
+
+    furi_string_free(layer_parsed_str);
+}
+
+const NfcHistoryItem* nfc_history_get_item(const NfcHistory* history, const NfcProtocol protocol) {
+    for(size_t i = 0; i < history->base.chain_count; i++) {
+        for(size_t j = 0; j < history->chains[i].length; j++) {
+            const NfcHistoryItem* item = &(history->chains[i].items[j]);
+            if(item->base.protocol != protocol) continue;
+            return item;
+        }
+    }
+
+    return NULL;
+}

applications/main/nfc/plugins/logger/formatter/common/nfc_history_formatter.h

@@ -0,0 +1,25 @@
+#pragma once
+
+#include "../nfc_formatter_context.h"
+
+#include <furi.h>
+#include <furi_hal_nfc.h>
+#include <nfc/helpers/logger/history/nfc_history.h>
+#include <nfc/helpers/logger/transaction/nfc_packet_data_type.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+void nfc_histroy_format_annotation(
+    const NfcFormatter* instance,
+    const NfcPacket* request,
+    const NfcHistory* history,
+    const FuriHalNfcEvent nfc_event,
+    FuriString* annotation);
+
+const NfcHistoryItem* nfc_history_get_item(const NfcHistory* history, const NfcProtocol protocol);
+
+#ifdef __cplusplus
+}
+#endif