nand/raw/nand_jedec.c

0001 // SPDX-License-Identifier: GPL-2.0
0002 /*
0003  *  Copyright (C) 2000 Steven J. Hill (sjhill@realitydiluted.com)
0004  *        2002-2006 Thomas Gleixner (tglx@linutronix.de)
0005  *
0006  *  Credits:
0007  *  David Woodhouse for adding multichip support
0008  *
0009  *  Aleph One Ltd. and Toby Churchill Ltd. for supporting the
0010  *  rework for 2K page size chips
0011  *
0012  * This file contains all ONFI helpers.
0013  */
0014
0015 #include <linux/slab.h>
0016
0017 #include "internals.h"
0018
0019 #define JEDEC_PARAM_PAGES 3
0020
0021 /*
0022  * Check if the NAND chip is JEDEC compliant, returns 1 if it is, 0 otherwise.
0023  */
0024 int nand_jedec_detect(struct nand_chip *chip)
0025 {
0026     struct nand_device *base = &chip->base;
0027     struct mtd_info *mtd = nand_to_mtd(chip);
0028     struct nand_memory_organization *memorg;
0029     struct nand_jedec_params *p;
0030     struct jedec_ecc_info *ecc;
0031     bool use_datain = false;
0032     int jedec_version = 0;
0033     char id[5];
0034     int i, val, ret;
0035     u16 crc;
0036
0037     memorg = nanddev_get_memorg(&chip->base);
0038
0039     /* Try JEDEC for unknown chip or LP */
0040     ret = nand_readid_op(chip, 0x40, id, sizeof(id));
0041     if (ret || strncmp(id, "JEDEC", sizeof(id)))
0042         return 0;
0043
0044     /* JEDEC chip: allocate a buffer to hold its parameter page */
0045     p = kzalloc(sizeof(*p), GFP_KERNEL);
0046     if (!p)
0047         return -ENOMEM;
0048
0049     if (!nand_has_exec_op(chip) ||
0050         !nand_read_data_op(chip, p, sizeof(*p), true, true))
0051         use_datain = true;
0052
0053     for (i = 0; i < JEDEC_PARAM_PAGES; i++) {
0054         if (!i)
0055             ret = nand_read_param_page_op(chip, 0x40, p,
0056                               sizeof(*p));
0057         else if (use_datain)
0058             ret = nand_read_data_op(chip, p, sizeof(*p), true,
0059                         false);
0060         else
0061             ret = nand_change_read_column_op(chip, sizeof(*p) * i,
0062                              p, sizeof(*p), true);
0063         if (ret) {
0064             ret = 0;
0065             goto free_jedec_param_page;
0066         }
0067
0068         crc = onfi_crc16(ONFI_CRC_BASE, (u8 *)p, 510);
0069         if (crc == le16_to_cpu(p->crc))
0070             break;
0071     }
0072
0073     if (i == JEDEC_PARAM_PAGES) {
0074         pr_err("Could not find valid JEDEC parameter page; aborting\n");
0075         goto free_jedec_param_page;
0076     }
0077
0078     /* Check version */
0079     val = le16_to_cpu(p->revision);
0080     if (val & (1 << 2))
0081         jedec_version = 10;
0082     else if (val & (1 << 1))
0083         jedec_version = 1; /* vendor specific version */
0084
0085     if (!jedec_version) {
0086         pr_info("unsupported JEDEC version: %d\n", val);
0087         goto free_jedec_param_page;
0088     }
0089
0090     sanitize_string(p->manufacturer, sizeof(p->manufacturer));
0091     sanitize_string(p->model, sizeof(p->model));
0092     chip->parameters.model = kstrdup(p->model, GFP_KERNEL);
0093     if (!chip->parameters.model) {
0094         ret = -ENOMEM;
0095         goto free_jedec_param_page;
0096     }
0097
0098     memorg->pagesize = le32_to_cpu(p->byte_per_page);
0099     mtd->writesize = memorg->pagesize;
0100
0101     /* Please reference to the comment for nand_flash_detect_onfi. */
0102     memorg->pages_per_eraseblock =
0103             1 << (fls(le32_to_cpu(p->pages_per_block)) - 1);
0104     mtd->erasesize = memorg->pages_per_eraseblock * memorg->pagesize;
0105
0106     memorg->oobsize = le16_to_cpu(p->spare_bytes_per_page);
0107     mtd->oobsize = memorg->oobsize;
0108
0109     memorg->luns_per_target = p->lun_count;
0110     memorg->planes_per_lun = 1 << p->multi_plane_addr;
0111
0112     /* Please reference to the comment for nand_flash_detect_onfi. */
0113     memorg->eraseblocks_per_lun =
0114         1 << (fls(le32_to_cpu(p->blocks_per_lun)) - 1);
0115     memorg->bits_per_cell = p->bits_per_cell;
0116
0117     if (le16_to_cpu(p->features) & JEDEC_FEATURE_16_BIT_BUS)
0118         chip->options |= NAND_BUSWIDTH_16;
0119
0120     /* ECC info */
0121     ecc = &p->ecc_info[0];
0122
0123     if (ecc->codeword_size >= 9) {
0124         struct nand_ecc_props requirements = {
0125             .strength = ecc->ecc_bits,
0126             .step_size = 1 << ecc->codeword_size,
0127         };
0128
0129         nanddev_set_ecc_requirements(base, &requirements);
0130     } else {
0131         pr_warn("Invalid codeword size\n");
0132     }
0133
0134     ret = 1;
0135
0136 free_jedec_param_page:
0137     kfree(p);
0138     return ret;
0139 }