@@ -12,7 +12,7 @@ chips including those with 24-bit addressing. He tested an XPX XT25F32B; I
1212tested Winbond W25Q32JV 4MiB and Cypress S25FL064L 8MiB devices.
1313
1414It is likely that other chips with 4096 byte blocks will work but I am unlikely
15- to be able to support hardware I don't possess. See
15+ to be able to support hardware I don't possess. See
1616[ Section 6] ( ./FLASH.md#6-unsupported-chips ) for recommendations on settings.
1717
1818## 1.2 The driver
@@ -36,7 +36,7 @@ capacity of flash chips.
3636FAT and littlefs filesystems are supported but the latter is preferred owing to
3737its resilience and wear levelling characteristics. Please note that this driver
3838has been tested on LFS2 only. Users requiring a driver with minimum RAM use
39- may want to consider [ this driver] ( https://github.com/robert-hh/SPI_Flash ) .
39+ may want to consider [ this driver] ( https://github.com/robert-hh/SPI_Flash ) .
4040This supports an LFS1 filesystem on a single flash chip.
4141
4242Arguably byte level access on such large devices has few use cases other than
@@ -161,7 +161,7 @@ Arguments. In most cases only the first two mandatory args are required:
161161 6 . ` block_size=9 ` The block size reported to the filesystem. The size in bytes
162162 is ` 2**block_size ` so is 512 bytes by default.
163163 7 . ` cmd5=None ` Flash chips can support two low level command sets, a 4 byte
164- set and a 5 byte set. By default if the size read from the chip's ID is
164+ set and a 5 byte set. By default if the size read from the chip's ID is
165165 <= 4096KiB the 4 byte set is used oterwise the 5 byte set is adopted. This
166166 works for supported chips. Setting ` cmd5 ` ` True ` forces 5 byte commands,
167167 ` False ` forces 4 byte. This override is necessary for certain chip types
@@ -271,6 +271,9 @@ These are provided by the base class. For the protocol definition see
271271[ the pyb documentation] ( http://docs.micropython.org/en/latest/library/uos.html#uos.AbstractBlockDev )
272272also [ here] ( http://docs.micropython.org/en/latest/reference/filesystem.html#custom-block-devices ) .
273273
274+ These methods exist purely to support the block protocol. They are undocumented:
275+ their use in application code is not recommended.
276+
274277` readblocks() `
275278` writeblocks() `
276279` ioctl() `
@@ -349,7 +352,7 @@ This driver buffers one sector (4KiB) in RAM. This is necessary to support
349352access as a byte array. I believed the buffer would confer an advantage when
350353running a filesystem, but testing suggests that performance is essentially
351354the same as an unbuffered driver. This appears to be true for littlefs 2 and
352- FAT. Testing was done by comparison with
355+ FAT. Testing was done by comparison with
353356[ this unbuffered driver] ( https://github.com/robert-hh/SPI_Flash ) .
354357
355358Both filesystem drivers seem to be designed on the assumption that they are
0 commit comments