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