flash.h

Go to the documentation of this file.

/* Copyright (c) 2026 Zane A. Maples
   Licensed under the MIT license. See LICENSE in the main repository for more information. */
#ifndef W_HAL_FLASH_H
#define W_HAL_FLASH_H
 
/* "Hello fbom flach memobi!" */

#include "shared.h"
 
/* Some extremely important info to anyone that decides they want to edit this:
   Before ANY flash operation (erase or program) interrupts MUST be saved and the other core MUST not be using ANY flash
   operations! If they are we could have serious errors in reading and writing flash putting the device in an 
   UNRECOVERABLE state as instructions are also read from flash.
 
   All of the functions below are setup to be *safe* to use! If you are to access flash AT ALL for WHATEVER REASON please
   use the functions below! (or you better know what you're doing!)  
   
   Also please minimize the WRITES to the flash device as much as possible, as there is a limited amount of lifetime to
   these chips. Any use of flash should be used primarily as a way to store often non-changing system information
   (ie. configuration) that also does not need to be secure. For secure data storage or one-time-use keys, please see the
   Raspberry Pi RP2350 datasheet for more info on OTP and flash encryption! 
 */
 
/* Note: FLASH_PAGE_SIZE & FLASH_SECTOR_SIZE are macros provided by pico-sdk. When switching boards they will need to be re-defined with a wrapper */
 
#ifdef W_HAL_RP2350
/* I can't be bothered to define these myself so we just gonna include the mf */
#include <hardware/flash.h>
#define WHISKERS_FLASH_SIZE PICO_FLASH_SIZE_BYTES 
#else
#define WHISKERS_FLASH_SIZE 0
#define FLASH_PAGE_SIZE 0
#define FLASH_SECTOR_SIZE 0
#endif



 
/* Basic helper functions */
/* Note: all page/sector indexing goes reverse from the bottom of the flash memory stack! */
HAL_ERROR read_page(uint32_t page, char buf[FLASH_PAGE_SIZE]);
HAL_ERROR read_sector(uint32_t sector, char buf[FLASH_SECTOR_SIZE]);
HAL_ERROR check_memory_integrity_sector(uint32_t sector, char checkagainst[FLASH_SECTOR_SIZE]);
HAL_ERROR check_memory_integrity_page(uint32_t page, char checkagainst[FLASH_PAGE_SIZE]);
HAL_ERROR write_page(uint32_t page, char buf[FLASH_PAGE_SIZE]);
HAL_ERROR write_sector(uint32_t sector, char buf[FLASH_SECTOR_SIZE]);
HAL_ERROR erase_page(uint32_t page);
HAL_ERROR erase_sector(uint32_t sector);
#endif