flipperzero-firmware/firmware/targets/f7/furi_hal/furi_hal_flash.h

81 lines
1.7 KiB
C
Raw Normal View History

#pragma once
#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>
/** Get flash base address
*
* @return pointer to flash base
*/
2021-08-08 18:03:25 +00:00
size_t furi_hal_flash_get_base();
/** Get flash read block size
*
* @return size in bytes
*/
2021-08-08 18:03:25 +00:00
size_t furi_hal_flash_get_read_block_size();
/** Get flash write block size
*
* @return size in bytes
*/
2021-08-08 18:03:25 +00:00
size_t furi_hal_flash_get_write_block_size();
/** Get flash page size
*
* @return size in bytes
*/
2021-08-08 18:03:25 +00:00
size_t furi_hal_flash_get_page_size();
/** Get expected flash cycles count
*
* @return count of erase-write operations
*/
2021-08-08 18:03:25 +00:00
size_t furi_hal_flash_get_cycles_count();
/** Get free flash start address
*
* @return pointer to free region start
*/
2021-08-08 18:03:25 +00:00
const void* furi_hal_flash_get_free_start_address();
/** Get free flash end address
*
* @return pointer to free region end
*/
2021-08-08 18:03:25 +00:00
const void* furi_hal_flash_get_free_end_address();
/** Get first free page start address
*
* @return first free page memory address
*/
2021-08-08 18:03:25 +00:00
size_t furi_hal_flash_get_free_page_start_address();
/** Get free page count
*
* @return free page count
*/
2021-08-08 18:03:25 +00:00
size_t furi_hal_flash_get_free_page_count();
/** Erase Flash
*
* @warning locking operation with critical section, stales execution
*
* @param page The page to erase
*
* @return true on success
*/
bool furi_hal_flash_erase(uint8_t page);
/** Write double word (64 bits)
*
* @warning locking operation with critical section, stales execution
*
* @param address destination address, must be double word aligned.
* @param data data to write
*
* @return true on success
*/
2021-08-08 18:03:25 +00:00
bool furi_hal_flash_write_dword(size_t address, uint64_t data);