diff --git a/jtag/doc/internals.xml b/jtag/doc/internals.xml new file mode 100644 index 00000000..2e98db72 --- /dev/null +++ b/jtag/doc/internals.xml @@ -0,0 +1,59 @@ + + + + + JTAG Tools Internals + + + +This chapter is primarily intented for JTAG Tools hackers. + + + + + JTAG Declarations Files + + + +JTAG declarations files are located in directory data. The files contains +common part specific JTAG informaions in parseble form, e.g. list of the JTAG commands, boundary +scan register, list of JTAG registers, etc. + + + +Syntax of the JTAG declaration file is defined in following subsections. + + + + + General rules + + + +JTAG declaration file is text file which consist of lines. Empty lines are ignored. Text after +first # on the line to the end of line is ignored. This is useful for comments. +All other lines are significant. + + + +Each significant line consists of tokens separated by whitespace. Whitespace could be spaces and/or tabs. + + + + + + + Signal Definition + + + +Signal definition line consist of word pin 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 is currently not used for any purpose in JTAG Tools. + + + + + + +