ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #5000 from 0xc0170/fix_flash_page_doc 

flash: add note about program size
pull/5174/merge
Martin Kojtal 2017-09-22 11:28:54 +01:00 committed by GitHub
parent bfc1c5aa39 3f58d3ef48
commit 26f9144c45
2 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
drivers/FlashIAP.h
View File

@ -112,6 +112,7 @@ public:
/** Get the program page size /** Get the program page size
* *
* The page size defines the writable page size
* @return Size of a program page in bytes * @return Size of a program page in bytes
*/ */
uint32_t get_page_size() const; uint32_t get_page_size() const;

5
hal/flash_api.h
View File

@ -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); 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. * 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 obj The flash object
* @param address The sector starting address * @param address The sector starting address
@ -97,6 +97,7 @@ uint32_t flash_get_sector_size(const flash_t *obj, uint32_t address);
/** Get page size /** Get page size
* *
* The page size defines the writable page size
* @param obj The flash object * @param obj The flash object
* @return The size of a page * @return The size of a page
*/ */