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
 135         instr->state = MTD_ERASING;
 136         addr &= ~(mtd->erasesize - 1); /* get lower aligned address */
 137         while (addr < end) {
 138                 sect = addr / mtd->erasesize;
 139                 sect <<= 8;
 140                 sect |= QUADSPI_MEM_OP_SECTOR_ERASE;
 141                 debug("erase %08x\n", sect);
 142                 writel(sect, &regs->mem_op);
 143                 stat = readl(&regs->isr);
 144                 if (stat & QUADSPI_ISR_ILLEGAL_ERASE) {
 145                         /* erase failed, sector might be protected */
 146                         debug("erase %08x fail %x\n", sect, stat);
 147                         writel(stat, &regs->isr); /* clear isr */
 148                         instr->fail_addr = addr;
 149                         instr->state = MTD_ERASE_FAILED;
 150                         mtd_erase_callback(instr);
 151                         return -EIO;
 152                 }
 153                 addr += mtd->erasesize;
 154         }
 155         instr->state = MTD_ERASE_DONE;
 156         mtd_erase_callback(instr);
 157
 158         return 0;
 159 }
 160
 161 static int altera_qspi_read(struct mtd_info *mtd, loff_t from, size_t len,
 162                             size_t *retlen, u_char *buf)
 163 {
 164         struct udevice *dev = mtd->dev;
 165         struct altera_qspi_platdata *pdata = dev_get_platdata(dev);
 166
 167         memcpy_fromio(buf, pdata->base + from, len);
 168         *retlen = len;
 169
 170         return 0;
 171 }
 172
 173 static int altera_qspi_write(struct mtd_info *mtd, loff_t to, size_t len,
 174                              size_t *retlen, const u_char *buf)
 175 {
 176         struct udevice *dev = mtd->dev;
 177         struct altera_qspi_platdata *pdata = dev_get_platdata(dev);
 178         struct altera_qspi_regs *regs = pdata->regs;
 179         u32 stat;
 180
 181         memcpy_toio(pdata->base + to, buf, len);
 182         /* check whether write triggered a illegal write interrupt */
 183         stat = readl(&regs->isr);
 184         if (stat & QUADSPI_ISR_ILLEGAL_WRITE) {
 185                 /* write failed, sector might be protected */
 186                 debug("write fail %x\n", stat);
 187                 writel(stat, &regs->isr); /* clear isr */
 188                 return -EIO;
 189         }
 190         *retlen = len;
 191
 192         return 0;
 193 }
 194
 195 static void altera_qspi_sync(struct mtd_info *mtd)
 196 {
 197 }
 198
 199 static void altera_qspi_get_locked_range(struct mtd_info *mtd, loff_t *ofs,
 200                                          uint64_t *len)
 201 {
 202         struct udevice *dev = mtd->dev;
 203         struct altera_qspi_platdata *pdata = dev_get_platdata(dev);
 204         struct altera_qspi_regs *regs = pdata->regs;
 205         int shift0 = ffs(QUADSPI_SR_BP2_0) - 1;
 206         int shift3 = ffs(QUADSPI_SR_BP3) - 1 - 3;
 207         u32 stat = readl(&regs->rd_status);
 208         unsigned pow = ((stat & QUADSPI_SR_BP2_0) >> shift0) |
 209                 ((stat & QUADSPI_SR_BP3) >> shift3);
 210
 211         *ofs = 0;
 212         *len = 0;
 213         if (pow) {
 214                 *len = mtd->erasesize << (pow - 1);
 215                 if (*len > mtd->size)
 216                         *len = mtd->size;
 217                 if (!(stat & QUADSPI_SR_TB))
 218                         *ofs = mtd->size - *len;
 219         }
 220 }
 221
 222 static int altera_qspi_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
 223 {
 224         struct udevice *dev = mtd->dev;
 225         struct altera_qspi_platdata *pdata = dev_get_platdata(dev);
 226         struct altera_qspi_regs *regs = pdata->regs;
 227         u32 sector_start, sector_end;
 228         u32 num_sectors;
 229         u32 mem_op;
 230         u32 sr_bp;
 231         u32 sr_tb;
 232
 233         num_sectors = mtd->size / mtd->erasesize;
 234         sector_start = ofs / mtd->erasesize;
 235         sector_end = (ofs + len) / mtd->erasesize;
 236
 237         if (sector_start >= num_sectors / 2) {
 238                 sr_bp = fls(num_sectors - 1 - sector_start) + 1;
 239                 sr_tb = 0;
 240         } else if (sector_end < num_sectors / 2) {
 241                 sr_bp = fls(sector_end) + 1;
 242                 sr_tb = 1;
 243         } else {
 244                 sr_bp = 15;
 245                 sr_tb = 0;
 246         }
 247
 248         mem_op = (sr_tb << 12) | (sr_bp << 8);
 249         mem_op |= QUADSPI_MEM_OP_SECTOR_PROTECT;
 250         debug("lock %08x\n", mem_op);
 251         writel(mem_op, &regs->mem_op);
 252
 253         return 0;
 254 }
 255
 256 static int altera_qspi_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
 257 {
 258         struct udevice *dev = mtd->dev;
 259         struct altera_qspi_platdata *pdata = dev_get_platdata(dev);
 260         struct altera_qspi_regs *regs = pdata->regs;
 261         u32 mem_op;
 262
 263         mem_op = QUADSPI_MEM_OP_SECTOR_PROTECT;
 264         debug("unlock %08x\n", mem_op);
 265         writel(mem_op, &regs->mem_op);
 266
 267         return 0;
 268 }
 269
 270 static int altera_qspi_probe(struct udevice *dev)
 271 {
 272         struct altera_qspi_platdata *pdata = dev_get_platdata(dev);
 273         struct altera_qspi_regs *regs = pdata->regs;
 274         unsigned long base = (unsigned long)pdata->base;
 275         struct mtd_info *mtd;
 276         flash_info_t *flash = &flash_info[0];
 277         u32 rdid;
 278         int i;
 279
 280         rdid = readl(&regs->rd_rdid);
 281         debug("rdid %x\n", rdid);
 282
 283         mtd = dev_get_uclass_priv(dev);
 284         mtd->dev = dev;
 285         mtd->name               = "nor0";
 286         mtd->type               = MTD_NORFLASH;
 287         mtd->flags              = MTD_CAP_NORFLASH;
 288         mtd->size               = 1 << ((rdid & 0xff) - 6);
 289         mtd->writesize          = 1;
 290         mtd->writebufsize       = mtd->writesize;
 291         mtd->_erase             = altera_qspi_erase;
 292         mtd->_read              = altera_qspi_read;
 293         mtd->_write             = altera_qspi_write;
 294         mtd->_sync              = altera_qspi_sync;
 295         mtd->_lock              = altera_qspi_lock;
 296         mtd->_unlock            = altera_qspi_unlock;
 297         mtd->numeraseregions = 0;
 298         mtd->erasesize = 0x10000;
 299         if (add_mtd_device(mtd))
 300                 return -ENOMEM;
 301
 302         flash->mtd = mtd;
 303         flash->size = mtd->size;
 304         flash->sector_count = mtd->size / mtd->erasesize;
 305         flash->flash_id = rdid;
 306         flash->start[0] = base;
 307         for (i = 1; i < flash->sector_count; i++)
 308                 flash->start[i] = flash->start[i - 1] + mtd->erasesize;
 309         gd->bd->bi_flashstart = base;
 310
 311         return 0;
 312 }
 313
 314 static int altera_qspi_ofdata_to_platdata(struct udevice *dev)
 315 {
 316         struct altera_qspi_platdata *pdata = dev_get_platdata(dev);
 317         void *blob = (void *)gd->fdt_blob;
 318         int node = dev->of_offset;
 319         const char *list, *end;
 320         const fdt32_t *cell;
 321         void *base;
 322         unsigned long addr, size;
 323         int parent, addrc, sizec;
 324         int len, idx;
 325
 326         /*
 327          * decode regs. there are multiple reg tuples, and they need to
 328          * match with reg-names.
 329          */
 330         parent = fdt_parent_offset(blob, node);
 331         of_bus_default_count_cells(blob, parent, &addrc, &sizec);
 332         list = fdt_getprop(blob, node, "reg-names", &len);
 333         if (!list)
 334                 return -ENOENT;
 335         end = list + len;
 336         cell = fdt_getprop(blob, node, "reg", &len);
 337         if (!cell)
 338                 return -ENOENT;
 339         idx = 0;
 340         while (list < end) {
 341                 addr = fdt_translate_address((void *)blob,
 342                                              node, cell + idx);
 343                 size = fdt_addr_to_cpu(cell[idx + addrc]);
 344                 base = map_physmem(addr, size, MAP_NOCACHE);
 345                 len = strlen(list);
 346                 if (strcmp(list, "avl_csr") == 0) {
 347                         pdata->regs = base;
 348                 } else if (strcmp(list, "avl_mem") == 0) {
 349                         pdata->base = base;
 350                         pdata->size = size;
 351                 }
 352                 idx += addrc + sizec;
 353                 list += (len + 1);
 354         }
 355
 356         return 0;
 357 }
 358
 359 static const struct udevice_id altera_qspi_ids[] = {
 360         { .compatible = "altr,quadspi-1.0" },
 361         {}
 362 };
 363
 364 U_BOOT_DRIVER(altera_qspi) = {
 365         .name   = "altera_qspi",
 366         .id     = UCLASS_MTD,
 367         .of_match = altera_qspi_ids,
 368         .ofdata_to_platdata = altera_qspi_ofdata_to_platdata,
 369         .platdata_auto_alloc_size = sizeof(struct altera_qspi_platdata),
 370         .probe  = altera_qspi_probe,
 371 };