\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{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{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.
\begin{landscape}
-\subsubsection{Logische Interfaces der Module}
+\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
free & out & 1 & std\_logic & Display & Signalisiert Bereitschaft \ZE
\TEND
-
-\paragraph{Display}
+\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 & Fordert History auf die Eingabe auszulesen \ZE
-new\_result & in & 1 & std\_logic & History & Fordert History auf das Ergebnis auszulesen \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 Ziechen inklusive \textbackslash 0) \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
free & in & 1 & std\_logic & VGA & Signalisiert Bereitschaft \ZE
\TEND
-
-\paragraph{RS232}
+\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
tx\_new & out & 1 & std\_logic & PC-Kommunikation & Signalisiert dass das anliegende Byte gesendet werden soll \ZE
\TEND
-
-\paragraph{PC-Kommunikation}
+\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 & in & 1 & std\_logic & externer Button & zum Triggern der RS232 Kommunikation \ZE
+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
\TEND
-\paragraph{PS/2}
+\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
\TEND
-\paragraph{Scanner}
+\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
\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
\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
\TEND
-\paragraph{History}
+\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
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\_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 Ziechen inklusive \textbackslash 0) \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
\end{landscape}
-\subsubsection{Verhalten der Interfaces}
+\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...
-welche tasten als input erlauben (haben numblock und normale ziffern unterschiedliche scancodes?)?
+\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"
-wie werden ueberlaeufe behandelt?
+\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"
-fehlerhafte eingaben?
+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"
-wie schaut die ausgabe aus?
+\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
-was ausgaben bei fehler?
+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 kann download oder upload einer history gestartet werden?
+Alle Textausgaben sind in weißer Schrift dargestellt.
-wie kann auf die history zugegriffen werden?
+\paragraph{Fehlermeldungen}
+Fehlermeldungen werden als Strings wie ein korrektes Ergebnis in die entsprechende Ausgabezeile geschrieben.
-soll in der eingabe auch mit pfeiltasten (links,rechts) gescrolled werden koennen?
+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.
+
+\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.
+%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}
\section{Detailed Design Description}
-
\subsection{VGA}
-TODO: not our business?
+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}
-%test, TODO
+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 zum Empfangen auf der RS232 Schnittstelle (8N1)}
-\label{fig:rs232-rs}
+\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}
-TODO: not our business?
+\subsection{PS/2}
+siehe \textit{hwmod\_ipcores.pdf}
\subsection{Scanner}
\begin{figure}[!ht]
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.
\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.
+
+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.
projects / hwmod.git / blobdiff