Improved protocol analyzer's error detection and handling

Author: Andrei-Basarab

CC1101SpiProtocol.py

@@ -142,6 +142,9 @@
 }
 
 
+class ProtocolException(Exception):
+    pass
+
 class ProtocolFrameType:
     REGISTER = "register"
     COMMAND = "cmd"
@@ -162,10 +165,12 @@ class CC1101SpiProtocol:
         "register": None,
         "data": None,
         "description": None,
+        "error": None,
     }
     RESPONSE = {
         "status": None,
         "data": None,
+        "error": None,
     }
     STATUS = {
         "chip_rdy": None,
@@ -210,6 +215,7 @@ def interpret_register(self, data_byte):
         register = None
         address = data_byte & 0x3F
         frame_type = None
+        error = None
 
         if address < 0x30:
             frame_type = ProtocolFrameType.REGISTER
@@ -223,11 +229,18 @@ def interpret_register(self, data_byte):
         elif self.is_read(data_byte) and self.is_burst(data_byte):
             frame_type = ProtocolFrameType.STATUS
             register = STATUS_REGISTERS[address]
-        else:
-            frame_type = ProtocolFrameType.COMMAND
-            register = COMMAND_REGISTERS[address]
-
-        return frame_type, register["register"], register["description"]
+        elif address <= 0x3D:
+            if address != 0x37:
+                frame_type = ProtocolFrameType.COMMAND
+                register = COMMAND_REGISTERS[address]
+            else:
+                frame_type = ProtocolFrameType.ERROR
+                error = "Invalid COMMAND"
+        elif address > 0x3D:
+            frame_type = ProtocolFrameType.ERROR
+            error = "Invalid ADDRESS"
+
+        return frame_type, register["register"], register["description"], error
 
     def interpret_request(self, data):
         request = deepcopy(self.REQUEST)
@@ -237,7 +250,7 @@ def interpret_request(self, data):
         request["burst"] = "B" if self.is_burst(data[0]) else ""
 
         # Register address
-        request["type"], request["register"], request["description"] = self.interpret_register(data[0])
+        request["type"], request["register"], request["description"], request["error"] = self.interpret_register(data[0])
 
         # Data Byte
         if len(data) > 1:

HighLevelAnalyzer.py

@@ -36,7 +36,7 @@ class Hla(HighLevelAnalyzer):
             'format': 'Error: {{type}}'
         },
         ProtocolFrameType.ERROR: {
-            'format': 'Error: {{type}}'
+            'format': 'Error: {{type}} | {{data.error_details}}'
         },
         ProtocolFrameType.REGISTER: {
             'format': 'Register: {{data.access}} | {{data.register}} = {{data.focus_data}}'
@@ -157,17 +157,25 @@ def construct_table(self, protocol_msg):
         fifo_bytes_available = "" if response is None else "{}".format(response["status"]["fifo_bytes_available"])
         read_data            = "" if response is None else " ".join(["{:02X}".format(x) for x in response["data"]])
         description          = protocol_msg["request"]["description"]
+        focus_data           = ""
+        error_details        = ""
 
         # Focus Data is used mainly for the Protocol UI labels
         if frame_type == ProtocolFrameType.ERROR:
-            focus_data = ""
+            error_details = protocol_msg["request"]["error"]
         elif frame_type == ProtocolFrameType.REGISTER:
             focus_data = write_data if access == "W" else read_data
         elif frame_type == ProtocolFrameType.COMMAND:
-            focus_data = ""
+            pass
         elif frame_type == ProtocolFrameType.STATUS:
             if register == "MARCSTATE":
-                focus_data = MARC_STATE[response["data"][0]]["state"]
+                marc_state = response["data"][0]
+                if marc_state <= 0x16:
+                    focus_data = MARC_STATE[response["data"][0]]["state"]
+                else:
+                    # See [SWRZ020E] CC1101 Silicon Errata
+                    frame_type = ProtocolFrameType.ERROR
+                    error_details = "Invalid MARCSTATE"
             else:
                 focus_data = read_data
         elif frame_type == ProtocolFrameType.PA_TABLE:
@@ -189,7 +197,7 @@ def construct_table(self, protocol_msg):
                 "read_data":            read_data,
                 "register_description": description,
                 "focus_data":           focus_data,
-                "error_details":        "",
+                "error_details":        error_details,
             }
         )
 

README.md

@@ -6,3 +6,9 @@ SPI protocol analyzer for the Texas Instruments CC1101 RF Transceiver
 
 - TODO
 
+# Texas Instruments references
+- [CC1101 Product Page](https://www.ti.com/product/CC1101)
+- [CC1101 Datasheet](https://www.ti.com/lit/ds/symlink/cc1101.pdf)
+- [CC1101 Silicon Errata](https://www.ti.com/lit/er/swrz020e/swrz020e.pdf)
+
+