uart: Add binaryout/dump support, drop obsolete 'uart_dump' PD.
authorUwe Hermann <uwe@hermann-uwe.de>
Mon, 20 Jan 2014 16:43:01 +0000 (17:43 +0100)
committerUwe Hermann <uwe@hermann-uwe.de>
Thu, 23 Jan 2014 19:02:38 +0000 (20:02 +0100)
The functionality of the preliminary 'uart_dump' PD is now available
in the proper 'uart' PD, via the OUTPUT_BINARY mechanism that frontends
can use to dump decoded data (in various formats) to a file, or pipe it
into other applications, and so on.

Old sigrok-cli example usage:

 $ sigrok-cli -i foo.sr -P uart:rx=0:tx=1,uart_dump:filename=bootlog.txt

New sigrok-cli example usage:

 $ sigrok-cli -i foo.sr -P uart:rx=0:tx=1 -B uart=rxtx > bootlog.txt

New sigrok-cli example usage (piping into other applications):

 $ sigrok-cli -i foo.sr -P uart:rx=0:tx=1 -B uart=rxtx | grep "whatever"

decoders/uart/pd.py
decoders/uart_dump/__init__.py [deleted file]
decoders/uart_dump/pd.py [deleted file]

index d71fc23115760c06fd9e2eef56ab64ba1dc47770..c3d1b62dbc5849f16fc4c5cf91f322cf8dfd36f9 100644 (file)
@@ -1,7 +1,7 @@
 ##
 ## This file is part of the libsigrokdecode project.
 ##
-## Copyright (C) 2011-2013 Uwe Hermann <uwe@hermann-uwe.de>
+## Copyright (C) 2011-2014 Uwe Hermann <uwe@hermann-uwe.de>
 ##
 ## This program is free software; you can redistribute it and/or modify
 ## it under the terms of the GNU General Public License as published by
@@ -104,6 +104,11 @@ class Decoder(srd.Decoder):
         ['Stop bits', 'UART stop bits'],
         ['Warnings', 'Warnings'],
     ]
+    binary = (
+        ('rx', 'RX dump'),
+        ('tx', 'TX dump'),
+        ('rxtx', 'RX/TX dump'),
+    )
 
     def putx(self, rxtx, data):
         s, halfbit = self.startsample[rxtx], int(self.bit_width / 2)
@@ -117,6 +122,10 @@ class Decoder(srd.Decoder):
         s, halfbit = self.samplenum, int(self.bit_width / 2)
         self.put(s - halfbit, s + halfbit, self.out_proto, data)
 
+    def putbin(self, rxtx, data):
+        s, halfbit = self.startsample[rxtx], int(self.bit_width / 2)
+        self.put(s - halfbit, self.samplenum + halfbit, self.out_bin, data)
+
     def __init__(self, **kwargs):
         self.samplerate = None
         self.samplenum = 0
@@ -133,6 +142,7 @@ class Decoder(srd.Decoder):
 
     def start(self):
         self.out_proto = self.register(srd.OUTPUT_PYTHON)
+        self.out_bin = self.register(srd.OUTPUT_BINARY)
         self.out_ann = self.register(srd.OUTPUT_ANN)
 
     def metadata(self, key, value):
@@ -235,6 +245,9 @@ class Decoder(srd.Decoder):
         else:
             raise Exception('Invalid data format option: %s' % f)
 
+        self.putbin(rxtx, (rxtx, bytes([b])))
+        self.putbin(rxtx, (2, bytes([b])))
+
     def get_parity_bit(self, rxtx, signal):
         # If no parity is used/configured, skip to the next state immediately.
         if self.options['parity_type'] == 'none':
diff --git a/decoders/uart_dump/__init__.py b/decoders/uart_dump/__init__.py
deleted file mode 100644 (file)
index 1775ad4..0000000
+++ /dev/null
@@ -1,29 +0,0 @@
-##
-## This file is part of the libsigrokdecode project.
-##
-## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
-##
-## This program is free software; you can redistribute it and/or modify
-## it under the terms of the GNU General Public License as published by
-## the Free Software Foundation; either version 2 of the License, or
-## (at your option) any later version.
-##
-## This program is distributed in the hope that it will be useful,
-## but WITHOUT ANY WARRANTY; without even the implied warranty of
-## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-## 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
-##
-
-'''
-TODO.
-
-Details:
-TODO
-'''
-
-from .pd import *
-
diff --git a/decoders/uart_dump/pd.py b/decoders/uart_dump/pd.py
deleted file mode 100644 (file)
index 96a5e3c..0000000
+++ /dev/null
@@ -1,107 +0,0 @@
-##
-## This file is part of the libsigrokdecode project.
-##
-## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
-##
-## This program is free software; you can redistribute it and/or modify
-## it under the terms of the GNU General Public License as published by
-## the Free Software Foundation; either version 2 of the License, or
-## (at your option) any later version.
-##
-## This program is distributed in the hope that it will be useful,
-## but WITHOUT ANY WARRANTY; without even the implied warranty of
-## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-## 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
-##
-
-import sigrokdecode as srd
-import os
-import sys
-
-RX = 0
-TX = 1
-
-class Decoder(srd.Decoder):
-    api_version = 1
-    id = 'uart_dump'
-    name = 'UART dump'
-    longname = 'UART dump'
-    desc = 'Output decoded UART data to a file.'
-    license = 'gplv2+'
-    inputs = ['uart']
-    outputs = [] # TODO?
-    probes = []
-    optional_probes = []
-    options = {
-        'rx': ['Output RX data?', 'yes'],
-        'tx': ['Output TX data?', 'yes'],
-        'filename': ['File name for RX and TX data', '-'],
-        'filename_rx': ['File name for RX data', 'none'],
-        'filename_tx': ['File name for TX data', 'none'],
-    }
-    annotations = []
-
-    def __init__(self, **kwargs):
-        self.f = None
-        self.f_rx = None
-        self.f_tx = None
-
-    def file_open(self, filename):
-        if filename == 'none':
-            return None
-        elif filename == '-':
-            return sys.stdout
-        else:
-            return open(filename, 'w')
-
-    def start(self):
-        # The user can specify 'filename' (gets both RX and TX data), and/or
-        # 'filename_rx' (for RX data only), and/or 'filename_tx', respectively.
-
-        # Default is to output RX and TX to 'filename', with 'filename_rx' and
-        # 'filename_tx' being unused.
-
-        # If multiple 'filename*' options are specified, the user must NOT
-        # use the same file for any of them.
-
-        # A filename of 'none' is not allowed (has special meaning). A filename
-        # of '-' means 'stdout'.
-
-        self.f = self.file_open(self.options['filename'])
-        self.f_rx = self.file_open(self.options['filename_rx'])
-        self.f_tx = self.file_open(self.options['filename_tx'])
-
-    def decode(self, ss, es, data):
-        ptype, rxtx, pdata = data
-
-        # Ignore all UART packets except the actual data packets (i.e., we
-        # do not print start bits, parity bits, stop bits, errors, and so on).
-        if ptype != 'DATA':
-            return
-
-        # TODO: Configurable format.
-        c = chr(pdata)
-
-        # TODO: Error handling.
-
-        # Output RX and/or TX to 'filename'.
-        if self.f != None:
-            self.f.write(c)
-            self.f.flush()
-
-        # Output RX data to 'filename_rx'.
-        if self.f_rx != None:
-            if self.options['rx'] == 'yes' and rxtx == RX:
-                self.f_rx.write(c)
-                self.f_rx.flush()
-
-        # Output TX data to 'filename_tx'.
-        if self.f_tx != None:
-            if self.options['tx'] == 'yes' and rxtx == TX:
-                self.f_tx.write(c)
-                self.f_tx.flush()
-