Skip to content

flash: add note about program size #5000

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 22, 2017
Merged

flash: add note about program size #5000

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions drivers/FlashIAP.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ class FlashIAP : private NonCopyable<FlashIAP> {

/** Get the program page size
*
* The page size defines the writable page size
* @return Size of a program page in bytes
*/
uint32_t get_page_size() const;
Expand Down
5 changes: 3 additions & 2 deletions hal/flash_api.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,9 @@ int32_t flash_erase_sector(flash_t *obj, uint32_t address);
*/
int32_t flash_read(flash_t *obj, uint32_t address, uint8_t *data, uint32_t size);

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

/** Get page size
*
* The page size defines the writable page size
* @param obj The flash object
* @return The size of a page
*/
Expand Down