CVS: python README-msp430-dco.txt, 1.1, 1.2 README-msp430-jtag.txt, 1.10, 1.11 readme.txt, 1.4, 1.5

Chris Liechti <[email protected]> Fri, 08 Dec 2006 14:05:58 -0800
Newsgroups gmane.comp.hardware.texas-instruments.msp430.gcc.cvs
Message-ID <[email protected]>
Update of /cvsroot/mspgcc/python
In directory sc8-pr-cvs7.sourceforge.net:/tmp/cvs-serv22132/python

Modified Files:
	README-msp430-dco.txt README-msp430-jtag.txt readme.txt 
Log Message:
doc updates, docutils syntax

Index: README-msp430-dco.txt
===================================================================
RCS file: /cvsroot/mspgcc/python/README-msp430-dco.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -w -d -r1.1 -r1.2
--- README-msp430-dco.txt	20 Apr 2006 23:06:47 -0000	1.1
+++ README-msp430-dco.txt	8 Dec 2006 22:05:56 -0000	1.2
@@ -59,13 +59,16 @@
 The target device has to be connected to the JTAG interface.
 
 Examples:
-    See min and max clock speeds:
+    See min and max clock speeds::
+    
         msp430-dco --measure
 
-    Get clock settings for 2.0MHz +/-1%:
+    Get clock settings for 2.0MHz +/-1%::
+    
         msp430-dco --tolerance=0.01 2.0e6
 
-    Write clock calibration for 1.5MHz to the information memory at 0x1000:
+    Write clock calibration for 1.5MHz to the information memory at 0x1000::
+    
         msp430-dco 1.5e6 BCSCTL1@0x1000 DCOCTL@0x1000
 
 Use it at your own risk. No guarantee that the values are correct.
@@ -86,6 +89,7 @@
   --erase=ERASE         erase flash page at given address. Use with care!
 
 Notes:
+
 - the --output option can be used to redirect the output. Once could also use
   the usual stdout redirection from the shell (``>filename``)
 - --tolerance specifies a window in which the clock has to be to complete the
@@ -170,7 +174,7 @@
         msp430-jtag -e my_firmware.elf
         msp430-dco 1e6 BCSCTL1@0x1000 DCOCTL@0x1001
 
-    The firmware can then read the values form the flash and configure the
+    The firmware can then read the values from the flash and configure the
     Basic Clock System using these values.
 
 ``msp430-dco --measure``

Index: README-msp430-jtag.txt
===================================================================
RCS file: /cvsroot/mspgcc/python/README-msp430-jtag.txt,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -w -d -r1.10 -r1.11
--- README-msp430-jtag.txt	29 Nov 2006 01:19:18 -0000	1.10
+++ README-msp430-jtag.txt	8 Dec 2006 22:05:56 -0000	1.11
@@ -78,7 +78,8 @@
 other filenames are considered to be in Intel HEX format.
 
 General options:
-  -h, --help            Show this help screen.
+  -h, --help            Show this help text.
+  --help-backend        Show help about the different backends.
   -D, --debug           Increase level of debug messages. This won't be
                         very useful for the average user.
   -I, --intelhex        Force input file format to Intel HEX.
@@ -88,20 +89,32 @@
                         autodetect).
 
 Connection:
-  -l, --lpt=name        Specify an other (parallel) port.
+  -l, --lpt=name        Specify an other parallel port or serial port for the
+                        USBFET (the later requires MSP430.dll instead of
+                        MSP430mspgcc.dll).
                         (defaults to "LPT1" ("/dev/parport0" on Linux))
+  --slowdown=microsecs  Artificially slow down the communication. Can help
+                        with long lines, try values between 1 and 50 (parallel
+                        port interface with mspgcc's HIL library only).
+                        (experts only)
+  --backend=backend     Select an alternate backend. See --help-backend for
+                        more information.
 
-Note: On Windows, use "TIUSB" or "COM5" etc if using MSP430.dll from TI.
+.. note:: On Windows, use "TIUSB" or "COM5" etc if using MSP430.dll from TI.
       If a MSP430.dll is found it is prefered, otherwise MSP430mspgcc.dll
       is used.
+.. note:: --slowdown > 50 can result in failures for the ramsize autodetection
+          (use --ramsize option to fix this). Use the --debug option and watch
+          the outputs. The DCO clock adjustment and thus the Flash timing may
+          be inaccurate for large values.
 
 Funclets:
   -f, --funclet         The given file is a funclet (a small program to
                         be run in RAM).
-  --parameter=<key>=<value>   Pass parameters to funclets.
+  --parameter=option    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
+                        --parameter can be given more than once.
   --result=value        Read results from funclets. "Rall" reads all registers
                         (case insensitive) "R15" reads R15 etc. Address ranges
                         can be read with "0x2e0-0x2ff". See also --upload.
@@ -109,9 +122,9 @@
   --timeout=value       Abort the funclet after the given time in seconds
                         if it does not exit no itself. (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.
-Note: Only possible with MSP430mspgcc.dll, not other backends.
+.. 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.
+.. note:: Only possible with MSP430mspgcc.dll, not other backends.
 
 Program flow specifiers:
   -e, --masserase       Mass Erase (clear all flash memory).
@@ -125,8 +138,10 @@
   -p, --program         Program file.
   -v, --verify          Verify by file.
   --secure              Blow JTAG security fuse.
-                        Note: This is not reversible, use with care!
-                        Note: Not supported with the simple parallel port
+  
+                        .. warning:: This is not reversible, use with care!
+                                
+                        .. note:: Not supported with the simple parallel port
                               adapter (7V source required).
 
 The order of the above options matters! The table is ordered by normal
@@ -169,8 +184,8 @@
     Dump Information memory: "msp430-jtag --upload=0x1000-0x10ff"
 
 
-
-NOTE:   Some versions of the Texas Instruments MSP430 Development Tool
+.. note::
+    Some versions of the Texas Instruments MSP430 Development Tool
         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 msp430-jtag from powering
@@ -187,6 +202,42 @@
         eval board from the JTAG interface.
 
 
+Backends
+--------
+msp430-jtag can use different libraries to connect to the target.
+The backend can be chosen with the --backend command line option.
+
+"mspgcc"
+    Using MSP430mspgcc.dll, the open source implementation from the mspgcc
+    project.
+
+"ti" (default)
+    Using MSP430.dll, the proprietary library from TI or a compatible one
+    from a 3rd pary supplier.
+
+"parjtag"
+    Old way of using MSP430mspgcc.dll. Use "mspgcc" instead.
+
+Compatibility of backends:
+
+    +-------------------------------------------+--------+--------+
+    | Feature                                   | mspgcc | ti     |
+    +===========================================+========+========+
+    | 4 Wire JTAG                               | yes    | yes    |
+    +-------------------------------------------+--------+--------+
+    | 4 Wire JTAG on devices with spy-bi-wire   | yes(1) | no     |
+    +-------------------------------------------+--------+--------+
+    | using --spy-bi-wire option                | no     | yes    |
+    +-------------------------------------------+--------+--------+
+    | support for USB JTAG adapters             | no     | yes    |
+    +-------------------------------------------+--------+--------+
+    | unsing --funclet option                   | yes    | no     |
+    +-------------------------------------------+--------+--------+
+
+Notes:
+    (1) Timing critical, may not work on all machines or at every try.
+
+
 Examples
 --------
 ``msp430-jtag -e``
@@ -239,14 +290,14 @@
 libMSP430.so etc.
 
 USB JTAG adapters are supported through the MSP430.dlls from the adaptor
-vendor. To enable its use, copy MSP430.dll to the
-``bin\lib`` folder, where ``shared.zip`` is located.
-Optionally copy ``HIL.dll`` to the ``bin`` folder.
+vendor. To enable its use, copy MSP430.dll to the ``bin\lib`` folder, where
+``shared.zip`` is located. Optionally copy ``HIL.dll`` to the ``bin`` folder.
 
 For example for MSP-FET430UIF from TI:
+
 - download a the MSP430.dll binary from the downloads section in
   http://mspgcc.sf.net
-- copy MSP430.dll to ``c:\mspgcc\bin\lib`` (substitute the source and
+- copy MSP430.dll to ``c:\mspgcc\bin`` (substitute the source and
   destination folders according to you own setup)
 
 The windows installer already includes this library.
@@ -261,7 +312,7 @@
 
     msp430-jtag -l COM5 --upload=0x0ff0
 
-Linux users have to specify the serial port differently:
+Linux users have to specify the serial port differently::
 
     msp430-jtag -l /dev/ttyUSB0 --upload=0x0ff0
 
@@ -291,8 +342,8 @@
     USB adapters can be used. Allow multiple --upload with address ranges.
 
 V2.3
-    Added Support for F2xx and MSP430X architectures. Improved 3rd party
-    Library support for Linux and Windows.
+    Added support for F2xx and MSP430X architectures. Improved 3rd party
+    library support for Linux and Windows.
 
 
 References

Index: readme.txt
===================================================================
RCS file: /cvsroot/mspgcc/python/readme.txt,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -w -d -r1.4 -r1.5
--- readme.txt	29 Dec 2005 04:04:48 -0000	1.4
+++ readme.txt	8 Dec 2006 22:05:56 -0000	1.5
@@ -1,34 +1,32 @@
 This module provides MSP430 related tools that are written in Python.
 
-Python 2.2 or newer should be used. The python package "msp430" can be
-installed with "python setup.py install". These modules can be used
-in user programs too.
-The msp430-bsl and msp430-jtag tools are installed to the binary
-directory /usr/local/msp430/bin and not in the Python library like
-the module above.
+Python 2.2 or newer should be used. The python package "mspgcc" can be
+installed with "python setup.py install". These modules can be used in user
+programs too.
+The msp430-bsl and msp430-jtag tools are installed to the binary directory
+/usr/local/msp430/bin and not in the Python library like the module above.
 
 Descriptions:
 
-msp430
+mspgcc
     Python modules related to the MSP430.
     
     bsl.py
         Support for the boot strap loader.
         
     jtag.py
-        Access to the mspgcc jtag tools using the MSP430mspgcc
-        library.
+        Access to the mspgcc jtag tools using the MSP430mspgcc library.
     
     elf.py
         Reead elf object files and extract data segments.
     
     memory.py
-        Memory implementation, used to store an memory image
-        used to download to the MSP.
+        Memory implementation, used to store an memory image used to download
+        to the MSP.
     
     util.py
-        Different unitlity functions such as writing ihex
-        files or making hex dumps.
+        Different utility functions such as writing ihex files or making
+        hex dumps.
     
     HIL.py
         Access to the HIL.dll/libHIL.so
@@ -40,38 +38,37 @@
         Copy of pyserial (http://pyserial.sf.net), used for bsl.py
 
 demo
-    Demonstration tools. Currently there are BSL and JTAG wrappers
-    for Win32 using the NSIS installer system. The resulting
-    executables contain everything that's needed to reprogram a
-    device. Useful for field updaters, etc.
+    Demonstration tools. Currently there are BSL and JTAG wrappers for Win32
+    using the NSIS installer system. The resulting executables contain
+    everything that's needed to reprogram a device. Useful for field updaters,
+    etc.
     
-    mmc.py: a Python demo that reads an MMC card connected
-    to the JTAG port. See source file for wiring.
+    mmc.py: a Python demo that reads an MMC card connected to the JTAG port.
+    See source file for wiring.
 
 win32
-    Windows related stuff, files to create executables and
-    installers.
+    Windows related stuff, files to create executables and installers.
 
 msp430-bsl.py
-    Command line application for the MSP430 Boot Strap Loader
-    Erasing, programming, uploading of flash and RAM. 
+    Command line application for the MSP430 Boot Strap Loader. Erasing,
+    programming, uploading of flash and RAM. 
 
 msp430-dco.py
-    Command line appliaction for the MSP430 parallel JTAG adapter.
-    Measure or callibrate the DCO clock.
+    Command line application for the MSP430 parallel JTAG adapter. Measure
+    or callibrate the DCO clock.
 
 msp430-downloader.py
-    Small program, suitable for file associations, so that double
-    clicking an elf or a43 file can be used to download via JTAG.
+    Small program, suitable for file associations, so that double clicking an
+    elf or a43 file can be used to download via JTAG.
 
 msp430-jtag.py
-    Command line appliaction for the MSP430 parallel JTAG adapter.
-    Erasing, programming, uploading of flash and RAM. Additionaly
-    it can run funclets.
+    Command line application for the MSP430 parallel JTAG adapter. Erasing,
+    programming, uploading of flash and RAM. Additionaly it can run funclets.
 
 makefile
     Install the two command line tools and the Python library.
 
 
 chris
+
 $Id$
\ No newline at end of file


-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys - and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV