spec/spec.tex

   1 \documentclass[12pt,a4paper,titlepage,oneside]{article}
   2 %\documentclass[12pt,a4paper,titlepage,oneside]{report}
   3
   4 \usepackage{ProtocolHeader}
   5
   6 \begin{document}
   7 \MakeTitleAndTOC
   8
   9 %\chapter %for use with report class
  10 \section
  11 {Einleitung}
  12
  13 Es ist ein einfacher Taschenrechner, der die Grundrechnungsarten Addition, Subtraktion,
  14 Multiplikation und Division beherrscht, auf einem FPGA Board zu realisieren. Dabei soll als Eingabegerät eine PS/2
  15 Tastatur beziehungsweise als Ausgabegerät ein VGA Monitor dienen. Als zusätzliches Feature soll eine
  16 History eingebaut werden, sodass vergangene Berechnungen angezeigt werden
  17 können. Außerdem besteht die Möglichkeit diese History per RS232-Schnittstelle zu
  18 exportieren bzw. importieren.
  19
  20 \section{Requirement Spezifikation}
  21
  22 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.
  23
  24 Die Subsections sind vielleicht ein kleiner Overshoot.
  25
  26
  27 %TODO
  28 wie schaut syntax aus der eingabe?
  29
  30 \subsection{Eingabe}
  31
  32 \req{Der Taschenrechner soll eine Eingabe bestehend aus den Ziffern '0'-'9', Leerzeichen ' ', '+', '-', '*' und '/' ausrechnen können}
  33
  34 \req{Der Syntax für so eine Eingabe - eine \textbf{Expression} - sieht folgendermaßen aus:
  35
  36 DIGIT = '0' \textbar '1' \textbar '2' \textbar '3' \textbar '4' \textbar '5' \textbar '6' \textbar '7' \textbar '8' \textbar '9' ;
  37
  38 UNSIGNED = DIGIT { DIGIT } ;
  39
  40 OPERAND = ['-'] UNSIGNED ;
  41
  42 OPERATOR = '+' \textbar '-' \textbar '*' \textbar '/' ;
  43
  44 EXPRESSION = OPERAND \{ OPERATOR OPERAND \} ;
  45 }
  46
  47 \req{Dabei soll Punkt- vor Strichrechnung gelten}
  48
  49 \req{Die Zahlen dürfen im Zahlenbereich eines signed long liegen ($-2^{31}$ bis $2^{31}-1$)}
  50
  51 \req{Die Eingabe darf aus 70 Zeichen bestehen}
  52
  53 \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}
  54
  55 \subsection{Ausgabe}
  56
  57 \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}
  58
  59 \subsection{History}
  60
  61 \req{Die letzten 50 Ein- und Ausgaben korrekter Eingaben werden als History im Speicher gehalten}
  62
  63 \req{Die History soll über RS232, auf Anfrage vom PC, oder bei Betätigen eines Buttons am Development Board, zum PC gesendet werden}
  64
  65
  66 \section{High-Level Design Description}
  67
  68 \begin{figure}[!ht]
  69 \includegraphics[width=\textwidth]{Architektur.png}
  70 \centering
  71 \caption{Die Architektur des Taschenrechners}
  72 \label{fig:arch}
  73 \end{figure}
  74
  75 In Abbildung \ref{fig:arch} ist der Aufbau des Taschenrechners zu sehen. Der Taschenrechner besteht aus folgenden Modulen:
  76
  77 Bla:
  78
  79 ps/2 schickt zeichen an controller, der nimmt nur gewünschte chars und schreibt die in die history in die editierbare "eingabezeile".
  80
  81 dann bei einem "enter" sagt er dem parser dass der was hackeln soll
  82
  83 der holt sich selbstständig den string aus der history und analysiert ihn mal - also ob es ein gültiger string ist
  84
  85 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)
  86
  87 jedenfalls müssen bei z.b. a + b * c die b*c zuerst ausgerechnet werden
  88
  89 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
  90
  91 der parser muss bei den zwischenrechnungen die zwischenergebnisse im speicher behalten
  92
  93 wenn er fertig ist liefert er das ergebnis an die history und benachrichtigt den controller dass er fertig ist
  94
  95 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
  96
  97 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?
  98
  99 es sollte vielleicht der controller das display modul veranlasen sich die daten aus der history zu holen (könnte auch die history)
 100
 101 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.
 102 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!
 103
 104 %\subsection{Module}
 105
 106 \begin{itemize}
 107 \item VGA - Ansprechen des Monitors
 108 \item PS/2 - Empfangen von Keyboard-Eingaben
 109 \item RS232 - Senden und Empfangen von Nachrichten vom/zum PC TODO. baudrate? kodierung? (8N1?)
 110 \item Historymodul - Verwaltung des dahinterliegenden Buffers von vergangenen Berechnungen
 111 \item Displaycontroller - Veranlasst das VGA Modul, einen Teil der History am Monitor anzuzeigen
 112 \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
 113 \item Converter - konvertiert Dezimalzahlen in Binärzahlen und umgekehrt TODO oder in Parser integrieren? Oder gibt's eine Library-Funktion dafür?
 114 \item ALU - führt die tatsächlichen Berechnungen durch
 115 \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, ...?
 116 \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
 117 \end{itemize}
 118
 119 %\subsection{Interfaces}
 120
 121 \subsection{Externe Interfaces}
 122
 123 \subsubsection{Physikalische Interfaces}
 124
 125 Interface zum key pad
 126
 127 Interfaces zu VGA, PS/2, RS232
 128
 129 Reset und Clock!
 130
 131 Active Low oder Active High
 132
 133 das ist mir noch nicht ganz klar was die da wollen. was meinen die z.b. mit ``interfaces
 134 to VGA'' unter ``physical interfaces'' (seite 10 in der exercise.pdf)
 135
 136 ``physikalisch'' im sinne der VHDL entity? oder doch den physischen stecker?
 137 Ersteres wuerde ich unter Logisches Interface verstehen.
 138
 139 \subsubsection{Logische Interfaces der Module}
 140
 141 \paragraph{VGA}
 142
 143 How to control the VGA component ?= schnittstelle + beschreibung des vga moduls?
 144
 145 \paragraph{PS/2}
 146
 147 ebenso hier?
 148
 149 \paragraph{RS232}
 150
 151 \paragraph{History}
 152
 153 \paragraph{Parser}
 154
 155 \paragraph{Control}
 156
 157 \subsubsection{Verhalten der Interfaces}
 158
 159 welche tasten als input erlauben (haben numblock und normale ziffern unterschiedliche scancodes?)?
 160
 161 wie werden ueberlaeufe behandelt?
 162
 163 fehlerhafte eingaben?
 164
 165 wie schaut die ausgabe aus?
 166
 167 was ausgaben bei fehler?
 168
 169 wie kann download oder upload einer history gestartet werden?
 170
 171 wie kann auf die history zugegriffen werden?
 172
 173 soll in der eingabe auch mit pfeiltasten (links,rechts) gescrolled werden koennen?
 174
 175
 176 \subsection{Testfälle}
 177
 178 alle requirements muessen von testfaellen abgedeckt werden!
 179
 180
 181 \section{Detailed Design Description}
 182
 183 alle Module hier genauer beschreiben
 184
 185 %TODO
 186 wie wollen wir das design implementieren?
 187
 188 event sequence diagrams! UML?
 189
 190 wie schauen interne strukturen aus? (speicher, logische bloecke, parallele prozesse, state machines)
 191
 192 \subsection{VGA}
 193
 194 \subsection{PS/2}
 195
 196 \subsection{RS232}
 197
 198 \subsection{History}
 199
 200 \subsection{Parser}
 201
 202 \subsection{Control}
 203
 204
 205 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 206 %LISTINGS
 207 %\newpage
 208 %\appendix
 209 %\section{Listings}
 210 %howto include src files
 211 %\subsection{einfache Variante -- generierter Sourcecode}
 212 %\label{att:einfachsrc}
 213 %\lstinputlisting{../einfach/einfach.src}
 214 %\lstinputlisting[firstnumber=24, firstline=24, lastline=34]{bla.src} %firstnumber shouldn't be necessary, but there is probably a bug
 215
 216 \end{document}
 217