\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 ;
%\subsection{Module}
\begin{itemize}
-\item VGA - Zeichenweises Ansprechen des Monitors
-\item PS/2 - Empfangen von Keyboard-Eingaben als Scancodes
-\item RS232 - Senden und Empfangen von Nachrichten vom/zum PC über die serielle Schnittstelle % TODO. baudrate? kodierung? (8N1?)
-\item 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 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 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 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 ALU - Führt die tatsächlichen Berechnungen von Addition, Subtraktion, Multiplikation und Division durch
-\item 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 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{VGA} - Zeichenweises Ansprechen des Monitors
+\item \textbf{PS/2} - Empfangen von Keyboard-Eingaben als Scancodes
+\item \textbf{RS232} - Senden und Empfangen von Nachrichten vom/zum PC über die serielle Schnittstelle % TODO. baudrate? kodierung? (8N1?)
+\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{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
\end{itemize}
%\subsection{Interfaces}
%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!
+\begin{landscape}
\paragraph{VGA}
+siehe Tabelle \ref{tab:vga}.
-TODO: How to control the VGA component ?= schnittstelle + beschreibung des vga moduls?
+\THEAD{vga}{Interfaces f\"ur das VGA Modul}
+vga\_clk & in & 1 & std\_logic & PLL & VGA-Clock \ZE
+vga\_res\_n & in & 1 & std\_logic & PLL & VGA-Reset \ZE
-vorgegeben:
+vsync\_n & out & 1 & std\_logic & Bildschirm & Vertikale Synchronisation\ZE
+hsync\_n & out & 1 & std\_logic & Bildschirm & Horizontale Synchronisation\ZE
-allgemein: sys\_clk, sys\_res\_n
+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
-zu den hardware pins: vga\_clk, vga\_res\_n, vsync\_n, hsync\_n, ? bits r, ? bits g, ? bits b
-
-zum modul display: 8 bit command, 32 bit command\_data, 1 bit free
+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
+\TEND
\paragraph{PS/2}
vorgegeben:
-allgemein: sys\_clk, sys\_res\_n
+allgemein: sys\_clk (in), sys\_res\_n (in)
-zum modul scanner: 1 bit new\_data, 8 bit data
+zum modul scanner: 1 bit new\_data (out), 8 bit data (out)
-zu den hardware pins: 1 bit ps2\_clk, 1 bit ps2\_data
+zu den hardware pins: 1 bit ps2\_clk (in), 1 bit ps2\_data (in)
\paragraph{RS232}
%Senden und Empfangen von Nachrichten vom/zum PC über die serielle Schnittstelle
Wir brauchen:
-allgemein: sys\_clk, sys\_res\_n
-
-externe Pins für die Schnittstelle (Data carrier detect, Receive data, Transmit data, Data terminal ready, Signal ground, Data set ready, Request to send, Clear to send, Ring indicator ?brauchen wir die alle?)
+allgemein: sys\_clk (in), sys\_res\_n (in)
-zum modul pc-kommunikation: 8 Empfangsbits, 1 Received Flag, 8 Sendebits, 1 Sendflag
+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?)
-\begin{table}%
-\begin{tabular}{lcr}
-
-\end{tabular}
-\caption{}
-\label{}
-\end{table}
+zum modul pc-kommunikation: 8 Empfangsbits (out), 1 Received Flag (out), 8 Sendebits (in), 1 Sendflag (in)
\paragraph{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
-allgemein: sys\_clk, sys\_res\_n
+allgemein: sys\_clk (in), sys\_res\_n (in)
+
+von modul ps/2: 8 bit data (in), 1 bit new\_data (in)
-von modul ps/2: 8 bit data, 1 bit new\_data
+an modul history: 8 bit char (out), 1 bit take (out), 1 bit backspace (out)
-an modul history: 8 bit char, 1 bit take, 1 bit backspace, an modul parser: 1 bit do\_it
+an modul parser: 1 bit do\_it (out), 1 bit finnnnnished\_result
\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
-allgemein: sys\_clk, sys\_res\_n
+allgemein: sys\_clk (in), sys\_res\_n (in)
-zum modul pc-kommunikation: 5 bit zeile (2*14+1), 7 bit spalte (71 zeichen - 0 am ende notwendig?), 1 get bit, 1 done bit, 8 daten bits
+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)
-vom modul scanner: 8 bit char, 1 bit take, 1 bit backspace
+vom modul scanner: 8 bit char (in), 1 bit take (in), 1 bit backspace (in)
-an modul display: 1 bit new\_eingabe, 1 bit new\_result, 5 bit zeile (2*14+1), 7 bit spalte (71 zeichen - 0 am ende notwendig?), 1 get bit, 1 done bit, 8 daten bits
+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)
-an modul parser: 5 bit zeile (2*14+1), 7 bit spalte (71 zeichen - 0 am ende notwendig?), 1 get bit, 1 done bit, 8 daten bits, 8 bit write\_result, 1 bit first\_result\_char, 1 bit write\_char, ? 1 bit finnnnnished\_result (triggert fortschalten des ringpuffer pointers)
+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)
\paragraph{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
-allgemein: sys\_clk, sys\_res\_n
+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)
-zu modul history: 5 bit zeile (2*14+1), 7 bit spalte (71 zeichen - 0 am ende notwendig?), 1 get bit, 1 done bit, 8 daten bits, 8 bit write\_result, 1 bit first\_result\_char, 1 bit write\_char, ? 1 bit finnnnnished\_result (triggert fortschalten des ringpuffer pointers)
+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)
-an modul bin/dez-converter: 11*8 bit char (vorzeichen + dezimalstellen; ok, das ist ein overkill...), 32 bit binärstellen, 1 bit do\_deztobin, 1 bit do\_bintodez, 1 bit bintodez\_done, 1 bit deztobin\_done (?)
+zu modul alu: enum opcode (out), 32 bit operator1 (out), 32 bit operator2 (out/in), 1 bit do\_calc (out), 1 bit calc\_done (in)
-zu modul alu: 32 bit operator1, 32 bit operator2, 32 bit result, 1 bit do\_calc, 1 bit calc\_done
+zu modul scanner: 1 bit finnnnnished\_result (out) (selbe signal wie an history modul. kann man das
+doppelt nehmen?)
\paragraph{Bin/Dez-Converter}
%Konvertiert 10 CP850-codierte Dezimalziffern mit Vorzeichen in eine Binärzahl und umgekehrt
-allgemein: sys\_clk, sys\_res\_n
+allgemein: sys\_clk (in), sys\_res\_n (in)
-zum modul parser: 11*8 bit char (vorzeichen + dezimalstellen; ok, das ist ein overkill...), 32 bit binärstellen, 1 bit do\_deztobin, 1 bit do\_bintodez, 1 bit bintodez\_done, 1 bit deztobin\_done (?)
+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)
\paragraph{ALU}
%Führt die tatsächlichen Berechnungen von Addition, Subtraktion, Multiplikation und Division durch
-allgemein: sys\_clk, sys\_res\_n
+allgemein: sys\_clk (in), sys\_res\_n (in)
-zum parser: 32 bit operator1, 32 bit operator2, 32 bit result, 1 bit do\_calc, 1 bit calc\_done
+zum parser: enum opcode (in), 32 bit operator1 (in), 32 bit operator2 (in/out), 1 bit do\_calc (in), 1 bit calc\_done (out)
\paragraph{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
-allgemein: sys\_clk, sys\_res\_n
+allgemein: sys\_clk (in), sys\_res\_n (in)
-zum modul history: 1 bit new\_eingabe, 1 bit new\_result, 5 bit zeile (2*14+1), 7 bit spalte (71 zeichen - 0 am ende notwendig?), 1 get bit, 1 done bit, 8 daten bits
+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)
-zum modul vga: 8 bit command, 32 bit command\_data, 1 bit free
+zum modul vga: 8 bit command (out), 32 bit command\_data (out), 1 bit free (in)
\paragraph{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
-allgemein: sys\_clk, sys\_res\_n
+allgemein: sys\_clk (in), sys\_res\_n (in)
-ein Pin zum externen Button
+ein Pin zum externen Button (in)
-zum modul rs232: 8 Empfangsbits, 1 Received Flag, 8 Sendebits, 1 Sendflag
+zum modul rs232: 8 Empfangsbits (in), 1 Received Flag (in), 8 Sendebits (out), 1 Sendflag (out)
-zum modul history: 5 bit zeile (2*14+1), 7 bit spalte (71 zeichen - 0 am ende notwendig?), 1 get bit, 1 done bit, 8 daten bits
+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}
\subsubsection{Verhalten der Interfaces}
alle requirements muessen von testfaellen abgedeckt werden!
+%29 zeilen am bildschirm
+
\section{Detailed Design Description}
\label{fig:rs232-rs}
\end{figure}
+\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}
+
+\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{\"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}
+\centering
+\caption{Statemachine zum Parsen der aktuellen Expression}
+\label{fig:parser}
+\end{figure}
+
+\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;
+}
+
+procedure c1() {
+ if(aktop in ['+','-','\0']) {
+ alu(ADD, z, strich);
+ }
+ else if (aktop in ['*','/']) {
+ alu(MUL, z, punkt);
+ }
+}
+\end{lstlisting}
+
+\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.
+
+\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{ALU}: 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'
+abgeschlossen wird.
+
+\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{finnnnnished\_result} f\"ur einen Zyklus auf high gesetzt.
+
+\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{finnnnnished\_result} wird f\"ur einen Zyklus auf high gesetzt.
+\end{itemize}
+
+
+\subsection{Bin/Dez-Converter}
+
+\subsection{ALU}
+opcodes: NOP, ADD, MUL, DIV, DONE (als enum)
-\subsection{Control}
+\subsection{Display}
+\subsection{PC-Kommunikation}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%LISTINGS
projects / hwmod.git / blobdiff