External apps (#1469)

* implemented external app build

* added some ui stuff for testing

* added pacman game

* wired key to pacman game

* fixed pacman drawing issue

* changed afsk rx app to be external

* fixed ui::NavigationView initialization for external apps

* refactoring

* refactoring

* moved m4 image to external app

* added script for external app deployment

* refactoring

* implemented dynamic app listing

* added color to app icon

* improved app loading

* added external apps to sd card content

* refactoring

* review findings

* typo

* review findings

* improved memory management of bitmaps

firmware/application/external/afsk_rx/main.cpp

@@ -0,0 +1,82 @@
+/*
+ * Copyright (C) 2023 Bernd Herzog
+ *
+ * This file is part of PortaPack.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2, or (at your option)
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; see the file COPYING.  If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#include "ui.hpp"
+#include "ui_afsk_rx.hpp"
+#include "ui_navigation.hpp"
+#include "external_app.hpp"
+
+namespace ui::external_app::afsk_rx {
+void initialize_app(ui::NavigationView& nav) {
+    nav.push<AFSKRxView>();
+}
+}  // namespace ui::external_app::afsk_rx
+
+extern "C" {
+
+__attribute__((section(".external_app.app_afsk_rx.application_information"), used)) application_information_t _application_information_afsk_rx = {
+    /*.memory_location = */ (uint8_t*)0x00000000,
+    /*.externalAppEntry = */ ui::external_app::afsk_rx::initialize_app,
+    /*.header_version = */ CURRENT_HEADER_VERSION,
+    /*.app_version = */ VERSION_MD5,
+
+    /*.app_name = */ "AFSK",
+    /*.bitmap_data = */ {
+        0x00,
+        0x00,
+        0x00,
+        0x00,
+        0x00,
+        0x00,
+        0x00,
+        0x00,
+        0xF8,
+        0x1F,
+        0x04,
+        0x20,
+        0x02,
+        0x40,
+        0xFF,
+        0xFF,
+        0xFF,
+        0xFF,
+        0xAB,
+        0xDF,
+        0xAB,
+        0xDF,
+        0xFF,
+        0xFF,
+        0xFF,
+        0xFF,
+        0x00,
+        0x00,
+        0x00,
+        0x00,
+        0x00,
+        0x00,
+    },
+    /*.icon_color = */ ui::Color::yellow().v,
+    /*.menu_location = */ app_location_t::RX,
+
+    /*.m4_app_tag = portapack::spi_flash::image_tag_afsk_rx */ {'P', 'A', 'F', 'R'},
+    /*.m4_app_offset = */ 0x00000000,  // will be filled at compile time
+};
+}

firmware/application/external/afsk_rx/ui_afsk_rx.cpp

@@ -0,0 +1,151 @@
+/*
+ * Copyright (C) 2014 Jared Boone, ShareBrained Technology, Inc.
+ * Copyright (C) 2017 Furrtek
+ *
+ * This file is part of PortaPack.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2, or (at your option)
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; see the file COPYING.  If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#include "ui_afsk_rx.hpp"
+#include "ui_modemsetup.hpp"
+
+#include "modems.hpp"
+#include "audio.hpp"
+#include "rtc_time.hpp"
+#include "baseband_api.hpp"
+#include "string_format.hpp"
+#include "portapack_persistent_memory.hpp"
+
+using namespace portapack;
+using namespace modems;
+using namespace ui;
+
+namespace ui::external_app::afsk_rx {
+
+void AFSKLogger::log_raw_data(const std::string& data) {
+    log_file.write_entry(data);
+}
+
+void AFSKRxView::focus() {
+    field_frequency.focus();
+}
+
+AFSKRxView::AFSKRxView(NavigationView& nav)
+    : nav_{nav} {
+    baseband::run_prepared_image(portapack::memory::map::m4_code.base());
+
+    add_children({&rssi,
+                  &channel,
+                  &field_rf_amp,
+                  &field_lna,
+                  &field_vga,
+                  &field_volume,
+                  &field_frequency,
+                  &check_log,
+                  &text_debug,
+                  &button_modem_setup,
+                  &console});
+
+    // Auto-configure modem for LCR RX (TODO remove)
+    field_frequency.set_value(467225500);
+    auto def_bell202 = &modem_defs[0];
+    persistent_memory::set_modem_baudrate(def_bell202->baudrate);
+    serial_format_t serial_format;
+    serial_format.data_bits = 7;
+    serial_format.parity = EVEN;
+    serial_format.stop_bits = 1;
+    serial_format.bit_order = LSB_FIRST;
+    persistent_memory::set_serial_format(serial_format);
+
+    field_frequency.set_step(100);
+
+    check_log.set_value(logging);
+    check_log.on_select = [this](Checkbox&, bool v) {
+        logging = v;
+    };
+
+    button_modem_setup.on_select = [&nav](Button&) {
+        nav.push<ModemSetupView>();
+    };
+
+    logger = std::make_unique<AFSKLogger>();
+    if (logger)
+        logger->append(LOG_ROOT_DIR "/AFSK.TXT");
+
+    // Auto-configure modem for LCR RX (will be removed later)
+    baseband::set_afsk(persistent_memory::modem_baudrate(), 8, 0, false);
+
+    audio::set_rate(audio::Rate::Hz_24000);
+    audio::output::start();
+
+    receiver_model.enable();
+}
+
+void AFSKRxView::on_data(uint32_t value, bool is_data) {
+    std::string str_console = "\x1B";
+    std::string str_byte = "";
+
+    if (is_data) {
+        // Colorize differently after message splits
+        str_console += (char)((console_color & 3) + 9);
+
+        // value = deframe_word(value);
+
+        value &= 0xFF;                                          // ABCDEFGH
+        value = ((value & 0xF0) >> 4) | ((value & 0x0F) << 4);  // EFGHABCD
+        value = ((value & 0xCC) >> 2) | ((value & 0x33) << 2);  // GHEFCDAB
+        value = ((value & 0xAA) >> 1) | ((value & 0x55) << 1);  // HGFEDCBA
+        value &= 0x7F;                                          // Ignore parity, which is the MSB now
+
+        if ((value >= 32) && (value < 127)) {
+            str_console += (char)value;  // Printable
+            str_byte += (char)value;
+        } else {
+            str_console += "[" + to_string_hex(value, 2) + "]";  // Not printable
+            str_byte += "[" + to_string_hex(value, 2) + "]";
+        }
+
+        // str_byte = to_string_bin(value & 0xFF, 8) + "  ";
+
+        console.write(str_console);
+
+        if (logger && logging) str_log += str_byte;
+
+        if ((value != 0x7F) && (prev_value == 0x7F)) {
+            // Message split
+            console.writeln("");
+            console_color++;
+
+            if (logger && logging) {
+                logger->log_raw_data(str_log);
+                str_log = "";
+            }
+        }
+        prev_value = value;
+    } else {
+        // Baudrate estimation
+        text_debug.set("Baudrate estimation: ~" + to_string_dec_uint(value));
+    }
+}
+
+AFSKRxView::~AFSKRxView() {
+    audio::output::stop();
+    receiver_model.disable();
+    baseband::shutdown();
+}
+
+}  // namespace ui::external_app::afsk_rx

firmware/application/external/afsk_rx/ui_afsk_rx.hpp

@@ -0,0 +1,123 @@
+/*
+ * Copyright (C) 2014 Jared Boone, ShareBrained Technology, Inc.
+ * Copyright (C) 2017 Furrtek
+ *
+ * This file is part of PortaPack.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2, or (at your option)
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; see the file COPYING.  If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#ifndef __UI_AFSK_RX_H__
+#define __UI_AFSK_RX_H__
+
+#include "ui.hpp"
+#include "ui_navigation.hpp"
+#include "ui_receiver.hpp"
+#include "ui_freq_field.hpp"
+#include "ui_record_view.hpp"
+#include "app_settings.hpp"
+#include "radio_state.hpp"
+#include "log_file.hpp"
+#include "utility.hpp"
+
+using namespace ui;
+
+namespace ui::external_app::afsk_rx {
+
+class AFSKLogger {
+   public:
+    Optional<File::Error> append(const std::string& filename) {
+        return log_file.append(filename);
+    }
+
+    void log_raw_data(const std::string& data);
+
+   private:
+    LogFile log_file{};
+};
+
+class AFSKRxView : public View {
+   public:
+    AFSKRxView(NavigationView& nav);
+    ~AFSKRxView();
+
+    void focus() override;
+
+    std::string title() const override { return "AFSK RX"; };
+
+   private:
+    void on_data(uint32_t value, bool is_data);
+
+    NavigationView& nav_;
+    RxRadioState radio_state_{};
+    app_settings::SettingsManager settings_{
+        "rx_afsk", app_settings::Mode::RX};
+
+    uint8_t console_color{0};
+    uint32_t prev_value{0};
+    std::string str_log{""};
+    bool logging{false};
+
+    RFAmpField field_rf_amp{
+        {13 * 8, 0 * 16}};
+    LNAGainField field_lna{
+        {15 * 8, 0 * 16}};
+    VGAGainField field_vga{
+        {18 * 8, 0 * 16}};
+    RSSI rssi{
+        {21 * 8, 0, 6 * 8, 4}};
+    Channel channel{
+        {21 * 8, 5, 6 * 8, 4}};
+
+    AudioVolumeField field_volume{
+        {28 * 8, 0 * 16}};
+
+    RxFrequencyField field_frequency{
+        {0 * 8, 0 * 16},
+        nav_};
+
+    Checkbox check_log{
+        {0 * 8, 1 * 16},
+        3,
+        "LOG",
+        false};
+
+    Text text_debug{
+        {0 * 8, 12 + 2 * 16, screen_width, 16},
+        "DEBUG"};
+
+    Button button_modem_setup{
+        {screen_width - 12 * 8, 1 * 16, 96, 24},
+        "Modem setup"};
+
+    Console console{
+        {0, 4 * 16, 240, screen_width}};
+
+    void on_data_afsk(const AFSKDataMessage& message);
+
+    std::unique_ptr<AFSKLogger> logger{};
+
+    MessageHandlerRegistration message_handler_packet{
+        Message::ID::AFSKData,
+        [this](Message* const p) {
+            const auto message = static_cast<const AFSKDataMessage*>(p);
+            this->on_data(message->value, message->is_data);
+        }};
+};
+
+}  // namespace ui::external_app::afsk_rx
+
+#endif /*__UI_AFSK_RX_H__*/

firmware/application/external/external.cmake

@@ -0,0 +1,15 @@
+set(EXTCPPSRC
+
+	#pacman
+	external/pacman/main.cpp
+	external/pacman/ui_pacman.cpp
+	
+	#afsk_rx
+	external/afsk_rx/main.cpp
+	external/afsk_rx/ui_afsk_rx.cpp
+)
+
+set(EXTAPPLIST
+	pacman
+	afsk_rx
+)

firmware/application/external/external.ld

@@ -0,0 +1,37 @@
+/*
+    Copyright (C) 2023 Bernd Herzog
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+*/
+
+MEMORY
+{
+    /* external apps: regions can't overlap so addresses are corrected after build */
+    ram_external_app_pacman     (rwx) : org = 0xEEE90000, len = 40k
+    ram_external_app_afsk_rx    (rwx) : org = 0xEEEA0000, len = 40k
+}
+
+SECTIONS
+{
+    .external_app_pacman : ALIGN(16) SUBALIGN(16)
+    {
+        KEEP(*(.external_app.app_pacman.application_information));
+        *(*ui*external_app*pacman*);
+    } > ram_external_app_pacman
+
+    .external_app_afsk_rx : ALIGN(16) SUBALIGN(16)
+    {
+        KEEP(*(.external_app.app_afsk_rx.application_information));
+        *(*ui*external_app*afsk_rx*);
+    } > ram_external_app_afsk_rx
+}

firmware/application/external/pacman/DrawIndexedMap.h

@@ -0,0 +1,66 @@
+/******************************************************************************/
+/*                                                                            */
+/*  PACMAN GAME FOR ARDUINO DUE                                               */
+/*                                                                            */
+/******************************************************************************/
+/*  Copyright (c) 2014  Dr. NCX (mirracle.mxx@gmail.com)                      */
+/*                                                                            */
+/* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL              */
+/* WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED              */
+/* WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR    */
+/* BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES      */
+/* OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,     */
+/* WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,     */
+/* ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS        */
+/* SOFTWARE.                                                                  */
+/*                                                                            */
+/*  MIT license, all text above must be included in any redistribution.       */
+
+// #include "ili9328.h"
+
+typedef uint16_t ushort;
+
+#define C16(_rr, _gg, _bb) ((ushort)(((_rr & 0xF8) << 8) | ((_gg & 0xFC) << 3) | ((_bb & 0xF8) >> 3)))
+
+uint16_t _paletteW[] =
+    {
+        C16(0, 0, 0),
+        C16(255, 0, 0),     // 1 red
+        C16(222, 151, 81),  // 2 brown
+        C16(255, 0, 255),   // 3 pink
+
+        C16(0, 0, 0),
+        C16(0, 255, 255),   // 5 cyan
+        C16(71, 84, 255),   // 6 mid blue
+        C16(255, 184, 81),  // 7 lt brown
+
+        C16(0, 0, 0),
+        C16(255, 255, 0),  // 9 yellow
+        C16(0, 0, 0),
+        C16(33, 33, 255),  // 11 blue
+
+        C16(0, 255, 0),      // 12 green
+        C16(71, 84, 174),    // 13 aqua
+        C16(255, 184, 174),  // 14 lt pink
+        C16(222, 222, 255),  // 15 whiteish
+};
+
+void drawIndexedmap(uint8_t* indexmap, int16_t x, uint16_t y) {
+    ui::Painter painter;
+
+    byte i = 0;
+    word color = (word)_paletteW[indexmap[0]];
+    for (byte tmpY = 0; tmpY < 8; tmpY++) {
+        byte width = 1;
+        for (byte tmpX = 0; tmpX < 8; tmpX++) {
+            word next_color = (word)_paletteW[indexmap[++i]];
+            if ((color != next_color && width >= 1) || tmpX == 7) {
+                painter.draw_hline({x + tmpX - width + 1, y + tmpY}, width, ui::Color(color));
+
+                color = next_color;
+                width = 0;
+            }
+            width++;
+        }
+    }
+}

firmware/application/external/pacman/main.cpp

@@ -0,0 +1,82 @@
+/*
+ * Copyright (C) 2023 Bernd Herzog
+ *
+ * This file is part of PortaPack.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2, or (at your option)
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; see the file COPYING.  If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#include "ui.hpp"
+#include "ui_pacman.hpp"
+#include "ui_navigation.hpp"
+#include "external_app.hpp"
+
+namespace ui::external_app::pacman {
+void initialize_app(ui::NavigationView& nav) {
+    nav.push<PacmanView>();
+}
+}  // namespace ui::external_app::pacman
+
+extern "C" {
+
+__attribute__((section(".external_app.app_pacman.application_information"), used)) application_information_t _application_information_pacman = {
+    /*.memory_location = */ (uint8_t*)0x00000000,  // will be filled at compile time
+    /*.externalAppEntry = */ ui::external_app::pacman::initialize_app,
+    /*.header_version = */ CURRENT_HEADER_VERSION,
+    /*.app_version = */ VERSION_MD5,
+
+    /*.app_name = */ "Pac-Man",
+    /*.bitmap_data = */ {
+        0x00,
+        0x00,
+        0x00,
+        0x00,
+        0xC0,
+        0x07,
+        0xE0,
+        0x0F,
+        0xF0,
+        0x1F,
+        0xF8,
+        0x07,
+        0xF8,
+        0x01,
+        0x78,
+        0x00,
+        0xF8,
+        0x01,
+        0xF8,
+        0x07,
+        0xF0,
+        0x1F,
+        0xE0,
+        0x0F,
+        0xC0,
+        0x07,
+        0x00,
+        0x00,
+        0x00,
+        0x00,
+        0x00,
+        0x00,
+    },
+    /*.icon_color = */ ui::Color::yellow().v,
+    /*.menu_location = */ app_location_t::UTILITIES,
+
+    /*.m4_app_tag = portapack::spi_flash::image_tag_noop */ {'\0', '\0', '\0', '\0'},  // optional
+    /*.m4_app_offset = */ 0x00000000,                                                  // will be filled at compile time
+};
+}

firmware/application/external/pacman/ui_pacman.cpp

@@ -0,0 +1,50 @@
+#include "ui_pacman.hpp"
+#include "irq_controls.hpp"
+
+namespace ui::external_app::pacman {
+
+#pragma GCC diagnostic push
+// external code, so ignore warnings
+#pragma GCC diagnostic ignored "-Wunused-variable"
+#pragma GCC diagnostic ignored "-Wunused-parameter"
+#pragma GCC diagnostic ignored "-Wunused-but-set-variable"
+#pragma GCC diagnostic ignored "-Wreturn-type"
+#pragma GCC diagnostic ignored "-Weffc++"
+#include "playfield.hpp"
+#pragma GCC diagnostic pop
+
+Playfield _game;
+
+PacmanView::PacmanView(NavigationView& nav)
+    : nav_(nav) {
+    add_children({&dummy});
+}
+
+void PacmanView::focus() {
+    dummy.focus();
+}
+
+void PacmanView::paint(Painter& painter) {
+    (void)painter;
+
+    if (!initialized) {
+        initialized = true;
+        _game.Init();
+    }
+
+    auto switches_debounced = get_switches_state().to_ulong();
+
+    but_RIGHT = (switches_debounced & 0x01) == 0x01;
+    but_LEFT = (switches_debounced & 0x02) == 0x02;
+    but_DOWN = (switches_debounced & 0x04) == 0x04;
+    but_UP = (switches_debounced & 0x08) == 0x08;
+    but_A = (switches_debounced & 0x10) == 0x10;
+
+    _game.Step();
+}
+
+void PacmanView::frame_sync() {
+    set_dirty();
+}
+
+}  // namespace ui::external_app::pacman

firmware/application/external/pacman/ui_pacman.hpp

@@ -0,0 +1,59 @@
+/*
+ * Copyright (C) 2023 Bernd Herzog
+ *
+ * This file is part of PortaPack.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2, or (at your option)
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; see the file COPYING.  If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#ifndef __UI_PACMAN_H__
+#define __UI_PACMAN_H__
+
+#include "ui_navigation.hpp"
+#include "event_m0.hpp"
+#include "message.hpp"
+
+namespace ui::external_app::pacman {
+
+class PacmanView : public View {
+   public:
+    PacmanView(NavigationView& nav);
+
+    void focus() override;
+
+    std::string title() const override { return "Pac-Man"; };
+
+    void paint(Painter& painter) override;
+    void frame_sync();
+
+   private:
+    bool initialized = false;
+    NavigationView& nav_;
+
+    Button dummy{
+        {240, 0, 0, 0},
+        ""};
+
+    MessageHandlerRegistration message_handler_sample{
+        Message::ID::DisplayFrameSync,
+        [this](const Message* const) {
+            this->frame_sync();
+        }};
+};
+
+}  // namespace ui::external_app::pacman
+
+#endif /*__UI_PACMAN_H__*/