From 84496c84f05a75458a10eadf6be1adca8a7d61d5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Arnim=20L=C3=A4uger?=
Date: Fri, 13 Mar 2009 21:12:53 +0000
Subject: [PATCH] update web docs to current UrJTAG.txt
git-svn-id: https://urjtag.svn.sourceforge.net/svnroot/urjtag/trunk@1458 b68d4a1b-bc3d-0410-92ed-d4ac073336b7
---
web/Makefile | 2 +-
web/htdocs/book/UrJTAG.dbk | 159 ++++++++---
web/htdocs/book/UrJTAG.html | 270 +++++++++++++++---
.../book/_compilation_and_installation.html | 69 ++++-
web/htdocs/book/_copyright.html | 2 +-
web/htdocs/book/_data_file_format.html | 2 +-
web/htdocs/book/_development.html | 2 +-
web/htdocs/book/_drivers.html | 2 +-
web/htdocs/book/_f_a_q.html | 51 +++-
web/htdocs/book/_general.html | 20 +-
.../_gnu_free_documentation_license_fdl.html | 2 +-
.../book/_gnu_general_public_license_gpl.html | 2 +-
web/htdocs/book/_internals.html | 4 +-
web/htdocs/book/_jtag_commands.html | 90 +++++-
web/htdocs/book/_licensing.html | 2 +-
web/htdocs/book/_system_requirements.html | 40 ++-
web/htdocs/book/_urjtag.html | 8 +-
web/htdocs/book/_usage.html | 2 +-
web/htdocs/book/index.html | 2 +-
19 files changed, 609 insertions(+), 122 deletions(-)
diff --git a/web/Makefile b/web/Makefile
index e543c123..40e4c47c 100644
--- a/web/Makefile
+++ b/web/Makefile
@@ -1,4 +1,4 @@
-WEB=kawk,urjtag@web.sourceforge.net:/home/groups/u/ur/urjtag
+WEB=arniml,urjtag@web.sourceforge.net:/home/groups/u/ur/urjtag
JTAG=../jtag
BOOK=./htdocs/book
diff --git a/web/htdocs/book/UrJTAG.dbk b/web/htdocs/book/UrJTAG.dbk
index 21be2c09..95c35943 100644
--- a/web/htdocs/book/UrJTAG.dbk
+++ b/web/htdocs/book/UrJTAG.dbk
@@ -4,7 +4,7 @@
Universal JTAG library, server and tools
- 2008-07-15
+ 2009-02-27
Kolja
Waschk
@@ -12,7 +12,7 @@
KW(
-13032008-07-15KW(
+14452009-02-27KW(
@@ -118,14 +118,14 @@ program devices.
The player has been developed according to the "Serial Vector Format
Specification", Revision E, 8 March 1999 issued by ASSET InterTech, Inc. The
full specification can be found at
-http://www.asset-intertech.com/support/svf.pdf
+http://www.asset-intertech.com/support/svf.pdf
UrJTAG features an "SVF player" that can read SVF files and perform the
described actions on the bus.
-SVF parser and lexer are also copyright 2002, CDS at http://www-csd.ijs.si/.
+SVF parser and lexer are also copyright 2002, CDS at http://www-csd.ijs.si/.
They have been reused from the "Experimental Boundary Scan" project at
-http://ebsp.sourceforge.net/.
+http://ebsp.sourceforge.net/.
@@ -167,7 +167,7 @@ at the UrJTAG website.
UrJTAG Website
The most current version of this documentation and UrJTAG sourcecode
-is always available from the project homepage at http://www.urjtag.org
+is always available from the project homepage at http://www.urjtag.org
@@ -215,7 +215,7 @@ with Cygwin installed.
-current Cygwin net installation from http://cygwin.com
+current Cygwin net installation from http://cygwin.com
@@ -308,6 +308,11 @@ Amontec JTAGkey-Tiny (supported as cable "JTAGkey")
+TinCanTools Flyswatter
+
+
+
+
Olimex ARM-USB-JTAG
@@ -318,7 +323,7 @@ Olimex ARM-USB-TINY
-OOCDLink-s (experimental) http://www.joernonline.de/dw/doku.php?id=projects:oocdlink:2_oocdlinks
+OOCDLink-s (experimental) http://www.joernonline.de/dw/doku.php?id=projects:oocdlink:2_oocdlinks
@@ -328,12 +333,12 @@ Other FT2232-based USB JTAG cables (experimental)
-Turtelizer 2 (experimental) http://www.ethernut.de/en/hardware/turtelizer/
+Turtelizer 2 (experimental) http://www.ethernut.de/en/hardware/turtelizer/
-USB to JTAG Interface (experimental) http://www.hs-augsburg.de/~hhoegl/proj/usbjtag/usbjtag.html
+USB to JTAG Interface (experimental) http://www.hs-augsburg.de/~hhoegl/proj/usbjtag/usbjtag.html
@@ -347,7 +352,7 @@ Xverve Signalyzer Tool (experimental)
-Altera USB-Blaster and compatible http://www.ixo.de/info/usb_jtag
+Altera USB-Blaster and compatible http://www.ixo.de/info/usb_jtag
@@ -361,6 +366,9 @@ Xilinx Platform USB Cable / DLC9 (slow, experimental, work in progress - don't u
+Other cables:
+ * Technologic Systems TS-7800 SoC GPIO builtin JTAG interface
+
JTAG-aware parts (chips)
@@ -557,10 +565,10 @@ AMD Am29xx040B (Am29F040B, Am29LV040B)
The distributed source tarball contains source pregenerated with a current
flex version; flex therefore is only needed if you want to compile code
checked out from our Subversion repository. Flex 2.5.4a as it comes with
-Cygwin cannot build the scanners for BSDL and SVF. Building these files
-requires Flex 2.5.33 or newer. The configure script will compare the available
-Flex version against these preconditions and enables or disables the related
-features.
+most but the very latest Cygwin release cannot build the scanners for BSDL and
+SVF. Building these files requires Flex 2.5.33 or newer. The configure script
+will compare the available Flex version against these preconditions and enables
+or disables the related features.
Furthermore, libtool should be available, and "devel" versions of the following
packages:
@@ -600,7 +608,7 @@ you don't run Linux, you can get it from
-http://www.intra2net.com/de/produkte/opensource/ftdi/
+http://www.intra2net.com/en/developer/libftdi/
@@ -614,12 +622,12 @@ There is a libusb-win32 variant that can be used in a Cygwin environment:
-http://libusb.sourceforge.net (libusb)
+http://libusb.sourceforge.net (libusb)
-http://libusb-win32.sourceforge.net (libusb for Windows)
+http://libusb-win32.sourceforge.net (libusb for Windows)
@@ -655,7 +663,7 @@ make install
-http://www.ftdichip.com/Drivers/D2XX.htm (FTDI FTD2XX library)
+http://www.ftdichip.com/Drivers/D2XX.htm (FTDI FTD2XX library)
@@ -677,7 +685,7 @@ without spaces in the name is better) and afterwards run configure with the
-http://libusb-win32.sourceforge.net
+http://libusb-win32.sourceforge.net
@@ -689,16 +697,29 @@ might give problems if the path contains spaces, as "Program Files" does!):
Compiling with MinGW
UrJTAG may be compiled into a Windows executable using the MinGW compiler
-(http://www.mingw.org). This has the advantage over running in a Cygwin
-environment that you don't need to install anything else but the jtag.exe.
-However, because support for MinGW is quite new in UrJTAG, it may lack some
+(http://www.mingw.org), or Cygwin GCC with the "-mno-cygwin" compiler flag.
+
+This has the advantage over running in a Cygwin environment that you don't need
+to install anything else but the jtag.exe (plus libraries like FTD2XX.dll or
+InpOut32.DLL that are required for device access under Windows in any case).
+
+However, because support for MinGW is quite new in UrJTAG, it may lack some
features (e.g. readline support) or run a little slower.
+Because it seems to be easier to set up a Cygwin environment, we recommend
+using the Cygwin GCC with "-mno-cygwin" flag instead of using a MinGW setup:
+
+CFLAGS="-mno-cygwin -O2" ./configure --with-ftd2xx=/tmp/cdm-drivers --with-inpout32
It is even possible to cross-compile and build the executable on a Linux
host:
-./configure --host=i586-mingw32msvc --with-ftd2xx=/tmp/cdm-drivers
+./configure --host=i586-mingw32msvc --with-ftd2xx=/tmp/cdm-drivers --with-inpout32
make
+The "—with-inpout32" switch tells UrJTAG to use the InpOut32.DLL for access to
+parallel ports, because the Cygwin ioperm isn't available for MinGW. The InpOut32
+library is available from logix4u.net:
+
+http://logix4u.net/Legacy_Ports/Parallel_Port/Inpout32.dll_for_Windows_98/2000/NT/XP.html
Driver tailoring
@@ -1242,6 +1263,14 @@ FTD2XX is selected. That's simply because FTD2XX showed some performance
advantages over libftdi in the past. You can still force libftdi with the
respective parameter.
+There's one quirk to consider when using FTDI's FTD2XX driver. It
+connects to any known FTDI chip, randomly. I.e. if there's more than one FTDI
+device connected to the host, chances are that the driver connects to the
+wrong USB device. This might be an OEM USB-serial converter and you'll be
+banging your head why there's no proper reading from the JTAG chain. Therefore
+it's strongly recommended to specify the desc=xxx parameter for the cable
+command if the ftd2xx driver is to be used. Set xxx to the product or serial
+number descriptor string that are exhibited by the USB device.
detect
@@ -1268,7 +1297,9 @@ also the documentation for the "include" command.
print
-Print a list of parts in the chain and the currently active instruction per part.
+Print a list of parts in the chain and the currently active instruction per part.
+Further details of bus, signals and instructions can be obtained with dedicated
+command options, see "help print".
@@ -1441,6 +1472,16 @@ get external signal value
+pod
+
+
+
+low level direct access to POD signals like TRST; use with care
+
+
+
+
+
scan
@@ -1605,7 +1646,7 @@ In case the TDO parameter of an SDR command leads to a mismatch the player
issues a warning and continues. If the player should abort in this case then
specify stop at the svf command.
-The absence of error or warning messages indicate that the SVF file could be
+The absence of error or warning messages indicate that the SVF file was
executed without problems. To get a progress reporting while the player advances
through the SVF file, specify progress at the svf command.
@@ -1704,11 +1745,15 @@ TIR, TDR commands not supported.
-Operation can be slowed down significantly when the FREQUENCY command has
-been specified. This is not a problem of the SVF player itself but seem to
-happen when the frequency of UrJTAG is set to a value larger than 0.
-Configuration takes very long although the maximum allowed frequency is 10 MHz.
-Consider to comment out the FREQUENCY command at the beginning of the SVF file.
+SVF files for programming flash-based devices might or might not work for a given
+setup. This has been observed for Actel IGLOO devices where success and failure
+depends on the actual clocking rate of the chosen cable.
+
+The ref_freq=<…> option to the svf command allows to tweak the calculation
+of RUNTEST xxx SEC commands. For these commands, the SVF player needs to
+calculate the equivalent number of clocks and per default it will use the
+current cable clock frequency. This can be overridden with the ref_freq option
+that specifies a fixed reference frequency for such calculations.
@@ -2676,7 +2721,7 @@ Q. The documentation is incomplete. Where can I get more information?
- A. Please ask in the "Using UrJTAG" Forum on http://urjtag.org
+ A. Please ask in the "Using UrJTAG" Forum on http://urjtag.org
@@ -2784,6 +2829,56 @@ Q. When running "make install", I get "Permission denied" errors
+
+
+Q. My BSDL file defines the bus DAT as bit_vector(15 downto 0), how should I access single elements?
+
+
+
+ A. BSDL syntax is an extension of the VHDL language. Array elements are indexed with
+ parentheses: DAT(4) selects index number 4 of the DAT vector. Also refer to the "print
+ signals" command.
+
+
+
+
+
+Q. My board requires certain signals to be set to dedicated values before external memories can be accessed.
+
+
+
+ A. Most (if not all) BSR-based bus drivers allow for static configurations of
+ pins that are controlled by BSR bits. Apply the required "set" commands before
+ issueing the "initbus …" command. These settings are preserved by all bus
+ related commands if they don't collide with the signals required for bus operation.
+
+
+
+
+
+Q. My USB pod seems slow.
+
+
+
+ A. USB-based JTAG pods suffer from a couple of intrinsic issues. Consider the
+ following to get maximum performance:
+
+
+
+
+Run UrJTAG on native linux. Cygwin and VMWare are reportedly slower.
+
+
+
+
+Connect the pod via a high speed USB hub to a high speed USB host port.
+ Even though the pod is a full speed device, it benefits from the shorter
+ turn-around times between host and hub.
+
+
+
+
+
diff --git a/web/htdocs/book/UrJTAG.html b/web/htdocs/book/UrJTAG.html
index 6c7328e3..bdf22e37 100644
--- a/web/htdocs/book/UrJTAG.html
+++ b/web/htdocs/book/UrJTAG.html
@@ -1,4 +1,4 @@
-
+
The player has been developed according to the "Serial Vector Format
Specification", Revision E, 8 March 1999 issued by ASSET InterTech, Inc. The
full specification can be found at
-http://www.asset-intertech.com/support/svf.pdf
http://www.asset-intertech.com/support/svf.pdfUrJTAG features an "SVF player" that can read SVF files and perform the
described actions on the bus.
SVF parser and lexer are also copyright 2002, CDS at http://www-csd.ijs.si/.
+>SVF parser and lexer are also copyright 2002, CDS at http://www-csd.ijs.si/.
They have been reused from the "Experimental Boundary Scan" project at
-http://ebsp.sourceforge.net/.
http://ebsp.sourceforge.net/.The most current version of this documentation and UrJTAG sourcecode
-is always available from the project homepage at http://www.urjtag.org
http://www.urjtag.org
The distributed source tarball contains source pregenerated with a current
flex version; flex therefore is only needed if you want to compile code
checked out from our Subversion repository. Flex 2.5.4a as it comes with
-Cygwin cannot build the scanners for BSDL and SVF. Building these files
-requires Flex 2.5.33 or newer. The configure script will compare the available
-Flex version against these preconditions and enables or disables the related
-features.
Furthermore, libtool should be available, and "devel" versions of the following
packages:
UrJTAG may be compiled into a Windows executable using the MinGW compiler
-(http://www.mingw.org). This has the advantage over running in a Cygwin
-environment that you don't need to install anything else but the jtag.exe.
-However, because support for MinGW is quite new in UrJTAG, it may lack some
+(http://www.mingw.org), or Cygwin GCC with the "-mno-cygwin" compiler flag.
This has the advantage over running in a Cygwin environment that you don't need
+to install anything else but the jtag.exe (plus libraries like FTD2XX.dll or
+InpOut32.DLL that are required for device access under Windows in any case).
However, because support for MinGW is quite new in UrJTAG, it may lack some
features (e.g. readline support) or run a little slower.
Because it seems to be easier to set up a Cygwin environment, we recommend
+using the Cygwin GCC with "-mno-cygwin" flag instead of using a MinGW setup:
CFLAGS="-mno-cygwin -O2" ./configure --with-ftd2xx=/tmp/cdm-drivers --with-inpout32
It is even possible to cross-compile and build the executable on a Linux
host:
./configure --host=i586-mingw32msvc --with-ftd2xx=/tmp/cdm-drivers
+>./configure --host=i586-mingw32msvc --with-ftd2xx=/tmp/cdm-drivers --with-inpout32
make
The "—with-inpout32" switch tells UrJTAG to use the InpOut32.DLL for access to
+parallel ports, because the Cygwin ioperm isn't available for MinGW. The InpOut32
+library is available from logix4u.net:
http://logix4u.net/Legacy_Ports/Parallel_Port/Inpout32.dll_for_Windows_98/2000/NT/XP.html
| There's one quirk to consider when using FTDI's FTD2XX driver. It
+connects to any known FTDI chip, randomly. I.e. if there's more than one FTDI
+device connected to the host, chances are that the driver connects to the
+wrong USB device. This might be an OEM USB-serial converter and you'll be
+banging your head why there's no proper reading from the JTAG chain. Therefore
+it's strongly recommended to specify the desc=xxx parameter for the cable
+command if the ftd2xx driver is to be used. Set xxx to the product or serial
+number descriptor string that are exhibited by the USB device. |
3.2.3.3. print
Print a list of parts in the chain and the currently active instruction per part.
Print a list of parts in the chain and the currently active instruction per part.
+Further details of bus, signals and instructions can be obtained with dedicated
+command options, see "help print".