1 /***************************************************************************
2 * Copyright (C) 2005, 2007 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * Copyright (C) 2009 Michael Schwingen *
5 * michael@schwingen.org *
6 * Copyright (C) 2010 Øyvind Harboe <oyvind.harboe@zylin.com> *
7 * Copyright (C) 2010 by Antonio Borneo <borneo.antonio@gmail.com> *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
14 * This program is distributed in the hope that it will be useful, *
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
17 * GNU General Public License for more details. *
19 * You should have received a copy of the GNU General Public License *
20 * along with this program; if not, write to the *
21 * Free Software Foundation, Inc., *
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
23 ***************************************************************************/
32 #include <target/arm.h>
33 #include <target/arm7_9_common.h>
34 #include <target/armv7m.h>
35 #include <target/mips32.h>
36 #include <helper/binarybuffer.h>
37 #include <target/algorithm.h>
39 #define CFI_MAX_BUS_WIDTH 4
40 #define CFI_MAX_CHIP_WIDTH 4
42 /* defines internal maximum size for code fragment in cfi_intel_write_block() */
43 #define CFI_MAX_INTEL_CODESIZE 256
45 /* some id-types with specific handling */
46 #define AT49BV6416 0x00d6
47 #define AT49BV6416T 0x00d2
49 static struct cfi_unlock_addresses cfi_unlock_addresses[] = {
50 [CFI_UNLOCK_555_2AA] = { .unlock1 = 0x555, .unlock2 = 0x2aa },
51 [CFI_UNLOCK_5555_2AAA] = { .unlock1 = 0x5555, .unlock2 = 0x2aaa },
54 /* CFI fixups foward declarations */
55 static void cfi_fixup_0002_erase_regions(struct flash_bank *bank, void *param);
56 static void cfi_fixup_0002_unlock_addresses(struct flash_bank *bank, void *param);
57 static void cfi_fixup_reversed_erase_regions(struct flash_bank *bank, void *param);
58 static void cfi_fixup_0002_write_buffer(struct flash_bank *bank, void *param);
60 /* fixup after reading cmdset 0002 primary query table */
61 static const struct cfi_fixup cfi_0002_fixups[] = {
62 {CFI_MFR_SST, 0x00D4, cfi_fixup_0002_unlock_addresses,
63 &cfi_unlock_addresses[CFI_UNLOCK_5555_2AAA]},
64 {CFI_MFR_SST, 0x00D5, cfi_fixup_0002_unlock_addresses,
65 &cfi_unlock_addresses[CFI_UNLOCK_5555_2AAA]},
66 {CFI_MFR_SST, 0x00D6, cfi_fixup_0002_unlock_addresses,
67 &cfi_unlock_addresses[CFI_UNLOCK_5555_2AAA]},
68 {CFI_MFR_SST, 0x00D7, cfi_fixup_0002_unlock_addresses,
69 &cfi_unlock_addresses[CFI_UNLOCK_5555_2AAA]},
70 {CFI_MFR_SST, 0x2780, cfi_fixup_0002_unlock_addresses,
71 &cfi_unlock_addresses[CFI_UNLOCK_5555_2AAA]},
72 {CFI_MFR_SST, 0x274b, cfi_fixup_0002_unlock_addresses,
73 &cfi_unlock_addresses[CFI_UNLOCK_5555_2AAA]},
74 {CFI_MFR_SST, 0x236d, cfi_fixup_0002_unlock_addresses,
75 &cfi_unlock_addresses[CFI_UNLOCK_555_2AA]},
76 {CFI_MFR_ATMEL, 0x00C8, cfi_fixup_reversed_erase_regions, NULL},
77 {CFI_MFR_ST, 0x22C4, cfi_fixup_reversed_erase_regions, NULL}, /* M29W160ET */
78 {CFI_MFR_FUJITSU, 0x22ea, cfi_fixup_0002_unlock_addresses,
79 &cfi_unlock_addresses[CFI_UNLOCK_555_2AA]},
80 {CFI_MFR_FUJITSU, 0x226b, cfi_fixup_0002_unlock_addresses,
81 &cfi_unlock_addresses[CFI_UNLOCK_5555_2AAA]},
82 {CFI_MFR_AMIC, 0xb31a, cfi_fixup_0002_unlock_addresses,
83 &cfi_unlock_addresses[CFI_UNLOCK_555_2AA]},
84 {CFI_MFR_MX, 0x225b, cfi_fixup_0002_unlock_addresses,
85 &cfi_unlock_addresses[CFI_UNLOCK_555_2AA]},
86 {CFI_MFR_EON, 0x225b, cfi_fixup_0002_unlock_addresses,
87 &cfi_unlock_addresses[CFI_UNLOCK_555_2AA]},
88 {CFI_MFR_AMD, 0x225b, cfi_fixup_0002_unlock_addresses,
89 &cfi_unlock_addresses[CFI_UNLOCK_555_2AA]},
90 {CFI_MFR_ANY, CFI_ID_ANY, cfi_fixup_0002_erase_regions, NULL},
91 {CFI_MFR_ST, 0x227E, cfi_fixup_0002_write_buffer, NULL},/* M29W128G */
95 /* fixup after reading cmdset 0001 primary query table */
96 static const struct cfi_fixup cfi_0001_fixups[] = {
100 static void cfi_fixup(struct flash_bank *bank, const struct cfi_fixup *fixups)
102 struct cfi_flash_bank *cfi_info = bank->driver_priv;
103 const struct cfi_fixup *f;
105 for (f = fixups; f->fixup; f++) {
106 if (((f->mfr == CFI_MFR_ANY) || (f->mfr == cfi_info->manufacturer)) &&
107 ((f->id == CFI_ID_ANY) || (f->id == cfi_info->device_id)))
108 f->fixup(bank, f->param);
112 /* inline uint32_t flash_address(struct flash_bank *bank, int sector, uint32_t offset) */
113 static inline uint32_t flash_address(struct flash_bank *bank, int sector, uint32_t offset)
115 struct cfi_flash_bank *cfi_info = bank->driver_priv;
117 if (cfi_info->x16_as_x8)
120 /* while the sector list isn't built, only accesses to sector 0 work */
122 return bank->base + offset * bank->bus_width;
124 if (!bank->sectors) {
125 LOG_ERROR("BUG: sector list not yet built");
128 return bank->base + bank->sectors[sector].offset + offset * bank->bus_width;
132 static void cfi_command(struct flash_bank *bank, uint8_t cmd, uint8_t *cmd_buf)
136 /* clear whole buffer, to ensure bits that exceed the bus_width
139 for (i = 0; i < CFI_MAX_BUS_WIDTH; i++)
142 if (bank->target->endianness == TARGET_LITTLE_ENDIAN) {
143 for (i = bank->bus_width; i > 0; i--)
144 *cmd_buf++ = (i & (bank->chip_width - 1)) ? 0x0 : cmd;
146 for (i = 1; i <= bank->bus_width; i++)
147 *cmd_buf++ = (i & (bank->chip_width - 1)) ? 0x0 : cmd;
151 static int cfi_send_command(struct flash_bank *bank, uint8_t cmd, uint32_t address)
153 uint8_t command[CFI_MAX_BUS_WIDTH];
155 cfi_command(bank, cmd, command);
156 return target_write_memory(bank->target, address, bank->bus_width, 1, command);
159 /* read unsigned 8-bit value from the bank
160 * flash banks are expected to be made of similar chips
161 * the query result should be the same for all
163 static int cfi_query_u8(struct flash_bank *bank, int sector, uint32_t offset, uint8_t *val)
165 struct target *target = bank->target;
166 uint8_t data[CFI_MAX_BUS_WIDTH];
169 retval = target_read_memory(target, flash_address(bank, sector, offset),
170 bank->bus_width, 1, data);
171 if (retval != ERROR_OK)
174 if (bank->target->endianness == TARGET_LITTLE_ENDIAN)
177 *val = data[bank->bus_width - 1];
182 /* read unsigned 8-bit value from the bank
183 * in case of a bank made of multiple chips,
184 * the individual values are ORed
186 static int cfi_get_u8(struct flash_bank *bank, int sector, uint32_t offset, uint8_t *val)
188 struct target *target = bank->target;
189 uint8_t data[CFI_MAX_BUS_WIDTH];
193 retval = target_read_memory(target, flash_address(bank, sector, offset),
194 bank->bus_width, 1, data);
195 if (retval != ERROR_OK)
198 if (bank->target->endianness == TARGET_LITTLE_ENDIAN) {
199 for (i = 0; i < bank->bus_width / bank->chip_width; i++)
205 for (i = 0; i < bank->bus_width / bank->chip_width; i++)
206 value |= data[bank->bus_width - 1 - i];
213 static int cfi_query_u16(struct flash_bank *bank, int sector, uint32_t offset, uint16_t *val)
215 struct target *target = bank->target;
216 struct cfi_flash_bank *cfi_info = bank->driver_priv;
217 uint8_t data[CFI_MAX_BUS_WIDTH * 2];
220 if (cfi_info->x16_as_x8) {
222 for (i = 0; i < 2; i++) {
223 retval = target_read_memory(target, flash_address(bank, sector, offset + i),
224 bank->bus_width, 1, &data[i * bank->bus_width]);
225 if (retval != ERROR_OK)
229 retval = target_read_memory(target, flash_address(bank, sector, offset),
230 bank->bus_width, 2, data);
231 if (retval != ERROR_OK)
235 if (bank->target->endianness == TARGET_LITTLE_ENDIAN)
236 *val = data[0] | data[bank->bus_width] << 8;
238 *val = data[bank->bus_width - 1] | data[(2 * bank->bus_width) - 1] << 8;
243 static int cfi_query_u32(struct flash_bank *bank, int sector, uint32_t offset, uint32_t *val)
245 struct target *target = bank->target;
246 struct cfi_flash_bank *cfi_info = bank->driver_priv;
247 uint8_t data[CFI_MAX_BUS_WIDTH * 4];
250 if (cfi_info->x16_as_x8) {
252 for (i = 0; i < 4; i++) {
253 retval = target_read_memory(target, flash_address(bank, sector, offset + i),
254 bank->bus_width, 1, &data[i * bank->bus_width]);
255 if (retval != ERROR_OK)
259 retval = target_read_memory(target, flash_address(bank, sector, offset),
260 bank->bus_width, 4, data);
261 if (retval != ERROR_OK)
265 if (bank->target->endianness == TARGET_LITTLE_ENDIAN)
266 *val = data[0] | data[bank->bus_width] << 8 |
267 data[bank->bus_width * 2] << 16 | data[bank->bus_width * 3] << 24;
269 *val = data[bank->bus_width - 1] | data[(2 * bank->bus_width) - 1] << 8 |
270 data[(3 * bank->bus_width) - 1] << 16 |
271 data[(4 * bank->bus_width) - 1] << 24;
276 static int cfi_reset(struct flash_bank *bank)
278 struct cfi_flash_bank *cfi_info = bank->driver_priv;
279 int retval = ERROR_OK;
281 retval = cfi_send_command(bank, 0xf0, flash_address(bank, 0, 0x0));
282 if (retval != ERROR_OK)
285 retval = cfi_send_command(bank, 0xff, flash_address(bank, 0, 0x0));
286 if (retval != ERROR_OK)
289 if (cfi_info->manufacturer == 0x20 &&
290 (cfi_info->device_id == 0x227E || cfi_info->device_id == 0x7E)) {
291 /* Numonix M29W128G is cmd 0xFF intolerant - causes internal undefined state
292 * so we send an extra 0xF0 reset to fix the bug */
293 retval = cfi_send_command(bank, 0xf0, flash_address(bank, 0, 0x00));
294 if (retval != ERROR_OK)
301 static void cfi_intel_clear_status_register(struct flash_bank *bank)
303 cfi_send_command(bank, 0x50, flash_address(bank, 0, 0x0));
306 static int cfi_intel_wait_status_busy(struct flash_bank *bank, int timeout, uint8_t *val)
310 int retval = ERROR_OK;
314 LOG_ERROR("timeout while waiting for WSM to become ready");
318 retval = cfi_get_u8(bank, 0, 0x0, &status);
319 if (retval != ERROR_OK)
328 /* mask out bit 0 (reserved) */
329 status = status & 0xfe;
331 LOG_DEBUG("status: 0x%x", status);
333 if (status != 0x80) {
334 LOG_ERROR("status register: 0x%x", status);
336 LOG_ERROR("Block Lock-Bit Detected, Operation Abort");
338 LOG_ERROR("Program suspended");
340 LOG_ERROR("Low Programming Voltage Detected, Operation Aborted");
342 LOG_ERROR("Program Error / Error in Setting Lock-Bit");
344 LOG_ERROR("Error in Block Erasure or Clear Lock-Bits");
346 LOG_ERROR("Block Erase Suspended");
348 cfi_intel_clear_status_register(bank);
357 static int cfi_spansion_wait_status_busy(struct flash_bank *bank, int timeout)
359 uint8_t status, oldstatus;
360 struct cfi_flash_bank *cfi_info = bank->driver_priv;
363 retval = cfi_get_u8(bank, 0, 0x0, &oldstatus);
364 if (retval != ERROR_OK)
368 retval = cfi_get_u8(bank, 0, 0x0, &status);
370 if (retval != ERROR_OK)
373 if ((status ^ oldstatus) & 0x40) {
374 if (status & cfi_info->status_poll_mask & 0x20) {
375 retval = cfi_get_u8(bank, 0, 0x0, &oldstatus);
376 if (retval != ERROR_OK)
378 retval = cfi_get_u8(bank, 0, 0x0, &status);
379 if (retval != ERROR_OK)
381 if ((status ^ oldstatus) & 0x40) {
382 LOG_ERROR("dq5 timeout, status: 0x%x", status);
383 return ERROR_FLASH_OPERATION_FAILED;
385 LOG_DEBUG("status: 0x%x", status);
389 } else {/* no toggle: finished, OK */
390 LOG_DEBUG("status: 0x%x", status);
396 } while (timeout-- > 0);
398 LOG_ERROR("timeout, status: 0x%x", status);
400 return ERROR_FLASH_BUSY;
403 static int cfi_read_intel_pri_ext(struct flash_bank *bank)
406 struct cfi_flash_bank *cfi_info = bank->driver_priv;
407 struct cfi_intel_pri_ext *pri_ext;
409 if (cfi_info->pri_ext)
410 free(cfi_info->pri_ext);
412 pri_ext = malloc(sizeof(struct cfi_intel_pri_ext));
413 if (pri_ext == NULL) {
414 LOG_ERROR("Out of memory");
417 cfi_info->pri_ext = pri_ext;
419 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 0, &pri_ext->pri[0]);
420 if (retval != ERROR_OK)
422 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 1, &pri_ext->pri[1]);
423 if (retval != ERROR_OK)
425 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 2, &pri_ext->pri[2]);
426 if (retval != ERROR_OK)
429 if ((pri_ext->pri[0] != 'P') || (pri_ext->pri[1] != 'R') || (pri_ext->pri[2] != 'I')) {
430 retval = cfi_reset(bank);
431 if (retval != ERROR_OK)
433 LOG_ERROR("Could not read bank flash bank information");
434 return ERROR_FLASH_BANK_INVALID;
437 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 3, &pri_ext->major_version);
438 if (retval != ERROR_OK)
440 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 4, &pri_ext->minor_version);
441 if (retval != ERROR_OK)
444 LOG_DEBUG("pri: '%c%c%c', version: %c.%c", pri_ext->pri[0], pri_ext->pri[1],
445 pri_ext->pri[2], pri_ext->major_version, pri_ext->minor_version);
447 retval = cfi_query_u32(bank, 0, cfi_info->pri_addr + 5, &pri_ext->feature_support);
448 if (retval != ERROR_OK)
450 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 9, &pri_ext->suspend_cmd_support);
451 if (retval != ERROR_OK)
453 retval = cfi_query_u16(bank, 0, cfi_info->pri_addr + 0xa, &pri_ext->blk_status_reg_mask);
454 if (retval != ERROR_OK)
457 LOG_DEBUG("feature_support: 0x%" PRIx32 ", suspend_cmd_support: "
458 "0x%x, blk_status_reg_mask: 0x%x",
459 pri_ext->feature_support,
460 pri_ext->suspend_cmd_support,
461 pri_ext->blk_status_reg_mask);
463 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 0xc, &pri_ext->vcc_optimal);
464 if (retval != ERROR_OK)
466 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 0xd, &pri_ext->vpp_optimal);
467 if (retval != ERROR_OK)
470 LOG_DEBUG("Vcc opt: %x.%x, Vpp opt: %u.%x",
471 (pri_ext->vcc_optimal & 0xf0) >> 4, pri_ext->vcc_optimal & 0x0f,
472 (pri_ext->vpp_optimal & 0xf0) >> 4, pri_ext->vpp_optimal & 0x0f);
474 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 0xe, &pri_ext->num_protection_fields);
475 if (retval != ERROR_OK)
477 if (pri_ext->num_protection_fields != 1) {
478 LOG_WARNING("expected one protection register field, but found %i",
479 pri_ext->num_protection_fields);
482 retval = cfi_query_u16(bank, 0, cfi_info->pri_addr + 0xf, &pri_ext->prot_reg_addr);
483 if (retval != ERROR_OK)
485 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 0x11, &pri_ext->fact_prot_reg_size);
486 if (retval != ERROR_OK)
488 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 0x12, &pri_ext->user_prot_reg_size);
489 if (retval != ERROR_OK)
492 LOG_DEBUG("protection_fields: %i, prot_reg_addr: 0x%x, "
493 "factory pre-programmed: %i, user programmable: %i",
494 pri_ext->num_protection_fields, pri_ext->prot_reg_addr,
495 1 << pri_ext->fact_prot_reg_size, 1 << pri_ext->user_prot_reg_size);
500 static int cfi_read_spansion_pri_ext(struct flash_bank *bank)
503 struct cfi_flash_bank *cfi_info = bank->driver_priv;
504 struct cfi_spansion_pri_ext *pri_ext;
506 if (cfi_info->pri_ext)
507 free(cfi_info->pri_ext);
509 pri_ext = malloc(sizeof(struct cfi_spansion_pri_ext));
510 if (pri_ext == NULL) {
511 LOG_ERROR("Out of memory");
514 cfi_info->pri_ext = pri_ext;
516 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 0, &pri_ext->pri[0]);
517 if (retval != ERROR_OK)
519 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 1, &pri_ext->pri[1]);
520 if (retval != ERROR_OK)
522 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 2, &pri_ext->pri[2]);
523 if (retval != ERROR_OK)
526 if ((pri_ext->pri[0] != 'P') || (pri_ext->pri[1] != 'R') || (pri_ext->pri[2] != 'I')) {
527 retval = cfi_send_command(bank, 0xf0, flash_address(bank, 0, 0x0));
528 if (retval != ERROR_OK)
530 LOG_ERROR("Could not read spansion bank information");
531 return ERROR_FLASH_BANK_INVALID;
534 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 3, &pri_ext->major_version);
535 if (retval != ERROR_OK)
537 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 4, &pri_ext->minor_version);
538 if (retval != ERROR_OK)
541 LOG_DEBUG("pri: '%c%c%c', version: %c.%c", pri_ext->pri[0], pri_ext->pri[1],
542 pri_ext->pri[2], pri_ext->major_version, pri_ext->minor_version);
544 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 5, &pri_ext->SiliconRevision);
545 if (retval != ERROR_OK)
547 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 6, &pri_ext->EraseSuspend);
548 if (retval != ERROR_OK)
550 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 7, &pri_ext->BlkProt);
551 if (retval != ERROR_OK)
553 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 8, &pri_ext->TmpBlkUnprotect);
554 if (retval != ERROR_OK)
556 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 9, &pri_ext->BlkProtUnprot);
557 if (retval != ERROR_OK)
559 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 10, &pri_ext->SimultaneousOps);
560 if (retval != ERROR_OK)
562 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 11, &pri_ext->BurstMode);
563 if (retval != ERROR_OK)
565 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 12, &pri_ext->PageMode);
566 if (retval != ERROR_OK)
568 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 13, &pri_ext->VppMin);
569 if (retval != ERROR_OK)
571 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 14, &pri_ext->VppMax);
572 if (retval != ERROR_OK)
574 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 15, &pri_ext->TopBottom);
575 if (retval != ERROR_OK)
578 LOG_DEBUG("Silicon Revision: 0x%x, Erase Suspend: 0x%x, Block protect: 0x%x",
579 pri_ext->SiliconRevision, pri_ext->EraseSuspend, pri_ext->BlkProt);
581 LOG_DEBUG("Temporary Unprotect: 0x%x, Block Protect Scheme: 0x%x, "
582 "Simultaneous Ops: 0x%x", pri_ext->TmpBlkUnprotect,
583 pri_ext->BlkProtUnprot, pri_ext->SimultaneousOps);
585 LOG_DEBUG("Burst Mode: 0x%x, Page Mode: 0x%x, ", pri_ext->BurstMode, pri_ext->PageMode);
588 LOG_DEBUG("Vpp min: %u.%x, Vpp max: %u.%x",
589 (pri_ext->VppMin & 0xf0) >> 4, pri_ext->VppMin & 0x0f,
590 (pri_ext->VppMax & 0xf0) >> 4, pri_ext->VppMax & 0x0f);
592 LOG_DEBUG("WP# protection 0x%x", pri_ext->TopBottom);
594 /* default values for implementation specific workarounds */
595 pri_ext->_unlock1 = cfi_unlock_addresses[CFI_UNLOCK_555_2AA].unlock1;
596 pri_ext->_unlock2 = cfi_unlock_addresses[CFI_UNLOCK_555_2AA].unlock2;
597 pri_ext->_reversed_geometry = 0;
602 static int cfi_read_atmel_pri_ext(struct flash_bank *bank)
605 struct cfi_atmel_pri_ext atmel_pri_ext;
606 struct cfi_flash_bank *cfi_info = bank->driver_priv;
607 struct cfi_spansion_pri_ext *pri_ext;
609 if (cfi_info->pri_ext)
610 free(cfi_info->pri_ext);
612 pri_ext = malloc(sizeof(struct cfi_spansion_pri_ext));
613 if (pri_ext == NULL) {
614 LOG_ERROR("Out of memory");
618 /* ATMEL devices use the same CFI primary command set (0x2) as AMD/Spansion,
619 * but a different primary extended query table.
620 * We read the atmel table, and prepare a valid AMD/Spansion query table.
623 memset(pri_ext, 0, sizeof(struct cfi_spansion_pri_ext));
625 cfi_info->pri_ext = pri_ext;
627 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 0, &atmel_pri_ext.pri[0]);
628 if (retval != ERROR_OK)
630 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 1, &atmel_pri_ext.pri[1]);
631 if (retval != ERROR_OK)
633 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 2, &atmel_pri_ext.pri[2]);
634 if (retval != ERROR_OK)
637 if ((atmel_pri_ext.pri[0] != 'P') || (atmel_pri_ext.pri[1] != 'R')
638 || (atmel_pri_ext.pri[2] != 'I')) {
639 retval = cfi_send_command(bank, 0xf0, flash_address(bank, 0, 0x0));
640 if (retval != ERROR_OK)
642 LOG_ERROR("Could not read atmel bank information");
643 return ERROR_FLASH_BANK_INVALID;
646 pri_ext->pri[0] = atmel_pri_ext.pri[0];
647 pri_ext->pri[1] = atmel_pri_ext.pri[1];
648 pri_ext->pri[2] = atmel_pri_ext.pri[2];
650 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 3, &atmel_pri_ext.major_version);
651 if (retval != ERROR_OK)
653 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 4, &atmel_pri_ext.minor_version);
654 if (retval != ERROR_OK)
657 LOG_DEBUG("pri: '%c%c%c', version: %c.%c", atmel_pri_ext.pri[0],
658 atmel_pri_ext.pri[1], atmel_pri_ext.pri[2],
659 atmel_pri_ext.major_version, atmel_pri_ext.minor_version);
661 pri_ext->major_version = atmel_pri_ext.major_version;
662 pri_ext->minor_version = atmel_pri_ext.minor_version;
664 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 5, &atmel_pri_ext.features);
665 if (retval != ERROR_OK)
667 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 6, &atmel_pri_ext.bottom_boot);
668 if (retval != ERROR_OK)
670 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 7, &atmel_pri_ext.burst_mode);
671 if (retval != ERROR_OK)
673 retval = cfi_query_u8(bank, 0, cfi_info->pri_addr + 8, &atmel_pri_ext.page_mode);
674 if (retval != ERROR_OK)
678 "features: 0x%2.2x, bottom_boot: 0x%2.2x, burst_mode: 0x%2.2x, page_mode: 0x%2.2x",
679 atmel_pri_ext.features,
680 atmel_pri_ext.bottom_boot,
681 atmel_pri_ext.burst_mode,
682 atmel_pri_ext.page_mode);
684 if (atmel_pri_ext.features & 0x02)
685 pri_ext->EraseSuspend = 2;
687 /* some chips got it backwards... */
688 if (cfi_info->device_id == AT49BV6416 ||
689 cfi_info->device_id == AT49BV6416T) {
690 if (atmel_pri_ext.bottom_boot)
691 pri_ext->TopBottom = 3;
693 pri_ext->TopBottom = 2;
695 if (atmel_pri_ext.bottom_boot)
696 pri_ext->TopBottom = 2;
698 pri_ext->TopBottom = 3;
701 pri_ext->_unlock1 = cfi_unlock_addresses[CFI_UNLOCK_555_2AA].unlock1;
702 pri_ext->_unlock2 = cfi_unlock_addresses[CFI_UNLOCK_555_2AA].unlock2;
707 static int cfi_read_0002_pri_ext(struct flash_bank *bank)
709 struct cfi_flash_bank *cfi_info = bank->driver_priv;
711 if (cfi_info->manufacturer == CFI_MFR_ATMEL)
712 return cfi_read_atmel_pri_ext(bank);
714 return cfi_read_spansion_pri_ext(bank);
717 static int cfi_spansion_info(struct flash_bank *bank, char *buf, int buf_size)
720 struct cfi_flash_bank *cfi_info = bank->driver_priv;
721 struct cfi_spansion_pri_ext *pri_ext = cfi_info->pri_ext;
723 printed = snprintf(buf, buf_size, "\nSpansion primary algorithm extend information:\n");
727 printed = snprintf(buf, buf_size, "pri: '%c%c%c', version: %c.%c\n", pri_ext->pri[0],
728 pri_ext->pri[1], pri_ext->pri[2],
729 pri_ext->major_version, pri_ext->minor_version);
733 printed = snprintf(buf, buf_size, "Silicon Rev.: 0x%x, Address Sensitive unlock: 0x%x\n",
734 (pri_ext->SiliconRevision) >> 2,
735 (pri_ext->SiliconRevision) & 0x03);
739 printed = snprintf(buf, buf_size, "Erase Suspend: 0x%x, Sector Protect: 0x%x\n",
740 pri_ext->EraseSuspend,
745 snprintf(buf, buf_size, "VppMin: %u.%x, VppMax: %u.%x\n",
746 (pri_ext->VppMin & 0xf0) >> 4, pri_ext->VppMin & 0x0f,
747 (pri_ext->VppMax & 0xf0) >> 4, pri_ext->VppMax & 0x0f);
752 static int cfi_intel_info(struct flash_bank *bank, char *buf, int buf_size)
755 struct cfi_flash_bank *cfi_info = bank->driver_priv;
756 struct cfi_intel_pri_ext *pri_ext = cfi_info->pri_ext;
758 printed = snprintf(buf, buf_size, "\nintel primary algorithm extend information:\n");
762 printed = snprintf(buf,
764 "pri: '%c%c%c', version: %c.%c\n",
768 pri_ext->major_version,
769 pri_ext->minor_version);
773 printed = snprintf(buf,
775 "feature_support: 0x%" PRIx32 ", "
776 "suspend_cmd_support: 0x%x, blk_status_reg_mask: 0x%x\n",
777 pri_ext->feature_support,
778 pri_ext->suspend_cmd_support,
779 pri_ext->blk_status_reg_mask);
783 printed = snprintf(buf, buf_size, "Vcc opt: %x.%x, Vpp opt: %u.%x\n",
784 (pri_ext->vcc_optimal & 0xf0) >> 4, pri_ext->vcc_optimal & 0x0f,
785 (pri_ext->vpp_optimal & 0xf0) >> 4, pri_ext->vpp_optimal & 0x0f);
789 snprintf(buf, buf_size, "protection_fields: %i, prot_reg_addr: 0x%x, "
790 "factory pre-programmed: %i, user programmable: %i\n",
791 pri_ext->num_protection_fields, pri_ext->prot_reg_addr,
792 1 << pri_ext->fact_prot_reg_size, 1 << pri_ext->user_prot_reg_size);
797 /* flash_bank cfi <base> <size> <chip_width> <bus_width> <target#> [options]
799 FLASH_BANK_COMMAND_HANDLER(cfi_flash_bank_command)
801 struct cfi_flash_bank *cfi_info;
804 return ERROR_COMMAND_SYNTAX_ERROR;
807 * - not exceed max value;
809 * - be equal to a power of 2.
810 * bus must be wide enought to hold one chip */
811 if ((bank->chip_width > CFI_MAX_CHIP_WIDTH)
812 || (bank->bus_width > CFI_MAX_BUS_WIDTH)
813 || (bank->chip_width == 0)
814 || (bank->bus_width == 0)
815 || (bank->chip_width & (bank->chip_width - 1))
816 || (bank->bus_width & (bank->bus_width - 1))
817 || (bank->chip_width > bank->bus_width)) {
818 LOG_ERROR("chip and bus width have to specified in bytes");
819 return ERROR_FLASH_BANK_INVALID;
822 cfi_info = malloc(sizeof(struct cfi_flash_bank));
823 cfi_info->probed = 0;
824 cfi_info->erase_region_info = NULL;
825 cfi_info->pri_ext = NULL;
826 bank->driver_priv = cfi_info;
828 cfi_info->x16_as_x8 = 0;
829 cfi_info->jedec_probe = 0;
830 cfi_info->not_cfi = 0;
832 for (unsigned i = 6; i < CMD_ARGC; i++) {
833 if (strcmp(CMD_ARGV[i], "x16_as_x8") == 0)
834 cfi_info->x16_as_x8 = 1;
835 else if (strcmp(CMD_ARGV[i], "jedec_probe") == 0)
836 cfi_info->jedec_probe = 1;
839 /* bank wasn't probed yet */
840 cfi_info->qry[0] = 0xff;
845 static int cfi_intel_erase(struct flash_bank *bank, int first, int last)
848 struct cfi_flash_bank *cfi_info = bank->driver_priv;
851 cfi_intel_clear_status_register(bank);
853 for (i = first; i <= last; i++) {
854 retval = cfi_send_command(bank, 0x20, flash_address(bank, i, 0x0));
855 if (retval != ERROR_OK)
858 retval = cfi_send_command(bank, 0xd0, flash_address(bank, i, 0x0));
859 if (retval != ERROR_OK)
863 retval = cfi_intel_wait_status_busy(bank, cfi_info->block_erase_timeout, &status);
864 if (retval != ERROR_OK)
868 bank->sectors[i].is_erased = 1;
870 retval = cfi_send_command(bank, 0xff, flash_address(bank, 0, 0x0));
871 if (retval != ERROR_OK)
874 LOG_ERROR("couldn't erase block %i of flash bank at base 0x%" PRIx32,
877 return ERROR_FLASH_OPERATION_FAILED;
881 return cfi_send_command(bank, 0xff, flash_address(bank, 0, 0x0));
884 static int cfi_spansion_erase(struct flash_bank *bank, int first, int last)
887 struct cfi_flash_bank *cfi_info = bank->driver_priv;
888 struct cfi_spansion_pri_ext *pri_ext = cfi_info->pri_ext;
891 for (i = first; i <= last; i++) {
892 retval = cfi_send_command(bank, 0xaa, flash_address(bank, 0, pri_ext->_unlock1));
893 if (retval != ERROR_OK)
896 retval = cfi_send_command(bank, 0x55, flash_address(bank, 0, pri_ext->_unlock2));
897 if (retval != ERROR_OK)
900 retval = cfi_send_command(bank, 0x80, flash_address(bank, 0, pri_ext->_unlock1));
901 if (retval != ERROR_OK)
904 retval = cfi_send_command(bank, 0xaa, flash_address(bank, 0, pri_ext->_unlock1));
905 if (retval != ERROR_OK)
908 retval = cfi_send_command(bank, 0x55, flash_address(bank, 0, pri_ext->_unlock2));
909 if (retval != ERROR_OK)
912 retval = cfi_send_command(bank, 0x30, flash_address(bank, i, 0x0));
913 if (retval != ERROR_OK)
916 if (cfi_spansion_wait_status_busy(bank, cfi_info->block_erase_timeout) == ERROR_OK)
917 bank->sectors[i].is_erased = 1;
919 retval = cfi_send_command(bank, 0xf0, flash_address(bank, 0, 0x0));
920 if (retval != ERROR_OK)
923 LOG_ERROR("couldn't erase block %i of flash bank at base 0x%"
924 PRIx32, i, bank->base);
925 return ERROR_FLASH_OPERATION_FAILED;
929 return cfi_send_command(bank, 0xf0, flash_address(bank, 0, 0x0));
932 static int cfi_erase(struct flash_bank *bank, int first, int last)
934 struct cfi_flash_bank *cfi_info = bank->driver_priv;
936 if (bank->target->state != TARGET_HALTED) {
937 LOG_ERROR("Target not halted");
938 return ERROR_TARGET_NOT_HALTED;
941 if ((first < 0) || (last < first) || (last >= bank->num_sectors))
942 return ERROR_FLASH_SECTOR_INVALID;
944 if (cfi_info->qry[0] != 'Q')
945 return ERROR_FLASH_BANK_NOT_PROBED;
947 switch (cfi_info->pri_id) {
950 return cfi_intel_erase(bank, first, last);
953 return cfi_spansion_erase(bank, first, last);
956 LOG_ERROR("cfi primary command set %i unsupported", cfi_info->pri_id);
963 static int cfi_intel_protect(struct flash_bank *bank, int set, int first, int last)
966 struct cfi_flash_bank *cfi_info = bank->driver_priv;
967 struct cfi_intel_pri_ext *pri_ext = cfi_info->pri_ext;
971 /* if the device supports neither legacy lock/unlock (bit 3) nor
972 * instant individual block locking (bit 5).
974 if (!(pri_ext->feature_support & 0x28)) {
975 LOG_ERROR("lock/unlock not supported on flash");
976 return ERROR_FLASH_OPERATION_FAILED;
979 cfi_intel_clear_status_register(bank);
981 for (i = first; i <= last; i++) {
982 retval = cfi_send_command(bank, 0x60, flash_address(bank, i, 0x0));
983 if (retval != ERROR_OK)
986 retval = cfi_send_command(bank, 0x01, flash_address(bank, i, 0x0));
987 if (retval != ERROR_OK)
989 bank->sectors[i].is_protected = 1;
991 retval = cfi_send_command(bank, 0xd0, flash_address(bank, i, 0x0));
992 if (retval != ERROR_OK)
994 bank->sectors[i].is_protected = 0;
997 /* instant individual block locking doesn't require reading of the status register
999 if (!(pri_ext->feature_support & 0x20)) {
1000 /* Clear lock bits operation may take up to 1.4s */
1002 retval = cfi_intel_wait_status_busy(bank, 1400, &status);
1003 if (retval != ERROR_OK)
1006 uint8_t block_status;
1007 /* read block lock bit, to verify status */
1008 retval = cfi_send_command(bank, 0x90, flash_address(bank, 0, 0x55));
1009 if (retval != ERROR_OK)
1011 retval = cfi_get_u8(bank, i, 0x2, &block_status);
1012 if (retval != ERROR_OK)
1015 if ((block_status & 0x1) != set) {
1017 "couldn't change block lock status (set = %i, block_status = 0x%2.2x)",
1019 retval = cfi_send_command(bank, 0x70, flash_address(bank, 0, 0x55));
1020 if (retval != ERROR_OK)
1023 retval = cfi_intel_wait_status_busy(bank, 10, &status);
1024 if (retval != ERROR_OK)
1028 return ERROR_FLASH_OPERATION_FAILED;
1037 /* if the device doesn't support individual block lock bits set/clear,
1038 * all blocks have been unlocked in parallel, so we set those that should be protected
1040 if ((!set) && (!(pri_ext->feature_support & 0x20))) {
1041 /* FIX!!! this code path is broken!!!
1043 * The correct approach is:
1045 * 1. read out current protection status
1047 * 2. override read out protection status w/unprotected.
1049 * 3. re-protect what should be protected.
1052 for (i = 0; i < bank->num_sectors; i++) {
1053 if (bank->sectors[i].is_protected == 1) {
1054 cfi_intel_clear_status_register(bank);
1056 retval = cfi_send_command(bank, 0x60, flash_address(bank, i, 0x0));
1057 if (retval != ERROR_OK)
1060 retval = cfi_send_command(bank, 0x01, flash_address(bank, i, 0x0));
1061 if (retval != ERROR_OK)
1065 retval = cfi_intel_wait_status_busy(bank, 100, &status);
1066 if (retval != ERROR_OK)
1072 return cfi_send_command(bank, 0xff, flash_address(bank, 0, 0x0));
1075 static int cfi_protect(struct flash_bank *bank, int set, int first, int last)
1077 struct cfi_flash_bank *cfi_info = bank->driver_priv;
1079 if (bank->target->state != TARGET_HALTED) {
1080 LOG_ERROR("Target not halted");
1081 return ERROR_TARGET_NOT_HALTED;
1084 if ((first < 0) || (last < first) || (last >= bank->num_sectors)) {
1085 LOG_ERROR("Invalid sector range");
1086 return ERROR_FLASH_SECTOR_INVALID;
1089 if (cfi_info->qry[0] != 'Q')
1090 return ERROR_FLASH_BANK_NOT_PROBED;
1092 switch (cfi_info->pri_id) {
1095 return cfi_intel_protect(bank, set, first, last);
1098 LOG_WARNING("protect: cfi primary command set %i unsupported", cfi_info->pri_id);
1103 /* Convert code image to target endian
1104 * FIXME create general block conversion fcts in target.c?) */
1105 static void cfi_fix_code_endian(struct target *target, uint8_t *dest,
1106 const uint32_t *src, uint32_t count)
1109 for (i = 0; i < count; i++) {
1110 target_buffer_set_u32(target, dest, *src);
1116 static uint32_t cfi_command_val(struct flash_bank *bank, uint8_t cmd)
1118 struct target *target = bank->target;
1120 uint8_t buf[CFI_MAX_BUS_WIDTH];
1121 cfi_command(bank, cmd, buf);
1122 switch (bank->bus_width) {
1127 return target_buffer_get_u16(target, buf);
1130 return target_buffer_get_u32(target, buf);
1133 LOG_ERROR("Unsupported bank buswidth %d, can't do block memory writes",
1139 static int cfi_intel_write_block(struct flash_bank *bank, uint8_t *buffer,
1140 uint32_t address, uint32_t count)
1142 struct target *target = bank->target;
1143 struct reg_param reg_params[7];
1144 struct arm_algorithm arm_algo;
1145 struct working_area *write_algorithm;
1146 struct working_area *source = NULL;
1147 uint32_t buffer_size = 32768;
1148 uint32_t write_command_val, busy_pattern_val, error_pattern_val;
1150 /* algorithm register usage:
1151 * r0: source address (in RAM)
1152 * r1: target address (in Flash)
1154 * r3: flash write command
1155 * r4: status byte (returned to host)
1156 * r5: busy test pattern
1157 * r6: error test pattern
1160 /* see contib/loaders/flash/armv4_5_cfi_intel_32.s for src */
1161 static const uint32_t word_32_code[] = {
1162 0xe4904004, /* loop: ldr r4, [r0], #4 */
1163 0xe5813000, /* str r3, [r1] */
1164 0xe5814000, /* str r4, [r1] */
1165 0xe5914000, /* busy: ldr r4, [r1] */
1166 0xe0047005, /* and r7, r4, r5 */
1167 0xe1570005, /* cmp r7, r5 */
1168 0x1afffffb, /* bne busy */
1169 0xe1140006, /* tst r4, r6 */
1170 0x1a000003, /* bne done */
1171 0xe2522001, /* subs r2, r2, #1 */
1172 0x0a000001, /* beq done */
1173 0xe2811004, /* add r1, r1 #4 */
1174 0xeafffff2, /* b loop */
1175 0xeafffffe /* done: b -2 */
1178 /* see contib/loaders/flash/armv4_5_cfi_intel_16.s for src */
1179 static const uint32_t word_16_code[] = {
1180 0xe0d040b2, /* loop: ldrh r4, [r0], #2 */
1181 0xe1c130b0, /* strh r3, [r1] */
1182 0xe1c140b0, /* strh r4, [r1] */
1183 0xe1d140b0, /* busy ldrh r4, [r1] */
1184 0xe0047005, /* and r7, r4, r5 */
1185 0xe1570005, /* cmp r7, r5 */
1186 0x1afffffb, /* bne busy */
1187 0xe1140006, /* tst r4, r6 */
1188 0x1a000003, /* bne done */
1189 0xe2522001, /* subs r2, r2, #1 */
1190 0x0a000001, /* beq done */
1191 0xe2811002, /* add r1, r1 #2 */
1192 0xeafffff2, /* b loop */
1193 0xeafffffe /* done: b -2 */
1196 /* see contib/loaders/flash/armv4_5_cfi_intel_8.s for src */
1197 static const uint32_t word_8_code[] = {
1198 0xe4d04001, /* loop: ldrb r4, [r0], #1 */
1199 0xe5c13000, /* strb r3, [r1] */
1200 0xe5c14000, /* strb r4, [r1] */
1201 0xe5d14000, /* busy ldrb r4, [r1] */
1202 0xe0047005, /* and r7, r4, r5 */
1203 0xe1570005, /* cmp r7, r5 */
1204 0x1afffffb, /* bne busy */
1205 0xe1140006, /* tst r4, r6 */
1206 0x1a000003, /* bne done */
1207 0xe2522001, /* subs r2, r2, #1 */
1208 0x0a000001, /* beq done */
1209 0xe2811001, /* add r1, r1 #1 */
1210 0xeafffff2, /* b loop */
1211 0xeafffffe /* done: b -2 */
1213 uint8_t target_code[4*CFI_MAX_INTEL_CODESIZE];
1214 const uint32_t *target_code_src;
1215 uint32_t target_code_size;
1216 int retval = ERROR_OK;
1218 /* check we have a supported arch */
1219 if (is_arm(target_to_arm(target))) {
1220 /* All other ARM CPUs have 32 bit instructions */
1221 arm_algo.common_magic = ARM_COMMON_MAGIC;
1222 arm_algo.core_mode = ARM_MODE_SVC;
1223 arm_algo.core_state = ARM_STATE_ARM;
1225 LOG_ERROR("Unknown architecture");
1229 cfi_intel_clear_status_register(bank);
1231 /* If we are setting up the write_algorith, we need target_code_src
1232 * if not we only need target_code_size. */
1234 /* However, we don't want to create multiple code paths, so we
1235 * do the unecessary evaluation of target_code_src, which the
1236 * compiler will probably nicely optimize away if not needed */
1238 /* prepare algorithm code for target endian */
1239 switch (bank->bus_width) {
1241 target_code_src = word_8_code;
1242 target_code_size = sizeof(word_8_code);
1245 target_code_src = word_16_code;
1246 target_code_size = sizeof(word_16_code);
1249 target_code_src = word_32_code;
1250 target_code_size = sizeof(word_32_code);
1253 LOG_ERROR("Unsupported bank buswidth %d, can't do block memory writes",
1255 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1258 /* flash write code */
1259 if (target_code_size > sizeof(target_code)) {
1260 LOG_WARNING("Internal error - target code buffer to small. "
1261 "Increase CFI_MAX_INTEL_CODESIZE and recompile.");
1262 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1264 cfi_fix_code_endian(target, target_code, target_code_src, target_code_size / 4);
1266 /* Get memory for block write handler */
1267 retval = target_alloc_working_area(target,
1270 if (retval != ERROR_OK) {
1271 LOG_WARNING("No working area available, can't do block memory writes");
1272 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1276 /* write algorithm code to working area */
1277 retval = target_write_buffer(target, write_algorithm->address,
1278 target_code_size, target_code);
1279 if (retval != ERROR_OK) {
1280 LOG_ERROR("Unable to write block write code to target");
1284 /* Get a workspace buffer for the data to flash starting with 32k size.
1285 Half size until buffer would be smaller 256 Bytem then fail back */
1286 /* FIXME Why 256 bytes, why not 32 bytes (smallest flash write page */
1287 while (target_alloc_working_area_try(target, buffer_size, &source) != ERROR_OK) {
1289 if (buffer_size <= 256) {
1291 "no large enough working area available, can't do block memory writes");
1292 retval = ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1298 /* setup algo registers */
1299 init_reg_param(®_params[0], "r0", 32, PARAM_OUT);
1300 init_reg_param(®_params[1], "r1", 32, PARAM_OUT);
1301 init_reg_param(®_params[2], "r2", 32, PARAM_OUT);
1302 init_reg_param(®_params[3], "r3", 32, PARAM_OUT);
1303 init_reg_param(®_params[4], "r4", 32, PARAM_IN);
1304 init_reg_param(®_params[5], "r5", 32, PARAM_OUT);
1305 init_reg_param(®_params[6], "r6", 32, PARAM_OUT);
1307 /* prepare command and status register patterns */
1308 write_command_val = cfi_command_val(bank, 0x40);
1309 busy_pattern_val = cfi_command_val(bank, 0x80);
1310 error_pattern_val = cfi_command_val(bank, 0x7e);
1312 LOG_DEBUG("Using target buffer at 0x%08" PRIx32 " and of size 0x%04" PRIx32,
1313 source->address, buffer_size);
1315 /* Programming main loop */
1317 uint32_t thisrun_count = (count > buffer_size) ? buffer_size : count;
1320 retval = target_write_buffer(target, source->address, thisrun_count, buffer);
1321 if (retval != ERROR_OK)
1324 buf_set_u32(reg_params[0].value, 0, 32, source->address);
1325 buf_set_u32(reg_params[1].value, 0, 32, address);
1326 buf_set_u32(reg_params[2].value, 0, 32, thisrun_count / bank->bus_width);
1328 buf_set_u32(reg_params[3].value, 0, 32, write_command_val);
1329 buf_set_u32(reg_params[5].value, 0, 32, busy_pattern_val);
1330 buf_set_u32(reg_params[6].value, 0, 32, error_pattern_val);
1332 LOG_DEBUG("Write 0x%04" PRIx32 " bytes to flash at 0x%08" PRIx32,
1333 thisrun_count, address);
1335 /* Execute algorithm, assume breakpoint for last instruction */
1336 retval = target_run_algorithm(target, 0, NULL, 7, reg_params,
1337 write_algorithm->address,
1338 write_algorithm->address + target_code_size -
1340 10000, /* 10s should be enough for max. 32k of data */
1343 /* On failure try a fall back to direct word writes */
1344 if (retval != ERROR_OK) {
1345 cfi_intel_clear_status_register(bank);
1347 "Execution of flash algorythm failed. Can't fall back. Please report.");
1348 retval = ERROR_FLASH_OPERATION_FAILED;
1349 /* retval = ERROR_TARGET_RESOURCE_NOT_AVAILABLE; */
1350 /* FIXME To allow fall back or recovery, we must save the actual status
1351 * somewhere, so that a higher level code can start recovery. */
1355 /* Check return value from algo code */
1356 wsm_error = buf_get_u32(reg_params[4].value, 0, 32) & error_pattern_val;
1358 /* read status register (outputs debug inforation) */
1360 cfi_intel_wait_status_busy(bank, 100, &status);
1361 cfi_intel_clear_status_register(bank);
1362 retval = ERROR_FLASH_OPERATION_FAILED;
1366 buffer += thisrun_count;
1367 address += thisrun_count;
1368 count -= thisrun_count;
1373 /* free up resources */
1376 target_free_working_area(target, source);
1378 target_free_working_area(target, write_algorithm);
1380 destroy_reg_param(®_params[0]);
1381 destroy_reg_param(®_params[1]);
1382 destroy_reg_param(®_params[2]);
1383 destroy_reg_param(®_params[3]);
1384 destroy_reg_param(®_params[4]);
1385 destroy_reg_param(®_params[5]);
1386 destroy_reg_param(®_params[6]);
1391 static int cfi_spansion_write_block_mips(struct flash_bank *bank, uint8_t *buffer,
1392 uint32_t address, uint32_t count)
1394 struct cfi_flash_bank *cfi_info = bank->driver_priv;
1395 struct cfi_spansion_pri_ext *pri_ext = cfi_info->pri_ext;
1396 struct target *target = bank->target;
1397 struct reg_param reg_params[10];
1398 struct mips32_algorithm mips32_info;
1399 struct working_area *write_algorithm;
1400 struct working_area *source;
1401 uint32_t buffer_size = 32768;
1403 int retval = ERROR_OK;
1405 /* input parameters -
1406 * 4 A0 = source address
1407 * 5 A1 = destination address
1408 * 6 A2 = number of writes
1409 * 7 A3 = flash write command
1410 * 8 T0 = constant to mask DQ7 bits (also used for Dq5 with shift)
1411 * output parameters -
1412 * 9 T1 = 0x80 ok 0x00 bad
1414 * 10 T2 = value read from flash to test status
1415 * 11 T3 = holding register
1416 * unlock registers -
1417 * 12 T4 = unlock1_addr
1418 * 13 T5 = unlock1_cmd
1419 * 14 T6 = unlock2_addr
1420 * 15 T7 = unlock2_cmd */
1422 static const uint32_t mips_word_16_code[] = {
1424 MIPS32_LHU(9, 0, 4), /* lhu $t1, ($a0) ; out = &saddr */
1425 MIPS32_ADDI(4, 4, 2), /* addi $a0, $a0, 2 ; saddr += 2 */
1426 MIPS32_SH(13, 0, 12), /* sh $t5, ($t4) ; *fl_unl_addr1 =
1428 MIPS32_SH(15, 0, 14), /* sh $t7, ($t6) ; *fl_unl_addr2 =
1430 MIPS32_SH(7, 0, 12), /* sh $a3, ($t4) ; *fl_unl_addr1 =
1432 MIPS32_SH(9, 0, 5), /* sh $t1, ($a1) ; *daddr = out */
1433 MIPS32_NOP, /* nop */
1435 MIPS32_LHU(10, 0, 5), /* lhu $t2, ($a1) ; temp1 = *daddr */
1436 MIPS32_XOR(11, 9, 10), /* xor $t3, $a0, $t2 ; temp2 = out ^
1438 MIPS32_AND(11, 8, 11), /* and $t3, $t0, $t3 ; temp2 = temp2 &
1440 MIPS32_BNE(11, 8, 13), /* bne $t3, $t0, cont ; if (temp2 !=
1441 *DQ7mask) goto cont */
1442 MIPS32_NOP, /* nop */
1444 MIPS32_SRL(10, 8, 2), /* srl $t2,$t0,2 ; temp1 = DQ7mask >>
1446 MIPS32_AND(11, 10, 11), /* and $t3, $t2, $t3 ; temp2 = temp2 &
1448 MIPS32_BNE(11, 10, NEG16(8)), /* bne $t3, $t2, busy ; if (temp2 !=
1449 *temp1) goto busy */
1450 MIPS32_NOP, /* nop */
1452 MIPS32_LHU(10, 0, 5), /* lhu $t2, ($a1) ; temp1 = *daddr */
1453 MIPS32_XOR(11, 9, 10), /* xor $t3, $a0, $t2 ; temp2 = out ^
1455 MIPS32_AND(11, 8, 11), /* and $t3, $t0, $t3 ; temp2 = temp2 &
1457 MIPS32_BNE(11, 8, 4), /* bne $t3, $t0, cont ; if (temp2 !=
1458 *DQ7mask) goto cont */
1459 MIPS32_NOP, /* nop */
1461 MIPS32_XOR(9, 9, 9), /* xor $t1, $t1, $t1 ; out = 0 */
1462 MIPS32_BEQ(9, 0, 11), /* beq $t1, $zero, done ; if (out == 0) goto
1464 MIPS32_NOP, /* nop */
1466 MIPS32_ADDI(6, 6, NEG16(1)), /* addi, $a2, $a2, -1 ; numwrites-- */
1467 MIPS32_BNE(6, 0, 5), /* bne $a2, $zero, cont2 ; if (numwrite != 0)
1469 MIPS32_NOP, /* nop */
1471 MIPS32_LUI(9, 0), /* lui $t1, 0 */
1472 MIPS32_ORI(9, 9, 0x80), /* ori $t1, $t1, 0x80 ; out = 0x80 */
1474 MIPS32_B(4), /* b done ; goto done */
1475 MIPS32_NOP, /* nop */
1477 MIPS32_ADDI(5, 5, 2), /* addi $a0, $a0, 2 ; daddr += 2 */
1478 MIPS32_B(NEG16(33)), /* b start ; goto start */
1479 MIPS32_NOP, /* nop */
1481 *MIPS32_B(NEG16(1)), */ /* b done ; goto done */
1482 MIPS32_SDBBP, /* sdbbp ; break(); */
1483 /*MIPS32_B(NEG16(33)), */ /* b start ; goto start
1487 mips32_info.common_magic = MIPS32_COMMON_MAGIC;
1488 mips32_info.isa_mode = MIPS32_ISA_MIPS32;
1490 int target_code_size = 0;
1491 const uint32_t *target_code_src = NULL;
1493 switch (bank->bus_width) {
1495 /* Check for DQ5 support */
1496 if (cfi_info->status_poll_mask & (1 << 5)) {
1497 target_code_src = mips_word_16_code;
1498 target_code_size = sizeof(mips_word_16_code);
1500 LOG_ERROR("Need DQ5 support");
1501 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1502 /* target_code_src = mips_word_16_code_dq7only; */
1503 /* target_code_size = sizeof(mips_word_16_code_dq7only); */
1507 LOG_ERROR("Unsupported bank buswidth %d, can't do block memory writes",
1509 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1512 /* flash write code */
1513 uint8_t *target_code;
1515 /* convert bus-width dependent algorithm code to correct endiannes */
1516 target_code = malloc(target_code_size);
1517 if (target_code == NULL) {
1518 LOG_ERROR("Out of memory");
1521 cfi_fix_code_endian(target, target_code, target_code_src, target_code_size / 4);
1523 /* allocate working area */
1524 retval = target_alloc_working_area(target, target_code_size,
1526 if (retval != ERROR_OK) {
1531 /* write algorithm code to working area */
1532 retval = target_write_buffer(target, write_algorithm->address,
1533 target_code_size, target_code);
1534 if (retval != ERROR_OK) {
1541 /* the following code still assumes target code is fixed 24*4 bytes */
1543 while (target_alloc_working_area_try(target, buffer_size, &source) != ERROR_OK) {
1545 if (buffer_size <= 256) {
1546 /* we already allocated the writing code, but failed to get a
1547 * buffer, free the algorithm */
1548 target_free_working_area(target, write_algorithm);
1551 "not enough working area available, can't do block memory writes");
1552 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1557 init_reg_param(®_params[0], "a0", 32, PARAM_OUT);
1558 init_reg_param(®_params[1], "a1", 32, PARAM_OUT);
1559 init_reg_param(®_params[2], "a2", 32, PARAM_OUT);
1560 init_reg_param(®_params[3], "a3", 32, PARAM_OUT);
1561 init_reg_param(®_params[4], "t0", 32, PARAM_OUT);
1562 init_reg_param(®_params[5], "t1", 32, PARAM_IN);
1563 init_reg_param(®_params[6], "t4", 32, PARAM_OUT);
1564 init_reg_param(®_params[7], "t5", 32, PARAM_OUT);
1565 init_reg_param(®_params[8], "t6", 32, PARAM_OUT);
1566 init_reg_param(®_params[9], "t7", 32, PARAM_OUT);
1569 uint32_t thisrun_count = (count > buffer_size) ? buffer_size : count;
1571 retval = target_write_buffer(target, source->address, thisrun_count, buffer);
1572 if (retval != ERROR_OK)
1575 buf_set_u32(reg_params[0].value, 0, 32, source->address);
1576 buf_set_u32(reg_params[1].value, 0, 32, address);
1577 buf_set_u32(reg_params[2].value, 0, 32, thisrun_count / bank->bus_width);
1578 buf_set_u32(reg_params[3].value, 0, 32, cfi_command_val(bank, 0xA0));
1579 buf_set_u32(reg_params[4].value, 0, 32, cfi_command_val(bank, 0x80));
1580 buf_set_u32(reg_params[6].value, 0, 32, flash_address(bank, 0, pri_ext->_unlock1));
1581 buf_set_u32(reg_params[7].value, 0, 32, 0xaaaaaaaa);
1582 buf_set_u32(reg_params[8].value, 0, 32, flash_address(bank, 0, pri_ext->_unlock2));
1583 buf_set_u32(reg_params[9].value, 0, 32, 0x55555555);
1585 retval = target_run_algorithm(target, 0, NULL, 10, reg_params,
1586 write_algorithm->address,
1587 write_algorithm->address + ((target_code_size) - 4),
1588 10000, &mips32_info);
1589 if (retval != ERROR_OK)
1592 status = buf_get_u32(reg_params[5].value, 0, 32);
1593 if (status != 0x80) {
1594 LOG_ERROR("flash write block failed status: 0x%" PRIx32, status);
1595 retval = ERROR_FLASH_OPERATION_FAILED;
1599 buffer += thisrun_count;
1600 address += thisrun_count;
1601 count -= thisrun_count;
1604 target_free_all_working_areas(target);
1606 destroy_reg_param(®_params[0]);
1607 destroy_reg_param(®_params[1]);
1608 destroy_reg_param(®_params[2]);
1609 destroy_reg_param(®_params[3]);
1610 destroy_reg_param(®_params[4]);
1611 destroy_reg_param(®_params[5]);
1612 destroy_reg_param(®_params[6]);
1613 destroy_reg_param(®_params[7]);
1614 destroy_reg_param(®_params[8]);
1615 destroy_reg_param(®_params[9]);
1620 static int cfi_spansion_write_block(struct flash_bank *bank, uint8_t *buffer,
1621 uint32_t address, uint32_t count)
1623 struct cfi_flash_bank *cfi_info = bank->driver_priv;
1624 struct cfi_spansion_pri_ext *pri_ext = cfi_info->pri_ext;
1625 struct target *target = bank->target;
1626 struct reg_param reg_params[10];
1628 struct arm_algorithm armv4_5_algo;
1629 struct armv7m_algorithm armv7m_algo;
1630 struct working_area *write_algorithm;
1631 struct working_area *source;
1632 uint32_t buffer_size = 32768;
1634 int retval = ERROR_OK;
1636 /* input parameters -
1637 * R0 = source address
1638 * R1 = destination address
1639 * R2 = number of writes
1640 * R3 = flash write command
1641 * R4 = constant to mask DQ7 bits (also used for Dq5 with shift)
1642 * output parameters -
1643 * R5 = 0x80 ok 0x00 bad
1645 * R6 = value read from flash to test status
1646 * R7 = holding register
1647 * unlock registers -
1650 * R10 = unlock2_addr
1651 * R11 = unlock2_cmd */
1653 /* see contib/loaders/flash/armv4_5_cfi_span_32.s for src */
1654 static const uint32_t armv4_5_word_32_code[] = {
1655 /* 00008100 <sp_32_code>: */
1656 0xe4905004, /* ldr r5, [r0], #4 */
1657 0xe5889000, /* str r9, [r8] */
1658 0xe58ab000, /* str r11, [r10] */
1659 0xe5883000, /* str r3, [r8] */
1660 0xe5815000, /* str r5, [r1] */
1661 0xe1a00000, /* nop */
1663 * 00008110 <sp_32_busy>: */
1664 0xe5916000, /* ldr r6, [r1] */
1665 0xe0257006, /* eor r7, r5, r6 */
1666 0xe0147007, /* ands r7, r4, r7 */
1667 0x0a000007, /* beq 8140 <sp_32_cont> ; b if DQ7 == Data7 */
1668 0xe0166124, /* ands r6, r6, r4, lsr #2 */
1669 0x0afffff9, /* beq 8110 <sp_32_busy> ; b if DQ5 low */
1670 0xe5916000, /* ldr r6, [r1] */
1671 0xe0257006, /* eor r7, r5, r6 */
1672 0xe0147007, /* ands r7, r4, r7 */
1673 0x0a000001, /* beq 8140 <sp_32_cont> ; b if DQ7 == Data7 */
1674 0xe3a05000, /* mov r5, #0 ; 0x0 - return 0x00, error */
1675 0x1a000004, /* bne 8154 <sp_32_done> */
1677 * 00008140 <sp_32_cont>: */
1678 0xe2522001, /* subs r2, r2, #1 ; 0x1 */
1679 0x03a05080, /* moveq r5, #128 ; 0x80 */
1680 0x0a000001, /* beq 8154 <sp_32_done> */
1681 0xe2811004, /* add r1, r1, #4 ; 0x4 */
1682 0xeaffffe8, /* b 8100 <sp_32_code> */
1684 * 00008154 <sp_32_done>: */
1685 0xeafffffe /* b 8154 <sp_32_done> */
1688 /* see contib/loaders/flash/armv4_5_cfi_span_16.s for src */
1689 static const uint32_t armv4_5_word_16_code[] = {
1690 /* 00008158 <sp_16_code>: */
1691 0xe0d050b2, /* ldrh r5, [r0], #2 */
1692 0xe1c890b0, /* strh r9, [r8] */
1693 0xe1cab0b0, /* strh r11, [r10] */
1694 0xe1c830b0, /* strh r3, [r8] */
1695 0xe1c150b0, /* strh r5, [r1] */
1696 0xe1a00000, /* nop (mov r0,r0) */
1698 * 00008168 <sp_16_busy>: */
1699 0xe1d160b0, /* ldrh r6, [r1] */
1700 0xe0257006, /* eor r7, r5, r6 */
1701 0xe0147007, /* ands r7, r4, r7 */
1702 0x0a000007, /* beq 8198 <sp_16_cont> */
1703 0xe0166124, /* ands r6, r6, r4, lsr #2 */
1704 0x0afffff9, /* beq 8168 <sp_16_busy> */
1705 0xe1d160b0, /* ldrh r6, [r1] */
1706 0xe0257006, /* eor r7, r5, r6 */
1707 0xe0147007, /* ands r7, r4, r7 */
1708 0x0a000001, /* beq 8198 <sp_16_cont> */
1709 0xe3a05000, /* mov r5, #0 ; 0x0 */
1710 0x1a000004, /* bne 81ac <sp_16_done> */
1712 * 00008198 <sp_16_cont>: */
1713 0xe2522001, /* subs r2, r2, #1 ; 0x1 */
1714 0x03a05080, /* moveq r5, #128 ; 0x80 */
1715 0x0a000001, /* beq 81ac <sp_16_done> */
1716 0xe2811002, /* add r1, r1, #2 ; 0x2 */
1717 0xeaffffe8, /* b 8158 <sp_16_code> */
1719 * 000081ac <sp_16_done>: */
1720 0xeafffffe /* b 81ac <sp_16_done> */
1723 /* see contib/loaders/flash/armv7m_cfi_span_16.s for src */
1724 static const uint32_t armv7m_word_16_code[] = {
1745 /* see contib/loaders/flash/armv4_5_cfi_span_16_dq7.s for src */
1746 static const uint32_t armv4_5_word_16_code_dq7only[] = {
1748 0xe0d050b2, /* ldrh r5, [r0], #2 */
1749 0xe1c890b0, /* strh r9, [r8] */
1750 0xe1cab0b0, /* strh r11, [r10] */
1751 0xe1c830b0, /* strh r3, [r8] */
1752 0xe1c150b0, /* strh r5, [r1] */
1753 0xe1a00000, /* nop (mov r0,r0) */
1756 0xe1d160b0, /* ldrh r6, [r1] */
1757 0xe0257006, /* eor r7, r5, r6 */
1758 0xe2177080, /* ands r7, #0x80 */
1759 0x1afffffb, /* bne 8168 <sp_16_busy> */
1761 0xe2522001, /* subs r2, r2, #1 ; 0x1 */
1762 0x03a05080, /* moveq r5, #128 ; 0x80 */
1763 0x0a000001, /* beq 81ac <sp_16_done> */
1764 0xe2811002, /* add r1, r1, #2 ; 0x2 */
1765 0xeafffff0, /* b 8158 <sp_16_code> */
1767 * 000081ac <sp_16_done>: */
1768 0xeafffffe /* b 81ac <sp_16_done> */
1771 /* see contib/loaders/flash/armv4_5_cfi_span_8.s for src */
1772 static const uint32_t armv4_5_word_8_code[] = {
1773 /* 000081b0 <sp_16_code_end>: */
1774 0xe4d05001, /* ldrb r5, [r0], #1 */
1775 0xe5c89000, /* strb r9, [r8] */
1776 0xe5cab000, /* strb r11, [r10] */
1777 0xe5c83000, /* strb r3, [r8] */
1778 0xe5c15000, /* strb r5, [r1] */
1779 0xe1a00000, /* nop (mov r0,r0) */
1781 * 000081c0 <sp_8_busy>: */
1782 0xe5d16000, /* ldrb r6, [r1] */
1783 0xe0257006, /* eor r7, r5, r6 */
1784 0xe0147007, /* ands r7, r4, r7 */
1785 0x0a000007, /* beq 81f0 <sp_8_cont> */
1786 0xe0166124, /* ands r6, r6, r4, lsr #2 */
1787 0x0afffff9, /* beq 81c0 <sp_8_busy> */
1788 0xe5d16000, /* ldrb r6, [r1] */
1789 0xe0257006, /* eor r7, r5, r6 */
1790 0xe0147007, /* ands r7, r4, r7 */
1791 0x0a000001, /* beq 81f0 <sp_8_cont> */
1792 0xe3a05000, /* mov r5, #0 ; 0x0 */
1793 0x1a000004, /* bne 8204 <sp_8_done> */
1795 * 000081f0 <sp_8_cont>: */
1796 0xe2522001, /* subs r2, r2, #1 ; 0x1 */
1797 0x03a05080, /* moveq r5, #128 ; 0x80 */
1798 0x0a000001, /* beq 8204 <sp_8_done> */
1799 0xe2811001, /* add r1, r1, #1 ; 0x1 */
1800 0xeaffffe8, /* b 81b0 <sp_16_code_end> */
1802 * 00008204 <sp_8_done>: */
1803 0xeafffffe /* b 8204 <sp_8_done> */
1806 if (strncmp(target_type_name(target), "mips_m4k", 8) == 0)
1807 return cfi_spansion_write_block_mips(bank, buffer, address, count);
1809 if (is_armv7m(target_to_armv7m(target))) { /* Cortex-M3 target */
1810 armv7m_algo.common_magic = ARMV7M_COMMON_MAGIC;
1811 armv7m_algo.core_mode = ARMV7M_MODE_HANDLER;
1812 arm_algo = &armv7m_algo;
1813 } else if (is_arm(target_to_arm(target))) {
1814 /* All other ARM CPUs have 32 bit instructions */
1815 armv4_5_algo.common_magic = ARM_COMMON_MAGIC;
1816 armv4_5_algo.core_mode = ARM_MODE_SVC;
1817 armv4_5_algo.core_state = ARM_STATE_ARM;
1818 arm_algo = &armv4_5_algo;
1820 LOG_ERROR("Unknown architecture");
1824 int target_code_size = 0;
1825 const uint32_t *target_code_src = NULL;
1827 switch (bank->bus_width) {
1829 if (is_armv7m(target_to_armv7m(target))) {
1830 LOG_ERROR("Unknown ARM architecture");
1833 target_code_src = armv4_5_word_8_code;
1834 target_code_size = sizeof(armv4_5_word_8_code);
1837 /* Check for DQ5 support */
1838 if (cfi_info->status_poll_mask & (1 << 5)) {
1839 if (is_armv7m(target_to_armv7m(target))) { /*
1843 target_code_src = armv7m_word_16_code;
1844 target_code_size = sizeof(armv7m_word_16_code);
1845 } else { /* armv4_5 target */
1846 target_code_src = armv4_5_word_16_code;
1847 target_code_size = sizeof(armv4_5_word_16_code);
1850 /* No DQ5 support. Use DQ7 DATA# polling only. */
1851 if (is_armv7m(target_to_armv7m(target))) {
1852 LOG_ERROR("Unknown ARM architecture");
1855 target_code_src = armv4_5_word_16_code_dq7only;
1856 target_code_size = sizeof(armv4_5_word_16_code_dq7only);
1860 if (is_armv7m(target_to_armv7m(target))) {
1861 LOG_ERROR("Unknown ARM architecture");
1864 target_code_src = armv4_5_word_32_code;
1865 target_code_size = sizeof(armv4_5_word_32_code);
1868 LOG_ERROR("Unsupported bank buswidth %d, can't do block memory writes",
1870 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1873 /* flash write code */
1874 uint8_t *target_code;
1876 /* convert bus-width dependent algorithm code to correct endiannes */
1877 target_code = malloc(target_code_size);
1878 if (target_code == NULL) {
1879 LOG_ERROR("Out of memory");
1882 cfi_fix_code_endian(target, target_code, target_code_src, target_code_size / 4);
1884 /* allocate working area */
1885 retval = target_alloc_working_area(target, target_code_size,
1887 if (retval != ERROR_OK) {
1892 /* write algorithm code to working area */
1893 retval = target_write_buffer(target, write_algorithm->address,
1894 target_code_size, target_code);
1895 if (retval != ERROR_OK) {
1902 /* the following code still assumes target code is fixed 24*4 bytes */
1904 while (target_alloc_working_area_try(target, buffer_size, &source) != ERROR_OK) {
1906 if (buffer_size <= 256) {
1907 /* we already allocated the writing code, but failed to get a
1908 * buffer, free the algorithm */
1909 target_free_working_area(target, write_algorithm);
1912 "not enough working area available, can't do block memory writes");
1913 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1918 init_reg_param(®_params[0], "r0", 32, PARAM_OUT);
1919 init_reg_param(®_params[1], "r1", 32, PARAM_OUT);
1920 init_reg_param(®_params[2], "r2", 32, PARAM_OUT);
1921 init_reg_param(®_params[3], "r3", 32, PARAM_OUT);
1922 init_reg_param(®_params[4], "r4", 32, PARAM_OUT);
1923 init_reg_param(®_params[5], "r5", 32, PARAM_IN);
1924 init_reg_param(®_params[6], "r8", 32, PARAM_OUT);
1925 init_reg_param(®_params[7], "r9", 32, PARAM_OUT);
1926 init_reg_param(®_params[8], "r10", 32, PARAM_OUT);
1927 init_reg_param(®_params[9], "r11", 32, PARAM_OUT);
1930 uint32_t thisrun_count = (count > buffer_size) ? buffer_size : count;
1932 retval = target_write_buffer(target, source->address, thisrun_count, buffer);
1933 if (retval != ERROR_OK)
1936 buf_set_u32(reg_params[0].value, 0, 32, source->address);
1937 buf_set_u32(reg_params[1].value, 0, 32, address);
1938 buf_set_u32(reg_params[2].value, 0, 32, thisrun_count / bank->bus_width);
1939 buf_set_u32(reg_params[3].value, 0, 32, cfi_command_val(bank, 0xA0));
1940 buf_set_u32(reg_params[4].value, 0, 32, cfi_command_val(bank, 0x80));
1941 buf_set_u32(reg_params[6].value, 0, 32, flash_address(bank, 0, pri_ext->_unlock1));
1942 buf_set_u32(reg_params[7].value, 0, 32, 0xaaaaaaaa);
1943 buf_set_u32(reg_params[8].value, 0, 32, flash_address(bank, 0, pri_ext->_unlock2));
1944 buf_set_u32(reg_params[9].value, 0, 32, 0x55555555);
1946 retval = target_run_algorithm(target, 0, NULL, 10, reg_params,
1947 write_algorithm->address,
1948 write_algorithm->address + ((target_code_size) - 4),
1950 if (retval != ERROR_OK)
1953 status = buf_get_u32(reg_params[5].value, 0, 32);
1954 if (status != 0x80) {
1955 LOG_ERROR("flash write block failed status: 0x%" PRIx32, status);
1956 retval = ERROR_FLASH_OPERATION_FAILED;
1960 buffer += thisrun_count;
1961 address += thisrun_count;
1962 count -= thisrun_count;
1965 target_free_all_working_areas(target);
1967 destroy_reg_param(®_params[0]);
1968 destroy_reg_param(®_params[1]);
1969 destroy_reg_param(®_params[2]);
1970 destroy_reg_param(®_params[3]);
1971 destroy_reg_param(®_params[4]);
1972 destroy_reg_param(®_params[5]);
1973 destroy_reg_param(®_params[6]);
1974 destroy_reg_param(®_params[7]);
1975 destroy_reg_param(®_params[8]);
1976 destroy_reg_param(®_params[9]);
1981 static int cfi_intel_write_word(struct flash_bank *bank, uint8_t *word, uint32_t address)
1984 struct cfi_flash_bank *cfi_info = bank->driver_priv;
1985 struct target *target = bank->target;
1987 cfi_intel_clear_status_register(bank);
1988 retval = cfi_send_command(bank, 0x40, address);
1989 if (retval != ERROR_OK)
1992 retval = target_write_memory(target, address, bank->bus_width, 1, word);
1993 if (retval != ERROR_OK)
1997 retval = cfi_intel_wait_status_busy(bank, cfi_info->word_write_timeout, &status);
1998 if (retval != 0x80) {
1999 retval = cfi_send_command(bank, 0xff, flash_address(bank, 0, 0x0));
2000 if (retval != ERROR_OK)
2003 LOG_ERROR("couldn't write word at base 0x%" PRIx32 ", address 0x%" PRIx32,
2004 bank->base, address);
2005 return ERROR_FLASH_OPERATION_FAILED;
2011 static int cfi_intel_write_words(struct flash_bank *bank, uint8_t *word,
2012 uint32_t wordcount, uint32_t address)
2015 struct cfi_flash_bank *cfi_info = bank->driver_priv;
2016 struct target *target = bank->target;
2018 /* Calculate buffer size and boundary mask
2019 * buffersize is (buffer size per chip) * (number of chips)
2020 * bufferwsize is buffersize in words */
2021 uint32_t buffersize =
2022 (1UL << cfi_info->max_buf_write_size) * (bank->bus_width / bank->chip_width);
2023 uint32_t buffermask = buffersize-1;
2024 uint32_t bufferwsize = buffersize / bank->bus_width;
2026 /* Check for valid range */
2027 if (address & buffermask) {
2028 LOG_ERROR("Write address at base 0x%" PRIx32 ", address 0x%" PRIx32
2029 " not aligned to 2^%d boundary",
2030 bank->base, address, cfi_info->max_buf_write_size);
2031 return ERROR_FLASH_OPERATION_FAILED;
2034 /* Check for valid size */
2035 if (wordcount > bufferwsize) {
2036 LOG_ERROR("Number of data words %" PRId32 " exceeds available buffersize %" PRId32,
2037 wordcount, buffersize);
2038 return ERROR_FLASH_OPERATION_FAILED;
2041 /* Write to flash buffer */
2042 cfi_intel_clear_status_register(bank);
2044 /* Initiate buffer operation _*/
2045 retval = cfi_send_command(bank, 0xe8, address);
2046 if (retval != ERROR_OK)
2049 retval = cfi_intel_wait_status_busy(bank, cfi_info->buf_write_timeout, &status);
2050 if (retval != ERROR_OK)
2052 if (status != 0x80) {
2053 retval = cfi_send_command(bank, 0xff, flash_address(bank, 0, 0x0));
2054 if (retval != ERROR_OK)
2058 "couldn't start buffer write operation at base 0x%" PRIx32 ", address 0x%" PRIx32,
2061 return ERROR_FLASH_OPERATION_FAILED;
2064 /* Write buffer wordcount-1 and data words */
2065 retval = cfi_send_command(bank, bufferwsize-1, address);
2066 if (retval != ERROR_OK)
2069 retval = target_write_memory(target, address, bank->bus_width, bufferwsize, word);
2070 if (retval != ERROR_OK)
2073 /* Commit write operation */
2074 retval = cfi_send_command(bank, 0xd0, address);
2075 if (retval != ERROR_OK)
2078 retval = cfi_intel_wait_status_busy(bank, cfi_info->buf_write_timeout, &status);
2079 if (retval != ERROR_OK)
2082 if (status != 0x80) {
2083 retval = cfi_send_command(bank, 0xff, flash_address(bank, 0, 0x0));
2084 if (retval != ERROR_OK)
2087 LOG_ERROR("Buffer write at base 0x%" PRIx32
2088 ", address 0x%" PRIx32 " failed.", bank->base, address);
2089 return ERROR_FLASH_OPERATION_FAILED;
2095 static int cfi_spansion_write_word(struct flash_bank *bank, uint8_t *word, uint32_t address)
2098 struct cfi_flash_bank *cfi_info = bank->driver_priv;
2099 struct cfi_spansion_pri_ext *pri_ext = cfi_info->pri_ext;
2100 struct target *target = bank->target;
2102 retval = cfi_send_command(bank, 0xaa, flash_address(bank, 0, pri_ext->_unlock1));
2103 if (retval != ERROR_OK)
2106 retval = cfi_send_command(bank, 0x55, flash_address(bank, 0, pri_ext->_unlock2));
2107 if (retval != ERROR_OK)
2110 retval = cfi_send_command(bank, 0xa0, flash_address(bank, 0, pri_ext->_unlock1));
2111 if (retval != ERROR_OK)
2114 retval = target_write_memory(target, address, bank->bus_width, 1, word);
2115 if (retval != ERROR_OK)
2118 if (cfi_spansion_wait_status_busy(bank, cfi_info->word_write_timeout) != ERROR_OK) {
2119 retval = cfi_send_command(bank, 0xf0, flash_address(bank, 0, 0x0));
2120 if (retval != ERROR_OK)
2123 LOG_ERROR("couldn't write word at base 0x%" PRIx32
2124 ", address 0x%" PRIx32, bank->base, address);
2125 return ERROR_FLASH_OPERATION_FAILED;
2131 static int cfi_spansion_write_words(struct flash_bank *bank, uint8_t *word,
2132 uint32_t wordcount, uint32_t address)
2135 struct cfi_flash_bank *cfi_info = bank->driver_priv;
2136 struct target *target = bank->target;
2137 struct cfi_spansion_pri_ext *pri_ext = cfi_info->pri_ext;
2139 /* Calculate buffer size and boundary mask
2140 * buffersize is (buffer size per chip) * (number of chips)
2141 * bufferwsize is buffersize in words */
2142 uint32_t buffersize =
2143 (1UL << cfi_info->max_buf_write_size) * (bank->bus_width / bank->chip_width);
2144 uint32_t buffermask = buffersize-1;
2145 uint32_t bufferwsize = buffersize / bank->bus_width;
2147 /* Check for valid range */
2148 if (address & buffermask) {
2149 LOG_ERROR("Write address at base 0x%" PRIx32
2150 ", address 0x%" PRIx32 " not aligned to 2^%d boundary",
2151 bank->base, address, cfi_info->max_buf_write_size);
2152 return ERROR_FLASH_OPERATION_FAILED;
2155 /* Check for valid size */
2156 if (wordcount > bufferwsize) {
2157 LOG_ERROR("Number of data words %" PRId32 " exceeds available buffersize %"
2158 PRId32, wordcount, buffersize);
2159 return ERROR_FLASH_OPERATION_FAILED;
2163 retval = cfi_send_command(bank, 0xaa, flash_address(bank, 0, pri_ext->_unlock1));
2164 if (retval != ERROR_OK)
2167 retval = cfi_send_command(bank, 0x55, flash_address(bank, 0, pri_ext->_unlock2));
2168 if (retval != ERROR_OK)
2171 /* Buffer load command */
2172 retval = cfi_send_command(bank, 0x25, address);
2173 if (retval != ERROR_OK)
2176 /* Write buffer wordcount-1 and data words */
2177 retval = cfi_send_command(bank, bufferwsize-1, address);
2178 if (retval != ERROR_OK)
2181 retval = target_write_memory(target, address, bank->bus_width, bufferwsize, word);
2182 if (retval != ERROR_OK)
2185 /* Commit write operation */
2186 retval = cfi_send_command(bank, 0x29, address);
2187 if (retval != ERROR_OK)
2190 if (cfi_spansion_wait_status_busy(bank, cfi_info->buf_write_timeout) != ERROR_OK) {
2191 retval = cfi_send_command(bank, 0xf0, flash_address(bank, 0, 0x0));
2192 if (retval != ERROR_OK)
2195 LOG_ERROR("couldn't write block at base 0x%" PRIx32
2196 ", address 0x%" PRIx32 ", size 0x%" PRIx32, bank->base, address,
2198 return ERROR_FLASH_OPERATION_FAILED;
2204 static int cfi_write_word(struct flash_bank *bank, uint8_t *word, uint32_t address)
2206 struct cfi_flash_bank *cfi_info = bank->driver_priv;
2208 switch (cfi_info->pri_id) {
2211 return cfi_intel_write_word(bank, word, address);
2214 return cfi_spansion_write_word(bank, word, address);
2217 LOG_ERROR("cfi primary command set %i unsupported", cfi_info->pri_id);
2221 return ERROR_FLASH_OPERATION_FAILED;
2224 static int cfi_write_words(struct flash_bank *bank, uint8_t *word,
2225 uint32_t wordcount, uint32_t address)
2227 struct cfi_flash_bank *cfi_info = bank->driver_priv;
2229 if (cfi_info->buf_write_timeout_typ == 0) {
2230 /* buffer writes are not supported */
2231 LOG_DEBUG("Buffer Writes Not Supported");
2232 return ERROR_FLASH_OPER_UNSUPPORTED;
2235 switch (cfi_info->pri_id) {
2238 return cfi_intel_write_words(bank, word, wordcount, address);
2241 return cfi_spansion_write_words(bank, word, wordcount, address);
2244 LOG_ERROR("cfi primary command set %i unsupported", cfi_info->pri_id);
2248 return ERROR_FLASH_OPERATION_FAILED;
2251 static int cfi_read(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_t count)
2253 struct cfi_flash_bank *cfi_info = bank->driver_priv;
2254 struct target *target = bank->target;
2255 uint32_t address = bank->base + offset;
2257 int align; /* number of unaligned bytes */
2258 uint8_t current_word[CFI_MAX_BUS_WIDTH];
2262 LOG_DEBUG("reading buffer of %i byte at 0x%8.8x",
2263 (int)count, (unsigned)offset);
2265 if (bank->target->state != TARGET_HALTED) {
2266 LOG_ERROR("Target not halted");
2267 return ERROR_TARGET_NOT_HALTED;
2270 if (offset + count > bank->size)
2271 return ERROR_FLASH_DST_OUT_OF_BANK;
2273 if (cfi_info->qry[0] != 'Q')
2274 return ERROR_FLASH_BANK_NOT_PROBED;
2276 /* start at the first byte of the first word (bus_width size) */
2277 read_p = address & ~(bank->bus_width - 1);
2278 align = address - read_p;
2280 LOG_INFO("Fixup %d unaligned read head bytes", align);
2282 /* read a complete word from flash */
2283 retval = target_read_memory(target, read_p, bank->bus_width, 1, current_word);
2284 if (retval != ERROR_OK)
2287 /* take only bytes we need */
2288 for (i = align; (i < bank->bus_width) && (count > 0); i++, count--)
2289 *buffer++ = current_word[i];
2291 read_p += bank->bus_width;
2294 align = count / bank->bus_width;
2296 retval = target_read_memory(target, read_p, bank->bus_width, align, buffer);
2297 if (retval != ERROR_OK)
2300 read_p += align * bank->bus_width;
2301 buffer += align * bank->bus_width;
2302 count -= align * bank->bus_width;
2306 LOG_INFO("Fixup %d unaligned read tail bytes", count);
2308 /* read a complete word from flash */
2309 retval = target_read_memory(target, read_p, bank->bus_width, 1, current_word);
2310 if (retval != ERROR_OK)
2313 /* take only bytes we need */
2314 for (i = 0; (i < bank->bus_width) && (count > 0); i++, count--)
2315 *buffer++ = current_word[i];
2321 static int cfi_write(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_t count)
2323 struct cfi_flash_bank *cfi_info = bank->driver_priv;
2324 struct target *target = bank->target;
2325 uint32_t address = bank->base + offset; /* address of first byte to be programmed */
2327 int align; /* number of unaligned bytes */
2328 int blk_count; /* number of bus_width bytes for block copy */
2329 uint8_t current_word[CFI_MAX_BUS_WIDTH * 4]; /* word (bus_width size) currently being
2334 if (bank->target->state != TARGET_HALTED) {
2335 LOG_ERROR("Target not halted");
2336 return ERROR_TARGET_NOT_HALTED;
2339 if (offset + count > bank->size)
2340 return ERROR_FLASH_DST_OUT_OF_BANK;
2342 if (cfi_info->qry[0] != 'Q')
2343 return ERROR_FLASH_BANK_NOT_PROBED;
2345 /* start at the first byte of the first word (bus_width size) */
2346 write_p = address & ~(bank->bus_width - 1);
2347 align = address - write_p;
2349 LOG_INFO("Fixup %d unaligned head bytes", align);
2351 /* read a complete word from flash */
2352 retval = target_read_memory(target, write_p, bank->bus_width, 1, current_word);
2353 if (retval != ERROR_OK)
2356 /* replace only bytes that must be written */
2357 for (i = align; (i < bank->bus_width) && (count > 0); i++, count--)
2358 current_word[i] = *buffer++;
2360 retval = cfi_write_word(bank, current_word, write_p);
2361 if (retval != ERROR_OK)
2363 write_p += bank->bus_width;
2366 /* handle blocks of bus_size aligned bytes */
2367 blk_count = count & ~(bank->bus_width - 1); /* round down, leave tail bytes */
2368 switch (cfi_info->pri_id) {
2369 /* try block writes (fails without working area) */
2372 retval = cfi_intel_write_block(bank, buffer, write_p, blk_count);
2375 retval = cfi_spansion_write_block(bank, buffer, write_p, blk_count);
2378 LOG_ERROR("cfi primary command set %i unsupported", cfi_info->pri_id);
2379 retval = ERROR_FLASH_OPERATION_FAILED;
2382 if (retval == ERROR_OK) {
2383 /* Increment pointers and decrease count on succesful block write */
2384 buffer += blk_count;
2385 write_p += blk_count;
2388 if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE) {
2389 /* Calculate buffer size and boundary mask
2390 * buffersize is (buffer size per chip) * (number of chips)
2391 * bufferwsize is buffersize in words */
2392 uint32_t buffersize =
2394 cfi_info->max_buf_write_size) *
2395 (bank->bus_width / bank->chip_width);
2396 uint32_t buffermask = buffersize-1;
2397 uint32_t bufferwsize = buffersize / bank->bus_width;
2399 /* fall back to memory writes */
2400 while (count >= (uint32_t)bank->bus_width) {
2402 if ((write_p & 0xff) == 0) {
2403 LOG_INFO("Programming at 0x%08" PRIx32 ", count 0x%08"
2404 PRIx32 " bytes remaining", write_p, count);
2407 if ((bufferwsize > 0) && (count >= buffersize) &&
2408 !(write_p & buffermask)) {
2409 retval = cfi_write_words(bank, buffer, bufferwsize, write_p);
2410 if (retval == ERROR_OK) {
2411 buffer += buffersize;
2412 write_p += buffersize;
2413 count -= buffersize;
2415 } else if (retval != ERROR_FLASH_OPER_UNSUPPORTED)
2418 /* try the slow way? */
2420 for (i = 0; i < bank->bus_width; i++)
2421 current_word[i] = *buffer++;
2423 retval = cfi_write_word(bank, current_word, write_p);
2424 if (retval != ERROR_OK)
2427 write_p += bank->bus_width;
2428 count -= bank->bus_width;
2435 /* return to read array mode, so we can read from flash again for padding */
2436 retval = cfi_reset(bank);
2437 if (retval != ERROR_OK)
2440 /* handle unaligned tail bytes */
2442 LOG_INFO("Fixup %" PRId32 " unaligned tail bytes", count);
2444 /* read a complete word from flash */
2445 retval = target_read_memory(target, write_p, bank->bus_width, 1, current_word);
2446 if (retval != ERROR_OK)
2449 /* replace only bytes that must be written */
2450 for (i = 0; (i < bank->bus_width) && (count > 0); i++, count--)
2451 current_word[i] = *buffer++;
2453 retval = cfi_write_word(bank, current_word, write_p);
2454 if (retval != ERROR_OK)
2458 /* return to read array mode */
2459 return cfi_reset(bank);
2462 static void cfi_fixup_reversed_erase_regions(struct flash_bank *bank, void *param)
2465 struct cfi_flash_bank *cfi_info = bank->driver_priv;
2466 struct cfi_spansion_pri_ext *pri_ext = cfi_info->pri_ext;
2468 pri_ext->_reversed_geometry = 1;
2471 static void cfi_fixup_0002_erase_regions(struct flash_bank *bank, void *param)
2474 struct cfi_flash_bank *cfi_info = bank->driver_priv;
2475 struct cfi_spansion_pri_ext *pri_ext = cfi_info->pri_ext;
2478 if ((pri_ext->_reversed_geometry) || (pri_ext->TopBottom == 3)) {
2479 LOG_DEBUG("swapping reversed erase region information on cmdset 0002 device");
2481 for (i = 0; i < cfi_info->num_erase_regions / 2; i++) {
2482 int j = (cfi_info->num_erase_regions - 1) - i;
2485 swap = cfi_info->erase_region_info[i];
2486 cfi_info->erase_region_info[i] = cfi_info->erase_region_info[j];
2487 cfi_info->erase_region_info[j] = swap;
2492 static void cfi_fixup_0002_unlock_addresses(struct flash_bank *bank, void *param)
2494 struct cfi_flash_bank *cfi_info = bank->driver_priv;
2495 struct cfi_spansion_pri_ext *pri_ext = cfi_info->pri_ext;
2496 struct cfi_unlock_addresses *unlock_addresses = param;
2498 pri_ext->_unlock1 = unlock_addresses->unlock1;
2499 pri_ext->_unlock2 = unlock_addresses->unlock2;
2503 static int cfi_query_string(struct flash_bank *bank, int address)
2505 struct cfi_flash_bank *cfi_info = bank->driver_priv;
2508 retval = cfi_send_command(bank, 0x98, flash_address(bank, 0, address));
2509 if (retval != ERROR_OK)
2512 retval = cfi_query_u8(bank, 0, 0x10, &cfi_info->qry[0]);
2513 if (retval != ERROR_OK)
2515 retval = cfi_query_u8(bank, 0, 0x11, &cfi_info->qry[1]);
2516 if (retval != ERROR_OK)
2518 retval = cfi_query_u8(bank, 0, 0x12, &cfi_info->qry[2]);
2519 if (retval != ERROR_OK)
2522 LOG_DEBUG("CFI qry returned: 0x%2.2x 0x%2.2x 0x%2.2x",
2523 cfi_info->qry[0], cfi_info->qry[1], cfi_info->qry[2]);
2525 if ((cfi_info->qry[0] != 'Q') || (cfi_info->qry[1] != 'R') || (cfi_info->qry[2] != 'Y')) {
2526 retval = cfi_reset(bank);
2527 if (retval != ERROR_OK)
2529 LOG_ERROR("Could not probe bank: no QRY");
2530 return ERROR_FLASH_BANK_INVALID;
2536 static int cfi_probe(struct flash_bank *bank)
2538 struct cfi_flash_bank *cfi_info = bank->driver_priv;
2539 struct target *target = bank->target;
2540 int num_sectors = 0;
2543 uint32_t unlock1 = 0x555;
2544 uint32_t unlock2 = 0x2aa;
2546 uint8_t value_buf0[CFI_MAX_BUS_WIDTH], value_buf1[CFI_MAX_BUS_WIDTH];
2548 if (bank->target->state != TARGET_HALTED) {
2549 LOG_ERROR("Target not halted");
2550 return ERROR_TARGET_NOT_HALTED;
2553 cfi_info->probed = 0;
2554 cfi_info->num_erase_regions = 0;
2555 if (bank->sectors) {
2556 free(bank->sectors);
2557 bank->sectors = NULL;
2559 if (cfi_info->erase_region_info) {
2560 free(cfi_info->erase_region_info);
2561 cfi_info->erase_region_info = NULL;
2564 /* JEDEC standard JESD21C uses 0x5555 and 0x2aaa as unlock addresses,
2565 * while CFI compatible AMD/Spansion flashes use 0x555 and 0x2aa
2567 if (cfi_info->jedec_probe) {
2572 /* switch to read identifier codes mode ("AUTOSELECT") */
2573 retval = cfi_send_command(bank, 0xaa, flash_address(bank, 0, unlock1));
2574 if (retval != ERROR_OK)
2576 retval = cfi_send_command(bank, 0x55, flash_address(bank, 0, unlock2));
2577 if (retval != ERROR_OK)
2579 retval = cfi_send_command(bank, 0x90, flash_address(bank, 0, unlock1));
2580 if (retval != ERROR_OK)
2583 retval = target_read_memory(target, flash_address(bank, 0, 0x00),
2584 bank->bus_width, 1, value_buf0);
2585 if (retval != ERROR_OK)
2587 retval = target_read_memory(target, flash_address(bank, 0, 0x01),
2588 bank->bus_width, 1, value_buf1);
2589 if (retval != ERROR_OK)
2591 switch (bank->chip_width) {
2593 cfi_info->manufacturer = *value_buf0;
2594 cfi_info->device_id = *value_buf1;
2597 cfi_info->manufacturer = target_buffer_get_u16(target, value_buf0);
2598 cfi_info->device_id = target_buffer_get_u16(target, value_buf1);
2601 cfi_info->manufacturer = target_buffer_get_u32(target, value_buf0);
2602 cfi_info->device_id = target_buffer_get_u32(target, value_buf1);
2605 LOG_ERROR("Unsupported bank chipwidth %d, can't probe memory",
2607 return ERROR_FLASH_OPERATION_FAILED;
2610 LOG_INFO("Flash Manufacturer/Device: 0x%04x 0x%04x",
2611 cfi_info->manufacturer, cfi_info->device_id);
2612 /* switch back to read array mode */
2613 retval = cfi_reset(bank);
2614 if (retval != ERROR_OK)
2617 /* check device/manufacturer ID for known non-CFI flashes. */
2618 cfi_fixup_non_cfi(bank);
2620 /* query only if this is a CFI compatible flash,
2621 * otherwise the relevant info has already been filled in
2623 if (cfi_info->not_cfi == 0) {
2624 /* enter CFI query mode
2625 * according to JEDEC Standard No. 68.01,
2626 * a single bus sequence with address = 0x55, data = 0x98 should put
2627 * the device into CFI query mode.
2629 * SST flashes clearly violate this, and we will consider them incompatbile for now
2632 retval = cfi_query_string(bank, 0x55);
2633 if (retval != ERROR_OK) {
2635 * Spansion S29WS-N CFI query fix is to try 0x555 if 0x55 fails. Should
2636 * be harmless enough:
2638 * http://www.infradead.org/pipermail/linux-mtd/2005-September/013618.html
2640 LOG_USER("Try workaround w/0x555 instead of 0x55 to get QRY.");
2641 retval = cfi_query_string(bank, 0x555);
2643 if (retval != ERROR_OK)
2646 retval = cfi_query_u16(bank, 0, 0x13, &cfi_info->pri_id);
2647 if (retval != ERROR_OK)
2649 retval = cfi_query_u16(bank, 0, 0x15, &cfi_info->pri_addr);
2650 if (retval != ERROR_OK)
2652 retval = cfi_query_u16(bank, 0, 0x17, &cfi_info->alt_id);
2653 if (retval != ERROR_OK)
2655 retval = cfi_query_u16(bank, 0, 0x19, &cfi_info->alt_addr);
2656 if (retval != ERROR_OK)
2659 LOG_DEBUG("qry: '%c%c%c', pri_id: 0x%4.4x, pri_addr: 0x%4.4x, alt_id: "
2660 "0x%4.4x, alt_addr: 0x%4.4x", cfi_info->qry[0], cfi_info->qry[1],
2661 cfi_info->qry[2], cfi_info->pri_id, cfi_info->pri_addr,
2662 cfi_info->alt_id, cfi_info->alt_addr);
2664 retval = cfi_query_u8(bank, 0, 0x1b, &cfi_info->vcc_min);
2665 if (retval != ERROR_OK)
2667 retval = cfi_query_u8(bank, 0, 0x1c, &cfi_info->vcc_max);
2668 if (retval != ERROR_OK)
2670 retval = cfi_query_u8(bank, 0, 0x1d, &cfi_info->vpp_min);
2671 if (retval != ERROR_OK)
2673 retval = cfi_query_u8(bank, 0, 0x1e, &cfi_info->vpp_max);
2674 if (retval != ERROR_OK)
2677 retval = cfi_query_u8(bank, 0, 0x1f, &cfi_info->word_write_timeout_typ);
2678 if (retval != ERROR_OK)
2680 retval = cfi_query_u8(bank, 0, 0x20, &cfi_info->buf_write_timeout_typ);
2681 if (retval != ERROR_OK)
2683 retval = cfi_query_u8(bank, 0, 0x21, &cfi_info->block_erase_timeout_typ);
2684 if (retval != ERROR_OK)
2686 retval = cfi_query_u8(bank, 0, 0x22, &cfi_info->chip_erase_timeout_typ);
2687 if (retval != ERROR_OK)
2689 retval = cfi_query_u8(bank, 0, 0x23, &cfi_info->word_write_timeout_max);
2690 if (retval != ERROR_OK)
2692 retval = cfi_query_u8(bank, 0, 0x24, &cfi_info->buf_write_timeout_max);
2693 if (retval != ERROR_OK)
2695 retval = cfi_query_u8(bank, 0, 0x25, &cfi_info->block_erase_timeout_max);
2696 if (retval != ERROR_OK)
2698 retval = cfi_query_u8(bank, 0, 0x26, &cfi_info->chip_erase_timeout_max);
2699 if (retval != ERROR_OK)
2703 retval = cfi_query_u8(bank, 0, 0x27, &data);
2704 if (retval != ERROR_OK)
2706 cfi_info->dev_size = 1 << data;
2708 retval = cfi_query_u16(bank, 0, 0x28, &cfi_info->interface_desc);
2709 if (retval != ERROR_OK)
2711 retval = cfi_query_u16(bank, 0, 0x2a, &cfi_info->max_buf_write_size);
2712 if (retval != ERROR_OK)
2714 retval = cfi_query_u8(bank, 0, 0x2c, &cfi_info->num_erase_regions);
2715 if (retval != ERROR_OK)
2718 LOG_DEBUG("size: 0x%" PRIx32 ", interface desc: %i, max buffer write size: 0x%x",
2719 cfi_info->dev_size, cfi_info->interface_desc,
2720 (1 << cfi_info->max_buf_write_size));
2722 if (cfi_info->num_erase_regions) {
2723 cfi_info->erase_region_info = malloc(sizeof(*cfi_info->erase_region_info)
2724 * cfi_info->num_erase_regions);
2725 for (i = 0; i < cfi_info->num_erase_regions; i++) {
2726 retval = cfi_query_u32(bank,
2729 &cfi_info->erase_region_info[i]);
2730 if (retval != ERROR_OK)
2733 "erase region[%i]: %" PRIu32 " blocks of size 0x%" PRIx32 "",
2735 (cfi_info->erase_region_info[i] & 0xffff) + 1,
2736 (cfi_info->erase_region_info[i] >> 16) * 256);
2739 cfi_info->erase_region_info = NULL;
2741 /* We need to read the primary algorithm extended query table before calculating
2742 * the sector layout to be able to apply fixups
2744 switch (cfi_info->pri_id) {
2745 /* Intel command set (standard and extended) */
2748 cfi_read_intel_pri_ext(bank);
2750 /* AMD/Spansion, Atmel, ... command set */
2752 cfi_info->status_poll_mask = CFI_STATUS_POLL_MASK_DQ5_DQ6_DQ7; /*
2759 cfi_read_0002_pri_ext(bank);
2762 LOG_ERROR("cfi primary command set %i unsupported", cfi_info->pri_id);
2766 /* return to read array mode
2767 * we use both reset commands, as some Intel flashes fail to recognize the 0xF0 command
2769 retval = cfi_reset(bank);
2770 if (retval != ERROR_OK)
2772 } /* end CFI case */
2774 LOG_DEBUG("Vcc min: %x.%x, Vcc max: %x.%x, Vpp min: %u.%x, Vpp max: %u.%x",
2775 (cfi_info->vcc_min & 0xf0) >> 4, cfi_info->vcc_min & 0x0f,
2776 (cfi_info->vcc_max & 0xf0) >> 4, cfi_info->vcc_max & 0x0f,
2777 (cfi_info->vpp_min & 0xf0) >> 4, cfi_info->vpp_min & 0x0f,
2778 (cfi_info->vpp_max & 0xf0) >> 4, cfi_info->vpp_max & 0x0f);
2780 LOG_DEBUG("typ. word write timeout: %u us, typ. buf write timeout: %u us, "
2781 "typ. block erase timeout: %u ms, typ. chip erase timeout: %u ms",
2782 1 << cfi_info->word_write_timeout_typ, 1 << cfi_info->buf_write_timeout_typ,
2783 1 << cfi_info->block_erase_timeout_typ, 1 << cfi_info->chip_erase_timeout_typ);
2785 LOG_DEBUG("max. word write timeout: %u us, max. buf write timeout: %u us, "
2786 "max. block erase timeout: %u ms, max. chip erase timeout: %u ms",
2787 (1 << cfi_info->word_write_timeout_max) * (1 << cfi_info->word_write_timeout_typ),
2788 (1 << cfi_info->buf_write_timeout_max) * (1 << cfi_info->buf_write_timeout_typ),
2789 (1 << cfi_info->block_erase_timeout_max) * (1 << cfi_info->block_erase_timeout_typ),
2790 (1 << cfi_info->chip_erase_timeout_max) * (1 << cfi_info->chip_erase_timeout_typ));
2792 /* convert timeouts to real values in ms */
2793 cfi_info->word_write_timeout = DIV_ROUND_UP((1L << cfi_info->word_write_timeout_typ) *
2794 (1L << cfi_info->word_write_timeout_max), 1000);
2795 cfi_info->buf_write_timeout = DIV_ROUND_UP((1L << cfi_info->buf_write_timeout_typ) *
2796 (1L << cfi_info->buf_write_timeout_max), 1000);
2797 cfi_info->block_erase_timeout = (1L << cfi_info->block_erase_timeout_typ) *
2798 (1L << cfi_info->block_erase_timeout_max);
2799 cfi_info->chip_erase_timeout = (1L << cfi_info->chip_erase_timeout_typ) *
2800 (1L << cfi_info->chip_erase_timeout_max);
2802 LOG_DEBUG("calculated word write timeout: %u ms, buf write timeout: %u ms, "
2803 "block erase timeout: %u ms, chip erase timeout: %u ms",
2804 cfi_info->word_write_timeout, cfi_info->buf_write_timeout,
2805 cfi_info->block_erase_timeout, cfi_info->chip_erase_timeout);
2807 /* apply fixups depending on the primary command set */
2808 switch (cfi_info->pri_id) {
2809 /* Intel command set (standard and extended) */
2812 cfi_fixup(bank, cfi_0001_fixups);
2814 /* AMD/Spansion, Atmel, ... command set */
2816 cfi_fixup(bank, cfi_0002_fixups);
2819 LOG_ERROR("cfi primary command set %i unsupported", cfi_info->pri_id);
2823 if ((cfi_info->dev_size * bank->bus_width / bank->chip_width) != bank->size) {
2824 LOG_WARNING("configuration specifies 0x%" PRIx32 " size, but a 0x%" PRIx32
2825 " size flash was found", bank->size, cfi_info->dev_size);
2828 if (cfi_info->num_erase_regions == 0) {
2829 /* a device might have only one erase block, spanning the whole device */
2830 bank->num_sectors = 1;
2831 bank->sectors = malloc(sizeof(struct flash_sector));
2833 bank->sectors[sector].offset = 0x0;
2834 bank->sectors[sector].size = bank->size;
2835 bank->sectors[sector].is_erased = -1;
2836 bank->sectors[sector].is_protected = -1;
2838 uint32_t offset = 0;
2840 for (i = 0; i < cfi_info->num_erase_regions; i++)
2841 num_sectors += (cfi_info->erase_region_info[i] & 0xffff) + 1;
2843 bank->num_sectors = num_sectors;
2844 bank->sectors = malloc(sizeof(struct flash_sector) * num_sectors);
2846 for (i = 0; i < cfi_info->num_erase_regions; i++) {
2848 for (j = 0; j < (cfi_info->erase_region_info[i] & 0xffff) + 1; j++) {
2849 bank->sectors[sector].offset = offset;
2850 bank->sectors[sector].size =
2851 ((cfi_info->erase_region_info[i] >> 16) * 256)
2852 * bank->bus_width / bank->chip_width;
2853 offset += bank->sectors[sector].size;
2854 bank->sectors[sector].is_erased = -1;
2855 bank->sectors[sector].is_protected = -1;
2859 if (offset != (cfi_info->dev_size * bank->bus_width / bank->chip_width)) {
2861 "CFI size is 0x%" PRIx32 ", but total sector size is 0x%" PRIx32 "", \
2862 (cfi_info->dev_size * bank->bus_width / bank->chip_width),
2867 cfi_info->probed = 1;
2872 static int cfi_auto_probe(struct flash_bank *bank)
2874 struct cfi_flash_bank *cfi_info = bank->driver_priv;
2875 if (cfi_info->probed)
2877 return cfi_probe(bank);
2880 static int cfi_intel_protect_check(struct flash_bank *bank)
2883 struct cfi_flash_bank *cfi_info = bank->driver_priv;
2884 struct cfi_intel_pri_ext *pri_ext = cfi_info->pri_ext;
2887 /* check if block lock bits are supported on this device */
2888 if (!(pri_ext->blk_status_reg_mask & 0x1))
2889 return ERROR_FLASH_OPERATION_FAILED;
2891 retval = cfi_send_command(bank, 0x90, flash_address(bank, 0, 0x55));
2892 if (retval != ERROR_OK)
2895 for (i = 0; i < bank->num_sectors; i++) {
2896 uint8_t block_status;
2897 retval = cfi_get_u8(bank, i, 0x2, &block_status);
2898 if (retval != ERROR_OK)
2901 if (block_status & 1)
2902 bank->sectors[i].is_protected = 1;
2904 bank->sectors[i].is_protected = 0;
2907 return cfi_send_command(bank, 0xff, flash_address(bank, 0, 0x0));
2910 static int cfi_spansion_protect_check(struct flash_bank *bank)
2913 struct cfi_flash_bank *cfi_info = bank->driver_priv;
2914 struct cfi_spansion_pri_ext *pri_ext = cfi_info->pri_ext;
2917 retval = cfi_send_command(bank, 0xaa, flash_address(bank, 0, pri_ext->_unlock1));
2918 if (retval != ERROR_OK)
2921 retval = cfi_send_command(bank, 0x55, flash_address(bank, 0, pri_ext->_unlock2));
2922 if (retval != ERROR_OK)
2925 retval = cfi_send_command(bank, 0x90, flash_address(bank, 0, pri_ext->_unlock1));
2926 if (retval != ERROR_OK)
2929 for (i = 0; i < bank->num_sectors; i++) {
2930 uint8_t block_status;
2931 retval = cfi_get_u8(bank, i, 0x2, &block_status);
2932 if (retval != ERROR_OK)
2935 if (block_status & 1)
2936 bank->sectors[i].is_protected = 1;
2938 bank->sectors[i].is_protected = 0;
2941 return cfi_send_command(bank, 0xf0, flash_address(bank, 0, 0x0));
2944 static int cfi_protect_check(struct flash_bank *bank)
2946 struct cfi_flash_bank *cfi_info = bank->driver_priv;
2948 if (bank->target->state != TARGET_HALTED) {
2949 LOG_ERROR("Target not halted");
2950 return ERROR_TARGET_NOT_HALTED;
2953 if (cfi_info->qry[0] != 'Q')
2954 return ERROR_FLASH_BANK_NOT_PROBED;
2956 switch (cfi_info->pri_id) {
2959 return cfi_intel_protect_check(bank);
2962 return cfi_spansion_protect_check(bank);
2965 LOG_ERROR("cfi primary command set %i unsupported", cfi_info->pri_id);
2972 static int get_cfi_info(struct flash_bank *bank, char *buf, int buf_size)
2975 struct cfi_flash_bank *cfi_info = bank->driver_priv;
2977 if (cfi_info->qry[0] == 0xff) {
2978 snprintf(buf, buf_size, "\ncfi flash bank not probed yet\n");
2982 if (cfi_info->not_cfi == 0)
2983 printed = snprintf(buf, buf_size, "\nCFI flash: ");
2985 printed = snprintf(buf, buf_size, "\nnon-CFI flash: ");
2987 buf_size -= printed;
2989 printed = snprintf(buf, buf_size, "mfr: 0x%4.4x, id:0x%4.4x\n\n",
2990 cfi_info->manufacturer, cfi_info->device_id);
2992 buf_size -= printed;
2994 printed = snprintf(buf, buf_size, "qry: '%c%c%c', pri_id: 0x%4.4x, pri_addr: "
2995 "0x%4.4x, alt_id: 0x%4.4x, alt_addr: 0x%4.4x\n",
2996 cfi_info->qry[0], cfi_info->qry[1], cfi_info->qry[2],
2997 cfi_info->pri_id, cfi_info->pri_addr, cfi_info->alt_id, cfi_info->alt_addr);
2999 buf_size -= printed;
3001 printed = snprintf(buf, buf_size, "Vcc min: %x.%x, Vcc max: %x.%x, "
3002 "Vpp min: %u.%x, Vpp max: %u.%x\n",
3003 (cfi_info->vcc_min & 0xf0) >> 4, cfi_info->vcc_min & 0x0f,
3004 (cfi_info->vcc_max & 0xf0) >> 4, cfi_info->vcc_max & 0x0f,
3005 (cfi_info->vpp_min & 0xf0) >> 4, cfi_info->vpp_min & 0x0f,
3006 (cfi_info->vpp_max & 0xf0) >> 4, cfi_info->vpp_max & 0x0f);
3008 buf_size -= printed;
3010 printed = snprintf(buf, buf_size, "typ. word write timeout: %u us, "
3011 "typ. buf write timeout: %u us, "
3012 "typ. block erase timeout: %u ms, "
3013 "typ. chip erase timeout: %u ms\n",
3014 1 << cfi_info->word_write_timeout_typ,
3015 1 << cfi_info->buf_write_timeout_typ,
3016 1 << cfi_info->block_erase_timeout_typ,
3017 1 << cfi_info->chip_erase_timeout_typ);
3019 buf_size -= printed;
3021 printed = snprintf(buf,
3023 "max. word write timeout: %u us, "
3024 "max. buf write timeout: %u us, max. "
3025 "block erase timeout: %u ms, max. chip erase timeout: %u ms\n",
3027 cfi_info->word_write_timeout_max) * (1 << cfi_info->word_write_timeout_typ),
3029 cfi_info->buf_write_timeout_max) * (1 << cfi_info->buf_write_timeout_typ),
3031 cfi_info->block_erase_timeout_max) *
3032 (1 << cfi_info->block_erase_timeout_typ),
3034 cfi_info->chip_erase_timeout_max) *
3035 (1 << cfi_info->chip_erase_timeout_typ));
3037 buf_size -= printed;
3039 printed = snprintf(buf, buf_size, "size: 0x%" PRIx32 ", interface desc: %i, "
3040 "max buffer write size: 0x%x\n",
3042 cfi_info->interface_desc,
3043 1 << cfi_info->max_buf_write_size);
3045 buf_size -= printed;
3047 switch (cfi_info->pri_id) {
3050 cfi_intel_info(bank, buf, buf_size);
3053 cfi_spansion_info(bank, buf, buf_size);
3056 LOG_ERROR("cfi primary command set %i unsupported", cfi_info->pri_id);
3063 static void cfi_fixup_0002_write_buffer(struct flash_bank *bank, void *param)
3065 struct cfi_flash_bank *cfi_info = bank->driver_priv;
3067 /* disable write buffer for M29W128G */
3068 cfi_info->buf_write_timeout_typ = 0;
3071 struct flash_driver cfi_flash = {
3073 .flash_bank_command = cfi_flash_bank_command,
3075 .protect = cfi_protect,
3079 .auto_probe = cfi_auto_probe,
3080 /* FIXME: access flash at bus_width size */
3081 .erase_check = default_flash_blank_check,
3082 .protect_check = cfi_protect_check,
3083 .info = get_cfi_info,