RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

flashpage: Make pagewise API optional

Browse Source 
flashpage currently requires pagewise implementation with an optional
extension for per block writes (flashpage_raw). Most implementations
with flashpage_raw implement the pagewise access via the flashpage_raw
functions. This commit makes the flashpage raw the main access method
and adds an extension feature for the pagewise access.

The functions and defines are renamed to reflect this. The API is also
extended with a dedicated function for erasing a sector.
This commit is contained in:
Koen Zandberg 2020-11-09 16:39:11 +01:00
parent 91f1b1c071
commit 41bbaa7442
No known key found for this signature in database
GPG Key ID: 0895A893E6D2985B
4 changed files with 64 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
drivers/include/periph/flashpage.h
View File

@ -64,17 +64,17 @@ extern "C" {
#define CPU_FLASH_BASE (0)
#endif
/**
* @def FLASHPAGE_RAW_BLOCKSIZE
* @def FLASHPAGE_WRITE_BLOCK_SIZE
*
* @brief For raw writings to the flash, this constant must define the
* minimum write length allowed by the MCU.
*/
#ifdef DOXYGEN
#define FLASHPAGE_RAW_BLOCKSIZE
#define FLASHPAGE_WRITE_BLOCK_SIZE
#endif
/**
* @def FLASHPAGE_RAW_ALIGNMENT
* @def FLASHPAGE_WRITE_BLOCK_ALIGNMENT
*
* @brief The buffers to be written to the flash MUST be aligned, as well as
* the address on which the buffer is written to the flash. This variable
@ -82,7 +82,7 @@ extern "C" {
* requirements.
*/
#ifdef DOXYGEN
#define FLASHPAGE_RAW_ALIGNMENT
#define FLASHPAGE_WRITE_BLOCK_ALIGNMENT
#endif
/**
* @def FLASHPAGE_SIZE
@ -114,7 +114,7 @@ enum {
*
* @return starting memory address of the given page
*/
static inline void *flashpage_addr(int page)
static inline void *flashpage_addr(unsigned page)
{
return (void *)(CPU_FLASH_BASE + (page * FLASHPAGE_SIZE));
}
@ -130,11 +130,18 @@ static inline void *flashpage_addr(int page)
*
* @return page containing the given address
*/
static inline int flashpage_page(void *addr)
static inline unsigned flashpage_page(void *addr)
{
return (int)(((int)addr - CPU_FLASH_BASE) / FLASHPAGE_SIZE);
return (((intptr_t)addr - CPU_FLASH_BASE) / FLASHPAGE_SIZE);
}
/**
* @brief Erase the given page
*
* @param[in] page Page to erase
*/
void flashpage_erase(unsigned page);
/**
* @brief Write the given page with the given data
*
@ -142,7 +149,7 @@ static inline int flashpage_page(void *addr)
* @param[in] data data to write to the page, MUST be FLASHPAGE_SIZE
* byte. Set to NULL for page erase only.
*/
void flashpage_write(int page, const void *data);
void flashpage_write_page(unsigned page, const void *data);
/**
* @brief Write any number of data bytes to a given location in the
@ -152,20 +159,20 @@ void flashpage_write(int page, const void *data);
* this function
*
* Both target address and data address must be aligned to
* FLASHPAGE_RAW_ALIGN. @p len must be a multiple of FLASHPAGE_RAW_BLOCKSIZE.
* FLASHPAGE_BLOCK_ALIGN. @p len must be a multiple of FLASHPAGE_WRITE_BLOCK_SIZE.
* This function doesn't erase any area in flash, thus be sure the targeted
* memory area is erased before writing on it (using the flashpage_write function).
*
* @param[in] target_addr address in flash to write to. MUST be aligned
* to FLASHPAGE_RAW_ALIGNMENT.
* to FLASHPAGE_WRITE_BLOCK_ALIGNMENT.
* @param[in] data data to write to the address. MUST be aligned
* to FLASHPAGE_RAW_ALIGNMENT.
* to FLASHPAGE_WRITE_BLOCK_ALIGNMENT.
* @param[in] len length of the data to be written. It MUST be
* multiple of FLASHPAGE_RAW_BLOCKSIZE. Also,
* multiple of FLASHPAGE_WRITE_BLOCK_SIZE. Also,
* ensure it doesn't exceed the actual flash
* memory size.
*/
void flashpage_write_raw(void *target_addr, const void *data, size_t len);
void flashpage_write(void *target_addr, const void *data, size_t len);
/**
* @brief Read the given page into the given memory location
@ -174,7 +181,7 @@ void flashpage_write_raw(void *target_addr, const void *data, size_t len);
* @param[out] data memory to write the page to, MUST be FLASHPAGE_SIZE
* byte
*/
void flashpage_read(int page, void *data);
void flashpage_read(unsigned page, void *data);
/**
* @brief Verify the given page against the given data
@ -186,7 +193,7 @@ void flashpage_read(int page, void *data);
* @return FLASHPAGE_OK if data in the page is identical to @p data
* @return FLASHPAGE_NOMATCH if data and page content diverge
*/
int flashpage_verify(int page, const void *data);
int flashpage_verify(unsigned page, const void *data);
/**
* @brief Write the given page and verify the results
@ -200,7 +207,7 @@ int flashpage_verify(int page, const void *data);
* @return FLASHPAGE_OK on success
* @return FLASHPAGE_NOMATCH if data and page content diverge
*/
int flashpage_write_and_verify(int page, const void *data);
int flashpage_write_and_verify(unsigned page, const void *data);
/**
* @brief Functions to support additional RWWEE flash section
@ -227,7 +234,7 @@ int flashpage_write_and_verify(int page, const void *data);
*
* @return starting memory address of the given RWWEE page
*/
static inline void *flashpage_rwwee_addr(int page)
static inline void *flashpage_rwwee_addr(unsigned page)
{
return (void *)(CPU_FLASH_RWWEE_BASE + (page * FLASHPAGE_SIZE));
}
@ -255,7 +262,7 @@ static inline int flashpage_rwwee_page(void *addr)
* @param[in] data data to write to the RWWEE page, MUST be FLASHPAGE_SIZE
* byte. Set to NULL for RWWEE page erase only.
*/
void flashpage_rwwee_write(int page, const void *data);
void flashpage_rwwee_write_page(unsigned page, const void *data);
/**
* @brief Write any number of data bytes to a given location in the
@ -265,20 +272,20 @@ void flashpage_rwwee_write(int page, const void *data);
* this function
*
* Both target address and data address must be aligned to
* FLASHPAGE_RAW_ALIGN. @p len must be a multiple of FLASHPAGE_RAW_BLOCKSIZE.
* FLASHPAGE_BLOCK_ALIGN. @p len must be a multiple of FLASHPAGE_WRITE_BLOCK_SIZE.
* This function doesn't erase any area in flash, thus be sure the targeted
* memory area is erased before writing on it (using the flashpage_write function).
*
* @param[in] target_addr RWWEE address in flash to write to. MUST be aligned
* to FLASHPAGE_RAW_ALIGNMENT.
* to FLASHPAGE_WRITE_BLOCK_ALIGNMENT.
* @param[in] data data to write to the address. MUST be aligned
* to FLASHPAGE_RAW_ALIGNMENT.
* to FLASHPAGE_WRITE_BLOCK_ALIGNMENT.
* @param[in] len length of the data to be written. It MUST be
* multiple of FLASHPAGE_RAW_BLOCKSIZE. Also,
* multiple of FLASHPAGE_WRITE_BLOCK_SIZE. Also,
* ensure it doesn't exceed the actual RWWEE flash
* memory size.
*/
void flashpage_rwwee_write_raw(void *target_addr, const void *data, size_t len);
void flashpage_rwwee_write(void *target_addr, const void *data, size_t len);
/**
* @brief Read the given RWWEE page into the given memory location
@ -287,7 +294,7 @@ void flashpage_rwwee_write_raw(void *target_addr, const void *data, size_t len);
* @param[out] data memory to write the RWWEE page to, MUST be FLASHPAGE_SIZE
* byte
*/
void flashpage_rwwee_read(int page, void *data);
void flashpage_rwwee_read(unsigned page, void *data);
/**
* @brief Verify the given RWWEE page against the given data
@ -299,7 +306,7 @@ void flashpage_rwwee_read(int page, void *data);
* @return FLASHPAGE_OK if data in the RWWEE page is identical to @p data
* @return FLASHPAGE_NOMATCH if data and RWWEE page content diverge
*/
int flashpage_rwwee_verify(int page, const void *data);
int flashpage_rwwee_verify(unsigned page, const void *data);
/**
* @brief Write the given RWWEE page and verify the results
@ -314,7 +321,7 @@ int flashpage_rwwee_verify(int page, const void *data);
* @return FLASHPAGE_OK on success
* @return FLASHPAGE_NOMATCH if data and RWWEE page content diverge
*/
int flashpage_rwwee_write_and_verify(int page, const void *data);
int flashpage_rwwee_write_and_verify(unsigned page, const void *data);
#endif /* FLASHPAGE_RWWEE_NUMOF */

12
drivers/periph_common/Kconfig.flashpage
View File

@ -19,15 +19,15 @@ config MODULE_PERIPH_INIT_FLASHPAGE
default y if MODULE_PERIPH_INIT
depends on MODULE_PERIPH_FLASHPAGE
config MODULE_PERIPH_FLASHPAGE_RAW
bool "Raw writing support"
depends on HAS_PERIPH_FLASHPAGE_RAW
config MODULE_PERIPH_FLASHPAGE_PAGEWISE
bool "Pagewise writing support"
depends on HAS_PERIPH_FLASHPAGE_PAGEWISE
depends on MODULE_PERIPH_FLASHPAGE
config MODULE_PERIPH_INIT_FLASHPAGE_RAW
bool "Auto initialize Flashpage raw"
config MODULE_PERIPH_INIT_FLASHPAGE_PAGEWISE
bool "Auto initialize Flashpage pagewise"
default y if MODULE_PERIPH_INIT
depends on MODULE_PERIPH_FLASHPAGE_RAW
depends on MODULE_PERIPH_FLASHPAGE_PAGEWISE
config MODULE_PERIPH_FLASHPAGE_RWEE
bool "Read while Write support"

33
drivers/periph_common/flashpage.c
View File

@ -28,18 +28,19 @@
#include "periph/flashpage.h"
void flashpage_read(int page, void *data)
#ifdef MODULE_PERIPH_FLASHPAGE_PAGEWISE
void flashpage_read(unsigned page, void *data)
{
assert(page < (int)FLASHPAGE_NUMOF);
assert(page < FLASHPAGE_NUMOF);
#if defined(CPU_FAM_STM32WB)
assert(page < (int)(FLASH->SFR & FLASH_SFR_SFSA));
assert(page < (FLASH->SFR & FLASH_SFR_SFSA));
#endif
memcpy(data, flashpage_addr(page), FLASHPAGE_SIZE);
}
int flashpage_verify(int page, const void *data)
int flashpage_verify(unsigned page, const void *data)
{
assert(page < (int)FLASHPAGE_NUMOF);
@ -55,23 +56,35 @@ int flashpage_verify(int page, const void *data)
}
}
int flashpage_write_and_verify(int page, const void *data)
int flashpage_write_and_verify(unsigned page, const void *data)
{
flashpage_write(page, data);
flashpage_write_page(page, data);
return flashpage_verify(page, data);
}
void flashpage_write_page(unsigned page, const void *data)
{
assert((unsigned) page < FLASHPAGE_NUMOF);
flashpage_erase(page);
/* write page */
if (data != NULL) {
flashpage_write(flashpage_addr(page), data, FLASHPAGE_SIZE);
}
}
#endif /* MODULE_PERIPH_FLASHPAGE_PAGEWISE */
#if defined(FLASHPAGE_RWWEE_NUMOF)
void flashpage_rwwee_read(int page, void *data)
void flashpage_rwwee_read(unsigned page, void *data)
{
assert(page < (int)FLASHPAGE_RWWEE_NUMOF);
memcpy(data, flashpage_rwwee_addr(page), FLASHPAGE_SIZE);
}
int flashpage_rwwee_verify(int page, const void *data)
int flashpage_rwwee_verify(unsigned page, const void *data)
{
assert(page < (int)FLASHPAGE_RWWEE_NUMOF);
@ -83,9 +96,9 @@ int flashpage_rwwee_verify(int page, const void *data)
}
}
int flashpage_rwwee_write_and_verify(int page, const void *data)
int flashpage_rwwee_write_and_verify(unsigned page, const void *data)
{
flashpage_rwwee_write(page, data);
flashpage_rwwee_write_page(page, data);
return flashpage_rwwee_verify(page, data);
}

4
kconfigs/Kconfig.features
View File

@ -124,10 +124,10 @@ config HAS_PERIPH_FLASHPAGE
help
Indicates that a Flashpage peripheral is present.
config HAS_PERIPH_FLASHPAGE_RAW
config HAS_PERIPH_FLASHPAGE_PAGEWISE
bool
help
Indicates that the Flashpage peripheral supports raw writing.
Indicates that the Flashpage peripheral supports pagewise writing.
config HAS_PERIPH_FLASHPAGE_RWEE
bool