review: finale version
[hwmod.git] / doc / review / hwmodspec.txt
index 2fb4b2e19b42b1e590b5fac87711b9d3a072ba2e..38f895e9e459f4f938368e2cd8feec94df59a6d7 100644 (file)
@@ -1,28 +1,69 @@
-1. Korrektheit: Enthält die Spezifikation inhaltiche Fehler, widersprüchliche Aussagen oder werden falsche Annahmen getroffen? Vergeben Sie eine Note (1-5) und begründen Sie!
+1. Korrektheit: Enthält die Spezifikation inhaltiche Fehler, widersprüchliche Aussagen oder werden
+   falsche Annahmen getroffen? Vergeben Sie eine Note (1-5) und begründen Sie!
 
-Wofuer sind die verschiedenen clocks im design da? ein multiclock design ist nicht wuenschenswert ausserdem komplex?
-ich glaube man sollte das durch kontroll signale ersetzen. also ein request geht hoch wenn alle daten ins register geladen wurden und bis zur fertig stellung der arbeit bleibt das ack signal niedrig.
-multiclocking in einem so kleinen design zu betrieben (stichwort GALS) ist
-overkill. ansonsten wirkt das ganze gut aufgebaut, die frage stellt sich noch
-wie wohl der interne ablauf der taschenrechner einheit funktioniert.
-state-machines sehe ich hier keine. nur sehr abstrahierte ideen wie diese
-zustandsmaschine funktionieren koennte.
+Wofuer sind die verschiedenen Clocks im Design da? Ein Multiclockdesign ist
+nicht wuenschenswert, ausserdem zu komplex? Wir glauben man sollte das durch
+Kontrollsignale ersetzen, also z.B. ein Requestsignal geht hoch wenn alle Daten
+ins Register geladen wurden und bis zur Fertigstellung der Arbeit bleibt das
+ACK-Signal niedrig. Es koennte sein, dass es so gemeint ist, dann ist aber die
+Bezeichnung '*_clk' sehr irrefuehrend gewaehlt.
 
+Note: 2
 
-2. Vollständigkeit: Enthält das Spezifikations-Dokument alle wesentlichen Requirements/Module des Designs? Vergeben Sie eine Note (1-5) und begründen Sie!
 
-module ja, requirements jein, da auf die genaue art wie das alles funktioniert
-schlicht und ergreifend nicht eingegangen wird.
+2. Vollständigkeit: Enthält das Spezifikations-Dokument alle wesentlichen Requirements/Module des
+   Designs? Vergeben Sie eine Note (1-5) und begründen Sie!
 
-3. Verständlichkeit: Ist das Dokument klar und verständlich geschrieben? Besitzt das Dokument eine ordentliche Struktur? Vergeben Sie eine Note (1-5) und begründen Sie!
+Requirements: passen.
 
-ja grundsaetzlich schon.
 
-4. Gesamtbeurteilung: Vergeben Sie eine Gesamtnote (1-5) und geben Sie Ihren Kollegen ein kurzes Feedback über die Qualität ihres Spezifikations-Dokumentes!
+Module:
+Ueberblicksmaessig wirkt es recht gut (abgesehen von den
+'*_clk'-Signalen), aber in der "Detailed Design Description" fehlen eben die
+Details.
+Ablaeufe werden zwar textuell kurz erklaert, aber sie werden nur sehr
+oberflaechig und abstrakt "angekratzt". Ausserdem fehlen grafische
+Darstellungen (z.B. State-Maschinen). Weiters waere eine Beschreibung
+wuenschenswert wie ihr die eigentliche Berechnung umsetzen wollt (z.B. mit
+Hilfe von Pseudocode). Da muss einfach noch viel gemacht werden!
 
-wenn die module die nicht beschrieben sind funktionieren, das komponenten design
-schaut so aus als koennte es funktionieren, wenn auch daraufhingehend das mit
-den multiple clocks zu beseitigen ist.
 
+Testfaelle: Sind sehr gut!
 
 
+Note: 3
+
+
+3. Verständlichkeit: Ist das Dokument klar und verständlich geschrieben? Besitzt das Dokument eine
+   ordentliche Struktur? Vergeben Sie eine Note (1-5) und begründen Sie!
+
+Ja, grundsaetzlich schon, bis auf die Schnittstellenbeschreibung. 
+Verbesserungsvorschlaege:
+[list]
+[*]
+eine Spalte zu welchen Module (oder externes Geraet, z.B. PS/2) die Signale
+fuehren.
+[/*]
+[*]
+einheitlichere Beschriftung der Signale (z.B. in "Calculator State Maschine",
+wo fuehren die Signale "result_data" bzw. "result_clk" hin? Das ist am ersten
+Blick nicht klar ersichtlich)
+[/*]
+[*]
+und wie schon angesprochen: die divisieren '*_clk'-Signale verwirren.
+[/*]
+[/list]
+
+Note: 2
+
+
+4. Gesamtbeurteilung: Vergeben Sie eine Gesamtnote (1-5) und geben Sie Ihren Kollegen ein kurzes
+   Feedback über die Qualität ihres Spezifikations-Dokumentes!
+
+Wenn die nicht naeher beschriebenen Module funktionieren, schaut das Gesamtdesign recht
+zuversichtlich aus. (Sofern das mit den mehreren Clocksignalen beseitigt wird).
+
+Die "Detailed Design Description" muss unbedingt noch ueberarbeitet werden.
+
+Note: 2-3
+