]>
Commit | Line | Data |
---|---|---|
6fc6879b JM |
1 | /* |
2 | * wpa_supplicant/hostapd control interface library | |
3 | * Copyright (c) 2004-2006, Jouni Malinen <j@w1.fi> | |
4 | * | |
0f3d578e JM |
5 | * This software may be distributed under the terms of the BSD license. |
6 | * See README for more details. | |
6fc6879b JM |
7 | */ |
8 | ||
9 | #ifndef WPA_CTRL_H | |
10 | #define WPA_CTRL_H | |
11 | ||
12 | #ifdef __cplusplus | |
13 | extern "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 " | |
ea78c315 JM |
29 | /** Association rejected during connection attempt */ |
30 | #define WPA_EVENT_ASSOC_REJECT "CTRL-EVENT-ASSOC-REJECT " | |
6fc6879b JM |
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 " | |
7796f20e JM |
39 | /** EAP method proposed by the server */ |
40 | #define WPA_EVENT_EAP_PROPOSED_METHOD "CTRL-EVENT-EAP-PROPOSED-METHOD " | |
6fc6879b JM |
41 | /** EAP method selected */ |
42 | #define WPA_EVENT_EAP_METHOD "CTRL-EVENT-EAP-METHOD " | |
00468b46 JM |
43 | /** EAP peer certificate from TLS */ |
44 | #define WPA_EVENT_EAP_PEER_CERT "CTRL-EVENT-EAP-PEER-CERT " | |
45 | /** EAP TLS certificate chain validation error */ | |
46 | #define WPA_EVENT_EAP_TLS_CERT_ERROR "CTRL-EVENT-EAP-TLS-CERT-ERROR " | |
c7a39ba4 CH |
47 | /** EAP status */ |
48 | #define WPA_EVENT_EAP_STATUS "CTRL-EVENT-EAP-STATUS " | |
6fc6879b JM |
49 | /** EAP authentication completed successfully */ |
50 | #define WPA_EVENT_EAP_SUCCESS "CTRL-EVENT-EAP-SUCCESS " | |
51 | /** EAP authentication failed (EAP-Failure received) */ | |
52 | #define WPA_EVENT_EAP_FAILURE "CTRL-EVENT-EAP-FAILURE " | |
00e5e3d5 JM |
53 | /** Network block temporarily disabled (e.g., due to authentication failure) */ |
54 | #define WPA_EVENT_TEMP_DISABLED "CTRL-EVENT-SSID-TEMP-DISABLED " | |
55 | /** Temporarily disabled network block re-enabled */ | |
56 | #define WPA_EVENT_REENABLED "CTRL-EVENT-SSID-REENABLED " | |
a5f40eff JM |
57 | /** New scan started */ |
58 | #define WPA_EVENT_SCAN_STARTED "CTRL-EVENT-SCAN-STARTED " | |
6fc6879b JM |
59 | /** New scan results available */ |
60 | #define WPA_EVENT_SCAN_RESULTS "CTRL-EVENT-SCAN-RESULTS " | |
d1079219 DS |
61 | /** Scan command failed */ |
62 | #define WPA_EVENT_SCAN_FAILED "CTRL-EVENT-SCAN-FAILED " | |
4e2ead7a DS |
63 | /** wpa_supplicant state change */ |
64 | #define WPA_EVENT_STATE_CHANGE "CTRL-EVENT-STATE-CHANGE " | |
b590812e | 65 | /** A new BSS entry was added (followed by BSS entry id and BSSID) */ |
f0d126d3 | 66 | #define WPA_EVENT_BSS_ADDED "CTRL-EVENT-BSS-ADDED " |
b590812e | 67 | /** A BSS entry was removed (followed by BSS entry id and BSSID) */ |
f0d126d3 | 68 | #define WPA_EVENT_BSS_REMOVED "CTRL-EVENT-BSS-REMOVED " |
0cd86028 JM |
69 | /** Change in the signal level was reported by the driver */ |
70 | #define WPA_EVENT_SIGNAL_CHANGE "CTRL-EVENT-SIGNAL-CHANGE " | |
142817b2 JM |
71 | /** Regulatory domain channel */ |
72 | #define WPA_EVENT_REGDOM_CHANGE "CTRL-EVENT-REGDOM-CHANGE " | |
6fc6879b | 73 | |
e743db43 JM |
74 | /** RSN IBSS 4-way handshakes completed with specified peer */ |
75 | #define IBSS_RSN_COMPLETED "IBSS-RSN-COMPLETED " | |
76 | ||
8567866d JJ |
77 | /** Notification of frequency conflict due to a concurrent operation. |
78 | * | |
79 | * The indicated network is disabled and needs to be re-enabled before it can | |
80 | * be used again. | |
81 | */ | |
82 | #define WPA_EVENT_FREQ_CONFLICT "CTRL-EVENT-FREQ-CONFLICT " | |
253f2e37 AH |
83 | /** Frequency ranges that the driver recommends to avoid */ |
84 | #define WPA_EVENT_AVOID_FREQ "CTRL-EVENT-AVOID-FREQ " | |
a524f05e | 85 | /** WPS overlap detected in PBC mode */ |
ad08c363 | 86 | #define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED " |
a524f05e JM |
87 | /** Available WPS AP with active PBC found in scan results */ |
88 | #define WPS_EVENT_AP_AVAILABLE_PBC "WPS-AP-AVAILABLE-PBC " | |
31fcea93 JM |
89 | /** Available WPS AP with our address as authorized in scan results */ |
90 | #define WPS_EVENT_AP_AVAILABLE_AUTH "WPS-AP-AVAILABLE-AUTH " | |
a524f05e JM |
91 | /** Available WPS AP with recently selected PIN registrar found in scan results |
92 | */ | |
93 | #define WPS_EVENT_AP_AVAILABLE_PIN "WPS-AP-AVAILABLE-PIN " | |
94 | /** Available WPS AP found in scan results */ | |
95 | #define WPS_EVENT_AP_AVAILABLE "WPS-AP-AVAILABLE " | |
ff8a53a8 JM |
96 | /** A new credential received */ |
97 | #define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED " | |
4b68290e JM |
98 | /** M2D received */ |
99 | #define WPS_EVENT_M2D "WPS-M2D " | |
469fc3a4 JM |
100 | /** WPS registration failed after M2/M2D */ |
101 | #define WPS_EVENT_FAIL "WPS-FAIL " | |
ad5302a1 JM |
102 | /** WPS registration completed successfully */ |
103 | #define WPS_EVENT_SUCCESS "WPS-SUCCESS " | |
a6099152 JM |
104 | /** WPS enrollment attempt timed out and was terminated */ |
105 | #define WPS_EVENT_TIMEOUT "WPS-TIMEOUT " | |
50396e29 JM |
106 | /* PBC mode was activated */ |
107 | #define WPS_EVENT_ACTIVE "WPS-PBC-ACTIVE " | |
108 | /* PBC mode was disabled */ | |
109 | #define WPS_EVENT_DISABLE "WPS-PBC-DISABLE " | |
ad08c363 | 110 | |
c2f51269 JM |
111 | #define WPS_EVENT_ENROLLEE_SEEN "WPS-ENROLLEE-SEEN " |
112 | ||
f981eabc JM |
113 | #define WPS_EVENT_OPEN_NETWORK "WPS-OPEN-NETWORK " |
114 | ||
b78bc3a3 JM |
115 | /* WPS ER events */ |
116 | #define WPS_EVENT_ER_AP_ADD "WPS-ER-AP-ADD " | |
117 | #define WPS_EVENT_ER_AP_REMOVE "WPS-ER-AP-REMOVE " | |
118 | #define WPS_EVENT_ER_ENROLLEE_ADD "WPS-ER-ENROLLEE-ADD " | |
119 | #define WPS_EVENT_ER_ENROLLEE_REMOVE "WPS-ER-ENROLLEE-REMOVE " | |
15dbf129 | 120 | #define WPS_EVENT_ER_AP_SETTINGS "WPS-ER-AP-SETTINGS " |
3e7533b3 | 121 | #define WPS_EVENT_ER_SET_SEL_REG "WPS-ER-AP-SET-SEL-REG " |
b78bc3a3 | 122 | |
5f92659d | 123 | /* MESH events */ |
603a3f34 JL |
124 | #define MESH_GROUP_STARTED "MESH-GROUP-STARTED " |
125 | #define MESH_GROUP_REMOVED "MESH-GROUP-REMOVED " | |
5f92659d BC |
126 | #define MESH_PEER_CONNECTED "MESH-PEER-CONNECTED " |
127 | #define MESH_PEER_DISCONNECTED "MESH-PEER-DISCONNECTED " | |
128 | ||
b22128ef JM |
129 | /** P2P device found */ |
130 | #define P2P_EVENT_DEVICE_FOUND "P2P-DEVICE-FOUND " | |
3074d8f1 JJ |
131 | |
132 | /** P2P device lost */ | |
133 | #define P2P_EVENT_DEVICE_LOST "P2P-DEVICE-LOST " | |
134 | ||
b22128ef JM |
135 | /** A P2P device requested GO negotiation, but we were not ready to start the |
136 | * negotiation */ | |
137 | #define P2P_EVENT_GO_NEG_REQUEST "P2P-GO-NEG-REQUEST " | |
138 | #define P2P_EVENT_GO_NEG_SUCCESS "P2P-GO-NEG-SUCCESS " | |
139 | #define P2P_EVENT_GO_NEG_FAILURE "P2P-GO-NEG-FAILURE " | |
140 | #define P2P_EVENT_GROUP_FORMATION_SUCCESS "P2P-GROUP-FORMATION-SUCCESS " | |
141 | #define P2P_EVENT_GROUP_FORMATION_FAILURE "P2P-GROUP-FORMATION-FAILURE " | |
142 | #define P2P_EVENT_GROUP_STARTED "P2P-GROUP-STARTED " | |
143 | #define P2P_EVENT_GROUP_REMOVED "P2P-GROUP-REMOVED " | |
72044390 JM |
144 | #define P2P_EVENT_CROSS_CONNECT_ENABLE "P2P-CROSS-CONNECT-ENABLE " |
145 | #define P2P_EVENT_CROSS_CONNECT_DISABLE "P2P-CROSS-CONNECT-DISABLE " | |
b22128ef JM |
146 | /* parameters: <peer address> <PIN> */ |
147 | #define P2P_EVENT_PROV_DISC_SHOW_PIN "P2P-PROV-DISC-SHOW-PIN " | |
148 | /* parameters: <peer address> */ | |
149 | #define P2P_EVENT_PROV_DISC_ENTER_PIN "P2P-PROV-DISC-ENTER-PIN " | |
150 | /* parameters: <peer address> */ | |
151 | #define P2P_EVENT_PROV_DISC_PBC_REQ "P2P-PROV-DISC-PBC-REQ " | |
152 | /* parameters: <peer address> */ | |
153 | #define P2P_EVENT_PROV_DISC_PBC_RESP "P2P-PROV-DISC-PBC-RESP " | |
f65a239b DG |
154 | /* parameters: <peer address> <status> */ |
155 | #define P2P_EVENT_PROV_DISC_FAILURE "P2P-PROV-DISC-FAILURE" | |
b22128ef JM |
156 | /* parameters: <freq> <src addr> <dialog token> <update indicator> <TLVs> */ |
157 | #define P2P_EVENT_SERV_DISC_REQ "P2P-SERV-DISC-REQ " | |
158 | /* parameters: <src addr> <update indicator> <TLVs> */ | |
159 | #define P2P_EVENT_SERV_DISC_RESP "P2P-SERV-DISC-RESP " | |
160 | #define P2P_EVENT_INVITATION_RECEIVED "P2P-INVITATION-RECEIVED " | |
161 | #define P2P_EVENT_INVITATION_RESULT "P2P-INVITATION-RESULT " | |
8aebb0e4 | 162 | #define P2P_EVENT_FIND_STOPPED "P2P-FIND-STOPPED " |
5bf9a6c8 | 163 | #define P2P_EVENT_PERSISTENT_PSK_FAIL "P2P-PERSISTENT-PSK-FAIL id=" |
c64e3a08 | 164 | #define P2P_EVENT_PRESENCE_RESPONSE "P2P-PRESENCE-RESPONSE " |
74df9ecd | 165 | #define P2P_EVENT_NFC_BOTH_GO "P2P-NFC-BOTH-GO " |
59b45d1a JM |
166 | #define P2P_EVENT_NFC_PEER_CLIENT "P2P-NFC-PEER-CLIENT " |
167 | #define P2P_EVENT_NFC_WHILE_CLIENT "P2P-NFC-WHILE-CLIENT " | |
b22128ef | 168 | |
ae8535b6 JM |
169 | /* parameters: <PMF enabled> <timeout in ms> <Session Information URL> */ |
170 | #define ESS_DISASSOC_IMMINENT "ESS-DISASSOC-IMMINENT " | |
253f2e37 | 171 | #define P2P_EVENT_REMOVE_AND_REFORM_GROUP "P2P-REMOVE-AND-REFORM-GROUP " |
ae8535b6 | 172 | |
b02fe7ff | 173 | #define INTERWORKING_AP "INTERWORKING-AP " |
28f2a7c4 | 174 | #define INTERWORKING_BLACKLISTED "INTERWORKING-BLACKLISTED " |
b02fe7ff | 175 | #define INTERWORKING_NO_MATCH "INTERWORKING-NO-MATCH " |
d28f4e44 | 176 | #define INTERWORKING_ALREADY_CONNECTED "INTERWORKING-ALREADY-CONNECTED " |
76a55a8e | 177 | #define INTERWORKING_SELECTED "INTERWORKING-SELECTED " |
b02fe7ff | 178 | |
1619e9d5 JM |
179 | /* Credential block added; parameters: <id> */ |
180 | #define CRED_ADDED "CRED-ADDED " | |
181 | /* Credential block modified; parameters: <id> <field> */ | |
182 | #define CRED_MODIFIED "CRED-MODIFIED " | |
183 | /* Credential block removed; parameters: <id> */ | |
184 | #define CRED_REMOVED "CRED-REMOVED " | |
185 | ||
b1f12296 | 186 | #define GAS_RESPONSE_INFO "GAS-RESPONSE-INFO " |
6ffa1687 JM |
187 | /* parameters: <addr> <dialog_token> <freq> */ |
188 | #define GAS_QUERY_START "GAS-QUERY-START " | |
189 | /* parameters: <addr> <dialog_token> <freq> <status_code> <result> */ | |
190 | #define GAS_QUERY_DONE "GAS-QUERY-DONE " | |
b1f12296 | 191 | |
95a3ea94 | 192 | #define HS20_SUBSCRIPTION_REMEDIATION "HS20-SUBSCRIPTION-REMEDIATION " |
7ef69479 | 193 | #define HS20_DEAUTH_IMMINENT_NOTICE "HS20-DEAUTH-IMMINENT-NOTICE " |
95a3ea94 | 194 | |
1f965e62 JM |
195 | #define EXT_RADIO_WORK_START "EXT-RADIO-WORK-START " |
196 | #define EXT_RADIO_WORK_TIMEOUT "EXT-RADIO-WORK-TIMEOUT " | |
197 | ||
ad08c363 JM |
198 | /* hostapd control interface - fixed message prefixes */ |
199 | #define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED " | |
200 | #define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS " | |
aabe26a1 | 201 | #define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS " |
3b2cf800 | 202 | #define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED " |
94481410 | 203 | #define WPS_EVENT_AP_SETUP_UNLOCKED "WPS-AP-SETUP-UNLOCKED " |
5a1cc30f JM |
204 | #define WPS_EVENT_AP_PIN_ENABLED "WPS-AP-PIN-ENABLED " |
205 | #define WPS_EVENT_AP_PIN_DISABLED "WPS-AP-PIN-DISABLED " | |
20bd9547 JM |
206 | #define AP_STA_CONNECTED "AP-STA-CONNECTED " |
207 | #define AP_STA_DISCONNECTED "AP-STA-DISCONNECTED " | |
ad08c363 | 208 | |
3140803b RM |
209 | #define AP_REJECTED_MAX_STA "AP-REJECTED-MAX-STA " |
210 | #define AP_REJECTED_BLOCKED_STA "AP-REJECTED-BLOCKED-STA " | |
6fc6879b | 211 | |
7d6d7370 JM |
212 | #define AP_EVENT_ENABLED "AP-ENABLED " |
213 | #define AP_EVENT_DISABLED "AP-DISABLED " | |
214 | ||
ab93fdeb JM |
215 | #define INTERFACE_ENABLED "INTERFACE-ENABLED " |
216 | #define INTERFACE_DISABLED "INTERFACE-DISABLED " | |
217 | ||
ae134e1d JM |
218 | #define ACS_EVENT_STARTED "ACS-STARTED " |
219 | #define ACS_EVENT_COMPLETED "ACS-COMPLETED " | |
220 | #define ACS_EVENT_FAILED "ACS-FAILED " | |
221 | ||
186c9059 JM |
222 | #define DFS_EVENT_RADAR_DETECTED "DFS-RADAR-DETECTED " |
223 | #define DFS_EVENT_NEW_CHANNEL "DFS-NEW-CHANNEL " | |
224 | #define DFS_EVENT_CAC_START "DFS-CAC-START " | |
225 | #define DFS_EVENT_CAC_COMPLETED "DFS-CAC-COMPLETED " | |
226 | #define DFS_EVENT_NOP_FINISHED "DFS-NOP-FINISHED " | |
227 | ||
bf281c12 AO |
228 | #define AP_CSA_FINISHED "AP-CSA-FINISHED " |
229 | ||
5f97dd1c DS |
230 | /* BSS command information masks */ |
231 | ||
c6673429 | 232 | #define WPA_BSS_MASK_ALL 0xFFFDFFFF |
5f97dd1c DS |
233 | #define WPA_BSS_MASK_ID BIT(0) |
234 | #define WPA_BSS_MASK_BSSID BIT(1) | |
235 | #define WPA_BSS_MASK_FREQ BIT(2) | |
236 | #define WPA_BSS_MASK_BEACON_INT BIT(3) | |
237 | #define WPA_BSS_MASK_CAPABILITIES BIT(4) | |
238 | #define WPA_BSS_MASK_QUAL BIT(5) | |
239 | #define WPA_BSS_MASK_NOISE BIT(6) | |
240 | #define WPA_BSS_MASK_LEVEL BIT(7) | |
241 | #define WPA_BSS_MASK_TSF BIT(8) | |
242 | #define WPA_BSS_MASK_AGE BIT(9) | |
243 | #define WPA_BSS_MASK_IE BIT(10) | |
244 | #define WPA_BSS_MASK_FLAGS BIT(11) | |
245 | #define WPA_BSS_MASK_SSID BIT(12) | |
246 | #define WPA_BSS_MASK_WPS_SCAN BIT(13) | |
247 | #define WPA_BSS_MASK_P2P_SCAN BIT(14) | |
248 | #define WPA_BSS_MASK_INTERNETW BIT(15) | |
337c781f | 249 | #define WPA_BSS_MASK_WIFI_DISPLAY BIT(16) |
c6673429 | 250 | #define WPA_BSS_MASK_DELIM BIT(17) |
79070906 | 251 | #define WPA_BSS_MASK_MESH_SCAN BIT(18) |
5f97dd1c DS |
252 | |
253 | ||
86bd36f0 JM |
254 | /* VENDOR_ELEM_* frame id values */ |
255 | enum wpa_vendor_elem_frame { | |
256 | VENDOR_ELEM_PROBE_REQ_P2P = 0, | |
257 | VENDOR_ELEM_PROBE_RESP_P2P = 1, | |
258 | VENDOR_ELEM_PROBE_RESP_P2P_GO = 2, | |
259 | VENDOR_ELEM_BEACON_P2P_GO = 3, | |
260 | VENDOR_ELEM_P2P_PD_REQ = 4, | |
261 | VENDOR_ELEM_P2P_PD_RESP = 5, | |
262 | VENDOR_ELEM_P2P_GO_NEG_REQ = 6, | |
263 | VENDOR_ELEM_P2P_GO_NEG_RESP = 7, | |
264 | VENDOR_ELEM_P2P_GO_NEG_CONF = 8, | |
265 | VENDOR_ELEM_P2P_INV_REQ = 9, | |
266 | VENDOR_ELEM_P2P_INV_RESP = 10, | |
267 | VENDOR_ELEM_P2P_ASSOC_REQ = 11, | |
268 | VENDOR_ELEM_P2P_ASSOC_RESP = 12, | |
269 | NUM_VENDOR_ELEM_FRAMES | |
270 | }; | |
271 | ||
272 | ||
6fc6879b JM |
273 | /* wpa_supplicant/hostapd control interface access */ |
274 | ||
275 | /** | |
276 | * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd | |
277 | * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used. | |
278 | * Returns: Pointer to abstract control interface data or %NULL on failure | |
279 | * | |
280 | * This function is used to open a control interface to wpa_supplicant/hostapd. | |
281 | * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path | |
282 | * is configured in wpa_supplicant/hostapd and other programs using the control | |
283 | * interface need to use matching path configuration. | |
284 | */ | |
285 | struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path); | |
286 | ||
287 | ||
288 | /** | |
289 | * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd | |
290 | * @ctrl: Control interface data from wpa_ctrl_open() | |
291 | * | |
292 | * This function is used to close a control interface. | |
293 | */ | |
294 | void wpa_ctrl_close(struct wpa_ctrl *ctrl); | |
295 | ||
296 | ||
297 | /** | |
298 | * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd | |
299 | * @ctrl: Control interface data from wpa_ctrl_open() | |
300 | * @cmd: Command; usually, ASCII text, e.g., "PING" | |
301 | * @cmd_len: Length of the cmd in bytes | |
302 | * @reply: Buffer for the response | |
303 | * @reply_len: Reply buffer length | |
304 | * @msg_cb: Callback function for unsolicited messages or %NULL if not used | |
305 | * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout | |
306 | * | |
307 | * This function is used to send commands to wpa_supplicant/hostapd. Received | |
308 | * response will be written to reply and reply_len is set to the actual length | |
309 | * of the reply. This function will block for up to two seconds while waiting | |
310 | * for the reply. If unsolicited messages are received, the blocking time may | |
311 | * be longer. | |
312 | * | |
313 | * msg_cb can be used to register a callback function that will be called for | |
314 | * unsolicited messages received while waiting for the command response. These | |
315 | * messages may be received if wpa_ctrl_request() is called at the same time as | |
316 | * wpa_supplicant/hostapd is sending such a message. This can happen only if | |
317 | * the program has used wpa_ctrl_attach() to register itself as a monitor for | |
318 | * event messages. Alternatively to msg_cb, programs can register two control | |
319 | * interface connections and use one of them for commands and the other one for | |
320 | * receiving event messages, in other words, call wpa_ctrl_attach() only for | |
321 | * the control interface connection that will be used for event messages. | |
322 | */ | |
323 | int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len, | |
324 | char *reply, size_t *reply_len, | |
325 | void (*msg_cb)(char *msg, size_t len)); | |
326 | ||
327 | ||
328 | /** | |
329 | * wpa_ctrl_attach - Register as an event monitor for the control interface | |
330 | * @ctrl: Control interface data from wpa_ctrl_open() | |
331 | * Returns: 0 on success, -1 on failure, -2 on timeout | |
332 | * | |
333 | * This function registers the control interface connection as a monitor for | |
334 | * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the | |
335 | * control interface connection starts receiving event messages that can be | |
336 | * read with wpa_ctrl_recv(). | |
337 | */ | |
338 | int wpa_ctrl_attach(struct wpa_ctrl *ctrl); | |
339 | ||
340 | ||
341 | /** | |
342 | * wpa_ctrl_detach - Unregister event monitor from the control interface | |
343 | * @ctrl: Control interface data from wpa_ctrl_open() | |
344 | * Returns: 0 on success, -1 on failure, -2 on timeout | |
345 | * | |
346 | * This function unregisters the control interface connection as a monitor for | |
347 | * wpa_supplicant/hostapd events, i.e., cancels the registration done with | |
348 | * wpa_ctrl_attach(). | |
349 | */ | |
350 | int wpa_ctrl_detach(struct wpa_ctrl *ctrl); | |
351 | ||
352 | ||
353 | /** | |
354 | * wpa_ctrl_recv - Receive a pending control interface message | |
355 | * @ctrl: Control interface data from wpa_ctrl_open() | |
356 | * @reply: Buffer for the message data | |
357 | * @reply_len: Length of the reply buffer | |
358 | * Returns: 0 on success, -1 on failure | |
359 | * | |
43f02e6a JM |
360 | * This function will receive a pending control interface message. The received |
361 | * response will be written to reply and reply_len is set to the actual length | |
362 | * of the reply. | |
363 | ||
6fc6879b JM |
364 | * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach() |
365 | * must have been used to register the control interface as an event monitor. | |
366 | */ | |
367 | int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len); | |
368 | ||
369 | ||
370 | /** | |
371 | * wpa_ctrl_pending - Check whether there are pending event messages | |
372 | * @ctrl: Control interface data from wpa_ctrl_open() | |
373 | * Returns: 1 if there are pending messages, 0 if no, or -1 on error | |
374 | * | |
375 | * This function will check whether there are any pending control interface | |
376 | * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is | |
377 | * only used for event messages, i.e., wpa_ctrl_attach() must have been used to | |
378 | * register the control interface as an event monitor. | |
379 | */ | |
380 | int wpa_ctrl_pending(struct wpa_ctrl *ctrl); | |
381 | ||
382 | ||
383 | /** | |
384 | * wpa_ctrl_get_fd - Get file descriptor used by the control interface | |
385 | * @ctrl: Control interface data from wpa_ctrl_open() | |
386 | * Returns: File descriptor used for the connection | |
387 | * | |
388 | * This function can be used to get the file descriptor that is used for the | |
389 | * control interface connection. The returned value can be used, e.g., with | |
390 | * select() while waiting for multiple events. | |
391 | * | |
392 | * The returned file descriptor must not be used directly for sending or | |
393 | * receiving packets; instead, the library functions wpa_ctrl_request() and | |
394 | * wpa_ctrl_recv() must be used for this. | |
395 | */ | |
396 | int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl); | |
397 | ||
ed3eecd7 DS |
398 | #ifdef ANDROID |
399 | /** | |
400 | * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that | |
401 | * may be left over from clients that were previously connected to | |
402 | * wpa_supplicant. This keeps these files from being orphaned in the | |
403 | * event of crashes that prevented them from being removed as part | |
404 | * of the normal orderly shutdown. | |
405 | */ | |
406 | void wpa_ctrl_cleanup(void); | |
407 | #endif /* ANDROID */ | |
408 | ||
6fc6879b | 409 | #ifdef CONFIG_CTRL_IFACE_UDP |
afadf423 | 410 | /* Port range for multiple wpa_supplicant instances and multiple VIFs */ |
6fc6879b | 411 | #define WPA_CTRL_IFACE_PORT 9877 |
afadf423 | 412 | #define WPA_CTRL_IFACE_PORT_LIMIT 50 /* decremented from start */ |
6fc6879b | 413 | #define WPA_GLOBAL_CTRL_IFACE_PORT 9878 |
afadf423 | 414 | #define WPA_GLOBAL_CTRL_IFACE_PORT_LIMIT 20 /* incremented from start */ |
3cea004d TG |
415 | |
416 | char * wpa_ctrl_get_remote_ifname(struct wpa_ctrl *ctrl); | |
6fc6879b JM |
417 | #endif /* CONFIG_CTRL_IFACE_UDP */ |
418 | ||
419 | ||
420 | #ifdef __cplusplus | |
421 | } | |
422 | #endif | |
423 | ||
424 | #endif /* WPA_CTRL_H */ |