1/*
2 * Wi-Fi Direct - P2P module
3 * Copyright (c) 2009-2010, Atheros Communications
4 *
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
7 */
8
9#ifndef P2P_H
10#define P2P_H
11
12#include "common/ieee802_11_defs.h"
13#include "wps/wps.h"
14
15/* P2P ASP Setup Capability */
16#define P2PS_SETUP_NONE 0
17#define P2PS_SETUP_NEW BIT(0)
18#define P2PS_SETUP_CLIENT BIT(1)
19#define P2PS_SETUP_GROUP_OWNER BIT(2)
20
21#define P2PS_WILD_HASH_STR "org.wi-fi.wfds"
22#define P2PS_HASH_LEN 6
23#define P2P_MAX_QUERY_HASH 6
24#define P2PS_FEATURE_CAPAB_CPT_MAX 2
25
26/**
27 * P2P_MAX_PREF_CHANNELS - Maximum number of preferred channels
28 */
29#define P2P_MAX_PREF_CHANNELS 100
30
31/**
32 * P2P_MAX_REG_CLASSES - Maximum number of regulatory classes
33 */
34#define P2P_MAX_REG_CLASSES 15
35
36/**
37 * P2P_MAX_REG_CLASS_CHANNELS - Maximum number of channels per regulatory class
38 */
39#define P2P_MAX_REG_CLASS_CHANNELS 20
40
41/**
42 * struct p2p_channels - List of supported channels
43 */
44struct p2p_channels {
45	/**
46	 * struct p2p_reg_class - Supported regulatory class
47	 */
48	struct p2p_reg_class {
49		/**
50		 * reg_class - Regulatory class (IEEE 802.11-2007, Annex J)
51		 */
52		u8 reg_class;
53
54		/**
55		 * channel - Supported channels
56		 */
57		u8 channel[P2P_MAX_REG_CLASS_CHANNELS];
58
59		/**
60		 * channels - Number of channel entries in use
61		 */
62		size_t channels;
63	} reg_class[P2P_MAX_REG_CLASSES];
64
65	/**
66	 * reg_classes - Number of reg_class entries in use
67	 */
68	size_t reg_classes;
69};
70
71enum p2p_wps_method {
72	WPS_NOT_READY, WPS_PIN_DISPLAY, WPS_PIN_KEYPAD, WPS_PBC, WPS_NFC,
73	WPS_P2PS
74};
75
76/**
77 * struct p2p_go_neg_results - P2P Group Owner Negotiation results
78 */
79struct p2p_go_neg_results {
80	/**
81	 * status - Negotiation result (Status Code)
82	 *
83	 * 0 (P2P_SC_SUCCESS) indicates success. Non-zero values indicate
84	 * failed negotiation.
85	 */
86	int status;
87
88	/**
89	 * role_go - Whether local end is Group Owner
90	 */
91	int role_go;
92
93	/**
94	 * freq - Frequency of the group operational channel in MHz
95	 */
96	int freq;
97
98	int ht40;
99
100	int vht;
101
102	u8 max_oper_chwidth;
103
104	unsigned int vht_center_freq2;
105
106	/**
107	 * he - Indicates if IEEE 802.11ax HE is enabled
108	 */
109	int he;
110
111	/**
112	 * ssid - SSID of the group
113	 */
114	u8 ssid[SSID_MAX_LEN];
115
116	/**
117	 * ssid_len - Length of SSID in octets
118	 */
119	size_t ssid_len;
120
121	/**
122	 * psk - WPA pre-shared key (256 bits) (GO only)
123	 */
124	u8 psk[32];
125
126	/**
127	 * psk_set - Whether PSK field is configured (GO only)
128	 */
129	int psk_set;
130
131	/**
132	 * passphrase - WPA2-Personal passphrase for the group (GO only)
133	 */
134	char passphrase[64];
135
136	/**
137	 * peer_device_addr - P2P Device Address of the peer
138	 */
139	u8 peer_device_addr[ETH_ALEN];
140
141	/**
142	 * peer_interface_addr - P2P Interface Address of the peer
143	 */
144	u8 peer_interface_addr[ETH_ALEN];
145
146	/**
147	 * wps_method - WPS method to be used during provisioning
148	 */
149	enum p2p_wps_method wps_method;
150
151#define P2P_MAX_CHANNELS 50
152
153	/**
154	 * freq_list - Zero-terminated list of possible operational channels
155	 */
156	int freq_list[P2P_MAX_CHANNELS];
157
158	/**
159	 * persistent_group - Whether the group should be made persistent
160	 * 0 = not persistent
161	 * 1 = persistent group without persistent reconnect
162	 * 2 = persistent group with persistent reconnect
163	 */
164	int persistent_group;
165
166	/**
167	 * peer_config_timeout - Peer configuration timeout (in 10 msec units)
168	 */
169	unsigned int peer_config_timeout;
170};
171
172struct p2ps_provision {
173	/**
174	 * pd_seeker - P2PS provision discovery seeker role
175	 */
176	unsigned int pd_seeker:1;
177
178	/**
179	 * status - Remote returned provisioning status code
180	 */
181	int status;
182
183	/**
184	 * adv_id - P2PS Advertisement ID
185	 */
186	u32 adv_id;
187
188	/**
189	 * session_id - P2PS Session ID
190	 */
191	u32 session_id;
192
193	/**
194	 * method - WPS Method (to be) used to establish session
195	 */
196	u16 method;
197
198	/**
199	 * conncap - Connection Capabilities negotiated between P2P peers
200	 */
201	u8 conncap;
202
203	/**
204	 * role - Info about the roles to be used for this connection
205	 */
206	u8 role;
207
208	/**
209	 * session_mac - MAC address of the peer that started the session
210	 */
211	u8 session_mac[ETH_ALEN];
212
213	/**
214	 * adv_mac - MAC address of the peer advertised the service
215	 */
216	u8 adv_mac[ETH_ALEN];
217
218	/**
219	 * cpt_mask - Supported Coordination Protocol Transport mask
220	 *
221	 * A bitwise mask of supported ASP Coordination Protocol Transports.
222	 * This property is set together and corresponds with cpt_priority.
223	 */
224	u8 cpt_mask;
225
226	/**
227	 * cpt_priority - Coordination Protocol Transport priority list
228	 *
229	 * Priorities of supported ASP Coordination Protocol Transports.
230	 * This property is set together and corresponds with cpt_mask.
231	 * The CPT priority list is 0 terminated.
232	 */
233	u8 cpt_priority[P2PS_FEATURE_CAPAB_CPT_MAX + 1];
234
235	/**
236	 * force_freq - The only allowed channel frequency in MHz or 0.
237	 */
238	unsigned int force_freq;
239
240	/**
241	 * pref_freq - Preferred operating frequency in MHz or 0.
242	 */
243	unsigned int pref_freq;
244
245	/**
246	 * info - Vendor defined extra Provisioning information
247	 */
248	char info[0];
249};
250
251struct p2ps_advertisement {
252	struct p2ps_advertisement *next;
253
254	/**
255	 * svc_info - Pointer to (internal) Service defined information
256	 */
257	char *svc_info;
258
259	/**
260	 * id - P2PS Advertisement ID
261	 */
262	u32 id;
263
264	/**
265	 * config_methods - WPS Methods which are allowed for this service
266	 */
267	u16 config_methods;
268
269	/**
270	 * state - Current state of the service: 0 - Out Of Service, 1-255 Vendor defined
271	 */
272	u8 state;
273
274	/**
275	 * auto_accept - Automatically Accept provisioning request if possible.
276	 */
277	u8 auto_accept;
278
279	/**
280	 * hash - 6 octet Service Name has to match against incoming Probe Requests
281	 */
282	u8 hash[P2PS_HASH_LEN];
283
284	/**
285	 * cpt_mask - supported Coordination Protocol Transport mask
286	 *
287	 * A bitwise mask of supported ASP Coordination Protocol Transports.
288	 * This property is set together and corresponds with cpt_priority.
289	 */
290	u8 cpt_mask;
291
292	/**
293	 * cpt_priority - Coordination Protocol Transport priority list
294	 *
295	 * Priorities of supported ASP Coordinatin Protocol Transports.
296	 * This property is set together and corresponds with cpt_mask.
297	 * The CPT priority list is 0 terminated.
298	 */
299	u8 cpt_priority[P2PS_FEATURE_CAPAB_CPT_MAX + 1];
300
301	/**
302	 * svc_name - NULL Terminated UTF-8 Service Name, and svc_info storage
303	 */
304	char svc_name[0];
305};
306
307
308struct p2p_data;
309
310enum p2p_scan_type {
311	P2P_SCAN_SOCIAL,
312	P2P_SCAN_FULL,
313	P2P_SCAN_SPECIFIC,
314	P2P_SCAN_SOCIAL_PLUS_ONE
315};
316
317#define P2P_MAX_WPS_VENDOR_EXT 10
318
319/**
320 * struct p2p_peer_info - P2P peer information
321 */
322struct p2p_peer_info {
323	/**
324	 * p2p_device_addr - P2P Device Address of the peer
325	 */
326	u8 p2p_device_addr[ETH_ALEN];
327
328	/**
329	 * pri_dev_type - Primary Device Type
330	 */
331	u8 pri_dev_type[8];
332
333	/**
334	 * device_name - Device Name (0..32 octets encoded in UTF-8)
335	 */
336	char device_name[WPS_DEV_NAME_MAX_LEN + 1];
337
338	/**
339	 * manufacturer - Manufacturer (0..64 octets encoded in UTF-8)
340	 */
341	char manufacturer[WPS_MANUFACTURER_MAX_LEN + 1];
342
343	/**
344	 * model_name - Model Name (0..32 octets encoded in UTF-8)
345	 */
346	char model_name[WPS_MODEL_NAME_MAX_LEN + 1];
347
348	/**
349	 * model_number - Model Number (0..32 octets encoded in UTF-8)
350	 */
351	char model_number[WPS_MODEL_NUMBER_MAX_LEN + 1];
352
353	/**
354	 * serial_number - Serial Number (0..32 octets encoded in UTF-8)
355	 */
356	char serial_number[WPS_SERIAL_NUMBER_MAX_LEN + 1];
357
358	/**
359	 * level - Signal level
360	 */
361	int level;
362
363	/**
364	 * config_methods - WPS Configuration Methods
365	 */
366	u16 config_methods;
367
368	/**
369	 * dev_capab - Device Capabilities
370	 */
371	u8 dev_capab;
372
373	/**
374	 * group_capab - Group Capabilities
375	 */
376	u8 group_capab;
377
378	/**
379	 * wps_sec_dev_type_list - WPS secondary device type list
380	 *
381	 * This list includes from 0 to 16 Secondary Device Types as indicated
382	 * by wps_sec_dev_type_list_len (8 * number of types).
383	 */
384	u8 wps_sec_dev_type_list[WPS_SEC_DEV_TYPE_MAX_LEN];
385
386	/**
387	 * wps_sec_dev_type_list_len - Length of secondary device type list
388	 */
389	size_t wps_sec_dev_type_list_len;
390
391	struct wpabuf *wps_vendor_ext[P2P_MAX_WPS_VENDOR_EXT];
392
393	/**
394	 * wfd_subelems - Wi-Fi Display subelements from WFD IE(s)
395	 */
396	struct wpabuf *wfd_subelems;
397
398	/**
399	 * vendor_elems - Unrecognized vendor elements
400	 *
401	 * This buffer includes any other vendor element than P2P, WPS, and WFD
402	 * IE(s) from the frame that was used to discover the peer.
403	 */
404	struct wpabuf *vendor_elems;
405
406	/**
407	 * p2ps_instance - P2PS Application Service Info
408	 */
409	struct wpabuf *p2ps_instance;
410};
411
412enum p2p_prov_disc_status {
413	P2P_PROV_DISC_SUCCESS,
414	P2P_PROV_DISC_TIMEOUT,
415	P2P_PROV_DISC_REJECTED,
416	P2P_PROV_DISC_TIMEOUT_JOIN,
417	P2P_PROV_DISC_INFO_UNAVAILABLE,
418};
419
420struct p2p_channel {
421	u8 op_class;
422	u8 chan;
423};
424
425/**
426 * struct p2p_config - P2P configuration
427 *
428 * This configuration is provided to the P2P module during initialization with
429 * p2p_init().
430 */
431struct p2p_config {
432	/**
433	 * country - Country code to use in P2P operations
434	 */
435	char country[3];
436
437	/**
438	 * reg_class - Regulatory class for own listen channel
439	 */
440	u8 reg_class;
441
442	/**
443	 * channel - Own listen channel
444	 */
445	u8 channel;
446
447	/**
448	 * channel_forced - the listen channel was forced by configuration
449	 *                  or by control interface and cannot be overridden
450	 */
451	u8 channel_forced;
452
453	/**
454	 * Regulatory class for own operational channel
455	 */
456	u8 op_reg_class;
457
458	/**
459	 * op_channel - Own operational channel
460	 */
461	u8 op_channel;
462
463	/**
464	 * cfg_op_channel - Whether op_channel is hardcoded in configuration
465	 */
466	u8 cfg_op_channel;
467
468	/**
469	 * channels - Own supported regulatory classes and channels
470	 *
471	 * List of supposerted channels per regulatory class. The regulatory
472	 * classes are defined in IEEE Std 802.11-2007 Annex J and the
473	 * numbering of the clases depends on the configured country code.
474	 */
475	struct p2p_channels channels;
476
477	/**
478	 * cli_channels - Additional client channels
479	 *
480	 * This list of channels (if any) will be used when advertising local
481	 * channels during GO Negotiation or Invitation for the cases where the
482	 * local end may become the client. This may allow the peer to become a
483	 * GO on additional channels if it supports these options. The main use
484	 * case for this is to include passive-scan channels on devices that may
485	 * not know their current location and have configured most channels to
486	 * not allow initiation of radition (i.e., another device needs to take
487	 * master responsibilities).
488	 */
489	struct p2p_channels cli_channels;
490
491	/**
492	 * num_pref_chan - Number of pref_chan entries
493	 */
494	unsigned int num_pref_chan;
495
496	/**
497	 * pref_chan - Preferred channels for GO Negotiation
498	 */
499	struct p2p_channel *pref_chan;
500
501	/**
502	 * pri_dev_type - Primary Device Type (see WPS)
503	 */
504	u8 pri_dev_type[8];
505
506	/**
507	 * P2P_SEC_DEVICE_TYPES - Maximum number of secondary device types
508	 */
509#define P2P_SEC_DEVICE_TYPES 5
510
511	/**
512	 * sec_dev_type - Optional secondary device types
513	 */
514	u8 sec_dev_type[P2P_SEC_DEVICE_TYPES][8];
515
516	/**
517	 * num_sec_dev_types - Number of sec_dev_type entries
518	 */
519	size_t num_sec_dev_types;
520
521	/**
522	 * dev_addr - P2P Device Address
523	 */
524	u8 dev_addr[ETH_ALEN];
525
526	/**
527	 * dev_name - Device Name
528	 */
529	char *dev_name;
530
531	char *manufacturer;
532	char *model_name;
533	char *model_number;
534	char *serial_number;
535
536	u8 uuid[16];
537	u16 config_methods;
538
539	/**
540	 * concurrent_operations - Whether concurrent operations are supported
541	 */
542	int concurrent_operations;
543
544	/**
545	 * max_peers - Maximum number of discovered peers to remember
546	 *
547	 * If more peers are discovered, older entries will be removed to make
548	 * room for the new ones.
549	 */
550	size_t max_peers;
551
552	/**
553	 * p2p_intra_bss - Intra BSS communication is supported
554	 */
555	int p2p_intra_bss;
556
557	/**
558	 * ssid_postfix - Postfix data to add to the SSID
559	 *
560	 * This data will be added to the end of the SSID after the
561	 * DIRECT-<random two octets> prefix.
562	 */
563	u8 ssid_postfix[SSID_MAX_LEN - 9];
564
565	/**
566	 * ssid_postfix_len - Length of the ssid_postfix data
567	 */
568	size_t ssid_postfix_len;
569
570	/**
571	 * max_listen - Maximum listen duration in ms
572	 */
573	unsigned int max_listen;
574
575	/**
576	 * passphrase_len - Passphrase length (8..63)
577	 *
578	 * This parameter controls the length of the random passphrase that is
579	 * generated at the GO.
580	 */
581	unsigned int passphrase_len;
582
583	/**
584	 * cb_ctx - Context to use with callback functions
585	 */
586	void *cb_ctx;
587
588	/**
589	 * debug_print - Debug print
590	 * @ctx: Callback context from cb_ctx
591	 * @level: Debug verbosity level (MSG_*)
592	 * @msg: Debug message
593	 */
594	void (*debug_print)(void *ctx, int level, const char *msg);
595
596
597	/* Callbacks to request lower layer driver operations */
598
599	/**
600	 * p2p_scan - Request a P2P scan/search
601	 * @ctx: Callback context from cb_ctx
602	 * @type: Scan type
603	 * @freq: Specific frequency (MHz) to scan or 0 for no restriction
604	 * @num_req_dev_types: Number of requested device types
605	 * @req_dev_types: Array containing requested device types
606	 * @dev_id: Device ID to search for or %NULL to find all devices
607	 * @pw_id: Device Password ID
608	 * Returns: 0 on success, -1 on failure
609	 *
610	 * This callback function is used to request a P2P scan or search
611	 * operation to be completed. Type type argument specifies which type
612	 * of scan is to be done. @P2P_SCAN_SOCIAL indicates that only the
613	 * social channels (1, 6, 11) should be scanned. @P2P_SCAN_FULL
614	 * indicates that all channels are to be scanned. @P2P_SCAN_SPECIFIC
615	 * request a scan of a single channel specified by freq.
616	 * @P2P_SCAN_SOCIAL_PLUS_ONE request scan of all the social channels
617	 * plus one extra channel specified by freq.
618	 *
619	 * The full scan is used for the initial scan to find group owners from
620	 * all. The other types are used during search phase scan of the social
621	 * channels (with potential variation if the Listen channel of the
622	 * target peer is known or if other channels are scanned in steps).
623	 *
624	 * The scan results are returned after this call by calling
625	 * p2p_scan_res_handler() for each scan result that has a P2P IE and
626	 * then calling p2p_scan_res_handled() to indicate that all scan
627	 * results have been indicated.
628	 */
629	int (*p2p_scan)(void *ctx, enum p2p_scan_type type, int freq,
630			unsigned int num_req_dev_types,
631			const u8 *req_dev_types, const u8 *dev_id, u16 pw_id);
632
633	/**
634	 * send_probe_resp - Transmit a Probe Response frame
635	 * @ctx: Callback context from cb_ctx
636	 * @buf: Probe Response frame (including the header and body)
637	 * @freq: Forced frequency (in MHz) to use or 0.
638	 * Returns: 0 on success, -1 on failure
639	 *
640	 * This function is used to reply to Probe Request frames that were
641	 * indicated with a call to p2p_probe_req_rx(). The response is to be
642	 * sent on the same channel, unless otherwise specified, or to be
643	 * dropped if the driver is not listening to Probe Request frames
644	 * anymore.
645	 *
646	 * Alternatively, the responsibility for building the Probe Response
647	 * frames in Listen state may be in another system component in which
648	 * case this function need to be implemented (i.e., the function
649	 * pointer can be %NULL). The WPS and P2P IEs to be added for Probe
650	 * Response frames in such a case are available from the
651	 * start_listen() callback. It should be noted that the received Probe
652	 * Request frames must be indicated by calling p2p_probe_req_rx() even
653	 * if this send_probe_resp() is not used.
654	 */
655	int (*send_probe_resp)(void *ctx, const struct wpabuf *buf,
656			       unsigned int freq);
657
658	/**
659	 * send_action - Transmit an Action frame
660	 * @ctx: Callback context from cb_ctx
661	 * @freq: Frequency in MHz for the channel on which to transmit
662	 * @dst: Destination MAC address (Address 1)
663	 * @src: Source MAC address (Address 2)
664	 * @bssid: BSSID (Address 3)
665	 * @buf: Frame body (starting from Category field)
666	 * @len: Length of buf in octets
667	 * @wait_time: How many msec to wait for a response frame
668	 * @scheduled: Return value indicating whether the transmissions was
669	 *	scheduled to happen once the radio is available
670	 * Returns: 0 on success, -1 on failure
671	 *
672	 * The Action frame may not be transmitted immediately and the status
673	 * of the transmission must be reported by calling
674	 * p2p_send_action_cb() once the frame has either been transmitted or
675	 * it has been dropped due to excessive retries or other failure to
676	 * transmit.
677	 */
678	int (*send_action)(void *ctx, unsigned int freq, const u8 *dst,
679			   const u8 *src, const u8 *bssid, const u8 *buf,
680			   size_t len, unsigned int wait_time, int *scheduled);
681
682	/**
683	 * send_action_done - Notify that Action frame sequence was completed
684	 * @ctx: Callback context from cb_ctx
685	 *
686	 * This function is called when the Action frame sequence that was
687	 * started with send_action() has been completed, i.e., when there is
688	 * no need to wait for a response from the destination peer anymore.
689	 */
690	void (*send_action_done)(void *ctx);
691
692	/**
693	 * start_listen - Start Listen state
694	 * @ctx: Callback context from cb_ctx
695	 * @freq: Frequency of the listen channel in MHz
696	 * @duration: Duration for the Listen state in milliseconds
697	 * @probe_resp_ie: IE(s) to be added to Probe Response frames
698	 * Returns: 0 on success, -1 on failure
699	 *
700	 * This Listen state may not start immediately since the driver may
701	 * have other pending operations to complete first. Once the Listen
702	 * state has started, p2p_listen_cb() must be called to notify the P2P
703	 * module. Once the Listen state is stopped, p2p_listen_end() must be
704	 * called to notify the P2P module that the driver is not in the Listen
705	 * state anymore.
706	 *
707	 * If the send_probe_resp() is not used for generating the response,
708	 * the IEs from probe_resp_ie need to be added to the end of the Probe
709	 * Response frame body. If send_probe_resp() is used, the probe_resp_ie
710	 * information can be ignored.
711	 */
712	int (*start_listen)(void *ctx, unsigned int freq,
713			    unsigned int duration,
714			    const struct wpabuf *probe_resp_ie);
715	/**
716	 * stop_listen - Stop Listen state
717	 * @ctx: Callback context from cb_ctx
718	 *
719	 * This callback can be used to stop a Listen state operation that was
720	 * previously requested with start_listen().
721	 */
722	void (*stop_listen)(void *ctx);
723
724	/**
725	 * get_noa - Get current Notice of Absence attribute payload
726	 * @ctx: Callback context from cb_ctx
727	 * @interface_addr: P2P Interface Address of the GO
728	 * @buf: Buffer for returning NoA
729	 * @buf_len: Buffer length in octets
730	 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
731	 * advertized, or -1 on failure
732	 *
733	 * This function is used to fetch the current Notice of Absence
734	 * attribute value from GO.
735	 */
736	int (*get_noa)(void *ctx, const u8 *interface_addr, u8 *buf,
737		       size_t buf_len);
738
739	/* Callbacks to notify events to upper layer management entity */
740
741	/**
742	 * dev_found - Notification of a found P2P Device
743	 * @ctx: Callback context from cb_ctx
744	 * @addr: Source address of the message triggering this notification
745	 * @info: P2P peer information
746	 * @new_device: Inform if the peer is newly found
747	 *
748	 * This callback is used to notify that a new P2P Device has been
749	 * found. This may happen, e.g., during Search state based on scan
750	 * results or during Listen state based on receive Probe Request and
751	 * Group Owner Negotiation Request.
752	 */
753	void (*dev_found)(void *ctx, const u8 *addr,
754			  const struct p2p_peer_info *info,
755			  int new_device);
756
757	/**
758	 * dev_lost - Notification of a lost P2P Device
759	 * @ctx: Callback context from cb_ctx
760	 * @dev_addr: P2P Device Address of the lost P2P Device
761	 *
762	 * This callback is used to notify that a P2P Device has been deleted.
763	 */
764	void (*dev_lost)(void *ctx, const u8 *dev_addr);
765
766	/**
767	 * find_stopped - Notification of a p2p_find operation stopping
768	 * @ctx: Callback context from cb_ctx
769	 */
770	void (*find_stopped)(void *ctx);
771
772	/**
773	 * go_neg_req_rx - Notification of a receive GO Negotiation Request
774	 * @ctx: Callback context from cb_ctx
775	 * @src: Source address of the message triggering this notification
776	 * @dev_passwd_id: WPS Device Password ID
777	 * @go_intent: Peer's GO Intent
778	 *
779	 * This callback is used to notify that a P2P Device is requesting
780	 * group owner negotiation with us, but we do not have all the
781	 * necessary information to start GO Negotiation. This indicates that
782	 * the local user has not authorized the connection yet by providing a
783	 * PIN or PBC button press. This information can be provided with a
784	 * call to p2p_connect().
785	 */
786	void (*go_neg_req_rx)(void *ctx, const u8 *src, u16 dev_passwd_id,
787			      u8 go_intent);
788
789	/**
790	 * go_neg_completed - Notification of GO Negotiation results
791	 * @ctx: Callback context from cb_ctx
792	 * @res: GO Negotiation results
793	 *
794	 * This callback is used to notify that Group Owner Negotiation has
795	 * been completed. Non-zero struct p2p_go_neg_results::status indicates
796	 * failed negotiation. In case of success, this function is responsible
797	 * for creating a new group interface (or using the existing interface
798	 * depending on driver features), setting up the group interface in
799	 * proper mode based on struct p2p_go_neg_results::role_go and
800	 * initializing WPS provisioning either as a Registrar (if GO) or as an
801	 * Enrollee. Successful WPS provisioning must be indicated by calling
802	 * p2p_wps_success_cb(). The callee is responsible for timing out group
803	 * formation if WPS provisioning cannot be completed successfully
804	 * within 15 seconds.
805	 */
806	void (*go_neg_completed)(void *ctx, struct p2p_go_neg_results *res);
807
808	/**
809	 * sd_request - Callback on Service Discovery Request
810	 * @ctx: Callback context from cb_ctx
811	 * @freq: Frequency (in MHz) of the channel
812	 * @sa: Source address of the request
813	 * @dialog_token: Dialog token
814	 * @update_indic: Service Update Indicator from the source of request
815	 * @tlvs: P2P Service Request TLV(s)
816	 * @tlvs_len: Length of tlvs buffer in octets
817	 *
818	 * This callback is used to indicate reception of a service discovery
819	 * request. Response to the query must be indicated by calling
820	 * p2p_sd_response() with the context information from the arguments to
821	 * this callback function.
822	 *
823	 * This callback handler can be set to %NULL to indicate that service
824	 * discovery is not supported.
825	 */
826	void (*sd_request)(void *ctx, int freq, const u8 *sa, u8 dialog_token,
827			   u16 update_indic, const u8 *tlvs, size_t tlvs_len);
828
829	/**
830	 * sd_response - Callback on Service Discovery Response
831	 * @ctx: Callback context from cb_ctx
832	 * @sa: Source address of the request
833	 * @update_indic: Service Update Indicator from the source of response
834	 * @tlvs: P2P Service Response TLV(s)
835	 * @tlvs_len: Length of tlvs buffer in octets
836	 *
837	 * This callback is used to indicate reception of a service discovery
838	 * response. This callback handler can be set to %NULL if no service
839	 * discovery requests are used. The information provided with this call
840	 * is replies to the queries scheduled with p2p_sd_request().
841	 */
842	void (*sd_response)(void *ctx, const u8 *sa, u16 update_indic,
843			    const u8 *tlvs, size_t tlvs_len);
844
845	/**
846	 * prov_disc_req - Callback on Provisiong Discovery Request
847	 * @ctx: Callback context from cb_ctx
848	 * @peer: Source address of the request
849	 * @config_methods: Requested WPS Config Method
850	 * @dev_addr: P2P Device Address of the found P2P Device
851	 * @pri_dev_type: Primary Device Type
852	 * @dev_name: Device Name
853	 * @supp_config_methods: Supported configuration Methods
854	 * @dev_capab: Device Capabilities
855	 * @group_capab: Group Capabilities
856	 * @group_id: P2P Group ID (or %NULL if not included)
857	 * @group_id_len: Length of P2P Group ID
858	 *
859	 * This callback is used to indicate reception of a Provision Discovery
860	 * Request frame that the P2P module accepted.
861	 */
862	void (*prov_disc_req)(void *ctx, const u8 *peer, u16 config_methods,
863			      const u8 *dev_addr, const u8 *pri_dev_type,
864			      const char *dev_name, u16 supp_config_methods,
865			      u8 dev_capab, u8 group_capab,
866			      const u8 *group_id, size_t group_id_len);
867
868	/**
869	 * prov_disc_resp - Callback on Provisiong Discovery Response
870	 * @ctx: Callback context from cb_ctx
871	 * @peer: Source address of the response
872	 * @config_methods: Value from p2p_prov_disc_req() or 0 on failure
873	 *
874	 * This callback is used to indicate reception of a Provision Discovery
875	 * Response frame for a pending request scheduled with
876	 * p2p_prov_disc_req(). This callback handler can be set to %NULL if
877	 * provision discovery is not used.
878	 */
879	void (*prov_disc_resp)(void *ctx, const u8 *peer, u16 config_methods);
880
881	/**
882	 * prov_disc_fail - Callback on Provision Discovery failure
883	 * @ctx: Callback context from cb_ctx
884	 * @peer: Source address of the response
885	 * @status: Cause of failure, will not be %P2P_PROV_DISC_SUCCESS
886	 * @adv_id: If non-zero, then the adv_id of the PD Request
887	 * @adv_mac: P2P Device Address of the advertizer
888	 * @deferred_session_resp: Deferred session response sent by advertizer
889	 *
890	 * This callback is used to indicate either a failure or no response
891	 * to an earlier provision discovery request.
892	 *
893	 * This callback handler can be set to %NULL if provision discovery
894	 * is not used or failures do not need to be indicated.
895	 */
896	void (*prov_disc_fail)(void *ctx, const u8 *peer,
897			       enum p2p_prov_disc_status status,
898			       u32 adv_id, const u8 *adv_mac,
899			       const char *deferred_session_resp);
900
901	/**
902	 * invitation_process - Optional callback for processing Invitations
903	 * @ctx: Callback context from cb_ctx
904	 * @sa: Source address of the Invitation Request
905	 * @bssid: P2P Group BSSID from the request or %NULL if not included
906	 * @go_dev_addr: GO Device Address from P2P Group ID
907	 * @ssid: SSID from P2P Group ID
908	 * @ssid_len: Length of ssid buffer in octets
909	 * @go: Variable for returning whether the local end is GO in the group
910	 * @group_bssid: Buffer for returning P2P Group BSSID (if local end GO)
911	 * @force_freq: Variable for returning forced frequency for the group
912	 * @persistent_group: Whether this is an invitation to reinvoke a
913	 *	persistent group (instead of invitation to join an active
914	 *	group)
915	 * @channels: Available operating channels for the group
916	 * @dev_pw_id: Device Password ID for NFC static handover or -1 if not
917	 *	used
918	 * Returns: Status code (P2P_SC_*)
919	 *
920	 * This optional callback can be used to implement persistent reconnect
921	 * by allowing automatic restarting of persistent groups without user
922	 * interaction. If this callback is not implemented (i.e., is %NULL),
923	 * the received Invitation Request frames are replied with
924	 * %P2P_SC_REQ_RECEIVED status and indicated to upper layer with the
925	 * invitation_result() callback.
926	 *
927	 * If the requested parameters are acceptable and the group is known,
928	 * %P2P_SC_SUCCESS may be returned. If the requested group is unknown,
929	 * %P2P_SC_FAIL_UNKNOWN_GROUP should be returned. %P2P_SC_REQ_RECEIVED
930	 * can be returned if there is not enough data to provide immediate
931	 * response, i.e., if some sort of user interaction is needed. The
932	 * invitation_received() callback will be called in that case
933	 * immediately after this call.
934	 */
935	u8 (*invitation_process)(void *ctx, const u8 *sa, const u8 *bssid,
936				 const u8 *go_dev_addr, const u8 *ssid,
937				 size_t ssid_len, int *go, u8 *group_bssid,
938				 int *force_freq, int persistent_group,
939				 const struct p2p_channels *channels,
940				 int dev_pw_id);
941
942	/**
943	 * invitation_received - Callback on Invitation Request RX
944	 * @ctx: Callback context from cb_ctx
945	 * @sa: Source address of the Invitation Request
946	 * @bssid: P2P Group BSSID or %NULL if not received
947	 * @ssid: SSID of the group
948	 * @ssid_len: Length of ssid in octets
949	 * @go_dev_addr: GO Device Address
950	 * @status: Response Status
951	 * @op_freq: Operational frequency for the group
952	 *
953	 * This callback is used to indicate sending of an Invitation Response
954	 * for a received Invitation Request. If status == 0 (success), the
955	 * upper layer code is responsible for starting the group. status == 1
956	 * indicates need to get user authorization for the group. Other status
957	 * values indicate that the invitation request was rejected.
958	 */
959	void (*invitation_received)(void *ctx, const u8 *sa, const u8 *bssid,
960				    const u8 *ssid, size_t ssid_len,
961				    const u8 *go_dev_addr, u8 status,
962				    int op_freq);
963
964	/**
965	 * invitation_result - Callback on Invitation result
966	 * @ctx: Callback context from cb_ctx
967	 * @status: Negotiation result (Status Code)
968	 * @bssid: P2P Group BSSID or %NULL if not received
969	 * @channels: Available operating channels for the group
970	 * @addr: Peer address
971	 * @freq: Frequency (in MHz) indicated during invitation or 0
972	 * @peer_oper_freq: Operating frequency (in MHz) advertized by the peer
973	 * during invitation or 0
974	 *
975	 * This callback is used to indicate result of an Invitation procedure
976	 * started with a call to p2p_invite(). The indicated status code is
977	 * the value received from the peer in Invitation Response with 0
978	 * (P2P_SC_SUCCESS) indicating success or -1 to indicate a timeout or a
979	 * local failure in transmitting the Invitation Request.
980	 */
981	void (*invitation_result)(void *ctx, int status, const u8 *bssid,
982				  const struct p2p_channels *channels,
983				  const u8 *addr, int freq, int peer_oper_freq);
984
985	/**
986	 * go_connected - Check whether we are connected to a GO
987	 * @ctx: Callback context from cb_ctx
988	 * @dev_addr: P2P Device Address of a GO
989	 * Returns: 1 if we are connected as a P2P client to the specified GO
990	 * or 0 if not.
991	 */
992	int (*go_connected)(void *ctx, const u8 *dev_addr);
993
994	/**
995	 * presence_resp - Callback on Presence Response
996	 * @ctx: Callback context from cb_ctx
997	 * @src: Source address (GO's P2P Interface Address)
998	 * @status: Result of the request (P2P_SC_*)
999	 * @noa: Returned NoA value
1000	 * @noa_len: Length of the NoA buffer in octets
1001	 */
1002	void (*presence_resp)(void *ctx, const u8 *src, u8 status,
1003			      const u8 *noa, size_t noa_len);
1004
1005	/**
1006	 * is_concurrent_session_active - Check whether concurrent session is
1007	 * active on other virtual interfaces
1008	 * @ctx: Callback context from cb_ctx
1009	 * Returns: 1 if concurrent session is active on other virtual interface
1010	 * or 0 if not.
1011	 */
1012	int (*is_concurrent_session_active)(void *ctx);
1013
1014	/**
1015	 * is_p2p_in_progress - Check whether P2P operation is in progress
1016	 * @ctx: Callback context from cb_ctx
1017	 * Returns: 1 if P2P operation (e.g., group formation) is in progress
1018	 * or 0 if not.
1019	 */
1020	int (*is_p2p_in_progress)(void *ctx);
1021
1022	/**
1023	 * Determine if we have a persistent group we share with remote peer
1024	 * and allocate interface for this group if needed
1025	 * @ctx: Callback context from cb_ctx
1026	 * @addr: Peer device address to search for
1027	 * @ssid: Persistent group SSID or %NULL if any
1028	 * @ssid_len: Length of @ssid
1029	 * @go_dev_addr: Buffer for returning GO P2P Device Address
1030	 * @ret_ssid: Buffer for returning group SSID
1031	 * @ret_ssid_len: Buffer for returning length of @ssid
1032	 * @intended_iface_addr: Buffer for returning intended iface address
1033	 * Returns: 1 if a matching persistent group was found, 0 otherwise
1034	 */
1035	int (*get_persistent_group)(void *ctx, const u8 *addr, const u8 *ssid,
1036				    size_t ssid_len, u8 *go_dev_addr,
1037				    u8 *ret_ssid, size_t *ret_ssid_len,
1038				    u8 *intended_iface_addr);
1039
1040	/**
1041	 * Get information about a possible local GO role
1042	 * @ctx: Callback context from cb_ctx
1043	 * @intended_addr: Buffer for returning intended GO interface address
1044	 * @ssid: Buffer for returning group SSID
1045	 * @ssid_len: Buffer for returning length of @ssid
1046	 * @group_iface: Buffer for returning whether a separate group interface
1047	 *	would be used
1048	 * @freq: Variable for returning the current operating frequency of a
1049	 *	currently running P2P GO.
1050	 * Returns: 1 if GO info found, 0 otherwise
1051	 *
1052	 * This is used to compose New Group settings (SSID, and intended
1053	 * address) during P2PS provisioning if results of provisioning *might*
1054	 * result in our being an autonomous GO.
1055	 */
1056	int (*get_go_info)(void *ctx, u8 *intended_addr,
1057			   u8 *ssid, size_t *ssid_len, int *group_iface,
1058			   unsigned int *freq);
1059
1060	/**
1061	 * remove_stale_groups - Remove stale P2PS groups
1062	 *
1063	 * Because P2PS stages *potential* GOs, and remote devices can remove
1064	 * credentials unilaterally, we need to make sure we don't let stale
1065	 * unusable groups build up.
1066	 */
1067	int (*remove_stale_groups)(void *ctx, const u8 *peer, const u8 *go,
1068				   const u8 *ssid, size_t ssid_len);
1069
1070	/**
1071	 * p2ps_prov_complete - P2PS provisioning complete
1072	 *
1073	 * When P2PS provisioning completes (successfully or not) we must
1074	 * transmit all of the results to the upper layers.
1075	 */
1076	void (*p2ps_prov_complete)(void *ctx, u8 status, const u8 *dev,
1077				   const u8 *adv_mac, const u8 *ses_mac,
1078				   const u8 *grp_mac, u32 adv_id, u32 ses_id,
1079				   u8 conncap, int passwd_id,
1080				   const u8 *persist_ssid,
1081				   size_t persist_ssid_size, int response_done,
1082				   int prov_start, const char *session_info,
1083				   const u8 *feat_cap, size_t feat_cap_len,
1084				   unsigned int freq, const u8 *group_ssid,
1085				   size_t group_ssid_len);
1086
1087	/**
1088	 * prov_disc_resp_cb - Callback for indicating completion of PD Response
1089	 * @ctx: Callback context from cb_ctx
1090	 * Returns: 1 if operation was started, 0 otherwise
1091	 *
1092	 * This callback can be used to perform any pending actions after
1093	 * provisioning. It is mainly used for P2PS pending group creation.
1094	 */
1095	int (*prov_disc_resp_cb)(void *ctx);
1096
1097	/**
1098	 * p2ps_group_capability - Determine group capability
1099	 * @ctx: Callback context from cb_ctx
1100	 * @incoming: Peer requested roles, expressed with P2PS_SETUP_* bitmap.
1101	 * @role: Local roles, expressed with P2PS_SETUP_* bitmap.
1102	 * @force_freq: Variable for returning forced frequency for the group.
1103	 * @pref_freq: Variable for returning preferred frequency for the group.
1104	 * Returns: P2PS_SETUP_* bitmap of group capability result.
1105	 *
1106	 * This function can be used to determine group capability and
1107	 * frequencies based on information from P2PS PD exchange and the
1108	 * current state of ongoing groups and driver capabilities.
1109	 */
1110	u8 (*p2ps_group_capability)(void *ctx, u8 incoming, u8 role,
1111				    unsigned int *force_freq,
1112				    unsigned int *pref_freq);
1113
1114	/**
1115	 * get_pref_freq_list - Get preferred frequency list for an interface
1116	 * @ctx: Callback context from cb_ctx
1117	 * @go: Whether the use if for GO role
1118	 * @len: Length of freq_list in entries (both IN and OUT)
1119	 * @freq_list: Buffer for returning the preferred frequencies (MHz)
1120	 * Returns: 0 on success, -1 on failure
1121	 *
1122	 * This function can be used to query the preferred frequency list from
1123	 * the driver specific to a particular interface type.
1124	 */
1125	int (*get_pref_freq_list)(void *ctx, int go,
1126				  unsigned int *len, unsigned int *freq_list);
1127};
1128
1129
1130/* P2P module initialization/deinitialization */
1131
1132/**
1133 * p2p_init - Initialize P2P module
1134 * @cfg: P2P module configuration
1135 * Returns: Pointer to private data or %NULL on failure
1136 *
1137 * This function is used to initialize global P2P module context (one per
1138 * device). The P2P module will keep a copy of the configuration data, so the
1139 * caller does not need to maintain this structure. However, the callback
1140 * functions and the context parameters to them must be kept available until
1141 * the P2P module is deinitialized with p2p_deinit().
1142 */
1143struct p2p_data * p2p_init(const struct p2p_config *cfg);
1144
1145/**
1146 * p2p_deinit - Deinitialize P2P module
1147 * @p2p: P2P module context from p2p_init()
1148 */
1149void p2p_deinit(struct p2p_data *p2p);
1150
1151/**
1152 * p2p_flush - Flush P2P module state
1153 * @p2p: P2P module context from p2p_init()
1154 *
1155 * This command removes the P2P module state like peer device entries.
1156 */
1157void p2p_flush(struct p2p_data *p2p);
1158
1159/**
1160 * p2p_unauthorize - Unauthorize the specified peer device
1161 * @p2p: P2P module context from p2p_init()
1162 * @addr: P2P peer entry to be unauthorized
1163 * Returns: 0 on success, -1 on failure
1164 *
1165 * This command removes any connection authorization from the specified P2P
1166 * peer device address. This can be used, e.g., to cancel effect of a previous
1167 * p2p_authorize() or p2p_connect() call that has not yet resulted in completed
1168 * GO Negotiation.
1169 */
1170int p2p_unauthorize(struct p2p_data *p2p, const u8 *addr);
1171
1172/**
1173 * p2p_set_dev_name - Set device name
1174 * @p2p: P2P module context from p2p_init()
1175 * Returns: 0 on success, -1 on failure
1176 *
1177 * This function can be used to update the P2P module configuration with
1178 * information that was not available at the time of the p2p_init() call.
1179 */
1180int p2p_set_dev_name(struct p2p_data *p2p, const char *dev_name);
1181
1182int p2p_set_manufacturer(struct p2p_data *p2p, const char *manufacturer);
1183int p2p_set_model_name(struct p2p_data *p2p, const char *model_name);
1184int p2p_set_model_number(struct p2p_data *p2p, const char *model_number);
1185int p2p_set_serial_number(struct p2p_data *p2p, const char *serial_number);
1186
1187void p2p_set_config_methods(struct p2p_data *p2p, u16 config_methods);
1188void p2p_set_uuid(struct p2p_data *p2p, const u8 *uuid);
1189
1190/**
1191 * p2p_set_pri_dev_type - Set primary device type
1192 * @p2p: P2P module context from p2p_init()
1193 * Returns: 0 on success, -1 on failure
1194 *
1195 * This function can be used to update the P2P module configuration with
1196 * information that was not available at the time of the p2p_init() call.
1197 */
1198int p2p_set_pri_dev_type(struct p2p_data *p2p, const u8 *pri_dev_type);
1199
1200/**
1201 * p2p_set_sec_dev_types - Set secondary device types
1202 * @p2p: P2P module context from p2p_init()
1203 * Returns: 0 on success, -1 on failure
1204 *
1205 * This function can be used to update the P2P module configuration with
1206 * information that was not available at the time of the p2p_init() call.
1207 */
1208int p2p_set_sec_dev_types(struct p2p_data *p2p, const u8 dev_types[][8],
1209			  size_t num_dev_types);
1210
1211int p2p_set_country(struct p2p_data *p2p, const char *country);
1212
1213
1214/* Commands from upper layer management entity */
1215
1216enum p2p_discovery_type {
1217	P2P_FIND_START_WITH_FULL,
1218	P2P_FIND_ONLY_SOCIAL,
1219	P2P_FIND_PROGRESSIVE
1220};
1221
1222/**
1223 * p2p_find - Start P2P Find (Device Discovery)
1224 * @p2p: P2P module context from p2p_init()
1225 * @timeout: Timeout for find operation in seconds or 0 for no timeout
1226 * @type: Device Discovery type
1227 * @num_req_dev_types: Number of requested device types
1228 * @req_dev_types: Requested device types array, must be an array
1229 *	containing num_req_dev_types * WPS_DEV_TYPE_LEN bytes; %NULL if no
1230 *	requested device types.
1231 * @dev_id: Device ID to search for or %NULL to find all devices
1232 * @search_delay: Extra delay in milliseconds between search iterations
1233 * @seek_count: Number of ASP Service Strings in the seek_string array
1234 * @seek_string: ASP Service Strings to query for in Probe Requests
1235 * @freq: Requested first scan frequency (in MHz) to modify type ==
1236 *	P2P_FIND_START_WITH_FULL behavior. 0 = Use normal full scan.
1237 *	If p2p_find is already in progress, this parameter is ignored and full
1238 *	scan will be executed.
1239 * Returns: 0 on success, -1 on failure
1240 */
1241int p2p_find(struct p2p_data *p2p, unsigned int timeout,
1242	     enum p2p_discovery_type type,
1243	     unsigned int num_req_dev_types, const u8 *req_dev_types,
1244	     const u8 *dev_id, unsigned int search_delay,
1245	     u8 seek_count, const char **seek_string, int freq);
1246
1247/**
1248 * p2p_notify_scan_trigger_status - Indicate scan trigger status
1249 * @p2p: P2P module context from p2p_init()
1250 * @status: 0 on success, -1 on failure
1251 */
1252void p2p_notify_scan_trigger_status(struct p2p_data *p2p, int status);
1253
1254/**
1255 * p2p_stop_find - Stop P2P Find (Device Discovery)
1256 * @p2p: P2P module context from p2p_init()
1257 */
1258void p2p_stop_find(struct p2p_data *p2p);
1259
1260/**
1261 * p2p_stop_find_for_freq - Stop P2P Find for next oper on specific freq
1262 * @p2p: P2P module context from p2p_init()
1263 * @freq: Frequency in MHz for next operation
1264 *
1265 * This is like p2p_stop_find(), but Listen state is not stopped if we are
1266 * already on the same frequency.
1267 */
1268void p2p_stop_find_for_freq(struct p2p_data *p2p, int freq);
1269
1270/**
1271 * p2p_listen - Start P2P Listen state for specified duration
1272 * @p2p: P2P module context from p2p_init()
1273 * @timeout: Listen state duration in milliseconds
1274 * Returns: 0 on success, -1 on failure
1275 *
1276 * This function can be used to request the P2P module to keep the device
1277 * discoverable on the listen channel for an extended set of time. At least in
1278 * its current form, this is mainly used for testing purposes and may not be of
1279 * much use for normal P2P operations.
1280 */
1281int p2p_listen(struct p2p_data *p2p, unsigned int timeout);
1282
1283/**
1284 * p2p_stop_listen - Stop P2P Listen
1285 * @p2p: P2P module context from p2p_init()
1286 */
1287void p2p_stop_listen(struct p2p_data *p2p);
1288
1289/**
1290 * p2p_connect - Start P2P group formation (GO negotiation)
1291 * @p2p: P2P module context from p2p_init()
1292 * @peer_addr: MAC address of the peer P2P client
1293 * @wps_method: WPS method to be used in provisioning
1294 * @go_intent: Local GO intent value (1..15)
1295 * @own_interface_addr: Intended interface address to use with the group
1296 * @force_freq: The only allowed channel frequency in MHz or 0
1297 * @persistent_group: Whether to create a persistent group (0 = no, 1 =
1298 * persistent group without persistent reconnect, 2 = persistent group with
1299 * persistent reconnect)
1300 * @force_ssid: Forced SSID for the group if we become GO or %NULL to generate
1301 *	a new SSID
1302 * @force_ssid_len: Length of $force_ssid buffer
1303 * @pd_before_go_neg: Whether to send Provision Discovery prior to GO
1304 *	Negotiation as an interoperability workaround when initiating group
1305 *	formation
1306 * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if
1307 *	force_freq == 0)
1308 * Returns: 0 on success, -1 on failure
1309 */
1310int p2p_connect(struct p2p_data *p2p, const u8 *peer_addr,
1311		enum p2p_wps_method wps_method,
1312		int go_intent, const u8 *own_interface_addr,
1313		unsigned int force_freq, int persistent_group,
1314		const u8 *force_ssid, size_t force_ssid_len,
1315		int pd_before_go_neg, unsigned int pref_freq, u16 oob_pw_id);
1316
1317/**
1318 * p2p_authorize - Authorize P2P group formation (GO negotiation)
1319 * @p2p: P2P module context from p2p_init()
1320 * @peer_addr: MAC address of the peer P2P client
1321 * @wps_method: WPS method to be used in provisioning
1322 * @go_intent: Local GO intent value (1..15)
1323 * @own_interface_addr: Intended interface address to use with the group
1324 * @force_freq: The only allowed channel frequency in MHz or 0
1325 * @persistent_group: Whether to create a persistent group (0 = no, 1 =
1326 * persistent group without persistent reconnect, 2 = persistent group with
1327 * persistent reconnect)
1328 * @force_ssid: Forced SSID for the group if we become GO or %NULL to generate
1329 *	a new SSID
1330 * @force_ssid_len: Length of $force_ssid buffer
1331 * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if
1332 *	force_freq == 0)
1333 * Returns: 0 on success, -1 on failure
1334 *
1335 * This is like p2p_connect(), but the actual group negotiation is not
1336 * initiated automatically, i.e., the other end is expected to do that.
1337 */
1338int p2p_authorize(struct p2p_data *p2p, const u8 *peer_addr,
1339		  enum p2p_wps_method wps_method,
1340		  int go_intent, const u8 *own_interface_addr,
1341		  unsigned int force_freq, int persistent_group,
1342		  const u8 *force_ssid, size_t force_ssid_len,
1343		  unsigned int pref_freq, u16 oob_pw_id);
1344
1345/**
1346 * p2p_reject - Reject peer device (explicitly block connection attempts)
1347 * @p2p: P2P module context from p2p_init()
1348 * @peer_addr: MAC address of the peer P2P client
1349 * Returns: 0 on success, -1 on failure
1350 */
1351int p2p_reject(struct p2p_data *p2p, const u8 *peer_addr);
1352
1353/**
1354 * p2p_prov_disc_req - Send Provision Discovery Request
1355 * @p2p: P2P module context from p2p_init()
1356 * @peer_addr: MAC address of the peer P2P client
1357 * @p2ps_prov: Provisioning info for P2PS
1358 * @config_methods: WPS Config Methods value (only one bit set)
1359 * @join: Whether this is used by a client joining an active group
1360 * @force_freq: Forced TX frequency for the frame (mainly for the join case)
1361 * @user_initiated_pd: Flag to indicate if initiated by user or not
1362 * Returns: 0 on success, -1 on failure
1363 *
1364 * This function can be used to request a discovered P2P peer to display a PIN
1365 * (config_methods = WPS_CONFIG_DISPLAY) or be prepared to enter a PIN from us
1366 * (config_methods = WPS_CONFIG_KEYPAD). The Provision Discovery Request frame
1367 * is transmitted once immediately and if no response is received, the frame
1368 * will be sent again whenever the target device is discovered during device
1369 * dsicovery (start with a p2p_find() call). Response from the peer is
1370 * indicated with the p2p_config::prov_disc_resp() callback.
1371 */
1372int p2p_prov_disc_req(struct p2p_data *p2p, const u8 *peer_addr,
1373		      struct p2ps_provision *p2ps_prov, u16 config_methods,
1374		      int join, int force_freq,
1375		      int user_initiated_pd);
1376
1377/**
1378 * p2p_sd_request - Schedule a service discovery query
1379 * @p2p: P2P module context from p2p_init()
1380 * @dst: Destination peer or %NULL to apply for all peers
1381 * @tlvs: P2P Service Query TLV(s)
1382 * Returns: Reference to the query or %NULL on failure
1383 *
1384 * Response to the query is indicated with the p2p_config::sd_response()
1385 * callback.
1386 */
1387void * p2p_sd_request(struct p2p_data *p2p, const u8 *dst,
1388		      const struct wpabuf *tlvs);
1389
1390#ifdef CONFIG_WIFI_DISPLAY
1391void * p2p_sd_request_wfd(struct p2p_data *p2p, const u8 *dst,
1392			  const struct wpabuf *tlvs);
1393#endif /* CONFIG_WIFI_DISPLAY */
1394
1395/**
1396 * p2p_sd_cancel_request - Cancel a pending service discovery query
1397 * @p2p: P2P module context from p2p_init()
1398 * @req: Query reference from p2p_sd_request()
1399 * Returns: 0 if request for cancelled; -1 if not found
1400 */
1401int p2p_sd_cancel_request(struct p2p_data *p2p, void *req);
1402
1403/**
1404 * p2p_sd_response - Send response to a service discovery query
1405 * @p2p: P2P module context from p2p_init()
1406 * @freq: Frequency from p2p_config::sd_request() callback
1407 * @dst: Destination address from p2p_config::sd_request() callback
1408 * @dialog_token: Dialog token from p2p_config::sd_request() callback
1409 * @resp_tlvs: P2P Service Response TLV(s)
1410 *
1411 * This function is called as a response to the request indicated with
1412 * p2p_config::sd_request() callback.
1413 */
1414void p2p_sd_response(struct p2p_data *p2p, int freq, const u8 *dst,
1415		     u8 dialog_token, const struct wpabuf *resp_tlvs);
1416
1417/**
1418 * p2p_sd_service_update - Indicate a change in local services
1419 * @p2p: P2P module context from p2p_init()
1420 *
1421 * This function needs to be called whenever there is a change in availability
1422 * of the local services. This will increment the Service Update Indicator
1423 * value which will be used in SD Request and Response frames.
1424 */
1425void p2p_sd_service_update(struct p2p_data *p2p);
1426
1427
1428enum p2p_invite_role {
1429	P2P_INVITE_ROLE_GO,
1430	P2P_INVITE_ROLE_ACTIVE_GO,
1431	P2P_INVITE_ROLE_CLIENT
1432};
1433
1434/**
1435 * p2p_invite - Invite a P2P Device into a group
1436 * @p2p: P2P module context from p2p_init()
1437 * @peer: Device Address of the peer P2P Device
1438 * @role: Local role in the group
1439 * @bssid: Group BSSID or %NULL if not known
1440 * @ssid: Group SSID
1441 * @ssid_len: Length of ssid in octets
1442 * @force_freq: The only allowed channel frequency in MHz or 0
1443 * @go_dev_addr: Forced GO Device Address or %NULL if none
1444 * @persistent_group: Whether this is to reinvoke a persistent group
1445 * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if
1446 *	force_freq == 0)
1447 * @dev_pw_id: Device Password ID from OOB Device Password (NFC) static handover
1448 *	case or -1 if not used
1449 * Returns: 0 on success, -1 on failure
1450 */
1451int p2p_invite(struct p2p_data *p2p, const u8 *peer, enum p2p_invite_role role,
1452	       const u8 *bssid, const u8 *ssid, size_t ssid_len,
1453	       unsigned int force_freq, const u8 *go_dev_addr,
1454	       int persistent_group, unsigned int pref_freq, int dev_pw_id);
1455
1456/**
1457 * p2p_presence_req - Request GO presence
1458 * @p2p: P2P module context from p2p_init()
1459 * @go_interface_addr: GO P2P Interface Address
1460 * @own_interface_addr: Own P2P Interface Address for this group
1461 * @freq: Group operating frequence (in MHz)
1462 * @duration1: Preferred presence duration in microseconds
1463 * @interval1: Preferred presence interval in microseconds
1464 * @duration2: Acceptable presence duration in microseconds
1465 * @interval2: Acceptable presence interval in microseconds
1466 * Returns: 0 on success, -1 on failure
1467 *
1468 * If both duration and interval values are zero, the parameter pair is not
1469 * specified (i.e., to remove Presence Request, use duration1 = interval1 = 0).
1470 */
1471int p2p_presence_req(struct p2p_data *p2p, const u8 *go_interface_addr,
1472		     const u8 *own_interface_addr, unsigned int freq,
1473		     u32 duration1, u32 interval1, u32 duration2,
1474		     u32 interval2);
1475
1476/**
1477 * p2p_ext_listen - Set Extended Listen Timing
1478 * @p2p: P2P module context from p2p_init()
1479 * @freq: Group operating frequence (in MHz)
1480 * @period: Availability period in milliseconds (1-65535; 0 to disable)
1481 * @interval: Availability interval in milliseconds (1-65535; 0 to disable)
1482 * Returns: 0 on success, -1 on failure
1483 *
1484 * This function can be used to enable or disable (period = interval = 0)
1485 * Extended Listen Timing. When enabled, the P2P Device will become
1486 * discoverable (go into Listen State) every @interval milliseconds for at
1487 * least @period milliseconds.
1488 */
1489int p2p_ext_listen(struct p2p_data *p2p, unsigned int period,
1490		   unsigned int interval);
1491
1492/* Event notifications from upper layer management operations */
1493
1494/**
1495 * p2p_wps_success_cb - Report successfully completed WPS provisioning
1496 * @p2p: P2P module context from p2p_init()
1497 * @mac_addr: Peer address
1498 *
1499 * This function is used to report successfully completed WPS provisioning
1500 * during group formation in both GO/Registrar and client/Enrollee roles.
1501 */
1502void p2p_wps_success_cb(struct p2p_data *p2p, const u8 *mac_addr);
1503
1504/**
1505 * p2p_group_formation_failed - Report failed WPS provisioning
1506 * @p2p: P2P module context from p2p_init()
1507 *
1508 * This function is used to report failed group formation. This can happen
1509 * either due to failed WPS provisioning or due to 15 second timeout during
1510 * the provisioning phase.
1511 */
1512void p2p_group_formation_failed(struct p2p_data *p2p);
1513
1514/**
1515 * p2p_get_provisioning_info - Get any stored provisioning info
1516 * @p2p: P2P module context from p2p_init()
1517 * @addr: Peer P2P Device Address
1518 * Returns: WPS provisioning information (WPS config method) or 0 if no
1519 * information is available
1520 *
1521 * This function is used to retrieve stored WPS provisioning info for the given
1522 * peer.
1523 */
1524u16 p2p_get_provisioning_info(struct p2p_data *p2p, const u8 *addr);
1525
1526/**
1527 * p2p_clear_provisioning_info - Clear any stored provisioning info
1528 * @p2p: P2P module context from p2p_init()
1529 * @iface_addr: Peer P2P Device Address
1530 *
1531 * This function is used to clear stored WPS provisioning info for the given
1532 * peer.
1533 */
1534void p2p_clear_provisioning_info(struct p2p_data *p2p, const u8 *addr);
1535
1536
1537/* Event notifications from lower layer driver operations */
1538
1539/**
1540 * enum p2p_probe_req_status
1541 *
1542 * @P2P_PREQ_MALFORMED: frame was not well-formed
1543 * @P2P_PREQ_NOT_LISTEN: device isn't in listen state, frame ignored
1544 * @P2P_PREQ_NOT_P2P: frame was not a P2P probe request
1545 * @P2P_PREQ_P2P_NOT_PROCESSED: frame was P2P but wasn't processed
1546 * @P2P_PREQ_P2P_PROCESSED: frame has been processed by P2P
1547 */
1548enum p2p_probe_req_status {
1549	P2P_PREQ_MALFORMED,
1550	P2P_PREQ_NOT_LISTEN,
1551	P2P_PREQ_NOT_P2P,
1552	P2P_PREQ_NOT_PROCESSED,
1553	P2P_PREQ_PROCESSED
1554};
1555
1556/**
1557 * p2p_probe_req_rx - Report reception of a Probe Request frame
1558 * @p2p: P2P module context from p2p_init()
1559 * @addr: Source MAC address
1560 * @dst: Destination MAC address if available or %NULL
1561 * @bssid: BSSID if available or %NULL
1562 * @ie: Information elements from the Probe Request frame body
1563 * @ie_len: Length of ie buffer in octets
1564 * @rx_freq: Probe Request frame RX frequency
1565 * @p2p_lo_started: Whether P2P Listen Offload is started
1566 * Returns: value indicating the type and status of the probe request
1567 */
1568enum p2p_probe_req_status
1569p2p_probe_req_rx(struct p2p_data *p2p, const u8 *addr, const u8 *dst,
1570		 const u8 *bssid, const u8 *ie, size_t ie_len,
1571		 unsigned int rx_freq, int p2p_lo_started);
1572
1573/**
1574 * p2p_rx_action - Report received Action frame
1575 * @p2p: P2P module context from p2p_init()
1576 * @da: Destination address of the received Action frame
1577 * @sa: Source address of the received Action frame
1578 * @bssid: Address 3 of the received Action frame
1579 * @category: Category of the received Action frame
1580 * @data: Action frame body after the Category field
1581 * @len: Length of the data buffer in octets
1582 * @freq: Frequency (in MHz) on which the frame was received
1583 */
1584void p2p_rx_action(struct p2p_data *p2p, const u8 *da, const u8 *sa,
1585		   const u8 *bssid, u8 category,
1586		   const u8 *data, size_t len, int freq);
1587
1588/**
1589 * p2p_scan_res_handler - Indicate a P2P scan results
1590 * @p2p: P2P module context from p2p_init()
1591 * @bssid: BSSID of the scan result
1592 * @freq: Frequency of the channel on which the device was found in MHz
1593 * @rx_time: Time when the result was received
1594 * @level: Signal level (signal strength of the received Beacon/Probe Response
1595 *	frame)
1596 * @ies: Pointer to IEs from the scan result
1597 * @ies_len: Length of the ies buffer
1598 * Returns: 0 to continue or 1 to stop scan result indication
1599 *
1600 * This function is called to indicate a scan result entry with P2P IE from a
1601 * scan requested with struct p2p_config::p2p_scan(). This can be called during
1602 * the actual scan process (i.e., whenever a new device is found) or as a
1603 * sequence of calls after the full scan has been completed. The former option
1604 * can result in optimized operations, but may not be supported by all
1605 * driver/firmware designs. The ies buffer need to include at least the P2P IE,
1606 * but it is recommended to include all IEs received from the device. The
1607 * caller does not need to check that the IEs contain a P2P IE before calling
1608 * this function since frames will be filtered internally if needed.
1609 *
1610 * This function will return 1 if it wants to stop scan result iteration (and
1611 * scan in general if it is still in progress). This is used to allow faster
1612 * start of a pending operation, e.g., to start a pending GO negotiation.
1613 */
1614int p2p_scan_res_handler(struct p2p_data *p2p, const u8 *bssid, int freq,
1615			 struct os_reltime *rx_time, int level, const u8 *ies,
1616			 size_t ies_len);
1617
1618/**
1619 * p2p_scan_res_handled - Indicate end of scan results
1620 * @p2p: P2P module context from p2p_init()
1621 *
1622 * This function is called to indicate that all P2P scan results from a scan
1623 * have been reported with zero or more calls to p2p_scan_res_handler(). This
1624 * function must be called as a response to successful
1625 * struct p2p_config::p2p_scan() call if none of the p2p_scan_res_handler()
1626 * calls stopped iteration.
1627 */
1628void p2p_scan_res_handled(struct p2p_data *p2p);
1629
1630enum p2p_send_action_result {
1631	P2P_SEND_ACTION_SUCCESS /* Frame was send and acknowledged */,
1632	P2P_SEND_ACTION_NO_ACK /* Frame was sent, but not acknowledged */,
1633	P2P_SEND_ACTION_FAILED /* Frame was not sent due to a failure */
1634};
1635
1636/**
1637 * p2p_send_action_cb - Notify TX status of an Action frame
1638 * @p2p: P2P module context from p2p_init()
1639 * @freq: Channel frequency in MHz
1640 * @dst: Destination MAC address (Address 1)
1641 * @src: Source MAC address (Address 2)
1642 * @bssid: BSSID (Address 3)
1643 * @result: Result of the transmission attempt
1644 *
1645 * This function is used to indicate the result of an Action frame transmission
1646 * that was requested with struct p2p_config::send_action() callback.
1647 */
1648void p2p_send_action_cb(struct p2p_data *p2p, unsigned int freq, const u8 *dst,
1649			const u8 *src, const u8 *bssid,
1650			enum p2p_send_action_result result);
1651
1652/**
1653 * p2p_listen_cb - Indicate the start of a requested Listen state
1654 * @p2p: P2P module context from p2p_init()
1655 * @freq: Listen channel frequency in MHz
1656 * @duration: Duration for the Listen state in milliseconds
1657 *
1658 * This function is used to indicate that a Listen state requested with
1659 * struct p2p_config::start_listen() callback has started.
1660 */
1661void p2p_listen_cb(struct p2p_data *p2p, unsigned int freq,
1662		   unsigned int duration);
1663
1664/**
1665 * p2p_listen_end - Indicate the end of a requested Listen state
1666 * @p2p: P2P module context from p2p_init()
1667 * @freq: Listen channel frequency in MHz
1668 * Returns: 0 if no operations were started, 1 if an operation was started
1669 *
1670 * This function is used to indicate that a Listen state requested with
1671 * struct p2p_config::start_listen() callback has ended.
1672 */
1673int p2p_listen_end(struct p2p_data *p2p, unsigned int freq);
1674
1675void p2p_deauth_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code,
1676		      const u8 *ie, size_t ie_len);
1677
1678void p2p_disassoc_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code,
1679			const u8 *ie, size_t ie_len);
1680
1681
1682/* Per-group P2P state for GO */
1683
1684struct p2p_group;
1685
1686/**
1687 * struct p2p_group_config - P2P group configuration
1688 *
1689 * This configuration is provided to the P2P module during initialization of
1690 * the per-group information with p2p_group_init().
1691 */
1692struct p2p_group_config {
1693	/**
1694	 * persistent_group - Whether the group is persistent
1695	 * 0 = not a persistent group
1696	 * 1 = persistent group without persistent reconnect
1697	 * 2 = persistent group with persistent reconnect
1698	 */
1699	int persistent_group;
1700
1701	/**
1702	 * interface_addr - P2P Interface Address of the group
1703	 */
1704	u8 interface_addr[ETH_ALEN];
1705
1706	/**
1707	 * max_clients - Maximum number of clients in the group
1708	 */
1709	unsigned int max_clients;
1710
1711	/**
1712	 * ssid - Group SSID
1713	 */
1714	u8 ssid[SSID_MAX_LEN];
1715
1716	/**
1717	 * ssid_len - Length of SSID
1718	 */
1719	size_t ssid_len;
1720
1721	/**
1722	 * freq - Operating channel of the group
1723	 */
1724	int freq;
1725
1726	/**
1727	 * ip_addr_alloc - Whether IP address allocation within 4-way handshake
1728	 *	is supported
1729	 */
1730	int ip_addr_alloc;
1731
1732	/**
1733	 * cb_ctx - Context to use with callback functions
1734	 */
1735	void *cb_ctx;
1736
1737	/**
1738	 * ie_update - Notification of IE update
1739	 * @ctx: Callback context from cb_ctx
1740	 * @beacon_ies: P2P IE for Beacon frames or %NULL if no change
1741	 * @proberesp_ies: P2P Ie for Probe Response frames
1742	 *
1743	 * P2P module uses this callback function to notify whenever the P2P IE
1744	 * in Beacon or Probe Response frames should be updated based on group
1745	 * events.
1746	 *
1747	 * The callee is responsible for freeing the returned buffer(s) with
1748	 * wpabuf_free().
1749	 */
1750	void (*ie_update)(void *ctx, struct wpabuf *beacon_ies,
1751			  struct wpabuf *proberesp_ies);
1752
1753	/**
1754	 * idle_update - Notification of changes in group idle state
1755	 * @ctx: Callback context from cb_ctx
1756	 * @idle: Whether the group is idle (no associated stations)
1757	 */
1758	void (*idle_update)(void *ctx, int idle);
1759};
1760
1761/**
1762 * p2p_group_init - Initialize P2P group
1763 * @p2p: P2P module context from p2p_init()
1764 * @config: P2P group configuration (will be freed by p2p_group_deinit())
1765 * Returns: Pointer to private data or %NULL on failure
1766 *
1767 * This function is used to initialize per-group P2P module context. Currently,
1768 * this is only used to manage GO functionality and P2P clients do not need to
1769 * create an instance of this per-group information.
1770 */
1771struct p2p_group * p2p_group_init(struct p2p_data *p2p,
1772				  struct p2p_group_config *config);
1773
1774/**
1775 * p2p_group_deinit - Deinitialize P2P group
1776 * @group: P2P group context from p2p_group_init()
1777 */
1778void p2p_group_deinit(struct p2p_group *group);
1779
1780/**
1781 * p2p_group_notif_assoc - Notification of P2P client association with GO
1782 * @group: P2P group context from p2p_group_init()
1783 * @addr: Interface address of the P2P client
1784 * @ie: IEs from the (Re)association Request frame
1785 * @len: Length of the ie buffer in octets
1786 * Returns: 0 on success, -1 on failure
1787 */
1788int p2p_group_notif_assoc(struct p2p_group *group, const u8 *addr,
1789			  const u8 *ie, size_t len);
1790
1791/**
1792 * p2p_group_assoc_resp_ie - Build P2P IE for (re)association response
1793 * @group: P2P group context from p2p_group_init()
1794 * @status: Status value (P2P_SC_SUCCESS if association succeeded)
1795 * Returns: P2P IE for (Re)association Response or %NULL on failure
1796 *
1797 * The caller is responsible for freeing the returned buffer with
1798 * wpabuf_free().
1799 */
1800struct wpabuf * p2p_group_assoc_resp_ie(struct p2p_group *group, u8 status);
1801
1802/**
1803 * p2p_group_notif_disassoc - Notification of P2P client disassociation from GO
1804 * @group: P2P group context from p2p_group_init()
1805 * @addr: Interface address of the P2P client
1806 */
1807void p2p_group_notif_disassoc(struct p2p_group *group, const u8 *addr);
1808
1809/**
1810 * p2p_group_notif_formation_done - Notification of completed group formation
1811 * @group: P2P group context from p2p_group_init()
1812 */
1813void p2p_group_notif_formation_done(struct p2p_group *group);
1814
1815/**
1816 * p2p_group_notif_noa - Notification of NoA change
1817 * @group: P2P group context from p2p_group_init()
1818 * @noa: Notice of Absence attribute payload, %NULL if none
1819 * @noa_len: Length of noa buffer in octets
1820 * Returns: 0 on success, -1 on failure
1821 *
1822 * Notify the P2P group management about a new NoA contents. This will be
1823 * inserted into the P2P IEs in Beacon and Probe Response frames with rest of
1824 * the group information.
1825 */
1826int p2p_group_notif_noa(struct p2p_group *group, const u8 *noa,
1827			size_t noa_len);
1828
1829/**
1830 * p2p_group_match_dev_type - Match device types in group with requested type
1831 * @group: P2P group context from p2p_group_init()
1832 * @wps: WPS TLVs from Probe Request frame (concatenated WPS IEs)
1833 * Returns: 1 on match, 0 on mismatch
1834 *
1835 * This function can be used to match the Requested Device Type attribute in
1836 * WPS IE with the device types of a group member for deciding whether a GO
1837 * should reply to a Probe Request frame. Match will be reported if the WPS IE
1838 * is not requested any specific device type.
1839 */
1840int p2p_group_match_dev_type(struct p2p_group *group, struct wpabuf *wps);
1841
1842/**
1843 * p2p_group_match_dev_id - Match P2P Device Address in group with requested device id
1844 */
1845int p2p_group_match_dev_id(struct p2p_group *group, struct wpabuf *p2p);
1846
1847/**
1848 * p2p_group_go_discover - Send GO Discoverability Request to a group client
1849 * @group: P2P group context from p2p_group_init()
1850 * Returns: 0 on success (frame scheduled); -1 if client was not found
1851 */
1852int p2p_group_go_discover(struct p2p_group *group, const u8 *dev_id,
1853			  const u8 *searching_dev, int rx_freq);
1854
1855
1856/* Generic helper functions */
1857
1858/**
1859 * p2p_ie_text - Build text format description of P2P IE
1860 * @p2p_ie: P2P IE
1861 * @buf: Buffer for returning text
1862 * @end: Pointer to the end of the buf area
1863 * Returns: Number of octets written to the buffer or -1 on failure
1864 *
1865 * This function can be used to parse P2P IE contents into text format
1866 * field=value lines.
1867 */
1868int p2p_ie_text(struct wpabuf *p2p_ie, char *buf, char *end);
1869
1870/**
1871 * p2p_scan_result_text - Build text format description of P2P IE
1872 * @ies: Information elements from scan results
1873 * @ies_len: ies buffer length in octets
1874 * @buf: Buffer for returning text
1875 * @end: Pointer to the end of the buf area
1876 * Returns: Number of octets written to the buffer or -1 on failure
1877 *
1878 * This function can be used to parse P2P IE contents into text format
1879 * field=value lines.
1880 */
1881int p2p_scan_result_text(const u8 *ies, size_t ies_len, char *buf, char *end);
1882
1883/**
1884 * p2p_parse_dev_addr_in_p2p_ie - Parse P2P Device Address from a concatenated
1885 * P2P IE
1886 * @p2p_ie: P2P IE
1887 * @dev_addr: Buffer for returning P2P Device Address
1888 * Returns: 0 on success or -1 if P2P Device Address could not be parsed
1889 */
1890int p2p_parse_dev_addr_in_p2p_ie(struct wpabuf *p2p_ie, u8 *dev_addr);
1891
1892/**
1893 * p2p_parse_dev_addr - Parse P2P Device Address from P2P IE(s)
1894 * @ies: Information elements from scan results
1895 * @ies_len: ies buffer length in octets
1896 * @dev_addr: Buffer for returning P2P Device Address
1897 * Returns: 0 on success or -1 if P2P Device Address could not be parsed
1898 */
1899int p2p_parse_dev_addr(const u8 *ies, size_t ies_len, u8 *dev_addr);
1900
1901/**
1902 * p2p_assoc_req_ie - Build P2P IE for (Re)Association Request frame
1903 * @p2p: P2P module context from p2p_init()
1904 * @bssid: BSSID
1905 * @buf: Buffer for writing the P2P IE
1906 * @len: Maximum buf length in octets
1907 * @p2p_group: Whether this is for association with a P2P GO
1908 * @p2p_ie: Reassembled P2P IE data from scan results or %NULL if none
1909 * Returns: Number of octets written into buf or -1 on failure
1910 */
1911int p2p_assoc_req_ie(struct p2p_data *p2p, const u8 *bssid, u8 *buf,
1912		     size_t len, int p2p_group, struct wpabuf *p2p_ie);
1913
1914/**
1915 * p2p_scan_ie - Build P2P IE for Probe Request
1916 * @p2p: P2P module context from p2p_init()
1917 * @ies: Buffer for writing P2P IE
1918 * @dev_id: Device ID to search for or %NULL for any
1919 * @bands: Frequency bands used in the scan (enum wpa_radio_work_band bitmap)
1920 */
1921void p2p_scan_ie(struct p2p_data *p2p, struct wpabuf *ies, const u8 *dev_id,
1922		 unsigned int bands);
1923
1924/**
1925 * p2p_scan_ie_buf_len - Get maximum buffer length needed for p2p_scan_ie
1926 * @p2p: P2P module context from p2p_init()
1927 * Returns: Number of octets that p2p_scan_ie() may add to the buffer
1928 */
1929size_t p2p_scan_ie_buf_len(struct p2p_data *p2p);
1930
1931/**
1932 * p2p_go_params - Generate random P2P group parameters
1933 * @p2p: P2P module context from p2p_init()
1934 * @params: Buffer for parameters
1935 * Returns: 0 on success, -1 on failure
1936 */
1937int p2p_go_params(struct p2p_data *p2p, struct p2p_go_neg_results *params);
1938
1939/**
1940 * p2p_get_group_capab - Get Group Capability from P2P IE data
1941 * @p2p_ie: P2P IE(s) contents
1942 * Returns: Group Capability
1943 */
1944u8 p2p_get_group_capab(const struct wpabuf *p2p_ie);
1945
1946/**
1947 * p2p_get_cross_connect_disallowed - Does WLAN AP disallows cross connection
1948 * @p2p_ie: P2P IE(s) contents
1949 * Returns: 0 if cross connection is allow, 1 if not
1950 */
1951int p2p_get_cross_connect_disallowed(const struct wpabuf *p2p_ie);
1952
1953/**
1954 * p2p_get_go_dev_addr - Get P2P Device Address from P2P IE data
1955 * @p2p_ie: P2P IE(s) contents
1956 * Returns: Pointer to P2P Device Address or %NULL if not included
1957 */
1958const u8 * p2p_get_go_dev_addr(const struct wpabuf *p2p_ie);
1959
1960/**
1961 * p2p_get_peer_info - Get P2P peer information
1962 * @p2p: P2P module context from p2p_init()
1963 * @addr: P2P Device Address of the peer or %NULL to indicate the first peer
1964 * @next: Whether to select the peer entry following the one indicated by addr
1965 * Returns: Pointer to peer info or %NULL if not found
1966 */
1967const struct p2p_peer_info * p2p_get_peer_info(struct p2p_data *p2p,
1968					       const u8 *addr, int next);
1969
1970/**
1971 * p2p_get_peer_info_txt - Get internal P2P peer information in text format
1972 * @info: Pointer to P2P peer info from p2p_get_peer_info()
1973 * @buf: Buffer for returning text
1974 * @buflen: Maximum buffer length
1975 * Returns: Number of octets written to the buffer or -1 on failure
1976 *
1977 * Note: This information is internal to the P2P module and subject to change.
1978 * As such, this should not really be used by external programs for purposes
1979 * other than debugging.
1980 */
1981int p2p_get_peer_info_txt(const struct p2p_peer_info *info,
1982			  char *buf, size_t buflen);
1983
1984/**
1985 * p2p_peer_known - Check whether P2P peer is known
1986 * @p2p: P2P module context from p2p_init()
1987 * @addr: P2P Device Address of the peer
1988 * Returns: 1 if the specified device is in the P2P peer table or 0 if not
1989 */
1990int p2p_peer_known(struct p2p_data *p2p, const u8 *addr);
1991
1992/**
1993 * p2p_set_client_discoverability - Set client discoverability capability
1994 * @p2p: P2P module context from p2p_init()
1995 * @enabled: Whether client discoverability will be enabled
1996 *
1997 * This function can be used to disable (and re-enable) client discoverability.
1998 * This capability is enabled by default and should not be disabled in normal
1999 * use cases, i.e., this is mainly for testing purposes.
2000 */
2001void p2p_set_client_discoverability(struct p2p_data *p2p, int enabled);
2002
2003/**
2004 * p2p_set_managed_oper - Set managed P2P Device operations capability
2005 * @p2p: P2P module context from p2p_init()
2006 * @enabled: Whether managed P2P Device operations will be enabled
2007 */
2008void p2p_set_managed_oper(struct p2p_data *p2p, int enabled);
2009
2010/**
2011 * p2p_config_get_random_social - Return a random social channel
2012 * @p2p: P2P config
2013 * @op_class: Selected operating class
2014 * @op_channel: Selected social channel
2015 * @avoid_list: Channel ranges to try to avoid or %NULL
2016 * @disallow_list: Channel ranges to discard or %NULL
2017 * Returns: 0 on success, -1 on failure
2018 *
2019 * This function is used before p2p_init is called. A random social channel
2020 * from supports bands 2.4 GHz (channels 1,6,11) and 60 GHz (channel 2) is
2021 * returned on success.
2022 */
2023int p2p_config_get_random_social(struct p2p_config *p2p, u8 *op_class,
2024				 u8 *op_channel,
2025				 struct wpa_freq_range_list *avoid_list,
2026				 struct wpa_freq_range_list *disallow_list);
2027
2028int p2p_set_listen_channel(struct p2p_data *p2p, u8 reg_class, u8 channel,
2029			   u8 forced);
2030
2031u8 p2p_get_listen_channel(struct p2p_data *p2p);
2032
2033int p2p_set_ssid_postfix(struct p2p_data *p2p, const u8 *postfix, size_t len);
2034
2035int p2p_get_interface_addr(struct p2p_data *p2p, const u8 *dev_addr,
2036			   u8 *iface_addr);
2037int p2p_get_dev_addr(struct p2p_data *p2p, const u8 *iface_addr,
2038			   u8 *dev_addr);
2039
2040void p2p_set_peer_filter(struct p2p_data *p2p, const u8 *addr);
2041
2042/**
2043 * p2p_set_cross_connect - Set cross connection capability
2044 * @p2p: P2P module context from p2p_init()
2045 * @enabled: Whether cross connection will be enabled
2046 */
2047void p2p_set_cross_connect(struct p2p_data *p2p, int enabled);
2048
2049int p2p_get_oper_freq(struct p2p_data *p2p, const u8 *iface_addr);
2050
2051/**
2052 * p2p_set_intra_bss_dist - Set intra BSS distribution
2053 * @p2p: P2P module context from p2p_init()
2054 * @enabled: Whether intra BSS distribution will be enabled
2055 */
2056void p2p_set_intra_bss_dist(struct p2p_data *p2p, int enabled);
2057
2058int p2p_channels_includes_freq(const struct p2p_channels *channels,
2059			       unsigned int freq);
2060
2061int p2p_channels_to_freqs(const struct p2p_channels *channels,
2062			  int *freq_list, unsigned int max_len);
2063
2064/**
2065 * p2p_supported_freq - Check whether channel is supported for P2P
2066 * @p2p: P2P module context from p2p_init()
2067 * @freq: Channel frequency in MHz
2068 * Returns: 0 if channel not usable for P2P, 1 if usable for P2P
2069 */
2070int p2p_supported_freq(struct p2p_data *p2p, unsigned int freq);
2071
2072/**
2073 * p2p_supported_freq_go - Check whether channel is supported for P2P GO operation
2074 * @p2p: P2P module context from p2p_init()
2075 * @freq: Channel frequency in MHz
2076 * Returns: 0 if channel not usable for P2P, 1 if usable for P2P
2077 */
2078int p2p_supported_freq_go(struct p2p_data *p2p, unsigned int freq);
2079
2080/**
2081 * p2p_supported_freq_cli - Check whether channel is supported for P2P client operation
2082 * @p2p: P2P module context from p2p_init()
2083 * @freq: Channel frequency in MHz
2084 * Returns: 0 if channel not usable for P2P, 1 if usable for P2P
2085 */
2086int p2p_supported_freq_cli(struct p2p_data *p2p, unsigned int freq);
2087
2088/**
2089 * p2p_get_pref_freq - Get channel from preferred channel list
2090 * @p2p: P2P module context from p2p_init()
2091 * @channels: List of channels
2092 * Returns: Preferred channel
2093 */
2094unsigned int p2p_get_pref_freq(struct p2p_data *p2p,
2095			       const struct p2p_channels *channels);
2096
2097void p2p_update_channel_list(struct p2p_data *p2p,
2098			     const struct p2p_channels *chan,
2099			     const struct p2p_channels *cli_chan);
2100
2101/**
2102 * p2p_set_best_channels - Update best channel information
2103 * @p2p: P2P module context from p2p_init()
2104 * @freq_24: Frequency (MHz) of best channel in 2.4 GHz band
2105 * @freq_5: Frequency (MHz) of best channel in 5 GHz band
2106 * @freq_overall: Frequency (MHz) of best channel overall
2107 */
2108void p2p_set_best_channels(struct p2p_data *p2p, int freq_24, int freq_5,
2109			   int freq_overall);
2110
2111/**
2112 * p2p_set_own_freq_preference - Set own preference for channel
2113 * @p2p: P2P module context from p2p_init()
2114 * @freq: Frequency (MHz) of the preferred channel or 0 if no preference
2115 *
2116 * This function can be used to set a preference on the operating channel based
2117 * on frequencies used on the other virtual interfaces that share the same
2118 * radio. If non-zero, this is used to try to avoid multi-channel concurrency.
2119 */
2120void p2p_set_own_freq_preference(struct p2p_data *p2p, int freq);
2121
2122const u8 * p2p_get_go_neg_peer(struct p2p_data *p2p);
2123
2124/**
2125 * p2p_get_group_num_members - Get number of members in group
2126 * @group: P2P group context from p2p_group_init()
2127 * Returns: Number of members in the group
2128 */
2129unsigned int p2p_get_group_num_members(struct p2p_group *group);
2130
2131/**
2132 * p2p_client_limit_reached - Check if client limit is reached
2133 * @group: P2P group context from p2p_group_init()
2134 * Returns: 1 if no of clients limit reached
2135 */
2136int p2p_client_limit_reached(struct p2p_group *group);
2137
2138/**
2139 * p2p_iterate_group_members - Iterate group members
2140 * @group: P2P group context from p2p_group_init()
2141 * @next: iteration pointer, must be a pointer to a void * that is set to %NULL
2142 *	on the first call and not modified later
2143 * Returns: A P2P Device Address for each call and %NULL for no more members
2144 */
2145const u8 * p2p_iterate_group_members(struct p2p_group *group, void **next);
2146
2147/**
2148 * p2p_group_get_client_interface_addr - Get P2P Interface Address of a client in a group
2149 * @group: P2P group context from p2p_group_init()
2150 * @dev_addr: P2P Device Address of the client
2151 * Returns: P2P Interface Address of the client if found or %NULL if no match
2152 * found
2153 */
2154const u8 * p2p_group_get_client_interface_addr(struct p2p_group *group,
2155					       const u8 *dev_addr);
2156
2157/**
2158 * p2p_group_get_dev_addr - Get a P2P Device Address of a client in a group
2159 * @group: P2P group context from p2p_group_init()
2160 * @addr: P2P Interface Address of the client
2161 * Returns: P2P Device Address of the client if found or %NULL if no match
2162 * found
2163 */
2164const u8 * p2p_group_get_dev_addr(struct p2p_group *group, const u8 *addr);
2165
2166/**
2167 * p2p_group_is_client_connected - Check whether a specific client is connected
2168 * @group: P2P group context from p2p_group_init()
2169 * @addr: P2P Device Address of the client
2170 * Returns: 1 if client is connected or 0 if not
2171 */
2172int p2p_group_is_client_connected(struct p2p_group *group, const u8 *dev_addr);
2173
2174/**
2175 * p2p_group_get_config - Get the group configuration
2176 * @group: P2P group context from p2p_group_init()
2177 * Returns: The group configuration pointer
2178 */
2179const struct p2p_group_config * p2p_group_get_config(struct p2p_group *group);
2180
2181/**
2182 * p2p_loop_on_all_groups - Run the given callback on all groups
2183 * @p2p: P2P module context from p2p_init()
2184 * @group_callback: The callback function pointer
2185 * @user_data: Some user data pointer which can be %NULL
2186 *
2187 * The group_callback function can stop the iteration by returning 0.
2188 */
2189void p2p_loop_on_all_groups(struct p2p_data *p2p,
2190			    int (*group_callback)(struct p2p_group *group,
2191						  void *user_data),
2192			    void *user_data);
2193
2194/**
2195 * p2p_get_peer_found - Get P2P peer info structure of a found peer
2196 * @p2p: P2P module context from p2p_init()
2197 * @addr: P2P Device Address of the peer or %NULL to indicate the first peer
2198 * @next: Whether to select the peer entry following the one indicated by addr
2199 * Returns: The first P2P peer info available or %NULL if no such peer exists
2200 */
2201const struct p2p_peer_info *
2202p2p_get_peer_found(struct p2p_data *p2p, const u8 *addr, int next);
2203
2204/**
2205 * p2p_remove_wps_vendor_extensions - Remove WPS vendor extensions
2206 * @p2p: P2P module context from p2p_init()
2207 */
2208void p2p_remove_wps_vendor_extensions(struct p2p_data *p2p);
2209
2210/**
2211 * p2p_add_wps_vendor_extension - Add a WPS vendor extension
2212 * @p2p: P2P module context from p2p_init()
2213 * @vendor_ext: The vendor extensions to add
2214 * Returns: 0 on success, -1 on failure
2215 *
2216 * The wpabuf structures in the array are owned by the P2P
2217 * module after this call.
2218 */
2219int p2p_add_wps_vendor_extension(struct p2p_data *p2p,
2220				 const struct wpabuf *vendor_ext);
2221
2222/**
2223 * p2p_set_oper_channel - Set the P2P operating channel
2224 * @p2p: P2P module context from p2p_init()
2225 * @op_reg_class: Operating regulatory class to set
2226 * @op_channel: operating channel to set
2227 * @cfg_op_channel : Whether op_channel is hardcoded in configuration
2228 * Returns: 0 on success, -1 on failure
2229 */
2230int p2p_set_oper_channel(struct p2p_data *p2p, u8 op_reg_class, u8 op_channel,
2231			 int cfg_op_channel);
2232
2233/**
2234 * p2p_set_pref_chan - Set P2P preferred channel list
2235 * @p2p: P2P module context from p2p_init()
2236 * @num_pref_chan: Number of entries in pref_chan list
2237 * @pref_chan: Preferred channels or %NULL to remove preferences
2238 * Returns: 0 on success, -1 on failure
2239 */
2240int p2p_set_pref_chan(struct p2p_data *p2p, unsigned int num_pref_chan,
2241		      const struct p2p_channel *pref_chan);
2242
2243/**
2244 * p2p_set_no_go_freq - Set no GO channel ranges
2245 * @p2p: P2P module context from p2p_init()
2246 * @list: Channel ranges or %NULL to remove restriction
2247 * Returns: 0 on success, -1 on failure
2248 */
2249int p2p_set_no_go_freq(struct p2p_data *p2p,
2250		       const struct wpa_freq_range_list *list);
2251
2252/**
2253 * p2p_in_progress - Check whether a P2P operation is progress
2254 * @p2p: P2P module context from p2p_init()
2255 * Returns: 0 if P2P module is idle, 1 if an operation is in progress but not
2256 * in search state, or 2 if search state operation is in progress
2257 */
2258int p2p_in_progress(struct p2p_data *p2p);
2259
2260const char * p2p_wps_method_text(enum p2p_wps_method method);
2261
2262/**
2263 * p2p_set_config_timeout - Set local config timeouts
2264 * @p2p: P2P module context from p2p_init()
2265 * @go_timeout: Time in 10 ms units it takes to start the GO mode
2266 * @client_timeout: Time in 10 ms units it takes to start the client mode
2267 */
2268void p2p_set_config_timeout(struct p2p_data *p2p, u8 go_timeout,
2269			    u8 client_timeout);
2270
2271int p2p_set_wfd_ie_beacon(struct p2p_data *p2p, struct wpabuf *ie);
2272int p2p_set_wfd_ie_probe_req(struct p2p_data *p2p, struct wpabuf *ie);
2273int p2p_set_wfd_ie_probe_resp(struct p2p_data *p2p, struct wpabuf *ie);
2274int p2p_set_wfd_ie_assoc_req(struct p2p_data *p2p, struct wpabuf *ie);
2275int p2p_set_wfd_ie_invitation(struct p2p_data *p2p, struct wpabuf *ie);
2276int p2p_set_wfd_ie_prov_disc_req(struct p2p_data *p2p, struct wpabuf *ie);
2277int p2p_set_wfd_ie_prov_disc_resp(struct p2p_data *p2p, struct wpabuf *ie);
2278int p2p_set_wfd_ie_go_neg(struct p2p_data *p2p, struct wpabuf *ie);
2279int p2p_set_wfd_dev_info(struct p2p_data *p2p, const struct wpabuf *elem);
2280int p2p_set_wfd_r2_dev_info(struct p2p_data *p2p, const struct wpabuf *elem);
2281int p2p_set_wfd_assoc_bssid(struct p2p_data *p2p, const struct wpabuf *elem);
2282int p2p_set_wfd_coupled_sink_info(struct p2p_data *p2p,
2283				  const struct wpabuf *elem);
2284struct wpabuf * wifi_display_encaps(struct wpabuf *subelems);
2285
2286/**
2287 * p2p_set_disc_int - Set min/max discoverable interval for p2p_find
2288 * @p2p: P2P module context from p2p_init()
2289 * @min_disc_int: minDiscoverableInterval (in units of 100 TU); default 1
2290 * @max_disc_int: maxDiscoverableInterval (in units of 100 TU); default 3
2291 * @max_disc_tu: Maximum number of TUs (1.024 ms) for discoverable interval; or
2292 *	-1 not to limit
2293 * Returns: 0 on success, or -1 on failure
2294 *
2295 * This function can be used to configure minDiscoverableInterval and
2296 * maxDiscoverableInterval parameters for the Listen state during device
2297 * discovery (p2p_find). A random number of 100 TU units is picked for each
2298 * Listen state iteration from [min_disc_int,max_disc_int] range.
2299 *
2300 * max_disc_tu can be used to further limit the discoverable duration. However,
2301 * it should be noted that use of this parameter is not recommended since it
2302 * would not be compliant with the P2P specification.
2303 */
2304int p2p_set_disc_int(struct p2p_data *p2p, int min_disc_int, int max_disc_int,
2305		     int max_disc_tu);
2306
2307/**
2308 * p2p_get_state_txt - Get current P2P state for debug purposes
2309 * @p2p: P2P module context from p2p_init()
2310 * Returns: Name of the current P2P module state
2311 *
2312 * It should be noted that the P2P module state names are internal information
2313 * and subject to change at any point, i.e., this information should be used
2314 * mainly for debugging purposes.
2315 */
2316const char * p2p_get_state_txt(struct p2p_data *p2p);
2317
2318struct wpabuf * p2p_build_nfc_handover_req(struct p2p_data *p2p,
2319					   int client_freq,
2320					   const u8 *go_dev_addr,
2321					   const u8 *ssid, size_t ssid_len);
2322struct wpabuf * p2p_build_nfc_handover_sel(struct p2p_data *p2p,
2323					   int client_freq,
2324					   const u8 *go_dev_addr,
2325					   const u8 *ssid, size_t ssid_len);
2326
2327struct p2p_nfc_params {
2328	int sel;
2329	const u8 *wsc_attr;
2330	size_t wsc_len;
2331	const u8 *p2p_attr;
2332	size_t p2p_len;
2333
2334	enum {
2335		NO_ACTION, JOIN_GROUP, AUTH_JOIN, INIT_GO_NEG, RESP_GO_NEG,
2336		BOTH_GO, PEER_CLIENT
2337	} next_step;
2338	struct p2p_peer_info *peer;
2339	u8 oob_dev_pw[WPS_OOB_PUBKEY_HASH_LEN + 2 +
2340		      WPS_OOB_DEVICE_PASSWORD_LEN];
2341	size_t oob_dev_pw_len;
2342	int go_freq;
2343	u8 go_dev_addr[ETH_ALEN];
2344	u8 go_ssid[SSID_MAX_LEN];
2345	size_t go_ssid_len;
2346};
2347
2348int p2p_process_nfc_connection_handover(struct p2p_data *p2p,
2349					struct p2p_nfc_params *params);
2350
2351void p2p_set_authorized_oob_dev_pw_id(struct p2p_data *p2p, u16 dev_pw_id,
2352				      int go_intent,
2353				      const u8 *own_interface_addr);
2354
2355int p2p_set_passphrase_len(struct p2p_data *p2p, unsigned int len);
2356
2357void p2p_loop_on_known_peers(struct p2p_data *p2p,
2358			     void (*peer_callback)(struct p2p_peer_info *peer,
2359						   void *user_data),
2360			     void *user_data);
2361
2362void p2p_set_vendor_elems(struct p2p_data *p2p, struct wpabuf **vendor_elem);
2363
2364void p2p_set_intended_addr(struct p2p_data *p2p, const u8 *intended_addr);
2365
2366struct p2ps_advertisement *
2367p2p_service_p2ps_id(struct p2p_data *p2p, u32 adv_id);
2368int p2p_service_add_asp(struct p2p_data *p2p, int auto_accept, u32 adv_id,
2369			const char *adv_str, u8 svc_state,
2370			u16 config_methods, const char *svc_info,
2371			const u8 *cpt_priority);
2372int p2p_service_del_asp(struct p2p_data *p2p, u32 adv_id);
2373void p2p_service_flush_asp(struct p2p_data *p2p);
2374struct p2ps_advertisement * p2p_get_p2ps_adv_list(struct p2p_data *p2p);
2375
2376/**
2377 * p2p_expire_peers - Periodic cleanup function to expire peers
2378 * @p2p: P2P module context from p2p_init()
2379 *
2380 * This is a cleanup function that the entity calling p2p_init() is
2381 * expected to call periodically to clean up expired peer entries.
2382 */
2383void p2p_expire_peers(struct p2p_data *p2p);
2384
2385void p2p_set_own_pref_freq_list(struct p2p_data *p2p,
2386				const unsigned int *pref_freq_list,
2387				unsigned int size);
2388void p2p_set_override_pref_op_chan(struct p2p_data *p2p, u8 op_class,
2389				   u8 chan);
2390
2391/**
2392 * p2p_group_get_common_freqs - Get the group common frequencies
2393 * @group: P2P group context from p2p_group_init()
2394 * @common_freqs: On return will hold the group common frequencies
2395 * @num: On return will hold the number of group common frequencies
2396 * Returns: 0 on success, -1 otherwise
2397 */
2398int p2p_group_get_common_freqs(struct p2p_group *group, int *common_freqs,
2399			       unsigned int *num);
2400
2401struct wpabuf * p2p_build_probe_resp_template(struct p2p_data *p2p,
2402					      unsigned int freq);
2403
2404#endif /* P2P_H */
2405