DebugProbe: refactored individual flags into set of capabilities.

- Added DebugProbe.Capability enums and 'capabilities' property
- Replaced has_swo() and 'supports_swj_sequence' property with capabilities.
- Managed DP/AP register access capabilities.

Author: flit

pyocd/coresight/dap.py

@@ -132,7 +132,8 @@ def connect(self, protocol=None):
         @exception TransferError
         """
         protocol_name = self._session.options.get('dap_protocol').strip().lower()
-        send_swj = self._session.options.get('dap_enable_swj') and self._probe.supports_swj_sequence
+        send_swj = self._session.options.get('dap_enable_swj') \
+                and (DebugProbe.Capability.SWJ_SEQUENCE in self._probe.capabilities)
         use_deprecated = self._session.options.get('dap_use_deprecated_swj')
 
         # Convert protocol from setting if not passed as parameter.

pyocd/probe/cmsis_dap_probe.py

@@ -99,6 +99,7 @@ def __init__(self, device):
         self._protocol = None
         self._is_open = False
         self._dp_select = -1
+        self._caps = set()
 
     @property
     def description(self):
@@ -136,8 +137,8 @@ def is_open(self):
         return self._is_open
 
     @property
-    def supports_swj_sequence(self):
-        return True
+    def capabilities(self):
+        return self._caps
 
     def create_associated_board(self):
         assert self.session is not None
@@ -163,6 +164,14 @@ def open(self):
                 self._supported_protocols.append(DebugProbe.Protocol.SWD)
             if self._capabilities & self.JTAG_CAPABILITY_MASK:
                 self._supported_protocols.append(DebugProbe.Protocol.JTAG)
+            
+            self._caps = {
+                self.Capability.SWJ_SEQUENCE,
+                self.Capability.BANKED_DP_REGISTERS,
+                self.Capability.APv2_ADDRESSES,
+                }
+            if self._link.has_swo():
+                self._caps.add(self.Capability.SWO)
         except DAPAccess.Error as exc:
             six.raise_from(self._convert_exception(exc), exc)
 
@@ -372,12 +381,6 @@ def write_ap_multiple(self, addr, values):
     #          SWO functions
     # ------------------------------------------- #
 
-    def has_swo(self):
-        try:
-            return self._link.has_swo()
-        except DAPAccess.Error as exc:
-            six.raise_from(self._convert_exception(exc), exc)
-
     def swo_start(self, baudrate):
         try:
             self._link.swo_configure(True, baudrate)

pyocd/probe/debug_probe.py

@@ -1,5 +1,5 @@
 # pyOCD debugger
-# Copyright (c) 2018-2019 Arm Limited
+# Copyright (c) 2018-2020 Arm Limited
 # SPDX-License-Identifier: Apache-2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -32,6 +32,32 @@ class Protocol(Enum):
             'default': Protocol.DEFAULT,
         }
 
+    class Capability(Enum):
+        """! @brief Probe capabilities."""
+        ## @brief Whether the probe supports the swj_sequence() API.
+        #
+        # If this property is True, then the swj_sequence() method is used to move between protocols.
+        # If False, it is assumed the probe firmware automatically manages the protocol switch.
+        SWJ_SEQUENCE = 0
+        
+        ## @brief Whether the probe supports receiving SWO data.
+        SWO = 1
+
+        ## @brief Whether the probe can access banked DP registers.
+        BANKED_DP_REGISTERS = 2
+        
+        ## @brief Whether the probe can access APv2 registers.
+        APv2_ADDRESSES = 3
+        
+        ## @brief Whether the probe automatically handles AP selection in the DP.
+        #
+        # If this capability is not present, the DebugPort object will perform the AP selection
+        # by DP register writes.
+        MANAGED_AP_SELECTION = 4
+        
+        ## @brief whether the probe automatically handles access of banked DAP registers.
+        MANAGED_DPBANKSEL = 5
+    
     @classmethod
     def get_all_connected_probes(cls):
         """! @brief Returns a list of DebugProbe instances."""
@@ -108,11 +134,10 @@ def is_open(self):
         raise NotImplementedError()
 
     @property
-    def supports_swj_sequence(self):
-        """! @brief Whether the probe supports the swj_sequence() API.
+    def capabilities(self):
+        """! @brief A set of DebugProbe.Capability enums indicating the probe's features.
         
-        If this property is True, then the swj_sequence() method is used to move between protocols.
-        If False, it is assumed the probe firmware automatically manages the protocol switch.
+        This value should not be trusted until after the probe is opened.
         """
         raise NotImplementedError()
 
@@ -251,10 +276,6 @@ def get_memory_interface_for_ap(self, ap_address):
     ## @name SWO
     ##@{
 
-    def has_swo(self):
-        """! @brief Returns bool indicating whether the probe supports SWO."""
-        raise NotImplementedError()
-
     def swo_start(self, baudrate):
         """! @brief Start receiving SWO data at the given baudrate.
         

pyocd/probe/jlink_probe.py

@@ -129,8 +129,8 @@ def is_open(self):
         return self._link.opened
 
     @property
-    def supports_swj_sequence(self):
-        return False
+    def capabilities(self):
+        return {self.Capability.SWO}
 
     def open(self):
         try:
@@ -311,9 +311,6 @@ def write_ap_multiple(self, addr, values):
         for v in values:
             self.write_ap(addr, v)
 
-    def has_swo(self):
-        return True
-
     def swo_start(self, baudrate):
         try:
             self._jlink.swo_start(baudrate)

pyocd/probe/stlink_probe.py

@@ -52,6 +52,7 @@ def __init__(self, device):
         self._memory_interfaces = {}
         self._mbed_info = None
         self._board_id = None
+        self._caps = set()
 
         # Try to detect associated board info via the STLinkV2-1 MSD volume.
         detector = create_mbed_detector()
@@ -101,8 +102,8 @@ def is_open(self):
         return self._is_open
 
     @property
-    def supports_swj_sequence(self):
-        return False
+    def capabilities(self):
+        return self._caps
 
     def create_associated_board(self):
         assert self.session is not None
@@ -114,6 +115,15 @@ def create_associated_board(self):
     def open(self):
         self._link.open()
         self._is_open = True
+        
+        # Update capabilities.
+        self._caps = {
+                self.Capability.SWO,
+                self.Capability.MANAGED_AP_SELECTION,
+                self.Capability.MANAGED_DPBANKSEL,
+                }
+        if self._link.supports_banked_dp:
+            self._caps.add(self.Capability.BANKED_DP_REGISTERS)
 
     def close(self):
         self._link.close()
@@ -204,9 +214,6 @@ def get_memory_interface_for_ap(self, ap_address):
             self._memory_interfaces[apsel] = STLinkMemoryInterface(self._link, apsel)
         return self._memory_interfaces[apsel]
 
-    def has_swo(self):
-        return True
-
     def swo_start(self, baudrate):
         self._link.swo_start(baudrate)
 

pyocd/trace/swv.py

@@ -26,6 +26,7 @@
 from ..coresight.tpiu import TPIU
 from ..core.target import Target
 from ..core import exceptions
+from ..probe.debug_probe import DebugProbe
 
 LOG = logging.getLogger(__name__)
 
@@ -101,7 +102,7 @@ def init(self, sys_clock, swo_clock, console):
         """
         self._swo_clock = swo_clock
 
-        if not self._session.probe.has_swo():
+        if DebugProbe.Capability.SWO not in self._session.probe.capabilities:
             LOG.warning("Probe %s does not support SWO", self._session.probe.unique_id)
             return