X-Git-Url: https://git.rohieb.name/openwrt.git/blobdiff_plain/a1aab420f0a1a7234b006e1d37358c72350dd3f6..cad52677420d82279b3b97d5268bda415c90dd54:/docs/wireless.tex

diff --git a/docs/wireless.tex b/docs/wireless.tex
index 279ee5515..e6a81b840 100644
--- a/docs/wireless.tex
+++ b/docs/wireless.tex
@@ -1,103 +1,212 @@
 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:
+(currently supported on Broadcom and Atheros). When booting the router for the first time
+it should detect your card and create a sample configuration file. By default '\texttt{option network  lan}' is
+commented. This prevents unsecured sharing of the network over the wireless interface.
+
+\paragraph{Generic Broadcom wireless config:}
+
+\begin{Verbatim}
+config wifi-device      "wl0"
+    option type         "broadcom"
+    option channel      "5"
+
+config wifi-iface
+    option device       "wl0"
+#   option network  lan
+    option mode         "ap"
+    option ssid         "OpenWrt"
+    option hidden       "0"
+    option encryption   "none"
+\end{Verbatim}
+
+\paragraph{Generic Atheros wireless config:}
 
 \begin{Verbatim}
-config wifi-device  wl0
-    option type     broadcom
-    option channel  5
+config wifi-device      "wifi0"
+    option type         "atheros"
+    option channel      "5"
+    option mode  	"11g"
 
 config wifi-iface
-    option device   wl0
+    option device       "wifi0"
+#   option network  lan
+    option mode         "ap"
+    option ssid         "OpenWrt"
+    option hidden       "0"
+    option encryption   "none"
+\end{Verbatim}
+
+\paragraph{Generic multi-radio Atheros wireless conifg:}
+
+\begin{Verbatim}
+config wifi-device  wifi0
+    option type     atheros
+    option channel  1
+
+config wifi-iface
+    option device   wifi0
+#   option network  lan
     option mode     ap
-    option ssid     OpenWrt
+    option ssid     OpenWrt_private
     option hidden   0
     option encryption none
+
+config wifi-device  wifi1
+    option type     atheros
+    option channel  11
+
+config wifi-iface
+    option device   wifi1
+#   option network  lan
+    option mode     ap
+    option ssid     OpenWrt_public
+    option hidden   1
+    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).
 
+A full outline of the wireless configuration file with description of each field:
+
+\begin{Verbatim}
+config wifi-device     wifi device name
+    option type     broadcom, atheros
+    option country  us, uk, fr, de, etc.
+    option channel  1-14
+    option maxassoc 1-128 (broadcom only)
+    option distance 1-n
+    option mode     11b, 11g, 11a, 11bg (atheros only)
+
+config wifi-iface
+    option network  the interface you want wifi to bridge with 
+    option device   wifi0, wifi1, wifi2, wifiN
+    option mode     ap, sta, adhoc, or wds
+    option ssid     ssid name
+    option bssid    bssid address
+    option encryption none, wep, psk, psk2, wpa, wpa2 
+    option key      encryption key
+    option key1     key 1
+    option key2     key 2
+    option key3     key 3
+    option key4     key 4
+    option server   ip address
+    option port     port
+    option hidden   0,1
+    option isolate  0,1
+\end{Verbatim}
+
 \paragraph{Options for the \texttt{wifi-device}:}
 
 \begin{itemize}
-	\item \texttt{type} \\
-		The driver to use for this interface.
+    \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{country} \\
+        The country code used to determine the regulatory settings.
 
-	\item \texttt{maxassoc} \\
-		Maximum number of associated clients
+    \item \texttt{channel} \\
+        The wifi channel (e.g. 1-14, depending on your country setting).
 
-\end{itemize}
+    \item \texttt{maxassoc} \\
+        Optional: Maximum number of associated clients. This feature is supported only on the broadcom chipset.
 
-\paragraph{Options for the \texttt{wifi-iface}:}
+    \item \texttt{distance} \\
+	Optional: Distance between the ap and the furthest client in meters. This feature is supported only on the atheros chipset.
 
-\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
+		The frequency band (\texttt{b}, \texttt{g}, \texttt{bg}, \texttt{a}). This feature is only supported on the atheros chipset.
+
 
 \end{itemize}
 
-\paragraph{Limitations:}
+\paragraph{Options for the \texttt{wifi-iface}:}
 
 \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).
+    \item \texttt{network} \\
+        Selects the interface section from \texttt{/etc/config/network} to be
+        used with this interface
+
+    \item \texttt{device} \\
+	Set the wifi device name.
+
+    \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{ssid}
+	Set the SSID to be used on the wifi device.
+
+    \item \texttt{bssid}
+	Set the BSSID address to be used for wds to set the mac address of the other wds unit.
+
+    \item \texttt{encryption} \\
+        Encryption setting. Accepts the following values:
+
+        \begin{itemize}
+	    \item \texttt{none}
+	    \item \texttt{wep}
+            \item \texttt{psk}, \texttt{psk2} \\
+                WPA(2) Pre-shared Key
+
+            \item \texttt{wpa}, \texttt{wpa2} \\
+                WPA(2) RADIUS
+        \end{itemize}
+
+    \item \texttt{key, key1, key2, key3, key4} (wep, wpa and psk) \\
+        WEP key, WPA key (PSK mode) or the RADIUS shared secret (WPA RADIUS mode)
+
+    \item \texttt{server} (wpa) \\
+        The RADIUS server ip address
+
+    \item \texttt{port} (wpa) \\
+        The RADIUS server port
+
+    \item \texttt{hidden} \\
+        0 broadcasts the ssid; 1 disables broadcasting of the ssid
+
+    \item \texttt{isolate} \\
+        Optional: Isolation is a mode usually set on hotspots that limits the clients to communicate only with the AP and not with other wireless clients.
+        0 disables ap isolation (default); 1 enables ap isolation.
 
 \end{itemize}
 
 
+\paragraph{Limitations:}
+
+There are certain limitations when combining modes.
+Only the following mode combinations are supported:
+
+\begin{itemize}
+    \item \textbf{Broadcom}: \\
+        \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 cannot use WEP (except when sharing the
+        settings with the master interface, which is done automatically).
+
+    \item \textbf{Atheros}: \\
+        \begin{itemize}
+            \item 1x \texttt{sta}, 0-4x \texttt{ap}
+            \item 1-4x \texttt{ap}
+            \item 1x \texttt{adhoc}
+        \end{itemize}
+\end{itemize}
