mirror of
https://github.com/eried/portapack-mayhem.git
synced 2024-12-14 10:14:28 -05:00
100bea644c
This pull requests adds a new type of external app to the firmware: The standalone app. Pros: Will work after an upgrade. Size of image is only limited by shared heap size of M0 (application) (64kb total). Cons: No full access to all functions in the main firmware. One well defined (and versioned) API handles all communication. The Pacman app was converted to be the first the the new kind.
75 lines
2.3 KiB
C++
75 lines
2.3 KiB
C++
/*
|
|
* 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>
|
|
|
|
#define CURRENT_STANDALONE_APPLICATION_API_VERSION 1
|
|
|
|
struct standalone_application_api_t {
|
|
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)();
|
|
|
|
// 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)();
|
|
};
|
|
|
|
#endif /*__UI_STANDALONE_APP_H__*/
|