summaryrefslogtreecommitdiff
path: root/decoders/timing/pd.py
blob: 95c533211df78f85f4b5d9e91d7e5df6ddaccd27 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
##
## This file is part of the libsigrokdecode project.
##
## Copyright (C) 2014 Torsten Duwe <duwe@suse.de>
## Copyright (C) 2014 Sebastien Bourdelin <sebastien.bourdelin@savoirfairelinux.com>
##
## 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, see <http://www.gnu.org/licenses/>.
##

import sigrokdecode as srd
from collections import deque

class SamplerateError(Exception):
    pass

def normalize_time(t):
    if abs(t) >= 1.0:
        return '%.3f s  (%.3f Hz)' % (t, (1/t))
    elif abs(t) >= 0.001:
        if 1/t/1000 < 1:
            return '%.3f ms (%.3f Hz)' % (t * 1000.0, (1/t))
        else:
            return '%.3f ms (%.3f kHz)' % (t * 1000.0, (1/t)/1000)
    elif abs(t) >= 0.000001:
        if 1/t/1000/1000 < 1:
            return '%.3f μs (%.3f kHz)' % (t * 1000.0 * 1000.0, (1/t)/1000)
        else:
            return '%.3f μs (%.3f MHz)' % (t * 1000.0 * 1000.0, (1/t)/1000/1000)
    elif abs(t) >= 0.000000001:
        if 1/t/1000/1000/1000:
            return '%.3f ns (%.3f MHz)' % (t * 1000.0 * 1000.0 * 1000.0, (1/t)/1000/1000)
        else:
            return '%.3f ns (%.3f GHz)' % (t * 1000.0 * 1000.0 * 1000.0, (1/t)/1000/1000/1000)
    else:
        return '%f' % t

def terse_times(t, fmt):
    # Strictly speaking these variants are not used in the current
    # implementation, but can reduce diffs during future maintenance.
    if fmt == 'full':
        return [normalize_time(t)]
    # End of "forward compatibility".

    if fmt == 'samples':
        # See below. No unit text, on purpose.
        return ['{:d}'.format(t)]

    # Use caller specified scale, or automatically find one.
    scale, unit = None, None
    if fmt == 'terse-auto':
        if abs(t) >= 1e0:
            scale, unit = 1e0, 's'
        elif abs(t) >= 1e-3:
            scale, unit = 1e3, 'ms'
        elif abs(t) >= 1e-6:
            scale, unit = 1e6, 'us'
        elif abs(t) >= 1e-9:
            scale, unit = 1e9, 'ns'
        elif abs(t) >= 1e-12:
            scale, unit = 1e12, 'ps'
    # Beware! Uses unit-less text when the user picked the scale. For
    # more consistent output with less clutter, thus faster navigation
    # by humans. Can also un-hide text at higher distance zoom levels.
    elif fmt == 'terse-s':
        scale, unit = 1e0, ''
    elif fmt == 'terse-ms':
        scale, unit = 1e3, ''
    elif fmt == 'terse-us':
        scale, unit = 1e6, ''
    elif fmt == 'terse-ns':
        scale, unit = 1e9, ''
    elif fmt == 'terse-ps':
        scale, unit = 1e12, ''
    if scale:
        t *= scale
        return ['{:.0f}{}'.format(t, unit), '{:.0f}'.format(t)]

    # Unspecified format, and nothing auto-detected.
    return ['{:f}'.format(t)]

class Pin:
    (DATA,) = range(1)

class Ann:
    (TIME, TERSE, AVG, DELTA,) = range(4)

class Decoder(srd.Decoder):
    api_version = 3
    id = 'timing'
    name = 'Timing'
    longname = 'Timing calculation with frequency and averaging'
    desc = 'Calculate time between edges.'
    license = 'gplv2+'
    inputs = ['logic']
    outputs = []
    tags = ['Clock/timing', 'Util']
    channels = (
        {'id': 'data', 'name': 'Data', 'desc': 'Data line'},
    )
    annotations = (
        ('time', 'Time'),
        ('terse', 'Terse'),
        ('average', 'Average'),
        ('delta', 'Delta'),
    )
    annotation_rows = (
        ('times', 'Times', (Ann.TIME, Ann.TERSE,)),
        ('averages', 'Averages', (Ann.AVG,)),
        ('deltas', 'Deltas', (Ann.DELTA,)),
    )
    options = (
        { 'id': 'avg_period', 'desc': 'Averaging period', 'default': 100 },
        { 'id': 'edge', 'desc': 'Edges to check',
          'default': 'any', 'values': ('any', 'rising', 'falling') },
        { 'id': 'delta', 'desc': 'Show delta from last',
          'default': 'no', 'values': ('yes', 'no') },
        { 'id': 'format', 'desc': 'Format of \'time\' annotation',
          'default': 'full', 'values': ('full', 'terse-auto',
          'terse-s', 'terse-ms', 'terse-us', 'terse-ns', 'terse-ps',
          'samples') },
    )

    def __init__(self):
        self.reset()

    def reset(self):
        self.samplerate = None

    def metadata(self, key, value):
        if key == srd.SRD_CONF_SAMPLERATE:
            self.samplerate = value

    def start(self):
        self.out_ann = self.register(srd.OUTPUT_ANN)

    def decode(self):
        if not self.samplerate:
            raise SamplerateError('Cannot decode without samplerate.')
        edge = self.options['edge']
        avg_period = self.options['avg_period']
        delta = self.options['delta'] == 'yes'
        fmt = self.options['format']
        ss = None
        last_n = deque()
        last_t = None
        while True:
            if edge == 'rising':
                pin = self.wait({Pin.DATA: 'r'})
            elif edge == 'falling':
                pin = self.wait({Pin.DATA: 'f'})
            else:
                pin = self.wait({Pin.DATA: 'e'})

            if not ss:
                ss = self.samplenum
                continue
            es = self.samplenum
            sa = es - ss
            t = sa / self.samplerate

            if fmt == 'full':
                cls, txt = Ann.TIME, [normalize_time(t)]
            elif fmt == 'samples':
                cls, txt = Ann.TERSE, terse_times(sa, fmt)
            else:
                cls, txt = Ann.TERSE, terse_times(t, fmt)
            if txt:
                self.put(ss, es, self.out_ann, [cls, txt])

            if avg_period > 0:
                if t > 0:
                    last_n.append(t)
                if len(last_n) > avg_period:
                    last_n.popleft()
                average = sum(last_n) / len(last_n)
                cls, txt = Ann.AVG, normalize_time(average)
                self.put(ss, es, self.out_ann, [cls, [txt]])
            if last_t and delta:
                cls, txt = Ann.DELTA, normalize_time(t - last_t)
                self.put(ss, es, self.out_ann, [cls, [txt]])

            last_t = t
            ss = es