1 /***************************************************************************
2 * Copyright (C) 2009 by Duane Ellis *
3 * openocd@duaneellis.com *
5 * Copyright (C) 2010 by Olaf Lüke (at91sam3s* support) *
6 * olaf@uni-paderborn.de *
8 * Copyright (C) 2011 by Olivier Schonken, Jim Norris *
9 * (at91sam3x* & at91sam4 support)* *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS for A PARTICULAR PURPOSE. See the *
19 * GNU General public License for more details. *
21 * You should have received a copy of the GNU General public License *
22 * along with this program; if not, write to the *
23 * Free Software Foundation, Inc., *
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
25 ****************************************************************************/
27 /* Some of the the lower level code was based on code supplied by
28 * ATMEL under this copyright. */
30 /* BEGIN ATMEL COPYRIGHT */
31 /* ----------------------------------------------------------------------------
32 * ATMEL Microcontroller Software Support
33 * ----------------------------------------------------------------------------
34 * Copyright (c) 2009, Atmel Corporation
36 * All rights reserved.
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions are met:
41 * - Redistributions of source code must retain the above copyright notice,
42 * this list of conditions and the disclaimer below.
44 * Atmel's name may not be used to endorse or promote products derived from
45 * this software without specific prior written permission.
47 * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
48 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
49 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
50 * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,
51 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
52 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
53 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
54 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
55 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
56 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
57 * ----------------------------------------------------------------------------
59 /* END ATMEL COPYRIGHT */
66 #include <helper/time_support.h>
68 #define REG_NAME_WIDTH (12)
70 /* at91sam4s/at91sam4e series (has always one flash bank)*/
71 #define FLASH_BANK_BASE_S 0x00400000
73 /* at91sam4sd series (two one flash banks), first bank address */
74 #define FLASH_BANK0_BASE_SD FLASH_BANK_BASE_S
75 /* at91sam4sd16x, second bank address */
76 #define FLASH_BANK1_BASE_1024K_SD (FLASH_BANK0_BASE_SD+(1024*1024/2))
77 /* at91sam4sd32x, second bank address */
78 #define FLASH_BANK1_BASE_2048K_SD (FLASH_BANK0_BASE_SD+(2048*1024/2))
80 #define AT91C_EFC_FCMD_GETD (0x0) /* (EFC) Get Flash Descriptor */
81 #define AT91C_EFC_FCMD_WP (0x1) /* (EFC) Write Page */
82 #define AT91C_EFC_FCMD_WPL (0x2) /* (EFC) Write Page and Lock */
83 #define AT91C_EFC_FCMD_EWP (0x3) /* (EFC) Erase Page and Write Page */
84 #define AT91C_EFC_FCMD_EWPL (0x4) /* (EFC) Erase Page and Write Page then Lock */
85 #define AT91C_EFC_FCMD_EA (0x5) /* (EFC) Erase All */
86 /* cmd6 is not present in the at91sam4u4/2/1 data sheet table 19-2 */
87 /* #define AT91C_EFC_FCMD_EPL (0x6) // (EFC) Erase plane? */
88 #define AT91C_EFC_FCMD_EPA (0x7) /* (EFC) Erase pages */
89 #define AT91C_EFC_FCMD_SLB (0x8) /* (EFC) Set Lock Bit */
90 #define AT91C_EFC_FCMD_CLB (0x9) /* (EFC) Clear Lock Bit */
91 #define AT91C_EFC_FCMD_GLB (0xA) /* (EFC) Get Lock Bit */
92 #define AT91C_EFC_FCMD_SFB (0xB) /* (EFC) Set Fuse Bit */
93 #define AT91C_EFC_FCMD_CFB (0xC) /* (EFC) Clear Fuse Bit */
94 #define AT91C_EFC_FCMD_GFB (0xD) /* (EFC) Get Fuse Bit */
95 #define AT91C_EFC_FCMD_STUI (0xE) /* (EFC) Start Read Unique ID */
96 #define AT91C_EFC_FCMD_SPUI (0xF) /* (EFC) Stop Read Unique ID */
98 #define offset_EFC_FMR 0
99 #define offset_EFC_FCR 4
100 #define offset_EFC_FSR 8
101 #define offset_EFC_FRR 12
103 extern struct flash_driver at91sam4_flash
;
105 static float _tomhz(uint32_t freq_hz
)
109 f
= ((float)(freq_hz
)) / 1000000.0;
113 /* How the chip is configured. */
115 uint32_t unique_id
[4];
119 uint32_t mainosc_freq
;
129 #define SAM4_CHIPID_CIDR (0x400E0740)
130 uint32_t CHIPID_CIDR
;
131 #define SAM4_CHIPID_EXID (0x400E0744)
132 uint32_t CHIPID_EXID
;
134 #define SAM4_PMC_BASE (0x400E0400)
135 #define SAM4_PMC_SCSR (SAM4_PMC_BASE + 0x0008)
137 #define SAM4_PMC_PCSR (SAM4_PMC_BASE + 0x0018)
139 #define SAM4_CKGR_UCKR (SAM4_PMC_BASE + 0x001c)
141 #define SAM4_CKGR_MOR (SAM4_PMC_BASE + 0x0020)
143 #define SAM4_CKGR_MCFR (SAM4_PMC_BASE + 0x0024)
145 #define SAM4_CKGR_PLLAR (SAM4_PMC_BASE + 0x0028)
147 #define SAM4_PMC_MCKR (SAM4_PMC_BASE + 0x0030)
149 #define SAM4_PMC_PCK0 (SAM4_PMC_BASE + 0x0040)
151 #define SAM4_PMC_PCK1 (SAM4_PMC_BASE + 0x0044)
153 #define SAM4_PMC_PCK2 (SAM4_PMC_BASE + 0x0048)
155 #define SAM4_PMC_SR (SAM4_PMC_BASE + 0x0068)
157 #define SAM4_PMC_IMR (SAM4_PMC_BASE + 0x006c)
159 #define SAM4_PMC_FSMR (SAM4_PMC_BASE + 0x0070)
161 #define SAM4_PMC_FSPR (SAM4_PMC_BASE + 0x0074)
165 struct sam4_bank_private
{
167 /* DANGER: THERE ARE DRAGONS HERE.. */
168 /* NOTE: If you add more 'ghost' pointers */
169 /* be aware that you must *manually* update */
170 /* these pointers in the function sam4_GetDetails() */
171 /* See the comment "Here there be dragons" */
173 /* so we can find the chip we belong to */
174 struct sam4_chip
*pChip
;
175 /* so we can find the original bank pointer */
176 struct flash_bank
*pBank
;
177 unsigned bank_number
;
178 uint32_t controller_address
;
179 uint32_t base_address
;
180 uint32_t flash_wait_states
;
184 unsigned sector_size
;
188 struct sam4_chip_details
{
189 /* THERE ARE DRAGONS HERE.. */
190 /* note: If you add pointers here */
191 /* be careful about them as they */
192 /* may need to be updated inside */
193 /* the function: "sam4_GetDetails() */
194 /* which copy/overwrites the */
195 /* 'runtime' copy of this structure */
196 uint32_t chipid_cidr
;
200 #define SAM4_N_NVM_BITS 3
201 unsigned gpnvm
[SAM4_N_NVM_BITS
];
202 unsigned total_flash_size
;
203 unsigned total_sram_size
;
205 #define SAM4_MAX_FLASH_BANKS 2
206 /* these are "initialized" from the global const data */
207 struct sam4_bank_private bank
[SAM4_MAX_FLASH_BANKS
];
211 struct sam4_chip
*next
;
214 /* this is "initialized" from the global const structure */
215 struct sam4_chip_details details
;
216 struct target
*target
;
221 struct sam4_reg_list
{
222 uint32_t address
; size_t struct_offset
; const char *name
;
223 void (*explain_func
)(struct sam4_chip
*pInfo
);
226 static struct sam4_chip
*all_sam4_chips
;
228 static struct sam4_chip
*get_current_sam4(struct command_context
*cmd_ctx
)
231 static struct sam4_chip
*p
;
233 t
= get_current_target(cmd_ctx
);
235 command_print(cmd_ctx
, "No current target?");
241 /* this should not happen */
242 /* the command is not registered until the chip is created? */
243 command_print(cmd_ctx
, "No SAM4 chips exist?");
252 command_print(cmd_ctx
, "Cannot find SAM4 chip?");
256 /*The actual sector size of the SAM4S flash memory is 65536 bytes. 16 sectors for a 1024KB device*/
257 /*The lockregions are 8KB per lock region, with a 1024KB device having 128 lock regions. */
258 /*For the best results, nsectors are thus set to the amount of lock regions, and the sector_size*/
259 /*set to the lock region size. Page erases are used to erase 8KB sections when programming*/
261 /* these are used to *initialize* the "pChip->details" structure. */
262 static const struct sam4_chip_details all_sam4_details
[] = {
264 /* Start at91sam4e* series */
265 /*atsam4e16e - LQFP144/LFBGA144*/
267 .chipid_cidr
= 0xA3CC0CE0,
268 .name
= "at91sam4e16e",
269 .total_flash_size
= 1024 * 1024,
270 .total_sram_size
= 128 * 1024,
280 .base_address
= FLASH_BANK_BASE_S
,
281 .controller_address
= 0x400e0a00,
282 .flash_wait_states
= 6, /* workaround silicon bug */
284 .size_bytes
= 1024 * 1024,
299 /* Start at91sam4s* series */
300 /*atsam4s16c - LQFP100/BGA100*/
302 .chipid_cidr
= 0x28AC0CE0,
303 .name
= "at91sam4s16c",
304 .total_flash_size
= 1024 * 1024,
305 .total_sram_size
= 128 * 1024,
315 .base_address
= FLASH_BANK_BASE_S
,
316 .controller_address
= 0x400e0a00,
317 .flash_wait_states
= 6, /* workaround silicon bug */
319 .size_bytes
= 1024 * 1024,
333 /*atsam4s16b - LQFP64/QFN64*/
335 .chipid_cidr
= 0x289C0CE0,
336 .name
= "at91sam4s16b",
337 .total_flash_size
= 1024 * 1024,
338 .total_sram_size
= 128 * 1024,
348 .base_address
= FLASH_BANK_BASE_S
,
349 .controller_address
= 0x400e0a00,
350 .flash_wait_states
= 6, /* workaround silicon bug */
352 .size_bytes
= 1024 * 1024,
366 /*atsam4s16a - LQFP48/QFN48*/
368 .chipid_cidr
= 0x288C0CE0,
369 .name
= "at91sam4s16a",
370 .total_flash_size
= 1024 * 1024,
371 .total_sram_size
= 128 * 1024,
381 .base_address
= FLASH_BANK_BASE_S
,
382 .controller_address
= 0x400e0a00,
383 .flash_wait_states
= 6, /* workaround silicon bug */
385 .size_bytes
= 1024 * 1024,
399 /*atsam4s8c - LQFP100/BGA100*/
401 .chipid_cidr
= 0x28AC0AE0,
402 .name
= "at91sam4s8c",
403 .total_flash_size
= 512 * 1024,
404 .total_sram_size
= 128 * 1024,
414 .base_address
= FLASH_BANK_BASE_S
,
415 .controller_address
= 0x400e0a00,
416 .flash_wait_states
= 6, /* workaround silicon bug */
418 .size_bytes
= 512 * 1024,
432 /*atsam4s8b - LQFP64/BGA64*/
434 .chipid_cidr
= 0x289C0AE0,
435 .name
= "at91sam4s8b",
436 .total_flash_size
= 512 * 1024,
437 .total_sram_size
= 128 * 1024,
447 .base_address
= FLASH_BANK_BASE_S
,
448 .controller_address
= 0x400e0a00,
449 .flash_wait_states
= 6, /* workaround silicon bug */
451 .size_bytes
= 512 * 1024,
465 /*atsam4s8a - LQFP48/BGA48*/
467 .chipid_cidr
= 0x288C0AE0,
468 .name
= "at91sam4s8a",
469 .total_flash_size
= 512 * 1024,
470 .total_sram_size
= 128 * 1024,
480 .base_address
= FLASH_BANK_BASE_S
,
481 .controller_address
= 0x400e0a00,
482 .flash_wait_states
= 6, /* workaround silicon bug */
484 .size_bytes
= 512 * 1024,
499 /*atsam4s4a - LQFP48/BGA48*/
501 .chipid_cidr
= 0x288b09e0,
502 .name
= "at91sam4s4a",
503 .total_flash_size
= 256 * 1024,
504 .total_sram_size
= 64 * 1024,
514 .base_address
= FLASH_BANK_BASE_S
,
515 .controller_address
= 0x400e0a00,
516 .flash_wait_states
= 6, /* workaround silicon bug */
518 .size_bytes
= 256 * 1024,
535 .chipid_cidr
= 0x29a70ee0,
536 .name
= "at91sam4sd32c",
537 .total_flash_size
= 2048 * 1024,
538 .total_sram_size
= 160 * 1024,
549 .base_address
= FLASH_BANK0_BASE_SD
,
550 .controller_address
= 0x400e0a00,
551 .flash_wait_states
= 6, /* workaround silicon bug */
553 .size_bytes
= 1024 * 1024,
565 .base_address
= FLASH_BANK1_BASE_2048K_SD
,
566 .controller_address
= 0x400e0c00,
567 .flash_wait_states
= 6, /* workaround silicon bug */
569 .size_bytes
= 1024 * 1024,
579 .chipid_cidr
= 0x29a70ce0,
580 .name
= "at91sam4sd16c",
581 .total_flash_size
= 1024 * 1024,
582 .total_sram_size
= 160 * 1024,
593 .base_address
= FLASH_BANK0_BASE_SD
,
594 .controller_address
= 0x400e0a00,
595 .flash_wait_states
= 6, /* workaround silicon bug */
597 .size_bytes
= 512 * 1024,
609 .base_address
= FLASH_BANK1_BASE_1024K_SD
,
610 .controller_address
= 0x400e0c00,
611 .flash_wait_states
= 6, /* workaround silicon bug */
613 .size_bytes
= 512 * 1024,
623 .chipid_cidr
= 0x247e0ae0,
624 .name
= "at91samg53n19",
625 .total_flash_size
= 512 * 1024,
626 .total_sram_size
= 96 * 1024,
637 .base_address
= FLASH_BANK_BASE_S
,
638 .controller_address
= 0x400e0a00,
639 .flash_wait_states
= 6, /* workaround silicon bug */
641 .size_bytes
= 512 * 1024,
664 /***********************************************************************
665 **********************************************************************
666 **********************************************************************
667 **********************************************************************
668 **********************************************************************
669 **********************************************************************/
670 /* *ATMEL* style code - from the SAM4 driver code */
673 * Get the current status of the EEFC and
674 * the value of some status bits (LOCKE, PROGE).
675 * @param pPrivate - info about the bank
676 * @param v - result goes here
678 static int EFC_GetStatus(struct sam4_bank_private
*pPrivate
, uint32_t *v
)
681 r
= target_read_u32(pPrivate
->pChip
->target
,
682 pPrivate
->controller_address
+ offset_EFC_FSR
,
684 LOG_DEBUG("Status: 0x%08x (lockerror: %d, cmderror: %d, ready: %d)",
686 ((unsigned int)((*v
>> 2) & 1)),
687 ((unsigned int)((*v
>> 1) & 1)),
688 ((unsigned int)((*v
>> 0) & 1)));
694 * Get the result of the last executed command.
695 * @param pPrivate - info about the bank
696 * @param v - result goes here
698 static int EFC_GetResult(struct sam4_bank_private
*pPrivate
, uint32_t *v
)
702 r
= target_read_u32(pPrivate
->pChip
->target
,
703 pPrivate
->controller_address
+ offset_EFC_FRR
,
707 LOG_DEBUG("Result: 0x%08x", ((unsigned int)(rv
)));
711 static int EFC_StartCommand(struct sam4_bank_private
*pPrivate
,
712 unsigned command
, unsigned argument
)
721 /* Check command & argument */
724 case AT91C_EFC_FCMD_WP
:
725 case AT91C_EFC_FCMD_WPL
:
726 case AT91C_EFC_FCMD_EWP
:
727 case AT91C_EFC_FCMD_EWPL
:
728 /* case AT91C_EFC_FCMD_EPL: */
729 case AT91C_EFC_FCMD_EPA
:
730 case AT91C_EFC_FCMD_SLB
:
731 case AT91C_EFC_FCMD_CLB
:
732 n
= (pPrivate
->size_bytes
/ pPrivate
->page_size
);
734 LOG_ERROR("*BUG*: Embedded flash has only %u pages", (unsigned)(n
));
737 case AT91C_EFC_FCMD_SFB
:
738 case AT91C_EFC_FCMD_CFB
:
739 if (argument
>= pPrivate
->pChip
->details
.n_gpnvms
) {
740 LOG_ERROR("*BUG*: Embedded flash has only %d GPNVMs",
741 pPrivate
->pChip
->details
.n_gpnvms
);
745 case AT91C_EFC_FCMD_GETD
:
746 case AT91C_EFC_FCMD_EA
:
747 case AT91C_EFC_FCMD_GLB
:
748 case AT91C_EFC_FCMD_GFB
:
749 case AT91C_EFC_FCMD_STUI
:
750 case AT91C_EFC_FCMD_SPUI
:
752 LOG_ERROR("Argument is meaningless for cmd: %d", command
);
755 LOG_ERROR("Unknown command %d", command
);
759 if (command
== AT91C_EFC_FCMD_SPUI
) {
760 /* this is a very special situation. */
761 /* Situation (1) - error/retry - see below */
762 /* And we are being called recursively */
763 /* Situation (2) - normal, finished reading unique id */
765 /* it should be "ready" */
766 EFC_GetStatus(pPrivate
, &v
);
768 /* then it is ready */
772 /* we have done this before */
773 /* the controller is not responding. */
774 LOG_ERROR("flash controller(%d) is not ready! Error",
775 pPrivate
->bank_number
);
779 LOG_ERROR("Flash controller(%d) is not ready, attempting reset",
780 pPrivate
->bank_number
);
781 /* we do that by issuing the *STOP* command */
782 EFC_StartCommand(pPrivate
, AT91C_EFC_FCMD_SPUI
, 0);
783 /* above is recursive, and further recursion is blocked by */
784 /* if (command == AT91C_EFC_FCMD_SPUI) above */
790 v
= (0x5A << 24) | (argument
<< 8) | command
;
791 LOG_DEBUG("Command: 0x%08x", ((unsigned int)(v
)));
792 r
= target_write_u32(pPrivate
->pBank
->target
,
793 pPrivate
->controller_address
+ offset_EFC_FCR
, v
);
795 LOG_DEBUG("Error Write failed");
800 * Performs the given command and wait until its completion (or an error).
801 * @param pPrivate - info about the bank
802 * @param command - Command to perform.
803 * @param argument - Optional command argument.
804 * @param status - put command status bits here
806 static int EFC_PerformCommand(struct sam4_bank_private
*pPrivate
,
814 long long ms_now
, ms_end
;
820 r
= EFC_StartCommand(pPrivate
, command
, argument
);
824 ms_end
= 10000 + timeval_ms();
827 r
= EFC_GetStatus(pPrivate
, &v
);
830 ms_now
= timeval_ms();
831 if (ms_now
> ms_end
) {
833 LOG_ERROR("Command timeout");
836 } while ((v
& 1) == 0);
846 * Read the unique ID.
847 * @param pPrivate - info about the bank
848 * The unique ID is stored in the 'pPrivate' structure.
850 static int FLASHD_ReadUniqueID(struct sam4_bank_private
*pPrivate
)
856 pPrivate
->pChip
->cfg
.unique_id
[0] = 0;
857 pPrivate
->pChip
->cfg
.unique_id
[1] = 0;
858 pPrivate
->pChip
->cfg
.unique_id
[2] = 0;
859 pPrivate
->pChip
->cfg
.unique_id
[3] = 0;
862 r
= EFC_StartCommand(pPrivate
, AT91C_EFC_FCMD_STUI
, 0);
866 for (x
= 0; x
< 4; x
++) {
867 r
= target_read_u32(pPrivate
->pChip
->target
,
868 pPrivate
->pBank
->base
+ (x
* 4),
872 pPrivate
->pChip
->cfg
.unique_id
[x
] = v
;
875 r
= EFC_PerformCommand(pPrivate
, AT91C_EFC_FCMD_SPUI
, 0, NULL
);
876 LOG_DEBUG("End: R=%d, id = 0x%08x, 0x%08x, 0x%08x, 0x%08x",
878 (unsigned int)(pPrivate
->pChip
->cfg
.unique_id
[0]),
879 (unsigned int)(pPrivate
->pChip
->cfg
.unique_id
[1]),
880 (unsigned int)(pPrivate
->pChip
->cfg
.unique_id
[2]),
881 (unsigned int)(pPrivate
->pChip
->cfg
.unique_id
[3]));
887 * Erases the entire flash.
888 * @param pPrivate - the info about the bank.
890 static int FLASHD_EraseEntireBank(struct sam4_bank_private
*pPrivate
)
893 return EFC_PerformCommand(pPrivate
, AT91C_EFC_FCMD_EA
, 0, NULL
);
897 * Erases the entire flash.
898 * @param pPrivate - the info about the bank.
900 static int FLASHD_ErasePages(struct sam4_bank_private
*pPrivate
,
925 /* AT91C_EFC_FCMD_EPA
926 * According to the datasheet FARG[15:2] defines the page from which
927 * the erase will start.This page must be modulo 4, 8, 16 or 32
928 * according to the number of pages to erase. FARG[1:0] defines the
929 * number of pages to be erased. Previously (firstpage << 2) was used
930 * to conform to this, seems it should not be shifted...
932 return EFC_PerformCommand(pPrivate
,
933 /* send Erase Page */
935 (firstPage
) | erasePages
,
940 * Gets current GPNVM state.
941 * @param pPrivate - info about the bank.
942 * @param gpnvm - GPNVM bit index.
943 * @param puthere - result stored here.
945 /* ------------------------------------------------------------------------------ */
946 static int FLASHD_GetGPNVM(struct sam4_bank_private
*pPrivate
, unsigned gpnvm
, unsigned *puthere
)
952 if (pPrivate
->bank_number
!= 0) {
953 LOG_ERROR("GPNVM only works with Bank0");
957 if (gpnvm
>= pPrivate
->pChip
->details
.n_gpnvms
) {
958 LOG_ERROR("Invalid GPNVM %d, max: %d, ignored",
959 gpnvm
, pPrivate
->pChip
->details
.n_gpnvms
);
963 /* Get GPNVMs status */
964 r
= EFC_PerformCommand(pPrivate
, AT91C_EFC_FCMD_GFB
, 0, NULL
);
970 r
= EFC_GetResult(pPrivate
, &v
);
973 /* Check if GPNVM is set */
974 /* get the bit and make it a 0/1 */
975 *puthere
= (v
>> gpnvm
) & 1;
982 * Clears the selected GPNVM bit.
983 * @param pPrivate info about the bank
984 * @param gpnvm GPNVM index.
985 * @returns 0 if successful; otherwise returns an error code.
987 static int FLASHD_ClrGPNVM(struct sam4_bank_private
*pPrivate
, unsigned gpnvm
)
993 if (pPrivate
->bank_number
!= 0) {
994 LOG_ERROR("GPNVM only works with Bank0");
998 if (gpnvm
>= pPrivate
->pChip
->details
.n_gpnvms
) {
999 LOG_ERROR("Invalid GPNVM %d, max: %d, ignored",
1000 gpnvm
, pPrivate
->pChip
->details
.n_gpnvms
);
1004 r
= FLASHD_GetGPNVM(pPrivate
, gpnvm
, &v
);
1005 if (r
!= ERROR_OK
) {
1006 LOG_DEBUG("Failed: %d", r
);
1009 r
= EFC_PerformCommand(pPrivate
, AT91C_EFC_FCMD_CFB
, gpnvm
, NULL
);
1010 LOG_DEBUG("End: %d", r
);
1015 * Sets the selected GPNVM bit.
1016 * @param pPrivate info about the bank
1017 * @param gpnvm GPNVM index.
1019 static int FLASHD_SetGPNVM(struct sam4_bank_private
*pPrivate
, unsigned gpnvm
)
1024 if (pPrivate
->bank_number
!= 0) {
1025 LOG_ERROR("GPNVM only works with Bank0");
1029 if (gpnvm
>= pPrivate
->pChip
->details
.n_gpnvms
) {
1030 LOG_ERROR("Invalid GPNVM %d, max: %d, ignored",
1031 gpnvm
, pPrivate
->pChip
->details
.n_gpnvms
);
1035 r
= FLASHD_GetGPNVM(pPrivate
, gpnvm
, &v
);
1043 r
= EFC_PerformCommand(pPrivate
, AT91C_EFC_FCMD_SFB
, gpnvm
, NULL
);
1049 * Returns a bit field (at most 64) of locked regions within a page.
1050 * @param pPrivate info about the bank
1051 * @param v where to store locked bits
1053 static int FLASHD_GetLockBits(struct sam4_bank_private
*pPrivate
, uint32_t *v
)
1057 r
= EFC_PerformCommand(pPrivate
, AT91C_EFC_FCMD_GLB
, 0, NULL
);
1058 if (r
== ERROR_OK
) {
1059 EFC_GetResult(pPrivate
, v
);
1060 EFC_GetResult(pPrivate
, v
);
1061 EFC_GetResult(pPrivate
, v
);
1062 r
= EFC_GetResult(pPrivate
, v
);
1064 LOG_DEBUG("End: %d", r
);
1069 * Unlocks all the regions in the given address range.
1070 * @param pPrivate info about the bank
1071 * @param start_sector first sector to unlock
1072 * @param end_sector last (inclusive) to unlock
1075 static int FLASHD_Unlock(struct sam4_bank_private
*pPrivate
,
1076 unsigned start_sector
,
1077 unsigned end_sector
)
1082 uint32_t pages_per_sector
;
1084 pages_per_sector
= pPrivate
->sector_size
/ pPrivate
->page_size
;
1086 /* Unlock all pages */
1087 while (start_sector
<= end_sector
) {
1088 pg
= start_sector
* pages_per_sector
;
1090 r
= EFC_PerformCommand(pPrivate
, AT91C_EFC_FCMD_CLB
, pg
, &status
);
1101 * @param pPrivate - info about the bank
1102 * @param start_sector - first sector to lock
1103 * @param end_sector - last sector (inclusive) to lock
1105 static int FLASHD_Lock(struct sam4_bank_private
*pPrivate
,
1106 unsigned start_sector
,
1107 unsigned end_sector
)
1111 uint32_t pages_per_sector
;
1114 pages_per_sector
= pPrivate
->sector_size
/ pPrivate
->page_size
;
1116 /* Lock all pages */
1117 while (start_sector
<= end_sector
) {
1118 pg
= start_sector
* pages_per_sector
;
1120 r
= EFC_PerformCommand(pPrivate
, AT91C_EFC_FCMD_SLB
, pg
, &status
);
1128 /****** END SAM4 CODE ********/
1130 /* begin helpful debug code */
1131 /* print the fieldname, the field value, in dec & hex, and return field value */
1132 static uint32_t sam4_reg_fieldname(struct sam4_chip
*pChip
,
1133 const char *regname
,
1142 /* extract the field */
1144 v
= v
& ((1 << width
)-1);
1153 /* show the basics */
1154 LOG_USER_N("\t%*s: %*" PRId32
" [0x%0*" PRIx32
"] ",
1155 REG_NAME_WIDTH
, regname
,
1161 static const char _unknown
[] = "unknown";
1162 static const char *const eproc_names
[] = {
1166 "cortex-m3", /* 3 */
1168 "arm926ejs", /* 5 */
1169 "cortex-a5", /* 6 */
1170 "cortex-m4", /* 7 */
1181 #define nvpsize2 nvpsize /* these two tables are identical */
1182 static const char *const nvpsize
[] = {
1185 "16K bytes", /* 2 */
1186 "32K bytes", /* 3 */
1188 "64K bytes", /* 5 */
1190 "128K bytes", /* 7 */
1192 "256K bytes", /* 9 */
1193 "512K bytes", /* 10 */
1195 "1024K bytes", /* 12 */
1197 "2048K bytes", /* 14 */
1201 static const char *const sramsize
[] = {
1202 "48K Bytes", /* 0 */
1206 "112K Bytes", /* 4 */
1208 "80K Bytes", /* 6 */
1209 "160K Bytes", /* 7 */
1211 "16K Bytes", /* 9 */
1212 "32K Bytes", /* 10 */
1213 "64K Bytes", /* 11 */
1214 "128K Bytes", /* 12 */
1215 "256K Bytes", /* 13 */
1216 "96K Bytes", /* 14 */
1217 "512K Bytes", /* 15 */
1221 static const struct archnames
{ unsigned value
; const char *name
; } archnames
[] = {
1222 { 0x19, "AT91SAM9xx Series" },
1223 { 0x29, "AT91SAM9XExx Series" },
1224 { 0x34, "AT91x34 Series" },
1225 { 0x37, "CAP7 Series" },
1226 { 0x39, "CAP9 Series" },
1227 { 0x3B, "CAP11 Series" },
1228 { 0x3C, "ATSAM4E" },
1229 { 0x40, "AT91x40 Series" },
1230 { 0x42, "AT91x42 Series" },
1231 { 0x43, "SAMG51 Series"
1233 { 0x47, "SAMG53 Series"
1235 { 0x55, "AT91x55 Series" },
1236 { 0x60, "AT91SAM7Axx Series" },
1237 { 0x61, "AT91SAM7AQxx Series" },
1238 { 0x63, "AT91x63 Series" },
1239 { 0x70, "AT91SAM7Sxx Series" },
1240 { 0x71, "AT91SAM7XCxx Series" },
1241 { 0x72, "AT91SAM7SExx Series" },
1242 { 0x73, "AT91SAM7Lxx Series" },
1243 { 0x75, "AT91SAM7Xxx Series" },
1244 { 0x76, "AT91SAM7SLxx Series" },
1245 { 0x80, "ATSAM3UxC Series (100-pin version)" },
1246 { 0x81, "ATSAM3UxE Series (144-pin version)" },
1247 { 0x83, "ATSAM3A/SAM4A xC Series (100-pin version)"},
1248 { 0x84, "ATSAM3X/SAM4X xC Series (100-pin version)"},
1249 { 0x85, "ATSAM3X/SAM4X xE Series (144-pin version)"},
1250 { 0x86, "ATSAM3X/SAM4X xG Series (208/217-pin version)" },
1251 { 0x88, "ATSAM3S/SAM4S xA Series (48-pin version)" },
1252 { 0x89, "ATSAM3S/SAM4S xB Series (64-pin version)" },
1253 { 0x8A, "ATSAM3S/SAM4S xC Series (100-pin version)"},
1254 { 0x92, "AT91x92 Series" },
1255 { 0x93, "ATSAM3NxA Series (48-pin version)" },
1256 { 0x94, "ATSAM3NxB Series (64-pin version)" },
1257 { 0x95, "ATSAM3NxC Series (100-pin version)" },
1258 { 0x98, "ATSAM3SDxA Series (48-pin version)" },
1259 { 0x99, "ATSAM3SDxB Series (64-pin version)" },
1260 { 0x9A, "ATSAM3SDxC Series (100-pin version)" },
1261 { 0xA5, "ATSAM5A" },
1262 { 0xF0, "AT75Cxx Series" },
1266 static const char *const nvptype
[] = {
1268 "romless or onchip flash", /* 1 */
1269 "embedded flash memory",/* 2 */
1270 "rom(nvpsiz) + embedded flash (nvpsiz2)", /* 3 */
1271 "sram emulating flash", /* 4 */
1277 static const char *_yes_or_no(uint32_t v
)
1285 static const char *const _rc_freq
[] = {
1286 "4 MHz", "8 MHz", "12 MHz", "reserved"
1289 static void sam4_explain_ckgr_mor(struct sam4_chip
*pChip
)
1294 v
= sam4_reg_fieldname(pChip
, "MOSCXTEN", pChip
->cfg
.CKGR_MOR
, 0, 1);
1295 LOG_USER("(main xtal enabled: %s)", _yes_or_no(v
));
1296 v
= sam4_reg_fieldname(pChip
, "MOSCXTBY", pChip
->cfg
.CKGR_MOR
, 1, 1);
1297 LOG_USER("(main osc bypass: %s)", _yes_or_no(v
));
1298 rcen
= sam4_reg_fieldname(pChip
, "MOSCRCEN", pChip
->cfg
.CKGR_MOR
, 3, 1);
1299 LOG_USER("(onchip RC-OSC enabled: %s)", _yes_or_no(rcen
));
1300 v
= sam4_reg_fieldname(pChip
, "MOSCRCF", pChip
->cfg
.CKGR_MOR
, 4, 3);
1301 LOG_USER("(onchip RC-OSC freq: %s)", _rc_freq
[v
]);
1303 pChip
->cfg
.rc_freq
= 0;
1307 pChip
->cfg
.rc_freq
= 0;
1310 pChip
->cfg
.rc_freq
= 4 * 1000 * 1000;
1313 pChip
->cfg
.rc_freq
= 8 * 1000 * 1000;
1316 pChip
->cfg
.rc_freq
= 12 * 1000 * 1000;
1321 v
= sam4_reg_fieldname(pChip
, "MOSCXTST", pChip
->cfg
.CKGR_MOR
, 8, 8);
1322 LOG_USER("(startup clks, time= %f uSecs)",
1323 ((float)(v
* 1000000)) / ((float)(pChip
->cfg
.slow_freq
)));
1324 v
= sam4_reg_fieldname(pChip
, "MOSCSEL", pChip
->cfg
.CKGR_MOR
, 24, 1);
1325 LOG_USER("(mainosc source: %s)",
1326 v
? "external xtal" : "internal RC");
1328 v
= sam4_reg_fieldname(pChip
, "CFDEN", pChip
->cfg
.CKGR_MOR
, 25, 1);
1329 LOG_USER("(clock failure enabled: %s)",
1333 static void sam4_explain_chipid_cidr(struct sam4_chip
*pChip
)
1339 sam4_reg_fieldname(pChip
, "Version", pChip
->cfg
.CHIPID_CIDR
, 0, 5);
1342 v
= sam4_reg_fieldname(pChip
, "EPROC", pChip
->cfg
.CHIPID_CIDR
, 5, 3);
1343 LOG_USER("%s", eproc_names
[v
]);
1345 v
= sam4_reg_fieldname(pChip
, "NVPSIZE", pChip
->cfg
.CHIPID_CIDR
, 8, 4);
1346 LOG_USER("%s", nvpsize
[v
]);
1348 v
= sam4_reg_fieldname(pChip
, "NVPSIZE2", pChip
->cfg
.CHIPID_CIDR
, 12, 4);
1349 LOG_USER("%s", nvpsize2
[v
]);
1351 v
= sam4_reg_fieldname(pChip
, "SRAMSIZE", pChip
->cfg
.CHIPID_CIDR
, 16, 4);
1352 LOG_USER("%s", sramsize
[v
]);
1354 v
= sam4_reg_fieldname(pChip
, "ARCH", pChip
->cfg
.CHIPID_CIDR
, 20, 8);
1356 for (x
= 0; archnames
[x
].name
; x
++) {
1357 if (v
== archnames
[x
].value
) {
1358 cp
= archnames
[x
].name
;
1365 v
= sam4_reg_fieldname(pChip
, "NVPTYP", pChip
->cfg
.CHIPID_CIDR
, 28, 3);
1366 LOG_USER("%s", nvptype
[v
]);
1368 v
= sam4_reg_fieldname(pChip
, "EXTID", pChip
->cfg
.CHIPID_CIDR
, 31, 1);
1369 LOG_USER("(exists: %s)", _yes_or_no(v
));
1372 static void sam4_explain_ckgr_mcfr(struct sam4_chip
*pChip
)
1376 v
= sam4_reg_fieldname(pChip
, "MAINFRDY", pChip
->cfg
.CKGR_MCFR
, 16, 1);
1377 LOG_USER("(main ready: %s)", _yes_or_no(v
));
1379 v
= sam4_reg_fieldname(pChip
, "MAINF", pChip
->cfg
.CKGR_MCFR
, 0, 16);
1381 v
= (v
* pChip
->cfg
.slow_freq
) / 16;
1382 pChip
->cfg
.mainosc_freq
= v
;
1384 LOG_USER("(%3.03f Mhz (%" PRIu32
".%03" PRIu32
"khz slowclk)",
1386 (uint32_t)(pChip
->cfg
.slow_freq
/ 1000),
1387 (uint32_t)(pChip
->cfg
.slow_freq
% 1000));
1390 static void sam4_explain_ckgr_plla(struct sam4_chip
*pChip
)
1392 uint32_t mula
, diva
;
1394 diva
= sam4_reg_fieldname(pChip
, "DIVA", pChip
->cfg
.CKGR_PLLAR
, 0, 8);
1396 mula
= sam4_reg_fieldname(pChip
, "MULA", pChip
->cfg
.CKGR_PLLAR
, 16, 11);
1398 pChip
->cfg
.plla_freq
= 0;
1400 LOG_USER("\tPLLA Freq: (Disabled,mula = 0)");
1402 LOG_USER("\tPLLA Freq: (Disabled,diva = 0)");
1403 else if (diva
>= 1) {
1404 pChip
->cfg
.plla_freq
= (pChip
->cfg
.mainosc_freq
* (mula
+ 1) / diva
);
1405 LOG_USER("\tPLLA Freq: %3.03f MHz",
1406 _tomhz(pChip
->cfg
.plla_freq
));
1410 static void sam4_explain_mckr(struct sam4_chip
*pChip
)
1412 uint32_t css
, pres
, fin
= 0;
1414 const char *cp
= NULL
;
1416 css
= sam4_reg_fieldname(pChip
, "CSS", pChip
->cfg
.PMC_MCKR
, 0, 2);
1419 fin
= pChip
->cfg
.slow_freq
;
1423 fin
= pChip
->cfg
.mainosc_freq
;
1427 fin
= pChip
->cfg
.plla_freq
;
1431 if (pChip
->cfg
.CKGR_UCKR
& (1 << 16)) {
1432 fin
= 480 * 1000 * 1000;
1436 cp
= "upll (*ERROR* UPLL is disabled)";
1444 LOG_USER("%s (%3.03f Mhz)",
1447 pres
= sam4_reg_fieldname(pChip
, "PRES", pChip
->cfg
.PMC_MCKR
, 4, 3);
1448 switch (pres
& 0x07) {
1451 cp
= "selected clock";
1485 LOG_USER("(%s)", cp
);
1487 /* sam4 has a *SINGLE* clock - */
1488 /* other at91 series parts have divisors for these. */
1489 pChip
->cfg
.cpu_freq
= fin
;
1490 pChip
->cfg
.mclk_freq
= fin
;
1491 pChip
->cfg
.fclk_freq
= fin
;
1492 LOG_USER("\t\tResult CPU Freq: %3.03f",
1497 static struct sam4_chip
*target2sam4(struct target
*pTarget
)
1499 struct sam4_chip
*pChip
;
1501 if (pTarget
== NULL
)
1504 pChip
= all_sam4_chips
;
1506 if (pChip
->target
== pTarget
)
1507 break; /* return below */
1509 pChip
= pChip
->next
;
1515 static uint32_t *sam4_get_reg_ptr(struct sam4_cfg
*pCfg
, const struct sam4_reg_list
*pList
)
1517 /* this function exists to help */
1518 /* keep funky offsetof() errors */
1519 /* and casting from causing bugs */
1521 /* By using prototypes - we can detect what would */
1522 /* be casting errors. */
1524 return (uint32_t *)(void *)(((char *)(pCfg
)) + pList
->struct_offset
);
1528 #define SAM4_ENTRY(NAME, FUNC) { .address = SAM4_ ## NAME, .struct_offset = offsetof( \
1530 NAME), # NAME, FUNC }
1531 static const struct sam4_reg_list sam4_all_regs
[] = {
1532 SAM4_ENTRY(CKGR_MOR
, sam4_explain_ckgr_mor
),
1533 SAM4_ENTRY(CKGR_MCFR
, sam4_explain_ckgr_mcfr
),
1534 SAM4_ENTRY(CKGR_PLLAR
, sam4_explain_ckgr_plla
),
1535 SAM4_ENTRY(CKGR_UCKR
, NULL
),
1536 SAM4_ENTRY(PMC_FSMR
, NULL
),
1537 SAM4_ENTRY(PMC_FSPR
, NULL
),
1538 SAM4_ENTRY(PMC_IMR
, NULL
),
1539 SAM4_ENTRY(PMC_MCKR
, sam4_explain_mckr
),
1540 SAM4_ENTRY(PMC_PCK0
, NULL
),
1541 SAM4_ENTRY(PMC_PCK1
, NULL
),
1542 SAM4_ENTRY(PMC_PCK2
, NULL
),
1543 SAM4_ENTRY(PMC_PCSR
, NULL
),
1544 SAM4_ENTRY(PMC_SCSR
, NULL
),
1545 SAM4_ENTRY(PMC_SR
, NULL
),
1546 SAM4_ENTRY(CHIPID_CIDR
, sam4_explain_chipid_cidr
),
1547 SAM4_ENTRY(CHIPID_EXID
, NULL
),
1548 /* TERMINATE THE LIST */
1553 static struct sam4_bank_private
*get_sam4_bank_private(struct flash_bank
*bank
)
1555 return bank
->driver_priv
;
1559 * Given a pointer to where it goes in the structure,
1560 * determine the register name, address from the all registers table.
1562 static const struct sam4_reg_list
*sam4_GetReg(struct sam4_chip
*pChip
, uint32_t *goes_here
)
1564 const struct sam4_reg_list
*pReg
;
1566 pReg
= &(sam4_all_regs
[0]);
1567 while (pReg
->name
) {
1568 uint32_t *pPossible
;
1570 /* calculate where this one go.. */
1571 /* it is "possibly" this register. */
1573 pPossible
= ((uint32_t *)(void *)(((char *)(&(pChip
->cfg
))) + pReg
->struct_offset
));
1575 /* well? Is it this register */
1576 if (pPossible
== goes_here
) {
1584 /* This is *TOTAL*PANIC* - we are totally screwed. */
1585 LOG_ERROR("INVALID SAM4 REGISTER");
1589 static int sam4_ReadThisReg(struct sam4_chip
*pChip
, uint32_t *goes_here
)
1591 const struct sam4_reg_list
*pReg
;
1594 pReg
= sam4_GetReg(pChip
, goes_here
);
1598 r
= target_read_u32(pChip
->target
, pReg
->address
, goes_here
);
1599 if (r
!= ERROR_OK
) {
1600 LOG_ERROR("Cannot read SAM4 register: %s @ 0x%08x, Err: %d",
1601 pReg
->name
, (unsigned)(pReg
->address
), r
);
1606 static int sam4_ReadAllRegs(struct sam4_chip
*pChip
)
1609 const struct sam4_reg_list
*pReg
;
1611 pReg
= &(sam4_all_regs
[0]);
1612 while (pReg
->name
) {
1613 r
= sam4_ReadThisReg(pChip
,
1614 sam4_get_reg_ptr(&(pChip
->cfg
), pReg
));
1615 if (r
!= ERROR_OK
) {
1616 LOG_ERROR("Cannot read SAM4 register: %s @ 0x%08x, Error: %d",
1617 pReg
->name
, ((unsigned)(pReg
->address
)), r
);
1626 static int sam4_GetInfo(struct sam4_chip
*pChip
)
1628 const struct sam4_reg_list
*pReg
;
1631 pReg
= &(sam4_all_regs
[0]);
1632 while (pReg
->name
) {
1633 /* display all regs */
1634 LOG_DEBUG("Start: %s", pReg
->name
);
1635 regval
= *sam4_get_reg_ptr(&(pChip
->cfg
), pReg
);
1636 LOG_USER("%*s: [0x%08" PRIx32
"] -> 0x%08" PRIx32
,
1641 if (pReg
->explain_func
)
1642 (*(pReg
->explain_func
))(pChip
);
1643 LOG_DEBUG("End: %s", pReg
->name
);
1646 LOG_USER(" rc-osc: %3.03f MHz", _tomhz(pChip
->cfg
.rc_freq
));
1647 LOG_USER(" mainosc: %3.03f MHz", _tomhz(pChip
->cfg
.mainosc_freq
));
1648 LOG_USER(" plla: %3.03f MHz", _tomhz(pChip
->cfg
.plla_freq
));
1649 LOG_USER(" cpu-freq: %3.03f MHz", _tomhz(pChip
->cfg
.cpu_freq
));
1650 LOG_USER("mclk-freq: %3.03f MHz", _tomhz(pChip
->cfg
.mclk_freq
));
1652 LOG_USER(" UniqueId: 0x%08" PRIx32
" 0x%08" PRIx32
" 0x%08" PRIx32
" 0x%08"PRIx32
,
1653 pChip
->cfg
.unique_id
[0],
1654 pChip
->cfg
.unique_id
[1],
1655 pChip
->cfg
.unique_id
[2],
1656 pChip
->cfg
.unique_id
[3]);
1661 static int sam4_protect_check(struct flash_bank
*bank
)
1664 uint32_t v
[4] = {0};
1666 struct sam4_bank_private
*pPrivate
;
1669 if (bank
->target
->state
!= TARGET_HALTED
) {
1670 LOG_ERROR("Target not halted");
1671 return ERROR_TARGET_NOT_HALTED
;
1674 pPrivate
= get_sam4_bank_private(bank
);
1676 LOG_ERROR("no private for this bank?");
1679 if (!(pPrivate
->probed
))
1680 return ERROR_FLASH_BANK_NOT_PROBED
;
1682 r
= FLASHD_GetLockBits(pPrivate
, v
);
1683 if (r
!= ERROR_OK
) {
1684 LOG_DEBUG("Failed: %d", r
);
1688 for (x
= 0; x
< pPrivate
->nsectors
; x
++)
1689 bank
->sectors
[x
].is_protected
= (!!(v
[x
>> 5] & (1 << (x
% 32))));
1694 FLASH_BANK_COMMAND_HANDLER(sam4_flash_bank_command
)
1696 struct sam4_chip
*pChip
;
1698 pChip
= all_sam4_chips
;
1700 /* is this an existing chip? */
1702 if (pChip
->target
== bank
->target
)
1704 pChip
= pChip
->next
;
1708 /* this is a *NEW* chip */
1709 pChip
= calloc(1, sizeof(struct sam4_chip
));
1711 LOG_ERROR("NO RAM!");
1714 pChip
->target
= bank
->target
;
1715 /* insert at head */
1716 pChip
->next
= all_sam4_chips
;
1717 all_sam4_chips
= pChip
;
1718 pChip
->target
= bank
->target
;
1719 /* assumption is this runs at 32khz */
1720 pChip
->cfg
.slow_freq
= 32768;
1724 switch (bank
->base
) {
1726 LOG_ERROR("Address 0x%08x invalid bank address (try 0x%08x"
1727 "[at91sam4s series] )",
1728 ((unsigned int)(bank
->base
)),
1729 ((unsigned int)(FLASH_BANK_BASE_S
)));
1733 /* at91sam4s series only has bank 0*/
1734 /* at91sam4sd series has the same address for bank 0 (FLASH_BANK0_BASE_SD)*/
1735 case FLASH_BANK_BASE_S
:
1736 bank
->driver_priv
= &(pChip
->details
.bank
[0]);
1737 bank
->bank_number
= 0;
1738 pChip
->details
.bank
[0].pChip
= pChip
;
1739 pChip
->details
.bank
[0].pBank
= bank
;
1742 /* Bank 1 of at91sam4sd series */
1743 case FLASH_BANK1_BASE_1024K_SD
:
1744 case FLASH_BANK1_BASE_2048K_SD
:
1745 bank
->driver_priv
= &(pChip
->details
.bank
[1]);
1746 bank
->bank_number
= 1;
1747 pChip
->details
.bank
[1].pChip
= pChip
;
1748 pChip
->details
.bank
[1].pBank
= bank
;
1752 /* we initialize after probing. */
1756 static int sam4_GetDetails(struct sam4_bank_private
*pPrivate
)
1758 const struct sam4_chip_details
*pDetails
;
1759 struct sam4_chip
*pChip
;
1760 struct flash_bank
*saved_banks
[SAM4_MAX_FLASH_BANKS
];
1764 pDetails
= all_sam4_details
;
1765 while (pDetails
->name
) {
1766 /* Compare cidr without version bits */
1767 if (pDetails
->chipid_cidr
== (pPrivate
->pChip
->cfg
.CHIPID_CIDR
& 0xFFFFFFE0))
1772 if (pDetails
->name
== NULL
) {
1773 LOG_ERROR("SAM4 ChipID 0x%08x not found in table (perhaps you can ID this chip?)",
1774 (unsigned int)(pPrivate
->pChip
->cfg
.CHIPID_CIDR
));
1775 /* Help the victim, print details about the chip */
1776 LOG_INFO("SAM4 CHIPID_CIDR: 0x%08" PRIx32
" decodes as follows",
1777 pPrivate
->pChip
->cfg
.CHIPID_CIDR
);
1778 sam4_explain_chipid_cidr(pPrivate
->pChip
);
1782 /* DANGER: THERE ARE DRAGONS HERE */
1784 /* get our pChip - it is going */
1785 /* to be over-written shortly */
1786 pChip
= pPrivate
->pChip
;
1788 /* Note that, in reality: */
1790 /* pPrivate = &(pChip->details.bank[0]) */
1791 /* or pPrivate = &(pChip->details.bank[1]) */
1794 /* save the "bank" pointers */
1795 for (x
= 0; x
< SAM4_MAX_FLASH_BANKS
; x
++)
1796 saved_banks
[x
] = pChip
->details
.bank
[x
].pBank
;
1798 /* Overwrite the "details" structure. */
1799 memcpy(&(pPrivate
->pChip
->details
),
1801 sizeof(pPrivate
->pChip
->details
));
1803 /* now fix the ghosted pointers */
1804 for (x
= 0; x
< SAM4_MAX_FLASH_BANKS
; x
++) {
1805 pChip
->details
.bank
[x
].pChip
= pChip
;
1806 pChip
->details
.bank
[x
].pBank
= saved_banks
[x
];
1809 /* update the *BANK*SIZE* */
1815 static int _sam4_probe(struct flash_bank
*bank
, int noise
)
1819 struct sam4_bank_private
*pPrivate
;
1822 LOG_DEBUG("Begin: Bank: %d, Noise: %d", bank
->bank_number
, noise
);
1823 if (bank
->target
->state
!= TARGET_HALTED
) {
1824 LOG_ERROR("Target not halted");
1825 return ERROR_TARGET_NOT_HALTED
;
1828 pPrivate
= get_sam4_bank_private(bank
);
1830 LOG_ERROR("Invalid/unknown bank number");
1834 r
= sam4_ReadAllRegs(pPrivate
->pChip
);
1839 if (pPrivate
->pChip
->probed
)
1840 r
= sam4_GetInfo(pPrivate
->pChip
);
1842 r
= sam4_GetDetails(pPrivate
);
1846 /* update the flash bank size */
1847 for (x
= 0; x
< SAM4_MAX_FLASH_BANKS
; x
++) {
1848 if (bank
->base
== pPrivate
->pChip
->details
.bank
[x
].base_address
) {
1849 bank
->size
= pPrivate
->pChip
->details
.bank
[x
].size_bytes
;
1854 if (bank
->sectors
== NULL
) {
1855 bank
->sectors
= calloc(pPrivate
->nsectors
, (sizeof((bank
->sectors
)[0])));
1856 if (bank
->sectors
== NULL
) {
1857 LOG_ERROR("No memory!");
1860 bank
->num_sectors
= pPrivate
->nsectors
;
1862 for (x
= 0; ((int)(x
)) < bank
->num_sectors
; x
++) {
1863 bank
->sectors
[x
].size
= pPrivate
->sector_size
;
1864 bank
->sectors
[x
].offset
= x
* (pPrivate
->sector_size
);
1865 /* mark as unknown */
1866 bank
->sectors
[x
].is_erased
= -1;
1867 bank
->sectors
[x
].is_protected
= -1;
1871 pPrivate
->probed
= 1;
1873 r
= sam4_protect_check(bank
);
1877 LOG_DEBUG("Bank = %d, nbanks = %d",
1878 pPrivate
->bank_number
, pPrivate
->pChip
->details
.n_banks
);
1879 if ((pPrivate
->bank_number
+ 1) == pPrivate
->pChip
->details
.n_banks
) {
1880 /* read unique id, */
1881 /* it appears to be associated with the *last* flash bank. */
1882 FLASHD_ReadUniqueID(pPrivate
);
1888 static int sam4_probe(struct flash_bank
*bank
)
1890 return _sam4_probe(bank
, 1);
1893 static int sam4_auto_probe(struct flash_bank
*bank
)
1895 return _sam4_probe(bank
, 0);
1898 static int sam4_erase(struct flash_bank
*bank
, int first
, int last
)
1900 struct sam4_bank_private
*pPrivate
;
1904 /*16 pages equals 8KB - Same size as a lock region*/
1909 if (bank
->target
->state
!= TARGET_HALTED
) {
1910 LOG_ERROR("Target not halted");
1911 return ERROR_TARGET_NOT_HALTED
;
1914 r
= sam4_auto_probe(bank
);
1915 if (r
!= ERROR_OK
) {
1916 LOG_DEBUG("Here,r=%d", r
);
1920 pPrivate
= get_sam4_bank_private(bank
);
1921 if (!(pPrivate
->probed
))
1922 return ERROR_FLASH_BANK_NOT_PROBED
;
1924 if ((first
== 0) && ((last
+ 1) == ((int)(pPrivate
->nsectors
)))) {
1927 return FLASHD_EraseEntireBank(pPrivate
);
1929 LOG_INFO("sam4 does not auto-erase while programming (Erasing relevant sectors)");
1930 LOG_INFO("sam4 First: 0x%08x Last: 0x%08x", (unsigned int)(first
), (unsigned int)(last
));
1931 for (i
= first
; i
<= last
; i
++) {
1932 /*16 pages equals 8KB - Same size as a lock region*/
1933 r
= FLASHD_ErasePages(pPrivate
, (i
* pageCount
), pageCount
, &status
);
1934 LOG_INFO("Erasing sector: 0x%08x", (unsigned int)(i
));
1936 LOG_ERROR("SAM4: Error performing Erase page @ lock region number %d",
1938 if (status
& (1 << 2)) {
1939 LOG_ERROR("SAM4: Lock Region %d is locked", (unsigned int)(i
));
1942 if (status
& (1 << 1)) {
1943 LOG_ERROR("SAM4: Flash Command error @lock region %d", (unsigned int)(i
));
1951 static int sam4_protect(struct flash_bank
*bank
, int set
, int first
, int last
)
1953 struct sam4_bank_private
*pPrivate
;
1957 if (bank
->target
->state
!= TARGET_HALTED
) {
1958 LOG_ERROR("Target not halted");
1959 return ERROR_TARGET_NOT_HALTED
;
1962 pPrivate
= get_sam4_bank_private(bank
);
1963 if (!(pPrivate
->probed
))
1964 return ERROR_FLASH_BANK_NOT_PROBED
;
1967 r
= FLASHD_Lock(pPrivate
, (unsigned)(first
), (unsigned)(last
));
1969 r
= FLASHD_Unlock(pPrivate
, (unsigned)(first
), (unsigned)(last
));
1970 LOG_DEBUG("End: r=%d", r
);
1976 static int sam4_page_read(struct sam4_bank_private
*pPrivate
, unsigned pagenum
, uint8_t *buf
)
1981 adr
= pagenum
* pPrivate
->page_size
;
1982 adr
= adr
+ pPrivate
->base_address
;
1984 r
= target_read_memory(pPrivate
->pChip
->target
,
1986 4, /* THIS*MUST*BE* in 32bit values */
1987 pPrivate
->page_size
/ 4,
1990 LOG_ERROR("SAM4: Flash program failed to read page phys address: 0x%08x",
1991 (unsigned int)(adr
));
1995 static int sam4_page_write(struct sam4_bank_private
*pPrivate
, unsigned pagenum
, const uint8_t *buf
)
1999 uint32_t fmr
; /* EEFC Flash Mode Register */
2002 adr
= pagenum
* pPrivate
->page_size
;
2003 adr
= (adr
+ pPrivate
->base_address
);
2005 /* Get flash mode register value */
2006 r
= target_read_u32(pPrivate
->pChip
->target
, pPrivate
->controller_address
, &fmr
);
2008 LOG_DEBUG("Error Read failed: read flash mode register");
2010 /* Clear flash wait state field */
2013 /* set FWS (flash wait states) field in the FMR (flash mode register) */
2014 fmr
|= (pPrivate
->flash_wait_states
<< 8);
2016 LOG_DEBUG("Flash Mode: 0x%08x", ((unsigned int)(fmr
)));
2017 r
= target_write_u32(pPrivate
->pBank
->target
, pPrivate
->controller_address
, fmr
);
2019 LOG_DEBUG("Error Write failed: set flash mode register");
2021 /* 1st sector 8kBytes - page 0 - 15*/
2022 /* 2nd sector 8kBytes - page 16 - 30*/
2023 /* 3rd sector 48kBytes - page 31 - 127*/
2024 LOG_DEBUG("Wr Page %u @ phys address: 0x%08x", pagenum
, (unsigned int)(adr
));
2025 r
= target_write_memory(pPrivate
->pChip
->target
,
2027 4, /* THIS*MUST*BE* in 32bit values */
2028 pPrivate
->page_size
/ 4,
2030 if (r
!= ERROR_OK
) {
2031 LOG_ERROR("SAM4: Failed to write (buffer) page at phys address 0x%08x",
2032 (unsigned int)(adr
));
2036 r
= EFC_PerformCommand(pPrivate
,
2037 /* send Erase & Write Page */
2038 AT91C_EFC_FCMD_WP
, /*AT91C_EFC_FCMD_EWP only works on first two 8kb sectors*/
2043 LOG_ERROR("SAM4: Error performing Write page @ phys address 0x%08x",
2044 (unsigned int)(adr
));
2045 if (status
& (1 << 2)) {
2046 LOG_ERROR("SAM4: Page @ Phys address 0x%08x is locked", (unsigned int)(adr
));
2049 if (status
& (1 << 1)) {
2050 LOG_ERROR("SAM4: Flash Command error @phys address 0x%08x", (unsigned int)(adr
));
2056 static int sam4_write(struct flash_bank
*bank
,
2057 const uint8_t *buffer
,
2065 unsigned page_offset
;
2066 struct sam4_bank_private
*pPrivate
;
2067 uint8_t *pagebuffer
;
2069 /* incase we bail further below, set this to null */
2072 /* ignore dumb requests */
2078 if (bank
->target
->state
!= TARGET_HALTED
) {
2079 LOG_ERROR("Target not halted");
2080 r
= ERROR_TARGET_NOT_HALTED
;
2084 pPrivate
= get_sam4_bank_private(bank
);
2085 if (!(pPrivate
->probed
)) {
2086 r
= ERROR_FLASH_BANK_NOT_PROBED
;
2090 if ((offset
+ count
) > pPrivate
->size_bytes
) {
2091 LOG_ERROR("Flash write error - past end of bank");
2092 LOG_ERROR(" offset: 0x%08x, count 0x%08x, BankEnd: 0x%08x",
2093 (unsigned int)(offset
),
2094 (unsigned int)(count
),
2095 (unsigned int)(pPrivate
->size_bytes
));
2100 pagebuffer
= malloc(pPrivate
->page_size
);
2102 LOG_ERROR("No memory for %d Byte page buffer", (int)(pPrivate
->page_size
));
2107 /* what page do we start & end in? */
2108 page_cur
= offset
/ pPrivate
->page_size
;
2109 page_end
= (offset
+ count
- 1) / pPrivate
->page_size
;
2111 LOG_DEBUG("Offset: 0x%08x, Count: 0x%08x", (unsigned int)(offset
), (unsigned int)(count
));
2112 LOG_DEBUG("Page start: %d, Page End: %d", (int)(page_cur
), (int)(page_end
));
2114 /* Special case: all one page */
2117 /* (1) non-aligned start */
2118 /* (2) body pages */
2119 /* (3) non-aligned end. */
2121 /* Handle special case - all one page. */
2122 if (page_cur
== page_end
) {
2123 LOG_DEBUG("Special case, all in one page");
2124 r
= sam4_page_read(pPrivate
, page_cur
, pagebuffer
);
2128 page_offset
= (offset
& (pPrivate
->page_size
-1));
2129 memcpy(pagebuffer
+ page_offset
,
2133 r
= sam4_page_write(pPrivate
, page_cur
, pagebuffer
);
2140 /* non-aligned start */
2141 page_offset
= offset
& (pPrivate
->page_size
- 1);
2143 LOG_DEBUG("Not-Aligned start");
2144 /* read the partial */
2145 r
= sam4_page_read(pPrivate
, page_cur
, pagebuffer
);
2149 /* over-write with new data */
2150 n
= (pPrivate
->page_size
- page_offset
);
2151 memcpy(pagebuffer
+ page_offset
,
2155 r
= sam4_page_write(pPrivate
, page_cur
, pagebuffer
);
2165 /* By checking that offset is correct here, we also
2166 fix a clang warning */
2167 assert(offset
% pPrivate
->page_size
== 0);
2169 /* intermediate large pages */
2170 /* also - the final *terminal* */
2171 /* if that terminal page is a full page */
2172 LOG_DEBUG("Full Page Loop: cur=%d, end=%d, count = 0x%08x",
2173 (int)page_cur
, (int)page_end
, (unsigned int)(count
));
2175 while ((page_cur
< page_end
) &&
2176 (count
>= pPrivate
->page_size
)) {
2177 r
= sam4_page_write(pPrivate
, page_cur
, buffer
);
2180 count
-= pPrivate
->page_size
;
2181 buffer
+= pPrivate
->page_size
;
2185 /* terminal partial page? */
2187 LOG_DEBUG("Terminal partial page, count = 0x%08x", (unsigned int)(count
));
2188 /* we have a partial page */
2189 r
= sam4_page_read(pPrivate
, page_cur
, pagebuffer
);
2192 /* data goes at start */
2193 memcpy(pagebuffer
, buffer
, count
);
2194 r
= sam4_page_write(pPrivate
, page_cur
, pagebuffer
);
2206 COMMAND_HANDLER(sam4_handle_info_command
)
2208 struct sam4_chip
*pChip
;
2209 pChip
= get_current_sam4(CMD_CTX
);
2216 /* bank0 must exist before we can do anything */
2217 if (pChip
->details
.bank
[0].pBank
== NULL
) {
2220 command_print(CMD_CTX
,
2221 "Please define bank %d via command: flash bank %s ... ",
2223 at91sam4_flash
.name
);
2227 /* if bank 0 is not probed, then probe it */
2228 if (!(pChip
->details
.bank
[0].probed
)) {
2229 r
= sam4_auto_probe(pChip
->details
.bank
[0].pBank
);
2233 /* above guarantees the "chip details" structure is valid */
2234 /* and thus, bank private areas are valid */
2235 /* and we have a SAM4 chip, what a concept! */
2237 /* auto-probe other banks, 0 done above */
2238 for (x
= 1; x
< SAM4_MAX_FLASH_BANKS
; x
++) {
2239 /* skip banks not present */
2240 if (!(pChip
->details
.bank
[x
].present
))
2243 if (pChip
->details
.bank
[x
].pBank
== NULL
)
2246 if (pChip
->details
.bank
[x
].probed
)
2249 r
= sam4_auto_probe(pChip
->details
.bank
[x
].pBank
);
2254 r
= sam4_GetInfo(pChip
);
2255 if (r
!= ERROR_OK
) {
2256 LOG_DEBUG("Sam4Info, Failed %d", r
);
2263 COMMAND_HANDLER(sam4_handle_gpnvm_command
)
2267 struct sam4_chip
*pChip
;
2269 pChip
= get_current_sam4(CMD_CTX
);
2273 if (pChip
->target
->state
!= TARGET_HALTED
) {
2274 LOG_ERROR("sam4 - target not halted");
2275 return ERROR_TARGET_NOT_HALTED
;
2278 if (pChip
->details
.bank
[0].pBank
== NULL
) {
2279 command_print(CMD_CTX
, "Bank0 must be defined first via: flash bank %s ...",
2280 at91sam4_flash
.name
);
2283 if (!pChip
->details
.bank
[0].probed
) {
2284 r
= sam4_auto_probe(pChip
->details
.bank
[0].pBank
);
2291 return ERROR_COMMAND_SYNTAX_ERROR
;
2300 if ((0 == strcmp(CMD_ARGV
[0], "show")) && (0 == strcmp(CMD_ARGV
[1], "all")))
2304 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], v32
);
2310 if (0 == strcmp("show", CMD_ARGV
[0])) {
2314 for (x
= 0; x
< pChip
->details
.n_gpnvms
; x
++) {
2315 r
= FLASHD_GetGPNVM(&(pChip
->details
.bank
[0]), x
, &v
);
2318 command_print(CMD_CTX
, "sam4-gpnvm%u: %u", x
, v
);
2322 if ((who
>= 0) && (((unsigned)(who
)) < pChip
->details
.n_gpnvms
)) {
2323 r
= FLASHD_GetGPNVM(&(pChip
->details
.bank
[0]), who
, &v
);
2324 command_print(CMD_CTX
, "sam4-gpnvm%u: %u", who
, v
);
2327 command_print(CMD_CTX
, "sam4-gpnvm invalid GPNVM: %u", who
);
2328 return ERROR_COMMAND_SYNTAX_ERROR
;
2333 command_print(CMD_CTX
, "Missing GPNVM number");
2334 return ERROR_COMMAND_SYNTAX_ERROR
;
2337 if (0 == strcmp("set", CMD_ARGV
[0]))
2338 r
= FLASHD_SetGPNVM(&(pChip
->details
.bank
[0]), who
);
2339 else if ((0 == strcmp("clr", CMD_ARGV
[0])) ||
2340 (0 == strcmp("clear", CMD_ARGV
[0]))) /* quietly accept both */
2341 r
= FLASHD_ClrGPNVM(&(pChip
->details
.bank
[0]), who
);
2343 command_print(CMD_CTX
, "Unknown command: %s", CMD_ARGV
[0]);
2344 r
= ERROR_COMMAND_SYNTAX_ERROR
;
2349 COMMAND_HANDLER(sam4_handle_slowclk_command
)
2351 struct sam4_chip
*pChip
;
2353 pChip
= get_current_sam4(CMD_CTX
);
2365 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[0], v
);
2367 /* absurd slow clock of 200Khz? */
2368 command_print(CMD_CTX
, "Absurd/illegal slow clock freq: %d\n", (int)(v
));
2369 return ERROR_COMMAND_SYNTAX_ERROR
;
2371 pChip
->cfg
.slow_freq
= v
;
2376 command_print(CMD_CTX
, "Too many parameters");
2377 return ERROR_COMMAND_SYNTAX_ERROR
;
2380 command_print(CMD_CTX
, "Slowclk freq: %d.%03dkhz",
2381 (int)(pChip
->cfg
.slow_freq
/ 1000),
2382 (int)(pChip
->cfg
.slow_freq
% 1000));
2386 static const struct command_registration at91sam4_exec_command_handlers
[] = {
2389 .handler
= sam4_handle_gpnvm_command
,
2390 .mode
= COMMAND_EXEC
,
2391 .usage
= "[('clr'|'set'|'show') bitnum]",
2392 .help
= "Without arguments, shows all bits in the gpnvm "
2393 "register. Otherwise, clears, sets, or shows one "
2394 "General Purpose Non-Volatile Memory (gpnvm) bit.",
2398 .handler
= sam4_handle_info_command
,
2399 .mode
= COMMAND_EXEC
,
2400 .help
= "Print information about the current at91sam4 chip"
2401 "and its flash configuration.",
2405 .handler
= sam4_handle_slowclk_command
,
2406 .mode
= COMMAND_EXEC
,
2407 .usage
= "[clock_hz]",
2408 .help
= "Display or set the slowclock frequency "
2409 "(default 32768 Hz).",
2411 COMMAND_REGISTRATION_DONE
2413 static const struct command_registration at91sam4_command_handlers
[] = {
2416 .mode
= COMMAND_ANY
,
2417 .help
= "at91sam4 flash command group",
2419 .chain
= at91sam4_exec_command_handlers
,
2421 COMMAND_REGISTRATION_DONE
2424 struct flash_driver at91sam4_flash
= {
2426 .commands
= at91sam4_command_handlers
,
2427 .flash_bank_command
= sam4_flash_bank_command
,
2428 .erase
= sam4_erase
,
2429 .protect
= sam4_protect
,
2430 .write
= sam4_write
,
2431 .read
= default_flash_read
,
2432 .probe
= sam4_probe
,
2433 .auto_probe
= sam4_auto_probe
,
2434 .erase_check
= default_flash_blank_check
,
2435 .protect_check
= sam4_protect_check
,
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)