index.sgml

IEEE1394Diag is a GUI application that presents a graphical view of an IEEE1394 network and provides

<!doctype linuxdoc system>
<article>
<title>The IEEE1394Diag Handbook
<author>Melekam Tsegaye <tt>[e-mail]</tt>
<date>Version 1.0 , Mon Oct  7 08:12:35 SAST 2002
<abstract>
This Handbook describes IEEE1394app Version 1.0
</abstract>

<toc>

<sect>Introduction
<p>
<sect1>What is IEEE1394Diag
<p>
IEEE1394Diag is a GUI application that presents a graphical view of an
IEEE1394 network and provides the ability to perform common 1394
operations such as async reads, writes, isoc listens and talks, as well as
configuration rom browsing of all nodes present on a bus.

<sect1> Why create IEEE1394Diag
<p>
When I first started investigating IEEE1394 on Linux, I found only one GUI
application called gscanbus (http://www.ivistar.de/0500opensource.php3?lang=en)
that allowed me to view my 1394 network graphically and perform simple diagnostics.
IEEE1394Diag improves on this by providing better diagnositic capabilites
as well as configuration rom browsing.

<sect>Requirements
<p>
IEEE1394Diag is a QT 3.0 C++ application intended for use on Linux. It
requires libraries for QT 3.0 or greater. IEEE1394
operations are preformed using libraw1394 so the current version of this
library is required. The Linux kernel in use must be configured
with support for IEEE1394 devices and drivers for these devices must
be loaded prior to using IEEE1394diag.

<sect>Using IEEE1394Diag
<p>
IEEE1394Diag allows you to perform read, write, lock, iso talk, iso listen operations.
Data to be used or produced by these operations may be inputed from or outputed to a specified
datafile. It also allows you to print data from any of the currently selected tabs represented
by one of the above operations.

<sect1>Application Screen
<p>
IEEE1394Diag's screen looks like the image shown below. On the left is a tree view that
shows nodes currently present on the bus and on the right are tabs for the various functions
IEEE1394Diag offers.
<p>
<sect1>Config Rom
<p>
The config rom tab displays config rom values for a selected node as you browse that node's leafs
through the tree view control. When new nodes are inserted into the bus the new nodes
should appear on the tree view.

<sect1>Read
<p>
The read tab allows you to perform block reads from a selected node on the left tree view.
Node ID, bus ID and the read size must be specified as well as the destination CSR address.
Common CSR address are listed in the dropdown listbox for convinience. The results of the read
operation will appear in the text box. Alternatively an output file can be specified where data
can be dumped. The time the read took and the transfer speed are also specified. The progress bar
indicates the progress of the read.

<sect1>Write
<p>
The write tab looks very similar to the read tab. The differences are that a target CSR address
must be selected or specified for the write operation. The data to be written can also be
specified through the the select file button or may be entered into the textbox one quadlet per line.
The size of the transaction must also be specified.

<sect1>Lock
<p>
The lock tab differs from the write tab in that it introduces a drop down box for the various types
of lock operations. Data for lock operations is specified in the text box in a specific order one quadlet at
per line. Ie. the first quadlet should be the argument value and the next quadlet the data value for lock32
operations. For lock64 operations the first two quadlets will be used as the argument value and
the next two quadlets as the data value. In each case the first quadlet will be the most significant
quadlet. If the lock operation is successfull the result will be displayed below the specified argument
and data values. Lock data may be specfied from a data file formated as in above.

<sect1>Fcp Listen
<p>
The FCP Listen tab enables listening for fcp commands/responses. A node ID of 63 should be specfied to
listen for FCP commands from all nodes on the bus otherwise a specific node id should be supplied.

<sect1>Iso Talk
<p>
This tab enables generating iso traffic. Data to be transmitted can be entered in the text box
one quadlet per line or can be specified from a data file. Iso talk will only work if there is a
proper IRM on the bus.

<sect1>Iso Listen
<p>
This tab enables listening for iso traffic. Received data can be dumped to a file.

<sect1>Configuration
<p>
This tab displays the current IEEE1394 configuration for the node on which IEEE1394Diag was executed.
The data is extracted from the file /proc/bus/ieee1394/devices. The "Active 1394 port" list box allows you
to select the port you want to use for the various operations, incase you have more
than one IEEE1394 port on your system.

<sect1>Printing data
<p>
Select the tab from which you want to print data. For example select the read tab. Choose
File->Print from the file menu. Values of all the fields in the read tab will then be printed.

<sect>Development Environment<p>
<p>
IEEE1394diag was developed using the following open source software tools
<itemize>
<item>kdevelop 2.1.3
<item>qt-3.0.5
<item>Linux kernel 2.4.19
<item>libraw394-0.9.1
<item>Tested on Redhat 7.2 and Redhat 8.0
<item>Icons from Conectiva Crystal Icon Theme Beta 3.1 by Everaldo ([e-mail])
</itemize>

<sect>Copyright<p>
IEEE1394app Copyright 2002 Melekam Tsegaye , [e-mail]

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

<p>
</article>