Differences

This shows you the differences between two versions of the page.

doc:uci:wireless [2012/08/02 12:47]
70d7a4f46
doc:uci:wireless [2013/05/01 20:54] (current)
mcgrof
Line 11: Line 11:
==== Wifi Devices ==== ==== Wifi Devices ====
-The ''wifi-device'' refer to physical radio devices present on the system. The options present in this section describe properties common accross all wireless networks on this radio interface, such as channel or antenna selection.+The ''wifi-device'' refer to physical radio devices present on the system. The options present in this section describe properties common across all wireless networks on this radio interface, such as channel or antenna selection.
In most cases there is only one radio adapter present on the device, so only one such section is defined, however on multi-radio hardware there may be multiple ''wifi-device'' sections - each referring to a different adapter. In most cases there is only one radio adapter present on the device, so only one such section is defined, however on multi-radio hardware there may be multiple ''wifi-device'' sections - each referring to a different adapter.
Line 33: Line 33:
^ Name ^ Type ^ Required ^ Default ^ Description ^ ^ Name ^ Type ^ Required ^ Default ^ Description ^
| ''type'' | string | yes | //(autodetected)// | The ''type'' is determined on firstboot during the initial radio device detection - it is usually not required to change it. Used values are ''broadcom'' on brcm-2.4, ''atheros'' for madwifi or ''mac80211'' for b43, ath5k and ath9k | | ''type'' | string | yes | //(autodetected)// | The ''type'' is determined on firstboot during the initial radio device detection - it is usually not required to change it. Used values are ''broadcom'' on brcm-2.4, ''atheros'' for madwifi or ''mac80211'' for b43, ath5k and ath9k |
-| ''phy'' | string | no/yes | //(autodetected)// | Specifies the radio phy associated to this section, it is usally autodetected and should not be changed. By default openwrt uses ''macaddr'' to identify the radio (more precise) but you can use ''phy'' instead, to be more hardware independant.\\ :!: **This option is only used for type ''mac80211'' and ''madwifi'' (trunk)** | +| ''phy'' | string | no/yes | //(autodetected)// | Specifies the radio phy associated to this section, it is usually autodetected and should not be changed. By default openwrt uses ''macaddr'' to identify the radio (more precise) but you can use ''phy'' instead, to be more hardware independent.\\ :!: **This option is only used for type ''mac80211'' and ''madwifi'' (trunk)** | 
-| ''macaddr'' | MAC address | yes/no | //(autodetected)// | Specifies the radio adapter associated to this section, it is //not// used to change the device mac but to identify the underlying interface. The value is autodetected at first boot or when you use ''phy'' parameter. If you wan't an hardware independant config (to restore the config on many routers) you should use ''phy'' parameter instead of ''macaddr''.\\ :!: **This option is only used for type ''mac80211'' and ''madwifi'' (trunk)** |+| ''macaddr'' | MAC address | yes/no | //(autodetected)// | Specifies the radio adapter associated to this section, it is //not// used to change the device mac but to identify the underlying interface. The value is autodetected at first boot or when you use ''phy'' parameter. If you want a hardware independent config (to restore the config on many routers) you should use ''phy'' parameter instead of ''macaddr''.\\ :!: **This option is only used for type ''mac80211'' and ''madwifi'' (trunk)** |
| ''disabled'' | boolean | no | ''1'' | Disables the radio adapter if set to ''1''. Removing this option or setting it to ''0'' will enable the adapter | | ''disabled'' | boolean | no | ''1'' | Disables the radio adapter if set to ''1''. Removing this option or setting it to ''0'' will enable the adapter |
| ''channel'' | integer or "auto" | yes | ''auto'' | Specifies the wireless channel to use. In station mode the value ''auto'' is allowed, in access point mode an actual channel number must be given | | ''channel'' | integer or "auto" | yes | ''auto'' | Specifies the wireless channel to use. In station mode the value ''auto'' is allowed, in access point mode an actual channel number must be given |
| ''hwmode'' | string | no | //(driver default)// | Selects the wireless protocol to use, possible values are ''11b'', ''11bg'', ''11g'', ''11gdt'' (G + dynamic turbo, madwifi only), ''11gst'' (G turbo, broadcom only), ''11a'', ''11adt'' (A + dynamic turbo, madwifi only), ''11ast'' (A + static turbo, madwifi only), ''11fh'' (frequency hopping), ''11lrs'' (LRS mode, broadcom only), ''11ng'' (11N+11G, 2.4GHz, mac80211 only), ''11na'' (11N+11A, 5GHz, mac80211 only) or ''auto'' | | ''hwmode'' | string | no | //(driver default)// | Selects the wireless protocol to use, possible values are ''11b'', ''11bg'', ''11g'', ''11gdt'' (G + dynamic turbo, madwifi only), ''11gst'' (G turbo, broadcom only), ''11a'', ''11adt'' (A + dynamic turbo, madwifi only), ''11ast'' (A + static turbo, madwifi only), ''11fh'' (frequency hopping), ''11lrs'' (LRS mode, broadcom only), ''11ng'' (11N+11G, 2.4GHz, mac80211 only), ''11na'' (11N+11A, 5GHz, mac80211 only) or ''auto'' |
-| ''htmode'' | string | no | //(driver default)// | Specifies the channel width in ''11ng'' and ''11na'' mode, possible values are: ''HT20'' (single 20MHz channel), ''HT40-'' (2x 20MHz channels, 2. channel below, control channel is upper) or ''HT40+'' (2x 20MHz channels, 2. channel above, control channel is lower). Cf. [[doc/faq/faq.wireless#why.can.t.i.use.ht40.with.channel.11]]. \\ :!: **This option is only used for type ''mac80211''** |+| ''htmode'' | string | no | //(driver default)// | Specifies the channel width in ''11ng'' and ''11na'' mode, possible values are: ''HT20'' (single 20MHz channel), ''HT40-'' (2x 20MHz channels, primary/control channel is upper, secondary channel is below) or ''HT40+'' (2x 20MHz channels, primary/control channel is lower, secondary channel is above). Cf. [[doc/faq/faq.wireless#why.can.t.i.use.ht40.with.channel.11]]. \\ :!: **This option is only used for type ''mac80211''** | 
 +| ''chanbw'' | integer | no | 20 | Specifies a narrow channel width, possible values are: ''5'' (5MHz channel), ''10'' (10MHz channel) or ''20'' (20MHz channel). \\ :!: **Only supported by the ''ath9k''/''ath5k'' driver (since Attitude Adjustment)** |
| ''ht_capab'' | string | no | //(driver default)// | Specifies the available capabilities of the radio. The values are autodetected.\\ :!: **This option is only used for type ''mac80211''** | | ''ht_capab'' | string | no | //(driver default)// | Specifies the available capabilities of the radio. The values are autodetected.\\ :!: **This option is only used for type ''mac80211''** |
| ''txpower'' | integer | no | //(driver default)// | Specifies the //transmission power in dBm// | | ''txpower'' | integer | no | //(driver default)// | Specifies the //transmission power in dBm// |
Line 51: Line 52:
| ''noscan'' | boolean | no | ''0'' | Do not scan for overlapping BSSs in HT40+/- mode.\\ :!: **Only supported by ''mac80211''** \\ :!: **Turning this on will violate regulatory requirements!** | | ''noscan'' | boolean | no | ''0'' | Do not scan for overlapping BSSs in HT40+/- mode.\\ :!: **Only supported by ''mac80211''** \\ :!: **Turning this on will violate regulatory requirements!** |
| ''beacon_int'' | integer | no | //100 (hostapd default)// | Set the beacon interval. This is the time interval between beacon frames, measured in units of 1.024 ms. hostapd permits this to be set between 15 and 65535. This option only has an effect on ''ap'' and ''adhoc'' wifi-ifaces. \\ :!: **Only supported by ''mac80211'' (in trunk)** | | ''beacon_int'' | integer | no | //100 (hostapd default)// | Set the beacon interval. This is the time interval between beacon frames, measured in units of 1.024 ms. hostapd permits this to be set between 15 and 65535. This option only has an effect on ''ap'' and ''adhoc'' wifi-ifaces. \\ :!: **Only supported by ''mac80211'' (in trunk)** |
 +| ''short_preamble'' | boolean | no | //0// | Set optional use of short preamble \\ :!: **Only supported by ''mac80211''** |
| ''basic_rate'' | list | no | //(hostapd/driver default)// | Set the supported basic rates. Each basic_rate is measured in kb/s. This option only has an effect on ''ap'' and ''adhoc'' wifi-ifaces. \\ :!: **Only supported by ''mac80211'' (in trunk)** | | ''basic_rate'' | list | no | //(hostapd/driver default)// | Set the supported basic rates. Each basic_rate is measured in kb/s. This option only has an effect on ''ap'' and ''adhoc'' wifi-ifaces. \\ :!: **Only supported by ''mac80211'' (in trunk)** |
 +| ''log_level'' | integer | no | 2 | Set the log_level. Supported levels are: 0 = verbose debugging, 1 = debugging, 2 = informational messages, 3 = notification, 4 = warning |
=== Broadcom Options === === Broadcom Options ===
Line 105: Line 108:
| ''mode'' | string | yes | ''ap'' | Selects the //operation mode// of the wireless network, ''ap'' for Access Point, ''sta'' for managed (client) mode, ''adhoc'' for Ad-Hoc, ''wds'' for static WDS and ''monitor'' for monitor mode, ''mesh'' for 802.11s mesh mode \\ :!: **''mesh'' mode only supported by ''mac80211'' (in trunk)**| | ''mode'' | string | yes | ''ap'' | Selects the //operation mode// of the wireless network, ''ap'' for Access Point, ''sta'' for managed (client) mode, ''adhoc'' for Ad-Hoc, ''wds'' for static WDS and ''monitor'' for monitor mode, ''mesh'' for 802.11s mesh mode \\ :!: **''mesh'' mode only supported by ''mac80211'' (in trunk)**|
| ''disabled'' | boolean | no | ''1'' | When set to 1, wireless network is disabled. | | ''disabled'' | boolean | no | ''1'' | When set to 1, wireless network is disabled. |
-| ''ssid'' | string | yes | ''OpenWrt'' | The broadcasted SSID of the wireless network |+| ''ssid'' | string | yes | ''OpenWrt'' | The broadcasted SSID of the wireless network (for managed mode the SSID of the network you're connecting to) |
| ''bssid'' | BSSID address | no | //(driver default)// | Override the BSSID of the network, only applicable in ''adhoc'' or ''sta'' mode. In ''wds'' mode specifies the BSSID of another AP to create WDS with. | | ''bssid'' | BSSID address | no | //(driver default)// | Override the BSSID of the network, only applicable in ''adhoc'' or ''sta'' mode. In ''wds'' mode specifies the BSSID of another AP to create WDS with. |
| ''mesh_id'' | Mesh ID | no | none | The Mesh ID as defined in IEEE 802.11s.  If set, the wireless interface will join this mesh network when brought up.  If not, it is necessary to invoke ''iw <iface> mesh join <mesh_id>'' to join a mesh after the interface is brought up. \\ :!: **Only supported by ''mac80211'' (in trunk)**| | ''mesh_id'' | Mesh ID | no | none | The Mesh ID as defined in IEEE 802.11s.  If set, the wireless interface will join this mesh network when brought up.  If not, it is necessary to invoke ''iw <iface> mesh join <mesh_id>'' to join a mesh after the interface is brought up. \\ :!: **Only supported by ''mac80211'' (in trunk)**|
Line 111: Line 114:
| ''isolate'' | boolean | no | ''0'' | Isolate wireless clients from each other, only applicable in ''ap'' mode.  // May not be supported in the original Backfire release for mac80211 // | | ''isolate'' | boolean | no | ''0'' | Isolate wireless clients from each other, only applicable in ''ap'' mode.  // May not be supported in the original Backfire release for mac80211 // |
| ''doth'' | boolean | no | ''0'' | Enables 802.11h support.\\ :!: **Not supported for the ''mac80211'' type yet** | | ''doth'' | boolean | no | ''0'' | Enables 802.11h support.\\ :!: **Not supported for the ''mac80211'' type yet** |
-| ''wmm'' | boolean | no | ''0'' | Enables WMM (802.11e) support.\\ :!: **Not supported for the ''mac80211'' type for backfire(?)**  Supported in trunk, in fact default but configurable in trunk  |+| ''wmm'' | boolean | no | ''1'' | Enables WMM (802.11e) support. Required for 802.11n support |
| ''network'' | string | yes | ''lan'' | Specifies the [[doc:uci:network#interfaces|network interface]] to attach the wireless to | | ''network'' | string | yes | ''lan'' | Specifies the [[doc:uci:network#interfaces|network interface]] to attach the wireless to |
| ''encryption'' | string | no | ''none'' | Wireless encryption method. ''none'' for an open network, ''wep'' for WEP, ''psk'' for WPA-PSK, or ''psk2'' for WPA2-PSK. See the [[doc:uci:wireless#WPA.Modes|WPA modes]] table for additional possible values.\\ For an access point in **WEP** mode, the default is "open system" authentication. Use ''wep+shared'' for "shared key" authentication (less secure), ''wep+open'' to explicitly use "open system," or ''wep+mixed'' to allow either. ''wep+mixed'' is only supported by hostapd. | | ''encryption'' | string | no | ''none'' | Wireless encryption method. ''none'' for an open network, ''wep'' for WEP, ''psk'' for WPA-PSK, or ''psk2'' for WPA2-PSK. See the [[doc:uci:wireless#WPA.Modes|WPA modes]] table for additional possible values.\\ For an access point in **WEP** mode, the default is "open system" authentication. Use ''wep+shared'' for "shared key" authentication (less secure), ''wep+open'' to explicitly use "open system," or ''wep+mixed'' to allow either. ''wep+mixed'' is only supported by hostapd. |
Line 119: Line 122:
| ''key3'' | string | no | //(none)// | WEP passphrase or key #3 (selected by the index in ''key''), as in ''key1''. | | ''key3'' | string | no | //(none)// | WEP passphrase or key #3 (selected by the index in ''key''), as in ''key1''. |
| ''key4'' | string | no | //(none)// | WEP passphrase or key #4 (selected by the index in ''key''), as in ''key1''. | | ''key4'' | string | no | //(none)// | WEP passphrase or key #4 (selected by the index in ''key''), as in ''key1''. |
-| ''iapp_interface'' | string | no | //(none)// | specify an //[[doc:uci:network#interfaces|interface]]// which used for 802.11f (IAPP) - only enabled when defined| +| ''iapp_interface'' | string | no | //(none)// | Specifies a [[doc:uci:network#interfaces|network interface]] to be used for 802.11f (IAPP) - only enabled when defined. | 
-| ''ieee80211d'' | integer | no | ''0'' | Enables IEEE 802.11d country IE (information element) advertisement in beacon and probe response frames. This IE contains the country code and channel/power map. Requires ''country''. |+| ''rsn_preauth'' | boolean | no | ''0'' | Allow preauthentication for WPA2-EAP networks (and advertise it in WLAN beacons). Only works if the specified network interface is a bridge.
 +| ''ieee80211d'' | integer | no | 1 if ''country'' is set, otherwise 0 | Enables IEEE 802.11d country IE (information element) advertisement in beacon and probe response frames. This IE contains the country code and channel/power map. Requires ''country''. |
| ''ieee80211w'' | integer | no | ''0'' | Enables MFP (802.11w) support (0 = disabled, 1 = optional, 2 = required).\\ :!: **Only supported by the ''ath9k'' driver (in trunk)**| | ''ieee80211w'' | integer | no | ''0'' | Enables MFP (802.11w) support (0 = disabled, 1 = optional, 2 = required).\\ :!: **Only supported by the ''ath9k'' driver (in trunk)**|
| ''ieee80211w_max_timeout'' | integer | no | //(hostapd default)// | Specifies the 802.11w Association SA Query maximum timeout.\\ :!: **Only supported by the ''ath9k'' driver (in trunk)** | | ''ieee80211w_max_timeout'' | integer | no | //(hostapd default)// | Specifies the 802.11w Association SA Query maximum timeout.\\ :!: **Only supported by the ''ath9k'' driver (in trunk)** |
Line 130: Line 134:
| ''mcast_rate'' | integer | no | //(driver default)// | Sets the fixed multicast rate, measured in kb/s. \\ :!: **Only supported by ''madwifi'', and ''mac80211'' (for type ''adhoc'' in trunk)** | | ''mcast_rate'' | integer | no | //(driver default)// | Sets the fixed multicast rate, measured in kb/s. \\ :!: **Only supported by ''madwifi'', and ''mac80211'' (for type ''adhoc'' in trunk)** |
| :!: See the [[doc:uci:wireless#WPA.Modes|WPA tables]] below for a full listing of WPA related options used for WPA2 Enterprise (802.1x) ||||| | :!: See the [[doc:uci:wireless#WPA.Modes|WPA tables]] below for a full listing of WPA related options used for WPA2 Enterprise (802.1x) |||||
 +| :!: See the [[doc:uci:wireless#WPS.Options|WPS Options]] below for a full listing of //Wi-Fi Protected Setup// options. |||||
 +| ''wds'' | boolean | no | ''0'' | This sets [[http://wireless.kernel.org/en/users/Documentation/iw#Using_4-address_for_AP_and_client_mode|4-address mode]] |
=== Madwifi Options === === Madwifi Options ===
Line 159: Line 165:
Besides the WPA mode, the ''encryption'' option also specifies the group and peer ciphers to use. Besides the WPA mode, the ''encryption'' option also specifies the group and peer ciphers to use.
To override the cipher, the value of ''encryption'' must be given in the form ''mode+cipher''. To override the cipher, the value of ''encryption'' must be given in the form ''mode+cipher''.
-See the listing below for possible combinations.+See the listing below for possible combinations. If the ''hwmode'' of the interface is set to ''ng'' or ''na'', then the ''CCMP'' cipher is always added to the list.
^ Value ^ WPA Version ^ Ciphers ^ ^ Value ^ WPA Version ^ Ciphers ^
Line 194: Line 200:
| ''auth_port'' | ''1812'' | RADIUS authentication port | | ''auth_port'' | ''1812'' | RADIUS authentication port |
| ''auth_secret'' | //(none)// | Shared authentication RADIUS secret | | ''auth_secret'' | //(none)// | Shared authentication RADIUS secret |
 +| ''auth_cache'' | ''0'' | Disable or enable PMKSA and Opportunistic Key Caching |
| ''acct_server'' | //(none)// | RADIUS accounting server to handle client authentication | | ''acct_server'' | //(none)// | RADIUS accounting server to handle client authentication |
| ''acct_port'' | ''1813'' | RADIUS accounting port | | ''acct_port'' | ''1813'' | RADIUS accounting port |
Line 203: Line 210:
Listing of Client related options for WPA Enterprise. Listing of Client related options for WPA Enterprise.
- 
-:!: At the time of writing only the //madwifi// driver supports WPA Enterprise in client mode. 
^ Name ^ Default ^ Description ^ ^ Name ^ Default ^ Description ^
Line 216: Line 221:
| ''priv_key_pwd'' | //(none)// | Password to unlock the private key file, only works in conjunction with ''priv_key'' | | ''priv_key_pwd'' | //(none)// | Password to unlock the private key file, only works in conjunction with ''priv_key'' |
 +
 +=== WPS Options ===
 +
 +Listing of [[http://en.wikipedia.org/wiki/Wi-Fi_Protected_Setup|Wi-Fi Protected Setup]] related options.
 +
 +:!: Support for WPS is provided by packages ''wpad'' and ''hostapd-utils''. Default package ''wpad-mini'' is not enough.\\
 +
 +:!: WPS is possible only when encryption PSK is selected.
 +
 +:!: Some package is not correctly generated and ''hostapd_cli'' doesn't support command ''wps_pbc''.  See this [[https://forum.openwrt.org/viewtopic.php?id=30882|thread]] for further details.\\ //Fixed with [[https://dev.openwrt.org/changeset/33393|changeset 33393]].//
 +
 +^ Name ^ Type ^ Required ^ Default ^ Description ^
 +| ''wps_config'' | list | no | //(none)// | List of configuration methods.\\ Available methods: ''usba ethernet'' ''label'' ''display'' ''ext_nfc_token'' ''int_nfc_token'' ''nfc_interface'' ''push_button'' ''keypad'' ''virtual_display'' ''physical_display'' ''virtual_push_button'' ''physical_push_button''.\\ Supported methods: ''push_button''. |
 +| ''wps_device_name'' | string | no | ''OpenWrt AP'' | User-friendly description of device; up to 32 octets encoded in UTF-8. |
 +| ''wps_device_type'' | string | no | ''6-0050F204-1'' | Primary device type.  Examples:\\ ''1-0050F204-1'' (Computer / PC)\\ ''1-0050F204-2'' (Computer / Server)\\ ''5-0050F204-1'' (Storage / NAS)\\ ''6-0050F204-1'' (Network Infrastructure / AP) |
 +| ''wps_label'' | boolean | no | ''0'' | Enable //label// configuration method. |
 +| ''wps_manufacturer'' | string | no | ''openwrt.org'' | The manufacturer of the device (up to 64 ASCII characters). |
 +| ''wps_pbc'' | boolean | no | ''0'' | Enable //push-button// configuration method. |
===== Configuring Encryption ===== ===== Configuring Encryption =====

Back to top

doc/uci/wireless.1343904463.txt.bz2 · Last modified: 2012/08/02 12:47 by 70d7a4f46