Initial support for debugging // Resolve #514

platformio/builder/tools/piodebug.py

@@ -0,0 +1,98 @@
+# Copyright 2014-present PlatformIO <contact@platformio.org>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from __future__ import absolute_import
+
+import sys
+from fnmatch import fnmatch
+
+from platformio import util
+
+
+def ProcessDebug(env):
+    env.Append(
+        BUILD_FLAGS=["-Og", "-ggdb"],
+        BUILD_UNFLAGS=["-Os", "-O0", "-O1", "-O2", "-O3"])
+
+
+def DebugLinkSettings(env):
+    if "BOARD" not in env:
+        return
+    board_debug = env.BoardConfig().get("debug")
+    if not board_debug or not board_debug.get("links"):
+        return
+    debug_links = board_debug.get("links")
+    link_name = (env.subst("$DEBUG_LINK") or
+                 board_debug.get("default_link", debug_links.keys()[0]))
+    settings = debug_links.get(link_name)
+    if not settings:
+        return
+    settings.update({"name": link_name})
+    return settings
+
+
+def AutodetectDebugPort(env):
+
+    def _get_pattern():
+        if "DEBUG_PORT" not in env:
+            return None
+        if set(["*", "?", "[", "]"]) & set(env['DEBUG_PORT']):
+            return env['DEBUG_PORT']
+        return None
+
+    def _is_match_pattern(port):
+        pattern = _get_pattern()
+        if not pattern:
+            return True
+        return fnmatch(port, pattern)
+
+    def _look_for_serial_port(hwids):
+        port = None
+        for item in util.get_serialports(filter_hwid=True):
+            if not _is_match_pattern(item['port']):
+                continue
+            if "GDB" in item['port']:
+                return item['port']
+            for hwid in hwids:
+                hwid_str = ("%s:%s" % (hwid[0], hwid[1])).replace("0x", "")
+                if hwid_str in item['hwid']:
+                    return port
+        return port
+
+    if "BOARD" not in env or ("DEBUG_PORT" in env and not _get_pattern()):
+        return
+
+    link_settings = env.DebugLinkSettings()
+    if not link_settings:
+        return
+    if not link_settings.get("require_debug_port"):
+        return
+    env.Replace(
+        DEBUG_PORT=_look_for_serial_port(link_settings.get("hwids", [])))
+
+    if not env.subst("$DEBUG_PORT"):
+        sys.stderr.write(
+            "Error: Please specify `debug_port` for environment.\n")
+        env.Exit(1)
+
+
+def exists(_):
+    return True
+
+
+def generate(env):
+    env.AddMethod(ProcessDebug)
+    env.AddMethod(DebugLinkSettings)
+    env.AddMethod(AutodetectDebugPort)
+    return env