rboot-api.h
Go to the documentation of this file.
1 #ifndef __RBOOT_API_H__
2 #define __RBOOT_API_H__
3 
15 #include <rboot.h>
16 
17 #ifdef __cplusplus
18 extern "C" {
19 #endif
20 
26 typedef struct {
27  uint32_t start_addr;
28  uint32_t start_sector;
29  //uint32_t max_sector_count;
31  uint8_t extra_count;
32  uint8_t extra_bytes[4];
34 
40 rboot_config ICACHE_FLASH_ATTR rboot_get_config(void);
41 
50 bool ICACHE_FLASH_ATTR rboot_set_config(rboot_config *conf);
51 
58 uint8_t ICACHE_FLASH_ATTR rboot_get_current_rom(void);
59 
66 bool ICACHE_FLASH_ATTR rboot_set_current_rom(uint8_t rom);
67 
75 rboot_write_status ICACHE_FLASH_ATTR rboot_write_init(uint32_t start_addr);
76 
84 bool ICACHE_FLASH_ATTR rboot_write_end(rboot_write_status *status);
85 
96 bool ICACHE_FLASH_ATTR rboot_write_flash(rboot_write_status *status, uint8_t *data, uint16_t len);
97 
98 #ifdef BOOT_RTC_ENABLED
99 
104 bool ICACHE_FLASH_ATTR rboot_get_rtc_data(rboot_rtc_data *rtc);
105 
111 bool ICACHE_FLASH_ATTR rboot_set_rtc_data(rboot_rtc_data *rtc);
112 
121 bool ICACHE_FLASH_ATTR rboot_set_temp_rom(uint8_t rom);
122 
129 bool ICACHE_FLASH_ATTR rboot_get_last_boot_rom(uint8_t *rom);
130 
137 bool ICACHE_FLASH_ATTR rboot_get_last_boot_mode(uint8_t *mode);
138 #endif
139 
140 #ifdef __cplusplus
141 }
142 #endif
143 
145 #endif
int32_t last_sector_erased
Definition: rboot-api.h:30
bool rboot_write_end(rboot_write_status *status)
Complete flash write process.
uint8_t rboot_get_current_rom(void)
Get index of current ROM.
rboot_write_status rboot_write_init(uint32_t start_addr)
Initialise flash write process.
Structure containing rBoot configuration.
Definition: rboot.h:113
bool rboot_write_flash(rboot_write_status *status, uint8_t *data, uint16_t len)
Write data to flash memory.
rboot_config rboot_get_config(void)
Read rBoot configuration from flash.
Structure defining flash write status.
Definition: rboot-api.h:26
uint8_t extra_count
Definition: rboot-api.h:31
uint32_t start_addr
Definition: rboot-api.h:27
bool rboot_set_config(rboot_config *conf)
Write rBoot configuration to flash memory.
uint32_t start_sector
Definition: rboot-api.h:28
bool rboot_set_current_rom(uint8_t rom)
Set the index of current ROM.