xref: /rk3399_rockchip-uboot/drivers/mtd/nand/spi/etron.c (revision 6414e3bc8687dbcc585b804d5c0bdfdb2d979c4b)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (c) 2021 Rockchip Electronics Co., Ltd
4  *
5  * Authors:
6  *	Dingqiang Lin <jon.lin@rock-chips.com>
7  */
8 
9 #ifndef __UBOOT__
10 #include <linux/device.h>
11 #include <linux/kernel.h>
12 #endif
13 #include <linux/mtd/spinand.h>
14 
15 #define SPINAND_MFR_ETRON		0xD5
16 
17 static SPINAND_OP_VARIANTS(read_cache_variants,
18 		SPINAND_PAGE_READ_FROM_CACHE_QUADIO_OP(0, 2, NULL, 0),
19 		SPINAND_PAGE_READ_FROM_CACHE_X4_OP(0, 1, NULL, 0),
20 		SPINAND_PAGE_READ_FROM_CACHE_DUALIO_OP(0, 1, NULL, 0),
21 		SPINAND_PAGE_READ_FROM_CACHE_X2_OP(0, 1, NULL, 0),
22 		SPINAND_PAGE_READ_FROM_CACHE_OP(true, 0, 1, NULL, 0),
23 		SPINAND_PAGE_READ_FROM_CACHE_OP(false, 0, 1, NULL, 0));
24 
25 static SPINAND_OP_VARIANTS(write_cache_variants,
26 		SPINAND_PROG_LOAD_X4(true, 0, NULL, 0),
27 		SPINAND_PROG_LOAD(true, 0, NULL, 0));
28 
29 static SPINAND_OP_VARIANTS(update_cache_variants,
30 		SPINAND_PROG_LOAD_X4(false, 0, NULL, 0),
31 		SPINAND_PROG_LOAD(false, 0, NULL, 0));
32 
33 static int em73c044vcf_oh_ooblayout_ecc(struct mtd_info *mtd, int section,
34 					struct mtd_oob_region *region)
35 {
36 	if (section > 3)
37 		return -ERANGE;
38 
39 	region->offset = (16 * section) + 8;
40 	region->length = 8;
41 
42 	return 0;
43 }
44 
45 static int em73c044vcf_oh_ooblayout_free(struct mtd_info *mtd, int section,
46 					 struct mtd_oob_region *region)
47 {
48 	if (section > 3)
49 		return -ERANGE;
50 
51 	region->offset = (16 * section) + 2;
52 	region->length = 6;
53 
54 	return 0;
55 }
56 
57 static const struct mtd_ooblayout_ops em73c044vcf_oh_ooblayout = {
58 	.ecc = em73c044vcf_oh_ooblayout_ecc,
59 	.rfree = em73c044vcf_oh_ooblayout_free,
60 };
61 
62 static int em73c044vcf_oh_ecc_get_status(struct spinand_device *spinand,
63 					 u8 status)
64 {
65 	struct nand_device *nand = spinand_to_nand(spinand);
66 
67 	switch (status & STATUS_ECC_MASK) {
68 	case STATUS_ECC_NO_BITFLIPS:
69 		return 0;
70 
71 	case STATUS_ECC_UNCOR_ERROR:
72 		return -EBADMSG;
73 
74 	case STATUS_ECC_HAS_BITFLIPS:
75 		return 1;
76 
77 	default:
78 		return nand->eccreq.strength;
79 	}
80 
81 	return -EINVAL;
82 }
83 
84 static const struct spinand_info etron_spinand_table[] = {
85 	SPINAND_INFO("EM73C044VCF-0H", 0x36,
86 		     NAND_MEMORG(1, 2048, 64, 64, 1024, 1, 1, 1),
87 		     NAND_ECCREQ(4, 512),
88 		     SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
89 					      &write_cache_variants,
90 					      &update_cache_variants),
91 		     SPINAND_HAS_QE_BIT,
92 		     SPINAND_ECCINFO(&em73c044vcf_oh_ooblayout,
93 				     em73c044vcf_oh_ecc_get_status)),
94 };
95 
96 /**
97  * etron_spinand_detect - initialize device related part in spinand_device
98  * struct if it is a Etron device.
99  * @spinand: SPI NAND device structure
100  */
101 static int etron_spinand_detect(struct spinand_device *spinand)
102 {
103 	u8 *id = spinand->id.data;
104 	int ret;
105 
106 	/*
107 	 * Etron SPI NAND read ID need a dummy byte,
108 	 * so the first byte in raw_id is dummy.
109 	 */
110 	if (id[1] != SPINAND_MFR_ETRON)
111 		return 0;
112 
113 	ret = spinand_match_and_init(spinand, etron_spinand_table,
114 				     ARRAY_SIZE(etron_spinand_table), id[2]);
115 	if (ret)
116 		return ret;
117 
118 	return 1;
119 }
120 
121 static const struct spinand_manufacturer_ops etron_spinand_manuf_ops = {
122 	.detect = etron_spinand_detect,
123 };
124 
125 const struct spinand_manufacturer etron_spinand_manufacturer = {
126 	.id = SPINAND_MFR_ETRON,
127 	.name = "Etron",
128 	.ops = &etron_spinand_manuf_ops,
129 };
130