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 ***************************************************************************/
24 #include "helper/binarybuffer.h"
26 #include <target/cortex_m.h>
28 #define SAMD_NUM_PROT_BLOCKS 16
29 #define SAMD_PAGE_SIZE_MAX 1024
31 #define SAMD_FLASH ((uint32_t)0x00000000) /* physical Flash memory */
32 #define SAMD_USER_ROW ((uint32_t)0x00804000) /* User Row of Flash */
33 #define SAMD_PAC1 0x41000000 /* Peripheral Access Control 1 */
34 #define SAMD_DSU 0x41002000 /* Device Service Unit */
35 #define SAMD_NVMCTRL 0x41004000 /* Non-volatile memory controller */
37 #define SAMD_DSU_STATUSA 1 /* DSU status register */
38 #define SAMD_DSU_DID 0x18 /* Device ID register */
39 #define SAMD_DSU_CTRL_EXT 0x100 /* CTRL register, external access */
41 #define SAMD_NVMCTRL_CTRLA 0x00 /* NVM control A register */
42 #define SAMD_NVMCTRL_CTRLB 0x04 /* NVM control B register */
43 #define SAMD_NVMCTRL_PARAM 0x08 /* NVM parameters register */
44 #define SAMD_NVMCTRL_INTFLAG 0x18 /* NVM Interupt Flag Status & Clear */
45 #define SAMD_NVMCTRL_STATUS 0x18 /* NVM status register */
46 #define SAMD_NVMCTRL_ADDR 0x1C /* NVM address register */
47 #define SAMD_NVMCTRL_LOCK 0x20 /* NVM Lock section register */
49 #define SAMD_CMDEX_KEY 0xA5UL
50 #define SAMD_NVM_CMD(n) ((SAMD_CMDEX_KEY << 8) | (n & 0x7F))
52 /* NVMCTRL commands. See Table 20-4 in 42129F–SAM–10/2013 */
53 #define SAMD_NVM_CMD_ER 0x02 /* Erase Row */
54 #define SAMD_NVM_CMD_WP 0x04 /* Write Page */
55 #define SAMD_NVM_CMD_EAR 0x05 /* Erase Auxilary Row */
56 #define SAMD_NVM_CMD_WAP 0x06 /* Write Auxilary Page */
57 #define SAMD_NVM_CMD_LR 0x40 /* Lock Region */
58 #define SAMD_NVM_CMD_UR 0x41 /* Unlock Region */
59 #define SAMD_NVM_CMD_SPRM 0x42 /* Set Power Reduction Mode */
60 #define SAMD_NVM_CMD_CPRM 0x43 /* Clear Power Reduction Mode */
61 #define SAMD_NVM_CMD_PBC 0x44 /* Page Buffer Clear */
62 #define SAMD_NVM_CMD_SSB 0x45 /* Set Security Bit */
63 #define SAMD_NVM_CMD_INVALL 0x46 /* Invalidate all caches */
66 #define SAMD_NVM_CTRLB_MANW 0x80
68 /* Known identifiers */
69 #define SAMD_PROCESSOR_M0 0x01
70 #define SAMD_FAMILY_D 0x00
71 #define SAMD_FAMILY_L 0x01
72 #define SAMD_FAMILY_C 0x02
73 #define SAMD_SERIES_20 0x00
74 #define SAMD_SERIES_21 0x01
75 #define SAMD_SERIES_22 0x02
76 #define SAMD_SERIES_10 0x02
77 #define SAMD_SERIES_11 0x03
78 #define SAMD_SERIES_09 0x04
80 /* Device ID macros */
81 #define SAMD_GET_PROCESSOR(id) (id >> 28)
82 #define SAMD_GET_FAMILY(id) (((id >> 23) & 0x1F))
83 #define SAMD_GET_SERIES(id) (((id >> 16) & 0x3F))
84 #define SAMD_GET_DEVSEL(id) (id & 0xFF)
86 /* Bits to mask out lockbits in user row */
87 #define NVMUSERROW_LOCKBIT_MASK ((uint64_t)0x0000FFFFFFFFFFFF)
96 /* Known SAMD09 parts. DID reset values missing in RM, see
97 * https://github.com/avrxml/asf/blob/master/sam0/utils/cmsis/samd09/include/ */
98 static const struct samd_part samd09_parts
[] = {
99 { 0x0, "SAMD09D14A", 16, 4 },
100 { 0x7, "SAMD09C13A", 8, 4 },
103 /* Known SAMD10 parts */
104 static const struct samd_part samd10_parts
[] = {
105 { 0x0, "SAMD10D14AMU", 16, 4 },
106 { 0x1, "SAMD10D13AMU", 8, 4 },
107 { 0x2, "SAMD10D12AMU", 4, 4 },
108 { 0x3, "SAMD10D14ASU", 16, 4 },
109 { 0x4, "SAMD10D13ASU", 8, 4 },
110 { 0x5, "SAMD10D12ASU", 4, 4 },
111 { 0x6, "SAMD10C14A", 16, 4 },
112 { 0x7, "SAMD10C13A", 8, 4 },
113 { 0x8, "SAMD10C12A", 4, 4 },
116 /* Known SAMD11 parts */
117 static const struct samd_part samd11_parts
[] = {
118 { 0x0, "SAMD11D14AMU", 16, 4 },
119 { 0x1, "SAMD11D13AMU", 8, 4 },
120 { 0x2, "SAMD11D12AMU", 4, 4 },
121 { 0x3, "SAMD11D14ASU", 16, 4 },
122 { 0x4, "SAMD11D13ASU", 8, 4 },
123 { 0x5, "SAMD11D12ASU", 4, 4 },
124 { 0x6, "SAMD11C14A", 16, 4 },
125 { 0x7, "SAMD11C13A", 8, 4 },
126 { 0x8, "SAMD11C12A", 4, 4 },
129 /* Known SAMD20 parts. See Table 12-8 in 42129F–SAM–10/2013 */
130 static const struct samd_part samd20_parts
[] = {
131 { 0x0, "SAMD20J18A", 256, 32 },
132 { 0x1, "SAMD20J17A", 128, 16 },
133 { 0x2, "SAMD20J16A", 64, 8 },
134 { 0x3, "SAMD20J15A", 32, 4 },
135 { 0x4, "SAMD20J14A", 16, 2 },
136 { 0x5, "SAMD20G18A", 256, 32 },
137 { 0x6, "SAMD20G17A", 128, 16 },
138 { 0x7, "SAMD20G16A", 64, 8 },
139 { 0x8, "SAMD20G15A", 32, 4 },
140 { 0x9, "SAMD20G14A", 16, 2 },
141 { 0xA, "SAMD20E18A", 256, 32 },
142 { 0xB, "SAMD20E17A", 128, 16 },
143 { 0xC, "SAMD20E16A", 64, 8 },
144 { 0xD, "SAMD20E15A", 32, 4 },
145 { 0xE, "SAMD20E14A", 16, 2 },
148 /* Known SAMD21 parts. */
149 static const struct samd_part samd21_parts
[] = {
150 { 0x0, "SAMD21J18A", 256, 32 },
151 { 0x1, "SAMD21J17A", 128, 16 },
152 { 0x2, "SAMD21J16A", 64, 8 },
153 { 0x3, "SAMD21J15A", 32, 4 },
154 { 0x4, "SAMD21J14A", 16, 2 },
155 { 0x5, "SAMD21G18A", 256, 32 },
156 { 0x6, "SAMD21G17A", 128, 16 },
157 { 0x7, "SAMD21G16A", 64, 8 },
158 { 0x8, "SAMD21G15A", 32, 4 },
159 { 0x9, "SAMD21G14A", 16, 2 },
160 { 0xA, "SAMD21E18A", 256, 32 },
161 { 0xB, "SAMD21E17A", 128, 16 },
162 { 0xC, "SAMD21E16A", 64, 8 },
163 { 0xD, "SAMD21E15A", 32, 4 },
164 { 0xE, "SAMD21E14A", 16, 2 },
166 /* SAMR21 parts have integrated SAMD21 with a radio */
167 { 0x19, "SAMR21G18A", 256, 32 },
168 { 0x1A, "SAMR21G17A", 128, 32 },
169 { 0x1B, "SAMR21G16A", 64, 32 },
170 { 0x1C, "SAMR21E18A", 256, 32 },
171 { 0x1D, "SAMR21E17A", 128, 32 },
172 { 0x1E, "SAMR21E16A", 64, 32 },
174 /* SAMD21 B Variants (Table 3-7 from rev I of datasheet) */
175 { 0x20, "SAMD21J16B", 64, 8 },
176 { 0x21, "SAMD21J15B", 32, 4 },
177 { 0x23, "SAMD21G16B", 64, 8 },
178 { 0x24, "SAMD21G15B", 32, 4 },
179 { 0x26, "SAMD21E16B", 64, 8 },
180 { 0x27, "SAMD21E15B", 32, 4 },
183 /* Known SAML21 parts. */
184 static const struct samd_part saml21_parts
[] = {
185 { 0x00, "SAML21J18A", 256, 32 },
186 { 0x01, "SAML21J17A", 128, 16 },
187 { 0x02, "SAML21J16A", 64, 8 },
188 { 0x05, "SAML21G18A", 256, 32 },
189 { 0x06, "SAML21G17A", 128, 16 },
190 { 0x07, "SAML21G16A", 64, 8 },
191 { 0x0A, "SAML21E18A", 256, 32 },
192 { 0x0B, "SAML21E17A", 128, 16 },
193 { 0x0C, "SAML21E16A", 64, 8 },
194 { 0x0D, "SAML21E15A", 32, 4 },
195 { 0x0F, "SAML21J18B", 256, 32 },
196 { 0x10, "SAML21J17B", 128, 16 },
197 { 0x11, "SAML21J16B", 64, 8 },
198 { 0x14, "SAML21G18B", 256, 32 },
199 { 0x15, "SAML21G17B", 128, 16 },
200 { 0x16, "SAML21G16B", 64, 8 },
201 { 0x19, "SAML21E18B", 256, 32 },
202 { 0x1A, "SAML21E17B", 128, 16 },
203 { 0x1B, "SAML21E16B", 64, 8 },
204 { 0x1C, "SAML21E15B", 32, 4 },
206 /* SAMR30 parts have integrated SAML21 with a radio */
207 { 0x1E, "SAMR30G18A", 256, 32 },
208 { 0x1F, "SAMR30E18A", 256, 32 },
211 /* Known SAML22 parts. */
212 static const struct samd_part saml22_parts
[] = {
213 { 0x00, "SAML22N18A", 256, 32 },
214 { 0x01, "SAML22N17A", 128, 16 },
215 { 0x02, "SAML22N16A", 64, 8 },
216 { 0x05, "SAML22J18A", 256, 32 },
217 { 0x06, "SAML22J17A", 128, 16 },
218 { 0x07, "SAML22J16A", 64, 8 },
219 { 0x0A, "SAML22G18A", 256, 32 },
220 { 0x0B, "SAML22G17A", 128, 16 },
221 { 0x0C, "SAML22G16A", 64, 8 },
224 /* Known SAMC20 parts. */
225 static const struct samd_part samc20_parts
[] = {
226 { 0x00, "SAMC20J18A", 256, 32 },
227 { 0x01, "SAMC20J17A", 128, 16 },
228 { 0x02, "SAMC20J16A", 64, 8 },
229 { 0x03, "SAMC20J15A", 32, 4 },
230 { 0x05, "SAMC20G18A", 256, 32 },
231 { 0x06, "SAMC20G17A", 128, 16 },
232 { 0x07, "SAMC20G16A", 64, 8 },
233 { 0x08, "SAMC20G15A", 32, 4 },
234 { 0x0A, "SAMC20E18A", 256, 32 },
235 { 0x0B, "SAMC20E17A", 128, 16 },
236 { 0x0C, "SAMC20E16A", 64, 8 },
237 { 0x0D, "SAMC20E15A", 32, 4 },
240 /* Known SAMC21 parts. */
241 static const struct samd_part samc21_parts
[] = {
242 { 0x00, "SAMC21J18A", 256, 32 },
243 { 0x01, "SAMC21J17A", 128, 16 },
244 { 0x02, "SAMC21J16A", 64, 8 },
245 { 0x03, "SAMC21J15A", 32, 4 },
246 { 0x05, "SAMC21G18A", 256, 32 },
247 { 0x06, "SAMC21G17A", 128, 16 },
248 { 0x07, "SAMC21G16A", 64, 8 },
249 { 0x08, "SAMC21G15A", 32, 4 },
250 { 0x0A, "SAMC21E18A", 256, 32 },
251 { 0x0B, "SAMC21E17A", 128, 16 },
252 { 0x0C, "SAMC21E16A", 64, 8 },
253 { 0x0D, "SAMC21E15A", 32, 4 },
256 /* Each family of parts contains a parts table in the DEVSEL field of DID. The
257 * processor ID, family ID, and series ID are used to determine which exact
258 * family this is and then we can use the corresponding table. */
263 const struct samd_part
*parts
;
265 uint64_t nvm_userrow_res_mask
; /* protect bits which are reserved, 0 -> protect */
268 /* Known SAMD families */
269 static const struct samd_family samd_families
[] = {
270 { SAMD_PROCESSOR_M0
, SAMD_FAMILY_D
, SAMD_SERIES_20
,
271 samd20_parts
, ARRAY_SIZE(samd20_parts
),
272 (uint64_t)0xFFFF01FFFE01FF77 },
273 { SAMD_PROCESSOR_M0
, SAMD_FAMILY_D
, SAMD_SERIES_21
,
274 samd21_parts
, ARRAY_SIZE(samd21_parts
),
275 (uint64_t)0xFFFF01FFFE01FF77 },
276 { SAMD_PROCESSOR_M0
, SAMD_FAMILY_D
, SAMD_SERIES_09
,
277 samd09_parts
, ARRAY_SIZE(samd09_parts
),
278 (uint64_t)0xFFFF01FFFE01FF77 },
279 { SAMD_PROCESSOR_M0
, SAMD_FAMILY_D
, SAMD_SERIES_10
,
280 samd10_parts
, ARRAY_SIZE(samd10_parts
),
281 (uint64_t)0xFFFF01FFFE01FF77 },
282 { SAMD_PROCESSOR_M0
, SAMD_FAMILY_D
, SAMD_SERIES_11
,
283 samd11_parts
, ARRAY_SIZE(samd11_parts
),
284 (uint64_t)0xFFFF01FFFE01FF77 },
285 { SAMD_PROCESSOR_M0
, SAMD_FAMILY_L
, SAMD_SERIES_21
,
286 saml21_parts
, ARRAY_SIZE(saml21_parts
),
287 (uint64_t)0xFFFF03FFFC01FF77 },
288 { SAMD_PROCESSOR_M0
, SAMD_FAMILY_L
, SAMD_SERIES_22
,
289 saml22_parts
, ARRAY_SIZE(saml22_parts
),
290 (uint64_t)0xFFFF03FFFC01FF77 },
291 { SAMD_PROCESSOR_M0
, SAMD_FAMILY_C
, SAMD_SERIES_20
,
292 samc20_parts
, ARRAY_SIZE(samc20_parts
),
293 (uint64_t)0xFFFF03FFFC01FF77 },
294 { SAMD_PROCESSOR_M0
, SAMD_FAMILY_C
, SAMD_SERIES_21
,
295 samc21_parts
, ARRAY_SIZE(samc21_parts
),
296 (uint64_t)0xFFFF03FFFC01FF77 },
306 struct target
*target
;
311 * Gives the family structure to specific device id.
312 * @param id The id of the device.
313 * @return On failure NULL, otherwise a pointer to the structure.
315 static const struct samd_family
*samd_find_family(uint32_t id
)
317 uint8_t processor
= SAMD_GET_PROCESSOR(id
);
318 uint8_t family
= SAMD_GET_FAMILY(id
);
319 uint8_t series
= SAMD_GET_SERIES(id
);
321 for (unsigned i
= 0; i
< ARRAY_SIZE(samd_families
); i
++) {
322 if (samd_families
[i
].processor
== processor
&&
323 samd_families
[i
].series
== series
&&
324 samd_families
[i
].family
== family
)
325 return &samd_families
[i
];
332 * Gives the part structure to specific device id.
333 * @param id The id of the device.
334 * @return On failure NULL, otherwise a pointer to the structure.
336 static const struct samd_part
*samd_find_part(uint32_t id
)
338 uint8_t devsel
= SAMD_GET_DEVSEL(id
);
339 const struct samd_family
*family
= samd_find_family(id
);
343 for (unsigned i
= 0; i
< family
->num_parts
; i
++) {
344 if (family
->parts
[i
].id
== devsel
)
345 return &family
->parts
[i
];
351 static int samd_protect_check(struct flash_bank
*bank
)
356 res
= target_read_u16(bank
->target
,
357 SAMD_NVMCTRL
+ SAMD_NVMCTRL_LOCK
, &lock
);
361 /* Lock bits are active-low */
362 for (prot_block
= 0; prot_block
< bank
->num_prot_blocks
; prot_block
++)
363 bank
->prot_blocks
[prot_block
].is_protected
= !(lock
& (1u<<prot_block
));
368 static int samd_get_flash_page_info(struct target
*target
,
369 uint32_t *sizep
, int *nump
)
374 res
= target_read_u32(target
, SAMD_NVMCTRL
+ SAMD_NVMCTRL_PARAM
, ¶m
);
375 if (res
== ERROR_OK
) {
376 /* The PSZ field (bits 18:16) indicate the page size bytes as 2^(3+n)
377 * so 0 is 8KB and 7 is 1024KB. */
379 *sizep
= (8 << ((param
>> 16) & 0x7));
380 /* The NVMP field (bits 15:0) indicates the total number of pages */
382 *nump
= param
& 0xFFFF;
384 LOG_ERROR("Couldn't read NVM Parameters register");
390 static int samd_probe(struct flash_bank
*bank
)
394 struct samd_info
*chip
= (struct samd_info
*)bank
->driver_priv
;
395 const struct samd_part
*part
;
400 res
= target_read_u32(bank
->target
, SAMD_DSU
+ SAMD_DSU_DID
, &id
);
401 if (res
!= ERROR_OK
) {
402 LOG_ERROR("Couldn't read Device ID register");
406 part
= samd_find_part(id
);
408 LOG_ERROR("Couldn't find part corresponding to DID %08" PRIx32
, id
);
412 bank
->size
= part
->flash_kb
* 1024;
414 res
= samd_get_flash_page_info(bank
->target
, &chip
->page_size
,
416 if (res
!= ERROR_OK
) {
417 LOG_ERROR("Couldn't determine Flash page size");
421 /* Sanity check: the total flash size in the DSU should match the page size
422 * multiplied by the number of pages. */
423 if (bank
->size
!= chip
->num_pages
* chip
->page_size
) {
424 LOG_WARNING("SAMD: bank size doesn't match NVM parameters. "
425 "Identified %" PRIu32
"KB Flash but NVMCTRL reports %u %" PRIu32
"B pages",
426 part
->flash_kb
, chip
->num_pages
, chip
->page_size
);
429 /* Erase granularity = 1 row = 4 pages */
430 chip
->sector_size
= chip
->page_size
* 4;
432 /* Allocate the sector table */
433 bank
->num_sectors
= chip
->num_pages
/ 4;
434 bank
->sectors
= alloc_block_array(0, chip
->sector_size
, bank
->num_sectors
);
438 /* 16 protection blocks per device */
439 chip
->prot_block_size
= bank
->size
/ SAMD_NUM_PROT_BLOCKS
;
441 /* Allocate the table of protection blocks */
442 bank
->num_prot_blocks
= SAMD_NUM_PROT_BLOCKS
;
443 bank
->prot_blocks
= alloc_block_array(0, chip
->prot_block_size
, bank
->num_prot_blocks
);
444 if (!bank
->prot_blocks
)
447 samd_protect_check(bank
);
452 LOG_INFO("SAMD MCU: %s (%" PRIu32
"KB Flash, %" PRIu32
"KB RAM)", part
->name
,
453 part
->flash_kb
, part
->ram_kb
);
458 static int samd_check_error(struct target
*target
)
463 ret
= target_read_u16(target
,
464 SAMD_NVMCTRL
+ SAMD_NVMCTRL_STATUS
, &status
);
465 if (ret
!= ERROR_OK
) {
466 LOG_ERROR("Can't read NVM status");
470 if ((status
& 0x001C) == 0)
473 if (status
& (1 << 4)) { /* NVME */
474 LOG_ERROR("SAMD: NVM Error");
475 ret
= ERROR_FLASH_OPERATION_FAILED
;
478 if (status
& (1 << 3)) { /* LOCKE */
479 LOG_ERROR("SAMD: NVM lock error");
480 ret
= ERROR_FLASH_PROTECTED
;
483 if (status
& (1 << 2)) { /* PROGE */
484 LOG_ERROR("SAMD: NVM programming error");
485 ret
= ERROR_FLASH_OPER_UNSUPPORTED
;
488 /* Clear the error conditions by writing a one to them */
489 ret2
= target_write_u16(target
,
490 SAMD_NVMCTRL
+ SAMD_NVMCTRL_STATUS
, status
);
491 if (ret2
!= ERROR_OK
)
492 LOG_ERROR("Can't clear NVM error conditions");
497 static int samd_issue_nvmctrl_command(struct target
*target
, uint16_t cmd
)
501 if (target
->state
!= TARGET_HALTED
) {
502 LOG_ERROR("Target not halted");
503 return ERROR_TARGET_NOT_HALTED
;
506 /* Issue the NVM command */
507 res
= target_write_u16(target
,
508 SAMD_NVMCTRL
+ SAMD_NVMCTRL_CTRLA
, SAMD_NVM_CMD(cmd
));
512 /* Check to see if the NVM command resulted in an error condition. */
513 return samd_check_error(target
);
517 * Erases a flash-row at the given address.
518 * @param target Pointer to the target structure.
519 * @param address The address of the row.
520 * @return On success ERROR_OK, on failure an errorcode.
522 static int samd_erase_row(struct target
*target
, uint32_t address
)
526 /* Set an address contained in the row to be erased */
527 res
= target_write_u32(target
,
528 SAMD_NVMCTRL
+ SAMD_NVMCTRL_ADDR
, address
>> 1);
530 /* Issue the Erase Row command to erase that row. */
532 res
= samd_issue_nvmctrl_command(target
,
533 address
== SAMD_USER_ROW
? SAMD_NVM_CMD_EAR
: SAMD_NVM_CMD_ER
);
535 if (res
!= ERROR_OK
) {
536 LOG_ERROR("Failed to erase row containing %08" PRIx32
, address
);
544 * Returns the bitmask of reserved bits in register.
545 * @param target Pointer to the target structure.
546 * @param mask Bitmask, 0 -> value stays untouched.
547 * @return On success ERROR_OK, on failure an errorcode.
549 static int samd_get_reservedmask(struct target
*target
, uint64_t *mask
)
552 /* Get the devicetype */
554 res
= target_read_u32(target
, SAMD_DSU
+ SAMD_DSU_DID
, &id
);
555 if (res
!= ERROR_OK
) {
556 LOG_ERROR("Couldn't read Device ID register");
559 const struct samd_family
*family
;
560 family
= samd_find_family(id
);
561 if (family
== NULL
) {
562 LOG_ERROR("Couldn't determine device family");
565 *mask
= family
->nvm_userrow_res_mask
;
569 static int read_userrow(struct target
*target
, uint64_t *userrow
)
574 res
= target_read_memory(target
, SAMD_USER_ROW
, 4, 2, buffer
);
578 *userrow
= target_buffer_get_u64(target
, buffer
);
583 * Modify the contents of the User Row in Flash. The User Row itself
584 * has a size of one page and contains a combination of "fuses" and
585 * calibration data. Bits which have a value of zero in the mask will
586 * not be changed. Up to now devices only use the first 64 bits.
587 * @param target Pointer to the target structure.
588 * @param value_input The value to write.
589 * @param value_mask Bitmask, 0 -> value stays untouched.
590 * @return On success ERROR_OK, on failure an errorcode.
592 static int samd_modify_user_row_masked(struct target
*target
,
593 uint64_t value_input
, uint64_t value_mask
)
597 bool manual_wp
= true;
599 /* Retrieve the MCU's page size, in bytes. This is also the size of the
600 * entire User Row. */
602 res
= samd_get_flash_page_info(target
, &page_size
, NULL
);
603 if (res
!= ERROR_OK
) {
604 LOG_ERROR("Couldn't determine Flash page size");
608 /* Make sure the size is sane. */
609 assert(page_size
<= SAMD_PAGE_SIZE_MAX
&&
610 page_size
>= sizeof(value_input
));
612 uint8_t buf
[SAMD_PAGE_SIZE_MAX
];
613 /* Read the user row (comprising one page) by words. */
614 res
= target_read_memory(target
, SAMD_USER_ROW
, 4, page_size
/ 4, buf
);
618 uint64_t value_device
;
619 res
= read_userrow(target
, &value_device
);
622 uint64_t value_new
= (value_input
& value_mask
) | (value_device
& ~value_mask
);
624 /* We will need to erase before writing if the new value needs a '1' in any
625 * position for which the current value had a '0'. Otherwise we can avoid
627 if ((~value_device
) & value_new
) {
628 res
= samd_erase_row(target
, SAMD_USER_ROW
);
629 if (res
!= ERROR_OK
) {
630 LOG_ERROR("Couldn't erase user row");
636 target_buffer_set_u64(target
, buf
, value_new
);
638 /* Write the page buffer back out to the target. */
639 res
= target_write_memory(target
, SAMD_USER_ROW
, 4, page_size
/ 4, buf
);
643 /* Check if we need to do manual page write commands */
644 res
= target_read_u32(target
, SAMD_NVMCTRL
+ SAMD_NVMCTRL_CTRLB
, &nvm_ctrlb
);
646 manual_wp
= (nvm_ctrlb
& SAMD_NVM_CTRLB_MANW
) != 0;
648 LOG_ERROR("Read of NVM register CTRKB failed.");
652 /* Trigger flash write */
653 res
= samd_issue_nvmctrl_command(target
, SAMD_NVM_CMD_WAP
);
655 res
= samd_check_error(target
);
662 * Modifies the user row register to the given value.
663 * @param target Pointer to the target structure.
664 * @param value The value to write.
665 * @param startb The bit-offset by which the given value is shifted.
666 * @param endb The bit-offset of the last bit in value to write.
667 * @return On success ERROR_OK, on failure an errorcode.
669 static int samd_modify_user_row(struct target
*target
, uint64_t value
,
670 uint8_t startb
, uint8_t endb
)
674 for (i
= startb
; i
<= endb
; i
++)
675 mask
|= ((uint64_t)1) << i
;
677 return samd_modify_user_row_masked(target
, value
<< startb
, mask
);
680 static int samd_protect(struct flash_bank
*bank
, int set
, int first_prot_bl
, int last_prot_bl
)
685 /* We can issue lock/unlock region commands with the target running but
686 * the settings won't persist unless we're able to modify the LOCK regions
687 * and that requires the target to be halted. */
688 if (bank
->target
->state
!= TARGET_HALTED
) {
689 LOG_ERROR("Target not halted");
690 return ERROR_TARGET_NOT_HALTED
;
693 for (prot_block
= first_prot_bl
; prot_block
<= last_prot_bl
; prot_block
++) {
694 if (set
!= bank
->prot_blocks
[prot_block
].is_protected
) {
695 /* Load an address that is within this protection block (we use offset 0) */
696 res
= target_write_u32(bank
->target
,
697 SAMD_NVMCTRL
+ SAMD_NVMCTRL_ADDR
,
698 bank
->prot_blocks
[prot_block
].offset
>> 1);
702 /* Tell the controller to lock that block */
703 res
= samd_issue_nvmctrl_command(bank
->target
,
704 set
? SAMD_NVM_CMD_LR
: SAMD_NVM_CMD_UR
);
710 /* We've now applied our changes, however they will be undone by the next
711 * reset unless we also apply them to the LOCK bits in the User Page. The
712 * LOCK bits start at bit 48, corresponding to Sector 0 and end with bit 63,
713 * corresponding to Sector 15. A '1' means unlocked and a '0' means
714 * locked. See Table 9-3 in the SAMD20 datasheet for more details. */
716 res
= samd_modify_user_row(bank
->target
,
717 set
? (uint64_t)0 : (uint64_t)UINT64_MAX
,
718 48 + first_prot_bl
, 48 + last_prot_bl
);
720 LOG_WARNING("SAMD: protect settings were not made persistent!");
725 samd_protect_check(bank
);
730 static int samd_erase(struct flash_bank
*bank
, int first_sect
, int last_sect
)
733 struct samd_info
*chip
= (struct samd_info
*)bank
->driver_priv
;
735 if (bank
->target
->state
!= TARGET_HALTED
) {
736 LOG_ERROR("Target not halted");
738 return ERROR_TARGET_NOT_HALTED
;
742 if (samd_probe(bank
) != ERROR_OK
)
743 return ERROR_FLASH_BANK_NOT_PROBED
;
746 /* For each sector to be erased */
747 for (s
= first_sect
; s
<= last_sect
; s
++) {
748 res
= samd_erase_row(bank
->target
, bank
->sectors
[s
].offset
);
749 if (res
!= ERROR_OK
) {
750 LOG_ERROR("SAMD: failed to erase sector %d at 0x%08" PRIx32
, s
, bank
->sectors
[s
].offset
);
759 static int samd_write(struct flash_bank
*bank
, const uint8_t *buffer
,
760 uint32_t offset
, uint32_t count
)
768 struct samd_info
*chip
= (struct samd_info
*)bank
->driver_priv
;
772 if (bank
->target
->state
!= TARGET_HALTED
) {
773 LOG_ERROR("Target not halted");
774 return ERROR_TARGET_NOT_HALTED
;
778 if (samd_probe(bank
) != ERROR_OK
)
779 return ERROR_FLASH_BANK_NOT_PROBED
;
782 /* Check if we need to do manual page write commands */
783 res
= target_read_u32(bank
->target
, SAMD_NVMCTRL
+ SAMD_NVMCTRL_CTRLB
, &nvm_ctrlb
);
788 if (nvm_ctrlb
& SAMD_NVM_CTRLB_MANW
)
793 res
= samd_issue_nvmctrl_command(bank
->target
, SAMD_NVM_CMD_PBC
);
794 if (res
!= ERROR_OK
) {
795 LOG_ERROR("%s: %d", __func__
, __LINE__
);
800 nb
= chip
->page_size
- offset
% chip
->page_size
;
804 address
= bank
->base
+ offset
;
805 pg_offset
= offset
% chip
->page_size
;
807 if (offset
% 4 || (offset
+ nb
) % 4) {
808 /* Either start or end of write is not word aligned */
810 pb
= malloc(chip
->page_size
);
815 /* Set temporary page buffer to 0xff and overwrite the relevant part */
816 memset(pb
, 0xff, chip
->page_size
);
817 memcpy(pb
+ pg_offset
, buffer
, nb
);
819 /* Align start address to a word boundary */
820 address
-= offset
% 4;
821 pg_offset
-= offset
% 4;
822 assert(pg_offset
% 4 == 0);
824 /* Extend length to whole words */
825 nw
= (nb
+ offset
% 4 + 3) / 4;
826 assert(pg_offset
+ 4 * nw
<= chip
->page_size
);
828 /* Now we have original data extended by 0xff bytes
829 * to the nearest word boundary on both start and end */
830 res
= target_write_memory(bank
->target
, address
, 4, nw
, pb
+ pg_offset
);
834 assert(pg_offset
+ 4 * nw
<= chip
->page_size
);
836 /* Word aligned data, use direct write from buffer */
837 res
= target_write_memory(bank
->target
, address
, 4, nw
, buffer
);
839 if (res
!= ERROR_OK
) {
840 LOG_ERROR("%s: %d", __func__
, __LINE__
);
844 /* Devices with errata 13134 have automatic page write enabled by default
845 * For other devices issue a write page CMD to the NVM
846 * If the page has not been written up to the last word
847 * then issue CMD_WP always */
848 if (manual_wp
|| pg_offset
+ 4 * nw
< chip
->page_size
) {
849 res
= samd_issue_nvmctrl_command(bank
->target
, SAMD_NVM_CMD_WP
);
851 /* Access through AHB is stalled while flash is being programmed */
854 res
= samd_check_error(bank
->target
);
857 if (res
!= ERROR_OK
) {
858 LOG_ERROR("%s: write failed at address 0x%08" PRIx32
, __func__
, address
);
862 /* We're done with the page contents */
875 FLASH_BANK_COMMAND_HANDLER(samd_flash_bank_command
)
877 if (bank
->base
!= SAMD_FLASH
) {
878 LOG_ERROR("Address 0x%08" PRIx32
" invalid bank address (try 0x%08" PRIx32
879 "[at91samd series] )",
880 bank
->base
, SAMD_FLASH
);
884 struct samd_info
*chip
;
885 chip
= calloc(1, sizeof(*chip
));
887 LOG_ERROR("No memory for flash bank chip info");
891 chip
->target
= bank
->target
;
892 chip
->probed
= false;
894 bank
->driver_priv
= chip
;
899 COMMAND_HANDLER(samd_handle_info_command
)
904 COMMAND_HANDLER(samd_handle_chip_erase_command
)
906 struct target
*target
= get_current_target(CMD_CTX
);
907 int res
= ERROR_FAIL
;
910 /* Enable access to the DSU by disabling the write protect bit */
911 target_write_u32(target
, SAMD_PAC1
, (1<<1));
912 /* intentionally without error checking - not accessible on secured chip */
914 /* Tell the DSU to perform a full chip erase. It takes about 240ms to
915 * perform the erase. */
916 res
= target_write_u8(target
, SAMD_DSU
+ SAMD_DSU_CTRL_EXT
, (1<<4));
918 command_print(CMD_CTX
, "chip erase started");
920 command_print(CMD_CTX
, "write to DSU CTRL failed");
926 COMMAND_HANDLER(samd_handle_set_security_command
)
929 struct target
*target
= get_current_target(CMD_CTX
);
931 if (CMD_ARGC
< 1 || (CMD_ARGC
>= 1 && (strcmp(CMD_ARGV
[0], "enable")))) {
932 command_print(CMD_CTX
, "supply the \"enable\" argument to proceed.");
933 return ERROR_COMMAND_SYNTAX_ERROR
;
937 if (target
->state
!= TARGET_HALTED
) {
938 LOG_ERROR("Target not halted");
939 return ERROR_TARGET_NOT_HALTED
;
942 res
= samd_issue_nvmctrl_command(target
, SAMD_NVM_CMD_SSB
);
944 /* Check (and clear) error conditions */
946 command_print(CMD_CTX
, "chip secured on next power-cycle");
948 command_print(CMD_CTX
, "failed to secure chip");
954 COMMAND_HANDLER(samd_handle_eeprom_command
)
957 struct target
*target
= get_current_target(CMD_CTX
);
960 if (target
->state
!= TARGET_HALTED
) {
961 LOG_ERROR("Target not halted");
962 return ERROR_TARGET_NOT_HALTED
;
966 int val
= atoi(CMD_ARGV
[0]);
972 /* Try to match size in bytes with corresponding size code */
973 for (code
= 0; code
<= 6; code
++) {
974 if (val
== (2 << (13 - code
)))
979 command_print(CMD_CTX
, "Invalid EEPROM size. Please see "
980 "datasheet for a list valid sizes.");
981 return ERROR_COMMAND_SYNTAX_ERROR
;
985 res
= samd_modify_user_row(target
, code
, 4, 6);
988 res
= target_read_u16(target
, SAMD_USER_ROW
, &val
);
989 if (res
== ERROR_OK
) {
990 uint32_t size
= ((val
>> 4) & 0x7); /* grab size code */
993 command_print(CMD_CTX
, "EEPROM is disabled");
995 /* Otherwise, 6 is 256B, 0 is 16KB */
996 command_print(CMD_CTX
, "EEPROM size is %u bytes",
1006 static COMMAND_HELPER(get_u64_from_hexarg
, unsigned int num
, uint64_t *value
)
1008 if (num
>= CMD_ARGC
) {
1009 command_print(CMD_CTX
, "Too few Arguments.");
1010 return ERROR_COMMAND_SYNTAX_ERROR
;
1013 if (strlen(CMD_ARGV
[num
]) >= 3 &&
1014 CMD_ARGV
[num
][0] == '0' &&
1015 CMD_ARGV
[num
][1] == 'x') {
1017 *value
= strtoull(&(CMD_ARGV
[num
][2]), &check
, 16);
1018 if ((value
== 0 && errno
== ERANGE
) ||
1019 check
== NULL
|| *check
!= 0) {
1020 command_print(CMD_CTX
, "Invalid 64-bit hex value in argument %d.",
1022 return ERROR_COMMAND_SYNTAX_ERROR
;
1025 command_print(CMD_CTX
, "Argument %d needs to be a hex value.", num
+ 1);
1026 return ERROR_COMMAND_SYNTAX_ERROR
;
1031 COMMAND_HANDLER(samd_handle_nvmuserrow_command
)
1034 struct target
*target
= get_current_target(CMD_CTX
);
1038 command_print(CMD_CTX
, "Too much Arguments given.");
1039 return ERROR_COMMAND_SYNTAX_ERROR
;
1043 if (target
->state
!= TARGET_HALTED
) {
1044 LOG_ERROR("Target not halted.");
1045 return ERROR_TARGET_NOT_HALTED
;
1049 res
= samd_get_reservedmask(target
, &mask
);
1050 if (res
!= ERROR_OK
) {
1051 LOG_ERROR("Couldn't determine the mask for reserved bits.");
1054 mask
&= NVMUSERROW_LOCKBIT_MASK
;
1057 res
= CALL_COMMAND_HANDLER(get_u64_from_hexarg
, 0, &value
);
1058 if (res
!= ERROR_OK
)
1060 if (CMD_ARGC
== 2) {
1062 res
= CALL_COMMAND_HANDLER(get_u64_from_hexarg
, 1, &mask_temp
);
1063 if (res
!= ERROR_OK
)
1067 res
= samd_modify_user_row_masked(target
, value
, mask
);
1068 if (res
!= ERROR_OK
)
1074 res
= read_userrow(target
, &value
);
1075 if (res
== ERROR_OK
)
1076 command_print(CMD_CTX
, "NVMUSERROW: 0x%016"PRIX64
, value
);
1078 LOG_ERROR("NVMUSERROW could not be read.");
1083 COMMAND_HANDLER(samd_handle_bootloader_command
)
1086 struct target
*target
= get_current_target(CMD_CTX
);
1089 if (target
->state
!= TARGET_HALTED
) {
1090 LOG_ERROR("Target not halted");
1091 return ERROR_TARGET_NOT_HALTED
;
1094 /* Retrieve the MCU's page size, in bytes. */
1096 res
= samd_get_flash_page_info(target
, &page_size
, NULL
);
1097 if (res
!= ERROR_OK
) {
1098 LOG_ERROR("Couldn't determine Flash page size");
1102 if (CMD_ARGC
>= 1) {
1103 int val
= atoi(CMD_ARGV
[0]);
1109 /* Try to match size in bytes with corresponding size code */
1110 for (code
= 0; code
<= 6; code
++) {
1111 if ((unsigned int)val
== (2UL << (8UL - code
)) * page_size
)
1116 command_print(CMD_CTX
, "Invalid bootloader size. Please "
1117 "see datasheet for a list valid sizes.");
1118 return ERROR_COMMAND_SYNTAX_ERROR
;
1123 res
= samd_modify_user_row(target
, code
, 0, 2);
1126 res
= target_read_u16(target
, SAMD_USER_ROW
, &val
);
1127 if (res
== ERROR_OK
) {
1128 uint32_t size
= (val
& 0x7); /* grab size code */
1134 nb
= (2 << (8 - size
)) * page_size
;
1136 /* There are 4 pages per row */
1137 command_print(CMD_CTX
, "Bootloader size is %" PRIu32
" bytes (%" PRIu32
" rows)",
1138 nb
, (uint32_t)(nb
/ (page_size
* 4)));
1148 COMMAND_HANDLER(samd_handle_reset_deassert
)
1150 struct target
*target
= get_current_target(CMD_CTX
);
1151 int retval
= ERROR_OK
;
1152 enum reset_types jtag_reset_config
= jtag_get_reset_config();
1154 /* If the target has been unresponsive before, try to re-establish
1155 * communication now - CPU is held in reset by DSU, DAP is working */
1156 if (!target_was_examined(target
))
1157 target_examine_one(target
);
1158 target_poll(target
);
1160 /* In case of sysresetreq, debug retains state set in cortex_m_assert_reset()
1161 * so we just release reset held by DSU
1163 * n_RESET (srst) clears the DP, so reenable debug and set vector catch here
1165 * After vectreset DSU release is not needed however makes no harm
1167 if (target
->reset_halt
&& (jtag_reset_config
& RESET_HAS_SRST
)) {
1168 retval
= target_write_u32(target
, DCB_DHCSR
, DBGKEY
| C_HALT
| C_DEBUGEN
);
1169 if (retval
== ERROR_OK
)
1170 retval
= target_write_u32(target
, DCB_DEMCR
,
1171 TRCENA
| VC_HARDERR
| VC_BUSERR
| VC_CORERESET
);
1172 /* do not return on error here, releasing DSU reset is more important */
1175 /* clear CPU Reset Phase Extension bit */
1176 int retval2
= target_write_u8(target
, SAMD_DSU
+ SAMD_DSU_STATUSA
, (1<<1));
1177 if (retval2
!= ERROR_OK
)
1183 static const struct command_registration at91samd_exec_command_handlers
[] = {
1185 .name
= "dsu_reset_deassert",
1186 .handler
= samd_handle_reset_deassert
,
1187 .mode
= COMMAND_EXEC
,
1188 .help
= "Deasert internal reset held by DSU."
1192 .handler
= samd_handle_info_command
,
1193 .mode
= COMMAND_EXEC
,
1194 .help
= "Print information about the current at91samd chip "
1195 "and its flash configuration.",
1198 .name
= "chip-erase",
1199 .handler
= samd_handle_chip_erase_command
,
1200 .mode
= COMMAND_EXEC
,
1201 .help
= "Erase the entire Flash by using the Chip-"
1202 "Erase feature in the Device Service Unit (DSU).",
1205 .name
= "set-security",
1206 .handler
= samd_handle_set_security_command
,
1207 .mode
= COMMAND_EXEC
,
1208 .help
= "Secure the chip's Flash by setting the Security Bit. "
1209 "This makes it impossible to read the Flash contents. "
1210 "The only way to undo this is to issue the chip-erase "
1215 .usage
= "[size_in_bytes]",
1216 .handler
= samd_handle_eeprom_command
,
1217 .mode
= COMMAND_EXEC
,
1218 .help
= "Show or set the EEPROM size setting, stored in the User Row. "
1219 "Please see Table 20-3 of the SAMD20 datasheet for allowed values. "
1220 "Changes are stored immediately but take affect after the MCU is "
1224 .name
= "bootloader",
1225 .usage
= "[size_in_bytes]",
1226 .handler
= samd_handle_bootloader_command
,
1227 .mode
= COMMAND_EXEC
,
1228 .help
= "Show or set the bootloader size, stored in the User Row. "
1229 "Please see Table 20-2 of the SAMD20 datasheet for allowed values. "
1230 "Changes are stored immediately but take affect after the MCU is "
1234 .name
= "nvmuserrow",
1235 .usage
= "[value] [mask]",
1236 .handler
= samd_handle_nvmuserrow_command
,
1237 .mode
= COMMAND_EXEC
,
1238 .help
= "Show or set the nvmuserrow register. It is 64 bit wide "
1239 "and located at address 0x804000. Use the optional mask argument "
1240 "to prevent changes at positions where the bitvalue is zero. "
1241 "For security reasons the lock- and reserved-bits are masked out "
1242 "in background and therefore cannot be changed.",
1244 COMMAND_REGISTRATION_DONE
1247 static const struct command_registration at91samd_command_handlers
[] = {
1250 .mode
= COMMAND_ANY
,
1251 .help
= "at91samd flash command group",
1253 .chain
= at91samd_exec_command_handlers
,
1255 COMMAND_REGISTRATION_DONE
1258 struct flash_driver at91samd_flash
= {
1260 .commands
= at91samd_command_handlers
,
1261 .flash_bank_command
= samd_flash_bank_command
,
1262 .erase
= samd_erase
,
1263 .protect
= samd_protect
,
1264 .write
= samd_write
,
1265 .read
= default_flash_read
,
1266 .probe
= samd_probe
,
1267 .auto_probe
= samd_probe
,
1268 .erase_check
= default_flash_blank_check
,
1269 .protect_check
= samd_protect_check
,
1270 .free_driver_priv
= default_flash_free_driver_priv
,
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)