decoders/atsha204a/pd.py

   1 ##
   2 ## This file is part of the libsigrokdecode project.
   3 ##
   4 ## Copyright (C) 2018 Michalis Pappas <mpappas@fastmail.fm>
   5 ##
   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.
  10 ##
  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.
  15 ##
  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/>.
  18 ##
  19
  20 import sigrokdecode as srd
  21
  22 WORD_ADDR_RESET         = 0x00
  23 WORD_ADDR_SLEEP         = 0x01
  24 WORD_ADDR_IDLE          = 0x02
  25 WORD_ADDR_COMMAND       = 0x03
  26
  27 WORD_ADDR = {0x00: 'RESET', 0x01: 'SLEEP', 0x02: 'IDLE', 0x03: 'COMMAND'}
  28
  29 OPCODE_DERIVE_KEY       = 0x1c
  30 OPCODE_DEV_REV          = 0x30
  31 OPCODE_GEN_DIG          = 0x15
  32 OPCODE_HMAC             = 0x11
  33 OPCODE_CHECK_MAC        = 0x28
  34 OPCODE_LOCK             = 0x17
  35 OPCODE_MAC              = 0x08
  36 OPCODE_NONCE            = 0x16
  37 OPCODE_PAUSE            = 0x01
  38 OPCODE_RANDOM           = 0x1b
  39 OPCODE_READ             = 0x02
  40 OPCODE_SHA              = 0x47
  41 OPCODE_UPDATE_EXTRA     = 0x20
  42 OPCODE_WRITE            = 0x12
  43
  44 OPCODES = {
  45     0x01: 'Pause',
  46     0x02: 'Read',
  47     0x08: 'MAC',
  48     0x11: 'HMAC',
  49     0x12: 'Write',
  50     0x15: 'GenDig',
  51     0x16: 'Nonce',
  52     0x17: 'Lock',
  53     0x1b: 'Random',
  54     0x1c: 'DeriveKey',
  55     0x20: 'UpdateExtra',
  56     0x28: 'CheckMac',
  57     0x30: 'DevRev',
  58     0x47: 'SHA',
  59 }
  60
  61 ZONE_CONFIG             = 0x00
  62 ZONE_OTP                = 0x01
  63 ZONE_DATA               = 0x02
  64
  65 ZONES = {0x00: 'CONFIG', 0x01: 'OTP', 0x02: 'DATA'}
  66
  67 STATUS_SUCCESS          = 0x00
  68 STATUS_CHECKMAC_FAIL    = 0x01
  69 STATUS_PARSE_ERROR      = 0x03
  70 STATUS_EXECUTION_ERROR  = 0x0f
  71 STATUS_READY            = 0x11
  72 STATUS_CRC_COMM_ERROR   = 0xff
  73
  74 STATUS = {
  75     0x00: 'Command success',
  76     0x01: 'Checkmac failure',
  77     0x03: 'Parse error',
  78     0x0f: 'Execution error',
  79     0x11: 'Ready',
  80     0xff: 'CRC / communications error',
  81 }
  82
  83 class Decoder(srd.Decoder):
  84     api_version = 3
  85     id = 'atsha204a'
  86     name = 'ATSHA204A'
  87     longname = 'Microchip ATSHA204A'
  88     desc = 'Microchip ATSHA204A CryptoAuthentication device'
  89     license = 'gplv2+'
  90     inputs = ['i2c']
  91     outputs = ['atsha204a']
  92     annotations = (
  93         ('waddr', 'Word address'),
  94         ('count', 'Count'),
  95         ('opcode', 'Opcode'),
  96         ('param1', 'Param1'),
  97         ('param2', 'Param2'),
  98         ('data', 'Data'),
  99         ('crc', 'CRC'),
 100         ('status', 'Status'),
 101         ('warning', 'Warning'),
 102     )
 103     annotation_rows = (
 104         ('frame', 'Frame', (0, 1, 2, 3, 4, 5, 6)),
 105         ('status', 'Status', (7,)),
 106         ('warnings', 'Warnings', (8,)),
 107     )
 108
 109     def __init__(self):
 110         self.state = 'IDLE'
 111         self.waddr = self.opcode = -1
 112         self.ss_block = self.es_block = 0
 113         self.bytes = []
 114
 115     def start(self):
 116         self.out_ann = self.register(srd.OUTPUT_ANN)
 117
 118     def output_tx_bytes(self):
 119         b = self.bytes
 120         if len(b) < 1: # Ignore wakeup.
 121             return
 122         self.waddr = b[0][2]
 123         self.put_waddr(b[0])
 124         if self.waddr == WORD_ADDR_COMMAND:
 125             count = b[1][2]
 126             self.put_count(b[1])
 127             if len(b) - 1 != count:
 128                 self.put_warning(b[0][0], b[-1][1],
 129                     'Invalid frame length: Got {}, expecting {} '.format(
 130                     len(b) - 1, count))
 131                 return
 132             self.opcode = b[2][2]
 133             self.put_opcode(b[2])
 134             self.put_param1(b[3])
 135             self.put_param2([b[4], b[5]])
 136             self.put_data(b[6:-2])
 137             self.put_crc([b[-2], b[-1]])
 138
 139     def output_rx_bytes(self):
 140         b = self.bytes
 141         count = b[0][2]
 142         self.put_count(b[0])
 143         if self.waddr == WORD_ADDR_RESET:
 144             self.put_data([b[1]])
 145             self.put_crc([b[2], b[3]])
 146             self.put_status(b[0][0], b[-1][1], b[1][2])
 147         elif self.waddr == WORD_ADDR_COMMAND:
 148             if count == 4: # Status / Error.
 149                 self.put_data([b[1]])
 150                 self.put_crc([b[2], b[3]])
 151                 self.put_status(b[0][0], b[-1][1], b[1][2])
 152             else:
 153                 self.put_data(b[1:-2])
 154                 self.put_crc([b[-2], b[-1]])
 155
 156     def putx(self, s, data):
 157         self.put(s[0], s[1], self.out_ann, data)
 158
 159     def puty(self, s, data):
 160         self.put(s[0][0], s[1][1], self.out_ann, data)
 161
 162     def putz(self, ss, es, data):
 163         self.put(ss, es, self.out_ann, data)
 164
 165     def put_waddr(self, s):
 166         self.putx(s, [0, ['Word addr: %s' % WORD_ADDR[s[2]]]])
 167
 168     def put_count(self, s):
 169         self.putx(s, [1, ['Count: %s' % s[2]]])
 170
 171     def put_opcode(self, s):
 172         self.putx(s, [2, ['Opcode: %s' % OPCODES[s[2]]]])
 173
 174     def put_param1(self, s):
 175         op = self.opcode
 176         if op in (OPCODE_CHECK_MAC, OPCODE_DEV_REV, OPCODE_HMAC, \
 177                 OPCODE_MAC, OPCODE_NONCE, OPCODE_RANDOM, OPCODE_SHA):
 178             self.putx(s, [3, ['Mode: %02X' % s[2]]])
 179         elif op == OPCODE_DERIVE_KEY:
 180             self.putx(s, [3, ['Random: %s' % s[2]]])
 181         elif op == OPCODE_GEN_DIG:
 182             self.putx(s, [3, ['Zone: %s' % ZONES[s[2]]]])
 183         elif op == OPCODE_LOCK:
 184             self.putx(s, [3, ['Zone: {}, Summary: {}'.format(
 185                 'DATA/OTP' if s[2] else 'CONFIG',
 186                 'Ignored' if s[2] & 0x80 else 'Used')]])
 187         elif op == OPCODE_PAUSE:
 188             self.putx(s, [3, ['Selector: %02X' % s[2]]])
 189         elif op == OPCODE_READ:
 190             self.putx(s, [3, ['Zone: {}, Length: {}'.format(ZONES[s[2] & 0x03],
 191                 '32 bytes' if s[2] & 0x90 else '4 bytes')]])
 192         elif op == OPCODE_WRITE:
 193             self.putx(s, [3, ['Zone: {}, Encrypted: {}, Length: {}'.format(ZONES[s[2] & 0x03],
 194                 'Yes' if s[2] & 0x40 else 'No', '32 bytes' if s[2] & 0x90 else '4 bytes')]])
 195         else:
 196             self.putx(s, [3, ['Param1: %02X' % s[2]]])
 197
 198     def put_param2(self, s):
 199         op = self.opcode
 200         if op == OPCODE_DERIVE_KEY:
 201             self.puty(s, [4, ['TargetKey: {:02x} {:02x}'.format(s[1][2], s[0][2])]])
 202         elif op in (OPCODE_NONCE, OPCODE_PAUSE, OPCODE_RANDOM):
 203             self.puty(s, [4, ['Zero: {:02x} {:02x}'.format(s[1][2], s[0][2])]])
 204         elif op in (OPCODE_HMAC, OPCODE_MAC, OPCODE_CHECK_MAC, OPCODE_GEN_DIG):
 205             self.puty(s, [4, ['SlotID: {:02x} {:02x}'.format(s[1][2], s[0][2])]])
 206         elif op == OPCODE_LOCK:
 207             self.puty(s, [4, ['Summary: {:02x} {:02x}'.format(s[1][2], s[0][2])]])
 208         elif op in (OPCODE_READ, OPCODE_WRITE):
 209             self.puty(s, [4, ['Address: {:02x} {:02x}'.format(s[1][2], s[0][2])]])
 210         elif op == OPCODE_UPDATE_EXTRA:
 211             self.puty(s, [4, ['NewValue: {:02x}'.format(s[0][2])]])
 212         else:
 213             self.puty(s, [4, ['-']])
 214
 215     def put_data(self, s):
 216         if len(s) == 0:
 217             return
 218         op = self.opcode
 219         if op == OPCODE_CHECK_MAC:
 220             self.putz(s[0][0], s[31][1], [5, ['ClientChal: %s' % ' '.join(format(i[2], '02x') for i in s[0:31])]])
 221             self.putz(s[32][0], s[63][1], [5, ['ClientResp: %s' % ' '.join(format(i[2], '02x') for i in s[32:63])]])
 222             self.putz(s[64][0], s[76][1], [5, ['OtherData: %s' % ' '.join(format(i[2], '02x') for i in s[64:76])]])
 223         elif op == OPCODE_DERIVE_KEY:
 224             self.putz(s[0][0], s[31][1], [5, ['MAC: %s' % ' '.join(format(i[2], '02x') for i in s)]])
 225         elif op == OPCODE_GEN_DIG:
 226             self.putz(s[0][0], s[3][1], [5, ['OtherData: %s' % ' '.join(format(i[2], '02x') for i in s)]])
 227         elif op == OPCODE_MAC:
 228             self.putz(s[0][0], s[31][1], [5, ['Challenge: %s' % ' '.join(format(i[2], '02x') for i in s)]])
 229         elif op == OPCODE_WRITE:
 230             if len(s) > 32: # Value + MAC.
 231                 self.putz(s[0][0], s[-31][1], [5, ['Value: %s' % ' '.join(format(i[2], '02x') for i in s)]])
 232                 self.putz(s[-32][0], s[-1][1], [5, ['MAC: %s' % ' '.join(format(i[2], '02x') for i in s)]])
 233             else: # Just value.
 234                 self.putz(s[0][0], s[-1][1], [5, ['Value: %s' % ' '.join(format(i[2], '02x') for i in s)]])
 235         else:
 236             self.putz(s[0][0], s[-1][1], [5, ['Data: %s' % ' '.join(format(i[2], '02x') for i in s)]])
 237
 238     def put_crc(self, s):
 239         self.puty(s, [6, ['CRC: {:02X} {:02X}'.format(s[0][2], s[1][2])]])
 240
 241     def put_status(self, ss, es, status):
 242         self.putz(ss, es, [7, ['Status: %s' % STATUS[status]]])
 243
 244     def put_warning(self, ss, es, msg):
 245         self.putz(ss, es, [8, ['Warning: %s' % msg]])
 246
 247     def decode(self, ss, es, data):
 248         cmd, databyte = data
 249
 250         # State machine.
 251         if self.state == 'IDLE':
 252             # Wait for an I²C START condition.
 253             if cmd != 'START':
 254                 return
 255             self.state = 'GET SLAVE ADDR'
 256             self.ss_block = ss
 257         elif self.state == 'GET SLAVE ADDR':
 258             # Wait for an address read/write operation.
 259             if cmd == 'ADDRESS READ':
 260                 self.state = 'READ REGS'
 261             elif cmd == 'ADDRESS WRITE':
 262                 self.state = 'WRITE REGS'
 263         elif self.state == 'READ REGS':
 264             if cmd == 'DATA READ':
 265                 self.bytes.append([ss, es, databyte])
 266             elif cmd == 'STOP':
 267                 self.es_block = es
 268                 # Reset the opcode before received data, as this causes
 269                 # responses to be displayed incorrectly.
 270                 self.opcode = -1
 271                 self.output_rx_bytes()
 272                 self.waddr = -1
 273                 self.bytes = []
 274                 self.state = 'IDLE'
 275         elif self.state == 'WRITE REGS':
 276             if cmd == 'DATA WRITE':
 277                 self.bytes.append([ss, es, databyte])
 278             elif cmd == 'STOP':
 279                 self.es_block = es
 280                 self.output_tx_bytes()
 281                 self.bytes = []
 282                 self.state = 'IDLE'
 283