[FL-3097] fbt, faploader: minimal app module implementation (#2420)
* fbt, faploader: minimal app module implementation * faploader, libs: moved API hashtable core to flipper_application * example: compound api * lib: flipper_application: naming fixes, doxygen comments * fbt: changed `requires` manifest field behavior for app extensions * examples: refactored plugin apps; faploader: changed new API naming; fbt: changed PLUGIN app type meaning * loader: dropped support for debug apps & plugin menus * moved applications/plugins -> applications/external * Restored x bit on chiplist_convert.py * git: fixed free-dap submodule path * pvs: updated submodule paths * examples: example_advanced_plugins.c: removed potential memory leak on errors * examples: example_plugins: refined requires * fbt: not deploying app modules for debug/sample apps; extra validation for .PLUGIN-type apps * apps: removed cdefines for external apps * fbt: moved ext app path definition * fbt: reworked fap_dist handling; f18: synced api_symbols.csv * fbt: removed resources_paths for extapps * scripts: reworked storage * scripts: reworked runfap.py & selfupdate.py to use new api * wip: fal runner * fbt: moved file packaging into separate module * scripts: storage: fixes * scripts: storage: minor fixes for new api * fbt: changed internal artifact storage details for external apps * scripts: storage: additional fixes and better error reporting; examples: using APP_DATA_PATH() * fbt, scripts: reworked launch_app to deploy plugins; moved old runfap.py to distfap.py * fbt: extra check for plugins descriptors * fbt: additional checks in emitter * fbt: better info message on SDK rebuild * scripts: removed requirements.txt * loader: removed remnants of plugins & debug menus * post-review fixes
This commit is contained in:
31
applications/examples/example_plugins/application.fam
Normal file
31
applications/examples/example_plugins/application.fam
Normal file
@@ -0,0 +1,31 @@
|
||||
App(
|
||||
appid="example_plugins",
|
||||
name="Example: App w/plugin",
|
||||
apptype=FlipperAppType.EXTERNAL,
|
||||
entry_point="example_plugins_app",
|
||||
stack_size=2 * 1024,
|
||||
fap_category="Examples",
|
||||
)
|
||||
|
||||
App(
|
||||
appid="example_plugins_multi",
|
||||
name="Example: App w/plugins",
|
||||
apptype=FlipperAppType.EXTERNAL,
|
||||
entry_point="example_plugins_multi_app",
|
||||
stack_size=2 * 1024,
|
||||
fap_category="Examples",
|
||||
)
|
||||
|
||||
App(
|
||||
appid="example_plugin1",
|
||||
apptype=FlipperAppType.PLUGIN,
|
||||
entry_point="example_plugin1_ep",
|
||||
requires=["example_plugins", "example_plugins_multi"],
|
||||
)
|
||||
|
||||
App(
|
||||
appid="example_plugin2",
|
||||
apptype=FlipperAppType.PLUGIN,
|
||||
entry_point="example_plugin2_ep",
|
||||
requires=["example_plugins_multi"],
|
||||
)
|
70
applications/examples/example_plugins/example_plugins.c
Normal file
70
applications/examples/example_plugins/example_plugins.c
Normal file
@@ -0,0 +1,70 @@
|
||||
/*
|
||||
* An example of a plugin host application.
|
||||
* Loads a single plugin and calls its methods.
|
||||
*/
|
||||
|
||||
#include "plugin_interface.h"
|
||||
|
||||
#include <furi.h>
|
||||
|
||||
#include <flipper_application/flipper_application.h>
|
||||
#include <loader/firmware_api/firmware_api.h>
|
||||
#include <storage/storage.h>
|
||||
|
||||
#define TAG "example_plugins"
|
||||
|
||||
int32_t example_plugins_app(void* p) {
|
||||
UNUSED(p);
|
||||
|
||||
FURI_LOG_I(TAG, "Starting");
|
||||
|
||||
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/example_plugin1.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_LOG_I(
|
||||
TAG,
|
||||
"Loaded plugin for appid '%s', API %lu",
|
||||
app_descriptor->appid,
|
||||
app_descriptor->ep_api_version);
|
||||
|
||||
furi_check(app_descriptor->ep_api_version == PLUGIN_API_VERSION);
|
||||
furi_check(strcmp(app_descriptor->appid, PLUGIN_APP_ID) == 0);
|
||||
|
||||
const ExamplePlugin* plugin = app_descriptor->entry_point;
|
||||
|
||||
FURI_LOG_I(TAG, "Plugin name: %s", plugin->name);
|
||||
FURI_LOG_I(TAG, "Plugin method1: %d", plugin->method1());
|
||||
FURI_LOG_I(TAG, "Plugin method2(7,8): %d", plugin->method2(7, 8));
|
||||
FURI_LOG_I(TAG, "Plugin method2(1337,228): %d", plugin->method2(1337, 228));
|
||||
} while(false);
|
||||
flipper_application_free(app);
|
||||
|
||||
furi_record_close(RECORD_STORAGE);
|
||||
FURI_LOG_I(TAG, "Goodbye!");
|
||||
|
||||
return 0;
|
||||
}
|
@@ -0,0 +1,43 @@
|
||||
/*
|
||||
* An example of an advanced plugin host application.
|
||||
* It uses PluginManager to load all plugins from a directory
|
||||
*/
|
||||
|
||||
#include "plugin_interface.h"
|
||||
|
||||
#include <flipper_application/flipper_application.h>
|
||||
#include <flipper_application/plugins/plugin_manager.h>
|
||||
#include <loader/firmware_api/firmware_api.h>
|
||||
|
||||
#include <furi.h>
|
||||
|
||||
#define TAG "example_plugins"
|
||||
|
||||
int32_t example_plugins_multi_app(void* p) {
|
||||
UNUSED(p);
|
||||
|
||||
FURI_LOG_I(TAG, "Starting");
|
||||
|
||||
PluginManager* manager =
|
||||
plugin_manager_alloc(PLUGIN_APP_ID, PLUGIN_API_VERSION, firmware_api_interface);
|
||||
|
||||
if(plugin_manager_load_all(manager, APP_DATA_PATH("plugins")) != PluginManagerErrorNone) {
|
||||
FURI_LOG_E(TAG, "Failed to load all libs");
|
||||
return 0;
|
||||
}
|
||||
|
||||
uint32_t plugin_count = plugin_manager_get_count(manager);
|
||||
FURI_LOG_I(TAG, "Loaded %lu plugin(s)", plugin_count);
|
||||
|
||||
for(uint32_t i = 0; i < plugin_count; i++) {
|
||||
const ExamplePlugin* plugin = plugin_manager_get_ep(manager, i);
|
||||
FURI_LOG_I(TAG, "plugin name: %s", plugin->name);
|
||||
FURI_LOG_I(TAG, "plugin method1: %d", plugin->method1());
|
||||
FURI_LOG_I(TAG, "plugin method2(7,8): %d", plugin->method2(7, 8));
|
||||
}
|
||||
|
||||
plugin_manager_free(manager);
|
||||
FURI_LOG_I(TAG, "Goodbye!");
|
||||
|
||||
return 0;
|
||||
}
|
32
applications/examples/example_plugins/plugin1.c
Normal file
32
applications/examples/example_plugins/plugin1.c
Normal file
@@ -0,0 +1,32 @@
|
||||
/* A simple plugin implementing example_plugins application's plugin interface */
|
||||
|
||||
#include "plugin_interface.h"
|
||||
|
||||
#include <flipper_application/flipper_application.h>
|
||||
|
||||
static int example_plugin1_method1() {
|
||||
return 42;
|
||||
}
|
||||
|
||||
static int example_plugin1_method2(int arg1, int arg2) {
|
||||
return arg1 + arg2;
|
||||
}
|
||||
|
||||
/* Actual implementation of app<>plugin interface */
|
||||
static const ExamplePlugin example_plugin1 = {
|
||||
.name = "Demo App Plugin 1",
|
||||
.method1 = &example_plugin1_method1,
|
||||
.method2 = &example_plugin1_method2,
|
||||
};
|
||||
|
||||
/* Plugin descriptor to comply with basic plugin specification */
|
||||
static const FlipperAppPluginDescriptor example_plugin1_descriptor = {
|
||||
.appid = PLUGIN_APP_ID,
|
||||
.ep_api_version = PLUGIN_API_VERSION,
|
||||
.entry_point = &example_plugin1,
|
||||
};
|
||||
|
||||
/* Plugin entry point - must return a pointer to const descriptor */
|
||||
const FlipperAppPluginDescriptor* example_plugin1_ep() {
|
||||
return &example_plugin1_descriptor;
|
||||
}
|
32
applications/examples/example_plugins/plugin2.c
Normal file
32
applications/examples/example_plugins/plugin2.c
Normal file
@@ -0,0 +1,32 @@
|
||||
/* Second plugin implementing example_plugins application's plugin interface */
|
||||
|
||||
#include "plugin_interface.h"
|
||||
|
||||
#include <flipper_application/flipper_application.h>
|
||||
|
||||
static int example_plugin2_method1() {
|
||||
return 1337;
|
||||
}
|
||||
|
||||
static int example_plugin2_method2(int arg1, int arg2) {
|
||||
return arg1 - arg2;
|
||||
}
|
||||
|
||||
/* Actual implementation of app<>plugin interface */
|
||||
static const ExamplePlugin example_plugin2 = {
|
||||
.name = "Demo App Plugin 2",
|
||||
.method1 = &example_plugin2_method1,
|
||||
.method2 = &example_plugin2_method2,
|
||||
};
|
||||
|
||||
/* Plugin descriptor to comply with basic plugin specification */
|
||||
static const FlipperAppPluginDescriptor example_plugin2_descriptor = {
|
||||
.appid = PLUGIN_APP_ID,
|
||||
.ep_api_version = PLUGIN_API_VERSION,
|
||||
.entry_point = &example_plugin2,
|
||||
};
|
||||
|
||||
/* Plugin entry point - must return a pointer to const descriptor */
|
||||
const FlipperAppPluginDescriptor* example_plugin2_ep() {
|
||||
return &example_plugin2_descriptor;
|
||||
}
|
12
applications/examples/example_plugins/plugin_interface.h
Normal file
12
applications/examples/example_plugins/plugin_interface.h
Normal file
@@ -0,0 +1,12 @@
|
||||
#pragma once
|
||||
|
||||
/* Common interface between a plugin and host applicaion */
|
||||
|
||||
#define PLUGIN_APP_ID "example_plugins"
|
||||
#define PLUGIN_API_VERSION 1
|
||||
|
||||
typedef struct {
|
||||
const char* name;
|
||||
int (*method1)();
|
||||
int (*method2)(int, int);
|
||||
} ExamplePlugin;
|
Reference in New Issue
Block a user