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 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.
  78 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!
  79
  80 %\subsection{Module}
  81
  82 \begin{itemize}
  83 \item VGA - Ansprechen des Monitors
  84 \item PS/2 - Empfangen von Keyboard-Eingaben
  85 \item RS232 - Senden und Empfangen von Nachrichten vom/zum PC TODO. baudrate? kodierung? (8N1?)
  86 \item Historymodul - Verwaltung des dahinterliegenden Buffers von vergangenen Berechnungen
  87 \item Displaycontroller - Veranlasst das VGA Modul, einen Teil der History am Monitor anzuzeigen
  88 \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
  89 \item Converter - konvertiert Dezimalzahlen in Binärzahlen und umgekehrt TODO oder in Parser integrieren? Oder gibt's eine Library-Funktion dafür?
  90 \item ALU - führt die tatsächlichen Berechnungen durch
  91 \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, ...?
  92 \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
  93 \end{itemize}
  94
  95 %\subsection{Interfaces}
  96
  97 \subsection{Externe Interfaces}
  98
  99 \subsubsection{Physikalische Interfaces}
 100
 101 Interface zum key pad
 102
 103 Interfaces zu VGA, PS/2, RS232
 104
 105 Reset und Clock!
 106
 107 Active Low oder Active High
 108
 109 das ist mir noch nicht ganz klar was die da wollen. was meinen die z.b. mit ``interfaces
 110 to VGA'' unter ``physical interfaces'' (seite 10 in der exercise.pdf)
 111
 112 ``physikalisch'' im sinne der VHDL entity? oder doch den physischen stecker?
 113 Ersteres wuerde ich unter Logisches Interface verstehen.
 114
 115 \subsubsection{Logische Interfaces der Module}
 116
 117 \paragraph{VGA}
 118
 119 How to control the VGA component ?= schnittstelle + beschreibung des vga moduls?
 120
 121 \paragraph{PS/2}
 122
 123 ebenso hier?
 124
 125 \paragraph{RS232}
 126
 127 \paragraph{History}
 128
 129 \paragraph{Parser}
 130
 131 \paragraph{Control}
 132
 133 \subsubsection{Verhalten der Interfaces}
 134
 135 welche tasten als input erlauben (haben numblock und normale ziffern unterschiedliche scancodes?)?
 136
 137 wie werden ueberlaeufe behandelt?
 138
 139 fehlerhafte eingaben?
 140
 141 wie schaut die ausgabe aus?
 142
 143 was ausgaben bei fehler?
 144
 145 wie kann download oder upload einer history gestartet werden?
 146
 147 wie kann auf die history zugegriffen werden?
 148
 149 soll in der eingabe auch mit pfeiltasten (links,rechts) gescrolled werden koennen?
 150
 151
 152 \subsection{Testfälle}
 153
 154 alle requirements muessen von testfaellen abgedeckt werden!
 155
 156
 157 \section{Detailed Design Description}
 158
 159 alle Module hier genauer beschreiben
 160
 161 %TODO
 162 wie wollen wir das design implementieren?
 163
 164 event sequence diagrams! UML?
 165
 166 wie schauen interne strukturen aus? (speicher, logische bloecke, parallele prozesse, state machines)
 167
 168 \subsection{VGA}
 169
 170 \subsection{PS/2}
 171
 172 \subsection{RS232}
 173
 174 \subsection{History}
 175
 176 \subsection{Parser}
 177
 178 \subsection{Control}
 179
 180
 181 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 182 %LISTINGS
 183 %\newpage
 184 %\appendix
 185 %\section{Listings}
 186 %howto include src files
 187 %\subsection{einfache Variante -- generierter Sourcecode}
 188 %\label{att:einfachsrc}
 189 %\lstinputlisting{../einfach/einfach.src}
 190 %\lstinputlisting[firstnumber=24, firstline=24, lastline=34]{bla.src} %firstnumber shouldn't be necessary, but there is probably a bug
 191
 192 \end{document}
 193