review: designspec.txt
[hwmod.git] / doc / review / designspec.txt
1 1. Korrektheit: Enthält die Spezifikation inhaltiche Fehler, widersprüchliche Aussagen oder werden
2    falsche Annahmen getroffen? Vergeben Sie eine Note (1-5) und begründen Sie!
3
4 Viele kleinere Unstimmigkeiten (vor allem bei der Schnittstellenbeschreibung), aber das hat wohl den
5 Grund, dass es noch nicht die finale Abgabe ist (ein paar Einzelheiten werden weiter unten erwaehnt).
6
7 > bernhard: Die Verwendung eines Stackes scheint das ganze Design etwas kompliziert zu machen, oder
8 > find das nur ich?
9
10 Note: X
11
12
13 2. Vollständigkeit: Enthält das Spezifikations-Dokument alle wesentlichen Requirements/Module des
14    Designs? Vergeben Sie eine Note (1-5) und begründen Sie!
15
16 > alexander: Mir persoenlich fehlen die Zustandsmaschinen. Ich wuerde vorschlagen hier
17 > entweder Grafen oder Tabellen zu nehmen.
18
19 > bernhard: Statemaschinen sind doch eh in der Detailed Design Description? ich find das passt...
20 > naehere Stackbeschreibung fehlt halt imho.
21
22 Die Interfaces sind grundsaetzlich vorhanden und tabellarisch fest gehalten, jedoch wird nicht
23 spezifiziert wie diese Werte zu verwenden sind. Zum Beispiel der Stack hat ein Signal "enable", aber
24 ist das nun High- oder Low-Aktiv?
25
26 Ist das Poppen des Stacks destruktiv? Wenn ja wie wird die Ausgabe dann produziert? Beim ASCII-Stack
27 bin ich mir nicht sicher ob das so gemeint ist und ob das auch gut ist. Beim Operanden-Stack ist
28 dieses Verhalten jedoch gewuenscht.
29
30 Die Grafik koennte man entweder weglassen oder ueberarbeiten (kann auch eine gute Handzeichnung
31 sein, solange klar ist was passiert).
32
33 Wichtig ist ausserdem nicht nur wer aller Zugriff auf den Stack hat sondern auch ob ein Zugriff auf
34 den Stack gleichzeitig geschehen darf. Der Zugriff selbst auf den Stack wird auch nur sehr
35 oberflaechig beschrieben und geht nicht wirklick hervor wie der tatsaechlich funktioniert.
36
37 Note: 2
38
39
40 3. Verständlichkeit: Ist das Dokument klar und verständlich geschrieben? Besitzt das Dokument eine
41    ordentliche Struktur? Vergeben Sie eine Note (1-5) und begründen Sie!
42
43 Grundssaetzlich ja, aber das Zusammenspiel einiger Komponenten ist teilweise unklar:
44 * im Modul "MulDiv" gibt es die Signale "quotient", mehrere "operand_out_*", "divisor" und
45   "dividend" (in dieser Reihenfolge). Das ist am ersten Blick sehr verwirrend, am zweiten Blick
46   (naemlich auf die anderen Module) wird erst klar dass diese Signale unterschiedliche Wege nehmen.
47   Ausserdem: Warum die Division und Multiplikation nochmal extra in ein Modul packen?
48
49 * Die Verwendung des Stacks geht leider nur sehr schwamming hervor (wie oben schon angesprochen).
50
51 * Wieviele Stacks sind nun tatsaechlich in Verwendung? ein ASCII-Stack, ein Operanden-Stack und ein
52   Operator-Stack? Haben die das selbe Interface? Wie speichern die Daten, sind doch eigentlich ganz
53   unterschiedliche Datenstrukturen zu speichern?
54
55 * Was haben signale wie "div_busy", "divisor", etc. im Modul "Encoder" zu suchen?
56
57
58 > alexander: divisor dividend sind output signale?
59 > und wenns muldiv heisst wieso isses dann immer nur ein operand und operator?
60 > (vermutlich irgendwie stack basiert aber wie greift der auf den stack zu.)
61
62 > bernhard: ja ist verwirrend am ersten blick. das scheint aber das interface zum "Divider" zu sein.
63 > meiner Meinung nach sind das zu viele Module und wuerde
64
65
66 Verbesserungsvorschlag fuer die Schnittstellenbeschreibung:
67 * eine Spalte zu welchen Module (oder externes Geraet, z.B. PS/2) die Signale fuehren.
68
69
70 Note: 3
71
72 4. Gesamtbeurteilung: Vergeben Sie eine Gesamtnote (1-5) und geben Sie Ihren Kollegen ein kurzes
73    Feedback über die Qualität ihres Spezifikations-Dokumentes!
74
75 Man erkennt grundsaetzlich eine Aufteilung in Komponenten, jedoch happerts im Detail: Die
76 Zusammenhaenge der Module werden einem durch das Lesen der Spezifikation nicht ganz klar. 
77 Der Stack selbst gehoert auch noch detailierter beschrieben
78
79 Note: 2