sm: display
[hwmod.git] / spec / spec.tex
index f4d4dfeda033c3b1bd6f3a61d80e0a31b29e0b88..0764c3663a35f96b1a1f8c8c5f47048f4170a068 100644 (file)
@@ -53,7 +53,9 @@ EXPRESSION = OPERAND \{ OPERATOR OPERAND \} ;
 
 \req{Die Anzeige der Ein- und Ausgaben erfolgt über einen VGA Monitor.}
 
-\req{Es wird pro Zeile eine Eingabe oder Ausgabe angezeigt. Die aktuelle Eingabezeile befindet sich zuoberst, darunter das Ergebnis der vorigen Rechnung, darunter die Eingabe der vorigen Rechnung und so weiter}
+\req{Es wird pro Zeile eine Eingabe oder Ausgabe angezeigt. Die aktuelle Eingabezeile wandert nach
+unten, dar\"uber befindet sich das Ergebnis der vorigen Rechnung, dar\"uber die Eingabe der
+vorigen Rechnung usw.}
 
 \req{Auf die in zuvor angegebene Methode sollen zusätzlich zur aktuellen Eingabezeile die letzten 14 Ein- und Ausgaben dargestellt werden}
 
@@ -75,48 +77,26 @@ EXPRESSION = OPERAND \{ OPERATOR OPERAND \} ;
 
 In Abbildung \ref{fig:arch} ist der Aufbau des Taschenrechners zu sehen. Der Taschenrechner besteht aus folgenden Modulen:
 
-%\subsection{Module}
-
 \begin{itemize}
 \item \textbf{VGA} - Zeichenweises Ansprechen des Monitors
-\item \textbf{PS/2} - Empfangen von Keyboard-Eingaben als Scancodes
+\item \textbf{Display} - Liest einzelne Zeichen aus der History aus und leitet diese an das VGA Modul weiter, um sie in der entsprechenden Zeile anzeigen zu lassen
 \item \textbf{RS232} - Senden und Empfangen von Nachrichten vom/zum PC über die serielle Schnittstelle % TODO. baudrate? kodierung? (8N1?)
+\item \textbf{PC-Kommunikation} - Auf eine vom PC eintreffende Bufferübermittlungsanforderung oder ein Drücken des entsprechenden Board-Buttons, liest es Zeichen für Zeichen aus dem History Modul aus und leitet es an das RS232 Modul weiter
+\item \textbf{PS/2} - Empfangen von Keyboard-Eingaben als Scancodes
 \item \textbf{Scanner} - Empfängt die Scan-Codes vom PS/2 Modul und leitet nur für die Eingabezeile erlaubte Zeichen dekodiert in das CP850 Format an die History weiter, bei einem empfangenen Enter wird der Beginn der Berechnung an das Parser Modul signalisiert
-\item \textbf{History} - Verwaltung des dahinterliegenden Buffers von vergangenen Berechnungen und der aktuellen Eingabezeile, bei Aktualisierung der aktuellen Eingabezeile und bei Empfang eines Ergebnisses vom Parser Modul signalisiert es das an das Display Modul
-\item \textbf{Parser} - Wertet die Eingabezeile der History aus und liefert als Antwort entweder einen Fehler zurück oder gibt die einzelnen Berechnungen von je zwei Zahlen an die ALU weiter, die vom History Modul ausgelesenen zusammenhängenden Dezimalstellen werden mit dem Bin/Dez-Converter Modul in Binärzahlen umgerechnet, das Berechnungs-Endergebnis wird wieder in mit dem Converter Modul in einzelne Charakter umgerechnet und in der History gespeichert
-\item \textbf{Bin/Dez-Converter} - Konvertiert 10 CP850-codierte Dezimalziffern mit Vorzeichen in eine Binärzahl und umgekehrt %TODO oder in Parser integrieren? Oder gibt's eine Library-Funktion dafür?
+\item \textbf{Parser} - Wertet die Eingabezeile der History aus und liefert als Antwort entweder
+einen Fehler zurück oder gibt die einzelnen Berechnungen von je zwei Zahlen an die ALU weiter, die
+vom History Modul ausgelesenen zusammenhängenden Dezimalstellen werden intern umgerechnet, das
+Berechnungs-Endergebnis wird jedoch wieder in einzelne Charakter umgerechnet und in der History gespeichert
 \item \textbf{ALU} - Führt die tatsächlichen Berechnungen von Addition, Subtraktion, Multiplikation und Division durch
-\item \textbf{Display} - Liest einzelne Zeichen aus der History aus und leitet diese an das VGA Modul weiter, um sie in der entsprechenden Zeile anzeigen zu lassen
-\item \textbf{PC-Kommunikation} - Auf eine vom PC eintreffende Bufferübermittlungsanforderung oder ein Drücken des entsprechenden Board-Buttons, liest es Zeichen für Zeichen aus dem History Modul aus und leitet es an das RS232 Modul weiter
+\item \textbf{History} - Verwaltung des dahinterliegenden Buffers von vergangenen Berechnungen und der aktuellen Eingabezeile, bei Aktualisierung der aktuellen Eingabezeile und bei Empfang eines Ergebnisses vom Parser Modul signalisiert es das an das Display Modul
 \end{itemize}
 
-%\subsection{Interfaces}
-
-\subsection{Externe Interfaces}
-
-\subsubsection{Physikalische Interfaces}
-
-%TODO die pins sind wahrscheilich gefragt
-%wie ist das mit dem clock? externe ungenaue clock + interne pll oder wie?
-
-Interface zum key pad
-
-Interfaces zu VGA, PS/2, RS232
-
-Reset und Clock!
-
-Active Low oder Active High
-
-das ist mir noch nicht ganz klar was die da wollen. was meinen die z.b. mit ``interfaces
-to VGA'' unter ``physical interfaces'' (seite 10 in der exercise.pdf)
-
-``physikalisch'' im sinne der VHDL entity? oder doch den physischen stecker?
-Ersteres wuerde ich unter Logisches Interface verstehen.
 
-\subsubsection{Logische Interfaces der Module}
 \begin{landscape}
+\subsection{Logische und physikalische Interfaces}
 
-\paragraph{VGA}
+\subsubsection{VGA}
 \THEAD
 vga\_clk & in & 1 & std\_logic & PLL & VGA-Clock \ZE
 vga\_res\_n & in & 1 & std\_logic & PLL & VGA-Reset \ZE
@@ -130,21 +110,30 @@ b & out & 2 & std\_logic\_vector & Bildschirm & Ausgabe der Farbe Blau \ZE
 
 command & in & 8 & std\_logic\_vector & Display & Kommando an das VGA Modul \ZE
 command\_data & in & 32 & std\_logic\_vector & Display & Daten f\"ur das Kommando \ZE
-free & in & 1 & std\_logic & Display & Signalisiert Bereitschaft \ZE
+free & out & 1 & std\_logic & Display & Signalisiert Bereitschaft \ZE
 \TEND
 
 
-\paragraph{PS/2}
+\subsubsection{Display}
+%Liest einzelne Zeichen aus der History aus und leitet diese an das VGA Modul weiter, um sie in der entsprechenden Zeile anzeigen zu lassen
 \THEAD
-new\_data & out & 1 & std\_logic\_vector & Scanner & Signalisiert neuen Scancode \ZE
-data & out & 8 & std\_logic\_vector & Scanner & Scancode laut Codepage 850 \ZE
-
-ps2\_clk & inout & 1 & std\_logic & Tastatur & Clockleitung zum Keyboard \ZE
-ps2\_data & inout & 1 & std\_logic & Tastatur & Datenleitung zum Keyboard \ZE
+new\_eingabe & in & 1 & std\_logic & History & Aufforderung der History die aktuelle Eingabe
+auszulesen \ZE
+new\_result & in & 1 & std\_logic & History & Aufforderung der History das aktuelle Ergebnis
+auszulesen \ZE
+zeile & out & 5 & std\_logic\_vector & History & Zeilenadressierung ($2 * 15$ Zeilen $=30$) \ZE
+spalte & out & 7 & std\_logic\_vector & History & Spaltenadressierung (71 Zeichen inklusive \textbackslash 0) \ZE
+get & out & 1 & std\_logic & History & Signalisiert Speicheranforderung \ZE
+done & in & 1 & std\_logic & History & Signalisiert dass Daten anliegen \ZE
+char & in & 8 & character & History & enth\"alt angeforderne Daten \ZE
+
+command & out & 8 & std\_logic\_vector & VGA & Kommando an das VGA Modul \ZE
+command\_data & out & 32 & std\_logic\_vector & VGA & Daten f\"ur das Kommando \ZE
+free & in & 1 & std\_logic & VGA & Signalisiert Bereitschaft \ZE
 \TEND
 
 
-\paragraph{RS232}
+\subsubsection{RS232}
 %Senden und Empfangen von Nachrichten vom/zum PC über die serielle Schnittstelle
 \THEAD
 rxd & in & 1 & std\_logic & PC & Sendeleitung der seriellen \"Ubertragung \ZE
@@ -157,7 +146,36 @@ tx\_data & out & 8 & std\_logic\_vector & PC-Kommunikation & Datenfeld f\"ur das
 tx\_new & out & 1 & std\_logic & PC-Kommunikation & Signalisiert dass das anliegende Byte gesendet werden soll \ZE
 \TEND
 
-\paragraph{Scanner}
+
+\subsubsection{PC-Kommunikation}
+%Auf eine vom PC eintreffende Bufferübermittlungsanforderung oder ein Drücken des entsprechenden Board-Buttons, liest es Zeichen für Zeichen aus dem History Modul aus und leitet es an das RS232 Modul weiter
+\THEAD
+btn\emph{A} & in & 1 & std\_logic & externer Button & zum Triggern der RS232 Kommunikation \ZE
+
+rx\_data & in & 8 & std\_logic\_vector & RS232 & Datenfeld f\"ur das Empfangen \ZE
+rx\_new & in & 1 & std\_logic & RS232 & Signalisiert ein neu empfangendes Byte \ZE
+tx\_data & in & 8 & std\_logic\_vector & RS232 & Datenfeld f\"ur das \"Ubertragen \ZE
+tx\_new & in & 1 & std\_logic & RS232 & Signalisiert dass das anliegende Byte gesendet werden soll \ZE
+
+zeile & out & 7 & std\_logic\_vector & History & Zeilenadressierung (50 * 2 Zeilen = 100)\ZE
+spalte & out & 7 & std\_logic\_vector & History & Spaltenadressierung (71 Zeichen inklusive \textbackslash 0) \ZE
+get & out & 1 & std\_logic & History & Signalisiert Speicheranforderung \ZE
+done & in & 1 & std\_logic & History & Signalisiert dass Daten anliegen \ZE
+char & in & 8 & character & History & enth\"alt angeforderne Daten \ZE
+\TEND
+
+
+\subsubsection{PS/2}
+\THEAD
+new\_data & out & 1 & std\_logic\_vector & Scanner & Signalisiert neuen Scancode \ZE
+data & out & 8 & std\_logic\_vector & Scanner & Scancode laut Codepage 850 \ZE
+
+ps2\_clk & inout & 1 & std\_logic & Tastatur & Clockleitung zum Keyboard \ZE
+ps2\_data & inout & 1 & std\_logic & Tastatur & Datenleitung zum Keyboard \ZE
+\TEND
+
+
+\subsubsection{Scanner}
 %Empfängt die Scan-Codes vom PS/2 Modul und leitet nur für die Eingabezeile erlaubte Zeichen dekodiert in das CP850 Format an die History weiter, bei einem empfangenen Enter wird der Beginn der Berechnung an das Parser Modul signalisiert
 \THEAD
 new\_data & in & 1 & std\_logic\_vector & PS/2 & Signalisiert neuen Scancode \ZE
@@ -165,6 +183,7 @@ data & in & 8 & std\_logic\_vector & PS/2 & Scancode laut Codepage 850 \ZE
 
 char & out & 8 & character & History & Zeichen das vom History Modul \"ubernommen werden soll \ZE
 take & out & 1 & std\_logic & History & Signalisiert Datenfeld char \ZE
+done & in & 1 & std\_logic & History & Signalisiert die \"Ubernahme der Daten \ZE
 backspace & out & 1 & std\_logic & History & Signalisiert Backspace (letztes Zeichen im Buffer soll gel\"oscht werden) \ZE
 
 do\_it & out & 1 & std\_logic & Parser & Auswertung beginnen (ENTER) \ZE
@@ -172,52 +191,16 @@ finished & in & 1 & std\_logic & Parser & Auswertung fertig \ZE
 \TEND
 
 
-\paragraph{History}
-%Verwaltung des dahinterliegenden Buffers von vergangenen Berechnungen und der aktuellen
-%Eingabezeile, bei Aktualisierung der aktuellen Eingabezeile und bei Empfang eines Ergebnisses vom
-%Parser Modul signalisiert es das an das Display Modul
-\THEAD
-pc\_zeile & in & 7 & std\_logic\_vector & PC-Kommunikation & Zeilenadressierung (50 * 2 Zeilen = 100)\ZE
-pc\_spalte & in & 7 & std\_logic\_vector & PC-Kommunikation & Spaltenadressierung (71 Zeichen inklusive \textbackslash 0) \ZE
-pc\_get & in & 1 & std\_logic & PC-Kommunikation & Signalisiert Speicheranforderung \ZE
-pc\_done & out & 1 & std\_logic & PC-Kommunikation & Signalisiert dass Daten anliegen \ZE
-pc\_char & out & 8 & character & PC-Kommunikation & enth\"alt angeforderne Daten \ZE
-
-s\_char & in & 8 & character & Scanner & Zeichen das vom Scanner Modul \"ubernommen werden soll \ZE
-s\_take & in & 1 & std\_logic & Scanner & Signalisiert Datenfeld char \ZE
-s\_backspace & in & 1 & std\_logic & Scanner & Signalisiert Backspace (letztes Zeichen im Buffer soll gel\"oscht werden) \ZE
-
-d\_new\_eingabe & out & 1 & std\_logic & Display & Fordert Display auf die Eingabe auszulesen \ZE
-d\_new\_result & out & 1 & std\_logic & Display & Fordert Display auf das Ergebnis auszulesen \ZE
-d\_zeile & in & 5 & std\_logic\_vector & Display & Zeilenadressierung ($2 * 15$ Zeilen $=30$) \ZE
-d\_spalte & in & 7 & std\_logic\_vector & Display & Spaltenadressierung (71 Ziechen inklusive \textbackslash 0) \ZE
-d\_get & in & 1 & std\_logic & Display & Signalisiert Speicheranforderung \ZE
-d\_done & out & 1 & std\_logic & Display & Signalisiert dass Daten anliegen \ZE
-d\_char & out & 8 & character & Display & enth\"alt angeforderne Daten \ZE
-
-p\_rw & in & 1 & std\_logic & Parser & 0 = read (Expression), 1 = write (Ergebnis) \ZE
-p\_spalte & in & 7 & std\_logic\_vector & Parser & Spaltenadressierung (71 Ziechen inklusive \textbackslash 0) \ZE
-p\_rget & in & 1 & std\_logic & Parser & Signalisiert Leseanforderung \ZE
-p\_rdone & out & 1 & std\_logic & Parser & Signalisiert dass Daten anliegen \ZE
-p\_read & in & 8 & character & Parser & enth\"alt angeforderne Daten \ZE
-
-p\_wdo & in & 1 & std\_logic & Parser & Signalisiert Schreibanforderung \ZE
-p\_wdone & out & 1 & std\_logic & Parser & Signalisiert dass Daten anliegen \ZE
-p\_write & out & 8 & character & Parser & enth\"alt zu schreibende Daten \ZE
-
-p\_finished & in & 1 & std\_logic & Parser & Auswertung fertig \ZE
-\TEND
-
-\paragraph{Parser}
+\subsubsection{Parser}
 %Wertet die Eingabezeile der History aus und liefert als Antwort entweder einen Fehler zurück oder gibt die einzelnen Berechnungen von je zwei Zahlen an die ALU weiter, die vom History Modul ausgelesenen zusammenhängenden Dezimalstellen werden mit dem Bin/Dez-Converter Modul in Binärzahlen umgerechnet, das Berechnungs-Endergebnis wird wieder in mit dem Converter Modul in einzelne Charakter umgerechnet und in der History gespeichert
 \THEAD
 h\_rw & in & 1 & std\_logic & History & 0 = read (Expression), 1 = write (Ergebnis) \ZE
-h\_spalte & in & 7 & std\_logic\_vector & History & Spaltenadressierung (71 Ziechen inklusive \textbackslash 0) \ZE
+h\_spalte & in & 7 & std\_logic\_vector & History & Spaltenadressierung (71 Zeichen inklusive \textbackslash 0) \ZE
 h\_rget & in & 1 & std\_logic & History & Signalisiert Leseanforderung \ZE
 h\_rdone & out & 1 & std\_logic & History & Signalisiert dass Daten anliegen \ZE
 h\_read & in & 8 & character & History & enth\"alt angeforderne Daten \ZE
 
-h\_wdo & in & 1 & std\_logic & History & Signalisiert Schreibanforderung \ZE
+h\_wtake & in & 1 & std\_logic & History & Signalisiert Schreibanforderung \ZE
 h\_wdone & out & 1 & std\_logic & History & Signalisiert dass Daten anliegen \ZE
 h\_write & out & 8 & character & History & enth\"alt zu schreibende Daten \ZE
 
@@ -234,7 +217,7 @@ finished & out & 1 & std\_logic & Scanner & Auswertung fertig \ZE
 \TEND
 
 
-\paragraph{ALU}
+\subsubsection{ALU}
 %Führt die tatsächlichen Berechnungen von Addition, Subtraktion, Multiplikation und Division durch
 \THEAD
 opcode & in & 3 & enum OPS & Parser & die auszuf\"uhrende Art der Berechnung \ZE
@@ -245,48 +228,109 @@ calc\_done & out & 1 & std\_logic & Parser & Berechnung fertig \ZE
 \TEND
 
 
-\paragraph{Display}
-TODO
-%Liest einzelne Zeichen aus der History aus und leitet diese an das VGA Modul weiter, um sie in der entsprechenden Zeile anzeigen zu lassen
+\subsubsection{History}
+%Verwaltung des dahinterliegenden Buffers von vergangenen Berechnungen und der aktuellen
+%Eingabezeile, bei Aktualisierung der aktuellen Eingabezeile und bei Empfang eines Ergebnisses vom
+%Parser Modul signalisiert es das an das Display Modul
+\THEAD
+pc\_zeile & in & 7 & std\_logic\_vector & PC-Kommunikation & Zeilenadressierung (50 * 2 Zeilen = 100)\ZE
+pc\_spalte & in & 7 & std\_logic\_vector & PC-Kommunikation & Spaltenadressierung (71 Zeichen inklusive \textbackslash 0) \ZE
+pc\_get & in & 1 & std\_logic & PC-Kommunikation & Signalisiert Speicheranforderung \ZE
+pc\_done & out & 1 & std\_logic & PC-Kommunikation & Signalisiert dass Daten anliegen \ZE
+pc\_char & out & 8 & character & PC-Kommunikation & enth\"alt angeforderne Daten \ZE
+
+s\_char & in & 8 & character & Scanner & Zeichen das vom Scanner Modul \"ubernommen werden soll \ZE
+s\_take & in & 1 & std\_logic & Scanner & Signalisiert Datenfeld char \ZE
+s\_done & out & 1 & std\_logic & Scanner & Signalisiert die \"Ubernahme der Daten \ZE
+s\_backspace & in & 1 & std\_logic & Scanner & Signalisiert Backspace (letztes Zeichen im Buffer soll gel\"oscht werden) \ZE
+
+d\_new\_eingabe & out & 1 & std\_logic & Display & Fordert Display auf die Eingabe auszulesen \ZE
+d\_new\_result & out & 1 & std\_logic & Display & Fordert Display auf das Ergebnis auszulesen \ZE
+d\_zeile & in & 5 & std\_logic\_vector & Display & Zeilenadressierung ($2 * 15$ Zeilen $=30$) \ZE
+d\_spalte & in & 7 & std\_logic\_vector & Display & Spaltenadressierung (71 Zeichen inklusive \textbackslash 0) \ZE
+d\_get & in & 1 & std\_logic & Display & Signalisiert Speicheranforderung \ZE
+d\_done & out & 1 & std\_logic & Display & Signalisiert dass Daten anliegen \ZE
+d\_char & out & 8 & character & Display & enth\"alt angeforderne Daten \ZE
+
+p\_rw & in & 1 & std\_logic & Parser & 0 = read (Expression), 1 = write (Ergebnis) \ZE
+p\_spalte & in & 7 & std\_logic\_vector & Parser & Spaltenadressierung (71 Zeichen inklusive \textbackslash 0) \ZE
+p\_rget & in & 1 & std\_logic & Parser & Signalisiert Leseanforderung \ZE
+p\_rdone & out & 1 & std\_logic & Parser & Signalisiert dass Daten anliegen \ZE
+p\_read & in & 8 & character & Parser & enth\"alt angeforderne Daten \ZE
 
-allgemein: sys\_clk (in), sys\_res\_n (in)
+p\_wtake & in & 1 & std\_logic & Parser & Signalisiert Schreibanforderung \ZE
+p\_wdone & out & 1 & std\_logic & Parser & Signalisiert dass Daten anliegen \ZE
+p\_write & out & 8 & character & Parser & enth\"alt zu schreibende Daten \ZE
 
-zum modul history: 1 bit new\_eingabe (in), 1 bit new\_result (in), 5 bit zeile (2*14+1) (out), 7 bit spalte (71 zeichen - 0 am ende notwendig?) (out), 1 get bit (out), 1 done bit (in), 8 daten bits (in)
+p\_finished & in & 1 & std\_logic & Parser & Auswertung fertig \ZE
+\TEND
+\end{landscape}
 
-zum modul vga: 8 bit command (out), 32 bit command\_data (out), 1 bit free (in)
 
-\paragraph{PC-Kommunikation}
+\subsection{Verhalten der Interfaces}
+\paragraph{Erlaubte Keyboard-Eingaben}
 
-TODO
+Als erlaubte Eingabetasten werden die Ziffern \emph{`0'} bis \emph{`9'} am Numpad, die Zeichen
+\emph{`/'}, \emph{`*'}, \emph{`-'} und \emph{`+'} am Numpad, die beiden Enter-Tasten und die Backspace-Taste akzeptiert. Dabei wird auf jede gedrückte Taste nur einmal reagiert. Alle anderen Tasten auf der Tastatur werden ignoriert.
+%warum nur numpad? weil / und * dann über eine shift-kombination erreicht werden müssen und die scancode-behandlung würd ich mir nicht antun wollen
+%ob numlock gedrückt ist oder nicht sollt egal sein - ändert die scancodes nicht AFAIK
+%wird auf eine taste wirklich nur einmal reagiert wenn man z.B. die 0 hält und CTRL drückt und wieder los lässt?
 
-%Auf eine vom PC eintreffende Bufferübermittlungsanforderung oder ein Drücken des entsprechenden Board-Buttons, liest es Zeichen für Zeichen aus dem History Modul aus und leitet es an das RS232 Modul weiter
+Während eine Berechnung durchgeführt wird, sind die Tastatureingaben wirkungslos.
 
-allgemein: sys\_clk (in), sys\_res\_n (in)
+%wie wärs mit einem easter egg...
 
-ein Pin zum externen Button (in)
+\paragraph{Overflows}
+Tritt ein Overflow während der Berechnung auf -- entweder in einem Zwischenergebnis, oder im
+Endergebnis -- dann wird der Fehlerstring ``ERROR'' in der Ergebniszeile ausgegeben.
+%TODO aufwendigere fehlermeldung? zb "ERROR: OVERFLOW"
 
-zum modul rs232: 8 Empfangsbits (in), 1 Received Flag (in), 8 Sendebits (out), 1 Sendflag (out)
+\paragraph{Fehlerhafte Eingaben}
+Entspricht eine zu berechnende Eingabezeile nicht dem Format der Regular Expression aus Requirement
+Req.2, so wird der Fehlerstring ``ERROR'' in der Ergebniszeile ausgegeben.
+%TODO aufwendigere fehlermeldung? zb "ERROR: FEHLERHAFTE EINGABE"
 
-zum modul history: 5 bit zeile (2*14+1) (out), 7 bit spalte (71 zeichen - 0 am ende notwendig?) (out), 1 get bit (out), 1 done bit (in), 8 daten bits (in)
-\end{landscape}
+Liegt der Wert eines Zahlen-Literals außerhalb dem Wertebereich eines Signed Long, dann wird der
+Fehlerstring ``ERROR'' am Bildschirm ausgegeben.
+%TODO aufwendigere fehlermeldung? zb "ERROR: ZAHL ZU GROSS"
 
-\subsubsection{Verhalten der Interfaces}
+\paragraph{Bildschirm-Layout}
+Die erste Berechnung nach dem Reset f\"angt links oben an. Die Eingabezeile wandert nach der Eingabe
+von Berechnungen ``runter'', d.h. \"uber der aktuellen Eingabezeile befinden sich die Ein- bzw.
+Ausgaben der vergangenen Berechnungen. 
+Wird das Ende des Bildschirms erreicht, so wird automatisch weitergescrollt (entsprechend
+verschwinden dann vergangene Berechnungen inkl. Ergebnisse vom Bildschirm).
+%TODO vielleicht in entsprechend ähnlichem requirement etwas abstrakter werden wie in der angabe
 
-welche tasten als input erlauben (haben numblock und normale ziffern unterschiedliche scancodes?)?
+Die Eingabezeile wird ebenso dargestellt wie die Eingabe erfolgt ist (Leerzeichen werden dargestellt), von der ersten Textspalte bis zur 70.
+%TODO vielleicht vor jede zeile präfix "IN3: " / "OUT3: "?
 
-wie werden ueberlaeufe behandelt?
+Alle Textausgaben sind in weißer Schrift dargestellt.
 
-fehlerhafte eingaben?
+\paragraph{Fehlermeldungen}
+Fehlermeldungen werden als Strings wie ein korrektes Ergebnis in die entsprechende Ausgabezeile geschrieben.
 
-wie schaut die ausgabe aus?
+Fehlerhafte Eingaben und Fehlermeldungen werden ebenso am Bildschirm dargestellt wie korrekte. Bei Abfrage der History über RS232 werden daher auch fehlerhafte Ein- und Ausgaben dazugezählt.
 
-was ausgaben bei fehler?
+\paragraph{Taster}
+Bei Drücken des Buttons \emph{A} wird eine einmalige Übertragung des History-Inhalts über
+die RS232-Schnittstelle veranlasst.
+Der Taster wird sowohl beim Drücken, als auch beim Loslassen entprellt mit einer Entprellzeit von 100ms.
 
-wie kann download oder upload einer history gestartet werden?
+\paragraph{RS232}
+Die Kommunikation über RS232 erfolgt über 8N1-Codierung ohne Handshake.
 
-wie kann auf die history zugegriffen werden?
+Bei Senden des Zeichens \emph{` \textbackslash n'} vom PC an den FPGA über die RS232 Schnittstelle wird
+eine einmalige Übertragung des History-Inhalts über die RS232-Schnittstelle veranlasst, ebenso wie
+beim Drücken des Buttons \emph{A}.
+%oder doch ein anderes zeichen?
 
-soll in der eingabe auch mit pfeiltasten (links,rechts) gescrolled werden koennen?
+Der History Inhalt wird im ASCII Format über die RS232 Schnittstelle an den PC gesendet. Dabei wird
+mit der 1. Eingabe begonnen, dann die 1. Ausgabe, die 2. Eingabe usw. Die aktuelle Eingabezeile
+wird NICHT mit übertragen. Die Ein- und Ausgabezeilen werden nur bis zum letzten erlaubten
+Eingabe- bzw. Ausgabezeichen gesendet. Nach jeder Zeile folgt ein \emph{` \textbackslash n'} Zeichen.
+%TODO das format hat irgendwie anders geheißen bild ich mir ein
+%oder doch immer die volle zeilenlänge von 70 zeichen senden weil einfacher?
 
 
 \subsection{Testfälle}
@@ -297,19 +341,31 @@ alle requirements muessen von testfaellen abgedeckt werden!
 
 
 \section{Detailed Design Description}
-
-alle Module hier genauer beschreiben
-
-%TODO
-wie wollen wir das design implementieren?
-
-event sequence diagrams! UML?
-
-wie schauen interne strukturen aus? (speicher, logische bloecke, parallele prozesse, state machines)
-
 \subsection{VGA}
+siehe \textit{hwmod\_ipcores.pdf}
 
-\subsection{PS/2}
+\subsection{Display}
+\begin{figure}[!ht]
+\includegraphics[width=0.9\textwidth]{sm/display.pdf}
+\centering
+\caption{Statemachine zum Anzeigen der Daten}
+\label{fig:display}
+\end{figure}
+
+\begin{itemize}
+\item \textbf{idle}: In diesem Zustand wird die lokale Variable \emph{s}, die der Spaltenberechnung
+dient, zur\"uckgesetzt.
+\item \textbf{addr\_eingabe}: Das Modul weiss nun, dass eine neue Eingabe vorliegt, es wird daher
+aufgefordert jenige zu aktualisieren. Daf\"ur wird nun die passende Zeile berechnet (mit Hilfe der
+Variable \emph{z}).
+\item \textbf{addr\_ergebnis}: In diesem Zustand weiss das Modul, dass ein neues Resultat vorliegt,
+es muss sich also nun die Zeilennummer mit Hilfe der internen Variable \emph{z} berechnen.
+\item \textbf{read/put}: Hier wird Zeichen f\"ur Zeichen das von der berechneten Zeilen vom
+History Modul angefordert und per VGA Modul auf den Bildschirm ausgegeben. F\"ur den Fall dass nicht
+die vollen 71 Zeichen in der entsprechenden Zeile enthalten sind\footnote{ein String wird mit
+\emph{` \textbackslash 0'} abgeschlossen}, wird der Rest der Zeile am Bildschirm mit dem Leerzeichen
+\emph{` '} ausgef\"ullt.
+\end{itemize}
 
 \subsection{RS232}
 %test, TODO
@@ -320,6 +376,30 @@ wie schauen interne strukturen aus? (speicher, logische bloecke, parallele proze
 \label{fig:rs232-rs}
 \end{figure}
 
+
+\subsection{PC-Kommunikation}
+\begin{figure}[!ht]
+\includegraphics[width=0.7\textwidth]{sm/pckomm.pdf}
+\centering
+\caption{Statemachine f\"ur das Modul PC-Kommunikation}
+\label{fig:pckomm}
+\end{figure}
+
+\begin{itemize}
+\item \textbf{idle}: die internen Variablen \emph{z} und \emph{s} werden zur\"uck gesetzt. \emph{z}
+wird als Zeilencounter verwendet und \emph{s} als Spaltencounter, da der interne Speicher nach und
+nach vollst\"andig auf der seriellen Schnittstelle ausgegeben werden soll.
+\item \textbf{nzeile}: Dieser Zustand wird erreicht wenn die Ausgabe auf die RS232 Schnittstelle
+entweder durch den Button oder durch ein empfangen von einem Byte getriggert wird.
+\item \textbf{rwbyte}: Es wird das Byte an der Stelle \emph{z}/\emph{s} ausgelesen und danach an das
+RS232 Modul weitergegeben und zum PC \"ubertragen. Ist die \"Ubertragung abgeschlossen, wird der
+Spaltencounter erh\"oht.
+\end{itemize}
+
+
+\subsection{PS/2}
+siehe \textit{hwmod\_ipcores.pdf}
+
 \subsection{Scanner}
 \begin{figure}[!ht]
 \includegraphics[width=0.9\textwidth]{sm/scanner.pdf}
@@ -337,14 +417,14 @@ einen Takt lang high). Der Scanner befindet sich so lange in diesem Zustand bis
 Ergebnis berechnet hat.
 \item \textbf{l\"oschen}: Teilt dem History Modul mit das letzte Zeichen im Buffer zu l\"oschen
 (\emph{backspace} ist einen Takt lang high).
+\item \textbf{mod}: Da wir nur Zeichen des Numpads \"ubernehmen wollen, ist dieser Zwischenstate
+n\"otig.
 \item \textbf{\"ubernehmen}: Wenn ein g\"ultiges Zeichen laut Requirements eingegeben wurde, wird
 jenes Zeichen an \emph{char} angelegt und \emph{take} wird einen Takt lang high gesetzt. Das History
 Modul wird dadurch getriggert das anliegende Zeichen in den Buffer zu \"ubernehmen.
 \end{itemize}
 
 
-\subsection{History}
-
 \subsection{Parser}
 \begin{figure}[!ht]
 \includegraphics[width=0.9\textwidth]{sm/parser.pdf}
@@ -404,9 +484,9 @@ History Modul angefordert.
 
 \item \textbf{sign}: Ggf. wird das Vorzeichen auf '-' gesetzt.
 
-\item \textbf{calc}: Zeichen f\"ur Zeichen wird eingelesen und die Zahl wird daraus berechnet.
+\item \textbf{int}: Zeichen f\"ur Zeichen wird eingelesen und die Zahl wird daraus berechnet.
 
-\item \textbf{ALU}: Punkt- und Strichrechnungen m\"ussen getrennt behandelt werden, daher ergibt
+\item \textbf{calc}: Punkt- und Strichrechnungen m\"ussen getrennt behandelt werden, daher ergibt
 sich dieses Konstrukt im Codebeispiel.
 
 \item \textbf{null}: Sonderbehandlung ist n\"otig wenn die Expression mit '\textbackslash 0'
@@ -423,14 +503,47 @@ auftritt. Es wird der String ``Error'' in den Ergebnisbuffer geschrieben und
 \end{itemize}
 
 
-\subsection{Bin/Dez-Converter}
-
 \subsection{ALU}
-opcodes: NOP, ADD, MUL, DIV, DONE (als enum)
+\begin{figure}[!ht]
+\includegraphics[width=0.9\textwidth]{sm/alu.pdf}
+\centering
+\caption{Statemachine der ALU}
+\label{fig:alu}
+\end{figure}
+%TODO: eventuell zweierkomplement statt SUB?
+Folgende Opcodes werden von uns als enum definiert:
+\begin{quote}
+NOP, SUB, ADD, MUL, DIV, DONE
+\end{quote}
+wobei NOP und DONE von der ALU nicht bearbeitet werden sollen.
 
-\subsection{Display}
+In jedem State wird die entsprechende Berechnungsart durchgef\"uhrt und danach der Abschluss der
+Berechnung mit \emph{calc\_done} signalisiert. Wichtig zu beachten ist dabei, dass sich die
+Rechenoperationen in der Ausf\"uhrungszeit unterscheiden k\"onnen.
+
+
+\subsection{History}
+Dieses Modul stellt die zentrale Speicherstelle f\"ur die verschiedenen Module da.
+Die Idee ist dabei, dass intern ein RAM-Block mit mindestens der Gr\"o\ss{}e
+$(50\cdot2)*(71) = 710$ Bytes verwaltet wird.
+
+Das History Modul kann \"uber die angelegten Leitungen \emph{s\_take}, \emph{p\_rget},
+\emph{p\_wdo}, \emph{pc\_get} bzw. \emph{d\_get} feststellen welches Modul\footnote{die
+betreffendenen Module sind: Scanner, Parser, PC-Kommunikation und Display} eine Speicheranfrage
+ausf\"uhrt.
+Der Zugriff der externen Module erfolgt priorisiert:
+\begin{quote}
+Scanner > Parser > PC-Kommunikation > Display
+\end{quote}
+
+Weiters ist zu beachten, dass das History Modul f\"ur den Scanner und Parser intern einen Index
+mitspeichern muss, der die Adresse der aktuellen Eingabe mitf\"uhrt. Mit Hilfe dieses Indexes plus
+der Spaltenadressierung der Module kann die tats\"achliche Adresse f\"ur des internen RAM-Blockes
+ermittelt werden.
+
+Ist das History Modul mit der Speicheranfrage fertig, wird das andere Modul \"uber die entsprechende
+\emph{done}-Leitung benachrichtigt.
 
-\subsection{PC-Kommunikation}
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %LISTINGS