review: finale version
[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),
5 aber das hat wohl den Grund, dass es noch nicht die finale Abgabe ist (ein paar
6 Einzelheiten werden weiter unten erwaehnt).
7
8 Note: 2
9
10 2. Vollständigkeit: Enthält das Spezifikations-Dokument alle wesentlichen Requirements/Module des
11    Designs? Vergeben Sie eine Note (1-5) und begründen Sie!
12
13 [list]
14 [*]
15 Statemaschinen sind zwar vorhanden, aber es fehlt an Details die man mit
16 Moore-State-Maschinen gut darstellen kann. D.h. jeder Zustand hat Kanten, die
17 Input und Output definieren. Wenn man in "wenign" Signalen, die wichtig sind,
18 zeigen kann, dass so eine Statemaschine glaubhaft funktionieren kann, hat man
19 viel gewonnen:
20
21 Beispiel fuer RS232:
22 [list]
23 [*]eine Kante hat Signale:
24 [list]
25 [*]input: req, char(N)[/*]
26 [*]output: ack, counter_overflow, tx[/*]
27 [/list]
28 [/*]
29 [*]die States waeren dann: startbit ,char(0), char(1), char(2), ... ,char(n-1),
30 stopbit1, stopbit2, done[/*]
31 [*]die Uebergaenge
32 [list]
33 [*]belieber state -> startbit: 0 XX ... XX / 0 0 X[/*]
34 [*]startbit -> char (0): 0 XX ... XX / 0 1 0[/*]
35 [*]char (k) -> char (k+1): 0 XX ... XX / 0 1 char(k)[/*]
36 [*]char (n-1) -> stopbit 1: 0 XX ... XX / 0 1 1[/*]
37 [*]stopbit1 -> stopbit2: 0 XX ... XX / 0 1 1[/*]
38 [*]stopbit2 -> done: 1 XX ... XX / 1 1 1[/*]
39 [/list]
40 [/*]
41 [/list]
42 [/*]
43 [*]
44 Die Interfaces sind grundsaetzlich vorhanden und tabellarisch fest gehalten,
45 jedoch wird nicht spezifiziert wie diese Werte zu verwenden sind. Zum Beispiel
46 der Stack hat ein Signal "enable", aber ist das nun High- oder Low-Aktiv?
47 [/*]
48 [*]
49 Ist das Poppen des Stacks destruktiv? Wenn ja wie wird die Ausgabe dann
50 produziert? Beim ASCII-Stack bin ich mir nicht sicher ob das so gemeint ist und
51 ob das auch gut ist. Beim Operanden-Stack ist dieses Verhalten jedoch
52 gewuenscht.
53 [/*]
54 [*]
55 Wichtig ist ausserdem nicht nur wer aller Zugriff auf den Stack hat sondern
56 auch ob ein Zugriff auf den Stack gleichzeitig geschehen darf. Der Zugriff
57 selbst auf den Stack wird auch nur sehr oberflaechig beschrieben und geht nicht
58 wirklick hervor wie der tatsaechlich funktioniert.
59 [/*]
60 [*]
61 Die Grafik koennte man entweder weglassen oder ueberarbeiten (kann auch eine
62 gute Handzeichnung sein, solange klar ist was passiert).
63 [/*]
64 [*]
65 Testfaelle fehlen komplett.
66 [/*]
67 [/list]
68
69 Note: 3
70
71
72 3. Verständlichkeit: Ist das Dokument klar und verständlich geschrieben? Besitzt das Dokument eine
73    ordentliche Struktur? Vergeben Sie eine Note (1-5) und begründen Sie!
74
75 Grundssaetzlich ja, aber das Zusammenspiel einiger Komponenten ist teilweise unklar:
76
77 [list]
78 [*]
79 im Modul "MulDiv" gibt es die Signale "quotient", mehrere "operand_out_*",
80 "divisor" und "dividend" (in dieser Reihenfolge). Das ist am ersten Blick sehr
81 verwirrend, am zweiten Blick (naemlich auf die anderen Module) wird erst klar
82 dass diese Signale unterschiedliche Wege nehmen. Ausserdem: Warum die Division
83 und Multiplikation nochmal extra in ein Modul packen?
84 [/*]
85 [*]
86 Die Verwendung des Stacks geht leider nur sehr schwamming hervor (wie oben
87 schon angesprochen).
88 [/*]
89 [*]
90 Wieviele Stacks sind nun tatsaechlich in Verwendung? ein ASCII-Stack, ein
91 Operanden-Stack und ein Operator-Stack? Haben die das selbe Interface? Wie
92 speichern die Daten, sind doch eigentlich ganz unterschiedliche Datenstrukturen
93 zu speichern?
94 [/*]
95 [*]
96 Was haben signale wie "div_busy", "divisor", etc. im Modul "Encoder" zu suchen?
97 [/*]
98 [/list]
99
100
101 Verbesserungsvorschlag fuer die Schnittstellenbeschreibung:
102 [list]
103 [*]
104 eine Spalte zu welchen Module (oder externes Geraet, z.B. PS/2) die Signale
105 fuehren.
106 [/*]
107 [/list]
108
109
110 Note: 3
111
112 4. Gesamtbeurteilung: Vergeben Sie eine Gesamtnote (1-5) und geben Sie Ihren Kollegen ein kurzes
113    Feedback über die Qualität ihres Spezifikations-Dokumentes!
114
115 Man erkennt grundsaetzlich eine Aufteilung in Komponenten, jedoch happerts im Detail: Die
116 Zusammenhaenge der Module werden einem durch das Lesen der Spezifikation nicht ganz klar. 
117
118 Der Stack selbst gehoert auch noch detailierter beschrieben
119
120 Note: 2-3