Added documents for MST1 and documentation for that

Signed-off-by: tyrolyean <tyrolyean@tyrolyean.net>

README.md

@@ -9,3 +9,18 @@ published by the Creative Commons Corporation. Please see the LICENSE.md
 file or the creative commons website at 
 https://creativecommons.org/licenses/by/4.0/legalcode
 for a full copy of the license.
+
+# Compile
+
+I try to always have a recent copy of the PDF-Document in this repositoy,
+however if you don't trust me, or want to check your installed latex
+distribution, you can compile it yourself via the following commandline:
+
+```bash
+xelatex --shell-escape main.tex
+```
+
+The used latex distribution is the 2019.50876-1 version of the archlinux texlive
+binary. Please make sure you have the texlive-lang, texlive-fontsextra and
+all regular texlive packages installed.
+

documents/mst1/fail.pdf

@@ -0,0 +1 @@
+I will fail this test!

documents/mst1/test.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+for f in *.pdf; do
+	echo "########################################"
+	echo "Tesing $f..."
+	echo "########################################" >> ./logfile
+	if pdfinfo "$f" >> ./logfile; then
+		echo "$f is correct!"
+	else
+		echo "$f is broken!"
+	fi
+	echo "########################################"
+done

main.tex

@@ -27,8 +27,7 @@
 	\vspace*{-14mm}
 	\noindent%
 	\\[35mm]{\fontsize{25pt}{25pt}\selectfont\bf DIPLOMARBEIT}
-	\\[19mm]{\fontsize{20pt}{20pt}\selectfont\textbf{\textsc{FPGA-Basierte
+	\\[19mm]{\fontsize{20pt}{20pt}\selectfont\textbf{\textsc{FPGA-basiertes RISC-V-Computersystem: YARM }}}
-	Studie moderner Computersysteme am Beispiel RISC-V: YARM}}}
 	\\[15mm]{\fontsize{12.4pt}{12.4pt}\selectfont\bf
 		Höhere Technische Bundeslehr- und Versuchsanstalt Anichstra"se}
 	\\[ 5mm]\rule{132mm}{1.0pt}
@@ -47,7 +46,7 @@
 		\\[5.0mm]Dipl.-Ing. Christoph Schönherr
 	  }
 	  \\[12mm]{Projektpartner: IT-Syndikat, Verein zur Förderung des freien
-		Zugangs zu technischer Fort- und Weiterbildung jeglicher Art}
+		Zugangs zu technischer Fort- und Weiterbildung jeglicher Art, Hackerspace Innsbruck}
 	  \\[12mm]{Ansprechpartner: Herr David Oberhollenzer}
 	  \\[14mm]{Innsbruck, am \today}
 	  \\[16mm]\rule{150mm}{0.5pt}

planung/DP/aufwand.tex

@@ -19,7 +19,7 @@ Diplomarbeit zu vollziehenden Arbeiten.
 	\label{tab:stunden_plank}
 	\caption{Stundenabschätzung Plank Daniel}
 
-	Die Dokumentation wird mit 60h beschätzt, da diese die Gesamte
+	Die Dokumentation wird mit 90h beschätzt, da diese die Gesamte
 	Funktionsweise der Hardware abdeckt, und mehrere Messungen der Hardware
 	beeinhlatet.
 

planung/DP/grobdesign.tex

@@ -11,12 +11,12 @@ Memory Mapped I/O} Angefertigt werden. Diese Dokumentation soll möglichst für
 Prozessorarchitekturen gültig und daher Architekturunabhängig sein. Die
 Dokumentation soll für Personen mit tieferem Verständniss von Hardware, sowie
 für Anfänger hilfreiche Aussagen über die Funktionswiese der Hardware liefern,
-welche sich aus einer seriellen Schnittstelle mit TIA-/EIA-232 Pegeln, einem
+welche sich aus einer seriellen Schnittstelle mit TIA-/EIA-232 Pegeln, 
-Framebuffer\footnote{\href{https://en.wikipedia.org/wiki/Framebuffer}
+der Eklärung der Funktionsweise eines Parallel-Ports nach IEEE
-{Framebuffer}...Ein Speicherbereich in welchen
+\footnote{IEEE...Institute of Electrical and Electronics Engineers} 1284 und
-ein Bild geladen werden kann, welches dann ausgegeben werden} und einem
+eines Parallelport Gebundenen DACs. Diese sollen mit einfachen, im Sortiment
-Soundbuffer\footnote{Ähnlich einem Framebuffer nur dass PCM-Audio anstatt 
+des Hackerspace-Innsbruck vorhandenen oder den Vereinsmitgliedern zum
-Bildern ausgegeben wird}.
+überwiegenden Teil bekannten THT-Bauteilen nachbaubar sein.
 
 \subsubsection{Umsetungsbeschreibung}
 
@@ -31,3 +31,5 @@ unanschaulich. Nach Entwicklung der Schaltungen sollen diese sinnvoll
 begründet werden und dann Dokumentiert werden. Die Dokumentation soll mindestens
 aus Schaltungsbeschreibung, einer generellen Bauteilbeschreibung und den
 Ideen hinter der aktuellen Umsetzung bestehen.
+Diese sollen schlussendlich mit weiteren Beschreibungen um die Integration mit
+dem FPGA ergänzt werden.

planung/DP/materialaufstellung.tex

@@ -1,7 +1,27 @@
 \subsection{Materialaufstellung}
 
 Zur Fertigung der in der Aufgabenstellung gegebenen Bauteile werden die
-folgenden Bauteile Benötigt:
+folgenden Bauteile zwingend Benötigt:
 
-\subsubsection{}
+\subsubsection{Serielle Schnittstelle}
 
+Aufgrund der rein theoretischen Implementation werden keine Bauteile zur
+Fertigung benötigt.
+
+\subsubsection{Parallele Schnittstelle}
+
+Aufgrund der rein theoretischen Implementation werden keine Bauteile zur
+Fertigung benötigt.
+
+\subsubsection{R-2R DAC}
+
+Es werden zur Fertigung eines R-2R DACs mit einer auflösung von 4 bit
+mindestens 10 Widerstände und ein Operationsverstärker benötigt. Diese
+können aus dem Sortiment des Hackerspace-Innsbruck Bezogen werden.
+
+\subsubsection{Zusammenfassung}
+
+Aufgrund des bereits vorhandenen Bauteilsortiments müssen keine nuen Bauteile
+beschaffen werden, daher belaufen sich die Gesamtkosten auf \textbf{0€}.
+Zusätzlich anfallende Kosten während der Projektdurchführung müssen mit dem
+Projektpartner vorher abgeklärt werden.

planung/DP/meilensteine/1.tex

@@ -1,22 +1,62 @@
 \subsubsection{1. Meilenstein - Beschaffung der Unterlagen}
+\paragraph{Titel nach Einreichung:}
+\textbf{Pflichtenheft, Grobdesign, Testplan, Beschaffung der Unterlagen}
 
-\textbf{Datum: 2019-11-19}
+
+\textbf{Datum: \sout{2019-11-19} 2019-10-22}
 
 Der 1. Meilenstein beschäftigt sich mit der Beschaffung der Benötigten
 Unterlagen auf welchen die weitere Dokumentation basieren soll. Diese Unterlagen
 sollen den Aufbau einer Seriellen Schnittstelle beschreiben, den Aufbau
-eines Frame-Buffers und den Aufbau einer Sound-Karte. Die Unterlagen
+eines Frame-Buffers und den Aufbau einer Sound-Karte, sowie den Aufbau und die
-sollen auch Beispielschlatungen beinhalten.
+Funktionsweise eines FPGAs. Die Unterlagen sollen auch Beispielschlatungen
+beinhalten. Weiters sollen Informationen über die Korrekte Implementation eines
+R-2R-Netzwerkes und eines Parlellports, sowie einer Seriellen Schnittstelle
+beschaffen werden.
 
 Die Folgenden Tests zur Verifikation der bisherigen Arbeit wurden dafür 
 definiert:
 
-
-
 \begin{enumerate}
 
-	\item{Testname:}
+	\item{\textbf{Verifikation der PDFs auf Validität}:}
-		Testinhalt
+	\newline
+	
+	Zur überprüfung der PDFs, welche sich auf dem der Diplomarbeit
+	beigelegten Datenträger befinden, oder zum Zeitpunkt des Tests, dem
+	Betreuer per ZIP-Datei gesendet wurden, müssen diese in ein Verzeichnis
+	gelegt werden, welches keine Unterverzeichnisse besitzt, und welches
+	keine Dateien die nicht PDFs sind beinhaltet. PDF-Dateien sind Korrekt
+	nach PDF-1.7-Standart von Adobe
+	\footnote{
+	\url{https://archive.org/details/pdf320002008}}
+	zu implementieren, und darauf zu Überprüfen. Dafür wird folgendes Shell-
+	Skript verwendet:
+
+\begin{lstlisting}[language=bash,frame=trBL,
+	breaklines=true, breakautoindent=true, formfeed=\newpage,
+	label={lst:mst-t1},
+	caption={Shell-Skript zum Testen der PDF-Dokumente},
+	columns=flexible]
+
+#!/bin/bash
+
+for f in *.pdf; do
+	echo "########################################"
+	echo "Tesing $f..."
+	echo "########################################" >> ./logfile
+	if pdfinfo "$f" >> ./logfile; then
+		echo "$f is correct!"
+	else
+		echo "$f is broken!"
+	fi
+	echo "########################################"
+done
+
+\end{lstlisting}
+
+Das Programm pdfinfo des XpdfReaders muss auf dem System installiert sein.
+Jedes PDF muss diesen Test bestehen.
 
 \begin{table}[H]
 \centering
@@ -28,4 +68,86 @@ definiert:
 	\hline
 \end{tabular}
 \end{table}
+
+
+	\item{\textbf{Verifikation der Erklärung einer Seriellen Schnittstelle}:}
+	\newline
+	\begin{mdframed}[backgroundcolor=blue!20]
+		Dieser Test gilt dem INHALT der Dokumente und kann nicht 
+		Automatisiert durchgeführt werden. Er obliegt daher subjektiven
+		Einflüssen.
+
+	\end{mdframed}
+
+	Zu diesem Test soll überprüft werden ob die Funktion einer Seriellen
+	Schnittstelle ausreichend über die beschaffenen Dokumente Erklärt werden
+	kann. Die Definition von "Ausreichend" obliegt hierbei dem Tester wird
+	jedoch mit einer Fuktionsbeschreibung und einigen Beispielen und
+	Hardware-Schaltungen als aussreichend angenommen.
+
+\begin{table}[H]
+\centering
+\begin{tabular}{|c|c|}
+	\hline
+	\textbf{FAILURE} & \textbf{SUCCESS}\\
+	\hline
+	 & \\
+	\hline
+\end{tabular}
+\end{table}
+	
+	\item{\textbf{Verifikation der Erklärung einer Parallelen Schnittstelle}:}
+	\newline
+	\begin{mdframed}[backgroundcolor=blue!20]
+		Dieser Test gilt dem INHALT der Dokumente und kann nicht 
+		Automatisiert durchgeführt werden. Er obliegt daher subjektiven
+		Einflüssen.
+
+	\end{mdframed}
+
+	Zu diesem Test soll überprüft werden ob die Funktion einer Paralellen
+	Schnittstelle ausreichend über die beschaffenen Dokumente Erklärt werden
+	kann. Die Definition von "Ausreichend" obliegt hierbei dem Tester wird
+	jedoch mit einer Fuktionsbeschreibung und einigen Beispielen und
+	Hardware-Schaltungen als aussreichend angenommen.
+
+\begin{table}[H]
+\centering
+\begin{tabular}{|c|c|}
+	\hline
+
+	\textbf{FAILURE} & \textbf{SUCCESS}\\
+	\hline
+	 & \\
+	\hline
+\end{tabular}
+\end{table}
+	
+	\item{\textbf{Verifikation der Erklärung eines R-2R Netzwerks}:}
+	\newline
+	\begin{mdframed}[backgroundcolor=blue!20]
+		Dieser Test gilt dem INHALT der Dokumente und kann nicht 
+		Automatisiert durchgeführt werden. Er obliegt daher subjektiven
+		Einflüssen.
+
+	\end{mdframed}
+
+	Zu diesem Test soll überprüft werden ob die Funktion eines R-2R
+	DACs ausreichend über die beschaffenen Dokumente Erklärt werden
+	kann. Die Definition von "Ausreichend" obliegt hierbei dem Tester wird
+	jedoch mit einer Fuktionsbeschreibung und einigen Beispielen und
+	Hardware-Schaltungen als aussreichend angenommen.
+
+\begin{table}[H]
+\centering
+\begin{tabular}{|c|c|}
+	\hline
+
+	\textbf{FAILURE} & \textbf{SUCCESS}\\
+	\hline
+	 & \\
+	\hline
+\end{tabular}
+\end{table}
+
 \end{enumerate}

planung/DP/meilensteine/2.tex

@@ -1,6 +1,6 @@
 \subsection{2. Meilenstein - Serielle Schnitstelle}
 
-\textbf{Datum: 2019-01-10}
+\textbf{Datum: \sout{2020-01-10} 2019-12-10}
 
 Der 2. Meilenstein beschäftigt sich mit der Seriellen Schnittstelle, ihrer 
 Schaltung und der Verifikation selbiger. Die Dokumentation ihrer Funktionsweise

planung/DP/meilensteine/3.tex

@@ -1,7 +1,7 @@
-\subsection{3. Meilenstein - Soundbuffer}
+\subsection{3. Meilenstein - 8-Bit-Parallelport}
 
-\textbf{Datum: 2019-02-04}
+\textbf{Datum: \sout{2020-02-04} 2020-01-14}
 
-Der 3. Meilenstein beschäftigt sich mit der Schaltungsentwicklung des
+Der 3. Meilenstein beschäftigt sich mit der Schaltungsentwicklung eines
-Soundbuffers, der Funktionsweise eines Soundbuffers und der
+8-Bit IEE1284 Parallel-Port Interfaces, der Funktionsweise selbiger und der
 Schaltungsverifikation der entwickelten Schaltung.

planung/DP/meilensteine/4.tex

@@ -1,8 +1,8 @@
 \subsection{4. Meilenstein - Dokumentation}
 
-\textbf{Datum: 2019-02-25}
+\textbf{Datum: \sout{2020-02-25} 2020-02-12}
 
 Der 4. Meilenstein beschäftigt sich mit der Dokumentation der bisherigen
-Bauteile, namlich des Soundbuffers und der Seriellen Schnittstelle. Zu diesem
+Bauteile, namlich des Parallelports und der Seriellen Schnittstelle. Zu diesem
 Meilenstein soll die Dokumentation der Funktionsweise und der Implementation
 gefertigt werden.

planung/DP/meilensteine/5.tex

@@ -1,6 +1,6 @@
-\subsection{5. Meilenstein - Framebuffer}
+\subsection{5. Meilenstein - 4-Bit-DAC mit R-2R-Netz }
 
-\textbf{Datum: 2019-03-24}
+\textbf{Datum: \sout{2020-03-24} 2020-03-10}
 
 Der 5. Meilenstein beschäftigt sich mit der Dokumentation eines Framebuffers und
 der rein theoretischen implementierung selbigens.

planung/DP/meilensteine/mst.tex

@@ -1,2 +0,0 @@
-
-

planung/DP/planung.tex

@@ -3,11 +3,12 @@
 
 \paragraph{Anmerkung zu den Daten}
 
-Die Daten wurden den Vorgaben entsprechend gewählt, so wurden mindestens 2
+\sout{Die Daten wurden den Vorgaben entsprechend gewählt, so wurden mindestens 2
 Meilensteine in das Sommersemester hineingelegt. Die Meilensteine wurden
 auf Dienstage gelegt, da an diesem Wochentag bekannt ist dass der Betreuer
 sich im Gebäude der HTBLuVA befindet. Die Meilensteintermine wurden möglichst
-Äquidistant über den zur Verfügung stehenden Zeitbereich verteilt.
+Äquidistant über den zur Verfügung stehenden Zeitbereich verteilt.} Die Daten
+wurden vom Betreuer vorgegeben.
 
 \input{planung/DP/meilensteine/1.tex}
 \input{planung/DP/meilensteine/2.tex}
@@ -18,3 +19,5 @@ sich im Gebäude der HTBLuVA befindet. Die Meilensteintermine wurden möglichst
 \subsection{Zeitabschätzung}
 
 \input{planung/DP/aufwand.tex}
+
+\input{planung/DP/materialaufstellung.tex}

preamble.tex

@@ -1,4 +1,9 @@
 %based on xhversion{v3.01 SiU} %PdJ,PdL,PdM,PdS,PdU,Pe6,PeI,PfB,PfD,RbN,RbP,RcL,RdC,RdD,RdF,Sb7,ScN,SiT,SiU,Sj3,
+%
+% Inherited from Michale Reitmeir, 2019, adopted by tyrolyean 2020
+% adoption for usage with xelatex and a lot of stuff beeing thrown out because
+% xelatex doesn't care about them.
+%
 
 \listfiles			%lists included files while processing 'pdflatex'
 \documentclass[12pt,a4paper]{article}
@@ -15,6 +20,7 @@
 \usepackage{svg} % Allows the inclusion of SVG files
 
 \usepackage{amssymb}
+\usepackage{ulem}
 \usepackage{amsmath}
 \usepackage{amscd}
   %\usepackage{extarrows}	%\xleftrightarrow[obentext]{untentext}
@@ -279,4 +285,92 @@ minimum height=1cm, align=center, text width=3cm, draw=black, fill=blue!30]
 	%\hfill
 }%HtlHeader
 
+\lstnewenvironment{bash}
+{\lstset{numbers=left,language=bash,keywordstyle={\color{blue}}}}
+{}
+
+\definecolor{backcolour}{rgb}{0.95,0.95,0.92}
+\definecolor{codegray}{rgb}{0.5,0.5,0.5}
+\definecolor{background}{HTML}{EEEEEE}
+\definecolor{delim}{RGB}{20,105,176}
+\colorlet{numb}{magenta!60!black}
+\colorlet{punct}{red!60!black}
+
+
+\lstdefinestyle{cstyle}{
+    backgroundcolor=\color{backcolour},
+    commentstyle=\color{green},
+    keywordstyle=\color{red},
+    numberstyle=\tiny\color{codegray},
+    stringstyle=\color{purple},
+    basicstyle=\ttfamily,
+    breakatwhitespace=false,
+    breaklines=true,
+    captionpos=b,
+    keepspaces=true,
+    numbers=left,
+    showspaces=false,
+    showstringspaces=false,
+    showtabs=false,
+    tabsize=2
+}
+
+\lstdefinelanguage{json}{
+    basicstyle=\normalfont\ttfamily,
+    numbers=left,
+    numberstyle=\scriptsize,
+    stepnumber=1,
+    numbersep=8pt,
+    showstringspaces=false,
+    breaklines=true,
+    frame=lines,
+    backgroundcolor=\color{background},
+    literate=
+     *{0}{{{\color{numb}0}}}{1}
+      {1}{{{\color{numb}1}}}{1}
+      {2}{{{\color{numb}2}}}{1}
+      {3}{{{\color{numb}3}}}{1}
+      {4}{{{\color{numb}4}}}{1}
+      {5}{{{\color{numb}5}}}{1}
+      {6}{{{\color{numb}6}}}{1}
+      {7}{{{\color{numb}7}}}{1}
+      {8}{{{\color{numb}8}}}{1}
+      {9}{{{\color{numb}9}}}{1}
+      {:}{{{\color{punct}{:}}}}{1}
+      {,}{{{\color{punct}{,}}}}{1}
+      {\{}{{{\color{delim}{\{}}}}{1}
+      {\}}{{{\color{delim}{\}}}}}{1}
+      {[}{{{\color{delim}{[}}}}{1}
+      {]}{{{\color{delim}{]}}}}{1},
+}
+
+\lstdefinelanguage{bash}{
+    basicstyle=\normalfont\ttfamily,
+    numbers=left,
+    numberstyle=\scriptsize,
+    stepnumber=1,
+    numbersep=8pt,
+    showstringspaces=false,
+    breaklines=true,
+    frame=lines,
+    backgroundcolor=\color{background},
+    literate=
+     *{0}{{{\color{numb}0}}}{1}
+      {1}{{{\color{numb}1}}}{1}
+      {2}{{{\color{numb}2}}}{1}
+      {3}{{{\color{numb}3}}}{1}
+      {4}{{{\color{numb}4}}}{1}
+      {5}{{{\color{numb}5}}}{1}
+      {6}{{{\color{numb}6}}}{1}
+      {7}{{{\color{numb}7}}}{1}
+      {8}{{{\color{numb}8}}}{1}
+      {9}{{{\color{numb}9}}}{1}
+      {:}{{{\color{punct}{:}}}}{1}
+      {,}{{{\color{punct}{,}}}}{1}
+      {\{}{{{\color{delim}{\{}}}}{1}
+      {\}}{{{\color{delim}{\}}}}}{1}
+      {[}{{{\color{delim}{[}}}}{1}
+      {]}{{{\color{delim}{]}}}}{1},
+}
+
 \sloppy