bootloader_flash.h

#pragma once
 
/************************************************************************************************
 * @file   bootloader_can_flash.h
 *
 * @brief  Header file for the flash API in the bootloader
 *
 * @date   2025-01-08
 * @author Midnight Sun Team #24 - MSXVI
 ************************************************************************************************/
 
/* Standard library Headers */
#include <stddef.h>
#include <stdint.h>
 
/* Inter-component Headers */
 
/* Intra-component Headers */
#include "bootloader.h"
#include "bootloader_error.h"
 
#define NUM_FLASH_PAGES 128U
 
#define BOOTLOADER_PAGE_BYTES ((size_t)0x800)
 
#define BOOTLOADER_FLASH_WORD_SIZE 4U
 
#define BOOTLOADER_ADDR_TO_PAGE(addr) (((uintptr_t)(addr) - (uintptr_t)APPLICATION_START_ADDRESS) / BOOTLOADER_PAGE_BYTES)
 
#define BOOTLOADER_PAGE_TO_ADDR(page) ((uintptr_t)(page) * (uintptr_t)BOOTLOADER_PAGE_BYTES + (uintptr_t)APPLICATION_START_ADDRESS)
 
BootloaderError boot_flash_write(uintptr_t address, uint8_t *buffer, size_t buffer_len);
 
BootloaderError boot_flash_erase(uint8_t start_page, uint8_t num_pages);
 
BootloaderError boot_flash_read(uintptr_t address, uint8_t *buffer, size_t buffer_len);
 
BootloaderError boot_verify_flash_memory(void);