def enable_debug(probe: DebugProbe, ap_mem: int = 0) -> bool:
"""Function that enables debug access ports on devices with debug mailbox.
:param probe: Initialized debug probe.
:param ap_mem: Index of Debug access port for memory interface.
:return: True if debug port is enabled, False otherwise
:raises SPSDKError: Unlock method failed.
"""
debug_enabled = False
try:
logger.debug("step 3: Check if AHB is enabled")
if not test_ahb_access(probe, ap_mem):
logger.debug("Locked Device. Launching unlock sequence.")
# Start debug mailbox system
StartDebugSession(dm=DebugMailbox(debug_probe=probe)).run()
# Recheck the AHB access
if test_ahb_access(probe, ap_mem):
logger.debug("Access granted")
debug_enabled = True
else:
logger.debug("Enable debug operation failed!")
else:
logger.debug("Unlocked Device")
debug_enabled = True
except AttributeError as exc:
raise SPSDKError(f"Invalid input parameters({str(exc)})") from exc
except SPSDKDebugProbeError as exc:
raise SPSDKError(f"Can't unlock device ({str(exc)})") from exc
return debug_enabled
def test_connection(pass_obj: dict) -> None:
"""Method just try if the device debug port is opened or not."""
ahb_access_granted = False
try:
interface = pass_obj["interface"]
serial_no = pass_obj["serial_no"]
debug_probe_params = pass_obj["debug_probe_params"]
debug_probe = None
debug_probes = DebugProbeUtils.get_connected_probes(
interface=interface, hardware_id=serial_no, user_params=debug_probe_params
)
selected_probe = debug_probes.select_probe()
debug_probe = selected_probe.get_probe(debug_probe_params)
debug_probe.open()
debug_probe.enable_memory_interface()
ahb_access_granted = test_ahb_access(debug_probe)
except SPSDKError as exc:
click.echo(str(exc))
finally:
if debug_probe:
debug_probe.close()
access_str = colorama.Fore.GREEN if ahb_access_granted else colorama.Fore.RED + "not-"
click.echo(f"The device is {access_str}accessible for debugging.{colorama.Fore.RESET}")
def auth(pass_obj: dict, beacon: int, certificate: str, key: str,
no_exit: bool) -> None:
"""Perform the Debug Authentication."""
try:
logger.info("Starting Debug Authentication")
with _open_debugmbox(pass_obj) as mail_box:
with open(certificate, "rb") as f:
debug_cred_data = f.read()
debug_cred = DebugCredential.parse(debug_cred_data)
dac_rsp_len = 30 if debug_cred.HASH_LENGTH == 48 and debug_cred.socc == 4 else 26
dac_data = dm_commands.DebugAuthenticationStart(
dm=mail_box, resplen=dac_rsp_len).run()
# convert List[int] to bytes
dac_data_bytes = struct.pack(f"<{len(dac_data)}I", *dac_data)
dac = DebugAuthenticationChallenge.parse(dac_data_bytes)
logger.debug(f"DAC: \n{dac.info()}")
dar = DebugAuthenticateResponse.create(
version=pass_obj["protocol"],
socc=dac.socc,
dc=debug_cred,
auth_beacon=beacon,
dac=dac,
dck=key,
)
logger.debug(f"DAR:\n{dar.info()}")
dar_data = dar.export()
# convert bytes to List[int]
dar_data_words = list(
struct.unpack(f"<{len(dar_data) // 4}I", dar_data))
dar_response = dm_commands.DebugAuthenticationResponse(
dm=mail_box, paramlen=len(dar_data_words)).run(dar_data_words)
logger.debug(f"DAR response: {dar_response}")
if not no_exit:
exit_response = dm_commands.ExitDebugMailbox(dm=mail_box).run()
logger.debug(f"Exit response: {exit_response}")
# Re-open debug probe
mail_box.debug_probe.close()
mail_box.debug_probe.open()
# Do test of access to AHB bus
ahb_access_granted = test_ahb_access(mail_box.debug_probe)
res_str = ((colorama.Fore.GREEN +
"successfully") if ahb_access_granted else
(colorama.Fore.RED + "without AHB access"))
logger.info(
f"Debug Authentication ends {res_str}{colorama.Fore.RESET}."
)
if not ahb_access_granted:
click.get_current_context().exit(1)
else:
logger.info(
"Debug Authentication ends without exit and without test of AHB access."
)
except SPSDKError as e:
logger.error(f"Start Debug Mailbox failed!\n{e}")
click.get_current_context().exit(1)
def blankauth(pass_obj: dict, file: str, no_exit: bool) -> None:
"""Debug Authentication for Blank Device."""
try:
token = []
logger.info("Starting Debug Authentication for Blank Device..")
with _open_debugmbox(pass_obj) as mail_box:
with open(file, "rb") as f:
while True:
chunk = f.read(8).strip()
if not chunk:
break
token.append(int(chunk, 16))
f.close()
dm_commands.EnterBlankDebugAuthentication(dm=mail_box).run(token)
if not no_exit:
exit_response = dm_commands.ExitDebugMailbox(dm=mail_box).run()
logger.debug(f"Exit response: {exit_response}")
# Re-open debug probe
mail_box.debug_probe.close()
mail_box.debug_probe.open()
# Do test of access to AHB bus
ahb_access_granted = test_ahb_access(mail_box.debug_probe)
res_str = ((colorama.Fore.GREEN +
"successfully") if ahb_access_granted else
(colorama.Fore.RED + "without AHB access"))
logger.info(
f"Debug Authentication ends {res_str}{colorama.Fore.RESET}."
)
if not ahb_access_granted:
click.get_current_context().exit(1)
else:
logger.info(
"Debug Authentication ends without exit and without test of AHB access."
)
except SPSDKError as e:
logger.error(colorama.Fore.RED +
f"Debug authentication for Blank device failed!\n{e}")
click.get_current_context().exit(1)