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