user_app_info.h

Go to the documentation of this file.

#ifndef USER_APP_INFO_H
#define USER_APP_INFO_H
#include "command.h"
#include "routing.h"
#include "stdarg.h"
#include "sctime.h"
#include "sensors/sensor_dev.h"
#define __need_size_t 1
#include <stddef.h>
 
typedef int MCULIB_HANDLE;
typedef void (*pin_irq_callback)(int pin);
typedef void (*irq_callback)(void);
typedef void (*serial_recv_callback)(int port, uint8_t b);
typedef void (*cpkt_callback)(struct command *com, struct command *reply);
typedef struct sc_firmware_api {
  int version;
  void (*debugf)(const char *format, ...);
  void (*printf)(const char *format, ...);
  int (*mculib_serialport_enable)(MCULIB_HANDLE handle, int portnum, int baudrate);
  int (*mculib_serialport_disable)(MCULIB_HANDLE handle, int portnum);
  int (*user_serialport_callback)(MCULIB_HANDLE handle,int portnum, serial_recv_callback cb);
  int (*mculib_serialport_write_char)(MCULIB_HANDLE handle, int portnum, uint8_t b);
  int (*mculib_pin_out)(MCULIB_HANDLE handle, int pinnum, int speed);
  int (*mculib_pin_out_opendrain)(MCULIB_HANDLE handle, int pinnum, int speed);
  int (*mculib_pin_in)(MCULIB_HANDLE handle, int pinnum, int speed, int mode);
  int (*mculib_pin_in_callback)(MCULIB_HANDLE handle, pin_irq_callback pic);
  int (*mculib_pin_set)(MCULIB_HANDLE handle, int pinnum, int highlow);
  int (*mculib_pin_release)(MCULIB_HANDLE handle, int pinnum);
  int (*mculib_pin_get)(MCULIB_HANDLE handle, int pinnum);
  int (*mculib_serialport_write_string)(MCULIB_HANDLE handle, int port, const char *txt);
  uint8_t (*mculib_has_time_passed)(int secs_to_wait, long *ctr);
  long (*mculib_get_seconds_since_boot)(void);
  int (*mculib_spi_disable)(MCULIB_HANDLE handle, int portnum);
  int (*mculib_spi_speed)(MCULIB_HANDLE handle, int portnum, long khz);
  int (*mculib_spi_master_enable3)(MCULIB_HANDLE handle, int portnum, uint8_t wide, uint8_t clkpol, uint8_t cpha, uint8_t dir,uint32_t baud_in_khz);
  int (*mculib_spi_write_and_read)(MCULIB_HANDLE handle, int portnum, const uint16_t write, uint16_t *read);
  int (*mculib_spi_write_only)(MCULIB_HANDLE handle, int portnum, const uint16_t write);
  int (*mculib_spi_read16_only)(MCULIB_HANDLE handle, int portnum, uint16_t *read);
/***************
 * timers
 */
  int (*mculib_timer_enable_simple)(MCULIB_HANDLE handle, int timer, int freq, irq_callback callback);
  int (*mculib_timer_disable)(MCULIB_HANDLE handle, int timer);
  int (*mculib_timer_attach_pin_pwm)(MCULIB_HANDLE handle, int timer, int pin);
  int (*mculib_timer_set_pwm)(MCULIB_HANDLE handle, int timer, int pin, uint16_t dutycycle);
 
/******************
 * ADC
 */
  int (*mculib_adc_read_once)(MCULIB_HANDLE handle, int pin, int *result);
  int (*mculib_adc_get_resolution)(MCULIB_HANDLE handle, int pin);
  int (*mculib_adc_enable)(MCULIB_HANDLE handle, int pin);
  int (*mculib_adc_read)(MCULIB_HANDLE handle, int pin, int *result);
  /***********************
   * command handler
   **********************/
  const char *(*com_get_named_arg)(struct command *com, const char *name) ;
  const char *(*com_get_arg)(const struct command *com, int index) ;
  int (* com_get_arg_size)(const struct command *com, int index) ;
  void (*com_add_arg)(struct command *com, const char *format, ...) ;
  void (*com_add_varg)(struct command *com, const char *format, va_list args) ;
  struct command * (*com_alloc)() ;
  struct command *(*com_get_data_reply)(struct command *com) ;
  int (*com_send_reply_with_args)(struct command *com, uint8_t flags, const char *format, ...) ;
  int (*com_deliver_command)(struct command *com, cpkt_callback);
 
  /*********************************
   * sensor stuff
   *********************************/
  int (*sensor_register)(struct sensordev *sensor);
  /*********************************
   * helper stuff
   *********************************/
  int (*snprintf)(char *buf, size_t size, const char *format, ...) ;
  int (*vsnprintf)(char *buf, size_t size, const char *format, va_list args) ;
  char *(* strncpy)(char *dst, const char *src, size_t size) ;
  size_t (*strlen)(const char *txt);
  void *(*memset)(void *buf, int c, size_t n) ;
  int (*strcmp)(const char *c1, const char *c2) ;
  int (* atoi)(const char *s);
  /*********************************
   * led
   *********************************/
  void (*led_blink) (int colour, int brightness, int on, int off);
  /*********************************
   * flags
   *********************************/
  int (*get_config_flag) (int flag);
  int (*com_send_command)(struct command *com);
 
  /*********************************
   * more spi
   *********************************/
  int (*mculib_spi_send_dma)(MCULIB_HANDLE handle, int portno,void *data, uint32_t size,uint32_t flags);
  /*********************************
   * more helpers
   *********************************/
  int (*com_get_named_arg_uint32)(struct command *com, const char *name, uint32_t *result ) ;
  int (*com_get_named_arg_uint16)(struct command *com, const char *name, uint16_t *result ) ;
  /*********************************
   * userconfig
   *********************************/
  uint32_t (*userconfig_size)();
  uint32_t (*userconfig_version)();
  int (*userconfig_copy)(uint8_t *buf,uint16_t bufsize,uint16_t *actual_size);
  int (* userconfig_write)(uint8_t *buf, uint32_t size);
  void (*com_free)(struct command *com);
  struct sensorruntime *(*sensor_get_runtime_by_index)(int idx);
  int (*proto_buf_to_struct)(void *buf, int bufsize, void *iter, void *out) ;
  int (*proto_struct_to_buf)(void *buf, int bufsize, void *iter, void *in) ;
  void (*proto_release)(void *buf);
  void (*pin_pwm)(int MCULIBHANDLE,int pin, uint32_t newstate, int flags);
  int  (*time_get_localtime_as_struct)(struct sctime *time);
  int (*timer_softirq)(uint32_t hertz,uint32_t opaque, void (*callback)(uint32_t));
  int (*time_get_diff)(struct sctime *time1,struct sctime *time2);
  void (*time_bcd_to_timestruct)(uint32_t bcd_time,uint32_t bcd_date,struct sctime *out);
 
  int (*com_add_binary_arg)(struct command *com, const int len, const uint8_t *buf);
 
  /********************************* powersave stuff ***************/
  int (*mcu_set_speed)(int MCULIBHANDLE, int speed);
 
  int (*hijack_usb_acm)(void (*receive_hook)(uint8_t *received, int size));
  int (*send_via_usb_acm)(uint8_t *buf, int size);
  int (*hijack_esp32_usart)(void (*receive_hook)(uint8_t received));
  void (*reset_module)(void);
  void (*reset_userapp)(void);
  void (*hijack_esp32_usart_stop)(void);
 
  /********************************* add calls above here ***************/
 
  
  int (*unhandled_call1)();
  int (*unhandled_call2)();
  int (*unhandled_call3)();
  int (*unhandled_call4)();
  int (*unhandled_call5)();
  int (*unhandled_call6)();
  int (*unhandled_call7)();
  int (*unhandled_call8)();
} _sc_firmware_api;
 
 
/**********************************************************************************/
 
 
typedef struct userapp_info {
  /* \brief must contain "SCUA" (0x53435541) for the firmware to recognize this as valid userapp */
  uint32_t magic; 
  /* \brief length of binary code. usually fuild in during build */
  uint32_t length;
  /* \brief checksum of binary code. usually fuild in during build */
  uint32_t checksum;
  /* \brief version of binary code. usually fuild in during build */
  uint32_t version;
  /* \brief used by the firmeware to determine what capabilities this userapp has */
  uint32_t api_version;
  uint32_t pad2;
  /* \brief pointer to address at which userapp code must be loaded */
  void *base;
  /* \brief build_timestamp, usually patched in during build */
  uint32_t build_timestamp;
  /* \brief git repositoryid, usually patched in during build */
  uint32_t repoid;    
  int (*start)(int MCULIBHANDLE, struct sc_firmware_api *api);
  void (*stop)();
  void (*user_loop)();
 
  int (*on_command_received)(struct command *com);
  void (*on_new_node)(struct hostroute *host);
  void *end_marker;
} _userapp_info_t;
 
 
#endif