flash: fix at91sam3/4 driver typos
[fw/openocd] / tools / xsvf_tools / xsvfdump.py
index df5db165bcec84b5d962338138e17716fa1fd39a..e65f8d5b273263fdc26daacaa4009aa157e18f91 100644 (file)
-#!/usr/bin/python3.0\r
-\r
-# Copyright 2008, SoftPLC Corporation  http://softplc.com\r
-# Dick Hollenbeck dick@softplc.com\r
-\r
-# This program is free software; you can redistribute it and/or\r
-# modify it under the terms of the GNU General Public License\r
-# as published by the Free Software Foundation; either version 2\r
-# of the License, or (at your option) any later version.\r
-#\r
-# This program is distributed in the hope that it will be useful,\r
-# but WITHOUT ANY WARRANTY; without even the implied warranty of\r
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
-# GNU General Public License for more details.\r
-#\r
-# You should have received a copy of the GNU General Public License\r
-# along with this program; if not, you may find one here:\r
-# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html\r
-# or you may search the http://www.gnu.org website for the version 2 license,\r
-# or you may write to the Free Software Foundation, Inc.,\r
-# 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
-\r
-# Dump an Xilinx XSVF file to stdout\r
-\r
-# This program is written for python 3.0, and it is not easy to change this\r
-# back to 2.x.  You may find it easier to use python 3.x even if that means\r
-# building it.\r
-\r
-\r
-import sys\r
-import struct\r
-\r
-\r
-LABEL = "A script to dump an XSVF file to stdout"\r
-\r
-\r
-Xsdrsize = 0\r
-\r
-\r
-(XCOMPLETE,XTDOMASK,XSIR,XSDR,XRUNTEST,hole0,hole1,XREPEAT,XSDRSIZE,XSDRTDO,\r
-    XSETSDRMASKS,XSDRINC,XSDRB,XSDRC,XSDRE,XSDRTDOB,XSDRTDOC,\r
-    XSDRTDOE,XSTATE,XENDIR,XENDDR,XSIR2,XCOMMENT,XWAIT,XWAITSTATE,LCOUNT,LDELAY,LSDR) = range(28)\r
-\r
-\r
-(RESET,IDLE,\r
-    DRSELECT,DRCAPTURE,DRSHIFT,DREXIT1,DRPAUSE,DREXIT2,DRUPDATE,\r
-    IRSELECT,IRCAPTURE,IRSHIFT,IREXIT1,IRPAUSE,IREXIT2,IRUPDATE) = range(16)\r
-\r
-\r
-State = ("RESET","IDLE",\r
-    "DRSELECT","DRCAPTURE","DRSHIFT","DREXIT1","DRPAUSE","DREXIT2","DRUPDATE",\r
-    "IRSELECT","IRCAPTURE","IRSHIFT","IREXIT1","IRPAUSE","IREXIT2","IRUPDATE")\r
-\r
-Setsdrmasks = 0\r
-SetsdrmasksOnesCount = 0\r
-\r
-def ReadSDRMASKS( f, len ):\r
-    global Setsdrmasks, SetsdrmasksOnesCount\r
-    byteCount = (len+7)//8\r
-    Setsdrmasks = f.read( byteCount )\r
-    ls = []\r
-    SetsdrmasksOnesCount = 0\r
-    for b in Setsdrmasks:\r
-        ls.append( "%x" % ((b & 0xf0) >> 4) )\r
-        ls.append( "%x" % ( b & 0x0f ) )\r
-        for i in range(8):\r
-            if b & (1<<i):\r
-                SetsdrmasksOnesCount = SetsdrmasksOnesCount +1\r
-    return ''.join(ls)\r
-\r
-\r
-def bytes2hexString( f, len ):\r
-    byteCount = (len+7)//8\r
-    bytebuf = f.read( byteCount )\r
-    ls = []\r
-    for b in bytebuf:\r
-        ls.append( "%x" % ((b & 0xf0) >> 4) )\r
-        ls.append( "%x" % ( b & 0x0f ) )\r
-    return ''.join(ls)\r
-\r
-\r
-def ReadByte( f ):\r
-    """Read a byte from a file and return it as an int in least significant 8 bits"""\r
-    b = f.read(1)\r
-    if b:\r
-        return 0xff & b[0];\r
-    else:\r
-        return -1\r
-\r
-\r
-def ShowState( state ):\r
-    """return the given state int as a state string"""\r
-    #return "0x%02x" % state # comment this out to get textual state form\r
-    global State\r
-    if 0 <= state <= IRUPDATE:\r
-        return State[state]\r
-    else:\r
-        return "Unknown state 0x%02x" % state\r
-\r
-\r
-def ShowOpcode( op, f ):\r
-    """return the given byte as an opcode string"""\r
-    global Xsdrsize\r
-    if op == XCOMPLETE:\r
-        print("XCOMPLETE")\r
-\r
-    elif op == XTDOMASK:\r
-        buf = bytes2hexString( f, Xsdrsize )\r
-        print("XTDOMASK 0x%s" % buf)\r
-\r
-    elif op == XSIR:\r
-        len = ReadByte( f )\r
-        buf = bytes2hexString( f, len )\r
-        print("XSIR 0x%02X 0x%s" % (len, buf))\r
-\r
-    elif op == XSDR:\r
-        tdi = bytes2hexString( f, Xsdrsize )\r
-        print("XSDR 0x%s" % tdi)\r
-\r
-    elif op == XRUNTEST:\r
-        len = struct.unpack( '>i', f.read(4) )[0]\r
-        print("XRUNTEST 0x%08X" % len)\r
-\r
-    elif op == XREPEAT:\r
-        len = ReadByte( f )\r
-        print("XREPEAT 0x%02X" % len)\r
-\r
-    elif op == XSDRSIZE:\r
-        Xsdrsize = struct.unpack( '>i', f.read(4) )[0]\r
-        #print("XSDRSIZE 0x%08X" % Xsdrsize, file=sys.stderr )\r
-        print("XSDRSIZE 0x%08X %d" % (Xsdrsize, Xsdrsize) )\r
-\r
-    elif op == XSDRTDO:\r
-        tdi = bytes2hexString( f, Xsdrsize )\r
-        tdo = bytes2hexString( f, Xsdrsize )\r
-        print("XSDRTDO 0x%s 0x%s" % (tdi, tdo) )\r
-\r
-    elif op == XSETSDRMASKS:\r
-        addrmask = bytes2hexString( f, Xsdrsize )\r
-        datamask = ReadSDRMASKS( f, Xsdrsize )\r
-        print("XSETSDRMASKS 0x%s 0x%s" % (addrmask, datamask) )\r
-\r
-    elif op == XSDRINC:\r
-        startaddr = bytes2hexString( f, Xsdrsize )\r
-        len = ReadByte(f)\r
-        print("XSDRINC 0x%s 0x%02X" % (startaddr, len), end='' )\r
-        for numTimes in range(len):\r
-            data = bytes2hexString( f, SetsdrmasksOnesCount)\r
-            print(" 0x%s" % data )\r
-        print() # newline\r
-\r
-    elif op == XSDRB:\r
-        tdi = bytes2hexString( f, Xsdrsize )\r
-        print("XSDRB 0x%s" % tdi )\r
-\r
-    elif op == XSDRC:\r
-        tdi = bytes2hexString( f, Xsdrsize )\r
-        print("XSDRC 0x%s" % tdi )\r
-\r
-    elif op == XSDRE:\r
-        tdi = bytes2hexString( f, Xsdrsize )\r
-        print("XSDRE 0x%s" % tdi )\r
-\r
-    elif op == XSDRTDOB:\r
-        tdo = bytes2hexString( f, Xsdrsize )\r
-        print("XSDRTDOB 0x%s" % tdo )\r
-\r
-    elif op == XSDRTDOC:\r
-        tdi = bytes2hexString( f, Xsdrsize )\r
-        tdo = bytes2hexString( f, Xsdrsize )\r
-        print("XSDRTDOC 0x%s 0x%s" % (tdi, tdo) )\r
-\r
-    elif op == XSDRTDOE:\r
-        tdi = bytes2hexString( f, Xsdrsize )\r
-        tdo = bytes2hexString( f, Xsdrsize )\r
-        print("XSDRTDOE 0x%s 0x%s" % (tdi, tdo) )\r
-\r
-    elif op == XSTATE:\r
-        b = ReadByte(f)\r
-        print("XSTATE %s" % ShowState(b))\r
-\r
-    elif op == XENDIR:\r
-        b = ReadByte( f )\r
-        print("XENDIR %s" % ShowState(b))\r
-\r
-    elif op == XENDDR:\r
-        b = ReadByte( f )\r
-        print("XENDDR %s" % ShowState(b))\r
-\r
-    elif op == XSIR2:\r
-        len = struct.unpack( '>H', f.read(2) )[0]\r
-        buf = bytes2hexString( f, len )\r
-        print("XSIR2 0x%04X 0x%s" % (len, buf))\r
-\r
-    elif op == XCOMMENT:\r
-        cmt = []\r
-        while 1:\r
-            b = ReadByte(f)\r
-            if b == 0:          # terminating nul\r
-                break;\r
-            cmt.append( chr(b) )\r
-        print("XCOMMENT \"%s\"" % ''.join(cmt)  )\r
-\r
-    elif op == XWAIT:\r
-        run_state = ReadByte(f)\r
-        end_state = ReadByte(f)\r
-        useconds  = struct.unpack( '>i', f.read(4) )[0]\r
-        print("XWAIT %s %s" % (ShowState(run_state), ShowState(end_state)), useconds)\r
-\r
-    elif op == XWAITSTATE:\r
-        run_state = ReadByte(f)\r
-        end_state = ReadByte(f)\r
-        clocks    = struct.unpack( '>i', f.read(4) )[0]\r
-        useconds  = struct.unpack( '>i', f.read(4) )[0]\r
-        print("XWAITSTATE %s %s CLOCKS=%d USECS=%d" % (ShowState(run_state), ShowState(end_state), clocks, useconds) )\r
-\r
-    elif op == LCOUNT:\r
-        loop_count = struct.unpack( '>i', f.read(4) )[0]\r
-        print("LCOUNT", loop_count )\r
-\r
-    elif op == LDELAY:\r
-        run_state = ReadByte(f)\r
-        clocks    = struct.unpack( '>i', f.read(4) )[0]\r
-        useconds  = struct.unpack( '>i', f.read(4) )[0]\r
-        print("LDELAY %s CLOCKS=%d USECS=%d" % (ShowState(run_state), clocks, useconds) )\r
-\r
-    elif op == LSDR:\r
-        tdi = bytes2hexString( f, Xsdrsize )\r
-        tdo = bytes2hexString( f, Xsdrsize )\r
-        print("LSDR 0x%s 0x%s" % (tdi, tdo) )\r
-\r
-    else:\r
-        print("UNKNOWN op 0x%02X %d" % (op, op))\r
-        exit(1)\r
-\r
-\r
-def main():\r
-\r
-    if len( sys.argv ) < 2:\r
-        print("usage %s <xsvf_filename>" % sys.argv[0])\r
-        exit(1)\r
-\r
-    f = open( sys.argv[1], 'rb' )\r
-\r
-    opcode = ReadByte( f )\r
-    while opcode != -1:\r
-        # print the position within the file, then the command\r
-        print( "%d: " % f.tell(), end='' )\r
-        ShowOpcode( opcode, f )\r
-        opcode = ReadByte(f)\r
-\r
-\r
-if __name__ == "__main__":\r
-    main()\r
-\r
+#!/usr/bin/python3.0
+
+# Copyright 2008, SoftPLC Corporation  http://softplc.com
+# Dick Hollenbeck dick@softplc.com
+
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# 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, you may find one here:
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+# or you may search the http://www.gnu.org website for the version 2 license,
+# or you may write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+
+# Dump an Xilinx XSVF file to stdout
+
+# This program is written for python 3.0, and it is not easy to change this
+# back to 2.x.  You may find it easier to use python 3.x even if that means
+# building it.
+
+
+import sys
+import struct
+
+
+LABEL = "A script to dump an XSVF file to stdout"
+
+
+Xsdrsize = 0
+
+
+(XCOMPLETE,XTDOMASK,XSIR,XSDR,XRUNTEST,hole0,hole1,XREPEAT,XSDRSIZE,XSDRTDO,
+    XSETSDRMASKS,XSDRINC,XSDRB,XSDRC,XSDRE,XSDRTDOB,XSDRTDOC,
+    XSDRTDOE,XSTATE,XENDIR,XENDDR,XSIR2,XCOMMENT,XWAIT,XWAITSTATE,
+    LCOUNT,LDELAY,LSDR,XTRST) = range(29)
+
+
+(RESET,IDLE,
+    DRSELECT,DRCAPTURE,DRSHIFT,DREXIT1,DRPAUSE,DREXIT2,DRUPDATE,
+    IRSELECT,IRCAPTURE,IRSHIFT,IREXIT1,IRPAUSE,IREXIT2,IRUPDATE) = range(16)
+
+
+State = ("RESET","IDLE",
+    "DRSELECT","DRCAPTURE","DRSHIFT","DREXIT1","DRPAUSE","DREXIT2","DRUPDATE",
+    "IRSELECT","IRCAPTURE","IRSHIFT","IREXIT1","IRPAUSE","IREXIT2","IRUPDATE")
+
+
+trst_mode_allowed = ('ON', 'OFF', 'Z', 'ABSENT')
+
+
+Setsdrmasks = 0
+SetsdrmasksOnesCount = 0
+
+def ReadSDRMASKS( f, len ):
+    global Setsdrmasks, SetsdrmasksOnesCount
+    byteCount = (len+7)//8
+    Setsdrmasks = f.read( byteCount )
+    ls = []
+    SetsdrmasksOnesCount = 0
+    for b in Setsdrmasks:
+        ls.append( "%x" % ((b & 0xf0) >> 4) )
+        ls.append( "%x" % ( b & 0x0f ) )
+        for i in range(8):
+            if b & (1<<i):
+                SetsdrmasksOnesCount = SetsdrmasksOnesCount +1
+    return ''.join(ls)
+
+
+def bytes2hexString( f, len ):
+    byteCount = (len+7)//8
+    bytebuf = f.read( byteCount )
+    ls = []
+    for b in bytebuf:
+        ls.append( "%x" % ((b & 0xf0) >> 4) )
+        ls.append( "%x" % ( b & 0x0f ) )
+    return ''.join(ls)
+
+
+def ReadByte( f ):
+    """Read a byte from a file and return it as an int in least significant 8 bits"""
+    b = f.read(1)
+    if b:
+        return 0xff & b[0];
+    else:
+        return -1
+
+
+def ShowState( state ):
+    """return the given state int as a state string"""
+    #return "0x%02x" % state # comment this out to get textual state form
+    global State
+    if 0 <= state <= IRUPDATE:
+        return State[state]
+    else:
+        return "Unknown state 0x%02x" % state
+
+
+def ShowOpcode( op, f ):
+    """return the given byte as an opcode string"""
+    global Xsdrsize
+    if op == XCOMPLETE:
+        print("XCOMPLETE")
+
+    elif op == XTDOMASK:
+        buf = bytes2hexString( f, Xsdrsize )
+        print("XTDOMASK 0x%s" % buf)
+
+    elif op == XSIR:
+        len = ReadByte( f )
+        buf = bytes2hexString( f, len )
+        print("XSIR 0x%02X 0x%s" % (len, buf))
+
+    elif op == XSDR:
+        tdi = bytes2hexString( f, Xsdrsize )
+        print("XSDR 0x%s" % tdi)
+
+    elif op == XRUNTEST:
+        len = struct.unpack( '>i', f.read(4) )[0]
+        print("XRUNTEST 0x%08X" % len)
+
+    elif op == XREPEAT:
+        len = ReadByte( f )
+        print("XREPEAT 0x%02X" % len)
+
+    elif op == XSDRSIZE:
+        Xsdrsize = struct.unpack( '>i', f.read(4) )[0]
+        #print("XSDRSIZE 0x%08X" % Xsdrsize, file=sys.stderr )
+        print("XSDRSIZE 0x%08X %d" % (Xsdrsize, Xsdrsize) )
+
+    elif op == XSDRTDO:
+        tdi = bytes2hexString( f, Xsdrsize )
+        tdo = bytes2hexString( f, Xsdrsize )
+        print("XSDRTDO 0x%s 0x%s" % (tdi, tdo) )
+
+    elif op == XSETSDRMASKS:
+        addrmask = bytes2hexString( f, Xsdrsize )
+        datamask = ReadSDRMASKS( f, Xsdrsize )
+        print("XSETSDRMASKS 0x%s 0x%s" % (addrmask, datamask) )
+
+    elif op == XSDRINC:
+        startaddr = bytes2hexString( f, Xsdrsize )
+        len = ReadByte(f)
+        print("XSDRINC 0x%s 0x%02X" % (startaddr, len), end='' )
+        for numTimes in range(len):
+            data = bytes2hexString( f, SetsdrmasksOnesCount)
+            print(" 0x%s" % data )
+        print() # newline
+
+    elif op == XSDRB:
+        tdi = bytes2hexString( f, Xsdrsize )
+        print("XSDRB 0x%s" % tdi )
+
+    elif op == XSDRC:
+        tdi = bytes2hexString( f, Xsdrsize )
+        print("XSDRC 0x%s" % tdi )
+
+    elif op == XSDRE:
+        tdi = bytes2hexString( f, Xsdrsize )
+        print("XSDRE 0x%s" % tdi )
+
+    elif op == XSDRTDOB:
+        tdo = bytes2hexString( f, Xsdrsize )
+        print("XSDRTDOB 0x%s" % tdo )
+
+    elif op == XSDRTDOC:
+        tdi = bytes2hexString( f, Xsdrsize )
+        tdo = bytes2hexString( f, Xsdrsize )
+        print("XSDRTDOC 0x%s 0x%s" % (tdi, tdo) )
+
+    elif op == XSDRTDOE:
+        tdi = bytes2hexString( f, Xsdrsize )
+        tdo = bytes2hexString( f, Xsdrsize )
+        print("XSDRTDOE 0x%s 0x%s" % (tdi, tdo) )
+
+    elif op == XSTATE:
+        b = ReadByte(f)
+        print("XSTATE %s" % ShowState(b))
+
+    elif op == XENDIR:
+        b = ReadByte( f )
+        print("XENDIR %s" % 'IRPAUSE' if b==1 else 'IDLE')
+
+    elif op == XENDDR:
+        b = ReadByte( f )
+        print("XENDDR %s" % 'DRPAUSE' if b==1 else 'IDLE')
+
+    elif op == XSIR2:
+        len = struct.unpack( '>H', f.read(2) )[0]
+        buf = bytes2hexString( f, len )
+        print("XSIR2 0x%04X 0x%s" % (len, buf))
+
+    elif op == XCOMMENT:
+        cmt = []
+        while 1:
+            b = ReadByte(f)
+            if b == 0:          # terminating nul
+                break;
+            cmt.append( chr(b) )
+        print("XCOMMENT \"%s\"" % ''.join(cmt)  )
+
+    elif op == XWAIT:
+        run_state = ReadByte(f)
+        end_state = ReadByte(f)
+        useconds  = struct.unpack( '>i', f.read(4) )[0]
+        print("XWAIT %s %s" % (ShowState(run_state), ShowState(end_state)), useconds)
+
+    elif op == XWAITSTATE:
+        run_state = ReadByte(f)
+        end_state = ReadByte(f)
+        clocks    = struct.unpack( '>i', f.read(4) )[0]
+        useconds  = struct.unpack( '>i', f.read(4) )[0]
+        print("XWAITSTATE %s %s CLOCKS=%d USECS=%d" % (ShowState(run_state), ShowState(end_state), clocks, useconds) )
+
+    elif op == LCOUNT:
+        loop_count = struct.unpack( '>i', f.read(4) )[0]
+        print("LCOUNT", loop_count )
+
+    elif op == LDELAY:
+        run_state = ReadByte(f)
+        clocks    = struct.unpack( '>i', f.read(4) )[0]
+        useconds  = struct.unpack( '>i', f.read(4) )[0]
+        print("LDELAY %s CLOCKS=%d USECS=%d" % (ShowState(run_state), clocks, useconds) )
+
+    elif op == LSDR:
+        tdi = bytes2hexString( f, Xsdrsize )
+        tdo = bytes2hexString( f, Xsdrsize )
+        print("LSDR 0x%s 0x%s" % (tdi, tdo) )
+
+    elif op == XTRST:
+        # the argument is a single byte and it is the index into "trst_mode_allowed"
+        trst_mode = ReadByte(f)
+        if trst_mode <= 3:
+            print("TRST %s" % trst_mode_allowed[trst_mode] )
+        else:
+            print("TRST 0x%02X" % trst_mode );
+
+    else:
+        print("UNKNOWN op 0x%02X %d" % (op, op))
+        exit(1)
+
+
+def main():
+
+    if len( sys.argv ) < 2:
+        print("usage %s <xsvf_filename>" % sys.argv[0])
+        exit(1)
+
+    f = open( sys.argv[1], 'rb' )
+
+    opcode = ReadByte( f )
+    while opcode != -1:
+        # print the position within the file, then the command
+        print( "%d: " % f.tell(), end='' )
+        ShowOpcode( opcode, f )
+        opcode = ReadByte(f)
+
+
+if __name__ == "__main__":
+    main()
+