flash.h

#pragma once
 
/************************************************************************************************
 * @file   flash.h
 *
 * @brief  Flash Library Header file
 *
 * @date   2024-11-05
 * @author Midnight Sun Team #24 - MSXVI
 ************************************************************************************************/
 
/* Standard library Headers */
#include <stddef.h>
#include <stdint.h>
 
/* Inter-component Headers */
 
/* Intra-component Headers */
#include "status.h"
 
#define FLASH_MEMORY_ALIGNMENT 4U
 
#define FLASH_BASE_ADDR (0x08000000U)
 
#ifndef FLASH_PAGE_SIZE
#define FLASH_PAGE_SIZE 0x800U
#endif
 
#define FLASH_PAGE_TO_ADDR(page) (FLASH_BASE_ADDR + ((page) * FLASH_PAGE_SIZE))
 
#define FLASH_ADDR_TO_PAGE(addr) (((addr) - FLASH_BASE_ADDR) / FLASH_PAGE_SIZE)
 
#define FLASH_TIMEOUT_MS 100U
 
#define NUM_FLASH_PAGES 128U
 
StatusCode flash_init();
 
StatusCode flash_read(uintptr_t address, uint8_t *buffer, size_t buffer_len);
 
StatusCode flash_write(uintptr_t address, uint8_t *buffer, size_t buffer_len);
 
StatusCode flash_erase(uint8_t start_page, uint8_t num_pages);