% README - Kurzbeschreibung Hades fr Technische Informatik I, KE 1-5
%
% fnh, 19.02.2002



0. Einfhrung, Motivation 

   *FIXME*
   *to be written later*


1. Systemanforderungen, Download, Arbeitsverzeichnis

   *FIXME*
   *Beschreibung erst nach endgltiger Definition der Verzeichnis*
   *struktur und der Downloadvarianten (Uni Hagen, Uni HH, CDs)*

   Die Verzeichnisstruktur sollte wie folgt aussehen, wobei das
   Verzeichnis oberhalb von "hades" frei gewhlt werden kann.
   Falls Sie eine andere Verzeichnisstruktur whlen, kann es zu
   Problemen kommen:

   ROOTDIR/
           hades/
                 README                            - diese Datei
                 hades.jar                         - Hades Software
                 .hadesrc                          - Hades Properties
                 hades.bin                         - Startskript, Unix
                 hades.bat                         - Startskript, Windows
                 PopupMenuHagen.txt                - Mendefinition
                 ...
                 /ke15/                            - Technische Informatik 1
                       doc/                        - Dokumentation 
                           kurzanleitung.pdf       - Hades Kurzanleitung
                           ...
                       1/                          - Aufgabenblatt 1 (leer)
                       2/                          - Aufgabenblatt 2 (leer)
                       3/                          - Aufgabenblatt 3
                         aufgabe_3_1_a.hds
                         ...
                         testbench_3_1_a.hds
                         ...
                       4/                          - Aufgabenblatt 4
                         aufgabe_4_1_a.hds
                         ...
                       5/                          - Aufgabenblatt 5
                         aufgabe_5_1_b.hds
                         ...


---------------------------------------------------------------------------

1. Installation (JDK 1.3)

   Auf Windows-Sytemen: bitte einfach das "hades.jar" doppelklicken,
   um den Editor zu starten.

   Alle Systeme (sofern die JDK 1.3 Programme im Suchpfad sind):

   cd <arbeitsverzeichnis-mit-dem-hades.jar>
   java -jar hades.jar
   

---------------------------------------------------------------------------

2. Installation (Microsoft jview)

   Hades luft unter Windows 9x/ME/2000 auch mit der Microsoft VM,
   die auf vielen Systemen als Bestandteil des Internet Explorers
   bereits vorinstalliert ist. Empfehlenswert ist Version 3.181
   oder hher, die Version 3.167 macht manchmal Probleme. Separater
   Download der aktuellen Version unter www.microsoft.com/java/
   Leider wird die Microsoft VM unter Windows XP nicht mitgeliefert
   und offiziell untersttzt.

   Aufruf in einer (DOS) Kommandoaufforderung:

   jview /cp "c:\path\to\your\hades.jar" hades.gui.Editor

   wo der vollstndige Pfad zum "hades.jar" Archiv eingesetzt werden
   mu. Die Anfhrungszeichen sind notwendig, wenn der Pfadname
   Leerzeichen oder Sonderzeichen enthlt.


---------------------------------------------------------------------------

3. Aufrufen der Design-Templates

   Fr alle KE15-Aufgaben, zu deren Lsung eine Schaltung gehrt,
   finden Sie an der entsprechenden Stelle im Verzeichnisbaum ein
   "Design Template". Das ist eine Schaltung, die zwar alle bentigten
   Ein- und Ausgabekomponenten bereits enthlt, die aber ansonsten
   leer ist. 


   Rufen Sie nach dem Starten des Editors aus dem Men die "File->
   Load..." Funtion auf und whlen Sie dann im Dateidialog die
   entsprechende ".hds" Datei aus, etwa "ke15/3/aufgabe_3_1_a.hds".
   Nutzen Sie dann die Editorfunktionen, um die Schaltung zu
   vervollstndigen. Denken Sie daran, die Datei regelmssig 
   abzuspeichern. Benutzen Sie die interaktiven Eingabeschalter,
   um die Schaltung bereits whrend des Entwurfs zu simulieren und
   zu berprfen. 

   Bitte lesen Sie die Hades Kurzbeschreibung, um weitere Informationen
   zur Bedienung des Editors zu erhalten. Die Beschreibung liefert
   auch einige Tips, etwa welche vordefinierten Komponenten fr die
   die einzelnen Aufgaben verwendet werden sollten (oder mssen).

   Fr den automatischen Selbsttest (s.u.) der Schaltungen ist es
   notwendig, dass Sie die fertige Version Ihres Entwurfs unter
   dem originalen Namen abspeichern. Auch sollten Sie die Ein-
   und Ausgnge der Schaltung nicht modifizieren, da der Selbsttest
   sonst nicht funktioniert.
   Falls Sie versehentlich Ein- oder Ausgnge gelscht oder umbenannt
   haben, machen Sie diese nderungen bitte rckgngig. Notfalls
   mssen Sie ein Rahmendesign aus dem originalen Archiv neu
   auspacken.


---------------------------------------------------------------------------

4. Selbsttest der Schaltungen 

   Neben den Template-Designs fr die einzelnen Aufgaben finden Sie
   zu vielen (aber nicht allen) Schaltungen auch zugehrige 
   Testumgebungen fr einen automatischen Selbsttest.
   Zum Beispiel gibt es zur Aufgabe 3.1.a die eigentliche Schaltung
   (aufgabe-3-1-a.hds) und die Testumgebung (testbench-3-1-a.hds).

   Die Testumgebungen nutzen Simulationsmodelle mit rckgekoppelten
   Schieberegistern, um Eingangssignale fr die zu testende Schaltung
   zu erzeugen und aus deren Ausgangssignalen einen Signaturwert zu
   Die Theorie dazu findet sich zum Beispiel in Hans Wojtkowiak, 
   Test und Testbarkeit digitaler Schaltungen, Teubner Verlag, 1988.

   Der Selbsttest startet jeweils automatisch nach Laden des testbench
   Designs. Warten Sie, bis die Testbench die voreingestellte Anzahl
   von Takten abgearbeitet hat. ffnen Sie dann den Edit-Dialog fr
   das Signaturanalyse-Register (jeweils ganz rechts in der Schaltung)
   und lesen Sie den Signaturwert ab. ndern Sie die Schaltung nicht und
   geben Sie auch keine zustzlichen Takte, da sich sonst die Signatur
   sofort ndert.

   Die jeweils erwartete Signatur fr eine korrekte Schaltung finden
   Sie in der Dokumentation. Falls die von Ihrer Schaltung erzeugte
   Signatur vom vorgegebenen Wert abweicht, gibt es eine Reihe von
   Mglichkeiten:

   - berprfen Sie interaktiv, ob Ihre Schaltung funktioniert.
     Prfen Sie dabei besonders auch die "kritischen" Eingabewerte,
     etwa ob sich ein Carry Signal korrekt verhlt.

   - Rechnet Ihre Schaltung korrekt aber zu langsam?  Da die Simulation
     auch Gatterlaufzeiten bercksichtigt, kann dies zu Abweichungen
     fhren, insbesondere bei Aufgabe 3.3.

   - Lsst sich Ihre Schaltung sauber initialisieren? Sind alle (!)
     bentigten Ein- und Ausgnge angeschlossen?

   - Einige Aufgaben sind nicht vollkommen eindeutig formuliert, so dass
     mehrere Lsungen richtig sein knnen. berprfen Sie mit interaktiver
     Simulation, dass Ihre Schaltung wirklich korrekt funktioniert,
     bevor Sie die Lsung einschicken.

   - (evtl. haben sich Fehler in die Dokumentation eingeschlichen)

  
---------------------------------------------------------------------------

5. GUI zum Selbsttest  

   *Reichen die einzelnen Testbenches, oder soll es eine benutzer-
   *freundlichere Oberflche geben, um die Tests automatisch zu
   *starten und die Signaturen auszuwerten?

