]> rtime.felk.cvut.cz Git - can-eth-gw.git/blob - doc/can-eth-gw.tex
6993dbdcdfc7191756af5c94212f01e66816fd2f
[can-eth-gw.git] / doc / can-eth-gw.tex
1 %
2 % Typographic conventions (already applied)
3 % * Each \caption{} should end with a dot
4 % * "Linux traffic control" will be written with lowercase T and C
5 %
6 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7
8 \documentclass[11pt,abstract]{scrreprt}
9 \usepackage[utf8]{inputenc}
10 % \usepackage[T1]{fontenc}
11 \usepackage[right]{lineno}
12 \usepackage{fixltx2e}
13 \usepackage{graphicx}
14 \usepackage{longtable}
15 \usepackage{tabularx}
16 \usepackage{float}
17 \usepackage{wrapfig}
18 \usepackage{soul}
19 % \usepackage{t1enc}
20 \usepackage{textcomp}
21 \usepackage{marvosym}
22 \usepackage{wasysym}
23 \usepackage{latexsym}
24 \usepackage{amssymb}
25 \usepackage{hyperref}
26 \usepackage{multirow}
27 \usepackage{tikz}
28 \usepackage[draft]{fixme}
29 \usepackage{vertbars} 
30 \usepackage{fancyvrb}
31 \usepackage{appendix}
32 \usepackage{listings}
33 \usepackage{color}
34
35 %\usepackage{multicol}
36 \hypersetup{
37         breaklinks = true, %allow links to break over lines
38         pdffitwindow = true, %resize document window to fit document size
39         colorlinks = true,
40 %       linkcolor = darkblue,
41 %       citecolor = darkblue,
42 %       urlcolor = darkblue,
43         linkcolor = black,
44         citecolor = black,
45         urlcolor = black,
46         plainpages=false,
47         }
48 %\urlstyle{same}
49
50 \RecustomVerbatimEnvironment{Verbatim}{Verbatim}{frame=single,framesep=4pt}
51
52
53 \setlength{\columnsep}{8mm}
54 \providecommand{\alert}[1]{\textbf{#1}}
55
56 \title{Linux-Based CAN-Ethernet Gateway}
57 \author{R. Matějka, M. Sojka\\
58 Czech Technical University in Prague}
59 \providecommand{\version}{???}
60 \date{\today\\Version \version}
61
62 \newcommand{\superscript}[1]{\ensuremath{^{\mathrm{#1}}}}
63 \newcommand{\subscript}[1]{\ensuremath{_{\mathrm{#1}}}}
64 \renewcommand{\th}[0]{\superscript{th}}
65 \renewcommand{\st}[0]{\superscript{st}}
66 \newcommand{\nd}[0]{\superscript{nd}}
67 \newcommand{\rd}[0]{\superscript{rd}}
68
69 \newenvironment{todo}
70 {\begin{vertbar}\begin{itshape}}
71     {\end{itshape}\end{vertbar}}
72 \pagestyle{headings}
73 \begin{document}
74 \lstset{language=sh,frame=single,basicstyle=\tt,commentstyle=\itshape\color{gray},columns=flexible}
75 %\linenumbers
76 %\onecolumn
77 \maketitle
78
79 % \begin{abstract}
80 % \end{abstract}
81
82 \tableofcontents
83
84 \chapter{Assignment}
85 \label{cha:assignment}
86
87 The goal is to implement CAN-Ethernet gateway based on Linux's AF\_CAN
88 subsystem with the following features:
89 \begin{enumerate}
90 \item Both user- and kernel-space implementations will be developed.
91   User-space one will contain only the most basic functionality.
92 \item Ethernet side will use UDP datagrams to carry the CAN messages.
93   Later it will be extended to support also TCP.
94 \item Initial version will route all CAN frames to Ethernet side and
95   all received UDP datagrams to CAN messages. Later, filtering
96   capabilities will be added.
97 \item UDP frames will contain timestamps of the time when the CAN
98   message was received.
99 \item For kernel-based gateway, implement a user-space configuration
100   tool, similar to \texttt{cangw} tool from \texttt{can-utils}.
101 \end{enumerate}
102 % \bibliography{can-eth-gw}
103 % \bibliographystyle{IEEEtran}
104
105 \end{document}
106
107 %%% Local Variables:
108 %%% mode: latex
109 %%% TeX-master: t
110 %%% ispell-local-dictionary: american
111 %%% End: