[FL-3954, FL-3955] New CLI architecture

SConstruct

@@ -412,6 +412,21 @@ distenv.PhonyTarget(
     ],
 )
 
+
+# Measure CLI loopback performance
+distenv.PhonyTarget(
+    "cli_perf",
+    [
+        [
+            "${PYTHON3}",
+            "${FBT_SCRIPT_DIR}/serial_cli_perf.py",
+            "-p",
+            "${FLIP_PORT}",
+            "${ARGS}",
+        ]
+    ],
+)
+
 # Update WiFi devboard firmware with release channel
 distenv.PhonyTarget(
     "devboard_flash",

applications/debug/speaker_debug/speaker_debug.c

@@ -3,6 +3,7 @@
 #include <music_worker/music_worker.h>
 #include <cli/cli.h>
 #include <toolbox/args.h>
+#include <toolbox/pipe.h>
 
 #define TAG "SpeakerDebug"
 
@@ -37,8 +38,8 @@ static void speaker_app_free(SpeakerDebugApp* app) {
     free(app);
 }
 
-static void speaker_app_cli(Cli* cli, FuriString* args, void* context) {
-    UNUSED(cli);
+static void speaker_app_cli(PipeSide* pipe, FuriString* args, void* context) {
+    UNUSED(pipe);
 
     SpeakerDebugApp* app = (SpeakerDebugApp*)context;
     SpeakerDebugAppMessage message;

applications/debug/unit_tests/test_runner.c

@@ -4,6 +4,7 @@
 
 #include <cli/cli.h>
 #include <toolbox/path.h>
+#include <toolbox/pipe.h>
 #include <loader/loader.h>
 #include <storage/storage.h>
 #include <notification/notification_messages.h>
@@ -25,7 +26,7 @@ struct TestRunner {
     NotificationApp* notification;
 
     // Temporary used things
-    Cli* cli;
+    PipeSide* pipe;
     FuriString* args;
 
     // ELF related stuff
@@ -38,14 +39,14 @@ struct TestRunner {
     int minunit_status;
 };
 
-TestRunner* test_runner_alloc(Cli* cli, FuriString* args) {
+TestRunner* test_runner_alloc(PipeSide* pipe, FuriString* args) {
     TestRunner* instance = malloc(sizeof(TestRunner));
 
     instance->storage = furi_record_open(RECORD_STORAGE);
     instance->loader = furi_record_open(RECORD_LOADER);
     instance->notification = furi_record_open(RECORD_NOTIFICATION);
 
-    instance->cli = cli;
+    instance->pipe = pipe;
     instance->args = args;
 
     instance->composite_resolver = composite_api_resolver_alloc();
@@ -147,7 +148,7 @@ static void test_runner_run_internal(TestRunner* instance) {
         }
 
         while(true) {
-            if(cli_cmd_interrupt_received(instance->cli)) {
+            if(cli_is_pipe_broken_or_is_etx_next_char(instance->pipe)) {
                 break;
             }
 

applications/debug/unit_tests/test_runner.h

@@ -1,12 +1,12 @@
 #pragma once
 
 #include <furi.h>
+#include <toolbox/pipe.h>
 
 typedef struct TestRunner TestRunner;
-typedef struct Cli Cli;
 
-TestRunner* test_runner_alloc(Cli* cli, FuriString* args);
+TestRunner* test_runner_alloc(PipeSide* pipe, FuriString* args);
 
-void test_runner_free(TestRunner* isntance);
+void test_runner_free(TestRunner* instance);
 
-void test_runner_run(TestRunner* isntance);
+void test_runner_run(TestRunner* instance);

applications/debug/unit_tests/tests/storage/storage_test.c

@@ -521,11 +521,6 @@ MU_TEST(test_storage_data_path) {
     // check that appsdata folder exists
     mu_check(storage_dir_exists(storage, APPS_DATA_PATH));
 
-    // check that cli folder exists
-    mu_check(storage_dir_exists(storage, APPSDATA_APP_PATH("cli")));
-
-    storage_simply_remove(storage, APPSDATA_APP_PATH("cli"));
-
     furi_record_close(RECORD_STORAGE);
 }
 

applications/debug/unit_tests/unit_tests.c

@@ -1,13 +1,13 @@
 #include <furi.h>
 #include <cli/cli.h>
+#include <toolbox/pipe.h>
 
 #include "test_runner.h"
 
-void unit_tests_cli(Cli* cli, FuriString* args, void* context) {
-    UNUSED(cli);
+void unit_tests_cli(PipeSide* pipe, FuriString* args, void* context) {
     UNUSED(context);
 
-    TestRunner* test_runner = test_runner_alloc(cli, args);
+    TestRunner* test_runner = test_runner_alloc(pipe, args);
     test_runner_run(test_runner);
     test_runner_free(test_runner);
 }

applications/main/application.fam

@@ -21,6 +21,7 @@ App(
     name="On start hooks",
     apptype=FlipperAppType.METAPACKAGE,
     provides=[
+        "cli",
         "ibutton_start",
         "onewire_start",
         "subghz_start",

applications/main/gpio/usb_uart_bridge.c

@@ -106,15 +106,15 @@ static void usb_uart_on_irq_rx_dma_cb(
 static void usb_uart_vcp_init(UsbUartBridge* usb_uart, uint8_t vcp_ch) {
     furi_hal_usb_unlock();
     if(vcp_ch == 0) {
-        Cli* cli = furi_record_open(RECORD_CLI);
-        cli_session_close(cli);
-        furi_record_close(RECORD_CLI);
+        CliVcp* cli_vcp = furi_record_open(RECORD_CLI_VCP);
+        cli_vcp_disable(cli_vcp);
+        furi_record_close(RECORD_CLI_VCP);
         furi_check(furi_hal_usb_set_config(&usb_cdc_single, NULL) == true);
     } else {
         furi_check(furi_hal_usb_set_config(&usb_cdc_dual, NULL) == true);
-        Cli* cli = furi_record_open(RECORD_CLI);
-        cli_session_open(cli, &cli_vcp);
-        furi_record_close(RECORD_CLI);
+        CliVcp* cli_vcp = furi_record_open(RECORD_CLI_VCP);
+        cli_vcp_enable(cli_vcp);
+        furi_record_close(RECORD_CLI_VCP);
     }
     furi_hal_cdc_set_callbacks(vcp_ch, (CdcCallbacks*)&cdc_cb, usb_uart);
 }
@@ -123,9 +123,9 @@ static void usb_uart_vcp_deinit(UsbUartBridge* usb_uart, uint8_t vcp_ch) {
     UNUSED(usb_uart);
     furi_hal_cdc_set_callbacks(vcp_ch, NULL, NULL);
     if(vcp_ch != 0) {
-        Cli* cli = furi_record_open(RECORD_CLI);
-        cli_session_close(cli);
-        furi_record_close(RECORD_CLI);
+        CliVcp* cli_vcp = furi_record_open(RECORD_CLI_VCP);
+        cli_vcp_disable(cli_vcp);
+        furi_record_close(RECORD_CLI_VCP);
     }
 }
 
@@ -309,9 +309,9 @@ static int32_t usb_uart_worker(void* context) {
 
     furi_hal_usb_unlock();
     furi_check(furi_hal_usb_set_config(&usb_cdc_single, NULL) == true);
-    Cli* cli = furi_record_open(RECORD_CLI);
-    cli_session_open(cli, &cli_vcp);
-    furi_record_close(RECORD_CLI);
+    CliVcp* cli_vcp = furi_record_open(RECORD_CLI_VCP);
+    cli_vcp_enable(cli_vcp);
+    furi_record_close(RECORD_CLI_VCP);
 
     return 0;
 }

applications/main/ibutton/ibutton_cli.c

@@ -1,26 +1,14 @@
 #include <furi.h>
 #include <furi_hal.h>
 
-#include <cli/cli.h>
+#include <cli/cli_commands.h>
 #include <toolbox/args.h>
+#include <toolbox/pipe.h>
 
 #include <ibutton/ibutton_key.h>
 #include <ibutton/ibutton_worker.h>
 #include <ibutton/ibutton_protocols.h>
 
-static void ibutton_cli(Cli* cli, FuriString* args, void* context);
-
-// app cli function
-void ibutton_on_system_start(void) {
-#ifdef SRV_CLI
-    Cli* cli = furi_record_open(RECORD_CLI);
-    cli_add_command(cli, "ikey", CliCommandFlagDefault, ibutton_cli, cli);
-    furi_record_close(RECORD_CLI);
-#else
-    UNUSED(ibutton_cli);
-#endif
-}
-
 static void ibutton_cli_print_usage(void) {
     printf("Usage:\r\n");
     printf("ikey read\r\n");
@@ -92,7 +80,7 @@ static void ibutton_cli_worker_read_cb(void* context) {
     furi_event_flag_set(event, EVENT_FLAG_IBUTTON_COMPLETE);
 }
 
-static void ibutton_cli_read(Cli* cli) {
+static void ibutton_cli_read(PipeSide* pipe) {
     iButtonProtocols* protocols = ibutton_protocols_alloc();
     iButtonWorker* worker = ibutton_worker_alloc(protocols);
     iButtonKey* key = ibutton_key_alloc(ibutton_protocols_get_max_data_size(protocols));
@@ -113,7 +101,7 @@ static void ibutton_cli_read(Cli* cli) {
             break;
         }
 
-        if(cli_cmd_interrupt_received(cli)) break;
+        if(cli_is_pipe_broken_or_is_etx_next_char(pipe)) break;
     }
 
     ibutton_worker_stop(worker);
@@ -138,7 +126,7 @@ static void ibutton_cli_worker_write_cb(void* context, iButtonWorkerWriteResult
     furi_event_flag_set(write_context->event, EVENT_FLAG_IBUTTON_COMPLETE);
 }
 
-void ibutton_cli_write(Cli* cli, FuriString* args) {
+void ibutton_cli_write(PipeSide* pipe, FuriString* args) {
     iButtonProtocols* protocols = ibutton_protocols_alloc();
     iButtonWorker* worker = ibutton_worker_alloc(protocols);
     iButtonKey* key = ibutton_key_alloc(ibutton_protocols_get_max_data_size(protocols));
@@ -181,7 +169,7 @@ void ibutton_cli_write(Cli* cli, FuriString* args) {
                 }
             }
 
-            if(cli_cmd_interrupt_received(cli)) break;
+            if(cli_is_pipe_broken_or_is_etx_next_char(pipe)) break;
         }
     } while(false);
 
@@ -195,7 +183,7 @@ void ibutton_cli_write(Cli* cli, FuriString* args) {
     furi_event_flag_free(write_context.event);
 }
 
-void ibutton_cli_emulate(Cli* cli, FuriString* args) {
+void ibutton_cli_emulate(PipeSide* pipe, FuriString* args) {
     iButtonProtocols* protocols = ibutton_protocols_alloc();
     iButtonWorker* worker = ibutton_worker_alloc(protocols);
     iButtonKey* key = ibutton_key_alloc(ibutton_protocols_get_max_data_size(protocols));
@@ -214,7 +202,7 @@ void ibutton_cli_emulate(Cli* cli, FuriString* args) {
 
         ibutton_worker_emulate_start(worker, key);
 
-        while(!cli_cmd_interrupt_received(cli)) {
+        while(!cli_is_pipe_broken_or_is_etx_next_char(pipe)) {
             furi_delay_ms(100);
         };
 
@@ -228,8 +216,8 @@ void ibutton_cli_emulate(Cli* cli, FuriString* args) {
     ibutton_protocols_free(protocols);
 }
 
-void ibutton_cli(Cli* cli, FuriString* args, void* context) {
-    UNUSED(cli);
+void ibutton_cli(PipeSide* pipe, FuriString* args, void* context) {
+    UNUSED(pipe);
     UNUSED(context);
     FuriString* cmd;
     cmd = furi_string_alloc();
@@ -241,14 +229,24 @@ void ibutton_cli(Cli* cli, FuriString* args, void* context) {
     }
 
     if(furi_string_cmp_str(cmd, "read") == 0) {
-        ibutton_cli_read(cli);
+        ibutton_cli_read(pipe);
     } else if(furi_string_cmp_str(cmd, "write") == 0) {
-        ibutton_cli_write(cli, args);
+        ibutton_cli_write(pipe, args);
     } else if(furi_string_cmp_str(cmd, "emulate") == 0) {
-        ibutton_cli_emulate(cli, args);
+        ibutton_cli_emulate(pipe, args);
     } else {
         ibutton_cli_print_usage();
     }
 
     furi_string_free(cmd);
 }
+
+void ibutton_on_system_start(void) {
+#ifdef SRV_CLI
+    Cli* cli = furi_record_open(RECORD_CLI);
+    cli_add_command(cli, "ikey", CliCommandFlagDefault, ibutton_cli, cli);
+    furi_record_close(RECORD_CLI);
+#else
+    UNUSED(ibutton_cli);
+#endif
+}