espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-11 00:24:34 +02:00
Code Issues Packages Projects Releases Wiki Activity

tools: allow to use hints for debug targets

Browse Source 
The debug targets are currently not utilizing hints, because they
are not using RunTool() helper from tools.py to spawn sub-processes.
Adjusting debug targets to use RunTool() would require some significant
changes to debug targets and RunTool() as well. Since debug targets
are already storing their output in logs, we can use these and process
them for hints.

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
This commit is contained in:
Frantisek Hrbata
2023-02-01 14:28:23 +01:00
parent 57c4508eb3
commit 4ee00623a3
1 changed files with 23 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
tools/idf_py_actions/debug_ext.py
View File

@@ -20,7 +20,8 @@ from esp_coredump import CoreDump
from idf_py_actions.constants import OPENOCD_TAGET_CONFIG, OPENOCD_TAGET_CONFIG_DEFAULT from idf_py_actions.constants import OPENOCD_TAGET_CONFIG, OPENOCD_TAGET_CONFIG_DEFAULT
from idf_py_actions.errors import FatalError from idf_py_actions.errors import FatalError
from idf_py_actions.serial_ext import BAUD_RATE, PORT from idf_py_actions.serial_ext import BAUD_RATE, PORT
from idf_py_actions.tools import PropertyDict, ensure_build_directory, get_default_serial_port, get_sdkconfig_value from idf_py_actions.tools import (PropertyDict, ensure_build_directory, generate_hints, get_default_serial_port,
get_sdkconfig_value, yellow_print)
PYTHON = sys.executable PYTHON = sys.executable
ESP_ROM_INFO_FILE = 'roms.json' ESP_ROM_INFO_FILE = 'roms.json'
@@ -73,23 +74,19 @@ def action_extensions(base_actions: Dict, project_path: str) -> Dict:
OPENOCD_OUT_FILE = 'openocd_out.txt' OPENOCD_OUT_FILE = 'openocd_out.txt'
GDBGUI_OUT_FILE = 'gdbgui_out.txt' GDBGUI_OUT_FILE = 'gdbgui_out.txt'
# Internal dictionary of currently active processes, threads and their output files # Internal dictionary of currently active processes, threads and their output files
processes: Dict = {'threads_to_join': [], 'openocd_issues': None} processes: Dict = {'threads_to_join': [], 'allow_hints': True}
def _check_for_common_openocd_issues(file_name: str, print_all: bool=True) -> Any: def _print_hints(file_name: str) -> None:
if processes['openocd_issues'] is not None: if not processes['allow_hints']:
return processes['openocd_issues'] return
try:
message = 'Please check JTAG connection!' for hint in generate_hints(file_name):
with open(file_name, 'r') as f: if sys.stderr.isatty():
content = f.read() yellow_print(hint)
if print_all: else:
print(content) # Hints go to stderr. Flush stdout, so hints are printed last.
if re.search(r'Address already in use', content): sys.stdout.flush()
message = ('Please check if another process uses the mentioned ports. OpenOCD already running, perhaps in the background?\n' print(hint, file=sys.stderr)
'Please list all processes to check if OpenOCD is already running; if so, terminate it before starting OpenOCD from idf.py')
finally:
processes['openocd_issues'] = message
return message
def _check_openocd_errors(fail_if_openocd_failed: Dict, target: str, ctx: Context) -> None: def _check_openocd_errors(fail_if_openocd_failed: Dict, target: str, ctx: Context) -> None:
if fail_if_openocd_failed: if fail_if_openocd_failed:
@@ -103,16 +100,16 @@ def action_extensions(base_actions: Dict, project_path: str) -> Dict:
break break
with open(name, 'r') as f: with open(name, 'r') as f:
content = f.read() content = f.read()
if re.search(r'no device found', content):
break
if re.search(r'Listening on port \d+ for gdb connections', content): if re.search(r'Listening on port \d+ for gdb connections', content):
# expect OpenOCD has started successfully - stop watching # expect OpenOCD has started successfully - stop watching
return return
time.sleep(0.5) time.sleep(0.5)
else:
return # OpenOCD exited or is not listening -> print full log and terminate
# OpenOCD exited or error message detected -> print possible output and terminate with open(name, 'r') as f:
raise FatalError('Action "{}" failed due to errors in OpenOCD:\n{}'.format(target, _check_for_common_openocd_issues(name)), ctx) print(f.read())
raise FatalError('Action "{}" failed due to errors in OpenOCD'.format(target), ctx)
def _terminate_async_target(target: str) -> None: def _terminate_async_target(target: str) -> None:
if target in processes and processes[target] is not None: if target in processes and processes[target] is not None:
@@ -129,8 +126,8 @@ def action_extensions(base_actions: Dict, project_path: str) -> Dict:
time.sleep(0.1) time.sleep(0.1)
else: else:
p.kill() p.kill()
if target + '_outfile_name' in processes and target == 'openocd': if target + '_outfile_name' in processes:
print(_check_for_common_openocd_issues(processes[target + '_outfile_name'], print_all=False)) _print_hints(processes[target + '_outfile_name'])
except Exception as e: except Exception as e:
print(e) print(e)
print('Failed to close/kill {}'.format(target)) print('Failed to close/kill {}'.format(target))
@@ -456,6 +453,7 @@ def action_extensions(base_actions: Dict, project_path: str) -> Dict:
tasks.insert(0, tasks.pop(index)) tasks.insert(0, tasks.pop(index))
break break
processes['allow_hints'] = not ctx.params['no_hints']
debug_targets = any([task.name in ('openocd', 'gdbgui') for task in tasks]) debug_targets = any([task.name in ('openocd', 'gdbgui') for task in tasks])
if debug_targets: if debug_targets:
# Register the meta cleanup callback -> called on FatalError # Register the meta cleanup callback -> called on FatalError