Split hostapd/driver.h into two files
[wpasupplicant] / 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_sta_add_params {
20         const u8 *addr;
21         u16 aid;
22         u16 capability;
23         const u8 *supp_rates;
24         size_t supp_rates_len;
25         int flags;
26         u16 listen_interval;
27         const struct ht_cap_ie *ht_capabilities;
28 };
29
30 struct hostapd_freq_params {
31         int mode;
32         int freq;
33         int ht_enabled;
34         int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
35                                  * secondary channel below primary, 1 = HT40
36                                  * enabled, secondary channel above primary */
37 };
38
39 enum hostapd_driver_if_type {
40         HOSTAPD_IF_VLAN, HOSTAPD_IF_WDS
41 };
42
43 struct wpa_driver_ops {
44         const char *name;               /* as appears in the config file */
45
46         void * (*init)(struct hostapd_data *hapd);
47         void * (*init_bssid)(struct hostapd_data *hapd, const u8 *bssid);
48         void (*deinit)(void *priv);
49
50         int (*wireless_event_init)(void *priv);
51         void (*wireless_event_deinit)(void *priv);
52
53         /**
54          * set_8021x - enable/disable IEEE 802.1X support
55          * @ifname: Interface name (for multi-SSID/VLAN support)
56          * @priv: driver private data
57          * @enabled: 1 = enable, 0 = disable
58          *
59          * Returns: 0 on success, -1 on failure
60          *
61          * Configure the kernel driver to enable/disable 802.1X support.
62          * This may be an empty function if 802.1X support is always enabled.
63          */
64         int (*set_ieee8021x)(const char *ifname, void *priv, int enabled);
65
66         /**
67          * set_privacy - enable/disable privacy
68          * @priv: driver private data
69          * @enabled: 1 = privacy enabled, 0 = disabled
70          *
71          * Return: 0 on success, -1 on failure
72          *
73          * Configure privacy.
74          */
75         int (*set_privacy)(const char *ifname, void *priv, int enabled);
76
77         int (*set_encryption)(const char *ifname, void *priv, const char *alg,
78                               const u8 *addr, int idx,
79                               const u8 *key, size_t key_len, int txkey);
80         int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
81                           int idx, u8 *seq);
82         int (*get_seqnum_igtk)(const char *ifname, void *priv, const u8 *addr,
83                                int idx, u8 *seq);
84         int (*flush)(void *priv);
85         int (*set_generic_elem)(const char *ifname, void *priv, const u8 *elem,
86                                 size_t elem_len);
87
88         int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
89                              const u8 *addr);
90         int (*send_eapol)(void *priv, const u8 *addr, const u8 *data,
91                           size_t data_len, int encrypt, const u8 *own_addr);
92         int (*sta_deauth)(void *priv, const u8 *addr, int reason);
93         int (*sta_disassoc)(void *priv, const u8 *addr, int reason);
94         int (*sta_remove)(void *priv, const u8 *addr);
95         int (*get_ssid)(const char *ifname, void *priv, u8 *buf, int len);
96         int (*set_ssid)(const char *ifname, void *priv, const u8 *buf,
97                         int len);
98         int (*set_countermeasures)(void *priv, int enabled);
99         int (*send_mgmt_frame)(void *priv, const void *msg, size_t len,
100                                int flags);
101         int (*set_assoc_ap)(void *priv, const u8 *addr);
102         /* note: sta_add() is deprecated; use sta_add2() instead */
103         int (*sta_add)(const char *ifname, void *priv, const u8 *addr, u16 aid,
104                        u16 capability, u8 *supp_rates, size_t supp_rates_len,
105                        int flags, u16 listen_interval);
106         int (*sta_add2)(const char *ifname, void *priv,
107                         struct hostapd_sta_add_params *params);
108         int (*get_inact_sec)(void *priv, const u8 *addr);
109         int (*sta_clear_stats)(void *priv, const u8 *addr);
110
111         /* note: set_freq() is deprecated; use sta_freq() instead */
112         int (*set_freq)(void *priv, int mode, int freq);
113         int (*set_freq2)(void *priv, struct hostapd_freq_params *freq);
114         int (*set_rts)(void *priv, int rts);
115         int (*get_rts)(void *priv, int *rts);
116         int (*set_frag)(void *priv, int frag);
117         int (*get_frag)(void *priv, int *frag);
118         int (*set_retry)(void *priv, int short_retry, int long_retry);
119         int (*get_retry)(void *priv, int *short_retry, int *long_retry);
120
121         int (*sta_set_flags)(void *priv, const u8 *addr,
122                              int total_flags, int flags_or, int flags_and);
123         int (*set_rate_sets)(void *priv, int *supp_rates, int *basic_rates,
124                              int mode);
125         int (*set_regulatory_domain)(void *priv, unsigned int rd);
126         int (*set_country)(void *priv, const char *country);
127         int (*set_ieee80211d)(void *priv, int enabled);
128         int (*set_beacon)(const char *ifname, void *priv,
129                           u8 *head, size_t head_len,
130                           u8 *tail, size_t tail_len);
131
132         /* Configure internal bridge:
133          * 0 = disabled, i.e., client separation is enabled (no bridging of
134          *     packets between associated STAs
135          * 1 = enabled, i.e., bridge packets between associated STAs (default)
136          */
137         int (*set_internal_bridge)(void *priv, int value);
138         int (*set_beacon_int)(void *priv, int value);
139         int (*set_dtim_period)(const char *ifname, void *priv, int value);
140         /* Configure broadcast SSID mode:
141          * 0 = include SSID in Beacon frames and reply to Probe Request frames
142          *     that use broadcast SSID
143          * 1 = hide SSID from Beacon frames and ignore Probe Request frames for
144          *     broadcast SSID
145          */
146         int (*set_broadcast_ssid)(void *priv, int value);
147         int (*set_cts_protect)(void *priv, int value);
148         int (*set_key_tx_rx_threshold)(void *priv, int value);
149         int (*set_preamble)(void *priv, int value);
150         int (*set_short_slot_time)(void *priv, int value);
151         int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
152                                    int cw_max, int burst_time);
153         int (*bss_add)(void *priv, const char *ifname, const u8 *bssid);
154         int (*bss_remove)(void *priv, const char *ifname);
155         int (*valid_bss_mask)(void *priv, const u8 *addr, const u8 *mask);
156         int (*passive_scan)(void *priv, int now, int our_mode_only,
157                             int interval, int _listen, int *channel,
158                             int *last_rx);
159         struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
160                                                          u16 *num_modes,
161                                                          u16 *flags);
162         int (*if_add)(const char *iface, void *priv,
163                       enum hostapd_driver_if_type type, char *ifname,
164                       const u8 *addr);
165         int (*if_update)(void *priv, enum hostapd_driver_if_type type,
166                          char *ifname, const u8 *addr);
167         int (*if_remove)(void *priv, enum hostapd_driver_if_type type,
168                          const char *ifname, const u8 *addr);
169         int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
170                             int vlan_id);
171         /**
172          * commit - Optional commit changes handler
173          * @priv: driver private data
174          * Returns: 0 on success, -1 on failure
175          *
176          * This optional handler function can be registered if the driver
177          * interface implementation needs to commit changes (e.g., by setting
178          * network interface up) at the end of initial configuration. If set,
179          * this handler will be called after initial setup has been completed.
180          */
181         int (*commit)(void *priv);
182
183         int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
184                           const u8 *data, size_t data_len);
185
186         int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted, 
187                                    u32 session_timeout);
188         int (*set_radius_acl_expire)(void *priv, const u8 *mac);
189
190         int (*set_ht_params)(const char *ifname, void *priv,
191                              const u8 *ht_capab, size_t ht_capab_len,
192                              const u8 *ht_oper, size_t ht_oper_len);
193
194         int (*set_wps_beacon_ie)(const char *ifname, void *priv,
195                                  const u8 *ie, size_t len);
196         int (*set_wps_probe_resp_ie)(const char *ifname, void *priv,
197                                      const u8 *ie, size_t len);
198 };
199
200 #endif /* DRIVER_H */