[PATCH] mtd: nand: Add help text for i.MX NAND controllers

[Sascha Hauer]

Hi Trent,

On Tue, May 25, 2021 at 11:48:05PM -0700, Trent Piepho wrote:
> From: Trent Piepho <tpiepho at gmail.com>
> 
> There are two different NAND drivers, used for different chips in the
> i.MX range.  It's quite confusing as to which to use.  Add some help
> text to clarify.
> 
> Signed-off-by: Trent Piepho <tpiepho at gmail.com>
> ---
>  drivers/mtd/nand/Kconfig | 15 +++++++++++++--
>  1 file changed, 13 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/mtd/nand/Kconfig b/drivers/mtd/nand/Kconfig
> index 7c9326089..9dd6851f3 100644
> --- a/drivers/mtd/nand/Kconfig
> +++ b/drivers/mtd/nand/Kconfig
> @@ -32,14 +32,25 @@ config NAND_ALLOW_ERASE_BAD
>  
>  config NAND_IMX
>  	bool
> -	prompt "i.MX NAND driver"
> +	prompt "i.MX NAND driver aka 'mxc'"
>  	depends on ARCH_IMX
> +	help
> +	  Support for NAND flash on Freescale/NXP i.MX devices.	 This is for the
> +	  "MXC" series:	 i.MX21/25/27/31/35/51/53.  It is not for the "MXS"
> +	  series i.MX processors (23 & 28), or i.MX6 and later, which use the
> +	  NAND controller from the MSX processors.  See the i.MX 'mxs' driver

s/MSX/MXS/

> +	  for those chips.
>  
>  config NAND_MXS
>  	bool
>  	select STMP_DEVICE
> -	prompt "i.MX23/28/6 NAND driver"
> +	prompt "i.MX23/28 & 6+ NAND driver aka 'mxs'"
>  	depends on MXS_APBH_DMA
> +	help
> +	  Support for NAND flash on Freescale/NXP i.MX devices.	 This is for the
> +	  "MXS" series: i.MX23/28 and all i.MX6 and later chips.  It is not for
> +	  the "MXC" series of i.MX processors in the i.MX 21 to 53 range.  See
> +	  the i.MX "msc" driver for those chips.

s/msc/mxc/

In the kernel this driver is known as GPMI nand driver. Maybe we should
add that term here as well?

Sascha


-- 
Pengutronix e.K.                           |                             |
Steuerwalder Str. 21                       | http://www.pengutronix.de/  |
31137 Hildesheim, Germany                  | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |