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 VGA - Zeichenweises Ansprechen des Monitors
82 \item PS/2 - Empfangen von Keyboard-Eingaben als Scancodes
83 \item RS232 - Senden und Empfangen von Nachrichten vom/zum PC über die serielle Schnittstelle % TODO. baudrate? kodierung? (8N1?)
84 \item 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 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 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 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 ALU - Führt die tatsächlichen Berechnungen von Addition, Subtraktion, Multiplikation und Division durch
89 \item 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 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}
120 %ps/2 schickt zeichen an controller, der nimmt nur gewünschte chars und schreibt die in die history
121 %in die editierbare ``eingabezeile''.
123 %dann bei einem "enter" sagt er dem parser dass der was hackeln soll
125 %der holt sich selbstständig den string aus der history und analysiert ihn mal - also ob es ein gültiger string ist
127 %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)
129 %jedenfalls müssen bei z.b. a + b * c die b*c zuerst ausgerechnet werden
131 %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
133 %der parser muss bei den zwischenrechnungen die zwischenergebnisse im speicher behalten
135 %wenn er fertig ist liefert er das ergebnis an die history und benachrichtigt den controller dass er fertig ist
137 %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
139 %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?
141 %es sollte vielleicht der controller das display modul veranlasen sich die daten aus der history zu holen (könnte auch die history)
143 %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.
144 %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!
148 TODO: How to control the VGA component ?= schnittstelle + beschreibung des vga moduls?
152 allgemein: sys\_clk, sys\_res\_n
154 zu den hardware pins: vga\_clk, vga\_res\_n, vsync\_n, hsync\_n, ? bits r, ? bits g, ? bits b
156 zum modul display: 8 bit command, 32 bit command\_data, 1 bit free
164 allgemein: sys\_clk, sys\_res\_n
166 zum modul scanner: 1 bit new\_data, 8 bit data
168 zu den hardware pins: 1 bit ps2\_clk, 1 bit ps2\_data
174 %Senden und Empfangen von Nachrichten vom/zum PC über die serielle Schnittstelle
177 allgemein: sys\_clk, sys\_res\_n
179 externe Pins für die Schnittstelle (Data carrier detect, Receive data, Transmit data, Data terminal ready, Signal ground, Data set ready, Request to send, Clear to send, Ring indicator ?brauchen wir die alle?)
181 zum modul pc-kommunikation: 8 Empfangsbits, 1 Received Flag, 8 Sendebits, 1 Sendflag
195 %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
197 allgemein: sys\_clk, sys\_res\_n
199 von modul ps/2: 8 bit data, 1 bit new\_data
201 an modul history: 8 bit char, 1 bit take, 1 bit backspace, an modul parser: 1 bit do\_it
207 %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
209 allgemein: sys\_clk, sys\_res\_n
211 zum modul pc-kommunikation: 5 bit zeile (2*14+1), 7 bit spalte (71 zeichen - 0 am ende notwendig?), 1 get bit, 1 done bit, 8 daten bits
213 vom modul scanner: 8 bit char, 1 bit take, 1 bit backspace
215 an modul display: 1 bit new\_eingabe, 1 bit new\_result, 5 bit zeile (2*14+1), 7 bit spalte (71 zeichen - 0 am ende notwendig?), 1 get bit, 1 done bit, 8 daten bits
217 an modul parser: 5 bit zeile (2*14+1), 7 bit spalte (71 zeichen - 0 am ende notwendig?), 1 get bit, 1 done bit, 8 daten bits, 8 bit write\_result, 1 bit first\_result\_char, 1 bit write\_char, ? 1 bit finnnnnished\_result (triggert fortschalten des ringpuffer pointers)
223 %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
225 allgemein: sys\_clk, sys\_res\_n
227 zu modul history: 5 bit zeile (2*14+1), 7 bit spalte (71 zeichen - 0 am ende notwendig?), 1 get bit, 1 done bit, 8 daten bits, 8 bit write\_result, 1 bit first\_result\_char, 1 bit write\_char, ? 1 bit finnnnnished\_result (triggert fortschalten des ringpuffer pointers)
229 an modul bin/dez-converter: 11*8 bit char (vorzeichen + dezimalstellen; ok, das ist ein overkill...), 32 bit binärstellen, 1 bit do\_deztobin, 1 bit do\_bintodez, 1 bit bintodez\_done, 1 bit deztobin\_done (?)
231 zu modul alu: 32 bit operator1, 32 bit operator2, 32 bit result, 1 bit do\_calc, 1 bit calc\_done
233 \paragraph{Bin/Dez-Converter}
237 %Konvertiert 10 CP850-codierte Dezimalziffern mit Vorzeichen in eine Binärzahl und umgekehrt
239 allgemein: sys\_clk, sys\_res\_n
241 zum modul parser: 11*8 bit char (vorzeichen + dezimalstellen; ok, das ist ein overkill...), 32 bit binärstellen, 1 bit do\_deztobin, 1 bit do\_bintodez, 1 bit bintodez\_done, 1 bit deztobin\_done (?)
247 %Führt die tatsächlichen Berechnungen von Addition, Subtraktion, Multiplikation und Division durch
249 allgemein: sys\_clk, sys\_res\_n
251 zum parser: 32 bit operator1, 32 bit operator2, 32 bit result, 1 bit do\_calc, 1 bit calc\_done
257 %Liest einzelne Zeichen aus der History aus und leitet diese an das VGA Modul weiter, um sie in der entsprechenden Zeile anzeigen zu lassen
259 allgemein: sys\_clk, sys\_res\_n
261 zum modul history: 1 bit new\_eingabe, 1 bit new\_result, 5 bit zeile (2*14+1), 7 bit spalte (71 zeichen - 0 am ende notwendig?), 1 get bit, 1 done bit, 8 daten bits
263 zum modul vga: 8 bit command, 32 bit command\_data, 1 bit free
265 \paragraph{PC-Kommunikation}
269 %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
271 allgemein: sys\_clk, sys\_res\_n
273 ein Pin zum externen Button
275 zum modul rs232: 8 Empfangsbits, 1 Received Flag, 8 Sendebits, 1 Sendflag
277 zum modul history: 5 bit zeile (2*14+1), 7 bit spalte (71 zeichen - 0 am ende notwendig?), 1 get bit, 1 done bit, 8 daten bits
279 \subsubsection{Verhalten der Interfaces}
281 welche tasten als input erlauben (haben numblock und normale ziffern unterschiedliche scancodes?)?
283 wie werden ueberlaeufe behandelt?
285 fehlerhafte eingaben?
287 wie schaut die ausgabe aus?
289 was ausgaben bei fehler?
291 wie kann download oder upload einer history gestartet werden?
293 wie kann auf die history zugegriffen werden?
295 soll in der eingabe auch mit pfeiltasten (links,rechts) gescrolled werden koennen?
298 \subsection{Testfälle}
300 alle requirements muessen von testfaellen abgedeckt werden!
303 \section{Detailed Design Description}
305 alle Module hier genauer beschreiben
308 wie wollen wir das design implementieren?
310 event sequence diagrams! UML?
312 wie schauen interne strukturen aus? (speicher, logische bloecke, parallele prozesse, state machines)
321 \includegraphics[width=0.9\textwidth]{sm/rs232-rs.pdf}
323 \caption{Statemachine zum Empfangen auf der RS232 Schnittstelle (8N1)}
334 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
339 %howto include src files
340 %\subsection{einfache Variante -- generierter Sourcecode}
341 %\label{att:einfachsrc}
342 %\lstinputlisting{../einfach/einfach.src}
343 %\lstinputlisting[firstnumber=24, firstline=24, lastline=34]{bla.src} %firstnumber shouldn't be necessary, but there is probably a bug