[thirdparty/hostap.git] / src / common / wpa_ctrl.h

/*
 * wpa_supplicant/hostapd control interface library
 * Copyright (c) 2004-2006, Jouni Malinen <j@w1.fi>
 *
 * This software may be distributed under the terms of the BSD license.
 * See README for more details.
 */

#ifndef WPA_CTRL_H
#define WPA_CTRL_H

#ifdef  __cplusplus
extern "C" {
#endif

/* wpa_supplicant control interface - fixed message prefixes */

/** Interactive request for identity/password/pin */
#define WPA_CTRL_REQ "CTRL-REQ-"

/** Response to identity/password/pin request */
#define WPA_CTRL_RSP "CTRL-RSP-"

/* Event messages with fixed prefix */
/** Authentication completed successfully and data connection enabled */
#define WPA_EVENT_CONNECTED "CTRL-EVENT-CONNECTED "
/** Disconnected, data connection is not available */
#define WPA_EVENT_DISCONNECTED "CTRL-EVENT-DISCONNECTED "
/** Association rejected during connection attempt */
#define WPA_EVENT_ASSOC_REJECT "CTRL-EVENT-ASSOC-REJECT "
/** wpa_supplicant is exiting */
#define WPA_EVENT_TERMINATING "CTRL-EVENT-TERMINATING "
/** Password change was completed successfully */
#define WPA_EVENT_PASSWORD_CHANGED "CTRL-EVENT-PASSWORD-CHANGED "
/** EAP-Request/Notification received */
#define WPA_EVENT_EAP_NOTIFICATION "CTRL-EVENT-EAP-NOTIFICATION "
/** EAP authentication started (EAP-Request/Identity received) */
#define WPA_EVENT_EAP_STARTED "CTRL-EVENT-EAP-STARTED "
/** EAP method proposed by the server */
#define WPA_EVENT_EAP_PROPOSED_METHOD "CTRL-EVENT-EAP-PROPOSED-METHOD "
/** EAP method selected */
#define WPA_EVENT_EAP_METHOD "CTRL-EVENT-EAP-METHOD "
/** EAP peer certificate from TLS */
#define WPA_EVENT_EAP_PEER_CERT "CTRL-EVENT-EAP-PEER-CERT "
/** EAP TLS certificate chain validation error */
#define WPA_EVENT_EAP_TLS_CERT_ERROR "CTRL-EVENT-EAP-TLS-CERT-ERROR "
/** EAP status */
#define WPA_EVENT_EAP_STATUS "CTRL-EVENT-EAP-STATUS "
/** EAP authentication completed successfully */
#define WPA_EVENT_EAP_SUCCESS "CTRL-EVENT-EAP-SUCCESS "
/** EAP authentication failed (EAP-Failure received) */
#define WPA_EVENT_EAP_FAILURE "CTRL-EVENT-EAP-FAILURE "
/** Network block temporarily disabled (e.g., due to authentication failure) */
#define WPA_EVENT_TEMP_DISABLED "CTRL-EVENT-SSID-TEMP-DISABLED "
/** Temporarily disabled network block re-enabled */
#define WPA_EVENT_REENABLED "CTRL-EVENT-SSID-REENABLED "
/** New scan started */
#define WPA_EVENT_SCAN_STARTED "CTRL-EVENT-SCAN-STARTED "
/** New scan results available */
#define WPA_EVENT_SCAN_RESULTS "CTRL-EVENT-SCAN-RESULTS "
/** Scan command failed */
#define WPA_EVENT_SCAN_FAILED "CTRL-EVENT-SCAN-FAILED "
/** wpa_supplicant state change */
#define WPA_EVENT_STATE_CHANGE "CTRL-EVENT-STATE-CHANGE "
/** A new BSS entry was added (followed by BSS entry id and BSSID) */
#define WPA_EVENT_BSS_ADDED "CTRL-EVENT-BSS-ADDED "
/** A BSS entry was removed (followed by BSS entry id and BSSID) */
#define WPA_EVENT_BSS_REMOVED "CTRL-EVENT-BSS-REMOVED "
/** Change in the signal level was reported by the driver */
#define WPA_EVENT_SIGNAL_CHANGE "CTRL-EVENT-SIGNAL-CHANGE "
/** Regulatory domain channel */
#define WPA_EVENT_REGDOM_CHANGE "CTRL-EVENT-REGDOM-CHANGE "

/** RSN IBSS 4-way handshakes completed with specified peer */
#define IBSS_RSN_COMPLETED "IBSS-RSN-COMPLETED "

/** Notification of frequency conflict due to a concurrent operation.
 *
 * The indicated network is disabled and needs to be re-enabled before it can
 * be used again.
 */
#define WPA_EVENT_FREQ_CONFLICT "CTRL-EVENT-FREQ-CONFLICT "
/** Frequency ranges that the driver recommends to avoid */
#define WPA_EVENT_AVOID_FREQ "CTRL-EVENT-AVOID-FREQ "
/** WPS overlap detected in PBC mode */
#define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED "
/** Available WPS AP with active PBC found in scan results */
#define WPS_EVENT_AP_AVAILABLE_PBC "WPS-AP-AVAILABLE-PBC "
/** Available WPS AP with our address as authorized in scan results */
#define WPS_EVENT_AP_AVAILABLE_AUTH "WPS-AP-AVAILABLE-AUTH "
/** Available WPS AP with recently selected PIN registrar found in scan results
 */
#define WPS_EVENT_AP_AVAILABLE_PIN "WPS-AP-AVAILABLE-PIN "
/** Available WPS AP found in scan results */
#define WPS_EVENT_AP_AVAILABLE "WPS-AP-AVAILABLE "
/** A new credential received */
#define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED "
/** M2D received */
#define WPS_EVENT_M2D "WPS-M2D "
/** WPS registration failed after M2/M2D */
#define WPS_EVENT_FAIL "WPS-FAIL "
/** WPS registration completed successfully */
#define WPS_EVENT_SUCCESS "WPS-SUCCESS "
/** WPS enrollment attempt timed out and was terminated */
#define WPS_EVENT_TIMEOUT "WPS-TIMEOUT "
/* PBC mode was activated */
#define WPS_EVENT_ACTIVE "WPS-PBC-ACTIVE "
/* PBC mode was disabled */
#define WPS_EVENT_DISABLE "WPS-PBC-DISABLE "

#define WPS_EVENT_ENROLLEE_SEEN "WPS-ENROLLEE-SEEN "

#define WPS_EVENT_OPEN_NETWORK "WPS-OPEN-NETWORK "

/* WPS ER events */
#define WPS_EVENT_ER_AP_ADD "WPS-ER-AP-ADD "
#define WPS_EVENT_ER_AP_REMOVE "WPS-ER-AP-REMOVE "
#define WPS_EVENT_ER_ENROLLEE_ADD "WPS-ER-ENROLLEE-ADD "
#define WPS_EVENT_ER_ENROLLEE_REMOVE "WPS-ER-ENROLLEE-REMOVE "
#define WPS_EVENT_ER_AP_SETTINGS "WPS-ER-AP-SETTINGS "
#define WPS_EVENT_ER_SET_SEL_REG "WPS-ER-AP-SET-SEL-REG "

/* MESH events */
#define MESH_GROUP_STARTED "MESH-GROUP-STARTED "
#define MESH_GROUP_REMOVED "MESH-GROUP-REMOVED "
#define MESH_PEER_CONNECTED "MESH-PEER-CONNECTED "
#define MESH_PEER_DISCONNECTED "MESH-PEER-DISCONNECTED "

/* WMM AC events */
#define WMM_AC_EVENT_TSPEC_ADDED "TSPEC-ADDED "
#define WMM_AC_EVENT_TSPEC_REMOVED "TSPEC-REMOVED "
#define WMM_AC_EVENT_TSPEC_REQ_FAILED "TSPEC-REQ-FAILED "

/** P2P device found */
#define P2P_EVENT_DEVICE_FOUND "P2P-DEVICE-FOUND "

/** P2P device lost */
#define P2P_EVENT_DEVICE_LOST "P2P-DEVICE-LOST "

/** A P2P device requested GO negotiation, but we were not ready to start the
 * negotiation */
#define P2P_EVENT_GO_NEG_REQUEST "P2P-GO-NEG-REQUEST "
#define P2P_EVENT_GO_NEG_SUCCESS "P2P-GO-NEG-SUCCESS "
#define P2P_EVENT_GO_NEG_FAILURE "P2P-GO-NEG-FAILURE "
#define P2P_EVENT_GROUP_FORMATION_SUCCESS "P2P-GROUP-FORMATION-SUCCESS "
#define P2P_EVENT_GROUP_FORMATION_FAILURE "P2P-GROUP-FORMATION-FAILURE "
#define P2P_EVENT_GROUP_STARTED "P2P-GROUP-STARTED "
#define P2P_EVENT_GROUP_REMOVED "P2P-GROUP-REMOVED "
#define P2P_EVENT_CROSS_CONNECT_ENABLE "P2P-CROSS-CONNECT-ENABLE "
#define P2P_EVENT_CROSS_CONNECT_DISABLE "P2P-CROSS-CONNECT-DISABLE "
/* parameters: <peer address> <PIN> */
#define P2P_EVENT_PROV_DISC_SHOW_PIN "P2P-PROV-DISC-SHOW-PIN "
/* parameters: <peer address> */
#define P2P_EVENT_PROV_DISC_ENTER_PIN "P2P-PROV-DISC-ENTER-PIN "
/* parameters: <peer address> */
#define P2P_EVENT_PROV_DISC_PBC_REQ "P2P-PROV-DISC-PBC-REQ "
/* parameters: <peer address> */
#define P2P_EVENT_PROV_DISC_PBC_RESP "P2P-PROV-DISC-PBC-RESP "
/* parameters: <peer address> <status> */
#define P2P_EVENT_PROV_DISC_FAILURE "P2P-PROV-DISC-FAILURE"
/* parameters: <freq> <src addr> <dialog token> <update indicator> <TLVs> */
#define P2P_EVENT_SERV_DISC_REQ "P2P-SERV-DISC-REQ "
/* parameters: <src addr> <update indicator> <TLVs> */
#define P2P_EVENT_SERV_DISC_RESP "P2P-SERV-DISC-RESP "
#define P2P_EVENT_INVITATION_RECEIVED "P2P-INVITATION-RECEIVED "
#define P2P_EVENT_INVITATION_RESULT "P2P-INVITATION-RESULT "
#define P2P_EVENT_FIND_STOPPED "P2P-FIND-STOPPED "
#define P2P_EVENT_PERSISTENT_PSK_FAIL "P2P-PERSISTENT-PSK-FAIL id="
#define P2P_EVENT_PRESENCE_RESPONSE "P2P-PRESENCE-RESPONSE "
#define P2P_EVENT_NFC_BOTH_GO "P2P-NFC-BOTH-GO "
#define P2P_EVENT_NFC_PEER_CLIENT "P2P-NFC-PEER-CLIENT "
#define P2P_EVENT_NFC_WHILE_CLIENT "P2P-NFC-WHILE-CLIENT "

/* parameters: <PMF enabled> <timeout in ms> <Session Information URL> */
#define ESS_DISASSOC_IMMINENT "ESS-DISASSOC-IMMINENT "
#define P2P_EVENT_REMOVE_AND_REFORM_GROUP "P2P-REMOVE-AND-REFORM-GROUP "

#define INTERWORKING_AP "INTERWORKING-AP "
#define INTERWORKING_BLACKLISTED "INTERWORKING-BLACKLISTED "
#define INTERWORKING_NO_MATCH "INTERWORKING-NO-MATCH "
#define INTERWORKING_ALREADY_CONNECTED "INTERWORKING-ALREADY-CONNECTED "
#define INTERWORKING_SELECTED "INTERWORKING-SELECTED "

/* Credential block added; parameters: <id> */
#define CRED_ADDED "CRED-ADDED "
/* Credential block modified; parameters: <id> <field> */
#define CRED_MODIFIED "CRED-MODIFIED "
/* Credential block removed; parameters: <id> */
#define CRED_REMOVED "CRED-REMOVED "

#define GAS_RESPONSE_INFO "GAS-RESPONSE-INFO "
/* parameters: <addr> <dialog_token> <freq> */
#define GAS_QUERY_START "GAS-QUERY-START "
/* parameters: <addr> <dialog_token> <freq> <status_code> <result> */
#define GAS_QUERY_DONE "GAS-QUERY-DONE "

#define HS20_SUBSCRIPTION_REMEDIATION "HS20-SUBSCRIPTION-REMEDIATION "
#define HS20_DEAUTH_IMMINENT_NOTICE "HS20-DEAUTH-IMMINENT-NOTICE "

#define EXT_RADIO_WORK_START "EXT-RADIO-WORK-START "
#define EXT_RADIO_WORK_TIMEOUT "EXT-RADIO-WORK-TIMEOUT "

#define RRM_EVENT_NEIGHBOR_REP_RXED "RRM-NEIGHBOR-REP-RECEIVED "
#define RRM_EVENT_NEIGHBOR_REP_FAILED "RRM-NEIGHBOR-REP-REQUEST-FAILED "

/* hostapd control interface - fixed message prefixes */
#define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED "
#define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS "
#define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS "
#define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED "
#define WPS_EVENT_AP_SETUP_UNLOCKED "WPS-AP-SETUP-UNLOCKED "
#define WPS_EVENT_AP_PIN_ENABLED "WPS-AP-PIN-ENABLED "
#define WPS_EVENT_AP_PIN_DISABLED "WPS-AP-PIN-DISABLED "
#define AP_STA_CONNECTED "AP-STA-CONNECTED "
#define AP_STA_DISCONNECTED "AP-STA-DISCONNECTED "

#define AP_REJECTED_MAX_STA "AP-REJECTED-MAX-STA "
#define AP_REJECTED_BLOCKED_STA "AP-REJECTED-BLOCKED-STA "

#define AP_EVENT_ENABLED "AP-ENABLED "
#define AP_EVENT_DISABLED "AP-DISABLED "

#define INTERFACE_ENABLED "INTERFACE-ENABLED "
#define INTERFACE_DISABLED "INTERFACE-DISABLED "

#define ACS_EVENT_STARTED "ACS-STARTED "
#define ACS_EVENT_COMPLETED "ACS-COMPLETED "
#define ACS_EVENT_FAILED "ACS-FAILED "

#define DFS_EVENT_RADAR_DETECTED "DFS-RADAR-DETECTED "
#define DFS_EVENT_NEW_CHANNEL "DFS-NEW-CHANNEL "
#define DFS_EVENT_CAC_START "DFS-CAC-START "
#define DFS_EVENT_CAC_COMPLETED "DFS-CAC-COMPLETED "
#define DFS_EVENT_NOP_FINISHED "DFS-NOP-FINISHED "

#define AP_CSA_FINISHED "AP-CSA-FINISHED "

/* BSS Transition Management Response frame received */
#define BSS_TM_RESP "BSS-TM-RESP "

/* BSS command information masks */

#define WPA_BSS_MASK_ALL		0xFFFDFFFF
#define WPA_BSS_MASK_ID			BIT(0)
#define WPA_BSS_MASK_BSSID		BIT(1)
#define WPA_BSS_MASK_FREQ		BIT(2)
#define WPA_BSS_MASK_BEACON_INT		BIT(3)
#define WPA_BSS_MASK_CAPABILITIES	BIT(4)
#define WPA_BSS_MASK_QUAL		BIT(5)
#define WPA_BSS_MASK_NOISE		BIT(6)
#define WPA_BSS_MASK_LEVEL		BIT(7)
#define WPA_BSS_MASK_TSF		BIT(8)
#define WPA_BSS_MASK_AGE		BIT(9)
#define WPA_BSS_MASK_IE			BIT(10)
#define WPA_BSS_MASK_FLAGS		BIT(11)
#define WPA_BSS_MASK_SSID		BIT(12)
#define WPA_BSS_MASK_WPS_SCAN		BIT(13)
#define WPA_BSS_MASK_P2P_SCAN		BIT(14)
#define WPA_BSS_MASK_INTERNETW		BIT(15)
#define WPA_BSS_MASK_WIFI_DISPLAY	BIT(16)
#define WPA_BSS_MASK_DELIM		BIT(17)
#define WPA_BSS_MASK_MESH_SCAN		BIT(18)


/* VENDOR_ELEM_* frame id values */
enum wpa_vendor_elem_frame {
	VENDOR_ELEM_PROBE_REQ_P2P = 0,
	VENDOR_ELEM_PROBE_RESP_P2P = 1,
	VENDOR_ELEM_PROBE_RESP_P2P_GO = 2,
	VENDOR_ELEM_BEACON_P2P_GO = 3,
	VENDOR_ELEM_P2P_PD_REQ = 4,
	VENDOR_ELEM_P2P_PD_RESP = 5,
	VENDOR_ELEM_P2P_GO_NEG_REQ = 6,
	VENDOR_ELEM_P2P_GO_NEG_RESP = 7,
	VENDOR_ELEM_P2P_GO_NEG_CONF = 8,
	VENDOR_ELEM_P2P_INV_REQ = 9,
	VENDOR_ELEM_P2P_INV_RESP = 10,
	VENDOR_ELEM_P2P_ASSOC_REQ = 11,
	VENDOR_ELEM_P2P_ASSOC_RESP = 12,
	NUM_VENDOR_ELEM_FRAMES
};


/* wpa_supplicant/hostapd control interface access */

/**
 * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd
 * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used.
 * Returns: Pointer to abstract control interface data or %NULL on failure
 *
 * This function is used to open a control interface to wpa_supplicant/hostapd.
 * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path
 * is configured in wpa_supplicant/hostapd and other programs using the control
 * interface need to use matching path configuration.
 */
struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path);


/**
 * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd
 * @ctrl: Control interface data from wpa_ctrl_open()
 *
 * This function is used to close a control interface.
 */
void wpa_ctrl_close(struct wpa_ctrl *ctrl);


/**
 * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd
 * @ctrl: Control interface data from wpa_ctrl_open()
 * @cmd: Command; usually, ASCII text, e.g., "PING"
 * @cmd_len: Length of the cmd in bytes
 * @reply: Buffer for the response
 * @reply_len: Reply buffer length
 * @msg_cb: Callback function for unsolicited messages or %NULL if not used
 * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout
 *
 * This function is used to send commands to wpa_supplicant/hostapd. Received
 * response will be written to reply and reply_len is set to the actual length
 * of the reply. This function will block for up to two seconds while waiting
 * for the reply. If unsolicited messages are received, the blocking time may
 * be longer.
 *
 * msg_cb can be used to register a callback function that will be called for
 * unsolicited messages received while waiting for the command response. These
 * messages may be received if wpa_ctrl_request() is called at the same time as
 * wpa_supplicant/hostapd is sending such a message. This can happen only if
 * the program has used wpa_ctrl_attach() to register itself as a monitor for
 * event messages. Alternatively to msg_cb, programs can register two control
 * interface connections and use one of them for commands and the other one for
 * receiving event messages, in other words, call wpa_ctrl_attach() only for
 * the control interface connection that will be used for event messages.
 */
int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
		     char *reply, size_t *reply_len,
		     void (*msg_cb)(char *msg, size_t len));


/**
 * wpa_ctrl_attach - Register as an event monitor for the control interface
 * @ctrl: Control interface data from wpa_ctrl_open()
 * Returns: 0 on success, -1 on failure, -2 on timeout
 *
 * This function registers the control interface connection as a monitor for
 * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the
 * control interface connection starts receiving event messages that can be
 * read with wpa_ctrl_recv().
 */
int wpa_ctrl_attach(struct wpa_ctrl *ctrl);


/**
 * wpa_ctrl_detach - Unregister event monitor from the control interface
 * @ctrl: Control interface data from wpa_ctrl_open()
 * Returns: 0 on success, -1 on failure, -2 on timeout
 *
 * This function unregisters the control interface connection as a monitor for
 * wpa_supplicant/hostapd events, i.e., cancels the registration done with
 * wpa_ctrl_attach().
 */
int wpa_ctrl_detach(struct wpa_ctrl *ctrl);


/**
 * wpa_ctrl_recv - Receive a pending control interface message
 * @ctrl: Control interface data from wpa_ctrl_open()
 * @reply: Buffer for the message data
 * @reply_len: Length of the reply buffer
 * Returns: 0 on success, -1 on failure
 *
 * This function will receive a pending control interface message. The received
 * response will be written to reply and reply_len is set to the actual length
 * of the reply.

 * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach()
 * must have been used to register the control interface as an event monitor.
 */
int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len);


/**
 * wpa_ctrl_pending - Check whether there are pending event messages
 * @ctrl: Control interface data from wpa_ctrl_open()
 * Returns: 1 if there are pending messages, 0 if no, or -1 on error
 *
 * This function will check whether there are any pending control interface
 * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is
 * only used for event messages, i.e., wpa_ctrl_attach() must have been used to
 * register the control interface as an event monitor.
 */
int wpa_ctrl_pending(struct wpa_ctrl *ctrl);


/**
 * wpa_ctrl_get_fd - Get file descriptor used by the control interface
 * @ctrl: Control interface data from wpa_ctrl_open()
 * Returns: File descriptor used for the connection
 *
 * This function can be used to get the file descriptor that is used for the
 * control interface connection. The returned value can be used, e.g., with
 * select() while waiting for multiple events.
 *
 * The returned file descriptor must not be used directly for sending or
 * receiving packets; instead, the library functions wpa_ctrl_request() and
 * wpa_ctrl_recv() must be used for this.
 */
int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl);

#ifdef ANDROID
/**
 * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that
 * may be left over from clients that were previously connected to
 * wpa_supplicant. This keeps these files from being orphaned in the
 * event of crashes that prevented them from being removed as part
 * of the normal orderly shutdown.
 */
void wpa_ctrl_cleanup(void);
#endif /* ANDROID */

#ifdef CONFIG_CTRL_IFACE_UDP
/* Port range for multiple wpa_supplicant instances and multiple VIFs */
#define WPA_CTRL_IFACE_PORT 9877
#define WPA_CTRL_IFACE_PORT_LIMIT 50 /* decremented from start */
#define WPA_GLOBAL_CTRL_IFACE_PORT 9878
#define WPA_GLOBAL_CTRL_IFACE_PORT_LIMIT 20 /* incremented from start */

char * wpa_ctrl_get_remote_ifname(struct wpa_ctrl *ctrl);
#endif /* CONFIG_CTRL_IFACE_UDP */


#ifdef  __cplusplus
}
#endif

#endif /* WPA_CTRL_H */
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.
0f3d578e JM	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 */
ea78c315 JM	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 */
7796f20e JM	40	#define WPA_EVENT_EAP_PROPOSED_METHOD "CTRL-EVENT-EAP-PROPOSED-METHOD "
6fc6879b JM	41	/** EAP method selected */
6fc6879b JM	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 */
c7a39ba4 CH	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 */
a5f40eff JM	58	#define WPA_EVENT_SCAN_STARTED "CTRL-EVENT-SCAN-STARTED "
6fc6879b JM	59	/** New scan results available */
6fc6879b JM	60	#define WPA_EVENT_SCAN_RESULTS "CTRL-EVENT-SCAN-RESULTS "
d1079219 DS	61	/** Scan command failed */
d1079219 DS	62	#define WPA_EVENT_SCAN_FAILED "CTRL-EVENT-SCAN-FAILED "
4e2ead7a DS	63	/** wpa_supplicant state change */
4e2ead7a DS	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 */
0cd86028 JM	70	#define WPA_EVENT_SIGNAL_CHANGE "CTRL-EVENT-SIGNAL-CHANGE "
142817b2 JM	71	/** Regulatory domain channel */
142817b2 JM	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 */
253f2e37 AH	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 */
a524f05e JM	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 */
31fcea93 JM	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 */
ff8a53a8 JM	97	#define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED "
4b68290e JM	98	/** M2D received */
4b68290e JM	99	#define WPS_EVENT_M2D "WPS-M2D "
469fc3a4 JM	100	/** WPS registration failed after M2/M2D */
469fc3a4 JM	101	#define WPS_EVENT_FAIL "WPS-FAIL "
ad5302a1 JM	102	/** WPS registration completed successfully */
ad5302a1 JM	103	#define WPS_EVENT_SUCCESS "WPS-SUCCESS "
a6099152 JM	104	/** WPS enrollment attempt timed out and was terminated */
a6099152 JM	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 "
c2f51269 JM	112
f981eabc JM	113	#define WPS_EVENT_OPEN_NETWORK "WPS-OPEN-NETWORK "
f981eabc JM	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 "
603a3f34 JL	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
d1f88001 MB	129	/* WMM AC events */
	130	#define WMM_AC_EVENT_TSPEC_ADDED "TSPEC-ADDED "
	131	#define WMM_AC_EVENT_TSPEC_REMOVED "TSPEC-REMOVED "
	132	#define WMM_AC_EVENT_TSPEC_REQ_FAILED "TSPEC-REQ-FAILED "
	133
b22128ef JM	134	/** P2P device found */
b22128ef JM	135	#define P2P_EVENT_DEVICE_FOUND "P2P-DEVICE-FOUND "
3074d8f1 JJ	136
	137	/** P2P device lost */
	138	#define P2P_EVENT_DEVICE_LOST "P2P-DEVICE-LOST "
	139
b22128ef JM	140	/** A P2P device requested GO negotiation, but we were not ready to start the
	141	* negotiation */
	142	#define P2P_EVENT_GO_NEG_REQUEST "P2P-GO-NEG-REQUEST "
	143	#define P2P_EVENT_GO_NEG_SUCCESS "P2P-GO-NEG-SUCCESS "
	144	#define P2P_EVENT_GO_NEG_FAILURE "P2P-GO-NEG-FAILURE "
	145	#define P2P_EVENT_GROUP_FORMATION_SUCCESS "P2P-GROUP-FORMATION-SUCCESS "
	146	#define P2P_EVENT_GROUP_FORMATION_FAILURE "P2P-GROUP-FORMATION-FAILURE "
	147	#define P2P_EVENT_GROUP_STARTED "P2P-GROUP-STARTED "
	148	#define P2P_EVENT_GROUP_REMOVED "P2P-GROUP-REMOVED "
72044390 JM	149	#define P2P_EVENT_CROSS_CONNECT_ENABLE "P2P-CROSS-CONNECT-ENABLE "
72044390 JM	150	#define P2P_EVENT_CROSS_CONNECT_DISABLE "P2P-CROSS-CONNECT-DISABLE "
b22128ef JM	151	/* parameters: <peer address> <PIN> */
	152	#define P2P_EVENT_PROV_DISC_SHOW_PIN "P2P-PROV-DISC-SHOW-PIN "
	153	/* parameters: <peer address> */
	154	#define P2P_EVENT_PROV_DISC_ENTER_PIN "P2P-PROV-DISC-ENTER-PIN "
	155	/* parameters: <peer address> */
	156	#define P2P_EVENT_PROV_DISC_PBC_REQ "P2P-PROV-DISC-PBC-REQ "
	157	/* parameters: <peer address> */
	158	#define P2P_EVENT_PROV_DISC_PBC_RESP "P2P-PROV-DISC-PBC-RESP "
f65a239b DG	159	/* parameters: <peer address> <status> */
f65a239b DG	160	#define P2P_EVENT_PROV_DISC_FAILURE "P2P-PROV-DISC-FAILURE"
b22128ef JM	161	/* parameters: <freq> <src addr> <dialog token> <update indicator> <TLVs> */
	162	#define P2P_EVENT_SERV_DISC_REQ "P2P-SERV-DISC-REQ "
	163	/* parameters: <src addr> <update indicator> <TLVs> */
	164	#define P2P_EVENT_SERV_DISC_RESP "P2P-SERV-DISC-RESP "
	165	#define P2P_EVENT_INVITATION_RECEIVED "P2P-INVITATION-RECEIVED "
	166	#define P2P_EVENT_INVITATION_RESULT "P2P-INVITATION-RESULT "
8aebb0e4	167	#define P2P_EVENT_FIND_STOPPED "P2P-FIND-STOPPED "
5bf9a6c8	168	#define P2P_EVENT_PERSISTENT_PSK_FAIL "P2P-PERSISTENT-PSK-FAIL id="
c64e3a08	169	#define P2P_EVENT_PRESENCE_RESPONSE "P2P-PRESENCE-RESPONSE "
74df9ecd	170	#define P2P_EVENT_NFC_BOTH_GO "P2P-NFC-BOTH-GO "
59b45d1a JM	171	#define P2P_EVENT_NFC_PEER_CLIENT "P2P-NFC-PEER-CLIENT "
59b45d1a JM	172	#define P2P_EVENT_NFC_WHILE_CLIENT "P2P-NFC-WHILE-CLIENT "
b22128ef	173
ae8535b6 JM	174	/* parameters: <PMF enabled> <timeout in ms> <Session Information URL> */
ae8535b6 JM	175	#define ESS_DISASSOC_IMMINENT "ESS-DISASSOC-IMMINENT "
253f2e37	176	#define P2P_EVENT_REMOVE_AND_REFORM_GROUP "P2P-REMOVE-AND-REFORM-GROUP "
ae8535b6	177
b02fe7ff	178	#define INTERWORKING_AP "INTERWORKING-AP "
28f2a7c4	179	#define INTERWORKING_BLACKLISTED "INTERWORKING-BLACKLISTED "
b02fe7ff	180	#define INTERWORKING_NO_MATCH "INTERWORKING-NO-MATCH "
d28f4e44	181	#define INTERWORKING_ALREADY_CONNECTED "INTERWORKING-ALREADY-CONNECTED "
76a55a8e	182	#define INTERWORKING_SELECTED "INTERWORKING-SELECTED "
b02fe7ff	183
1619e9d5 JM	184	/* Credential block added; parameters: <id> */
	185	#define CRED_ADDED "CRED-ADDED "
	186	/* Credential block modified; parameters: <id> <field> */
	187	#define CRED_MODIFIED "CRED-MODIFIED "
	188	/* Credential block removed; parameters: <id> */
	189	#define CRED_REMOVED "CRED-REMOVED "
	190
b1f12296	191	#define GAS_RESPONSE_INFO "GAS-RESPONSE-INFO "
6ffa1687 JM	192	/* parameters: <addr> <dialog_token> <freq> */
	193	#define GAS_QUERY_START "GAS-QUERY-START "
	194	/* parameters: <addr> <dialog_token> <freq> <status_code> <result> */
	195	#define GAS_QUERY_DONE "GAS-QUERY-DONE "
b1f12296	196
95a3ea94	197	#define HS20_SUBSCRIPTION_REMEDIATION "HS20-SUBSCRIPTION-REMEDIATION "
7ef69479	198	#define HS20_DEAUTH_IMMINENT_NOTICE "HS20-DEAUTH-IMMINENT-NOTICE "
95a3ea94	199
1f965e62 JM	200	#define EXT_RADIO_WORK_START "EXT-RADIO-WORK-START "
	201	#define EXT_RADIO_WORK_TIMEOUT "EXT-RADIO-WORK-TIMEOUT "
	202
f4b8bfae AK	203	#define RRM_EVENT_NEIGHBOR_REP_RXED "RRM-NEIGHBOR-REP-RECEIVED "
	204	#define RRM_EVENT_NEIGHBOR_REP_FAILED "RRM-NEIGHBOR-REP-REQUEST-FAILED "
	205
ad08c363 JM	206	/* hostapd control interface - fixed message prefixes */
	207	#define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED "
	208	#define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS "
aabe26a1	209	#define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS "
3b2cf800	210	#define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED "
94481410	211	#define WPS_EVENT_AP_SETUP_UNLOCKED "WPS-AP-SETUP-UNLOCKED "
5a1cc30f JM	212	#define WPS_EVENT_AP_PIN_ENABLED "WPS-AP-PIN-ENABLED "
5a1cc30f JM	213	#define WPS_EVENT_AP_PIN_DISABLED "WPS-AP-PIN-DISABLED "
20bd9547 JM	214	#define AP_STA_CONNECTED "AP-STA-CONNECTED "
20bd9547 JM	215	#define AP_STA_DISCONNECTED "AP-STA-DISCONNECTED "
ad08c363	216
3140803b RM	217	#define AP_REJECTED_MAX_STA "AP-REJECTED-MAX-STA "
3140803b RM	218	#define AP_REJECTED_BLOCKED_STA "AP-REJECTED-BLOCKED-STA "
6fc6879b	219
7d6d7370 JM	220	#define AP_EVENT_ENABLED "AP-ENABLED "
	221	#define AP_EVENT_DISABLED "AP-DISABLED "
	222
ab93fdeb JM	223	#define INTERFACE_ENABLED "INTERFACE-ENABLED "
	224	#define INTERFACE_DISABLED "INTERFACE-DISABLED "
	225
ae134e1d JM	226	#define ACS_EVENT_STARTED "ACS-STARTED "
	227	#define ACS_EVENT_COMPLETED "ACS-COMPLETED "
	228	#define ACS_EVENT_FAILED "ACS-FAILED "
	229
186c9059 JM	230	#define DFS_EVENT_RADAR_DETECTED "DFS-RADAR-DETECTED "
	231	#define DFS_EVENT_NEW_CHANNEL "DFS-NEW-CHANNEL "
	232	#define DFS_EVENT_CAC_START "DFS-CAC-START "
	233	#define DFS_EVENT_CAC_COMPLETED "DFS-CAC-COMPLETED "
	234	#define DFS_EVENT_NOP_FINISHED "DFS-NOP-FINISHED "
	235
bf281c12 AO	236	#define AP_CSA_FINISHED "AP-CSA-FINISHED "
bf281c12 AO	237
53514800 JM	238	/* BSS Transition Management Response frame received */
	239	#define BSS_TM_RESP "BSS-TM-RESP "
	240
5f97dd1c DS	241	/* BSS command information masks */
5f97dd1c DS	242
c6673429	243	#define WPA_BSS_MASK_ALL 0xFFFDFFFF
5f97dd1c DS	244	#define WPA_BSS_MASK_ID BIT(0)
	245	#define WPA_BSS_MASK_BSSID BIT(1)
	246	#define WPA_BSS_MASK_FREQ BIT(2)
	247	#define WPA_BSS_MASK_BEACON_INT BIT(3)
	248	#define WPA_BSS_MASK_CAPABILITIES BIT(4)
	249	#define WPA_BSS_MASK_QUAL BIT(5)
	250	#define WPA_BSS_MASK_NOISE BIT(6)
	251	#define WPA_BSS_MASK_LEVEL BIT(7)
	252	#define WPA_BSS_MASK_TSF BIT(8)
	253	#define WPA_BSS_MASK_AGE BIT(9)
	254	#define WPA_BSS_MASK_IE BIT(10)
	255	#define WPA_BSS_MASK_FLAGS BIT(11)
	256	#define WPA_BSS_MASK_SSID BIT(12)
	257	#define WPA_BSS_MASK_WPS_SCAN BIT(13)
	258	#define WPA_BSS_MASK_P2P_SCAN BIT(14)
	259	#define WPA_BSS_MASK_INTERNETW BIT(15)
337c781f	260	#define WPA_BSS_MASK_WIFI_DISPLAY BIT(16)
c6673429	261	#define WPA_BSS_MASK_DELIM BIT(17)
79070906	262	#define WPA_BSS_MASK_MESH_SCAN BIT(18)
5f97dd1c DS	263
5f97dd1c DS	264
86bd36f0 JM	265	/* VENDOR_ELEM_* frame id values */
	266	enum wpa_vendor_elem_frame {
	267	VENDOR_ELEM_PROBE_REQ_P2P = 0,
	268	VENDOR_ELEM_PROBE_RESP_P2P = 1,
	269	VENDOR_ELEM_PROBE_RESP_P2P_GO = 2,
	270	VENDOR_ELEM_BEACON_P2P_GO = 3,
	271	VENDOR_ELEM_P2P_PD_REQ = 4,
	272	VENDOR_ELEM_P2P_PD_RESP = 5,
	273	VENDOR_ELEM_P2P_GO_NEG_REQ = 6,
	274	VENDOR_ELEM_P2P_GO_NEG_RESP = 7,
	275	VENDOR_ELEM_P2P_GO_NEG_CONF = 8,
	276	VENDOR_ELEM_P2P_INV_REQ = 9,
	277	VENDOR_ELEM_P2P_INV_RESP = 10,
	278	VENDOR_ELEM_P2P_ASSOC_REQ = 11,
	279	VENDOR_ELEM_P2P_ASSOC_RESP = 12,
	280	NUM_VENDOR_ELEM_FRAMES
	281	};
	282
	283
6fc6879b JM	284	/* wpa_supplicant/hostapd control interface access */
	285
	286	/**
	287	* wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd
	288	* @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used.
	289	* Returns: Pointer to abstract control interface data or %NULL on failure
	290	*
	291	* This function is used to open a control interface to wpa_supplicant/hostapd.
	292	* ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path
	293	* is configured in wpa_supplicant/hostapd and other programs using the control
	294	* interface need to use matching path configuration.
	295	*/
	296	struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path);
	297
	298
	299	/**
	300	* wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd
	301	* @ctrl: Control interface data from wpa_ctrl_open()
	302	*
	303	* This function is used to close a control interface.
	304	*/
	305	void wpa_ctrl_close(struct wpa_ctrl *ctrl);
	306
	307
	308	/**
	309	* wpa_ctrl_request - Send a command to wpa_supplicant/hostapd
	310	* @ctrl: Control interface data from wpa_ctrl_open()
	311	* @cmd: Command; usually, ASCII text, e.g., "PING"
	312	* @cmd_len: Length of the cmd in bytes
	313	* @reply: Buffer for the response
	314	* @reply_len: Reply buffer length
	315	* @msg_cb: Callback function for unsolicited messages or %NULL if not used
	316	* Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout
	317	*
	318	* This function is used to send commands to wpa_supplicant/hostapd. Received
	319	* response will be written to reply and reply_len is set to the actual length
	320	* of the reply. This function will block for up to two seconds while waiting
	321	* for the reply. If unsolicited messages are received, the blocking time may
	322	* be longer.
	323	*
	324	* msg_cb can be used to register a callback function that will be called for
	325	* unsolicited messages received while waiting for the command response. These
	326	* messages may be received if wpa_ctrl_request() is called at the same time as
	327	* wpa_supplicant/hostapd is sending such a message. This can happen only if
	328	* the program has used wpa_ctrl_attach() to register itself as a monitor for
	329	* event messages. Alternatively to msg_cb, programs can register two control
	330	* interface connections and use one of them for commands and the other one for
	331	* receiving event messages, in other words, call wpa_ctrl_attach() only for
	332	* the control interface connection that will be used for event messages.
	333	*/
	334	int wpa_ctrl_request(struct wpa_ctrl ctrl, const char cmd, size_t cmd_len,
	335	char reply, size_t reply_len,
	336	void (msg_cb)(char msg, size_t len));
	337
	338
	339	/**
	340	* wpa_ctrl_attach - Register as an event monitor for the control interface
	341	* @ctrl: Control interface data from wpa_ctrl_open()
	342	* Returns: 0 on success, -1 on failure, -2 on timeout
	343	*
	344	* This function registers the control interface connection as a monitor for
	345	* wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the
	346	* control interface connection starts receiving event messages that can be
	347	* read with wpa_ctrl_recv().
348	*/
349	int wpa_ctrl_attach(struct wpa_ctrl *ctrl);
350
351
352	/**
353	* wpa_ctrl_detach - Unregister event monitor from the control interface
354	* @ctrl: Control interface data from wpa_ctrl_open()
355	* Returns: 0 on success, -1 on failure, -2 on timeout
356	*
357	* This function unregisters the control interface connection as a monitor for
358	* wpa_supplicant/hostapd events, i.e., cancels the registration done with
359	* wpa_ctrl_attach().
360	*/
361	int wpa_ctrl_detach(struct wpa_ctrl *ctrl);
362
363
364	/**
365	* wpa_ctrl_recv - Receive a pending control interface message
366	* @ctrl: Control interface data from wpa_ctrl_open()
367	* @reply: Buffer for the message data
368	* @reply_len: Length of the reply buffer
369	* Returns: 0 on success, -1 on failure
370	*
43f02e6a JM	371	* This function will receive a pending control interface message. The received
	372	* response will be written to reply and reply_len is set to the actual length
	373	* of the reply.
	374
6fc6879b JM	375	* wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach()
	376	* must have been used to register the control interface as an event monitor.
	377	*/
	378	int wpa_ctrl_recv(struct wpa_ctrl ctrl, char reply, size_t *reply_len);
	379
	380
	381	/**
	382	* wpa_ctrl_pending - Check whether there are pending event messages
	383	* @ctrl: Control interface data from wpa_ctrl_open()
	384	* Returns: 1 if there are pending messages, 0 if no, or -1 on error
	385	*
	386	* This function will check whether there are any pending control interface
	387	* message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is
	388	* only used for event messages, i.e., wpa_ctrl_attach() must have been used to
	389	* register the control interface as an event monitor.
	390	*/
	391	int wpa_ctrl_pending(struct wpa_ctrl *ctrl);
	392
	393
	394	/**
	395	* wpa_ctrl_get_fd - Get file descriptor used by the control interface
	396	* @ctrl: Control interface data from wpa_ctrl_open()
	397	* Returns: File descriptor used for the connection
	398	*
	399	* This function can be used to get the file descriptor that is used for the
	400	* control interface connection. The returned value can be used, e.g., with
	401	* select() while waiting for multiple events.
	402	*
	403	* The returned file descriptor must not be used directly for sending or
	404	* receiving packets; instead, the library functions wpa_ctrl_request() and
	405	* wpa_ctrl_recv() must be used for this.
	406	*/
	407	int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl);
	408
ed3eecd7 DS	409	#ifdef ANDROID
	410	/**
	411	* wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that
	412	* may be left over from clients that were previously connected to
	413	* wpa_supplicant. This keeps these files from being orphaned in the
	414	* event of crashes that prevented them from being removed as part
	415	* of the normal orderly shutdown.
	416	*/
	417	void wpa_ctrl_cleanup(void);
	418	#endif /* ANDROID */
	419
6fc6879b	420	#ifdef CONFIG_CTRL_IFACE_UDP
afadf423	421	/* Port range for multiple wpa_supplicant instances and multiple VIFs */
6fc6879b	422	#define WPA_CTRL_IFACE_PORT 9877
afadf423	423	#define WPA_CTRL_IFACE_PORT_LIMIT 50 /* decremented from start */
6fc6879b	424	#define WPA_GLOBAL_CTRL_IFACE_PORT 9878
afadf423	425	#define WPA_GLOBAL_CTRL_IFACE_PORT_LIMIT 20 /* incremented from start */
3cea004d TG	426
3cea004d TG	427	char * wpa_ctrl_get_remote_ifname(struct wpa_ctrl *ctrl);
6fc6879b JM	428	#endif /* CONFIG_CTRL_IFACE_UDP */
	429
	430
	431	#ifdef __cplusplus
	432	}
	433	#endif
	434
	435	#endif /* WPA_CTRL_H */