1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2008 by Spencer Oliver *
6 * spen@spen-soft.co.uk *
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. *
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. *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program; if not, write to the *
20 * Free Software Foundation, Inc., *
21 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
22 ***************************************************************************/
27 #include "replacements.h"
35 #include "algorithm.h"
36 #include "binarybuffer.h"
42 static u32 bank1start = 0x00080000;
44 int str9x_register_commands(struct command_context_s *cmd_ctx);
45 int str9x_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank);
46 int str9x_erase(struct flash_bank_s *bank, int first, int last);
47 int str9x_protect(struct flash_bank_s *bank, int set, int first, int last);
48 int str9x_write(struct flash_bank_s *bank, u8 *buffer, u32 offset, u32 count);
49 int str9x_probe(struct flash_bank_s *bank);
50 int str9x_handle_part_id_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
51 int str9x_protect_check(struct flash_bank_s *bank);
52 int str9x_info(struct flash_bank_s *bank, char *buf, int buf_size);
54 int str9x_handle_flash_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
56 flash_driver_t str9x_flash =
59 .register_commands = str9x_register_commands,
60 .flash_bank_command = str9x_flash_bank_command,
62 .protect = str9x_protect,
65 .auto_probe = str9x_probe,
66 .erase_check = default_flash_blank_check,
67 .protect_check = str9x_protect_check,
71 int str9x_register_commands(struct command_context_s *cmd_ctx)
73 command_t *str9x_cmd = register_command(cmd_ctx, NULL, "str9x", NULL, COMMAND_ANY, NULL);
75 register_command(cmd_ctx, str9x_cmd, "flash_config", str9x_handle_flash_config_command, COMMAND_EXEC,
76 "configure str9 flash controller");
81 int str9x_build_block_list(struct flash_bank_s *bank)
83 str9x_flash_bank_t *str9x_info = bank->driver_priv;
87 int b0_sectors = 0, b1_sectors = 0;
90 /* set if we have large flash str9 */
91 str9x_info->variant = 0;
92 str9x_info->bank1 = 0;
103 bank1start = 0x00100000;
104 str9x_info->variant = 1;
108 bank1start = 0x00200000;
109 str9x_info->variant = 1;
113 str9x_info->variant = 1;
114 str9x_info->bank1 = 1;
116 bank1start = bank->base;
119 str9x_info->bank1 = 1;
121 bank1start = bank->base;
124 LOG_ERROR("BUG: unknown bank->size encountered");
128 num_sectors = b0_sectors + b1_sectors;
130 bank->num_sectors = num_sectors;
131 bank->sectors = malloc(sizeof(flash_sector_t) * num_sectors);
132 str9x_info->sector_bits = malloc(sizeof(u32) * num_sectors);
136 for (i = 0; i < b0_sectors; i++)
138 bank->sectors[num_sectors].offset = offset;
139 bank->sectors[num_sectors].size = 0x10000;
140 offset += bank->sectors[i].size;
141 bank->sectors[num_sectors].is_erased = -1;
142 bank->sectors[num_sectors].is_protected = 1;
143 str9x_info->sector_bits[num_sectors++] = (1<<i);
146 for (i = 0; i < b1_sectors; i++)
148 bank->sectors[num_sectors].offset = offset;
149 bank->sectors[num_sectors].size = str9x_info->variant == 0 ? 0x2000 : 0x4000;
150 offset += bank->sectors[i].size;
151 bank->sectors[num_sectors].is_erased = -1;
152 bank->sectors[num_sectors].is_protected = 1;
153 if (str9x_info->variant)
154 str9x_info->sector_bits[num_sectors++] = (1<<i);
156 str9x_info->sector_bits[num_sectors++] = (1<<(i+8));
162 /* flash bank str9x <base> <size> 0 0 <target#>
164 int str9x_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank)
166 str9x_flash_bank_t *str9x_info;
170 LOG_WARNING("incomplete flash_bank str9x configuration");
171 return ERROR_FLASH_BANK_INVALID;
174 str9x_info = malloc(sizeof(str9x_flash_bank_t));
175 bank->driver_priv = str9x_info;
177 str9x_build_block_list(bank);
179 str9x_info->write_algorithm = NULL;
184 int str9x_protect_check(struct flash_bank_s *bank)
186 str9x_flash_bank_t *str9x_info = bank->driver_priv;
187 target_t *target = bank->target;
193 if (bank->target->state != TARGET_HALTED)
195 LOG_ERROR("Target not halted");
196 return ERROR_TARGET_NOT_HALTED;
199 /* read level one protection */
201 if (str9x_info->variant)
203 if (str9x_info->bank1)
205 adr = bank1start + 0x18;
206 target_write_u16(target, adr, 0x90);
207 target_read_u16(target, adr, (u16*)&status);
211 adr = bank1start + 0x14;
212 target_write_u16(target, adr, 0x90);
213 target_read_u32(target, adr, &status);
218 adr = bank1start + 0x10;
219 target_write_u16(target, adr, 0x90);
220 target_read_u16(target, adr, (u16*)&status);
223 /* read array command */
224 target_write_u16(target, adr, 0xFF);
226 for (i = 0; i < bank->num_sectors; i++)
228 if (status & str9x_info->sector_bits[i])
229 bank->sectors[i].is_protected = 1;
231 bank->sectors[i].is_protected = 0;
237 int str9x_erase(struct flash_bank_s *bank, int first, int last)
239 target_t *target = bank->target;
245 if (bank->target->state != TARGET_HALTED)
247 LOG_ERROR("Target not halted");
248 return ERROR_TARGET_NOT_HALTED;
251 /* Check if we erase whole bank */
252 if ((first == 0) && (last == (bank->num_sectors - 1)))
254 /* Optimize to run erase bank command instead of sector */
259 /* Erase sector command */
263 for (i = first; i <= last; i++)
265 adr = bank->base + bank->sectors[i].offset;
268 target_write_u16(target, adr, erase_cmd);
269 target_write_u16(target, adr, 0xD0);
272 target_write_u16(target, adr, 0x70);
275 target_read_u8(target, adr, &status);
281 /* clear status, also clear read array */
282 target_write_u16(target, adr, 0x50);
284 /* read array command */
285 target_write_u16(target, adr, 0xFF);
289 LOG_ERROR("error erasing flash bank, status: 0x%x", status);
290 return ERROR_FLASH_OPERATION_FAILED;
293 /* If we ran erase bank command, we are finished */
294 if (erase_cmd == 0x80)
298 for (i = first; i <= last; i++)
299 bank->sectors[i].is_erased = 1;
304 int str9x_protect(struct flash_bank_s *bank, int set, int first, int last)
306 target_t *target = bank->target;
311 if (bank->target->state != TARGET_HALTED)
313 LOG_ERROR("Target not halted");
314 return ERROR_TARGET_NOT_HALTED;
317 for (i = first; i <= last; i++)
319 /* Level One Protection */
321 adr = bank->base + bank->sectors[i].offset;
323 target_write_u16(target, adr, 0x60);
325 target_write_u16(target, adr, 0x01);
327 target_write_u16(target, adr, 0xD0);
330 target_read_u8(target, adr, &status);
332 /* clear status, also clear read array */
333 target_write_u16(target, adr, 0x50);
335 /* read array command */
336 target_write_u16(target, adr, 0xFF);
342 int str9x_write_block(struct flash_bank_s *bank, u8 *buffer, u32 offset, u32 count)
344 str9x_flash_bank_t *str9x_info = bank->driver_priv;
345 target_t *target = bank->target;
346 u32 buffer_size = 8192;
347 working_area_t *source;
348 u32 address = bank->base + offset;
349 reg_param_t reg_params[4];
350 armv4_5_algorithm_t armv4_5_info;
351 int retval = ERROR_OK;
353 u32 str9x_flash_write_code[] = {
355 0xe3c14003, /* bic r4, r1, #3 */
356 0xe3a03040, /* mov r3, #0x40 */
357 0xe1c430b0, /* strh r3, [r4, #0] */
358 0xe0d030b2, /* ldrh r3, [r0], #2 */
359 0xe0c130b2, /* strh r3, [r1], #2 */
360 0xe3a03070, /* mov r3, #0x70 */
361 0xe1c430b0, /* strh r3, [r4, #0] */
363 0xe5d43000, /* ldrb r3, [r4, #0] */
364 0xe3130080, /* tst r3, #0x80 */
365 0x0afffffc, /* beq busy */
366 0xe3a05050, /* mov r5, #0x50 */
367 0xe1c450b0, /* strh r5, [r4, #0] */
368 0xe3a050ff, /* mov r5, #0xFF */
369 0xe1c450b0, /* strh r5, [r4, #0] */
370 0xe3130012, /* tst r3, #0x12 */
371 0x1a000001, /* bne exit */
372 0xe2522001, /* subs r2, r2, #1 */
373 0x1affffed, /* bne write */
375 0xeafffffe, /* b exit */
378 /* flash write code */
379 if (target_alloc_working_area(target, 4 * 19, &str9x_info->write_algorithm) != ERROR_OK)
381 LOG_WARNING("no working area available, can't do block memory writes");
382 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
385 target_write_buffer(target, str9x_info->write_algorithm->address, 19 * 4, (u8*)str9x_flash_write_code);
388 while (target_alloc_working_area(target, buffer_size, &source) != ERROR_OK)
391 if (buffer_size <= 256)
393 /* if we already allocated the writing code, but failed to get a buffer, free the algorithm */
394 if (str9x_info->write_algorithm)
395 target_free_working_area(target, str9x_info->write_algorithm);
397 LOG_WARNING("no large enough working area available, can't do block memory writes");
398 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
402 armv4_5_info.common_magic = ARMV4_5_COMMON_MAGIC;
403 armv4_5_info.core_mode = ARMV4_5_MODE_SVC;
404 armv4_5_info.core_state = ARMV4_5_STATE_ARM;
406 init_reg_param(®_params[0], "r0", 32, PARAM_OUT);
407 init_reg_param(®_params[1], "r1", 32, PARAM_OUT);
408 init_reg_param(®_params[2], "r2", 32, PARAM_OUT);
409 init_reg_param(®_params[3], "r3", 32, PARAM_IN);
413 u32 thisrun_count = (count > (buffer_size / 2)) ? (buffer_size / 2) : count;
415 target_write_buffer(target, source->address, thisrun_count * 2, buffer);
417 buf_set_u32(reg_params[0].value, 0, 32, source->address);
418 buf_set_u32(reg_params[1].value, 0, 32, address);
419 buf_set_u32(reg_params[2].value, 0, 32, thisrun_count);
421 if ((retval = target->type->run_algorithm(target, 0, NULL, 4, reg_params, str9x_info->write_algorithm->address, str9x_info->write_algorithm->address + (18 * 4), 10000, &armv4_5_info)) != ERROR_OK)
423 LOG_ERROR("error executing str9x flash write algorithm");
424 retval = ERROR_FLASH_OPERATION_FAILED;
428 if (buf_get_u32(reg_params[3].value, 0, 32) != 0x80)
430 retval = ERROR_FLASH_OPERATION_FAILED;
434 buffer += thisrun_count * 2;
435 address += thisrun_count * 2;
436 count -= thisrun_count;
439 target_free_working_area(target, source);
440 target_free_working_area(target, str9x_info->write_algorithm);
442 destroy_reg_param(®_params[0]);
443 destroy_reg_param(®_params[1]);
444 destroy_reg_param(®_params[2]);
445 destroy_reg_param(®_params[3]);
450 int str9x_write(struct flash_bank_s *bank, u8 *buffer, u32 offset, u32 count)
452 target_t *target = bank->target;
453 u32 words_remaining = (count / 2);
454 u32 bytes_remaining = (count & 0x00000001);
455 u32 address = bank->base + offset;
456 u32 bytes_written = 0;
459 u32 check_address = offset;
463 if (bank->target->state != TARGET_HALTED)
465 LOG_ERROR("Target not halted");
466 return ERROR_TARGET_NOT_HALTED;
471 LOG_WARNING("offset 0x%x breaks required 2-byte alignment", offset);
472 return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
475 for (i = 0; i < bank->num_sectors; i++)
477 u32 sec_start = bank->sectors[i].offset;
478 u32 sec_end = sec_start + bank->sectors[i].size;
480 /* check if destination falls within the current sector */
481 if ((check_address >= sec_start) && (check_address < sec_end))
483 /* check if destination ends in the current sector */
484 if (offset + count < sec_end)
485 check_address = offset + count;
487 check_address = sec_end;
491 if (check_address != offset + count)
492 return ERROR_FLASH_DST_OUT_OF_BANK;
494 /* multiple half words (2-byte) to be programmed? */
495 if (words_remaining > 0)
497 /* try using a block write */
498 if ((retval = str9x_write_block(bank, buffer, offset, words_remaining)) != ERROR_OK)
500 if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE)
502 /* if block write failed (no sufficient working area),
503 * we use normal (slow) single dword accesses */
504 LOG_WARNING("couldn't use block writes, falling back to single memory accesses");
506 else if (retval == ERROR_FLASH_OPERATION_FAILED)
508 LOG_ERROR("flash writing failed with error code: 0x%x", retval);
509 return ERROR_FLASH_OPERATION_FAILED;
514 buffer += words_remaining * 2;
515 address += words_remaining * 2;
520 while (words_remaining > 0)
522 bank_adr = address & ~0x03;
524 /* write data command */
525 target_write_u16(target, bank_adr, 0x40);
526 target->type->write_memory(target, address, 2, 1, buffer + bytes_written);
528 /* get status command */
529 target_write_u16(target, bank_adr, 0x70);
532 target_read_u8(target, bank_adr, &status);
538 /* clear status reg and read array */
539 target_write_u16(target, bank_adr, 0x50);
540 target_write_u16(target, bank_adr, 0xFF);
543 return ERROR_FLASH_OPERATION_FAILED;
544 else if (status & 0x02)
545 return ERROR_FLASH_OPERATION_FAILED;
554 u8 last_halfword[2] = {0xff, 0xff};
557 while(bytes_remaining > 0)
559 last_halfword[i++] = *(buffer + bytes_written);
564 bank_adr = address & ~0x03;
566 /* write data comamnd */
567 target_write_u16(target, bank_adr, 0x40);
568 target->type->write_memory(target, address, 2, 1, last_halfword);
570 /* query status command */
571 target_write_u16(target, bank_adr, 0x70);
574 target_read_u8(target, bank_adr, &status);
580 /* clear status reg and read array */
581 target_write_u16(target, bank_adr, 0x50);
582 target_write_u16(target, bank_adr, 0xFF);
585 return ERROR_FLASH_OPERATION_FAILED;
586 else if (status & 0x02)
587 return ERROR_FLASH_OPERATION_FAILED;
593 int str9x_probe(struct flash_bank_s *bank)
598 int str9x_handle_part_id_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
603 int str9x_info(struct flash_bank_s *bank, char *buf, int buf_size)
605 snprintf(buf, buf_size, "str9x flash driver info" );
609 int str9x_handle_flash_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
611 str9x_flash_bank_t *str9x_info;
613 target_t *target = NULL;
617 return ERROR_COMMAND_SYNTAX_ERROR;
620 bank = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
623 command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
627 str9x_info = bank->driver_priv;
629 target = bank->target;
631 if (bank->target->state != TARGET_HALTED)
633 LOG_ERROR("Target not halted");
634 return ERROR_TARGET_NOT_HALTED;
637 /* config flash controller */
638 target_write_u32(target, FLASH_BBSR, strtoul(args[1], NULL, 0));
639 target_write_u32(target, FLASH_NBBSR, strtoul(args[2], NULL, 0));
640 target_write_u32(target, FLASH_BBADR, (strtoul(args[3], NULL, 0) >> 2));
641 target_write_u32(target, FLASH_NBBADR, (strtoul(args[4], NULL, 0) >> 2));
643 /* set bit 18 instruction TCM order as per flash programming manual */
644 arm966e_write_cp15(target, 62, 0x40000);
646 /* enable flash bank 1 */
647 target_write_u32(target, FLASH_CR, 0x18);