Improve at91sam7.c command argument parsing.
[openocd.git] / src / flash / at91sam7.c
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 ****************************************************************************/
22
23 /***************************************************************************
24 *
25 * New flash setup command:
26 *
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>]
32 *
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 ****************************************************************************/
47
48 #ifdef HAVE_CONFIG_H
49 #include "config.h"
50 #endif
51
52 #include "at91sam7.h"
53 #include "binarybuffer.h"
54
55
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);
66
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);
72
73 flash_driver_t at91sam7_flash =
74 {
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
86 };
87
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 };
91
92 static char * EPROC[8]= {"Unknown","ARM946-E","ARM7TDMI","Unknown","ARM920T","ARM926EJ-S","Unknown","Unknown"};
93
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 */
112 };
113 #endif
114
115 static int at91sam7_register_commands(struct command_context_s *cmd_ctx)
116 {
117 command_t *at91sam7_cmd = register_command(cmd_ctx, NULL, "at91sam7", NULL, COMMAND_ANY, NULL);
118
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;
122 }
123
124 static uint32_t at91sam7_get_flash_status(target_t *target, int bank_number)
125 {
126 uint32_t fsr;
127 target_read_u32(target, MC_FSR[bank_number], &fsr);
128
129 return fsr;
130 }
131
132 /* Read clock configuration and set at91sam7_info->mck_freq */
133 static void at91sam7_read_clock_info(flash_bank_t *bank)
134 {
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;
139
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);
148
149 at91sam7_info->mck_valid = 0;
150 at91sam7_info->mck_freq = 0;
151 switch (mckr & PMC_MCKR_CSS)
152 {
153 case 0: /* Slow Clock */
154 at91sam7_info->mck_valid = 1;
155 tmp = RC_FREQ;
156 break;
157
158 case 1: /* Main Clock */
159 if ((mcfr & CKGR_MCFR_MAINRDY) &&
160 (at91sam7_info->ext_freq == 0))
161 {
162 at91sam7_info->mck_valid = 1;
163 tmp = RC_FREQ / 16ul * (mcfr & 0xffff);
164 }
165 else if (at91sam7_info->ext_freq != 0)
166 {
167 at91sam7_info->mck_valid = 1;
168 tmp = at91sam7_info->ext_freq;
169 }
170 break;
171
172 case 2: /* Reserved */
173 break;
174
175 case 3: /* PLL Clock */
176 if ((mcfr & CKGR_MCFR_MAINRDY) &&
177 (at91sam7_info->ext_freq == 0))
178 {
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);
188 }
189 else if ((at91sam7_info->ext_freq != 0) &&
190 ((pllr&CKGR_PLLR_DIV) != 0))
191 {
192 at91sam7_info->mck_valid = 1;
193 tmp = at91sam7_info->ext_freq / (pllr&CKGR_PLLR_DIV)*
194 (((pllr & CKGR_PLLR_MUL) >> 16) + 1);
195 }
196 break;
197 }
198
199 /* Prescaler adjust */
200 if ((((mckr & PMC_MCKR_PRES) >> 2) == 7) || (tmp == 0))
201 {
202 at91sam7_info->mck_valid = 0;
203 at91sam7_info->mck_freq = 0;
204 }
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;
209 }
210
211 /* Setup the timimg registers for nvbits or normal flash */
212 static void at91sam7_set_flash_mode(flash_bank_t *bank, int mode)
213 {
214 uint32_t fmr, fmcn = 0, fws = 0;
215 at91sam7_flash_bank_t *at91sam7_info = bank->driver_priv;
216 target_t *target = bank->target;
217
218 if (mode && (mode != at91sam7_info->flashmode))
219 {
220 /* Always round up (ceil) */
221 if (mode == FMR_TIMING_NVBITS)
222 {
223 if (at91sam7_info->cidr_arch == 0x60)
224 {
225 /* AT91SAM7A3 uses master clocks in 100 ns */
226 fmcn = (at91sam7_info->mck_freq/10000000ul) + 1;
227 }
228 else
229 {
230 /* master clocks in 1uS for ARCH 0x7 types */
231 fmcn = (at91sam7_info->mck_freq/1000000ul) + 1;
232 }
233 }
234 else if (mode == FMR_TIMING_FLASH)
235 {
236 /* main clocks in 1.5uS */
237 fmcn = (at91sam7_info->mck_freq/1000000ul)+
238 (at91sam7_info->mck_freq/2000000ul) + 1;
239 }
240
241 /* hard overclocking */
242 if (fmcn > 0xFF)
243 fmcn = 0xFF;
244
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;
251
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);
255 }
256
257 at91sam7_info->flashmode = mode;
258 }
259
260 static uint32_t at91sam7_wait_status_busy(flash_bank_t *bank, uint32_t waitbits, int timeout)
261 {
262 uint32_t status;
263
264 while ((!((status = at91sam7_get_flash_status(bank->target, bank->bank_number)) & waitbits)) && (timeout-- > 0))
265 {
266 LOG_DEBUG("status[%i]: 0x%" PRIx32 "", (int)bank->bank_number, status);
267 alive_sleep(1);
268 }
269
270 LOG_DEBUG("status[%i]: 0x%" PRIx32 "", bank->bank_number, status);
271
272 if (status & 0x0C)
273 {
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");
281 }
282
283 return status;
284 }
285
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)
288 {
289 uint32_t fcr;
290 at91sam7_flash_bank_t *at91sam7_info = bank->driver_priv;
291 target_t *target = bank->target;
292
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);
296
297 if ((at91sam7_info->cidr_arch == 0x60) && ((cmd == SLB) | (cmd == CLB)))
298 {
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)
301 {
302 return ERROR_FLASH_OPERATION_FAILED;
303 }
304 return ERROR_OK;
305 }
306
307 if (at91sam7_wait_status_busy(bank, MC_FSR_FRDY, 10)&0x0C)
308 {
309 return ERROR_FLASH_OPERATION_FAILED;
310 }
311
312 return ERROR_OK;
313 }
314
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)
317 {
318 flash_bank_t *t_bank = bank;
319 at91sam7_flash_bank_t *at91sam7_info;
320 target_t *target = t_bank->target;
321
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";
334
335 at91sam7_info = t_bank->driver_priv;
336
337 if (at91sam7_info->cidr != 0)
338 {
339 /* flash already configured, update clock and check for protected sectors */
340 flash_bank_t *fb = bank;
341 t_bank = fb;
342
343 while (t_bank)
344 {
345 /* re-calculate master clock frequency */
346 at91sam7_read_clock_info(t_bank);
347
348 /* no timming */
349 at91sam7_set_flash_mode(t_bank, FMR_TIMING_NONE);
350
351 /* check protect state */
352 at91sam7_protect_check(t_bank);
353
354 t_bank = fb->next;
355 fb = t_bank;
356 }
357
358 return ERROR_OK;
359 }
360
361 /* Read and parse chip identification register */
362 target_read_u32(target, DBGU_CIDR, &cidr);
363 if (cidr == 0)
364 {
365 LOG_WARNING("Cannot identify target as an AT91SAM");
366 return ERROR_FLASH_OPERATION_FAILED;
367 }
368
369 if (at91sam7_info->flash_autodetection == 0)
370 {
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)
375 {
376 at91sam7_info = t_bank->driver_priv;
377
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;
387
388 /* calculate master clock frequency */
389 at91sam7_read_clock_info(t_bank);
390
391 /* no timming */
392 at91sam7_set_flash_mode(t_bank, FMR_TIMING_NONE);
393
394 /* check protect state */
395 at91sam7_protect_check(t_bank);
396
397 t_bank = fb->next;
398 fb = t_bank;
399 }
400
401 return ERROR_OK;
402 }
403
404 arch = (cidr >> 20)&0x00FF;
405
406 /* check flash size */
407 switch ((cidr >> 8)&0x000F)
408 {
409 case FLASH_SIZE_8KB:
410 break;
411
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)
419 {
420 num_nvmbits = 2;
421 target_name = "AT91SAM7S161/16";
422 }
423 break;
424
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)
432 {
433 num_nvmbits = 2;
434 target_name = "AT91SAM7S321/32";
435 }
436 if (arch == 0x72)
437 {
438 num_nvmbits = 3;
439 target_name = "AT91SAM7SE32";
440 }
441 break;
442
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)
450 {
451 num_nvmbits = 2;
452 target_name = "AT91SAM7S64";
453 }
454 break;
455
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)
463 {
464 num_nvmbits = 2;
465 target_name = "AT91SAM7S128";
466 }
467 if (arch == 0x71)
468 {
469 num_nvmbits = 3;
470 target_name = "AT91SAM7XC128";
471 }
472 if (arch == 0x72)
473 {
474 num_nvmbits = 3;
475 target_name = "AT91SAM7SE128";
476 }
477 if (arch == 0x75)
478 {
479 num_nvmbits = 3;
480 target_name = "AT91SAM7X128";
481 }
482 break;
483
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)
491 {
492 num_nvmbits = 3;
493 target_name = "AT91SAM7A3";
494 }
495 if (arch == 0x70)
496 {
497 num_nvmbits = 2;
498 target_name = "AT91SAM7S256";
499 }
500 if (arch == 0x71)
501 {
502 num_nvmbits = 3;
503 target_name = "AT91SAM7XC256";
504 }
505 if (arch == 0x72)
506 {
507 num_nvmbits = 3;
508 target_name = "AT91SAM7SE256";
509 }
510 if (arch == 0x75)
511 {
512 num_nvmbits = 3;
513 target_name = "AT91SAM7X256";
514 }
515 break;
516
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)
524 {
525 num_nvmbits = 2;
526 target_name = "AT91SAM7S512";
527 }
528 if (arch == 0x71)
529 {
530 num_nvmbits = 3;
531 target_name = "AT91SAM7XC512";
532 }
533 if (arch == 0x72)
534 {
535 num_nvmbits = 3;
536 target_name = "AT91SAM7SE512";
537 }
538 if (arch == 0x75)
539 {
540 num_nvmbits = 3;
541 target_name = "AT91SAM7X512";
542 }
543 break;
544
545 case FLASH_SIZE_1024KB:
546 break;
547
548 case FLASH_SIZE_2048KB:
549 break;
550 }
551
552 if (strcmp(target_name, "Unknown") == 0)
553 {
554 LOG_ERROR("Target autodetection failed! Please specify target parameters in configuration file");
555 return ERROR_FLASH_OPERATION_FAILED;
556 }
557
558 ext_freq = at91sam7_info->ext_freq;
559
560 /* calculate bank size */
561 bank_size = sectors_num * pages_per_sector * page_size;
562
563 for (bnk = 0; bnk < banks_num; bnk++)
564 {
565 if (bnk > 0)
566 {
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;
573
574 /* link created bank in 'flash_banks' list and redirect t_bank */
575 t_bank->next = fb;
576 t_bank = fb;
577 }
578
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;
585
586 /* allocate sectors */
587 t_bank->sectors = malloc(sectors_num * sizeof(flash_sector_t));
588 for (sec = 0; sec < sectors_num; sec++)
589 {
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;
594 }
595
596 at91sam7_info = t_bank->driver_priv;
597
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;
607
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;
615
616 /* calculate master clock frequency */
617 at91sam7_read_clock_info(t_bank);
618
619 /* no timming */
620 at91sam7_set_flash_mode(t_bank, FMR_TIMING_NONE);
621
622 /* check protect state */
623 at91sam7_protect_check(t_bank);
624 }
625
626 LOG_DEBUG("nvptyp: 0x%3.3x, arch: 0x%4.4x", at91sam7_info->cidr_nvptyp, at91sam7_info->cidr_arch);
627
628 return ERROR_OK;
629 }
630
631 static int at91sam7_erase_check(struct flash_bank_s *bank)
632 {
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;
640
641 if (bank->target->state != TARGET_HALTED)
642 {
643 LOG_ERROR("Target not halted");
644 return ERROR_TARGET_NOT_HALTED;
645 }
646
647 /* Configure the flash controller timing */
648 at91sam7_read_clock_info(bank);
649 at91sam7_set_flash_mode(bank, FMR_TIMING_FLASH);
650
651 fast_check = 1;
652 for (nSector = 0; nSector < bank->num_sectors; nSector++)
653 {
654 retval = target_blank_check_memory(target, bank->base + bank->sectors[nSector].offset,
655 bank->sectors[nSector].size, &blank);
656 if (retval != ERROR_OK)
657 {
658 fast_check = 0;
659 break;
660 }
661 if (blank == 0xFF)
662 bank->sectors[nSector].is_erased = 1;
663 else
664 bank->sectors[nSector].is_erased = 0;
665 }
666
667 if (fast_check)
668 {
669 return ERROR_OK;
670 }
671
672 LOG_USER("Running slow fallback erase check - add working memory");
673
674 buffer = malloc(bank->sectors[0].size);
675 for (nSector = 0; nSector < bank->num_sectors; nSector++)
676 {
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;
682
683 for (nByte = 0; nByte < bank->sectors[nSector].size; nByte++)
684 {
685 if (buffer[nByte] != 0xFF)
686 {
687 bank->sectors[nSector].is_erased = 0;
688 break;
689 }
690 }
691 }
692 free(buffer);
693
694 return ERROR_OK;
695 }
696
697 static int at91sam7_protect_check(struct flash_bank_s *bank)
698 {
699 uint8_t lock_pos, gpnvm_pos;
700 uint32_t status;
701
702 at91sam7_flash_bank_t *at91sam7_info = bank->driver_priv;
703
704 if (at91sam7_info->cidr == 0)
705 {
706 return ERROR_FLASH_BANK_NOT_PROBED;
707 }
708 if (bank->target->state != TARGET_HALTED)
709 {
710 LOG_ERROR("Target not halted");
711 return ERROR_TARGET_NOT_HALTED;
712 }
713
714 status = at91sam7_get_flash_status(bank->target, bank->bank_number);
715 at91sam7_info->lockbits = (status >> 16);
716
717 at91sam7_info->num_lockbits_on = 0;
718 for (lock_pos = 0; lock_pos < bank->num_sectors; lock_pos++)
719 {
720 if (((status >> (16 + lock_pos))&(0x0001)) == 1)
721 {
722 at91sam7_info->num_lockbits_on++;
723 bank->sectors[lock_pos].is_protected = 1;
724 }
725 else
726 bank->sectors[lock_pos].is_protected = 0;
727 }
728
729 /* GPNVM and SECURITY bits apply only for MC_FSR of EFC0 */
730 status = at91sam7_get_flash_status(bank->target, 0);
731
732 at91sam7_info->securitybit = (status >> 4)&0x01;
733 at91sam7_info->nvmbits = (status >> 8)&0xFF;
734
735 at91sam7_info->num_nvmbits_on = 0;
736 for (gpnvm_pos = 0; gpnvm_pos < at91sam7_info->num_nvmbits; gpnvm_pos++)
737 {
738 if (((status >> (8 + gpnvm_pos))&(0x01)) == 1)
739 {
740 at91sam7_info->num_nvmbits_on++;
741 }
742 }
743
744 return ERROR_OK;
745 }
746
747 static int at91sam7_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank)
748 {
749 flash_bank_t *t_bank = bank;
750 at91sam7_flash_bank_t *at91sam7_info;
751 target_t *target = t_bank->target;
752
753 uint32_t base_address;
754 uint32_t bank_size;
755 uint32_t ext_freq = 0;
756
757 int chip_width;
758 int bus_width;
759 int banks_num;
760 int num_sectors;
761
762 uint16_t pages_per_sector;
763 uint16_t page_size;
764 uint16_t num_nvmbits;
765
766 char *target_name;
767
768 int bnk, sec;
769
770 at91sam7_info = malloc(sizeof(at91sam7_flash_bank_t));
771 t_bank->driver_priv = at91sam7_info;
772
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;
778
779 if (argc < 13)
780 {
781 at91sam7_info->flash_autodetection = 1;
782 return ERROR_OK;
783 }
784
785 COMMAND_PARSE_NUMBER(u32, args[1], base_address);
786
787 COMMAND_PARSE_NUMBER(int, args[3], chip_width);
788 COMMAND_PARSE_NUMBER(int, args[4], bus_width);
789
790 COMMAND_PARSE_NUMBER(int, args[8], banks_num);
791 COMMAND_PARSE_NUMBER(int, args[9], num_sectors);
792 COMMAND_PARSE_NUMBER(u16, args[10], pages_per_sector);
793 COMMAND_PARSE_NUMBER(u16, args[11], page_size);
794 COMMAND_PARSE_NUMBER(u16, args[12], num_nvmbits);
795
796 if (argc == 14) {
797 unsigned long freq;
798 COMMAND_PARSE_NUMBER(ulong, args[13], freq);
799 ext_freq = freq * 1000;
800 at91sam7_info->ext_freq = ext_freq;
801 }
802
803 if ((bus_width == 0) || (banks_num == 0) || (num_sectors == 0) ||
804 (pages_per_sector == 0) || (page_size == 0) || (num_nvmbits == 0))
805 {
806 at91sam7_info->flash_autodetection = 1;
807 return ERROR_OK;
808 }
809
810 target_name = calloc(strlen(args[7]) + 1, sizeof(char));
811 strcpy(target_name, args[7]);
812
813 /* calculate bank size */
814 bank_size = num_sectors * pages_per_sector * page_size;
815
816 for (bnk = 0; bnk < banks_num; bnk++)
817 {
818 if (bnk > 0)
819 {
820 /* create a new bank element */
821 flash_bank_t *fb = malloc(sizeof(flash_bank_t));
822 fb->target = target;
823 fb->driver = &at91sam7_flash;
824 fb->driver_priv = malloc(sizeof(at91sam7_flash_bank_t));
825 fb->next = NULL;
826
827 /* link created bank in 'flash_banks' list and redirect t_bank */
828 t_bank->next = fb;
829 t_bank = fb;
830 }
831
832 t_bank->bank_number = bnk;
833 t_bank->base = base_address + bnk * bank_size;
834 t_bank->size = bank_size;
835 t_bank->chip_width = chip_width;
836 t_bank->bus_width = bus_width;
837 t_bank->num_sectors = num_sectors;
838
839 /* allocate sectors */
840 t_bank->sectors = malloc(num_sectors * sizeof(flash_sector_t));
841 for (sec = 0; sec < num_sectors; sec++)
842 {
843 t_bank->sectors[sec].offset = sec * pages_per_sector * page_size;
844 t_bank->sectors[sec].size = pages_per_sector * page_size;
845 t_bank->sectors[sec].is_erased = -1;
846 t_bank->sectors[sec].is_protected = -1;
847 }
848
849 at91sam7_info = t_bank->driver_priv;
850
851 at91sam7_info->target_name = target_name;
852 at91sam7_info->flashmode = 0;
853 at91sam7_info->ext_freq = ext_freq;
854 at91sam7_info->num_nvmbits = num_nvmbits;
855 at91sam7_info->num_nvmbits_on = 0;
856 at91sam7_info->pagesize = page_size;
857 at91sam7_info->pages_per_sector = pages_per_sector;
858 }
859
860 return ERROR_OK;
861 }
862
863 static int at91sam7_erase(struct flash_bank_s *bank, int first, int last)
864 {
865 at91sam7_flash_bank_t *at91sam7_info = bank->driver_priv;
866 int sec;
867 uint32_t nbytes, pos;
868 uint8_t *buffer;
869 uint8_t erase_all;
870
871 if (at91sam7_info->cidr == 0)
872 {
873 return ERROR_FLASH_BANK_NOT_PROBED;
874 }
875
876 if (bank->target->state != TARGET_HALTED)
877 {
878 LOG_ERROR("Target not halted");
879 return ERROR_TARGET_NOT_HALTED;
880 }
881
882 if ((first < 0) || (last < first) || (last >= bank->num_sectors))
883 {
884 return ERROR_FLASH_SECTOR_INVALID;
885 }
886
887 erase_all = 0;
888 if ((first == 0) && (last == (bank->num_sectors-1)))
889 {
890 erase_all = 1;
891 }
892
893 /* Configure the flash controller timing */
894 at91sam7_read_clock_info(bank);
895 at91sam7_set_flash_mode(bank, FMR_TIMING_FLASH);
896
897 if (erase_all)
898 {
899 if (at91sam7_flash_command(bank, EA, 0) != ERROR_OK)
900 {
901 return ERROR_FLASH_OPERATION_FAILED;
902 }
903 }
904 else
905 {
906 /* allocate and clean buffer */
907 nbytes = (last - first + 1) * bank->sectors[first].size;
908 buffer = malloc(nbytes * sizeof(uint8_t));
909 for (pos = 0; pos < nbytes; pos++)
910 {
911 buffer[pos] = 0xFF;
912 }
913
914 if (at91sam7_write(bank, buffer, bank->sectors[first].offset, nbytes) != ERROR_OK)
915 {
916 return ERROR_FLASH_OPERATION_FAILED;
917 }
918
919 free(buffer);
920 }
921
922 /* mark erased sectors */
923 for (sec = first; sec <= last; sec++)
924 {
925 bank->sectors[sec].is_erased = 1;
926 }
927
928 return ERROR_OK;
929 }
930
931 static int at91sam7_protect(struct flash_bank_s *bank, int set, int first, int last)
932 {
933 uint32_t cmd;
934 int sector;
935 uint32_t pagen;
936
937 at91sam7_flash_bank_t *at91sam7_info = bank->driver_priv;
938
939 if (at91sam7_info->cidr == 0)
940 {
941 return ERROR_FLASH_BANK_NOT_PROBED;
942 }
943
944 if (bank->target->state != TARGET_HALTED)
945 {
946 LOG_ERROR("Target not halted");
947 return ERROR_TARGET_NOT_HALTED;
948 }
949
950 if ((first < 0) || (last < first) || (last >= bank->num_sectors))
951 {
952 return ERROR_FLASH_SECTOR_INVALID;
953 }
954
955 /* Configure the flash controller timing */
956 at91sam7_read_clock_info(bank);
957 at91sam7_set_flash_mode(bank, FMR_TIMING_NVBITS);
958
959 for (sector = first; sector <= last; sector++)
960 {
961 if (set)
962 cmd = SLB;
963 else
964 cmd = CLB;
965
966 /* if we lock a page from one sector then entire sector will be locked, also,
967 * if we unlock a page from a locked sector, entire sector will be unlocked */
968 pagen = sector * at91sam7_info->pages_per_sector;
969
970 if (at91sam7_flash_command(bank, cmd, pagen) != ERROR_OK)
971 {
972 return ERROR_FLASH_OPERATION_FAILED;
973 }
974 }
975
976 at91sam7_protect_check(bank);
977
978 return ERROR_OK;
979 }
980
981 static int at91sam7_write(struct flash_bank_s *bank, uint8_t *buffer, uint32_t offset, uint32_t count)
982 {
983 int retval;
984 at91sam7_flash_bank_t *at91sam7_info = bank->driver_priv;
985 target_t *target = bank->target;
986 uint32_t dst_min_alignment, wcount, bytes_remaining = count;
987 uint32_t first_page, last_page, pagen, buffer_pos;
988
989 if (at91sam7_info->cidr == 0)
990 {
991 return ERROR_FLASH_BANK_NOT_PROBED;
992 }
993
994 if (bank->target->state != TARGET_HALTED)
995 {
996 LOG_ERROR("Target not halted");
997 return ERROR_TARGET_NOT_HALTED;
998 }
999
1000 if (offset + count > bank->size)
1001 return ERROR_FLASH_DST_OUT_OF_BANK;
1002
1003 dst_min_alignment = at91sam7_info->pagesize;
1004
1005 if (offset % dst_min_alignment)
1006 {
1007 LOG_WARNING("offset 0x%" PRIx32 " breaks required alignment 0x%" PRIx32 "", offset, dst_min_alignment);
1008 return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
1009 }
1010
1011 if (at91sam7_info->cidr_arch == 0)
1012 return ERROR_FLASH_BANK_NOT_PROBED;
1013
1014 first_page = offset/dst_min_alignment;
1015 last_page = CEIL(offset + count, dst_min_alignment);
1016
1017 LOG_DEBUG("first_page: %i, last_page: %i, count %i", (int)first_page, (int)last_page, (int)count);
1018
1019 /* Configure the flash controller timing */
1020 at91sam7_read_clock_info(bank);
1021 at91sam7_set_flash_mode(bank, FMR_TIMING_FLASH);
1022
1023 for (pagen = first_page; pagen < last_page; pagen++)
1024 {
1025 if (bytes_remaining < dst_min_alignment)
1026 count = bytes_remaining;
1027 else
1028 count = dst_min_alignment;
1029 bytes_remaining -= count;
1030
1031 /* Write one block to the PageWriteBuffer */
1032 buffer_pos = (pagen-first_page)*dst_min_alignment;
1033 wcount = CEIL(count,4);
1034 if ((retval = target_write_memory(target, bank->base + pagen*dst_min_alignment, 4, wcount, buffer + buffer_pos)) != ERROR_OK)
1035 {
1036 return retval;
1037 }
1038
1039 /* Send Write Page command to Flash Controller */
1040 if (at91sam7_flash_command(bank, WP, pagen) != ERROR_OK)
1041 {
1042 return ERROR_FLASH_OPERATION_FAILED;
1043 }
1044 LOG_DEBUG("Write flash bank:%i page number:%" PRIi32 "", bank->bank_number, pagen);
1045 }
1046
1047 return ERROR_OK;
1048 }
1049
1050 static int at91sam7_probe(struct flash_bank_s *bank)
1051 {
1052 /* we can't probe on an at91sam7
1053 * if this is an at91sam7, it has the configured flash */
1054 int retval;
1055
1056 if (bank->target->state != TARGET_HALTED)
1057 {
1058 LOG_ERROR("Target not halted");
1059 return ERROR_TARGET_NOT_HALTED;
1060 }
1061
1062 retval = at91sam7_read_part_info(bank);
1063 if (retval != ERROR_OK)
1064 return retval;
1065
1066 return ERROR_OK;
1067 }
1068
1069 static int at91sam7_info(struct flash_bank_s *bank, char *buf, int buf_size)
1070 {
1071 int printed;
1072 at91sam7_flash_bank_t *at91sam7_info = bank->driver_priv;
1073
1074 if (at91sam7_info->cidr == 0)
1075 {
1076 return ERROR_FLASH_BANK_NOT_PROBED;
1077 }
1078
1079 printed = snprintf(buf, buf_size,
1080 "\n at91sam7 driver information: Chip is %s\n",
1081 at91sam7_info->target_name);
1082
1083 buf += printed;
1084 buf_size -= printed;
1085
1086 printed = snprintf(buf,
1087 buf_size,
1088 " Cidr: 0x%8.8" PRIx32 " | Arch: 0x%4.4x | Eproc: %s | Version: 0x%3.3x | Flashsize: 0x%8.8" PRIx32 "\n",
1089 at91sam7_info->cidr,
1090 at91sam7_info->cidr_arch,
1091 EPROC[at91sam7_info->cidr_eproc],
1092 at91sam7_info->cidr_version,
1093 bank->size);
1094
1095 buf += printed;
1096 buf_size -= printed;
1097
1098 printed = snprintf(buf, buf_size,
1099 " Master clock (estimated): %u KHz | External clock: %u KHz\n",
1100 (unsigned)(at91sam7_info->mck_freq / 1000), (unsigned)(at91sam7_info->ext_freq / 1000));
1101
1102 buf += printed;
1103 buf_size -= printed;
1104
1105 printed = snprintf(buf, buf_size,
1106 " Pagesize: %i bytes | Lockbits(%i): %i 0x%4.4x | Pages in lock region: %i \n",
1107 at91sam7_info->pagesize, bank->num_sectors, at91sam7_info->num_lockbits_on,
1108 at91sam7_info->lockbits, at91sam7_info->pages_per_sector*at91sam7_info->num_lockbits_on);
1109
1110 buf += printed;
1111 buf_size -= printed;
1112
1113 printed = snprintf(buf, buf_size,
1114 " Securitybit: %i | Nvmbits(%i): %i 0x%1.1x\n",
1115 at91sam7_info->securitybit, at91sam7_info->num_nvmbits,
1116 at91sam7_info->num_nvmbits_on, at91sam7_info->nvmbits);
1117
1118 buf += printed;
1119 buf_size -= printed;
1120
1121 return ERROR_OK;
1122 }
1123
1124 /*
1125 * On AT91SAM7S: When the gpnvm bits are set with
1126 * > at91sam7 gpnvm bitnr set
1127 * the changes are not visible in the flash controller status register MC_FSR
1128 * until the processor has been reset.
1129 * On the Olimex board this requires a power cycle.
1130 * Note that the AT91SAM7S has the following errata (doc6175.pdf sec 14.1.3):
1131 * The maximum number of write/erase cycles for Non volatile Memory bits is 100. this includes
1132 * Lock Bits (LOCKx), General Purpose NVM bits (GPNVMx) and the Security Bit.
1133 */
1134 static int at91sam7_handle_gpnvm_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1135 {
1136 flash_bank_t *bank;
1137 int bit;
1138 uint8_t flashcmd;
1139 uint32_t status;
1140 at91sam7_flash_bank_t *at91sam7_info;
1141 int retval;
1142
1143 if (argc != 2)
1144 {
1145 command_print(cmd_ctx, "at91sam7 gpnvm <bit> <set | clear>");
1146 return ERROR_OK;
1147 }
1148
1149 bank = get_flash_bank_by_num_noprobe(0);
1150 if (bank == NULL)
1151 {
1152 return ERROR_FLASH_BANK_INVALID;
1153 }
1154 if (bank->driver != &at91sam7_flash)
1155 {
1156 command_print(cmd_ctx, "not an at91sam7 flash bank '%s'", args[0]);
1157 return ERROR_FLASH_BANK_INVALID;
1158 }
1159 if (bank->target->state != TARGET_HALTED)
1160 {
1161 LOG_ERROR("target has to be halted to perform flash operation");
1162 return ERROR_TARGET_NOT_HALTED;
1163 }
1164
1165 if (strcmp(args[1], "set") == 0)
1166 {
1167 flashcmd = SGPB;
1168 }
1169 else if (strcmp(args[1], "clear") == 0)
1170 {
1171 flashcmd = CGPB;
1172 }
1173 else
1174 {
1175 return ERROR_COMMAND_SYNTAX_ERROR;
1176 }
1177
1178 at91sam7_info = bank->driver_priv;
1179 if (at91sam7_info->cidr == 0)
1180 {
1181 retval = at91sam7_read_part_info(bank);
1182 if (retval != ERROR_OK)
1183 {
1184 return retval;
1185 }
1186 }
1187
1188 COMMAND_PARSE_NUMBER(int, args[0], bit);
1189 if ((bit < 0) || (bit >= at91sam7_info->num_nvmbits))
1190 {
1191 command_print(cmd_ctx, "gpnvm bit '#%s' is out of bounds for target %s", args[0], at91sam7_info->target_name);
1192 return ERROR_OK;
1193 }
1194
1195 /* Configure the flash controller timing */
1196 at91sam7_read_clock_info(bank);
1197 at91sam7_set_flash_mode(bank, FMR_TIMING_NVBITS);
1198
1199 if (at91sam7_flash_command(bank, flashcmd, bit) != ERROR_OK)
1200 {
1201 return ERROR_FLASH_OPERATION_FAILED;
1202 }
1203
1204 /* GPNVM and SECURITY bits apply only for MC_FSR of EFC0 */
1205 status = at91sam7_get_flash_status(bank->target, 0);
1206 LOG_DEBUG("at91sam7_handle_gpnvm_command: cmd 0x%x, value %d, status 0x%" PRIx32 " \n", flashcmd, bit, status);
1207
1208 /* check protect state */
1209 at91sam7_protect_check(bank);
1210
1211 return ERROR_OK;
1212 }

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)