decoders/qi/pd.py

   1 ##
   2 ## This file is part of the libsigrokdecode project.
   3 ##
   4 ## Copyright (C) 2015 Josef Gajdusek <atx@atx.name>
   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 import operator
  22 import collections
  23 from functools import reduce
  24
  25 end_codes = (
  26     'Unknown',
  27     'Charge Complete',
  28     'Internal Fault',
  29     'Over Temperature',
  30     'Over Voltage',
  31     'Over Current',
  32     'Battery Failure',
  33     'Reconfigure',
  34     'No Response',
  35 )
  36
  37 class SamplerateError(Exception):
  38     pass
  39
  40 def calc_checksum(packet):
  41     return reduce(operator.xor, packet[:-1])
  42
  43 def bits_to_uint(bits):
  44     # LSB first
  45     return reduce(lambda i, v: (i >> 1) | (v << (len(bits) - 1)), bits, 0)
  46
  47 class Decoder(srd.Decoder):
  48     api_version = 3
  49     id = 'qi'
  50     name = 'Qi'
  51     longname = 'Qi charger protocol'
  52     desc = 'Protocol used by Qi receiver'
  53     license = 'gplv2+'
  54     inputs = ['logic']
  55     outputs = ['qi']
  56     channels = (
  57         {'id': 'qi', 'name': 'Qi', 'desc': 'Demodulated Qi data line'},
  58     )
  59     annotations = (
  60         ('bits', 'Bits'),
  61         ('bytes-errors', 'Bit errors'),
  62         ('bytes-start', 'Start bits'),
  63         ('bytes-info', 'Info bits'),
  64         ('bytes-data', 'Data bytes'),
  65         ('packets-data', 'Packet data'),
  66         ('packets-checksum-ok', 'Packet checksum'),
  67         ('packets-checksum-err', 'Packet checksum'),
  68     )
  69     annotation_rows = (
  70         ('bits', 'Bits', (0,)),
  71         ('bytes', 'Bytes', (1, 2, 3, 4)),
  72         ('packets', 'Packets', (5, 6, 7)),
  73     )
  74
  75     def __init__(self):
  76         self.samplerate = None
  77         self.reset_variables()
  78
  79     def reset_variables(self):
  80         self.counter = 0
  81         self.prev = None
  82         self.state = 'IDLE'
  83         self.lastbit = 0
  84         self.bytestart = 0
  85         self.deq = collections.deque(maxlen = 2)
  86         self.bits = []
  87         self.bitsi = [0]
  88         self.bytesi = []
  89         self.packet = []
  90
  91     def metadata(self, key, value):
  92         if key == srd.SRD_CONF_SAMPLERATE:
  93             self.samplerate = value
  94             self.bit_width = float(self.samplerate) / 2e3
  95
  96     def start(self):
  97         self.out_ann = self.register(srd.OUTPUT_ANN)
  98         self.reset_variables()
  99
 100     def packet_len(self, byte):
 101         if 0x00 <= byte <= 0x1f:
 102             return int(1 + (byte - 0) / 32)
 103         if 0x20 <= byte <= 0x7f:
 104             return int(2 + (byte - 32) / 16)
 105         if 0x80 <= byte <= 0xdf:
 106             return int(8 + (byte - 128) / 8)
 107         if 0xe0 <= byte <= 0xff:
 108             return int(20 + (byte - 224) / 4)
 109
 110     def in_tolerance(self, l):
 111         return (0.75 * self.bit_width) < l < (1.25 * self.bit_width)
 112
 113     def putp(self, data):
 114         self.put(self.bytesi[0], self.bytesi[-1], self.out_ann, [5, data])
 115
 116     def process_packet(self):
 117         if self.packet[0] == 0x01: # Signal Strength
 118             self.putp(['Signal Strength: %d' % self.packet[1],
 119                        'SS: %d' % self.packet[1], 'SS'])
 120         elif self.packet[0] == 0x02: # End Power Transfer
 121             reason = end_codes[self.packet[1]] if self.packet[1] < len(end_codes) else 'Reserved'
 122             self.putp(['End Power Transfer: %s' % reason,
 123                        'EPT: %s' % reason, 'EPT'])
 124         elif self.packet[0] == 0x03: # Control Error
 125             val = self.packet[1] if self.packet[1] < 128 else (self.packet[1] & 0x7f) - 128
 126             self.putp(['Control Error: %d' % val, 'CE: %d' % val, 'CE'])
 127         elif self.packet[0] == 0x04: # Received Power
 128             self.putp(['Received Power: %d' % self.packet[1],
 129                        'RP: %d' % self.packet[1], 'RP'])
 130         elif self.packet[0] == 0x05: # Charge Status
 131             self.putp(['Charge Status: %d' % self.packet[1],
 132                        'CS: %d' % self.packet[1], 'CS'])
 133         elif self.packet[0] == 0x06: # Power Control Hold-off
 134             self.putp(['Power Control Hold-off: %dms' % self.packet[1],
 135                        'PCH: %d' % self.packet[1]], 'PCH')
 136         elif self.packet[0] == 0x51: # Configuration
 137             powerclass = (self.packet[1] & 0xc0) >> 7
 138             maxpower = self.packet[1] & 0x3f
 139             prop = (self.packet[3] & 0x80) >> 7
 140             count = self.packet[3] & 0x07
 141             winsize = (self.packet[4] & 0xf8) >> 3
 142             winoff = self.packet[4] & 0x07
 143             self.putp(['Configuration: Power Class = %d, Maximum Power = %d, Prop = %d,'
 144                        'Count = %d, Window Size = %d, Window Offset = %d' %
 145                        (powerclass, maxpower, prop, count, winsize, winoff),
 146                        'C: PC = %d MP = %d P = %d C = %d WS = %d WO = %d' %
 147                        (powerclass, maxpower, prop, count, winsize, winoff),
 148                        'Configuration', 'C'])
 149         elif self.packet[0] == 0x71: # Identification
 150             version = '%d.%d' % ((self.packet[1] & 0xf0) >> 4, self.packet[1] & 0x0f)
 151             mancode = '%02x%02x' % (self.packet[2], self.packet[3])
 152             devid = '%02x%02x%02x%02x' % (self.packet[4] & ~0x80,
 153                     self.packet[5], self.packet[6], self.packet[7])
 154             self.putp(['Identification: Version = %s, Manufacturer = %s, ' \
 155                        'Device = %s' % (version, mancode, devid),
 156                        'ID: %s %s %s' % (version, mancode, devid), 'ID'])
 157         elif self.packet[0] == 0x81: # Extended Identification
 158             edevid = '%02x%02x%02x%02x%02x%02x%02x%02x' % self.packet[1:-1]
 159             self.putp(['Extended Identification: %s' % edevid,
 160                        'EI: %s' % edevid, 'EI'])
 161         elif self.packet[0] in (0x18, 0x19, 0x28, 0x29, 0x38, 0x48, 0x58, 0x68,
 162                 0x78, 0x85, 0xa4, 0xc4, 0xe2): # Proprietary
 163             self.putp(['Proprietary', 'P'])
 164         else: # Unknown
 165             self.putp(['Unknown', '?'])
 166         self.put(self.bytesi[-1], self.samplenum, self.out_ann,
 167                  [6, ['Checksum OK', 'OK']] if \
 168                  calc_checksum(self.packet) == self.packet[-1]
 169                  else [6, ['Checksum error', 'ERR']])
 170
 171     def process_byte(self):
 172         self.put(self.bytestart, self.bitsi[0], self.out_ann,
 173                  ([2, ['Start bit', 'Start', 'S']]) if self.bits[0] == 0 else
 174                  ([1, ['Start error', 'Start err', 'SE']]))
 175         databits = self.bits[1:9]
 176         data = bits_to_uint(databits)
 177         parity = reduce(lambda i, v: (i + v) % 2, databits, 1)
 178         self.put(self.bitsi[0], self.bitsi[8], self.out_ann, [4, ['%02x' % data]])
 179         self.put(self.bitsi[8], self.bitsi[9], self.out_ann,
 180                  ([3, ['Parity bit', 'Parity', 'P']]) if self.bits[9] == parity else
 181                  ([1, ['Parity error', 'Parity err', 'PE']]))
 182         self.put(self.bitsi[9], self.bitsi[10], self.out_ann,
 183                  ([3, ['Stop bit', 'Stop', 'S']]) if self.bits[10] == 1 else
 184                  ([1, ['Stop error', 'Stop err', 'SE']]))
 185
 186         self.bytesi.append(self.bytestart)
 187         self.packet.append(data)
 188         if self.packet_len(self.packet[0]) + 2 == len(self.packet):
 189             self.process_packet()
 190             self.bytesi.clear()
 191             self.packet.clear()
 192
 193     def add_bit(self, bit):
 194         self.bits.append(bit)
 195         self.bitsi.append(self.samplenum)
 196
 197         if self.state == 'IDLE' and len(self.bits) >= 5 and \
 198                                     self.bits[-5:] == [1, 1, 1, 1, 0]:
 199             self.state = 'DATA'
 200             self.bytestart = self.bitsi[-2]
 201             self.bits = [0]
 202             self.bitsi = [self.samplenum]
 203             self.packet.clear()
 204         elif self.state == 'DATA' and len(self.bits) == 11:
 205             self.process_byte()
 206             self.bytestart = self.samplenum
 207             self.bits.clear()
 208             self.bitsi.clear()
 209         if self.state != 'IDLE':
 210             self.put(self.lastbit, self.samplenum, self.out_ann, [0, ['%d' % bit]])
 211         self.lastbit = self.samplenum
 212
 213     def handle_transition(self, l, htl):
 214         self.deq.append(l)
 215         if len(self.deq) >= 2 and \
 216                 (self.in_tolerance(self.deq[-1] + self.deq[-2]) or \
 217                 htl and self.in_tolerance(l * 2) and \
 218                 self.deq[-2] > 1.25 * self.bit_width):
 219             self.add_bit(1)
 220             self.deq.clear()
 221         elif self.in_tolerance(l):
 222             self.add_bit(0)
 223             self.deq.clear()
 224         elif l > (1.25 * self.bit_width):
 225             self.state = 'IDLE'
 226             self.bytesi.clear()
 227             self.packet.clear()
 228             self.bits.clear()
 229             self.bitsi.clear()
 230
 231     def decode(self):
 232         if not self.samplerate:
 233             raise SamplerateError('Cannot decode without samplerate.')
 234
 235         (qi,) = self.wait({'skip': 1})
 236         self.handle_transition(self.samplenum, qi == 0)
 237         while True:
 238             prev = self.samplenum
 239             (qi,) = self.wait({0: 'e'})
 240             self.handle_transition(self.samplenum - prev, qi == 0)