]> sigrok.org Git - libsigrokdecode.git/blobdiff - decoders/mrf24j40/pd.py
avr_isp: Add more parts
[libsigrokdecode.git] / decoders / mrf24j40 / pd.py
index e470e8a4d772fb9f0e84e6efefbb9c3f6074d6cb..87022dd71b46710928e93b1213a36c4d21d03c04 100644 (file)
 ## GNU General Public License for more details.
 ##
 ## You should have received a copy of the GNU General Public License
-## along with this program; if not, write to the Free Software
-## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+## along with this program; if not, see <http://www.gnu.org/licenses/>.
 ##
 
 import sigrokdecode as srd
+from .lists import *
 
-sregs = {
-    0: 'RXMCR',
-    1: 'PANIDL',
-    2: 'PANIDH',
-    3: 'SADRL',
-    4: 'SADRH',
-    5: 'EADR0',
-    6: 'EADR1',
-    7: 'EADR2',
-    8: 'EADR3',
-    9: 'EADR4',
-    0xa: 'EADR5',
-    0xb: 'EADR6',
-    0xc: 'EADR7',
-    0xd: 'RXFLUSH',
-    0xe: 'Reserved',
-    0xf: 'Reserved',
-    0x10: 'ORDER',
-    0x11: 'TXMCR',
-    0x12: 'ACKTMOUT',
-    0x13: 'ESLOTG1',
-    0x14: 'SYMTICKL',
-    0x15: 'SYMTICKH',
-    0x16: 'PACON0',
-    0x17: 'PACON1',
-    0x18: 'PACON2',
-    0x19: 'Reserved',
-    0x1a: 'TXBCON0',
-    0x1b: 'TXNCON',
-    0x1c: 'TXG1CON',
-    0x1d: 'TXG2CON',
-    0x1e: 'ESLOTG23',
-    0x1f: 'ESLOTG45',
-    0x20: 'ESLOTG67',
-    0x21: 'TXPEND',
-    0x22: 'WAKECON',
-    0x23: 'FRMOFFSET',
-    0x24: 'TXSTAT',
-    0x25: 'TXBCON1',
-    0x26: 'GATECLK',
-    0x27: 'TXTIME',
-    0x28: 'HSYMTIMRL',
-    0x29: 'HSYMTIMRH',
-    0x2a: 'SOFTRST',
-    0x2b: 'Reserved',
-    0x2c: 'SECCON0',
-    0x2d: 'SECCON1',
-    0x2e: 'TXSTBL',
-    0x3f: 'Reserved',
-    0x30: 'RXSR',
-    0x31: 'INTSTAT',
-    0x32: 'INTCON',
-    0x33: 'GPIO',
-    0x34: 'TRISGPIO',
-    0x35: 'SLPACK',
-    0x36: 'RFCTL',
-    0x37: 'SECCR2',
-    0x38: 'BBREG0',
-    0x39: 'BBREG1',
-    0x3a: 'BBREG2',
-    0x3b: 'BBREG3',
-    0x3c: 'BBREG4',
-    0x3d: 'Reserved',
-    0x3e: 'BBREG6',
-    0x3f: 'CCAEDTH',
-}
-
-lregs = {
-    0x200: 'RFCON0',
-    0x201: 'RFCON1',
-    0x202: 'RFCON2',
-    0x203: 'RFCON3',
-    0x204: 'Reserved',
-    0x205: 'RFCON5',
-    0x206: 'RFCON6',
-    0x207: 'RFCON7',
-    0x208: 'RFCON8',
-    0x209: 'SLPCAL0',
-    0x20A: 'SLPCAL1',
-    0x20B: 'SLPCAL2',
-    0x20C: 'Reserved',
-    0x20D: 'Reserved',
-    0x20E: 'Reserved',
-    0x20F: 'RFSTATE',
-    0x210: 'RSSI',
-    0x211: 'SLPCON0',
-    0x212: 'Reserved',
-    0x213: 'Reserved',
-    0x214: 'Reserved',
-    0x215: 'Reserved',
-    0x216: 'Reserved',
-    0x217: 'Reserved',
-    0x218: 'Reserved',
-    0x219: 'Reserved',
-    0x21A: 'Reserved',
-    0x21B: 'Reserved',
-    0x21C: 'Reserved',
-    0x21D: 'Reserved',
-    0x21E: 'Reserved',
-    0x21F: 'Reserved',
-    0x220: 'SLPCON1',
-    0x221: 'Reserved',
-    0x222: 'WAKETIMEL',
-    0x223: 'WAKETIMEH',
-    0x224: 'REMCNTL',
-    0x225: 'REMCNTH',
-    0x226: 'MAINCNT0',
-    0x227: 'MAINCNT1',
-    0x228: 'MAINCNT2',
-    0x229: 'MAINCNT3',
-    0x22A: 'Reserved',
-    0x22B: 'Reserved',
-    0x22C: 'Reserved',
-    0x22D: 'Reserved',
-    0x22E: 'Reserved',
-    0x22F: 'TESTMODE',
-    0x230: 'ASSOEADR0',
-    0x231: 'ASSOEADR1',
-    0x232: 'ASSOEADR2',
-    0x233: 'ASSOEADR3',
-    0x234: 'ASSOEADR4',
-    0x235: 'ASSOEADR5',
-    0x236: 'ASSOEADR6',
-    0x237: 'ASSOEADR7',
-    0x238: 'ASSOSADR0',
-    0x239: 'ASSOSADR1',
-    0x23A: 'Reserved',
-    0x23B: 'Reserved',
-    0x23C: 'Unimplemented',
-    0x23D: 'Unimplemented',
-    0x23E: 'Unimplemented',
-    0x23F: 'Unimplemented',
-    0x240: 'UPNONCE0',
-    0x241: 'UPNONCE1',
-    0x242: 'UPNONCE2',
-    0x243: 'UPNONCE3',
-    0x244: 'UPNONCE4',
-    0x245: 'UPNONCE5',
-    0x246: 'UPNONCE6',
-    0x247: 'UPNONCE7',
-    0x248: 'UPNONCE8',
-    0x249: 'UPNONCE9',
-    0x24A: 'UPNONCE10',
-    0x24B: 'UPNONCE11',
-    0x24C: 'UPNONCE12'
-}
+TX, RX = range(2)
 
 class Decoder(srd.Decoder):
-    api_version = 2
+    api_version = 3
     id = 'mrf24j40'
     name = 'MRF24J40'
     longname = 'Microchip MRF24J40'
     desc = 'IEEE 802.15.4 2.4 GHz RF tranceiver chip.'
-    license = 'gplv2'
+    license = 'gplv2+'
     inputs = ['spi']
-    outputs = ['mrf24j40']
+    outputs = []
+    tags = ['IC', 'Wireless/RF']
     annotations = (
-        ('sread', 'Short register read commands'),
-        ('swrite', 'Short register write commands'),
-        ('lread', 'Long register read commands'),
-        ('lwrite', 'Long register write commands'),
-        ('warning', 'Warnings'),
+        ('sread', 'Short register read'),
+        ('swrite', 'Short register write'),
+        ('lread', 'Long register read'),
+        ('lwrite', 'Long register write'),
+        ('warning', 'Warning'),
+        ('tx-frame', 'TX frame'),
+        ('rx-frame', 'RX frame'),
+        ('tx-retry-1', '1x TX retry'),
+        ('tx-retry-2', '2x TX retry'),
+        ('tx-retry-3', '3x TX retry'),
+        ('tx-fail', 'TX fail (too many retries)'),
+        ('ccafail', 'CCAFAIL (channel busy)'),
     )
     annotation_rows = (
-        ('read', 'Read', (0, 2)),
-        ('write', 'Write', (1, 3)),
+        ('reads', 'Reads', (0, 2)),
+        ('writes', 'Writes', (1, 3)),
         ('warnings', 'Warnings', (4,)),
+        ('tx-frames', 'TX frames', (5,)),
+        ('rx-frames', 'RX frames', (6,)),
+        ('tx-retries-1', '1x TX retries', (7,)),
+        ('tx-retries-2', '2x TX retries', (8,)),
+        ('tx-retries-3', '3x TX retries', (9,)),
+        ('tx-fails', 'TX fails', (10,)),
+        ('ccafails', 'CCAFAILs', (11,)),
     )
 
-    def __init__(self, **kwargs):
+    def __init__(self):
+        self.reset()
+
+    def reset(self):
         self.ss_cmd, self.es_cmd = 0, 0
-        self.mosi_bytes = []
-        self.miso_bytes = []
+        self.ss_frame, self.es_frame = [0, 0], [0, 0]
+        self.mosi_bytes, self.miso_bytes = [], []
+        self.framecache = [[], []]
 
     def start(self):
         self.out_ann = self.register(srd.OUTPUT_ANN)
@@ -203,7 +77,7 @@ class Decoder(srd.Decoder):
     def putw(self, pos, msg):
         self.put(pos[0], pos[1], self.out_ann, [4, [msg]])
 
-    def reset(self):
+    def reset_data(self):
         self.mosi_bytes = []
         self.miso_bytes = []
 
@@ -211,10 +85,34 @@ class Decoder(srd.Decoder):
         write = self.mosi_bytes[0] & 0x1
         reg = (self.mosi_bytes[0] >> 1) & 0x3f
         reg_desc = sregs.get(reg, 'illegal')
+        for rxtx in (RX, TX):
+            if self.framecache[rxtx] == []:
+                continue
+            bit0 = self.mosi_bytes[1] & (1 << 0)
+            if rxtx == TX and not (reg_desc == 'TXNCON' and bit0 == 1):
+                continue
+            if rxtx == RX and not (reg_desc == 'RXFLUSH' and bit0 == 1):
+                continue
+            idx = 5 if rxtx == TX else 6
+            xmitdir = 'TX' if rxtx == TX else 'RX'
+            frame = ' '.join(['%02X' % b for b in self.framecache[rxtx]])
+            self.put(self.ss_frame[rxtx], self.es_frame[rxtx], self.out_ann,
+                [idx, ['%s frame: %s' % (xmitdir, frame)]])
+            self.framecache[rxtx] = []
         if write:
             self.putx([1, ['%s: %#x' % (reg_desc, self.mosi_bytes[1])]])
         else:
             self.putx([0, ['%s: %#x' % (reg_desc, self.miso_bytes[1])]])
+            numretries = (self.miso_bytes[1] & 0xc0) >> 6
+            if reg_desc == 'TXSTAT' and numretries > 0:
+                txfail = 1 if ((self.miso_bytes[1] & (1 << 0)) != 0) else 0
+                idx = 6 + numretries + txfail
+                if txfail:
+                    self.putx([idx, ['TX fail (>= 4 retries)', 'TX fail']])
+                else:
+                    self.putx([idx, ['TX retries: %d' % numretries]])
+            if reg_desc == 'TXSTAT' and (self.miso_bytes[1] & (1 << 5)) != 0:
+                self.putx([11, ['CCAFAIL (channel busy)', 'CCAFAIL']])
 
     def handle_long(self):
         dword = self.mosi_bytes[0] << 8 | self.mosi_bytes[1]
@@ -242,6 +140,16 @@ class Decoder(srd.Decoder):
         else:
             self.putx([2, ['%s: %#x' % (reg_desc, self.miso_bytes[2])]])
 
+        for rxtx in (RX, TX):
+            if rxtx == RX and reg_desc[:3] != 'RX:':
+                continue
+            if rxtx == TX and reg_desc[:3] != 'TX:':
+                continue
+            if len(self.framecache[rxtx]) == 0:
+                self.ss_frame[rxtx] = self.ss_cmd
+            self.es_frame[rxtx] = self.es_cmd
+            self.framecache[rxtx] += [self.mosi_bytes[2]] if rxtx == TX else [self.miso_bytes[2]]
+
     def decode(self, ss, es, data):
         ptype = data[0]
         if ptype == 'CS-CHANGE':
@@ -250,7 +158,7 @@ class Decoder(srd.Decoder):
             if cs_old is not None and cs_old == 0 and cs_new == 1:
                 if len(self.mosi_bytes) not in (0, 2, 3):
                     self.putw([self.ss_cmd, es], 'Misplaced CS!')
-                    self.reset()
+                    self.reset_data()
             return
 
         # Don't care about anything else.
@@ -273,8 +181,8 @@ class Decoder(srd.Decoder):
             if len(self.mosi_bytes) == 3:
                 self.es_cmd = es
                 self.handle_long()
-                self.reset()
+                self.reset_data()
         else:
             self.es_cmd = es
             self.handle_short()
-            self.reset()
+            self.reset_data()