Skip to content

Commit 38be332

Browse files
Fix comment
1 parent f351743 commit 38be332

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

storage/blockdevice/include/blockdevice/BufferedBlockDevice.h

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,15 @@ namespace mbed {
2626
/** \addtogroup storage-blockdevice */
2727
/** @{*/
2828

29-
/** Block device for allowing minimal read and program sizes (of 1) for the underlying BD,
30-
* using a buffer on the heap.
29+
/**
30+
* Block device which allows minimal read and program sizes (of 1) for the underlying BD
31+
* using a buffer on the heap. This essentially "simulates" a byte-programmable device
32+
* like a NOR flash or an EEPROM, using a non-byte-programmable device like an SD card or
33+
* NAND flash.
34+
*
35+
* @note While the read and write size of the buffered block device will always be 1,
36+
* the erase size is the same as the underlying block device. In other words, you
37+
* still must erase in the hardware erase sector size.
3138
*/
3239
class BufferedBlockDevice : public BlockDevice {
3340
public:

0 commit comments

Comments
 (0)