[v1,2/2] mtd: nand: gpio: improve comments about GPIO assisted operation

Message ID 1407227846-3257-2-git-send-email-gsi@denx.de
State Accepted
Commit c9d79c4bbb0e47a75f35652567b2647b99d6295e
Headers show

Commit Message

Gerhard Sittig Aug. 5, 2014, 8:37 a.m.
The drivers/mtd/nand/gpio.c driver does not GPIO bitbang the complete
NAND protocol, but instead is GPIO _assisted_ -- a memory mapped interface
communicates commands and data, and only few control signals are connected
to GPIO pins.

Expand comments in the driver source and in the Kconfig description to
better reflect the very nature of the driver.  The previous text could be
mistaken for complete GPIO bitbanging.

Signed-off-by: Gerhard Sittig <gsi@denx.de>
 drivers/mtd/nand/Kconfig |    6 ++++--
 drivers/mtd/nand/gpio.c  |    4 +++-
 2 files changed, 7 insertions(+), 3 deletions(-)


diff --git a/drivers/mtd/nand/Kconfig b/drivers/mtd/nand/Kconfig
index f1cf503517fd..0ef8b35b459f 100644
--- a/drivers/mtd/nand/Kconfig
+++ b/drivers/mtd/nand/Kconfig
@@ -75,10 +75,12 @@  config MTD_NAND_DENALI_SCRATCH_REG_ADDR
           boards, the scratch register is at 0xFF108018.
-	tristate "GPIO NAND Flash driver"
+	tristate "GPIO assisted NAND Flash driver"
 	depends on GPIOLIB
-	  This enables a GPIO based NAND flash driver.
+	  This enables a NAND flash driver where control signals are
+	  connected to GPIO pins, and commands and data are communicated
+	  via a memory mapped interface.
 	tristate "NAND Flash device on Amstrad E3"
diff --git a/drivers/mtd/nand/gpio.c b/drivers/mtd/nand/gpio.c
index 117ce333fdd4..226eda6f2eee 100644
--- a/drivers/mtd/nand/gpio.c
+++ b/drivers/mtd/nand/gpio.c
@@ -8,7 +8,9 @@ 
  * © 2004 Simtec Electronics
- * Device driver for NAND connected via GPIO
+ * Device driver for NAND flash that uses a memory mapped interface to
+ * read/write the NAND commands and data, and GPIO pins for control signals
+ * (the DT binding refers to this as "GPIO assisted NAND flash")
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 2 as