2 ## This file is part of the libsigrokdecode project.
4 ## Copyright (C) 2018 Michalis Pappas <mpappas@fastmail.fm>
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 version 2 of the License, or
9 ## (at your option) any later version.
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, see <http://www.gnu.org/licenses/>.
20 import sigrokdecode as srd
22 WORD_ADDR_RESET = 0x00
23 WORD_ADDR_SLEEP = 0x01
25 WORD_ADDR_COMMAND = 0x03
27 WORD_ADDR = {0x00: 'RESET', 0x01: 'SLEEP', 0x02: 'IDLE', 0x03: 'COMMAND'}
29 OPCODE_DERIVE_KEY = 0x1c
33 OPCODE_CHECK_MAC = 0x28
41 OPCODE_UPDATE_EXTRA = 0x20
65 ZONES = {0x00: 'CONFIG', 0x01: 'OTP', 0x02: 'DATA'}
68 STATUS_CHECKMAC_FAIL = 0x01
69 STATUS_PARSE_ERROR = 0x03
70 STATUS_EXECUTION_ERROR = 0x0f
72 STATUS_CRC_COMM_ERROR = 0xff
75 0x00: 'Command success',
76 0x01: 'Checkmac failure',
78 0x0f: 'Execution error',
80 0xff: 'CRC / communications error',
83 class Decoder(srd.Decoder):
87 longname = 'Microchip ATSHA204A'
88 desc = 'Microchip ATSHA204A CryptoAuthentication device'
91 outputs = ['atsha204a']
93 ('waddr', 'Word address'),
100 ('status', 'Status'),
101 ('warning', 'Warning'),
104 ('frame', 'Frame', (0, 1, 2, 3, 4, 5, 6)),
105 ('status', 'Status', (7,)),
106 ('warnings', 'Warnings', (8,)),
114 self.waddr = self.opcode = -1
115 self.ss_block = self.es_block = 0
119 self.out_ann = self.register(srd.OUTPUT_ANN)
121 def output_tx_bytes(self):
123 if len(b) < 1: # Ignore wakeup.
127 if self.waddr == WORD_ADDR_COMMAND:
130 if len(b) - 1 != count:
131 self.put_warning(b[0][0], b[-1][1],
132 'Invalid frame length: Got {}, expecting {} '.format(
135 self.opcode = b[2][2]
136 self.put_opcode(b[2])
137 self.put_param1(b[3])
138 self.put_param2([b[4], b[5]])
139 self.put_data(b[6:-2])
140 self.put_crc([b[-2], b[-1]])
142 def output_rx_bytes(self):
146 if self.waddr == WORD_ADDR_RESET:
147 self.put_data([b[1]])
148 self.put_crc([b[2], b[3]])
149 self.put_status(b[0][0], b[-1][1], b[1][2])
150 elif self.waddr == WORD_ADDR_COMMAND:
151 if count == 4: # Status / Error.
152 self.put_data([b[1]])
153 self.put_crc([b[2], b[3]])
154 self.put_status(b[0][0], b[-1][1], b[1][2])
156 self.put_data(b[1:-2])
157 self.put_crc([b[-2], b[-1]])
159 def putx(self, s, data):
160 self.put(s[0], s[1], self.out_ann, data)
162 def puty(self, s, data):
163 self.put(s[0][0], s[1][1], self.out_ann, data)
165 def putz(self, ss, es, data):
166 self.put(ss, es, self.out_ann, data)
168 def put_waddr(self, s):
169 self.putx(s, [0, ['Word addr: %s' % WORD_ADDR[s[2]]]])
171 def put_count(self, s):
172 self.putx(s, [1, ['Count: %s' % s[2]]])
174 def put_opcode(self, s):
175 self.putx(s, [2, ['Opcode: %s' % OPCODES[s[2]]]])
177 def put_param1(self, s):
179 if op in (OPCODE_CHECK_MAC, OPCODE_DEV_REV, OPCODE_HMAC, \
180 OPCODE_MAC, OPCODE_NONCE, OPCODE_RANDOM, OPCODE_SHA):
181 self.putx(s, [3, ['Mode: %02X' % s[2]]])
182 elif op == OPCODE_DERIVE_KEY:
183 self.putx(s, [3, ['Random: %s' % s[2]]])
184 elif op == OPCODE_GEN_DIG:
185 self.putx(s, [3, ['Zone: %s' % ZONES[s[2]]]])
186 elif op == OPCODE_LOCK:
187 self.putx(s, [3, ['Zone: {}, Summary: {}'.format(
188 'DATA/OTP' if s[2] else 'CONFIG',
189 'Ignored' if s[2] & 0x80 else 'Used')]])
190 elif op == OPCODE_PAUSE:
191 self.putx(s, [3, ['Selector: %02X' % s[2]]])
192 elif op == OPCODE_READ:
193 self.putx(s, [3, ['Zone: {}, Length: {}'.format(ZONES[s[2] & 0x03],
194 '32 bytes' if s[2] & 0x90 else '4 bytes')]])
195 elif op == OPCODE_WRITE:
196 self.putx(s, [3, ['Zone: {}, Encrypted: {}, Length: {}'.format(ZONES[s[2] & 0x03],
197 'Yes' if s[2] & 0x40 else 'No', '32 bytes' if s[2] & 0x90 else '4 bytes')]])
199 self.putx(s, [3, ['Param1: %02X' % s[2]]])
201 def put_param2(self, s):
203 if op == OPCODE_DERIVE_KEY:
204 self.puty(s, [4, ['TargetKey: {:02x} {:02x}'.format(s[1][2], s[0][2])]])
205 elif op in (OPCODE_NONCE, OPCODE_PAUSE, OPCODE_RANDOM):
206 self.puty(s, [4, ['Zero: {:02x} {:02x}'.format(s[1][2], s[0][2])]])
207 elif op in (OPCODE_HMAC, OPCODE_MAC, OPCODE_CHECK_MAC, OPCODE_GEN_DIG):
208 self.puty(s, [4, ['SlotID: {:02x} {:02x}'.format(s[1][2], s[0][2])]])
209 elif op == OPCODE_LOCK:
210 self.puty(s, [4, ['Summary: {:02x} {:02x}'.format(s[1][2], s[0][2])]])
211 elif op in (OPCODE_READ, OPCODE_WRITE):
212 self.puty(s, [4, ['Address: {:02x} {:02x}'.format(s[1][2], s[0][2])]])
213 elif op == OPCODE_UPDATE_EXTRA:
214 self.puty(s, [4, ['NewValue: {:02x}'.format(s[0][2])]])
216 self.puty(s, [4, ['-']])
218 def put_data(self, s):
222 if op == OPCODE_CHECK_MAC:
223 self.putz(s[0][0], s[31][1], [5, ['ClientChal: %s' % ' '.join(format(i[2], '02x') for i in s[0:31])]])
224 self.putz(s[32][0], s[63][1], [5, ['ClientResp: %s' % ' '.join(format(i[2], '02x') for i in s[32:63])]])
225 self.putz(s[64][0], s[76][1], [5, ['OtherData: %s' % ' '.join(format(i[2], '02x') for i in s[64:76])]])
226 elif op == OPCODE_DERIVE_KEY:
227 self.putz(s[0][0], s[31][1], [5, ['MAC: %s' % ' '.join(format(i[2], '02x') for i in s)]])
228 elif op == OPCODE_GEN_DIG:
229 self.putz(s[0][0], s[3][1], [5, ['OtherData: %s' % ' '.join(format(i[2], '02x') for i in s)]])
230 elif op == OPCODE_MAC:
231 self.putz(s[0][0], s[31][1], [5, ['Challenge: %s' % ' '.join(format(i[2], '02x') for i in s)]])
232 elif op == OPCODE_WRITE:
233 if len(s) > 32: # Value + MAC.
234 self.putz(s[0][0], s[-31][1], [5, ['Value: %s' % ' '.join(format(i[2], '02x') for i in s)]])
235 self.putz(s[-32][0], s[-1][1], [5, ['MAC: %s' % ' '.join(format(i[2], '02x') for i in s)]])
237 self.putz(s[0][0], s[-1][1], [5, ['Value: %s' % ' '.join(format(i[2], '02x') for i in s)]])
239 self.putz(s[0][0], s[-1][1], [5, ['Data: %s' % ' '.join(format(i[2], '02x') for i in s)]])
241 def put_crc(self, s):
242 self.puty(s, [6, ['CRC: {:02X} {:02X}'.format(s[0][2], s[1][2])]])
244 def put_status(self, ss, es, status):
245 self.putz(ss, es, [7, ['Status: %s' % STATUS[status]]])
247 def put_warning(self, ss, es, msg):
248 self.putz(ss, es, [8, ['Warning: %s' % msg]])
250 def decode(self, ss, es, data):
254 if self.state == 'IDLE':
255 # Wait for an I²C START condition.
258 self.state = 'GET SLAVE ADDR'
260 elif self.state == 'GET SLAVE ADDR':
261 # Wait for an address read/write operation.
262 if cmd == 'ADDRESS READ':
263 self.state = 'READ REGS'
264 elif cmd == 'ADDRESS WRITE':
265 self.state = 'WRITE REGS'
266 elif self.state == 'READ REGS':
267 if cmd == 'DATA READ':
268 self.bytes.append([ss, es, databyte])
271 # Reset the opcode before received data, as this causes
272 # responses to be displayed incorrectly.
274 self.output_rx_bytes()
278 elif self.state == 'WRITE REGS':
279 if cmd == 'DATA WRITE':
280 self.bytes.append([ss, es, databyte])
283 self.output_tx_bytes()