1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * Copyright (C) 2019 Jeff Kletsky
4*4882a593Smuzhiyun *
5*4882a593Smuzhiyun * Author: Jeff Kletsky <git-commits@allycomm.com>
6*4882a593Smuzhiyun */
7*4882a593Smuzhiyun
8*4882a593Smuzhiyun #include <linux/device.h>
9*4882a593Smuzhiyun #include <linux/kernel.h>
10*4882a593Smuzhiyun #include <linux/mtd/spinand.h>
11*4882a593Smuzhiyun
12*4882a593Smuzhiyun
13*4882a593Smuzhiyun #define SPINAND_MFR_PARAGON 0xa1
14*4882a593Smuzhiyun
15*4882a593Smuzhiyun
16*4882a593Smuzhiyun #define PN26G0XA_STATUS_ECC_BITMASK (3 << 4)
17*4882a593Smuzhiyun
18*4882a593Smuzhiyun #define PN26G0XA_STATUS_ECC_NONE_DETECTED (0 << 4)
19*4882a593Smuzhiyun #define PN26G0XA_STATUS_ECC_1_7_CORRECTED (1 << 4)
20*4882a593Smuzhiyun #define PN26G0XA_STATUS_ECC_ERRORED (2 << 4)
21*4882a593Smuzhiyun #define PN26G0XA_STATUS_ECC_8_CORRECTED (3 << 4)
22*4882a593Smuzhiyun
23*4882a593Smuzhiyun
24*4882a593Smuzhiyun static SPINAND_OP_VARIANTS(read_cache_variants,
25*4882a593Smuzhiyun SPINAND_PAGE_READ_FROM_CACHE_QUADIO_OP(0, 2, NULL, 0),
26*4882a593Smuzhiyun SPINAND_PAGE_READ_FROM_CACHE_X4_OP(0, 1, NULL, 0),
27*4882a593Smuzhiyun SPINAND_PAGE_READ_FROM_CACHE_DUALIO_OP(0, 1, NULL, 0),
28*4882a593Smuzhiyun SPINAND_PAGE_READ_FROM_CACHE_X2_OP(0, 1, NULL, 0),
29*4882a593Smuzhiyun SPINAND_PAGE_READ_FROM_CACHE_OP(true, 0, 1, NULL, 0),
30*4882a593Smuzhiyun SPINAND_PAGE_READ_FROM_CACHE_OP(false, 0, 1, NULL, 0));
31*4882a593Smuzhiyun
32*4882a593Smuzhiyun static SPINAND_OP_VARIANTS(write_cache_variants,
33*4882a593Smuzhiyun SPINAND_PROG_LOAD_X4(true, 0, NULL, 0),
34*4882a593Smuzhiyun SPINAND_PROG_LOAD(true, 0, NULL, 0));
35*4882a593Smuzhiyun
36*4882a593Smuzhiyun static SPINAND_OP_VARIANTS(update_cache_variants,
37*4882a593Smuzhiyun SPINAND_PROG_LOAD_X4(false, 0, NULL, 0),
38*4882a593Smuzhiyun SPINAND_PROG_LOAD(false, 0, NULL, 0));
39*4882a593Smuzhiyun
40*4882a593Smuzhiyun
pn26g0xa_ooblayout_ecc(struct mtd_info * mtd,int section,struct mtd_oob_region * region)41*4882a593Smuzhiyun static int pn26g0xa_ooblayout_ecc(struct mtd_info *mtd, int section,
42*4882a593Smuzhiyun struct mtd_oob_region *region)
43*4882a593Smuzhiyun {
44*4882a593Smuzhiyun if (section > 3)
45*4882a593Smuzhiyun return -ERANGE;
46*4882a593Smuzhiyun
47*4882a593Smuzhiyun region->offset = 6 + (15 * section); /* 4 BBM + 2 user bytes */
48*4882a593Smuzhiyun region->length = 13;
49*4882a593Smuzhiyun
50*4882a593Smuzhiyun return 0;
51*4882a593Smuzhiyun }
52*4882a593Smuzhiyun
pn26g0xa_ooblayout_free(struct mtd_info * mtd,int section,struct mtd_oob_region * region)53*4882a593Smuzhiyun static int pn26g0xa_ooblayout_free(struct mtd_info *mtd, int section,
54*4882a593Smuzhiyun struct mtd_oob_region *region)
55*4882a593Smuzhiyun {
56*4882a593Smuzhiyun if (section > 4)
57*4882a593Smuzhiyun return -ERANGE;
58*4882a593Smuzhiyun
59*4882a593Smuzhiyun if (section == 4) {
60*4882a593Smuzhiyun region->offset = 64;
61*4882a593Smuzhiyun region->length = 64;
62*4882a593Smuzhiyun } else {
63*4882a593Smuzhiyun region->offset = 4 + (15 * section);
64*4882a593Smuzhiyun region->length = 2;
65*4882a593Smuzhiyun }
66*4882a593Smuzhiyun
67*4882a593Smuzhiyun return 0;
68*4882a593Smuzhiyun }
69*4882a593Smuzhiyun
pn26g0xa_ecc_get_status(struct spinand_device * spinand,u8 status)70*4882a593Smuzhiyun static int pn26g0xa_ecc_get_status(struct spinand_device *spinand,
71*4882a593Smuzhiyun u8 status)
72*4882a593Smuzhiyun {
73*4882a593Smuzhiyun switch (status & PN26G0XA_STATUS_ECC_BITMASK) {
74*4882a593Smuzhiyun case PN26G0XA_STATUS_ECC_NONE_DETECTED:
75*4882a593Smuzhiyun return 0;
76*4882a593Smuzhiyun
77*4882a593Smuzhiyun case PN26G0XA_STATUS_ECC_1_7_CORRECTED:
78*4882a593Smuzhiyun return 7; /* Return upper limit by convention */
79*4882a593Smuzhiyun
80*4882a593Smuzhiyun case PN26G0XA_STATUS_ECC_8_CORRECTED:
81*4882a593Smuzhiyun return 8;
82*4882a593Smuzhiyun
83*4882a593Smuzhiyun case PN26G0XA_STATUS_ECC_ERRORED:
84*4882a593Smuzhiyun return -EBADMSG;
85*4882a593Smuzhiyun
86*4882a593Smuzhiyun default:
87*4882a593Smuzhiyun break;
88*4882a593Smuzhiyun }
89*4882a593Smuzhiyun
90*4882a593Smuzhiyun return -EINVAL;
91*4882a593Smuzhiyun }
92*4882a593Smuzhiyun
93*4882a593Smuzhiyun static const struct mtd_ooblayout_ops pn26g0xa_ooblayout = {
94*4882a593Smuzhiyun .ecc = pn26g0xa_ooblayout_ecc,
95*4882a593Smuzhiyun .free = pn26g0xa_ooblayout_free,
96*4882a593Smuzhiyun };
97*4882a593Smuzhiyun
98*4882a593Smuzhiyun
99*4882a593Smuzhiyun static const struct spinand_info paragon_spinand_table[] = {
100*4882a593Smuzhiyun SPINAND_INFO("PN26G01A",
101*4882a593Smuzhiyun SPINAND_ID(SPINAND_READID_METHOD_OPCODE_DUMMY, 0xe1),
102*4882a593Smuzhiyun NAND_MEMORG(1, 2048, 128, 64, 1024, 21, 1, 1, 1),
103*4882a593Smuzhiyun NAND_ECCREQ(8, 512),
104*4882a593Smuzhiyun SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
105*4882a593Smuzhiyun &write_cache_variants,
106*4882a593Smuzhiyun &update_cache_variants),
107*4882a593Smuzhiyun 0,
108*4882a593Smuzhiyun SPINAND_ECCINFO(&pn26g0xa_ooblayout,
109*4882a593Smuzhiyun pn26g0xa_ecc_get_status)),
110*4882a593Smuzhiyun SPINAND_INFO("PN26G02A",
111*4882a593Smuzhiyun SPINAND_ID(SPINAND_READID_METHOD_OPCODE_DUMMY, 0xe2),
112*4882a593Smuzhiyun NAND_MEMORG(1, 2048, 128, 64, 2048, 41, 1, 1, 1),
113*4882a593Smuzhiyun NAND_ECCREQ(8, 512),
114*4882a593Smuzhiyun SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
115*4882a593Smuzhiyun &write_cache_variants,
116*4882a593Smuzhiyun &update_cache_variants),
117*4882a593Smuzhiyun 0,
118*4882a593Smuzhiyun SPINAND_ECCINFO(&pn26g0xa_ooblayout,
119*4882a593Smuzhiyun pn26g0xa_ecc_get_status)),
120*4882a593Smuzhiyun };
121*4882a593Smuzhiyun
122*4882a593Smuzhiyun static const struct spinand_manufacturer_ops paragon_spinand_manuf_ops = {
123*4882a593Smuzhiyun };
124*4882a593Smuzhiyun
125*4882a593Smuzhiyun const struct spinand_manufacturer paragon_spinand_manufacturer = {
126*4882a593Smuzhiyun .id = SPINAND_MFR_PARAGON,
127*4882a593Smuzhiyun .name = "Paragon",
128*4882a593Smuzhiyun .chips = paragon_spinand_table,
129*4882a593Smuzhiyun .nchips = ARRAY_SIZE(paragon_spinand_table),
130*4882a593Smuzhiyun .ops = ¶gon_spinand_manuf_ops,
131*4882a593Smuzhiyun };
132