license: remove FSF postal address from boiler plate license text

[libsigrokdecode.git] / decoders / can / pd.py

diff --git a/decoders/can/pd.py b/decoders/can/pd.py
index c394cf1faa84bb77ab1957bb05ba6c4444e69426..1a99c307c94861acf9deca895d6ef181ab81fb2a 100644 (file)
--- a/decoders/can/pd.py
+++ b/decoders/can/pd.py
@@ -14,14 +14,16 @@
 ## GNU General Public License for more details.
 ##
 ## You should have received a copy of the GNU General Public License
-## along with this program; if not, write to the Free Software
-## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+## along with this program; if not, see <http://www.gnu.org/licenses/>.
 ##
 
 import sigrokdecode as srd
 
+class SamplerateError(Exception):
+    pass
+
 class Decoder(srd.Decoder):
-    api_version = 1
+    api_version = 2
     id = 'can'
     name = 'CAN'
     longname = 'Controller Area Network'
@@ -29,40 +31,43 @@ class Decoder(srd.Decoder):
     license = 'gplv2+'
     inputs = ['logic']
     outputs = ['can']
-    probes = [
+    channels = (
         {'id': 'can_rx', 'name': 'CAN RX', 'desc': 'CAN bus line'},
-    ]
-    optional_probes = []
-    options = {
-        'bitrate': ['Bitrate', 1000000], # 1Mbit/s
-        'sample_point': ['Sample point', 70], # 70%
-    }
-    annotations = [
-        ['data', 'CAN payload data'],
-        ['sof', 'Start of frame'],
-        ['eof', 'End of frame'],
-        ['id', 'Identifier'],
-        ['ext-id', 'Extended identifier'],
-        ['full-id', 'Full identifier'],
-        ['ide', 'Identifier extension bit'],
-        ['reserved-bit', 'Reserved bit 0 and 1'],
-        ['rtr', 'Remote transmission request'],
-        ['srr', 'Substitute remote request'],
-        ['dlc', 'Data length count'],
-        ['crc-sequence', 'CRC sequence'],
-        ['crc-delimiter', 'CRC delimiter'],
-        ['ack-slot', 'ACK slot'],
-        ['ack-delimiter', 'ACK delimiter'],
-        ['stuff-bit', 'Stuff bit'],
-        ['warnings', 'Human-readable warnings'],
-    ]
-
-    def __init__(self, **kwargs):
+    )
+    options = (
+        {'id': 'bitrate', 'desc': 'Bitrate (bits/s)', 'default': 1000000},
+        {'id': 'sample_point', 'desc': 'Sample point (%)', 'default': 70.0},
+    )
+    annotations = (
+        ('data', 'CAN payload data'),
+        ('sof', 'Start of frame'),
+        ('eof', 'End of frame'),
+        ('id', 'Identifier'),
+        ('ext-id', 'Extended identifier'),
+        ('full-id', 'Full identifier'),
+        ('ide', 'Identifier extension bit'),
+        ('reserved-bit', 'Reserved bit 0 and 1'),
+        ('rtr', 'Remote transmission request'),
+        ('srr', 'Substitute remote request'),
+        ('dlc', 'Data length count'),
+        ('crc-sequence', 'CRC sequence'),
+        ('crc-delimiter', 'CRC delimiter'),
+        ('ack-slot', 'ACK slot'),
+        ('ack-delimiter', 'ACK delimiter'),
+        ('stuff-bit', 'Stuff bit'),
+        ('warnings', 'Human-readable warnings'),
+        ('bit', 'Bit'),
+    )
+    annotation_rows = (
+        ('bits', 'Bits', (15, 17)),
+        ('fields', 'Fields', tuple(range(15)) + (16,)),
+    )
+
+    def __init__(self):
         self.samplerate = None
         self.reset_variables()
 
     def start(self):
-        # self.out_python = self.register(srd.OUTPUT_PYTHON)
         self.out_ann = self.register(srd.OUTPUT_ANN)
 
     def metadata(self, key, value):
@@ -114,8 +119,6 @@ class Decoder(srd.Decoder):
             return False
 
         # Stuff bit. Keep it in self.rawbits, but drop it from self.bits.
-        self.putx([15, ['Stuff bit: %d' % self.rawbits[-1],
-                        'SB: %d' % self.rawbits[-1], 'SB']])
         self.bits.pop() # Drop last bit.
         return True
 
@@ -304,14 +307,13 @@ class Decoder(srd.Decoder):
         # Get the index of the current CAN frame bit (without stuff bits).
         bitnum = len(self.bits) - 1
 
-        # For debugging.
-        # self.putx([0, ['Bit %d (CAN bit %d): %d' % \
-        #           (self.curbit, bitnum, can_rx)]])
-
         # If this is a stuff bit, remove it from self.bits and ignore it.
         if self.is_stuff_bit():
+            self.putx([15, [str(can_rx)]])
             self.curbit += 1 # Increase self.curbit (bitnum is not affected).
             return
+        else:
+            self.putx([17, [str(can_rx)]])
 
         # Bit 0: Start of frame (SOF) bit
         if bitnum == 0:
@@ -360,8 +362,8 @@ class Decoder(srd.Decoder):
         self.curbit += 1
 
     def decode(self, ss, es, data):
-        if self.samplerate is None:
-            raise Exception("Cannot decode without samplerate.")
+        if not self.samplerate:
+            raise SamplerateError('Cannot decode without samplerate.')
         for (self.samplenum, pins) in data:
 
             (can_rx,) = pins
@@ -378,6 +380,3 @@ class Decoder(srd.Decoder):
                 if not self.reached_bit(self.curbit):
                     continue
                 self.handle_bit(can_rx)
-            else:
-                raise Exception("Invalid state: %s" % self.state)
-