marvell/linux/drivers/mtd/nand/spi/fudanmicro.c

// SPDX-License-Identifier: GPL-2.0
/*
 * Copyright (C) 2021 ASR Micro Limited
 *
 * Authors:
 *	Fei Lv <feilv@asrmicro.com>
 */

#include <linux/device.h>
#include <linux/kernel.h>
#include <linux/mtd/spinand.h>

#define SPINAND_MFR_FMSH		0xA1

#define FM25LG02B_STATUS_ECC_MASK		(7 << 4)
#define FM25LG02B_STATUS_ECC_NO_BITFLIPS	(0 << 4)
#define FM25LG02B_STATUS_ECC_1_3_BITFLIPS	(1 << 4)
#define FM25LG02B_STATUS_ECC_4_BITFLIPS		(2 << 4)
#define FM25LG02B_STATUS_ECC_5_BITFLIPS		(3 << 4)
#define FM25LG02B_STATUS_ECC_6_BITFLIPS		(4 << 4)
#define FM25LG02B_STATUS_ECC_7_BITFLIPS		(5 << 4)
#define FM25LG02B_STATUS_ECC_8_BITFLIPS		(6 << 4)
#define FM25LG02B_STATUS_ECC_UNCOR_ERROR	(7 << 4)

static SPINAND_OP_VARIANTS(read_cache_variants,
		 /* 0xEB only can work @40MHz, not use now */
		//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 fm25lg02_ecc_get_status(struct spinand_device *spinand, u8 status)
{
	switch (status & FM25LG02B_STATUS_ECC_MASK) {
	case FM25LG02B_STATUS_ECC_NO_BITFLIPS:
		return 0;

	case FM25LG02B_STATUS_ECC_1_3_BITFLIPS:
		return 3;

	case FM25LG02B_STATUS_ECC_4_BITFLIPS:
		return 4;

	case FM25LG02B_STATUS_ECC_5_BITFLIPS:
		return 5;

	case FM25LG02B_STATUS_ECC_6_BITFLIPS:
		return 6;

	case FM25LG02B_STATUS_ECC_7_BITFLIPS:
		return 7;

	case FM25LG02B_STATUS_ECC_8_BITFLIPS:
		return 8;

	case FM25LG02B_STATUS_ECC_UNCOR_ERROR:
		return -EBADMSG;

	default:
		break;
	}

	return -EINVAL;
}

static int fm25ls01_ooblayout_ecc(struct mtd_info *mtd, int section,
				  struct mtd_oob_region *region)
{
	if (section)
		return -ERANGE;

	region->offset = 64;
	region->length = 64;

	return 0;
}

static int fm25ls01_ooblayout_free(struct mtd_info *mtd, int section,
				   struct mtd_oob_region *region)
{
	if (section)
		return -ERANGE;

	/* Reserve 2 bytes for the BBM. */
	region->offset = 2;
	region->length = 62;

	return 0;
}

static const struct mtd_ooblayout_ops fm25ls01_ooblayout = {
	.ecc = fm25ls01_ooblayout_ecc,
	.free = fm25ls01_ooblayout_free,
};

static const struct spinand_info fmsh_spinand_table[] = {
	SPINAND_INFO("FM25LS01", 0xA5,
		     NAND_MEMORG(1, 2048, 128, 64, 1024, 20, 1, 1, 1),
		     NAND_ECCREQ(1, 512),
		     SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
					      &write_cache_variants,
					      &update_cache_variants),
		     0,
		     SPINAND_ECCINFO(&fm25ls01_ooblayout, NULL)),

	SPINAND_INFO("FM25LG02B", 0xB2,
		     NAND_MEMORG(1, 2048, 128, 64, 2048, 20, 1, 1, 1),
		     NAND_ECCREQ(1, 512),
		     SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
					      &write_cache_variants,
					      &update_cache_variants),
		     0,
		     SPINAND_ECCINFO(&fm25ls01_ooblayout,
				     &fm25lg02_ecc_get_status)),
};

/**
 * fmsh_spinand_detect - initialize device related part in spinand_device
 * struct if it is a FudanMicro device.
 * @spinand: SPI NAND device structure
 */
static int fmsh_spinand_detect(struct spinand_device *spinand)
{
	u8 *id = spinand->id.data;
	int ret;

	/*
	 * FudanMicro SPI NAND read ID need a dummy byte,
	 * so the first byte in raw_id is dummy.
	 */
	if (id[1] != SPINAND_MFR_FMSH)
		return 0;

	ret = spinand_match_and_init(spinand, fmsh_spinand_table,
				     ARRAY_SIZE(fmsh_spinand_table), id[2]);
	if (ret)
		return ret;

	return 1;
}

static const struct spinand_manufacturer_ops fmsh_spinand_manuf_ops = {
	.detect = fmsh_spinand_detect,
};

const struct spinand_manufacturer fmsh_spinand_manufacturer = {
	.id = SPINAND_MFR_FMSH,
	.name = "FudanMicro",
	.ops = &fmsh_spinand_manuf_ops,
};