Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Parent: Remove unnecessary check in pio_encode_sideset_opt
merged 1 commit into from
Apr 26, 2025
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 31 additions & 9 deletions tools/check_board_header.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,17 @@ def read_defines_from(header_file, defines_dict):
# strip trailing comments
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)"
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:
Expand All @@ -87,10 +98,10 @@ def read_defines_from(header_file, defines_dict):
# check for multiply-defined values
if name in cmake_settings:
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:
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:
cmake_settings[name] = DefineType(name, value, None, lineno)
continue
Expand Down Expand Up @@ -223,6 +234,17 @@ def read_defines_from(header_file, defines_dict):
raise Exception("{}:{} Suggests including \"{}\" but file is named \"{}\"".format(board_header, lineno, include_suggestion, expected_include_suggestion))
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)"
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:
Expand All @@ -234,7 +256,7 @@ def read_defines_from(header_file, defines_dict):
raise Exception("{}:{} Expected \"{}\" to be all uppercase".format(board_header, lineno, name))
# check for multiply-defined values
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:
if value:
try:
Expand All @@ -256,7 +278,7 @@ def read_defines_from(header_file, defines_dict):
raise Exception("{}:{} Expected \"{}\" to be all uppercase".format(board_header, lineno, name))
# check for multiply-defined values
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:
if value:
try:
Expand Down Expand Up @@ -382,7 +404,7 @@ def read_defines_from(header_file, defines_dict):
else:
for setting in compulsory_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":
chip = 'RP2040'
other_chip = 'RP2350'
Expand All @@ -399,19 +421,19 @@ def read_defines_from(header_file, defines_dict):
chip = 'RP2350B'
if not board_header.endswith("amethyst_fpga.h"):
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:
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:
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:
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:
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:
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:
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))
Expand Down
Loading