[v2] mtd: spinand: Add initial support for Paragon PN26G0xA
diff mbox series

Message ID 20190618170805.7187-1-lede@allycomm.com
State Accepted
Delegated to: Miquel Raynal
Headers show
Series
  • [v2] mtd: spinand: Add initial support for Paragon PN26G0xA
Related show

Commit Message

Jeff Kletsky June 18, 2019, 5:08 p.m. UTC
From: Jeff Kletsky <git-commits@allycomm.com>

Add initial support for Paragon Technology
PN26G01Axxxxx and PN26G02Axxxxx SPI NAND

Datasheets available at
http://www.xtxtech.com/upfile/2016082517274590.pdf
http://www.xtxtech.com/upfile/2016082517282329.pdf

Signed-off-by: Jeff Kletsky <git-commits@allycomm.com>
---
 drivers/mtd/nand/spi/Makefile  |   2 +-
 drivers/mtd/nand/spi/core.c    |   1 +
 drivers/mtd/nand/spi/paragon.c | 147 +++++++++++++++++++++++++++++++++
 include/linux/mtd/spinand.h    |   1 +
 4 files changed, 150 insertions(+), 1 deletion(-)
 create mode 100644 drivers/mtd/nand/spi/paragon.c

Comments

Schrempf Frieder June 25, 2019, 9:41 a.m. UTC | #1
Hi Jeff,

On 18.06.19 19:08, Jeff Kletsky wrote:
> From: Jeff Kletsky <git-commits@allycomm.com>
> 
> Add initial support for Paragon Technology
> PN26G01Axxxxx and PN26G02Axxxxx SPI NAND
> 
> Datasheets available at
> http://www.xtxtech.com/upfile/2016082517274590.pdf
> http://www.xtxtech.com/upfile/2016082517282329.pdf
> 
> Signed-off-by: Jeff Kletsky <git-commits@allycomm.com>
> ---

Can you please add a changelog here with a list of things that changed 
from v1 to v2?

Thanks,
Frieder

>   drivers/mtd/nand/spi/Makefile  |   2 +-
>   drivers/mtd/nand/spi/core.c    |   1 +
>   drivers/mtd/nand/spi/paragon.c | 147 +++++++++++++++++++++++++++++++++
>   include/linux/mtd/spinand.h    |   1 +
>   4 files changed, 150 insertions(+), 1 deletion(-)
>   create mode 100644 drivers/mtd/nand/spi/paragon.c
> 
> diff --git a/drivers/mtd/nand/spi/Makefile b/drivers/mtd/nand/spi/Makefile
> index 753125082640..9662b9c1d5a9 100644
> --- a/drivers/mtd/nand/spi/Makefile
> +++ b/drivers/mtd/nand/spi/Makefile
> @@ -1,3 +1,3 @@
>   # SPDX-License-Identifier: GPL-2.0
> -spinand-objs := core.o gigadevice.o macronix.o micron.o toshiba.o winbond.o
> +spinand-objs := core.o gigadevice.o macronix.o micron.o paragon.o toshiba.o winbond.o
>   obj-$(CONFIG_MTD_SPI_NAND) += spinand.o
> diff --git a/drivers/mtd/nand/spi/core.c b/drivers/mtd/nand/spi/core.c
> index 556bfdb34455..f0f3528aab8f 100644
> --- a/drivers/mtd/nand/spi/core.c
> +++ b/drivers/mtd/nand/spi/core.c
> @@ -757,6 +757,7 @@ static const struct spinand_manufacturer *spinand_manufacturers[] = {
>   	&gigadevice_spinand_manufacturer,
>   	&macronix_spinand_manufacturer,
>   	&micron_spinand_manufacturer,
> +	&paragon_spinand_manufacturer,
>   	&toshiba_spinand_manufacturer,
>   	&winbond_spinand_manufacturer,
>   };
> diff --git a/drivers/mtd/nand/spi/paragon.c b/drivers/mtd/nand/spi/paragon.c
> new file mode 100644
> index 000000000000..52307681cbd0
> --- /dev/null
> +++ b/drivers/mtd/nand/spi/paragon.c
> @@ -0,0 +1,147 @@
> +// SPDX-License-Identifier: GPL-2.0
> +/*
> + * Copyright (C) 2019 Jeff Kletsky
> + *
> + * Author: Jeff Kletsky <git-commits@allycomm.com>
> + */
> +
> +#include <linux/device.h>
> +#include <linux/kernel.h>
> +#include <linux/mtd/spinand.h>
> +
> +
> +#define SPINAND_MFR_PARAGON	0xa1
> +
> +
> +#define PN26G0XA_STATUS_ECC_BITMASK		(3 << 4)
> +
> +#define PN26G0XA_STATUS_ECC_NONE_DETECTED	(0 << 4)
> +#define PN26G0XA_STATUS_ECC_1_7_CORRECTED	(1 << 4)
> +#define PN26G0XA_STATUS_ECC_ERRORED		(2 << 4)
> +#define PN26G0XA_STATUS_ECC_8_CORRECTED		(3 << 4)
> +
> +
> +static SPINAND_OP_VARIANTS(read_cache_variants,
> +		SPINAND_PAGE_READ_FROM_CACHE_QUADIO_OP(0, 2, NULL, 0),
> +		SPINAND_PAGE_READ_FROM_CACHE_X4_OP(0, 1, NULL, 0),
> +		SPINAND_PAGE_READ_FROM_CACHE_DUALIO_OP(0, 1, NULL, 0),
> +		SPINAND_PAGE_READ_FROM_CACHE_X2_OP(0, 1, NULL, 0),
> +		SPINAND_PAGE_READ_FROM_CACHE_OP(true, 0, 1, NULL, 0),
> +		SPINAND_PAGE_READ_FROM_CACHE_OP(false, 0, 1, NULL, 0));
> +
> +static SPINAND_OP_VARIANTS(write_cache_variants,
> +		SPINAND_PROG_LOAD_X4(true, 0, NULL, 0),
> +		SPINAND_PROG_LOAD(true, 0, NULL, 0));
> +
> +static SPINAND_OP_VARIANTS(update_cache_variants,
> +		SPINAND_PROG_LOAD_X4(false, 0, NULL, 0),
> +		SPINAND_PROG_LOAD(false, 0, NULL, 0));
> +
> +
> +static int pn26g0xa_ooblayout_ecc(struct mtd_info *mtd, int section,
> +				   struct mtd_oob_region *region)
> +{
> +	if (section > 3)
> +		return -ERANGE;
> +
> +	region->offset = 6 + (15 * section); /* 4 BBM + 2 user bytes */
> +	region->length = 13;
> +
> +	return 0;
> +}
> +
> +static int pn26g0xa_ooblayout_free(struct mtd_info *mtd, int section,
> +				   struct mtd_oob_region *region)
> +{
> +	if (section > 4)
> +		return -ERANGE;
> +
> +	if (section == 4) {
> +		region->offset = 64;
> +		region->length = 64;
> +	} else {
> +		region->offset = 4 + (15 * section);
> +		region->length = 2;
> +	}
> +
> +	return 0;
> +}
> +
> +static int pn26g0xa_ecc_get_status(struct spinand_device *spinand,
> +				   u8 status)
> +{
> +	switch (status & PN26G0XA_STATUS_ECC_BITMASK) {
> +	case PN26G0XA_STATUS_ECC_NONE_DETECTED:
> +		return 0;
> +
> +	case PN26G0XA_STATUS_ECC_1_7_CORRECTED:
> +		return 7;	/* Return upper limit by convention */
> +
> +	case PN26G0XA_STATUS_ECC_8_CORRECTED:
> +		return 8;
> +
> +	case PN26G0XA_STATUS_ECC_ERRORED:
> +		return -EBADMSG;
> +
> +	default:
> +		break;
> +	}
> +
> +	return -EINVAL;
> +}
> +
> +static const struct mtd_ooblayout_ops pn26g0xa_ooblayout = {
> +	.ecc = pn26g0xa_ooblayout_ecc,
> +	.free = pn26g0xa_ooblayout_free,
> +};
> +
> +
> +static const struct spinand_info paragon_spinand_table[] = {
> +	SPINAND_INFO("PN26G01A", 0xe1,
> +		     NAND_MEMORG(1, 2048, 128, 64, 1024, 21, 1, 1, 1),
> +		     NAND_ECCREQ(8, 512),
> +		     SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
> +					      &write_cache_variants,
> +					      &update_cache_variants),
> +		     0,
> +		     SPINAND_ECCINFO(&pn26g0xa_ooblayout,
> +				     pn26g0xa_ecc_get_status)),
> +	SPINAND_INFO("PN26G02A", 0xe2,
> +		     NAND_MEMORG(1, 2048, 128, 64, 2048, 41, 1, 1, 1),
> +		     NAND_ECCREQ(8, 512),
> +		     SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
> +					      &write_cache_variants,
> +					      &update_cache_variants),
> +		     0,
> +		     SPINAND_ECCINFO(&pn26g0xa_ooblayout,
> +				     pn26g0xa_ecc_get_status)),
> +};
> +
> +static int paragon_spinand_detect(struct spinand_device *spinand)
> +{
> +	u8 *id = spinand->id.data;
> +	int ret;
> +
> +	/* Read ID returns [0][MID][DID] */
> +
> +	if (id[1] != SPINAND_MFR_PARAGON)
> +		return 0;
> +
> +	ret = spinand_match_and_init(spinand, paragon_spinand_table,
> +				     ARRAY_SIZE(paragon_spinand_table),
> +				     id[2]);
> +	if (ret)
> +		return ret;
> +
> +	return 1;
> +}
> +
> +static const struct spinand_manufacturer_ops paragon_spinand_manuf_ops = {
> +	.detect = paragon_spinand_detect,
> +};
> +
> +const struct spinand_manufacturer paragon_spinand_manufacturer = {
> +	.id = SPINAND_MFR_PARAGON,
> +	.name = "Paragon",
> +	.ops = &paragon_spinand_manuf_ops,
> +};
> diff --git a/include/linux/mtd/spinand.h b/include/linux/mtd/spinand.h
> index fbc0423bb4ae..4ea558bd3c46 100644
> --- a/include/linux/mtd/spinand.h
> +++ b/include/linux/mtd/spinand.h
> @@ -227,6 +227,7 @@ struct spinand_manufacturer {
>   extern const struct spinand_manufacturer gigadevice_spinand_manufacturer;
>   extern const struct spinand_manufacturer macronix_spinand_manufacturer;
>   extern const struct spinand_manufacturer micron_spinand_manufacturer;
> +extern const struct spinand_manufacturer paragon_spinand_manufacturer;
>   extern const struct spinand_manufacturer toshiba_spinand_manufacturer;
>   extern const struct spinand_manufacturer winbond_spinand_manufacturer;
>   
>
Jeff Kletsky June 25, 2019, 2:45 p.m. UTC | #2
(Resend to lists only, due to multipart content in previous)

Of course!

Thanks for taking the time to look at this.

* Updated OOB-layout definitions to agree with
    Table 10; ECC Protection and Spare Area
    (PN26G01A pg. 36, PN26G02A pg. 35)

* Corrected NAND_MEMORG for PN26G02A to 41, to agree with
    Table 9; Error Management Details (PN26G02A pg. 34)

Jeff

On 6/25/19 2:41 AM, Schrempf Frieder wrote:

> Hi Jeff,
>
> On 18.06.19 19:08, Jeff Kletsky wrote:
>> From: Jeff Kletsky <git-commits@allycomm.com>
>>
>> Add initial support for Paragon Technology
>> PN26G01Axxxxx and PN26G02Axxxxx SPI NAND
>>
>> Datasheets available at
>> http://www.xtxtech.com/upfile/2016082517274590.pdf
>> http://www.xtxtech.com/upfile/2016082517282329.pdf
>>
>> Signed-off-by: Jeff Kletsky <git-commits@allycomm.com>
>> ---
> Can you please add a changelog here with a list of things that changed
> from v1 to v2?
>
> Thanks,
> Frieder
>
>>    drivers/mtd/nand/spi/Makefile  |   2 +-
>>    drivers/mtd/nand/spi/core.c    |   1 +
>>    drivers/mtd/nand/spi/paragon.c | 147 +++++++++++++++++++++++++++++++++
>>    include/linux/mtd/spinand.h    |   1 +
>>    4 files changed, 150 insertions(+), 1 deletion(-)
>>    create mode 100644 drivers/mtd/nand/spi/paragon.c
>>
>> diff --git a/drivers/mtd/nand/spi/Makefile b/drivers/mtd/nand/spi/Makefile
>> index 753125082640..9662b9c1d5a9 100644
>> --- a/drivers/mtd/nand/spi/Makefile
>> +++ b/drivers/mtd/nand/spi/Makefile
>> @@ -1,3 +1,3 @@
>>    # SPDX-License-Identifier: GPL-2.0
>> -spinand-objs := core.o gigadevice.o macronix.o micron.o toshiba.o winbond.o
>> +spinand-objs := core.o gigadevice.o macronix.o micron.o paragon.o toshiba.o winbond.o
>>    obj-$(CONFIG_MTD_SPI_NAND) += spinand.o
>> diff --git a/drivers/mtd/nand/spi/core.c b/drivers/mtd/nand/spi/core.c
>> index 556bfdb34455..f0f3528aab8f 100644
>> --- a/drivers/mtd/nand/spi/core.c
>> +++ b/drivers/mtd/nand/spi/core.c
>> @@ -757,6 +757,7 @@ static const struct spinand_manufacturer *spinand_manufacturers[] = {
>>    	&gigadevice_spinand_manufacturer,
>>    	&macronix_spinand_manufacturer,
>>    	&micron_spinand_manufacturer,
>> +	&paragon_spinand_manufacturer,
>>    	&toshiba_spinand_manufacturer,
>>    	&winbond_spinand_manufacturer,
>>    };
>> diff --git a/drivers/mtd/nand/spi/paragon.c b/drivers/mtd/nand/spi/paragon.c
>> new file mode 100644
>> index 000000000000..52307681cbd0
>> --- /dev/null
>> +++ b/drivers/mtd/nand/spi/paragon.c
>> @@ -0,0 +1,147 @@
>> +// SPDX-License-Identifier: GPL-2.0
>> +/*
>> + * Copyright (C) 2019 Jeff Kletsky
>> + *
>> + * Author: Jeff Kletsky <git-commits@allycomm.com>
>> + */
>> +
>> +#include <linux/device.h>
>> +#include <linux/kernel.h>
>> +#include <linux/mtd/spinand.h>
>> +
>> +
>> +#define SPINAND_MFR_PARAGON	0xa1
>> +
>> +
>> +#define PN26G0XA_STATUS_ECC_BITMASK		(3 << 4)
>> +
>> +#define PN26G0XA_STATUS_ECC_NONE_DETECTED	(0 << 4)
>> +#define PN26G0XA_STATUS_ECC_1_7_CORRECTED	(1 << 4)
>> +#define PN26G0XA_STATUS_ECC_ERRORED		(2 << 4)
>> +#define PN26G0XA_STATUS_ECC_8_CORRECTED		(3 << 4)
>> +
>> +
>> +static SPINAND_OP_VARIANTS(read_cache_variants,
>> +		SPINAND_PAGE_READ_FROM_CACHE_QUADIO_OP(0, 2, NULL, 0),
>> +		SPINAND_PAGE_READ_FROM_CACHE_X4_OP(0, 1, NULL, 0),
>> +		SPINAND_PAGE_READ_FROM_CACHE_DUALIO_OP(0, 1, NULL, 0),
>> +		SPINAND_PAGE_READ_FROM_CACHE_X2_OP(0, 1, NULL, 0),
>> +		SPINAND_PAGE_READ_FROM_CACHE_OP(true, 0, 1, NULL, 0),
>> +		SPINAND_PAGE_READ_FROM_CACHE_OP(false, 0, 1, NULL, 0));
>> +
>> +static SPINAND_OP_VARIANTS(write_cache_variants,
>> +		SPINAND_PROG_LOAD_X4(true, 0, NULL, 0),
>> +		SPINAND_PROG_LOAD(true, 0, NULL, 0));
>> +
>> +static SPINAND_OP_VARIANTS(update_cache_variants,
>> +		SPINAND_PROG_LOAD_X4(false, 0, NULL, 0),
>> +		SPINAND_PROG_LOAD(false, 0, NULL, 0));
>> +
>> +
>> +static int pn26g0xa_ooblayout_ecc(struct mtd_info *mtd, int section,
>> +				   struct mtd_oob_region *region)
>> +{
>> +	if (section > 3)
>> +		return -ERANGE;
>> +
>> +	region->offset = 6 + (15 * section); /* 4 BBM + 2 user bytes */
>> +	region->length = 13;
>> +
>> +	return 0;
>> +}
>> +
>> +static int pn26g0xa_ooblayout_free(struct mtd_info *mtd, int section,
>> +				   struct mtd_oob_region *region)
>> +{
>> +	if (section > 4)
>> +		return -ERANGE;
>> +
>> +	if (section == 4) {
>> +		region->offset = 64;
>> +		region->length = 64;
>> +	} else {
>> +		region->offset = 4 + (15 * section);
>> +		region->length = 2;
>> +	}
>> +
>> +	return 0;
>> +}
>> +
>> +static int pn26g0xa_ecc_get_status(struct spinand_device *spinand,
>> +				   u8 status)
>> +{
>> +	switch (status & PN26G0XA_STATUS_ECC_BITMASK) {
>> +	case PN26G0XA_STATUS_ECC_NONE_DETECTED:
>> +		return 0;
>> +
>> +	case PN26G0XA_STATUS_ECC_1_7_CORRECTED:
>> +		return 7;	/* Return upper limit by convention */
>> +
>> +	case PN26G0XA_STATUS_ECC_8_CORRECTED:
>> +		return 8;
>> +
>> +	case PN26G0XA_STATUS_ECC_ERRORED:
>> +		return -EBADMSG;
>> +
>> +	default:
>> +		break;
>> +	}
>> +
>> +	return -EINVAL;
>> +}
>> +
>> +static const struct mtd_ooblayout_ops pn26g0xa_ooblayout = {
>> +	.ecc = pn26g0xa_ooblayout_ecc,
>> +	.free = pn26g0xa_ooblayout_free,
>> +};
>> +
>> +
>> +static const struct spinand_info paragon_spinand_table[] = {
>> +	SPINAND_INFO("PN26G01A", 0xe1,
>> +		     NAND_MEMORG(1, 2048, 128, 64, 1024, 21, 1, 1, 1),
>> +		     NAND_ECCREQ(8, 512),
>> +		     SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
>> +					      &write_cache_variants,
>> +					      &update_cache_variants),
>> +		     0,
>> +		     SPINAND_ECCINFO(&pn26g0xa_ooblayout,
>> +				     pn26g0xa_ecc_get_status)),
>> +	SPINAND_INFO("PN26G02A", 0xe2,
>> +		     NAND_MEMORG(1, 2048, 128, 64, 2048, 41, 1, 1, 1),
>> +		     NAND_ECCREQ(8, 512),
>> +		     SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
>> +					      &write_cache_variants,
>> +					      &update_cache_variants),
>> +		     0,
>> +		     SPINAND_ECCINFO(&pn26g0xa_ooblayout,
>> +				     pn26g0xa_ecc_get_status)),
>> +};
>> +
>> +static int paragon_spinand_detect(struct spinand_device *spinand)
>> +{
>> +	u8 *id = spinand->id.data;
>> +	int ret;
>> +
>> +	/* Read ID returns [0][MID][DID] */
>> +
>> +	if (id[1] != SPINAND_MFR_PARAGON)
>> +		return 0;
>> +
>> +	ret = spinand_match_and_init(spinand, paragon_spinand_table,
>> +				     ARRAY_SIZE(paragon_spinand_table),
>> +				     id[2]);
>> +	if (ret)
>> +		return ret;
>> +
>> +	return 1;
>> +}
>> +
>> +static const struct spinand_manufacturer_ops paragon_spinand_manuf_ops = {
>> +	.detect = paragon_spinand_detect,
>> +};
>> +
>> +const struct spinand_manufacturer paragon_spinand_manufacturer = {
>> +	.id = SPINAND_MFR_PARAGON,
>> +	.name = "Paragon",
>> +	.ops = &paragon_spinand_manuf_ops,
>> +};
>> diff --git a/include/linux/mtd/spinand.h b/include/linux/mtd/spinand.h
>> index fbc0423bb4ae..4ea558bd3c46 100644
>> --- a/include/linux/mtd/spinand.h
>> +++ b/include/linux/mtd/spinand.h
>> @@ -227,6 +227,7 @@ struct spinand_manufacturer {
>>    extern const struct spinand_manufacturer gigadevice_spinand_manufacturer;
>>    extern const struct spinand_manufacturer macronix_spinand_manufacturer;
>>    extern const struct spinand_manufacturer micron_spinand_manufacturer;
>> +extern const struct spinand_manufacturer paragon_spinand_manufacturer;
>>    extern const struct spinand_manufacturer toshiba_spinand_manufacturer;
>>    extern const struct spinand_manufacturer winbond_spinand_manufacturer;
>>    
>>
> ______________________________________________________
> Linux MTD discussion mailing list
> http://lists.infradead.org/mailman/listinfo/linux-mtd/
>
Schrempf Frieder June 27, 2019, 5:55 p.m. UTC | #3
On 18.06.19 19:08, Jeff Kletsky wrote:
> From: Jeff Kletsky <git-commits@allycomm.com>
> 
> Add initial support for Paragon Technology
> PN26G01Axxxxx and PN26G02Axxxxx SPI NAND
> 
> Datasheets available at
> http://www.xtxtech.com/upfile/2016082517274590.pdf
> http://www.xtxtech.com/upfile/2016082517282329.pdf
> 
> Signed-off-by: Jeff Kletsky <git-commits@allycomm.com>

Reviewed-by: Frieder Schrempf <frieder.schrempf@kontron.de>

> ---
>   drivers/mtd/nand/spi/Makefile  |   2 +-
>   drivers/mtd/nand/spi/core.c    |   1 +
>   drivers/mtd/nand/spi/paragon.c | 147 +++++++++++++++++++++++++++++++++
>   include/linux/mtd/spinand.h    |   1 +
>   4 files changed, 150 insertions(+), 1 deletion(-)
>   create mode 100644 drivers/mtd/nand/spi/paragon.c
> 
> diff --git a/drivers/mtd/nand/spi/Makefile b/drivers/mtd/nand/spi/Makefile
> index 753125082640..9662b9c1d5a9 100644
> --- a/drivers/mtd/nand/spi/Makefile
> +++ b/drivers/mtd/nand/spi/Makefile
> @@ -1,3 +1,3 @@
>   # SPDX-License-Identifier: GPL-2.0
> -spinand-objs := core.o gigadevice.o macronix.o micron.o toshiba.o winbond.o
> +spinand-objs := core.o gigadevice.o macronix.o micron.o paragon.o toshiba.o winbond.o
>   obj-$(CONFIG_MTD_SPI_NAND) += spinand.o
> diff --git a/drivers/mtd/nand/spi/core.c b/drivers/mtd/nand/spi/core.c
> index 556bfdb34455..f0f3528aab8f 100644
> --- a/drivers/mtd/nand/spi/core.c
> +++ b/drivers/mtd/nand/spi/core.c
> @@ -757,6 +757,7 @@ static const struct spinand_manufacturer *spinand_manufacturers[] = {
>   	&gigadevice_spinand_manufacturer,
>   	&macronix_spinand_manufacturer,
>   	&micron_spinand_manufacturer,
> +	&paragon_spinand_manufacturer,
>   	&toshiba_spinand_manufacturer,
>   	&winbond_spinand_manufacturer,
>   };
> diff --git a/drivers/mtd/nand/spi/paragon.c b/drivers/mtd/nand/spi/paragon.c
> new file mode 100644
> index 000000000000..52307681cbd0
> --- /dev/null
> +++ b/drivers/mtd/nand/spi/paragon.c
> @@ -0,0 +1,147 @@
> +// SPDX-License-Identifier: GPL-2.0
> +/*
> + * Copyright (C) 2019 Jeff Kletsky
> + *
> + * Author: Jeff Kletsky <git-commits@allycomm.com>
> + */
> +
> +#include <linux/device.h>
> +#include <linux/kernel.h>
> +#include <linux/mtd/spinand.h>
> +
> +
> +#define SPINAND_MFR_PARAGON	0xa1
> +
> +
> +#define PN26G0XA_STATUS_ECC_BITMASK		(3 << 4)
> +
> +#define PN26G0XA_STATUS_ECC_NONE_DETECTED	(0 << 4)
> +#define PN26G0XA_STATUS_ECC_1_7_CORRECTED	(1 << 4)
> +#define PN26G0XA_STATUS_ECC_ERRORED		(2 << 4)
> +#define PN26G0XA_STATUS_ECC_8_CORRECTED		(3 << 4)
> +
> +
> +static SPINAND_OP_VARIANTS(read_cache_variants,
> +		SPINAND_PAGE_READ_FROM_CACHE_QUADIO_OP(0, 2, NULL, 0),
> +		SPINAND_PAGE_READ_FROM_CACHE_X4_OP(0, 1, NULL, 0),
> +		SPINAND_PAGE_READ_FROM_CACHE_DUALIO_OP(0, 1, NULL, 0),
> +		SPINAND_PAGE_READ_FROM_CACHE_X2_OP(0, 1, NULL, 0),
> +		SPINAND_PAGE_READ_FROM_CACHE_OP(true, 0, 1, NULL, 0),
> +		SPINAND_PAGE_READ_FROM_CACHE_OP(false, 0, 1, NULL, 0));
> +
> +static SPINAND_OP_VARIANTS(write_cache_variants,
> +		SPINAND_PROG_LOAD_X4(true, 0, NULL, 0),
> +		SPINAND_PROG_LOAD(true, 0, NULL, 0));
> +
> +static SPINAND_OP_VARIANTS(update_cache_variants,
> +		SPINAND_PROG_LOAD_X4(false, 0, NULL, 0),
> +		SPINAND_PROG_LOAD(false, 0, NULL, 0));
> +
> +
> +static int pn26g0xa_ooblayout_ecc(struct mtd_info *mtd, int section,
> +				   struct mtd_oob_region *region)
> +{
> +	if (section > 3)
> +		return -ERANGE;
> +
> +	region->offset = 6 + (15 * section); /* 4 BBM + 2 user bytes */
> +	region->length = 13;
> +
> +	return 0;
> +}
> +
> +static int pn26g0xa_ooblayout_free(struct mtd_info *mtd, int section,
> +				   struct mtd_oob_region *region)
> +{
> +	if (section > 4)
> +		return -ERANGE;
> +
> +	if (section == 4) {
> +		region->offset = 64;
> +		region->length = 64;
> +	} else {
> +		region->offset = 4 + (15 * section);
> +		region->length = 2;
> +	}
> +
> +	return 0;
> +}
> +
> +static int pn26g0xa_ecc_get_status(struct spinand_device *spinand,
> +				   u8 status)
> +{
> +	switch (status & PN26G0XA_STATUS_ECC_BITMASK) {
> +	case PN26G0XA_STATUS_ECC_NONE_DETECTED:
> +		return 0;
> +
> +	case PN26G0XA_STATUS_ECC_1_7_CORRECTED:
> +		return 7;	/* Return upper limit by convention */
> +
> +	case PN26G0XA_STATUS_ECC_8_CORRECTED:
> +		return 8;
> +
> +	case PN26G0XA_STATUS_ECC_ERRORED:
> +		return -EBADMSG;
> +
> +	default:
> +		break;
> +	}
> +
> +	return -EINVAL;
> +}
> +
> +static const struct mtd_ooblayout_ops pn26g0xa_ooblayout = {
> +	.ecc = pn26g0xa_ooblayout_ecc,
> +	.free = pn26g0xa_ooblayout_free,
> +};
> +
> +
> +static const struct spinand_info paragon_spinand_table[] = {
> +	SPINAND_INFO("PN26G01A", 0xe1,
> +		     NAND_MEMORG(1, 2048, 128, 64, 1024, 21, 1, 1, 1),
> +		     NAND_ECCREQ(8, 512),
> +		     SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
> +					      &write_cache_variants,
> +					      &update_cache_variants),
> +		     0,
> +		     SPINAND_ECCINFO(&pn26g0xa_ooblayout,
> +				     pn26g0xa_ecc_get_status)),
> +	SPINAND_INFO("PN26G02A", 0xe2,
> +		     NAND_MEMORG(1, 2048, 128, 64, 2048, 41, 1, 1, 1),
> +		     NAND_ECCREQ(8, 512),
> +		     SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
> +					      &write_cache_variants,
> +					      &update_cache_variants),
> +		     0,
> +		     SPINAND_ECCINFO(&pn26g0xa_ooblayout,
> +				     pn26g0xa_ecc_get_status)),
> +};
> +
> +static int paragon_spinand_detect(struct spinand_device *spinand)
> +{
> +	u8 *id = spinand->id.data;
> +	int ret;
> +
> +	/* Read ID returns [0][MID][DID] */
> +
> +	if (id[1] != SPINAND_MFR_PARAGON)
> +		return 0;
> +
> +	ret = spinand_match_and_init(spinand, paragon_spinand_table,
> +				     ARRAY_SIZE(paragon_spinand_table),
> +				     id[2]);
> +	if (ret)
> +		return ret;
> +
> +	return 1;
> +}
> +
> +static const struct spinand_manufacturer_ops paragon_spinand_manuf_ops = {
> +	.detect = paragon_spinand_detect,
> +};
> +
> +const struct spinand_manufacturer paragon_spinand_manufacturer = {
> +	.id = SPINAND_MFR_PARAGON,
> +	.name = "Paragon",
> +	.ops = &paragon_spinand_manuf_ops,
> +};
> diff --git a/include/linux/mtd/spinand.h b/include/linux/mtd/spinand.h
> index fbc0423bb4ae..4ea558bd3c46 100644
> --- a/include/linux/mtd/spinand.h
> +++ b/include/linux/mtd/spinand.h
> @@ -227,6 +227,7 @@ struct spinand_manufacturer {
>   extern const struct spinand_manufacturer gigadevice_spinand_manufacturer;
>   extern const struct spinand_manufacturer macronix_spinand_manufacturer;
>   extern const struct spinand_manufacturer micron_spinand_manufacturer;
> +extern const struct spinand_manufacturer paragon_spinand_manufacturer;
>   extern const struct spinand_manufacturer toshiba_spinand_manufacturer;
>   extern const struct spinand_manufacturer winbond_spinand_manufacturer;
>   
>
Miquel Raynal June 28, 2019, 6:37 p.m. UTC | #4
On Tue, 2019-06-18 at 17:08:05 UTC, Jeff Kletsky wrote:
> From: Jeff Kletsky <git-commits@allycomm.com>
> 
> Add initial support for Paragon Technology
> PN26G01Axxxxx and PN26G02Axxxxx SPI NAND
> 
> Datasheets available at
> http://www.xtxtech.com/upfile/2016082517274590.pdf
> http://www.xtxtech.com/upfile/2016082517282329.pdf
> 
> Signed-off-by: Jeff Kletsky <git-commits@allycomm.com>
> Reviewed-by: Frieder Schrempf <frieder.schrempf@kontron.de>

Applied to https://git.kernel.org/pub/scm/linux/kernel/git/mtd/linux.git nand/next, thanks.

Miquel

Patch
diff mbox series

diff --git a/drivers/mtd/nand/spi/Makefile b/drivers/mtd/nand/spi/Makefile
index 753125082640..9662b9c1d5a9 100644
--- a/drivers/mtd/nand/spi/Makefile
+++ b/drivers/mtd/nand/spi/Makefile
@@ -1,3 +1,3 @@ 
 # SPDX-License-Identifier: GPL-2.0
-spinand-objs := core.o gigadevice.o macronix.o micron.o toshiba.o winbond.o
+spinand-objs := core.o gigadevice.o macronix.o micron.o paragon.o toshiba.o winbond.o
 obj-$(CONFIG_MTD_SPI_NAND) += spinand.o
diff --git a/drivers/mtd/nand/spi/core.c b/drivers/mtd/nand/spi/core.c
index 556bfdb34455..f0f3528aab8f 100644
--- a/drivers/mtd/nand/spi/core.c
+++ b/drivers/mtd/nand/spi/core.c
@@ -757,6 +757,7 @@  static const struct spinand_manufacturer *spinand_manufacturers[] = {
 	&gigadevice_spinand_manufacturer,
 	&macronix_spinand_manufacturer,
 	&micron_spinand_manufacturer,
+	&paragon_spinand_manufacturer,
 	&toshiba_spinand_manufacturer,
 	&winbond_spinand_manufacturer,
 };
diff --git a/drivers/mtd/nand/spi/paragon.c b/drivers/mtd/nand/spi/paragon.c
new file mode 100644
index 000000000000..52307681cbd0
--- /dev/null
+++ b/drivers/mtd/nand/spi/paragon.c
@@ -0,0 +1,147 @@ 
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Copyright (C) 2019 Jeff Kletsky
+ *
+ * Author: Jeff Kletsky <git-commits@allycomm.com>
+ */
+
+#include <linux/device.h>
+#include <linux/kernel.h>
+#include <linux/mtd/spinand.h>
+
+
+#define SPINAND_MFR_PARAGON	0xa1
+
+
+#define PN26G0XA_STATUS_ECC_BITMASK		(3 << 4)
+
+#define PN26G0XA_STATUS_ECC_NONE_DETECTED	(0 << 4)
+#define PN26G0XA_STATUS_ECC_1_7_CORRECTED	(1 << 4)
+#define PN26G0XA_STATUS_ECC_ERRORED		(2 << 4)
+#define PN26G0XA_STATUS_ECC_8_CORRECTED		(3 << 4)
+
+
+static SPINAND_OP_VARIANTS(read_cache_variants,
+		SPINAND_PAGE_READ_FROM_CACHE_QUADIO_OP(0, 2, NULL, 0),
+		SPINAND_PAGE_READ_FROM_CACHE_X4_OP(0, 1, NULL, 0),
+		SPINAND_PAGE_READ_FROM_CACHE_DUALIO_OP(0, 1, NULL, 0),
+		SPINAND_PAGE_READ_FROM_CACHE_X2_OP(0, 1, NULL, 0),
+		SPINAND_PAGE_READ_FROM_CACHE_OP(true, 0, 1, NULL, 0),
+		SPINAND_PAGE_READ_FROM_CACHE_OP(false, 0, 1, NULL, 0));
+
+static SPINAND_OP_VARIANTS(write_cache_variants,
+		SPINAND_PROG_LOAD_X4(true, 0, NULL, 0),
+		SPINAND_PROG_LOAD(true, 0, NULL, 0));
+
+static SPINAND_OP_VARIANTS(update_cache_variants,
+		SPINAND_PROG_LOAD_X4(false, 0, NULL, 0),
+		SPINAND_PROG_LOAD(false, 0, NULL, 0));
+
+
+static int pn26g0xa_ooblayout_ecc(struct mtd_info *mtd, int section,
+				   struct mtd_oob_region *region)
+{
+	if (section > 3)
+		return -ERANGE;
+
+	region->offset = 6 + (15 * section); /* 4 BBM + 2 user bytes */
+	region->length = 13;
+
+	return 0;
+}
+
+static int pn26g0xa_ooblayout_free(struct mtd_info *mtd, int section,
+				   struct mtd_oob_region *region)
+{
+	if (section > 4)
+		return -ERANGE;
+
+	if (section == 4) {
+		region->offset = 64;
+		region->length = 64;
+	} else {
+		region->offset = 4 + (15 * section);
+		region->length = 2;
+	}
+
+	return 0;
+}
+
+static int pn26g0xa_ecc_get_status(struct spinand_device *spinand,
+				   u8 status)
+{
+	switch (status & PN26G0XA_STATUS_ECC_BITMASK) {
+	case PN26G0XA_STATUS_ECC_NONE_DETECTED:
+		return 0;
+
+	case PN26G0XA_STATUS_ECC_1_7_CORRECTED:
+		return 7;	/* Return upper limit by convention */
+
+	case PN26G0XA_STATUS_ECC_8_CORRECTED:
+		return 8;
+
+	case PN26G0XA_STATUS_ECC_ERRORED:
+		return -EBADMSG;
+
+	default:
+		break;
+	}
+
+	return -EINVAL;
+}
+
+static const struct mtd_ooblayout_ops pn26g0xa_ooblayout = {
+	.ecc = pn26g0xa_ooblayout_ecc,
+	.free = pn26g0xa_ooblayout_free,
+};
+
+
+static const struct spinand_info paragon_spinand_table[] = {
+	SPINAND_INFO("PN26G01A", 0xe1,
+		     NAND_MEMORG(1, 2048, 128, 64, 1024, 21, 1, 1, 1),
+		     NAND_ECCREQ(8, 512),
+		     SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
+					      &write_cache_variants,
+					      &update_cache_variants),
+		     0,
+		     SPINAND_ECCINFO(&pn26g0xa_ooblayout,
+				     pn26g0xa_ecc_get_status)),
+	SPINAND_INFO("PN26G02A", 0xe2,
+		     NAND_MEMORG(1, 2048, 128, 64, 2048, 41, 1, 1, 1),
+		     NAND_ECCREQ(8, 512),
+		     SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
+					      &write_cache_variants,
+					      &update_cache_variants),
+		     0,
+		     SPINAND_ECCINFO(&pn26g0xa_ooblayout,
+				     pn26g0xa_ecc_get_status)),
+};
+
+static int paragon_spinand_detect(struct spinand_device *spinand)
+{
+	u8 *id = spinand->id.data;
+	int ret;
+
+	/* Read ID returns [0][MID][DID] */
+
+	if (id[1] != SPINAND_MFR_PARAGON)
+		return 0;
+
+	ret = spinand_match_and_init(spinand, paragon_spinand_table,
+				     ARRAY_SIZE(paragon_spinand_table),
+				     id[2]);
+	if (ret)
+		return ret;
+
+	return 1;
+}
+
+static const struct spinand_manufacturer_ops paragon_spinand_manuf_ops = {
+	.detect = paragon_spinand_detect,
+};
+
+const struct spinand_manufacturer paragon_spinand_manufacturer = {
+	.id = SPINAND_MFR_PARAGON,
+	.name = "Paragon",
+	.ops = &paragon_spinand_manuf_ops,
+};
diff --git a/include/linux/mtd/spinand.h b/include/linux/mtd/spinand.h
index fbc0423bb4ae..4ea558bd3c46 100644
--- a/include/linux/mtd/spinand.h
+++ b/include/linux/mtd/spinand.h
@@ -227,6 +227,7 @@  struct spinand_manufacturer {
 extern const struct spinand_manufacturer gigadevice_spinand_manufacturer;
 extern const struct spinand_manufacturer macronix_spinand_manufacturer;
 extern const struct spinand_manufacturer micron_spinand_manufacturer;
+extern const struct spinand_manufacturer paragon_spinand_manufacturer;
 extern const struct spinand_manufacturer toshiba_spinand_manufacturer;
 extern const struct spinand_manufacturer winbond_spinand_manufacturer;