drivers/mtd/spi/sf_ops.c

   1 /*
   2  * SPI flash operations
   3  *
   4  * Copyright (C) 2008 Atmel Corporation
   5  * Copyright (C) 2010 Reinhard Meyer, EMK Elektronik
   6  * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
   7  *
   8  * SPDX-License-Identifier:     GPL-2.0+
   9  */
  10
  11 #include <common.h>
  12 #include <spi.h>
  13 #include <spi_flash.h>
  14 #include <watchdog.h>
  15
  16 #include "sf_internal.h"
  17
  18 static void spi_flash_addr(u32 addr, u8 *cmd)
  19 {
  20         /* cmd[0] is actual command */
  21         cmd[1] = addr >> 16;
  22         cmd[2] = addr >> 8;
  23         cmd[3] = addr >> 0;
  24 }
  25
  26 int spi_flash_cmd_write_status(struct spi_flash *flash, u8 sr)
  27 {
  28         u8 cmd;
  29         int ret;
  30
  31         cmd = CMD_WRITE_STATUS;
  32         ret = spi_flash_write_common(flash, &cmd, 1, &sr, 1);
  33         if (ret < 0) {
  34                 debug("SF: fail to write status register\n");
  35                 return ret;
  36         }
  37
  38         return 0;
  39 }
  40
  41 #ifdef CONFIG_SPI_FLASH_BAR
  42 static int spi_flash_cmd_bankaddr_write(struct spi_flash *flash, u8 bank_sel)
  43 {
  44         u8 cmd;
  45         int ret;
  46
  47         if (flash->bank_curr == bank_sel) {
  48                 debug("SF: not require to enable bank%d\n", bank_sel);
  49                 return 0;
  50         }
  51
  52         cmd = flash->bank_write_cmd;
  53         ret = spi_flash_write_common(flash, &cmd, 1, &bank_sel, 1);
  54         if (ret < 0) {
  55                 debug("SF: fail to write bank register\n");
  56                 return ret;
  57         }
  58         flash->bank_curr = bank_sel;
  59
  60         return 0;
  61 }
  62
  63 static int spi_flash_bank(struct spi_flash *flash, u32 offset)
  64 {
  65         u8 bank_sel;
  66         int ret;
  67
  68         bank_sel = offset / SPI_FLASH_16MB_BOUN;
  69
  70         ret = spi_flash_cmd_bankaddr_write(flash, bank_sel);
  71         if (ret) {
  72                 debug("SF: fail to set bank%d\n", bank_sel);
  73                 return ret;
  74         }
  75
  76         return 0;
  77 }
  78 #endif
  79
  80 int spi_flash_cmd_wait_ready(struct spi_flash *flash, unsigned long timeout)
  81 {
  82         struct spi_slave *spi = flash->spi;
  83         unsigned long timebase;
  84         int ret;
  85         u8 status;
  86         u8 check_status = 0x0;
  87         u8 poll_bit = STATUS_WIP;
  88         u8 cmd = flash->poll_cmd;
  89
  90         if (cmd == CMD_FLAG_STATUS) {
  91                 poll_bit = STATUS_PEC;
  92                 check_status = poll_bit;
  93         }
  94
  95         ret = spi_xfer(spi, 8, &cmd, NULL, SPI_XFER_BEGIN);
  96         if (ret) {
  97                 debug("SF: fail to read %s status register\n",
  98                       cmd == CMD_READ_STATUS ? "read" : "flag");
  99                 return ret;
 100         }
 101
 102         timebase = get_timer(0);
 103         do {
 104                 WATCHDOG_RESET();
 105
 106                 ret = spi_xfer(spi, 8, NULL, &status, 0);
 107                 if (ret)
 108                         return -1;
 109
 110                 if ((status & poll_bit) == check_status)
 111                         break;
 112
 113         } while (get_timer(timebase) < timeout);
 114
 115         spi_xfer(spi, 0, NULL, NULL, SPI_XFER_END);
 116
 117         if ((status & poll_bit) == check_status)
 118                 return 0;
 119
 120         /* Timed out */
 121         debug("SF: time out!\n");
 122         return -1;
 123 }
 124
 125 int spi_flash_write_common(struct spi_flash *flash, const u8 *cmd,
 126                 size_t cmd_len, const void *buf, size_t buf_len)
 127 {
 128         struct spi_slave *spi = flash->spi;
 129         unsigned long timeout = SPI_FLASH_PROG_TIMEOUT;
 130         int ret;
 131
 132         if (buf == NULL)
 133                 timeout = SPI_FLASH_PAGE_ERASE_TIMEOUT;
 134
 135         ret = spi_claim_bus(flash->spi);
 136         if (ret) {
 137                 debug("SF: unable to claim SPI bus\n");
 138                 return ret;
 139         }
 140
 141         ret = spi_flash_cmd_write_enable(flash);
 142         if (ret < 0) {
 143                 debug("SF: enabling write failed\n");
 144                 return ret;
 145         }
 146
 147         ret = spi_flash_cmd_write(spi, cmd, cmd_len, buf, buf_len);
 148         if (ret < 0) {
 149                 debug("SF: write cmd failed\n");
 150                 return ret;
 151         }
 152
 153         ret = spi_flash_cmd_wait_ready(flash, timeout);
 154         if (ret < 0) {
 155                 debug("SF: write %s timed out\n",
 156                       timeout == SPI_FLASH_PROG_TIMEOUT ?
 157                         "program" : "page erase");
 158                 return ret;
 159         }
 160
 161         spi_release_bus(spi);
 162
 163         return ret;
 164 }
 165
 166 int spi_flash_cmd_erase_ops(struct spi_flash *flash, u32 offset, size_t len)
 167 {
 168         u32 erase_size;
 169         u8 cmd[4];
 170         int ret = -1;
 171
 172         erase_size = flash->erase_size;
 173         if (offset % erase_size || len % erase_size) {
 174                 debug("SF: Erase offset/length not multiple of erase size\n");
 175                 return -1;
 176         }
 177
 178         cmd[0] = flash->erase_cmd;
 179         while (len) {
 180 #ifdef CONFIG_SPI_FLASH_BAR
 181                 ret = spi_flash_bank(flash, offset);
 182                 if (ret < 0)
 183                         return ret;
 184 #endif
 185                 spi_flash_addr(offset, cmd);
 186
 187                 debug("SF: erase %2x %2x %2x %2x (%x)\n", cmd[0], cmd[1],
 188                       cmd[2], cmd[3], offset);
 189
 190                 ret = spi_flash_write_common(flash, cmd, sizeof(cmd), NULL, 0);
 191                 if (ret < 0) {
 192                         debug("SF: erase failed\n");
 193                         break;
 194                 }
 195
 196                 offset += erase_size;
 197                 len -= erase_size;
 198         }
 199
 200         return ret;
 201 }
 202
 203 int spi_flash_cmd_write_ops(struct spi_flash *flash, u32 offset,
 204                 size_t len, const void *buf)
 205 {
 206         unsigned long byte_addr, page_size;
 207         size_t chunk_len, actual;
 208         u8 cmd[4];
 209         int ret = -1;
 210
 211         page_size = flash->page_size;
 212
 213         cmd[0] = CMD_PAGE_PROGRAM;
 214         for (actual = 0; actual < len; actual += chunk_len) {
 215 #ifdef CONFIG_SPI_FLASH_BAR
 216                 ret = spi_flash_bank(flash, offset);
 217                 if (ret < 0)
 218                         return ret;
 219 #endif
 220                 byte_addr = offset % page_size;
 221                 chunk_len = min(len - actual, page_size - byte_addr);
 222
 223                 if (flash->spi->max_write_size)
 224                         chunk_len = min(chunk_len, flash->spi->max_write_size);
 225
 226                 spi_flash_addr(offset, cmd);
 227
 228                 debug("PP: 0x%p => cmd = { 0x%02x 0x%02x%02x%02x } chunk_len = %zu\n",
 229                       buf + actual, cmd[0], cmd[1], cmd[2], cmd[3], chunk_len);
 230
 231                 ret = spi_flash_write_common(flash, cmd, sizeof(cmd),
 232                                         buf + actual, chunk_len);
 233                 if (ret < 0) {
 234                         debug("SF: write failed\n");
 235                         break;
 236                 }
 237
 238                 offset += chunk_len;
 239         }
 240
 241         return ret;
 242 }
 243
 244 int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd,
 245                 size_t cmd_len, void *data, size_t data_len)
 246 {
 247         struct spi_slave *spi = flash->spi;
 248         int ret;
 249
 250         ret = spi_claim_bus(flash->spi);
 251         if (ret) {
 252                 debug("SF: unable to claim SPI bus\n");
 253                 return ret;
 254         }
 255
 256         ret = spi_flash_cmd_read(spi, cmd, cmd_len, data, data_len);
 257         if (ret < 0) {
 258                 debug("SF: read cmd failed\n");
 259                 return ret;
 260         }
 261
 262         spi_release_bus(spi);
 263
 264         return ret;
 265 }
 266
 267 int spi_flash_cmd_read_ops(struct spi_flash *flash, u32 offset,
 268                 size_t len, void *data)
 269 {
 270         u8 cmd[5], bank_sel = 0;
 271         u32 remain_len, read_len;
 272         int ret = -1;
 273
 274         /* Handle memory-mapped SPI */
 275         if (flash->memory_map) {
 276                 spi_xfer(flash->spi, 0, NULL, NULL, SPI_XFER_MMAP);
 277                 memcpy(data, flash->memory_map + offset, len);
 278                 spi_xfer(flash->spi, 0, NULL, NULL, SPI_XFER_MMAP_END);
 279                 return 0;
 280         }
 281
 282         cmd[0] = CMD_READ_ARRAY_FAST;
 283         cmd[4] = 0x00;
 284
 285         while (len) {
 286 #ifdef CONFIG_SPI_FLASH_BAR
 287                 bank_sel = offset / SPI_FLASH_16MB_BOUN;
 288
 289                 ret = spi_flash_cmd_bankaddr_write(flash, bank_sel);
 290                 if (ret) {
 291                         debug("SF: fail to set bank%d\n", bank_sel);
 292                         return ret;
 293                 }
 294 #endif
 295                 remain_len = (SPI_FLASH_16MB_BOUN * (bank_sel + 1)) - offset;
 296                 if (len < remain_len)
 297                         read_len = len;
 298                 else
 299                         read_len = remain_len;
 300
 301                 spi_flash_addr(offset, cmd);
 302
 303                 ret = spi_flash_read_common(flash, cmd, sizeof(cmd),
 304                                                         data, read_len);
 305                 if (ret < 0) {
 306                         debug("SF: read failed\n");
 307                         break;
 308                 }
 309
 310                 offset += read_len;
 311                 len -= read_len;
 312                 data += read_len;
 313         }
 314
 315         return ret;
 316 }
 317
 318 #ifdef CONFIG_SPI_FLASH_SST
 319 static int sst_byte_write(struct spi_flash *flash, u32 offset, const void *buf)
 320 {
 321         int ret;
 322         u8 cmd[4] = {
 323                 CMD_SST_BP,
 324                 offset >> 16,
 325                 offset >> 8,
 326                 offset,
 327         };
 328
 329         debug("BP[%02x]: 0x%p => cmd = { 0x%02x 0x%06x }\n",
 330               spi_w8r8(flash->spi, CMD_READ_STATUS), buf, cmd[0], offset);
 331
 332         ret = spi_flash_cmd_write_enable(flash);
 333         if (ret)
 334                 return ret;
 335
 336         ret = spi_flash_cmd_write(flash->spi, cmd, sizeof(cmd), buf, 1);
 337         if (ret)
 338                 return ret;
 339
 340         return spi_flash_cmd_wait_ready(flash, SPI_FLASH_PROG_TIMEOUT);
 341 }
 342
 343 int sst_write_wp(struct spi_flash *flash, u32 offset, size_t len,
 344                 const void *buf)
 345 {
 346         size_t actual, cmd_len;
 347         int ret;
 348         u8 cmd[4];
 349
 350         ret = spi_claim_bus(flash->spi);
 351         if (ret) {
 352                 debug("SF: Unable to claim SPI bus\n");
 353                 return ret;
 354         }
 355
 356         /* If the data is not word aligned, write out leading single byte */
 357         actual = offset % 2;
 358         if (actual) {
 359                 ret = sst_byte_write(flash, offset, buf);
 360                 if (ret)
 361                         goto done;
 362         }
 363         offset += actual;
 364
 365         ret = spi_flash_cmd_write_enable(flash);
 366         if (ret)
 367                 goto done;
 368
 369         cmd_len = 4;
 370         cmd[0] = CMD_SST_AAI_WP;
 371         cmd[1] = offset >> 16;
 372         cmd[2] = offset >> 8;
 373         cmd[3] = offset;
 374
 375         for (; actual < len - 1; actual += 2) {
 376                 debug("WP[%02x]: 0x%p => cmd = { 0x%02x 0x%06x }\n",
 377                       spi_w8r8(flash->spi, CMD_READ_STATUS), buf + actual,
 378                       cmd[0], offset);
 379
 380                 ret = spi_flash_cmd_write(flash->spi, cmd, cmd_len,
 381                                         buf + actual, 2);
 382                 if (ret) {
 383                         debug("SF: sst word program failed\n");
 384                         break;
 385                 }
 386
 387                 ret = spi_flash_cmd_wait_ready(flash, SPI_FLASH_PROG_TIMEOUT);
 388                 if (ret)
 389                         break;
 390
 391                 cmd_len = 1;
 392                 offset += 2;
 393         }
 394
 395         if (!ret)
 396                 ret = spi_flash_cmd_write_disable(flash);
 397
 398         /* If there is a single trailing byte, write it out */
 399         if (!ret && actual != len)
 400                 ret = sst_byte_write(flash, offset, buf + actual);
 401
 402  done:
 403         debug("SF: sst: program %s %zu bytes @ 0x%zx\n",
 404               ret ? "failure" : "success", len, offset - actual);
 405
 406         spi_release_bus(flash->spi);
 407         return ret;
 408 }
 409 #endif