Re: [PATCH] docs: mtd: Update spi nor reference driver

From: John Garry
Date: Fri Aug 16 2019 - 06:20:46 EST

On 06/08/2019 17:40, Schrempf Frieder wrote:
Cc: +MTD/SPI-NOR/SPI maintainers

Hi John,

On 06.08.19 18:35, John Garry wrote:
On 06/08/2019 17:06, John Garry wrote:
The reference driver no longer exists since commit 50f1242c6742 ("mtd:
fsl-quadspi: Remove the driver as it was replaced by spi-fsl-qspi.c").

Update reference to spi-fsl-qspi.c driver.

Signed-off-by: John Garry <john.garry@xxxxxxxxxx>

diff --git a/Documentation/driver-api/mtd/spi-nor.rst
index f5333e3bf486..1f0437676762 100644
--- a/Documentation/driver-api/mtd/spi-nor.rst
+++ b/Documentation/driver-api/mtd/spi-nor.rst

In fact this document has many references to Freescale QuadSPI - could
someone kindly review this complete document for up-to-date accuracy?

The new driver spi-fsl-qspi.c is not a SPI NOR controller driver
anymore. It is now a SPI controller driver that uses the SPI MEM API, so
referencing it here is obsolete.

Actually it seems like the whole file is obsolete and needs to be
removed or replaced by proper documentation of the SPI MEM API.


Could someone kindly advise on the following:

I am looking at ACPI support only for an mtd spi nor driver we're targeting for mainline support.

So for the host, I could use a proprietary HID in the DSDT for matching in the kernel driver.

About the child spi flash devices, is the recommendation to just use PRP0001 HID and "jedec,spi-nor" compatible?


Maybe the docs under Documentation/driver-api/mtd should be officially
maintained by the MTD subsystem (and added to MAINTAINERS). And if there
will be some driver API docs for SPI MEM it should probably live in
Documentation/driver-api/spi instead of Documentation/driver-api/mtd, as
spi-mem.c itself is in drivers/spi.



@@ -59,7 +59,7 @@ Part III - How can drivers use the framework?

The main API is spi_nor_scan(). Before you call the hook, a driver
initialize the necessary fields for spi_nor{}. Please see
-drivers/mtd/spi-nor/spi-nor.c for detail. Please also refer to
+drivers/mtd/spi-nor/spi-nor.c for detail. Please also refer to
when you want to write a new driver for a SPI NOR controller.
Another API is spi_nor_restore(), this is used to restore the status
of SPI
flash chip such as addressing mode. Call it whenever detach the
driver from

Linux MTD discussion mailing list