urjtag/jtag/doc/internals.xml

<!-- $Id$ -->

<appendix>
	<title>JTAG Declarations Files</title>

<para>
JTAG declarations files are located in directory <filename>data</filename>. The files contains
common part specific JTAG information in parseable form, e.g. list of the JTAG commands, boundary
scan register, list of JTAG registers, etc.
</para>

<para>
Syntax of the JTAG declaration file is defined in the following subsections.
</para>

<section>
	<title>General rules</title>

<para>
JTAG declaration file is text file which consists of lines. Empty lines are ignored. Text after
first <constant>#</constant> on the line to the end of line is ignored. This is useful for comments.
All other lines are significant.
</para>

<para>
Each significant line consists of tokens separated by whitespace. Whitespace could be spaces and/or tabs.
</para>

</section>

<section>
	<title>Signal Definition</title>

<para>
Signal definition line consists of word <constant>signal</constant> followed by whitespace and signal name
(without spaces in the name). Rest of the line should contain whitespace separated list of pins
of the part. This list is currently not used for any purpose in JTAG Tools. It is intended for future use.
</para>

</section>

</appendix>