drivers/mtd/nand/raw/nand_toshiba.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  * Copyright (C) 2017 Free Electrons
   4  * Copyright (C) 2017 NextThing Co
   5  *
   6  * Author: Boris Brezillon <boris.brezillon@free-electrons.com>
   7  */
   8
   9 #include "internals.h"
  10
  11 /* Bit for detecting BENAND */
  12 #define TOSHIBA_NAND_ID4_IS_BENAND              BIT(7)
  13
  14 /* Recommended to rewrite for BENAND */
  15 #define TOSHIBA_NAND_STATUS_REWRITE_RECOMMENDED BIT(3)
  16
  17 /* ECC Status Read Command for BENAND */
  18 #define TOSHIBA_NAND_CMD_ECC_STATUS_READ        0x7A
  19
  20 /* ECC Status Mask for BENAND */
  21 #define TOSHIBA_NAND_ECC_STATUS_MASK            0x0F
  22
  23 /* Uncorrectable Error for BENAND */
  24 #define TOSHIBA_NAND_ECC_STATUS_UNCORR          0x0F
  25
  26 /* Max ECC Steps for BENAND */
  27 #define TOSHIBA_NAND_MAX_ECC_STEPS              8
  28
  29 static int toshiba_nand_benand_read_eccstatus_op(struct nand_chip *chip,
  30                                                  u8 *buf)
  31 {
  32         u8 *ecc_status = buf;
  33
  34         if (nand_has_exec_op(chip)) {
  35                 const struct nand_sdr_timings *sdr =
  36                         nand_get_sdr_timings(nand_get_interface_config(chip));
  37                 struct nand_op_instr instrs[] = {
  38                         NAND_OP_CMD(TOSHIBA_NAND_CMD_ECC_STATUS_READ,
  39                                     PSEC_TO_NSEC(sdr->tADL_min)),
  40                         NAND_OP_8BIT_DATA_IN(chip->ecc.steps, ecc_status, 0),
  41                 };
  42                 struct nand_operation op = NAND_OPERATION(chip->cur_cs, instrs);
  43
  44                 return nand_exec_op(chip, &op);
  45         }
  46
  47         return -ENOTSUPP;
  48 }
  49
  50 static int toshiba_nand_benand_eccstatus(struct nand_chip *chip)
  51 {
  52         struct mtd_info *mtd = nand_to_mtd(chip);
  53         int ret;
  54         unsigned int max_bitflips = 0;
  55         u8 status, ecc_status[TOSHIBA_NAND_MAX_ECC_STEPS];
  56
  57         /* Check Status */
  58         ret = toshiba_nand_benand_read_eccstatus_op(chip, ecc_status);
  59         if (!ret) {
  60                 unsigned int i, bitflips = 0;
  61
  62                 for (i = 0; i < chip->ecc.steps; i++) {
  63                         bitflips = ecc_status[i] & TOSHIBA_NAND_ECC_STATUS_MASK;
  64                         if (bitflips == TOSHIBA_NAND_ECC_STATUS_UNCORR) {
  65                                 mtd->ecc_stats.failed++;
  66                         } else {
  67                                 mtd->ecc_stats.corrected += bitflips;
  68                                 max_bitflips = max(max_bitflips, bitflips);
  69                         }
  70                 }
  71
  72                 return max_bitflips;
  73         }
  74
  75         /*
  76          * Fallback to regular status check if
  77          * toshiba_nand_benand_read_eccstatus_op() failed.
  78          */
  79         ret = nand_status_op(chip, &status);
  80         if (ret)
  81                 return ret;
  82
  83         if (status & NAND_STATUS_FAIL) {
  84                 /* uncorrected */
  85                 mtd->ecc_stats.failed++;
  86         } else if (status & TOSHIBA_NAND_STATUS_REWRITE_RECOMMENDED) {
  87                 /* corrected */
  88                 max_bitflips = mtd->bitflip_threshold;
  89                 mtd->ecc_stats.corrected += max_bitflips;
  90         }
  91
  92         return max_bitflips;
  93 }
  94
  95 static int
  96 toshiba_nand_read_page_benand(struct nand_chip *chip, uint8_t *buf,
  97                               int oob_required, int page)
  98 {
  99         int ret;
 100
 101         ret = nand_read_page_raw(chip, buf, oob_required, page);
 102         if (ret)
 103                 return ret;
 104
 105         return toshiba_nand_benand_eccstatus(chip);
 106 }
 107
 108 static int
 109 toshiba_nand_read_subpage_benand(struct nand_chip *chip, uint32_t data_offs,
 110                                  uint32_t readlen, uint8_t *bufpoi, int page)
 111 {
 112         int ret;
 113
 114         ret = nand_read_page_op(chip, page, data_offs,
 115                                 bufpoi + data_offs, readlen);
 116         if (ret)
 117                 return ret;
 118
 119         return toshiba_nand_benand_eccstatus(chip);
 120 }
 121
 122 static void toshiba_nand_benand_init(struct nand_chip *chip)
 123 {
 124         struct mtd_info *mtd = nand_to_mtd(chip);
 125
 126         /*
 127          * On BENAND, the entire OOB region can be used by the MTD user.
 128          * The calculated ECC bytes are stored into other isolated
 129          * area which is not accessible to users.
 130          * This is why chip->ecc.bytes = 0.
 131          */
 132         chip->ecc.bytes = 0;
 133         chip->ecc.size = 512;
 134         chip->ecc.strength = 8;
 135         chip->ecc.read_page = toshiba_nand_read_page_benand;
 136         chip->ecc.read_subpage = toshiba_nand_read_subpage_benand;
 137         chip->ecc.write_page = nand_write_page_raw;
 138         chip->ecc.read_page_raw = nand_read_page_raw_notsupp;
 139         chip->ecc.write_page_raw = nand_write_page_raw_notsupp;
 140
 141         chip->options |= NAND_SUBPAGE_READ;
 142
 143         mtd_set_ooblayout(mtd, nand_get_large_page_ooblayout());
 144 }
 145
 146 static void toshiba_nand_decode_id(struct nand_chip *chip)
 147 {
 148         struct nand_device *base = &chip->base;
 149         struct nand_ecc_props requirements = {};
 150         struct mtd_info *mtd = nand_to_mtd(chip);
 151         struct nand_memory_organization *memorg;
 152
 153         memorg = nanddev_get_memorg(&chip->base);
 154
 155         nand_decode_ext_id(chip);
 156
 157         /*
 158          * Toshiba 24nm raw SLC (i.e., not BENAND) have 32B OOB per
 159          * 512B page. For Toshiba SLC, we decode the 5th/6th byte as
 160          * follows:
 161          * - ID byte 6, bits[2:0]: 100b -> 43nm, 101b -> 32nm,
 162          *                         110b -> 24nm
 163          * - ID byte 5, bit[7]:    1 -> BENAND, 0 -> raw SLC
 164          */
 165         if (chip->id.len >= 6 && nand_is_slc(chip) &&
 166             (chip->id.data[5] & 0x7) == 0x6 /* 24nm */ &&
 167             !(chip->id.data[4] & TOSHIBA_NAND_ID4_IS_BENAND) /* !BENAND */) {
 168                 memorg->oobsize = 32 * memorg->pagesize >> 9;
 169                 mtd->oobsize = memorg->oobsize;
 170         }
 171
 172         /*
 173          * Extract ECC requirements from 6th id byte.
 174          * For Toshiba SLC, ecc requrements are as follows:
 175          *  - 43nm: 1 bit ECC for each 512Byte is required.
 176          *  - 32nm: 4 bit ECC for each 512Byte is required.
 177          *  - 24nm: 8 bit ECC for each 512Byte is required.
 178          */
 179         if (chip->id.len >= 6 && nand_is_slc(chip)) {
 180                 requirements.step_size = 512;
 181                 switch (chip->id.data[5] & 0x7) {
 182                 case 0x4:
 183                         requirements.strength = 1;
 184                         break;
 185                 case 0x5:
 186                         requirements.strength = 4;
 187                         break;
 188                 case 0x6:
 189                         requirements.strength = 8;
 190                         break;
 191                 default:
 192                         WARN(1, "Could not get ECC info");
 193                         requirements.step_size = 0;
 194                         break;
 195                 }
 196         }
 197
 198         nanddev_set_ecc_requirements(base, &requirements);
 199 }
 200
 201 static int
 202 tc58teg5dclta00_choose_interface_config(struct nand_chip *chip,
 203                                         struct nand_interface_config *iface)
 204 {
 205         onfi_fill_interface_config(chip, iface, NAND_SDR_IFACE, 5);
 206
 207         return nand_choose_best_sdr_timings(chip, iface, NULL);
 208 }
 209
 210 static int
 211 tc58nvg0s3e_choose_interface_config(struct nand_chip *chip,
 212                                     struct nand_interface_config *iface)
 213 {
 214         onfi_fill_interface_config(chip, iface, NAND_SDR_IFACE, 2);
 215
 216         return nand_choose_best_sdr_timings(chip, iface, NULL);
 217 }
 218
 219 static int
 220 th58nvg2s3hbai4_choose_interface_config(struct nand_chip *chip,
 221                                         struct nand_interface_config *iface)
 222 {
 223         struct nand_sdr_timings *sdr = &iface->timings.sdr;
 224
 225         /* Start with timings from the closest timing mode, mode 4. */
 226         onfi_fill_interface_config(chip, iface, NAND_SDR_IFACE, 4);
 227
 228         /* Patch timings that differ from mode 4. */
 229         sdr->tALS_min = 12000;
 230         sdr->tCHZ_max = 20000;
 231         sdr->tCLS_min = 12000;
 232         sdr->tCOH_min = 0;
 233         sdr->tDS_min = 12000;
 234         sdr->tRHOH_min = 25000;
 235         sdr->tRHW_min = 30000;
 236         sdr->tRHZ_max = 60000;
 237         sdr->tWHR_min = 60000;
 238
 239         /* Patch timings not part of onfi timing mode. */
 240         sdr->tPROG_max = 700000000;
 241         sdr->tBERS_max = 5000000000;
 242
 243         return nand_choose_best_sdr_timings(chip, iface, sdr);
 244 }
 245
 246 static int tc58teg5dclta00_init(struct nand_chip *chip)
 247 {
 248         struct mtd_info *mtd = nand_to_mtd(chip);
 249
 250         chip->ops.choose_interface_config =
 251                 &tc58teg5dclta00_choose_interface_config;
 252         chip->options |= NAND_NEED_SCRAMBLING;
 253         mtd_set_pairing_scheme(mtd, &dist3_pairing_scheme);
 254
 255         return 0;
 256 }
 257
 258 static int tc58nvg0s3e_init(struct nand_chip *chip)
 259 {
 260         chip->ops.choose_interface_config =
 261                 &tc58nvg0s3e_choose_interface_config;
 262
 263         return 0;
 264 }
 265
 266 static int th58nvg2s3hbai4_init(struct nand_chip *chip)
 267 {
 268         chip->ops.choose_interface_config =
 269                 &th58nvg2s3hbai4_choose_interface_config;
 270
 271         return 0;
 272 }
 273
 274 static int toshiba_nand_init(struct nand_chip *chip)
 275 {
 276         if (nand_is_slc(chip))
 277                 chip->options |= NAND_BBM_FIRSTPAGE | NAND_BBM_SECONDPAGE;
 278
 279         /* Check that chip is BENAND and ECC mode is on-die */
 280         if (nand_is_slc(chip) &&
 281             chip->ecc.engine_type == NAND_ECC_ENGINE_TYPE_ON_DIE &&
 282             chip->id.data[4] & TOSHIBA_NAND_ID4_IS_BENAND)
 283                 toshiba_nand_benand_init(chip);
 284
 285         if (!strcmp("TC58TEG5DCLTA00", chip->parameters.model))
 286                 tc58teg5dclta00_init(chip);
 287         if (!strncmp("TC58NVG0S3E", chip->parameters.model,
 288                      sizeof("TC58NVG0S3E") - 1))
 289                 tc58nvg0s3e_init(chip);
 290         if (!strncmp("TH58NVG2S3HBAI4", chip->parameters.model,
 291                      sizeof("TH58NVG2S3HBAI4") - 1))
 292                 th58nvg2s3hbai4_init(chip);
 293
 294         return 0;
 295 }
 296
 297 const struct nand_manufacturer_ops toshiba_nand_manuf_ops = {
 298         .detect = toshiba_nand_decode_id,
 299         .init = toshiba_nand_init,
 300 };