Merge commit 'origin/master'
[openocd.git] / src / flash / at91sam7.c
blob315a3f3ffd195e1ef7dd441f9902eb87cda5c66f
1 /***************************************************************************
2 * Copyright (C) 2006 by Magnus Lundin *
3 * lundin@mlu.mine.nu *
4 * *
5 * Copyright (C) 2008 by Gheorghe Guran (atlas) *
6 * *
7 * This program is free software; you can redistribute it and/or modify *
8 * it under the terms of the GNU General public License as published by *
9 * the Free Software Foundation; either version 2 of the License, or *
10 * (at your option) any later version. *
11 * *
12 * This program is distributed in the hope that it will be useful, *
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
14 * MERCHANTABILITY or FITNESS for A PARTICULAR PURPOSE. See the *
15 * GNU General public License for more details. *
16 * *
17 * You should have received a copy of the GNU General public License *
18 * along with this program; if not, write to the *
19 * Free Software Foundation, Inc., *
20 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
21 ****************************************************************************/
23 /***************************************************************************
25 * New flash setup command:
27 * flash bank <driver> <base_addr> <size> <chip_width> <bus_width> <target_id>
28 * [<chip_type> <banks>
29 * <sectors_per_bank> <pages_per_sector>
30 * <page_size> <num_nvmbits>
31 * <ext_freq_khz>]
33 * <ext_freq_khz> - MUST be used if clock is from external source,
34 * CAN be used if main oscillator frequency is known (recommended)
35 * Examples:
36 * ==== RECOMMENDED (covers clock speed) ============
37 * flash bank at91sam7 0x00100000 0 0 4 $_TARGETNAME AT91SAM7XC256 1 16 64 256 3 25000
38 * (if auto-detect fails; provides clock spec)
39 * flash bank at91sam7 0 0 0 0 $_TARGETNAME 0 0 0 0 0 0 25000
40 * (auto-detect everything except the clock)
41 * ==== NOT RECOMMENDED !!! (clock speed is not configured) ====
42 * flash bank at91sam7 0x00100000 0 0 4 $_TARGETNAME AT91SAM7XC256 1 16 64 256 3 0
43 * (if auto-detect fails)
44 * flash bank at91sam7 0 0 0 0 $_TARGETNAME
45 * (old style, auto-detect everything)
46 ****************************************************************************/
48 #ifdef HAVE_CONFIG_H
49 #include "config.h"
50 #endif
52 #include "at91sam7.h"
53 #include "binarybuffer.h"
56 static int at91sam7_register_commands(struct command_context_s *cmd_ctx);
57 static int at91sam7_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank);
58 static int at91sam7_erase(struct flash_bank_s *bank, int first, int last);
59 static int at91sam7_protect(struct flash_bank_s *bank, int set, int first, int last);
60 static int at91sam7_write(struct flash_bank_s *bank, uint8_t *buffer, uint32_t offset, uint32_t count);
61 static int at91sam7_probe(struct flash_bank_s *bank);
62 //static int at91sam7_auto_probe(struct flash_bank_s *bank);
63 static int at91sam7_erase_check(struct flash_bank_s *bank);
64 static int at91sam7_protect_check(struct flash_bank_s *bank);
65 static int at91sam7_info(struct flash_bank_s *bank, char *buf, int buf_size);
67 static uint32_t at91sam7_get_flash_status(target_t *target, int bank_number);
68 static void at91sam7_set_flash_mode(flash_bank_t *bank, int mode);
69 static uint32_t at91sam7_wait_status_busy(flash_bank_t *bank, uint32_t waitbits, int timeout);
70 static int at91sam7_flash_command(struct flash_bank_s *bank, uint8_t cmd, uint16_t pagen);
71 static int at91sam7_handle_gpnvm_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
73 flash_driver_t at91sam7_flash =
75 .name = "at91sam7",
76 .register_commands = at91sam7_register_commands,
77 .flash_bank_command = at91sam7_flash_bank_command,
78 .erase = at91sam7_erase,
79 .protect = at91sam7_protect,
80 .write = at91sam7_write,
81 .probe = at91sam7_probe,
82 .auto_probe = at91sam7_probe,
83 .erase_check = at91sam7_erase_check,
84 .protect_check = at91sam7_protect_check,
85 .info = at91sam7_info
88 static uint32_t MC_FMR[4] = { 0xFFFFFF60, 0xFFFFFF70, 0xFFFFFF80, 0xFFFFFF90 };
89 static uint32_t MC_FCR[4] = { 0xFFFFFF64, 0xFFFFFF74, 0xFFFFFF84, 0xFFFFFF94 };
90 static uint32_t MC_FSR[4] = { 0xFFFFFF68, 0xFFFFFF78, 0xFFFFFF88, 0xFFFFFF98 };
92 static char * EPROC[8]= {"Unknown","ARM946-E","ARM7TDMI","Unknown","ARM920T","ARM926EJ-S","Unknown","Unknown"};
94 #if 0
95 static long SRAMSIZ[16] = {
96 -1,
97 0x0400, /* 1K */
98 0x0800, /* 2K */
99 -1,
100 0x1c000, /* 112K */
101 0x1000, /* 4K */
102 0x14000, /* 80K */
103 0x28000, /* 160K */
104 0x2000, /* 8K */
105 0x4000, /* 16K */
106 0x8000, /* 32K */
107 0x10000, /* 64K */
108 0x20000, /* 128K */
109 0x40000, /* 256K */
110 0x18000, /* 96K */
111 0x80000, /* 512K */
113 #endif
115 static int at91sam7_register_commands(struct command_context_s *cmd_ctx)
117 command_t *at91sam7_cmd = register_command(cmd_ctx, NULL, "at91sam7", NULL, COMMAND_ANY, NULL);
119 register_command(cmd_ctx, at91sam7_cmd, "gpnvm", at91sam7_handle_gpnvm_command, COMMAND_EXEC,
120 "at91sam7 gpnvm <bit> set | clear, set or clear one gpnvm bit");
121 return ERROR_OK;
124 static uint32_t at91sam7_get_flash_status(target_t *target, int bank_number)
126 uint32_t fsr;
127 target_read_u32(target, MC_FSR[bank_number], &fsr);
129 return fsr;
132 /* Read clock configuration and set at91sam7_info->mck_freq */
133 static void at91sam7_read_clock_info(flash_bank_t *bank)
135 at91sam7_flash_bank_t *at91sam7_info = bank->driver_priv;
136 target_t *target = bank->target;
137 uint32_t mckr, mcfr, pllr, mor;
138 unsigned long tmp = 0, mainfreq;
140 /* Read Clock Generator Main Oscillator Register */
141 target_read_u32(target, CKGR_MOR, &mor);
142 /* Read Clock Generator Main Clock Frequency Register */
143 target_read_u32(target, CKGR_MCFR, &mcfr);
144 /* Read Master Clock Register*/
145 target_read_u32(target, PMC_MCKR, &mckr);
146 /* Read Clock Generator PLL Register */
147 target_read_u32(target, CKGR_PLLR, &pllr);
149 at91sam7_info->mck_valid = 0;
150 at91sam7_info->mck_freq = 0;
151 switch (mckr & PMC_MCKR_CSS)
153 case 0: /* Slow Clock */
154 at91sam7_info->mck_valid = 1;
155 tmp = RC_FREQ;
156 break;
158 case 1: /* Main Clock */
159 if ((mcfr & CKGR_MCFR_MAINRDY) &&
160 (at91sam7_info->ext_freq == 0))
162 at91sam7_info->mck_valid = 1;
163 tmp = RC_FREQ / 16ul * (mcfr & 0xffff);
165 else if (at91sam7_info->ext_freq != 0)
167 at91sam7_info->mck_valid = 1;
168 tmp = at91sam7_info->ext_freq;
170 break;
172 case 2: /* Reserved */
173 break;
175 case 3: /* PLL Clock */
176 if ((mcfr & CKGR_MCFR_MAINRDY) &&
177 (at91sam7_info->ext_freq == 0))
179 target_read_u32(target, CKGR_PLLR, &pllr);
180 if (!(pllr & CKGR_PLLR_DIV))
181 break; /* 0 Hz */
182 at91sam7_info->mck_valid = 1;
183 mainfreq = RC_FREQ / 16ul * (mcfr & 0xffff);
184 /* Integer arithmetic should have sufficient precision
185 * as long as PLL is properly configured. */
186 tmp = mainfreq / (pllr & CKGR_PLLR_DIV)*
187 (((pllr & CKGR_PLLR_MUL) >> 16) + 1);
189 else if ((at91sam7_info->ext_freq != 0) &&
190 ((pllr&CKGR_PLLR_DIV) != 0))
192 at91sam7_info->mck_valid = 1;
193 tmp = at91sam7_info->ext_freq / (pllr&CKGR_PLLR_DIV)*
194 (((pllr & CKGR_PLLR_MUL) >> 16) + 1);
196 break;
199 /* Prescaler adjust */
200 if ((((mckr & PMC_MCKR_PRES) >> 2) == 7) || (tmp == 0))
202 at91sam7_info->mck_valid = 0;
203 at91sam7_info->mck_freq = 0;
205 else if (((mckr & PMC_MCKR_PRES) >> 2) != 0)
206 at91sam7_info->mck_freq = tmp >> ((mckr & PMC_MCKR_PRES) >> 2);
207 else
208 at91sam7_info->mck_freq = tmp;
211 /* Setup the timimg registers for nvbits or normal flash */
212 static void at91sam7_set_flash_mode(flash_bank_t *bank, int mode)
214 uint32_t fmr, fmcn = 0, fws = 0;
215 at91sam7_flash_bank_t *at91sam7_info = bank->driver_priv;
216 target_t *target = bank->target;
218 if (mode && (mode != at91sam7_info->flashmode))
220 /* Always round up (ceil) */
221 if (mode == FMR_TIMING_NVBITS)
223 if (at91sam7_info->cidr_arch == 0x60)
225 /* AT91SAM7A3 uses master clocks in 100 ns */
226 fmcn = (at91sam7_info->mck_freq/10000000ul) + 1;
228 else
230 /* master clocks in 1uS for ARCH 0x7 types */
231 fmcn = (at91sam7_info->mck_freq/1000000ul) + 1;
234 else if (mode == FMR_TIMING_FLASH)
236 /* main clocks in 1.5uS */
237 fmcn = (at91sam7_info->mck_freq/1000000ul)+
238 (at91sam7_info->mck_freq/2000000ul) + 1;
241 /* hard overclocking */
242 if (fmcn > 0xFF)
243 fmcn = 0xFF;
245 /* Only allow fmcn = 0 if clock period is > 30 us = 33kHz. */
246 if (at91sam7_info->mck_freq <= 33333ul)
247 fmcn = 0;
248 /* Only allow fws = 0 if clock frequency is < 30 MHz. */
249 if (at91sam7_info->mck_freq > 30000000ul)
250 fws = 1;
252 LOG_DEBUG("fmcn[%i]: %i", bank->bank_number, (int)(fmcn));
253 fmr = fmcn << 16 | fws << 8;
254 target_write_u32(target, MC_FMR[bank->bank_number], fmr);
257 at91sam7_info->flashmode = mode;
260 static uint32_t at91sam7_wait_status_busy(flash_bank_t *bank, uint32_t waitbits, int timeout)
262 uint32_t status;
264 while ((!((status = at91sam7_get_flash_status(bank->target, bank->bank_number)) & waitbits)) && (timeout-- > 0))
266 LOG_DEBUG("status[%i]: 0x%" PRIx32 "", (int)bank->bank_number, status);
267 alive_sleep(1);
270 LOG_DEBUG("status[%i]: 0x%" PRIx32 "", bank->bank_number, status);
272 if (status & 0x0C)
274 LOG_ERROR("status register: 0x%" PRIx32 "", status);
275 if (status & 0x4)
276 LOG_ERROR("Lock Error Bit Detected, Operation Abort");
277 if (status & 0x8)
278 LOG_ERROR("Invalid command and/or bad keyword, Operation Abort");
279 if (status & 0x10)
280 LOG_ERROR("Security Bit Set, Operation Abort");
283 return status;
286 /* Send one command to the AT91SAM flash controller */
287 static int at91sam7_flash_command(struct flash_bank_s *bank, uint8_t cmd, uint16_t pagen)
289 uint32_t fcr;
290 at91sam7_flash_bank_t *at91sam7_info = bank->driver_priv;
291 target_t *target = bank->target;
293 fcr = (0x5A << 24) | ((pagen&0x3FF) << 8) | cmd;
294 target_write_u32(target, MC_FCR[bank->bank_number], fcr);
295 LOG_DEBUG("Flash command: 0x%" PRIx32 ", flash bank: %i, page number: %u", fcr, bank->bank_number + 1, pagen);
297 if ((at91sam7_info->cidr_arch == 0x60) && ((cmd == SLB) | (cmd == CLB)))
299 /* Lock bit manipulation on AT91SAM7A3 waits for FC_FSR bit 1, EOL */
300 if (at91sam7_wait_status_busy(bank, MC_FSR_EOL, 10)&0x0C)
302 return ERROR_FLASH_OPERATION_FAILED;
304 return ERROR_OK;
307 if (at91sam7_wait_status_busy(bank, MC_FSR_FRDY, 10)&0x0C)
309 return ERROR_FLASH_OPERATION_FAILED;
312 return ERROR_OK;
315 /* Read device id register, main clock frequency register and fill in driver info structure */
316 static int at91sam7_read_part_info(struct flash_bank_s *bank)
318 flash_bank_t *t_bank = bank;
319 at91sam7_flash_bank_t *at91sam7_info;
320 target_t *target = t_bank->target;
322 uint16_t bnk, sec;
323 uint16_t arch;
324 uint32_t cidr;
325 uint8_t banks_num = 0;
326 uint16_t num_nvmbits = 0;
327 uint16_t sectors_num = 0;
328 uint16_t pages_per_sector = 0;
329 uint16_t page_size = 0;
330 uint32_t ext_freq;
331 uint32_t bank_size;
332 uint32_t base_address = 0;
333 char *target_name = "Unknown";
335 at91sam7_info = t_bank->driver_priv;
337 if (at91sam7_info->cidr != 0)
339 /* flash already configured, update clock and check for protected sectors */
340 flash_bank_t *fb = bank;
341 t_bank = fb;
343 while (t_bank)
345 /* re-calculate master clock frequency */
346 at91sam7_read_clock_info(t_bank);
348 /* no timming */
349 at91sam7_set_flash_mode(t_bank, FMR_TIMING_NONE);
351 /* check protect state */
352 at91sam7_protect_check(t_bank);
354 t_bank = fb->next;
355 fb = t_bank;
358 return ERROR_OK;
361 /* Read and parse chip identification register */
362 target_read_u32(target, DBGU_CIDR, &cidr);
363 if (cidr == 0)
365 LOG_WARNING("Cannot identify target as an AT91SAM");
366 return ERROR_FLASH_OPERATION_FAILED;
369 if (at91sam7_info->flash_autodetection == 0)
371 /* banks and sectors are already created, based on data from input file */
372 flash_bank_t *fb = bank;
373 t_bank = fb;
374 while (t_bank)
376 at91sam7_info = t_bank->driver_priv;
378 at91sam7_info->cidr = cidr;
379 at91sam7_info->cidr_ext = (cidr >> 31)&0x0001;
380 at91sam7_info->cidr_nvptyp = (cidr >> 28)&0x0007;
381 at91sam7_info->cidr_arch = (cidr >> 20)&0x00FF;
382 at91sam7_info->cidr_sramsiz = (cidr >> 16)&0x000F;
383 at91sam7_info->cidr_nvpsiz2 = (cidr >> 12)&0x000F;
384 at91sam7_info->cidr_nvpsiz = (cidr >> 8)&0x000F;
385 at91sam7_info->cidr_eproc = (cidr >> 5)&0x0007;
386 at91sam7_info->cidr_version = cidr&0x001F;
388 /* calculate master clock frequency */
389 at91sam7_read_clock_info(t_bank);
391 /* no timming */
392 at91sam7_set_flash_mode(t_bank, FMR_TIMING_NONE);
394 /* check protect state */
395 at91sam7_protect_check(t_bank);
397 t_bank = fb->next;
398 fb = t_bank;
401 return ERROR_OK;
404 arch = (cidr >> 20)&0x00FF;
406 /* check flash size */
407 switch ((cidr >> 8)&0x000F)
409 case FLASH_SIZE_8KB:
410 break;
412 case FLASH_SIZE_16KB:
413 banks_num = 1;
414 sectors_num = 8;
415 pages_per_sector = 32;
416 page_size = 64;
417 base_address = 0x00100000;
418 if (arch == 0x70)
420 num_nvmbits = 2;
421 target_name = "AT91SAM7S161/16";
423 break;
425 case FLASH_SIZE_32KB:
426 banks_num = 1;
427 sectors_num = 8;
428 pages_per_sector = 32;
429 page_size = 128;
430 base_address = 0x00100000;
431 if (arch == 0x70)
433 num_nvmbits = 2;
434 target_name = "AT91SAM7S321/32";
436 if (arch == 0x72)
438 num_nvmbits = 3;
439 target_name = "AT91SAM7SE32";
441 break;
443 case FLASH_SIZE_64KB:
444 banks_num = 1;
445 sectors_num = 16;
446 pages_per_sector = 32;
447 page_size = 128;
448 base_address = 0x00100000;
449 if (arch == 0x70)
451 num_nvmbits = 2;
452 target_name = "AT91SAM7S64";
454 break;
456 case FLASH_SIZE_128KB:
457 banks_num = 1;
458 sectors_num = 8;
459 pages_per_sector = 64;
460 page_size = 256;
461 base_address = 0x00100000;
462 if (arch == 0x70)
464 num_nvmbits = 2;
465 target_name = "AT91SAM7S128";
467 if (arch == 0x71)
469 num_nvmbits = 3;
470 target_name = "AT91SAM7XC128";
472 if (arch == 0x72)
474 num_nvmbits = 3;
475 target_name = "AT91SAM7SE128";
477 if (arch == 0x75)
479 num_nvmbits = 3;
480 target_name = "AT91SAM7X128";
482 break;
484 case FLASH_SIZE_256KB:
485 banks_num = 1;
486 sectors_num = 16;
487 pages_per_sector = 64;
488 page_size = 256;
489 base_address = 0x00100000;
490 if (arch == 0x60)
492 num_nvmbits = 3;
493 target_name = "AT91SAM7A3";
495 if (arch == 0x70)
497 num_nvmbits = 2;
498 target_name = "AT91SAM7S256";
500 if (arch == 0x71)
502 num_nvmbits = 3;
503 target_name = "AT91SAM7XC256";
505 if (arch == 0x72)
507 num_nvmbits = 3;
508 target_name = "AT91SAM7SE256";
510 if (arch == 0x75)
512 num_nvmbits = 3;
513 target_name = "AT91SAM7X256";
515 break;
517 case FLASH_SIZE_512KB:
518 banks_num = 2;
519 sectors_num = 16;
520 pages_per_sector = 64;
521 page_size = 256;
522 base_address = 0x00100000;
523 if (arch == 0x70)
525 num_nvmbits = 2;
526 target_name = "AT91SAM7S512";
528 if (arch == 0x71)
530 num_nvmbits = 3;
531 target_name = "AT91SAM7XC512";
533 if (arch == 0x72)
535 num_nvmbits = 3;
536 target_name = "AT91SAM7SE512";
538 if (arch == 0x75)
540 num_nvmbits = 3;
541 target_name = "AT91SAM7X512";
543 break;
545 case FLASH_SIZE_1024KB:
546 break;
548 case FLASH_SIZE_2048KB:
549 break;
552 if (strcmp(target_name, "Unknown") == 0)
554 LOG_ERROR("Target autodetection failed! Please specify target parameters in configuration file");
555 return ERROR_FLASH_OPERATION_FAILED;
558 ext_freq = at91sam7_info->ext_freq;
560 /* calculate bank size */
561 bank_size = sectors_num * pages_per_sector * page_size;
563 for (bnk = 0; bnk < banks_num; bnk++)
565 if (bnk > 0)
567 /* create a new flash bank element */
568 flash_bank_t *fb = malloc(sizeof(flash_bank_t));
569 fb->target = target;
570 fb->driver = &at91sam7_flash;
571 fb->driver_priv = malloc(sizeof(at91sam7_flash_bank_t));
572 fb->next = NULL;
574 /* link created bank in 'flash_banks' list and redirect t_bank */
575 t_bank->next = fb;
576 t_bank = fb;
579 t_bank->bank_number = bnk;
580 t_bank->base = base_address + bnk * bank_size;
581 t_bank->size = bank_size;
582 t_bank->chip_width = 0;
583 t_bank->bus_width = 4;
584 t_bank->num_sectors = sectors_num;
586 /* allocate sectors */
587 t_bank->sectors = malloc(sectors_num * sizeof(flash_sector_t));
588 for (sec = 0; sec < sectors_num; sec++)
590 t_bank->sectors[sec].offset = sec * pages_per_sector * page_size;
591 t_bank->sectors[sec].size = pages_per_sector * page_size;
592 t_bank->sectors[sec].is_erased = -1;
593 t_bank->sectors[sec].is_protected = -1;
596 at91sam7_info = t_bank->driver_priv;
598 at91sam7_info->cidr = cidr;
599 at91sam7_info->cidr_ext = (cidr >> 31)&0x0001;
600 at91sam7_info->cidr_nvptyp = (cidr >> 28)&0x0007;
601 at91sam7_info->cidr_arch = (cidr >> 20)&0x00FF;
602 at91sam7_info->cidr_sramsiz = (cidr >> 16)&0x000F;
603 at91sam7_info->cidr_nvpsiz2 = (cidr >> 12)&0x000F;
604 at91sam7_info->cidr_nvpsiz = (cidr >> 8)&0x000F;
605 at91sam7_info->cidr_eproc = (cidr >> 5)&0x0007;
606 at91sam7_info->cidr_version = cidr&0x001F;
608 at91sam7_info->target_name = target_name;
609 at91sam7_info->flashmode = 0;
610 at91sam7_info->ext_freq = ext_freq;
611 at91sam7_info->num_nvmbits = num_nvmbits;
612 at91sam7_info->num_nvmbits_on = 0;
613 at91sam7_info->pagesize = page_size;
614 at91sam7_info->pages_per_sector = pages_per_sector;
616 /* calculate master clock frequency */
617 at91sam7_read_clock_info(t_bank);
619 /* no timming */
620 at91sam7_set_flash_mode(t_bank, FMR_TIMING_NONE);
622 /* check protect state */
623 at91sam7_protect_check(t_bank);
626 LOG_DEBUG("nvptyp: 0x%3.3x, arch: 0x%4.4x", at91sam7_info->cidr_nvptyp, at91sam7_info->cidr_arch);
628 return ERROR_OK;
631 static int at91sam7_erase_check(struct flash_bank_s *bank)
633 target_t *target = bank->target;
634 uint16_t retval;
635 uint32_t blank;
636 uint16_t fast_check;
637 uint8_t *buffer;
638 uint16_t nSector;
639 uint16_t nByte;
641 if (bank->target->state != TARGET_HALTED)
643 LOG_ERROR("Target not halted");
644 return ERROR_TARGET_NOT_HALTED;
647 /* Configure the flash controller timing */
648 at91sam7_read_clock_info(bank);
649 at91sam7_set_flash_mode(bank, FMR_TIMING_FLASH);
651 fast_check = 1;
652 for (nSector = 0; nSector < bank->num_sectors; nSector++)
654 retval = target_blank_check_memory(target, bank->base + bank->sectors[nSector].offset,
655 bank->sectors[nSector].size, &blank);
656 if (retval != ERROR_OK)
658 fast_check = 0;
659 break;
661 if (blank == 0xFF)
662 bank->sectors[nSector].is_erased = 1;
663 else
664 bank->sectors[nSector].is_erased = 0;
667 if (fast_check)
669 return ERROR_OK;
672 LOG_USER("Running slow fallback erase check - add working memory");
674 buffer = malloc(bank->sectors[0].size);
675 for (nSector = 0; nSector < bank->num_sectors; nSector++)
677 bank->sectors[nSector].is_erased = 1;
678 retval = target_read_memory(target, bank->base + bank->sectors[nSector].offset, 4,
679 bank->sectors[nSector].size/4, buffer);
680 if (retval != ERROR_OK)
681 return retval;
683 for (nByte = 0; nByte < bank->sectors[nSector].size; nByte++)
685 if (buffer[nByte] != 0xFF)
687 bank->sectors[nSector].is_erased = 0;
688 break;
692 free(buffer);
694 return ERROR_OK;
697 static int at91sam7_protect_check(struct flash_bank_s *bank)
699 uint8_t lock_pos, gpnvm_pos;
700 uint32_t status;
702 at91sam7_flash_bank_t *at91sam7_info = bank->driver_priv;
704 if (at91sam7_info->cidr == 0)
706 return ERROR_FLASH_BANK_NOT_PROBED;
708 if (bank->target->state != TARGET_HALTED)
710 LOG_ERROR("Target not halted");
711 return ERROR_TARGET_NOT_HALTED;
714 status = at91sam7_get_flash_status(bank->target, bank->bank_number);
715 at91sam7_info->lockbits = (status >> 16);
717 at91sam7_info->num_lockbits_on = 0;
718 for (lock_pos = 0; lock_pos < bank->num_sectors; lock_pos++)
720 if (((status >> (16 + lock_pos))&(0x0001)) == 1)
722 at91sam7_info->num_lockbits_on++;
723 bank->sectors[lock_pos].is_protected = 1;
725 else
726 bank->sectors[lock_pos].is_protected = 0;
729 /* GPNVM and SECURITY bits apply only for MC_FSR of EFC0 */
730 status = at91sam7_get_flash_status(bank->target, 0);
732 at91sam7_info->securitybit = (status >> 4)&0x01;
733 at91sam7_info->nvmbits = (status >> 8)&0xFF;
735 at91sam7_info->num_nvmbits_on = 0;
736 for (gpnvm_pos = 0; gpnvm_pos < at91sam7_info->num_nvmbits; gpnvm_pos++)
738 if (((status >> (8 + gpnvm_pos))&(0x01)) == 1)
740 at91sam7_info->num_nvmbits_on++;
744 return ERROR_OK;
747 static int at91sam7_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank)
749 flash_bank_t *t_bank = bank;
750 at91sam7_flash_bank_t *at91sam7_info;
751 target_t *target = t_bank->target;
753 uint32_t base_address;
754 uint32_t bank_size;
755 uint32_t ext_freq;
757 int chip_width;
758 int bus_width;
759 int banks_num;
760 int num_sectors;
762 uint16_t pages_per_sector;
763 uint16_t page_size;
764 uint16_t num_nvmbits;
766 char *target_name;
768 int bnk, sec;
770 at91sam7_info = malloc(sizeof(at91sam7_flash_bank_t));
771 t_bank->driver_priv = at91sam7_info;
773 /* part wasn't probed for info yet */
774 at91sam7_info->cidr = 0;
775 at91sam7_info->flashmode = 0;
776 at91sam7_info->ext_freq = 0;
777 at91sam7_info->flash_autodetection = 0;
779 if (argc == 14)
781 ext_freq = atol(args[13]) * 1000;
782 at91sam7_info->ext_freq = ext_freq;
785 if ((argc != 14) ||
786 (atoi(args[4]) == 0) || /* bus width */
787 (atoi(args[8]) == 0) || /* banks number */
788 (atoi(args[9]) == 0) || /* sectors per bank */
789 (atoi(args[10]) == 0) || /* pages per sector */
790 (atoi(args[11]) == 0) || /* page size */
791 (atoi(args[12]) == 0)) /* nvmbits number */
793 at91sam7_info->flash_autodetection = 1;
794 return ERROR_OK;
797 base_address = strtoul(args[1], NULL, 0);
798 chip_width = atoi(args[3]);
799 bus_width = atoi(args[4]);
800 banks_num = atoi(args[8]);
801 num_sectors = atoi(args[9]);
802 pages_per_sector = atoi(args[10]);
803 page_size = atoi(args[11]);
804 num_nvmbits = atoi(args[12]);
806 target_name = calloc(strlen(args[7]) + 1, sizeof(char));
807 strcpy(target_name, args[7]);
809 /* calculate bank size */
810 bank_size = num_sectors * pages_per_sector * page_size;
812 for (bnk = 0; bnk < banks_num; bnk++)
814 if (bnk > 0)
816 /* create a new bank element */
817 flash_bank_t *fb = malloc(sizeof(flash_bank_t));
818 fb->target = target;
819 fb->driver = &at91sam7_flash;
820 fb->driver_priv = malloc(sizeof(at91sam7_flash_bank_t));
821 fb->next = NULL;
823 /* link created bank in 'flash_banks' list and redirect t_bank */
824 t_bank->next = fb;
825 t_bank = fb;
828 t_bank->bank_number = bnk;
829 t_bank->base = base_address + bnk * bank_size;
830 t_bank->size = bank_size;
831 t_bank->chip_width = chip_width;
832 t_bank->bus_width = bus_width;
833 t_bank->num_sectors = num_sectors;
835 /* allocate sectors */
836 t_bank->sectors = malloc(num_sectors * sizeof(flash_sector_t));
837 for (sec = 0; sec < num_sectors; sec++)
839 t_bank->sectors[sec].offset = sec * pages_per_sector * page_size;
840 t_bank->sectors[sec].size = pages_per_sector * page_size;
841 t_bank->sectors[sec].is_erased = -1;
842 t_bank->sectors[sec].is_protected = -1;
845 at91sam7_info = t_bank->driver_priv;
847 at91sam7_info->target_name = target_name;
848 at91sam7_info->flashmode = 0;
849 at91sam7_info->ext_freq = ext_freq;
850 at91sam7_info->num_nvmbits = num_nvmbits;
851 at91sam7_info->num_nvmbits_on = 0;
852 at91sam7_info->pagesize = page_size;
853 at91sam7_info->pages_per_sector = pages_per_sector;
856 return ERROR_OK;
859 static int at91sam7_erase(struct flash_bank_s *bank, int first, int last)
861 at91sam7_flash_bank_t *at91sam7_info = bank->driver_priv;
862 int sec;
863 uint32_t nbytes, pos;
864 uint8_t *buffer;
865 uint8_t erase_all;
867 if (at91sam7_info->cidr == 0)
869 return ERROR_FLASH_BANK_NOT_PROBED;
872 if (bank->target->state != TARGET_HALTED)
874 LOG_ERROR("Target not halted");
875 return ERROR_TARGET_NOT_HALTED;
878 if ((first < 0) || (last < first) || (last >= bank->num_sectors))
880 return ERROR_FLASH_SECTOR_INVALID;
883 erase_all = 0;
884 if ((first == 0) && (last == (bank->num_sectors-1)))
886 erase_all = 1;
889 /* Configure the flash controller timing */
890 at91sam7_read_clock_info(bank);
891 at91sam7_set_flash_mode(bank, FMR_TIMING_FLASH);
893 if (erase_all)
895 if (at91sam7_flash_command(bank, EA, 0) != ERROR_OK)
897 return ERROR_FLASH_OPERATION_FAILED;
900 else
902 /* allocate and clean buffer */
903 nbytes = (last - first + 1) * bank->sectors[first].size;
904 buffer = malloc(nbytes * sizeof(uint8_t));
905 for (pos = 0; pos < nbytes; pos++)
907 buffer[pos] = 0xFF;
910 if (at91sam7_write(bank, buffer, bank->sectors[first].offset, nbytes) != ERROR_OK)
912 return ERROR_FLASH_OPERATION_FAILED;
915 free(buffer);
918 /* mark erased sectors */
919 for (sec = first; sec <= last; sec++)
921 bank->sectors[sec].is_erased = 1;
924 return ERROR_OK;
927 static int at91sam7_protect(struct flash_bank_s *bank, int set, int first, int last)
929 uint32_t cmd;
930 int sector;
931 uint32_t pagen;
933 at91sam7_flash_bank_t *at91sam7_info = bank->driver_priv;
935 if (at91sam7_info->cidr == 0)
937 return ERROR_FLASH_BANK_NOT_PROBED;
940 if (bank->target->state != TARGET_HALTED)
942 LOG_ERROR("Target not halted");
943 return ERROR_TARGET_NOT_HALTED;
946 if ((first < 0) || (last < first) || (last >= bank->num_sectors))
948 return ERROR_FLASH_SECTOR_INVALID;
951 /* Configure the flash controller timing */
952 at91sam7_read_clock_info(bank);
953 at91sam7_set_flash_mode(bank, FMR_TIMING_NVBITS);
955 for (sector = first; sector <= last; sector++)
957 if (set)
958 cmd = SLB;
959 else
960 cmd = CLB;
962 /* if we lock a page from one sector then entire sector will be locked, also,
963 * if we unlock a page from a locked sector, entire sector will be unlocked */
964 pagen = sector * at91sam7_info->pages_per_sector;
966 if (at91sam7_flash_command(bank, cmd, pagen) != ERROR_OK)
968 return ERROR_FLASH_OPERATION_FAILED;
972 at91sam7_protect_check(bank);
974 return ERROR_OK;
977 static int at91sam7_write(struct flash_bank_s *bank, uint8_t *buffer, uint32_t offset, uint32_t count)
979 int retval;
980 at91sam7_flash_bank_t *at91sam7_info = bank->driver_priv;
981 target_t *target = bank->target;
982 uint32_t dst_min_alignment, wcount, bytes_remaining = count;
983 uint32_t first_page, last_page, pagen, buffer_pos;
985 if (at91sam7_info->cidr == 0)
987 return ERROR_FLASH_BANK_NOT_PROBED;
990 if (bank->target->state != TARGET_HALTED)
992 LOG_ERROR("Target not halted");
993 return ERROR_TARGET_NOT_HALTED;
996 if (offset + count > bank->size)
997 return ERROR_FLASH_DST_OUT_OF_BANK;
999 dst_min_alignment = at91sam7_info->pagesize;
1001 if (offset % dst_min_alignment)
1003 LOG_WARNING("offset 0x%" PRIx32 " breaks required alignment 0x%" PRIx32 "", offset, dst_min_alignment);
1004 return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
1007 if (at91sam7_info->cidr_arch == 0)
1008 return ERROR_FLASH_BANK_NOT_PROBED;
1010 first_page = offset/dst_min_alignment;
1011 last_page = CEIL(offset + count, dst_min_alignment);
1013 LOG_DEBUG("first_page: %i, last_page: %i, count %i", (int)first_page, (int)last_page, (int)count);
1015 /* Configure the flash controller timing */
1016 at91sam7_read_clock_info(bank);
1017 at91sam7_set_flash_mode(bank, FMR_TIMING_FLASH);
1019 for (pagen = first_page; pagen < last_page; pagen++)
1021 if (bytes_remaining < dst_min_alignment)
1022 count = bytes_remaining;
1023 else
1024 count = dst_min_alignment;
1025 bytes_remaining -= count;
1027 /* Write one block to the PageWriteBuffer */
1028 buffer_pos = (pagen-first_page)*dst_min_alignment;
1029 wcount = CEIL(count,4);
1030 if ((retval = target_write_memory(target, bank->base + pagen*dst_min_alignment, 4, wcount, buffer + buffer_pos)) != ERROR_OK)
1032 return retval;
1035 /* Send Write Page command to Flash Controller */
1036 if (at91sam7_flash_command(bank, WP, pagen) != ERROR_OK)
1038 return ERROR_FLASH_OPERATION_FAILED;
1040 LOG_DEBUG("Write flash bank:%i page number:%" PRIi32 "", bank->bank_number, pagen);
1043 return ERROR_OK;
1046 static int at91sam7_probe(struct flash_bank_s *bank)
1048 /* we can't probe on an at91sam7
1049 * if this is an at91sam7, it has the configured flash */
1050 int retval;
1052 if (bank->target->state != TARGET_HALTED)
1054 LOG_ERROR("Target not halted");
1055 return ERROR_TARGET_NOT_HALTED;
1058 retval = at91sam7_read_part_info(bank);
1059 if (retval != ERROR_OK)
1060 return retval;
1062 return ERROR_OK;
1065 static int at91sam7_info(struct flash_bank_s *bank, char *buf, int buf_size)
1067 int printed;
1068 at91sam7_flash_bank_t *at91sam7_info = bank->driver_priv;
1070 if (at91sam7_info->cidr == 0)
1072 return ERROR_FLASH_BANK_NOT_PROBED;
1075 printed = snprintf(buf, buf_size,
1076 "\n at91sam7 driver information: Chip is %s\n",
1077 at91sam7_info->target_name);
1079 buf += printed;
1080 buf_size -= printed;
1082 printed = snprintf(buf,
1083 buf_size,
1084 " Cidr: 0x%8.8" PRIx32 " | Arch: 0x%4.4x | Eproc: %s | Version: 0x%3.3x | Flashsize: 0x%8.8" PRIx32 "\n",
1085 at91sam7_info->cidr,
1086 at91sam7_info->cidr_arch,
1087 EPROC[at91sam7_info->cidr_eproc],
1088 at91sam7_info->cidr_version,
1089 bank->size);
1091 buf += printed;
1092 buf_size -= printed;
1094 printed = snprintf(buf, buf_size,
1095 " Master clock (estimated): %u KHz | External clock: %u KHz\n",
1096 (unsigned)(at91sam7_info->mck_freq / 1000), (unsigned)(at91sam7_info->ext_freq / 1000));
1098 buf += printed;
1099 buf_size -= printed;
1101 printed = snprintf(buf, buf_size,
1102 " Pagesize: %i bytes | Lockbits(%i): %i 0x%4.4x | Pages in lock region: %i \n",
1103 at91sam7_info->pagesize, bank->num_sectors, at91sam7_info->num_lockbits_on,
1104 at91sam7_info->lockbits, at91sam7_info->pages_per_sector*at91sam7_info->num_lockbits_on);
1106 buf += printed;
1107 buf_size -= printed;
1109 printed = snprintf(buf, buf_size,
1110 " Securitybit: %i | Nvmbits(%i): %i 0x%1.1x\n",
1111 at91sam7_info->securitybit, at91sam7_info->num_nvmbits,
1112 at91sam7_info->num_nvmbits_on, at91sam7_info->nvmbits);
1114 buf += printed;
1115 buf_size -= printed;
1117 return ERROR_OK;
1121 * On AT91SAM7S: When the gpnvm bits are set with
1122 * > at91sam7 gpnvm bitnr set
1123 * the changes are not visible in the flash controller status register MC_FSR
1124 * until the processor has been reset.
1125 * On the Olimex board this requires a power cycle.
1126 * Note that the AT91SAM7S has the following errata (doc6175.pdf sec 14.1.3):
1127 * The maximum number of write/erase cycles for Non volatile Memory bits is 100. this includes
1128 * Lock Bits (LOCKx), General Purpose NVM bits (GPNVMx) and the Security Bit.
1130 static int at91sam7_handle_gpnvm_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1132 flash_bank_t *bank;
1133 int bit;
1134 uint8_t flashcmd;
1135 uint32_t status;
1136 at91sam7_flash_bank_t *at91sam7_info;
1137 int retval;
1139 if (argc != 2)
1141 command_print(cmd_ctx, "at91sam7 gpnvm <bit> <set | clear>");
1142 return ERROR_OK;
1145 bank = get_flash_bank_by_num_noprobe(0);
1146 if (bank == NULL)
1148 return ERROR_FLASH_BANK_INVALID;
1150 if (bank->driver != &at91sam7_flash)
1152 command_print(cmd_ctx, "not an at91sam7 flash bank '%s'", args[0]);
1153 return ERROR_FLASH_BANK_INVALID;
1155 if (bank->target->state != TARGET_HALTED)
1157 LOG_ERROR("target has to be halted to perform flash operation");
1158 return ERROR_TARGET_NOT_HALTED;
1161 if (strcmp(args[1], "set") == 0)
1163 flashcmd = SGPB;
1165 else if (strcmp(args[1], "clear") == 0)
1167 flashcmd = CGPB;
1169 else
1171 return ERROR_COMMAND_SYNTAX_ERROR;
1174 at91sam7_info = bank->driver_priv;
1175 if (at91sam7_info->cidr == 0)
1177 retval = at91sam7_read_part_info(bank);
1178 if (retval != ERROR_OK)
1180 return retval;
1184 bit = atoi(args[0]);
1185 if ((bit < 0) || (bit >= at91sam7_info->num_nvmbits))
1187 command_print(cmd_ctx, "gpnvm bit '#%s' is out of bounds for target %s", args[0], at91sam7_info->target_name);
1188 return ERROR_OK;
1191 /* Configure the flash controller timing */
1192 at91sam7_read_clock_info(bank);
1193 at91sam7_set_flash_mode(bank, FMR_TIMING_NVBITS);
1195 if (at91sam7_flash_command(bank, flashcmd, bit) != ERROR_OK)
1197 return ERROR_FLASH_OPERATION_FAILED;
1200 /* GPNVM and SECURITY bits apply only for MC_FSR of EFC0 */
1201 status = at91sam7_get_flash_status(bank->target, 0);
1202 LOG_DEBUG("at91sam7_handle_gpnvm_command: cmd 0x%x, value %d, status 0x%" PRIx32 " \n", flashcmd, bit, status);
1204 /* check protect state */
1205 at91sam7_protect_check(bank);
1207 return ERROR_OK;