bootloader_hal.h

Go to the documentation of this file.

 
#ifndef _INCLUDE_FREERTOS_BOOTLOADER_HAL_H_
#define _INCLUDE_FREERTOS_BOOTLOADER_HAL_H_
 
#include <stdint.h>
#include "can_frame.h"
 
 
#ifdef __cplusplus
extern "C" {
#else
typedef unsigned bool;
#endif
 
#define CHECKSUM_COUNT 4
 
struct app_header {
    uint32_t app_size;
    uint32_t checksum_pre[CHECKSUM_COUNT];
    uint32_t checksum_post[CHECKSUM_COUNT];
};
 
enum BootloaderLed {
  /* 1 when there is an incoming packet pending, an outgoing packet pending or
     datagram being transmitted or deceived. */
  LED_ACTIVE = 1,
  /* 1 for the duration of erase and write operations. */
  LED_WRITING = 2,
  /* Not used currently. */
  LED_IDENT = 4,
  /* 1 if the applicaiton checksum failed. */
  LED_CSUM_ERROR = 8,
  /* 1 if the end-user requested entry to the bootloader. */
  LED_REQUEST = 16,
  /* 1 if a buffer overrun occurred. */
  LED_FRAME_LOST = 32,
};
 
static const uint32_t REQUEST_BOOTLOADER = 0x76b89b1eU;
extern uint32_t __bootloader_magic_ptr;
 
extern void bootloader_hw_set_to_safe(void);
 
extern void bootloader_hw_init(void);
 
extern bool request_bootloader(void);
 
extern void application_entry(void);
 
extern void bootloader_reboot(void);
 
extern void bootloader_led(enum BootloaderLed led, bool value);
 
extern bool read_can_frame(struct can_frame *frame);
 
#ifdef __cplusplus
 
extern bool try_send_can_frame(const struct can_frame &frame);
 
#endif
 
extern void get_flash_boundaries(const void **flash_min, const void **flash_max,
    const struct app_header **app_header);
 
extern void get_flash_page_info(
    const void *address, const void **page_start, uint32_t *page_length_bytes);
 
extern void erase_flash_page(const void *address);
 
extern void raw_erase_flash_page(const void *address);
 
extern void write_flash(
    const void *address, const void *data, uint32_t size_bytes);
 
extern void raw_write_flash(
    const void *address, const void *data, uint32_t size_bytes);
 
extern uint16_t flash_complete(void);
 
extern void checksum_data(const void* data, uint32_t size, uint32_t* checksum);
 
extern uint16_t nmranet_alias(void);
 
extern uint64_t nmranet_nodeid(void);
 
#ifdef __cplusplus
}
#endif
 
#endif // _INCLUDE_FREERTOS_BOOTLOADER_HAL_H_