drivers/mtd/nand/spi/micron.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Copyright (c) 2016-2017 Micron Technology, Inc.
   4  *
   5  * Authors:
   6  *      Peter Pan <peterpandong@micron.com>
   7  */
   8
   9 #ifndef __UBOOT__
  10 #include <malloc.h>
  11 #include <linux/device.h>
  12 #include <linux/kernel.h>
  13 #endif
  14 #include <linux/mtd/spinand.h>
  15
  16 #define SPINAND_MFR_MICRON              0x2c
  17
  18 #define MICRON_STATUS_ECC_MASK          GENMASK(7, 4)
  19 #define MICRON_STATUS_ECC_NO_BITFLIPS   (0 << 4)
  20 #define MICRON_STATUS_ECC_1TO3_BITFLIPS (1 << 4)
  21 #define MICRON_STATUS_ECC_4TO6_BITFLIPS (3 << 4)
  22 #define MICRON_STATUS_ECC_7TO8_BITFLIPS (5 << 4)
  23
  24 static SPINAND_OP_VARIANTS(read_cache_variants,
  25                 SPINAND_PAGE_READ_FROM_CACHE_QUADIO_OP(0, 2, NULL, 0),
  26                 SPINAND_PAGE_READ_FROM_CACHE_X4_OP(0, 1, NULL, 0),
  27                 SPINAND_PAGE_READ_FROM_CACHE_DUALIO_OP(0, 1, NULL, 0),
  28                 SPINAND_PAGE_READ_FROM_CACHE_X2_OP(0, 1, NULL, 0),
  29                 SPINAND_PAGE_READ_FROM_CACHE_OP(true, 0, 1, NULL, 0),
  30                 SPINAND_PAGE_READ_FROM_CACHE_OP(false, 0, 1, NULL, 0));
  31
  32 static SPINAND_OP_VARIANTS(write_cache_variants,
  33                 SPINAND_PROG_LOAD_X4(true, 0, NULL, 0),
  34                 SPINAND_PROG_LOAD(true, 0, NULL, 0));
  35
  36 static SPINAND_OP_VARIANTS(update_cache_variants,
  37                 SPINAND_PROG_LOAD_X4(false, 0, NULL, 0),
  38                 SPINAND_PROG_LOAD(false, 0, NULL, 0));
  39
  40 static int mt29f2g01abagd_ooblayout_ecc(struct mtd_info *mtd, int section,
  41                                         struct mtd_oob_region *region)
  42 {
  43         if (section)
  44                 return -ERANGE;
  45
  46         region->offset = 64;
  47         region->length = 64;
  48
  49         return 0;
  50 }
  51
  52 static int mt29f2g01abagd_ooblayout_free(struct mtd_info *mtd, int section,
  53                                          struct mtd_oob_region *region)
  54 {
  55         if (section)
  56                 return -ERANGE;
  57
  58         /* Reserve 2 bytes for the BBM. */
  59         region->offset = 2;
  60         region->length = 62;
  61
  62         return 0;
  63 }
  64
  65 static const struct mtd_ooblayout_ops mt29f2g01abagd_ooblayout = {
  66         .ecc = mt29f2g01abagd_ooblayout_ecc,
  67         .rfree = mt29f2g01abagd_ooblayout_free,
  68 };
  69
  70 static int mt29f2g01abagd_ecc_get_status(struct spinand_device *spinand,
  71                                          u8 status)
  72 {
  73         switch (status & MICRON_STATUS_ECC_MASK) {
  74         case STATUS_ECC_NO_BITFLIPS:
  75                 return 0;
  76
  77         case STATUS_ECC_UNCOR_ERROR:
  78                 return -EBADMSG;
  79
  80         case MICRON_STATUS_ECC_1TO3_BITFLIPS:
  81                 return 3;
  82
  83         case MICRON_STATUS_ECC_4TO6_BITFLIPS:
  84                 return 6;
  85
  86         case MICRON_STATUS_ECC_7TO8_BITFLIPS:
  87                 return 8;
  88
  89         default:
  90                 break;
  91         }
  92
  93         return -EINVAL;
  94 }
  95
  96 static const struct spinand_info micron_spinand_table[] = {
  97         SPINAND_INFO("MT29F2G01ABAGD", 0x24,
  98                      NAND_MEMORG(1, 2048, 128, 64, 2048, 2, 1, 1),
  99                      NAND_ECCREQ(8, 512),
 100                      SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
 101                                               &write_cache_variants,
 102                                               &update_cache_variants),
 103                      0,
 104                      SPINAND_ECCINFO(&mt29f2g01abagd_ooblayout,
 105                                      mt29f2g01abagd_ecc_get_status)),
 106 };
 107
 108 static int micron_spinand_detect(struct spinand_device *spinand)
 109 {
 110         u8 *id = spinand->id.data;
 111         int ret;
 112
 113         /*
 114          * Micron SPI NAND read ID need a dummy byte,
 115          * so the first byte in raw_id is dummy.
 116          */
 117         if (id[1] != SPINAND_MFR_MICRON)
 118                 return 0;
 119
 120         ret = spinand_match_and_init(spinand, micron_spinand_table,
 121                                      ARRAY_SIZE(micron_spinand_table), id[2]);
 122         if (ret)
 123                 return ret;
 124
 125         return 1;
 126 }
 127
 128 static const struct spinand_manufacturer_ops micron_spinand_manuf_ops = {
 129         .detect = micron_spinand_detect,
 130 };
 131
 132 const struct spinand_manufacturer micron_spinand_manufacturer = {
 133         .id = SPINAND_MFR_MICRON,
 134         .name = "Micron",
 135         .ops = &micron_spinand_manuf_ops,
 136 };