enum ieee80211_band

enum ieee80211_band {
IEEE80211_BAND_2GHZ,
IEEE80211_BAND_5GHZ,
IEEE80211_NUM_BANDS
};

Constants

IEEE80211_BAND_2GHZ
2.4GHz ISM band
IEEE80211_BAND_5GHZ
around 5GHz band (4.9-5.7)
IEEE80211_NUM_BANDS
-- undescribed --

Description

The bands are assigned this way because the supported bitrates differ in these bands.


enum ieee80211_channel_flags

enum ieee80211_channel_flags {
IEEE80211_CHAN_DISABLED,
IEEE80211_CHAN_PASSIVE_SCAN,
IEEE80211_CHAN_NO_IBSS,
IEEE80211_CHAN_RADAR,
IEEE80211_CHAN_NO_HT40PLUS,
IEEE80211_CHAN_NO_HT40MINUS
};

Constants

IEEE80211_CHAN_DISABLED
This channel is disabled.
IEEE80211_CHAN_PASSIVE_SCAN
Only passive scanning is permitted on this channel.
IEEE80211_CHAN_NO_IBSS
IBSS is not allowed on this channel.
IEEE80211_CHAN_RADAR
Radar detection is required on this channel.
IEEE80211_CHAN_NO_HT40PLUS
extension channel above this channel is not permitted.
IEEE80211_CHAN_NO_HT40MINUS
extension channel below this channel is not permitted.

Description

Channel flags set by the regulatory control code.


struct ieee80211_channel - channel definition

struct ieee80211_channel {
    enum ieee80211_band band;
    u16 center_freq;
    u16 hw_value;
    u32 flags;
    int max_antenna_gain;
    int max_power;
    bool beacon_found;
    u32 orig_flags;
    int orig_mag;
    int orig_mpwr;
};

Members

band
band this channel belongs to.
center_freq
center frequency in MHz
hw_value
hardware-specific value for the channel
flags
channel flags from enum ieee80211_channel_flags.
max_antenna_gain
maximum antenna gain in dBi
max_power
maximum transmission power (in dBm)
beacon_found
helper to regulatory code to indicate when a beacon has been found on this channel. Use regulatory_hint_found_beacon to enable this, this is is useful only on 5 GHz band.
orig_flags
channel flags at registration time, used by regulatory code to support devices with additional restrictions
orig_mag
internal use
orig_mpwr
internal use

Description

This structure describes a single channel for use with cfg80211.


enum ieee80211_rate_flags

enum ieee80211_rate_flags {
IEEE80211_RATE_SHORT_PREAMBLE,
IEEE80211_RATE_MANDATORY_A,
IEEE80211_RATE_MANDATORY_B,
IEEE80211_RATE_MANDATORY_G,
IEEE80211_RATE_ERP_G
};

Constants

IEEE80211_RATE_SHORT_PREAMBLE
Hardware can send with short preamble on this bitrate; only relevant in 2.4GHz band and with CCK rates.
IEEE80211_RATE_MANDATORY_A
This bitrate is a mandatory rate when used with 802.11a (on the 5 GHz band); filled by the core code when registering the wiphy.
IEEE80211_RATE_MANDATORY_B
This bitrate is a mandatory rate when used with 802.11b (on the 2.4 GHz band); filled by the core code when registering the wiphy.
IEEE80211_RATE_MANDATORY_G
This bitrate is a mandatory rate when used with 802.11g (on the 2.4 GHz band); filled by the core code when registering the wiphy.
IEEE80211_RATE_ERP_G
This is an ERP rate in 802.11g mode.

Description

Hardware/specification flags for rates. These are structured in a way that allows using the same bitrate structure for different bands/PHY modes.


struct ieee80211_rate - bitrate definition

struct ieee80211_rate {
    u32 flags;
    u16 bitrate;
    u16 hw_value;
    u16 hw_value_short;
};

Members

flags
rate-specific flags
bitrate
bitrate in units of 100 Kbps
hw_value
driver/hardware value for this rate
hw_value_short
driver/hardware value for this rate when short preamble is used

Description

This structure describes a bitrate that an 802.11 PHY can operate with. The two values hw_value and hw_value_short are only for driver use when pointers to this structure are passed around.


struct ieee80211_sta_ht_cap - STA's HT capabilities

struct ieee80211_sta_ht_cap {
    u16 cap;
    bool ht_supported;
    u8 ampdu_factor;
    u8 ampdu_density;
    struct ieee80211_mcs_info mcs;
};

Members

cap
HT capabilities map as described in 802.11n spec
ht_supported
is HT supported by the STA
ampdu_factor
Maximum A-MPDU length factor
ampdu_density
Minimum A-MPDU spacing
mcs
Supported MCS rates

Description

This structure describes most essential parameters needed to describe 802.11n HT capabilities for an STA.


struct ieee80211_supported_band - frequency band definition

struct ieee80211_supported_band {
    struct ieee80211_channel * channels;
    struct ieee80211_rate * bitrates;
    enum ieee80211_band band;
    int n_channels;
    int n_bitrates;
};

Members

channels
Array of channels the hardware can operate in in this band.
bitrates
Array of bitrates the hardware can operate with in this band. Must be sorted to give a valid "supported rates" IE, i.e. CCK rates first, then OFDM.
band
the band this structure represents
n_channels
Number of channels in channels
n_bitrates
Number of bitrates in bitrates

Description

This structure describes a frequency band a wiphy is able to operate in.


struct vif_params - describes virtual interface parameters

struct vif_params {
    u8 * mesh_id;
    int mesh_id_len;
    int use_4addr;
};

Members

mesh_id
mesh ID to use
mesh_id_len
length of the mesh ID
use_4addr
use 4-address frames

struct key_params - key information

struct key_params {
    u8 * key;
    u8 * seq;
    int key_len;
    u32 cipher;
};

Members

key
key material
seq
sequence counter (IV/PN) for TKIP and CCMP keys, only used with the get_key callback, must be in little endian, length given by seq_len.
key_len
length of key material
cipher
cipher suite selector

Description

Information about a key


enum survey_info_flags

enum survey_info_flags {
SURVEY_INFO_NOISE_DBM
};

Constants

SURVEY_INFO_NOISE_DBM
-- undescribed --

Description

Used by the driver to indicate which info in struct survey_info it has filled in during the get_survey.


struct survey_info - channel survey response

struct survey_info {
    struct ieee80211_channel * channel;
    u32 filled;
    s8 noise;
};

Members

channel
the channel this survey record reports, mandatory
filled
bitflag of flags from enum survey_info_flags
noise
channel noise in dBm. This and all following fields are optional

Description

This structure can later be expanded with things like channel duty cycle etc.

Description

This structure can later be expanded with things like channel duty cycle etc.

struct beacon_parameters - beacon parameters

struct beacon_parameters {
    u8 * head;
    u8 * tail;
    int interval;
    int dtim_period;
    int head_len;
    int tail_len;
};

Members

head
head portion of beacon (before TIM IE) or NULL if not changed
tail
tail portion of beacon (after TIM IE) or NULL if not changed
interval
beacon interval or zero if not changed
dtim_period
DTIM period or zero if not changed
head_len
length of head
tail_len
length of tail

Description

Used to configure the beacon for an interface.


enum plink_actions

enum plink_actions {
PLINK_ACTION_INVALID,
PLINK_ACTION_OPEN,
PLINK_ACTION_BLOCK
};

Constants

PLINK_ACTION_INVALID
action 0 is reserved
PLINK_ACTION_OPEN
start mesh peer link establishment
PLINK_ACTION_BLOCK
-- undescribed --

struct station_parameters - station parameters

struct station_parameters {
    u8 * supported_rates;
    struct net_device * vlan;
    u32 sta_flags_mask;
    u32 sta_flags_set;
    int listen_interval;
    u16 aid;
    u8 supported_rates_len;
};

Members

supported_rates
supported rates in IEEE 802.11 format (or NULL for no change)
vlan
vlan interface station should belong to
sta_flags_mask
station flags that changed (bitmask of BIT(NL80211_STA_FLAG_...))
sta_flags_set
station flags values (bitmask of BIT(NL80211_STA_FLAG_...))
listen_interval
listen interval or -1 for no change
aid
AID or zero for no change
supported_rates_len
number of supported rates

Description

Used to change and create a new station.


enum station_info_flags

enum station_info_flags {
STATION_INFO_INACTIVE_TIME,
STATION_INFO_RX_BYTES,
STATION_INFO_TX_BYTES,
STATION_INFO_LLID,
STATION_INFO_PLID,
STATION_INFO_PLINK_STATE,
STATION_INFO_SIGNAL,
STATION_INFO_TX_BITRATE,
STATION_INFO_RX_PACKETS,
STATION_INFO_TX_PACKETS
};

Constants

STATION_INFO_INACTIVE_TIME
inactive_time filled
STATION_INFO_RX_BYTES
rx_bytes filled
STATION_INFO_TX_BYTES
tx_bytes filled
STATION_INFO_LLID
llid filled
STATION_INFO_PLID
plid filled
STATION_INFO_PLINK_STATE
plink_state filled
STATION_INFO_SIGNAL
signal filled
STATION_INFO_TX_BITRATE
tx_bitrate fields are filled (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
STATION_INFO_RX_PACKETS
rx_packets filled
STATION_INFO_TX_PACKETS
tx_packets filled

Description

Used by the driver to indicate which info in struct station_info it has filled in during get_station or dump_station.


enum rate_info_flags

enum rate_info_flags {
RATE_INFO_FLAGS_MCS,
RATE_INFO_FLAGS_40_MHZ_WIDTH,
RATE_INFO_FLAGS_SHORT_GI
};

Constants

RATE_INFO_FLAGS_MCS
tx_bitrate_mcs filled
RATE_INFO_FLAGS_40_MHZ_WIDTH
40 Mhz width transmission
RATE_INFO_FLAGS_SHORT_GI
400ns guard interval

Description

Used by the driver to indicate the specific rate transmission type for 802.11n transmissions.


struct rate_info - bitrate information

struct rate_info {
    u8 flags;
    u8 mcs;
    u16 legacy;
};

Members

flags
bitflag of flags from enum rate_info_flags
mcs
mcs index if struct describes a 802.11n bitrate
legacy
bitrate in 100kbit/s for 802.11abg

Description

Information about a receiving or transmitting bitrate


struct station_info - station information

struct station_info {
    u32 filled;
    u32 inactive_time;
    u32 rx_bytes;
    u32 tx_bytes;
    u16 llid;
    u16 plid;
    u8 plink_state;
    s8 signal;
    struct rate_info txrate;
    u32 rx_packets;
    u32 tx_packets;
    int generation;
};

Members

filled
bitflag of flags from enum station_info_flags
inactive_time
time since last station activity (tx/rx) in milliseconds
rx_bytes
bytes received from this station
tx_bytes
bytes transmitted to this station
llid
mesh local link id
plid
mesh peer link id
plink_state
mesh peer link state
signal
signal strength of last received packet in dBm
txrate
current unicast bitrate to this station
rx_packets
packets received from this station
tx_packets
packets transmitted to this station
generation
generation number for nl80211 dumps. This number should increase every time the list of stations changes, i.e. when a station is added or removed, so that userspace can tell whether it got a consistent snapshot.

Description

Station information filled by driver for get_station and dump_station.


enum monitor_flags

enum monitor_flags {
MONITOR_FLAG_FCSFAIL,
MONITOR_FLAG_PLCPFAIL,
MONITOR_FLAG_CONTROL,
MONITOR_FLAG_OTHER_BSS,
MONITOR_FLAG_COOK_FRAMES
};

Constants

MONITOR_FLAG_FCSFAIL
pass frames with bad FCS
MONITOR_FLAG_PLCPFAIL
pass frames with bad PLCP
MONITOR_FLAG_CONTROL
pass control frames
MONITOR_FLAG_OTHER_BSS
disable BSSID filtering
MONITOR_FLAG_COOK_FRAMES
report frames after processing

Description

Monitor interface configuration flags. Note that these must be the bits according to the nl80211 flags.


enum mpath_info_flags

enum mpath_info_flags {
MPATH_INFO_FRAME_QLEN,
MPATH_INFO_SN,
MPATH_INFO_METRIC,
MPATH_INFO_EXPTIME,
MPATH_INFO_DISCOVERY_TIMEOUT,
MPATH_INFO_DISCOVERY_RETRIES,
MPATH_INFO_FLAGS
};

Constants

MPATH_INFO_FRAME_QLEN
-- undescribed --
MPATH_INFO_SN
-- undescribed --
MPATH_INFO_METRIC
-- undescribed --
MPATH_INFO_EXPTIME
-- undescribed --
MPATH_INFO_DISCOVERY_TIMEOUT
-- undescribed --
MPATH_INFO_DISCOVERY_RETRIES
-- undescribed --
MPATH_INFO_FLAGS
-- undescribed --

Description

Used by the driver to indicate which info in struct mpath_info it has filled in during get_station or dump_station.

MPATH_INFO_FRAME_QLEN

frame_qlen filled

MPATH_INFO_SN

sn filled

MPATH_INFO_METRIC

metric filled

MPATH_INFO_EXPTIME

exptime filled

MPATH_INFO_DISCOVERY_TIMEOUT

discovery_timeout filled

MPATH_INFO_DISCOVERY_RETRIES

discovery_retries filled

MPATH_INFO_FLAGS

flags filled

struct mpath_info - mesh path information

struct mpath_info {
    u32 filled;
    u32 frame_qlen;
    u32 sn;
    u32 metric;
    u32 exptime;
    u32 discovery_timeout;
    u8 discovery_retries;
    u8 flags;
    int generation;
};

Members

filled
bitfield of flags from enum mpath_info_flags
frame_qlen
number of queued frames for this destination
sn
target sequence number
metric
metric (cost) of this mesh path
exptime
expiration time for the mesh path from now, in msecs
discovery_timeout
total mesh path discovery timeout, in msecs
discovery_retries
mesh path discovery retries
flags
mesh path flags
generation
generation number for nl80211 dumps. This number should increase every time the list of mesh paths changes, i.e. when a station is added or removed, so that userspace can tell whether it got a consistent snapshot.

Description

Mesh path information filled by driver for get_mpath and dump_mpath.


struct bss_parameters - BSS parameters

struct bss_parameters {
    int use_cts_prot;
    int use_short_preamble;
    int use_short_slot_time;
    u8 * basic_rates;
    u8 basic_rates_len;
};

Members

use_cts_prot
Whether to use CTS protection (0 = no, 1 = yes, -1 = do not change)
use_short_preamble
Whether the use of short preambles is allowed (0 = no, 1 = yes, -1 = do not change)
use_short_slot_time
Whether the use of short slot time is allowed (0 = no, 1 = yes, -1 = do not change)
basic_rates
basic rates in IEEE 802.11 format (or NULL for no change)
basic_rates_len
number of basic rates

Description

Used to change BSS parameters (mainly for AP mode).


struct ieee80211_txq_params - TX queue parameters

struct ieee80211_txq_params {
    enum nl80211_txq_q queue;
    u16 txop;
    u16 cwmin;
    u16 cwmax;
    u8 aifs;
};

Members

queue
TX queue identifier (NL80211_TXQ_Q_*)
txop
Maximum burst time in units of 32 usecs, 0 meaning disabled
cwmin
Minimum contention window [a value of the form 2^n-1 in the range 1..32767]
cwmax
Maximum contention window [a value of the form 2^n-1 in the range 1..32767]
aifs
Arbitration interframe space [0..255]

struct cfg80211_ssid - SSID description

struct cfg80211_ssid {
    u8 ssid[IEEE80211_MAX_SSID_LEN];
    u8 ssid_len;
};

Members

ssid[IEEE80211_MAX_SSID_LEN]
the SSID
ssid_len
length of the ssid

struct cfg80211_scan_request - scan request description

struct cfg80211_scan_request {
    struct cfg80211_ssid * ssids;
    int n_ssids;
    u32 n_channels;
    const u8 * ie;
    size_t ie_len;
    struct wiphy * wiphy;
    struct net_device * dev;
    struct ieee80211_channel * channels[0];
};

Members

ssids
SSIDs to scan for (active scan only)
n_ssids
number of SSIDs
n_channels
total number of channels to scan
ie
optional information element(s) to add into Probe Request or NULL
ie_len
length of ie in octets
wiphy
the wiphy this was for
dev
the interface
channels[0]
channels to scan on.

enum cfg80211_signal_type

enum cfg80211_signal_type {
CFG80211_SIGNAL_TYPE_NONE,
CFG80211_SIGNAL_TYPE_MBM,
CFG80211_SIGNAL_TYPE_UNSPEC
};

Constants

CFG80211_SIGNAL_TYPE_NONE
no signal strength information available
CFG80211_SIGNAL_TYPE_MBM
signal strength in mBm (100*dBm)
CFG80211_SIGNAL_TYPE_UNSPEC
signal strength, increasing from 0 through 100

struct cfg80211_bss - BSS description

struct cfg80211_bss {
    u8 bssid[ETH_ALEN];
    u64 tsf;
    u16 beacon_interval;
    u16 capability;
    u8 * information_elements;
    size_t len_information_elements;
    u8 * beacon_ies;
    size_t len_beacon_ies;
    u8 * proberesp_ies;
    size_t len_proberesp_ies;
    s32 signal;
    void (*free_priv) (struct cfg80211_bss *bss);
    u8 priv[0] __attribute__((__aligned__(sizeof(void *))));
};

Members

bssid[ETH_ALEN]
BSSID of the BSS
tsf
timestamp of last received update
beacon_interval
the beacon interval as from the frame
capability
the capability field in host byte order
information_elements
the information elements (Note that there is no guarantee that these are well-formed!); this is a pointer to either the beacon_ies or proberesp_ies depending on whether Probe Response frame has been received
len_information_elements
total length of the information elements
beacon_ies
the information elements from the last Beacon frame
len_beacon_ies
total length of the beacon_ies
proberesp_ies
the information elements from the last Probe Response frame
len_proberesp_ies
total length of the proberesp_ies
signal
signal strength value (type depends on the wiphy's signal_type)
free_priv
function pointer to free private data
priv[0] __attribute__((__aligned__(sizeof(void *))))
private area for driver use, has at least wiphy->bss_priv_size bytes

Description

This structure describes a BSS (which may also be a mesh network) for use in scan results and similar.


ieee80211_bss_get_ie - find IE with given ID

const u8 * ieee80211_bss_get_ie (struct cfg80211_bss * bss, u8 ie)

Arguments

bss
the bss to search
ie
the IE ID Returns NULL if not found.

struct cfg80211_crypto_settings - Crypto settings

struct cfg80211_crypto_settings {
    u32 wpa_versions;
    u32 cipher_group;
    int n_ciphers_pairwise;
    u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
    int n_akm_suites;
    u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
    bool control_port;
};

Members

wpa_versions
indicates which, if any, WPA versions are enabled (from enum nl80211_wpa_versions)
cipher_group
group key cipher suite (or 0 if unset)
n_ciphers_pairwise
number of AP supported unicast ciphers
ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES]
unicast key cipher suites
n_akm_suites
number of AKM suites
akm_suites[NL80211_MAX_NR_AKM_SUITES]
AKM suites
control_port
Whether user space controls IEEE 802.1X port, i.e., sets/clears NL80211_STA_FLAG_AUTHORIZED. If true, the driver is required to assume that the port is unauthorized until authorized by user space. Otherwise, port is marked authorized by default.

struct cfg80211_auth_request - Authentication request data

struct cfg80211_auth_request {
    struct cfg80211_bss * bss;
    const u8 * ie;
    size_t ie_len;
    enum nl80211_auth_type auth_type;
    const u8 * key;
    u8 key_len;
    u8 key_idx;
};

Members

bss
The BSS to authenticate with.
ie
Extra IEs to add to Authentication frame or NULL
ie_len
Length of ie buffer in octets
auth_type
Authentication type (algorithm)
key
WEP key for shared key authentication
key_len
length of WEP key for shared key authentication
key_idx
index of WEP key for shared key authentication

Description

This structure provides information needed to complete IEEE 802.11 authentication.


struct cfg80211_assoc_request - (Re)Association request data

struct cfg80211_assoc_request {
    struct cfg80211_bss * bss;
    const u8 * ie;
    const u8 * prev_bssid;
    size_t ie_len;
    struct cfg80211_crypto_settings crypto;
    bool use_mfp;
};

Members

bss
The BSS to associate with.
ie
Extra IEs to add to (Re)Association Request frame or NULL
prev_bssid
previous BSSID, if not NULL use reassociate frame
ie_len
Length of ie buffer in octets
crypto
crypto settings
use_mfp
Use management frame protection (IEEE 802.11w) in this association

Description

This structure provides information needed to complete IEEE 802.11 (re)association.


struct cfg80211_deauth_request - Deauthentication request data

struct cfg80211_deauth_request {
    struct cfg80211_bss * bss;
    const u8 * ie;
    size_t ie_len;
    u16 reason_code;
};

Members

bss
the BSS to deauthenticate from
ie
Extra IEs to add to Deauthentication frame or NULL
ie_len
Length of ie buffer in octets
reason_code
The reason code for the deauthentication

Description

This structure provides information needed to complete IEEE 802.11 deauthentication.


struct cfg80211_disassoc_request - Disassociation request data

struct cfg80211_disassoc_request {
    struct cfg80211_bss * bss;
    const u8 * ie;
    size_t ie_len;
    u16 reason_code;
};

Members

bss
the BSS to disassociate from
ie
Extra IEs to add to Disassociation frame or NULL
ie_len
Length of ie buffer in octets
reason_code
The reason code for the disassociation

Description

This structure provides information needed to complete IEEE 802.11 disassocation.


struct cfg80211_ibss_params - IBSS parameters

struct cfg80211_ibss_params {
    u8 * ssid;
    u8 * bssid;
    struct ieee80211_channel * channel;
    u8 * ie;
    u8 ssid_len;
    u8 ie_len;
    u16 beacon_interval;
    bool channel_fixed;
    bool privacy;
};

Members

ssid
The SSID, will always be non-null.
bssid
Fixed BSSID requested, maybe be NULL, if set do not search for IBSSs with a different BSSID.
channel
The channel to use if no IBSS can be found to join.
ie
information element(s) to include in the beacon
ssid_len
The length of the SSID, will always be non-zero.
ie_len
length of that
beacon_interval
beacon interval to use
channel_fixed
The channel should be fixed -- do not search for IBSSs to join on other channels.
privacy
this is a protected network, keys will be configured after joining

Description

This structure defines the IBSS parameters for the join_ibss method.


struct cfg80211_connect_params - Connection parameters

struct cfg80211_connect_params {
    struct ieee80211_channel * channel;
    u8 * bssid;
    u8 * ssid;
    size_t ssid_len;
    enum nl80211_auth_type auth_type;
    bool privacy;
    struct cfg80211_crypto_settings crypto;
    const u8 * key;
    u8 key_len;
    u8 key_idx;
};

Members

channel
The channel to use or NULL if not specified (auto-select based on scan results)
bssid
The AP BSSID or NULL if not specified (auto-select based on scan results)
ssid
SSID
ssid_len
Length of ssid in octets
auth_type
Authentication type (algorithm)
privacy
indicates whether privacy-enabled APs should be used
crypto
crypto settings
key
WEP key for shared key authentication
key_len
length of WEP key for shared key authentication
key_idx
index of WEP key for shared key authentication

Description

This structure provides information needed to complete IEEE 802.11 authentication and association.


enum wiphy_params_flags

enum wiphy_params_flags {
WIPHY_PARAM_RETRY_SHORT,
WIPHY_PARAM_RETRY_LONG,
WIPHY_PARAM_FRAG_THRESHOLD,
WIPHY_PARAM_RTS_THRESHOLD,
WIPHY_PARAM_COVERAGE_CLASS
};

Constants

WIPHY_PARAM_RETRY_SHORT
-- undescribed --
WIPHY_PARAM_RETRY_LONG
-- undescribed --
WIPHY_PARAM_FRAG_THRESHOLD
-- undescribed --
WIPHY_PARAM_RTS_THRESHOLD
-- undescribed --
WIPHY_PARAM_COVERAGE_CLASS
-- undescribed --

WIPHY_PARAM_RETRY_SHORT

wiphy->retry_short has changed

WIPHY_PARAM_RETRY_LONG

wiphy->retry_long has changed

WIPHY_PARAM_FRAG_THRESHOLD

wiphy->frag_threshold has changed

WIPHY_PARAM_RTS_THRESHOLD

wiphy->rts_threshold has changed

enum tx_power_setting

enum tx_power_setting {
TX_POWER_AUTOMATIC,
TX_POWER_LIMITED,
TX_POWER_FIXED
};

Constants

TX_POWER_AUTOMATIC
the dbm parameter is ignored
TX_POWER_LIMITED
limit TX power by the dbm parameter
TX_POWER_FIXED
fix TX power to the dbm parameter

struct cfg80211_pmksa - PMK Security Association

struct cfg80211_pmksa {
    u8 * bssid;
    u8 * pmkid;
};

Members

bssid
The AP's BSSID.
pmkid
The PMK material itself.

Description

This structure is passed to the set/del_pmksa method for PMKSA caching.


struct cfg80211_ops - backend description for wireless configuration

struct cfg80211_ops {
    int (*suspend) (struct wiphy *wiphy);
    int (*resume) (struct wiphy *wiphy);
    int (*add_virtual_intf) (struct wiphy *wiphy, char *name,enum nl80211_iftype type, u32 *flags,struct vif_params *params);
    int (*del_virtual_intf) (struct wiphy *wiphy, struct net_device *dev);
    int (*change_virtual_intf) (struct wiphy *wiphy,struct net_device *dev,enum nl80211_iftype type, u32 *flags,struct vif_params *params);
    int (*add_key) (struct wiphy *wiphy, struct net_device *netdev,u8 key_index, const u8 *mac_addr,struct key_params *params);
    int (*get_key) (struct wiphy *wiphy, struct net_device *netdev,u8 key_index, const u8 *mac_addr, void *cookie,void (*callback);
    int (*del_key) (struct wiphy *wiphy, struct net_device *netdev,u8 key_index, const u8 *mac_addr);
    int (*set_default_key) (struct wiphy *wiphy,struct net_device *netdev,u8 key_index);
    int (*set_default_mgmt_key) (struct wiphy *wiphy,struct net_device *netdev,u8 key_index);
    int (*add_beacon) (struct wiphy *wiphy, struct net_device *dev,struct beacon_parameters *info);
    int (*set_beacon) (struct wiphy *wiphy, struct net_device *dev,struct beacon_parameters *info);
    int (*del_beacon) (struct wiphy *wiphy, struct net_device *dev);
    int (*add_station) (struct wiphy *wiphy, struct net_device *dev,u8 *mac, struct station_parameters *params);
    int (*del_station) (struct wiphy *wiphy, struct net_device *dev,u8 *mac);
    int (*change_station) (struct wiphy *wiphy, struct net_device *dev,u8 *mac, struct station_parameters *params);
    int (*get_mesh_params) (struct wiphy *wiphy,struct net_device *dev,struct mesh_config *conf);
    int (*set_mesh_params) (struct wiphy *wiphy,struct net_device *dev,const struct mesh_config *nconf, u32 mask);
    int (*change_bss) (struct wiphy *wiphy, struct net_device *dev,struct bss_parameters *params);
    int (*set_txq_params) (struct wiphy *wiphy,struct ieee80211_txq_params *params);
    int (*set_channel) (struct wiphy *wiphy,struct ieee80211_channel *chan,enum nl80211_channel_type channel_type);
    int (*scan) (struct wiphy *wiphy, struct net_device *dev,struct cfg80211_scan_request *request);
    int (*auth) (struct wiphy *wiphy, struct net_device *dev,struct cfg80211_auth_request *req);
    int (*assoc) (struct wiphy *wiphy, struct net_device *dev,struct cfg80211_assoc_request *req);
    int (*deauth) (struct wiphy *wiphy, struct net_device *dev,struct cfg80211_deauth_request *req,void *cookie);
    int (*disassoc) (struct wiphy *wiphy, struct net_device *dev,struct cfg80211_disassoc_request *req,void *cookie);
    int (*connect) (struct wiphy *wiphy, struct net_device *dev,struct cfg80211_connect_params *sme);
    int (*disconnect) (struct wiphy *wiphy, struct net_device *dev,u16 reason_code);
    int (*join_ibss) (struct wiphy *wiphy, struct net_device *dev,struct cfg80211_ibss_params *params);
    int (*leave_ibss) (struct wiphy *wiphy, struct net_device *dev);
    int (*set_wiphy_params) (struct wiphy *wiphy, u32 changed);
    int (*set_tx_power) (struct wiphy *wiphy,enum tx_power_setting type, int dbm);
    int (*get_tx_power) (struct wiphy *wiphy, int *dbm);
    void (*rfkill_poll) (struct wiphy *wiphy);
#ifdef CONFIG_NL80211_TESTMODE
    int (*testmode_cmd) (struct wiphy *wiphy, void *data, int len);
#endif
    int (*dump_survey) (struct wiphy *wiphy, struct net_device *netdev,int idx, struct survey_info *info);
    int (*set_pmksa) (struct wiphy *wiphy, struct net_device *netdev,struct cfg80211_pmksa *pmksa);
    int (*del_pmksa) (struct wiphy *wiphy, struct net_device *netdev,struct cfg80211_pmksa *pmksa);
    int (*flush_pmksa) (struct wiphy *wiphy, struct net_device *netdev);
    int (*remain_on_channel) (struct wiphy *wiphy,struct net_device *dev,struct ieee80211_channel *chan,enum nl80211_channel_type channel_type,unsigned int duration,u64 *cookie);
    int (*cancel_remain_on_channel) (struct wiphy *wiphy,struct net_device *dev,u64 cookie);
    int (*action) (struct wiphy *wiphy, struct net_device *dev,struct ieee80211_channel *chan,enum nl80211_channel_type channel_type,const u8 *buf, size_t len, u64 *cookie);
};

Members

suspend
wiphy device needs to be suspended
resume
wiphy device needs to be resumed
add_virtual_intf
create a new virtual interface with the given name, must set the struct wireless_dev's iftype. Beware: You must create the new netdev in the wiphy's network namespace!
del_virtual_intf
remove the virtual interface determined by ifindex.
change_virtual_intf
change type/configuration of virtual interface, keep the struct wireless_dev's iftype updated.
add_key
add a key with the given parameters. mac_addr will be NULL when adding a group key.
get_key
get information about the key with the given parameters. mac_addr will be NULL when requesting information for a group key. All pointers given to the callback function need not be valid after it returns. This function should return an error if it is not possible to retrieve the key, -ENOENT if it doesn't exist.
del_key
remove a key given the mac_addr (NULL for a group key) and key_index, return -ENOENT if the key doesn't exist.
set_default_key
set the default key on an interface
set_default_mgmt_key
set the default management frame key on an interface
add_beacon
Add a beacon with given parameters, head, interval and dtim_period will be valid, tail is optional.
set_beacon
Change the beacon parameters for an access point mode interface. This should reject the call when no beacon has been configured.
del_beacon
Remove beacon configuration and stop sending the beacon.
add_station
Add a new station.
del_station
Remove a station; mac may be NULL to remove all stations.
change_station
Modify a given station.
get_mesh_params
Put the current mesh parameters into *params
set_mesh_params
Set mesh parameters. The mask is a bitfield which tells us which parameters to set, and which to leave alone.
change_bss
Modify parameters for a given BSS.
set_txq_params
Set TX queue parameters
set_channel
Set channel
scan
Request to do a scan. If returning zero, the scan request is given the driver, and will be valid until passed to cfg80211_scan_done. For scan results, call cfg80211_inform_bss; you can call this outside the scan/scan_done bracket too.
auth
Request to authenticate with the specified peer
assoc
Request to (re)associate with the specified peer
deauth
Request to deauthenticate from the specified peer
disassoc
Request to disassociate from the specified peer
connect
Connect to the ESS with the specified parameters. When connected, call cfg80211_connect_result with status code WLAN_STATUS_SUCCESS. If the connection fails for some reason, call cfg80211_connect_result with the status from the AP.
disconnect
Disconnect from the BSS/ESS.
join_ibss
Join the specified IBSS (or create if necessary). Once done, call cfg80211_ibss_joined, also call that function when changing BSSID due to a merge.
leave_ibss
Leave the IBSS.
set_wiphy_params
Notify that wiphy parameters have changed; changed bitfield (see enum wiphy_params_flags) describes which values have changed. The actual parameter values are available in struct wiphy. If returning an error, no value should be changed.
set_tx_power
set the transmit power according to the parameters
get_tx_power
store the current TX power into the dbm variable; return 0 if successful
rfkill_poll
polls the hw rfkill line, use cfg80211 reporting functions to adjust rfkill hw state
testmode_cmd
run a test mode command
dump_survey
get site survey information.
set_pmksa
Cache a PMKID for a BSSID. This is mostly useful for fullmac devices running firmwares capable of generating the (re) association RSN IE. It allows for faster roaming between WPA2 BSSIDs.
del_pmksa
Delete a cached PMKID.
flush_pmksa
Flush all cached PMKIDs.
remain_on_channel
Request the driver to remain awake on the specified channel for the specified duration to complete an off-channel operation (e.g., public action frame exchange). When the driver is ready on the requested channel, it must indicate this with an event notification by calling cfg80211_ready_on_channel.
cancel_remain_on_channel
Cancel an on-going remain-on-channel operation. This allows the operation to be terminated prior to timeout based on the duration value.
action
Transmit an action frame

Description

This struct is registered by fullmac card drivers and/or wireless stacks in order to handle configuration requests on their interfaces.

All callbacks except where otherwise noted should return 0 on success or a negative error code.

All operations are currently invoked under rtnl for consistency with the wireless extensions but this is subject to reevaluation as soon as this code is used more widely and we have a first user without wext.


enum wiphy_flags

enum wiphy_flags {
WIPHY_FLAG_CUSTOM_REGULATORY,
WIPHY_FLAG_STRICT_REGULATORY,
WIPHY_FLAG_DISABLE_BEACON_HINTS,
WIPHY_FLAG_NETNS_OK,
WIPHY_FLAG_PS_ON_BY_DEFAULT,
WIPHY_FLAG_4ADDR_AP,
WIPHY_FLAG_4ADDR_STATION
};

Constants

WIPHY_FLAG_CUSTOM_REGULATORY
tells us the driver for this device has its own custom regulatory domain and cannot identify the ISO / IEC 3166 alpha2 it belongs to. When this is enabled we will disregard the first regulatory hint (when the initiator is REGDOM_SET_BY_CORE).
WIPHY_FLAG_STRICT_REGULATORY
tells us the driver for this device will ignore regulatory domain settings until it gets its own regulatory domain via its regulatory_hint. After its gets its own regulatory domain it will only allow further regulatory domain settings to further enhance compliance. For example if channel 13 and 14 are disabled by this regulatory domain no user regulatory domain can enable these channels at a later time. This can be used for devices which do not have calibration information gauranteed for frequencies or settings outside of its regulatory domain.
WIPHY_FLAG_DISABLE_BEACON_HINTS
enable this if your driver needs to ensure that passive scan flags and beaconing flags may not be lifted by cfg80211 due to regulatory beacon hints. For more information on beacon hints read the documenation for regulatory_hint_found_beacon
WIPHY_FLAG_NETNS_OK
if not set, do not allow changing the netns of this wiphy at all
WIPHY_FLAG_PS_ON_BY_DEFAULT
if set to true, powersave will be enabled by default -- this flag will be set depending on the kernel's default on wiphy_new, but can be changed by the driver if it has a good reason to override the default
WIPHY_FLAG_4ADDR_AP
supports 4addr mode even on AP (with a single station on a VLAN interface)
WIPHY_FLAG_4ADDR_STATION
supports 4addr mode even as a station

struct wiphy - wireless hardware description

struct wiphy {
    u8 perm_addr[ETH_ALEN];
    u8 addr_mask[ETH_ALEN];
    u16 n_addresses;
    struct mac_address * addresses;
    enum cfg80211_signal_type signal_type;
    int n_cipher_suites;
    const u32 * cipher_suites;
    u8 retry_short;
    u8 retry_long;
    u32 frag_threshold;
    u32 rts_threshold;
    int (*reg_notifier) (struct wiphy *wiphy,struct regulatory_request *request);
    const struct ieee80211_regdomain * regd;
#ifdef CONFIG_NET_NS
#endif
#ifdef CONFIG_CFG80211_WEXT
#endif
};

Members

perm_addr[ETH_ALEN]
permanent MAC address of this device
addr_mask[ETH_ALEN]
If the device supports multiple MAC addresses by masking, set this to a mask with variable bits set to 1, e.g. if the last
n_addresses
number of addresses in addresses.
addresses
If the device has more than one address, set this pointer to a list of addresses (6 bytes each). The first one will be used by default for perm_addr. In this case, the mask should be set to all-zeroes. In this case it is assumed that the device can handle the same number of arbitrary MAC addresses.
signal_type
signal type reported in struct cfg80211_bss.
n_cipher_suites
number of supported cipher suites
cipher_suites
supported cipher suites
retry_short
Retry limit for short frames (dot11ShortRetryLimit)
retry_long
Retry limit for long frames (dot11LongRetryLimit)
frag_threshold
Fragmentation threshold (dot11FragmentationThreshold); -1 = fragmentation disabled, only odd values >= 256 used
rts_threshold
RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
reg_notifier
the driver's regulatory notification callback
regd
the driver's regulatory domain, if one was requested via the regulatory_hint API. This can be used by the driver on the reg_notifier if it chooses to ignore future regulatory domain changes caused by other drivers.

four bits are variable then set it to 00

...:00:0f. The actual variable bits shall be determined by the interfaces added, with interfaces not matching the mask being rejected to be brought up.

wiphy_priv - return priv from wiphy

void * wiphy_priv (struct wiphy * wiphy)

Arguments

wiphy
the wiphy whose priv pointer to return

priv_to_wiphy - return the wiphy containing the priv

struct wiphy * priv_to_wiphy (void * priv)

Arguments

priv
a pointer previously returned by wiphy_priv

set_wiphy_dev - set device pointer for wiphy

void set_wiphy_dev (struct wiphy * wiphy, struct device * dev)

Arguments

wiphy
The wiphy whose device to bind
dev
The device to parent it to

wiphy_dev - get wiphy dev pointer

struct device * wiphy_dev (struct wiphy * wiphy)

Arguments

wiphy
The wiphy whose device struct to look up

wiphy_name - get wiphy name

const char * wiphy_name (struct wiphy * wiphy)

Arguments

wiphy
The wiphy whose name to return

wiphy_new - create a new wiphy for use with cfg80211

struct wiphy * wiphy_new (const struct cfg80211_ops * ops, int sizeof_priv)

Arguments

ops
The configuration operations for this device
sizeof_priv
The size of the private area to allocate

Description

Create a new wiphy and associate the given operations with it. sizeof_priv bytes are allocated for private use.

The returned pointer must be assigned to each netdev's ieee80211_ptr for proper operation.


wiphy_register - register a wiphy with cfg80211

int wiphy_register (struct wiphy * wiphy)

Arguments

wiphy
The wiphy to register.

Description

Returns a non-negative wiphy index or a negative error code.

wiphy_unregister - deregister a wiphy from cfg80211

void wiphy_unregister (struct wiphy * wiphy)

Arguments

wiphy
The wiphy to unregister.

Description

After this call, no more requests can be made with this priv pointer, but the call may sleep to wait for an outstanding request that is being handled.

wiphy_free - free wiphy

void wiphy_free (struct wiphy * wiphy)

Arguments

wiphy
The wiphy to free

struct wireless_dev - wireless per-netdev state

struct wireless_dev {
    struct wiphy * wiphy;
    enum nl80211_iftype iftype;
    struct list_head list;
    struct net_device * netdev;
    struct list_head action_registrations;
    spinlock_t action_registrations_lock;
    bool use_4addr;
    u8 ssid[IEEE80211_MAX_SSID_LEN];
    u8 ssid_len;
    enum wext;
#endif
};

Members

wiphy
pointer to hardware description
iftype
interface type
list
(private) Used to collect the interfaces
netdev
(private) Used to reference back to the netdev
action_registrations
list of registrations for action frames
action_registrations_lock
lock for the list
use_4addr
indicates 4addr mode is used on this interface, must be set by driver (if supported) on add_interface BEFORE registering the netdev and may otherwise be used by driver read-only, will be update by cfg80211 on change_interface
ssid[IEEE80211_MAX_SSID_LEN]
(private) Used by the internal configuration code
ssid_len
(private) Used by the internal configuration code
wext
(private) Used by the internal wireless extensions compat code

Description

This structure must be allocated by the driver/stack that uses the ieee80211_ptr field in struct net_device (this is intentional so it can be allocated along with the netdev.)


wdev_priv - return wiphy priv from wireless_dev

void * wdev_priv (struct wireless_dev * wdev)

Arguments

wdev
The wireless device whose wiphy's priv pointer to return

ieee80211_channel_to_frequency - convert channel number to frequency

int ieee80211_channel_to_frequency (int chan)

Arguments


ieee80211_frequency_to_channel - convert frequency to channel number

int ieee80211_frequency_to_channel (int freq)

Arguments


ieee80211_get_channel - get channel struct from wiphy for specified frequency

struct ieee80211_channel * ieee80211_get_channel (struct wiphy * wiphy, int freq)

Arguments


ieee80211_get_response_rate - get basic rate for a given rate

struct ieee80211_rate * ieee80211_get_response_rate (struct ieee80211_supported_band * sband, u32 basic_rates, int bitrate)

Arguments

sband
the band to look for rates in
basic_rates
bitmap of basic rates
bitrate
the bitrate for which to find the basic rate

Description

This function returns the basic rate corresponding to a given bitrate, that is the next lower bitrate contained in the basic rate map, which is, for this function, given as a bitmap of indices of rates in the band's bitrate table.

struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args

struct ieee80211_radiotap_iterator {
    struct ieee80211_radiotap_header * _rtheader;
    const struct ieee80211_radiotap_vendor_namespaces * _vns;
    const struct ieee80211_radiotap_namespace * current_namespace;
    unsigned char * _arg;
    unsigned char * _next_ns_data;
    uint32_t * _next_bitmap;
    unsigned char * this_arg;
    int this_arg_index;
    int this_arg_size;
    int is_radiotap_ns;
    int _max_length;
    int _arg_index;
    uint32_t _bitmap_shifter;
    int _reset_on_ext;
};

Members

_rtheader
pointer to the radiotap header we are walking through
_vns
vendor namespace definitions
current_namespace
pointer to the current namespace definition (or internally NULL if the current namespace is unknown)
_arg
next argument pointer
_next_ns_data
beginning of the next namespace's data
_next_bitmap
internal pointer to next present u32
this_arg
pointer to current radiotap arg; it is valid after each call to ieee80211_radiotap_iterator_next but also after ieee80211_radiotap_iterator_init where it will point to the beginning of the actual data portion
this_arg_index
index of current arg, valid after each successful call to ieee80211_radiotap_iterator_next
this_arg_size
length of the current arg, for convenience
is_radiotap_ns
indicates whether the current namespace is the default radiotap namespace or not
_max_length
length of radiotap header in cpu byte ordering
_arg_index
next argument index
_bitmap_shifter
internal shifter for curr u32 bitmap, b0 set == arg present
_reset_on_ext
internal; reset the arg index to 0 when going to the next bitmap word

Description

Describes the radiotap parser state. Fields prefixed with an underscore must not be used by users of the parser, only by the parser internally.

ieee80211_get_hdrlen_from_skb - get header length from data

unsigned int ieee80211_get_hdrlen_from_skb (const struct sk_buff * skb)

Arguments

skb
the frame

Description

Given an skb with a raw 802.11 header at the data pointer this function returns the 802.11 header length in bytes (not including encryption headers). If the data in the sk_buff is too short to contain a valid 802.11 header the function returns 0.


ieee80211_hdrlen - get header length in bytes from frame control

unsigned int ieee80211_hdrlen (__le16 fc)

Arguments

fc
frame control field in little-endian format

ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3

int ieee80211_data_to_8023 (struct sk_buff * skb, const u8 * addr, enum nl80211_iftype iftype)

Arguments

skb
the 802.11 data frame
addr
the device MAC address
iftype
the virtual interface type

ieee80211_data_from_8023 - convert an 802.3 frame to 802.11

int ieee80211_data_from_8023 (struct sk_buff * skb, const u8 * addr, enum nl80211_iftype iftype, u8 * bssid, bool qos)

Arguments

skb
the 802.3 frame
addr
the device MAC address
iftype
the virtual interface type
bssid
the network bssid (used only for iftype STATION and ADHOC)
qos
build 802.11 QoS data frame

ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame

void ieee80211_amsdu_to_8023s (struct sk_buff * skb, struct sk_buff_head * list, const u8 * addr, enum nl80211_iftype iftype, const unsigned int extra_headroom)

Arguments

skb
The input IEEE 802.11n A-MSDU frame.
list
The output list of 802.3 frames. It must be allocated and initialized by by the caller.
addr
The device MAC address.
iftype
The device interface type.
extra_headroom
The hardware extra headroom for SKBs in the list.

Description

Decode an IEEE 802.11n A-MSDU frame and convert it to a list of 802.3 frames. The list will be empty if the decode fails. The skb is consumed after the function returns.


cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame

unsigned int cfg80211_classify8021d (struct sk_buff * skb)

Arguments

skb
the data frame

cfg80211_find_ie - find information element in data

const u8 * cfg80211_find_ie (u8 eid, const u8 * ies, int len)

Arguments

eid
element ID
ies
data consisting of IEs
len
length of data

Description

This function will return NULL if the element ID could not be found or if the element is invalid (claims to be longer than the given data), or a pointer to the first byte of the requested element, that is the byte containing the element ID. There are no checks on the element length other than having to fit into the given data.

regulatory_hint - driver hint to the wireless core a regulatory domain

int regulatory_hint (struct wiphy * wiphy, const char * alpha2)

Arguments

wiphy
the wireless device giving the hint (used only for reporting conflicts)
alpha2
the ISO/IEC 3166 alpha2 the driver claims its regulatory domain should be in. If rd is set this should be NULL. Note that if you set this to NULL you should still set rd->alpha2 to some accepted alpha2.

Description

Wireless drivers can use this function to hint to the wireless core what it believes should be the current regulatory domain by giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory domain should be in or by providing a completely build regulatory domain. If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried for a regulatory domain structure for the respective country.

The wiphy must have been registered to cfg80211 prior to this call. For cfg80211 drivers this means you must first use wiphy_register, for mac80211 drivers you must first use ieee80211_register_hw.

Drivers should check the return value, its possible you can get an -ENOMEM.


wiphy_apply_custom_regulatory - apply a custom driver regulatory domain

void wiphy_apply_custom_regulatory (struct wiphy * wiphy, const struct ieee80211_regdomain * regd)

Arguments

wiphy
the wireless device we want to process the regulatory domain on
regd
the custom regulatory domain to use for this wiphy

Description

Drivers can sometimes have custom regulatory domains which do not apply to a specific country. Drivers can use this to apply such custom regulatory domains. This routine must be called prior to wiphy registration. The custom regulatory domain will be trusted completely and as such previous default channel settings will be disregarded. If no rule is found for a channel on the regulatory domain the channel will be disabled.

freq_reg_info - get regulatory information for the given frequency

int freq_reg_info (struct wiphy * wiphy, u32 center_freq, u32 desired_bw_khz, const struct ieee80211_reg_rule ** reg_rule)

Arguments

wiphy
the wiphy for which we want to process this rule for
center_freq
Frequency in KHz for which we want regulatory information for
desired_bw_khz
the desired max bandwidth you want to use per channel. Note that this is still 20 MHz if you want to use HT40 as HT40 makes use of two channels for its 40 MHz width bandwidth. If set to 0 we'll assume you want the standard 20 MHz.
reg_rule
the regulatory rule which we have for this frequency

Description

Use this function to get the regulatory rule for a specific frequency on a given wireless device. If the device has a specific regulatory domain it wants to follow we respect that unless a country IE has been received and processed already.

Returns 0 if it was able to find a valid regulatory rule which does apply to the given center_freq otherwise it returns non-zero. It will also return -ERANGE if we determine the given center_freq does not even have a regulatory rule for a frequency range in the center_freq's band. See freq_in_rule_band for our current definition of a band -- this is purely subjective and right now its 802.11 specific.


cfg80211_scan_done - notify that scan finished

void cfg80211_scan_done (struct cfg80211_scan_request * request, bool aborted)

Arguments

request
the corresponding scan request
aborted
set to true if the scan was aborted for any reason, userspace will be notified of that

cfg80211_inform_bss_frame - inform cfg80211 of a new BSS

struct cfg80211_bss* cfg80211_inform_bss_frame (struct wiphy * wiphy, struct ieee80211_channel * channel, struct ieee80211_mgmt * mgmt, size_t len, s32 signal, gfp_t gfp)

Arguments

wiphy
the wiphy reporting the BSS
signal
the signal strength, type depends on the wiphy's signal_type
gfp
context flags

Description

This informs cfg80211 that BSS information was found and the BSS should be updated/added.

cfg80211_unlink_bss - unlink BSS from internal data structures

void cfg80211_unlink_bss (struct wiphy * wiphy, struct cfg80211_bss * bss)

Arguments

wiphy
the wiphy
bss
the bss to remove

Description

This function removes the given BSS from the internal data structures thereby making it no longer show up in scan results etc. Use this function when you detect a BSS is gone. Normally BSSes will also time out, so it is not necessary to use this function at all.

cfg80211_send_rx_auth - notification of processed authentication

void cfg80211_send_rx_auth (struct net_device * dev, const u8 * buf, size_t len)

Arguments

dev
network device
buf
authentication frame (header + body)
len
length of the frame data

Description

This function is called whenever an authentication has been processed in station mode. The driver is required to call either this function or cfg80211_send_auth_timeout to indicate the result of cfg80211_ops::auth call. This function may sleep.

cfg80211_send_auth_timeout - notification of timed out authentication

void cfg80211_send_auth_timeout (struct net_device * dev, const u8 * addr)

Arguments

dev
network device
addr
The MAC address of the device with which the authentication timed out

Description

This function may sleep.

__cfg80211_auth_canceled - notify cfg80211 that authentication was canceled

void __cfg80211_auth_canceled (struct net_device * dev, const u8 * addr)

Arguments

dev
network device
addr
The MAC address of the device with which the authentication timed out

Description

When a pending authentication had no action yet, the driver may decide to not send a deauth frame, but in that case must calls this function to tell cfg80211 about this decision. It is only valid to call this function within the deauth callback.

cfg80211_send_rx_assoc - notification of processed association

void cfg80211_send_rx_assoc (struct net_device * dev, const u8 * buf, size_t len)

Arguments

dev
network device
buf
(re)association response frame (header + body)
len
length of the frame data

Description

This function is called whenever a (re)association response has been processed in station mode. The driver is required to call either this function or cfg80211_send_assoc_timeout to indicate the result of

cfg80211_ops

:assoc call. This function may sleep.

cfg80211_send_assoc_timeout - notification of timed out association

void cfg80211_send_assoc_timeout (struct net_device * dev, const u8 * addr)

Arguments

dev
network device
addr
The MAC address of the device with which the association timed out

Description

This function may sleep.

cfg80211_send_deauth - notification of processed deauthentication

void cfg80211_send_deauth (struct net_device * dev, const u8 * buf, size_t len)

Arguments

dev
network device
buf
deauthentication frame (header + body)
len
length of the frame data

Description

This function is called whenever deauthentication has been processed in station mode. This includes both received deauthentication frames and locally generated ones. This function may sleep.

__cfg80211_send_deauth - notification of processed deauthentication

void __cfg80211_send_deauth (struct net_device * dev, const u8 * buf, size_t len)

Arguments

dev
network device
buf
deauthentication frame (header + body)
len
length of the frame data

Description

Like cfg80211_send_deauth, but doesn't take the wdev lock.

cfg80211_send_disassoc - notification of processed disassociation

void cfg80211_send_disassoc (struct net_device * dev, const u8 * buf, size_t len)

Arguments

dev
network device
buf
disassociation response frame (header + body)
len
length of the frame data

Description

This function is called whenever disassociation has been processed in station mode. This includes both received disassociation frames and locally generated ones. This function may sleep.

__cfg80211_send_disassoc - notification of processed disassociation

void __cfg80211_send_disassoc (struct net_device * dev, const u8 * buf, size_t len)

Arguments

dev
network device
buf
disassociation response frame (header + body)
len
length of the frame data

Description

Like cfg80211_send_disassoc, but doesn't take the wdev lock.

cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)

void cfg80211_michael_mic_failure (struct net_device * dev, const u8 * addr, enum nl80211_key_type key_type, int key_id, const u8 * tsc, gfp_t gfp)

Arguments

dev
network device
addr
The source MAC address of the frame
key_type
The key type that the received frame used
key_id
Key identifier (0..3)
tsc
The TSC value of the frame that generated the MIC failure (6 octets)
gfp
allocation flags

Description

This function is called whenever the local MAC detects a MIC failure in a received frame. This matches with MLME-MICHAELMICFAILURE.indication primitive.

cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS

void cfg80211_ibss_joined (struct net_device * dev, const u8 * bssid, gfp_t gfp)

Arguments

dev
network device
bssid
the BSSID of the IBSS joined
gfp
allocation flags

Description

This function notifies cfg80211 that the device joined an IBSS or switched to a different BSSID. Before this function can be called, either a beacon has to have been received from the IBSS, or one of the cfg80211_inform_bss{,_frame} functions must have been called with the locally generated beacon -- this guarantees that there is always a scan result for this IBSS. cfg80211 will handle the rest.

wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state

void wiphy_rfkill_set_hw_state (struct wiphy * wiphy, bool blocked)

Arguments

wiphy
the wiphy
blocked
block status

wiphy_rfkill_start_polling - start polling rfkill

void wiphy_rfkill_start_polling (struct wiphy * wiphy)

Arguments

wiphy
the wiphy

wiphy_rfkill_stop_polling - stop polling rfkill

void wiphy_rfkill_stop_polling (struct wiphy * wiphy)

Arguments

wiphy
the wiphy

cfg80211_testmode_alloc_reply_skb - allocate testmode reply

struct sk_buff * cfg80211_testmode_alloc_reply_skb (struct wiphy * wiphy, int approxlen)

Arguments

wiphy
the wiphy
approxlen
an upper bound of the length of the data that will be put into the skb

Description

This function allocates and pre-fills an skb for a reply to the testmode command. Since it is intended for a reply, calling it outside of the testmode_cmd operation is invalid.

The returned skb (or NULL if any errors happen) is pre-filled with the wiphy index and set up in a way that any data that is put into the skb (with skb_put, nla_put or similar) will end up being within the NL80211_ATTR_TESTDATA attribute, so all that needs to be done with the skb is adding data for the corresponding userspace tool which can then read that data out of the testdata attribute. You must not modify the skb in any other way.

When done, call cfg80211_testmode_reply with the skb and return its error code as the result of the testmode_cmd operation.


cfg80211_testmode_reply - send the reply skb

int cfg80211_testmode_reply (struct sk_buff * skb)

Arguments

skb
The skb, must have been allocated with cfg80211_testmode_alloc_reply_skb

Description

Returns an error code or 0 on success, since calling this function will usually be the last thing before returning from the testmode_cmd you should return the error code. Note that this function consumes the skb regardless of the return value.

cfg80211_testmode_alloc_event_skb - allocate testmode event

struct sk_buff * cfg80211_testmode_alloc_event_skb (struct wiphy * wiphy, int approxlen, gfp_t gfp)

Arguments

wiphy
the wiphy
approxlen
an upper bound of the length of the data that will be put into the skb
gfp
allocation flags

Description

This function allocates and pre-fills an skb for an event on the testmode multicast group.

The returned skb (or NULL if any errors happen) is set up in the same way as with cfg80211_testmode_alloc_reply_skb but prepared for an event. As there, you should simply add data to it that will then end up in the NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb in any other way.

When done filling the skb, call cfg80211_testmode_event with the skb to send the event.


cfg80211_testmode_event - send the event

void cfg80211_testmode_event (struct sk_buff * skb, gfp_t gfp)

Arguments

skb
The skb, must have been allocated with cfg80211_testmode_alloc_event_skb
gfp
allocation flags

Description

This function sends the given skb, which must have been allocated by cfg80211_testmode_alloc_event_skb, as an event. It always consumes it.

cfg80211_connect_result - notify cfg80211 of connection result

void cfg80211_connect_result (struct net_device * dev, const u8 * bssid, const u8 * req_ie, size_t req_ie_len, const u8 * resp_ie, size_t resp_ie_len, u16 status, gfp_t gfp)

Arguments

dev
network device
bssid
the BSSID of the AP
req_ie
association request IEs (maybe be NULL)
req_ie_len
association request IEs length
resp_ie
association response IEs (may be NULL)
resp_ie_len
assoc response IEs length
status
status code, 0 for successful connection, use WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you the real status code for failures.
gfp
allocation flags

Description

It should be called by the underlying driver whenever connect has succeeded.

cfg80211_roamed - notify cfg80211 of roaming

void cfg80211_roamed (struct net_device * dev, const u8 * bssid, const u8 * req_ie, size_t req_ie_len, const u8 * resp_ie, size_t resp_ie_len, gfp_t gfp)

Arguments

dev
network device
bssid
the BSSID of the new AP
req_ie
association request IEs (maybe be NULL)
req_ie_len
association request IEs length
resp_ie
association response IEs (may be NULL)
resp_ie_len
assoc response IEs length
gfp
allocation flags

Description

It should be called by the underlying driver whenever it roamed from one AP to another while connected.

cfg80211_disconnected - notify cfg80211 that connection was dropped

void cfg80211_disconnected (struct net_device * dev, u16 reason, u8 * ie, size_t ie_len, gfp_t gfp)

Arguments

dev
network device
reason
reason code for the disconnection, set it to 0 if unknown
ie
information elements of the deauth/disassoc frame (may be NULL)
ie_len
length of IEs
gfp
allocation flags

Description

After it calls this function, the driver should enter an idle state and not try to connect to any AP any more.

cfg80211_ready_on_channel - notification of remain_on_channel start

void cfg80211_ready_on_channel (struct net_device * dev, u64 cookie, struct ieee80211_channel * chan, enum nl80211_channel_type channel_type, unsigned int duration, gfp_t gfp)

Arguments

dev
network device
cookie
the request cookie
chan
The current channel (from remain_on_channel request)
channel_type
Channel type
duration
Duration in milliseconds that the driver intents to remain on the channel
gfp
allocation flags

cfg80211_remain_on_channel_expired - remain_on_channel duration expired

void cfg80211_remain_on_channel_expired (struct net_device * dev, u64 cookie, struct ieee80211_channel * chan, enum nl80211_channel_type channel_type, gfp_t gfp)

Arguments

dev
network device
cookie
the request cookie
chan
The current channel (from remain_on_channel request)
channel_type
Channel type
gfp
allocation flags

cfg80211_new_sta - notify userspace about station

void cfg80211_new_sta (struct net_device * dev, const u8 * mac_addr, struct station_info * sinfo, gfp_t gfp)

Arguments

dev
the netdev
mac_addr
the station's address
sinfo
the station information
gfp
allocation flags

cfg80211_rx_action - notification of received, unprocessed Action frame

bool cfg80211_rx_action (struct net_device * dev, int freq, const u8 * buf, size_t len, gfp_t gfp)

Arguments

dev
network device
freq
Frequency on which the frame was received in MHz
buf
Action frame (header + body)
len
length of the frame data
gfp
context flags Returns true if a user space application is responsible for rejecting the unrecognized Action frame; false if no such application is registered (i.e., the driver is responsible for rejecting the unrecognized Action frame)

Description

This function is called whenever an Action frame is received for a station mode interface, but is not processed in kernel.

cfg80211_action_tx_status - notification of TX status for Action frame

void cfg80211_action_tx_status (struct net_device * dev, u64 cookie, const u8 * buf, size_t len, bool ack, gfp_t gfp)

Arguments

dev
network device
cookie
Cookie returned by cfg80211_ops::action
buf
Action frame (header + body)
len
length of the frame data
ack
Whether frame was acknowledged
gfp
context flags

Description

This function is called whenever an Action frame was requested to be

transmitted with cfg80211_ops

:action to report the TX status of the transmission attempt.