2985 $ `\textbf{make modules}` |
2986 $ `\textbf{make modules}` |
2986 \end{lstlisting} |
2987 \end{lstlisting} |
2987 |
2988 |
2988 Table~\ref{tab:config} lists important configuration switches and options. |
2989 Table~\ref{tab:config} lists important configuration switches and options. |
2989 |
2990 |
2990 \begin{table} |
2991 \begin{longtable}{l|p{.4\textwidth}|l} |
2991 \caption{Configuration options} |
2992 \caption{Configuration options}\rule[-5ex]{0mm}{0mm} |
2992 \label{tab:config} |
2993 \label{tab:config}\\ |
2993 \vspace{2mm} |
2994 |
2994 \begin{tabular}{l|p{.3\textwidth}|l} |
2995 \textbf{Option/Switch} & \textbf{Description} & \textbf{Default}\\\hline |
2995 |
2996 \endfirsthead |
2996 \bf Option/Switch & \bf Description & \bf Default\\\hline |
2997 |
|
2998 \textbf{Option/Switch} & \textbf{Description} & \textbf{Default}\\\hline |
|
2999 \endhead |
2997 |
3000 |
2998 \lstinline+--prefix+ & Installation prefix & \textit{/opt/etherlab}\\ |
3001 \lstinline+--prefix+ & Installation prefix & \textit{/opt/etherlab}\\ |
2999 |
3002 |
3000 \lstinline+--with-linux-dir+ & Linux kernel sources & Use running kernel\\ |
3003 \lstinline+--with-linux-dir+ & Linux kernel sources & Use running kernel\\ |
3001 |
3004 |
|
3005 \lstinline+--with-module-dir+ & Subdirectory in the kernel module tree, where |
|
3006 the EtherCAT kernel modules shall be installed. & \textit{ethercat}\\ |
|
3007 |
|
3008 \hline |
|
3009 |
|
3010 \lstinline+--enable-generic+ & Build the generic Ethernet driver (see |
|
3011 sec.~\ref{sec:generic-driver}). & no\\ |
|
3012 |
|
3013 \lstinline+--enable-8139too+ & Build the 8139too driver & yes\\ |
|
3014 |
|
3015 \lstinline+--with-8139too-kernel+ & 8139too kernel & $\dagger$\\ |
|
3016 |
|
3017 \lstinline+--enable-e100+ & Build the e100 driver & no\\ |
|
3018 |
|
3019 \lstinline+--with-e100-kernel+ & e100 kernel & $\dagger$\\ |
|
3020 |
|
3021 \lstinline+--enable-e1000+ & Enable e1000 driver & no\\ |
|
3022 |
|
3023 \lstinline+--with-e1000-kernel+ & e1000 kernel & $\dagger$\\ |
|
3024 |
|
3025 \lstinline+--enable-e1000e+ & Enable e1000e driver & no\\ |
|
3026 |
|
3027 \lstinline+--with-e1000e-kernel+ & e1000e kernel & $\dagger$\\ |
|
3028 |
|
3029 \lstinline+--enable-r8169+ & Enable r8169 driver & no\\ |
|
3030 |
|
3031 \lstinline+--with-r8169-kernel+ & r8169 kernel & $\dagger$\\ |
|
3032 |
|
3033 \hline |
|
3034 |
3002 \lstinline+--with-rtai-dir+ & RTAI path (only for RTAI example) & \\ |
3035 \lstinline+--with-rtai-dir+ & RTAI path (only for RTAI example) & \\ |
3003 |
3036 |
3004 \hline |
3037 \lstinline+--enable-debug-if+ & Create a debug interface for each master & no\\ |
|
3038 |
|
3039 \lstinline+--enable-debug-ring+ & Create a debug ring to record frames & no\\ |
|
3040 |
|
3041 \lstinline+--enable-eoe+ & Enable EoE support & yes\\ |
|
3042 |
|
3043 \lstinline+--enable-cycles+ & Use CPU timestamp counter. Enable this on Intel |
|
3044 architecture to get finer timing calculation. & no\\ |
|
3045 |
|
3046 \lstinline+--enable-hrtimer+ & Use high-resolution timer to let the master |
|
3047 state machine sleep between sending frames. & no\\ |
|
3048 |
|
3049 \lstinline+--enable-regalias+ & Read alias address from register. & no\\ |
3005 |
3050 |
3006 \lstinline+--enable-tool+ & Build the command-line tool ``ethercat'' (see |
3051 \lstinline+--enable-tool+ & Build the command-line tool ``ethercat'' (see |
3007 sec.~\ref{sec:tool}). & yes\\ |
3052 sec.~\ref{sec:tool}). & yes\\ |
3008 |
3053 |
3009 \lstinline+--enable-userlib+ & Build the userspace library. & yes\\ |
3054 \lstinline+--enable-userlib+ & Build the userspace library. & yes\\ |
3010 |
3055 |
3011 \lstinline+--enable-eoe+ & Enable EoE support & yes\\ |
3056 \lstinline+--enable-tty+ & Build the TTY driver. & no\\ |
3012 |
3057 |
3013 \lstinline+--enable-cycles+ & Use CPU timestamp counter. Enable this on Intel |
3058 \lstinline+--enable-wildcards+ & Enable \textit{0xffffffff} to be wildcards |
3014 architecture to get finer timing calculation. & no\\ |
3059 for vendor ID and product code. & no\\ |
3015 |
|
3016 \lstinline+--enable-debug-if+ & Create a debug interface for each master & no\\ |
|
3017 |
|
3018 \lstinline+--enable-debug-ring+ & Create a debug ring to record frames & no\\ |
|
3019 |
3060 |
3020 \hline |
3061 \hline |
3021 |
3062 |
3022 \lstinline+--enable-8139too+ & Build the 8139too driver & yes\\ |
3063 \end{longtable} |
3023 |
|
3024 \lstinline+--with-8139too-kernel+ & 8139too kernel & $\dagger$\\ |
|
3025 |
|
3026 \lstinline+--enable-e100+ & Build the e100 driver & no\\ |
|
3027 |
|
3028 \lstinline+--with-e100-kernel+ & e100 kernel & $\dagger$\\ |
|
3029 |
|
3030 \lstinline+--enable-e1000+ & Enable e1000 driver & no\\ |
|
3031 |
|
3032 \lstinline+--with-e1000-kernel+ & e1000 kernel & $\dagger$\\ |
|
3033 |
|
3034 \lstinline+--enable-e1000e+ & Enable e1000e driver & no\\ |
|
3035 |
|
3036 \lstinline+--with-e1000e-kernel+ & e1000e kernel & $\dagger$\\ |
|
3037 |
|
3038 \lstinline+--enable-r8169+ & Enable r8169 driver & no\\ |
|
3039 |
|
3040 \lstinline+--with-r8169-kernel+ & r8169 kernel & $\dagger$\\ |
|
3041 |
|
3042 \lstinline+--enable-generic+ & Build the generic Ethernet driver (see |
|
3043 sec.~\ref{sec:generic-driver}). & no\\ |
|
3044 |
|
3045 \end{tabular} |
|
3046 \vspace{2mm} |
|
3047 |
3064 |
3048 \begin{description} |
3065 \begin{description} |
3049 |
3066 |
3050 \item[$\dagger$] If this option is not specified, the kernel version to use is |
3067 \item[$\dagger$] If this option is not specified, the kernel version to use is |
3051 extracted from the Linux kernel sources. |
3068 extracted from the Linux kernel sources. |
3052 |
3069 |
3053 \end{description} |
3070 \end{description} |
3054 |
|
3055 \end{table} |
|
3056 |
3071 |
3057 \section{Building the Interface Documentation} |
3072 \section{Building the Interface Documentation} |
3058 \label{sec:gendoc} |
3073 \label{sec:gendoc} |
3059 |
3074 |
3060 The source code is documented using Doxygen~\cite{doxygen}. To build the HTML |
3075 The source code is documented using Doxygen~\cite{doxygen}. To build the HTML |