1 /***************************************************************************
3 * Copyright (C) 2018 by Bohdan Tymkiv *
4 * bohdan.tymkiv@cypress.com bohdan200@gmail.com *
6 * This program is free software; you can redistribute it and/or modify *
7 * it under the terms of the GNU General Public License as published by *
8 * the Free Software Foundation; either version 2 of the License, or *
9 * (at your option) any later version. *
11 * This program is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
14 * GNU General Public License for more details. *
16 * You should have received a copy of the GNU General Public License *
17 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
18 ***************************************************************************/
27 #include "helper/time_support.h"
28 #include "target/arm_adi_v5.h"
29 #include "target/target.h"
30 #include "target/cortex_m.h"
31 #include "target/breakpoints.h"
32 #include "target/target_type.h"
33 #include "target/algorithm.h"
35 /**************************************************************************************************
36 * PSoC6 device definitions
37 *************************************************************************************************/
38 #define MFLASH_SECTOR_SIZE (256u * 1024u)
39 #define WFLASH_SECTOR_SIZE (32u * 1024u)
41 #define MEM_BASE_MFLASH 0x10000000u
42 #define MEM_BASE_WFLASH 0x14000000u
43 #define MEM_WFLASH_SIZE 32768u
44 #define MEM_BASE_SFLASH 0x16000000u
45 #define RAM_STACK_WA_SIZE 2048u
46 #define PSOC6_SPCIF_GEOMETRY 0x4025F00Cu
48 #define PROTECTION_UNKNOWN 0x00u
49 #define PROTECTION_VIRGIN 0x01u
50 #define PROTECTION_NORMAL 0x02u
51 #define PROTECTION_SECURE 0x03u
52 #define PROTECTION_DEAD 0x04u
54 #define MEM_BASE_IPC 0x40230000u
55 #define IPC_STRUCT_SIZE 0x20u
56 #define MEM_IPC(n) (MEM_BASE_IPC + (n) * IPC_STRUCT_SIZE)
57 #define MEM_IPC_ACQUIRE(n) (MEM_IPC(n) + 0x00u)
58 #define MEM_IPC_NOTIFY(n) (MEM_IPC(n) + 0x08u)
59 #define MEM_IPC_DATA(n) (MEM_IPC(n) + 0x0Cu)
60 #define MEM_IPC_LOCK_STATUS(n) (MEM_IPC(n) + 0x10u)
62 #define MEM_BASE_IPC_INTR 0x40231000u
63 #define IPC_INTR_STRUCT_SIZE 0x20u
64 #define MEM_IPC_INTR(n) (MEM_BASE_IPC_INTR + (n) * IPC_INTR_STRUCT_SIZE)
65 #define MEM_IPC_INTR_MASK(n) (MEM_IPC_INTR(n) + 0x08u)
66 #define IPC_ACQUIRE_SUCCESS_MSK 0x80000000u
67 #define IPC_LOCK_ACQUIRED_MSK 0x80000000u
70 #define IPC_INTR_ID 0u
71 #define IPC_TIMEOUT_MS 1000
73 #define SROMAPI_SIID_REQ 0x00000001u
74 #define SROMAPI_SIID_REQ_FAMILY_REVISION (SROMAPI_SIID_REQ | 0x000u)
75 #define SROMAPI_SIID_REQ_SIID_PROTECTION (SROMAPI_SIID_REQ | 0x100u)
76 #define SROMAPI_WRITEROW_REQ 0x05000100u
77 #define SROMAPI_PROGRAMROW_REQ 0x06000100u
78 #define SROMAPI_ERASESECTOR_REQ 0x14000100u
79 #define SROMAPI_ERASEALL_REQ 0x0A000100u
80 #define SROMAPI_ERASEROW_REQ 0x1C000100u
82 #define SROMAPI_STATUS_MSK 0xF0000000u
83 #define SROMAPI_STAT_SUCCESS 0xA0000000u
84 #define SROMAPI_DATA_LOCATION_MSK 0x00000001u
85 #define SROMAPI_CALL_TIMEOUT_MS 1500
87 struct psoc6_target_info
{
90 uint32_t main_flash_sz
;
105 static const struct row_region safe_sflash_regions
[] = {
106 {0x16000800, 0x800}, /* SFLASH: User Data */
107 {0x16001A00, 0x200}, /* SFLASH: NAR */
108 {0x16005A00, 0xC00}, /* SFLASH: Public Key */
109 {0x16007C00, 0x400}, /* SFLASH: TOC2 */
112 #define SFLASH_NUM_REGIONS ARRAY_SIZE(safe_sflash_regions)
114 static struct working_area
*g_stack_area
;
115 static struct armv7m_algorithm g_armv7m_info
;
117 /** ***********************************************************************************************
118 * @brief Initializes `struct timeout` structure with given timeout value
119 * @param to pointer to `struct timeout` structure
120 * @param timeout_ms timeout, in milliseconds
121 *************************************************************************************************/
122 static void timeout_init(struct timeout
*to
, long timeout_ms
)
124 to
->start_time
= timeval_ms();
125 to
->timeout_ms
= timeout_ms
;
128 /** ***********************************************************************************************
129 * @brief Returns true if given `struct timeout` structure has expired
130 * @param to pointer to `struct timeout` structure
131 * @return true if timeout expired
132 *************************************************************************************************/
133 static bool timeout_expired(struct timeout
*to
)
135 return (timeval_ms() - to
->start_time
) > to
->timeout_ms
;
138 /** ***********************************************************************************************
139 * @brief Starts pseudo flash algorithm and leaves it running. Function allocates working area for
140 * algorithm code and CPU stack, adjusts stack pointer, uploads and starts the algorithm.
141 * Algorithm (a basic infinite loop) runs asynchronously while driver performs Flash operations.
143 * @param target target for the algorithm
144 * @return ERROR_OK in case of success, ERROR_XXX code otherwise
145 *************************************************************************************************/
146 static int sromalgo_prepare(struct target
*target
)
150 /* Initialize Vector Table Offset register (in case FW modified it) */
151 hr
= target_write_u32(target
, 0xE000ED08, 0x00000000);
155 /* Allocate Working Area for Stack and Flash algorithm */
156 hr
= target_alloc_working_area(target
, RAM_STACK_WA_SIZE
, &g_stack_area
);
160 g_armv7m_info
.common_magic
= ARMV7M_COMMON_MAGIC
;
161 g_armv7m_info
.core_mode
= ARM_MODE_THREAD
;
163 struct reg_param reg_params
;
164 init_reg_param(®_params
, "sp", 32, PARAM_OUT
);
165 buf_set_u32(reg_params
.value
, 0, 32, g_stack_area
->address
+ g_stack_area
->size
);
167 /* Write basic infinite loop algorithm to target RAM */
168 hr
= target_write_u32(target
, g_stack_area
->address
, 0xFEE7FEE7);
170 goto destroy_rp_free_wa
;
172 hr
= target_start_algorithm(target
, 0, NULL
, 1, ®_params
, g_stack_area
->address
,
175 goto destroy_rp_free_wa
;
177 destroy_reg_param(®_params
);
182 /* Something went wrong, do some cleanup */
183 destroy_reg_param(®_params
);
186 target_free_working_area(target
, g_stack_area
);
193 /** ***********************************************************************************************
194 * @brief Stops running flash algorithm and releases associated resources.
195 * This function is also used for cleanup in case of errors so g_stack_area may be NULL.
196 * These cases have to be handled gracefully.
198 * @param target current target
199 *************************************************************************************************/
200 static void sromalgo_release(struct target
*target
)
205 /* Stop flash algorithm if it is running */
206 if (target
->running_alg
) {
207 hr
= target_halt(target
);
211 hr
= target_wait_algorithm(target
, 0, NULL
, 0, NULL
, 0,
212 IPC_TIMEOUT_MS
, &g_armv7m_info
);
218 /* Free Stack/Flash algorithm working area */
219 target_free_working_area(target
, g_stack_area
);
224 /** ***********************************************************************************************
225 * @brief Waits for expected IPC lock status. PSoC6 uses IPC structures for inter-core
226 * communication. Same IPCs are used to invoke SROM API. IPC structure must be locked prior to
227 * invoking any SROM API. This ensures nothing else in the system will use same IPC thus corrupting
228 * our data. Locking is performed by ipc_acquire(), this function ensures that IPC is actually
231 * @param target current target
232 * @param ipc_id IPC index to poll. IPC #2 is dedicated for DAP access
233 * @param lock_expected expected lock status
234 * @return ERROR_OK in case of success, ERROR_XXX code otherwise
235 *************************************************************************************************/
236 static int ipc_poll_lock_stat(struct target
*target
, uint32_t ipc_id
, bool lock_expected
)
242 timeout_init(&to
, IPC_TIMEOUT_MS
);
244 while (!timeout_expired(&to
)) {
245 /* Process any server requests */
248 /* Read IPC Lock status */
249 hr
= target_read_u32(target
, MEM_IPC_LOCK_STATUS(ipc_id
), ®_val
);
250 if (hr
!= ERROR_OK
) {
251 LOG_ERROR("Unable to read IPC Lock Status register");
255 bool is_locked
= (reg_val
& IPC_LOCK_ACQUIRED_MSK
) != 0;
257 if (lock_expected
== is_locked
)
261 if (target
->coreid
) {
262 LOG_WARNING("SROM API calls via CM4 target are supported on single-core PSoC6 devices only. "
263 "Please perform all Flash-related operations via CM0+ target on dual-core devices.");
266 LOG_ERROR("Timeout polling IPC Lock Status");
267 return ERROR_TARGET_TIMEOUT
;
270 /** ***********************************************************************************************
271 * @brief Acquires IPC structure. PSoC6 uses IPC structures for inter-core communication.
272 * Same IPCs are used to invoke SROM API. IPC structure must be locked prior to invoking any SROM API.
273 * This ensures nothing else in the system will use same IPC thus corrupting our data.
274 * This function locks the IPC.
276 * @param target current target
277 * @param ipc_id ipc_id IPC index to acquire. IPC #2 is dedicated for DAP access
278 * @return ERROR_OK in case of success, ERROR_XXX code otherwise
279 *************************************************************************************************/
280 static int ipc_acquire(struct target
*target
, char ipc_id
)
283 bool is_acquired
= false;
287 timeout_init(&to
, IPC_TIMEOUT_MS
);
289 while (!timeout_expired(&to
)) {
292 hr
= target_write_u32(target
, MEM_IPC_ACQUIRE(ipc_id
), IPC_ACQUIRE_SUCCESS_MSK
);
293 if (hr
!= ERROR_OK
) {
294 LOG_ERROR("Unable to write to IPC Acquire register");
298 /* Check if data is written on first step */
299 hr
= target_read_u32(target
, MEM_IPC_ACQUIRE(ipc_id
), ®_val
);
300 if (hr
!= ERROR_OK
) {
301 LOG_ERROR("Unable to read IPC Acquire register");
305 is_acquired
= (reg_val
& IPC_ACQUIRE_SUCCESS_MSK
) != 0;
307 /* If IPC structure is acquired, the lock status should be set */
308 hr
= ipc_poll_lock_stat(target
, ipc_id
, true);
314 LOG_ERROR("Timeout acquiring IPC structure");
319 /** ***********************************************************************************************
320 * @brief Invokes SROM API functions which are responsible for Flash operations
322 * @param target current target
323 * @param req_and_params request id of the function to invoke
324 * @param working_area address of memory buffer in target's memory space for SROM API parameters
325 * @param data_out pointer to variable which will be populated with execution status
326 * @return ERROR_OK in case of success, ERROR_XXX code otherwise
327 *************************************************************************************************/
328 static int call_sromapi(struct target
*target
,
329 uint32_t req_and_params
,
330 uint32_t working_area
,
335 bool is_data_in_ram
= (req_and_params
& SROMAPI_DATA_LOCATION_MSK
) == 0;
337 hr
= ipc_acquire(target
, IPC_ID
);
342 hr
= target_write_u32(target
, MEM_IPC_DATA(IPC_ID
), working_area
);
344 hr
= target_write_u32(target
, MEM_IPC_DATA(IPC_ID
), req_and_params
);
349 /* Enable notification interrupt of IPC_INTR_STRUCT0(CM0+) for IPC_STRUCT2 */
350 hr
= target_write_u32(target
, MEM_IPC_INTR_MASK(IPC_INTR_ID
), 1u << (16 + IPC_ID
));
354 hr
= target_write_u32(target
, MEM_IPC_NOTIFY(IPC_ID
), 1);
358 /* Poll lock status */
359 hr
= ipc_poll_lock_stat(target
, IPC_ID
, false);
365 hr
= target_read_u32(target
, working_area
, data_out
);
367 hr
= target_read_u32(target
, MEM_IPC_DATA(IPC_ID
), data_out
);
369 if (hr
!= ERROR_OK
) {
370 LOG_ERROR("Error reading SROM API Status location");
374 bool is_success
= (*data_out
& SROMAPI_STATUS_MSK
) == SROMAPI_STAT_SUCCESS
;
376 LOG_ERROR("SROM API execution failed. Status: 0x%08" PRIX32
, *data_out
);
377 return ERROR_TARGET_FAILURE
;
383 /** ***********************************************************************************************
384 * @brief Retrieves SiliconID and Protection status of the target device
385 * @param target current target
386 * @param si_id pointer to variable, will be populated with SiliconID
387 * @param protection pointer to variable, will be populated with protection status
388 * @return ERROR_OK in case of success, ERROR_XXX code otherwise
389 *************************************************************************************************/
390 static int get_silicon_id(struct target
*target
, uint32_t *si_id
, uint8_t *protection
)
393 uint32_t family_rev
, siid_prot
;
395 hr
= sromalgo_prepare(target
);
399 /* Read FamilyID and Revision */
400 hr
= call_sromapi(target
, SROMAPI_SIID_REQ_FAMILY_REVISION
, 0, &family_rev
);
404 /* Read SiliconID and Protection */
405 hr
= call_sromapi(target
, SROMAPI_SIID_REQ_SIID_PROTECTION
, 0, &siid_prot
);
409 *si_id
= (siid_prot
& 0x0000FFFF) << 16;
410 *si_id
|= (family_rev
& 0x00FF0000) >> 8;
411 *si_id
|= (family_rev
& 0x000000FF) >> 0;
413 *protection
= (siid_prot
& 0x000F0000) >> 0x10;
416 sromalgo_release(target
);
420 /** ***********************************************************************************************
421 * @brief Translates Protection status to openocd-friendly boolean value
422 * @param bank current flash bank
423 * @return ERROR_OK in case of success, ERROR_XXX code otherwise
424 *************************************************************************************************/
425 static int psoc6_protect_check(struct flash_bank
*bank
)
429 struct psoc6_target_info
*psoc6_info
= bank
->driver_priv
;
430 int hr
= get_silicon_id(bank
->target
, &psoc6_info
->silicon_id
, &psoc6_info
->protection
);
434 switch (psoc6_info
->protection
) {
435 case PROTECTION_VIRGIN
:
436 case PROTECTION_NORMAL
:
440 case PROTECTION_UNKNOWN
:
441 case PROTECTION_SECURE
:
442 case PROTECTION_DEAD
:
448 for (unsigned int i
= 0; i
< bank
->num_sectors
; i
++)
449 bank
->sectors
[i
].is_protected
= is_protected
;
454 /** ***********************************************************************************************
455 * @brief Dummy function, Life Cycle transition is not currently supported
456 * @return ERROR_OK always
457 *************************************************************************************************/
458 static int psoc6_protect(struct flash_bank
*bank
, int set
, unsigned int first
,
466 LOG_WARNING("Life Cycle transition for PSoC6 is not supported");
470 /** ***********************************************************************************************
471 * @brief Translates Protection status to string
472 * @param protection protection value
473 * @return pointer to const string describing protection status
474 *************************************************************************************************/
475 static const char *protection_to_str(uint8_t protection
)
477 switch (protection
) {
478 case PROTECTION_VIRGIN
:
480 case PROTECTION_NORMAL
:
482 case PROTECTION_SECURE
:
484 case PROTECTION_DEAD
:
486 case PROTECTION_UNKNOWN
:
492 /** ***********************************************************************************************
493 * @brief psoc6_get_info Displays human-readable information about acquired device
494 * @param bank current flash bank
495 * @param cmd pointer to command invocation instance
496 * @return ERROR_OK in case of success, ERROR_XXX code otherwise
497 *************************************************************************************************/
498 static int psoc6_get_info(struct flash_bank
*bank
, struct command_invocation
*cmd
)
500 struct psoc6_target_info
*psoc6_info
= bank
->driver_priv
;
502 if (psoc6_info
->is_probed
== false)
505 int hr
= get_silicon_id(bank
->target
, &psoc6_info
->silicon_id
, &psoc6_info
->protection
);
509 command_print_sameline(cmd
,
510 "PSoC6 Silicon ID: 0x%08" PRIX32
"\n"
512 "Main Flash size: %" PRIu32
" kB\n"
513 "Work Flash size: 32 kB\n",
514 psoc6_info
->silicon_id
,
515 protection_to_str(psoc6_info
->protection
),
516 psoc6_info
->main_flash_sz
/ 1024);
521 /** ***********************************************************************************************
522 * @brief Checks if given flash bank belongs to Supervisory Flash
523 * @param bank current flash bank
524 * @return true if flash bank belongs to Supervisory Flash
525 *************************************************************************************************/
526 static bool is_sflash_bank(struct flash_bank
*bank
)
528 for (size_t i
= 0; i
< SFLASH_NUM_REGIONS
; i
++) {
529 if (bank
->base
== safe_sflash_regions
[i
].addr
)
536 /** ***********************************************************************************************
537 * @brief Checks if given flash bank belongs to Work Flash
538 * @param bank current flash bank
539 * @return true if flash bank belongs to Work Flash
540 *************************************************************************************************/
541 static inline bool is_wflash_bank(struct flash_bank
*bank
)
543 return (bank
->base
== MEM_BASE_WFLASH
);
546 /** ***********************************************************************************************
547 * @brief Checks if given flash bank belongs to Main Flash
548 * @param bank current flash bank
549 * @return true if flash bank belongs to Main Flash
550 *************************************************************************************************/
551 static inline bool is_mflash_bank(struct flash_bank
*bank
)
553 return (bank
->base
== MEM_BASE_MFLASH
);
556 /** ***********************************************************************************************
557 * @brief Probes the device and populates related data structures with target flash geometry data.
558 * This is done in non-intrusive way, no SROM API calls are involved so GDB can safely attach to a
559 * running target. Function assumes that size of Work Flash is 32kB (true for all current part numbers)
561 * @param bank current flash bank
562 * @return ERROR_OK in case of success, ERROR_XXX code otherwise
563 *************************************************************************************************/
564 static int psoc6_probe(struct flash_bank
*bank
)
566 struct target
*target
= bank
->target
;
567 struct psoc6_target_info
*psoc6_info
= bank
->driver_priv
;
571 /* Retrieve data from SPCIF_GEOMETRY */
573 target_read_u32(target
, PSOC6_SPCIF_GEOMETRY
, &geom
);
574 uint32_t row_sz_lg2
= (geom
& 0xF0) >> 4;
575 uint32_t row_sz
= (0x01 << row_sz_lg2
);
576 uint32_t row_cnt
= 1 + ((geom
& 0x00FFFF00) >> 8);
577 uint32_t bank_cnt
= 1 + ((geom
& 0xFF000000) >> 24);
579 /* Calculate size of Main Flash*/
580 uint32_t flash_sz_bytes
= bank_cnt
* row_cnt
* row_sz
;
583 bank
->sectors
= NULL
;
585 size_t bank_size
= 0;
587 if (is_mflash_bank(bank
))
588 bank_size
= flash_sz_bytes
;
589 else if (is_wflash_bank(bank
))
590 bank_size
= MEM_WFLASH_SIZE
;
591 else if (is_sflash_bank(bank
)) {
592 for (size_t i
= 0; i
< SFLASH_NUM_REGIONS
; i
++) {
593 if (safe_sflash_regions
[i
].addr
== bank
->base
) {
594 bank_size
= safe_sflash_regions
[i
].size
;
600 if (bank_size
== 0) {
601 LOG_ERROR("Invalid Flash Bank base address in config file");
602 return ERROR_FLASH_BANK_INVALID
;
605 unsigned int num_sectors
= bank_size
/ row_sz
;
606 bank
->size
= bank_size
;
607 bank
->chip_width
= 4;
609 bank
->erased_value
= 0;
610 bank
->default_padded_value
= 0;
612 bank
->num_sectors
= num_sectors
;
613 bank
->sectors
= calloc(num_sectors
, sizeof(struct flash_sector
));
614 for (unsigned int i
= 0; i
< num_sectors
; i
++) {
615 bank
->sectors
[i
].size
= row_sz
;
616 bank
->sectors
[i
].offset
= i
* row_sz
;
617 bank
->sectors
[i
].is_erased
= -1;
618 bank
->sectors
[i
].is_protected
= -1;
621 psoc6_info
->is_probed
= true;
622 psoc6_info
->main_flash_sz
= flash_sz_bytes
;
623 psoc6_info
->row_sz
= row_sz
;
628 /** ***********************************************************************************************
629 * @brief Probes target device only if it hasn't been probed yet
630 * @param bank current flash bank
631 * @return ERROR_OK in case of success, ERROR_XXX code otherwise
632 *************************************************************************************************/
633 static int psoc6_auto_probe(struct flash_bank
*bank
)
635 struct psoc6_target_info
*psoc6_info
= bank
->driver_priv
;
638 if (psoc6_info
->is_probed
)
641 hr
= psoc6_probe(bank
);
646 /** ***********************************************************************************************
647 * @brief Erases single sector (256k) on target device
648 * @param bank current flash bank
649 * @param wa working area for SROM API parameters
650 * @param addr starting address of the sector
651 * @return ERROR_OK in case of success, ERROR_XXX code otherwise
652 *************************************************************************************************/
653 static int psoc6_erase_sector(struct flash_bank
*bank
, struct working_area
*wa
, uint32_t addr
)
655 struct target
*target
= bank
->target
;
657 LOG_DEBUG("Erasing SECTOR @%08" PRIX32
, addr
);
659 int hr
= target_write_u32(target
, wa
->address
, SROMAPI_ERASESECTOR_REQ
);
663 hr
= target_write_u32(target
, wa
->address
+ 0x04, addr
);
668 hr
= call_sromapi(target
, SROMAPI_ERASESECTOR_REQ
, wa
->address
, &data_out
);
670 LOG_ERROR("SECTOR @%08" PRIX32
" not erased!", addr
);
675 /** ***********************************************************************************************
676 * @brief Erases single row (512b) on target device
677 * @param bank current flash bank
678 * @param wa working area for SROM API parameters
679 * @param addr starting address of the flash row
680 * @return ERROR_OK in case of success, ERROR_XXX code otherwise
681 *************************************************************************************************/
682 static int psoc6_erase_row(struct flash_bank
*bank
, struct working_area
*wa
, uint32_t addr
)
684 struct target
*target
= bank
->target
;
686 LOG_DEBUG("Erasing ROW @%08" PRIX32
, addr
);
688 int hr
= target_write_u32(target
, wa
->address
, SROMAPI_ERASEROW_REQ
);
692 hr
= target_write_u32(target
, wa
->address
+ 0x04, addr
);
697 hr
= call_sromapi(target
, SROMAPI_ERASEROW_REQ
, wa
->address
, &data_out
);
699 LOG_ERROR("ROW @%08" PRIX32
" not erased!", addr
);
704 /** ***********************************************************************************************
705 * @brief Performs Erase operation. Function will try to use biggest erase block possible to
706 * speedup the operation.
708 * @param bank current flash bank
709 * @param first first sector to erase
710 * @param last last sector to erase
711 * @return ERROR_OK in case of success, ERROR_XXX code otherwise
712 *************************************************************************************************/
713 static int psoc6_erase(struct flash_bank
*bank
, unsigned int first
,
716 struct target
*target
= bank
->target
;
717 struct psoc6_target_info
*psoc6_info
= bank
->driver_priv
;
718 const uint32_t sector_size
= is_wflash_bank(bank
) ? WFLASH_SECTOR_SIZE
: MFLASH_SECTOR_SIZE
;
721 struct working_area
*wa
;
723 if (is_sflash_bank(bank
)) {
724 LOG_INFO("Erase operation on Supervisory Flash is not required, skipping");
728 hr
= sromalgo_prepare(target
);
732 hr
= target_alloc_working_area(target
, psoc6_info
->row_sz
+ 32, &wa
);
736 /* Number of rows in single sector */
737 const unsigned int rows_in_sector
= sector_size
/ psoc6_info
->row_sz
;
739 while (last
>= first
) {
740 /* Erase Sector if we are on sector boundary and erase size covers whole sector */
741 if ((first
% rows_in_sector
) == 0 &&
742 (last
- first
+ 1) >= rows_in_sector
) {
743 hr
= psoc6_erase_sector(bank
, wa
, bank
->base
+ first
* psoc6_info
->row_sz
);
747 first
+= rows_in_sector
;
749 /* Perform Row Erase otherwise */
750 hr
= psoc6_erase_row(bank
, wa
, bank
->base
+ first
* psoc6_info
->row_sz
);
759 target_free_working_area(target
, wa
);
761 sromalgo_release(target
);
765 /** ***********************************************************************************************
766 * @brief Programs single Flash Row
767 * @param bank current flash bank
768 * @param addr address of the flash row
769 * @param buffer pointer to the buffer with data
770 * @param is_sflash true if current flash bank belongs to Supervisory Flash
771 * @return ERROR_OK in case of success, ERROR_XXX code otherwise
772 *************************************************************************************************/
773 static int psoc6_program_row(struct flash_bank
*bank
,
775 const uint8_t *buffer
,
778 struct target
*target
= bank
->target
;
779 struct psoc6_target_info
*psoc6_info
= bank
->driver_priv
;
780 struct working_area
*wa
;
781 const uint32_t sromapi_req
= is_sflash
? SROMAPI_WRITEROW_REQ
: SROMAPI_PROGRAMROW_REQ
;
785 LOG_DEBUG("Programming ROW @%08" PRIX32
, addr
);
787 hr
= target_alloc_working_area(target
, psoc6_info
->row_sz
+ 32, &wa
);
791 hr
= target_write_u32(target
, wa
->address
, sromapi_req
);
795 hr
= target_write_u32(target
,
801 hr
= target_write_u32(target
, wa
->address
+ 0x08, addr
);
805 hr
= target_write_u32(target
, wa
->address
+ 0x0C, wa
->address
+ 0x10);
809 hr
= target_write_buffer(target
, wa
->address
+ 0x10, psoc6_info
->row_sz
, buffer
);
813 hr
= call_sromapi(target
, sromapi_req
, wa
->address
, &data_out
);
816 target_free_working_area(target
, wa
);
822 /** ***********************************************************************************************
823 * @brief Performs Program operation
824 * @param bank current flash bank
825 * @param buffer pointer to the buffer with data
826 * @param offset starting offset in flash bank
827 * @param count number of bytes in buffer
828 * @return ERROR_OK in case of success, ERROR_XXX code otherwise
829 *************************************************************************************************/
830 static int psoc6_program(struct flash_bank
*bank
,
831 const uint8_t *buffer
,
835 struct target
*target
= bank
->target
;
836 struct psoc6_target_info
*psoc6_info
= bank
->driver_priv
;
837 const bool is_sflash
= is_sflash_bank(bank
);
840 uint8_t page_buf
[psoc6_info
->row_sz
];
842 hr
= sromalgo_prepare(target
);
847 uint32_t row_offset
= offset
% psoc6_info
->row_sz
;
848 uint32_t aligned_addr
= bank
->base
+ offset
- row_offset
;
849 uint32_t row_bytes
= MIN(psoc6_info
->row_sz
- row_offset
, count
);
851 memset(page_buf
, 0, sizeof(page_buf
));
852 memcpy(&page_buf
[row_offset
], buffer
, row_bytes
);
854 hr
= psoc6_program_row(bank
, aligned_addr
, page_buf
, is_sflash
);
855 if (hr
!= ERROR_OK
) {
856 LOG_ERROR("Failed to program Flash at address 0x%08" PRIX32
, aligned_addr
);
866 sromalgo_release(target
);
870 /** ***********************************************************************************************
871 * @brief Performs Mass Erase operation
872 * @return ERROR_OK in case of success, ERROR_XXX code otherwise
873 *************************************************************************************************/
874 COMMAND_HANDLER(psoc6_handle_mass_erase_command
)
877 return ERROR_COMMAND_SYNTAX_ERROR
;
879 struct flash_bank
*bank
;
880 int hr
= CALL_COMMAND_HANDLER(flash_command_get_bank
, 0, &bank
);
884 hr
= psoc6_erase(bank
, 0, bank
->num_sectors
- 1);
889 /** ***********************************************************************************************
890 * @brief Simulates broken Vector Catch
891 * Function will try to determine entry point of user application. If it succeeds it will set HW
892 * breakpoint at that address, issue SW Reset and remove the breakpoint afterwards.
893 * In case of CM0, SYSRESETREQ is used. This allows to reset all peripherals. Boot code will
894 * reset CM4 anyway, so using SYSRESETREQ is safe here.
895 * In case of CM4, VECTRESET is used instead of SYSRESETREQ to not disturb CM0 core.
897 * @param target current target
898 * @return ERROR_OK in case of success, ERROR_XXX code otherwise
899 *************************************************************************************************/
900 static int handle_reset_halt(struct target
*target
)
904 bool is_cm0
= (target
->coreid
== 0);
906 /* Halt target device */
907 if (target
->state
!= TARGET_HALTED
) {
908 hr
= target_halt(target
);
912 target_wait_state(target
, TARGET_HALTED
, IPC_TIMEOUT_MS
);
917 /* Read Vector Offset register */
919 const uint32_t vt_offset_reg
= is_cm0
? 0x402102B0 : 0x402102C0;
920 hr
= target_read_u32(target
, vt_offset_reg
, &vt_base
);
924 /* Invalid value means flash is empty */
925 vt_base
&= 0xFFFFFF00;
926 if ((vt_base
== 0) || (vt_base
== 0xFFFFFF00))
929 /* Read Reset Vector value*/
930 hr
= target_read_u32(target
, vt_base
+ 4, &reset_addr
);
934 /* Invalid value means flash is empty */
935 if ((reset_addr
== 0) || (reset_addr
== 0xFFFFFF00))
939 /* Set breakpoint at User Application entry point */
940 hr
= breakpoint_add(target
, reset_addr
, 2, BKPT_HARD
);
944 const struct armv7m_common
*cm
= target_to_armv7m(target
);
946 /* PSoC6 reboots immediately after issuing SYSRESETREQ / VECTRESET
947 * this disables SWD/JTAG pins momentarily and may break communication
948 * Ignoring return value of mem_ap_write_atomic_u32 seems to be ok here */
950 /* Reset the CM0 by asserting SYSRESETREQ. This will also reset CM4 */
951 LOG_INFO("psoc6.cm0: bkpt @0x%08" PRIX32
", issuing SYSRESETREQ", reset_addr
);
952 mem_ap_write_atomic_u32(cm
->debug_ap
, NVIC_AIRCR
,
953 AIRCR_VECTKEY
| AIRCR_SYSRESETREQ
);
955 LOG_INFO("psoc6.cm4: bkpt @0x%08" PRIX32
", issuing VECTRESET", reset_addr
);
956 mem_ap_write_atomic_u32(cm
->debug_ap
, NVIC_AIRCR
,
957 AIRCR_VECTKEY
| AIRCR_VECTRESET
);
960 /* Wait 100ms for bootcode and reinitialize DAP */
962 dap_dp_init(cm
->debug_ap
->dap
);
964 target_wait_state(target
, TARGET_HALTED
, IPC_TIMEOUT_MS
);
966 /* Remove the break point */
967 breakpoint_remove(target
, reset_addr
);
972 /** ***********************************************************************************************
973 * @brief Simulates broken Vector Catch
974 * Function will try to determine entry point of user application. If it succeeds it will set HW
975 * breakpoint at that address, issue SW Reset and remove the breakpoint afterwards.
976 * In case of CM0, SYSRESETREQ is used. This allows to reset all peripherals. Boot code will
977 * reset CM4 anyway, so using SYSRESETREQ is safe here.
978 * In case of CM4, VECTRESET is used instead of SYSRESETREQ to not disturb CM0 core.
980 * @return ERROR_OK in case of success, ERROR_XXX code otherwise
981 *************************************************************************************************/
982 COMMAND_HANDLER(psoc6_handle_reset_halt
)
985 return ERROR_COMMAND_SYNTAX_ERROR
;
987 struct target
*target
= get_current_target(CMD_CTX
);
988 return handle_reset_halt(target
);
991 FLASH_BANK_COMMAND_HANDLER(psoc6_flash_bank_command
)
993 struct psoc6_target_info
*psoc6_info
;
997 hr
= ERROR_COMMAND_SYNTAX_ERROR
;
999 psoc6_info
= calloc(1, sizeof(struct psoc6_target_info
));
1000 psoc6_info
->is_probed
= false;
1001 bank
->driver_priv
= psoc6_info
;
1006 static const struct command_registration psoc6_exec_command_handlers
[] = {
1008 .name
= "mass_erase",
1009 .handler
= psoc6_handle_mass_erase_command
,
1010 .mode
= COMMAND_EXEC
,
1012 .help
= "Erases entire Main Flash",
1015 .name
= "reset_halt",
1016 .handler
= psoc6_handle_reset_halt
,
1017 .mode
= COMMAND_EXEC
,
1019 .help
= "Tries to simulate broken Vector Catch",
1021 COMMAND_REGISTRATION_DONE
1024 static const struct command_registration psoc6_command_handlers
[] = {
1027 .mode
= COMMAND_ANY
,
1028 .help
= "PSoC 6 flash command group",
1030 .chain
= psoc6_exec_command_handlers
,
1032 COMMAND_REGISTRATION_DONE
1035 const struct flash_driver psoc6_flash
= {
1037 .commands
= psoc6_command_handlers
,
1038 .flash_bank_command
= psoc6_flash_bank_command
,
1039 .erase
= psoc6_erase
,
1040 .protect
= psoc6_protect
,
1041 .write
= psoc6_program
,
1042 .read
= default_flash_read
,
1043 .probe
= psoc6_probe
,
1044 .auto_probe
= psoc6_auto_probe
,
1045 .erase_check
= default_flash_blank_check
,
1046 .protect_check
= psoc6_protect_check
,
1047 .info
= psoc6_get_info
,
1048 .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)