openocd/tcl/target/nrf52.cfg

# SPDX-License-Identifier: GPL-2.0-or-later

#
# Nordic nRF52 series: ARM Cortex-M4 @ 64 MHz
#

source [find target/swj-dp.tcl]
source [find mem_helper.tcl]

if { [info exists CHIPNAME] } {
	set _CHIPNAME $CHIPNAME
} else {
	set _CHIPNAME nrf52
}

# Work-area is a space in RAM used for flash programming
# By default use 16kB
if { [info exists WORKAREASIZE] } {
   set _WORKAREASIZE $WORKAREASIZE
} else {
   set _WORKAREASIZE 0x4000
}

if { [info exists CPUTAPID] } {
	set _CPUTAPID $CPUTAPID
} else {
	set _CPUTAPID 0x2ba01477
}

swj_newdap $_CHIPNAME cpu -expected-id $_CPUTAPID
dap create $_CHIPNAME.dap -chain-position $_CHIPNAME.cpu

set _TARGETNAME $_CHIPNAME.cpu
target create $_TARGETNAME cortex_m -dap $_CHIPNAME.dap

adapter speed 1000

$_TARGETNAME configure -work-area-phys 0x20000000 -work-area-size $_WORKAREASIZE -work-area-backup 0

if { [using_hla] } {
	echo ""
	echo "nRF52 device has a CTRL-AP dedicated to recover the device from AP lock."
	echo "A high level adapter (like a ST-Link) you are currently using cannot access"
	echo "the CTRL-AP so 'nrf52_recover' command will not work."
	echo "Do not enable UICR APPROTECT."
	echo ""
} else {
	cortex_m reset_config sysresetreq

	$_TARGETNAME configure -event examine-fail nrf52_check_ap_lock
}

flash bank $_CHIPNAME.flash nrf5 0x00000000 0 1 1 $_TARGETNAME
flash bank $_CHIPNAME.uicr nrf5 0x10001000 0 1 1 $_TARGETNAME

# Test if MEM-AP is locked by UICR APPROTECT
proc nrf52_check_ap_lock {} {
	set dap [[target current] cget -dap]
	set err [catch {set APPROTECTSTATUS [$dap apreg 1 0xc]}]
	if {$err == 0 && $APPROTECTSTATUS != 1} {
		echo "****** WARNING ******"
		echo "nRF52 device has AP lock engaged (see UICR APPROTECT register)."
		echo "Debug access is denied."
		echo "Use 'nrf52_recover' to erase and unlock the device."
		echo ""
		poll off
	}
}

# Mass erase and unlock the device using proprietary nRF CTRL-AP (AP #1)
# http://www.ebyte.com produces modules with nRF52 locked by default,
# use nrf52_recover to enable flashing and debug.
proc nrf52_recover {} {
	set target [target current]
	set dap [$target cget -dap]

	set IDR [$dap apreg 1 0xfc]
	if {$IDR != 0x02880000} {
		echo "Error: Cannot access nRF52 CTRL-AP!"
		return
	}

	poll off

	# Reset and trigger ERASEALL task
	$dap apreg 1 4 0
	$dap apreg 1 4 1

	for {set i 0} {1} {incr i} {
		set ERASEALLSTATUS [$dap apreg 1 8]
		if {$ERASEALLSTATUS == 0} {
			echo "$target device has been successfully erased and unlocked."
			break
		}
		if {$i == 0} {
			echo "Waiting for chip erase..."
		}
		if {$i >= 150} {
			echo "Error: $target recovery failed."
			break
		}
		sleep 100
	}

	# Assert reset
	$dap apreg 1 0 1

	# Deassert reset
	$dap apreg 1 0 0

	# Reset ERASEALL task
	$dap apreg 1 4 0

	sleep 100
	$target arp_examine
	poll on
}

add_help_text nrf52_recover "Mass erase and unlock nRF52 device"

tpiu create $_CHIPNAME.tpiu -dap $_CHIPNAME.dap -ap-num 0 -baseaddr 0xE0040000

lappend _telnet_autocomplete_skip _proc_pre_enable_$_CHIPNAME.tpiu
proc _proc_pre_enable_$_CHIPNAME.tpiu {_targetname _chipname} {
	targets $_targetname

	# Read FICR.INFO.PART
	set PART [mrw 0x10000100]

	switch $PART {
		0x52840 -
		0x52833 -
		0x52832 {
			# Configuration values for all supported trace port speeds, see
			# TRACECONFIG.TRACEPORTSPEED
			set trace_port_speeds {
				32000000 0
				16000000 1
				8000000  2
				4000000  3
			}

			# Note that trace port clock stands for what is referred to as
			# TRACECLKIN in the Arm CoreSight documentation.
			set trace_port_clock [$_chipname.tpiu cget -traceclk]

			if { ![dict exists $trace_port_speeds $trace_port_clock] } {
				error "Trace clock speed is not supported"
			}

			# Set TRACECONFIG.TRACEPORTSPEED
			mmw 0x4000055C [dict get $trace_port_speeds $trace_port_clock] 0x3

			if { [$_chipname.tpiu cget -protocol] eq "sync" } {
				if { [$_chipname.tpiu cget -port-width] != 4 } {
					error "Device only supports 4-bit sync traces"
				}

				# Set TRACECONFIG.TRACEMUX to enable synchronous trace
				mmw 0x4000055C 0x00020000 0x00010000
				$_targetname configure -event reset-end {
					mmw 0x4000055C 0x00020000 0x00010000
				}
			} else {
				# Set TRACECONFIG.TRACEMUX to enable SWO
				mmw 0x4000055C 0x00010000 0x00020000
				$_targetname configure -event reset-end {
					mmw 0x4000055C 0x00010000 0x00020000
				}
			}
		}
		0x52820 -
		0x52811 -
		0x52810 -
		0x52805 {
			error "Device does not support TPIU"
		}
		default {
			error "Unknown device, cannot configure TPIU"
		}
	}
}

$_CHIPNAME.tpiu configure -event pre-enable "_proc_pre_enable_$_CHIPNAME.tpiu $_TARGETNAME $_CHIPNAME"