user_app_exe.h

#ifndef USER_APP_EXE_H
#define USER_APP_EXE_H
 
/* these are functions that help the firmware to decide wether or not
 * to execute user code and locate it if applicable
 * these are not relevant for the user code itself
 */
 
#include "main-header.h"
#include "user_app_info.h"
 
struct userapp_info *get_user_app();
// return >0 if a user_app is installed, compatible and should be executed
int user_app_executable();
void user_app_enable();
void user_app_disable();
int user_app_is_enabled();
int user_app_is_valid();
int user_app_checksum_valid();
void user_app_reset_state();
void user_app_control(struct command *com);
int user_app_info(struct command *com);
// send a packet to the server describing current status of userapp
int send_user_app_status();
 
// these are the actual user hooks.
 
int invoke_on_command_received(struct command *com);
void invoke_start(int MCULIBHANDLE);
void invoke_stop();
void invoke_on_new_node(struct hostroute *host);
void invoke_user_loop();
void user_app_exe_init();
// check if the userapp at baseadr x is valid
int userapp_checksum_valid(void *baseadr);
 
// called by irq handlers and loop entry/exit, so faults can be allocated to userapp if they happen
void set_in_app(uint8_t a);
 
// callback for serialports (in case user wants to get IRQ for chars from serialport)
// returns 0 if no callback handler set, otherwise >0
int user_serial_callback(int portnum, int byte);
#endif