architekturüberlegungen
[hwmod.git] / spec / spec.tex
index 0a75a2cad31fe1aeab88d208f312232639d05011..5ec2655ca491ad203e063584abbdf58a55a14730 100644 (file)
 \begin{document}
 \MakeTitleAndTOC
 
-
-% howto use graphics
-% \begin{figure}[!ht]
-% \includegraphics[width=\textwidth]{ftol_pic.pdf}
-% \centering
-% \caption{Ein kleines, fehlertolerantes Computersystem}
-% \label{fig:angabe}
-% \end{figure}
-
 %\chapter %for use with report class
 \section
 {Einleitung}
-%TODO
-Es ist ein einfacher Taschenrechner der die Grundrechnungsarten Addition, Subtraktion,
-Multiplikation und Division beherrscht in Hardware zu realisieren. Dabei soll als Input eine PS/2
-Tastatur beziehungsweise als Output ein VGA Monitor dienen. Als zus\"atzliches Feature soll eine
-History eingebaut werden, sodass vergangene Berechnungen wieder aus einem Buffer geladen werden
-koennen. Au\ss{}erdem besteht die M\"oglichkeit eine solche History per RS232-Schnittstelle zu
+
+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}
 
-%\chapter
-\section
-{High-Level Design Description}
+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.
 
-XXX
+Die Subsections sind vielleicht ein kleiner Overshoot.
 
-\subsection
-{Requirement Spezifikation}
 
-wie schaut syntax aus der eingabe? welche regeln gelten (punkt vor strich)?
-wie lang darf die eingabe sein?
-zahlentyp?
-was soll am bildschirm angezeigt werden?
-wie gross soll der buffer sein?
-wie wird zum pc gesendet bzw. empfangen?
+%TODO
+wie schaut syntax aus der eingabe? 
 
-... requirements durchnummierieren (wegen testfaelle)
+\subsection{Eingabe}
 
+\req{Der Taschenrechner soll eine Eingabe bestehend aus den Ziffern '0'-'9', Leerzeichen ' ', '+', '-', '*' und '/' ausrechnen können}
 
-\subsection
-{Module}
+\req{Der Syntax für so eine Eingabe - eine \textbf{Expression} - sieht folgendermaßen aus:
 
-was gibts fuer module? vorschlag:
-\begin{itemize}
-\item VGA
-\item PS/2
-\item RS232
-\item Historymodul fuer die Verwaltung des dahinterliegenden Buffers
-\item Parser der die Eingabe auswertet
-\item Controlmodul (nimmt eingabe entgegen, legt berechnungen im buffer ab, ...?)
-\item Modul fuer die Kommunikation zum PC? oder gleich im Historymodul implementieren? oder ins
-Controlmodul mit rein packen?
-\end{itemize}
+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$)}
 
-\subsection
-{VGA}
-ist gegeben.
+\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
-{PS/2}
-ist gegeben.
+\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}
 
-\subsection
-{RS232}
-TODO. baudrate? kodierung? (8N1?)
+\subsection{History}
 
+\req{Die letzten 50 Ein- und Ausgaben korrekter Eingaben werden als History im Speicher gehalten}
 
-\subsection
-{History}
-Verwaltet den dahinterliegenden Buffer fuer die History
+\req{Die History soll über RS232, auf Anfrage vom PC, oder bei Betätigen eines Buttons am Development Board, zum PC gesendet werden}
 
 
-\subsection
-{Parser}
-wertet ein gegeben Buffer aus.
+\section{High-Level Design Description}
 
+\begin{figure}[!ht]
+\includegraphics[width=\textwidth]{Architektur.png}
+\centering
+\caption{Die Architektur des Taschenrechners}
+\label{fig:arch}
+\end{figure}
 
-\subsection
-{Control}
-soll das Bindeglied zwischen allen Modulen sein
+In Abbildung \ref{fig:arch} ist der Aufbau des Taschenrechners zu sehen. Der Taschenrechner besteht aus folgenden Modulen:
 
+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
-{Interfaces}
+%\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
+\end{itemize}
+
+%\subsection{Interfaces}
+
+\subsection{Externe Interfaces}
+
+\subsubsection{Physikalische Interfaces}
+
+Interface zum key pad
+
+Interfaces zu VGA, PS/2, RS232
+
+Reset und Clock!
+
+Active Low oder Active High
 
-\subsubsection
-{Physikalische Interfaces}
 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}
+
+\paragraph{VGA}
+
+How to control the VGA component ?= schnittstelle + beschreibung des vga moduls?
 
-\subsubsection
-{Logische Interfaces}
+\paragraph{PS/2}
 
+ebenso hier?
+
+\paragraph{RS232}
+
+\paragraph{History}
+
+\paragraph{Parser}
+
+\paragraph{Control}
+
+\subsubsection{Verhalten der Interfaces}
 
-\subsubsection
-{Verhalten der Interfaces}
 welche tasten als input erlauben (haben numblock und normale ziffern unterschiedliche scancodes?)?
+
 wie werden ueberlaeufe behandelt?
+
 fehlerhafte eingaben?
+
 wie schaut die ausgabe aus?
+
 was ausgaben bei fehler?
+
 wie kann download oder upload einer history gestartet werden?
+
 wie kann auf die history zugegriffen werden?
+
 soll in der eingabe auch mit pfeiltasten (links,rechts) gescrolled werden koennen?
 
 
-\subsection
-{Testf\"alle}
+\subsection{Testfälle}
+
 alle requirements muessen von testfaellen abgedeckt werden!
 
 
-%\chapter
-\section
-{Detailed Design Description}
+\section{Detailed Design Description}
+
 alle Module hier genauer beschreiben
 
+%TODO
 wie wollen wir das design implementieren?
-event sequence diagrams!
+
+event sequence diagrams! UML?
+
 wie schauen interne strukturen aus? (speicher, logische bloecke, parallele prozesse, state machines)
 
+\subsection{VGA}
+
+\subsection{PS/2}
+
+\subsection{RS232}
+
+\subsection{History}
+
+\subsection{Parser}
+
+\subsection{Control}
+
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %LISTINGS