sf: Add SPI protection mechanism from the kernel
[oweals/u-boot.git] / 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         cmd[0] = flash->erase_cmd;
272         while (len) {
273                 erase_addr = offset;
274
275 #ifdef CONFIG_SF_DUAL_FLASH
276                 if (flash->dual_flash > SF_SINGLE_FLASH)
277                         spi_flash_dual_flash(flash, &erase_addr);
278 #endif
279 #ifdef CONFIG_SPI_FLASH_BAR
280                 ret = spi_flash_write_bank(flash, erase_addr);
281                 if (ret < 0)
282                         return ret;
283 #endif
284                 spi_flash_addr(erase_addr, cmd);
285
286                 debug("SF: erase %2x %2x %2x %2x (%x)\n", cmd[0], cmd[1],
287                       cmd[2], cmd[3], erase_addr);
288
289                 ret = spi_flash_write_common(flash, cmd, sizeof(cmd), NULL, 0);
290                 if (ret < 0) {
291                         debug("SF: erase failed\n");
292                         break;
293                 }
294
295                 offset += erase_size;
296                 len -= erase_size;
297         }
298
299         return ret;
300 }
301
302 int spi_flash_cmd_write_ops(struct spi_flash *flash, u32 offset,
303                 size_t len, const void *buf)
304 {
305         unsigned long byte_addr, page_size;
306         u32 write_addr;
307         size_t chunk_len, actual;
308         u8 cmd[SPI_FLASH_CMD_LEN];
309         int ret = -1;
310
311         page_size = flash->page_size;
312
313         cmd[0] = flash->write_cmd;
314         for (actual = 0; actual < len; actual += chunk_len) {
315                 write_addr = offset;
316
317 #ifdef CONFIG_SF_DUAL_FLASH
318                 if (flash->dual_flash > SF_SINGLE_FLASH)
319                         spi_flash_dual_flash(flash, &write_addr);
320 #endif
321 #ifdef CONFIG_SPI_FLASH_BAR
322                 ret = spi_flash_write_bank(flash, write_addr);
323                 if (ret < 0)
324                         return ret;
325 #endif
326                 byte_addr = offset % page_size;
327                 chunk_len = min(len - actual, (size_t)(page_size - byte_addr));
328
329                 if (flash->spi->max_write_size)
330                         chunk_len = min(chunk_len,
331                                         (size_t)flash->spi->max_write_size);
332
333                 spi_flash_addr(write_addr, cmd);
334
335                 debug("SF: 0x%p => cmd = { 0x%02x 0x%02x%02x%02x } chunk_len = %zu\n",
336                       buf + actual, cmd[0], cmd[1], cmd[2], cmd[3], chunk_len);
337
338                 ret = spi_flash_write_common(flash, cmd, sizeof(cmd),
339                                         buf + actual, chunk_len);
340                 if (ret < 0) {
341                         debug("SF: write failed\n");
342                         break;
343                 }
344
345                 offset += chunk_len;
346         }
347
348         return ret;
349 }
350
351 int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd,
352                 size_t cmd_len, void *data, size_t data_len)
353 {
354         struct spi_slave *spi = flash->spi;
355         int ret;
356
357         ret = spi_claim_bus(flash->spi);
358         if (ret) {
359                 debug("SF: unable to claim SPI bus\n");
360                 return ret;
361         }
362
363         ret = spi_flash_cmd_read(spi, cmd, cmd_len, data, data_len);
364         if (ret < 0) {
365                 debug("SF: read cmd failed\n");
366                 return ret;
367         }
368
369         spi_release_bus(spi);
370
371         return ret;
372 }
373
374 void __weak spi_flash_copy_mmap(void *data, void *offset, size_t len)
375 {
376         memcpy(data, offset, len);
377 }
378
379 int spi_flash_cmd_read_ops(struct spi_flash *flash, u32 offset,
380                 size_t len, void *data)
381 {
382         u8 *cmd, cmdsz;
383         u32 remain_len, read_len, read_addr;
384         int bank_sel = 0;
385         int ret = -1;
386
387         /* Handle memory-mapped SPI */
388         if (flash->memory_map) {
389                 ret = spi_claim_bus(flash->spi);
390                 if (ret) {
391                         debug("SF: unable to claim SPI bus\n");
392                         return ret;
393                 }
394                 spi_xfer(flash->spi, 0, NULL, NULL, SPI_XFER_MMAP);
395                 spi_flash_copy_mmap(data, flash->memory_map + offset, len);
396                 spi_xfer(flash->spi, 0, NULL, NULL, SPI_XFER_MMAP_END);
397                 spi_release_bus(flash->spi);
398                 return 0;
399         }
400
401         cmdsz = SPI_FLASH_CMD_LEN + flash->dummy_byte;
402         cmd = calloc(1, cmdsz);
403         if (!cmd) {
404                 debug("SF: Failed to allocate cmd\n");
405                 return -ENOMEM;
406         }
407
408         cmd[0] = flash->read_cmd;
409         while (len) {
410                 read_addr = offset;
411
412 #ifdef CONFIG_SF_DUAL_FLASH
413                 if (flash->dual_flash > SF_SINGLE_FLASH)
414                         spi_flash_dual_flash(flash, &read_addr);
415 #endif
416 #ifdef CONFIG_SPI_FLASH_BAR
417                 ret = spi_flash_write_bank(flash, read_addr);
418                 if (ret < 0)
419                         return ret;
420                 bank_sel = flash->bank_curr;
421 #endif
422                 remain_len = ((SPI_FLASH_16MB_BOUN << flash->shift) *
423                                 (bank_sel + 1)) - offset;
424                 if (len < remain_len)
425                         read_len = len;
426                 else
427                         read_len = remain_len;
428
429                 spi_flash_addr(read_addr, cmd);
430
431                 ret = spi_flash_read_common(flash, cmd, cmdsz, data, read_len);
432                 if (ret < 0) {
433                         debug("SF: read failed\n");
434                         break;
435                 }
436
437                 offset += read_len;
438                 len -= read_len;
439                 data += read_len;
440         }
441
442         free(cmd);
443         return ret;
444 }
445
446 #ifdef CONFIG_SPI_FLASH_SST
447 static int sst_byte_write(struct spi_flash *flash, u32 offset, const void *buf)
448 {
449         int ret;
450         u8 cmd[4] = {
451                 CMD_SST_BP,
452                 offset >> 16,
453                 offset >> 8,
454                 offset,
455         };
456
457         debug("BP[%02x]: 0x%p => cmd = { 0x%02x 0x%06x }\n",
458               spi_w8r8(flash->spi, CMD_READ_STATUS), buf, cmd[0], offset);
459
460         ret = spi_flash_cmd_write_enable(flash);
461         if (ret)
462                 return ret;
463
464         ret = spi_flash_cmd_write(flash->spi, cmd, sizeof(cmd), buf, 1);
465         if (ret)
466                 return ret;
467
468         return spi_flash_cmd_wait_ready(flash, SPI_FLASH_PROG_TIMEOUT);
469 }
470
471 int sst_write_wp(struct spi_flash *flash, u32 offset, size_t len,
472                 const void *buf)
473 {
474         size_t actual, cmd_len;
475         int ret;
476         u8 cmd[4];
477
478         ret = spi_claim_bus(flash->spi);
479         if (ret) {
480                 debug("SF: Unable to claim SPI bus\n");
481                 return ret;
482         }
483
484         /* If the data is not word aligned, write out leading single byte */
485         actual = offset % 2;
486         if (actual) {
487                 ret = sst_byte_write(flash, offset, buf);
488                 if (ret)
489                         goto done;
490         }
491         offset += actual;
492
493         ret = spi_flash_cmd_write_enable(flash);
494         if (ret)
495                 goto done;
496
497         cmd_len = 4;
498         cmd[0] = CMD_SST_AAI_WP;
499         cmd[1] = offset >> 16;
500         cmd[2] = offset >> 8;
501         cmd[3] = offset;
502
503         for (; actual < len - 1; actual += 2) {
504                 debug("WP[%02x]: 0x%p => cmd = { 0x%02x 0x%06x }\n",
505                       spi_w8r8(flash->spi, CMD_READ_STATUS), buf + actual,
506                       cmd[0], offset);
507
508                 ret = spi_flash_cmd_write(flash->spi, cmd, cmd_len,
509                                         buf + actual, 2);
510                 if (ret) {
511                         debug("SF: sst word program failed\n");
512                         break;
513                 }
514
515                 ret = spi_flash_cmd_wait_ready(flash, SPI_FLASH_PROG_TIMEOUT);
516                 if (ret)
517                         break;
518
519                 cmd_len = 1;
520                 offset += 2;
521         }
522
523         if (!ret)
524                 ret = spi_flash_cmd_write_disable(flash);
525
526         /* If there is a single trailing byte, write it out */
527         if (!ret && actual != len)
528                 ret = sst_byte_write(flash, offset, buf + actual);
529
530  done:
531         debug("SF: sst: program %s %zu bytes @ 0x%zx\n",
532               ret ? "failure" : "success", len, offset - actual);
533
534         spi_release_bus(flash->spi);
535         return ret;
536 }
537
538 int sst_write_bp(struct spi_flash *flash, u32 offset, size_t len,
539                 const void *buf)
540 {
541         size_t actual;
542         int ret;
543
544         ret = spi_claim_bus(flash->spi);
545         if (ret) {
546                 debug("SF: Unable to claim SPI bus\n");
547                 return ret;
548         }
549
550         for (actual = 0; actual < len; actual++) {
551                 ret = sst_byte_write(flash, offset, buf + actual);
552                 if (ret) {
553                         debug("SF: sst byte program failed\n");
554                         break;
555                 }
556                 offset++;
557         }
558
559         if (!ret)
560                 ret = spi_flash_cmd_write_disable(flash);
561
562         debug("SF: sst: program %s %zu bytes @ 0x%zx\n",
563               ret ? "failure" : "success", len, offset - actual);
564
565         spi_release_bus(flash->spi);
566         return ret;
567 }
568 #endif
569
570 #ifdef CONFIG_SPI_FLASH_STMICRO
571 static void stm_get_locked_range(struct spi_flash *flash, u8 sr, loff_t *ofs,
572                                  u32 *len)
573 {
574         u8 mask = SR_BP2 | SR_BP1 | SR_BP0;
575         int shift = ffs(mask) - 1;
576         int pow;
577
578         if (!(sr & mask)) {
579                 /* No protection */
580                 *ofs = 0;
581                 *len = 0;
582         } else {
583                 pow = ((sr & mask) ^ mask) >> shift;
584                 *len = flash->size >> pow;
585                 *ofs = flash->size - *len;
586         }
587 }
588
589 /*
590  * Return 1 if the entire region is locked, 0 otherwise
591  */
592 static int stm_is_locked_sr(struct spi_flash *flash, loff_t ofs, u32 len,
593                             u8 sr)
594 {
595         loff_t lock_offs;
596         u32 lock_len;
597
598         stm_get_locked_range(flash, sr, &lock_offs, &lock_len);
599
600         return (ofs + len <= lock_offs + lock_len) && (ofs >= lock_offs);
601 }
602
603 /*
604  * Check if a region of the flash is (completely) locked. See stm_lock() for
605  * more info.
606  *
607  * Returns 1 if entire region is locked, 0 if any portion is unlocked, and
608  * negative on errors.
609  */
610 int stm_is_locked(struct spi_flash *flash, loff_t ofs, u32 len)
611 {
612         int status;
613         u8 sr;
614
615         status = spi_flash_cmd_read_status(flash, &sr);
616         if (status < 0)
617                 return status;
618
619         return stm_is_locked_sr(flash, ofs, len, sr);
620 }
621
622 /*
623  * Lock a region of the flash. Compatible with ST Micro and similar flash.
624  * Supports only the block protection bits BP{0,1,2} in the status register
625  * (SR). Does not support these features found in newer SR bitfields:
626  *   - TB: top/bottom protect - only handle TB=0 (top protect)
627  *   - SEC: sector/block protect - only handle SEC=0 (block protect)
628  *   - CMP: complement protect - only support CMP=0 (range is not complemented)
629  *
630  * Sample table portion for 8MB flash (Winbond w25q64fw):
631  *
632  *   SEC  |  TB   |  BP2  |  BP1  |  BP0  |  Prot Length  | Protected Portion
633  *  --------------------------------------------------------------------------
634  *    X   |   X   |   0   |   0   |   0   |  NONE         | NONE
635  *    0   |   0   |   0   |   0   |   1   |  128 KB       | Upper 1/64
636  *    0   |   0   |   0   |   1   |   0   |  256 KB       | Upper 1/32
637  *    0   |   0   |   0   |   1   |   1   |  512 KB       | Upper 1/16
638  *    0   |   0   |   1   |   0   |   0   |  1 MB         | Upper 1/8
639  *    0   |   0   |   1   |   0   |   1   |  2 MB         | Upper 1/4
640  *    0   |   0   |   1   |   1   |   0   |  4 MB         | Upper 1/2
641  *    X   |   X   |   1   |   1   |   1   |  8 MB         | ALL
642  *
643  * Returns negative on errors, 0 on success.
644  */
645 int stm_lock(struct spi_flash *flash, u32 ofs, size_t len)
646 {
647         u8 status_old, status_new;
648         u8 mask = SR_BP2 | SR_BP1 | SR_BP0;
649         u8 shift = ffs(mask) - 1, pow, val;
650
651         spi_flash_cmd_read_status(flash, &status_old);
652
653         /* SPI NOR always locks to the end */
654         if (ofs + len != flash->size) {
655                 /* Does combined region extend to end? */
656                 if (!stm_is_locked_sr(flash, ofs + len, flash->size - ofs - len,
657                                       status_old))
658                         return -EINVAL;
659                 len = flash->size - ofs;
660         }
661
662         /*
663          * Need smallest pow such that:
664          *
665          *   1 / (2^pow) <= (len / size)
666          *
667          * so (assuming power-of-2 size) we do:
668          *
669          *   pow = ceil(log2(size / len)) = log2(size) - floor(log2(len))
670          */
671         pow = ilog2(flash->size) - ilog2(len);
672         val = mask - (pow << shift);
673         if (val & ~mask)
674                 return -EINVAL;
675
676         /* Don't "lock" with no region! */
677         if (!(val & mask))
678                 return -EINVAL;
679
680         status_new = (status_old & ~mask) | val;
681
682         /* Only modify protection if it will not unlock other areas */
683         if ((status_new & mask) <= (status_old & mask))
684                 return -EINVAL;
685
686         spi_flash_cmd_write_status(flash, status_new);
687
688         return 0;
689 }
690
691 /*
692  * Unlock a region of the flash. See stm_lock() for more info
693  *
694  * Returns negative on errors, 0 on success.
695  */
696 int stm_unlock(struct spi_flash *flash, u32 ofs, size_t len)
697 {
698         uint8_t status_old, status_new;
699         u8 mask = SR_BP2 | SR_BP1 | SR_BP0;
700         u8 shift = ffs(mask) - 1, pow, val;
701
702         spi_flash_cmd_read_status(flash, &status_old);
703
704         /* Cannot unlock; would unlock larger region than requested */
705         if (stm_is_locked_sr(flash, status_old, ofs - flash->erase_size,
706                              flash->erase_size))
707                 return -EINVAL;
708         /*
709          * Need largest pow such that:
710          *
711          *   1 / (2^pow) >= (len / size)
712          *
713          * so (assuming power-of-2 size) we do:
714          *
715          *   pow = floor(log2(size / len)) = log2(size) - ceil(log2(len))
716          */
717         pow = ilog2(flash->size) - order_base_2(flash->size - (ofs + len));
718         if (ofs + len == flash->size) {
719                 val = 0; /* fully unlocked */
720         } else {
721                 val = mask - (pow << shift);
722                 /* Some power-of-two sizes are not supported */
723                 if (val & ~mask)
724                         return -EINVAL;
725         }
726
727         status_new = (status_old & ~mask) | val;
728
729         /* Only modify protection if it will not lock other areas */
730         if ((status_new & mask) >= (status_old & mask))
731                 return -EINVAL;
732
733         spi_flash_cmd_write_status(flash, status_new);
734
735         return 0;
736 }
737 #endif  /* CONFIG_SPI_FLASH_STMICRO */