allow newlines in prereq error messages
[openwrt/svn-archive/archive.git] / docs / wireless.tex
1 The WiFi settings are configured in the file \texttt{/etc/config/wireless}
2 (currently supported on Broadcom and Atheros). When booting the router for the first time
3 it should detect your card and create a sample configuration that looks like this:
4
5 \paragraph{Sample Broadcom wireless config:}
6
7 \begin{Verbatim}
8 config wifi-device "wl0"
9 option type "broadcom"
10 option channel "5"
11
12 config wifi-iface
13 option device "wl0"
14 option mode "ap"
15 option ssid "OpenWrt"
16 option hidden "0"
17 option encryption "none"
18 \end{Verbatim}
19
20 \paragraph{Sample Atheros wireless config:}
21
22 \begin{Verbatim}
23 config wifi-device "wifi0"
24 option type "atheros"
25 option channel "5"
26 option mode "11g"
27
28 config wifi-iface
29 option device "wifi0"
30 option mode "ap"
31 option ssid "OpenWrt"
32 option hidden "0"
33 option encryption "none"
34 \end{Verbatim}
35
36 There are two types of config sections in this file. The '\texttt{wifi-device}' refers to
37 the physical wifi interface and '\texttt{wifi-iface}' configures a virtual interface on top
38 of that (if supported by the driver).
39
40 \paragraph{Options for the \texttt{wifi-device}:}
41
42 \begin{itemize}
43 \item \texttt{type} \\
44 The driver to use for this interface.
45
46 \item \texttt{mode} \\
47 The frequency band (\texttt{b}, \texttt{g}, \texttt{bg}, \texttt{a})
48
49 \item \texttt{country} \\
50 The country code used to determine the regulatory settings.
51
52 \item \texttt{channel} \\
53 The wifi channel (e.g. 1-14, depending on your country setting).
54
55 \item \texttt{maxassoc} \\
56 Maximum number of associated clients
57
58 \end{itemize}
59
60 \paragraph{Options for the \texttt{wifi-iface}:}
61
62 \begin{itemize}
63 \item \texttt{mode} \\
64 Operating mode:
65
66 \begin{itemize}
67 \item \texttt{ap} \\
68 Access point mode
69
70 \item \texttt{sta} \\
71 Client mode
72
73 \item \texttt{adhoc} \\
74 Ad-Hoc mode
75
76 \item \texttt{wds} \\
77 WDS point-to-point link
78
79 \end{itemize}
80
81 \item \texttt{network} \\
82 Selects the interface section from \texttt{/etc/config/network} to be
83 used with this interface
84
85 \item \texttt{encryption} \\
86 Encryption setting. Accepts the following values:
87
88 \begin{itemize}
89 \item \texttt{psk}, \texttt{psk2} \\
90 WPA(2) Pre-shared Key
91
92 \item \texttt{wpa}, \texttt{wpa2} \\
93 WPA(2) RADIUS
94
95 \end{itemize}
96
97 \item \texttt{key} (wpa and psk) \\
98 Either the WPA key (PSK mode) or the RADIUS shared secret (WPA RADIUS mode)
99
100 \item \texttt{server} (wpa) \\
101 The RADIUS server address
102
103 \item \texttt{port} (wpa) \\
104 The RADIUS server port
105
106 \end{itemize}
107
108 \paragraph{Limitations:}
109
110 Only the following mode combinations are supported:
111
112 \begin{itemize}
113 \item \textbf{Broadcom}: \\
114 \begin{itemize}
115 \item 1x \texttt{sta}, 0-3x \texttt{ap}
116 \item 1-4x \texttt{ap}
117 \item 1x \texttt{adhoc}
118 \end{itemize}
119
120 WDS links can only be used in pure AP mode and can't use WEP (except when sharing the
121 settings with the master interface, which is done automatically).
122
123 \item \textbf{Atheros}: \\
124 \begin{itemize}
125 \item 1x \texttt{sta}, 0-4x \texttt{ap}
126 \item 1-4x \texttt{ap}
127 \item 1x \texttt{adhoc}
128 \end{itemize}
129
130 \end{itemize}
131
132