git.maemo.org Git - wpasupplicant/blob - hostapd/driver.h

   1 /*
   2  * hostapd - driver interface definition
   3  * Copyright (c) 2002-2009, Jouni Malinen <j@w1.fi>
   4  * Copyright (c) 2007-2008, Intel Corporation
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 as
   8  * published by the Free Software Foundation.
   9  *
  10  * Alternatively, this software may be distributed under the terms of BSD
  11  * license.
  12  *
  13  * See README and COPYING for more details.
  14  */
  15
  16 #ifndef DRIVER_H
  17 #define DRIVER_H
  18
  19 struct hostapd_data;
  20
  21 struct hostap_sta_driver_data {
  22         unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
  23         unsigned long current_tx_rate;
  24         unsigned long inactive_msec;
  25         unsigned long flags;
  26         unsigned long num_ps_buf_frames;
  27         unsigned long tx_retry_failed;
  28         unsigned long tx_retry_count;
  29         int last_rssi;
  30         int last_ack_rssi;
  31 };
  32
  33 struct hostapd_sta_add_params {
  34         const u8 *addr;
  35         u16 aid;
  36         u16 capability;
  37         const u8 *supp_rates;
  38         size_t supp_rates_len;
  39         int flags;
  40         u16 listen_interval;
  41         const struct ht_cap_ie *ht_capabilities;
  42 };
  43
  44 struct hostapd_freq_params {
  45         int mode;
  46         int freq;
  47         int ht_enabled;
  48         int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
  49                                  * secondary channel below primary, 1 = HT40
  50                                  * enabled, secondary channel above primary */
  51 };
  52
  53 enum hostapd_driver_if_type {
  54         HOSTAPD_IF_VLAN, HOSTAPD_IF_WDS
  55 };
  56
  57 struct hostapd_neighbor_bss {
  58         u8 bssid[ETH_ALEN];
  59         int freq; /* MHz */
  60         unsigned int ht:1;
  61         int pri_chan;
  62         int sec_chan; /* 0 for 20 MHz channels */
  63 };
  64
  65 struct wpa_driver_ops {
  66         const char *name;               /* as appears in the config file */
  67
  68         void * (*init)(struct hostapd_data *hapd);
  69         void * (*init_bssid)(struct hostapd_data *hapd, const u8 *bssid);
  70         void (*deinit)(void *priv);
  71
  72         int (*wireless_event_init)(void *priv);
  73         void (*wireless_event_deinit)(void *priv);
  74
  75         /**
  76          * set_8021x - enable/disable IEEE 802.1X support
  77          * @ifname: Interface name (for multi-SSID/VLAN support)
  78          * @priv: driver private data
  79          * @enabled: 1 = enable, 0 = disable
  80          *
  81          * Returns: 0 on success, -1 on failure
  82          *
  83          * Configure the kernel driver to enable/disable 802.1X support.
  84          * This may be an empty function if 802.1X support is always enabled.
  85          */
  86         int (*set_ieee8021x)(const char *ifname, void *priv, int enabled);
  87
  88         /**
  89          * set_privacy - enable/disable privacy
  90          * @priv: driver private data
  91          * @enabled: 1 = privacy enabled, 0 = disabled
  92          *
  93          * Return: 0 on success, -1 on failure
  94          *
  95          * Configure privacy.
  96          */
  97         int (*set_privacy)(const char *ifname, void *priv, int enabled);
  98
  99         int (*set_encryption)(const char *ifname, void *priv, const char *alg,
 100                               const u8 *addr, int idx,
 101                               const u8 *key, size_t key_len, int txkey);
 102         int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
 103                           int idx, u8 *seq);
 104         int (*get_seqnum_igtk)(const char *ifname, void *priv, const u8 *addr,
 105                                int idx, u8 *seq);
 106         int (*flush)(void *priv);
 107         int (*set_generic_elem)(const char *ifname, void *priv, const u8 *elem,
 108                                 size_t elem_len);
 109
 110         int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
 111                              const u8 *addr);
 112         int (*send_eapol)(void *priv, const u8 *addr, const u8 *data,
 113                           size_t data_len, int encrypt, const u8 *own_addr);
 114         int (*sta_deauth)(void *priv, const u8 *addr, int reason);
 115         int (*sta_disassoc)(void *priv, const u8 *addr, int reason);
 116         int (*sta_remove)(void *priv, const u8 *addr);
 117         int (*get_ssid)(const char *ifname, void *priv, u8 *buf, int len);
 118         int (*set_ssid)(const char *ifname, void *priv, const u8 *buf,
 119                         int len);
 120         int (*set_countermeasures)(void *priv, int enabled);
 121         int (*send_mgmt_frame)(void *priv, const void *msg, size_t len,
 122                                int flags);
 123         int (*set_assoc_ap)(void *priv, const u8 *addr);
 124         /* note: sta_add() is deprecated; use sta_add2() instead */
 125         int (*sta_add)(const char *ifname, void *priv, const u8 *addr, u16 aid,
 126                        u16 capability, u8 *supp_rates, size_t supp_rates_len,
 127                        int flags, u16 listen_interval);
 128         int (*sta_add2)(const char *ifname, void *priv,
 129                         struct hostapd_sta_add_params *params);
 130         int (*get_inact_sec)(void *priv, const u8 *addr);
 131         int (*sta_clear_stats)(void *priv, const u8 *addr);
 132
 133         /* note: set_freq() is deprecated; use set_freq2() instead */
 134         int (*set_freq)(void *priv, int mode, int freq);
 135         int (*set_freq2)(void *priv, struct hostapd_freq_params *freq);
 136         int (*set_rts)(void *priv, int rts);
 137         int (*get_rts)(void *priv, int *rts);
 138         int (*set_frag)(void *priv, int frag);
 139         int (*get_frag)(void *priv, int *frag);
 140         int (*set_retry)(void *priv, int short_retry, int long_retry);
 141         int (*get_retry)(void *priv, int *short_retry, int *long_retry);
 142
 143         int (*sta_set_flags)(void *priv, const u8 *addr,
 144                              int total_flags, int flags_or, int flags_and);
 145         int (*set_rate_sets)(void *priv, int *supp_rates, int *basic_rates,
 146                              int mode);
 147         int (*set_country)(void *priv, const char *country);
 148         int (*set_ieee80211d)(void *priv, int enabled);
 149         int (*set_beacon)(const char *ifname, void *priv,
 150                           u8 *head, size_t head_len,
 151                           u8 *tail, size_t tail_len);
 152
 153         /* Configure internal bridge:
 154          * 0 = disabled, i.e., client separation is enabled (no bridging of
 155          *     packets between associated STAs
 156          * 1 = enabled, i.e., bridge packets between associated STAs (default)
 157          */
 158         int (*set_internal_bridge)(void *priv, int value);
 159         int (*set_beacon_int)(void *priv, int value);
 160         int (*set_dtim_period)(const char *ifname, void *priv, int value);
 161         /* Configure broadcast SSID mode:
 162          * 0 = include SSID in Beacon frames and reply to Probe Request frames
 163          *     that use broadcast SSID
 164          * 1 = hide SSID from Beacon frames and ignore Probe Request frames for
 165          *     broadcast SSID
 166          */
 167         int (*set_broadcast_ssid)(void *priv, int value);
 168         int (*set_cts_protect)(void *priv, int value);
 169         int (*set_key_tx_rx_threshold)(void *priv, int value);
 170         int (*set_preamble)(void *priv, int value);
 171         int (*set_short_slot_time)(void *priv, int value);
 172         int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
 173                                    int cw_max, int burst_time);
 174         int (*bss_add)(void *priv, const char *ifname, const u8 *bssid);
 175         int (*bss_remove)(void *priv, const char *ifname);
 176         int (*valid_bss_mask)(void *priv, const u8 *addr, const u8 *mask);
 177         int (*passive_scan)(void *priv, int now, int our_mode_only,
 178                             int interval, int _listen, int *channel,
 179                             int *last_rx);
 180         struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
 181                                                          u16 *num_modes,
 182                                                          u16 *flags);
 183         int (*if_add)(const char *iface, void *priv,
 184                       enum hostapd_driver_if_type type, char *ifname,
 185                       const u8 *addr);
 186         int (*if_update)(void *priv, enum hostapd_driver_if_type type,
 187                          char *ifname, const u8 *addr);
 188         int (*if_remove)(void *priv, enum hostapd_driver_if_type type,
 189                          const char *ifname, const u8 *addr);
 190         int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
 191                             int vlan_id);
 192         /**
 193          * commit - Optional commit changes handler
 194          * @priv: driver private data
 195          * Returns: 0 on success, -1 on failure
 196          *
 197          * This optional handler function can be registered if the driver
 198          * interface implementation needs to commit changes (e.g., by setting
 199          * network interface up) at the end of initial configuration. If set,
 200          * this handler will be called after initial setup has been completed.
 201          */
 202         int (*commit)(void *priv);
 203
 204         int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
 205                           const u8 *data, size_t data_len);
 206
 207         int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
 208                                    u32 session_timeout);
 209         int (*set_radius_acl_expire)(void *priv, const u8 *mac);
 210
 211         int (*set_ht_params)(const char *ifname, void *priv,
 212                              const u8 *ht_capab, size_t ht_capab_len,
 213                              const u8 *ht_oper, size_t ht_oper_len);
 214
 215         int (*set_wps_beacon_ie)(const char *ifname, void *priv,
 216                                  const u8 *ie, size_t len);
 217         int (*set_wps_probe_resp_ie)(const char *ifname, void *priv,
 218                                      const u8 *ie, size_t len);
 219
 220         const struct hostapd_neighbor_bss *
 221         (*get_neighbor_bss)(void *priv, size_t *num);
 222 };
 223
 224 void hostapd_new_assoc_sta(struct hostapd_data *hapd, struct sta_info *sta,
 225                            int reassoc);
 226 void hostapd_tx_status(struct hostapd_data *hapd, const u8 *addr,
 227                        const u8 *buf, size_t len, int ack);
 228 void hostapd_rx_from_unknown_sta(struct hostapd_data *hapd, const u8 *addr);
 229 int hostapd_notif_assoc(struct hostapd_data *hapd, const u8 *addr,
 230                         const u8 *ie, size_t ielen);
 231 void hostapd_notif_disassoc(struct hostapd_data *hapd, const u8 *addr);
 232 void hostapd_eapol_receive(struct hostapd_data *hapd, const u8 *sa,
 233                            const u8 *buf, size_t len);
 234
 235 struct hostapd_frame_info {
 236         u32 phytype;
 237         u32 channel;
 238         u32 datarate;
 239         u32 ssi_signal;
 240
 241         unsigned int passive_scan:1;
 242 };
 243
 244 void hostapd_mgmt_rx(struct hostapd_data *hapd, u8 *buf, size_t len,
 245                      u16 stype, struct hostapd_frame_info *fi);
 246 void hostapd_mgmt_tx_cb(struct hostapd_data *hapd, u8 *buf, size_t len,
 247                         u16 stype, int ok);
 248 void hostapd_michael_mic_failure(struct hostapd_data *hapd, const u8 *addr);
 249
 250 #endif /* DRIVER_H */