Skip to content

Commit 3f58d3e

Browse files
committed
flash: add note about program size
Program size - the writable page size that flash controller supports. Plus fix program page description - multiple pages program
1 parent 4978a08 commit 3f58d3e

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

drivers/FlashIAP.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ class FlashIAP : private NonCopyable<FlashIAP> {
112112

113113
/** Get the program page size
114114
*
115+
* The page size defines the writable page size
115116
* @return Size of a program page in bytes
116117
*/
117118
uint32_t get_page_size() const;

hal/flash_api.h

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,9 @@ int32_t flash_erase_sector(flash_t *obj, uint32_t address);
7575
*/
7676
int32_t flash_read(flash_t *obj, uint32_t address, uint8_t *data, uint32_t size);
7777

78-
/** Program one page starting at defined address
78+
/** Program pages starting at defined address
7979
*
80-
* The page should be at page boundary, should not cross multiple sectors.
80+
* The pages should not cross multiple sectors.
8181
* This function does not do any check for address alignments or if size is aligned to a page size.
8282
* @param obj The flash object
8383
* @param address The sector starting address
@@ -97,6 +97,7 @@ uint32_t flash_get_sector_size(const flash_t *obj, uint32_t address);
9797

9898
/** Get page size
9999
*
100+
* The page size defines the writable page size
100101
* @param obj The flash object
101102
* @return The size of a page
102103
*/

0 commit comments

Comments
 (0)