users-guide.tex

Linux下wifi实现

\cmd{iwpriv ath0 compression 0}
\ev
\end{example}

\subsubsection{\mytt{get\_compression} - Get Atheros SuperA/G Compression Support}
\argdesc{0}{1}{N/A}{No}
This command returns whether Atheros SuperA/G hardware compression support is enabled or disabled
in the driver.
\begin{example}
The following command retrieves the status of Atheros SuperA/G
hardware compression support in the driver:
\bv
\cmd{iwpriv ath0 get\_compression}\\
\mytt{ath0\hspace{32pt}get\_compression:0}
\ev
\end{example}

\subsubsection{\mytt{abolt} - Set ABOLT value}
\argdesc{1}{0}{Varies}{Yes}
This command sets the abolt value used to control the Atheros
proprietary features.  This is a bitmask where each bit position
corresponds to a feature.  Setting the bit to 1 enables the feature if
hardware is capable.  Setting the bit to 0 disables the feature.  The
bitmask is described in Table~\ref{tab:abolt}
\begin{table}[h*]
  \centering
  \begin{tabular}{|c|c|} \hline
    Bit Position & Feature \\ \hline
    1 & Static Turbo G (disabled) \\
    2 & Dynamic turbo \\
    3 & Compression \\
    4 & Fast Frames \\
    5 & Bursting \\
    6 & WMM based cwmin/cwmax/burst tuning \\
    7 & XR \\
    8 & AR \\ \hline
  \end{tabular}
  \caption{Abolt Bit Position Definitions}
  \label{tab:abolt}
\end{table}

\subsubsection{\mytt{pureg} - Use Only 802.11g Data Rates (no legacy 802.11b
  support) Enable/Disable}
\argdesc{1}{0}{Disabled}{Yes}
This command enables or disables 802.11g only operation (no legacy
802.11b rates are supported).  Passing a value of 1 to the driver
enables 802.11g rates only operation (rates below 6Mbps are disabled).
Passing a value of 0 to the driver disables 802.11g only operation and
allows legacy 802.11b rates to be supported.
\begin{example}
The following command enables 802.11g rates only operation.  Thus, no
rates below 6Mbps will be supported.
\bv
\cmd{iwpriv ath0 pureg 0}
\ev
\end{example}

\subsubsection{\mytt{get\_pureg} - Get Status of 802.11g Only Data Rates Support}
\argdesc{0}{1}{N/A}{No}
This command returns whether the driver is using only 802.11g rates
(no rates below 6Mbps).
\begin{example}
The following command returns whether the driver supports 802.11g
rates only.
\bv
\cmd{iwpriv ath0 get\_pureg}\\
\mytt{ath0\hspace{32pt}get\_pureg:0}
\ev
\end{example}

\subsubsection{\mytt{wds} - Enable/Disable 4 Address (WDS) Parsing}
\argdesc{1}{0}{N/A}{No}
This command enables or disables 4 address parsing on the device.  For
Stations, enabling 4 address parsing results in the station passing up
\emph{any} packet received in a 4 address from to the network layer.
Also, any unicast packet not destined for the AP which is passed to
the station by the network layer will be sent in 4 address mode.  For
APs, enabling 4 address parsing will result in the AP forwarding
packets to any MAC address from which it has received a 4 address
packet.  Passing a value of 1 will enable 4 address parsing.  Passing
a value of 0 will disable 4 address parsing.
\begin{example}
The following command enables 4 address parsing on \mytt{ath0}:
\bv
\cmd{iwpriv ath0 wds 1}
\ev
\end{example}

\subsubsection{\mytt{get\_wds} - Get Status of 4 Address (WDS) Parsing}
\argdesc{0}{1}{N/A}{No}
This command returns whether 4 address parsing is enabled or disabled
in the driver.  A value of 1 indicates that 4 address parsing is
enabled. A value of 0 indicates that 4 address parsing is disabled.
\begin{example}
The following command returns the stats of address parsing on \mytt{ath0}:
\bv
\cmd{iwpriv ath0 get\_wds}\\
\mytt{ath0\hspace{32pt}get\_wds:0}
\ev
\end{example}

\subsubsection{\mytt{countryie} - Enable Country IE in Beacon Enable/Disable}
\argdesc{1}{0}{Disabled}{Yes}
This command enables and disables generation of country IE in beacon and probe
response.  To enable the support, a value of 1 is passed into the driver. 
To disable, a value of 0 is passed into the driver.
\begin{example}
  The following command enables country ie in beacon  on \mytt{ath0}:
  \bv
  \cmd{iwpriv ath0 countryie 1}
  \ev
\end{example}

\subsubsection{\mytt{get\_countryie} - Get Country IE Status}
\argdesc{0}{1}{N/A}{No}
This command returns whether country IE is enabled or disabled in
the driver.
\begin{example}
  The following command retrieves the country IE status on \mytt{ath0}:
  \bv
  \cmd{iwpriv ath0 get\_countryie}\\
  \mytt{ath0\hspace{32pt}get\_countryie:0}
  \ev
\end{example}

\subsubsection{\mytt{coverageclass} - Set Coverage Class for AP}
\argdesc{1}{0}{0}{Yes}
This commands sets the coverage class for AP. Coverage class determines the
air propagation time used in BSS operation. The coverageclass value can be 
between 0 to 31. The coverageclass value is sent by AP via country IE
element in beacon.
\begin{example}
  The following command sets the coverage class to 12.
  on \mytt{ath0}:
  \bv
  \cmd{iwpriv ath0 coverageclass 12}\\
  \ev
\end{example}

\subsubsection{\mytt{get\_coveragecls} - Get Coverage Class Value}
\argdesc{0}{1}{N/A}{No}
This commands gets current coverage class value.
\begin{example}
  The following command gets coverageclass value
  on \mytt{ath0}:
  \bv
  \cmd{iwpriv ath0 get\_coveragecls}\\
  \mytt{ath0\hspace{32pt}get\_coveragecls:12}
  \ev
\end{example}

\subsubsection{\mytt{regclass} - Enable Regulatory class ids to be used in country 
IE in Beacon. Enable/Disable}
\argdesc{1}{0}{Disabled}{Yes}
This command enables advertising regclass ids in country IE in beacon instead of 
regular channel triplet (chan no/no.of channels/max transmit power). If set 
country does not have any regclass ids defined, it reverts back to regular triplet. 
The option needs to be enabled when using coverageclass. To enable the support, a value 
of 1 is passed into the driver.  To disable, a value of 0 is passed into the driver.
\begin{example}
  The following command enables country ie in beacon  on \mytt{ath0}:
  \bv
  \cmd{iwpriv ath0 regclass 1}
  \ev
\end{example}

\subsubsection{\mytt{get\_regclass} - Get Regulatory Class ID Status}
\argdesc{0}{1}{N/A}{No}
This command returns whether regulatory class ids are getting advertised in country 
IE in beacon.
\begin{example}
  The following command retrieves the country IE status on \mytt{ath0}:
  \bv
  \cmd{iwpriv ath0 get\_regclass}\\
  \mytt{ath0\hspace{32pt}get\_regclass:0}
  \ev
\end{example}

\section{Configuring AP using CLI}
This section describes the configuration of Atheros Linux AP using CLI command sets.

\subsection{CLI commands}
This section lists all the supported CLI commands.  Throughout this
document, CLI commands will be denoted using bold, computer font as in
\clicmd{command}.  Parameters to the command will be denoted by
non-bold computer font as in \cliparam{parameter}.  Any values which
are needed by the parameters will be denoted using italic Times font
as in \clival{value}.

\subsubsection{Switching the WLAN and BSS}
\bv
\clicmd{config} \cliparam{wlan} \clival{wlan\_index} \cliparam{bss}
\clival{bss\_index}\\
\clicmd{config} \cliparam{wlan} \clival{wlan\_index}\\
\clicmd{config} \cliparam{bss} \clival{bss\_index}\\
\ev

Use \clicmd{config} command to switch current WLAN (radio) or virtual BSS. 
Except for the command \clicmd{commit}, all other CLI commands are only effective on the
current WLAN or BSS.

The shell prompt reflects the current WLAN and BSS in the following form.
\bv
\mytt{wlan[wlan\_index,bss\_index] ->} 
\ev
or
\bv
\mytt{wlan[wlan\_index] -> }
\ev
If only one index is in the prompt, it could be either that there is no BSS
created for this WLAN, or there is no BSS currently selected. To select a BSS
within the same WLAN, use \mytt{config bss bss\_index}.

\subsubsection{Reading the AP Configuration}
\bv
\clicmd{get} [\cliparam{parameter}]
\ev
Use \clicmd{get} command to display the current AP configurations.
For description of each available parameter, please refer to section
~\ref{sec:param}. 

\subsubsection{Modifying the AP Configuration}
\bv
\clicmd{set} \cliparam{parameter} [\clival{value}]
\ev
Use \clicmd{set} command to modify the current AP configuration.
For description of each available parameter, please refer to section
~\ref{sec:param}.

\subsubsection{Adding a BSS}
\bv
\clicmd{add} $<$\cliparam{bss}$|$\cliparam{sta}$>$ [\clival{bss\_index}]
\ev
where \clival{bss\_index} is a value from 0-3.

Use the \clicmd{add} command to add a new virtual BSS (\cliparam{bss}) or
a wireless client (\cliparam{sta}) to the current WLAN. 
If the \clival{bss\_index} is not specified, the new BSS will created
using the first available index.

The maximum number of BSS's is 4. 

\subsubsection{Deleting a BSS}
\bv
\clicmd{del} \cliparam{bss} \clival{bss\_index}\\
\clicmd{del} \cliparam{bss} \clival{all}
\ev
in which, \clival{bss\_index} is a value from 0-3.

Use the \clicmd{del} command to delete a virtual BSS.
The\clival{bss\_index} must be specified to indicate which BSS to
delete.  If the BSS value \clival{all} is specified, all the BSS's on
the current WLAN will be deleted.

\subsubsection{Saving the AP Configuration}
\bv
\clicmd{commit}
\ev
Use \clicmd{commit} to save the current AP configuration. 
The saved configuration will take effect on the next AP reboot.

\subsubsection{Getting Help}
\bv
\clicmd{help} \cliparam{command}
\ev
Use \clicmd{help} to display the usage of each command.  For the get
and set commands, the supported configuration parameters are
displayed.

\subsubsection{The ap\_service Script}
\bv
\clicmd{ap\_service} $<$\clival{start}$|$\clival{stop}$|$\clival{restart}$>$
\ev
The \clicmd{ap\_service} script is used to start, stop and restart the
Linux AP service without rebooting the entire AP. Besides configuring
WLAN using CLI commands, it's also responsible for configuring
network functions such as bridging and VLAN.
It's located in directory /etc/wlan.

\begin{example}
  In system startup script (by default /etc/rc.d/rcS), \clicmd{ap\_service}
  can be used to start the AP service.
  \bv
  \mytt{/etc/wlan/ap\_service start}
  \ev
\end{example}

\begin{example}
  After using \clicmd{commit} to save the configurations, instead of rebooting
  the entire AP, \clicmd{ap\_service} can be used to restart just the AP service.
  \bv
  \clidemo{commit}\\
  \clidemo{. /etc/wlan/ap\_service restart}
  \ev
\end{example}

\subsection{AP Configuration Parameters}
\label{sec:param}
This section describes the available AP configuration parameters.  All
parameters will be saved by the \clicmd{commit} command and take
effect upon next AP reboot.

\subsubsection{ACL List}
\bv
\clicmd{get} \cliparam{acl}\\
\clicmd{set} \cliparam{acl} \clival{acl\_mode}\\
\clicmd{add} \cliparam{acl} \clival{mac\_address}\\
\clicmd{del} \cliparam{acl} \clival{mac\_address}
\ev
The supported ACL modes and their actions are listed in Table ~\ref{tab:acl}.
\begin{table}[h*]
  \centering
  \begin{tabular}{|l|l|} \hline
    ACL Mode & Actions \\ \hline
    Open & No ACL checking is performed \\
    Allow & Only allow ACLs in the ACL list \\
    Deny & Only deny ACLs in the ACL list \\
    Flush & Flush the ACL database \\
    Disable & Remove the ACL policy \\ \hline
  \end{tabular}
  \caption{Supported ACL Modes}
  \label{tab:acl}
\end{table}

\begin{example}
  Set ACL mode to allow, and add one MAC address to the ACL list.
  \bv
  \clidemo{set acl allow}\\
  \clidemo{add acl 00:03:7f:03:42:3f}
  \ev
\end{example}

The command \mytt{get acl} will display the current ACL mode and the
MAC addresses in the list.

\subsubsection{Authentication Type}
\bv
\clicmd{get} \cliparam{authentication}\\
\clicmd{set} \cliparam{authentication} \clival{authmode}
\ev
The supported authentication types are listed in Table ~\ref{tab:auth}.
\begin{table}[h*]
  \centering
  \begin{tabular}{|l|l|} \hline
    Authentication Type & Description \\ \hline
    open & Open-System authentication type \\
    shared & Shared-Key authentication type \\
    auto & Allow Open-System or Shared Key for authentication type \\
    802.1x & 802.1x authentication type \\
    WPA  & WPAv1 authentication type \\
    WPA-PSK & WPAv1-PSK authentication type \\
    WPA2 & WPAv2 authentication type \\
    WPA2-PSK & WPAv2-PSK authentication type \\
    WPA-AUTO & Allow WPAv1 or WPAv2 for authentication type \\
    WPA-AUTO-PSK & Allow WPAv1-PSK or WPAv2-PSK for authentication type \\ \hline
  \end{tabular}
  \capti