Change PD options to be a tuple of dictionaries.
[libsigrokdecode.git] / decoders / onewire_link / pd.py
index 76e9b24bfe84d95abea2362052b0d8fd0b4fceb6..38ef8ccea3b5907fa1f020ba4964741e853bcb9d 100644 (file)
@@ -18,8 +18,6 @@
 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 ##
 
-# 1-Wire protocol decoder (link layer)
-
 import sigrokdecode as srd
 
 class Decoder(srd.Decoder):
@@ -37,19 +35,36 @@ class Decoder(srd.Decoder):
     optional_probes = [
         {'id': 'pwr', 'name': 'PWR', 'desc': '1-Wire power supply pin'},
     ]
-    options = {
-        'overdrive': ['Overdrive mode', 'no'],
+    options = (
+        {'id': 'overdrive',
+            'desc': 'Overdrive mode',
+            'default': 'no'},
         # Time options (specified in microseconds):
-        'cnt_normal_bit': ['Normal mode sample bit time (us)', 15],
-        'cnt_normal_slot': ['Normal mode data slot time (us)', 60],
-        'cnt_normal_presence': ['Normal mode sample presence time (us)', 75],
-        'cnt_normal_reset': ['Normal mode reset time (us)', 480],
-        'cnt_overdrive_bit': ['Overdrive mode sample bit time (us)', 2],
-        # 'cnt_overdrive_slot': ['Overdrive mode data slot time (us)', 7.3],
-        'cnt_overdrive_slot': ['Overdrive mode data slot time (us)', 7],
-        'cnt_overdrive_presence': ['Overdrive mode sample presence time (us)', 10],
-        'cnt_overdrive_reset': ['Overdrive mode reset time (us)', 48],
-    }
+        {'id': 'cnt_normal_bit',
+            'desc': 'Normal mode sample bit time (μs)',
+            'default': 15},
+        {'id': 'cnt_normal_slot',
+            'desc': 'Normal mode data slot time (μs)',
+            'default': 60},
+        {'id': 'cnt_normal_presence',
+            'desc': 'Normal mode sample presence time (μs)',
+            'default': 75},
+        {'id': 'cnt_normal_reset',
+            'desc': 'Normal mode reset time (μs)',
+            'default': 480},
+        {'id': 'cnt_overdrive_bit',
+            'desc': 'Overdrive mode sample bit time (μs)',
+            'default': 2},
+        {'id': 'cnt_overdrive_slot',
+            'desc': 'Overdrive mode data slot time (μs)',
+            'default': 7.3},
+        {'id': 'cnt_overdrive_presence',
+            'desc': 'Overdrive mode sample presence time (μs)',
+            'default': 10},
+        {'id': 'cnt_overdrive_reset',
+            'desc': 'Overdrive mode reset time (μs)',
+            'default': 48},
+    )
     annotations = [
         ['bit', 'Bit'],
         ['warnings', 'Warnings'],
@@ -57,12 +72,17 @@ class Decoder(srd.Decoder):
         ['presence', 'Presence'],
         ['overdrive', 'Overdrive mode notifications'],
     ]
+    annotation_rows = (
+        ('bits', 'Bits', (0, 2, 3)),
+        ('info', 'Info', (4,)),
+        ('warnings', 'Warnings', (1,)),
+    )
 
     def putm(self, data):
         self.put(0, 0, self.out_ann, data)
 
     def putpb(self, data):
-        self.put(self.fall, self.samplenum, self.out_proto, data)
+        self.put(self.fall, self.samplenum, self.out_python, data)
 
     def putb(self, data):
         self.put(self.fall, self.samplenum, self.out_ann, data)
@@ -74,12 +94,13 @@ class Decoder(srd.Decoder):
         self.put(self.fall, self.rise, self.out_ann, data)
 
     def putprs(self, data):
-        self.put(self.rise, self.samplenum, self.out_proto, data)
+        self.put(self.rise, self.samplenum, self.out_python, data)
 
     def putrs(self, data):
         self.put(self.rise, self.samplenum, self.out_ann, data)
 
     def __init__(self, **kwargs):
+        self.samplerate = None
         self.samplenum = 0
         self.state = 'WAIT FOR FALLING EDGE'
         self.present = 0
@@ -90,11 +111,14 @@ class Decoder(srd.Decoder):
         self.fall = 0
         self.rise = 0
 
-    def start(self, metadata):
-        self.out_proto = self.add(srd.OUTPUT_PROTO, 'onewire_link')
-        self.out_ann = self.add(srd.OUTPUT_ANN, 'onewire_link')
+    def start(self):
+        self.out_python = self.register(srd.OUTPUT_PYTHON)
+        self.out_ann = self.register(srd.OUTPUT_ANN)
 
-        self.samplerate = metadata['samplerate']
+    def metadata(self, key, value):
+        if key != srd.SRD_CONF_SAMPLERATE:
+            return
+        self.samplerate = value
 
         # Check if samplerate is appropriate.
         if self.options['overdrive'] == 'yes':
@@ -169,10 +193,9 @@ class Decoder(srd.Decoder):
                  '(%2.1fus-%2.1fus) should be inside (7.3us, 10.0us).'
                  % (time_min*1000000, time_max*1000000)]])
 
-    def report(self):
-        pass
-
     def decode(self, ss, es, data):
+        if self.samplerate is None:
+            raise Exception("Cannot decode without samplerate.")
         for (self.samplenum, (owr, pwr)) in data:
             # State machine.
             if self.state == 'WAIT FOR FALLING EDGE':
@@ -201,7 +224,7 @@ class Decoder(srd.Decoder):
                     self.state = 'WAIT FOR RISING EDGE'
                     continue
 
-                self.putb([0, ['Bit: %d' % self.bit]])
+                self.putb([0, ['Bit: %d' % self.bit, '%d' % self.bit]])
                 self.putpb(['BIT', self.bit])
 
                 # Checking the first command to see if overdrive mode
@@ -209,7 +232,7 @@ class Decoder(srd.Decoder):
                 if self.bit_cnt <= 8:
                     self.command |= (self.bit << self.bit_cnt)
                 elif self.bit_cnt == 8 and self.command in [0x3c, 0x69]:
-                    self.putx([4, ['Entering overdrive mode']])
+                    self.putx([4, ['Entering overdrive mode', 'Overdrive on']])
                 # Increment the bit counter.
                 self.bit_cnt += 1
                 # Wait for next slot.
@@ -224,11 +247,11 @@ class Decoder(srd.Decoder):
                 if t > self.cnt_normal_reset:
                     # Save the sample number for the rising edge.
                     self.rise = self.samplenum
-                    self.putfr([2, ['Reset']])
+                    self.putfr([2, ['Reset', 'Rst', 'R']])
                     self.state = 'WAIT FOR PRESENCE DETECT'
                     # Exit overdrive mode.
                     if self.overdrive:
-                        self.putx([4, ['Exiting overdrive mode']])
+                        self.putx([4, ['Exiting overdrive mode', 'Overdrive off']])
                         self.overdrive = 0
                     # Clear command bit counter and data register.
                     self.bit_cnt = 0
@@ -236,7 +259,7 @@ class Decoder(srd.Decoder):
                 elif (t > self.cnt_overdrive_reset) and self.overdrive:
                     # Save the sample number for the rising edge.
                     self.rise = self.samplenum
-                    self.putfr([2, ['Reset']])
+                    self.putfr([2, ['Reset', 'Rst', 'R']])
                     self.state = "WAIT FOR PRESENCE DETECT"
                 # Otherwise this is assumed to be a data bit.
                 else:
@@ -259,7 +282,7 @@ class Decoder(srd.Decoder):
                     continue
 
                 p = 'false' if self.present else 'true'
-                self.putrs([3, ['Presence: %s' % p]])
+                self.putrs([3, ['Presence: %s' % p, 'Presence', 'Pres', 'P']])
                 self.putprs(['RESET/PRESENCE', not self.present])
 
                 # Wait for next slot.