1 /***************************************************************************
2 * Copyright (C) 2013 by Andrey Yurovsky *
3 * Andrey Yurovsky <yurovsky@gmail.com> *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
17 ***************************************************************************/
25 #include <target/cortex_m.h>
27 /* At this time, the SAM4L Flash is available in these capacities:
28 * ATSAM4Lx4xx: 256KB (512 pages)
29 * ATSAM4Lx2xx: 128KB (256 pages)
30 * ATSAM4Lx8xx: 512KB (1024 pages)
33 /* There are 16 lockable regions regardless of overall capacity. The number
34 * of pages per sector is therefore dependant on capacity. */
35 #define SAM4L_NUM_SECTORS 16
37 /* Locations in memory map */
38 #define SAM4L_FLASH ((uint32_t)0x00000000) /* Flash region */
39 #define SAM4L_FLASH_USER 0x00800000 /* Flash user page region */
40 #define SAM4L_FLASHCALW 0x400A0000 /* Flash controller */
41 #define SAM4L_CHIPID 0x400E0740 /* Chip Identification */
43 /* Offsets from SAM4L_FLASHCALW */
44 #define SAM4L_FCR 0x00 /* Flash Control Register (RW) */
45 #define SAM4L_FCMD 0x04 /* Flash Command Register (RW) */
46 #define SAM4L_FSR 0x08 /* Flash Status Register (RO) */
47 #define SAM4L_FPR 0x0C /* Flash Parameter Register (RO) */
48 #define SAM4L_FVR 0x10 /* Flash Version Register (RO) */
49 #define SAM4L_FGPFRHI 0x14 /* Flash General Purpose Register High (RO) */
50 #define SAM4L_FGPFRLO 0x18 /* Flash General Purpose Register Low (RO) */
52 /* Offsets from SAM4L_CHIPID */
53 #define SAM4L_CIDR 0x00 /* Chip ID Register (RO) */
54 #define SAM4L_EXID 0x04 /* Chip ID Extension Register (RO) */
56 /* Flash commands (for SAM4L_FCMD), see Table 14-5 */
57 #define SAM4L_FCMD_NOP 0 /* No Operation */
58 #define SAM4L_FCMD_WP 1 /* Write Page */
59 #define SAM4L_FCMD_EP 2 /* Erase Page */
60 #define SAM4L_FCMD_CPB 3 /* Clear Page Buffer */
61 #define SAM4L_FCMD_LP 4 /* Lock region containing given page */
62 #define SAM4L_FCMD_UP 5 /* Unlock region containing given page */
63 #define SAM4L_FCMD_EA 6 /* Erase All */
64 #define SAM4L_FCMD_WGPB 7 /* Write general-purpose fuse bit */
65 #define SAM4L_FCMD_EGPB 8 /* Erase general-purpose fuse bit */
66 #define SAM4L_FCMD_SSB 9 /* Set security fuses */
67 #define SAM4L_FCMD_PGPFB 10 /* Program general-purpose fuse byte */
68 #define SAM4L_FCMD_EAGPF 11 /* Erase all general-purpose fuse bits */
69 #define SAM4L_FCMD_QPR 12 /* Quick page read */
70 #define SAM4L_FCMD_WUP 13 /* Write user page */
71 #define SAM4L_FCMD_EUP 14 /* Erase user page */
72 #define SAM4L_FCMD_QPRUP 15 /* Quick page read (user page) */
73 #define SAM4L_FCMD_HSEN 16 /* High speed mode enable */
74 #define SAM4L_FCMD_HSDIS 17 /* High speed mode disable */
76 #define SAM4L_FMCD_CMDKEY 0xA5UL /* 'key' to issue commands, see 14.10.2 */
79 /* SMAP registers and bits */
80 #define SMAP_BASE 0x400A3000
82 #define SMAP_SCR (SMAP_BASE + 8)
83 #define SMAP_SCR_HCR (1 << 1)
86 struct sam4l_chip_info
{
92 /* These are taken from Table 9-1 in 42023E-SAM-07/2013 */
93 static const struct sam4l_chip_info sam4l_known_chips
[] = {
94 { 0xAB0B0AE0, 0x1400000F, "ATSAM4LC8C" },
95 { 0xAB0A09E0, 0x0400000F, "ATSAM4LC4C" },
96 { 0xAB0A07E0, 0x0400000F, "ATSAM4LC2C" },
97 { 0xAB0B0AE0, 0x1300000F, "ATSAM4LC8B" },
98 { 0xAB0A09E0, 0x0300000F, "ATSAM4LC4B" },
99 { 0xAB0A07E0, 0x0300000F, "ATSAM4LC2B" },
100 { 0xAB0B0AE0, 0x1200000F, "ATSAM4LC8A" },
101 { 0xAB0A09E0, 0x0200000F, "ATSAM4LC4A" },
102 { 0xAB0A07E0, 0x0200000F, "ATSAM4LC2A" },
103 { 0xAB0B0AE0, 0x14000002, "ATSAM4LS8C" },
104 { 0xAB0A09E0, 0x04000002, "ATSAM4LS4C" },
105 { 0xAB0A07E0, 0x04000002, "ATSAM4LS2C" },
106 { 0xAB0B0AE0, 0x13000002, "ATSAM4LS8B" },
107 { 0xAB0A09E0, 0x03000002, "ATSAM4LS4B" },
108 { 0xAB0A07E0, 0x03000002, "ATSAM4LS2B" },
109 { 0xAB0B0AE0, 0x12000002, "ATSAM4LS8A" },
110 { 0xAB0A09E0, 0x02000002, "ATSAM4LS4A" },
111 { 0xAB0A07E0, 0x02000002, "ATSAM4LS2A" },
114 /* Meaning of SRAMSIZ field in CHIPID, see 9.3.1 in 42023E-SAM-07/2013 */
115 static const uint16_t sam4l_ram_sizes
[16] = { 48, 1, 2, 6, 24, 4, 80, 160, 8, 16, 32, 64, 128, 256, 96, 512 };
117 /* Meaning of PSZ field in FPR, see 14.10.4 in 42023E-SAM-07/2013 */
118 static const uint16_t sam4l_page_sizes
[8] = { 32, 64, 128, 256, 512, 1024, 2048, 4096 };
121 const struct sam4l_chip_info
*details
;
128 int pages_per_sector
;
131 struct target
*target
;
132 struct sam4l_info
*next
;
135 static struct sam4l_info
*sam4l_chips
;
137 static int sam4l_flash_wait_until_ready(struct target
*target
)
139 volatile unsigned int t
= 0;
143 /* Poll the status register until the FRDY bit is set */
145 res
= target_read_u32(target
, SAM4L_FLASHCALW
+ SAM4L_FSR
, &st
);
146 } while (res
== ERROR_OK
&& !(st
& (1<<0)) && ++t
< 10);
151 static int sam4l_flash_check_error(struct target
*target
, uint32_t *err
)
156 res
= target_read_u32(target
, SAM4L_FLASHCALW
+ SAM4L_FSR
, &st
);
159 *err
= st
& ((1<<3) | (1<<2)); /* grab PROGE and LOCKE bits */
164 static int sam4l_flash_command(struct target
*target
, uint8_t cmd
, int page
)
170 res
= sam4l_flash_wait_until_ready(target
);
175 /* Set the page number. For some commands, the page number is just an
176 * argument (ex: fuse bit number). */
177 fcmd
= (SAM4L_FMCD_CMDKEY
<< 24) | ((page
& 0xFFFF) << 8) | (cmd
& 0x3F);
179 /* Reuse the page number that was read from the flash command register. */
180 res
= target_read_u32(target
, SAM4L_FLASHCALW
+ SAM4L_FCMD
, &fcmd
);
184 fcmd
&= ~0x3F; /* clear out the command code */
185 fcmd
|= (SAM4L_FMCD_CMDKEY
<< 24) | (cmd
& 0x3F);
188 /* Send the command */
189 res
= target_write_u32(target
, SAM4L_FLASHCALW
+ SAM4L_FCMD
, fcmd
);
193 res
= sam4l_flash_check_error(target
, &err
);
198 LOG_ERROR("%s got error status 0x%08" PRIx32
, __func__
, err
);
200 res
= sam4l_flash_wait_until_ready(target
);
205 FLASH_BANK_COMMAND_HANDLER(sam4l_flash_bank_command
)
207 struct sam4l_info
*chip
= sam4l_chips
;
210 if (chip
->target
== bank
->target
)
216 /* Create a new chip */
217 chip
= calloc(1, sizeof(*chip
));
221 chip
->target
= bank
->target
;
222 chip
->probed
= false;
224 bank
->driver_priv
= chip
;
226 /* Insert it into the chips list (at head) */
227 chip
->next
= sam4l_chips
;
231 if (bank
->base
!= SAM4L_FLASH
) {
232 LOG_ERROR("Address 0x%08" PRIx32
" invalid bank address (try 0x%08" PRIx32
233 "[at91sam4l series] )",
234 bank
->base
, SAM4L_FLASH
);
241 static const struct sam4l_chip_info
*sam4l_find_chip_name(uint32_t id
, uint32_t exid
)
247 for (i
= 0; i
< ARRAY_SIZE(sam4l_known_chips
); i
++) {
248 if (sam4l_known_chips
[i
].id
== id
&& sam4l_known_chips
[i
].exid
== exid
)
249 return &sam4l_known_chips
[i
];
255 static int sam4l_check_page_erased(struct flash_bank
*bank
, uint32_t pn
,
261 /* Issue a quick page read to verify that we've erased this page */
262 res
= sam4l_flash_command(bank
->target
, SAM4L_FCMD_QPR
, pn
);
263 if (res
!= ERROR_OK
) {
264 LOG_ERROR("Quick page read %" PRIu32
" failed", pn
);
268 /* Retrieve the flash status */
269 res
= target_read_u32(bank
->target
, SAM4L_FLASHCALW
+ SAM4L_FSR
, &st
);
270 if (res
!= ERROR_OK
) {
271 LOG_ERROR("Couldn't read erase status");
275 /* Is the page in question really erased? */
276 *is_erased_p
= !!(st
& (1<<5));
281 static int sam4l_probe(struct flash_bank
*bank
)
283 uint32_t id
, exid
, param
;
285 struct sam4l_info
*chip
= (struct sam4l_info
*)bank
->driver_priv
;
290 res
= target_read_u32(bank
->target
, SAM4L_CHIPID
+ SAM4L_CIDR
, &id
);
291 if (res
!= ERROR_OK
) {
292 LOG_ERROR("Couldn't read chip ID");
296 res
= target_read_u32(bank
->target
, SAM4L_CHIPID
+ SAM4L_EXID
, &exid
);
297 if (res
!= ERROR_OK
) {
298 LOG_ERROR("Couldn't read extended chip ID");
302 chip
->details
= sam4l_find_chip_name(id
, exid
);
304 /* The RAM capacity is in a lookup table. */
305 chip
->ram_kb
= sam4l_ram_sizes
[0xF & (id
>> 16)];
307 switch (0xF & (id
>> 8)) {
309 chip
->flash_kb
= 128;
312 chip
->flash_kb
= 256;
315 chip
->flash_kb
= 512;
318 LOG_ERROR("Unknown flash size (chip ID is %08" PRIx32
"), assuming 128K", id
);
319 chip
->flash_kb
= 128;
323 /* Retrieve the Flash parameters */
324 res
= target_read_u32(bank
->target
, SAM4L_FLASHCALW
+ SAM4L_FPR
, ¶m
);
325 if (res
!= ERROR_OK
) {
326 LOG_ERROR("Couldn't read Flash parameters");
330 /* Fetch the page size from the parameter register. Technically the flash
331 * capacity is there too though the manual mentions that not all parts will
332 * have it set so we use the Chip ID capacity information instead. */
333 chip
->page_size
= sam4l_page_sizes
[0x7 & (param
>> 8)];
334 assert(chip
->page_size
);
335 chip
->num_pages
= chip
->flash_kb
* 1024 / chip
->page_size
;
337 chip
->sector_size
= (chip
->flash_kb
* 1024) / SAM4L_NUM_SECTORS
;
338 chip
->pages_per_sector
= chip
->sector_size
/ chip
->page_size
;
340 /* Make sure the bank size is correct */
341 bank
->size
= chip
->flash_kb
* 1024;
343 /* Allocate the sector table. */
344 bank
->num_sectors
= SAM4L_NUM_SECTORS
;
345 bank
->sectors
= calloc(bank
->num_sectors
, (sizeof((bank
->sectors
)[0])));
349 /* Fill out the sector information: all SAM4L sectors are the same size and
350 * there is always a fixed number of them. */
351 for (int i
= 0; i
< bank
->num_sectors
; i
++) {
352 bank
->sectors
[i
].size
= chip
->sector_size
;
353 bank
->sectors
[i
].offset
= i
* chip
->sector_size
;
354 /* mark as unknown */
355 bank
->sectors
[i
].is_erased
= -1;
356 bank
->sectors
[i
].is_protected
= -1;
362 LOG_INFO("SAM4L MCU: %s (Rev %c) (%" PRIu32
"KB Flash with %d %" PRId32
"B pages, %" PRIu32
"KB RAM)",
363 chip
->details
? chip
->details
->name
: "unknown", (char)('A' + (id
& 0xF)),
364 chip
->flash_kb
, chip
->num_pages
, chip
->page_size
, chip
->ram_kb
);
369 static int sam4l_protect_check(struct flash_bank
*bank
)
373 struct sam4l_info
*chip
= (struct sam4l_info
*)bank
->driver_priv
;
375 if (bank
->target
->state
!= TARGET_HALTED
) {
376 LOG_ERROR("Target not halted");
378 return ERROR_TARGET_NOT_HALTED
;
382 if (sam4l_probe(bank
) != ERROR_OK
)
383 return ERROR_FLASH_BANK_NOT_PROBED
;
386 res
= target_read_u32(bank
->target
, SAM4L_FLASHCALW
+ SAM4L_FSR
, &st
);
390 st
>>= 16; /* There are 16 lock region bits in the upper half word */
391 for (int i
= 0; i
< bank
->num_sectors
; i
++)
392 bank
->sectors
[i
].is_protected
= !!(st
& (1<<i
));
397 static int sam4l_protect(struct flash_bank
*bank
, int set
, int first
, int last
)
399 struct sam4l_info
*chip
= sam4l_chips
;
401 if (bank
->target
->state
!= TARGET_HALTED
) {
402 LOG_ERROR("Target not halted");
404 return ERROR_TARGET_NOT_HALTED
;
408 if (sam4l_probe(bank
) != ERROR_OK
)
409 return ERROR_FLASH_BANK_NOT_PROBED
;
412 /* Make sure the pages make sense. */
413 if (first
>= bank
->num_sectors
|| last
>= bank
->num_sectors
) {
414 LOG_ERROR("Protect range %d - %d not valid (%d sectors total)", first
, last
,
419 /* Try to lock or unlock each sector in the range. This is done by locking
420 * a region containing one page in that sector, we arbitrarily choose the 0th
421 * page in the sector. */
422 for (int i
= first
; i
<= last
; i
++) {
425 res
= sam4l_flash_command(bank
->target
,
426 set
? SAM4L_FCMD_LP
: SAM4L_FCMD_UP
, i
* chip
->pages_per_sector
);
427 if (res
!= ERROR_OK
) {
428 LOG_ERROR("Can't %slock region containing page %d", set
? "" : "un", i
);
436 static int sam4l_erase(struct flash_bank
*bank
, int first
, int last
)
439 struct sam4l_info
*chip
= (struct sam4l_info
*)bank
->driver_priv
;
441 if (bank
->target
->state
!= TARGET_HALTED
) {
442 LOG_ERROR("Target not halted");
444 return ERROR_TARGET_NOT_HALTED
;
448 if (sam4l_probe(bank
) != ERROR_OK
)
449 return ERROR_FLASH_BANK_NOT_PROBED
;
452 /* Make sure the pages make sense. */
453 if (first
>= bank
->num_sectors
|| last
>= bank
->num_sectors
) {
454 LOG_ERROR("Erase range %d - %d not valid (%d sectors total)", first
, last
,
460 if ((first
== 0) && ((last
+ 1) == bank
->num_sectors
)) {
461 LOG_DEBUG("Erasing the whole chip");
463 ret
= sam4l_flash_command(bank
->target
, SAM4L_FCMD_EA
, -1);
464 if (ret
!= ERROR_OK
) {
465 LOG_ERROR("Erase All failed");
469 LOG_DEBUG("Erasing sectors %d through %d...\n", first
, last
);
471 /* For each sector... */
472 for (int i
= first
; i
<= last
; i
++) {
473 /* For each page in that sector... */
474 for (int j
= 0; j
< chip
->pages_per_sector
; j
++) {
475 int pn
= i
* chip
->pages_per_sector
+ j
;
476 bool is_erased
= false;
478 /* Issue the page erase */
479 ret
= sam4l_flash_command(bank
->target
, SAM4L_FCMD_EP
, pn
);
480 if (ret
!= ERROR_OK
) {
481 LOG_ERROR("Erasing page %d failed", pn
);
485 ret
= sam4l_check_page_erased(bank
, pn
, &is_erased
);
490 LOG_DEBUG("Page %d was not erased.", pn
);
495 /* This sector is definitely erased. */
496 bank
->sectors
[i
].is_erased
= 1;
503 /* Write an entire page from host buffer 'buf' to page-aligned 'address' in the
505 static int sam4l_write_page(struct sam4l_info
*chip
, struct target
*target
,
506 uint32_t address
, const uint8_t *buf
)
510 LOG_DEBUG("sam4l_write_page address=%08" PRIx32
, address
);
512 /* Clear the page buffer before we write to it */
513 res
= sam4l_flash_command(target
, SAM4L_FCMD_CPB
, -1);
514 if (res
!= ERROR_OK
) {
515 LOG_ERROR("%s: can't clear page buffer", __func__
);
519 /* Write the modified page back to the target's page buffer */
520 res
= target_write_memory(target
, address
, 4, chip
->page_size
/ 4, buf
);
522 if (res
!= ERROR_OK
) {
523 LOG_ERROR("%s: %d", __func__
, __LINE__
);
527 /* Commit the page contents to Flash: erase the current page and then
529 res
= sam4l_flash_command(target
, SAM4L_FCMD_EP
, -1);
532 res
= sam4l_flash_command(target
, SAM4L_FCMD_WP
, -1);
537 /* Write partial contents into page-aligned 'address' on the Flash from host
538 * buffer 'buf' by writing 'nb' of 'buf' at 'offset' into the Flash page. */
539 static int sam4l_write_page_partial(struct sam4l_info
*chip
,
540 struct flash_bank
*bank
, uint32_t address
, const uint8_t *buf
,
541 uint32_t page_offset
, uint32_t nb
)
544 uint8_t *pg
= malloc(chip
->page_size
);
548 LOG_DEBUG("sam4l_write_page_partial address=%08" PRIx32
" nb=%08" PRIx32
, address
, nb
);
550 assert(page_offset
+ nb
< chip
->page_size
);
551 assert((address
% chip
->page_size
) == 0);
553 /* Retrieve the full page contents from Flash */
554 res
= target_read_memory(bank
->target
, address
, 4,
555 chip
->page_size
/ 4, pg
);
556 if (res
!= ERROR_OK
) {
561 /* Insert our partial page over the data from Flash */
562 memcpy(pg
+ (page_offset
% chip
->page_size
), buf
, nb
);
564 /* Write the page back out */
565 res
= sam4l_write_page(chip
, bank
->target
, address
, pg
);
571 static int sam4l_write(struct flash_bank
*bank
, const uint8_t *buffer
,
572 uint32_t offset
, uint32_t count
)
576 struct sam4l_info
*chip
= (struct sam4l_info
*)bank
->driver_priv
;
578 LOG_DEBUG("sam4l_write offset=%08" PRIx32
" count=%08" PRIx32
, offset
, count
);
580 if (bank
->target
->state
!= TARGET_HALTED
) {
581 LOG_ERROR("Target not halted");
583 return ERROR_TARGET_NOT_HALTED
;
587 if (sam4l_probe(bank
) != ERROR_OK
)
588 return ERROR_FLASH_BANK_NOT_PROBED
;
591 if (offset
% chip
->page_size
) {
592 /* We're starting at an unaligned offset so we'll write a partial page
593 * comprising that offset and up to the end of that page. */
594 nb
= chip
->page_size
- (offset
% chip
->page_size
);
597 } else if (count
< chip
->page_size
) {
598 /* We're writing an aligned but partial page. */
603 res
= sam4l_write_page_partial(chip
, bank
,
604 (offset
/ chip
->page_size
) * chip
->page_size
+ bank
->base
,
606 offset
% chip
->page_size
, nb
);
610 /* We're done with the page contents */
615 /* There's at least one aligned page to write out. */
616 if (count
>= chip
->page_size
) {
617 int np
= count
/ chip
->page_size
+ ((count
% chip
->page_size
) ? 1 : 0);
619 for (int i
= 0; i
< np
; i
++) {
620 if (count
>= chip
->page_size
) {
621 res
= sam4l_write_page(chip
, bank
->target
,
623 buffer
+ (i
* chip
->page_size
));
624 /* Advance one page */
625 offset
+= chip
->page_size
;
626 count
-= chip
->page_size
;
628 res
= sam4l_write_page_partial(chip
, bank
,
630 buffer
+ (i
* chip
->page_size
), 0, count
);
631 /* We're done after this. */
645 COMMAND_HANDLER(sam4l_handle_reset_deassert
)
647 struct target
*target
= get_current_target(CMD_CTX
);
648 int retval
= ERROR_OK
;
649 enum reset_types jtag_reset_config
= jtag_get_reset_config();
651 /* If the target has been unresponsive before, try to re-establish
652 * communication now - CPU is held in reset by DSU, DAP is working */
653 if (!target_was_examined(target
))
654 target_examine_one(target
);
657 /* In case of sysresetreq, debug retains state set in cortex_m_assert_reset()
658 * so we just release reset held by SMAP
660 * n_RESET (srst) clears the DP, so reenable debug and set vector catch here
662 * After vectreset SMAP release is not needed however makes no harm
664 if (target
->reset_halt
&& (jtag_reset_config
& RESET_HAS_SRST
)) {
665 retval
= target_write_u32(target
, DCB_DHCSR
, DBGKEY
| C_HALT
| C_DEBUGEN
);
666 if (retval
== ERROR_OK
)
667 retval
= target_write_u32(target
, DCB_DEMCR
,
668 TRCENA
| VC_HARDERR
| VC_BUSERR
| VC_CORERESET
);
669 /* do not return on error here, releasing SMAP reset is more important */
672 int retval2
= target_write_u32(target
, SMAP_SCR
, SMAP_SCR_HCR
);
673 if (retval2
!= ERROR_OK
)
679 static const struct command_registration at91sam4l_exec_command_handlers
[] = {
681 .name
= "smap_reset_deassert",
682 .handler
= sam4l_handle_reset_deassert
,
683 .mode
= COMMAND_EXEC
,
684 .help
= "deasert internal reset held by SMAP"
686 COMMAND_REGISTRATION_DONE
689 static const struct command_registration at91sam4l_command_handlers
[] = {
693 .help
= "at91sam4l flash command group",
695 .chain
= at91sam4l_exec_command_handlers
,
697 COMMAND_REGISTRATION_DONE
700 struct flash_driver at91sam4l_flash
= {
702 .commands
= at91sam4l_command_handlers
,
703 .flash_bank_command
= sam4l_flash_bank_command
,
704 .erase
= sam4l_erase
,
705 .protect
= sam4l_protect
,
706 .write
= sam4l_write
,
707 .read
= default_flash_read
,
708 .probe
= sam4l_probe
,
709 .auto_probe
= sam4l_probe
,
710 .erase_check
= default_flash_blank_check
,
711 .protect_check
= sam4l_protect_check
,