Unverified Commit 4ab13489 authored by Mika Westerberg's avatar Mika Westerberg Committed by Mark Brown
Browse files

Documentation / MTD: Rename the intel-spi driver 



Since the driver is renamed (and moved) update the BIOS upgrade guide
accordingly from intel-spi to spi-intel. Keep the guide under MTD
documentation because this is pretty much still about MTD and SPI-NOR.

Signed-off-by: default avatarMika Westerberg <mika.westerberg@linux.intel.com>
Reviewed-by: default avatarAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Reviewed-by: default avatarMauro Lima <mauro.lima@eclypsium.com>
Reviewed-by: default avatarTudor Ambarus <tudor.ambarus@microchip.com>
Link: https://lore.kernel.org/r/20220209122706.42439-4-mika.westerberg@linux.intel.com


Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent e23e5a05

Documentation/driver-api/mtd/index.rst

+1 −1
Original line number Diff line number Diff line
@@ -7,6 +7,6 @@ Memory Technology Device (MTD) 
.. toctree::

   :maxdepth: 1



   intel-spi

   spi-intel

   nand_ecc

   spi-nor

Documentation/driver-api/mtd/intel-spi.rst→Documentation/driver-api/mtd/spi-intel.rst

+4 −4
Original line number Diff line number Diff line 
==============================

Upgrading BIOS using intel-spi

Upgrading BIOS using spi-intel

==============================



Many Intel CPUs like Baytrail and Braswell include SPI serial flash host
@@ -11,12 +11,12 @@ avoid accidental (or on purpose) overwrite of the content. 
Not all manufacturers protect the SPI serial flash, mainly because it

allows upgrading the BIOS image directly from an OS.



The intel-spi driver makes it possible to read and write the SPI serial

The spi-intel driver makes it possible to read and write the SPI serial

flash, if certain protection bits are not set and locked. If it finds

any of them set, the whole MTD device is made read-only to prevent

partial overwrites. By default the driver exposes SPI serial flash

contents as read-only but it can be changed from kernel command line,

passing "intel-spi.writeable=1".

passing "spi_intel.writeable=1".



Please keep in mind that overwriting the BIOS image on SPI serial flash

might render the machine unbootable and requires special equipment like
@@ -32,7 +32,7 @@ Linux. 
    serial flash. Distros like Debian and Fedora have this prepackaged with

    name "mtd-utils".



 3) Add "intel-spi.writeable=1" to the kernel command line and reboot

 3) Add "spi_intel.writeable=1" to the kernel command line and reboot

    the board (you can also reload the driver passing "writeable=1" as

    module parameter to modprobe).