]> sigrok.org Git - libsigrokdecode.git/blobdiff - decoders/onewire_network/onewire_network.py
onewire: added new transport layer commands
[libsigrokdecode.git] / decoders / onewire_network / onewire_network.py
index 836bce980b9c4de10d77ecdb2f25d0d34eb7dd47..9e641fd31ced7ac52cfea1fe8b94b7bb7e5684ae 100644 (file)
 
 import sigrokdecode as srd
 
-# Annotation feed formats
-ANN_NETWORK   = 0
-ANN_TRANSPORT = 1
-
-# a dictionary of ROM commands and their names
-rom_command = {0x33: "READ ROM",
-               0x0f: "CONDITIONAL READ ROM",
-               0xcc: "SKIP ROM",
-               0x55: "MATCH ROM",
-               0xf0: "SEARCH ROM",
-               0xec: "CONDITIONAL SEARCH ROM",
-               0x3c: "OVERDRIVE SKIP ROM",
-               0x6d: "OVERDRIVE MATCH ROM"}
+# a dictionary of ROM commands and their names, next state
+command = {
+    0x33: ["READ ROM"              , "GET ROM"   ], 
+    0x0f: ["CONDITIONAL READ ROM"  , "GET ROM"   ],
+    0xcc: ["SKIP ROM"              , "TRANSPORT" ],
+    0x55: ["MATCH ROM"             , "GET ROM"   ],
+    0xf0: ["SEARCH ROM"            , "SEARCH ROM"],
+    0xec: ["CONDITIONAL SEARCH ROM", "SEARCH ROM"],
+    0x3c: ["OVERDRIVE SKIP ROM"    , "TRANSPORT" ],
+    0x6d: ["OVERDRIVE MATCH ROM"   , "GET ROM"   ]
+}
 
 class Decoder(srd.Decoder):
     api_version = 1
@@ -50,7 +48,6 @@ class Decoder(srd.Decoder):
     options = {}
     annotations = [
         ['Network', 'Network layer events (device addressing)'],
-        ['Transport', 'Transport layer events'],
     ]
 
     def __init__(self, **kwargs):
@@ -77,68 +74,64 @@ class Decoder(srd.Decoder):
         [code, val] = data
 
         # State machine.
-        if (self.code == "RESET"):
-            self.state = "COMMAND"
+        if (code == "RESET/PRESENCE"):
             self.search = "P"
             self.bit_cnt = 0
-        elif (self.code == "BIT"):
+            self.put(ss, es, self.out_ann, [0, ['RESET/PRESENCE: %s' % ('True' if val else 'False')]])
+            self.put(ss, es, self.out_proto, ['RESET/PRESENCE', val])
+            self.state = "COMMAND"
+        elif (code == "BIT"):
             if (self.state == "COMMAND"):
                 # Receiving and decoding a ROM command
-                if (self.onewire_collect(8, val)):
-                    self.put(self.net_beg, self.net_end, self.out_ann, [ANN_NETWORK,
-                      ['ROM COMMAND: 0x%02x \'%s\'' % (self.data, rom_command[self.data])]])
-                    if   (self.data == 0x33):  # READ ROM
-                        self.state = "GET ROM"
-                    elif (self.data == 0x0f):  # CONDITIONAL READ ROM
-                        self.state = "GET ROM"
-                    elif (self.data == 0xcc):  # SKIP ROM
-                        self.state = "TRANSPORT"
-                    elif (self.data == 0x55):  # MATCH ROM
-                        self.state = "GET ROM"
-                    elif (self.data == 0xf0):  # SEARCH ROM
-                        self.state = "SEARCH ROM"
-                    elif (self.data == 0xec):  # CONDITIONAL SEARCH ROM
-                        self.state = "SEARCH ROM"
-                    elif (self.data == 0x3c):  # OVERDRIVE SKIP ROM
-                        self.state = "TRANSPORT"
-                    elif (self.data == 0x69):  # OVERDRIVE MATCH ROM
-                        self.state = "GET ROM"
+                if (self.onewire_collect(8, val, ss, es)):
+                    if (self.data in command):
+                        self.put(self.net_beg, self.net_end, self.out_ann, [0,
+                          ['ROM COMMAND: 0x%02x \'%s\'' % (self.data, command[self.data][0])]])
+                        self.state = command[self.data][1]
+                    else:
+                        self.put(self.net_beg, self.net_end, self.out_ann, [0,
+                          ['ROM COMMAND: 0x%02x \'%s\'' % (self.data, 'UNRECOGNIZED')]])
+                        self.state = "COMMAND ERROR"
             elif (self.state == "GET ROM"):
                 # A 64 bit device address is selected
                 # family code (1B) + serial number (6B) + CRC (1B)
-                if (self.onewire_collect(64, val)):
+                if (self.onewire_collect(64, val, ss, es)):
                     self.net_rom = self.data & 0xffffffffffffffff
-                    self.put(self.net_beg, self.net_end, self.out_ann, [ANN_NETWORK, ['ROM: 0x%016x' % self.net_rom]])
+                    self.put(self.net_beg, self.net_end, self.out_ann, [0, ['ROM: 0x%016x' % self.net_rom]])
+                    self.put(self.net_beg, self.net_end, self.out_proto, ['ROM', self.net_rom])
                     self.state = "TRANSPORT"
             elif (self.state == "SEARCH ROM"):
                 # A 64 bit device address is searched for
                 # family code (1B) + serial number (6B) + CRC (1B)
-                if (self.onewire_search(64)):
+                if (self.onewire_search(64, val, ss, es)):
                     self.net_rom = self.data & 0xffffffffffffffff
-                    self.put(self.net_beg, self.net_end, self.out_ann, [ANN_NETWORK, ['ROM: 0x%016x' % self.net_rom]])
+                    self.put(self.net_beg, self.net_end, self.out_ann, [0, ['ROM: 0x%016x' % self.net_rom]])
+                    self.put(self.net_beg, self.net_end, self.out_proto, ['ROM', self.net_rom])
                     self.state = "TRANSPORT"
             elif (self.state == "TRANSPORT"):
                 # The transport layer is handled in byte sized units
-                if (self.onewire_collect(8, val)):
-                    self.put(self.net_beg, self.net_end, self.out_ann, [ANN_NETWORK  , ['TRANSPORT: 0x%02x' % self.data]])
-                    self.put(self.net_beg, self.net_end, self.out_ann, [ANN_TRANSPORT, ['TRANSPORT: 0x%02x' % self.data]])
-                    self.put(self.net_beg, self.net_end, self.out_proto, ['transfer', self.data])
-                    # TODO: Sending translort layer data to 1-Wire device models
+                if (self.onewire_collect(8, val, ss, es)):
+                    self.put(self.net_beg, self.net_end, self.out_ann, [0, ['DATA: 0x%02x' % self.data]])
+                    self.put(self.net_beg, self.net_end, self.out_proto, ['DATA', self.data])
+            elif (self.state == "COMMAND ERROR"):
+                # Since the command is not recognized, print raw data
+                if (self.onewire_collect(8, val, ss, es)):
+                    self.put(self.net_beg, self.net_end, self.out_ann, [0, ['ROM ERROR DATA: 0x%02x' % self.data]])
             else:
                 raise Exception('Invalid state: %s' % self.state)
 
 
     # Link/Network layer data collector
-    def onewire_collect (self, length, val):
+    def onewire_collect (self, length, val, ss, es):
         # Storing the sampe this sequence begins with
         if (self.bit_cnt == 1):
-            self.net_beg = self.ss
+            self.net_beg = ss
         self.data = self.data & ~(1 << self.bit_cnt) | (val << self.bit_cnt)
         self.bit_cnt  = self.bit_cnt + 1
         # Storing the sampe this sequence ends with
         # In case the full length of the sequence is received, return 1
         if (self.bit_cnt == length):
-            self.net_end  = self.es
+            self.net_end  = es
             self.data = self.data & ((1<<length)-1)
             self.bit_cnt  = 0
             return (1)
@@ -146,10 +139,10 @@ class Decoder(srd.Decoder):
             return (0)
 
     # Link/Network layer search collector
-    def onewire_search (self, length):
+    def onewire_search (self, length, val, ss, es):
         # Storing the sampe this sequence begins with
         if ((self.bit_cnt == 0) and (self.search == "P")):
-            self.net_beg = self.ss
+            self.net_beg = ss
         # Master receives an original address bit
         if   (self.search == "P"):
           self.data_p = self.data_p & ~(1 << self.bit_cnt) | (val << self.bit_cnt)
@@ -166,7 +159,7 @@ class Decoder(srd.Decoder):
         # Storing the sampe this sequence ends with
         # In case the full length of the sequence is received, return 1
         if (self.bit_cnt == length):
-            self.net_end = self.es
+            self.net_end = es
             self.data_p = self.data_p & ((1<<length)-1)
             self.data_n = self.data_n & ((1<<length)-1)
             self.data   = self.data   & ((1<<length)-1)