diff options
| -rw-r--r-- | docs/Makefile | 2 | ||||
| -rw-r--r-- | docs/config.tex | 4 | ||||
| -rw-r--r-- | docs/openwrt.tex | 60 | ||||
| -rw-r--r-- | docs/wireless.tex | 103 |
4 files changed, 133 insertions, 36 deletions
diff --git a/docs/Makefile b/docs/Makefile index 0a41287..8ee4680 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,4 +1,4 @@ -openwrt.pdf: Makefile openwrt.tex config.tex network.tex network-scripts.tex +openwrt.pdf: Makefile openwrt.tex config.tex network.tex network-scripts.tex network-scripts.tex wireless.tex $(MAKE) cleanup pdflatex openwrt.tex pdflatex openwrt.tex diff --git a/docs/config.tex b/docs/config.tex index 44b6689..acb4bdf 100644 --- a/docs/config.tex +++ b/docs/config.tex @@ -9,8 +9,8 @@ it was written under. Syntax: \begin{Verbatim} -config <type> [<name>] # Section - option <name> <value> # Option +config <type> [<name>] # Section + option <name> <value> # Option \end{Verbatim} Every parameter needs to be a single string and is formatted exactly diff --git a/docs/openwrt.tex b/docs/openwrt.tex index ff58169..f1269e2 100644 --- a/docs/openwrt.tex +++ b/docs/openwrt.tex @@ -10,39 +10,33 @@ \tableofcontents \chapter{The Router} -\section{Getting started} -\subsection{Installation} -\subsection{Initial configuration} -\subsection{Failsafe mode} -\section{Configuring OpenWrt} -\subsection{Network} -\include{network} - -\subsection{Wireless} - -\section{Advanced configuration} -\include{config} - -\subsection{Hotplug} -\subsection{Init scripts} -\include{init-scripts} -\subsection{Network scripts} -\include{network-scripts} - + \section{Getting started} + \subsection{Installation} + \subsection{Initial configuration} + \subsection{Failsafe mode} + \section{Configuring OpenWrt} + \subsection{Network} + \input{network} + \subsection{Wireless} + \input{wireless} + \section{Advanced configuration} + \input{config} + \subsection{Hotplug} + \subsection{Init scripts} + \input{init-scripts} + \subsection{Network scripts} + \input{network-scripts} \chapter{Development issues} -\section{The build system} -\subsection{Building an image} -\subsection{Integrating packages} -\subsection{Creating packages} - -\section{Extra tools} -\subsection{Image Builder} -\subsection{SDK} - -\section{Adding platform support} -\section{Debugging and debricking} -\subsection{Adding a serial port} -\subsection{JTAG} - + \section{The build system} + \subsection{Building an image} + \subsection{Integrating packages} + \subsection{Creating packages} + \section{Extra tools} + \subsection{Image Builder} + \subsection{SDK} + \section{Adding platform support} + \section{Debugging and debricking} + \subsection{Adding a serial port} + \subsection{JTAG} \end{document} diff --git a/docs/wireless.tex b/docs/wireless.tex new file mode 100644 index 0000000..279ee55 --- /dev/null +++ b/docs/wireless.tex @@ -0,0 +1,103 @@ +The WiFi settings are configured in the file \texttt{/etc/config/wireless} +(currently supported on Broadcom only). When booting the router for the first time +it should detect your card and create a sample configuration that looks like this: + +\begin{Verbatim} +config wifi-device wl0 + option type broadcom + option channel 5 + +config wifi-iface + option device wl0 + option mode ap + option ssid OpenWrt + option hidden 0 + option encryption none +\end{Verbatim} + +There are two types of config sections in this file. The '\texttt{wifi-device}' refers to +the physical wifi interface and '\texttt{wifi-iface}' configures a virtual interface on top +of that (if supported by the driver). + +\paragraph{Options for the \texttt{wifi-device}:} + +\begin{itemize} + \item \texttt{type} \\ + The driver to use for this interface. + + \item \texttt{country} \\ + The country code used to determine the regulatory settings. + + \item \texttt{channel} \\ + The wifi channel (1-14, depending on your country setting). + + \item \texttt{maxassoc} \\ + Maximum number of associated clients + +\end{itemize} + +\paragraph{Options for the \texttt{wifi-iface}:} + +\begin{itemize} + \item \texttt{mode} \\ + Operating mode: + + \begin{itemize} + \item \texttt{ap} \\ + Access point mode + + \item \texttt{sta} \\ + Client mode + + \item \texttt{adhoc} \\ + Ad-Hoc mode + + \item \texttt{wds} \\ + WDS point-to-point link + + \end{itemize} + \item \texttt{network} \\ + Selects the interface section from \texttt{/etc/config/network} to be + used with this interface + + \item \texttt{encryption} \\ + Encryption setting. Accepts the following values: + + \begin{itemize} + \item \texttt{psk}, \texttt{psk2} \\ + WPA(2) Pre-shared Key + + \item \texttt{wpa}, \texttt{wpa2} \\ + WPA(2) RADIUS + + \end{itemize} + + \item \texttt{key} (wpa and psk) \\ + Either the WPA key (PSK mode) or the RADIUS shared secret (WPA RADIUS mode) + + \item \texttt{server} (wpa) \\ + The RADIUS server address + + \item \texttt{port} (wpa) \\ + The RADIUS server port + +\end{itemize} + +\paragraph{Limitations:} + +\begin{itemize} + \item \textbf{Broadcom}: \\ + Only the following mode combinations are supported: + + \begin{itemize} + \item 1x \texttt{sta}, 0-3x \texttt{ap} + \item 1-4x \texttt{ap} + \item 1x \texttt{adhoc} + \end{itemize} + + WDS links can only be used in pure AP mode and can't use WEP (except when sharing the + settings with the master interface, which is done automatically). + +\end{itemize} + + |