Commit d6ba883f authored by Stefan Tauner's avatar Stefan Tauner
Browse files

Unify latex docs

 - cover page:
    * remove explicit copyright notice
    * add same acknowledgment as in papers
 - use a single main makefile
 - move together common images
 - set image search path to common_tex/img
 - include a unified tex header file
parent 67228401
% This file was created with JabRef 2.9.2.
% Encoding: Cp1252
@misc{oregano8051,
title = {{MC8051 IP Core -- Overview V1.3}},
year = {2013},
author = {{Oregano Systems}},
howpublished = {\url{http://www.oreganosystems.at/}}
}
@misc{tableLFSR,
title = {{Table of Linear Feedback Shift Registers}},
year = {2007},
author = {Roy Ward and Tim Molteno},
howpublished = {\url{http://www.eej.ulst.ac.uk/~ian/modules/EEE515/files/old_files/lfsr/lfsr_table.pdf}}
}
@misc{synpmanual,
title = {{Synopsys FPGA Synthesis User Guide}},
year = {2013},
month = {September},
author = {{Synopsys, Inc.}}
}
\ No newline at end of file
\section{Introduction}
Silence bibtex error \cite{adams2007hitchhiker}
FIJI allows to instrument user-selected nets of an existing FPGA design
with fault injection units (\acp{FIU}). For each affected net there exists
......
......@@ -71,7 +71,7 @@ support three modes:
\item Random: \todo{command line usage/features and/or batch configuration file etc.}
\end{enumerate}
\subsection{Specification of \ac{FIJI} Settings}
\subsection{Specification of FIJI Settings}
The \ac{FIJI} Settings are organized in blocks of key-value pairs represented
in the same format as common .ini files:
......
......@@ -68,7 +68,7 @@ Fault injection units are daisy-chained in fault\_injection\_top as described in
\begin{table}
\caption{Design Constants}
\input{content/tab_public_vhdl_constants.tex}
\label{tab:consts}
\label{tab:vhdl_consts}
\end{table}
\begin{table}
......
% Copyright page
\clearpage
\thispagestyle{empty}
\null\vfill
\begingroup
\setlength{\parindent}{0pt}
\setlength{\parskip}{\baselineskip}
Copyright \textcopyright{} \the\year{} by UAS Technikum Wien. Some rights reserved.
This document was created in the context of the research project
``Josef Ressel Centre for Verification of Embedded Computing Systems''
at the University of Applied Sciences Technikum Wien, Department of Embedded Systems.
\makeatletter
\textit{Address:} University of Applied Sciences Technikum Wien\\
Department of Embedded Systems\\
Hoechstaedtplatz 6\\
A-1200 Vienna, Austria
\makeatother
\url{http://embsys.technikum-wien.at}
\endgroup
\clearpage
\thispagestyle{empty}
\begin{picture}(0,0)
\color{twgray}
\sffamily
\fontfamily{phv}
\selectfont
\put(-56,-150){\includegraphics[width=\paperwidth]{style/jrc_logo.pdf}}
\put(-10,-380){\bfseries\huge Josef Ressel Centre for}
\put(-10,-415){\bfseries\huge Verification of Embedded Computing Systems}
\put(-10,-460){\Large FIJI Technical Reference Manual}
\put(-10,-480){\Large Authors: Christian Fibich, Stefan Tauner}
\put(-10,-500){\Large Revision: 0.1}
\put(250,-705){\includegraphics[width=0.15\textwidth]{img/fiji_logo.pdf}}
\put(350,-710){\includegraphics[width=0.3\textwidth]{style/fhtw_logo.pdf}}
\put(-10,-647){UAS Technikum Wien}
\put(-10,-665){H\"ochst\"adtplatz 6, A-1200 Vienna}
\put(-10,-683){I: www.technikum-wien.at}
\put(-10,-701){E: \{fibich, tauner\}@technikum-wien.at}
\color{black}
\end{picture}
\newpage
% For longer reports use: (starts with chapter) %
% \documentclass[a4paper,bibtotoc,oneside,halfparskip]{scrbook}
% For short reports use: (starts with section) %
\documentclass[a4paper,bibtotoc,oneside,halfparskip]{scrartcl}
\input{../tex_common/header.tex}
\usepackage[colorlinks=true,
linkcolor=black,
citecolor=black,
filecolor=black,
pagecolor=black,
urlcolor=black,
bookmarks=true,
bookmarksopen=true,
bookmarksopenlevel=3,
plainpages=false,
pdfpagelabels=true]{hyperref}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage[ngerman,english]{babel}
\usepackage{enumerate}
\usepackage{amsmath,amssymb,amsfonts,amstext}
\usepackage{keystroke}
\usepackage{textcomp}
\usepackage{booktabs}
\usepackage{multirow}
\usepackage{pdflscape}
% Use more powerful glossaries instead of acronym (requires a "makeglossary") %
\usepackage[acronym,toc,shortcuts,nomain,nonumberlist]{glossaries}
% Use multicol for the definition of the glossary style %
\usepackage{multicol}
% Define the look of the glossary %
\newglossarystyle{myAcroStyle}{%
\glossarystyle{list}%
\renewcommand*{\glspostdescription}{}%
\renewcommand*{\glsgroupskip}{}%
\renewcommand*{\glossarypreamble}{\begin{multicols*}{2}}%
\renewcommand*{\glossarypostamble}{\end{multicols*}}%
}
% Redefine the acro command (from acronym) to be used with glossaries %
\newcommand{\acro}[2]{\newacronym{#1}{#1}{#2}}
% Initiate glossaries %
\makeglossaries
% Load acronym definitions from separate file %
\input{abbreviations.tex}
\usepackage{float}
% Can be used to generate blindtext to get a preliminary "look and feel" %
\usepackage{blindtext}
\usepackage{fancyhdr}
\lfoot[\fancyplain{}{}]{\fancyplain{}{}}
\rfoot[\fancyplain{}{}]{\fancyplain{}{}}
\cfoot[\fancyplain{}{\footnotesize\thepage}]{\fancyplain{}{\footnotesize\thepage}}
\lhead[\fancyplain{}{\footnotesize\nouppercase\leftmark}]{\fancyplain{}{}}
\chead{}
\rhead[\fancyplain{}{}]{\fancyplain{}{\footnotesize\nouppercase\sc\leftmark}}
% Use of an extended color table %
\usepackage{xcolor}
\usepackage{color}
\usepackage{colortbl}
% Define the FHTW corporate design colors %
\definecolor{twgray}{RGB}{99,106,111}
\definecolor{twgreen}{RGB}{0,146,110}
\definecolor{twblue}{RGB}{10,143,217}
% Caption package to define caption style of images, tables, etc. %
\usepackage{caption}
\captionsetup[table]{singlelinecheck=false}
% Use cleveref to reference sections, chapters, etc. (\cref{} & \Cref{}) %
\usepackage{cleveref}
% Can be used to append pages of an existing PDF document %
%\usepackage{pdfpages}
% Can be used to define the hierarchy depth appearing in the TOC %
%\usepackage{tocvsec2}
%\settocdepth{section}
% % % % % Listings % % % % % % % % % % % % % % % % % % % % % % % % % % % % % %
% Use listings for listings %
\usepackage{listings}
% Define the listings caption (=> "Listing #No - Title")
\DeclareCaptionFormat{listing}{\par\vskip1pt#1#2- #3}
\captionsetup[lstlisting]{format=listing,singlelinecheck=false,margin=0pt,font={sf},labelsep=space,labelfont=bf}
% % % VHDL % % %
\lstdefinestyle{VHDL}{
language = VHDL,
%numbers=left,
%numberstyle=\tiny,
% More Keywords taken from Patricks Example %
morekeywords = {
library,use,all,entity,is,port,in,out,end,architecture,of,
begin,and,not,xor,or,mod,abs,*,/,rm,+,-,&,sll,srl,sla,sra,rol,ror,
nand,nor,xnor, if, elsif, else, then, downto
},
morecomment = [l]--,
tabsize = 4,
showstringspaces = false,
basicstyle = \footnotesize\ttfamily,
keywordstyle = \color{blue!100!black!80}\bfseries,
commentstyle = \itshape\color{green!40!black},
stringstyle = \color{purple!40!black},
}
% % % XML % % %
\lstdefinestyle{XML}{
language = XML,
%numbers=left,
%numberstyle=\tiny,
columns = fullflexible,
tabsize = 4,
showstringspaces = false,
morestring=[b]",
morecomment=[s]{<?}{?>},
morecomment=[s][\color{green!40!black}]{<!--}{-->},
morekeywords={version,type}, % list your attributes here
emph={},
emphstyle=\color{red!40!black},
basicstyle = \footnotesize\ttfamily,
commentstyle = \itshape\color{green!40!black},
keywordstyle = \color{blue!100!black!80}\bfseries,
stringstyle = \color{purple!40!black},
tagstyle = \color{blue!100!black!80}\bfseries,
}
% % % C % % %
\lstdefinestyle{C}{
language = C,
%numbers=left,
%numberstyle=\tiny,
belowcaptionskip = 1\baselineskip,
breaklines = true,
xleftmargin = \parindent,
tabsize = 4,
showstringspaces = false,
basicstyle = \footnotesize\ttfamily,
keywordstyle = \color{blue!100!black!80}\bfseries,
commentstyle = \itshape\color{green!40!black},
stringstyle = \color{purple!40!black},
}
% % % PERL % % %
\lstdefinestyle{Perl}{
language = Perl,
%numbers=left,
%numberstyle=\tiny,
tabsize=4,
columns=fixed,
showstringspaces=false,
showtabs=false,
keepspaces,
basicstyle = \footnotesize\ttfamily,
keywordstyle = \color{blue!100!black!80}\bfseries,
commentstyle = \itshape\color{green!40!black},
stringstyle = \color{purple!40!black},
}
% % % INI % % %
\lstdefinestyle{Ini}{
%numbers=left,
%numberstyle=\tiny,
morecomment = [l][\color{purple!40!black}]{//},
morecomment = [s][\color{blue!100!black!80}]{[}{]},
morecomment = [l][\textrm]{[...]},
columns = fixed, %fullflexible
morestring = [b]"
showstringspaces = false,
basicstyle = \footnotesize\ttfamily,
}
% % % MATHLAB % % %
\lstdefinestyle{Mathlab}{
language = Matlab,
%numbers = left,
%numberstyle = \tiny,
breaklines = true,
showstringspaces = false,
basicstyle = \footnotesize\ttfamily,
keywordstyle = \color{blue!100!black!80}\bfseries,
commentstyle = \itshape\color{green!40!black},
stringstyle = \color{purple!40!black},
identifierstyle = \color{blue!100!black!80}\bfseries,
}
% % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % %
\usepackage{float}
\usepackage{array}
\usepackage{lmodern} % Latin Modern font
\usepackage[scaled=0.85]{beramono}
\usepackage[toc,page]{appendix}
\usepackage[pdftex]{graphicx}
\usepackage{tikz}
\usepackage[margin=2cm]{geometry}
\usetikzlibrary{
calc,%
arrows,%
folding,%
patterns,%
plotmarks,%
shapes.geometric,%
shapes.misc,%
shapes.symbols,%
shapes.arrows,%
shapes.multipart,%
automata,%
backgrounds,%
chains,%
topaths,%
trees,%
mindmap,%
positioning,%
decorations,%
decorations.fractals,%
decorations.shapes,%
decorations.text,%
decorations.pathmorphing,%
decorations.pathreplacing,%
decorations.markings,%
shadows}
\usepackage{tikz-timing}
\usetikztiminglibrary{overlays}
\usepackage{bytefield}
\DeclareMathDelimiter{\bsp}{\mathopen} {symbols}{"00}{symbols}{"00}
% Define global page properties %
\setlength{\textheight}{245mm}
%\setlength{\textheight}{225mm}
%\setlength{\textwidth}{1.025\textwidth}
\sloppy
% Load global definitions
\input{global_defines.tex}
\def\title{FIJI Technical Reference Manual}
\begin{document}
......@@ -247,10 +8,7 @@
\pagestyle{fancy}
% Cover page:
\input{cover_page.tex}
% Copyright page:
\input{copyright.tex}
\input{../tex_common/cover_page.tex}
\tableofcontents\thispagestyle{empty}
\newpage
......@@ -271,7 +29,7 @@
% Bibliography
\bibliographystyle{IEEEtran}
\bibliography{Bibliography}
\bibliography{../tex_common/Bibliography}
% List of Figures %
\listoffigures
......@@ -281,6 +39,10 @@
\listoftables
\addcontentsline{toc}{section}{\nonumberline List of Tables}
\renewcommand*{\lstlistlistingname}{List of Listings}
\lstlistoflistings
\addcontentsline{toc}{section}{\nonumberline List of Listings}
% List of Abbreviations %
\printglossary[style=myAcroStyle,type=acronym,title=List of Abbreviations,toctitle=List of Abbreviations]
......
JOB ?= fiji_trm
TEX_MAIN ?= $(JOB)
# trailing / is important below
OUTDIR := ./
#shell escape needed for epstopdf, svg2pdf etc.
# TEX := pdflatex -shell-escape -output-directory $(OUTDIR) -jobname $(JOB)
TEX := pdflatex -shell-escape -jobname $(JOB)
BIB := bibtex
IDX := makeindex
# ACR := /home/bla/bin/makeglossaries -d $(OUTDIR)
ACR := makeglossaries
VIEW := "gnome-open"
CWD := $(shell pwd)
TEX_OUT := $(OUTDIR)$(JOB).pdf
#all: $(TEX_OUT)
all: view
fast:
$(TEX) $(TEX_MAIN).tex
"$(VIEW)" "$(CWD)/$(TEX_OUT)"
view: $(TEX_OUT)
"$(VIEW)" "$(CWD)/$(TEX_OUT)"
clean:
rm -f $(OUTDIR)*.aux $(OUTDIR)*.bcf $(OUTDIR)*.bbl $(OUTDIR)*-blx.bib $(OUTDIR)*.run.xml $(OUTDIR)*.idx $(OUTDIR)*.ilg $(OUTDIR)*.lot $(OUTDIR)*.lof $(OUTDIR)*.blg $(OUTDIR)*.alg $(OUTDIR)*.ind $(OUTDIR)*.toc $(OUTDIR)*.acl $(OUTDIR)*.acn $(OUTDIR)*.acr $(OUTDIR)*.out $(OUTDIR)*.log $(OUTDIR)*.gls $(OUTDIR)*.glo $(OUTDIR)*.glg $(OUTDIR)*.ist $(OUTDIR)*.brf $(OUTDIR)*.ver $(OUTDIR)*.hst $(OUTDIR)*.glsdefs
$(JOB).pdf: *.tex content/*.tex img/*.pdf *.bib content/protocol_host_to_fic.tex
$(TEX) $(TEX_MAIN)
$(BIB) $(OUTDIR)$(JOB)
#$(IDX) $(OUTDIR)$(JOB).idx
$(ACR) $(JOB)
$(TEX) $(TEX_MAIN)
#$(ACR) $(JOB)
$(TEX) $(TEX_MAIN)
content/protocol_host_to_fic.tex: bin/generate_host_to_fic_protocol.sh
bin/generate_host_to_fic_protocol.sh > $@
.PHONY = clean view all fast
include ../tex_common/makefile.mk
\acro{LOC}{Lines Of Code}
\acro{DUT}{Design under Test}
\acro{FIC}{Fault Injection Controller}
\acro{FIJIEE}{\ac{FIJI} Execution Engine}
\acro{FIJI}{Fault InJection Instrumenter}
\acro{FIU}{Fault Injection Unit}
\acro{LFSR}{Linear Feedback Shift Register}
\acro{LOC}{Lines Of Code}
\acro{LUT}{Look-up Table}
\acro{SEU}{Single Event Upset}
\acro{FIC}{Fault Injection Controller}
\acro{DUT}{Design under Test}
\acro{UART}{Universal Asynchronous Receiver Transmitter}
\acro{LFSR}{Linear Feedback Shift Register}
\acro{VM}{Verilog Mapping}
\acro{VQM}{Verilog Quartus Mapping}
\acro{WWW}{World Wide Web}
\thispagestyle{empty}
\begin{picture}(0,0)
{
\color{twgray}
\hypersetup{urlcolor=twgray}
\sffamily
\fontfamily{phv}
\selectfont
\put(-60,-150){\includegraphics[width=\paperwidth]{img/jrc_logo.pdf}}
\put(-10,-350){\bfseries\huge \title}
\put(-10,-380){\Large Authors: Christian Fibich, Stefan Tauner}
\put(250,-682){\includegraphics[height=84pt]{img/fiji_logo.pdf}}
\put(350,-680){\includegraphics[height=80pt]{img/fhtw_logo.pdf}}
\put(-10,-617){UAS Technikum Wien}
\put(-10,-635){Höchstädtplatz 6, A-1200 Vienna}
\put(-10,-653){I: \href{http://embsys.technikum-wien.at}{http://embsys.technikum-wien.at}}
\put(-10,-670){E: \{\href{mailto:fibich@technikum-wien.at}{fibich}, \href{mailto:tauner@technikum-wien.at}{tauner}@\href{mailto:fibich@technikum-wien.at,tauner@technikum-wien.at}{technikum-wien.at}}
\put(-10,-730){\begin{minipage}{1.05\textwidth}
\small
The creation of this document has been supported by the publicly funded R\&D project ``Josef Ressel Center for Verification of Embedded Computing Systems (VECS)'' managed by the Christian Doppler Gesellschaft (CDG).
\end{minipage}}
}
\end{picture}
\newpage
% For longer reports use: (starts with chapter) %
% \documentclass[a4paper,bibtotoc,oneside,parskip=half]{scrbook}
% For short reports use: (starts with section) %
\documentclass[a4paper,bibliography=totoc,oneside,parskip=half]{scrartcl}
\usepackage[colorlinks=true,
linkcolor=black,
citecolor=black,
filecolor=black,
urlcolor=black,
bookmarks=true,
bookmarksopen=true,
bookmarksopenlevel=3,
plainpages=false,
pdfpagelabels=true]{hyperref}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage[ngerman,english]{babel}
\usepackage{enumerate}
\usepackage[shortlabels]{enumitem}
\setlist[description]{style=nextline}
\usepackage{keystroke}
\usepackage{textcomp}
\usepackage{booktabs}
\usepackage{multirow}
\usepackage{pdflscape}
\usepackage{ulem} % make \emph underlined instead of italics
% Use more powerful glossaries instead of acronym (requires a "makeglossary") %
\usepackage[acronym,toc,shortcuts,nomain,nonumberlist]{glossaries}
% Use multicol for the definition of the glossary style %
\usepackage{multicol}
% Define the look of the glossary %
\newglossarystyle{myAcroStyle}{%
\setglossarystyle{list}%
\renewcommand*{\glspostdescription}{}%
\renewcommand*{\glsgroupskip}{}%
\renewcommand*{\glossarypreamble}{\begin{multicols*}{2}}%
\renewcommand*{\glossarypostamble}{\end{multicols*}}%
}
% Redefine the acro command (from acronym) to be used with glossaries %
\newcommand{\acro}[2]{\newacronym{#1}{#1}{#2}}
% Initiate glossaries %
\makeglossaries
% Load acronym definitions from separate file %
\input{../tex_common/abbreviations.tex}
\usepackage{float}
% Can be used to generate blindtext to get a preliminary "look and feel" %
\usepackage{blindtext}
\usepackage{fancyhdr}
\lfoot[\fancyplain{}{}]{\fancyplain{}{}}
\rfoot[\fancyplain{}{}]{\fancyplain{}{}}
\cfoot[\fancyplain{}{\footnotesize\thepage}]{\fancyplain{}{\footnotesize\thepage}}
\lhead[\fancyplain{}{\footnotesize\nouppercase\leftmark}]{\fancyplain{}{}}
\chead{}
\rhead[\fancyplain{}{}]{\fancyplain{}{\footnotesize\nouppercase\scshape\leftmark}}
% center captions, even for tables
\addtokomafont{caption}{\centering}
% Use of an extended color table %
\usepackage[svgnames]{xcolor}
\usepackage{color}
\usepackage{colortbl}
% Define the FHTW corporate design colors %
\definecolor{twgray}{RGB}{99,106,111}
\definecolor{twgreen}{RGB}{0,146,110}
\definecolor{twblue}{RGB}{10,143,217}
% Caption package to define caption style of images, tables, etc. %
\usepackage{caption}
\captionsetup[table]{singlelinecheck=false}
% Use cleveref to reference sections, chapters, etc. (\cref{} & \Cref{}) %
\usepackage{cleveref}
% Can be used to append pages of an existing PDF document %
%\usepackage{pdfpages}
% Can be used to define the hierarchy depth appearing in the TOC %
%\usepackage{tocvsec2}
%\settocdepth{section}
% % % % % Listings % % % % % % % % % % % % % % % % % % % % % % % % % % % % % %
% Use listings for listings %
\usepackage{listings}
\renewcommand{\lstlistingname}{Listing}
\lstdefinestyle{plain}{
language={},
identifierstyle=\color{black},
}
\lstset{%
upquote=true,
stepnumber=1,
% numbers=left,
% numberstyle=\footnotesize\ttfamily,
% numbersep=10pt,
showlines=true,
captionpos=b,
frame=single,
aboveskip=5pt,
belowskip=5pt,
showtabs=true,
tabsize=4,
basicstyle = \footnotesize\ttfamily,
emphstyle=\color{red!40!black},
commentstyle = \itshape\color{green!40!black},
keywordstyle = \color{blue!100!black!80}\bfseries,
stringstyle = \color{purple!40!black},
identifierstyle = \color{blue!100!black!80}\bfseries,
breaklines = true,
columns = fixed,
style=plain,
}
% % % VHDL % % %
\lstdefinestyle{VHDL}{
language = VHDL,
% More Keywords taken from Patricks Example %
morekeywords = {
library,use,all,entity,is,port,in,out,end,architecture,of,
begin,and,not,xor,or,mod,abs,*,/,rm,+,-,&,sll,srl,sla,sra,rol,ror,
nand,nor,xnor, if, elsif, else, then, downto
},
morecomment = [l]--,
}