Hi Simon, On 01/08/21 03:12PM, Simon Glass wrote: > This command is fairly complicated so documentation is useful. > Unfortunately I an not sure how the MTD side of things works and cannot > find information about that. > > Signed-off-by: Simon Glass <s...@chromium.org> > --- > > (no changes since v2) > > Changes in v2: > - Many fixes as suggested by Heinrich > > doc/usage/index.rst | 1 + > doc/usage/sf.rst | 241 ++++++++++++++++++++++++++++++++++++++++++++ > 2 files changed, 242 insertions(+) > create mode 100644 doc/usage/sf.rst > [...] > +Erase > +~~~~~ > + > +Use *sf erase* to erase a region of SPI flash. The erase will fail if any > part > +of the region to be erased is protected or lies past the end of the flash. It > +may also fail if the start offset or length are not aligned to an erase > region > +(e.g. 256 bytes). > + > + > +Update > +~~~~~~ > + > +Use *sf update* to automatically erase and update a region of SPI flash from > +memory. This works a sector at a time (typical 256 bytes or 4KB). For each
Nitpick: I haven't seen any flash with a 256 bytes sector size. 256 bytes is usually the page size, not the (erase) sector size. Looking at spi-nor-ids.c, 4 KiB and 64 KiB seem to be the most common. I think it is better to use one of them to make sure readers don't confuse page size and sector size. > +sector it first checks if the sector already has the right data. If so it is > +skipped. If not, the sector is erased and the new data written. Note that if > +the length is not a multiple of the erase size, the space after the data in > +the last sector will be erased. If the offset does not start at the beginning > +of an erase block, the operation will fail. > + > +Speed statistics are shown including the number of bytes that were already > +correct. > + > + > +Protect > +~~~~~~~ > + > +SPI-flash chips often have a protection feature where the chip is split up > into > +regions which can be locked or unlocked. With *sf protect* it is possible to > +change these settings, if supported by the driver. > + > +lock|unlock > + Selects whether to lock or unlock the sectors > + > +<sector> > + Start sector number to lock/unlock. This may be the byte offset or some > + other value, depending on the chip. > + > +<len> > + Number of bytes to lock/unlock > + > + > +Test > +~~~~ > + > +A convenient and fast *sf test* subcommand provides a way to check that SPI > +flash is working as expected. This works in four stages: > + > + * erase - erases the entire region > + * check - checks that the region is erased > + * write - writes a test pattern to the region, consisting of the U-Boot > code > + * read - reads back the test pattern to check that it was written > correctly > + > +Memory is allocated for two buffers, each <len> bytes in size. At typical > +size is 64KB to 1MB. The offset and size must be aligned to an erase > boundary. > + > +Note that this test will fail if any part of the SPI flash is > write-protected. > + > + > +Examples > +-------- > + > +This first example uses sandbox:: > + Please show the sf probe command as well here and below. Other than these comments Acked-by: Pratyush Yadav <p.ya...@ti.com> Thanks. > + => sf read 1000 1100 80000 > + device 0 offset 0x1100, size 0x80000 > + SF: 524288 bytes @ 0x1100 Read: OK > + => md 1000 > + 00001000: edfe0dd0 f33a0000 78000000 84250000 ......:....x..%. > + 00001010: 28000000 11000000 10000000 00000000 ...(............ > + 00001020: 6f050000 0c250000 00000000 00000000 ...o..%......... > + 00001030: 00000000 00000000 00000000 00000000 ................ > + 00001040: 00000000 00000000 00000000 00000000 ................ > + 00001050: 00000000 00000000 00000000 00000000 ................ > + 00001060: 00000000 00000000 00000000 00000000 ................ > + 00001070: 00000000 00000000 01000000 00000000 ................ > + 00001080: 03000000 04000000 00000000 01000000 ................ > + 00001090: 03000000 04000000 0f000000 01000000 ................ > + 000010a0: 03000000 08000000 1b000000 646e6173 ............sand > + 000010b0: 00786f62 03000000 08000000 21000000 box............! > + 000010c0: 646e6173 00786f62 01000000 61696c61 sandbox.....alia > + 000010d0: 00736573 03000000 07000000 2c000000 ses............, > + 000010e0: 6332692f 00003040 03000000 07000000 /i2c@0.......... > + 000010f0: 31000000 6963702f 00003040 03000000 ...1/pci@0...... > + => sf erase 0 80000 > + SF: 524288 bytes @ 0x0 Erased: OK > + => sf read 1000 1100 80000 > + device 0 offset 0x1100, size 0x80000 > + SF: 524288 bytes @ 0x1100 Read: OK > + => md 1000 > + 00001000: ffffffff ffffffff ffffffff ffffffff ................ > + 00001010: ffffffff ffffffff ffffffff ffffffff ................ > + 00001020: ffffffff ffffffff ffffffff ffffffff ................ > + 00001030: ffffffff ffffffff ffffffff ffffffff ................ > + 00001040: ffffffff ffffffff ffffffff ffffffff ................ > + 00001050: ffffffff ffffffff ffffffff ffffffff ................ > + 00001060: ffffffff ffffffff ffffffff ffffffff ................ > + 00001070: ffffffff ffffffff ffffffff ffffffff ................ > + 00001080: ffffffff ffffffff ffffffff ffffffff ................ > + 00001090: ffffffff ffffffff ffffffff ffffffff ................ > + 000010a0: ffffffff ffffffff ffffffff ffffffff ................ > + 000010b0: ffffffff ffffffff ffffffff ffffffff ................ > + 000010c0: ffffffff ffffffff ffffffff ffffffff ................ > + 000010d0: ffffffff ffffffff ffffffff ffffffff ................ > + 000010e0: ffffffff ffffffff ffffffff ffffffff ................ > + 000010f0: ffffffff ffffffff ffffffff ffffffff ................ > + > +This second example is running on coral, an x86 Chromebook:: > + > + => sf erase 300000 80000 > + SF: 524288 bytes @ 0x300000 Erased: OK > + => sf update 1110000 300000 80000 > + device 0 offset 0x300000, size 0x80000 > + 524288 bytes written, 0 bytes skipped in 0.457s, speed 1164578 B/s > + > + # This does nothing as the flash is already updated > + => sf update 1110000 300000 80000 > + device 0 offset 0x300000, size 0x80000 > + 0 bytes written, 524288 bytes skipped in 0.196s, speed 2684354 B/s > + => sf test 00000 80000 # try a protected region > + SPI flash test: > + Erase failed (err = -5) > + Test failed > + => sf test 800000 80000 > + SPI flash test: > + 0 erase: 18 ticks, 28444 KiB/s 227.552 Mbps > + 1 check: 192 ticks, 2666 KiB/s 21.328 Mbps > + 2 write: 227 ticks, 2255 KiB/s 18.040 Mbps > + 3 read: 189 ticks, 2708 KiB/s 21.664 Mbps > + Test passed > + 0 erase: 18 ticks, 28444 KiB/s 227.552 Mbps > + 1 check: 192 ticks, 2666 KiB/s 21.328 Mbps > + 2 write: 227 ticks, 2255 KiB/s 18.040 Mbps > + 3 read: 189 ticks, 2708 KiB/s 21.664 Mbps > + > + > +.. _SPI documentation: > + https://en.wikipedia.org/wiki/Serial_Peripheral_Interface > -- > 2.32.0.554.ge1b32706d8-goog > -- Regards, Pratyush Yadav Texas Instruments Inc.
