[FL-2627] Flipper applications: SDK, build and debug system (#1387)

* Added support for running applications from SD card (FAPs - Flipper Application Packages)
* Added plugin_dist target for fbt to build FAPs
* All apps of type FlipperAppType.EXTERNAL and FlipperAppType.PLUGIN are built as FAPs by default
* Updated VSCode configuration for new fbt features - re-deploy stock configuration to use them
* Added debugging support for FAPs with fbt debug & VSCode
* Added public firmware API with automated versioning

Co-authored-by: hedger <hedger@users.noreply.github.com>
Co-authored-by: SG <who.just.the.doctor@gmail.com>
Co-authored-by: あく <alleteam@gmail.com>

applications/debug/lfrfid_debug/application.fam

@@ -0,0 +1,15 @@
+App(
+    appid="lfrfid_debug",
+    name="LF-RFID Debug",
+    apptype=FlipperAppType.DEBUG,
+    entry_point="lfrfid_debug_app",
+    requires=[
+        "gui",
+    ],
+    provides=[
+        "lfrfid_debug",
+    ],
+    stack_size=1 * 1024,
+    order=100,
+    fap_category="Debug",
+)

applications/debug/lfrfid_debug/lfrfid_debug.c

@@ -0,0 +1,81 @@
+#include "lfrfid_debug_i.h"
+
+static bool lfrfid_debug_custom_event_callback(void* context, uint32_t event) {
+    furi_assert(context);
+    LfRfidDebug* app = context;
+    return scene_manager_handle_custom_event(app->scene_manager, event);
+}
+
+static bool lfrfid_debug_back_event_callback(void* context) {
+    furi_assert(context);
+    LfRfidDebug* app = context;
+    return scene_manager_handle_back_event(app->scene_manager);
+}
+
+static LfRfidDebug* lfrfid_debug_alloc() {
+    LfRfidDebug* app = malloc(sizeof(LfRfidDebug));
+
+    app->view_dispatcher = view_dispatcher_alloc();
+    app->scene_manager = scene_manager_alloc(&lfrfid_debug_scene_handlers, app);
+    view_dispatcher_enable_queue(app->view_dispatcher);
+    view_dispatcher_set_event_callback_context(app->view_dispatcher, app);
+    view_dispatcher_set_custom_event_callback(
+        app->view_dispatcher, lfrfid_debug_custom_event_callback);
+    view_dispatcher_set_navigation_event_callback(
+        app->view_dispatcher, lfrfid_debug_back_event_callback);
+
+    // Open GUI record
+    app->gui = furi_record_open(RECORD_GUI);
+    view_dispatcher_attach_to_gui(app->view_dispatcher, app->gui, ViewDispatcherTypeFullscreen);
+
+    // Submenu
+    app->submenu = submenu_alloc();
+    view_dispatcher_add_view(
+        app->view_dispatcher, LfRfidDebugViewSubmenu, submenu_get_view(app->submenu));
+
+    // Tune view
+    app->tune_view = lfrfid_debug_view_tune_alloc();
+    view_dispatcher_add_view(
+        app->view_dispatcher,
+        LfRfidDebugViewTune,
+        lfrfid_debug_view_tune_get_view(app->tune_view));
+
+    return app;
+}
+
+static void lfrfid_debug_free(LfRfidDebug* app) {
+    furi_assert(app);
+
+    // Submenu
+    view_dispatcher_remove_view(app->view_dispatcher, LfRfidDebugViewSubmenu);
+    submenu_free(app->submenu);
+
+    // Tune view
+    view_dispatcher_remove_view(app->view_dispatcher, LfRfidDebugViewTune);
+    lfrfid_debug_view_tune_free(app->tune_view);
+
+    // View Dispatcher
+    view_dispatcher_free(app->view_dispatcher);
+
+    // Scene Manager
+    scene_manager_free(app->scene_manager);
+
+    // GUI
+    furi_record_close(RECORD_GUI);
+    app->gui = NULL;
+
+    free(app);
+}
+
+int32_t lfrfid_debug_app(void* p) {
+    UNUSED(p);
+    LfRfidDebug* app = lfrfid_debug_alloc();
+
+    scene_manager_next_scene(app->scene_manager, LfRfidDebugSceneStart);
+
+    view_dispatcher_run(app->view_dispatcher);
+
+    lfrfid_debug_free(app);
+
+    return 0;
+}

applications/debug/lfrfid_debug/lfrfid_debug_i.h

@@ -0,0 +1,30 @@
+#pragma once
+#include <furi.h>
+#include <furi_hal.h>
+
+#include <gui/gui.h>
+#include <gui/view.h>
+#include <gui/view_dispatcher.h>
+#include <gui/scene_manager.h>
+
+#include <gui/modules/submenu.h>
+
+#include "views/lfrfid_debug_view_tune.h"
+#include "scenes/lfrfid_debug_scene.h"
+
+typedef struct LfRfidDebug LfRfidDebug;
+
+struct LfRfidDebug {
+    Gui* gui;
+    ViewDispatcher* view_dispatcher;
+    SceneManager* scene_manager;
+
+    // Common Views
+    Submenu* submenu;
+    LfRfidTuneView* tune_view;
+};
+
+typedef enum {
+    LfRfidDebugViewSubmenu,
+    LfRfidDebugViewTune,
+} LfRfidDebugView;

applications/debug/lfrfid_debug/scenes/lfrfid_debug_app_scene_start.c

@@ -0,0 +1,44 @@
+#include "../lfrfid_debug_i.h"
+
+typedef enum {
+    SubmenuIndexTune,
+} SubmenuIndex;
+
+static void lfrfid_debug_scene_start_submenu_callback(void* context, uint32_t index) {
+    LfRfidDebug* app = context;
+
+    view_dispatcher_send_custom_event(app->view_dispatcher, index);
+}
+
+void lfrfid_debug_scene_start_on_enter(void* context) {
+    LfRfidDebug* app = context;
+    Submenu* submenu = app->submenu;
+
+    submenu_add_item(
+        submenu, "Tune", SubmenuIndexTune, lfrfid_debug_scene_start_submenu_callback, app);
+
+    submenu_set_selected_item(
+        submenu, scene_manager_get_scene_state(app->scene_manager, LfRfidDebugSceneStart));
+
+    view_dispatcher_switch_to_view(app->view_dispatcher, LfRfidDebugViewSubmenu);
+}
+
+bool lfrfid_debug_scene_start_on_event(void* context, SceneManagerEvent event) {
+    LfRfidDebug* app = context;
+    bool consumed = false;
+
+    if(event.type == SceneManagerEventTypeCustom) {
+        if(event.event == SubmenuIndexTune) {
+            scene_manager_next_scene(app->scene_manager, LfRfidDebugSceneTune);
+            consumed = true;
+        }
+    }
+
+    return consumed;
+}
+
+void lfrfid_debug_scene_start_on_exit(void* context) {
+    LfRfidDebug* app = context;
+
+    submenu_reset(app->submenu);
+}

applications/debug/lfrfid_debug/scenes/lfrfid_debug_app_scene_tune.c

@@ -0,0 +1,48 @@
+#include "../lfrfid_debug_i.h"
+#include <furi_hal.h>
+
+static void comparator_trigger_callback(bool level, void* comp_ctx) {
+    UNUSED(comp_ctx);
+    furi_hal_gpio_write(&gpio_ext_pa7, !level);
+}
+
+void lfrfid_debug_scene_tune_on_enter(void* context) {
+    LfRfidDebug* app = context;
+
+    furi_hal_gpio_init_simple(&gpio_ext_pa7, GpioModeOutputPushPull);
+
+    furi_hal_rfid_comp_set_callback(comparator_trigger_callback, app);
+    furi_hal_rfid_comp_start();
+
+    furi_hal_rfid_pins_read();
+    furi_hal_rfid_tim_read(125000, 0.5);
+    furi_hal_rfid_tim_read_start();
+
+    view_dispatcher_switch_to_view(app->view_dispatcher, LfRfidDebugViewTune);
+}
+
+bool lfrfid_debug_scene_tune_on_event(void* context, SceneManagerEvent event) {
+    UNUSED(event);
+
+    LfRfidDebug* app = context;
+    bool consumed = false;
+
+    if(lfrfid_debug_view_tune_is_dirty(app->tune_view)) {
+        furi_hal_rfid_set_read_period(lfrfid_debug_view_tune_get_arr(app->tune_view));
+        furi_hal_rfid_set_read_pulse(lfrfid_debug_view_tune_get_ccr(app->tune_view));
+    }
+
+    return consumed;
+}
+
+void lfrfid_debug_scene_tune_on_exit(void* context) {
+    UNUSED(context);
+
+    furi_hal_rfid_comp_stop();
+    furi_hal_rfid_comp_set_callback(NULL, NULL);
+
+    furi_hal_gpio_init_simple(&gpio_ext_pa7, GpioModeAnalog);
+    furi_hal_rfid_tim_read_stop();
+    furi_hal_rfid_tim_reset();
+    furi_hal_rfid_pins_reset();
+}

applications/debug/lfrfid_debug/scenes/lfrfid_debug_scene.c

@@ -0,0 +1,30 @@
+#include "lfrfid_debug_scene.h"
+
+// Generate scene on_enter handlers array
+#define ADD_SCENE(prefix, name, id) prefix##_scene_##name##_on_enter,
+void (*const lfrfid_debug_on_enter_handlers[])(void*) = {
+#include "lfrfid_debug_scene_config.h"
+};
+#undef ADD_SCENE
+
+// Generate scene on_event handlers array
+#define ADD_SCENE(prefix, name, id) prefix##_scene_##name##_on_event,
+bool (*const lfrfid_debug_on_event_handlers[])(void* context, SceneManagerEvent event) = {
+#include "lfrfid_debug_scene_config.h"
+};
+#undef ADD_SCENE
+
+// Generate scene on_exit handlers array
+#define ADD_SCENE(prefix, name, id) prefix##_scene_##name##_on_exit,
+void (*const lfrfid_debug_on_exit_handlers[])(void* context) = {
+#include "lfrfid_debug_scene_config.h"
+};
+#undef ADD_SCENE
+
+// Initialize scene handlers configuration structure
+const SceneManagerHandlers lfrfid_debug_scene_handlers = {
+    .on_enter_handlers = lfrfid_debug_on_enter_handlers,
+    .on_event_handlers = lfrfid_debug_on_event_handlers,
+    .on_exit_handlers = lfrfid_debug_on_exit_handlers,
+    .scene_num = LfRfidDebugSceneNum,
+};

applications/debug/lfrfid_debug/scenes/lfrfid_debug_scene.h

@@ -0,0 +1,29 @@
+#pragma once
+
+#include <gui/scene_manager.h>
+
+// Generate scene id and total number
+#define ADD_SCENE(prefix, name, id) LfRfidDebugScene##id,
+typedef enum {
+#include "lfrfid_debug_scene_config.h"
+    LfRfidDebugSceneNum,
+} LfRfidDebugScene;
+#undef ADD_SCENE
+
+extern const SceneManagerHandlers lfrfid_debug_scene_handlers;
+
+// Generate scene on_enter handlers declaration
+#define ADD_SCENE(prefix, name, id) void prefix##_scene_##name##_on_enter(void*);
+#include "lfrfid_debug_scene_config.h"
+#undef ADD_SCENE
+
+// Generate scene on_event handlers declaration
+#define ADD_SCENE(prefix, name, id) \
+    bool prefix##_scene_##name##_on_event(void* context, SceneManagerEvent event);
+#include "lfrfid_debug_scene_config.h"
+#undef ADD_SCENE
+
+// Generate scene on_exit handlers declaration
+#define ADD_SCENE(prefix, name, id) void prefix##_scene_##name##_on_exit(void* context);
+#include "lfrfid_debug_scene_config.h"
+#undef ADD_SCENE

applications/debug/lfrfid_debug/scenes/lfrfid_debug_scene_config.h

@@ -0,0 +1,2 @@
+ADD_SCENE(lfrfid_debug, start, Start)
+ADD_SCENE(lfrfid_debug, tune, Tune)

applications/debug/lfrfid_debug/views/lfrfid_debug_view_tune.c

@@ -0,0 +1,229 @@
+#include "lfrfid_debug_view_tune.h"
+#include <gui/elements.h>
+
+#define TEMP_STR_LEN 128
+
+struct LfRfidTuneView {
+    View* view;
+};
+
+typedef struct {
+    bool dirty;
+    bool fine;
+    uint32_t ARR;
+    uint32_t CCR;
+    int pos;
+} LfRfidTuneViewModel;
+
+static void lfrfid_debug_view_tune_draw_callback(Canvas* canvas, void* _model) {
+    LfRfidTuneViewModel* model = _model;
+    canvas_set_color(canvas, ColorBlack);
+
+    if(model->fine) {
+        canvas_draw_box(
+            canvas,
+            128 - canvas_string_width(canvas, "Fine") - 4,
+            0,
+            canvas_string_width(canvas, "Fine") + 4,
+            canvas_current_font_height(canvas) + 1);
+        canvas_set_color(canvas, ColorWhite);
+    }
+    canvas_draw_str_aligned(canvas, 128 - 2, 2, AlignRight, AlignTop, "Fine");
+    canvas_set_color(canvas, ColorBlack);
+
+    char buffer[TEMP_STR_LEN + 1];
+    double freq = ((float)SystemCoreClock / ((float)model->ARR + 1));
+    double duty = ((float)model->CCR + 1) / ((float)model->ARR + 1) * 100.0f;
+    snprintf(
+        buffer,
+        TEMP_STR_LEN,
+        "%sARR: %lu\n"
+        "freq = %.4f\n"
+        "%sCCR: %lu\n"
+        "duty = %.4f",
+        model->pos == 0 ? ">" : "",
+        model->ARR,
+        freq,
+        model->pos == 1 ? ">" : "",
+        model->CCR,
+        duty);
+    elements_multiline_text_aligned(canvas, 2, 2, AlignLeft, AlignTop, buffer);
+}
+
+static void lfrfid_debug_view_tune_button_up(LfRfidTuneView* tune_view) {
+    with_view_model(
+        tune_view->view, (LfRfidTuneViewModel * model) {
+            if(model->pos > 0) model->pos--;
+            return true;
+        });
+}
+
+static void lfrfid_debug_view_tune_button_down(LfRfidTuneView* tune_view) {
+    with_view_model(
+        tune_view->view, (LfRfidTuneViewModel * model) {
+            if(model->pos < 1) model->pos++;
+            return true;
+        });
+}
+
+static void lfrfid_debug_view_tune_button_left(LfRfidTuneView* tune_view) {
+    with_view_model(
+        tune_view->view, (LfRfidTuneViewModel * model) {
+            if(model->pos == 0) {
+                if(model->fine) {
+                    model->ARR -= 1;
+                } else {
+                    model->ARR -= 10;
+                }
+            } else if(model->pos == 1) {
+                if(model->fine) {
+                    model->CCR -= 1;
+                } else {
+                    model->CCR -= 10;
+                }
+            }
+
+            model->dirty = true;
+            return true;
+        });
+}
+
+static void lfrfid_debug_view_tune_button_right(LfRfidTuneView* tune_view) {
+    with_view_model(
+        tune_view->view, (LfRfidTuneViewModel * model) {
+            if(model->pos == 0) {
+                if(model->fine) {
+                    model->ARR += 1;
+                } else {
+                    model->ARR += 10;
+                }
+            } else if(model->pos == 1) {
+                if(model->fine) {
+                    model->CCR += 1;
+                } else {
+                    model->CCR += 10;
+                }
+            }
+
+            model->dirty = true;
+            return true;
+        });
+}
+
+static void lfrfid_debug_view_tune_button_ok(LfRfidTuneView* tune_view) {
+    with_view_model(
+        tune_view->view, (LfRfidTuneViewModel * model) {
+            model->fine = !model->fine;
+            return true;
+        });
+}
+
+static bool lfrfid_debug_view_tune_input_callback(InputEvent* event, void* context) {
+    LfRfidTuneView* tune_view = context;
+    bool consumed = false;
+
+    // Process key presses only
+    if(event->type == InputTypeShort || event->type == InputTypeRepeat) {
+        consumed = true;
+
+        switch(event->key) {
+        case InputKeyLeft:
+            lfrfid_debug_view_tune_button_left(tune_view);
+            break;
+        case InputKeyRight:
+            lfrfid_debug_view_tune_button_right(tune_view);
+            break;
+        case InputKeyUp:
+            lfrfid_debug_view_tune_button_up(tune_view);
+            break;
+        case InputKeyDown:
+            lfrfid_debug_view_tune_button_down(tune_view);
+            break;
+        case InputKeyOk:
+            lfrfid_debug_view_tune_button_ok(tune_view);
+            break;
+        default:
+            consumed = false;
+            break;
+        }
+    }
+
+    return consumed;
+}
+
+LfRfidTuneView* lfrfid_debug_view_tune_alloc() {
+    LfRfidTuneView* tune_view = malloc(sizeof(LfRfidTuneView));
+    tune_view->view = view_alloc();
+    view_set_context(tune_view->view, tune_view);
+    view_allocate_model(tune_view->view, ViewModelTypeLocking, sizeof(LfRfidTuneViewModel));
+
+    with_view_model(
+        tune_view->view, (LfRfidTuneViewModel * model) {
+            model->dirty = true;
+            model->fine = false;
+            model->ARR = 511;
+            model->CCR = 255;
+            model->pos = 0;
+            return true;
+        });
+
+    view_set_draw_callback(tune_view->view, lfrfid_debug_view_tune_draw_callback);
+    view_set_input_callback(tune_view->view, lfrfid_debug_view_tune_input_callback);
+
+    return tune_view;
+}
+
+void lfrfid_debug_view_tune_free(LfRfidTuneView* tune_view) {
+    view_free(tune_view->view);
+    free(tune_view);
+}
+
+View* lfrfid_debug_view_tune_get_view(LfRfidTuneView* tune_view) {
+    return tune_view->view;
+}
+
+void lfrfid_debug_view_tune_clean(LfRfidTuneView* tune_view) {
+    with_view_model(
+        tune_view->view, (LfRfidTuneViewModel * model) {
+            model->dirty = true;
+            model->fine = false;
+            model->ARR = 511;
+            model->CCR = 255;
+            model->pos = 0;
+            return true;
+        });
+}
+
+bool lfrfid_debug_view_tune_is_dirty(LfRfidTuneView* tune_view) {
+    bool result = false;
+    with_view_model(
+        tune_view->view, (LfRfidTuneViewModel * model) {
+            result = model->dirty;
+            model->dirty = false;
+            return false;
+        });
+
+    return result;
+}
+
+uint32_t lfrfid_debug_view_tune_get_arr(LfRfidTuneView* tune_view) {
+    uint32_t result = false;
+    with_view_model(
+        tune_view->view, (LfRfidTuneViewModel * model) {
+            result = model->ARR;
+            return false;
+        });
+
+    return result;
+}
+
+uint32_t lfrfid_debug_view_tune_get_ccr(LfRfidTuneView* tune_view) {
+    uint32_t result = false;
+    with_view_model(
+        tune_view->view, (LfRfidTuneViewModel * model) {
+            result = model->CCR;
+            return false;
+        });
+
+    return result;
+}

applications/debug/lfrfid_debug/views/lfrfid_debug_view_tune.h

@@ -0,0 +1,18 @@
+#pragma once
+#include <gui/view.h>
+
+typedef struct LfRfidTuneView LfRfidTuneView;
+
+LfRfidTuneView* lfrfid_debug_view_tune_alloc();
+
+void lfrfid_debug_view_tune_free(LfRfidTuneView* tune_view);
+
+View* lfrfid_debug_view_tune_get_view(LfRfidTuneView* tune_view);
+
+void lfrfid_debug_view_tune_clean(LfRfidTuneView* tune_view);
+
+bool lfrfid_debug_view_tune_is_dirty(LfRfidTuneView* tune_view);
+
+uint32_t lfrfid_debug_view_tune_get_arr(LfRfidTuneView* tune_view);
+
+uint32_t lfrfid_debug_view_tune_get_ccr(LfRfidTuneView* tune_view);