Remove FSF address from GPL notices
[fw/openocd] / src / flash / nor / core.c
1 /***************************************************************************
2  *   Copyright (C) 2005 by Dominic Rath <Dominic.Rath@gmx.de>              *
3  *   Copyright (C) 2007-2010 Øyvind Harboe <oyvind.harboe@zylin.com>       *
4  *   Copyright (C) 2008 by Spencer Oliver <spen@spen-soft.co.uk>           *
5  *   Copyright (C) 2009 Zachary T Welch <zw@superlucidity.net>             *
6  *   Copyright (C) 2010 by Antonio Borneo <borneo.antonio@gmail.com>       *
7  *                                                                         *
8  *   This program is free software; you can redistribute it and/or modify  *
9  *   it under the terms of the GNU General Public License as published by  *
10  *   the Free Software Foundation; either version 2 of the License, or     *
11  *   (at your option) any later version.                                   *
12  *                                                                         *
13  *   This program is distributed in the hope that it will be useful,       *
14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
16  *   GNU General Public License for more details.                          *
17  *                                                                         *
18  *   You should have received a copy of the GNU General Public License     *
19  *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
20  ***************************************************************************/
21
22 #ifdef HAVE_CONFIG_H
23 #include <config.h>
24 #endif
25 #include <flash/common.h>
26 #include <flash/nor/core.h>
27 #include <flash/nor/imp.h>
28 #include <target/image.h>
29
30 /**
31  * @file
32  * Upper level of NOR flash framework.
33  * The lower level interfaces are to drivers.  These upper level ones
34  * primarily support access from Tcl scripts or from GDB.
35  */
36
37 static struct flash_bank *flash_banks;
38
39 int flash_driver_erase(struct flash_bank *bank, int first, int last)
40 {
41         int retval;
42
43         retval = bank->driver->erase(bank, first, last);
44         if (retval != ERROR_OK)
45                 LOG_ERROR("failed erasing sectors %d to %d", first, last);
46
47         return retval;
48 }
49
50 int flash_driver_protect(struct flash_bank *bank, int set, int first, int last)
51 {
52         int retval;
53
54         /* callers may not supply illegal parameters ... */
55         if (first < 0 || first > last || last >= bank->num_sectors) {
56                 LOG_ERROR("illegal sector range");
57                 return ERROR_FAIL;
58         }
59
60         /* force "set" to 0/1 */
61         set = !!set;
62
63         /* DANGER!
64          *
65          * We must not use any cached information about protection state!!!!
66          *
67          * There are a million things that could change the protect state:
68          *
69          * the target could have reset, power cycled, been hot plugged,
70          * the application could have run, etc.
71          *
72          * Drivers only receive valid sector range.
73          */
74         retval = bank->driver->protect(bank, set, first, last);
75         if (retval != ERROR_OK)
76                 LOG_ERROR("failed setting protection for areas %d to %d", first, last);
77
78         return retval;
79 }
80
81 int flash_driver_write(struct flash_bank *bank,
82         uint8_t *buffer, uint32_t offset, uint32_t count)
83 {
84         int retval;
85
86         retval = bank->driver->write(bank, buffer, offset, count);
87         if (retval != ERROR_OK) {
88                 LOG_ERROR(
89                         "error writing to flash at address 0x%08" PRIx32 " at offset 0x%8.8" PRIx32,
90                         bank->base,
91                         offset);
92         }
93
94         return retval;
95 }
96
97 int flash_driver_read(struct flash_bank *bank,
98         uint8_t *buffer, uint32_t offset, uint32_t count)
99 {
100         int retval;
101
102         LOG_DEBUG("call flash_driver_read()");
103
104         retval = bank->driver->read(bank, buffer, offset, count);
105         if (retval != ERROR_OK) {
106                 LOG_ERROR(
107                         "error reading to flash at address 0x%08" PRIx32 " at offset 0x%8.8" PRIx32,
108                         bank->base,
109                         offset);
110         }
111
112         return retval;
113 }
114
115 int default_flash_read(struct flash_bank *bank,
116         uint8_t *buffer, uint32_t offset, uint32_t count)
117 {
118         return target_read_buffer(bank->target, offset + bank->base, count, buffer);
119 }
120
121 void flash_bank_add(struct flash_bank *bank)
122 {
123         /* put flash bank in linked list */
124         unsigned bank_num = 0;
125         if (flash_banks) {
126                 /* find last flash bank */
127                 struct flash_bank *p = flash_banks;
128                 while (NULL != p->next) {
129                         bank_num += 1;
130                         p = p->next;
131                 }
132                 p->next = bank;
133                 bank_num += 1;
134         } else
135                 flash_banks = bank;
136
137         bank->bank_number = bank_num;
138 }
139
140 struct flash_bank *flash_bank_list(void)
141 {
142         return flash_banks;
143 }
144
145 struct flash_bank *get_flash_bank_by_num_noprobe(int num)
146 {
147         struct flash_bank *p;
148         int i = 0;
149
150         for (p = flash_banks; p; p = p->next) {
151                 if (i++ == num)
152                         return p;
153         }
154         LOG_ERROR("flash bank %d does not exist", num);
155         return NULL;
156 }
157
158 int flash_get_bank_count(void)
159 {
160         struct flash_bank *p;
161         int i = 0;
162         for (p = flash_banks; p; p = p->next)
163                 i++;
164         return i;
165 }
166
167 struct flash_bank *get_flash_bank_by_name_noprobe(const char *name)
168 {
169         unsigned requested = get_flash_name_index(name);
170         unsigned found = 0;
171
172         struct flash_bank *bank;
173         for (bank = flash_banks; NULL != bank; bank = bank->next) {
174                 if (strcmp(bank->name, name) == 0)
175                         return bank;
176                 if (!flash_driver_name_matches(bank->driver->name, name))
177                         continue;
178                 if (++found < requested)
179                         continue;
180                 return bank;
181         }
182         return NULL;
183 }
184
185 int get_flash_bank_by_name(const char *name, struct flash_bank **bank_result)
186 {
187         struct flash_bank *bank;
188         int retval;
189
190         bank = get_flash_bank_by_name_noprobe(name);
191         if (bank != NULL) {
192                 retval = bank->driver->auto_probe(bank);
193
194                 if (retval != ERROR_OK) {
195                         LOG_ERROR("auto_probe failed");
196                         return retval;
197                 }
198         }
199
200         *bank_result = bank;
201         return ERROR_OK;
202 }
203
204 int get_flash_bank_by_num(int num, struct flash_bank **bank)
205 {
206         struct flash_bank *p = get_flash_bank_by_num_noprobe(num);
207         int retval;
208
209         if (p == NULL)
210                 return ERROR_FAIL;
211
212         retval = p->driver->auto_probe(p);
213
214         if (retval != ERROR_OK) {
215                 LOG_ERROR("auto_probe failed");
216                 return retval;
217         }
218         *bank = p;
219         return ERROR_OK;
220 }
221
222 /* lookup flash bank by address, bank not found is success, but
223  * result_bank is set to NULL. */
224 int get_flash_bank_by_addr(struct target *target,
225         uint32_t addr,
226         bool check,
227         struct flash_bank **result_bank)
228 {
229         struct flash_bank *c;
230
231         /* cycle through bank list */
232         for (c = flash_banks; c; c = c->next) {
233                 if (c->target != target)
234                         continue;
235
236                 int retval;
237                 retval = c->driver->auto_probe(c);
238
239                 if (retval != ERROR_OK) {
240                         LOG_ERROR("auto_probe failed");
241                         return retval;
242                 }
243                 /* check whether address belongs to this flash bank */
244                 if ((addr >= c->base) && (addr <= c->base + (c->size - 1))) {
245                         *result_bank = c;
246                         return ERROR_OK;
247                 }
248         }
249         *result_bank = NULL;
250         if (check) {
251                 LOG_ERROR("No flash at address 0x%08" PRIx32, addr);
252                 return ERROR_FAIL;
253         }
254         return ERROR_OK;
255 }
256
257 static int default_flash_mem_blank_check(struct flash_bank *bank)
258 {
259         struct target *target = bank->target;
260         const int buffer_size = 1024;
261         int i;
262         uint32_t nBytes;
263         int retval = ERROR_OK;
264
265         if (bank->target->state != TARGET_HALTED) {
266                 LOG_ERROR("Target not halted");
267                 return ERROR_TARGET_NOT_HALTED;
268         }
269
270         uint8_t *buffer = malloc(buffer_size);
271
272         for (i = 0; i < bank->num_sectors; i++) {
273                 uint32_t j;
274                 bank->sectors[i].is_erased = 1;
275
276                 for (j = 0; j < bank->sectors[i].size; j += buffer_size) {
277                         uint32_t chunk;
278                         chunk = buffer_size;
279                         if (chunk > (j - bank->sectors[i].size))
280                                 chunk = (j - bank->sectors[i].size);
281
282                         retval = target_read_memory(target,
283                                         bank->base + bank->sectors[i].offset + j,
284                                         4,
285                                         chunk/4,
286                                         buffer);
287                         if (retval != ERROR_OK)
288                                 goto done;
289
290                         for (nBytes = 0; nBytes < chunk; nBytes++) {
291                                 if (buffer[nBytes] != 0xFF) {
292                                         bank->sectors[i].is_erased = 0;
293                                         break;
294                                 }
295                         }
296                 }
297         }
298
299 done:
300         free(buffer);
301
302         return retval;
303 }
304
305 int default_flash_blank_check(struct flash_bank *bank)
306 {
307         struct target *target = bank->target;
308         int i;
309         int retval;
310         int fast_check = 0;
311         uint32_t blank;
312
313         if (bank->target->state != TARGET_HALTED) {
314                 LOG_ERROR("Target not halted");
315                 return ERROR_TARGET_NOT_HALTED;
316         }
317
318         for (i = 0; i < bank->num_sectors; i++) {
319                 uint32_t address = bank->base + bank->sectors[i].offset;
320                 uint32_t size = bank->sectors[i].size;
321
322                 retval = target_blank_check_memory(target, address, size, &blank);
323                 if (retval != ERROR_OK) {
324                         fast_check = 0;
325                         break;
326                 }
327                 if (blank == 0xFF)
328                         bank->sectors[i].is_erased = 1;
329                 else
330                         bank->sectors[i].is_erased = 0;
331                 fast_check = 1;
332         }
333
334         if (!fast_check) {
335                 LOG_USER("Running slow fallback erase check - add working memory");
336                 return default_flash_mem_blank_check(bank);
337         }
338
339         return ERROR_OK;
340 }
341
342 /* Manipulate given flash region, selecting the bank according to target
343  * and address.  Maps an address range to a set of sectors, and issues
344  * the callback() on that set ... e.g. to erase or unprotect its members.
345  *
346  * (Note a current bad assumption:  that protection operates on the same
347  * size sectors as erase operations use.)
348  *
349  * The "pad_reason" parameter is a kind of boolean:  when it's NULL, the
350  * range must fit those sectors exactly.  This is clearly safe; it can't
351  * erase data which the caller said to leave alone, for example.  If it's
352  * non-NULL, rather than failing, extra data in the first and/or last
353  * sectors will be added to the range, and that reason string is used when
354  * warning about those additions.
355  */
356 static int flash_iterate_address_range_inner(struct target *target,
357         char *pad_reason, uint32_t addr, uint32_t length,
358         int (*callback)(struct flash_bank *bank, int first, int last))
359 {
360         struct flash_bank *c;
361         uint32_t last_addr = addr + length;     /* first address AFTER end */
362         int first = -1;
363         int last = -1;
364         int i;
365
366         int retval = get_flash_bank_by_addr(target, addr, true, &c);
367         if (retval != ERROR_OK)
368                 return retval;
369
370         if (c->size == 0 || c->num_sectors == 0) {
371                 LOG_ERROR("Bank is invalid");
372                 return ERROR_FLASH_BANK_INVALID;
373         }
374
375         if (length == 0) {
376                 /* special case, erase whole bank when length is zero */
377                 if (addr != c->base) {
378                         LOG_ERROR("Whole bank access must start at beginning of bank.");
379                         return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
380                 }
381
382                 return callback(c, 0, c->num_sectors - 1);
383         }
384
385         /* check whether it all fits in this bank */
386         if (addr + length - 1 > c->base + c->size - 1) {
387                 LOG_ERROR("Flash access does not fit into bank.");
388                 return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
389         }
390
391         /** @todo: handle erasures that cross into adjacent banks */
392
393         addr -= c->base;
394         last_addr -= c->base;
395
396         for (i = 0; i < c->num_sectors; i++) {
397                 struct flash_sector *f = c->sectors + i;
398                 uint32_t end = f->offset + f->size;
399
400                 /* start only on a sector boundary */
401                 if (first < 0) {
402                         /* scanned past the first sector? */
403                         if (addr < f->offset)
404                                 break;
405
406                         /* is this the first sector? */
407                         if (addr == f->offset)
408                                 first = i;
409
410                         /* Does this need head-padding?  If so, pad and warn;
411                          * or else force an error.
412                          *
413                          * Such padding can make trouble, since *WE* can't
414                          * ever know if that data was in use.  The warning
415                          * should help users sort out messes later.
416                          */
417                         else if (addr < end && pad_reason) {
418                                 /* FIXME say how many bytes (e.g. 80 KB) */
419                                 LOG_WARNING("Adding extra %s range, "
420                                         "%#8.8x to %#8.8x",
421                                         pad_reason,
422                                         (unsigned) f->offset,
423                                         (unsigned) addr - 1);
424                                 first = i;
425                         } else
426                                 continue;
427                 }
428
429                 /* is this (also?) the last sector? */
430                 if (last_addr == end) {
431                         last = i;
432                         break;
433                 }
434
435                 /* Does this need tail-padding?  If so, pad and warn;
436                  * or else force an error.
437                  */
438                 if (last_addr < end && pad_reason) {
439                         /* FIXME say how many bytes (e.g. 80 KB) */
440                         LOG_WARNING("Adding extra %s range, "
441                                 "%#8.8x to %#8.8x",
442                                 pad_reason,
443                                 (unsigned) last_addr,
444                                 (unsigned) end - 1);
445                         last = i;
446                         break;
447                 }
448
449                 /* MUST finish on a sector boundary */
450                 if (last_addr <= f->offset)
451                         break;
452         }
453
454         /* invalid start or end address? */
455         if (first == -1 || last == -1) {
456                 LOG_ERROR("address range 0x%8.8x .. 0x%8.8x "
457                         "is not sector-aligned",
458                         (unsigned) (c->base + addr),
459                         (unsigned) (c->base + last_addr - 1));
460                 return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
461         }
462
463         /* The NOR driver may trim this range down, based on what
464          * sectors are already erased/unprotected.  GDB currently
465          * blocks such optimizations.
466          */
467         return callback(c, first, last);
468 }
469
470 /* The inner fn only handles a single bank, we could be spanning
471  * multiple chips.
472  */
473 static int flash_iterate_address_range(struct target *target,
474         char *pad_reason, uint32_t addr, uint32_t length,
475         int (*callback)(struct flash_bank *bank, int first, int last))
476 {
477         struct flash_bank *c;
478         int retval = ERROR_OK;
479
480         /* Danger! zero-length iterations means entire bank! */
481         do {
482                 retval = get_flash_bank_by_addr(target, addr, true, &c);
483                 if (retval != ERROR_OK)
484                         return retval;
485
486                 uint32_t cur_length = length;
487                 /* check whether it all fits in this bank */
488                 if (addr + length - 1 > c->base + c->size - 1) {
489                         LOG_DEBUG("iterating over more than one flash bank.");
490                         cur_length = c->base + c->size - addr;
491                 }
492                 retval = flash_iterate_address_range_inner(target,
493                                 pad_reason, addr, cur_length,
494                                 callback);
495                 if (retval != ERROR_OK)
496                         break;
497
498                 length -= cur_length;
499                 addr += cur_length;
500         } while (length > 0);
501
502         return retval;
503 }
504
505 int flash_erase_address_range(struct target *target,
506         bool pad, uint32_t addr, uint32_t length)
507 {
508         return flash_iterate_address_range(target, pad ? "erase" : NULL,
509                 addr, length, &flash_driver_erase);
510 }
511
512 static int flash_driver_unprotect(struct flash_bank *bank, int first, int last)
513 {
514         return flash_driver_protect(bank, 0, first, last);
515 }
516
517 int flash_unlock_address_range(struct target *target, uint32_t addr, uint32_t length)
518 {
519         /* By default, pad to sector boundaries ... the real issue here
520          * is that our (only) caller *permanently* removes protection,
521          * and doesn't restore it.
522          */
523         return flash_iterate_address_range(target, "unprotect",
524                 addr, length, &flash_driver_unprotect);
525 }
526
527 static int compare_section(const void *a, const void *b)
528 {
529         struct imagesection *b1, *b2;
530         b1 = *((struct imagesection **)a);
531         b2 = *((struct imagesection **)b);
532
533         if (b1->base_address == b2->base_address)
534                 return 0;
535         else if (b1->base_address > b2->base_address)
536                 return 1;
537         else
538                 return -1;
539 }
540
541 int flash_write_unlock(struct target *target, struct image *image,
542         uint32_t *written, int erase, bool unlock)
543 {
544         int retval = ERROR_OK;
545
546         int section;
547         uint32_t section_offset;
548         struct flash_bank *c;
549         int *padding;
550
551         section = 0;
552         section_offset = 0;
553
554         if (written)
555                 *written = 0;
556
557         if (erase) {
558                 /* assume all sectors need erasing - stops any problems
559                  * when flash_write is called multiple times */
560
561                 flash_set_dirty();
562         }
563
564         /* allocate padding array */
565         padding = calloc(image->num_sections, sizeof(*padding));
566
567         /* This fn requires all sections to be in ascending order of addresses,
568          * whereas an image can have sections out of order. */
569         struct imagesection **sections = malloc(sizeof(struct imagesection *) *
570                         image->num_sections);
571         int i;
572         for (i = 0; i < image->num_sections; i++)
573                 sections[i] = &image->sections[i];
574
575         qsort(sections, image->num_sections, sizeof(struct imagesection *),
576                 compare_section);
577
578         /* loop until we reach end of the image */
579         while (section < image->num_sections) {
580                 uint32_t buffer_size;
581                 uint8_t *buffer;
582                 int section_last;
583                 uint32_t run_address = sections[section]->base_address + section_offset;
584                 uint32_t run_size = sections[section]->size - section_offset;
585                 int pad_bytes = 0;
586
587                 if (sections[section]->size ==  0) {
588                         LOG_WARNING("empty section %d", section);
589                         section++;
590                         section_offset = 0;
591                         continue;
592                 }
593
594                 /* find the corresponding flash bank */
595                 retval = get_flash_bank_by_addr(target, run_address, false, &c);
596                 if (retval != ERROR_OK)
597                         goto done;
598                 if (c == NULL) {
599                         LOG_WARNING("no flash bank found for address %" PRIx32, run_address);
600                         section++;      /* and skip it */
601                         section_offset = 0;
602                         continue;
603                 }
604
605                 /* collect consecutive sections which fall into the same bank */
606                 section_last = section;
607                 padding[section] = 0;
608                 while ((run_address + run_size - 1 < c->base + c->size - 1) &&
609                                 (section_last + 1 < image->num_sections)) {
610                         /* sections are sorted */
611                         assert(sections[section_last + 1]->base_address >= c->base);
612                         if (sections[section_last + 1]->base_address >= (c->base + c->size)) {
613                                 /* Done with this bank */
614                                 break;
615                         }
616
617                         /* FIXME This needlessly touches sectors BETWEEN the
618                          * sections it's writing.  Without auto erase, it just
619                          * writes ones.  That WILL INVALIDATE data in cases
620                          * like Stellaris Tempest chips, corrupting internal
621                          * ECC codes; and at least FreeScale suggests issues
622                          * with that approach (in HC11 documentation).
623                          *
624                          * With auto erase enabled, data in those sectors will
625                          * be needlessly destroyed; and some of the limited
626                          * number of flash erase cycles will be wasted...
627                          *
628                          * In both cases, the extra writes slow things down.
629                          */
630
631                         /* if we have multiple sections within our image,
632                          * flash programming could fail due to alignment issues
633                          * attempt to rebuild a consecutive buffer for the flash loader */
634                         pad_bytes = (sections[section_last + 1]->base_address) - (run_address + run_size);
635                         padding[section_last] = pad_bytes;
636                         run_size += sections[++section_last]->size;
637                         run_size += pad_bytes;
638
639                         if (pad_bytes > 0)
640                                 LOG_INFO("Padding image section %d with %d bytes",
641                                         section_last-1,
642                                         pad_bytes);
643                 }
644
645                 if (run_address + run_size - 1 > c->base + c->size - 1) {
646                         /* If we have more than one flash chip back to back, then we limit
647                          * the current write operation to the current chip.
648                          */
649                         LOG_DEBUG("Truncate flash run size to the current flash chip.");
650
651                         run_size = c->base + c->size - run_address;
652                         assert(run_size > 0);
653                 }
654
655                 /* If we're applying any sector automagic, then pad this
656                  * (maybe-combined) segment to the end of its last sector.
657                  */
658                 if (unlock || erase) {
659                         int sector;
660                         uint32_t offset_start = run_address - c->base;
661                         uint32_t offset_end = offset_start + run_size;
662                         uint32_t end = offset_end, delta;
663
664                         for (sector = 0; sector < c->num_sectors; sector++) {
665                                 end = c->sectors[sector].offset
666                                         + c->sectors[sector].size;
667                                 if (offset_end <= end)
668                                         break;
669                         }
670
671                         delta = end - offset_end;
672                         padding[section_last] += delta;
673                         run_size += delta;
674                 }
675
676                 /* allocate buffer */
677                 buffer = malloc(run_size);
678                 if (buffer == NULL) {
679                         LOG_ERROR("Out of memory for flash bank buffer");
680                         retval = ERROR_FAIL;
681                         goto done;
682                 }
683                 buffer_size = 0;
684
685                 /* read sections to the buffer */
686                 while (buffer_size < run_size) {
687                         size_t size_read;
688
689                         size_read = run_size - buffer_size;
690                         if (size_read > sections[section]->size - section_offset)
691                                 size_read = sections[section]->size - section_offset;
692
693                         /* KLUDGE!
694                          *
695                          * #¤%#"%¤% we have to figure out the section # from the sorted
696                          * list of pointers to sections to invoke image_read_section()...
697                          */
698                         intptr_t diff = (intptr_t)sections[section] - (intptr_t)image->sections;
699                         int t_section_num = diff / sizeof(struct imagesection);
700
701                         LOG_DEBUG("image_read_section: section = %d, t_section_num = %d, "
702                                         "section_offset = %d, buffer_size = %d, size_read = %d",
703                                 (int)section, (int)t_section_num, (int)section_offset,
704                                 (int)buffer_size, (int)size_read);
705                         retval = image_read_section(image, t_section_num, section_offset,
706                                         size_read, buffer + buffer_size, &size_read);
707                         if (retval != ERROR_OK || size_read == 0) {
708                                 free(buffer);
709                                 goto done;
710                         }
711
712                         /* see if we need to pad the section */
713                         while (padding[section]--)
714                                 (buffer + buffer_size)[size_read++] = c->default_padded_value;
715
716                         buffer_size += size_read;
717                         section_offset += size_read;
718
719                         if (section_offset >= sections[section]->size) {
720                                 section++;
721                                 section_offset = 0;
722                         }
723                 }
724
725                 retval = ERROR_OK;
726
727                 if (unlock)
728                         retval = flash_unlock_address_range(target, run_address, run_size);
729                 if (retval == ERROR_OK) {
730                         if (erase) {
731                                 /* calculate and erase sectors */
732                                 retval = flash_erase_address_range(target,
733                                                 true, run_address, run_size);
734                         }
735                 }
736
737                 if (retval == ERROR_OK) {
738                         /* write flash sectors */
739                         retval = flash_driver_write(c, buffer, run_address - c->base, run_size);
740                 }
741
742                 free(buffer);
743
744                 if (retval != ERROR_OK) {
745                         /* abort operation */
746                         goto done;
747                 }
748
749                 if (written != NULL)
750                         *written += run_size;   /* add run size to total written counter */
751         }
752
753 done:
754         free(sections);
755         free(padding);
756
757         return retval;
758 }
759
760 int flash_write(struct target *target, struct image *image,
761         uint32_t *written, int erase)
762 {
763         return flash_write_unlock(target, image, written, erase, false);
764 }