blob: 1d19fc550df651e9a0c461a791cb47a9eacc7090 [file] [log] [blame]
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001/*
2 * wpa_supplicant/hostapd control interface library
3 * Copyright (c) 2004-2006, Jouni Malinen <j@w1.fi>
4 *
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07007 */
8
9#ifndef WPA_CTRL_H
10#define WPA_CTRL_H
11
12#ifdef __cplusplus
13extern "C" {
14#endif
15
16/* wpa_supplicant control interface - fixed message prefixes */
17
18/** Interactive request for identity/password/pin */
19#define WPA_CTRL_REQ "CTRL-REQ-"
20
21/** Response to identity/password/pin request */
22#define WPA_CTRL_RSP "CTRL-RSP-"
23
24/* Event messages with fixed prefix */
25/** Authentication completed successfully and data connection enabled */
26#define WPA_EVENT_CONNECTED "CTRL-EVENT-CONNECTED "
27/** Disconnected, data connection is not available */
28#define WPA_EVENT_DISCONNECTED "CTRL-EVENT-DISCONNECTED "
29/** Association rejected during connection attempt */
30#define WPA_EVENT_ASSOC_REJECT "CTRL-EVENT-ASSOC-REJECT "
31/** wpa_supplicant is exiting */
32#define WPA_EVENT_TERMINATING "CTRL-EVENT-TERMINATING "
33/** Password change was completed successfully */
34#define WPA_EVENT_PASSWORD_CHANGED "CTRL-EVENT-PASSWORD-CHANGED "
35/** EAP-Request/Notification received */
36#define WPA_EVENT_EAP_NOTIFICATION "CTRL-EVENT-EAP-NOTIFICATION "
37/** EAP authentication started (EAP-Request/Identity received) */
38#define WPA_EVENT_EAP_STARTED "CTRL-EVENT-EAP-STARTED "
39/** EAP method proposed by the server */
40#define WPA_EVENT_EAP_PROPOSED_METHOD "CTRL-EVENT-EAP-PROPOSED-METHOD "
41/** EAP method selected */
42#define WPA_EVENT_EAP_METHOD "CTRL-EVENT-EAP-METHOD "
43/** EAP peer certificate from TLS */
44#define WPA_EVENT_EAP_PEER_CERT "CTRL-EVENT-EAP-PEER-CERT "
Dmitry Shmidt2f74e362015-01-21 13:19:05 -080045/** EAP peer certificate alternative subject name component from TLS */
46#define WPA_EVENT_EAP_PEER_ALT "CTRL-EVENT-EAP-PEER-ALT "
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070047/** EAP TLS certificate chain validation error */
48#define WPA_EVENT_EAP_TLS_CERT_ERROR "CTRL-EVENT-EAP-TLS-CERT-ERROR "
Dmitry Shmidt8da800a2013-04-24 12:57:01 -070049/** EAP status */
50#define WPA_EVENT_EAP_STATUS "CTRL-EVENT-EAP-STATUS "
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070051/** EAP authentication completed successfully */
52#define WPA_EVENT_EAP_SUCCESS "CTRL-EVENT-EAP-SUCCESS "
53/** EAP authentication failed (EAP-Failure received) */
54#define WPA_EVENT_EAP_FAILURE "CTRL-EVENT-EAP-FAILURE "
Dmitry Shmidt61d9df32012-08-29 16:22:06 -070055/** Network block temporarily disabled (e.g., due to authentication failure) */
56#define WPA_EVENT_TEMP_DISABLED "CTRL-EVENT-SSID-TEMP-DISABLED "
57/** Temporarily disabled network block re-enabled */
58#define WPA_EVENT_REENABLED "CTRL-EVENT-SSID-REENABLED "
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -080059/** New scan started */
60#define WPA_EVENT_SCAN_STARTED "CTRL-EVENT-SCAN-STARTED "
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070061/** New scan results available */
62#define WPA_EVENT_SCAN_RESULTS "CTRL-EVENT-SCAN-RESULTS "
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080063/** Scan command failed */
64#define WPA_EVENT_SCAN_FAILED "CTRL-EVENT-SCAN-FAILED "
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070065/** wpa_supplicant state change */
66#define WPA_EVENT_STATE_CHANGE "CTRL-EVENT-STATE-CHANGE "
67/** A new BSS entry was added (followed by BSS entry id and BSSID) */
68#define WPA_EVENT_BSS_ADDED "CTRL-EVENT-BSS-ADDED "
69/** A BSS entry was removed (followed by BSS entry id and BSSID) */
70#define WPA_EVENT_BSS_REMOVED "CTRL-EVENT-BSS-REMOVED "
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -070071/** Change in the signal level was reported by the driver */
72#define WPA_EVENT_SIGNAL_CHANGE "CTRL-EVENT-SIGNAL-CHANGE "
73/** Regulatory domain channel */
74#define WPA_EVENT_REGDOM_CHANGE "CTRL-EVENT-REGDOM-CHANGE "
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070075
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -070076/** RSN IBSS 4-way handshakes completed with specified peer */
77#define IBSS_RSN_COMPLETED "IBSS-RSN-COMPLETED "
78
Dmitry Shmidt04f534e2013-12-09 15:50:16 -080079/** Notification of frequency conflict due to a concurrent operation.
80 *
81 * The indicated network is disabled and needs to be re-enabled before it can
82 * be used again.
83 */
84#define WPA_EVENT_FREQ_CONFLICT "CTRL-EVENT-FREQ-CONFLICT "
Dmitry Shmidtcf32e602014-01-28 10:57:39 -080085/** Frequency ranges that the driver recommends to avoid */
86#define WPA_EVENT_AVOID_FREQ "CTRL-EVENT-AVOID-FREQ "
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070087/** WPS overlap detected in PBC mode */
88#define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED "
89/** Available WPS AP with active PBC found in scan results */
90#define WPS_EVENT_AP_AVAILABLE_PBC "WPS-AP-AVAILABLE-PBC "
91/** Available WPS AP with our address as authorized in scan results */
92#define WPS_EVENT_AP_AVAILABLE_AUTH "WPS-AP-AVAILABLE-AUTH "
93/** Available WPS AP with recently selected PIN registrar found in scan results
94 */
95#define WPS_EVENT_AP_AVAILABLE_PIN "WPS-AP-AVAILABLE-PIN "
96/** Available WPS AP found in scan results */
97#define WPS_EVENT_AP_AVAILABLE "WPS-AP-AVAILABLE "
98/** A new credential received */
99#define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED "
100/** M2D received */
101#define WPS_EVENT_M2D "WPS-M2D "
102/** WPS registration failed after M2/M2D */
103#define WPS_EVENT_FAIL "WPS-FAIL "
104/** WPS registration completed successfully */
105#define WPS_EVENT_SUCCESS "WPS-SUCCESS "
106/** WPS enrollment attempt timed out and was terminated */
107#define WPS_EVENT_TIMEOUT "WPS-TIMEOUT "
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -0700108/* PBC mode was activated */
109#define WPS_EVENT_ACTIVE "WPS-PBC-ACTIVE "
110/* PBC mode was disabled */
111#define WPS_EVENT_DISABLE "WPS-PBC-DISABLE "
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700112
113#define WPS_EVENT_ENROLLEE_SEEN "WPS-ENROLLEE-SEEN "
114
115#define WPS_EVENT_OPEN_NETWORK "WPS-OPEN-NETWORK "
116
117/* WPS ER events */
118#define WPS_EVENT_ER_AP_ADD "WPS-ER-AP-ADD "
119#define WPS_EVENT_ER_AP_REMOVE "WPS-ER-AP-REMOVE "
120#define WPS_EVENT_ER_ENROLLEE_ADD "WPS-ER-ENROLLEE-ADD "
121#define WPS_EVENT_ER_ENROLLEE_REMOVE "WPS-ER-ENROLLEE-REMOVE "
122#define WPS_EVENT_ER_AP_SETTINGS "WPS-ER-AP-SETTINGS "
123#define WPS_EVENT_ER_SET_SEL_REG "WPS-ER-AP-SET-SEL-REG "
124
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800125/* MESH events */
126#define MESH_GROUP_STARTED "MESH-GROUP-STARTED "
127#define MESH_GROUP_REMOVED "MESH-GROUP-REMOVED "
128#define MESH_PEER_CONNECTED "MESH-PEER-CONNECTED "
129#define MESH_PEER_DISCONNECTED "MESH-PEER-DISCONNECTED "
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800130/** Mesh SAE authentication failure. Wrong password suspected. */
131#define MESH_SAE_AUTH_FAILURE "MESH-SAE-AUTH-FAILURE "
132#define MESH_SAE_AUTH_BLOCKED "MESH-SAE-AUTH-BLOCKED "
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800133
134/* WMM AC events */
135#define WMM_AC_EVENT_TSPEC_ADDED "TSPEC-ADDED "
136#define WMM_AC_EVENT_TSPEC_REMOVED "TSPEC-REMOVED "
137#define WMM_AC_EVENT_TSPEC_REQ_FAILED "TSPEC-REQ-FAILED "
138
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700139/** P2P device found */
140#define P2P_EVENT_DEVICE_FOUND "P2P-DEVICE-FOUND "
Dmitry Shmidt497c1d52011-07-21 15:19:46 -0700141
Dmitry Shmidt497c1d52011-07-21 15:19:46 -0700142/** P2P device lost */
143#define P2P_EVENT_DEVICE_LOST "P2P-DEVICE-LOST "
Dmitry Shmidt497c1d52011-07-21 15:19:46 -0700144
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700145/** A P2P device requested GO negotiation, but we were not ready to start the
146 * negotiation */
147#define P2P_EVENT_GO_NEG_REQUEST "P2P-GO-NEG-REQUEST "
148#define P2P_EVENT_GO_NEG_SUCCESS "P2P-GO-NEG-SUCCESS "
149#define P2P_EVENT_GO_NEG_FAILURE "P2P-GO-NEG-FAILURE "
150#define P2P_EVENT_GROUP_FORMATION_SUCCESS "P2P-GROUP-FORMATION-SUCCESS "
151#define P2P_EVENT_GROUP_FORMATION_FAILURE "P2P-GROUP-FORMATION-FAILURE "
152#define P2P_EVENT_GROUP_STARTED "P2P-GROUP-STARTED "
153#define P2P_EVENT_GROUP_REMOVED "P2P-GROUP-REMOVED "
154#define P2P_EVENT_CROSS_CONNECT_ENABLE "P2P-CROSS-CONNECT-ENABLE "
155#define P2P_EVENT_CROSS_CONNECT_DISABLE "P2P-CROSS-CONNECT-DISABLE "
156/* parameters: <peer address> <PIN> */
157#define P2P_EVENT_PROV_DISC_SHOW_PIN "P2P-PROV-DISC-SHOW-PIN "
158/* parameters: <peer address> */
159#define P2P_EVENT_PROV_DISC_ENTER_PIN "P2P-PROV-DISC-ENTER-PIN "
160/* parameters: <peer address> */
161#define P2P_EVENT_PROV_DISC_PBC_REQ "P2P-PROV-DISC-PBC-REQ "
162/* parameters: <peer address> */
163#define P2P_EVENT_PROV_DISC_PBC_RESP "P2P-PROV-DISC-PBC-RESP "
Dmitry Shmidt04949592012-07-19 12:16:46 -0700164/* parameters: <peer address> <status> */
165#define P2P_EVENT_PROV_DISC_FAILURE "P2P-PROV-DISC-FAILURE"
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700166/* parameters: <freq> <src addr> <dialog token> <update indicator> <TLVs> */
167#define P2P_EVENT_SERV_DISC_REQ "P2P-SERV-DISC-REQ "
168/* parameters: <src addr> <update indicator> <TLVs> */
169#define P2P_EVENT_SERV_DISC_RESP "P2P-SERV-DISC-RESP "
Dmitry Shmidt216983b2015-02-06 10:50:36 -0800170#define P2P_EVENT_SERV_ASP_RESP "P2P-SERV-ASP-RESP "
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700171#define P2P_EVENT_INVITATION_RECEIVED "P2P-INVITATION-RECEIVED "
172#define P2P_EVENT_INVITATION_RESULT "P2P-INVITATION-RESULT "
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800173#define P2P_EVENT_FIND_STOPPED "P2P-FIND-STOPPED "
Dmitry Shmidt391c59f2013-09-03 12:16:28 -0700174#define P2P_EVENT_PERSISTENT_PSK_FAIL "P2P-PERSISTENT-PSK-FAIL id="
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800175#define P2P_EVENT_PRESENCE_RESPONSE "P2P-PRESENCE-RESPONSE "
Dmitry Shmidtcf32e602014-01-28 10:57:39 -0800176#define P2P_EVENT_NFC_BOTH_GO "P2P-NFC-BOTH-GO "
177#define P2P_EVENT_NFC_PEER_CLIENT "P2P-NFC-PEER-CLIENT "
178#define P2P_EVENT_NFC_WHILE_CLIENT "P2P-NFC-WHILE-CLIENT "
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800179#define P2P_EVENT_FALLBACK_TO_GO_NEG "P2P-FALLBACK-TO-GO-NEG "
180#define P2P_EVENT_FALLBACK_TO_GO_NEG_ENABLED "P2P-FALLBACK-TO-GO-NEG-ENABLED "
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800181
Dmitry Shmidtf7e0a992013-05-23 11:03:10 -0700182/* parameters: <PMF enabled> <timeout in ms> <Session Information URL> */
183#define ESS_DISASSOC_IMMINENT "ESS-DISASSOC-IMMINENT "
Dmitry Shmidtcf32e602014-01-28 10:57:39 -0800184#define P2P_EVENT_REMOVE_AND_REFORM_GROUP "P2P-REMOVE-AND-REFORM-GROUP "
Dmitry Shmidtf7e0a992013-05-23 11:03:10 -0700185
Dmitry Shmidt216983b2015-02-06 10:50:36 -0800186#define P2P_EVENT_P2PS_PROVISION_START "P2PS-PROV-START "
187#define P2P_EVENT_P2PS_PROVISION_DONE "P2PS-PROV-DONE "
188
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800189#define INTERWORKING_AP "INTERWORKING-AP "
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800190#define INTERWORKING_BLACKLISTED "INTERWORKING-BLACKLISTED "
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800191#define INTERWORKING_NO_MATCH "INTERWORKING-NO-MATCH "
Dmitry Shmidt54605472013-11-08 11:10:19 -0800192#define INTERWORKING_ALREADY_CONNECTED "INTERWORKING-ALREADY-CONNECTED "
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800193#define INTERWORKING_SELECTED "INTERWORKING-SELECTED "
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700194
Dmitry Shmidt0cfd5f72014-04-04 14:48:05 -0700195/* Credential block added; parameters: <id> */
196#define CRED_ADDED "CRED-ADDED "
197/* Credential block modified; parameters: <id> <field> */
198#define CRED_MODIFIED "CRED-MODIFIED "
199/* Credential block removed; parameters: <id> */
200#define CRED_REMOVED "CRED-REMOVED "
201
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700202#define GAS_RESPONSE_INFO "GAS-RESPONSE-INFO "
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800203/* parameters: <addr> <dialog_token> <freq> */
204#define GAS_QUERY_START "GAS-QUERY-START "
205/* parameters: <addr> <dialog_token> <freq> <status_code> <result> */
206#define GAS_QUERY_DONE "GAS-QUERY-DONE "
207
Dmitry Shmidt2f74e362015-01-21 13:19:05 -0800208/* parameters: <addr> <result> */
209#define ANQP_QUERY_DONE "ANQP-QUERY-DONE "
210
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800211#define HS20_SUBSCRIPTION_REMEDIATION "HS20-SUBSCRIPTION-REMEDIATION "
212#define HS20_DEAUTH_IMMINENT_NOTICE "HS20-DEAUTH-IMMINENT-NOTICE "
213
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800214#define EXT_RADIO_WORK_START "EXT-RADIO-WORK-START "
215#define EXT_RADIO_WORK_TIMEOUT "EXT-RADIO-WORK-TIMEOUT "
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700216
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800217#define RRM_EVENT_NEIGHBOR_REP_RXED "RRM-NEIGHBOR-REP-RECEIVED "
218#define RRM_EVENT_NEIGHBOR_REP_FAILED "RRM-NEIGHBOR-REP-REQUEST-FAILED "
219
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700220/* hostapd control interface - fixed message prefixes */
221#define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED "
222#define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS "
223#define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS "
224#define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED "
225#define WPS_EVENT_AP_SETUP_UNLOCKED "WPS-AP-SETUP-UNLOCKED "
226#define WPS_EVENT_AP_PIN_ENABLED "WPS-AP-PIN-ENABLED "
227#define WPS_EVENT_AP_PIN_DISABLED "WPS-AP-PIN-DISABLED "
228#define AP_STA_CONNECTED "AP-STA-CONNECTED "
229#define AP_STA_DISCONNECTED "AP-STA-DISCONNECTED "
230
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800231#define AP_REJECTED_MAX_STA "AP-REJECTED-MAX-STA "
232#define AP_REJECTED_BLOCKED_STA "AP-REJECTED-BLOCKED-STA "
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700233
Dmitry Shmidtcce06662013-11-04 18:44:24 -0800234#define AP_EVENT_ENABLED "AP-ENABLED "
235#define AP_EVENT_DISABLED "AP-DISABLED "
236
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800237#define INTERFACE_ENABLED "INTERFACE-ENABLED "
238#define INTERFACE_DISABLED "INTERFACE-DISABLED "
239
Dmitry Shmidtcce06662013-11-04 18:44:24 -0800240#define ACS_EVENT_STARTED "ACS-STARTED "
241#define ACS_EVENT_COMPLETED "ACS-COMPLETED "
242#define ACS_EVENT_FAILED "ACS-FAILED "
243
244#define DFS_EVENT_RADAR_DETECTED "DFS-RADAR-DETECTED "
245#define DFS_EVENT_NEW_CHANNEL "DFS-NEW-CHANNEL "
246#define DFS_EVENT_CAC_START "DFS-CAC-START "
247#define DFS_EVENT_CAC_COMPLETED "DFS-CAC-COMPLETED "
248#define DFS_EVENT_NOP_FINISHED "DFS-NOP-FINISHED "
249
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -0800250#define AP_CSA_FINISHED "AP-CSA-FINISHED "
251
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800252/* BSS Transition Management Response frame received */
253#define BSS_TM_RESP "BSS-TM-RESP "
254
Dmitry Shmidt04949592012-07-19 12:16:46 -0700255/* BSS command information masks */
256
Dmitry Shmidt2f3b8de2013-03-01 09:32:50 -0800257#define WPA_BSS_MASK_ALL 0xFFFDFFFF
Dmitry Shmidt04949592012-07-19 12:16:46 -0700258#define WPA_BSS_MASK_ID BIT(0)
259#define WPA_BSS_MASK_BSSID BIT(1)
260#define WPA_BSS_MASK_FREQ BIT(2)
261#define WPA_BSS_MASK_BEACON_INT BIT(3)
262#define WPA_BSS_MASK_CAPABILITIES BIT(4)
263#define WPA_BSS_MASK_QUAL BIT(5)
264#define WPA_BSS_MASK_NOISE BIT(6)
265#define WPA_BSS_MASK_LEVEL BIT(7)
266#define WPA_BSS_MASK_TSF BIT(8)
267#define WPA_BSS_MASK_AGE BIT(9)
268#define WPA_BSS_MASK_IE BIT(10)
269#define WPA_BSS_MASK_FLAGS BIT(11)
270#define WPA_BSS_MASK_SSID BIT(12)
271#define WPA_BSS_MASK_WPS_SCAN BIT(13)
272#define WPA_BSS_MASK_P2P_SCAN BIT(14)
273#define WPA_BSS_MASK_INTERNETW BIT(15)
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700274#define WPA_BSS_MASK_WIFI_DISPLAY BIT(16)
Dmitry Shmidt2f3b8de2013-03-01 09:32:50 -0800275#define WPA_BSS_MASK_DELIM BIT(17)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800276#define WPA_BSS_MASK_MESH_SCAN BIT(18)
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800277#define WPA_BSS_MASK_SNR BIT(19)
278#define WPA_BSS_MASK_EST_THROUGHPUT BIT(20)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700279
280
Dmitry Shmidt2e67f062014-07-16 09:55:28 -0700281/* VENDOR_ELEM_* frame id values */
282enum wpa_vendor_elem_frame {
283 VENDOR_ELEM_PROBE_REQ_P2P = 0,
284 VENDOR_ELEM_PROBE_RESP_P2P = 1,
285 VENDOR_ELEM_PROBE_RESP_P2P_GO = 2,
286 VENDOR_ELEM_BEACON_P2P_GO = 3,
287 VENDOR_ELEM_P2P_PD_REQ = 4,
288 VENDOR_ELEM_P2P_PD_RESP = 5,
289 VENDOR_ELEM_P2P_GO_NEG_REQ = 6,
290 VENDOR_ELEM_P2P_GO_NEG_RESP = 7,
291 VENDOR_ELEM_P2P_GO_NEG_CONF = 8,
292 VENDOR_ELEM_P2P_INV_REQ = 9,
293 VENDOR_ELEM_P2P_INV_RESP = 10,
294 VENDOR_ELEM_P2P_ASSOC_REQ = 11,
295 VENDOR_ELEM_P2P_ASSOC_RESP = 12,
Dmitry Shmidt2f74e362015-01-21 13:19:05 -0800296 VENDOR_ELEM_ASSOC_REQ = 13,
Dmitry Shmidt2e67f062014-07-16 09:55:28 -0700297 NUM_VENDOR_ELEM_FRAMES
298};
299
300
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700301/* wpa_supplicant/hostapd control interface access */
302
303/**
304 * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd
305 * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used.
306 * Returns: Pointer to abstract control interface data or %NULL on failure
307 *
308 * This function is used to open a control interface to wpa_supplicant/hostapd.
309 * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path
310 * is configured in wpa_supplicant/hostapd and other programs using the control
311 * interface need to use matching path configuration.
312 */
313struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path);
314
315
316/**
317 * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd
318 * @ctrl: Control interface data from wpa_ctrl_open()
319 *
320 * This function is used to close a control interface.
321 */
322void wpa_ctrl_close(struct wpa_ctrl *ctrl);
323
324
325/**
326 * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd
327 * @ctrl: Control interface data from wpa_ctrl_open()
328 * @cmd: Command; usually, ASCII text, e.g., "PING"
329 * @cmd_len: Length of the cmd in bytes
330 * @reply: Buffer for the response
331 * @reply_len: Reply buffer length
332 * @msg_cb: Callback function for unsolicited messages or %NULL if not used
333 * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout
334 *
335 * This function is used to send commands to wpa_supplicant/hostapd. Received
336 * response will be written to reply and reply_len is set to the actual length
337 * of the reply. This function will block for up to two seconds while waiting
338 * for the reply. If unsolicited messages are received, the blocking time may
339 * be longer.
340 *
341 * msg_cb can be used to register a callback function that will be called for
342 * unsolicited messages received while waiting for the command response. These
343 * messages may be received if wpa_ctrl_request() is called at the same time as
344 * wpa_supplicant/hostapd is sending such a message. This can happen only if
345 * the program has used wpa_ctrl_attach() to register itself as a monitor for
346 * event messages. Alternatively to msg_cb, programs can register two control
347 * interface connections and use one of them for commands and the other one for
348 * receiving event messages, in other words, call wpa_ctrl_attach() only for
349 * the control interface connection that will be used for event messages.
350 */
351int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
352 char *reply, size_t *reply_len,
353 void (*msg_cb)(char *msg, size_t len));
354
355
356/**
357 * wpa_ctrl_attach - Register as an event monitor for the control interface
358 * @ctrl: Control interface data from wpa_ctrl_open()
359 * Returns: 0 on success, -1 on failure, -2 on timeout
360 *
361 * This function registers the control interface connection as a monitor for
362 * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the
363 * control interface connection starts receiving event messages that can be
364 * read with wpa_ctrl_recv().
365 */
366int wpa_ctrl_attach(struct wpa_ctrl *ctrl);
367
368
369/**
370 * wpa_ctrl_detach - Unregister event monitor from the control interface
371 * @ctrl: Control interface data from wpa_ctrl_open()
372 * Returns: 0 on success, -1 on failure, -2 on timeout
373 *
374 * This function unregisters the control interface connection as a monitor for
375 * wpa_supplicant/hostapd events, i.e., cancels the registration done with
376 * wpa_ctrl_attach().
377 */
378int wpa_ctrl_detach(struct wpa_ctrl *ctrl);
379
380
381/**
382 * wpa_ctrl_recv - Receive a pending control interface message
383 * @ctrl: Control interface data from wpa_ctrl_open()
384 * @reply: Buffer for the message data
385 * @reply_len: Length of the reply buffer
386 * Returns: 0 on success, -1 on failure
387 *
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700388 * This function will receive a pending control interface message. The received
389 * response will be written to reply and reply_len is set to the actual length
390 * of the reply.
391
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700392 * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach()
393 * must have been used to register the control interface as an event monitor.
394 */
395int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len);
396
397
398/**
399 * wpa_ctrl_pending - Check whether there are pending event messages
400 * @ctrl: Control interface data from wpa_ctrl_open()
401 * Returns: 1 if there are pending messages, 0 if no, or -1 on error
402 *
403 * This function will check whether there are any pending control interface
404 * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is
405 * only used for event messages, i.e., wpa_ctrl_attach() must have been used to
406 * register the control interface as an event monitor.
407 */
408int wpa_ctrl_pending(struct wpa_ctrl *ctrl);
409
410
411/**
412 * wpa_ctrl_get_fd - Get file descriptor used by the control interface
413 * @ctrl: Control interface data from wpa_ctrl_open()
414 * Returns: File descriptor used for the connection
415 *
416 * This function can be used to get the file descriptor that is used for the
417 * control interface connection. The returned value can be used, e.g., with
418 * select() while waiting for multiple events.
419 *
420 * The returned file descriptor must not be used directly for sending or
421 * receiving packets; instead, the library functions wpa_ctrl_request() and
422 * wpa_ctrl_recv() must be used for this.
423 */
424int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl);
425
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800426#ifdef ANDROID
427/**
428 * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that
429 * may be left over from clients that were previously connected to
430 * wpa_supplicant. This keeps these files from being orphaned in the
431 * event of crashes that prevented them from being removed as part
432 * of the normal orderly shutdown.
433 */
434void wpa_ctrl_cleanup(void);
435#endif /* ANDROID */
436
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700437#ifdef CONFIG_CTRL_IFACE_UDP
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700438/* Port range for multiple wpa_supplicant instances and multiple VIFs */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700439#define WPA_CTRL_IFACE_PORT 9877
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700440#define WPA_CTRL_IFACE_PORT_LIMIT 50 /* decremented from start */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700441#define WPA_GLOBAL_CTRL_IFACE_PORT 9878
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700442#define WPA_GLOBAL_CTRL_IFACE_PORT_LIMIT 20 /* incremented from start */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800443
444char * wpa_ctrl_get_remote_ifname(struct wpa_ctrl *ctrl);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700445#endif /* CONFIG_CTRL_IFACE_UDP */
446
447
448#ifdef __cplusplus
449}
450#endif
451
452#endif /* WPA_CTRL_H */