CVS: jtag README.txt,1.4,1.5

Update of /cvsroot/mspgcc/jtag
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv9028/jtag

Modified Files:
	README.txt 
Log Message:
doc updates

Index: README.txt
===================================================================
RCS file: /cvsroot/mspgcc/jtag/README.txt,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -w -d -r1.4 -r1.5
--- README.txt	27 Sep 2005 08:00:42 -0000	1.4
+++ README.txt	27 Dec 2005 15:26:29 -0000	1.5
@@ -1,31 +1,38 @@
 Parallel Port JTAG Interface
-----------------------------
+============================
+
 Sources for the MSP430mspgcc library, the Python extension using it
 and the hardware access library HIL.
 
 Description of the directories:
-- funclets
+
+funclets
     Helper programs that are downloaded to the target.
     Require the mspgcc toolchain to compile (msp430-gcc etc.)
 
-- hardware_access
+hardware_access
     The hardware layer is encapsulated in the HIL library.
     Sources for Linux and Win32 and tools for Win32.
 
-- msp430
+msp430
     The MSP430mspgcc library communicates trough the JTAG with an
     attached MSP430 processor. It has support to read and write memory,
     erase and write Flash.
 
-- python
-    Python extension for use with pyjtag.
+python
+    Python '_parjtag' extension for use with msp430-jtag. This library is no
+    longer required as the 'ctypes' backend works well on platforms where this
+    Python extension is available. 'ctypes' is the recomended JTAG backend.
+
 
 All makefiles contain targets for Win32 and Linux. If "WINDIR" is found
 in the environment variables a Win32 build is assumed, linux otherwise. For
 Linux, two options are supported: 
-- Parallel port device (ppdev). This requires a Linux 2.4 kernel.
+
+- Parallel port device (ppdev). This requires a Linux 2.4 or newer kernel.
 - Direct input/output (directio). This should work under any Linux kernel
-  (tested under 2.2.14-5.0), but requires jtag.py to be run as "root".
+  (tested under 2.2.14-5.0), but requires msp430-jtag to be run as "root".
+
 If "DIRECTIO" is found in the environment variables, the direct I/O interface
 will be used. Otherwise, ppdev is assumed.
 
@@ -35,20 +42,23 @@
 Requirements
 ------------
 The giveio driver is required on Windows NT/2k/XP.
-You must execute hardware_access/giveio/install_giveio.bat to install the
+You must execute ``hardware_access/giveio/install_giveio.bat`` to install the
 driver.
 
 
 Build
 -----
 
-For the default (Linux ppdev) build:
+For the default (Linux ppdev) build::
+
   Type "make" in the jtag directory and hope ;-)
 
-To build for direct I/O under Linux:
+To build for direct I/O under Linux::
+
   env DIRECTIO=1 make
 
-To build for Windows:
+To build for Windows::
+
   env WINDIR=1 make
 
 Then copy the resulting _parjtag (so or pyd) library in the pyjtag (separate
@@ -56,25 +66,20 @@
 On Windows you'll need hardware_access/HILwin32_giveio/HIL.dll and
 msp430/MSP430mspgcc.dll too.
 
-Test, I usualy use: "python jtag.py -f ../jtag/funclets/blinking.a43" in
-the pyjtag directory for a first connection test (LEDs on P1 and P2 are
+Test, I usualy use: ``python msp430-jtag.py -f ../jtag/funclets/blinking.a43``
+in the python directory for a first connection test (LEDs on P1 and P2 are
 toggled).
 
 
-WARNING
--------
-The clock of the target MSP430 is not verified when programming Flash.
-The default frequency of an unconfigured device is used. In certain
-conditions of voltage and temperature the flash specifications may be
-violated. In such a case the flash programming may be unreliable or fail
-completly.
-
+Disclaimer
+----------
 As allways with open source - use at your own risk :-)
+See also LICENSE.txt.
 
 
 References
 ----------
- - TI MSP430 home: www.ti.com/msp430
+- TI MSP430 home: http://www.ti.com/msp430
  
  - TI application notes:
       slaa149: "Programming a Flash-Based MSP430 Using the JTAG Interface"



-------------------------------------------------------
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