2 ## This file is part of the libsigrokdecode project.
4 ## Copyright (C) 2015 Benjamin Larsson <benjamin@southpole.se>
6 ## This program is free software; you can redistribute it and/or modify
7 ## it under the terms of the GNU General Public License as published by
8 ## the Free Software Foundation; either data 2 of the License, or
9 ## (at your option) any later data.
11 ## This program is distributed in the hope that it will be useful,
12 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 ## GNU General Public License for more details.
16 ## You should have received a copy of the GNU General Public License
17 ## along with this program; if not, write to the Free Software
18 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 import sigrokdecode as srd
23 class SamplerateError(Exception):
26 class Decoder(srd.Decoder):
30 longname = 'RFID EM4100'
31 desc = 'EM4100 100-150kHz RFID protocol.'
36 {'id': 'data', 'name': 'Data', 'desc': 'Data line'},
39 {'id': 'polarity', 'desc': 'Polarity', 'default': 'active-high',
40 'values': ('active-low', 'active-high')},
41 {'id': 'datarate' , 'desc': 'Data rate', 'default': 64,
42 'values': (64, 32, 16)},
43 # {'id': 'coding', 'desc': 'Bit coding', 'default': 'biphase',
44 # 'values': ('biphase', 'manchester', 'psk')},
45 {'id': 'coilfreq', 'desc': 'Coil frequency', 'default': 125000},
50 ('version-customer', 'Version/customer'),
52 ('rowparity-ok', 'Row parity OK'),
53 ('rowparity-err', 'Row parity error'),
54 ('colparity-ok', 'Column parity OK'),
55 ('colparity-err', 'Column parity error'),
56 ('stopbit', 'Stop bit'),
60 ('bits', 'Bits', (0,)),
61 ('fields', 'Fields', (1, 2, 3, 4, 5, 6, 7, 8)),
62 ('tags', 'Tags', (9,)),
65 def __init__(self, **kwargs):
66 self.samplerate = None
68 self.last_samplenum = None
69 self.lastlast_samplenum = None
72 self.halfbit_limit = 0
85 self.data_col_parity = [0, 0, 0, 0, 0, 0]
86 self.col_parity = [0, 0, 0, 0, 0, 0]
88 self.all_row_parity_ok = True
89 self.col_parity_pos = []
91 def metadata(self, key, value):
92 if key == srd.SRD_CONF_SAMPLERATE:
93 self.samplerate = value
94 self.bit_width = (self.samplerate / self.options['coilfreq']) * self.options['datarate']
95 self.halfbit_limit = self.bit_width/2 + self.bit_width/4
96 self.polarity = 0 if self.options['polarity'] == 'active-low' else 1
99 self.out_ann = self.register(srd.OUTPUT_ANN)
101 def add_bit(self, bit, ss, es):
102 if self.state == 'HEADER':
104 if self.first_one > 0:
106 if self.first_one == 9:
107 self.put(self.first_ss, es, self.out_ann,
108 [1, ['Header', 'Head', 'He', 'H']])
110 self.state = 'PAYLOAD'
112 if self.first_one == 0:
120 if self.state == 'PAYLOAD':
121 self.payload_cnt += 1
122 if self.data_bits == 0:
127 if self.data_bits == 5:
128 s = 'Version/customer' if self.payload_cnt <= 10 else 'Data'
129 c = 2 if self.payload_cnt <= 10 else 3
130 self.put(self.data_ss, ss, self.out_ann,
131 [c, [s + ': %X' % self.data, '%X' % self.data]])
132 s = 'OK' if self.data_parity == bit else 'ERROR'
133 c = 4 if s == 'OK' else 5
135 self.all_row_parity_ok = False
136 self.put(ss, es, self.out_ann,
137 [c, ['Row parity: ' + s, 'RP: ' + s, 'RP', 'R']])
138 self.tag = (self.tag << 4) | self.data
140 if self.payload_cnt == 50:
141 self.state = 'TRAILER'
144 self.data_parity ^= bit
145 self.data_col_parity[self.data_bits] ^= bit
146 self.data = (self.data << 1) | bit
149 if self.state == 'TRAILER':
150 self.payload_cnt += 1
151 if self.data_bits == 0:
156 self.col_parity[self.data_bits] = bit
157 self.col_parity_pos.append([ss, es])
159 if self.data_bits == 5:
160 self.put(ss, es, self.out_ann, [8, ['Stop bit', 'SB', 'S']])
162 for i in range(1, 5):
163 s = 'OK' if self.data_col_parity[i] == \
164 self.col_parity[i] else 'ERROR'
165 c = 6 if s == 'OK' else 7
166 self.put(self.col_parity_pos[i - 1][0],
167 self.col_parity_pos[i - 1][1], self.out_ann,
168 [c, ['Column parity %d: %s' % (i, s),
169 'CP%d: %s' % (i, s), 'CP%d' % i, 'C']])
171 # Emit an annotation for valid-looking tags.
172 all_col_parity_ok = (self.data_col_parity[1:5] == self.col_parity[1:5])
173 if all_col_parity_ok and self.all_row_parity_ok:
174 self.put(self.first_ss, es, self.out_ann,
175 [9, ['Tag: %010X' % self.tag, 'Tag', 'T']])
180 if self.payload_cnt == 5:
181 self.state = 'HEADER'
183 self.data_col_parity = [0, 0, 0, 0, 0, 0]
184 self.col_parity = [0, 0, 0, 0, 0, 0]
185 self.col_parity_pos = []
186 self.all_row_parity_ok = True
188 def putbit(self, bit, ss, es):
189 self.put(ss, es, self.out_ann, [0, [str(bit)]])
190 self.add_bit(bit, ss, es)
192 def manchester_decode(self, samplenum, pl, pp, pin):
194 bit = self.oldpin ^ self.polarity
195 if pl > self.halfbit_limit:
196 samples = samplenum - self.oldsamplenum
197 t = samples / self.samplerate
199 if self.oldpl > self.halfbit_limit:
200 ss = int(self.oldsamplenum - self.oldpl/2)
201 es = int(samplenum - pl/2)
202 self.putbit(bit, ss, es)
203 if self.oldpl <= self.halfbit_limit:
204 ss = int(self.oldsamplenum - self.oldpl)
205 es = int(samplenum - pl/2)
206 self.putbit(bit, ss, es)
207 self.last_bit_pos = int(samplenum - pl/2)
209 if pl < self.halfbit_limit:
210 samples = samplenum - self.oldsamplenum
211 t = samples / self.samplerate
213 if self.oldpl > self.halfbit_limit:
214 ss = int(self.oldsamplenum - self.oldpl/2)
216 self.putbit(bit, ss, es)
217 self.last_bit_pos = int(samplenum)
218 if self.oldpl <= self.halfbit_limit:
219 if self.last_bit_pos <= self.oldsamplenum - self.oldpl:
220 ss = int(self.oldsamplenum - self.oldpl)
222 self.putbit(bit, ss, es)
223 self.last_bit_pos = int(samplenum)
225 def decode(self, ss, es, data):
226 if not self.samplerate:
227 raise SamplerateError('Cannot decode without samplerate.')
228 for (samplenum, (pin,)) in data:
229 # Ignore identical samples early on (for performance reasons).
230 if self.oldpin == pin:
233 if self.oldpin is None:
235 self.last_samplenum = samplenum
236 self.lastlast_samplenum = samplenum
237 self.last_edge = samplenum
240 self.oldsamplenum = 0
241 self.last_bit_pos = 0
244 if self.oldpin != pin:
245 pl = samplenum - self.oldsamplenum
248 self.manchester_decode(samplenum, pl, pp, pin)
252 self.oldsamplenum = samplenum