[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 "
/** 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 "

/** 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 "

/** 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_NO_MATCH "INTERWORKING-NO-MATCH "
#define INTERWORKING_ALREADY_CONNECTED "INTERWORKING-ALREADY-CONNECTED "

#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 "

/* 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 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 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)


/* 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. This
 * function will block if no messages are available. 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);

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