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