one goes in, one goes out
[hwmod.git] / spec / spec.tex
index 68dd72281640d05b3b5afc4e08b8475787640f69..9b0e59dc2bcff25e35d6faa616307865771636c5 100644 (file)
@@ -24,9 +24,6 @@ TODO: in der Angabe steht nix von einer extrigen Requirement Spezifikation neben
 Die Subsections sind vielleicht ein kleiner Overshoot.
 
 
-%TODO
-wie schaut syntax aus der eingabe? 
-
 \subsection{Eingabe}
 
 \req{Der Taschenrechner soll eine Eingabe bestehend aus den Ziffern '0'-'9', Leerzeichen ' ', '+', '-', '*' und '/' ausrechnen können}
@@ -54,7 +51,11 @@ EXPRESSION = OPERAND \{ OPERATOR OPERAND \} ;
 
 \subsection{Ausgabe}
 
-\req{Die Anzeige der Ein- und Ausgaben erfolgt über einen VGA Monitor. 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{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{Auf die in zuvor angegebene Methode sollen zusätzlich zur aktuellen Eingabezeile die letzten 14 Ein- und Ausgaben dargestellt werden}
 
 \subsection{History}
 
@@ -74,46 +75,19 @@ EXPRESSION = OPERAND \{ OPERATOR OPERAND \} ;
 
 In Abbildung \ref{fig:arch} ist der Aufbau des Taschenrechners zu sehen. Der Taschenrechner besteht aus folgenden Modulen:
 
-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!
-
 %\subsection{Module}
 
 \begin{itemize}
-\item VGA - Ansprechen des Monitors
-\item PS/2 - Empfangen von Keyboard-Eingaben
-\item RS232 - Senden und Empfangen von Nachrichten vom/zum PC TODO. baudrate? kodierung? (8N1?)
-\item Historymodul - Verwaltung des dahinterliegenden Buffers von vergangenen Berechnungen
-\item Displaycontroller - Veranlasst das VGA Modul, einen Teil der History am Monitor anzuzeigen
-\item Parser - wertet ein gegeben Buffer aus und liefert entweder einen Fehler zurück oder gibt die einzelnen Berechnungen von je zwei Zahlen (?) an die ALU weiter
-\item Converter - konvertiert Dezimalzahlen in Binärzahlen und umgekehrt TODO oder in Parser integrieren? Oder gibt's eine Library-Funktion dafür?
-\item ALU - führt die tatsächlichen Berechnungen durch
-\item Controlmodul - soll das Bindeglied zwischen allen Modulen sein, nimmt Eingabe von PS/2 Modul oder von der Board-Paripherie entgegen, legt Berechnungen im Buffer ab, ...?
-\item Modul für die Kommunikation zum PC - sendet eine vom PC eintreffende Bufferübermittlungsanforderung an den Controller weiter und übermittelt die History an den PC
+\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}
@@ -122,6 +96,9 @@ Da in der History Zahlen als Character Strings abgelegt sind m
 
 \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
@@ -138,21 +115,168 @@ 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}
 
-How to control the VGA component ?= schnittstelle + beschreibung des vga moduls?
+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)
+
+zum modul display: 8 bit command (in), 32 bit command\_data (in), 1 bit free (out)
 
 \paragraph{PS/2}
 
 ebenso hier?
 
+vorgegeben:
+
+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
+
+%Senden und Empfangen von Nachrichten vom/zum PC über die serielle Schnittstelle
+Wir brauchen:
+
+allgemein: sys\_clk (in), sys\_res\_n (in)
+
+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?)
+
+zum modul pc-kommunikation: 8 Empfangsbits (out), 1 Received Flag (out), 8 Sendebits (in), 1 Sendflag (in)
+
+\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)
+
 \paragraph{History}
 
+TODO
+
+%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)
+
+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 (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)
+
+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}
 
-\paragraph{Control}
+TODO
+
+%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 (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
+
+%Konvertiert 10 CP850-codierte Dezimalziffern mit Vorzeichen in eine Binärzahl und umgekehrt
+
+allgemein: sys\_clk (in), sys\_res\_n (in)
+
+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}
+
+TODO
+
+%Führt die tatsächlichen Berechnungen von Addition, Subtraktion, Multiplikation und Division durch
+
+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
+
+allgemein: sys\_clk (in), sys\_res\_n (in)
+
+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 (out), 32 bit command\_data (out), 1 bit free (in)
+
+\paragraph{PC-Kommunikation}
+
+TODO
+
+%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 (in), sys\_res\_n (in)
+
+ein Pin zum externen Button (in)
+
+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) (out), 7 bit spalte (71 zeichen - 0 am ende notwendig?) (out), 1 get bit (out), 1 done bit (in), 8 daten bits (in)
 
 \subsubsection{Verhalten der Interfaces}
 
@@ -177,6 +301,8 @@ soll in der eingabe auch mit pfeiltasten (links,rechts) gescrolled werden koenne
 
 alle requirements muessen von testfaellen abgedeckt werden!
 
+%29 zeilen am bildschirm
+
 
 \section{Detailed Design Description}
 
@@ -194,6 +320,13 @@ wie schauen interne strukturen aus? (speicher, logische bloecke, parallele proze
 \subsection{PS/2}
 
 \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}
 
 \subsection{History}