MAX3267X LittleFS demo
flash.h File Reference

Flash read/write/erase functions declaration. More...

#include <stdint.h>
#include <stdbool.h>
#include "littlefs/lfs.h"

Go to the source code of this file.

Macros

#define LOGF(...)
 

Functions

int flash_read (const struct lfs_config *c, lfs_block_t block, lfs_off_t off, void *buffer, lfs_size_t size)
 Reads flash memory. More...
 
int flash_write (const struct lfs_config *c, lfs_block_t block, lfs_off_t off, const void *buffer, lfs_size_t size)
 Writes flash memory. More...
 
int flash_erase (const struct lfs_config *c, lfs_block_t block)
 Erases flash memory block. More...
 
int flash_sync (const struct lfs_config *c)
 Performs pending flash operations. More...
 
int flash_verify (uint32_t address, uint32_t length, uint8_t *data)
 Verifies data in flash. More...
 
int check_mem (uint32_t startaddr, uint32_t length, uint32_t data)
 Compares data in flash with value specified. More...
 
int check_erased (uint32_t startaddr, uint32_t length)
 Checks whether flash memory is erased. More...
 
int flash_write4 (uint32_t startaddr, uint32_t length, uint32_t *data, bool verify)
 Writes 32bit data words to flash. More...
 

Detailed Description

Flash read/write/erase functions declaration.

Macro Definition Documentation

◆ LOGF

#define LOGF (   ...)

Function Documentation

◆ check_erased()

int check_erased ( uint32_t  startaddr,
uint32_t  length 
)

Checks whether flash memory is erased.

Parameters
startaddrFlash memory address
lengthMemory block size
Returns
Error code

◆ check_mem()

int check_mem ( uint32_t  startaddr,
uint32_t  length,
uint32_t  data 
)

Compares data in flash with value specified.

Parameters
startaddrFlash memory address
lengthData size
dataThe value to compare to
Returns
Error code

◆ flash_erase()

int flash_erase ( const struct lfs_config c,
lfs_block_t  block 
)

Erases flash memory block.

Note
LittleFS callback method
Parameters
cLittleFS config
blockFlash memory block number
Returns
Error code

◆ flash_read()

int flash_read ( const struct lfs_config c,
lfs_block_t  block,
lfs_off_t  off,
void *  buffer,
lfs_size_t  size 
)

Reads flash memory.

Note
LittleFS callback method
Parameters
cLittleFS config
blockFlash memory block number
offData offset in the block
bufferData buffer
sizeData size
Returns
Error code

◆ flash_sync()

int flash_sync ( const struct lfs_config c)

Performs pending flash operations.

Note
LittleFS callback method. Not supported by Maxim SDK
Parameters
cLittleFS config
Returns
Error code

◆ flash_verify()

int flash_verify ( uint32_t  address,
uint32_t  length,
uint8_t *  data 
)

Verifies data in flash.

Parameters
addressFlash memory address
lengthData size
dataData buffer
Returns
Error code

◆ flash_write()

int flash_write ( const struct lfs_config c,
lfs_block_t  block,
lfs_off_t  off,
const void *  buffer,
lfs_size_t  size 
)

Writes flash memory.

Note
LittleFS callback method
Parameters
cLittleFS config
blockFlash memory block number
offData offset in the block
bufferData buffer
sizeData size
Returns
Error code

◆ flash_write4()

int flash_write4 ( uint32_t  startaddr,
uint32_t  length,
uint32_t *  data,
bool  verify 
)

Writes 32bit data words to flash.

Parameters
startaddrFlash memory address
lengthData size
dataData buffer
verifyWhether to verify written data
Returns
Error code