decoders/mrf24j40/pd.py

   1 ##
   2 ## This file is part of the libsigrokdecode project.
   3 ##
   4 ## Copyright (C) 2015 Karl Palsson <karlp@tweak.net.au>
   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, write to the Free Software
  18 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19 ##
  20
  21 import sigrokdecode as srd
  22
  23 sregs = {
  24     0: 'RXMCR',
  25     1: 'PANIDL',
  26     2: 'PANIDH',
  27     3: 'SADRL',
  28     4: 'SADRH',
  29     5: 'EADR0',
  30     6: 'EADR1',
  31     7: 'EADR2',
  32     8: 'EADR3',
  33     9: 'EADR4',
  34     0xa: 'EADR5',
  35     0xb: 'EADR6',
  36     0xc: 'EADR7',
  37     0xd: 'RXFLUSH',
  38     0xe: 'Reserved',
  39     0xf: 'Reserved',
  40     0x10: 'ORDER',
  41     0x11: 'TXMCR',
  42     0x12: 'ACKTMOUT',
  43     0x13: 'ESLOTG1',
  44     0x14: 'SYMTICKL',
  45     0x15: 'SYMTICKH',
  46     0x16: 'PACON0',
  47     0x17: 'PACON1',
  48     0x18: 'PACON2',
  49     0x19: 'Reserved',
  50     0x1a: 'TXBCON0',
  51     0x1b: 'TXNCON',
  52     0x1c: 'TXG1CON',
  53     0x1d: 'TXG2CON',
  54     0x1e: 'ESLOTG23',
  55     0x1f: 'ESLOTG45',
  56     0x20: 'ESLOTG67',
  57     0x21: 'TXPEND',
  58     0x22: 'WAKECON',
  59     0x23: 'FRMOFFSET',
  60     0x24: 'TXSTAT',
  61     0x25: 'TXBCON1',
  62     0x26: 'GATECLK',
  63     0x27: 'TXTIME',
  64     0x28: 'HSYMTIMRL',
  65     0x29: 'HSYMTIMRH',
  66     0x2a: 'SOFTRST',
  67     0x2b: 'Reserved',
  68     0x2c: 'SECCON0',
  69     0x2d: 'SECCON1',
  70     0x2e: 'TXSTBL',
  71     0x3f: 'Reserved',
  72     0x30: 'RXSR',
  73     0x31: 'INTSTAT',
  74     0x32: 'INTCON',
  75     0x33: 'GPIO',
  76     0x34: 'TRISGPIO',
  77     0x35: 'SLPACK',
  78     0x36: 'RFCTL',
  79     0x37: 'SECCR2',
  80     0x38: 'BBREG0',
  81     0x39: 'BBREG1',
  82     0x3a: 'BBREG2',
  83     0x3b: 'BBREG3',
  84     0x3c: 'BBREG4',
  85     0x3d: 'Reserved',
  86     0x3e: 'BBREG6',
  87     0x3f: 'CCAEDTH',
  88 }
  89
  90 lregs = {
  91     0x200: 'RFCON0',
  92     0x201: 'RFCON1',
  93     0x202: 'RFCON2',
  94     0x203: 'RFCON3',
  95     0x204: 'Reserved',
  96     0x205: 'RFCON5',
  97     0x206: 'RFCON6',
  98     0x207: 'RFCON7',
  99     0x208: 'RFCON8',
 100     0x209: 'SLPCAL0',
 101     0x20A: 'SLPCAL1',
 102     0x20B: 'SLPCAL2',
 103     0x20C: 'Reserved',
 104     0x20D: 'Reserved',
 105     0x20E: 'Reserved',
 106     0x20F: 'RFSTATE',
 107     0x210: 'RSSI',
 108     0x211: 'SLPCON0',
 109     0x212: 'Reserved',
 110     0x213: 'Reserved',
 111     0x214: 'Reserved',
 112     0x215: 'Reserved',
 113     0x216: 'Reserved',
 114     0x217: 'Reserved',
 115     0x218: 'Reserved',
 116     0x219: 'Reserved',
 117     0x21A: 'Reserved',
 118     0x21B: 'Reserved',
 119     0x21C: 'Reserved',
 120     0x21D: 'Reserved',
 121     0x21E: 'Reserved',
 122     0x21F: 'Reserved',
 123     0x220: 'SLPCON1',
 124     0x221: 'Reserved',
 125     0x222: 'WAKETIMEL',
 126     0x223: 'WAKETIMEH',
 127     0x224: 'REMCNTL',
 128     0x225: 'REMCNTH',
 129     0x226: 'MAINCNT0',
 130     0x227: 'MAINCNT1',
 131     0x228: 'MAINCNT2',
 132     0x229: 'MAINCNT3',
 133     0x22A: 'Reserved',
 134     0x22B: 'Reserved',
 135     0x22C: 'Reserved',
 136     0x22D: 'Reserved',
 137     0x22E: 'Reserved',
 138     0x22F: 'TESTMODE',
 139     0x230: 'ASSOEADR0',
 140     0x231: 'ASSOEADR1',
 141     0x232: 'ASSOEADR2',
 142     0x233: 'ASSOEADR3',
 143     0x234: 'ASSOEADR4',
 144     0x235: 'ASSOEADR5',
 145     0x236: 'ASSOEADR6',
 146     0x237: 'ASSOEADR7',
 147     0x238: 'ASSOSADR0',
 148     0x239: 'ASSOSADR1',
 149     0x23A: 'Reserved',
 150     0x23B: 'Reserved',
 151     0x23C: 'Unimplemented',
 152     0x23D: 'Unimplemented',
 153     0x23E: 'Unimplemented',
 154     0x23F: 'Unimplemented',
 155     0x240: 'UPNONCE0',
 156     0x241: 'UPNONCE1',
 157     0x242: 'UPNONCE2',
 158     0x243: 'UPNONCE3',
 159     0x244: 'UPNONCE4',
 160     0x245: 'UPNONCE5',
 161     0x246: 'UPNONCE6',
 162     0x247: 'UPNONCE7',
 163     0x248: 'UPNONCE8',
 164     0x249: 'UPNONCE9',
 165     0x24A: 'UPNONCE10',
 166     0x24B: 'UPNONCE11',
 167     0x24C: 'UPNONCE12'
 168 }
 169
 170 class Decoder(srd.Decoder):
 171     api_version = 2
 172     id = 'mrf24j40'
 173     name = 'MRF24J40'
 174     longname = 'Microchip MRF24J40'
 175     desc = 'IEEE 802.15.4 2.4 GHz RF tranceiver chip.'
 176     license = 'gplv2'
 177     inputs = ['spi']
 178     outputs = ['mrf24j40']
 179     annotations = (
 180         ('sread', 'Short register read commands'),
 181         ('swrite', 'Short register write commands'),
 182         ('lread', 'Long register read commands'),
 183         ('lwrite', 'Long register write commands'),
 184         ('warning', 'Warnings'),
 185     )
 186     annotation_rows = (
 187         ('read', 'Read', (0, 2)),
 188         ('write', 'Write', (1, 3)),
 189         ('warnings', 'Warnings', (4,)),
 190     )
 191
 192     def __init__(self, **kwargs):
 193         self.ss_cmd, self.es_cmd = 0, 0
 194         self.mosi_bytes = []
 195         self.miso_bytes = []
 196
 197     def start(self):
 198         self.out_ann = self.register(srd.OUTPUT_ANN)
 199
 200     def putx(self, data):
 201         self.put(self.ss_cmd, self.es_cmd, self.out_ann, data)
 202
 203     def putw(self, pos, msg):
 204         self.put(pos[0], pos[1], self.out_ann, [4, [msg]])
 205
 206     def reset(self):
 207         self.mosi_bytes = []
 208         self.miso_bytes = []
 209
 210     def handle_short(self):
 211         write = self.mosi_bytes[0] & 0x1
 212         reg = (self.mosi_bytes[0] >> 1) & 0x3f
 213         reg_desc = sregs.get(reg, 'illegal')
 214         if write:
 215             self.putx([1, ['%s: %#x' % (reg_desc, self.mosi_bytes[1])]])
 216         else:
 217             self.putx([0, ['%s: %#x' % (reg_desc, self.miso_bytes[1])]])
 218
 219     def handle_long(self):
 220         dword = self.mosi_bytes[0] << 8 | self.mosi_bytes[1]
 221         write = dword & (0x1 << 4)
 222         reg = dword >> 5 & 0x3ff
 223         if reg >= 0x0:
 224             reg_desc = 'TX:%#x' % reg
 225         if reg >= 0x80:
 226             reg_desc = 'TX beacon:%#x' % reg
 227         if reg >= 0x100:
 228             reg_desc = 'TX GTS1:%#x' % reg
 229         if reg >= 0x180:
 230             reg_desc = 'TX GTS2:%#x' % reg
 231         if reg >= 0x200:
 232             reg_desc = lregs.get(reg, 'illegal')
 233         if reg >= 0x280:
 234             reg_desc = 'Security keys:%#x' % reg
 235         if reg >= 0x2c0:
 236             reg_desc = 'Reserved:%#x' % reg
 237         if reg >= 0x300:
 238             reg_desc = 'RX:%#x' % reg
 239
 240         if write:
 241             self.putx([3, ['%s: %#x' % (reg_desc, self.mosi_bytes[2])]])
 242         else:
 243             self.putx([2, ['%s: %#x' % (reg_desc, self.miso_bytes[2])]])
 244
 245     def decode(self, ss, es, data):
 246         ptype = data[0]
 247         if ptype == 'CS-CHANGE':
 248             # If we transition high mid-stream, toss out our data and restart.
 249             cs_old, cs_new = data[1:]
 250             if cs_old is not None and cs_old == 0 and cs_new == 1:
 251                 if len(self.mosi_bytes) not in (0, 2, 3):
 252                     self.putw([self.ss_cmd, es], 'Misplaced CS!')
 253                     self.reset()
 254             return
 255
 256         # Don't care about anything else.
 257         if ptype != 'DATA':
 258             return
 259         mosi, miso = data[1:]
 260
 261         self.ss, self.es = ss, es
 262
 263         if len(self.mosi_bytes) == 0:
 264             self.ss_cmd = ss
 265         self.mosi_bytes.append(mosi)
 266         self.miso_bytes.append(miso)
 267
 268         # Everything is either 2 bytes or 3 bytes.
 269         if len(self.mosi_bytes) < 2:
 270             return
 271
 272         if self.mosi_bytes[0] & 0x80:
 273             if len(self.mosi_bytes) == 3:
 274                 self.es_cmd = es
 275                 self.handle_long()
 276                 self.reset()
 277         else:
 278             self.es_cmd = es
 279             self.handle_short()
 280             self.reset()