drivers/mtd/nand/raw/mxs_nand_spl.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (C) 2014 Gateworks Corporation
   4  * Copyright 2019 NXP
   5  * Author: Tim Harvey <tharvey@gateworks.com>
   6  */
   7 #include <common.h>
   8 #include <log.h>
   9 #include <nand.h>
  10 #include <malloc.h>
  11 #include <mxs_nand.h>
  12 #include <asm/cache.h>
  13 #include <linux/err.h>
  14
  15 static struct mtd_info *mtd;
  16 static struct nand_chip nand_chip;
  17
  18 static void mxs_nand_command(struct mtd_info *mtd, unsigned int command,
  19                              int column, int page_addr)
  20 {
  21         register struct nand_chip *chip = mtd_to_nand(mtd);
  22         u32 timeo, time_start;
  23
  24         /* write out the command to the device */
  25         chip->cmd_ctrl(mtd, command, NAND_CLE);
  26
  27         /* Serially input address */
  28         if (column != -1) {
  29                 chip->cmd_ctrl(mtd, column, NAND_ALE);
  30                 chip->cmd_ctrl(mtd, column >> 8, NAND_ALE);
  31         }
  32         if (page_addr != -1) {
  33                 chip->cmd_ctrl(mtd, page_addr, NAND_ALE);
  34                 chip->cmd_ctrl(mtd, page_addr >> 8, NAND_ALE);
  35                 /* One more address cycle for devices > 128MiB */
  36                 if (chip->chipsize > (128 << 20))
  37                         chip->cmd_ctrl(mtd, page_addr >> 16, NAND_ALE);
  38         }
  39         chip->cmd_ctrl(mtd, NAND_CMD_NONE, 0);
  40
  41         if (command == NAND_CMD_READ0) {
  42                 chip->cmd_ctrl(mtd, NAND_CMD_READSTART, NAND_CLE);
  43                 chip->cmd_ctrl(mtd, NAND_CMD_NONE, 0);
  44         } else if (command == NAND_CMD_RNDOUT) {
  45                 /* No ready / busy check necessary */
  46                 chip->cmd_ctrl(mtd, NAND_CMD_RNDOUTSTART,
  47                                NAND_NCE | NAND_CLE);
  48                 chip->cmd_ctrl(mtd, NAND_CMD_NONE,
  49                                NAND_NCE);
  50         }
  51
  52         /* wait for nand ready */
  53         ndelay(100);
  54         timeo = (CONFIG_SYS_HZ * 20) / 1000;
  55         time_start = get_timer(0);
  56         while (get_timer(time_start) < timeo) {
  57                 if (chip->dev_ready(mtd))
  58                         break;
  59         }
  60 }
  61
  62 #if defined (CONFIG_SPL_NAND_IDENT)
  63
  64 /* Trying to detect the NAND flash using ONFi, JEDEC, and (extended) IDs */
  65 static int mxs_flash_full_ident(struct mtd_info *mtd)
  66 {
  67         int nand_maf_id, nand_dev_id;
  68         struct nand_chip *chip = mtd_to_nand(mtd);
  69         struct nand_flash_dev *type;
  70
  71         type = nand_get_flash_type(mtd, chip, &nand_maf_id, &nand_dev_id, NULL);
  72
  73         if (IS_ERR(type)) {
  74                 chip->select_chip(mtd, -1);
  75                 return PTR_ERR(type);
  76         }
  77
  78         return 0;
  79 }
  80
  81 #else
  82
  83 /* Trying to detect the NAND flash using ONFi only */
  84 static int mxs_flash_onfi_ident(struct mtd_info *mtd)
  85 {
  86         register struct nand_chip *chip = mtd_to_nand(mtd);
  87         int i;
  88         u8 mfg_id, dev_id;
  89         u8 id_data[8];
  90         struct nand_onfi_params *p = &chip->onfi_params;
  91
  92         /* Reset the chip */
  93         chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
  94
  95         /* Send the command for reading device ID */
  96         chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
  97
  98         /* Read manufacturer and device IDs */
  99         mfg_id = chip->read_byte(mtd);
 100         dev_id = chip->read_byte(mtd);
 101
 102         /* Try again to make sure */
 103         chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
 104         for (i = 0; i < 8; i++)
 105                 id_data[i] = chip->read_byte(mtd);
 106         if (id_data[0] != mfg_id || id_data[1] != dev_id) {
 107                 printf("second ID read did not match");
 108                 return -1;
 109         }
 110         debug("0x%02x:0x%02x ", mfg_id, dev_id);
 111
 112         /* read ONFI */
 113         chip->onfi_version = 0;
 114         chip->cmdfunc(mtd, NAND_CMD_READID, 0x20, -1);
 115         if (chip->read_byte(mtd) != 'O' || chip->read_byte(mtd) != 'N' ||
 116             chip->read_byte(mtd) != 'F' || chip->read_byte(mtd) != 'I') {
 117                 return -2;
 118         }
 119
 120         /* we have ONFI, probe it */
 121         chip->cmdfunc(mtd, NAND_CMD_PARAM, 0, -1);
 122         chip->read_buf(mtd, (uint8_t *)p, sizeof(*p));
 123         mtd->name = p->model;
 124         mtd->writesize = le32_to_cpu(p->byte_per_page);
 125         mtd->erasesize = le32_to_cpu(p->pages_per_block) * mtd->writesize;
 126         mtd->oobsize = le16_to_cpu(p->spare_bytes_per_page);
 127         chip->chipsize = le32_to_cpu(p->blocks_per_lun);
 128         chip->chipsize *= (uint64_t)mtd->erasesize * p->lun_count;
 129         /* Calculate the address shift from the page size */
 130         chip->page_shift = ffs(mtd->writesize) - 1;
 131         chip->phys_erase_shift = ffs(mtd->erasesize) - 1;
 132         /* Convert chipsize to number of pages per chip -1 */
 133         chip->pagemask = (chip->chipsize >> chip->page_shift) - 1;
 134         chip->badblockbits = 8;
 135
 136         debug("erasesize=%d (>>%d)\n", mtd->erasesize, chip->phys_erase_shift);
 137         debug("writesize=%d (>>%d)\n", mtd->writesize, chip->page_shift);
 138         debug("oobsize=%d\n", mtd->oobsize);
 139         debug("chipsize=%lld\n", chip->chipsize);
 140
 141         return 0;
 142 }
 143
 144 #endif /* CONFIG_SPL_NAND_IDENT */
 145
 146 static int mxs_flash_ident(struct mtd_info *mtd)
 147 {
 148         int ret;
 149 #if defined (CONFIG_SPL_NAND_IDENT)
 150         ret = mxs_flash_full_ident(mtd);
 151 #else
 152         ret = mxs_flash_onfi_ident(mtd);
 153 #endif
 154         return ret;
 155 }
 156
 157 static int mxs_read_page_ecc(struct mtd_info *mtd, void *buf, unsigned int page)
 158 {
 159         register struct nand_chip *chip = mtd_to_nand(mtd);
 160         int ret;
 161
 162         chip->cmdfunc(mtd, NAND_CMD_READ0, 0x0, page);
 163         ret = nand_chip.ecc.read_page(mtd, chip, buf, 1, page);
 164         if (ret < 0) {
 165                 printf("read_page failed %d\n", ret);
 166                 return -1;
 167         }
 168         return 0;
 169 }
 170
 171 static int is_badblock(struct mtd_info *mtd, loff_t offs, int allowbbt)
 172 {
 173         register struct nand_chip *chip = mtd_to_nand(mtd);
 174         unsigned int block = offs >> chip->phys_erase_shift;
 175         unsigned int page = offs >> chip->page_shift;
 176
 177         debug("%s offs=0x%08x block:%d page:%d\n", __func__, (int)offs, block,
 178               page);
 179         chip->cmdfunc(mtd, NAND_CMD_READ0, mtd->writesize, page);
 180         memset(chip->oob_poi, 0, mtd->oobsize);
 181         chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
 182
 183         return chip->oob_poi[0] != 0xff;
 184 }
 185
 186 /* setup mtd and nand structs and init mxs_nand driver */
 187 void nand_init(void)
 188 {
 189         /* return if already initalized */
 190         if (nand_chip.numchips)
 191                 return;
 192
 193         /* init mxs nand driver */
 194         mxs_nand_init_spl(&nand_chip);
 195         mtd = nand_to_mtd(&nand_chip);
 196         /* set mtd functions */
 197         nand_chip.cmdfunc = mxs_nand_command;
 198         nand_chip.scan_bbt = nand_default_bbt;
 199         nand_chip.numchips = 1;
 200
 201         /* identify flash device */
 202         if (mxs_flash_ident(mtd)) {
 203                 printf("Failed to identify\n");
 204                 nand_chip.numchips = 0; /* If fail, don't use nand */
 205                 return;
 206         }
 207
 208         /* allocate and initialize buffers */
 209         nand_chip.buffers = memalign(ARCH_DMA_MINALIGN,
 210                                      sizeof(*nand_chip.buffers));
 211         nand_chip.oob_poi = nand_chip.buffers->databuf + mtd->writesize;
 212         /* setup flash layout (does not scan as we override that) */
 213         mtd->size = nand_chip.chipsize;
 214         nand_chip.scan_bbt(mtd);
 215         mxs_nand_setup_ecc(mtd);
 216 }
 217
 218 int nand_spl_load_image(uint32_t offs, unsigned int size, void *buf)
 219 {
 220         struct nand_chip *chip;
 221         unsigned int page;
 222         unsigned int nand_page_per_block;
 223         unsigned int sz = 0;
 224         u8 *page_buf = NULL;
 225         u32 page_off;
 226
 227         chip = mtd_to_nand(mtd);
 228         if (!chip->numchips)
 229                 return -ENODEV;
 230
 231         page_buf = malloc(mtd->writesize);
 232         if (!page_buf)
 233                 return -ENOMEM;
 234
 235         page = offs >> chip->page_shift;
 236         page_off = offs & (mtd->writesize - 1);
 237         nand_page_per_block = mtd->erasesize / mtd->writesize;
 238
 239         debug("%s offset:0x%08x len:%d page:%x\n", __func__, offs, size, page);
 240
 241         while (size) {
 242                 if (mxs_read_page_ecc(mtd, page_buf, page) < 0)
 243                         return -1;
 244
 245                 if (size > (mtd->writesize - page_off))
 246                         sz = (mtd->writesize - page_off);
 247                 else
 248                         sz = size;
 249
 250                 memcpy(buf, page_buf + page_off, sz);
 251
 252                 offs += mtd->writesize;
 253                 page++;
 254                 buf += (mtd->writesize - page_off);
 255                 page_off = 0;
 256                 size -= sz;
 257
 258                 /*
 259                  * Check if we have crossed a block boundary, and if so
 260                  * check for bad block.
 261                  */
 262                 if (!(page % nand_page_per_block)) {
 263                         /*
 264                          * Yes, new block. See if this block is good. If not,
 265                          * loop until we find a good block.
 266                          */
 267                         while (is_badblock(mtd, offs, 1)) {
 268                                 page = page + nand_page_per_block;
 269                                 /* Check i we've reached the end of flash. */
 270                                 if (page >= mtd->size >> chip->page_shift) {
 271                                         free(page_buf);
 272                                         return -ENOMEM;
 273                                 }
 274                         }
 275                 }
 276         }
 277
 278         free(page_buf);
 279
 280         return 0;
 281 }
 282
 283 int nand_default_bbt(struct mtd_info *mtd)
 284 {
 285         return 0;
 286 }
 287
 288 void nand_deselect(void)
 289 {
 290 }
 291