rpi/pico-sdk
1
0
Fork 0
mirror of https://github.com/raspberrypi/pico-sdk.git synced 2025-08-07 17:02:52 +03:00
Code Activity

More board-header checks (followup to #2397) (#2442)

Browse Source 
- make the error messages less misleading
- suggest replacing the old comment-style syntax with the new macro-style syntax
This commit is contained in:
Andrew Scheller
2025-04-26 18:15:26 +01:00
committed by GitHub
parent ae332b3522
commit 082d9f75cd
1 changed files with 31 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
tools/check_board_header.py
View File

@@ -75,6 +75,17 @@ def read_defines_from(header_file, defines_dict):
# strip trailing comments # strip trailing comments
line = re.sub(r"(?<=\S)\s*//.*$", "", line) line = re.sub(r"(?<=\S)\s*//.*$", "", line)
# look for "// old_comment BLAH_BLAH=42" and suggest changing it to "new_macro(BLAH_BLAH, 42)"
for (old_comment, new_macro) in (
('pico_cmake_set', 'pico_board_cmake_set'),
('pico_cmake_set_default', 'pico_board_cmake_set_default')
):
m = re.match(r"^\s*//\s*{}\s+(\w+)\s*=\s*(.+?)\s*$".format(old_comment), line)
if m:
name = m.group(1)
value = m.group(2)
raise Exception("{}:{} \"// {} {}={}\" should be replaced with \"{}({}, {})\"".format(board_header, lineno, old_comment, name, value, new_macro, name, value))
# look for "pico_board_cmake_set(BLAH_BLAH, 42)" # look for "pico_board_cmake_set(BLAH_BLAH, 42)"
m = re.match(r"^\s*pico_board_cmake_set\s*\(\s*([a-zA-Z_][a-zA-Z0-9_]*)\s*,\s*(.*)\s*\)\s*$", line) m = re.match(r"^\s*pico_board_cmake_set\s*\(\s*([a-zA-Z_][a-zA-Z0-9_]*)\s*,\s*(.*)\s*\)\s*$", line)
if m: if m:
@@ -87,10 +98,10 @@ def read_defines_from(header_file, defines_dict):
# check for multiply-defined values # check for multiply-defined values
if name in cmake_settings: if name in cmake_settings:
if cmake_settings[name].value != value: if cmake_settings[name].value != value:
raise Exception("{}:{} Conflicting values for pico_board_cmake_set {} ({} and {})".format(board_header, lineno, name, cmake_settings[name].value, value)) raise Exception("{}:{} Conflicting values for pico_board_cmake_set({}) ({} and {})".format(board_header, lineno, name, cmake_settings[name].value, value))
else: else:
if show_warnings: if show_warnings:
warnings.warn("{}:{} Multiple values for pico_board_cmake_set {} ({} and {})".format(board_header, lineno, name, cmake_settings[name].value, value)) warnings.warn("{}:{} Multiple values for pico_board_cmake_set({}) ({} and {})".format(board_header, lineno, name, cmake_settings[name].value, value))
else: else:
cmake_settings[name] = DefineType(name, value, None, lineno) cmake_settings[name] = DefineType(name, value, None, lineno)
continue continue
@@ -223,6 +234,17 @@ with open(board_header) as header_fh:
raise Exception("{}:{} Suggests including \"{}\" but file is named \"{}\"".format(board_header, lineno, include_suggestion, expected_include_suggestion)) raise Exception("{}:{} Suggests including \"{}\" but file is named \"{}\"".format(board_header, lineno, include_suggestion, expected_include_suggestion))
continue continue
# look for "// old_comment BLAH_BLAH=42" and suggest changing it to "new_macro(BLAH_BLAH, 42)"
for (old_comment, new_macro) in (
('pico_cmake_set', 'pico_board_cmake_set'),
('pico_cmake_set_default', 'pico_board_cmake_set_default')
):
m = re.match(r"^\s*//\s*{}\s+(\w+)\s*=\s*(.+?)\s*$".format(old_comment), line)
if m:
name = m.group(1)
value = m.group(2)
raise Exception("{}:{} \"// {} {}={}\" should be replaced with \"{}({}, {})\"".format(board_header, lineno, old_comment, name, value, new_macro, name, value))
# look for "pico_board_cmake_set(BLAH_BLAH, 42)" # look for "pico_board_cmake_set(BLAH_BLAH, 42)"
m = re.match(r"^\s*pico_board_cmake_set\s*\(\s*([a-zA-Z_][a-zA-Z0-9_]*)\s*,\s*(.*)\s*\)\s*$", line) m = re.match(r"^\s*pico_board_cmake_set\s*\(\s*([a-zA-Z_][a-zA-Z0-9_]*)\s*,\s*(.*)\s*\)\s*$", line)
if m: if m:
@@ -234,7 +256,7 @@ with open(board_header) as header_fh:
raise Exception("{}:{} Expected \"{}\" to be all uppercase".format(board_header, lineno, name)) raise Exception("{}:{} Expected \"{}\" to be all uppercase".format(board_header, lineno, name))
# check for multiply-defined values # check for multiply-defined values
if name in cmake_settings: if name in cmake_settings:
raise Exception("{}:{} Multiple values for pico_board_cmake_set {} ({} and {})".format(board_header, lineno, name, cmake_settings[name].value, value)) raise Exception("{}:{} Multiple values for pico_board_cmake_set({}) ({} and {})".format(board_header, lineno, name, cmake_settings[name].value, value))
else: else:
if value: if value:
try: try:
@@ -256,7 +278,7 @@ with open(board_header) as header_fh:
raise Exception("{}:{} Expected \"{}\" to be all uppercase".format(board_header, lineno, name)) raise Exception("{}:{} Expected \"{}\" to be all uppercase".format(board_header, lineno, name))
# check for multiply-defined values # check for multiply-defined values
if name in cmake_default_settings: if name in cmake_default_settings:
raise Exception("{}:{} Multiple values for pico_board_cmake_set_default {} ({} and {})".format(board_header, lineno, name, cmake_default_settings[name].value, value)) raise Exception("{}:{} Multiple values for pico_board_cmake_set_default({}) ({} and {})".format(board_header, lineno, name, cmake_default_settings[name].value, value))
else: else:
if value: if value:
try: try:
@@ -382,7 +404,7 @@ if board_header_basename == "none.h":
else: else:
for setting in compulsory_cmake_settings: for setting in compulsory_cmake_settings:
if setting not in cmake_settings: if setting not in cmake_settings:
raise Exception("{} is missing a pico_board_cmake_set {} comment".format(board_header, setting)) raise Exception("{} is missing a pico_board_cmake_set({}, XXX) call".format(board_header, setting))
if cmake_settings['PICO_PLATFORM'].value == "rp2040": if cmake_settings['PICO_PLATFORM'].value == "rp2040":
chip = 'RP2040' chip = 'RP2040'
other_chip = 'RP2350' other_chip = 'RP2350'
@@ -399,19 +421,19 @@ else:
chip = 'RP2350B' chip = 'RP2350B'
if not board_header.endswith("amethyst_fpga.h"): if not board_header.endswith("amethyst_fpga.h"):
if 'PICO_RP2350_A2_SUPPORTED' not in cmake_default_settings: if 'PICO_RP2350_A2_SUPPORTED' not in cmake_default_settings:
raise Exception("{} uses chip {} but is missing a pico_board_cmake_set_default {} comment".format(board_header, chip, 'PICO_RP2350_A2_SUPPORTED')) raise Exception("{} uses chip {} but is missing a pico_board_cmake_set_default({}, XXX) call".format(board_header, chip, 'PICO_RP2350_A2_SUPPORTED'))
if 'PICO_RP2350_A2_SUPPORTED' not in defines: if 'PICO_RP2350_A2_SUPPORTED' not in defines:
raise Exception("{} uses chip {} but is missing a #define {}".format(board_header, chip, 'PICO_RP2350_A2_SUPPORTED')) raise Exception("{} uses chip {} but is missing a #define {}".format(board_header, chip, 'PICO_RP2350_A2_SUPPORTED'))
if defines['PICO_RP2350_A2_SUPPORTED'].resolved_value != 1: if defines['PICO_RP2350_A2_SUPPORTED'].resolved_value != 1:
raise Exception("{} sets #define {} {} (should be 1)".format(board_header, chip, 'PICO_RP2350_A2_SUPPORTED', defines['PICO_RP2350_A2_SUPPORTED'].resolved_value)) raise Exception("{} sets #define {} {} (should be 1)".format(board_header, chip, 'PICO_RP2350_A2_SUPPORTED', defines['PICO_RP2350_A2_SUPPORTED'].resolved_value))
for setting in compulsory_cmake_default_settings: for setting in compulsory_cmake_default_settings:
if setting not in cmake_default_settings: if setting not in cmake_default_settings:
raise Exception("{} is missing a pico_board_cmake_set_default {} comment".format(board_header, setting)) raise Exception("{} is missing a pico_board_cmake_set_default({}, XXX) call".format(board_header, setting))
for setting in matching_cmake_default_settings: for setting in matching_cmake_default_settings:
if setting in cmake_default_settings and setting not in defines: if setting in cmake_default_settings and setting not in defines:
raise Exception("{} has pico_board_cmake_set_default {} but is missing a matching #define".format(board_header, setting)) raise Exception("{} has pico_board_cmake_set_default({}, XXX) but is missing a matching #define".format(board_header, setting))
elif setting in defines and setting not in cmake_default_settings: elif setting in defines and setting not in cmake_default_settings:
raise Exception("{} has #define {} but is missing a matching pico_board_cmake_set_default comment".format(board_header, setting)) raise Exception("{} has #define {} but is missing a matching pico_board_cmake_set_default({}, XXX) call".format(board_header, setting, setting))
elif setting in defines and setting in cmake_default_settings: elif setting in defines and setting in cmake_default_settings:
if cmake_default_settings[setting].value != defines[setting].resolved_value: if cmake_default_settings[setting].value != defines[setting].resolved_value:
raise Exception("{} has mismatched pico_board_cmake_set_default and #define values for {}".format(board_header, setting)) raise Exception("{} has mismatched pico_board_cmake_set_default and #define values for {}".format(board_header, setting))