Skip to content

Commit 6cc52dc

Browse files
authored
Added more warnings about FlashIAP
1 parent 90e82da commit 6cc52dc

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,13 @@
22
Block device driver using the mbed OS FlashIAP API.
33

44
# Warning
5+
This driver is **EXPERIMENTAL** and improper usage could kill your board's flash.
6+
57
This driver should only be used on platforms where the FlashIAP implementation is using external flash or in conjunction with a filesystem with wear leveling, that can operate on a page size granularity.
68

7-
The BlockDevice API assumes a uniform erase size so the underlying flash must also have uniform sectors.
9+
Additional concerns:
10+
- The BlockDevice API assumes a uniform erase size so the underlying flash must also have uniform sectors.
11+
- The FlashIAP may freeze code execution for a long period of time while writing to flash. Not even high-priority irqs will be allowed to run, which may interrupt background processes.
812

913
# Tested on
1014

0 commit comments

Comments
 (0)