CVS: python README-msp430-bsl.txt,1.2,1.3 README-msp430-jtag.txt,1.3,1.4

Chris Liechti <[email protected]>
Newsgroups gmane.comp.hardware.texas-instruments.msp430.gcc.cvs
Message-ID <[email protected]>
Update of /cvsroot/mspgcc/python
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv7627/python

Modified Files:
	README-msp430-bsl.txt README-msp430-jtag.txt 
Log Message:
update readmes

Index: README-msp430-bsl.txt
===================================================================
RCS file: /cvsroot/mspgcc/python/README-msp430-bsl.txt,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -w -d -r1.2 -r1.3
--- README-msp430-bsl.txt	27 Sep 2005 08:00:42 -0000	1.2
+++ README-msp430-bsl.txt	27 Dec 2005 15:16:33 -0000	1.3
@@ -1,5 +1,5 @@
-pyBSL
-----
+msp430-bsl
+==========
 
 BootStrapLoader software for the flash devices MSP430F1xx 
 (maybe F4xx too, but its not tested).
@@ -10,6 +10,7 @@
 
 (C) 2001-2003 Chris Liechti <[email protected]>
 
+
 Features
 --------
 
@@ -30,6 +31,7 @@
 - baudrate change for newer MSP430-BSLs
 - test and reset lines can be inverted for non standard BSL hardware
 
+
 Requirements
 ------------
 - Linux, BSD, Un*x or Windows PC
@@ -37,6 +39,7 @@
 - win32all extensions to Python on Windows
 - BSL hardware with an MSP430 device connected to a serial port 
 
+
 Installation
 ------------
 Python installations are available from www.python.org. On Windows simply
@@ -45,6 +48,7 @@
 
 XXX
 
+
 Short introduction
 ------------------
 First the MSP430 BSL hardware is needed. An example schematics can be found
@@ -64,10 +68,12 @@
 General options:
   -h, --help            Show this help screen.
   -c, --comport=port    Specify the communication port to be used.
-                        (Default is 0)
+                        (Default is 0)::
+                        
                                 0->COM1 / ttyS0
                                 1->COM2 / ttyS1
                                 etc.
+                                
   -P, --password=file   Specify a file with the interrupt vectors that
                         are used as password. This can be any file that
                         has previously been used to program the device.
@@ -87,7 +93,7 @@
   -I, --intelhex        Force fileformat to IntelHex
   -T, --titext          Force fileformat to be TIText
   -N, --notimeout       Don't use timeout on serial port (use with care)
-  -B, --bsl=bsl.txt     Load and use new BSL from the TI Text file
+  -B, --bsl=filename    Load and use new BSL from the TI Text file
   -S, --speed=baud      Reconfigure speed, only possible with newer
                         MSP403-BSL versions (>1.5, read slaa089a.pdf for
                         details). If the --bsl option is not used, an
@@ -141,10 +147,10 @@
 
 Examples
 --------
-msp430-bsl -e
+``msp430-bsl -e``
         Only erase flash.
 
-msp430-bsl -eErw 6port.a43
+``msp430-bsl -eErw 6port.a43``
         Erase flash, erase check, download an executable, run it (reset)
         and wait.
         
@@ -152,16 +158,16 @@
         option in this case (-m20 will be OK is most cases):
         "msp430-bsl -eErwm20 6port.a43"
 
-msp430-bsl 6port.a43
+``msp430-bsl 6port.a43``
         Download of an executable to en empty (new or erased) device.
         (Note that in new devices some of the first bytes in the
         information memory are random data. If data should be
         downloaded there, specify -eE.)
 
-msp430-bsl --go=0x220 ramtest.a43
+``msp430-bsl --go=0x220 ramtest.a43``
         Download a program into RAM and run it (on an erased device)
 
-msp430-bsl --go=0x200 -P 6port.a43 ramtest.a43
+``msp430-bsl --go=0x200 -P 6port.a43 ramtest.a43``
         Download a program into RAM and run it (on a device that was
         previously programmed with 6port.a43 and therefore needs a
         specific password).
@@ -169,21 +175,24 @@
         For old devices that use the patch the above command gives a
         conflict with the patch. But as the patch is only needed to
         programm flash, it can be left out when running a program solely
-        from RAM:
+        from RAM::
+        
           msp430-bsl --go=0x200 -u -P 6port.a43 ramtest.a43
 
-msp430-bsl -u 0x0c00 -s 1024 -P 6port.a43
+``msp430-bsl -u 0x0c00 -s 1024 -P 6port.a43``
         Get a memory dump in HEX, from the bootstrap loader (on a device
         that was previously programmed with 6port.a43 and therefore needs
         a specific password):
 
-        or on unix with the use of "hexdump":
+        or on unix with the use of "hexdump"::
+        
           msp430-bsl -u 0x0c00 -s 1024 -P 6port.a43 -b | hexdump
 
-        or save the binary in a file:
+        or save the binary in a file::
+        
           msp430-bsl -u 0x0c00 -s 1024 -P 6port.a43 -b >dump.bin
 
-msp430-bsl --go=0x220 --upload=0x200 --size=256 ramtest.a43
+``msp430-bsl --go=0x220 --upload=0x200 --size=256 ramtest.a43``
         Download the file ramtest.a43 to an empty device, execute its
         main function at 0x0220. The BSL then tries to reconnect to the
         device. This does only work when the program on the MSP430
@@ -200,38 +209,40 @@
         program which possibly destroys a program that was downloaded
         to RAM.
 
-msp430-bsl -rw
+``msp430-bsl -rw``
         Just start the user program (with a reset) and wait.
 
-msp430-bsl -rwc1
+``msp430-bsl -rwc1``
         Reset the device on the second serial/COM port and wait.
 
-cat 6port.a43|msp430-bsl -eE -
+``cat 6port.a43|msp430-bsl -eE -``
         Pipe the data from "cat" to the BSL to erase and program the
         flash. (un*x example, don't forget the dash at the end of the
         line)
 
-msp430-bsl -e -S 38400 6port.a43
+``msp430-bsl -e -S 38400 6port.a43``
         First download the internal replacement BSL and then use it
         to program at 38400 baud. Only works with targets with more
         than 1kB of RAM.
 
-msp430-bsl -e -B BL_150S_14x.txt -S 38400 6port.a43
+``msp430-bsl -e -B BL_150S_14x.txt -S 38400 6port.a43``
         First download the given replacement BSL and then use it to
         program at 38400 baud. Only works with targets with more
         than 1kB of RAM.
 
+
 History
 -------
   V1.4
-        uses improved serial library
-        support for BSL download to MSP
+    uses improved serial library,
+    support for BSL download to MSP,
         support for higher baudrates (up to 38400)
 
   V1.5
-        ELF file support
+    ELF file support,
         replacement BSLs are now internal
 
+
 References
 ----------
 - Python: http://www.python.org
@@ -244,11 +255,11 @@
   and http://www.activestate.com/Products/ActivePython/win32all.html
 
 - slaa89.pdf: "Features of the MSP430 Bootstrap Loader in the
-  MSP430F1121", TI
+  MSP430F1121", TI, http://www.ti.com/msp430
 
 - slaa96b.pdf: "Application of Bootstrap Loader in MSP430 With Flash
   Hardware and Software Proposal", TI
 
 - Texas Instruments MSP430 Homepage, links to Datasheets and Application
-  Notes: http://www.ti.com/docs/products/micro/msp430/msp430.htm
+  Notes: http://www.ti.com/msp430
 

Index: README-msp430-jtag.txt
===================================================================
RCS file: /cvsroot/mspgcc/python/README-msp430-jtag.txt,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -w -d -r1.3 -r1.4
--- README-msp430-jtag.txt	27 Sep 2005 08:00:42 -0000	1.3
+++ README-msp430-jtag.txt	27 Dec 2005 15:16:33 -0000	1.4
@@ -1,5 +1,5 @@
-pyJTAG
-------
+msp430-jtag
+===========
 
 Software to talk to the parallel port JTAG PCB as seen with the FET kits.
 It is released under a free software license,
@@ -7,6 +7,7 @@
 
 (C) 2002-2004 Chris Liechti <[email protected]>
 
+
 Features
 --------
 
@@ -19,12 +20,14 @@
 - reset and wait for keypress (to run a device directly from the port
   power)
 
+
 Requirements
 ------------
 - Linux, BSD, Un*x or Windows PC
 - Python 2.0 or newer, 2.2+ recomeded
 - Parallel JTAG hardware with an MSP430 device connected
 
+
 Installation
 ------------
 Binaries for Windows can be found in the download section of
@@ -61,30 +64,49 @@
 
 
 
-USAGE: msp430-jtag [options] [file]
+USAGE: msp430-jtag.py [options] [file]
+
 If "-" is specified as file the data is read from stdin.
-A file ending with ".txt" is considered to be in TIText format all
+A file ending with ".txt" is considered to be in TI-Text format all
 other filenames are considered to be in IntelHex format.
 
 General options:
   -h, --help            Show this help screen.
   -l, --lpt=name        Specify an other parallel port.
-                        (defaults to LPT1 (/dev/parport0 on unix)
+                        (defaults to LPT1 (/dev/parport0 on unix))
   -D, --debug           Increase level of debug messages. This won't be
-                        very useful for the average user...
+                        very useful for the average user.
   -I, --intelhex        Force fileformat to IntelHex
-  -T, --titext          Force fileformat to be TIText
-  -f, --funclet         The given file is a funclet (a small program to
-                        be run in RAM)
-  -R, --ramsize         Specify the amont of RAM to be used to program
+  -T, --titext          Force fileformat to be TI-Text
+  -R, --ramsize         Specify the amount of RAM to be used to program
                         flash (default 256).
 
-Program Flow Specifiers:
+Funclets:
+  -f, --funclet         The given file is a funclet (a small program to
+                        be run in RAM).
+  --parameter=<key>=<value> Pass parameters to funclets.
+                        Registers can be written like "R15=123" or "R4=0x55"
+                        A string can be written to memory with "0x2e0=hello"
+                        --parameter can be given more than once
+  --result=value        Read results from funclets. "Rall" read all registers
+                        (case insensitive) "R15" reads R15 etc. Address ranges
+                        can be read with "0x2e0-0x2ff". see also --upload.
+                        --result can be given more than once
+  --timeout=value       Abort the funclet after the given time in seconds
+                        if it does not exit no itslef. (default 1)
+
+Note: writing and/or reading RAM before and/or after running a funclet may not
+work as expected on devices with the JTAG bug like the F123.
+
+Program flow specifiers:
 
   -e, --masserase       Mass Erase (clear all flash memory)
+                        Note: SegmentA on F2xx is NOT erased, that must be
+                        done separately with --erase=0x1000
   -m, --mainerase       Erase main flash memory only
   --eraseinfo           Erase info flash memory only (0x1000-0x10ff)
   --erase=address       Selectively erase segment at the specified address
+  --erase=adr1-adr2     Selectively erase a range of segments
   -E, --erasecheck      Erase Check by file
   -p, --program         Program file
   -v, --verify          Verify by file
@@ -92,11 +114,11 @@
 The order of the above options matters! The table is ordered by normal
 execution order. For the options "Epv" a file must be specified.
 Program flow specifiers default to "p" if a file is given.
-Don't forget to specify "e" or "eE" when programming flash!
+Don't forget to specify "e", "eE" or "m" when programming flash!
 "p" already verifies the programmed data, "v" adds an additional
-verification though uploading the written data for a 1:1 compare.
+verification through uploading the written data for a 1:1 compare.
 No default action is taken if "p" and/or "v" is given, say specifying
-only "v" does a check by file of a programmed device.
+only "v" does a "check by file" of a programmed device.
 
 Data retreiving:
   -u, --upload=addr     Upload a datablock (see also: -s).
@@ -117,14 +139,18 @@
                         interrupt vector. (see also -g)
   -w, --wait            Wait for <ENTER> before closing parallel port.
 
+Address parameters for --erase, --upload, --size can be given in
+decimal, hexadecimal or octal.
+
+
 
 NOTE:   Some versions of the Texas Instruments MSP430 Development Tool
-        require that you give the '--no-close' option to pyJTAG.  This
+        require that you give the '--no-close' option to msp430-jtag. This
         is because the Texas Instruments tool is powered via the JTAG
-        adapter; the '--no-close' option prevents pyJTAG from powering the
-        adapter off.  You may also need to restart the program with 
-        pyJTAG (using the '--no-close' and '-r' options is sufficient) after
-        rebooting your machine.
+        adapter; the '--no-close' option prevents msp430-jtag from powering
+        the adapter off.  You may also need to restart the program with 
+        msp430-jtag (using the '--no-close' and '-r' options is sufficient)
+        after rebooting your machine.
 
         Other development kits that rely on the parallel port for their power
         source may also need the '--no-close' option.  It is preferable to
@@ -134,14 +160,14 @@
 
 Examples
 --------
-msp430-jtag -e
+``msp430-jtag -e``
         Only erase flash.
 
-msp430-jtag -eErw 6port.a43
+``msp430-jtag -eErw 6port.a43``
         Erase flash, erase check, download an executable, run it (reset)
         and wait.
 
-msp430-jtag -mS -R 2048 6port.a43
+``msp430-jtag -mS -R 2048 6port.a43``
         Use ramsize option on a device with 2k RAM to speed up
         download. Of course any value from 128B up to the maximum
         a device has is allowed.
@@ -149,50 +175,68 @@
         Only erasing the main memory is useful to keep calibration
         data in the information memory.
 
-msp430-jtag 6port.a43
+``msp430-jtag 6port.a43``
         Download of an executable to en empty (new or erased) device.
         (Note that in new devices some of the first bytes in the
         information memory are random data. If data should be
         downloaded there, specify -eE.)
 
-msp430-jtag --go=0x220 ramtest.a43
+``msp430-jtag --go=0x220 ramtest.a43``
         Download a program into RAM and run it, may not work
         with all devices.
 
-msp430-jtag -f blinking.a43
+``msp430-jtag -f blinking.a43``
         Download a program into RAM and run it. It must be
         a special format with "startadr", "entrypoint",
         "exitpoint" as the first three words in the data
         and it must end on "jmp $". See MSP430debug sources
         for more info.
 
-msp430-jtag -u 0x0c00 -s 1024
+``msp430-jtag -u 0x0c00 -s 1024``
         Get a memory dump in HEX, from the bootstrap loader.
-        or save the binary in a file:
+        or save the binary in a file::
+        
           msp430-jtag -u 0x0c00 -s 1024 -b >dump.bin
-        or as an intel-hex file:
+          
+        or as an intel-hex file::
+        
           msp430-jtag -u 0x0c00 -s 1024 -i >dump.a43
 
-msp430-jtag -r
+``msp430-jtag``
         Just start the user program (with a reset).
 
-cat 6port.a43|msp430-jtag -e -
-        Pipe the data from "cat" to jtag.py to erase and program the
+``cat 6port.a43|msp430-jtag -e -``
+        Pipe the data from "cat" to msp430-jtag to erase and program the
         flash. (un*x example, don't forget the dash at the end of the
         line)
 
+
 History
 -------
-1.0     public release
-1.1     fix of verify error
-1.2     use the verification during programming
-1.3     mainerase, progress options, ihex output
+V1.0
+    public release
+
+V1.1
+    fix of verify error
+
+V1.2
+    use the verification during programming
+
+V1.3
+    mainerase, progress options, ihex output
+
+V2.0
+    updateed imlementation, new ctypes backend
+
+V2.1
+    F2xx support, improved options for funclets
+
 
 References
 ----------
 - Python: http://www.python.org
 
-- ctypes: starship.python.net/crew/theller/ctypes
+- ctypes: http://starship.python.net/crew/theller/ctypes
 
 - Texas Instruments MSP430 Homepage, links to Datasheets and Application
   Notes: http://www.ti.com/msp430



-------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc. Do you grep through log files
for problems?  Stop!  Download the new AJAX search engine that makes
searching your log files as easy as surfing the  web.  DOWNLOAD SPLUNK!
http://ads.osdn.com/?ad_id=7637&alloc_id=16865&op=click
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.