1/*
2 * wpa_supplicant/hostapd control interface library
3 * Copyright (c) 2004-2017, Jouni Malinen <j@w1.fi>
4 *
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
7 */
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/** Authentication rejected during connection attempt */
32#define WPA_EVENT_AUTH_REJECT "CTRL-EVENT-AUTH-REJECT "
33/** wpa_supplicant is exiting */
34#define WPA_EVENT_TERMINATING "CTRL-EVENT-TERMINATING "
35/** Password change was completed successfully */
36#define WPA_EVENT_PASSWORD_CHANGED "CTRL-EVENT-PASSWORD-CHANGED "
37/** EAP-Request/Notification received */
38#define WPA_EVENT_EAP_NOTIFICATION "CTRL-EVENT-EAP-NOTIFICATION "
39/** EAP authentication started (EAP-Request/Identity received) */
40#define WPA_EVENT_EAP_STARTED "CTRL-EVENT-EAP-STARTED "
41/** EAP method proposed by the server */
42#define WPA_EVENT_EAP_PROPOSED_METHOD "CTRL-EVENT-EAP-PROPOSED-METHOD "
43/** EAP method selected */
44#define WPA_EVENT_EAP_METHOD "CTRL-EVENT-EAP-METHOD "
45/** EAP peer certificate from TLS */
46#define WPA_EVENT_EAP_PEER_CERT "CTRL-EVENT-EAP-PEER-CERT "
47/** EAP peer certificate alternative subject name component from TLS */
48#define WPA_EVENT_EAP_PEER_ALT "CTRL-EVENT-EAP-PEER-ALT "
49/** EAP TLS certificate chain validation error */
50#define WPA_EVENT_EAP_TLS_CERT_ERROR "CTRL-EVENT-EAP-TLS-CERT-ERROR "
51/** EAP status */
52#define WPA_EVENT_EAP_STATUS "CTRL-EVENT-EAP-STATUS "
53/** Retransmit the previous request packet */
54#define WPA_EVENT_EAP_RETRANSMIT "CTRL-EVENT-EAP-RETRANSMIT "
55#define WPA_EVENT_EAP_RETRANSMIT2 "CTRL-EVENT-EAP-RETRANSMIT2 "
56/** EAP authentication completed successfully */
57#define WPA_EVENT_EAP_SUCCESS "CTRL-EVENT-EAP-SUCCESS "
58#define WPA_EVENT_EAP_SUCCESS2 "CTRL-EVENT-EAP-SUCCESS2 "
59/** EAP authentication failed (EAP-Failure received) */
60#define WPA_EVENT_EAP_FAILURE "CTRL-EVENT-EAP-FAILURE "
61#define WPA_EVENT_EAP_FAILURE2 "CTRL-EVENT-EAP-FAILURE2 "
62/** EAP authentication failed due to no response received */
63#define WPA_EVENT_EAP_TIMEOUT_FAILURE "CTRL-EVENT-EAP-TIMEOUT-FAILURE "
64#define WPA_EVENT_EAP_TIMEOUT_FAILURE2 "CTRL-EVENT-EAP-TIMEOUT-FAILURE2 "
65#define WPA_EVENT_EAP_ERROR_CODE "EAP-ERROR-CODE "
66/** Network block temporarily disabled (e.g., due to authentication failure) */
67#define WPA_EVENT_TEMP_DISABLED "CTRL-EVENT-SSID-TEMP-DISABLED "
68/** Temporarily disabled network block re-enabled */
69#define WPA_EVENT_REENABLED "CTRL-EVENT-SSID-REENABLED "
70/** New scan started */
71#define WPA_EVENT_SCAN_STARTED "CTRL-EVENT-SCAN-STARTED "
72/** New scan results available */
73#define WPA_EVENT_SCAN_RESULTS "CTRL-EVENT-SCAN-RESULTS "
74/** Scan command failed */
75#define WPA_EVENT_SCAN_FAILED "CTRL-EVENT-SCAN-FAILED "
76/** wpa_supplicant state change */
77#define WPA_EVENT_STATE_CHANGE "CTRL-EVENT-STATE-CHANGE "
78/** A new BSS entry was added (followed by BSS entry id and BSSID) */
79#define WPA_EVENT_BSS_ADDED "CTRL-EVENT-BSS-ADDED "
80/** A BSS entry was removed (followed by BSS entry id and BSSID) */
81#define WPA_EVENT_BSS_REMOVED "CTRL-EVENT-BSS-REMOVED "
82/** No suitable network was found */
83#define WPA_EVENT_NETWORK_NOT_FOUND "CTRL-EVENT-NETWORK-NOT-FOUND "
84/** Change in the signal level was reported by the driver */
85#define WPA_EVENT_SIGNAL_CHANGE "CTRL-EVENT-SIGNAL-CHANGE "
86/** Beacon loss reported by the driver */
87#define WPA_EVENT_BEACON_LOSS "CTRL-EVENT-BEACON-LOSS "
88/** Regulatory domain channel */
89#define WPA_EVENT_REGDOM_CHANGE "CTRL-EVENT-REGDOM-CHANGE "
90/** Channel switch started (followed by freq=<MHz> and other channel parameters)
91 */
92#define WPA_EVENT_CHANNEL_SWITCH_STARTED "CTRL-EVENT-STARTED-CHANNEL-SWITCH "
93/** Channel switch (followed by freq=<MHz> and other channel parameters) */
94#define WPA_EVENT_CHANNEL_SWITCH "CTRL-EVENT-CHANNEL-SWITCH "
95/** SAE authentication failed due to unknown password identifier */
96#define WPA_EVENT_SAE_UNKNOWN_PASSWORD_IDENTIFIER \
97	"CTRL-EVENT-SAE-UNKNOWN-PASSWORD-IDENTIFIER "
98
99/** IP subnet status change notification
100 *
101 * When using an offloaded roaming mechanism where driver/firmware takes care
102 * of roaming and IP subnet validation checks post-roaming, this event can
103 * indicate whether IP subnet has changed.
104 *
105 * The event has a status=<0/1/2> parameter where
106 * 0 = unknown
107 * 1 = IP subnet unchanged (can continue to use the old IP address)
108 * 2 = IP subnet changed (need to get a new IP address)
109 */
110#define WPA_EVENT_SUBNET_STATUS_UPDATE "CTRL-EVENT-SUBNET-STATUS-UPDATE "
111
112/** RSN IBSS 4-way handshakes completed with specified peer */
113#define IBSS_RSN_COMPLETED "IBSS-RSN-COMPLETED "
114
115/** Notification of frequency conflict due to a concurrent operation.
116 *
117 * The indicated network is disabled and needs to be re-enabled before it can
118 * be used again.
119 */
120#define WPA_EVENT_FREQ_CONFLICT "CTRL-EVENT-FREQ-CONFLICT "
121/** Frequency ranges that the driver recommends to avoid */
122#define WPA_EVENT_AVOID_FREQ "CTRL-EVENT-AVOID-FREQ "
123/** WPS overlap detected in PBC mode */
124#define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED "
125/** Available WPS AP with active PBC found in scan results */
126#define WPS_EVENT_AP_AVAILABLE_PBC "WPS-AP-AVAILABLE-PBC "
127/** Available WPS AP with our address as authorized in scan results */
128#define WPS_EVENT_AP_AVAILABLE_AUTH "WPS-AP-AVAILABLE-AUTH "
129/** Available WPS AP with recently selected PIN registrar found in scan results
130 */
131#define WPS_EVENT_AP_AVAILABLE_PIN "WPS-AP-AVAILABLE-PIN "
132/** Available WPS AP found in scan results */
133#define WPS_EVENT_AP_AVAILABLE "WPS-AP-AVAILABLE "
134/** A new credential received */
135#define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED "
136/** M2D received */
137#define WPS_EVENT_M2D "WPS-M2D "
138/** WPS registration failed after M2/M2D */
139#define WPS_EVENT_FAIL "WPS-FAIL "
140/** WPS registration completed successfully */
141#define WPS_EVENT_SUCCESS "WPS-SUCCESS "
142/** WPS enrollment attempt timed out and was terminated */
143#define WPS_EVENT_TIMEOUT "WPS-TIMEOUT "
144/* PBC mode was activated */
145#define WPS_EVENT_ACTIVE "WPS-PBC-ACTIVE "
146/* PBC mode was disabled */
147#define WPS_EVENT_DISABLE "WPS-PBC-DISABLE "
148
149#define WPS_EVENT_ENROLLEE_SEEN "WPS-ENROLLEE-SEEN "
150
151#define WPS_EVENT_OPEN_NETWORK "WPS-OPEN-NETWORK "
152
153/* WPS ER events */
154#define WPS_EVENT_ER_AP_ADD "WPS-ER-AP-ADD "
155#define WPS_EVENT_ER_AP_REMOVE "WPS-ER-AP-REMOVE "
156#define WPS_EVENT_ER_ENROLLEE_ADD "WPS-ER-ENROLLEE-ADD "
157#define WPS_EVENT_ER_ENROLLEE_REMOVE "WPS-ER-ENROLLEE-REMOVE "
158#define WPS_EVENT_ER_AP_SETTINGS "WPS-ER-AP-SETTINGS "
159#define WPS_EVENT_ER_SET_SEL_REG "WPS-ER-AP-SET-SEL-REG "
160
161/* DPP events */
162#define DPP_EVENT_AUTH_SUCCESS "DPP-AUTH-SUCCESS "
163#define DPP_EVENT_AUTH_INIT_FAILED "DPP-AUTH-INIT-FAILED "
164#define DPP_EVENT_NOT_COMPATIBLE "DPP-NOT-COMPATIBLE "
165#define DPP_EVENT_RESPONSE_PENDING "DPP-RESPONSE-PENDING "
166#define DPP_EVENT_SCAN_PEER_QR_CODE "DPP-SCAN-PEER-QR-CODE "
167#define DPP_EVENT_AUTH_DIRECTION "DPP-AUTH-DIRECTION "
168#define DPP_EVENT_CONF_RECEIVED "DPP-CONF-RECEIVED "
169#define DPP_EVENT_CONF_SENT "DPP-CONF-SENT "
170#define DPP_EVENT_CONF_FAILED "DPP-CONF-FAILED "
171#define DPP_EVENT_CONFOBJ_AKM "DPP-CONFOBJ-AKM "
172#define DPP_EVENT_CONFOBJ_SSID "DPP-CONFOBJ-SSID "
173#define DPP_EVENT_CONFOBJ_PASS "DPP-CONFOBJ-PASS "
174#define DPP_EVENT_CONFOBJ_PSK "DPP-CONFOBJ-PSK "
175#define DPP_EVENT_CONNECTOR "DPP-CONNECTOR "
176#define DPP_EVENT_C_SIGN_KEY "DPP-C-SIGN-KEY "
177#define DPP_EVENT_NET_ACCESS_KEY "DPP-NET-ACCESS-KEY "
178#define DPP_EVENT_MISSING_CONNECTOR "DPP-MISSING-CONNECTOR "
179#define DPP_EVENT_NETWORK_ID "DPP-NETWORK-ID "
180#define DPP_EVENT_RX "DPP-RX "
181#define DPP_EVENT_TX "DPP-TX "
182#define DPP_EVENT_TX_STATUS "DPP-TX-STATUS "
183#define DPP_EVENT_FAIL "DPP-FAIL "
184#define DPP_EVENT_PKEX_T_LIMIT "DPP-PKEX-T-LIMIT "
185#define DPP_EVENT_INTRO "DPP-INTRO "
186#define DPP_EVENT_CONF_REQ_RX "DPP-CONF-REQ-RX "
187
188/* MESH events */
189#define MESH_GROUP_STARTED "MESH-GROUP-STARTED "
190#define MESH_GROUP_REMOVED "MESH-GROUP-REMOVED "
191#define MESH_PEER_CONNECTED "MESH-PEER-CONNECTED "
192#define MESH_PEER_DISCONNECTED "MESH-PEER-DISCONNECTED "
193/** Mesh SAE authentication failure. Wrong password suspected. */
194#define MESH_SAE_AUTH_FAILURE "MESH-SAE-AUTH-FAILURE "
195#define MESH_SAE_AUTH_BLOCKED "MESH-SAE-AUTH-BLOCKED "
196
197/* WMM AC events */
198#define WMM_AC_EVENT_TSPEC_ADDED "TSPEC-ADDED "
199#define WMM_AC_EVENT_TSPEC_REMOVED "TSPEC-REMOVED "
200#define WMM_AC_EVENT_TSPEC_REQ_FAILED "TSPEC-REQ-FAILED "
201
202/** P2P device found */
203#define P2P_EVENT_DEVICE_FOUND "P2P-DEVICE-FOUND "
204
205/** P2P device lost */
206#define P2P_EVENT_DEVICE_LOST "P2P-DEVICE-LOST "
207
208/** A P2P device requested GO negotiation, but we were not ready to start the
209 * negotiation */
210#define P2P_EVENT_GO_NEG_REQUEST "P2P-GO-NEG-REQUEST "
211#define P2P_EVENT_GO_NEG_SUCCESS "P2P-GO-NEG-SUCCESS "
212#define P2P_EVENT_GO_NEG_FAILURE "P2P-GO-NEG-FAILURE "
213#define P2P_EVENT_GROUP_FORMATION_SUCCESS "P2P-GROUP-FORMATION-SUCCESS "
214#define P2P_EVENT_GROUP_FORMATION_FAILURE "P2P-GROUP-FORMATION-FAILURE "
215#define P2P_EVENT_GROUP_STARTED "P2P-GROUP-STARTED "
216#define P2P_EVENT_GROUP_REMOVED "P2P-GROUP-REMOVED "
217#define P2P_EVENT_CROSS_CONNECT_ENABLE "P2P-CROSS-CONNECT-ENABLE "
218#define P2P_EVENT_CROSS_CONNECT_DISABLE "P2P-CROSS-CONNECT-DISABLE "
219/* parameters: <peer address> <PIN> */
220#define P2P_EVENT_PROV_DISC_SHOW_PIN "P2P-PROV-DISC-SHOW-PIN "
221/* parameters: <peer address> */
222#define P2P_EVENT_PROV_DISC_ENTER_PIN "P2P-PROV-DISC-ENTER-PIN "
223/* parameters: <peer address> */
224#define P2P_EVENT_PROV_DISC_PBC_REQ "P2P-PROV-DISC-PBC-REQ "
225/* parameters: <peer address> */
226#define P2P_EVENT_PROV_DISC_PBC_RESP "P2P-PROV-DISC-PBC-RESP "
227/* parameters: <peer address> <status> */
228#define P2P_EVENT_PROV_DISC_FAILURE "P2P-PROV-DISC-FAILURE"
229/* parameters: <freq> <src addr> <dialog token> <update indicator> <TLVs> */
230#define P2P_EVENT_SERV_DISC_REQ "P2P-SERV-DISC-REQ "
231/* parameters: <src addr> <update indicator> <TLVs> */
232#define P2P_EVENT_SERV_DISC_RESP "P2P-SERV-DISC-RESP "
233#define P2P_EVENT_SERV_ASP_RESP "P2P-SERV-ASP-RESP "
234#define P2P_EVENT_INVITATION_RECEIVED "P2P-INVITATION-RECEIVED "
235#define P2P_EVENT_INVITATION_RESULT "P2P-INVITATION-RESULT "
236#define P2P_EVENT_INVITATION_ACCEPTED "P2P-INVITATION-ACCEPTED "
237#define P2P_EVENT_FIND_STOPPED "P2P-FIND-STOPPED "
238#define P2P_EVENT_PERSISTENT_PSK_FAIL "P2P-PERSISTENT-PSK-FAIL id="
239#define P2P_EVENT_PRESENCE_RESPONSE "P2P-PRESENCE-RESPONSE "
240#define P2P_EVENT_NFC_BOTH_GO "P2P-NFC-BOTH-GO "
241#define P2P_EVENT_NFC_PEER_CLIENT "P2P-NFC-PEER-CLIENT "
242#define P2P_EVENT_NFC_WHILE_CLIENT "P2P-NFC-WHILE-CLIENT "
243#define P2P_EVENT_FALLBACK_TO_GO_NEG "P2P-FALLBACK-TO-GO-NEG "
244#define P2P_EVENT_FALLBACK_TO_GO_NEG_ENABLED "P2P-FALLBACK-TO-GO-NEG-ENABLED "
245
246/* parameters: <PMF enabled> <timeout in ms> <Session Information URL> */
247#define ESS_DISASSOC_IMMINENT "ESS-DISASSOC-IMMINENT "
248#define P2P_EVENT_REMOVE_AND_REFORM_GROUP "P2P-REMOVE-AND-REFORM-GROUP "
249
250#define P2P_EVENT_P2PS_PROVISION_START "P2PS-PROV-START "
251#define P2P_EVENT_P2PS_PROVISION_DONE "P2PS-PROV-DONE "
252
253#define INTERWORKING_AP "INTERWORKING-AP "
254#define INTERWORKING_BLACKLISTED "INTERWORKING-BLACKLISTED "
255#define INTERWORKING_NO_MATCH "INTERWORKING-NO-MATCH "
256#define INTERWORKING_ALREADY_CONNECTED "INTERWORKING-ALREADY-CONNECTED "
257#define INTERWORKING_SELECTED "INTERWORKING-SELECTED "
258
259/* Credential block added; parameters: <id> */
260#define CRED_ADDED "CRED-ADDED "
261/* Credential block modified; parameters: <id> <field> */
262#define CRED_MODIFIED "CRED-MODIFIED "
263/* Credential block removed; parameters: <id> */
264#define CRED_REMOVED "CRED-REMOVED "
265
266#define GAS_RESPONSE_INFO "GAS-RESPONSE-INFO "
267/* parameters: <addr> <dialog_token> <freq> */
268#define GAS_QUERY_START "GAS-QUERY-START "
269/* parameters: <addr> <dialog_token> <freq> <status_code> <result> */
270#define GAS_QUERY_DONE "GAS-QUERY-DONE "
271
272/* parameters: <addr> <result> */
273#define ANQP_QUERY_DONE "ANQP-QUERY-DONE "
274
275#define RX_ANQP "RX-ANQP "
276#define RX_HS20_ANQP "RX-HS20-ANQP "
277#define RX_HS20_ANQP_ICON "RX-HS20-ANQP-ICON "
278#define RX_HS20_ICON "RX-HS20-ICON "
279#define RX_MBO_ANQP "RX-MBO-ANQP "
280
281/* parameters: <Venue Number> <Venue URL> */
282#define RX_VENUE_URL "RX-VENUE-URL "
283
284#define HS20_SUBSCRIPTION_REMEDIATION "HS20-SUBSCRIPTION-REMEDIATION "
285#define HS20_DEAUTH_IMMINENT_NOTICE "HS20-DEAUTH-IMMINENT-NOTICE "
286#define HS20_T_C_ACCEPTANCE "HS20-T-C-ACCEPTANCE "
287
288#define EXT_RADIO_WORK_START "EXT-RADIO-WORK-START "
289#define EXT_RADIO_WORK_TIMEOUT "EXT-RADIO-WORK-TIMEOUT "
290
291#define RRM_EVENT_NEIGHBOR_REP_RXED "RRM-NEIGHBOR-REP-RECEIVED "
292#define RRM_EVENT_NEIGHBOR_REP_FAILED "RRM-NEIGHBOR-REP-REQUEST-FAILED "
293
294/* hostapd control interface - fixed message prefixes */
295#define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED "
296#define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS "
297#define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS "
298#define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED "
299#define WPS_EVENT_AP_SETUP_UNLOCKED "WPS-AP-SETUP-UNLOCKED "
300#define WPS_EVENT_AP_PIN_ENABLED "WPS-AP-PIN-ENABLED "
301#define WPS_EVENT_AP_PIN_DISABLED "WPS-AP-PIN-DISABLED "
302#define AP_STA_CONNECTED "AP-STA-CONNECTED "
303#define AP_STA_DISCONNECTED "AP-STA-DISCONNECTED "
304#define AP_STA_POSSIBLE_PSK_MISMATCH "AP-STA-POSSIBLE-PSK-MISMATCH "
305#define AP_STA_POLL_OK "AP-STA-POLL-OK "
306
307#define AP_REJECTED_MAX_STA "AP-REJECTED-MAX-STA "
308#define AP_REJECTED_BLOCKED_STA "AP-REJECTED-BLOCKED-STA "
309
310#define HS20_T_C_FILTERING_ADD "HS20-T-C-FILTERING-ADD "
311#define HS20_T_C_FILTERING_REMOVE "HS20-T-C-FILTERING-REMOVE "
312
313#define AP_EVENT_ENABLED "AP-ENABLED "
314#define AP_EVENT_DISABLED "AP-DISABLED "
315
316#define INTERFACE_ENABLED "INTERFACE-ENABLED "
317#define INTERFACE_DISABLED "INTERFACE-DISABLED "
318
319#define ACS_EVENT_STARTED "ACS-STARTED "
320#define ACS_EVENT_COMPLETED "ACS-COMPLETED "
321#define ACS_EVENT_FAILED "ACS-FAILED "
322
323#define DFS_EVENT_RADAR_DETECTED "DFS-RADAR-DETECTED "
324#define DFS_EVENT_NEW_CHANNEL "DFS-NEW-CHANNEL "
325#define DFS_EVENT_CAC_START "DFS-CAC-START "
326#define DFS_EVENT_CAC_COMPLETED "DFS-CAC-COMPLETED "
327#define DFS_EVENT_NOP_FINISHED "DFS-NOP-FINISHED "
328#define DFS_EVENT_PRE_CAC_EXPIRED "DFS-PRE-CAC-EXPIRED "
329
330#define AP_CSA_FINISHED "AP-CSA-FINISHED "
331
332#define P2P_EVENT_LISTEN_OFFLOAD_STOP "P2P-LISTEN-OFFLOAD-STOPPED "
333#define P2P_LISTEN_OFFLOAD_STOP_REASON "P2P-LISTEN-OFFLOAD-STOP-REASON "
334
335/* BSS Transition Management Response frame received */
336#define BSS_TM_RESP "BSS-TM-RESP "
337
338/* Collocated Interference Request frame received;
339 * parameters: <dialog token> <automatic report enabled> <report timeout> */
340#define COLOC_INTF_REQ "COLOC-INTF-REQ "
341/* Collocated Interference Report frame received;
342 * parameters: <STA address> <dialog token> <hexdump of report elements> */
343#define COLOC_INTF_REPORT "COLOC-INTF-REPORT "
344
345/* MBO IE with cellular data connection preference received */
346#define MBO_CELL_PREFERENCE "MBO-CELL-PREFERENCE "
347
348/* BSS Transition Management Request received with MBO transition reason */
349#define MBO_TRANSITION_REASON "MBO-TRANSITION-REASON "
350
351/* parameters: <STA address> <dialog token> <ack=0/1> */
352#define BEACON_REQ_TX_STATUS "BEACON-REQ-TX-STATUS "
353/* parameters: <STA address> <dialog token> <report mode> <beacon report> */
354#define BEACON_RESP_RX "BEACON-RESP-RX "
355
356/* PMKSA cache entry added; parameters: <BSSID> <network_id> */
357#define PMKSA_CACHE_ADDED "PMKSA-CACHE-ADDED "
358/* PMKSA cache entry removed; parameters: <BSSID> <network_id> */
359#define PMKSA_CACHE_REMOVED "PMKSA-CACHE-REMOVED "
360
361/* FILS HLP Container receive; parameters: dst=<addr> src=<addr> frame=<hexdump>
362 */
363#define FILS_HLP_RX "FILS-HLP-RX "
364
365/* Event to indicate Probe Request frame;
366 * parameters: sa=<STA MAC address> signal=<signal> */
367#define RX_PROBE_REQUEST "RX-PROBE-REQUEST "
368
369/* Event to indicate station's HT/VHT operation mode change information */
370#define STA_OPMODE_MAX_BW_CHANGED "STA-OPMODE-MAX-BW-CHANGED "
371#define STA_OPMODE_SMPS_MODE_CHANGED "STA-OPMODE-SMPS-MODE-CHANGED "
372#define STA_OPMODE_N_SS_CHANGED "STA-OPMODE-N_SS-CHANGED "
373
374/* New interface addition or removal for 4addr WDS SDA */
375#define WDS_STA_INTERFACE_ADDED "WDS-STA-INTERFACE-ADDED "
376#define WDS_STA_INTERFACE_REMOVED "WDS-STA-INTERFACE-REMOVED "
377
378/* BSS command information masks */
379
380#define WPA_BSS_MASK_ALL		0xFFFDFFFF
381#define WPA_BSS_MASK_ID			BIT(0)
382#define WPA_BSS_MASK_BSSID		BIT(1)
383#define WPA_BSS_MASK_FREQ		BIT(2)
384#define WPA_BSS_MASK_BEACON_INT		BIT(3)
385#define WPA_BSS_MASK_CAPABILITIES	BIT(4)
386#define WPA_BSS_MASK_QUAL		BIT(5)
387#define WPA_BSS_MASK_NOISE		BIT(6)
388#define WPA_BSS_MASK_LEVEL		BIT(7)
389#define WPA_BSS_MASK_TSF		BIT(8)
390#define WPA_BSS_MASK_AGE		BIT(9)
391#define WPA_BSS_MASK_IE			BIT(10)
392#define WPA_BSS_MASK_FLAGS		BIT(11)
393#define WPA_BSS_MASK_SSID		BIT(12)
394#define WPA_BSS_MASK_WPS_SCAN		BIT(13)
395#define WPA_BSS_MASK_P2P_SCAN		BIT(14)
396#define WPA_BSS_MASK_INTERNETW		BIT(15)
397#define WPA_BSS_MASK_WIFI_DISPLAY	BIT(16)
398#define WPA_BSS_MASK_DELIM		BIT(17)
399#define WPA_BSS_MASK_MESH_SCAN		BIT(18)
400#define WPA_BSS_MASK_SNR		BIT(19)
401#define WPA_BSS_MASK_EST_THROUGHPUT	BIT(20)
402#define WPA_BSS_MASK_FST		BIT(21)
403#define WPA_BSS_MASK_UPDATE_IDX		BIT(22)
404#define WPA_BSS_MASK_BEACON_IE		BIT(23)
405#define WPA_BSS_MASK_FILS_INDICATION	BIT(24)
406
407
408/* VENDOR_ELEM_* frame id values */
409enum wpa_vendor_elem_frame {
410	VENDOR_ELEM_PROBE_REQ_P2P = 0,
411	VENDOR_ELEM_PROBE_RESP_P2P = 1,
412	VENDOR_ELEM_PROBE_RESP_P2P_GO = 2,
413	VENDOR_ELEM_BEACON_P2P_GO = 3,
414	VENDOR_ELEM_P2P_PD_REQ = 4,
415	VENDOR_ELEM_P2P_PD_RESP = 5,
416	VENDOR_ELEM_P2P_GO_NEG_REQ = 6,
417	VENDOR_ELEM_P2P_GO_NEG_RESP = 7,
418	VENDOR_ELEM_P2P_GO_NEG_CONF = 8,
419	VENDOR_ELEM_P2P_INV_REQ = 9,
420	VENDOR_ELEM_P2P_INV_RESP = 10,
421	VENDOR_ELEM_P2P_ASSOC_REQ = 11,
422	VENDOR_ELEM_P2P_ASSOC_RESP = 12,
423	VENDOR_ELEM_ASSOC_REQ = 13,
424	VENDOR_ELEM_PROBE_REQ = 14,
425	NUM_VENDOR_ELEM_FRAMES
426};
427
428
429/* wpa_supplicant/hostapd control interface access */
430
431/**
432 * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd
433 * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used.
434 * Returns: Pointer to abstract control interface data or %NULL on failure
435 *
436 * This function is used to open a control interface to wpa_supplicant/hostapd.
437 * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path
438 * is configured in wpa_supplicant/hostapd and other programs using the control
439 * interface need to use matching path configuration.
440 */
441struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path);
442
443/**
444 * wpa_ctrl_open2 - Open a control interface to wpa_supplicant/hostapd
445 * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used.
446 * @cli_path: Path for client UNIX domain sockets; ignored if UDP socket
447 *            is used.
448 * Returns: Pointer to abstract control interface data or %NULL on failure
449 *
450 * This function is used to open a control interface to wpa_supplicant/hostapd
451 * when the socket path for client need to be specified explicitly. Default
452 * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd and client
453 * socket path is /tmp.
454 */
455struct wpa_ctrl * wpa_ctrl_open2(const char *ctrl_path, const char *cli_path);
456
457
458/**
459 * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd
460 * @ctrl: Control interface data from wpa_ctrl_open()
461 *
462 * This function is used to close a control interface.
463 */
464void wpa_ctrl_close(struct wpa_ctrl *ctrl);
465
466
467/**
468 * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd
469 * @ctrl: Control interface data from wpa_ctrl_open()
470 * @cmd: Command; usually, ASCII text, e.g., "PING"
471 * @cmd_len: Length of the cmd in bytes
472 * @reply: Buffer for the response
473 * @reply_len: Reply buffer length
474 * @msg_cb: Callback function for unsolicited messages or %NULL if not used
475 * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout
476 *
477 * This function is used to send commands to wpa_supplicant/hostapd. Received
478 * response will be written to reply and reply_len is set to the actual length
479 * of the reply. This function will block for up to 10 seconds while waiting
480 * for the reply. If unsolicited messages are received, the blocking time may
481 * be longer.
482 *
483 * msg_cb can be used to register a callback function that will be called for
484 * unsolicited messages received while waiting for the command response. These
485 * messages may be received if wpa_ctrl_request() is called at the same time as
486 * wpa_supplicant/hostapd is sending such a message. This can happen only if
487 * the program has used wpa_ctrl_attach() to register itself as a monitor for
488 * event messages. Alternatively to msg_cb, programs can register two control
489 * interface connections and use one of them for commands and the other one for
490 * receiving event messages, in other words, call wpa_ctrl_attach() only for
491 * the control interface connection that will be used for event messages.
492 */
493int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
494		     char *reply, size_t *reply_len,
495		     void (*msg_cb)(char *msg, size_t len));
496
497
498/**
499 * wpa_ctrl_attach - Register as an event monitor for the control interface
500 * @ctrl: Control interface data from wpa_ctrl_open()
501 * Returns: 0 on success, -1 on failure, -2 on timeout
502 *
503 * This function registers the control interface connection as a monitor for
504 * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the
505 * control interface connection starts receiving event messages that can be
506 * read with wpa_ctrl_recv().
507 */
508int wpa_ctrl_attach(struct wpa_ctrl *ctrl);
509
510
511/**
512 * wpa_ctrl_detach - Unregister event monitor from the control interface
513 * @ctrl: Control interface data from wpa_ctrl_open()
514 * Returns: 0 on success, -1 on failure, -2 on timeout
515 *
516 * This function unregisters the control interface connection as a monitor for
517 * wpa_supplicant/hostapd events, i.e., cancels the registration done with
518 * wpa_ctrl_attach().
519 */
520int wpa_ctrl_detach(struct wpa_ctrl *ctrl);
521
522
523/**
524 * wpa_ctrl_recv - Receive a pending control interface message
525 * @ctrl: Control interface data from wpa_ctrl_open()
526 * @reply: Buffer for the message data
527 * @reply_len: Length of the reply buffer
528 * Returns: 0 on success, -1 on failure
529 *
530 * This function will receive a pending control interface message. The received
531 * response will be written to reply and reply_len is set to the actual length
532 * of the reply.
533
534 * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach()
535 * must have been used to register the control interface as an event monitor.
536 */
537int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len);
538
539
540/**
541 * wpa_ctrl_pending - Check whether there are pending event messages
542 * @ctrl: Control interface data from wpa_ctrl_open()
543 * Returns: 1 if there are pending messages, 0 if no, or -1 on error
544 *
545 * This function will check whether there are any pending control interface
546 * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is
547 * only used for event messages, i.e., wpa_ctrl_attach() must have been used to
548 * register the control interface as an event monitor.
549 */
550int wpa_ctrl_pending(struct wpa_ctrl *ctrl);
551
552
553/**
554 * wpa_ctrl_get_fd - Get file descriptor used by the control interface
555 * @ctrl: Control interface data from wpa_ctrl_open()
556 * Returns: File descriptor used for the connection
557 *
558 * This function can be used to get the file descriptor that is used for the
559 * control interface connection. The returned value can be used, e.g., with
560 * select() while waiting for multiple events.
561 *
562 * The returned file descriptor must not be used directly for sending or
563 * receiving packets; instead, the library functions wpa_ctrl_request() and
564 * wpa_ctrl_recv() must be used for this.
565 */
566int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl);
567
568#ifdef ANDROID
569/**
570 * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that
571 * may be left over from clients that were previously connected to
572 * wpa_supplicant. This keeps these files from being orphaned in the
573 * event of crashes that prevented them from being removed as part
574 * of the normal orderly shutdown.
575 */
576void wpa_ctrl_cleanup(void);
577#endif /* ANDROID */
578
579#ifdef CONFIG_CTRL_IFACE_UDP
580/* Port range for multiple wpa_supplicant instances and multiple VIFs */
581#define WPA_CTRL_IFACE_PORT 9877
582#define WPA_CTRL_IFACE_PORT_LIMIT 50 /* decremented from start */
583#define WPA_GLOBAL_CTRL_IFACE_PORT 9878
584#define WPA_GLOBAL_CTRL_IFACE_PORT_LIMIT 20 /* incremented from start */
585
586char * wpa_ctrl_get_remote_ifname(struct wpa_ctrl *ctrl);
587#endif /* CONFIG_CTRL_IFACE_UDP */
588
589
590#ifdef  __cplusplus
591}
592#endif
593
594#endif /* WPA_CTRL_H */
595