portapack-mayhem/firmware/common/standalone_app.hpp

/*
 * Copyright (C) 2024 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_STANDALONE_APP_H__
#define __UI_STANDALONE_APP_H__

#include <cerrno>
#include <cstdint>
#include <stddef.h>

#include "ui.hpp"

#define CURRENT_STANDALONE_APPLICATION_API_VERSION 2

struct standalone_application_api_t {
    // Version 1
    void* (*malloc)(size_t size);
    void* (*calloc)(size_t num, size_t size);
    void* (*realloc)(void* p, size_t size);
    void (*free)(void* p);
    void (*create_thread)(int32_t (*fn)(void*), void* arg, size_t stack_size, int priority);
    void (*fill_rectangle)(int x, int y, int width, int height, uint16_t color);
    uint8_t (*swizzled_switches)();
    uint64_t (*get_switches_state)();

    // Version 2
    const uint8_t* fixed_5x8_glyph_data;
    const uint8_t* fixed_8x16_glyph_data;

    void (*fill_rectangle_unrolled8)(int x, int y, int width, int height, uint16_t color);
    void (*draw_bitmap)(int x, int y, int width, int height, const uint8_t* pixels, uint16_t foreground, uint16_t background);

    ui::Coord (*scroll_area_y)(const ui::Coord y);
    void (*scroll_set_area)(const ui::Coord top_y, const ui::Coord bottom_y);
    void (*scroll_disable)();
    ui::Coord (*scroll_set_position)(const ui::Coord position);
    ui::Coord (*scroll)(const int32_t delta);

    bool (*i2c_read)(uint8_t* cmd, size_t cmd_len, uint8_t* data, size_t data_len);
    void (*panic)(const char* msg);
    void (*set_dirty)();

    // TODO: add filesystem access functions
    // TODO: add baseband access functions

    // HOW TO extend this interface:
    // to keep everything backward compatible: add new fields at the end
    // and increment CURRENT_STANDALONE_APPLICATION_API_VERSION
};

enum app_location_t : uint32_t {
    UTILITIES = 0,
    RX,
    TX,
    DEBUG,
    HOME
};

struct standalone_application_information_t {
    uint32_t header_version;

    uint8_t app_name[16];
    uint8_t bitmap_data[32];
    uint32_t icon_color;
    app_location_t menu_location;

    /// @brief gets called once at application start
    void (*initialize)(const standalone_application_api_t& api);

    /// @brief gets called when an event occurs
    /// @param events bitfield of events
    /// @note events are defined in firmware/application/event_m0.hpp
    void (*on_event)(const uint32_t& events);

    /// @brief gets called once at application shutdown
    void (*shutdown)();

    void (*PaintViewMirror)();
    void (*OnTouchEvent)(int x, int y, uint32_t type);
    void (*OnFocus)();
    bool (*OnKeyEvent)(uint8_t key);
    bool (*OnEncoder)(int32_t delta);
    bool (*OnKeyboard)(uint8_t key);
};

#endif /*__UI_STANDALONE_APP_H__*/