PES4 / Mbed OS Queue_02

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/tools/targets/lint.py@0:6bf0743ece18, 2020-03-28 (annotated)

Committer:
demayer
Date:
Sat Mar 28 15:28:19 2020 +0000
Revision:
0:6bf0743ece18
IMU Thread with an event-queue running parallel to handle tasks like a 5 times blinking LED. Button with interrupt detected.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
demayer 0:6bf0743ece18 1 """A linting utility for targets.json
demayer 0:6bf0743ece18 2
demayer 0:6bf0743ece18 3 This linting utility may be called as follows:
demayer 0:6bf0743ece18 4 python <path-to>/lint.py targets TARGET [TARGET ...]
demayer 0:6bf0743ece18 5
demayer 0:6bf0743ece18 6 all targets will be linted
demayer 0:6bf0743ece18 7 """
demayer 0:6bf0743ece18 8
demayer 0:6bf0743ece18 9 # mbed SDK
demayer 0:6bf0743ece18 10 # Copyright (c) 2017 ARM Limited
demayer 0:6bf0743ece18 11 #
demayer 0:6bf0743ece18 12 # Licensed under the Apache License, Version 2.0 (the "License");
demayer 0:6bf0743ece18 13 # you may not use this file except in compliance with the License.
demayer 0:6bf0743ece18 14 # You may obtain a copy of the License at
demayer 0:6bf0743ece18 15 #
demayer 0:6bf0743ece18 16 # http://www.apache.org/licenses/LICENSE-2.0
demayer 0:6bf0743ece18 17 #
demayer 0:6bf0743ece18 18 # Unless required by applicable law or agreed to in writing, software
demayer 0:6bf0743ece18 19 # distributed under the License is distributed on an "AS IS" BASIS,
demayer 0:6bf0743ece18 20 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
demayer 0:6bf0743ece18 21 # See the License for the specific language governing permissions and
demayer 0:6bf0743ece18 22 # limitations under the License.
demayer 0:6bf0743ece18 23
demayer 0:6bf0743ece18 24 from os.path import join, abspath, dirname
demayer 0:6bf0743ece18 25 if __name__ == "__main__":
demayer 0:6bf0743ece18 26 import sys
demayer 0:6bf0743ece18 27 ROOT = abspath(join(dirname(__file__), "..", ".."))
demayer 0:6bf0743ece18 28 sys.path.insert(0, ROOT)
demayer 0:6bf0743ece18 29 from copy import copy
demayer 0:6bf0743ece18 30 from yaml import dump_all
demayer 0:6bf0743ece18 31 import argparse
demayer 0:6bf0743ece18 32
demayer 0:6bf0743ece18 33 from tools.targets import Target, set_targets_json_location, TARGET_MAP
demayer 0:6bf0743ece18 34
demayer 0:6bf0743ece18 35 def must_have_keys(keys, dict):
demayer 0:6bf0743ece18 36 """Require keys in an MCU/Board
demayer 0:6bf0743ece18 37
demayer 0:6bf0743ece18 38 is a generator for errors
demayer 0:6bf0743ece18 39 """
demayer 0:6bf0743ece18 40 for key in keys:
demayer 0:6bf0743ece18 41 if key not in dict:
demayer 0:6bf0743ece18 42 yield "%s not found, and is required" % key
demayer 0:6bf0743ece18 43
demayer 0:6bf0743ece18 44 def may_have_keys(keys, dict):
demayer 0:6bf0743ece18 45 """Disable all other keys in an MCU/Board
demayer 0:6bf0743ece18 46
demayer 0:6bf0743ece18 47 is a generator for errors
demayer 0:6bf0743ece18 48 """
demayer 0:6bf0743ece18 49 for key in dict.keys():
demayer 0:6bf0743ece18 50 if key not in keys:
demayer 0:6bf0743ece18 51 yield "%s found, and is not allowed" % key
demayer 0:6bf0743ece18 52
demayer 0:6bf0743ece18 53 def check_extra_labels(dict):
demayer 0:6bf0743ece18 54 """Check that extra_labels does not contain any Target names
demayer 0:6bf0743ece18 55
demayer 0:6bf0743ece18 56 is a generator for errors
demayer 0:6bf0743ece18 57 """
demayer 0:6bf0743ece18 58 for label in (dict.get("extra_labels", []) +
demayer 0:6bf0743ece18 59 dict.get("extra_labels_add", [])):
demayer 0:6bf0743ece18 60 if label in Target.get_json_target_data():
demayer 0:6bf0743ece18 61 yield "%s is not allowed in extra_labels" % label
demayer 0:6bf0743ece18 62
demayer 0:6bf0743ece18 63 def check_release_version(dict):
demayer 0:6bf0743ece18 64 """Verify that release version 5 is combined with support for all toolcahins
demayer 0:6bf0743ece18 65
demayer 0:6bf0743ece18 66 is a generator for errors
demayer 0:6bf0743ece18 67 """
demayer 0:6bf0743ece18 68 if ("release_versions" in dict and
demayer 0:6bf0743ece18 69 "5" in dict["release_versions"] and
demayer 0:6bf0743ece18 70 "supported_toolchains" in dict):
demayer 0:6bf0743ece18 71 for toolc in ["GCC_ARM", "ARM", "IAR"]:
demayer 0:6bf0743ece18 72 if toolc not in dict["supported_toolchains"]:
demayer 0:6bf0743ece18 73 yield ("%s not found in supported_toolchains, and is "
demayer 0:6bf0743ece18 74 "required by mbed OS 5" % toolc)
demayer 0:6bf0743ece18 75
demayer 0:6bf0743ece18 76 def check_inherits(dict):
demayer 0:6bf0743ece18 77 if ("inherits" in dict and len(dict["inherits"]) > 1):
demayer 0:6bf0743ece18 78 yield "multiple inheritance is forbidden"
demayer 0:6bf0743ece18 79
demayer 0:6bf0743ece18 80 DEVICE_HAS_ALLOWED = ["ANALOGIN", "ANALOGOUT", "CAN", "ETHERNET", "EMAC",
demayer 0:6bf0743ece18 81 "FLASH", "I2C", "I2CSLAVE", "I2C_ASYNCH", "INTERRUPTIN",
demayer 0:6bf0743ece18 82 "LOWPOWERTIMER", "PORTIN", "PORTINOUT", "PORTOUT",
demayer 0:6bf0743ece18 83 "PWMOUT", "RTC", "TRNG","SERIAL", "SERIAL_ASYNCH",
demayer 0:6bf0743ece18 84 "SERIAL_FC", "SLEEP", "SPI", "SPI_ASYNCH", "SPISLAVE",
demayer 0:6bf0743ece18 85 "STORAGE", "STCLK_OFF_DURING_SLEEP"]
demayer 0:6bf0743ece18 86 def check_device_has(dict):
demayer 0:6bf0743ece18 87 for name in dict.get("device_has", []):
demayer 0:6bf0743ece18 88 if name not in DEVICE_HAS_ALLOWED:
demayer 0:6bf0743ece18 89 yield "%s is not allowed in device_has" % name
demayer 0:6bf0743ece18 90
demayer 0:6bf0743ece18 91 MCU_REQUIRED_KEYS = ["release_versions", "supported_toolchains",
demayer 0:6bf0743ece18 92 "default_lib", "public", "inherits", "device_has"]
demayer 0:6bf0743ece18 93 MCU_ALLOWED_KEYS = ["device_has_add", "device_has_remove", "core",
demayer 0:6bf0743ece18 94 "extra_labels", "features", "features_add",
demayer 0:6bf0743ece18 95 "features_remove", "bootloader_supported", "device_name",
demayer 0:6bf0743ece18 96 "post_binary_hook", "default_toolchain", "config",
demayer 0:6bf0743ece18 97 "extra_labels_add", "extra_labels_remove",
demayer 0:6bf0743ece18 98 "target_overrides"] + MCU_REQUIRED_KEYS
demayer 0:6bf0743ece18 99 def check_mcu(mcu_json, strict=False):
demayer 0:6bf0743ece18 100 """Generate a list of problems with an MCU
demayer 0:6bf0743ece18 101
demayer 0:6bf0743ece18 102 :param: mcu_json the MCU's dict to check
demayer 0:6bf0743ece18 103 :param: strict enforce required keys
demayer 0:6bf0743ece18 104 """
demayer 0:6bf0743ece18 105 errors = list(may_have_keys(MCU_ALLOWED_KEYS, mcu_json))
demayer 0:6bf0743ece18 106 if strict:
demayer 0:6bf0743ece18 107 errors.extend(must_have_keys(MCU_REQUIRED_KEYS, mcu_json))
demayer 0:6bf0743ece18 108 errors.extend(check_extra_labels(mcu_json))
demayer 0:6bf0743ece18 109 errors.extend(check_release_version(mcu_json))
demayer 0:6bf0743ece18 110 errors.extend(check_inherits(mcu_json))
demayer 0:6bf0743ece18 111 errors.extend(check_device_has(mcu_json))
demayer 0:6bf0743ece18 112 if 'public' in mcu_json and mcu_json['public']:
demayer 0:6bf0743ece18 113 errors.append("public must be false")
demayer 0:6bf0743ece18 114 return errors
demayer 0:6bf0743ece18 115
demayer 0:6bf0743ece18 116 BOARD_REQUIRED_KEYS = ["inherits"]
demayer 0:6bf0743ece18 117 BOARD_ALLOWED_KEYS = ["supported_form_factors", "is_disk_virtual",
demayer 0:6bf0743ece18 118 "detect_code", "extra_labels", "extra_labels_add",
demayer 0:6bf0743ece18 119 "extra_labels_remove", "public", "config",
demayer 0:6bf0743ece18 120 "forced_reset_timeout", "target_overrides"] + BOARD_REQUIRED_KEYS
demayer 0:6bf0743ece18 121 def check_board(board_json, strict=False):
demayer 0:6bf0743ece18 122 """Generate a list of problems with an board
demayer 0:6bf0743ece18 123
demayer 0:6bf0743ece18 124 :param: board_json the mcus dict to check
demayer 0:6bf0743ece18 125 :param: strict enforce required keys
demayer 0:6bf0743ece18 126 """
demayer 0:6bf0743ece18 127 errors = list(may_have_keys(BOARD_ALLOWED_KEYS, board_json))
demayer 0:6bf0743ece18 128 if strict:
demayer 0:6bf0743ece18 129 errors.extend(must_have_keys(BOARD_REQUIRED_KEYS, board_json))
demayer 0:6bf0743ece18 130 errors.extend(check_extra_labels(board_json))
demayer 0:6bf0743ece18 131 errors.extend(check_inherits(board_json))
demayer 0:6bf0743ece18 132 return errors
demayer 0:6bf0743ece18 133
demayer 0:6bf0743ece18 134 def add_if(dict, key, val):
demayer 0:6bf0743ece18 135 """Add a value to a dict if it's non-empty"""
demayer 0:6bf0743ece18 136 if val:
demayer 0:6bf0743ece18 137 dict[key] = val
demayer 0:6bf0743ece18 138
demayer 0:6bf0743ece18 139 def _split_boards(resolution_order, tgt):
demayer 0:6bf0743ece18 140 """Split the resolution order between boards and mcus"""
demayer 0:6bf0743ece18 141 mcus = []
demayer 0:6bf0743ece18 142 boards = []
demayer 0:6bf0743ece18 143 iterable = iter(resolution_order)
demayer 0:6bf0743ece18 144 for name in iterable:
demayer 0:6bf0743ece18 145 mcu_json = tgt.json_data[name]
demayer 0:6bf0743ece18 146 if (len(list(check_mcu(mcu_json, True))) >
demayer 0:6bf0743ece18 147 len(list(check_board(mcu_json, True)))):
demayer 0:6bf0743ece18 148 boards.append(name)
demayer 0:6bf0743ece18 149 else:
demayer 0:6bf0743ece18 150 mcus.append(name)
demayer 0:6bf0743ece18 151 break
demayer 0:6bf0743ece18 152 mcus.extend(iterable)
demayer 0:6bf0743ece18 153 mcus.reverse()
demayer 0:6bf0743ece18 154 boards.reverse()
demayer 0:6bf0743ece18 155 return mcus, boards
demayer 0:6bf0743ece18 156
demayer 0:6bf0743ece18 157
demayer 0:6bf0743ece18 158 MCU_FORMAT_STRING = {1: "MCU (%s) ->",
demayer 0:6bf0743ece18 159 2: "Family (%s) -> MCU (%s) ->",
demayer 0:6bf0743ece18 160 3: "Family (%s) -> SubFamily (%s) -> MCU (%s) ->"}
demayer 0:6bf0743ece18 161 BOARD_FORMAT_STRING = {1: "Board (%s)",
demayer 0:6bf0743ece18 162 2: "Module (%s) -> Board (%s)"}
demayer 0:6bf0743ece18 163 def _generate_hierarchy_string(mcus, boards):
demayer 0:6bf0743ece18 164 global_errors = []
demayer 0:6bf0743ece18 165 if len(mcus) < 1:
demayer 0:6bf0743ece18 166 global_errors.append("No MCUS found in heirarchy")
demayer 0:6bf0743ece18 167 mcus_string = "??? ->"
demayer 0:6bf0743ece18 168 elif len(mcus) > 3:
demayer 0:6bf0743ece18 169 global_errors.append("No name for targets %s" % ", ".join(mcus[3:]))
demayer 0:6bf0743ece18 170 mcus_string = MCU_FORMAT_STRING[3] % tuple(mcus[:3])
demayer 0:6bf0743ece18 171 for name in mcus[3:]:
demayer 0:6bf0743ece18 172 mcus_string += " ??? (%s) ->" % name
demayer 0:6bf0743ece18 173 else:
demayer 0:6bf0743ece18 174 mcus_string = MCU_FORMAT_STRING[len(mcus)] % tuple(mcus)
demayer 0:6bf0743ece18 175
demayer 0:6bf0743ece18 176 if len(boards) < 1:
demayer 0:6bf0743ece18 177 global_errors.append("no boards found in heirarchy")
demayer 0:6bf0743ece18 178 boards_string = "???"
demayer 0:6bf0743ece18 179 elif len(boards) > 2:
demayer 0:6bf0743ece18 180 global_errors.append("no name for targets %s" % ", ".join(boards[2:]))
demayer 0:6bf0743ece18 181 boards_string = BOARD_FORMAT_STRING[2] % tuple(boards[:2])
demayer 0:6bf0743ece18 182 for name in boards[2:]:
demayer 0:6bf0743ece18 183 boards_string += " -> ??? (%s)" % name
demayer 0:6bf0743ece18 184 else:
demayer 0:6bf0743ece18 185 boards_string = BOARD_FORMAT_STRING[len(boards)] % tuple(boards)
demayer 0:6bf0743ece18 186 return mcus_string + " " + boards_string, global_errors
demayer 0:6bf0743ece18 187
demayer 0:6bf0743ece18 188
demayer 0:6bf0743ece18 189 def check_hierarchy(tgt):
demayer 0:6bf0743ece18 190 """Atempts to assign labels to the heirarchy"""
demayer 0:6bf0743ece18 191 resolution_order = copy(tgt.resolution_order_names[:-1])
demayer 0:6bf0743ece18 192 mcus, boards = _split_boards(resolution_order, tgt)
demayer 0:6bf0743ece18 193
demayer 0:6bf0743ece18 194 target_errors = {}
demayer 0:6bf0743ece18 195 hierachy_string, hierachy_errors = _generate_hierarchy_string(mcus, boards)
demayer 0:6bf0743ece18 196 to_ret = {"hierarchy": hierachy_string}
demayer 0:6bf0743ece18 197 add_if(to_ret, "hierarchy errors", hierachy_errors)
demayer 0:6bf0743ece18 198
demayer 0:6bf0743ece18 199 for name in mcus[:-1]:
demayer 0:6bf0743ece18 200 add_if(target_errors, name, list(check_mcu(tgt.json_data[name])))
demayer 0:6bf0743ece18 201 if len(mcus) >= 1:
demayer 0:6bf0743ece18 202 add_if(target_errors, mcus[-1],
demayer 0:6bf0743ece18 203 list(check_mcu(tgt.json_data[mcus[-1]], True)))
demayer 0:6bf0743ece18 204 for name in boards:
demayer 0:6bf0743ece18 205 add_if(target_errors, name, list(check_board(tgt.json_data[name])))
demayer 0:6bf0743ece18 206 if len(boards) >= 1:
demayer 0:6bf0743ece18 207 add_if(target_errors, boards[-1],
demayer 0:6bf0743ece18 208 list(check_board(tgt.json_data[boards[-1]], True)))
demayer 0:6bf0743ece18 209 add_if(to_ret, "target errors", target_errors)
demayer 0:6bf0743ece18 210 return to_ret
demayer 0:6bf0743ece18 211
demayer 0:6bf0743ece18 212 PARSER = argparse.ArgumentParser(prog="targets/lint.py")
demayer 0:6bf0743ece18 213 SUBPARSERS = PARSER.add_subparsers(title="Commands")
demayer 0:6bf0743ece18 214
demayer 0:6bf0743ece18 215 def subcommand(name, *args, **kwargs):
demayer 0:6bf0743ece18 216 def __subcommand(command):
demayer 0:6bf0743ece18 217 kwargs['description'] = command.__doc__
demayer 0:6bf0743ece18 218 subparser = SUBPARSERS.add_parser(name, **kwargs)
demayer 0:6bf0743ece18 219 for arg in args:
demayer 0:6bf0743ece18 220 arg = dict(arg)
demayer 0:6bf0743ece18 221 opt = arg['name']
demayer 0:6bf0743ece18 222 del arg['name']
demayer 0:6bf0743ece18 223
demayer 0:6bf0743ece18 224 if isinstance(opt, basestring):
demayer 0:6bf0743ece18 225 subparser.add_argument(opt, **arg)
demayer 0:6bf0743ece18 226 else:
demayer 0:6bf0743ece18 227 subparser.add_argument(*opt, **arg)
demayer 0:6bf0743ece18 228
demayer 0:6bf0743ece18 229 def _thunk(parsed_args):
demayer 0:6bf0743ece18 230 argv = [arg['dest'] if 'dest' in arg else arg['name']
demayer 0:6bf0743ece18 231 for arg in args]
demayer 0:6bf0743ece18 232 argv = [(arg if isinstance(arg, basestring)
demayer 0:6bf0743ece18 233 else arg[-1]).strip('-').replace('-', '_')
demayer 0:6bf0743ece18 234 for arg in argv]
demayer 0:6bf0743ece18 235 argv = {arg: vars(parsed_args)[arg] for arg in argv
demayer 0:6bf0743ece18 236 if vars(parsed_args)[arg] is not None}
demayer 0:6bf0743ece18 237
demayer 0:6bf0743ece18 238 return command(**argv)
demayer 0:6bf0743ece18 239
demayer 0:6bf0743ece18 240 subparser.set_defaults(command=_thunk)
demayer 0:6bf0743ece18 241 return command
demayer 0:6bf0743ece18 242 return __subcommand
demayer 0:6bf0743ece18 243
demayer 0:6bf0743ece18 244 @subcommand("targets",
demayer 0:6bf0743ece18 245 dict(name="mcus", nargs="+", metavar="MCU",
demayer 0:6bf0743ece18 246 choices=TARGET_MAP.keys(), type=str.upper))
demayer 0:6bf0743ece18 247 def targets_cmd(mcus=[]):
demayer 0:6bf0743ece18 248 """Find and print errors about specific targets"""
demayer 0:6bf0743ece18 249 print dump_all([check_hierarchy(TARGET_MAP[m]) for m in mcus],
demayer 0:6bf0743ece18 250 default_flow_style=False)
demayer 0:6bf0743ece18 251
demayer 0:6bf0743ece18 252 @subcommand("all-targets")
demayer 0:6bf0743ece18 253 def all_targets_cmd():
demayer 0:6bf0743ece18 254 """Print all errors about all parts"""
demayer 0:6bf0743ece18 255 print dump_all([check_hierarchy(m) for m in TARGET_MAP.values()],
demayer 0:6bf0743ece18 256 default_flow_style=False)
demayer 0:6bf0743ece18 257
demayer 0:6bf0743ece18 258 @subcommand("orphans")
demayer 0:6bf0743ece18 259 def orphans_cmd():
demayer 0:6bf0743ece18 260 """Find and print all orphan targets"""
demayer 0:6bf0743ece18 261 orphans = Target.get_json_target_data().keys()
demayer 0:6bf0743ece18 262 for tgt in TARGET_MAP.values():
demayer 0:6bf0743ece18 263 for name in tgt.resolution_order_names:
demayer 0:6bf0743ece18 264 if name in orphans:
demayer 0:6bf0743ece18 265 orphans.remove(name)
demayer 0:6bf0743ece18 266 if orphans:
demayer 0:6bf0743ece18 267 print dump_all([orphans], default_flow_style=False)
demayer 0:6bf0743ece18 268 return len(orphans)
demayer 0:6bf0743ece18 269
demayer 0:6bf0743ece18 270 def main():
demayer 0:6bf0743ece18 271 """entry point"""
demayer 0:6bf0743ece18 272 options = PARSER.parse_args()
demayer 0:6bf0743ece18 273 return options.command(options)
demayer 0:6bf0743ece18 274
demayer 0:6bf0743ece18 275 if __name__ == "__main__":
demayer 0:6bf0743ece18 276 sys.exit(main())
demayer 0:6bf0743ece18 277