spec/alu: extriges register fuer ergebnis

[hwmod.git] / spec / speck.tex

\documentclass[12pt,a4paper,titlepage,oneside]{article}
%\documentclass[12pt,a4paper,titlepage,oneside]{report}

\usepackage{ProtocolHeader}

\begin{document}
\MakeTitleAndTOC

%\chapter %for use with report class
\section
{Einleitung}

Es ist ein einfacher Taschenrechner, der die Grundrechnungsarten Addition, Subtraktion,
Multiplikation und Division beherrscht, auf einem FPGA Board zu realisieren. Dabei soll als Eingabegerät eine PS/2
Tastatur beziehungsweise als Ausgabegerät ein VGA Monitor dienen. Als zusätzliches Feature soll eine
History eingebaut werden, sodass vergangene Berechnungen angezeigt werden
können. Außerdem besteht die Möglichkeit diese History per RS232-Schnittstelle zu
exportieren bzw. importieren.

\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.


\subsection{Eingabe}

\req{Der Taschenrechner soll eine Eingabe bestehend aus den Ziffern '0'-'9', Leerzeichen ' ', '+', '-', '*' und '/' ausrechnen können}

\req{Der Syntax für so eine Eingabe - eine \textbf{Expression} - sieht folgendermaßen aus:

DIGIT = '0' \textbar '1' \textbar '2' \textbar '3' \textbar '4' \textbar '5' \textbar '6' \textbar '7' \textbar '8' \textbar '9' ;

UNSIGNED = DIGIT \{ DIGIT \} ;

OPERAND = ['-'] UNSIGNED ;

OPERATOR = '+' \textbar '-' \textbar '*' \textbar '/' ;

EXPRESSION = OPERAND \{ OPERATOR OPERAND \} ;
}

\req{Dabei soll Punkt- vor Strichrechnung gelten}

\req{Die Zahlen dürfen im Zahlenbereich eines signed long liegen ($-2^{31}$ bis $2^{31}-1$)}

\req{Die Eingabe darf aus 70 Zeichen bestehen}

\req{Die Eingabe erfolgt über eine PS/2-Tastatur, 'Enter' schließt die Eingabe ab und berechnet das Ergebnis, 'Backspace' löscht das zuletzt eingegebene Zeichen}

\subsection{Ausgabe}

\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 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}

\subsection{History}

\req{Die letzten 50 Ein- und Ausgaben korrekter Eingaben werden als History im Speicher gehalten}

\req{Die History soll über RS232, auf Anfrage vom PC, oder bei Betätigen eines Buttons am Development Board, zum PC gesendet werden}


\section{High-Level Design Description}

\begin{figure}[!ht]
\includegraphics[width=\textwidth]{Architektur.png}
\centering
\caption{Die Architektur des Taschenrechners}
\label{fig:arch}
\end{figure}

In Abbildung \ref{fig:arch} ist der Aufbau des Taschenrechners zu sehen. Der Taschenrechner besteht aus folgenden Modulen:

\begin{itemize}
\item \textbf{VGA} - Zeichenweises Ansprechen des Monitors
\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{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{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}


\begin{landscape}
\subsection{Logische und physikalische Interfaces}

\subsubsection{VGA}
\THEAD
vga\_clk & in & 1 & std\_logic & PLL & VGA-Clock \ZE
vga\_res\_n & in & 1 & std\_logic & PLL & VGA-Reset \ZE

vsync\_n & out & 1 & std\_logic & Bildschirm & Vertikale Synchronisation\ZE
hsync\_n & out & 1 & std\_logic & Bildschirm & Horizontale Synchronisation\ZE

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

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

\newpage
\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

\newpage
\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
txd & out & 1 & std\_logic & PC & Empfangsleitung der seriellen \"Ubertragung \ZE

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

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

\newpage
\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


\newpage
\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
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
finished & in & 1 & std\_logic & Parser & Auswertung fertig \ZE
\TEND


\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

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

h\_finished & in & 1 & std\_logic & History & Auswertung fertig \ZE

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 & out & 32 & SIGNED(32-1 downto 0) & ALU & zweite Operand \ZE
op3 & in & 32 & SIGNED(32-1 downto 0) & ALU & Zieloperand \ZE
do\_calc & out & 1 & std\_logic & ALU & Signalisert Berechnungstart \ZE
calc\_done & in & 1 & std\_logic & ALU & Berechnung fertig \ZE

do\_it & in & 1 & std\_logic & Scanner & Auswertung beginnen (ENTER) \ZE
finished & out & 1 & std\_logic & Scanner & Auswertung fertig \ZE
\TEND


\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 & in & 32 & SIGNED(32-1 downto 0) & ALU & zweite Operand \ZE
op3 & out & 32 & SIGNED(32-1 downto 0) & ALU & 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 \"uber RS232 werden daher auch fehlerhafte Ein- und Ausgaben dazugez\"ahlt.

\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.

\paragraph{RS232}
Die Kommunikation über RS232 erfolgt über 8N1-Codierung ohne Handshake.

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?

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.

\subsection{Testf\"alle}
\tcc{$9*55*-6+3000/2-1-1-1*50\text{\textasciicircum B}00 = -1972 $}
Erf\"ullt \textbf{Req 1, 2, 3, 6}

\tcc{$9---2 \Rightarrow$ Err}
Erf\"ullt \textbf{Req 2}

\tcc{$-2147483648 + 1 = -2147483647$}
Erf\"ullt \textbf{Req 4}

\tcc{$-2147483649 + 1 \Rightarrow$ Err}
Erf\"ullt \textbf{Req 4}

\tcc{$2147483647 - 1 = 2147483646$}
Erf\"ullt \textbf{Req 4}

\tcc{$2147483644 + 100 \Rightarrow$ Err}
Erf\"ullt \textbf{Req 4}

\tcc{$1 +1 + 1 +1 + 1 +1 + 1 +1 + 1 +1 + 1 +1 + 1 +1 + 1 +1 + 1 +1 + 1 +1 + 2 +2 + 2 + 1
\Rightarrow$ ab dem ersten `2'er soll die Eingabe verweigert werden (man beachte die Leerzeichen)}
Erf\"ullt \textbf{Req 5}

\tcc{Es sollen 20 Rechnungen eingegeben werden (ob g\"ultig oder nicht spielt dabei keine Rolle).
Ab der 15. Berechnung soll ein Scrollen des Bildschirms festgestellt werden k\"onnen.}
Erf\"ullt \textbf{Req 7, 8, 9}

\tcc{Es sollen 52 Berechnungen der Art $i + i\text{<ENTER>}$ eingegeben werden, wobei $i$ der
aktuellen Berechnung entspricht. Danach soll eine RS232 \"Ubertragung (einmal per Button und einmal
per PC) in Gang gesetzt werden. Am PC sollen nur die letzten 50 Berechnungen ersichtlich sein.}
Erf\"ullt \textbf{Req 10, 11}

\section{Detailed Design Description}
\subsection{VGA}
siehe \textit{hwmod\_ipcores.pdf}

\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}
Es soll eine Baudrate von 115200 bauds und die 8N1 Codierung (8bit Daten, keine Parity und ein
Stopbit) verwendet werden. Da das FPGA Design um ein Vielfaches schneller als 115200Hz \footnote{
n\"amlich $33.33$MHz} ist muss bei der Implementierung zus\"atzlich ein Taktgeber f\"ur das RS232
Modul implementiert werden um BT zu erzeugen (BT steht dabei f\"ur BitTime), das soll mit einem
Takteiler realisiert werden. Ausserdem ist zu beachten dass das LSB zuerst geschickt wird.

\begin{figure}[!ht]
\includegraphics[width=0.9\textwidth]{sm/rs232-rs.pdf}
\centering
\caption{Statemachine des RS232 Modules zum Empfangen von Daten}
\label{fig:rs232rx}
\end{figure}
\begin{itemize}
\item \textbf{idle}: die lokale Variable \emph{bc} wird zur\"uckgesetzt.
\item \textbf{read startbit}: Eine fallende Flanke auf \emph{rxd} signalisiert dass eine
Byte\"ubertragung beginnt.
\item \textbf{read}: In diesem State werden die Datenbits nacheinander \"uber \emph{rxd} empfangen.
\item \textbf{read stopbit}: Um das Ende einer Byte\"ubertragung zu signalisieren wird \emph{rxd}
auf high gesetzt. Dadurch weiss das RS232 Modul bescheid dass die Byte\"ubertragung zu ende ist und
kann dem PC-Kommunikation Modul signalisieren, dass ein Byte vollst\"andig empfangen wurde.
\end{itemize}


\begin{figure}[!ht]
\includegraphics[width=0.9\textwidth]{sm/rs232-ts.pdf}
\centering
\caption{Statemachine des RS232 Modules zum Senden von Daten}
\label{fig:rs232tx}
\end{figure}
\begin{itemize}
\item \textbf{idle}: die lokale Variable \emph{bc} wird zur\"uckgesetzt.
\item \textbf{write startbit}: Um eine \"Ubertragung in Gang zu setzen muss \emph{txd} auf low
gesetzt werden.
\item \textbf{write}: In diesem State werden die Datenbits nacheinander an \emph{txd} angelegt.
\item \textbf{write stopbit}: Um das Ende einer Byte\"ubertragung zu signalisieren muss \emph{txd}
auf high gesetzt werden.
\end{itemize}


\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}
\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{mod}: Da wir nur Zeichen des Numpads \"ubernehmen wollen, ist dieser Zwischenstate
n\"otig, da Scancodes vom Numpad einen Modifier mitschicken (\emph{0xe0}).
\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{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{int}: Zeichen f\"ur Zeichen wird eingelesen und die Zahl wird daraus berechnet.

\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'
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{finished} 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{finished} wird f\"ur einen Zyklus auf high gesetzt.
\end{itemize}


\subsection{ALU}
\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.

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.


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%LISTINGS
%\newpage
%\appendix
%\section{Listings}
%howto include src files
%\subsection{einfache Variante -- generierter Sourcecode}
%\label{att:einfachsrc}
%\lstinputlisting{../einfach/einfach.src}
%\lstinputlisting[firstnumber=24, firstline=24, lastline=34]{bla.src} %firstnumber shouldn't be necessary, but there is probably a bug

\end{document}