\section{Requirement Spezifikation}
-TODO: in der Angabe steht nix von einer extrigen Requirement Spezifikation neben der High Level Beschreibung, aber im Template und Auf den Folien ist es als 3. Punkt neben High- und Low Level Spec noch erwähnt.
-
-Die Subsections sind vielleicht ein kleiner Overshoot.
+%TODO: in der Angabe steht nix von einer extrigen Requirement Spezifikation neben der High Level Beschreibung, aber im Template und Auf den Folien ist es als 3. Punkt neben High- und Low Level Spec noch erwähnt.
+%
+%Die Subsections sind vielleicht ein kleiner Overshoot.
\subsection{Eingabe}
DIGIT = '0' \textbar '1' \textbar '2' \textbar '3' \textbar '4' \textbar '5' \textbar '6' \textbar '7' \textbar '8' \textbar '9' ;
-UNSIGNED = DIGIT { DIGIT } ;
+UNSIGNED = DIGIT \{ DIGIT \} ;
OPERAND = ['-'] UNSIGNED ;
\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}
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}
-
-%Bla:
-%
-%ps/2 schickt zeichen an controller, der nimmt nur gewünschte chars und schreibt die in die history
-%in die editierbare ``eingabezeile''.
-%
-%dann bei einem "enter" sagt er dem parser dass der was hackeln soll
-%
-%der holt sich selbstständig den string aus der history und analysiert ihn mal - also ob es ein gültiger string ist
-%
-%dann brauchen wir schleifen, eine äußere für die strichrechnung und eine innere für die punktrechnung (k.a. wie das in vhdl geht)
-%
-%jedenfalls müssen bei z.b. a + b * c die b*c zuerst ausgerechnet werden
-%
-%diese einzelnen rechnungen - also z.b. b*c - schickt der parser an die alu die das ausrechnet und dann asynchron an den parser zurückschickt - das geht so lange weiter bis der ganze string abgearbeitet ist
-%
-%der parser muss bei den zwischenrechnungen die zwischenergebnisse im speicher behalten
-%
-%wenn er fertig ist liefert er das ergebnis an die history und benachrichtigt den controller dass er fertig ist
-%
-%achja, die zahlen zur/von der history muss der parser zum converter schicken - das geht leider nicht als zwischenstufe zwischen parser und history weil der parser sich einen erst zu analysierenden string von der history holt - es ist auch nicht sinnvoll zwischen alu und parser, weil zwischenergebnisse nicht neu umgewandelt werden müssen
-%
-%der controller verursacht dann den zeilenvorschub um 2 zeilen in der history (ringpuffer, index vorandrehen). eigentlich braucht der controller dem display modul nichts mitteilen, oder?
-%
-%es sollte vielleicht der controller das display modul veranlasen sich die daten aus der history zu holen (könnte auch die history)
-%
-%TODO Module soll der Parser in einer "`Schleife"' alle Teilberechnungen an die ALU weiterleiten und zB Zwischenergebnisse speichern? Die ALU könnte dann nur 2 Zahlen addieren/bla.
-%Da in der History Zahlen als Character Strings abgelegt sind müssen diese für die ALU in Binärdarstellung umgewandelt werden - und Umgekehrt natürlich!
-
-\paragraph{VGA}
-
-TODO: How to control the VGA component ?= schnittstelle + beschreibung des vga moduls?
-
-vorgegeben:
-
-allgemein: sys\_clk (in), sys\_res\_n (in)
-zu den hardware pins: vga\_clk (in), vga\_res\_n (in), vsync\_n (out), hsync\_n (out), ? bits r (out), ? bits g (out), ? bits b (out)
+\begin{landscape}
+\subsection{Logische und physikalische Interfaces}
-zum modul display: 8 bit command (in), 32 bit command\_data (in), 1 bit free (out)
+\subsubsection{VGA}
+\THEAD
+vga\_clk & in & 1 & std\_logic & PLL & VGA-Clock \ZE
+vga\_res\_n & in & 1 & std\_logic & PLL & VGA-Reset \ZE
-\paragraph{PS/2}
+vsync\_n & out & 1 & std\_logic & Bildschirm & Vertikale Synchronisation\ZE
+hsync\_n & out & 1 & std\_logic & Bildschirm & Horizontale Synchronisation\ZE
-ebenso hier?
+r & out & 3 & std\_logic\_vector & Bildschirm & Ausgabe der Farbe Rot \ZE
+g & out & 3 & std\_logic\_vector & Bildschirm & Ausgabe der Farbe Gr\"un \ZE
+b & out & 2 & std\_logic\_vector & Bildschirm & Ausgabe der Farbe Blau \ZE
-vorgegeben:
+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 & out & 1 & std\_logic & Display & Signalisiert Bereitschaft \ZE
+\TEND
-allgemein: sys\_clk (in), sys\_res\_n (in)
-
-zum modul scanner: 1 bit new\_data (out), 8 bit data (out)
-
-zu den hardware pins: 1 bit ps2\_clk (in), 1 bit ps2\_data (in)
-
-\paragraph{RS232}
-
-TODO
+\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\_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
+
+
+\subsubsection{RS232}
%Senden und Empfangen von Nachrichten vom/zum PC über die serielle Schnittstelle
-Wir brauchen:
-
-allgemein: sys\_clk (in), sys\_res\_n (in)
+\THEAD
+rxd & in & 1 & std\_logic & PC & Sendeleitung der seriellen \"Ubertragung \ZE
+txd & out & 1 & std\_logic & PC & Empfangsleitung der seriellen \"Ubertragung \ZE
-externe Pins für die Schnittstelle (Data carrier detect, Receive data (in), Transmit data (out), Data terminal ready, Signal ground, Data set ready, Request to send, Clear to send, Ring indicator ?brauchen wir die alle?)
+rx\_data & out & 8 & std\_logic\_vector & PC-Kommunikation & Datenfeld f\"ur das Empfangen \ZE
+rx\_new & out & 1 & std\_logic & PC-Kommunikation & Signalisiert ein neu empfangendes Byte \ZE
-zum modul pc-kommunikation: 8 Empfangsbits (out), 1 Received Flag (out), 8 Sendebits (in), 1 Sendflag (in)
+tx\_data & out & 8 & std\_logic\_vector & PC-Kommunikation & Datenfeld f\"ur das \"Ubertragen \ZE
+tx\_new & out & 1 & std\_logic & PC-Kommunikation & Signalisiert dass das anliegende Byte gesendet werden soll \ZE
+\TEND
-\begin{table}%
-\begin{tabular}{lcr}
-\end{tabular}
-\caption{}
-\label{}
-\end{table}
-
-\paragraph{Scanner}
-
-TODO
-
-%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
-
-allgemein: sys\_clk (in), sys\_res\_n (in)
-
-von modul ps/2: 8 bit data (in), 1 bit new\_data (in)
-
-an modul history: 8 bit char (out), 1 bit take (out), 1 bit backspace (out)
-
-an modul parser: 1 bit do\_it (out)
+\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
-\paragraph{History}
+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
-TODO
+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
-%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
-allgemein: sys\_clk (in), sys\_res\_n (in)
+\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
-zum modul pc-kommunikation: 5 bit zeile (2*14+1) (in), 7 bit spalte (71 zeichen - 0 am ende notwendig?) (in), 1 get bit (in), 1 done bit (out), 8 daten bits (out)
+ps2\_clk & inout & 1 & std\_logic & Tastatur & Clockleitung zum Keyboard \ZE
+ps2\_data & inout & 1 & std\_logic & Tastatur & Datenleitung zum Keyboard \ZE
+\TEND
-vom modul scanner: 8 bit char (in), 1 bit take (in), 1 bit backspace (in)
-an modul display: 1 bit new\_eingabe (out), 1 bit new\_result (out), 5 bit zeile (2*14+1) (in), 7 bit spalte (71 zeichen - 0 am ende notwendig?) (in), 1 get bit (in), 1 done bit (out), 8 daten bits (out)
+\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
+data & in & 8 & std\_logic\_vector & PS/2 & Scancode laut Codepage 850 \ZE
-an modul parser: 5 bit zeile (2*14+1) (in), 7 bit spalte (71 zeichen - 0 am ende notwendig?) (in), 1 get bit (in), 1 done bit (out), 8 daten bits (out), 8 bit write\_result (in), 1 bit first\_result\_char (in), 1 bit write\_char (in), ? 1 bit finnnnnished\_result (triggert fortschalten des ringpuffer pointers) (in)
+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
-\paragraph{Parser}
+do\_it & out & 1 & std\_logic & Parser & Auswertung beginnen (ENTER) \ZE
+finished & in & 1 & std\_logic & Parser & Auswertung fertig \ZE
+\TEND
-TODO
+\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 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
-allgemein: sys\_clk (in), sys\_res\_n (in)
-
-zu 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), 8 bit write\_result (in), 1 bit first\_result\_char (out), 1 bit write\_char (out), ? 1 bit finnnnnished\_result (triggert fortschalten des ringpuffer pointers) (out)
-
-an modul bin/dez-converter: 11*8 bit char (vorzeichen + dezimalstellen; ok, das ist ein overkill...) (in/out), 32 bit binärstellen (in/out), 1 bit do\_deztobin (out), 1 bit do\_bintodez (out), 1 bit bintodez\_done (in), 1 bit deztobin\_done (?) (in)
-
-zu modul alu: 32 bit operator1 (out), 32 bit operator2 (out), 32 bit result (in), 1 bit do\_calc (out), 1 bit calc\_done (in)
-
-\paragraph{Bin/Dez-Converter}
-
-TODO
+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
-%Konvertiert 10 CP850-codierte Dezimalziffern mit Vorzeichen in eine Binärzahl und umgekehrt
+h\_finished & in & 1 & std\_logic & History & Auswertung fertig \ZE
-allgemein: sys\_clk (in), sys\_res\_n (in)
+opcode & out & 3 & enum OPS & ALU & die auszuf\"uhrende Art der Berechnung \ZE
+op1 & out & 32 & SIGNED(32-1 downto 0) & ALU & erste Operand \ZE
+op2 & inout & 32 & SIGNED(32-1 downto 0) & ALU & zweite Operand und gleichzeitig der Zieloperand \ZE
+do\_calc & out & 1 & std\_logic & ALU & Signalisert Berechnungstart \ZE
+calc\_done & in & 1 & std\_logic & ALU & Berechnung fertig \ZE
-zum modul parser: 11*8 bit char (vorzeichen + dezimalstellen; ok, das ist ein overkill...) (in/out), 32 bit binärstellen (in/out), 1 bit do\_deztobin (in), 1 bit do\_bintodez (in), 1 bit bintodez\_done (out), 1 bit deztobin\_done (?) (out)
+do\_it & in & 1 & std\_logic & Scanner & Auswertung beginnen (ENTER) \ZE
+finished & out & 1 & std\_logic & Scanner & Auswertung fertig \ZE
+\TEND
-\paragraph{ALU}
-
-TODO
+\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
+op1 & in & 32 & SIGNED(32-1 downto 0) & Parser & erste Operand \ZE
+op2 & inout & 32 & SIGNED(32-1 downto 0) & Parser & zweite Operand und gleichzeitig der Zieloperand \ZE
+do\_calc & in & 1 & std\_logic & Parser & Signalisert Berechnungstart \ZE
+calc\_done & out & 1 & std\_logic & Parser & Berechnung fertig \ZE
+\TEND
+
+
+\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
+
+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
+
+p\_finished & in & 1 & std\_logic & Parser & Auswertung fertig \ZE
+\TEND
+\end{landscape}
+
+
+\subsection{Verhalten der Interfaces}
+\paragraph{Erlaubte Keyboard-Eingaben}
+
+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?
+
+Während eine Berechnung durchgeführt wird, sind die Tastatureingaben wirkungslos.
+
+%wie wärs mit einem easter egg...
+
+\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"
+
+\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"
+
+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"
+
+\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
+
+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: "?
+
+Alle Textausgaben sind in weißer Schrift dargestellt.
+
+\paragraph{Fehlermeldungen}
+Fehlermeldungen werden als Strings wie ein korrektes Ergebnis in die entsprechende Ausgabezeile geschrieben.
+
+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.
+
+\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.
-allgemein: sys\_clk (in), sys\_res\_n (in)
-
-zum parser: 32 bit operator1 (in), 32 bit operator2 (in), 32 bit result (out), 1 bit do\_calc (in), 1 bit calc\_done (out)
-
-\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
+\paragraph{RS232}
+Die Kommunikation über RS232 erfolgt über 8N1-Codierung ohne Handshake.
-allgemein: sys\_clk (in), sys\_res\_n (in)
+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?
-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)
+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?
-zum modul vga: 8 bit command (out), 32 bit command\_data (out), 1 bit free (in)
-\paragraph{PC-Kommunikation}
+\subsection{Testfälle}
-TODO
+alle requirements muessen von testfaellen abgedeckt werden!
-%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
+%29 zeilen am bildschirm
-allgemein: sys\_clk (in), sys\_res\_n (in)
-ein Pin zum externen Button (in)
+\section{Detailed Design Description}
+\subsection{VGA}
+siehe \textit{hwmod\_ipcores.pdf}
-zum modul rs232: 8 Empfangsbits (in), 1 Received Flag (in), 8 Sendebits (out), 1 Sendflag (out)
+\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}
-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)
+\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}
-\subsubsection{Verhalten der Interfaces}
+\subsection{RS232}
+%test, TODO
+\begin{figure}[!ht]
+\includegraphics[width=0.9\textwidth]{sm/rs232-rs.pdf}
+\centering
+\caption{Statemachine zum Empfangen auf der RS232 Schnittstelle (8N1)}
+\label{fig:rs232-rs}
+\end{figure}
-welche tasten als input erlauben (haben numblock und normale ziffern unterschiedliche scancodes?)?
-wie werden ueberlaeufe behandelt?
+\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}
-fehlerhafte eingaben?
+\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}
-wie schaut die ausgabe aus?
-was ausgaben bei fehler?
+\subsection{PS/2}
+siehe \textit{hwmod\_ipcores.pdf}
-wie kann download oder upload einer history gestartet werden?
+\subsection{Scanner}
+\begin{figure}[!ht]
+\includegraphics[width=0.9\textwidth]{sm/scanner.pdf}
+\centering
+\caption{Statemachine zum Scannen des Inputs der PS/2 Schnittstelle}
+\label{fig:scanner}
+\end{figure}
-wie kann auf die history zugegriffen werden?
+\begin{itemize}
+\item \textbf{idle}: Setz alle Steuersignale \emph{backspace}, \emph{take} und \emph{do\_it} low.
+\item \textbf{read}: Bei steigender Flanke auf \emph{new\_data} wird das anliegende Byte des
+PS/2-Modules \"ubernommen. Je nach Wert wird in den n\"achsten Zustand gewechselt.
+\item \textbf{enter}: Wurde die Entertaste gedr\"uckt wird der Parser getriggert (\emph{do\_it} ist
+einen Takt lang high). Der Scanner befindet sich so lange in diesem Zustand bis der Parser das
+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}
-soll in der eingabe auch mit pfeiltasten (links,rechts) gescrolled werden koennen?
+\subsection{Parser}
+\begin{figure}[!ht]
+\includegraphics[width=0.9\textwidth]{sm/parser.pdf}
+\centering
+\caption{Statemachine zum Parsen der aktuellen Expression}
+\label{fig:parser}
+\end{figure}
-\subsection{Testfälle}
+\begin{lstlisting}
+procedure exec() {
+ z := z*s;
+ switch(opp) {
+ case NOP:
+ if(aktop != '\0')
+ c1();
+ break;
+ case '-':
+ z := z * (-1);
+ case '+':
+ c1();
+ break;
+
+ case '/':
+ case '*':
+ if(aktop in ['+','-','\0']) {
+ alu(opp, z, punkt);
+ do_calc = 1;
+ while(calc_done == 0);
+
+ alu(ADD, punkt, strich);
+ punkt = 1;
+ }
+ else if (aktop in ['*','/']) {
+ alu(opp, z, punkt);
+ }
+ break;
+ }
+ do_calc = 1;
+ opp = aktop;
+}
-alle requirements muessen von testfaellen abgedeckt werden!
+procedure c1() {
+ if(aktop in ['+','-','\0']) {
+ alu(ADD, z, strich);
+ }
+ else if (aktop in ['*','/']) {
+ alu(MUL, z, punkt);
+ }
+}
+\end{lstlisting}
-%29 zeilen am bildschirm
+\begin{itemize}
+\item \textbf{idle}: Das Modul ist unt\"atig und wartet auf eine steigende Flanke von \emph{do\_it}.
+\item \textbf{read char}: Lokale Variablen werden zur\"uckgesetzt und das n\"achste Zeichen wird vom
+History Modul angefordert.
-\section{Detailed Design Description}
+\item \textbf{sign}: Ggf. wird das Vorzeichen auf '-' gesetzt.
-alle Module hier genauer beschreiben
+\item \textbf{int}: Zeichen f\"ur Zeichen wird eingelesen und die Zahl wird daraus berechnet.
-%TODO
-wie wollen wir das design implementieren?
+\item \textbf{calc}: Punkt- und Strichrechnungen m\"ussen getrennt behandelt werden, daher ergibt
+sich dieses Konstrukt im Codebeispiel.
-event sequence diagrams! UML?
+\item \textbf{null}: Sonderbehandlung ist n\"otig wenn die Expression mit '\textbackslash 0'
+abgeschlossen wird.
-wie schauen interne strukturen aus? (speicher, logische bloecke, parallele prozesse, state machines)
+\item \textbf{done}: In diesem Zustand wird das Ergebnis das sich je nach \emph{opp} in
+\emph{strich} oder \emph{punkt} befindet als String in den Ergebnisbuffer des History Modules
+geschrieben und danach wird \emph{finished} f\"ur einen Zyklus auf high gesetzt.
-\subsection{VGA}
+\item \textbf{error}: Zwecks \"Ubersichtlichkeit wurden die Transitionen zu diesem Zustand
+vernachl\"assigt. Dieser Zustand wird erreicht sobald ein Grammatikfehler oder ein Fehler der ALU
+auftritt. Es wird der String ``Error'' in den Ergebnisbuffer geschrieben und
+\emph{finished} wird f\"ur einen Zyklus auf high gesetzt.
+\end{itemize}
-\subsection{PS/2}
-\subsection{RS232}
-%test, TODO
+\subsection{ALU}
\begin{figure}[!ht]
-\includegraphics[width=0.9\textwidth]{sm/rs232-rs.pdf}
+\includegraphics[width=0.9\textwidth]{sm/alu.pdf}
\centering
-\caption{Statemachine zum Empfangen auf der RS232 Schnittstelle (8N1)}
-\label{fig:rs232-rs}
+\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{History}
+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{Parser}
-\subsection{Control}
+\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.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
projects / hwmod.git / blobdiff