]>
Commit | Line | Data |
---|---|---|
444960cc KR |
1 | ## |
2 | ## This file is part of the libsigrokdecode project. | |
3 | ## | |
4 | ## Copyright (C) 2017 Kevin Redon <kingkevin@cuvoodoo.info> | |
a319f42f | 5 | ## Copyright (C) 2017 Soeren Apel <soeren@apelpie.net> |
444960cc KR |
6 | ## |
7 | ## This program is free software; you can redistribute it and/or modify | |
8 | ## it under the terms of the GNU General Public License as published by | |
9 | ## the Free Software Foundation; either version 2 of the License, or | |
10 | ## (at your option) any later version. | |
11 | ## | |
12 | ## This program is distributed in the hope that it will be useful, | |
13 | ## but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | ## GNU General Public License for more details. | |
16 | ## | |
17 | ## You should have received a copy of the GNU General Public License | |
18 | ## along with this program; if not, see <http://www.gnu.org/licenses/>. | |
19 | ## | |
20 | ||
21 | import sigrokdecode as srd | |
22 | ||
23 | # Dictionary of FUNCTION commands and their names. | |
a319f42f | 24 | commands_2432 = { |
444960cc KR |
25 | 0x0f: 'Write scratchpad', |
26 | 0xaa: 'Read scratchpad', | |
27 | 0x55: 'Copy scratchpad', | |
28 | 0xf0: 'Read memory', | |
29 | 0x5a: 'Load first secret', | |
30 | 0x33: 'Compute next secret', | |
31 | 0xa5: 'Read authenticated page', | |
32 | } | |
33 | ||
a319f42f SA |
34 | commands_2433 = { |
35 | 0x0f: 'Write scratchpad', | |
36 | 0xaa: 'Read scratchpad', | |
37 | 0x55: 'Copy scratchpad', | |
38 | 0xf0: 'Read memory', | |
39 | } | |
40 | ||
41 | # Maxim DS243x family code, present at the end of the ROM code. | |
42 | family_codes = { | |
43 | 0x33: ('DS2432', commands_2432), | |
44 | 0x23: ('DS2433', commands_2433), | |
45 | } | |
444960cc KR |
46 | |
47 | # Calculate the CRC-16 checksum. | |
48 | # Initial value: 0x0000, xor-in: 0x0000, polynom 0x8005, xor-out: 0xffff. | |
49 | def crc16(byte_array): | |
50 | reverse = 0xa001 # Use the reverse polynom to make algo simpler. | |
51 | crc = 0x0000 # Initial value. | |
52 | # Reverse CRC calculation. | |
53 | for byte in byte_array: | |
54 | for bit in range(8): | |
55 | if (byte ^ crc) & 1: | |
56 | crc = (crc >> 1) ^ reverse | |
57 | else: | |
58 | crc >>= 1 | |
59 | byte >>= 1 | |
60 | crc ^= 0xffff # Invert CRC. | |
61 | return crc | |
62 | ||
63 | class Decoder(srd.Decoder): | |
64 | api_version = 3 | |
a319f42f SA |
65 | id = 'ds243x' |
66 | name = 'DS243x' | |
67 | longname = 'Maxim DS2432/2433' | |
68 | desc = 'Maxim DS243x series 1-Wire EEPROM protocol.' | |
444960cc KR |
69 | license = 'gplv2+' |
70 | inputs = ['onewire_network'] | |
a319f42f | 71 | outputs = ['ds243x'] |
444960cc KR |
72 | annotations = ( |
73 | ('text', 'Human-readable text'), | |
74 | ) | |
d40e7762 SA |
75 | binary = ( |
76 | ('mem_read', 'Data read from memory'), | |
77 | ) | |
444960cc KR |
78 | |
79 | def __init__(self): | |
80 | # Bytes for function command. | |
81 | self.bytes = [] | |
a319f42f SA |
82 | self.family_code = None |
83 | self.family = '' | |
84 | self.commands = commands_2432 # Use max command set until we know better. | |
444960cc KR |
85 | |
86 | def start(self): | |
87 | self.out_ann = self.register(srd.OUTPUT_ANN) | |
d40e7762 | 88 | self.out_binary = self.register(srd.OUTPUT_BINARY) |
444960cc KR |
89 | |
90 | def putx(self, data): | |
91 | self.put(self.ss, self.es, self.out_ann, data) | |
92 | ||
93 | def decode(self, ss, es, data): | |
94 | code, val = data | |
95 | ||
96 | if code == 'RESET/PRESENCE': | |
97 | self.ss, self.es = ss, es | |
98 | self.putx([0, ['Reset/presence: %s' | |
99 | % ('true' if val else 'false')]]) | |
100 | self.bytes = [] | |
101 | elif code == 'ROM': | |
102 | self.ss, self.es = ss, es | |
a319f42f SA |
103 | self.family_code = val & 0xff |
104 | ||
105 | s = None | |
106 | if self.family_code in family_codes: | |
107 | self.family, self.commands = family_codes[val & 0xff] | |
108 | s = 'is 0x%02x, %s detected' % (self.family_code, self.family) | |
109 | else: | |
110 | s = '%x%02x unknown' % (self.family_code) | |
111 | ||
112 | self.putx([0, ['ROM: 0x%016x (%s)' % (val, 'family code ' + s), | |
113 | 'ROM: 0x%016x (%s)' % (val, self.family)]]) | |
444960cc KR |
114 | self.bytes = [] |
115 | elif code == 'DATA': | |
116 | self.bytes.append(val) | |
117 | if 1 == len(self.bytes): | |
118 | self.ss, self.es = ss, es | |
a319f42f | 119 | if val not in self.commands: |
444960cc KR |
120 | self.putx([0, ['Unrecognized command: 0x%02x' % val]]) |
121 | else: | |
122 | self.putx([0, ['Function command: %s (0x%02x)' | |
a319f42f | 123 | % (self.commands[val], val)]]) |
444960cc KR |
124 | elif 0x0f == self.bytes[0]: # Write scratchpad |
125 | if 2 == len(self.bytes): | |
126 | self.ss = ss | |
127 | elif 3 == len(self.bytes): | |
128 | self.es = es | |
129 | self.putx([0, ['Target address: 0x%04x' | |
130 | % ((self.bytes[2] << 8) + self.bytes[1])]]) | |
131 | elif 4 == len(self.bytes): | |
132 | self.ss = ss | |
133 | elif 11 == len(self.bytes): | |
134 | self.es = es | |
135 | self.putx([0, ['Data: ' + (','.join(format(n, '#04x') | |
136 | for n in self.bytes[3:11]))]]) | |
137 | elif 12 == len(self.bytes): | |
138 | self.ss = ss | |
139 | elif 13 == len(self.bytes): | |
140 | self.es = es | |
141 | self.putx([0, ['CRC: ' | |
142 | + ('ok' if crc16(self.bytes[0:11]) == (self.bytes[11] | |
143 | + (self.bytes[12] << 8)) else 'error')]]) | |
144 | elif 0xaa == self.bytes[0]: # Read scratchpad | |
145 | if 2 == len(self.bytes): | |
146 | self.ss = ss | |
147 | elif 3 == len(self.bytes): | |
148 | self.es = es | |
149 | self.putx([0, ['Target address: 0x%04x' | |
150 | % ((self.bytes[2] << 8) + self.bytes[1])]]) | |
151 | elif 4 == len(self.bytes): | |
152 | self.ss, self.es = ss, es | |
153 | self.putx([0, ['Data status (E/S): 0x%02x' | |
154 | % (self.bytes[3])]]) | |
155 | elif 5 == len(self.bytes): | |
156 | self.ss = ss | |
157 | elif 12 == len(self.bytes): | |
158 | self.es = es | |
159 | self.putx([0, ['Data: ' + (','.join(format(n, '#04x') | |
160 | for n in self.bytes[4:12]))]]) | |
161 | elif 13 == len(self.bytes): | |
162 | self.ss = ss | |
163 | elif 14 == len(self.bytes): | |
164 | self.es = es | |
165 | self.putx([0, ['CRC: ' | |
166 | + ('ok' if crc16(self.bytes[0:12]) == (self.bytes[12] | |
167 | + (self.bytes[13] << 8)) else 'error')]]) | |
168 | elif 0x5a == self.bytes[0]: # Load first secret | |
169 | if 2 == len(self.bytes): | |
170 | self.ss = ss | |
171 | elif 4 == len(self.bytes): | |
172 | self.es = es | |
173 | self.putx([0, ['Authorization pattern (TA1, TA2, E/S): ' | |
174 | + (','.join(format(n, '#04x') | |
175 | for n in self.bytes[1:4]))]]) | |
176 | elif 4 < len(self.bytes): | |
177 | self.ss, self.es = ss, es | |
178 | if (0xaa == self.bytes[-1] or 0x55 == self.bytes[-1]): | |
179 | self.putx([0, ['End of operation']]) | |
180 | elif 0x33 == self.bytes[0]: # Compute next secret | |
181 | if 2 == len(self.bytes): | |
182 | self.ss = ss | |
183 | elif 3 == len(self.bytes): | |
184 | self.es = es | |
185 | self.putx([0, ['Target address: 0x%04x' | |
186 | % ((self.bytes[2] << 8) + self.bytes[1])]]) | |
187 | elif 3 < len(self.bytes): | |
188 | self.ss, self.es = ss, es | |
189 | if (0xaa == self.bytes[-1] or 0x55 == self.bytes[-1]): | |
190 | self.putx([0, ['End of operation']]) | |
191 | elif 0x55 == self.bytes[0]: # Copy scratchpad | |
192 | if 2 == len(self.bytes): | |
193 | self.ss = ss | |
194 | elif 4 == len(self.bytes): | |
195 | self.es = es | |
196 | self.putx([0, ['Authorization pattern (TA1, TA2, E/S): ' | |
197 | + (','.join(format(n, '#04x') | |
198 | for n in self.bytes[1:4]))]]) | |
199 | elif 5 == len(self.bytes): | |
200 | self.ss = ss | |
201 | elif 24 == len(self.bytes): | |
202 | self.es = es | |
3a9f6abf UH |
203 | mac = ','.join(format(n, '#04x') for n in self.bytes[4:24]) |
204 | self.putx([0, ['Message authentication code: ' + mac, | |
205 | 'MAC: ' + mac]]) | |
444960cc KR |
206 | elif 24 < len(self.bytes): |
207 | self.ss, self.es = ss, es | |
208 | if (0xaa == self.bytes[-1] or 0x55 == self.bytes[-1]): | |
209 | self.putx([0, ['Operation succeeded']]) | |
210 | elif (0 == self.bytes[-1]): | |
211 | self.putx([0, ['Operation failed']]) | |
212 | elif 0xa5 == self.bytes[0]: # Read authenticated page | |
213 | if 2 == len(self.bytes): | |
214 | self.ss = ss | |
215 | elif 3 == len(self.bytes): | |
216 | self.es = es | |
217 | self.putx([0, ['Target address: 0x%04x' | |
218 | % ((self.bytes[2] << 8) + self.bytes[1])]]) | |
219 | elif 4 == len(self.bytes): | |
220 | self.ss = ss | |
221 | elif 35 == len(self.bytes): | |
222 | self.es = es | |
223 | self.putx([0, ['Data: ' + (','.join(format(n, '#04x') | |
224 | for n in self.bytes[3:35]))]]) | |
225 | elif 36 == len(self.bytes): | |
226 | self.ss, self.es = ss, es | |
227 | self.putx([0, ['Padding: ' | |
228 | + ('ok' if 0xff == self.bytes[-1] else 'error')]]) | |
229 | elif 37 == len(self.bytes): | |
230 | self.ss = ss | |
231 | elif 38 == len(self.bytes): | |
232 | self.es = es | |
233 | self.putx([0, ['CRC: ' | |
234 | + ('ok' if crc16(self.bytes[0:36]) == (self.bytes[36] | |
235 | + (self.bytes[37] << 8)) else 'error')]]) | |
236 | elif 39 == len(self.bytes): | |
237 | self.ss = ss | |
238 | elif 58 == len(self.bytes): | |
239 | self.es = es | |
3a9f6abf UH |
240 | mac = ','.join(format(n, '#04x') for n in self.bytes[38:58]) |
241 | self.putx([0, ['Message authentication code: ' + mac, | |
242 | 'MAC: ' + mac]]) | |
444960cc KR |
243 | elif 59 == len(self.bytes): |
244 | self.ss = ss | |
245 | elif 60 == len(self.bytes): | |
246 | self.es = es | |
247 | self.putx([0, ['MAC CRC: ' | |
248 | + ('ok' if crc16(self.bytes[38:58]) == (self.bytes[58] | |
249 | + (self.bytes[59] << 8)) else 'error')]]) | |
250 | elif 60 < len(self.bytes): | |
251 | self.ss, self.es = ss, es | |
252 | if (0xaa == self.bytes[-1] or 0x55 == self.bytes[-1]): | |
253 | self.putx([0, ['Operation completed']]) | |
254 | elif 0xf0 == self.bytes[0]: # Read memory | |
255 | if 2 == len(self.bytes): | |
256 | self.ss = ss | |
257 | elif 3 == len(self.bytes): | |
258 | self.es = es | |
259 | self.putx([0, ['Target address: 0x%04x' | |
260 | % ((self.bytes[2] << 8) + self.bytes[1])]]) | |
261 | elif 3 < len(self.bytes): | |
262 | self.ss, self.es = ss, es | |
263 | self.putx([0, ['Data: 0x%02x' % (self.bytes[-1])]]) | |
d40e7762 SA |
264 | |
265 | bdata = self.bytes[-1].to_bytes(1, byteorder='big') | |
266 | self.put(ss, es, self.out_binary, [0, bdata]) |