1 /**************************************************************************
2 * Copyright (C) 2015 Jeff Ciesielski <jeffciesielski@gmail.com> *
4 * This program is free software; you can redistribute it and/or modify *
5 * it under the terms of the GNU General Public License as published by *
6 * the Free Software Foundation; either version 2 of the License, or *
7 * (at your option) any later version. *
9 * This program is distributed in the hope that it will be useful, *
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12 * GNU General Public License for more details. *
14 ***************************************************************************/
21 #include <helper/binarybuffer.h>
22 #include <target/algorithm.h>
23 #include <target/armv7m.h>
25 /* Maximum number of sectors */
26 #define MAX_XMC_SECTORS 12
28 /* System control unit registers */
29 #define SCU_REG_BASE 0x50004000
31 #define SCU_ID_CHIP 0x04
33 /* Base of the non-cached flash memory */
34 #define PFLASH_BASE 0x0C000000
36 /* User configuration block offsets */
37 #define UCB0_BASE 0x00000000
38 #define UCB1_BASE 0x00000400
39 #define UCB2_BASE 0x00000800
41 /* Flash register base */
42 #define FLASH_REG_BASE 0x58000000
44 /* PMU ID Registers */
45 #define FLASH_REG_PMU_ID (FLASH_REG_BASE | 0x0508)
48 #define PMU_MOD_REV_MASK 0xFF
49 #define PMU_MOD_TYPE_MASK 0xFF00
50 #define PMU_MOD_NO_MASK 0xFFFF0000
53 #define FLASH_REG_PREF_PCON (FLASH_REG_BASE | 0x4000)
56 #define PCON_IBYP (1 << 0)
57 #define PCON_IINV (1 << 1)
59 /* Flash ID Register */
60 #define FLASH_REG_FLASH0_ID (FLASH_REG_BASE | 0x2008)
62 /* Flash Status Register */
63 #define FLASH_REG_FLASH0_FSR (FLASH_REG_BASE | 0x2010)
66 #define FSR_FABUSY (1)
69 #define FSR_PFPAGE (6)
70 #define FSR_PFOPER (8)
72 #define FSR_PROER (11)
73 #define FSR_PFSBER (12)
74 #define FSR_PFDBER (14)
75 #define FSR_PROIN (16)
76 #define FSR_RPROIN (18)
77 #define FSR_RPRODIS (19)
78 #define FSR_WPROIN0 (21)
79 #define FSR_WPROIN1 (22)
80 #define FSR_WPROIN2 (23)
81 #define FSR_WPRODIS0 (25)
82 #define FSR_WPRODIS1 (26)
86 #define FSR_PBUSY_MASK (0x01 << FSR_PBUSY)
87 #define FSR_FABUSY_MASK (0x01 << FSR_FABUSY)
88 #define FSR_PROG_MASK (0x01 << FSR_PROG)
89 #define FSR_ERASE_MASK (0x01 << FSR_ERASE)
90 #define FSR_PFPAGE_MASK (0x01 << FSR_PFPAGE)
91 #define FSR_PFOPER_MASK (0x01 << FSR_PFOPER)
92 #define FSR_SQER_MASK (0x01 << FSR_SQER)
93 #define FSR_PROER_MASK (0x01 << FSR_PROER)
94 #define FSR_PFSBER_MASK (0x01 << FSR_PFSBER)
95 #define FSR_PFDBER_MASK (0x01 << FSR_PFDBER)
96 #define FSR_PROIN_MASK (0x01 << FSR_PROIN)
97 #define FSR_RPROIN_MASK (0x01 << FSR_RPROIN)
98 #define FSR_RPRODIS_MASK (0x01 << FSR_RPRODIS)
99 #define FSR_WPROIN0_MASK (0x01 << FSR_WPROIN0)
100 #define FSR_WPROIN1_MASK (0x01 << FSR_WPROIN1)
101 #define FSR_WPROIN2_MASK (0x01 << FSR_WPROIN2)
102 #define FSR_WPRODIS0_MASK (0x01 << FSR_WPRODIS0)
103 #define FSR_WPRODIS1_MASK (0x01 << FSR_WPRODIS1)
104 #define FSR_SLM_MASK (0x01 << FSR_SLM)
105 #define FSR_VER_MASK (0x01 << FSR_VER)
107 /* Flash Config Register */
108 #define FLASH_REG_FLASH0_FCON (FLASH_REG_BASE | 0x2014)
110 #define FCON_WSPFLASH (0)
111 #define FCON_WSECPF (4)
112 #define FCON_IDLE (13)
113 #define FCON_ESLDIS (14)
114 #define FCON_SLEEP (15)
115 #define FCON_RPA (16)
116 #define FCON_DCF (17)
117 #define FCON_DDF (18)
118 #define FCON_VOPERM (24)
119 #define FCON_SQERM (25)
120 #define FCON_PROERM (26)
121 #define FCON_PFSBERM (27)
122 #define FCON_PFDBERM (29)
123 #define FCON_EOBM (31)
125 #define FCON_WSPFLASH_MASK (0x0f << FCON_WSPFLASH)
126 #define FCON_WSECPF_MASK (0x01 << FCON_WSECPF)
127 #define FCON_IDLE_MASK (0x01 << FCON_IDLE)
128 #define FCON_ESLDIS_MASK (0x01 << FCON_ESLDIS)
129 #define FCON_SLEEP_MASK (0x01 << FCON_SLEEP)
130 #define FCON_RPA_MASK (0x01 << FCON_RPA)
131 #define FCON_DCF_MASK (0x01 << FCON_DCF)
132 #define FCON_DDF_MASK (0x01 << FCON_DDF)
133 #define FCON_VOPERM_MASK (0x01 << FCON_VOPERM)
134 #define FCON_SQERM_MASK (0x01 << FCON_SQERM)
135 #define FCON_PROERM_MASK (0x01 << FCON_PROERM)
136 #define FCON_PFSBERM_MASK (0x01 << FCON_PFSBERM)
137 #define FCON_PFDBERM_MASK (0x01 << FCON_PFDBERM)
138 #define FCON_EOBM_MASK (0x01 << FCON_EOBM)
140 /* Flash Margin Control Register */
141 #define FLASH_REG_FLASH0_MARP (FLASH_REG_BASE | 0x2018)
143 #define MARP_MARGIN (0)
144 #define MARP_TRAPDIS (15)
146 #define MARP_MARGIN_MASK (0x0f << MARP_MARGIN)
147 #define MARP_TRAPDIS_MASK (0x01 << MARP_TRAPDIS)
149 /* Flash Protection Registers */
150 #define FLASH_REG_FLASH0_PROCON0 (FLASH_REG_BASE | 0x2020)
151 #define FLASH_REG_FLASH0_PROCON1 (FLASH_REG_BASE | 0x2024)
152 #define FLASH_REG_FLASH0_PROCON2 (FLASH_REG_BASE | 0x2028)
154 #define PROCON_S0L (0)
155 #define PROCON_S1L (1)
156 #define PROCON_S2L (2)
157 #define PROCON_S3L (3)
158 #define PROCON_S4L (4)
159 #define PROCON_S5L (5)
160 #define PROCON_S6L (6)
161 #define PROCON_S7L (7)
162 #define PROCON_S8L (8)
163 #define PROCON_S9L (9)
164 #define PROCON_S10_S11L (10)
165 #define PROCON_RPRO (15)
167 #define PROCON_S0L_MASK (0x01 << PROCON_S0L)
168 #define PROCON_S1L_MASK (0x01 << PROCON_S1L)
169 #define PROCON_S2L_MASK (0x01 << PROCON_S2L)
170 #define PROCON_S3L_MASK (0x01 << PROCON_S3L)
171 #define PROCON_S4L_MASK (0x01 << PROCON_S4L)
172 #define PROCON_S5L_MASK (0x01 << PROCON_S5L)
173 #define PROCON_S6L_MASK (0x01 << PROCON_S6L)
174 #define PROCON_S7L_MASK (0x01 << PROCON_S7L)
175 #define PROCON_S8L_MASK (0x01 << PROCON_S8L)
176 #define PROCON_S9L_MASK (0x01 << PROCON_S9L)
177 #define PROCON_S10_S11L_MASK (0x01 << PROCON_S10_S11L)
178 #define PROCON_RPRO_MASK (0x01 << PROCON_RPRO)
180 #define FLASH_PROTECT_CONFIRMATION_CODE 0x8AFE15C3
182 /* Flash controller configuration values */
183 #define FLASH_ID_XMC4500 0xA2
184 #define FLASH_ID_XMC4700_4800 0x92
185 #define FLASH_ID_XMC4100_4200 0x9C
186 #define FLASH_ID_XMC4400 0x9F
189 #define FLASH_OP_TIMEOUT 5000
191 /* Flash commands (write/erase/protect) are performed using special
192 * command sequences that are written to magic addresses in the flash controller */
193 /* Command sequence addresses. See reference manual, section 8: Flash Command Sequences */
194 #define FLASH_CMD_ERASE_1 0x0C005554
195 #define FLASH_CMD_ERASE_2 0x0C00AAA8
196 #define FLASH_CMD_ERASE_3 FLASH_CMD_ERASE_1
197 #define FLASH_CMD_ERASE_4 FLASH_CMD_ERASE_1
198 #define FLASH_CMD_ERASE_5 FLASH_CMD_ERASE_2
199 /* ERASE_6 is the sector base address */
201 #define FLASH_CMD_CLEAR_STATUS FLASH_CMD_ERASE_1
203 #define FLASH_CMD_ENTER_PAGEMODE FLASH_CMD_ERASE_1
205 #define FLASH_CMD_LOAD_PAGE_1 0x0C0055F0
206 #define FLASH_CMD_LOAD_PAGE_2 0x0C0055F4
208 #define FLASH_CMD_WRITE_PAGE_1 FLASH_CMD_ERASE_1
209 #define FLASH_CMD_WRITE_PAGE_2 FLASH_CMD_ERASE_2
210 #define FLASH_CMD_WRITE_PAGE_3 FLASH_CMD_ERASE_1
211 /* WRITE_PAGE_4 is the page base address */
213 #define FLASH_CMD_TEMP_UNPROT_1 FLASH_CMD_ERASE_1
214 #define FLASH_CMD_TEMP_UNPROT_2 FLASH_CMD_ERASE_2
215 #define FLASH_CMD_TEMP_UNPROT_3 0x0C00553C
216 #define FLASH_CMD_TEMP_UNPROT_4 FLASH_CMD_ERASE_2
217 #define FLASH_CMD_TEMP_UNPROT_5 FLASH_CMD_ERASE_2
218 #define FLASH_CMD_TEMP_UNPROT_6 0x0C005558
220 struct xmc4xxx_flash_bank
{
223 /* We need the flash controller ID to choose the sector layout */
226 /* Passwords used for protection operations */
231 /* Protection flags */
234 bool write_prot_otp
[MAX_XMC_SECTORS
];
237 struct xmc4xxx_command_seq
{
242 /* Sector capacities. See section 8 of xmc4x00_rm */
243 static const unsigned int sector_capacity_8
[8] = {
244 16, 16, 16, 16, 16, 16, 16, 128
247 static const unsigned int sector_capacity_9
[9] = {
248 16, 16, 16, 16, 16, 16, 16, 128, 256
251 static const unsigned int sector_capacity_12
[12] = {
252 16, 16, 16, 16, 16, 16, 16, 16, 128, 256, 256, 256
255 static const unsigned int sector_capacity_16
[16] = {
256 16, 16, 16, 16, 16, 16, 16, 16, 128, 256, 256, 256, 256, 256, 256, 256
259 static int xmc4xxx_write_command_sequence(struct flash_bank
*bank
,
260 struct xmc4xxx_command_seq
*seq
,
265 for (int i
= 0; i
< seq_len
; i
++) {
266 res
= target_write_u32(bank
->target
, seq
[i
].address
,
275 static int xmc4xxx_load_bank_layout(struct flash_bank
*bank
)
277 const unsigned int *capacity
= NULL
;
279 /* At this point, we know which flash controller ID we're
280 * talking to and simply need to fill out the bank structure accordingly */
281 LOG_DEBUG("%d sectors", bank
->num_sectors
);
283 switch (bank
->num_sectors
) {
285 capacity
= sector_capacity_8
;
288 capacity
= sector_capacity_9
;
291 capacity
= sector_capacity_12
;
294 capacity
= sector_capacity_16
;
297 LOG_ERROR("Unexpected number of sectors, %d\n",
302 /* This looks like a bank that we understand, now we know the
303 * corresponding sector capacities and we can add those up into the
305 uint32_t total_offset
= 0;
306 bank
->sectors
= calloc(bank
->num_sectors
,
307 sizeof(struct flash_sector
));
308 for (int i
= 0; i
< bank
->num_sectors
; i
++) {
309 bank
->sectors
[i
].size
= capacity
[i
] * 1024;
310 bank
->sectors
[i
].offset
= total_offset
;
311 bank
->sectors
[i
].is_erased
= -1;
312 bank
->sectors
[i
].is_protected
= -1;
314 bank
->size
+= bank
->sectors
[i
].size
;
315 LOG_DEBUG("\t%d: %uk", i
, capacity
[i
]);
316 total_offset
+= bank
->sectors
[i
].size
;
319 /* This part doesn't follow the typical standard of 0xff
320 * being the default padding value.*/
321 bank
->default_padded_value
= 0x00;
326 static int xmc4xxx_probe(struct flash_bank
*bank
)
329 uint32_t devid
, config
;
330 struct xmc4xxx_flash_bank
*fb
= bank
->driver_priv
;
336 /* It's not possible for the DAP to access the OTP locations needed for
337 * probing the part info and Flash geometry so we require that the target
338 * be halted before proceeding. */
339 if (bank
->target
->state
!= TARGET_HALTED
) {
340 LOG_WARNING("Cannot communicate... target not halted.");
341 return ERROR_TARGET_NOT_HALTED
;
344 /* The SCU registers contain the ID of the chip */
345 res
= target_read_u32(bank
->target
, SCU_REG_BASE
+ SCU_ID_CHIP
, &devid
);
346 if (res
!= ERROR_OK
) {
347 LOG_ERROR("Cannot read device identification register.");
351 /* Make sure this is a XMC4000 family device */
352 if ((devid
& 0xF0000) != 0x40000 && devid
!= 0) {
353 LOG_ERROR("Platform ID doesn't match XMC4xxx: 0x%08" PRIx32
, devid
);
357 LOG_DEBUG("Found XMC4xxx with devid: 0x%08" PRIx32
, devid
);
359 /* Now sanity-check the Flash controller itself. */
360 res
= target_read_u32(bank
->target
, FLASH_REG_FLASH0_ID
,
362 if (res
!= ERROR_OK
) {
363 LOG_ERROR("Cannot read Flash bank configuration.");
366 flash_id
= (config
& 0xff0000) >> 16;
368 /* The Flash configuration register is our only means of
369 * determining the sector layout. We need to make sure that
370 * we understand the type of controller we're dealing with */
372 case FLASH_ID_XMC4100_4200
:
373 bank
->num_sectors
= 8;
374 LOG_DEBUG("XMC4xxx: XMC4100/4200 detected.");
376 case FLASH_ID_XMC4400
:
377 bank
->num_sectors
= 9;
378 LOG_DEBUG("XMC4xxx: XMC4400 detected.");
380 case FLASH_ID_XMC4500
:
381 bank
->num_sectors
= 12;
382 LOG_DEBUG("XMC4xxx: XMC4500 detected.");
384 case FLASH_ID_XMC4700_4800
:
385 bank
->num_sectors
= 16;
386 LOG_DEBUG("XMC4xxx: XMC4700/4800 detected.");
389 LOG_ERROR("XMC4xxx: Unexpected flash ID. got %02" PRIx8
,
394 /* Retrieve information about the particular bank we're probing and fill in
395 * the bank structure accordingly. */
396 res
= xmc4xxx_load_bank_layout(bank
);
397 if (res
== ERROR_OK
) {
401 LOG_ERROR("Unable to load bank information.");
408 static int xmc4xxx_get_sector_start_addr(struct flash_bank
*bank
,
409 int sector
, uint32_t *ret_addr
)
411 /* Make sure we understand this sector */
412 if (sector
> bank
->num_sectors
)
415 *ret_addr
= bank
->base
+ bank
->sectors
[sector
].offset
;
421 static int xmc4xxx_clear_flash_status(struct flash_bank
*bank
)
424 /* TODO: Do we need to check for sequence error? */
425 LOG_INFO("Clearing flash status");
426 res
= target_write_u32(bank
->target
, FLASH_CMD_CLEAR_STATUS
,
428 if (res
!= ERROR_OK
) {
429 LOG_ERROR("Unable to write erase command sequence");
436 static int xmc4xxx_get_flash_status(struct flash_bank
*bank
, uint32_t *status
)
440 res
= target_read_u32(bank
->target
, FLASH_REG_FLASH0_FSR
, status
);
443 LOG_ERROR("Cannot read flash status register.");
448 static int xmc4xxx_wait_status_busy(struct flash_bank
*bank
, int timeout
)
453 res
= xmc4xxx_get_flash_status(bank
, &status
);
457 /* While the flash controller is busy, wait */
458 while (status
& FSR_PBUSY_MASK
) {
459 res
= xmc4xxx_get_flash_status(bank
, &status
);
463 if (timeout
-- <= 0) {
464 LOG_ERROR("Timed out waiting for flash");
471 if (status
& FSR_PROER_MASK
) {
472 LOG_ERROR("XMC4xxx flash protected");
479 static int xmc4xxx_erase_sector(struct flash_bank
*bank
, uint32_t address
,
485 /* See reference manual table 8.4: Command Sequences for Flash Control */
486 struct xmc4xxx_command_seq erase_cmd_seq
[6] = {
487 {FLASH_CMD_ERASE_1
, 0xAA},
488 {FLASH_CMD_ERASE_2
, 0x55},
489 {FLASH_CMD_ERASE_3
, 0x80},
490 {FLASH_CMD_ERASE_4
, 0xAA},
491 {FLASH_CMD_ERASE_5
, 0x55},
492 {0xFF, 0xFF} /* Needs filled in */
495 /* We need to fill in the base address of the sector we'll be
496 * erasing, as well as the magic code that determines whether
497 * this is a standard flash sector or a user configuration block */
499 erase_cmd_seq
[5].address
= address
;
501 /* Removing flash protection requires the addition of
502 * the base address */
503 erase_cmd_seq
[5].address
+= bank
->base
;
504 erase_cmd_seq
[5].magic
= 0xC0;
506 erase_cmd_seq
[5].magic
= 0x30;
509 res
= xmc4xxx_write_command_sequence(bank
, erase_cmd_seq
,
510 ARRAY_SIZE(erase_cmd_seq
));
514 /* Read the flash status register */
515 res
= target_read_u32(bank
->target
, FLASH_REG_FLASH0_FSR
, &status
);
516 if (res
!= ERROR_OK
) {
517 LOG_ERROR("Cannot read flash status register.");
521 /* Check for a sequence error */
522 if (status
& FSR_SQER_MASK
) {
523 LOG_ERROR("Error with flash erase sequence");
527 /* Make sure a flash erase was triggered */
528 if (!(status
& FSR_ERASE_MASK
)) {
529 LOG_ERROR("Flash failed to erase");
533 /* Now we must wait for the erase operation to end */
534 res
= xmc4xxx_wait_status_busy(bank
, FLASH_OP_TIMEOUT
);
539 static int xmc4xxx_erase(struct flash_bank
*bank
, int first
, int last
)
541 struct xmc4xxx_flash_bank
*fb
= bank
->driver_priv
;
544 if (bank
->target
->state
!= TARGET_HALTED
) {
545 LOG_ERROR("Unable to erase, target is not halted");
546 return ERROR_TARGET_NOT_HALTED
;
550 res
= xmc4xxx_probe(bank
);
556 /* Loop through the sectors and erase each one */
557 for (int i
= first
; i
<= last
; i
++) {
558 res
= xmc4xxx_get_sector_start_addr(bank
, i
, &tmp_addr
);
559 if (res
!= ERROR_OK
) {
560 LOG_ERROR("Invalid sector %d", i
);
564 LOG_DEBUG("Erasing sector %d @ 0x%08"PRIx32
, i
, tmp_addr
);
566 res
= xmc4xxx_erase_sector(bank
, tmp_addr
, false);
567 if (res
!= ERROR_OK
) {
568 LOG_ERROR("Unable to write erase command sequence");
569 goto clear_status_and_exit
;
572 /* Now we must wait for the erase operation to end */
573 res
= xmc4xxx_wait_status_busy(bank
, FLASH_OP_TIMEOUT
);
576 goto clear_status_and_exit
;
578 bank
->sectors
[i
].is_erased
= 1;
581 clear_status_and_exit
:
582 res
= xmc4xxx_clear_flash_status(bank
);
587 static int xmc4xxx_enter_page_mode(struct flash_bank
*bank
)
592 res
= target_write_u32(bank
->target
, FLASH_CMD_ENTER_PAGEMODE
, 0x50);
593 if (res
!= ERROR_OK
) {
594 LOG_ERROR("Unable to write enter page mode command");
598 res
= xmc4xxx_get_flash_status(bank
, &status
);
603 /* Make sure we're in page mode */
604 if (!(status
& FSR_PFPAGE_MASK
)) {
605 LOG_ERROR("Unable to enter page mode");
609 /* Make sure we didn't encounter a sequence error */
610 if (status
& FSR_SQER_MASK
) {
611 LOG_ERROR("Sequence error while entering page mode");
618 /* The logical erase value of an xmc4xxx memory cell is 0x00,
619 * therefore, we cannot use the built in flash blank check and must
620 * implement our own */
622 /** Checks whether a memory region is zeroed. */
623 static int xmc4xxx_blank_check_memory(struct target
*target
,
624 uint32_t address
, uint32_t count
, uint32_t *blank
)
626 struct working_area
*erase_check_algorithm
;
627 struct reg_param reg_params
[3];
628 struct armv7m_algorithm armv7m_info
;
631 static const uint8_t erase_check_code
[] = {
632 #include "../../../contrib/loaders/erase_check/armv7m_0_erase_check.inc"
635 /* make sure we have a working area */
636 if (target_alloc_working_area(target
, sizeof(erase_check_code
),
637 &erase_check_algorithm
) != ERROR_OK
)
638 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
640 retval
= target_write_buffer(target
, erase_check_algorithm
->address
,
641 sizeof(erase_check_code
), (uint8_t *)erase_check_code
);
642 if (retval
!= ERROR_OK
)
645 armv7m_info
.common_magic
= ARMV7M_COMMON_MAGIC
;
646 armv7m_info
.core_mode
= ARM_MODE_THREAD
;
648 init_reg_param(®_params
[0], "r0", 32, PARAM_OUT
);
649 buf_set_u32(reg_params
[0].value
, 0, 32, address
);
651 init_reg_param(®_params
[1], "r1", 32, PARAM_OUT
);
652 buf_set_u32(reg_params
[1].value
, 0, 32, count
);
654 init_reg_param(®_params
[2], "r2", 32, PARAM_IN_OUT
);
655 buf_set_u32(reg_params
[2].value
, 0, 32, 0x00);
657 retval
= target_run_algorithm(target
,
662 erase_check_algorithm
->address
,
663 erase_check_algorithm
->address
+ (sizeof(erase_check_code
) - 2),
667 if (retval
== ERROR_OK
)
668 *blank
= buf_get_u32(reg_params
[2].value
, 0, 32);
670 destroy_reg_param(®_params
[0]);
671 destroy_reg_param(®_params
[1]);
672 destroy_reg_param(®_params
[2]);
674 target_free_working_area(target
, erase_check_algorithm
);
679 static int xmc4xxx_flash_blank_check(struct flash_bank
*bank
)
681 struct target
*target
= bank
->target
;
683 int retval
= ERROR_OK
;
686 if (bank
->target
->state
!= TARGET_HALTED
) {
687 LOG_ERROR("Target not halted");
688 return ERROR_TARGET_NOT_HALTED
;
691 for (i
= 0; i
< bank
->num_sectors
; i
++) {
692 uint32_t address
= bank
->base
+ bank
->sectors
[i
].offset
;
693 uint32_t size
= bank
->sectors
[i
].size
;
695 LOG_DEBUG("Erase checking 0x%08"PRIx32
, address
);
696 retval
= xmc4xxx_blank_check_memory(target
, address
, size
, &blank
);
698 if (retval
!= ERROR_OK
)
702 bank
->sectors
[i
].is_erased
= 1;
704 bank
->sectors
[i
].is_erased
= 0;
710 static int xmc4xxx_write_page(struct flash_bank
*bank
, const uint8_t *pg_buf
,
711 uint32_t offset
, bool user_config
)
716 /* Base of the flash write command */
717 struct xmc4xxx_command_seq write_cmd_seq
[4] = {
718 {FLASH_CMD_WRITE_PAGE_1
, 0xAA},
719 {FLASH_CMD_WRITE_PAGE_2
, 0x55},
720 {FLASH_CMD_WRITE_PAGE_3
, 0xFF}, /* Needs filled in */
721 {0xFF, 0xFF} /* Needs filled in */
724 /* The command sequence differs depending on whether this is
725 * being written to standard flash or the user configuration
728 write_cmd_seq
[2].magic
= 0xC0;
730 write_cmd_seq
[2].magic
= 0xA0;
732 /* Finally, we need to add the address that this page will be
734 write_cmd_seq
[3].address
= bank
->base
+ offset
;
735 write_cmd_seq
[3].magic
= 0xAA;
738 /* Flash pages are written 256 bytes at a time. For each 256
739 * byte chunk, we need to:
740 * 1. Enter page mode. This activates the flash write buffer
741 * 2. Load the page buffer with data (2x 32 bit words at a time)
742 * 3. Burn the page buffer into its intended location
743 * If the starting offset is not on a 256 byte boundary, we
744 * will need to pad the beginning of the write buffer
745 * accordingly. Likewise, if the last page does not fill the
746 * buffer, we should pad it to avoid leftover data from being
749 res
= xmc4xxx_enter_page_mode(bank
);
753 /* Copy the data into the page buffer*/
754 for (int i
= 0; i
< 256; i
+= 8) {
755 uint32_t w_lo
= target_buffer_get_u32(bank
->target
, &pg_buf
[i
]);
756 uint32_t w_hi
= target_buffer_get_u32(bank
->target
, &pg_buf
[i
+ 4]);
757 LOG_DEBUG("WLO: %08"PRIx32
, w_lo
);
758 LOG_DEBUG("WHI: %08"PRIx32
, w_hi
);
760 /* Data is loaded 2x 32 bit words at a time */
761 res
= target_write_u32(bank
->target
, FLASH_CMD_LOAD_PAGE_1
, w_lo
);
765 res
= target_write_u32(bank
->target
, FLASH_CMD_LOAD_PAGE_2
, w_hi
);
769 /* Check for an error */
770 res
= xmc4xxx_get_flash_status(bank
, &status
);
774 if (status
& FSR_SQER_MASK
) {
775 LOG_ERROR("Error loading page buffer");
780 /* The page buffer is now full, time to commit it to flash */
782 res
= xmc4xxx_write_command_sequence(bank
, write_cmd_seq
, ARRAY_SIZE(write_cmd_seq
));
783 if (res
!= ERROR_OK
) {
784 LOG_ERROR("Unable to enter write command sequence");
788 /* Read the flash status register */
789 res
= xmc4xxx_get_flash_status(bank
, &status
);
793 /* Check for a sequence error */
794 if (status
& FSR_SQER_MASK
) {
795 LOG_ERROR("Error with flash write sequence");
799 /* Make sure a flash write was triggered */
800 if (!(status
& FSR_PROG_MASK
)) {
801 LOG_ERROR("Failed to write flash page");
805 /* Wait for the write operation to end */
806 res
= xmc4xxx_wait_status_busy(bank
, FLASH_OP_TIMEOUT
);
810 /* TODO: Verify that page was written without error */
814 static int xmc4xxx_write(struct flash_bank
*bank
, const uint8_t *buffer
,
815 uint32_t offset
, uint32_t count
)
817 struct xmc4xxx_flash_bank
*fb
= bank
->driver_priv
;
820 if (bank
->target
->state
!= TARGET_HALTED
) {
821 LOG_ERROR("Unable to erase, target is not halted");
822 return ERROR_TARGET_NOT_HALTED
;
826 res
= xmc4xxx_probe(bank
);
831 /* Make sure we won't run off the end of the flash bank */
832 if ((offset
+ count
) > (bank
->size
)) {
833 LOG_ERROR("Attempting to write past the end of flash");
838 /* Attempt to write the passed in buffer to flash */
839 /* Pages are written 256 bytes at a time, we need to handle
840 * scenarios where padding is required at the beginning and
843 /* page working area */
844 uint8_t tmp_buf
[256] = {0};
846 /* Amount of data we'll be writing to this page */
850 remaining
= MIN(count
, sizeof(tmp_buf
));
851 end_pad
= sizeof(tmp_buf
) - remaining
;
853 /* Make sure we're starting on a page boundary */
854 int start_pad
= offset
% 256;
856 LOG_INFO("Write does not start on a 256 byte boundary. "
857 "Padding by %d bytes", start_pad
);
858 memset(tmp_buf
, 0xff, start_pad
);
859 /* Subtract the amount of start offset from
860 * the amount of data we'll need to write */
861 remaining
-= start_pad
;
864 /* Remove the amount we'll be writing from the total count */
867 /* Now copy in the remaining data */
868 memcpy(&tmp_buf
[start_pad
], buffer
, remaining
);
871 LOG_INFO("Padding end of page @%08"PRIx32
" by %d bytes",
872 bank
->base
+ offset
, end_pad
);
873 memset(&tmp_buf
[256 - end_pad
], 0xff, end_pad
);
876 /* Now commit this page to flash, if there was start
877 * padding, we should subtract that from the target offset */
878 res
= xmc4xxx_write_page(bank
, tmp_buf
, (offset
- start_pad
), false);
879 if (res
!= ERROR_OK
) {
880 LOG_ERROR("Unable to write flash page");
881 goto abort_write_and_exit
;
884 /* Advance the buffer pointer */
887 /* Advance the offset */
891 abort_write_and_exit
:
892 xmc4xxx_clear_flash_status(bank
);
897 static int xmc4xxx_get_info_command(struct flash_bank
*bank
, char *buf
, int buf_size
)
899 struct xmc4xxx_flash_bank
*fb
= bank
->driver_priv
;
902 if (bank
->target
->state
!= TARGET_HALTED
) {
903 LOG_WARNING("Cannot communicate... target not halted.");
904 return ERROR_TARGET_NOT_HALTED
;
907 /* The SCU registers contain the ID of the chip */
908 int res
= target_read_u32(bank
->target
, SCU_REG_BASE
+ SCU_ID_CHIP
, &scu_idcode
);
909 if (res
!= ERROR_OK
) {
910 LOG_ERROR("Cannot read device identification register.");
914 uint16_t dev_id
= (scu_idcode
& 0xfff0) >> 4;
915 uint16_t rev_id
= scu_idcode
& 0xf;
917 const char *rev_str
= NULL
;
957 /* XMC4500 EES AA13 with date codes before GE212
958 * had zero SCU_IDCHIP
960 dev_str
= "XMC4500 EES";
998 snprintf(buf
, buf_size
,
999 "Cannot identify target as an XMC4xxx. SCU_ID: %"PRIx32
"\n",
1004 /* String to declare protection data held in the private driver */
1005 char prot_str
[512] = {0};
1006 if (fb
->read_protected
)
1007 snprintf(prot_str
, sizeof(prot_str
), "\nFlash is read protected");
1009 bool otp_enabled
= false;
1010 for (int i
= 0; i
< bank
->num_sectors
; i
++)
1011 if (fb
->write_prot_otp
[i
])
1014 /* If OTP Write protection is enabled (User 2), list each
1015 * sector that has it enabled */
1018 strcat(prot_str
, "\nOTP Protection is enabled for sectors:\n");
1019 for (int i
= 0; i
< bank
->num_sectors
; i
++) {
1020 if (fb
->write_prot_otp
[i
]) {
1021 snprintf(otp_str
, sizeof(otp_str
), "- %d\n", i
);
1022 strncat(prot_str
, otp_str
, ARRAY_SIZE(otp_str
));
1027 if (rev_str
!= NULL
)
1028 snprintf(buf
, buf_size
, "%s - Rev: %s%s",
1029 dev_str
, rev_str
, prot_str
);
1031 snprintf(buf
, buf_size
, "%s - Rev: unknown (0x%01x)%s",
1032 dev_str
, rev_id
, prot_str
);
1037 static int xmc4xxx_temp_unprotect(struct flash_bank
*bank
, int user_level
)
1039 struct xmc4xxx_flash_bank
*fb
;
1041 uint32_t status
= 0;
1043 struct xmc4xxx_command_seq temp_unprot_seq
[6] = {
1044 {FLASH_CMD_TEMP_UNPROT_1
, 0xAA},
1045 {FLASH_CMD_TEMP_UNPROT_2
, 0x55},
1046 {FLASH_CMD_TEMP_UNPROT_3
, 0xFF}, /* Needs filled in */
1047 {FLASH_CMD_TEMP_UNPROT_4
, 0xFF}, /* Needs filled in */
1048 {FLASH_CMD_TEMP_UNPROT_5
, 0xFF}, /* Needs filled in */
1049 {FLASH_CMD_TEMP_UNPROT_6
, 0x05}
1052 if (user_level
< 0 || user_level
> 2) {
1053 LOG_ERROR("Invalid user level, must be 0-2");
1057 fb
= bank
->driver_priv
;
1059 /* Fill in the user level and passwords */
1060 temp_unprot_seq
[2].magic
= user_level
;
1061 temp_unprot_seq
[3].magic
= fb
->pw1
;
1062 temp_unprot_seq
[4].magic
= fb
->pw2
;
1064 res
= xmc4xxx_write_command_sequence(bank
, temp_unprot_seq
,
1065 ARRAY_SIZE(temp_unprot_seq
));
1066 if (res
!= ERROR_OK
) {
1067 LOG_ERROR("Unable to write temp unprotect sequence");
1071 res
= xmc4xxx_get_flash_status(bank
, &status
);
1072 if (res
!= ERROR_OK
)
1075 if (status
& FSR_WPRODIS0
) {
1076 LOG_INFO("Flash is temporarily unprotected");
1078 LOG_INFO("Unable to disable flash protection");
1086 static int xmc4xxx_flash_unprotect(struct flash_bank
*bank
, int32_t level
)
1091 if ((level
< 0) || (level
> 1)) {
1092 LOG_ERROR("Invalid user level. Must be 0-1");
1105 res
= xmc4xxx_erase_sector(bank
, addr
, true);
1107 if (res
!= ERROR_OK
)
1108 LOG_ERROR("Error erasing user configuration block");
1113 /* Reference: "XMC4500 Flash Protection.pptx" app note */
1114 static int xmc4xxx_flash_protect(struct flash_bank
*bank
, int level
, bool read_protect
,
1115 int first
, int last
)
1117 /* User configuration block buffers */
1118 uint8_t ucp0_buf
[8 * sizeof(uint32_t)] = {0};
1119 uint32_t ucb_base
= 0;
1120 uint32_t procon
= 0;
1122 uint32_t status
= 0;
1125 struct xmc4xxx_flash_bank
*fb
= bank
->driver_priv
;
1127 /* Read protect only works for user 0, make sure we don't try
1128 * to do something silly */
1129 if (level
!= 0 && read_protect
) {
1130 LOG_ERROR("Read protection is for user level 0 only!");
1134 /* Check to see if protection is already installed for the
1135 * specified user level. If it is, the user configuration
1136 * block will need to be erased before we can continue */
1138 /* Grab the flash status register*/
1139 res
= xmc4xxx_get_flash_status(bank
, &status
);
1140 if (res
!= ERROR_OK
)
1145 if ((status
& FSR_RPROIN_MASK
) || (status
& FSR_WPROIN0_MASK
))
1149 if (status
& FSR_WPROIN1_MASK
)
1153 if (status
& FSR_WPROIN2_MASK
)
1159 LOG_ERROR("Flash protection is installed for user %d"
1160 " and must be removed before continuing", level
);
1164 /* If this device has 12 flash sectors, protection for
1165 * sectors 10 & 11 are handled jointly. If we are trying to
1166 * write all sectors, we should decrement
1167 * last to ensure we don't write to a register bit that
1169 if ((bank
->num_sectors
== 12) && (last
== 12))
1172 /* We need to fill out the procon register representation
1173 * that we will be writing to the device */
1174 for (int i
= first
; i
<= last
; i
++)
1177 /* If read protection is requested, set the appropriate bit
1178 * (we checked that this is allowed above) */
1180 procon
|= PROCON_RPRO_MASK
;
1182 LOG_DEBUG("Setting flash protection with procon:");
1183 LOG_DEBUG("PROCON: %"PRIx32
, procon
);
1185 /* First we need to copy in the procon register to the buffer
1186 * we're going to attempt to write. This is written twice */
1187 target_buffer_set_u32(bank
->target
, &ucp0_buf
[0 * 4], procon
);
1188 target_buffer_set_u32(bank
->target
, &ucp0_buf
[2 * 4], procon
);
1190 /* Now we must copy in both flash passwords. As with the
1191 * procon data, this must be written twice (4 total words
1193 target_buffer_set_u32(bank
->target
, &ucp0_buf
[4 * 4], fb
->pw1
);
1194 target_buffer_set_u32(bank
->target
, &ucp0_buf
[5 * 4], fb
->pw2
);
1195 target_buffer_set_u32(bank
->target
, &ucp0_buf
[6 * 4], fb
->pw1
);
1196 target_buffer_set_u32(bank
->target
, &ucp0_buf
[7 * 4], fb
->pw2
);
1198 /* Finally, (if requested) we copy in the confirmation
1199 * code so that the protection is permanent and will
1200 * require a password to undo. */
1201 target_buffer_set_u32(bank
->target
, &ucp0_buf
[0 * 4], FLASH_PROTECT_CONFIRMATION_CODE
);
1202 target_buffer_set_u32(bank
->target
, &ucp0_buf
[2 * 4], FLASH_PROTECT_CONFIRMATION_CODE
);
1204 /* Now that the data is copied into place, we must write
1205 * these pages into flash */
1207 /* The user configuration block base depends on what level of
1208 * protection we're trying to install, select the proper one */
1211 ucb_base
= UCB0_BASE
;
1214 ucb_base
= UCB1_BASE
;
1217 ucb_base
= UCB2_BASE
;
1221 /* Write the user config pages */
1222 res
= xmc4xxx_write_page(bank
, ucp0_buf
, ucb_base
, true);
1223 if (res
!= ERROR_OK
) {
1224 LOG_ERROR("Error writing user configuration block 0");
1231 static int xmc4xxx_protect(struct flash_bank
*bank
, int set
, int first
, int last
)
1234 struct xmc4xxx_flash_bank
*fb
= bank
->driver_priv
;
1236 /* Check for flash passwords */
1238 LOG_ERROR("Flash passwords not set, use xmc4xxx flash_password to set them");
1242 /* We want to clear flash protection temporarily*/
1244 LOG_WARNING("Flash protection will be temporarily disabled"
1245 " for all pages (User 0 only)!");
1246 ret
= xmc4xxx_temp_unprotect(bank
, 0);
1250 /* Install write protection for user 0 on the specified pages */
1251 ret
= xmc4xxx_flash_protect(bank
, 0, false, first
, last
);
1256 static int xmc4xxx_protect_check(struct flash_bank
*bank
)
1259 uint32_t protection
[3] = {0};
1260 struct xmc4xxx_flash_bank
*fb
= bank
->driver_priv
;
1262 ret
= target_read_u32(bank
->target
, FLASH_REG_FLASH0_PROCON0
, &protection
[0]);
1263 if (ret
!= ERROR_OK
) {
1264 LOG_ERROR("Unable to read flash User0 protection register");
1268 ret
= target_read_u32(bank
->target
, FLASH_REG_FLASH0_PROCON1
, &protection
[1]);
1269 if (ret
!= ERROR_OK
) {
1270 LOG_ERROR("Unable to read flash User1 protection register");
1274 ret
= target_read_u32(bank
->target
, FLASH_REG_FLASH0_PROCON2
, &protection
[2]);
1275 if (ret
!= ERROR_OK
) {
1276 LOG_ERROR("Unable to read flash User2 protection register");
1280 int sectors
= bank
->num_sectors
;
1282 /* On devices with 12 sectors, sectors 10 & 11 are ptected
1283 * together instead of individually */
1287 /* Clear the protection status */
1288 for (int i
= 0; i
< bank
->num_sectors
; i
++) {
1289 bank
->sectors
[i
].is_protected
= 0;
1290 fb
->write_prot_otp
[i
] = false;
1292 fb
->read_protected
= false;
1294 /* The xmc4xxx series supports 3 levels of user protection
1295 * (User0, User1 (low priority), and User 2(OTP), we need to
1297 for (unsigned int i
= 0; i
< ARRAY_SIZE(protection
); i
++) {
1299 /* Check for write protection on every available
1301 for (int j
= 0; j
< sectors
; j
++) {
1302 int set
= (protection
[i
] & (1 << j
)) ? 1 : 0;
1303 bank
->sectors
[j
].is_protected
|= set
;
1305 /* Handle sector 11 */
1307 bank
->sectors
[j
+ 1].is_protected
|= set
;
1309 /* User 2 indicates this protection is
1310 * permanent, make note in the private driver structure */
1311 if (i
== 2 && set
) {
1312 fb
->write_prot_otp
[j
] = true;
1314 /* Handle sector 11 */
1316 fb
->write_prot_otp
[j
+ 1] = true;
1322 /* XMC4xxx also supports read proptection, make a note
1323 * in the private driver structure */
1324 if (protection
[0] & PROCON_RPRO_MASK
)
1325 fb
->read_protected
= true;
1330 FLASH_BANK_COMMAND_HANDLER(xmc4xxx_flash_bank_command
)
1332 bank
->driver_priv
= malloc(sizeof(struct xmc4xxx_flash_bank
));
1334 if (!bank
->driver_priv
)
1335 return ERROR_FLASH_OPERATION_FAILED
;
1337 (void)memset(bank
->driver_priv
, 0, sizeof(struct xmc4xxx_flash_bank
));
1342 COMMAND_HANDLER(xmc4xxx_handle_flash_password_command
)
1345 struct flash_bank
*bank
;
1348 return ERROR_COMMAND_SYNTAX_ERROR
;
1350 res
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &bank
);
1351 if (res
!= ERROR_OK
)
1354 struct xmc4xxx_flash_bank
*fb
= bank
->driver_priv
;
1358 /* We skip over the flash bank */
1359 fb
->pw1
= strtol(CMD_ARGV
[1], NULL
, 16);
1362 return ERROR_COMMAND_SYNTAX_ERROR
;
1364 fb
->pw2
= strtol(CMD_ARGV
[2], NULL
, 16);
1367 return ERROR_COMMAND_SYNTAX_ERROR
;
1371 command_print(CMD_CTX
, "XMC4xxx flash passwords set to:\n");
1372 command_print(CMD_CTX
, "-0x%08"PRIx32
"\n", fb
->pw1
);
1373 command_print(CMD_CTX
, "-0x%08"PRIx32
"\n", fb
->pw2
);
1377 COMMAND_HANDLER(xmc4xxx_handle_flash_unprotect_command
)
1379 struct flash_bank
*bank
;
1384 return ERROR_COMMAND_SYNTAX_ERROR
;
1386 res
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &bank
);
1387 if (res
!= ERROR_OK
)
1390 COMMAND_PARSE_NUMBER(s32
, CMD_ARGV
[1], level
);
1392 res
= xmc4xxx_flash_unprotect(bank
, level
);
1397 static const struct command_registration xmc4xxx_exec_command_handlers
[] = {
1399 .name
= "flash_password",
1400 .handler
= xmc4xxx_handle_flash_password_command
,
1401 .mode
= COMMAND_EXEC
,
1402 .usage
= "bank_id password1 password2",
1403 .help
= "Set the flash passwords used for protect operations. "
1404 "Passwords should be in standard hex form (0x00000000). "
1405 "(You must call this before any other protect commands) "
1406 "NOTE: The xmc4xxx's UCB area only allows for FOUR cycles. "
1407 "Please use protection carefully!",
1410 .name
= "flash_unprotect",
1411 .handler
= xmc4xxx_handle_flash_unprotect_command
,
1412 .mode
= COMMAND_EXEC
,
1413 .usage
= "bank_id user_level[0-1]",
1414 .help
= "Permanently Removes flash protection (read and write) "
1415 "for the specified user level",
1416 }, COMMAND_REGISTRATION_DONE
1419 static const struct command_registration xmc4xxx_command_handlers
[] = {
1422 .mode
= COMMAND_ANY
,
1423 .help
= "xmc4xxx flash command group",
1425 .chain
= xmc4xxx_exec_command_handlers
,
1427 COMMAND_REGISTRATION_DONE
1430 struct flash_driver xmc4xxx_flash
= {
1432 .commands
= xmc4xxx_command_handlers
,
1433 .flash_bank_command
= xmc4xxx_flash_bank_command
,
1434 .erase
= xmc4xxx_erase
,
1435 .write
= xmc4xxx_write
,
1436 .read
= default_flash_read
,
1437 .probe
= xmc4xxx_probe
,
1438 .auto_probe
= xmc4xxx_probe
,
1439 .erase_check
= xmc4xxx_flash_blank_check
,
1440 .info
= xmc4xxx_get_info_command
,
1441 .protect_check
= xmc4xxx_protect_check
,
1442 .protect
= xmc4xxx_protect
,
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)