git.sur5r.net Git - u-boot/blob - drivers/mtd/altera_qspi.c

   1 /*
   2  * Copyright (C) 2015 Thomas Chou <thomas@wytron.com.tw>
   3  *
   4  * SPDX-License-Identifier:     GPL-2.0+
   5  */
   6
   7 #include <common.h>
   8 #include <dm.h>
   9 #include <errno.h>
  10 #include <fdt_support.h>
  11 #include <flash.h>
  12 #include <mtd.h>
  13 #include <asm/io.h>
  14
  15 DECLARE_GLOBAL_DATA_PTR;
  16
  17 /* The STATUS register */
  18 #define QUADSPI_SR_BP0                          BIT(2)
  19 #define QUADSPI_SR_BP1                          BIT(3)
  20 #define QUADSPI_SR_BP2                          BIT(4)
  21 #define QUADSPI_SR_BP2_0                        GENMASK(4, 2)
  22 #define QUADSPI_SR_BP3                          BIT(6)
  23 #define QUADSPI_SR_TB                           BIT(5)
  24
  25 /*
  26  * The QUADSPI_MEM_OP register is used to do memory protect and erase operations
  27  */
  28 #define QUADSPI_MEM_OP_BULK_ERASE               0x00000001
  29 #define QUADSPI_MEM_OP_SECTOR_ERASE             0x00000002
  30 #define QUADSPI_MEM_OP_SECTOR_PROTECT           0x00000003
  31
  32 /*
  33  * The QUADSPI_ISR register is used to determine whether an invalid write or
  34  * erase operation trigerred an interrupt
  35  */
  36 #define QUADSPI_ISR_ILLEGAL_ERASE               BIT(0)
  37 #define QUADSPI_ISR_ILLEGAL_WRITE               BIT(1)
  38
  39 struct altera_qspi_regs {
  40         u32     rd_status;
  41         u32     rd_sid;
  42         u32     rd_rdid;
  43         u32     mem_op;
  44         u32     isr;
  45         u32     imr;
  46         u32     chip_select;
  47 };
  48
  49 struct altera_qspi_platdata {
  50         struct altera_qspi_regs *regs;
  51         void *base;
  52         unsigned long size;
  53 };
  54
  55 flash_info_t flash_info[CONFIG_SYS_MAX_FLASH_BANKS];    /* FLASH chips info */
  56
  57 static void altera_qspi_get_locked_range(struct mtd_info *mtd, loff_t *ofs,
  58                                          uint64_t *len);
  59
  60 void flash_print_info(flash_info_t *info)
  61 {
  62         struct mtd_info *mtd = info->mtd;
  63         loff_t ofs;
  64         u64 len;
  65
  66         printf("Altera QSPI flash  Size: %ld MB in %d Sectors\n",
  67                info->size >> 20, info->sector_count);
  68         altera_qspi_get_locked_range(mtd, &ofs, &len);
  69         printf("  %08lX +%lX", info->start[0], info->size);
  70         if (len) {
  71                 printf(", protected %08llX +%llX",
  72                        info->start[0] + ofs, len);
  73         }
  74         putc('\n');
  75 }
  76
  77 int flash_erase(flash_info_t *info, int s_first, int s_last)
  78 {
  79         struct mtd_info *mtd = info->mtd;
  80         struct erase_info instr;
  81         int ret;
  82
  83         memset(&instr, 0, sizeof(instr));
  84         instr.mtd = mtd;
  85         instr.addr = mtd->erasesize * s_first;
  86         instr.len = mtd->erasesize * (s_last + 1 - s_first);
  87         ret = mtd_erase(mtd, &instr);
  88         if (ret)
  89                 return ERR_PROTECTED;
  90
  91         return 0;
  92 }
  93
  94 int write_buff(flash_info_t *info, uchar *src, ulong addr, ulong cnt)
  95 {
  96         struct mtd_info *mtd = info->mtd;
  97         struct udevice *dev = mtd->dev;
  98         struct altera_qspi_platdata *pdata = dev_get_platdata(dev);
  99         ulong base = (ulong)pdata->base;
 100         loff_t to = addr - base;
 101         size_t retlen;
 102         int ret;
 103
 104         ret = mtd_write(mtd, to, cnt, &retlen, src);
 105         if (ret)
 106                 return ERR_PROTECTED;
 107
 108         return 0;
 109 }
 110
 111 unsigned long flash_init(void)
 112 {
 113         struct udevice *dev;
 114
 115         /* probe every MTD device */
 116         for (uclass_first_device(UCLASS_MTD, &dev);
 117              dev;
 118              uclass_next_device(&dev)) {
 119         }
 120
 121         return flash_info[0].size;
 122 }
 123
 124 static int altera_qspi_erase(struct mtd_info *mtd, struct erase_info *instr)
 125 {
 126         struct udevice *dev = mtd->dev;
 127         struct altera_qspi_platdata *pdata = dev_get_platdata(dev);
 128         struct altera_qspi_regs *regs = pdata->regs;
 129         size_t addr = instr->addr;
 130         size_t len = instr->len;
 131         size_t end = addr + len;
 132         u32 sect;
 133         u32 stat;
 134         u32 *flash, *last;
 135
 136         instr->state = MTD_ERASING;
 137         addr &= ~(mtd->erasesize - 1); /* get lower aligned address */
 138         while (addr < end) {
 139                 flash = pdata->base + addr;
 140                 last = pdata->base + addr + mtd->erasesize;
 141                 /* skip erase if sector is blank */
 142                 while (flash < last) {
 143                         if (readl(flash) != 0xffffffff)
 144                                 break;
 145                         flash++;
 146                 }
 147                 if (flash < last) {
 148                         sect = addr / mtd->erasesize;
 149                         sect <<= 8;
 150                         sect |= QUADSPI_MEM_OP_SECTOR_ERASE;
 151                         debug("erase %08x\n", sect);
 152                         writel(sect, &regs->mem_op);
 153                         stat = readl(&regs->isr);
 154                         if (stat & QUADSPI_ISR_ILLEGAL_ERASE) {
 155                                 /* erase failed, sector might be protected */
 156                                 debug("erase %08x fail %x\n", sect, stat);
 157                                 writel(stat, &regs->isr); /* clear isr */
 158                                 instr->fail_addr = addr;
 159                                 instr->state = MTD_ERASE_FAILED;
 160                                 mtd_erase_callback(instr);
 161                                 return -EIO;
 162                         }
 163                 }
 164                 addr += mtd->erasesize;
 165         }
 166         instr->state = MTD_ERASE_DONE;
 167         mtd_erase_callback(instr);
 168
 169         return 0;
 170 }
 171
 172 static int altera_qspi_read(struct mtd_info *mtd, loff_t from, size_t len,
 173                             size_t *retlen, u_char *buf)
 174 {
 175         struct udevice *dev = mtd->dev;
 176         struct altera_qspi_platdata *pdata = dev_get_platdata(dev);
 177
 178         memcpy_fromio(buf, pdata->base + from, len);
 179         *retlen = len;
 180
 181         return 0;
 182 }
 183
 184 static int altera_qspi_write(struct mtd_info *mtd, loff_t to, size_t len,
 185                              size_t *retlen, const u_char *buf)
 186 {
 187         struct udevice *dev = mtd->dev;
 188         struct altera_qspi_platdata *pdata = dev_get_platdata(dev);
 189         struct altera_qspi_regs *regs = pdata->regs;
 190         u32 stat;
 191
 192         memcpy_toio(pdata->base + to, buf, len);
 193         /* check whether write triggered a illegal write interrupt */
 194         stat = readl(&regs->isr);
 195         if (stat & QUADSPI_ISR_ILLEGAL_WRITE) {
 196                 /* write failed, sector might be protected */
 197                 debug("write fail %x\n", stat);
 198                 writel(stat, &regs->isr); /* clear isr */
 199                 return -EIO;
 200         }
 201         *retlen = len;
 202
 203         return 0;
 204 }
 205
 206 static void altera_qspi_sync(struct mtd_info *mtd)
 207 {
 208 }
 209
 210 static void altera_qspi_get_locked_range(struct mtd_info *mtd, loff_t *ofs,
 211                                          uint64_t *len)
 212 {
 213         struct udevice *dev = mtd->dev;
 214         struct altera_qspi_platdata *pdata = dev_get_platdata(dev);
 215         struct altera_qspi_regs *regs = pdata->regs;
 216         int shift0 = ffs(QUADSPI_SR_BP2_0) - 1;
 217         int shift3 = ffs(QUADSPI_SR_BP3) - 1 - 3;
 218         u32 stat = readl(&regs->rd_status);
 219         unsigned pow = ((stat & QUADSPI_SR_BP2_0) >> shift0) |
 220                 ((stat & QUADSPI_SR_BP3) >> shift3);
 221
 222         *ofs = 0;
 223         *len = 0;
 224         if (pow) {
 225                 *len = mtd->erasesize << (pow - 1);
 226                 if (*len > mtd->size)
 227                         *len = mtd->size;
 228                 if (!(stat & QUADSPI_SR_TB))
 229                         *ofs = mtd->size - *len;
 230         }
 231 }
 232
 233 static int altera_qspi_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
 234 {
 235         struct udevice *dev = mtd->dev;
 236         struct altera_qspi_platdata *pdata = dev_get_platdata(dev);
 237         struct altera_qspi_regs *regs = pdata->regs;
 238         u32 sector_start, sector_end;
 239         u32 num_sectors;
 240         u32 mem_op;
 241         u32 sr_bp;
 242         u32 sr_tb;
 243
 244         num_sectors = mtd->size / mtd->erasesize;
 245         sector_start = ofs / mtd->erasesize;
 246         sector_end = (ofs + len) / mtd->erasesize;
 247
 248         if (sector_start >= num_sectors / 2) {
 249                 sr_bp = fls(num_sectors - 1 - sector_start) + 1;
 250                 sr_tb = 0;
 251         } else if (sector_end < num_sectors / 2) {
 252                 sr_bp = fls(sector_end) + 1;
 253                 sr_tb = 1;
 254         } else {
 255                 sr_bp = 15;
 256                 sr_tb = 0;
 257         }
 258
 259         mem_op = (sr_tb << 12) | (sr_bp << 8);
 260         mem_op |= QUADSPI_MEM_OP_SECTOR_PROTECT;
 261         debug("lock %08x\n", mem_op);
 262         writel(mem_op, &regs->mem_op);
 263
 264         return 0;
 265 }
 266
 267 static int altera_qspi_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
 268 {
 269         struct udevice *dev = mtd->dev;
 270         struct altera_qspi_platdata *pdata = dev_get_platdata(dev);
 271         struct altera_qspi_regs *regs = pdata->regs;
 272         u32 mem_op;
 273
 274         mem_op = QUADSPI_MEM_OP_SECTOR_PROTECT;
 275         debug("unlock %08x\n", mem_op);
 276         writel(mem_op, &regs->mem_op);
 277
 278         return 0;
 279 }
 280
 281 static int altera_qspi_probe(struct udevice *dev)
 282 {
 283         struct altera_qspi_platdata *pdata = dev_get_platdata(dev);
 284         struct altera_qspi_regs *regs = pdata->regs;
 285         unsigned long base = (unsigned long)pdata->base;
 286         struct mtd_info *mtd;
 287         flash_info_t *flash = &flash_info[0];
 288         u32 rdid;
 289         int i;
 290
 291         rdid = readl(&regs->rd_rdid);
 292         debug("rdid %x\n", rdid);
 293
 294         mtd = dev_get_uclass_priv(dev);
 295         mtd->dev = dev;
 296         mtd->name               = "nor0";
 297         mtd->type               = MTD_NORFLASH;
 298         mtd->flags              = MTD_CAP_NORFLASH;
 299         mtd->size               = 1 << ((rdid & 0xff) - 6);
 300         mtd->writesize          = 1;
 301         mtd->writebufsize       = mtd->writesize;
 302         mtd->_erase             = altera_qspi_erase;
 303         mtd->_read              = altera_qspi_read;
 304         mtd->_write             = altera_qspi_write;
 305         mtd->_sync              = altera_qspi_sync;
 306         mtd->_lock              = altera_qspi_lock;
 307         mtd->_unlock            = altera_qspi_unlock;
 308         mtd->numeraseregions = 0;
 309         mtd->erasesize = 0x10000;
 310         if (add_mtd_device(mtd))
 311                 return -ENOMEM;
 312
 313         flash->mtd = mtd;
 314         flash->size = mtd->size;
 315         flash->sector_count = mtd->size / mtd->erasesize;
 316         flash->flash_id = rdid;
 317         flash->start[0] = base;
 318         for (i = 1; i < flash->sector_count; i++)
 319                 flash->start[i] = flash->start[i - 1] + mtd->erasesize;
 320         gd->bd->bi_flashstart = base;
 321
 322         return 0;
 323 }
 324
 325 static int altera_qspi_ofdata_to_platdata(struct udevice *dev)
 326 {
 327         struct altera_qspi_platdata *pdata = dev_get_platdata(dev);
 328         void *blob = (void *)gd->fdt_blob;
 329         int node = dev->of_offset;
 330         const char *list, *end;
 331         const fdt32_t *cell;
 332         void *base;
 333         unsigned long addr, size;
 334         int parent, addrc, sizec;
 335         int len, idx;
 336
 337         /*
 338          * decode regs. there are multiple reg tuples, and they need to
 339          * match with reg-names.
 340          */
 341         parent = fdt_parent_offset(blob, node);
 342         of_bus_default_count_cells(blob, parent, &addrc, &sizec);
 343         list = fdt_getprop(blob, node, "reg-names", &len);
 344         if (!list)
 345                 return -ENOENT;
 346         end = list + len;
 347         cell = fdt_getprop(blob, node, "reg", &len);
 348         if (!cell)
 349                 return -ENOENT;
 350         idx = 0;
 351         while (list < end) {
 352                 addr = fdt_translate_address((void *)blob,
 353                                              node, cell + idx);
 354                 size = fdt_addr_to_cpu(cell[idx + addrc]);
 355                 base = map_physmem(addr, size, MAP_NOCACHE);
 356                 len = strlen(list);
 357                 if (strcmp(list, "avl_csr") == 0) {
 358                         pdata->regs = base;
 359                 } else if (strcmp(list, "avl_mem") == 0) {
 360                         pdata->base = base;
 361                         pdata->size = size;
 362                 }
 363                 idx += addrc + sizec;
 364                 list += (len + 1);
 365         }
 366
 367         return 0;
 368 }
 369
 370 static const struct udevice_id altera_qspi_ids[] = {
 371         { .compatible = "altr,quadspi-1.0" },
 372         {}
 373 };
 374
 375 U_BOOT_DRIVER(altera_qspi) = {
 376         .name   = "altera_qspi",
 377         .id     = UCLASS_MTD,
 378         .of_match = altera_qspi_ids,
 379         .ofdata_to_platdata = altera_qspi_ofdata_to_platdata,
 380         .platdata_auto_alloc_size = sizeof(struct altera_qspi_platdata),
 381         .probe  = altera_qspi_probe,
 382 };