urjtag/jtag/doc/doc-layout.txt

<?xml version="1.0" standalone="no"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
         "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY datafilespecs SYSTEM "internals.xml">
  <!ENTITY FDL SYSTEM "fdl.xml">
  <!ENTITY GPL SYSTEM "gpl.dbk">
  <!ENTITY LGPL SYSTEM "lgpl.dbk">
]>

<book>
  <bookinfo>
    <title>Universal JTAG library, server and tools</title>
    <authorgroup>
      <author><firstname>Kolja</firstname><surname>Waschk</surname></author>
    </authorgroup>

    <legalnotice>
      <para>
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free
Documentation License, Version 1.2 or any later version published by the Free
Software Foundation. A copy of the license is included in the section entitled
"GNU Free Documentation License".
      </para>
    </legalnotice>

    <copyright>
      <year>2007</year>
      <year>2008</year>
      <holder>Kolja Waschk and the respective authors</holder>
    </copyright>

  </bookinfo>

  <toc/>

<chapter><title>General</title>

  <section><title>The name "UrJTAG"</title> <para/></section>
  <section><title>Authors, contributors, ... thanks</title><para/></section>
  <section><title>Copyright/Licensing</title> <para/> <para/></section>
  <section><title>UrJTAG/openwince history</title> <para/> <para/></section>
  <section><title>Supported hardware</title> <para/> <para/></section>
  <section><title>Installation </title><para/></section>
  <section><title>from binary tarball </title><para/></section>
  <section><title>from source tarball </title><para/></section>
  <section><title>from svn </title><para/></section>
  <section><title>Cygwin/MinGW specifics </title><para/></section>
  <section><title>Getting updates </title><para/></section>
  <section><title>Further info / support</title><para/></section>
</chapter>

<chapter><title>Usage</title>

  <section><title> Quick start: flash example </title><para/></section>
  <section><title> Configuration, cable setup </title><para/></section>
  <section><title> Chain setup </title><para/></section>
  <section><title> Part setup </title><para/></section>
  <section><title> Doing things with parts </title><para/></section>
  <section><title> Pin I/O </title><para/></section>
  <section><title> Memory I/O </title><para/></section>
  <section><title> FPGA configuration </title><para/></section>
  <section><title> Flash programming </title><para/></section>
  <section><title> ...  </title><para/></section>
  <section><title> SVF Player </title><para/></section>
  <section><title> bsdl2jtag, data files </title><para/></section>
  <section><title> target specific documentation</title><para/></section>
  <section><title> EJTAG support </title><para/></section> 
  <section><title> Blackfin support (when available) </title><para/></section> 
</chapter>

<chapter><title>Internals</title>


<section><title> How to</title>
  <para>
      .. add a part
      .. add a command
      .. add a bus driver
      .. add a cable driver
      ,,
     .. create a patch and upload to SF
  </para>
  <para/></section>
  <section><title> Directory structure</title>
  <para>
    data/
    ./include/
    ../include/
    libbrux/
      cmd/ flash/
    src/
      bus/ cmd/ lib/ tap/ svf/
  </para>
  <para/></section>
  <section><title> Cable driver interface</title>
  <para>
      parport
      cable
      chain
  </para>
  <para/></section> 
  <section><title> Bus driver interface </title><para/></section>
  <section><title> target specific internals  </title><para/></section><section><title>
  </title><para/></section>
</chapter>

<chapter><title> Frequently asked questions </title>

  <section><title> Cygwin/MinGW </title><para/></section>
  <section><title> Compilation problems </title><para/></section>
</chapter>

<chapter><title>Future plans</title>

    <section><title> API and library package
    </title><para/></section><section><title> Bindings for Python, Perl, ...
    </title><para/></section><section><title> TCP/IP access
    </title><para/></section><section><title> New cable drivers
    </title><para/></section><section><title> ...
    </title><para/></section>
</chapter>

&datafilespecs;

<appendix><title>UrJTAG shell quick reference sheet</title><para/> </appendix>
<appendix><title>man pages</title>
  <section><title>jtag(1)</title><para/></section>
  <section><title>bsdl2jtag(1)</title><para/></section>
</appendix>

<appendix><title> Exkurs: JTAG </title><para/></appendix>

<appendix><title>UrJTAG Revision information</title><para/>
  <section><title>UrJTAG 0.6</title><para/></section>
  <section><title>openwince JTAG Tools 0.5.1</title><para/></section>
</appendix>

&FDL;
&GPL;
&LGPL;

</book>