]> git.sur5r.net Git - u-boot/blob - drivers/mtd/spi/sf_ops.c
Merge branch 'master' of git://git.denx.de/u-boot-nios
[u-boot] / 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 <errno.h>
13 #include <malloc.h>
14 #include <spi.h>
15 #include <spi_flash.h>
16 #include <watchdog.h>
17 #include <linux/compiler.h>
18 #include <linux/log2.h>
19
20 #include "sf_internal.h"
21
22 static void spi_flash_addr(u32 addr, u8 *cmd)
23 {
24         /* cmd[0] is actual command */
25         cmd[1] = addr >> 16;
26         cmd[2] = addr >> 8;
27         cmd[3] = addr >> 0;
28 }
29
30 int spi_flash_cmd_read_status(struct spi_flash *flash, u8 *rs)
31 {
32         int ret;
33         u8 cmd;
34
35         cmd = CMD_READ_STATUS;
36         ret = spi_flash_read_common(flash, &cmd, 1, rs, 1);
37         if (ret < 0) {
38                 debug("SF: fail to read status register\n");
39                 return ret;
40         }
41
42         return 0;
43 }
44
45 static int read_fsr(struct spi_flash *flash, u8 *fsr)
46 {
47         int ret;
48         const u8 cmd = CMD_FLAG_STATUS;
49
50         ret = spi_flash_read_common(flash, &cmd, 1, fsr, 1);
51         if (ret < 0) {
52                 debug("SF: fail to read flag status register\n");
53                 return ret;
54         }
55
56         return 0;
57 }
58
59 int spi_flash_cmd_write_status(struct spi_flash *flash, u8 ws)
60 {
61         u8 cmd;
62         int ret;
63
64         cmd = CMD_WRITE_STATUS;
65         ret = spi_flash_write_common(flash, &cmd, 1, &ws, 1);
66         if (ret < 0) {
67                 debug("SF: fail to write status register\n");
68                 return ret;
69         }
70
71         return 0;
72 }
73
74 #if defined(CONFIG_SPI_FLASH_SPANSION) || defined(CONFIG_SPI_FLASH_WINBOND)
75 int spi_flash_cmd_read_config(struct spi_flash *flash, u8 *rc)
76 {
77         int ret;
78         u8 cmd;
79
80         cmd = CMD_READ_CONFIG;
81         ret = spi_flash_read_common(flash, &cmd, 1, rc, 1);
82         if (ret < 0) {
83                 debug("SF: fail to read config register\n");
84                 return ret;
85         }
86
87         return 0;
88 }
89
90 int spi_flash_cmd_write_config(struct spi_flash *flash, u8 wc)
91 {
92         u8 data[2];
93         u8 cmd;
94         int ret;
95
96         ret = spi_flash_cmd_read_status(flash, &data[0]);
97         if (ret < 0)
98                 return ret;
99
100         cmd = CMD_WRITE_STATUS;
101         data[1] = wc;
102         ret = spi_flash_write_common(flash, &cmd, 1, &data, 2);
103         if (ret) {
104                 debug("SF: fail to write config register\n");
105                 return ret;
106         }
107
108         return 0;
109 }
110 #endif
111
112 #ifdef CONFIG_SPI_FLASH_BAR
113 static int spi_flash_write_bank(struct spi_flash *flash, u32 offset)
114 {
115         u8 cmd, bank_sel;
116         int ret;
117
118         bank_sel = offset / (SPI_FLASH_16MB_BOUN << flash->shift);
119         if (bank_sel == flash->bank_curr)
120                 goto bar_end;
121
122         cmd = flash->bank_write_cmd;
123         ret = spi_flash_write_common(flash, &cmd, 1, &bank_sel, 1);
124         if (ret < 0) {
125                 debug("SF: fail to write bank register\n");
126                 return ret;
127         }
128
129 bar_end:
130         flash->bank_curr = bank_sel;
131         return flash->bank_curr;
132 }
133 #endif
134
135 #ifdef CONFIG_SF_DUAL_FLASH
136 static void spi_flash_dual_flash(struct spi_flash *flash, u32 *addr)
137 {
138         switch (flash->dual_flash) {
139         case SF_DUAL_STACKED_FLASH:
140                 if (*addr >= (flash->size >> 1)) {
141                         *addr -= flash->size >> 1;
142                         flash->spi->flags |= SPI_XFER_U_PAGE;
143                 } else {
144                         flash->spi->flags &= ~SPI_XFER_U_PAGE;
145                 }
146                 break;
147         case SF_DUAL_PARALLEL_FLASH:
148                 *addr >>= flash->shift;
149                 break;
150         default:
151                 debug("SF: Unsupported dual_flash=%d\n", flash->dual_flash);
152                 break;
153         }
154 }
155 #endif
156
157 static int spi_flash_sr_ready(struct spi_flash *flash)
158 {
159         u8 sr;
160         int ret;
161
162         ret = spi_flash_cmd_read_status(flash, &sr);
163         if (ret < 0)
164                 return ret;
165
166         return !(sr & STATUS_WIP);
167 }
168
169 static int spi_flash_fsr_ready(struct spi_flash *flash)
170 {
171         u8 fsr;
172         int ret;
173
174         ret = read_fsr(flash, &fsr);
175         if (ret < 0)
176                 return ret;
177
178         return fsr & STATUS_PEC;
179 }
180
181 static int spi_flash_ready(struct spi_flash *flash)
182 {
183         int sr, fsr;
184
185         sr = spi_flash_sr_ready(flash);
186         if (sr < 0)
187                 return sr;
188
189         fsr = 1;
190         if (flash->flags & SNOR_F_USE_FSR) {
191                 fsr = spi_flash_fsr_ready(flash);
192                 if (fsr < 0)
193                         return fsr;
194         }
195
196         return sr && fsr;
197 }
198
199 int spi_flash_cmd_wait_ready(struct spi_flash *flash, unsigned long timeout)
200 {
201         int timebase, ret;
202
203         timebase = get_timer(0);
204
205         while (get_timer(timebase) < timeout) {
206                 ret = spi_flash_ready(flash);
207                 if (ret < 0)
208                         return ret;
209                 if (ret)
210                         return 0;
211         }
212
213         printf("SF: Timeout!\n");
214
215         return -ETIMEDOUT;
216 }
217
218 int spi_flash_write_common(struct spi_flash *flash, const u8 *cmd,
219                 size_t cmd_len, const void *buf, size_t buf_len)
220 {
221         struct spi_slave *spi = flash->spi;
222         unsigned long timeout = SPI_FLASH_PROG_TIMEOUT;
223         int ret;
224
225         if (buf == NULL)
226                 timeout = SPI_FLASH_PAGE_ERASE_TIMEOUT;
227
228         ret = spi_claim_bus(flash->spi);
229         if (ret) {
230                 debug("SF: unable to claim SPI bus\n");
231                 return ret;
232         }
233
234         ret = spi_flash_cmd_write_enable(flash);
235         if (ret < 0) {
236                 debug("SF: enabling write failed\n");
237                 return ret;
238         }
239
240         ret = spi_flash_cmd_write(spi, cmd, cmd_len, buf, buf_len);
241         if (ret < 0) {
242                 debug("SF: write cmd failed\n");
243                 return ret;
244         }
245
246         ret = spi_flash_cmd_wait_ready(flash, timeout);
247         if (ret < 0) {
248                 debug("SF: write %s timed out\n",
249                       timeout == SPI_FLASH_PROG_TIMEOUT ?
250                         "program" : "page erase");
251                 return ret;
252         }
253
254         spi_release_bus(spi);
255
256         return ret;
257 }
258
259 int spi_flash_cmd_erase_ops(struct spi_flash *flash, u32 offset, size_t len)
260 {
261         u32 erase_size, erase_addr;
262         u8 cmd[SPI_FLASH_CMD_LEN];
263         int ret = -1;
264
265         erase_size = flash->erase_size;
266         if (offset % erase_size || len % erase_size) {
267                 debug("SF: Erase offset/length not multiple of erase size\n");
268                 return -1;
269         }
270
271         if (flash->flash_is_locked(flash, offset, len) > 0) {
272                 printf("offset 0x%x is protected and cannot be erased\n", offset);
273                 return -EINVAL;
274         }
275
276         cmd[0] = flash->erase_cmd;
277         while (len) {
278                 erase_addr = offset;
279
280 #ifdef CONFIG_SF_DUAL_FLASH
281                 if (flash->dual_flash > SF_SINGLE_FLASH)
282                         spi_flash_dual_flash(flash, &erase_addr);
283 #endif
284 #ifdef CONFIG_SPI_FLASH_BAR
285                 ret = spi_flash_write_bank(flash, erase_addr);
286                 if (ret < 0)
287                         return ret;
288 #endif
289                 spi_flash_addr(erase_addr, cmd);
290
291                 debug("SF: erase %2x %2x %2x %2x (%x)\n", cmd[0], cmd[1],
292                       cmd[2], cmd[3], erase_addr);
293
294                 ret = spi_flash_write_common(flash, cmd, sizeof(cmd), NULL, 0);
295                 if (ret < 0) {
296                         debug("SF: erase failed\n");
297                         break;
298                 }
299
300                 offset += erase_size;
301                 len -= erase_size;
302         }
303
304         return ret;
305 }
306
307 int spi_flash_cmd_write_ops(struct spi_flash *flash, u32 offset,
308                 size_t len, const void *buf)
309 {
310         unsigned long byte_addr, page_size;
311         u32 write_addr;
312         size_t chunk_len, actual;
313         u8 cmd[SPI_FLASH_CMD_LEN];
314         int ret = -1;
315
316         page_size = flash->page_size;
317
318         if (flash->flash_is_locked(flash, offset, len) > 0) {
319                 printf("offset 0x%x is protected and cannot be written\n", offset);
320                 return -EINVAL;
321         }
322
323         cmd[0] = flash->write_cmd;
324         for (actual = 0; actual < len; actual += chunk_len) {
325                 write_addr = offset;
326
327 #ifdef CONFIG_SF_DUAL_FLASH
328                 if (flash->dual_flash > SF_SINGLE_FLASH)
329                         spi_flash_dual_flash(flash, &write_addr);
330 #endif
331 #ifdef CONFIG_SPI_FLASH_BAR
332                 ret = spi_flash_write_bank(flash, write_addr);
333                 if (ret < 0)
334                         return ret;
335 #endif
336                 byte_addr = offset % page_size;
337                 chunk_len = min(len - actual, (size_t)(page_size - byte_addr));
338
339                 if (flash->spi->max_write_size)
340                         chunk_len = min(chunk_len,
341                                         (size_t)flash->spi->max_write_size);
342
343                 spi_flash_addr(write_addr, cmd);
344
345                 debug("SF: 0x%p => cmd = { 0x%02x 0x%02x%02x%02x } chunk_len = %zu\n",
346                       buf + actual, cmd[0], cmd[1], cmd[2], cmd[3], chunk_len);
347
348                 ret = spi_flash_write_common(flash, cmd, sizeof(cmd),
349                                         buf + actual, chunk_len);
350                 if (ret < 0) {
351                         debug("SF: write failed\n");
352                         break;
353                 }
354
355                 offset += chunk_len;
356         }
357
358         return ret;
359 }
360
361 int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd,
362                 size_t cmd_len, void *data, size_t data_len)
363 {
364         struct spi_slave *spi = flash->spi;
365         int ret;
366
367         ret = spi_claim_bus(flash->spi);
368         if (ret) {
369                 debug("SF: unable to claim SPI bus\n");
370                 return ret;
371         }
372
373         ret = spi_flash_cmd_read(spi, cmd, cmd_len, data, data_len);
374         if (ret < 0) {
375                 debug("SF: read cmd failed\n");
376                 return ret;
377         }
378
379         spi_release_bus(spi);
380
381         return ret;
382 }
383
384 void __weak spi_flash_copy_mmap(void *data, void *offset, size_t len)
385 {
386         memcpy(data, offset, len);
387 }
388
389 int spi_flash_cmd_read_ops(struct spi_flash *flash, u32 offset,
390                 size_t len, void *data)
391 {
392         u8 *cmd, cmdsz;
393         u32 remain_len, read_len, read_addr;
394         int bank_sel = 0;
395         int ret = -1;
396
397         /* Handle memory-mapped SPI */
398         if (flash->memory_map) {
399                 ret = spi_claim_bus(flash->spi);
400                 if (ret) {
401                         debug("SF: unable to claim SPI bus\n");
402                         return ret;
403                 }
404                 spi_xfer(flash->spi, 0, NULL, NULL, SPI_XFER_MMAP);
405                 spi_flash_copy_mmap(data, flash->memory_map + offset, len);
406                 spi_xfer(flash->spi, 0, NULL, NULL, SPI_XFER_MMAP_END);
407                 spi_release_bus(flash->spi);
408                 return 0;
409         }
410
411         cmdsz = SPI_FLASH_CMD_LEN + flash->dummy_byte;
412         cmd = calloc(1, cmdsz);
413         if (!cmd) {
414                 debug("SF: Failed to allocate cmd\n");
415                 return -ENOMEM;
416         }
417
418         cmd[0] = flash->read_cmd;
419         while (len) {
420                 read_addr = offset;
421
422 #ifdef CONFIG_SF_DUAL_FLASH
423                 if (flash->dual_flash > SF_SINGLE_FLASH)
424                         spi_flash_dual_flash(flash, &read_addr);
425 #endif
426 #ifdef CONFIG_SPI_FLASH_BAR
427                 ret = spi_flash_write_bank(flash, read_addr);
428                 if (ret < 0)
429                         return ret;
430                 bank_sel = flash->bank_curr;
431 #endif
432                 remain_len = ((SPI_FLASH_16MB_BOUN << flash->shift) *
433                                 (bank_sel + 1)) - offset;
434                 if (len < remain_len)
435                         read_len = len;
436                 else
437                         read_len = remain_len;
438
439                 spi_flash_addr(read_addr, cmd);
440
441                 ret = spi_flash_read_common(flash, cmd, cmdsz, data, read_len);
442                 if (ret < 0) {
443                         debug("SF: read failed\n");
444                         break;
445                 }
446
447                 offset += read_len;
448                 len -= read_len;
449                 data += read_len;
450         }
451
452         free(cmd);
453         return ret;
454 }
455
456 #ifdef CONFIG_SPI_FLASH_SST
457 static int sst_byte_write(struct spi_flash *flash, u32 offset, const void *buf)
458 {
459         int ret;
460         u8 cmd[4] = {
461                 CMD_SST_BP,
462                 offset >> 16,
463                 offset >> 8,
464                 offset,
465         };
466
467         debug("BP[%02x]: 0x%p => cmd = { 0x%02x 0x%06x }\n",
468               spi_w8r8(flash->spi, CMD_READ_STATUS), buf, cmd[0], offset);
469
470         ret = spi_flash_cmd_write_enable(flash);
471         if (ret)
472                 return ret;
473
474         ret = spi_flash_cmd_write(flash->spi, cmd, sizeof(cmd), buf, 1);
475         if (ret)
476                 return ret;
477
478         return spi_flash_cmd_wait_ready(flash, SPI_FLASH_PROG_TIMEOUT);
479 }
480
481 int sst_write_wp(struct spi_flash *flash, u32 offset, size_t len,
482                 const void *buf)
483 {
484         size_t actual, cmd_len;
485         int ret;
486         u8 cmd[4];
487
488         ret = spi_claim_bus(flash->spi);
489         if (ret) {
490                 debug("SF: Unable to claim SPI bus\n");
491                 return ret;
492         }
493
494         /* If the data is not word aligned, write out leading single byte */
495         actual = offset % 2;
496         if (actual) {
497                 ret = sst_byte_write(flash, offset, buf);
498                 if (ret)
499                         goto done;
500         }
501         offset += actual;
502
503         ret = spi_flash_cmd_write_enable(flash);
504         if (ret)
505                 goto done;
506
507         cmd_len = 4;
508         cmd[0] = CMD_SST_AAI_WP;
509         cmd[1] = offset >> 16;
510         cmd[2] = offset >> 8;
511         cmd[3] = offset;
512
513         for (; actual < len - 1; actual += 2) {
514                 debug("WP[%02x]: 0x%p => cmd = { 0x%02x 0x%06x }\n",
515                       spi_w8r8(flash->spi, CMD_READ_STATUS), buf + actual,
516                       cmd[0], offset);
517
518                 ret = spi_flash_cmd_write(flash->spi, cmd, cmd_len,
519                                         buf + actual, 2);
520                 if (ret) {
521                         debug("SF: sst word program failed\n");
522                         break;
523                 }
524
525                 ret = spi_flash_cmd_wait_ready(flash, SPI_FLASH_PROG_TIMEOUT);
526                 if (ret)
527                         break;
528
529                 cmd_len = 1;
530                 offset += 2;
531         }
532
533         if (!ret)
534                 ret = spi_flash_cmd_write_disable(flash);
535
536         /* If there is a single trailing byte, write it out */
537         if (!ret && actual != len)
538                 ret = sst_byte_write(flash, offset, buf + actual);
539
540  done:
541         debug("SF: sst: program %s %zu bytes @ 0x%zx\n",
542               ret ? "failure" : "success", len, offset - actual);
543
544         spi_release_bus(flash->spi);
545         return ret;
546 }
547
548 int sst_write_bp(struct spi_flash *flash, u32 offset, size_t len,
549                 const void *buf)
550 {
551         size_t actual;
552         int ret;
553
554         ret = spi_claim_bus(flash->spi);
555         if (ret) {
556                 debug("SF: Unable to claim SPI bus\n");
557                 return ret;
558         }
559
560         for (actual = 0; actual < len; actual++) {
561                 ret = sst_byte_write(flash, offset, buf + actual);
562                 if (ret) {
563                         debug("SF: sst byte program failed\n");
564                         break;
565                 }
566                 offset++;
567         }
568
569         if (!ret)
570                 ret = spi_flash_cmd_write_disable(flash);
571
572         debug("SF: sst: program %s %zu bytes @ 0x%zx\n",
573               ret ? "failure" : "success", len, offset - actual);
574
575         spi_release_bus(flash->spi);
576         return ret;
577 }
578 #endif
579
580 #ifdef CONFIG_SPI_FLASH_STMICRO
581 static void stm_get_locked_range(struct spi_flash *flash, u8 sr, loff_t *ofs,
582                                  u32 *len)
583 {
584         u8 mask = SR_BP2 | SR_BP1 | SR_BP0;
585         int shift = ffs(mask) - 1;
586         int pow;
587
588         if (!(sr & mask)) {
589                 /* No protection */
590                 *ofs = 0;
591                 *len = 0;
592         } else {
593                 pow = ((sr & mask) ^ mask) >> shift;
594                 *len = flash->size >> pow;
595                 *ofs = flash->size - *len;
596         }
597 }
598
599 /*
600  * Return 1 if the entire region is locked, 0 otherwise
601  */
602 static int stm_is_locked_sr(struct spi_flash *flash, u32 ofs, u32 len,
603                             u8 sr)
604 {
605         loff_t lock_offs;
606         u32 lock_len;
607
608         stm_get_locked_range(flash, sr, &lock_offs, &lock_len);
609
610         return (ofs + len <= lock_offs + lock_len) && (ofs >= lock_offs);
611 }
612
613 /*
614  * Check if a region of the flash is (completely) locked. See stm_lock() for
615  * more info.
616  *
617  * Returns 1 if entire region is locked, 0 if any portion is unlocked, and
618  * negative on errors.
619  */
620 int stm_is_locked(struct spi_flash *flash, u32 ofs, size_t len)
621 {
622         int status;
623         u8 sr;
624
625         status = spi_flash_cmd_read_status(flash, &sr);
626         if (status < 0)
627                 return status;
628
629         return stm_is_locked_sr(flash, ofs, len, sr);
630 }
631
632 /*
633  * Lock a region of the flash. Compatible with ST Micro and similar flash.
634  * Supports only the block protection bits BP{0,1,2} in the status register
635  * (SR). Does not support these features found in newer SR bitfields:
636  *   - TB: top/bottom protect - only handle TB=0 (top protect)
637  *   - SEC: sector/block protect - only handle SEC=0 (block protect)
638  *   - CMP: complement protect - only support CMP=0 (range is not complemented)
639  *
640  * Sample table portion for 8MB flash (Winbond w25q64fw):
641  *
642  *   SEC  |  TB   |  BP2  |  BP1  |  BP0  |  Prot Length  | Protected Portion
643  *  --------------------------------------------------------------------------
644  *    X   |   X   |   0   |   0   |   0   |  NONE         | NONE
645  *    0   |   0   |   0   |   0   |   1   |  128 KB       | Upper 1/64
646  *    0   |   0   |   0   |   1   |   0   |  256 KB       | Upper 1/32
647  *    0   |   0   |   0   |   1   |   1   |  512 KB       | Upper 1/16
648  *    0   |   0   |   1   |   0   |   0   |  1 MB         | Upper 1/8
649  *    0   |   0   |   1   |   0   |   1   |  2 MB         | Upper 1/4
650  *    0   |   0   |   1   |   1   |   0   |  4 MB         | Upper 1/2
651  *    X   |   X   |   1   |   1   |   1   |  8 MB         | ALL
652  *
653  * Returns negative on errors, 0 on success.
654  */
655 int stm_lock(struct spi_flash *flash, u32 ofs, size_t len)
656 {
657         u8 status_old, status_new;
658         u8 mask = SR_BP2 | SR_BP1 | SR_BP0;
659         u8 shift = ffs(mask) - 1, pow, val;
660
661         spi_flash_cmd_read_status(flash, &status_old);
662
663         /* SPI NOR always locks to the end */
664         if (ofs + len != flash->size) {
665                 /* Does combined region extend to end? */
666                 if (!stm_is_locked_sr(flash, ofs + len, flash->size - ofs - len,
667                                       status_old))
668                         return -EINVAL;
669                 len = flash->size - ofs;
670         }
671
672         /*
673          * Need smallest pow such that:
674          *
675          *   1 / (2^pow) <= (len / size)
676          *
677          * so (assuming power-of-2 size) we do:
678          *
679          *   pow = ceil(log2(size / len)) = log2(size) - floor(log2(len))
680          */
681         pow = ilog2(flash->size) - ilog2(len);
682         val = mask - (pow << shift);
683         if (val & ~mask)
684                 return -EINVAL;
685
686         /* Don't "lock" with no region! */
687         if (!(val & mask))
688                 return -EINVAL;
689
690         status_new = (status_old & ~mask) | val;
691
692         /* Only modify protection if it will not unlock other areas */
693         if ((status_new & mask) <= (status_old & mask))
694                 return -EINVAL;
695
696         spi_flash_cmd_write_status(flash, status_new);
697
698         return 0;
699 }
700
701 /*
702  * Unlock a region of the flash. See stm_lock() for more info
703  *
704  * Returns negative on errors, 0 on success.
705  */
706 int stm_unlock(struct spi_flash *flash, u32 ofs, size_t len)
707 {
708         uint8_t status_old, status_new;
709         u8 mask = SR_BP2 | SR_BP1 | SR_BP0;
710         u8 shift = ffs(mask) - 1, pow, val;
711
712         spi_flash_cmd_read_status(flash, &status_old);
713
714         /* Cannot unlock; would unlock larger region than requested */
715         if (stm_is_locked_sr(flash, status_old, ofs - flash->erase_size,
716                              flash->erase_size))
717                 return -EINVAL;
718         /*
719          * Need largest pow such that:
720          *
721          *   1 / (2^pow) >= (len / size)
722          *
723          * so (assuming power-of-2 size) we do:
724          *
725          *   pow = floor(log2(size / len)) = log2(size) - ceil(log2(len))
726          */
727         pow = ilog2(flash->size) - order_base_2(flash->size - (ofs + len));
728         if (ofs + len == flash->size) {
729                 val = 0; /* fully unlocked */
730         } else {
731                 val = mask - (pow << shift);
732                 /* Some power-of-two sizes are not supported */
733                 if (val & ~mask)
734                         return -EINVAL;
735         }
736
737         status_new = (status_old & ~mask) | val;
738
739         /* Only modify protection if it will not lock other areas */
740         if ((status_new & mask) >= (status_old & mask))
741                 return -EINVAL;
742
743         spi_flash_cmd_write_status(flash, status_new);
744
745         return 0;
746 }
747 #endif  /* CONFIG_SPI_FLASH_STMICRO */