Anders Blomdell / mbed-sdk-tools

Clone of official tools

targets.py@35:da9c89f8be7d, 2017-02-15 (annotated)

Committer:
The Other Jimmy
Date:
Wed Feb 15 13:53:18 2017 -0600
Revision:
35:da9c89f8be7d
Parent:
31:8ea194f6145b 
Update tools to mbed-os 5.3.5

Who changed what in which revision?

UserRevisionLine numberNew contents of line
screamer 0:66f3b5499f7f 1 """
screamer 0:66f3b5499f7f 2 mbed SDK
screamer 0:66f3b5499f7f 3 Copyright (c) 2011-2016 ARM Limited
screamer 0:66f3b5499f7f 4
screamer 0:66f3b5499f7f 5 Licensed under the Apache License, Version 2.0 (the "License");
screamer 0:66f3b5499f7f 6 you may not use this file except in compliance with the License.
screamer 0:66f3b5499f7f 7 You may obtain a copy of the License at
screamer 0:66f3b5499f7f 8
screamer 0:66f3b5499f7f 9 http://www.apache.org/licenses/LICENSE-2.0
screamer 0:66f3b5499f7f 10
screamer 0:66f3b5499f7f 11 Unless required by applicable law or agreed to in writing, software
screamer 0:66f3b5499f7f 12 distributed under the License is distributed on an "AS IS" BASIS,
screamer 0:66f3b5499f7f 13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
screamer 0:66f3b5499f7f 14 See the License for the specific language governing permissions and
screamer 0:66f3b5499f7f 15 limitations under the License.
screamer 0:66f3b5499f7f 16 """
screamer 0:66f3b5499f7f 17
screamer 29:1210849dba19 18 import os
screamer 29:1210849dba19 19 import binascii
screamer 29:1210849dba19 20 import struct
screamer 29:1210849dba19 21 import shutil
screamer 29:1210849dba19 22 import inspect
screamer 29:1210849dba19 23 import sys
The Other Jimmy 35:da9c89f8be7d 24 from copy import copy
The Other Jimmy 31:8ea194f6145b 25 from collections import namedtuple
screamer 29:1210849dba19 26 from tools.patch import patch
screamer 29:1210849dba19 27 from tools.paths import TOOLS_BOOTLOADERS
screamer 29:1210849dba19 28 from tools.utils import json_file_to_dict
screamer 29:1210849dba19 29
The Other Jimmy 31:8ea194f6145b 30 __all__ = ["target", "TARGETS", "TARGET_MAP", "TARGET_NAMES", "CORE_LABELS",
The Other Jimmy 31:8ea194f6145b 31 "HookError", "generate_py_target", "Target",
The Other Jimmy 31:8ea194f6145b 32 "CUMULATIVE_ATTRIBUTES", "get_resolution_order"]
The Other Jimmy 31:8ea194f6145b 33
screamer 0:66f3b5499f7f 34 CORE_LABELS = {
screamer 0:66f3b5499f7f 35 "ARM7TDMI-S": ["ARM7", "LIKE_CORTEX_ARM7"],
screamer 0:66f3b5499f7f 36 "Cortex-M0" : ["M0", "CORTEX_M", "LIKE_CORTEX_M0"],
screamer 0:66f3b5499f7f 37 "Cortex-M0+": ["M0P", "CORTEX_M", "LIKE_CORTEX_M0"],
screamer 0:66f3b5499f7f 38 "Cortex-M1" : ["M1", "CORTEX_M", "LIKE_CORTEX_M1"],
screamer 0:66f3b5499f7f 39 "Cortex-M3" : ["M3", "CORTEX_M", "LIKE_CORTEX_M3"],
screamer 0:66f3b5499f7f 40 "Cortex-M4" : ["M4", "CORTEX_M", "RTOS_M4_M7", "LIKE_CORTEX_M4"],
screamer 0:66f3b5499f7f 41 "Cortex-M4F" : ["M4", "CORTEX_M", "RTOS_M4_M7", "LIKE_CORTEX_M4"],
screamer 0:66f3b5499f7f 42 "Cortex-M7" : ["M7", "CORTEX_M", "RTOS_M4_M7", "LIKE_CORTEX_M7"],
screamer 0:66f3b5499f7f 43 "Cortex-M7F" : ["M7", "CORTEX_M", "RTOS_M4_M7", "LIKE_CORTEX_M7"],
screamer 13:ab47a20b66f0 44 "Cortex-M7FD" : ["M7", "CORTEX_M", "RTOS_M4_M7", "LIKE_CORTEX_M7"],
screamer 0:66f3b5499f7f 45 "Cortex-A9" : ["A9", "CORTEX_A", "LIKE_CORTEX_A9"]
screamer 0:66f3b5499f7f 46 }
screamer 0:66f3b5499f7f 47
screamer 29:1210849dba19 48 ################################################################################
screamer 7:5af61d55adbe 49 # Generic Target class that reads and interprets the data in targets.json
screamer 7:5af61d55adbe 50
screamer 7:5af61d55adbe 51 class HookError(Exception):
screamer 29:1210849dba19 52 """ A simple class that represents all the exceptions associated with
screamer 29:1210849dba19 53 hooking
screamer 29:1210849dba19 54 """
screamer 7:5af61d55adbe 55 pass
screamer 7:5af61d55adbe 56
screamer 29:1210849dba19 57 CACHES = {}
screamer 7:5af61d55adbe 58 def cached(func):
screamer 29:1210849dba19 59 """A simple decorator used for automatically caching data returned by a
screamer 29:1210849dba19 60 function
screamer 29:1210849dba19 61 """
screamer 7:5af61d55adbe 62 def wrapper(*args, **kwargs):
screamer 29:1210849dba19 63 """The wrapped function itself"""
screamer 29:1210849dba19 64 if not CACHES.has_key((func.__name__, args)):
screamer 29:1210849dba19 65 CACHES[(func.__name__, args)] = func(*args, **kwargs)
screamer 29:1210849dba19 66 return CACHES[(func.__name__, args)]
screamer 7:5af61d55adbe 67 return wrapper
screamer 0:66f3b5499f7f 68
The Other Jimmy 31:8ea194f6145b 69
The Other Jimmy 31:8ea194f6145b 70 # Cumulative attributes can have values appended to them, so they
The Other Jimmy 31:8ea194f6145b 71 # need to be computed differently than regular attributes
The Other Jimmy 31:8ea194f6145b 72 CUMULATIVE_ATTRIBUTES = ['extra_labels', 'macros', 'device_has', 'features']
The Other Jimmy 31:8ea194f6145b 73
The Other Jimmy 31:8ea194f6145b 74
The Other Jimmy 31:8ea194f6145b 75 def get_resolution_order(json_data, target_name, order, level=0):
The Other Jimmy 31:8ea194f6145b 76 """ Return the order in which target descriptions are searched for
The Other Jimmy 31:8ea194f6145b 77 attributes. This mimics the Python 2.2 method resolution order, which
The Other Jimmy 31:8ea194f6145b 78 is what the old targets.py module used. For more details, check
The Other Jimmy 31:8ea194f6145b 79 http://makina-corpus.com/blog/metier/2014/python-tutorial-understanding-python-mro-class-search-path
The Other Jimmy 31:8ea194f6145b 80 The resolution order contains (name, level) tuples, where "name" is the
The Other Jimmy 31:8ea194f6145b 81 name of the class and "level" is the level in the inheritance hierarchy
The Other Jimmy 31:8ea194f6145b 82 (the target itself is at level 0, its first parent at level 1, its
The Other Jimmy 31:8ea194f6145b 83 parent's parent at level 2 and so on)
The Other Jimmy 31:8ea194f6145b 84 """
The Other Jimmy 31:8ea194f6145b 85 # the resolution order can't contain duplicate target names
The Other Jimmy 31:8ea194f6145b 86 if target_name not in [l[0] for l in order]:
The Other Jimmy 31:8ea194f6145b 87 order.append((target_name, level))
The Other Jimmy 31:8ea194f6145b 88 parents = json_data[target_name].get("inherits", [])
The Other Jimmy 31:8ea194f6145b 89 for par in parents:
The Other Jimmy 31:8ea194f6145b 90 order = get_resolution_order(json_data, par, order, level + 1)
The Other Jimmy 31:8ea194f6145b 91 return order
The Other Jimmy 31:8ea194f6145b 92
The Other Jimmy 31:8ea194f6145b 93
The Other Jimmy 31:8ea194f6145b 94 def target(name, json_data):
The Other Jimmy 31:8ea194f6145b 95 """Construct a target object"""
The Other Jimmy 31:8ea194f6145b 96 resolution_order = get_resolution_order(json_data, name, [])
The Other Jimmy 31:8ea194f6145b 97 resolution_order_names = [tgt for tgt, _ in resolution_order]
The Other Jimmy 31:8ea194f6145b 98 return Target(name=name,
The Other Jimmy 31:8ea194f6145b 99 json_data={key: value for key, value in json_data.items()
The Other Jimmy 31:8ea194f6145b 100 if key in resolution_order_names},
The Other Jimmy 31:8ea194f6145b 101 resolution_order=resolution_order,
The Other Jimmy 31:8ea194f6145b 102 resolution_order_names=resolution_order_names)
The Other Jimmy 31:8ea194f6145b 103
The Other Jimmy 31:8ea194f6145b 104 def generate_py_target(new_targets, name):
The Other Jimmy 31:8ea194f6145b 105 """Add one or more new target(s) represented as a Python dictionary
The Other Jimmy 31:8ea194f6145b 106 in 'new_targets'. It is an error to add a target with a name that
The Other Jimmy 31:8ea194f6145b 107 already exists.
The Other Jimmy 31:8ea194f6145b 108 """
The Other Jimmy 31:8ea194f6145b 109 base_targets = Target.get_json_target_data()
The Other Jimmy 31:8ea194f6145b 110 for new_target in new_targets.keys():
The Other Jimmy 31:8ea194f6145b 111 if new_target in base_targets:
The Other Jimmy 31:8ea194f6145b 112 raise Exception("Attempt to add target '%s' that already exists"
The Other Jimmy 31:8ea194f6145b 113 % new_target)
The Other Jimmy 31:8ea194f6145b 114 total_data = {}
The Other Jimmy 31:8ea194f6145b 115 total_data.update(new_targets)
The Other Jimmy 31:8ea194f6145b 116 total_data.update(base_targets)
The Other Jimmy 31:8ea194f6145b 117 return target(name, total_data)
The Other Jimmy 31:8ea194f6145b 118
The Other Jimmy 31:8ea194f6145b 119 class Target(namedtuple("Target", "name json_data resolution_order resolution_order_names")):
screamer 29:1210849dba19 120 """An object to represent a Target (MCU/Board)"""
screamer 7:5af61d55adbe 121
screamer 29:1210849dba19 122 # Default location of the 'targets.json' file
screamer 29:1210849dba19 123 __targets_json_location_default = os.path.join(
screamer 29:1210849dba19 124 os.path.dirname(os.path.abspath(__file__)), 'latest_targets.json')
screamer 16:a6285a7e5cc6 125
screamer 29:1210849dba19 126 # Current/new location of the 'targets.json' file
screamer 29:1210849dba19 127 __targets_json_location = None
screamer 29:1210849dba19 128
screamer 7:5af61d55adbe 129 @staticmethod
screamer 7:5af61d55adbe 130 @cached
screamer 7:5af61d55adbe 131 def get_json_target_data():
screamer 29:1210849dba19 132 """Load the description of JSON target data"""
screamer 29:1210849dba19 133 return json_file_to_dict(Target.__targets_json_location or
screamer 29:1210849dba19 134 Target.__targets_json_location_default)
screamer 16:a6285a7e5cc6 135
screamer 16:a6285a7e5cc6 136 @staticmethod
screamer 29:1210849dba19 137 def set_targets_json_location(location=None):
screamer 29:1210849dba19 138 """Set the location of the targets.json file"""
screamer 29:1210849dba19 139 Target.__targets_json_location = (location or
screamer 29:1210849dba19 140 Target.__targets_json_location_default)
screamer 16:a6285a7e5cc6 141 # Invalidate caches, since the location of the JSON file changed
screamer 29:1210849dba19 142 CACHES.clear()
screamer 7:5af61d55adbe 143
screamer 7:5af61d55adbe 144 @staticmethod
screamer 7:5af61d55adbe 145 @cached
screamer 7:5af61d55adbe 146 def get_module_data():
screamer 29:1210849dba19 147 """Get the members of this module using Python's "inspect" module"""
screamer 29:1210849dba19 148 return dict([(m[0], m[1]) for m in
screamer 29:1210849dba19 149 inspect.getmembers(sys.modules[__name__])])
screamer 0:66f3b5499f7f 150
screamer 7:5af61d55adbe 151 @staticmethod
screamer 7:5af61d55adbe 152 def __add_paths_to_progen(data):
screamer 29:1210849dba19 153 """Modify the exporter specification ("progen") by changing all
screamer 29:1210849dba19 154 "template" keys to full paths
screamer 29:1210849dba19 155 """
screamer 7:5af61d55adbe 156 out = {}
screamer 29:1210849dba19 157 for key, val in data.items():
screamer 29:1210849dba19 158 if isinstance(val, dict):
screamer 29:1210849dba19 159 out[key] = Target.__add_paths_to_progen(val)
screamer 7:5af61d55adbe 160 elif key == "template":
screamer 29:1210849dba19 161 out[key] = [os.path.join(os.path.dirname(__file__), 'export', v)
screamer 29:1210849dba19 162 for v in val]
screamer 7:5af61d55adbe 163 else:
screamer 29:1210849dba19 164 out[key] = val
screamer 7:5af61d55adbe 165 return out
screamer 0:66f3b5499f7f 166
screamer 29:1210849dba19 167 def __getattr_cumulative(self, attrname):
screamer 29:1210849dba19 168 """Look for the attribute in the class and its parents, as defined by
screamer 29:1210849dba19 169 the resolution order
screamer 29:1210849dba19 170 """
The Other Jimmy 31:8ea194f6145b 171 tdata = self.json_data
screamer 29:1210849dba19 172 # For a cumulative attribute, figure out when it was defined the
screamer 29:1210849dba19 173 # last time (in attribute resolution order) then follow the "_add"
screamer 29:1210849dba19 174 # and "_remove" data fields
The Other Jimmy 31:8ea194f6145b 175 for idx, tgt in enumerate(self.resolution_order):
screamer 29:1210849dba19 176 # the attribute was defined at this level in the resolution
screamer 29:1210849dba19 177 # order
The Other Jimmy 31:8ea194f6145b 178 if attrname in tdata[tgt[0]]:
screamer 29:1210849dba19 179 def_idx = idx
screamer 29:1210849dba19 180 break
screamer 29:1210849dba19 181 else:
screamer 29:1210849dba19 182 raise AttributeError("Attribute '%s' not found in target '%s'"
screamer 29:1210849dba19 183 % (attrname, self.name))
screamer 29:1210849dba19 184 # Get the starting value of the attribute
screamer 29:1210849dba19 185 starting_value = (tdata[self.resolution_order[def_idx][0]][attrname]
screamer 29:1210849dba19 186 or [])[:]
screamer 29:1210849dba19 187 # Traverse the resolution list in high inheritance to low
screamer 29:1210849dba19 188 # inheritance level, left to right order to figure out all the
screamer 29:1210849dba19 189 # other classes that change the definition by adding or removing
screamer 29:1210849dba19 190 # elements
screamer 29:1210849dba19 191 for idx in xrange(self.resolution_order[def_idx][1] - 1, -1, -1):
screamer 29:1210849dba19 192 same_level_targets = [tar[0] for tar in self.resolution_order
screamer 29:1210849dba19 193 if tar[1] == idx]
screamer 29:1210849dba19 194 for tar in same_level_targets:
screamer 29:1210849dba19 195 data = tdata[tar]
screamer 29:1210849dba19 196 # Do we have anything to add ?
screamer 29:1210849dba19 197 if data.has_key(attrname + "_add"):
screamer 29:1210849dba19 198 starting_value.extend(data[attrname + "_add"])
screamer 29:1210849dba19 199 # Do we have anything to remove ?
screamer 29:1210849dba19 200 if data.has_key(attrname + "_remove"):
screamer 29:1210849dba19 201 # Macros can be defined either without a value (MACRO)
screamer 29:1210849dba19 202 # or with a value (MACRO=10). When removing, we specify
screamer 29:1210849dba19 203 # only the name of the macro, without the value. So we
screamer 29:1210849dba19 204 # need to create a mapping between the macro name and
screamer 29:1210849dba19 205 # its value. This will work for extra_labels and other
screamer 29:1210849dba19 206 # type of arrays as well, since they fall into the
screamer 29:1210849dba19 207 # "macros without a value" category (simple definitions
screamer 29:1210849dba19 208 # without a value).
screamer 29:1210849dba19 209 name_def_map = {}
screamer 29:1210849dba19 210 for crtv in starting_value:
screamer 29:1210849dba19 211 if crtv.find('=') != -1:
screamer 29:1210849dba19 212 temp = crtv.split('=')
screamer 29:1210849dba19 213 if len(temp) != 2:
screamer 29:1210849dba19 214 raise ValueError(
screamer 29:1210849dba19 215 "Invalid macro definition '%s'" % crtv)
screamer 29:1210849dba19 216 name_def_map[temp[0]] = crtv
screamer 29:1210849dba19 217 else:
screamer 29:1210849dba19 218 name_def_map[crtv] = crtv
screamer 29:1210849dba19 219 for element in data[attrname + "_remove"]:
screamer 29:1210849dba19 220 if element not in name_def_map:
screamer 29:1210849dba19 221 raise ValueError(
screamer 29:1210849dba19 222 ("Unable to remove '%s' in '%s.%s' since "
screamer 29:1210849dba19 223 % (element, self.name, attrname)) +
screamer 29:1210849dba19 224 "it doesn't exist")
screamer 29:1210849dba19 225 starting_value.remove(name_def_map[element])
screamer 29:1210849dba19 226 return starting_value
screamer 29:1210849dba19 227
screamer 29:1210849dba19 228 def __getattr_helper(self, attrname):
screamer 29:1210849dba19 229 """Compute the value of a given target attribute"""
The Other Jimmy 31:8ea194f6145b 230 if attrname in CUMULATIVE_ATTRIBUTES:
screamer 29:1210849dba19 231 return self.__getattr_cumulative(attrname)
screamer 29:1210849dba19 232 else:
The Other Jimmy 31:8ea194f6145b 233 tdata = self.json_data
screamer 29:1210849dba19 234 starting_value = None
The Other Jimmy 31:8ea194f6145b 235 for tgt in self.resolution_order:
The Other Jimmy 31:8ea194f6145b 236 data = tdata[tgt[0]]
screamer 29:1210849dba19 237 if data.has_key(attrname):
screamer 29:1210849dba19 238 starting_value = data[attrname]
screamer 7:5af61d55adbe 239 break
screamer 29:1210849dba19 240 else: # Attribute not found
screamer 29:1210849dba19 241 raise AttributeError(
screamer 29:1210849dba19 242 "Attribute '%s' not found in target '%s'"
screamer 29:1210849dba19 243 % (attrname, self.name))
screamer 29:1210849dba19 244 # 'progen' needs the full path to the template (the path in JSON is
screamer 29:1210849dba19 245 # relative to tools/export)
screamer 29:1210849dba19 246 if attrname == "progen":
screamer 29:1210849dba19 247 return self.__add_paths_to_progen(starting_value)
screamer 7:5af61d55adbe 248 else:
screamer 29:1210849dba19 249 return starting_value
screamer 0:66f3b5499f7f 250
screamer 7:5af61d55adbe 251 def __getattr__(self, attrname):
screamer 29:1210849dba19 252 """ Return the value of an attribute. This function only computes the
screamer 29:1210849dba19 253 attribute's value once, then adds it to the instance attributes (in
screamer 29:1210849dba19 254 __dict__), so the next time it is returned directly
screamer 29:1210849dba19 255 """
screamer 29:1210849dba19 256 result = self.__getattr_helper(attrname)
screamer 29:1210849dba19 257 self.__dict__[attrname] = result
screamer 29:1210849dba19 258 return result
screamer 0:66f3b5499f7f 259
screamer 7:5af61d55adbe 260 @staticmethod
screamer 16:a6285a7e5cc6 261 @cached
screamer 29:1210849dba19 262 def get_target(target_name):
screamer 29:1210849dba19 263 """ Return the target instance starting from the target name """
The Other Jimmy 31:8ea194f6145b 264 return target(target_name, Target.get_json_target_data())
screamer 7:5af61d55adbe 265
screamer 0:66f3b5499f7f 266
screamer 13:ab47a20b66f0 267 @property
screamer 0:66f3b5499f7f 268 def program_cycle_s(self):
screamer 29:1210849dba19 269 """Special override for program_cycle_s as it's default value depends
screamer 29:1210849dba19 270 upon is_disk_virtual
screamer 29:1210849dba19 271 """
screamer 7:5af61d55adbe 272 try:
screamer 7:5af61d55adbe 273 return self.__getattr__("program_cycle_s")
screamer 7:5af61d55adbe 274 except AttributeError:
screamer 7:5af61d55adbe 275 return 4 if self.is_disk_virtual else 1.5
screamer 0:66f3b5499f7f 276
The Other Jimmy 31:8ea194f6145b 277 @property
The Other Jimmy 31:8ea194f6145b 278 def labels(self):
screamer 29:1210849dba19 279 """Get all possible labels for this target"""
The Other Jimmy 35:da9c89f8be7d 280 names = copy(self.resolution_order_names)
The Other Jimmy 35:da9c89f8be7d 281 if "Target" in names:
The Other Jimmy 35:da9c89f8be7d 282 names.remove("Target")
The Other Jimmy 35:da9c89f8be7d 283 labels = (names + CORE_LABELS[self.core] + self.extra_labels)
screamer 29:1210849dba19 284 # Automatically define UVISOR_UNSUPPORTED if the target doesn't
screamer 29:1210849dba19 285 # specifically define UVISOR_SUPPORTED
screamer 29:1210849dba19 286 if "UVISOR_SUPPORTED" not in labels:
screamer 13:ab47a20b66f0 287 labels.append("UVISOR_UNSUPPORTED")
screamer 13:ab47a20b66f0 288 return labels
screamer 0:66f3b5499f7f 289
screamer 0:66f3b5499f7f 290 def init_hooks(self, hook, toolchain_name):
screamer 29:1210849dba19 291 """Initialize the post-build hooks for a toolchain. For now, this
screamer 29:1210849dba19 292 function only allows "post binary" hooks (hooks that are executed
screamer 29:1210849dba19 293 after the binary image is extracted from the executable file)
screamer 29:1210849dba19 294 """
screamer 29:1210849dba19 295
screamer 7:5af61d55adbe 296 # If there's no hook, simply return
screamer 7:5af61d55adbe 297 try:
screamer 7:5af61d55adbe 298 hook_data = self.post_binary_hook
screamer 7:5af61d55adbe 299 except AttributeError:
screamer 7:5af61d55adbe 300 return
screamer 29:1210849dba19 301 # A hook was found. The hook's name is in the format
screamer 29:1210849dba19 302 # "classname.functionname"
screamer 7:5af61d55adbe 303 temp = hook_data["function"].split(".")
screamer 7:5af61d55adbe 304 if len(temp) != 2:
screamer 29:1210849dba19 305 raise HookError(
screamer 29:1210849dba19 306 ("Invalid format for hook '%s' in target '%s'"
screamer 29:1210849dba19 307 % (hook_data["function"], self.name)) +
screamer 29:1210849dba19 308 " (must be 'class_name.function_name')")
screamer 7:5af61d55adbe 309 class_name, function_name = temp[0], temp[1]
screamer 29:1210849dba19 310 # "class_name" must refer to a class in this file, so check if the
screamer 29:1210849dba19 311 # class exists
screamer 7:5af61d55adbe 312 mdata = self.get_module_data()
screamer 29:1210849dba19 313 if not mdata.has_key(class_name) or \
screamer 29:1210849dba19 314 not inspect.isclass(mdata[class_name]):
screamer 29:1210849dba19 315 raise HookError(
screamer 29:1210849dba19 316 ("Class '%s' required by '%s' in target '%s'"
screamer 29:1210849dba19 317 % (class_name, hook_data["function"], self.name)) +
screamer 29:1210849dba19 318 " not found in targets.py")
screamer 29:1210849dba19 319 # "function_name" must refer to a static function inside class
screamer 29:1210849dba19 320 # "class_name"
screamer 7:5af61d55adbe 321 cls = mdata[class_name]
screamer 29:1210849dba19 322 if (not hasattr(cls, function_name)) or \
screamer 29:1210849dba19 323 (not inspect.isfunction(getattr(cls, function_name))):
screamer 29:1210849dba19 324 raise HookError(
screamer 29:1210849dba19 325 ("Static function '%s' " % function_name) +
screamer 29:1210849dba19 326 ("required by '%s' " % hook_data["function"]) +
screamer 29:1210849dba19 327 ("in target '%s' " % self.name) +
screamer 29:1210849dba19 328 ("not found in class '%s'" % class_name))
screamer 7:5af61d55adbe 329 # Check if the hook specification also has target restrictions
screamer 7:5af61d55adbe 330 toolchain_restrictions = hook_data.get("toolchains", [])
screamer 29:1210849dba19 331 if toolchain_restrictions and \
screamer 29:1210849dba19 332 (toolchain_name not in toolchain_restrictions):
screamer 7:5af61d55adbe 333 return
screamer 7:5af61d55adbe 334 # Finally, hook the requested function
screamer 7:5af61d55adbe 335 hook.hook_add_binary("post", getattr(cls, function_name))
screamer 0:66f3b5499f7f 336
screamer 29:1210849dba19 337 ################################################################################
screamer 7:5af61d55adbe 338 # Target specific code goes in this section
screamer 29:1210849dba19 339 # This code can be invoked from the target description using the
screamer 29:1210849dba19 340 # "post_binary_hook" key
screamer 0:66f3b5499f7f 341
screamer 29:1210849dba19 342 class LPCTargetCode(object):
screamer 29:1210849dba19 343 """General LPC Target patching code"""
screamer 0:66f3b5499f7f 344 @staticmethod
screamer 0:66f3b5499f7f 345 def lpc_patch(t_self, resources, elf, binf):
screamer 29:1210849dba19 346 """Patch an elf file"""
screamer 0:66f3b5499f7f 347 t_self.debug("LPC Patch: %s" % os.path.split(binf)[1])
screamer 0:66f3b5499f7f 348 patch(binf)
screamer 0:66f3b5499f7f 349
screamer 29:1210849dba19 350 class LPC4088Code(object):
screamer 29:1210849dba19 351 """Code specific to the LPC4088"""
screamer 0:66f3b5499f7f 352 @staticmethod
screamer 0:66f3b5499f7f 353 def binary_hook(t_self, resources, elf, binf):
screamer 29:1210849dba19 354 """Hook to be run after an elf file is built"""
screamer 0:66f3b5499f7f 355 if not os.path.isdir(binf):
screamer 0:66f3b5499f7f 356 # Regular binary file, nothing to do
screamer 7:5af61d55adbe 357 LPCTargetCode.lpc_patch(t_self, resources, elf, binf)
screamer 0:66f3b5499f7f 358 return
screamer 0:66f3b5499f7f 359 outbin = open(binf + ".temp", "wb")
screamer 0:66f3b5499f7f 360 partf = open(os.path.join(binf, "ER_IROM1"), "rb")
screamer 0:66f3b5499f7f 361 # Pad the fist part (internal flash) with 0xFF to 512k
screamer 0:66f3b5499f7f 362 data = partf.read()
screamer 0:66f3b5499f7f 363 outbin.write(data)
screamer 0:66f3b5499f7f 364 outbin.write('\xFF' * (512*1024 - len(data)))
screamer 0:66f3b5499f7f 365 partf.close()
screamer 29:1210849dba19 366 # Read and append the second part (external flash) in chunks of fixed
screamer 29:1210849dba19 367 # size
screamer 0:66f3b5499f7f 368 chunksize = 128 * 1024
screamer 0:66f3b5499f7f 369 partf = open(os.path.join(binf, "ER_IROM2"), "rb")
screamer 0:66f3b5499f7f 370 while True:
screamer 0:66f3b5499f7f 371 data = partf.read(chunksize)
screamer 0:66f3b5499f7f 372 outbin.write(data)
screamer 0:66f3b5499f7f 373 if len(data) < chunksize:
screamer 0:66f3b5499f7f 374 break
screamer 0:66f3b5499f7f 375 partf.close()
screamer 0:66f3b5499f7f 376 outbin.close()
screamer 0:66f3b5499f7f 377 # Remove the directory with the binary parts and rename the temporary
screamer 0:66f3b5499f7f 378 # file to 'binf'
screamer 0:66f3b5499f7f 379 shutil.rmtree(binf, True)
screamer 0:66f3b5499f7f 380 os.rename(binf + '.temp', binf)
screamer 0:66f3b5499f7f 381 t_self.debug("Generated custom binary file (internal flash + SPIFI)")
screamer 7:5af61d55adbe 382 LPCTargetCode.lpc_patch(t_self, resources, elf, binf)
screamer 0:66f3b5499f7f 383
screamer 29:1210849dba19 384 class TEENSY3_1Code(object):
screamer 29:1210849dba19 385 """Hooks for the TEENSY3.1"""
screamer 0:66f3b5499f7f 386 @staticmethod
screamer 0:66f3b5499f7f 387 def binary_hook(t_self, resources, elf, binf):
screamer 29:1210849dba19 388 """Hook that is run after elf is generated"""
screamer 0:66f3b5499f7f 389 from intelhex import IntelHex
screamer 0:66f3b5499f7f 390 binh = IntelHex()
screamer 29:1210849dba19 391 binh.loadbin(binf, offset=0)
screamer 29:1210849dba19 392
screamer 29:1210849dba19 393 with open(binf.replace(".bin", ".hex"), "w") as file_desc:
screamer 29:1210849dba19 394 binh.tofile(file_desc, format='hex')
screamer 0:66f3b5499f7f 395
screamer 29:1210849dba19 396 class MTSCode(object):
screamer 29:1210849dba19 397 """Generic MTS code"""
screamer 0:66f3b5499f7f 398 @staticmethod
screamer 29:1210849dba19 399 def _combine_bins_helper(target_name, binf):
screamer 29:1210849dba19 400 """combine bins with the bootloader for a particular target"""
screamer 7:5af61d55adbe 401 loader = os.path.join(TOOLS_BOOTLOADERS, target_name, "bootloader.bin")
screamer 0:66f3b5499f7f 402 target = binf + ".tmp"
screamer 0:66f3b5499f7f 403 if not os.path.exists(loader):
screamer 0:66f3b5499f7f 404 print "Can't find bootloader binary: " + loader
screamer 0:66f3b5499f7f 405 return
screamer 0:66f3b5499f7f 406 outbin = open(target, 'w+b')
screamer 0:66f3b5499f7f 407 part = open(loader, 'rb')
screamer 0:66f3b5499f7f 408 data = part.read()
screamer 0:66f3b5499f7f 409 outbin.write(data)
screamer 0:66f3b5499f7f 410 outbin.write('\xFF' * (64*1024 - len(data)))
screamer 0:66f3b5499f7f 411 part.close()
screamer 0:66f3b5499f7f 412 part = open(binf, 'rb')
screamer 0:66f3b5499f7f 413 data = part.read()
screamer 0:66f3b5499f7f 414 outbin.write(data)
screamer 0:66f3b5499f7f 415 part.close()
screamer 0:66f3b5499f7f 416 outbin.seek(0, 0)
screamer 0:66f3b5499f7f 417 data = outbin.read()
screamer 0:66f3b5499f7f 418 outbin.seek(0, 1)
screamer 0:66f3b5499f7f 419 crc = struct.pack('<I', binascii.crc32(data) & 0xFFFFFFFF)
screamer 0:66f3b5499f7f 420 outbin.write(crc)
screamer 0:66f3b5499f7f 421 outbin.close()
screamer 0:66f3b5499f7f 422 os.remove(binf)
screamer 0:66f3b5499f7f 423 os.rename(target, binf)
screamer 0:66f3b5499f7f 424
screamer 0:66f3b5499f7f 425 @staticmethod
screamer 7:5af61d55adbe 426 def combine_bins_mts_dot(t_self, resources, elf, binf):
screamer 29:1210849dba19 427 """A hook for the MTS MDOT"""
screamer 29:1210849dba19 428 MTSCode._combine_bins_helper("MTS_MDOT_F411RE", binf)
screamer 0:66f3b5499f7f 429
screamer 7:5af61d55adbe 430 @staticmethod
screamer 7:5af61d55adbe 431 def combine_bins_mts_dragonfly(t_self, resources, elf, binf):
screamer 29:1210849dba19 432 """A hoof for the MTS Dragonfly"""
screamer 29:1210849dba19 433 MTSCode._combine_bins_helper("MTS_DRAGONFLY_F411RE", binf)
screamer 0:66f3b5499f7f 434
screamer 29:1210849dba19 435 class MCU_NRF51Code(object):
screamer 29:1210849dba19 436 """NRF51 Hooks"""
screamer 0:66f3b5499f7f 437 @staticmethod
screamer 29:1210849dba19 438 def binary_hook(t_self, resources, _, binf):
screamer 29:1210849dba19 439 """Hook that merges the soft device with the bin file"""
screamer 0:66f3b5499f7f 440 # Scan to find the actual paths of soft device
screamer 0:66f3b5499f7f 441 sdf = None
screamer 29:1210849dba19 442 for softdevice_and_offset_entry\
screamer 29:1210849dba19 443 in t_self.target.EXPECTED_SOFTDEVICES_WITH_OFFSETS:
screamer 0:66f3b5499f7f 444 for hexf in resources.hex_files:
screamer 29:1210849dba19 445 if hexf.find(softdevice_and_offset_entry['name']) != -1:
screamer 29:1210849dba19 446 t_self.debug("SoftDevice file found %s."
screamer 29:1210849dba19 447 % softdevice_and_offset_entry['name'])
screamer 0:66f3b5499f7f 448 sdf = hexf
screamer 0:66f3b5499f7f 449
screamer 29:1210849dba19 450 if sdf is not None:
screamer 29:1210849dba19 451 break
screamer 29:1210849dba19 452 if sdf is not None:
screamer 29:1210849dba19 453 break
screamer 0:66f3b5499f7f 454
screamer 0:66f3b5499f7f 455 if sdf is None:
screamer 0:66f3b5499f7f 456 t_self.debug("Hex file not found. Aborting.")
screamer 0:66f3b5499f7f 457 return
screamer 0:66f3b5499f7f 458
screamer 29:1210849dba19 459 # Look for bootloader file that matches this soft device or bootloader
screamer 29:1210849dba19 460 # override image
screamer 0:66f3b5499f7f 461 blf = None
screamer 0:66f3b5499f7f 462 if t_self.target.MERGE_BOOTLOADER is True:
screamer 0:66f3b5499f7f 463 for hexf in resources.hex_files:
screamer 0:66f3b5499f7f 464 if hexf.find(t_self.target.OVERRIDE_BOOTLOADER_FILENAME) != -1:
screamer 29:1210849dba19 465 t_self.debug("Bootloader file found %s."
screamer 29:1210849dba19 466 % t_self.target.OVERRIDE_BOOTLOADER_FILENAME)
screamer 0:66f3b5499f7f 467 blf = hexf
screamer 0:66f3b5499f7f 468 break
screamer 29:1210849dba19 469 elif hexf.find(softdevice_and_offset_entry['boot']) != -1:
screamer 29:1210849dba19 470 t_self.debug("Bootloader file found %s."
screamer 29:1210849dba19 471 % softdevice_and_offset_entry['boot'])
screamer 0:66f3b5499f7f 472 blf = hexf
screamer 0:66f3b5499f7f 473 break
screamer 0:66f3b5499f7f 474
screamer 0:66f3b5499f7f 475 # Merge user code with softdevice
screamer 0:66f3b5499f7f 476 from intelhex import IntelHex
screamer 0:66f3b5499f7f 477 binh = IntelHex()
screamer 29:1210849dba19 478 binh.loadbin(binf, offset=softdevice_and_offset_entry['offset'])
screamer 0:66f3b5499f7f 479
screamer 0:66f3b5499f7f 480 if t_self.target.MERGE_SOFT_DEVICE is True:
screamer 29:1210849dba19 481 t_self.debug("Merge SoftDevice file %s"
screamer 29:1210849dba19 482 % softdevice_and_offset_entry['name'])
screamer 0:66f3b5499f7f 483 sdh = IntelHex(sdf)
screamer 0:66f3b5499f7f 484 binh.merge(sdh)
screamer 0:66f3b5499f7f 485
screamer 0:66f3b5499f7f 486 if t_self.target.MERGE_BOOTLOADER is True and blf is not None:
screamer 0:66f3b5499f7f 487 t_self.debug("Merge BootLoader file %s" % blf)
screamer 0:66f3b5499f7f 488 blh = IntelHex(blf)
screamer 0:66f3b5499f7f 489 binh.merge(blh)
screamer 0:66f3b5499f7f 490
screamer 29:1210849dba19 491 with open(binf.replace(".bin", ".hex"), "w") as fileout:
screamer 29:1210849dba19 492 binh.tofile(fileout, format='hex')
screamer 0:66f3b5499f7f 493
The Other Jimmy 31:8ea194f6145b 494 class NCS36510TargetCode:
The Other Jimmy 31:8ea194f6145b 495 @staticmethod
The Other Jimmy 31:8ea194f6145b 496 def ncs36510_addfib(t_self, resources, elf, binf):
The Other Jimmy 31:8ea194f6145b 497 from tools.add_fib import add_fib_at_start
The Other Jimmy 31:8ea194f6145b 498 print("binf ", binf)
The Other Jimmy 31:8ea194f6145b 499 add_fib_at_start(binf[:-4])
screamer 29:1210849dba19 500 ################################################################################
screamer 0:66f3b5499f7f 501
screamer 7:5af61d55adbe 502 # Instantiate all public targets
screamer 29:1210849dba19 503 TARGETS = [Target.get_target(name) for name, value
screamer 29:1210849dba19 504 in Target.get_json_target_data().items()
screamer 29:1210849dba19 505 if value.get("public", True)]
screamer 0:66f3b5499f7f 506
screamer 0:66f3b5499f7f 507 # Map each target name to its unique instance
screamer 7:5af61d55adbe 508 TARGET_MAP = dict([(t.name, t) for t in TARGETS])
screamer 0:66f3b5499f7f 509
screamer 0:66f3b5499f7f 510 TARGET_NAMES = TARGET_MAP.keys()
screamer 0:66f3b5499f7f 511
screamer 0:66f3b5499f7f 512 # Some targets with different name have the same exporters
screamer 7:5af61d55adbe 513 EXPORT_MAP = {}
screamer 0:66f3b5499f7f 514
screamer 0:66f3b5499f7f 515 # Detection APIs
screamer 0:66f3b5499f7f 516 def get_target_detect_codes():
screamer 0:66f3b5499f7f 517 """ Returns dictionary mapping detect_code -> platform_name
screamer 0:66f3b5499f7f 518 """
screamer 0:66f3b5499f7f 519 result = {}
The Other Jimmy 31:8ea194f6145b 520 for tgt in TARGETS:
The Other Jimmy 31:8ea194f6145b 521 for detect_code in tgt.detect_code:
The Other Jimmy 31:8ea194f6145b 522 result[detect_code] = tgt.name
screamer 0:66f3b5499f7f 523 return result
screamer 16:a6285a7e5cc6 524
screamer 29:1210849dba19 525 def set_targets_json_location(location=None):
screamer 29:1210849dba19 526 """Sets the location of the JSON file that contains the targets"""
screamer 16:a6285a7e5cc6 527 # First instruct Target about the new location
screamer 16:a6285a7e5cc6 528 Target.set_targets_json_location(location)
screamer 29:1210849dba19 529 # Then re-initialize TARGETS, TARGET_MAP and TARGET_NAMES. The
screamer 29:1210849dba19 530 # re-initialization does not create new variables, it keeps the old ones
screamer 29:1210849dba19 531 # instead. This ensures compatibility with code that does
screamer 29:1210849dba19 532 # "from tools.targets import TARGET_NAMES"
The Other Jimmy 31:8ea194f6145b 533 TARGETS[:] = [Target.get_target(tgt) for tgt, obj
screamer 29:1210849dba19 534 in Target.get_json_target_data().items()
screamer 29:1210849dba19 535 if obj.get("public", True)]
screamer 16:a6285a7e5cc6 536 TARGET_MAP.clear()
The Other Jimmy 31:8ea194f6145b 537 TARGET_MAP.update(dict([(tgt.name, tgt) for tgt in TARGETS]))
screamer 16:a6285a7e5cc6 538 TARGET_NAMES[:] = TARGET_MAP.keys()