1 \documentclass[12pt,a4paper,titlepage,oneside]{article}
2 %\documentclass[12pt,a4paper,titlepage,oneside]{report}
4 \usepackage{ProtocolHeader}
9 %\chapter %for use with report class
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.
20 \section{Requirement Spezifikation}
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.
24 %Die Subsections sind vielleicht ein kleiner Overshoot.
29 \req{Der Taschenrechner soll eine Eingabe bestehend aus den Ziffern '0'-'9', Leerzeichen ' ', '+', '-', '*' und '/' ausrechnen können}
31 \req{Der Syntax für so eine Eingabe - eine \textbf{Expression} - sieht folgendermaßen aus:
33 DIGIT = '0' \textbar '1' \textbar '2' \textbar '3' \textbar '4' \textbar '5' \textbar '6' \textbar '7' \textbar '8' \textbar '9' ;
35 UNSIGNED = DIGIT \{ DIGIT \} ;
37 OPERAND = ['-'] UNSIGNED ;
39 OPERATOR = '+' \textbar '-' \textbar '*' \textbar '/' ;
41 EXPRESSION = OPERAND \{ OPERATOR OPERAND \} ;
44 \req{Dabei soll Punkt- vor Strichrechnung gelten}
46 \req{Die Zahlen dürfen im Zahlenbereich eines signed long liegen ($-2^{31}$ bis $2^{31}-1$)}
48 \req{Die Eingabe darf aus 70 Zeichen bestehen}
50 \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 \req{Die Anzeige der Ein- und Ausgaben erfolgt über einen VGA Monitor.}
56 \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}
58 \req{Auf die in zuvor angegebene Methode sollen zusätzlich zur aktuellen Eingabezeile die letzten 14 Ein- und Ausgaben dargestellt werden}
62 \req{Die letzten 50 Ein- und Ausgaben korrekter Eingaben werden als History im Speicher gehalten}
64 \req{Die History soll über RS232, auf Anfrage vom PC, oder bei Betätigen eines Buttons am Development Board, zum PC gesendet werden}
67 \section{High-Level Design Description}
70 \includegraphics[width=\textwidth]{Architektur.png}
72 \caption{Die Architektur des Taschenrechners}
76 In Abbildung \ref{fig:arch} ist der Aufbau des Taschenrechners zu sehen. Der Taschenrechner besteht aus folgenden Modulen:
81 \item \textbf{VGA} - Zeichenweises Ansprechen des Monitors
82 \item \textbf{PS/2} - Empfangen von Keyboard-Eingaben als Scancodes
83 \item \textbf{RS232} - Senden und Empfangen von Nachrichten vom/zum PC über die serielle Schnittstelle % TODO. baudrate? kodierung? (8N1?)
84 \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
85 \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
86 \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
87 \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?
88 \item \textbf{ALU} - Führt die tatsächlichen Berechnungen von Addition, Subtraktion, Multiplikation und Division durch
89 \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
90 \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
93 %\subsection{Interfaces}
95 \subsection{Externe Interfaces}
97 \subsubsection{Physikalische Interfaces}
99 %TODO die pins sind wahrscheilich gefragt
100 %wie ist das mit dem clock? externe ungenaue clock + interne pll oder wie?
102 Interface zum key pad
104 Interfaces zu VGA, PS/2, RS232
108 Active Low oder Active High
110 das ist mir noch nicht ganz klar was die da wollen. was meinen die z.b. mit ``interfaces
111 to VGA'' unter ``physical interfaces'' (seite 10 in der exercise.pdf)
113 ``physikalisch'' im sinne der VHDL entity? oder doch den physischen stecker?
114 Ersteres wuerde ich unter Logisches Interface verstehen.
116 \subsubsection{Logische Interfaces der Module}
121 vga\_clk & in & 1 & std\_logic & PLL & VGA-Clock \ZE
122 vga\_res\_n & in & 1 & std\_logic & PLL & VGA-Reset \ZE
124 vsync\_n & out & 1 & std\_logic & Bildschirm & Vertikale Synchronisation\ZE
125 hsync\_n & out & 1 & std\_logic & Bildschirm & Horizontale Synchronisation\ZE
127 r & out & 3 & std\_logic\_vector & Bildschirm & Ausgabe der Farbe Rot \ZE
128 g & out & 3 & std\_logic\_vector & Bildschirm & Ausgabe der Farbe Gr\"un \ZE
129 b & out & 2 & std\_logic\_vector & Bildschirm & Ausgabe der Farbe Blau \ZE
131 command & in & 8 & std\_logic\_vector & Display & Kommando an das VGA Modul \ZE
132 command\_data & in & 32 & std\_logic\_vector & Display & Daten f\"ur das Kommando \ZE
133 free & in & 1 & std\_logic & Display & Signalisiert Bereitschaft \ZE
139 new\_data & out & 1 & std\_logic\_vector & Scanner & Signalisiert neuen Scancode \ZE
140 data & out & 8 & std\_logic\_vector & Scanner & Scancode laut Codepage 850 \ZE
142 ps2\_clk & inout & 1 & std\_logic & Tastatur & Clockleitung zum Keyboard \ZE
143 ps2\_data & inout & 1 & std\_logic & Tastatur & Datenleitung zum Keyboard \ZE
148 %Senden und Empfangen von Nachrichten vom/zum PC über die serielle Schnittstelle
150 rxd & in & 1 & std\_logic & PC & Sendeleitung der seriellen \"Ubertragung \ZE
151 txd & out & 1 & std\_logic & PC & Empfangsleitung der seriellen \"Ubertragung \ZE
153 rx\_data & out & 8 & std\_logic\_vector & PC-Kommunikation & Datenfeld f\"ur das Empfangen \ZE
154 rx\_new & out & 1 & std\_logic & PC-Kommunikation & Signalisiert ein neu empfangendes Byte \ZE
156 tx\_data & out & 8 & std\_logic\_vector & PC-Kommunikation & Datenfeld f\"ur das \"Ubertragen \ZE
157 tx\_new & out & 1 & std\_logic & PC-Kommunikation & Signalisiert dass das anliegende Byte gesendet werden soll \ZE
161 %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
163 new\_data & in & 1 & std\_logic\_vector & PS/2 & Signalisiert neuen Scancode \ZE
164 data & in & 8 & std\_logic\_vector & PS/2 & Scancode laut Codepage 850 \ZE
166 char & out & 8 & character & History & Zeichen das vom History Modul \"ubernommen werden soll \ZE
167 take & out & 1 & std\_logic & History & Signalisiert Datenfeld char \ZE
168 backspace & out & 1 & std\_logic & History & Signalisiert Backspace (letztes Zeichen im Buffer soll gel\"oscht werden) \ZE
170 do\_it & out & 1 & std\_logic & Parser & Auswertung beginnen (ENTER) \ZE
171 finished & in & 1 & std\_logic & Parser & Auswertung fertig \ZE
176 %Verwaltung des dahinterliegenden Buffers von vergangenen Berechnungen und der aktuellen
177 %Eingabezeile, bei Aktualisierung der aktuellen Eingabezeile und bei Empfang eines Ergebnisses vom
178 %Parser Modul signalisiert es das an das Display Modul
180 pc\_zeile & in & 7 & std\_logic\_vector & PC-Kommunikation & Zeilenadressierung (50 * 2 Zeilen = 100)\ZE
181 pc\_spalte & in & 7 & std\_logic\_vector & PC-Kommunikation & Spaltenadressierung (71 Zeichen inklusive \textbackslash 0) \ZE
182 pc\_get & in & 1 & std\_logic & PC-Kommunikation & Signalisiert Speicheranforderung \ZE
183 pc\_done & out & 1 & std\_logic & PC-Kommunikation & Signalisiert dass Daten anliegen \ZE
184 pc\_char & out & 8 & character & PC-Kommunikation & enth\"alt angeforderne Daten \ZE
186 s\_char & in & 8 & character & Scanner & Zeichen das vom Scanner Modul \"ubernommen werden soll \ZE
187 s\_take & in & 1 & std\_logic & Scanner & Signalisiert Datenfeld char \ZE
188 s\_backspace & in & 1 & std\_logic & Scanner & Signalisiert Backspace (letztes Zeichen im Buffer soll gel\"oscht werden) \ZE
190 d\_new\_eingabe & out & 1 & std\_logic & Display & Fordert Display auf die Eingabe auszulesen \ZE
191 d\_new\_result & out & 1 & std\_logic & Display & Fordert Display auf das Ergebnis auszulesen \ZE
192 d\_zeile & in & 5 & std\_logic\_vector & Display & Zeilenadressierung ($2 * 15$ Zeilen $=30$) \ZE
193 d\_spalte & in & 7 & std\_logic\_vector & Display & Spaltenadressierung (71 Ziechen inklusive \textbackslash 0) \ZE
194 d\_get & in & 1 & std\_logic & Display & Signalisiert Speicheranforderung \ZE
195 d\_done & out & 1 & std\_logic & Display & Signalisiert dass Daten anliegen \ZE
196 d\_char & out & 8 & character & Display & enth\"alt angeforderne Daten \ZE
198 p\_rw & in & 1 & std\_logic & Parser & 0 = read (Expression), 1 = write (Ergebnis) \ZE
199 p\_spalte & in & 7 & std\_logic\_vector & Parser & Spaltenadressierung (71 Ziechen inklusive \textbackslash 0) \ZE
200 p\_rget & in & 1 & std\_logic & Parser & Signalisiert Leseanforderung \ZE
201 p\_rdone & out & 1 & std\_logic & Parser & Signalisiert dass Daten anliegen \ZE
202 p\_read & in & 8 & character & Parser & enth\"alt angeforderne Daten \ZE
204 p\_wdo & in & 1 & std\_logic & Parser & Signalisiert Schreibanforderung \ZE
205 p\_wdone & out & 1 & std\_logic & Parser & Signalisiert dass Daten anliegen \ZE
206 p\_write & out & 8 & character & Parser & enth\"alt zu schreibende Daten \ZE
208 p\_finished & in & 1 & std\_logic & Parser & Auswertung fertig \ZE
212 %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
214 h\_rw & in & 1 & std\_logic & History & 0 = read (Expression), 1 = write (Ergebnis) \ZE
215 h\_spalte & in & 7 & std\_logic\_vector & History & Spaltenadressierung (71 Ziechen inklusive \textbackslash 0) \ZE
216 h\_rget & in & 1 & std\_logic & History & Signalisiert Leseanforderung \ZE
217 h\_rdone & out & 1 & std\_logic & History & Signalisiert dass Daten anliegen \ZE
218 h\_read & in & 8 & character & History & enth\"alt angeforderne Daten \ZE
220 h\_wdo & in & 1 & std\_logic & History & Signalisiert Schreibanforderung \ZE
221 h\_wdone & out & 1 & std\_logic & History & Signalisiert dass Daten anliegen \ZE
222 h\_write & out & 8 & character & History & enth\"alt zu schreibende Daten \ZE
224 h\_finished & in & 1 & std\_logic & History & Auswertung fertig \ZE
226 opcode & out & 3 & enum OPS & ALU & die auszuf\"uhrende Art der Berechnung \ZE
227 op1 & out & 32 & SIGNED(32-1 downto 0) & ALU & erste Operand \ZE
228 op2 & inout & 32 & SIGNED(32-1 downto 0) & ALU & zweite Operand und gleichzeitig der Zieloperand \ZE
229 do\_calc & out & 1 & std\_logic & ALU & Signalisert Berechnungstart \ZE
230 calc\_done & in & 1 & std\_logic & ALU & Berechnung fertig \ZE
232 do\_it & in & 1 & std\_logic & Scanner & Auswertung beginnen (ENTER) \ZE
233 finished & out & 1 & std\_logic & Scanner & Auswertung fertig \ZE
238 %Führt die tatsächlichen Berechnungen von Addition, Subtraktion, Multiplikation und Division durch
240 opcode & in & 3 & enum OPS & Parser & die auszuf\"uhrende Art der Berechnung \ZE
241 op1 & in & 32 & SIGNED(32-1 downto 0) & Parser & erste Operand \ZE
242 op2 & inout & 32 & SIGNED(32-1 downto 0) & Parser & zweite Operand und gleichzeitig der Zieloperand \ZE
243 do\_calc & in & 1 & std\_logic & Parser & Signalisert Berechnungstart \ZE
244 calc\_done & out & 1 & std\_logic & Parser & Berechnung fertig \ZE
250 %Liest einzelne Zeichen aus der History aus und leitet diese an das VGA Modul weiter, um sie in der entsprechenden Zeile anzeigen zu lassen
252 allgemein: sys\_clk (in), sys\_res\_n (in)
254 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)
256 zum modul vga: 8 bit command (out), 32 bit command\_data (out), 1 bit free (in)
258 \paragraph{PC-Kommunikation}
262 %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
264 allgemein: sys\_clk (in), sys\_res\_n (in)
266 ein Pin zum externen Button (in)
268 zum modul rs232: 8 Empfangsbits (in), 1 Received Flag (in), 8 Sendebits (out), 1 Sendflag (out)
270 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)
273 \subsubsection{Verhalten der Interfaces}
275 welche tasten als input erlauben (haben numblock und normale ziffern unterschiedliche scancodes?)?
277 wie werden ueberlaeufe behandelt?
279 fehlerhafte eingaben?
281 wie schaut die ausgabe aus?
283 was ausgaben bei fehler?
285 wie kann download oder upload einer history gestartet werden?
287 wie kann auf die history zugegriffen werden?
289 soll in der eingabe auch mit pfeiltasten (links,rechts) gescrolled werden koennen?
292 \subsection{Testfälle}
294 alle requirements muessen von testfaellen abgedeckt werden!
296 %29 zeilen am bildschirm
299 \section{Detailed Design Description}
301 alle Module hier genauer beschreiben
304 wie wollen wir das design implementieren?
306 event sequence diagrams! UML?
308 wie schauen interne strukturen aus? (speicher, logische bloecke, parallele prozesse, state machines)
317 \includegraphics[width=0.9\textwidth]{sm/rs232-rs.pdf}
319 \caption{Statemachine zum Empfangen auf der RS232 Schnittstelle (8N1)}
325 \includegraphics[width=0.9\textwidth]{sm/scanner.pdf}
327 \caption{Statemachine zum Scannen des Inputs der PS/2 Schnittstelle}
332 \item \textbf{idle}: Setz alle Steuersignale \emph{backspace}, \emph{take} und \emph{do\_it} low.
333 \item \textbf{read}: Bei steigender Flanke auf \emph{new\_data} wird das anliegende Byte des
334 PS/2-Modules \"ubernommen. Je nach Wert wird in den n\"achsten Zustand gewechselt.
335 \item \textbf{enter}: Wurde die Entertaste gedr\"uckt wird der Parser getriggert (\emph{do\_it} ist
336 einen Takt lang high). Der Scanner befindet sich so lange in diesem Zustand bis der Parser das
337 Ergebnis berechnet hat.
338 \item \textbf{l\"oschen}: Teilt dem History Modul mit das letzte Zeichen im Buffer zu l\"oschen
339 (\emph{backspace} ist einen Takt lang high).
340 \item \textbf{\"ubernehmen}: Wenn ein g\"ultiges Zeichen laut Requirements eingegeben wurde, wird
341 jenes Zeichen an \emph{char} angelegt und \emph{take} wird einen Takt lang high gesetzt. Das History
342 Modul wird dadurch getriggert das anliegende Zeichen in den Buffer zu \"ubernehmen.
350 \includegraphics[width=0.9\textwidth]{sm/parser.pdf}
352 \caption{Statemachine zum Parsen der aktuellen Expression}
372 if(aktop in ['+','-','\0']) {
375 while(calc_done == 0);
377 alu(ADD, punkt, strich);
380 else if (aktop in ['*','/']) {
390 if(aktop in ['+','-','\0']) {
393 else if (aktop in ['*','/']) {
400 \item \textbf{idle}: Das Modul ist unt\"atig und wartet auf eine steigende Flanke von \emph{do\_it}.
402 \item \textbf{read char}: Lokale Variablen werden zur\"uckgesetzt und das n\"achste Zeichen wird vom
403 History Modul angefordert.
405 \item \textbf{sign}: Ggf. wird das Vorzeichen auf '-' gesetzt.
407 \item \textbf{calc}: Zeichen f\"ur Zeichen wird eingelesen und die Zahl wird daraus berechnet.
409 \item \textbf{ALU}: Punkt- und Strichrechnungen m\"ussen getrennt behandelt werden, daher ergibt
410 sich dieses Konstrukt im Codebeispiel.
412 \item \textbf{null}: Sonderbehandlung ist n\"otig wenn die Expression mit '\textbackslash 0'
415 \item \textbf{done}: In diesem Zustand wird das Ergebnis das sich je nach \emph{opp} in
416 \emph{strich} oder \emph{punkt} befindet als String in den Ergebnisbuffer des History Modules
417 geschrieben und danach wird \emph{finished} f\"ur einen Zyklus auf high gesetzt.
419 \item \textbf{error}: Zwecks \"Ubersichtlichkeit wurden die Transitionen zu diesem Zustand
420 vernachl\"assigt. Dieser Zustand wird erreicht sobald ein Grammatikfehler oder ein Fehler der ALU
421 auftritt. Es wird der String ``Error'' in den Ergebnisbuffer geschrieben und
422 \emph{finished} wird f\"ur einen Zyklus auf high gesetzt.
426 \subsection{Bin/Dez-Converter}
429 opcodes: NOP, ADD, MUL, DIV, DONE (als enum)
433 \subsection{PC-Kommunikation}
435 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
440 %howto include src files
441 %\subsection{einfache Variante -- generierter Sourcecode}
442 %\label{att:einfachsrc}
443 %\lstinputlisting{../einfach/einfach.src}
444 %\lstinputlisting[firstnumber=24, firstline=24, lastline=34]{bla.src} %firstnumber shouldn't be necessary, but there is probably a bug