EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

tools/targets/lint.py@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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