p2p.h revision f86232838cf712377867cb42417c1613ab5dc425
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/**
13 * P2P_MAX_REG_CLASSES - Maximum number of regulatory classes
14 */
15#define P2P_MAX_REG_CLASSES 10
16
17/**
18 * P2P_MAX_REG_CLASS_CHANNELS - Maximum number of channels per regulatory class
19 */
20#define P2P_MAX_REG_CLASS_CHANNELS 20
21
22/**
23 * struct p2p_channels - List of supported channels
24 */
25struct p2p_channels {
26	/**
27	 * struct p2p_reg_class - Supported regulatory class
28	 */
29	struct p2p_reg_class {
30		/**
31		 * reg_class - Regulatory class (IEEE 802.11-2007, Annex J)
32		 */
33		u8 reg_class;
34
35		/**
36		 * channel - Supported channels
37		 */
38		u8 channel[P2P_MAX_REG_CLASS_CHANNELS];
39
40		/**
41		 * channels - Number of channel entries in use
42		 */
43		size_t channels;
44	} reg_class[P2P_MAX_REG_CLASSES];
45
46	/**
47	 * reg_classes - Number of reg_class entries in use
48	 */
49	size_t reg_classes;
50};
51
52enum p2p_wps_method {
53	WPS_NOT_READY, WPS_PIN_DISPLAY, WPS_PIN_KEYPAD, WPS_PBC
54};
55
56enum p2p_sd_action {
57	SRV_UPDATE, SRV_ADD, SRV_DEL, SRV_FLUSH
58};
59
60/**
61 * struct p2p_go_neg_results - P2P Group Owner Negotiation results
62 */
63struct p2p_go_neg_results {
64	/**
65	 * status - Negotiation result (Status Code)
66	 *
67	 * 0 (P2P_SC_SUCCESS) indicates success. Non-zero values indicate
68	 * failed negotiation.
69	 */
70	int status;
71
72	/**
73	 * role_go - Whether local end is Group Owner
74	 */
75	int role_go;
76
77	/**
78	 * freq - Frequency of the group operational channel in MHz
79	 */
80	int freq;
81
82	int ht40;
83
84	/**
85	 * ssid - SSID of the group
86	 */
87	u8 ssid[32];
88
89	/**
90	 * ssid_len - Length of SSID in octets
91	 */
92	size_t ssid_len;
93
94	/**
95	 * psk - WPA pre-shared key (256 bits) (GO only)
96	 */
97	u8 psk[32];
98
99	/**
100	 * psk_set - Whether PSK field is configured (GO only)
101	 */
102	int psk_set;
103
104	/**
105	 * passphrase - WPA2-Personal passphrase for the group (GO only)
106	 */
107	char passphrase[64];
108
109	/**
110	 * peer_device_addr - P2P Device Address of the peer
111	 */
112	u8 peer_device_addr[ETH_ALEN];
113
114	/**
115	 * peer_interface_addr - P2P Interface Address of the peer
116	 */
117	u8 peer_interface_addr[ETH_ALEN];
118
119	/**
120	 * wps_method - WPS method to be used during provisioning
121	 */
122	enum p2p_wps_method wps_method;
123
124#define P2P_MAX_CHANNELS 50
125
126	/**
127	 * freq_list - Zero-terminated list of possible operational channels
128	 */
129	int freq_list[P2P_MAX_CHANNELS];
130
131	/**
132	 * persistent_group - Whether the group should be made persistent
133	 * 0 = not persistent
134	 * 1 = persistent group without persistent reconnect
135	 * 2 = persistent group with persistent reconnect
136	 */
137	int persistent_group;
138
139	/**
140	 * peer_config_timeout - Peer configuration timeout (in 10 msec units)
141	 */
142	unsigned int peer_config_timeout;
143};
144
145struct p2p_data;
146
147enum p2p_scan_type {
148	P2P_SCAN_SOCIAL,
149	P2P_SCAN_FULL,
150	P2P_SCAN_SPECIFIC,
151	P2P_SCAN_SOCIAL_PLUS_ONE
152};
153
154#define P2P_MAX_WPS_VENDOR_EXT 10
155
156/**
157 * struct p2p_peer_info - P2P peer information
158 */
159struct p2p_peer_info {
160	/**
161	 * p2p_device_addr - P2P Device Address of the peer
162	 */
163	u8 p2p_device_addr[ETH_ALEN];
164
165	/**
166	 * pri_dev_type - Primary Device Type
167	 */
168	u8 pri_dev_type[8];
169
170	/**
171	 * device_name - Device Name (0..32 octets encoded in UTF-8)
172	 */
173	char device_name[33];
174
175	/**
176	 * manufacturer - Manufacturer (0..64 octets encoded in UTF-8)
177	 */
178	char manufacturer[65];
179
180	/**
181	 * model_name - Model Name (0..32 octets encoded in UTF-8)
182	 */
183	char model_name[33];
184
185	/**
186	 * model_number - Model Number (0..32 octets encoded in UTF-8)
187	 */
188	char model_number[33];
189
190	/**
191	 * serial_number - Serial Number (0..32 octets encoded in UTF-8)
192	 */
193	char serial_number[33];
194
195	/**
196	 * level - Signal level
197	 */
198	int level;
199
200	/**
201	 * config_methods - WPS Configuration Methods
202	 */
203	u16 config_methods;
204
205	/**
206	 * dev_capab - Device Capabilities
207	 */
208	u8 dev_capab;
209
210	/**
211	 * group_capab - Group Capabilities
212	 */
213	u8 group_capab;
214
215	/**
216	 * wps_sec_dev_type_list - WPS secondary device type list
217	 *
218	 * This list includes from 0 to 16 Secondary Device Types as indicated
219	 * by wps_sec_dev_type_list_len (8 * number of types).
220	 */
221	u8 wps_sec_dev_type_list[128];
222
223	/**
224	 * wps_sec_dev_type_list_len - Length of secondary device type list
225	 */
226	size_t wps_sec_dev_type_list_len;
227
228	struct wpabuf *wps_vendor_ext[P2P_MAX_WPS_VENDOR_EXT];
229
230	/**
231	 * wfd_subelems - Wi-Fi Display subelements from WFD IE(s)
232	 */
233	struct wpabuf *wfd_subelems;
234};
235
236enum p2p_prov_disc_status {
237	P2P_PROV_DISC_SUCCESS,
238	P2P_PROV_DISC_TIMEOUT,
239	P2P_PROV_DISC_REJECTED,
240	P2P_PROV_DISC_TIMEOUT_JOIN,
241};
242
243struct p2p_channel {
244	u8 op_class;
245	u8 chan;
246};
247
248/**
249 * struct p2p_config - P2P configuration
250 *
251 * This configuration is provided to the P2P module during initialization with
252 * p2p_init().
253 */
254struct p2p_config {
255	/**
256	 * country - Country code to use in P2P operations
257	 */
258	char country[3];
259
260	/**
261	 * reg_class - Regulatory class for own listen channel
262	 */
263	u8 reg_class;
264
265	/**
266	 * channel - Own listen channel
267	 */
268	u8 channel;
269
270	/**
271	 * Regulatory class for own operational channel
272	 */
273	u8 op_reg_class;
274
275	/**
276	 * op_channel - Own operational channel
277	 */
278	u8 op_channel;
279
280	/**
281	 * cfg_op_channel - Whether op_channel is hardcoded in configuration
282	 */
283	u8 cfg_op_channel;
284
285	/**
286	 * channels - Own supported regulatory classes and channels
287	 *
288	 * List of supposerted channels per regulatory class. The regulatory
289	 * classes are defined in IEEE Std 802.11-2007 Annex J and the
290	 * numbering of the clases depends on the configured country code.
291	 */
292	struct p2p_channels channels;
293
294	/**
295	 * num_pref_chan - Number of pref_chan entries
296	 */
297	unsigned int num_pref_chan;
298
299	/**
300	 * pref_chan - Preferred channels for GO Negotiation
301	 */
302	struct p2p_channel *pref_chan;
303
304	/**
305	 * pri_dev_type - Primary Device Type (see WPS)
306	 */
307	u8 pri_dev_type[8];
308
309	/**
310	 * P2P_SEC_DEVICE_TYPES - Maximum number of secondary device types
311	 */
312#define P2P_SEC_DEVICE_TYPES 5
313
314	/**
315	 * sec_dev_type - Optional secondary device types
316	 */
317	u8 sec_dev_type[P2P_SEC_DEVICE_TYPES][8];
318
319	/**
320	 * num_sec_dev_types - Number of sec_dev_type entries
321	 */
322	size_t num_sec_dev_types;
323
324	/**
325	 * dev_addr - P2P Device Address
326	 */
327	u8 dev_addr[ETH_ALEN];
328
329	/**
330	 * dev_name - Device Name
331	 */
332	char *dev_name;
333
334	char *manufacturer;
335	char *model_name;
336	char *model_number;
337	char *serial_number;
338
339	u8 uuid[16];
340	u16 config_methods;
341
342	/**
343	 * concurrent_operations - Whether concurrent operations are supported
344	 */
345	int concurrent_operations;
346
347	/**
348	 * max_peers - Maximum number of discovered peers to remember
349	 *
350	 * If more peers are discovered, older entries will be removed to make
351	 * room for the new ones.
352	 */
353	size_t max_peers;
354
355	/**
356	 * p2p_intra_bss - Intra BSS communication is supported
357	 */
358	int p2p_intra_bss;
359
360	/**
361	 * ssid_postfix - Postfix data to add to the SSID
362	 *
363	 * This data will be added to the end of the SSID after the
364	 * DIRECT-<random two octets> prefix.
365	 */
366	u8 ssid_postfix[32 - 9];
367
368	/**
369	 * ssid_postfix_len - Length of the ssid_postfix data
370	 */
371	size_t ssid_postfix_len;
372
373	/**
374	 * max_listen - Maximum listen duration in ms
375	 */
376	unsigned int max_listen;
377
378#ifdef ANDROID_P2P
379	enum p2p_concurrency_type {
380		P2P_NON_CONCURRENT,
381		P2P_SINGLE_CHANNEL_CONCURRENT,
382		P2P_MULTI_CHANNEL_CONCURRENT,
383	} p2p_concurrency;
384#endif
385
386	/**
387	 * msg_ctx - Context to use with wpa_msg() calls
388	 */
389	void *msg_ctx;
390
391	/**
392	 * cb_ctx - Context to use with callback functions
393	 */
394	void *cb_ctx;
395
396
397	/* Callbacks to request lower layer driver operations */
398
399	/**
400	 * p2p_scan - Request a P2P scan/search
401	 * @ctx: Callback context from cb_ctx
402	 * @type: Scan type
403	 * @freq: Specific frequency (MHz) to scan or 0 for no restriction
404	 * @num_req_dev_types: Number of requested device types
405	 * @req_dev_types: Array containing requested device types
406	 * @dev_id: Device ID to search for or %NULL to find all devices
407	 * @pw_id: Device Password ID
408	 * Returns: 0 on success, -1 on failure
409	 *
410	 * This callback function is used to request a P2P scan or search
411	 * operation to be completed. Type type argument specifies which type
412	 * of scan is to be done. @P2P_SCAN_SOCIAL indicates that only the
413	 * social channels (1, 6, 11) should be scanned. @P2P_SCAN_FULL
414	 * indicates that all channels are to be scanned.
415	 * @P2P_SCAN_SOCIAL_PLUS_ONE request scan of all the social channels
416	 * plus one extra channel specified by freq.
417	 *
418	 * The full scan is used for the initial scan to find group owners from
419	 * all. The other types are used during search phase scan of the social
420	 * channels (with potential variation if the Listen channel of the
421	 * target peer is known or if other channels are scanned in steps).
422	 *
423	 * The scan results are returned after this call by calling
424	 * p2p_scan_res_handler() for each scan result that has a P2P IE and
425	 * then calling p2p_scan_res_handled() to indicate that all scan
426	 * results have been indicated.
427	 */
428	int (*p2p_scan)(void *ctx, enum p2p_scan_type type, int freq,
429			unsigned int num_req_dev_types,
430			const u8 *req_dev_types, const u8 *dev_id, u16 pw_id);
431
432	/**
433	 * send_probe_resp - Transmit a Probe Response frame
434	 * @ctx: Callback context from cb_ctx
435	 * @buf: Probe Response frame (including the header and body)
436	 * Returns: 0 on success, -1 on failure
437	 *
438	 * This function is used to reply to Probe Request frames that were
439	 * indicated with a call to p2p_probe_req_rx(). The response is to be
440	 * sent on the same channel or to be dropped if the driver is not
441	 * anymore listening to Probe Request frames.
442	 *
443	 * Alternatively, the responsibility for building the Probe Response
444	 * frames in Listen state may be in another system component in which
445	 * case this function need to be implemented (i.e., the function
446	 * pointer can be %NULL). The WPS and P2P IEs to be added for Probe
447	 * Response frames in such a case are available from the
448	 * start_listen() callback. It should be noted that the received Probe
449	 * Request frames must be indicated by calling p2p_probe_req_rx() even
450	 * if this send_probe_resp() is not used.
451	 */
452	int (*send_probe_resp)(void *ctx, const struct wpabuf *buf);
453
454	/**
455	 * send_action - Transmit an Action frame
456	 * @ctx: Callback context from cb_ctx
457	 * @freq: Frequency in MHz for the channel on which to transmit
458	 * @dst: Destination MAC address (Address 1)
459	 * @src: Source MAC address (Address 2)
460	 * @bssid: BSSID (Address 3)
461	 * @buf: Frame body (starting from Category field)
462	 * @len: Length of buf in octets
463	 * @wait_time: How many msec to wait for a response frame
464	 * Returns: 0 on success, -1 on failure
465	 *
466	 * The Action frame may not be transmitted immediately and the status
467	 * of the transmission must be reported by calling
468	 * p2p_send_action_cb() once the frame has either been transmitted or
469	 * it has been dropped due to excessive retries or other failure to
470	 * transmit.
471	 */
472	int (*send_action)(void *ctx, unsigned int freq, const u8 *dst,
473			   const u8 *src, const u8 *bssid, const u8 *buf,
474			   size_t len, unsigned int wait_time);
475
476	/**
477	 * send_action_done - Notify that Action frame sequence was completed
478	 * @ctx: Callback context from cb_ctx
479	 *
480	 * This function is called when the Action frame sequence that was
481	 * started with send_action() has been completed, i.e., when there is
482	 * no need to wait for a response from the destination peer anymore.
483	 */
484	void (*send_action_done)(void *ctx);
485
486	/**
487	 * start_listen - Start Listen state
488	 * @ctx: Callback context from cb_ctx
489	 * @freq: Frequency of the listen channel in MHz
490	 * @duration: Duration for the Listen state in milliseconds
491	 * @probe_resp_ie: IE(s) to be added to Probe Response frames
492	 * Returns: 0 on success, -1 on failure
493	 *
494	 * This Listen state may not start immediately since the driver may
495	 * have other pending operations to complete first. Once the Listen
496	 * state has started, p2p_listen_cb() must be called to notify the P2P
497	 * module. Once the Listen state is stopped, p2p_listen_end() must be
498	 * called to notify the P2P module that the driver is not in the Listen
499	 * state anymore.
500	 *
501	 * If the send_probe_resp() is not used for generating the response,
502	 * the IEs from probe_resp_ie need to be added to the end of the Probe
503	 * Response frame body. If send_probe_resp() is used, the probe_resp_ie
504	 * information can be ignored.
505	 */
506	int (*start_listen)(void *ctx, unsigned int freq,
507			    unsigned int duration,
508			    const struct wpabuf *probe_resp_ie);
509	/**
510	 * stop_listen - Stop Listen state
511	 * @ctx: Callback context from cb_ctx
512	 *
513	 * This callback can be used to stop a Listen state operation that was
514	 * previously requested with start_listen().
515	 */
516	void (*stop_listen)(void *ctx);
517
518	/**
519	 * get_noa - Get current Notice of Absence attribute payload
520	 * @ctx: Callback context from cb_ctx
521	 * @interface_addr: P2P Interface Address of the GO
522	 * @buf: Buffer for returning NoA
523	 * @buf_len: Buffer length in octets
524	 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
525	 * advertized, or -1 on failure
526	 *
527	 * This function is used to fetch the current Notice of Absence
528	 * attribute value from GO.
529	 */
530	int (*get_noa)(void *ctx, const u8 *interface_addr, u8 *buf,
531		       size_t buf_len);
532
533	/* Callbacks to notify events to upper layer management entity */
534
535	/**
536	 * dev_found - Notification of a found P2P Device
537	 * @ctx: Callback context from cb_ctx
538	 * @addr: Source address of the message triggering this notification
539	 * @info: P2P peer information
540	 * @new_device: Inform if the peer is newly found
541	 *
542	 * This callback is used to notify that a new P2P Device has been
543	 * found. This may happen, e.g., during Search state based on scan
544	 * results or during Listen state based on receive Probe Request and
545	 * Group Owner Negotiation Request.
546	 */
547	void (*dev_found)(void *ctx, const u8 *addr,
548			  const struct p2p_peer_info *info,
549			  int new_device);
550
551	/**
552	 * dev_lost - Notification of a lost P2P Device
553	 * @ctx: Callback context from cb_ctx
554	 * @dev_addr: P2P Device Address of the lost P2P Device
555	 *
556	 * This callback is used to notify that a P2P Device has been deleted.
557	 */
558	void (*dev_lost)(void *ctx, const u8 *dev_addr);
559
560	/**
561	 * go_neg_req_rx - Notification of a receive GO Negotiation Request
562	 * @ctx: Callback context from cb_ctx
563	 * @src: Source address of the message triggering this notification
564	 * @dev_passwd_id: WPS Device Password ID
565	 *
566	 * This callback is used to notify that a P2P Device is requesting
567	 * group owner negotiation with us, but we do not have all the
568	 * necessary information to start GO Negotiation. This indicates that
569	 * the local user has not authorized the connection yet by providing a
570	 * PIN or PBC button press. This information can be provided with a
571	 * call to p2p_connect().
572	 */
573	void (*go_neg_req_rx)(void *ctx, const u8 *src, u16 dev_passwd_id);
574
575	/**
576	 * go_neg_completed - Notification of GO Negotiation results
577	 * @ctx: Callback context from cb_ctx
578	 * @res: GO Negotiation results
579	 *
580	 * This callback is used to notify that Group Owner Negotiation has
581	 * been completed. Non-zero struct p2p_go_neg_results::status indicates
582	 * failed negotiation. In case of success, this function is responsible
583	 * for creating a new group interface (or using the existing interface
584	 * depending on driver features), setting up the group interface in
585	 * proper mode based on struct p2p_go_neg_results::role_go and
586	 * initializing WPS provisioning either as a Registrar (if GO) or as an
587	 * Enrollee. Successful WPS provisioning must be indicated by calling
588	 * p2p_wps_success_cb(). The callee is responsible for timing out group
589	 * formation if WPS provisioning cannot be completed successfully
590	 * within 15 seconds.
591	 */
592	void (*go_neg_completed)(void *ctx, struct p2p_go_neg_results *res);
593
594	/**
595	 * sd_request - Callback on Service Discovery Request
596	 * @ctx: Callback context from cb_ctx
597	 * @freq: Frequency (in MHz) of the channel
598	 * @sa: Source address of the request
599	 * @dialog_token: Dialog token
600	 * @update_indic: Service Update Indicator from the source of request
601	 * @tlvs: P2P Service Request TLV(s)
602	 * @tlvs_len: Length of tlvs buffer in octets
603	 *
604	 * This callback is used to indicate reception of a service discovery
605	 * request. Response to the query must be indicated by calling
606	 * p2p_sd_response() with the context information from the arguments to
607	 * this callback function.
608	 *
609	 * This callback handler can be set to %NULL to indicate that service
610	 * discovery is not supported.
611	 */
612	void (*sd_request)(void *ctx, int freq, const u8 *sa, u8 dialog_token,
613			   u16 update_indic, const u8 *tlvs, size_t tlvs_len);
614
615	/**
616	 * sd_response - Callback on Service Discovery Response
617	 * @ctx: Callback context from cb_ctx
618	 * @sa: Source address of the request
619	 * @update_indic: Service Update Indicator from the source of response
620	 * @tlvs: P2P Service Response TLV(s)
621	 * @tlvs_len: Length of tlvs buffer in octets
622	 *
623	 * This callback is used to indicate reception of a service discovery
624	 * response. This callback handler can be set to %NULL if no service
625	 * discovery requests are used. The information provided with this call
626	 * is replies to the queries scheduled with p2p_sd_request().
627	 */
628	void (*sd_response)(void *ctx, const u8 *sa, u16 update_indic,
629			    const u8 *tlvs, size_t tlvs_len);
630
631	/**
632	 * prov_disc_req - Callback on Provisiong Discovery Request
633	 * @ctx: Callback context from cb_ctx
634	 * @peer: Source address of the request
635	 * @config_methods: Requested WPS Config Method
636	 * @dev_addr: P2P Device Address of the found P2P Device
637	 * @pri_dev_type: Primary Device Type
638	 * @dev_name: Device Name
639	 * @supp_config_methods: Supported configuration Methods
640	 * @dev_capab: Device Capabilities
641	 * @group_capab: Group Capabilities
642	 * @group_id: P2P Group ID (or %NULL if not included)
643	 * @group_id_len: Length of P2P Group ID
644	 *
645	 * This callback is used to indicate reception of a Provision Discovery
646	 * Request frame that the P2P module accepted.
647	 */
648	void (*prov_disc_req)(void *ctx, const u8 *peer, u16 config_methods,
649			      const u8 *dev_addr, const u8 *pri_dev_type,
650			      const char *dev_name, u16 supp_config_methods,
651			      u8 dev_capab, u8 group_capab,
652			      const u8 *group_id, size_t group_id_len);
653
654	/**
655	 * prov_disc_resp - Callback on Provisiong Discovery Response
656	 * @ctx: Callback context from cb_ctx
657	 * @peer: Source address of the response
658	 * @config_methods: Value from p2p_prov_disc_req() or 0 on failure
659	 *
660	 * This callback is used to indicate reception of a Provision Discovery
661	 * Response frame for a pending request scheduled with
662	 * p2p_prov_disc_req(). This callback handler can be set to %NULL if
663	 * provision discovery is not used.
664	 */
665	void (*prov_disc_resp)(void *ctx, const u8 *peer, u16 config_methods);
666
667	/**
668	 * prov_disc_fail - Callback on Provision Discovery failure
669	 * @ctx: Callback context from cb_ctx
670	 * @peer: Source address of the response
671	 * @status: Cause of failure, will not be %P2P_PROV_DISC_SUCCESS
672	 *
673	 * This callback is used to indicate either a failure or no response
674	 * to an earlier provision discovery request.
675	 *
676	 * This callback handler can be set to %NULL if provision discovery
677	 * is not used or failures do not need to be indicated.
678	 */
679	void (*prov_disc_fail)(void *ctx, const u8 *peer,
680			       enum p2p_prov_disc_status status);
681
682	/**
683	 * invitation_process - Optional callback for processing Invitations
684	 * @ctx: Callback context from cb_ctx
685	 * @sa: Source address of the Invitation Request
686	 * @bssid: P2P Group BSSID from the request or %NULL if not included
687	 * @go_dev_addr: GO Device Address from P2P Group ID
688	 * @ssid: SSID from P2P Group ID
689	 * @ssid_len: Length of ssid buffer in octets
690	 * @go: Variable for returning whether the local end is GO in the group
691	 * @group_bssid: Buffer for returning P2P Group BSSID (if local end GO)
692	 * @force_freq: Variable for returning forced frequency for the group
693	 * @persistent_group: Whether this is an invitation to reinvoke a
694	 *	persistent group (instead of invitation to join an active
695	 *	group)
696	 * Returns: Status code (P2P_SC_*)
697	 *
698	 * This optional callback can be used to implement persistent reconnect
699	 * by allowing automatic restarting of persistent groups without user
700	 * interaction. If this callback is not implemented (i.e., is %NULL),
701	 * the received Invitation Request frames are replied with
702	 * %P2P_SC_REQ_RECEIVED status and indicated to upper layer with the
703	 * invitation_result() callback.
704	 *
705	 * If the requested parameters are acceptable and the group is known,
706	 * %P2P_SC_SUCCESS may be returned. If the requested group is unknown,
707	 * %P2P_SC_FAIL_UNKNOWN_GROUP should be returned. %P2P_SC_REQ_RECEIVED
708	 * can be returned if there is not enough data to provide immediate
709	 * response, i.e., if some sort of user interaction is needed. The
710	 * invitation_received() callback will be called in that case
711	 * immediately after this call.
712	 */
713	u8 (*invitation_process)(void *ctx, const u8 *sa, const u8 *bssid,
714				 const u8 *go_dev_addr, const u8 *ssid,
715				 size_t ssid_len, int *go, u8 *group_bssid,
716				 int *force_freq, int persistent_group);
717
718	/**
719	 * invitation_received - Callback on Invitation Request RX
720	 * @ctx: Callback context from cb_ctx
721	 * @sa: Source address of the Invitation Request
722	 * @bssid: P2P Group BSSID or %NULL if not received
723	 * @ssid: SSID of the group
724	 * @ssid_len: Length of ssid in octets
725	 * @go_dev_addr: GO Device Address
726	 * @status: Response Status
727	 * @op_freq: Operational frequency for the group
728	 *
729	 * This callback is used to indicate sending of an Invitation Response
730	 * for a received Invitation Request. If status == 0 (success), the
731	 * upper layer code is responsible for starting the group. status == 1
732	 * indicates need to get user authorization for the group. Other status
733	 * values indicate that the invitation request was rejected.
734	 */
735	void (*invitation_received)(void *ctx, const u8 *sa, const u8 *bssid,
736				    const u8 *ssid, size_t ssid_len,
737				    const u8 *go_dev_addr, u8 status,
738				    int op_freq);
739
740	/**
741	 * invitation_result - Callback on Invitation result
742	 * @ctx: Callback context from cb_ctx
743	 * @status: Negotiation result (Status Code)
744	 * @bssid: P2P Group BSSID or %NULL if not received
745	 *
746	 * This callback is used to indicate result of an Invitation procedure
747	 * started with a call to p2p_invite(). The indicated status code is
748	 * the value received from the peer in Invitation Response with 0
749	 * (P2P_SC_SUCCESS) indicating success or -1 to indicate a timeout or a
750	 * local failure in transmitting the Invitation Request.
751	 */
752	void (*invitation_result)(void *ctx, int status, const u8 *bssid);
753
754	/**
755	 * go_connected - Check whether we are connected to a GO
756	 * @ctx: Callback context from cb_ctx
757	 * @dev_addr: P2P Device Address of a GO
758	 * Returns: 1 if we are connected as a P2P client to the specified GO
759	 * or 0 if not.
760	 */
761	int (*go_connected)(void *ctx, const u8 *dev_addr);
762};
763
764
765/* P2P module initialization/deinitialization */
766
767/**
768 * p2p_init - Initialize P2P module
769 * @cfg: P2P module configuration
770 * Returns: Pointer to private data or %NULL on failure
771 *
772 * This function is used to initialize global P2P module context (one per
773 * device). The P2P module will keep a copy of the configuration data, so the
774 * caller does not need to maintain this structure. However, the callback
775 * functions and the context parameters to them must be kept available until
776 * the P2P module is deinitialized with p2p_deinit().
777 */
778struct p2p_data * p2p_init(const struct p2p_config *cfg);
779
780/**
781 * p2p_deinit - Deinitialize P2P module
782 * @p2p: P2P module context from p2p_init()
783 */
784void p2p_deinit(struct p2p_data *p2p);
785
786/**
787 * p2p_flush - Flush P2P module state
788 * @p2p: P2P module context from p2p_init()
789 *
790 * This command removes the P2P module state like peer device entries.
791 */
792void p2p_flush(struct p2p_data *p2p);
793
794/**
795 * p2p_unauthorize - Unauthorize the specified peer device
796 * @p2p: P2P module context from p2p_init()
797 * @addr: P2P peer entry to be unauthorized
798 * Returns: 0 on success, -1 on failure
799 *
800 * This command removes any connection authorization from the specified P2P
801 * peer device address. This can be used, e.g., to cancel effect of a previous
802 * p2p_authorize() or p2p_connect() call that has not yet resulted in completed
803 * GO Negotiation.
804 */
805int p2p_unauthorize(struct p2p_data *p2p, const u8 *addr);
806
807/**
808 * p2p_set_dev_name - Set device name
809 * @p2p: P2P module context from p2p_init()
810 * Returns: 0 on success, -1 on failure
811 *
812 * This function can be used to update the P2P module configuration with
813 * information that was not available at the time of the p2p_init() call.
814 */
815int p2p_set_dev_name(struct p2p_data *p2p, const char *dev_name);
816
817int p2p_set_manufacturer(struct p2p_data *p2p, const char *manufacturer);
818int p2p_set_model_name(struct p2p_data *p2p, const char *model_name);
819int p2p_set_model_number(struct p2p_data *p2p, const char *model_number);
820int p2p_set_serial_number(struct p2p_data *p2p, const char *serial_number);
821
822void p2p_set_config_methods(struct p2p_data *p2p, u16 config_methods);
823void p2p_set_uuid(struct p2p_data *p2p, const u8 *uuid);
824
825/**
826 * p2p_set_pri_dev_type - Set primary device type
827 * @p2p: P2P module context from p2p_init()
828 * Returns: 0 on success, -1 on failure
829 *
830 * This function can be used to update the P2P module configuration with
831 * information that was not available at the time of the p2p_init() call.
832 */
833int p2p_set_pri_dev_type(struct p2p_data *p2p, const u8 *pri_dev_type);
834
835/**
836 * p2p_set_sec_dev_types - Set secondary device types
837 * @p2p: P2P module context from p2p_init()
838 * Returns: 0 on success, -1 on failure
839 *
840 * This function can be used to update the P2P module configuration with
841 * information that was not available at the time of the p2p_init() call.
842 */
843int p2p_set_sec_dev_types(struct p2p_data *p2p, const u8 dev_types[][8],
844			  size_t num_dev_types);
845
846int p2p_set_country(struct p2p_data *p2p, const char *country);
847
848
849/* Commands from upper layer management entity */
850
851enum p2p_discovery_type {
852	P2P_FIND_START_WITH_FULL,
853	P2P_FIND_ONLY_SOCIAL,
854	P2P_FIND_PROGRESSIVE
855};
856
857/**
858 * p2p_find - Start P2P Find (Device Discovery)
859 * @p2p: P2P module context from p2p_init()
860 * @timeout: Timeout for find operation in seconds or 0 for no timeout
861 * @type: Device Discovery type
862 * @num_req_dev_types: Number of requested device types
863 * @req_dev_types: Requested device types array, must be an array
864 *	containing num_req_dev_types * WPS_DEV_TYPE_LEN bytes; %NULL if no
865 *	requested device types.
866 * @dev_id: Device ID to search for or %NULL to find all devices
867 * @search_delay: Extra delay in milliseconds between search iterations
868 * Returns: 0 on success, -1 on failure
869 */
870int p2p_find(struct p2p_data *p2p, unsigned int timeout,
871	     enum p2p_discovery_type type,
872	     unsigned int num_req_dev_types, const u8 *req_dev_types,
873	     const u8 *dev_id, unsigned int search_delay);
874
875/**
876 * p2p_stop_find - Stop P2P Find (Device Discovery)
877 * @p2p: P2P module context from p2p_init()
878 */
879void p2p_stop_find(struct p2p_data *p2p);
880
881/**
882 * p2p_stop_find_for_freq - Stop P2P Find for next oper on specific freq
883 * @p2p: P2P module context from p2p_init()
884 * @freq: Frequency in MHz for next operation
885 *
886 * This is like p2p_stop_find(), but Listen state is not stopped if we are
887 * already on the same frequency.
888 */
889void p2p_stop_find_for_freq(struct p2p_data *p2p, int freq);
890
891/**
892 * p2p_listen - Start P2P Listen state for specified duration
893 * @p2p: P2P module context from p2p_init()
894 * @timeout: Listen state duration in milliseconds
895 * Returns: 0 on success, -1 on failure
896 *
897 * This function can be used to request the P2P module to keep the device
898 * discoverable on the listen channel for an extended set of time. At least in
899 * its current form, this is mainly used for testing purposes and may not be of
900 * much use for normal P2P operations.
901 */
902int p2p_listen(struct p2p_data *p2p, unsigned int timeout);
903
904/**
905 * p2p_connect - Start P2P group formation (GO negotiation)
906 * @p2p: P2P module context from p2p_init()
907 * @peer_addr: MAC address of the peer P2P client
908 * @wps_method: WPS method to be used in provisioning
909 * @go_intent: Local GO intent value (1..15)
910 * @own_interface_addr: Intended interface address to use with the group
911 * @force_freq: The only allowed channel frequency in MHz or 0
912 * @persistent_group: Whether to create a persistent group (0 = no, 1 =
913 * persistent group without persistent reconnect, 2 = persistent group with
914 * persistent reconnect)
915 * @force_ssid: Forced SSID for the group if we become GO or %NULL to generate
916 *	a new SSID
917 * @force_ssid_len: Length of $force_ssid buffer
918 * @pd_before_go_neg: Whether to send Provision Discovery prior to GO
919 *	Negotiation as an interoperability workaround when initiating group
920 *	formation
921 * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if
922 *	force_freq == 0)
923 * Returns: 0 on success, -1 on failure
924 */
925int p2p_connect(struct p2p_data *p2p, const u8 *peer_addr,
926		enum p2p_wps_method wps_method,
927		int go_intent, const u8 *own_interface_addr,
928		unsigned int force_freq, int persistent_group,
929		const u8 *force_ssid, size_t force_ssid_len,
930		int pd_before_go_neg, unsigned int pref_freq);
931
932/**
933 * p2p_authorize - Authorize P2P group formation (GO negotiation)
934 * @p2p: P2P module context from p2p_init()
935 * @peer_addr: MAC address of the peer P2P client
936 * @wps_method: WPS method to be used in provisioning
937 * @go_intent: Local GO intent value (1..15)
938 * @own_interface_addr: Intended interface address to use with the group
939 * @force_freq: The only allowed channel frequency in MHz or 0
940 * @persistent_group: Whether to create a persistent group (0 = no, 1 =
941 * persistent group without persistent reconnect, 2 = persistent group with
942 * persistent reconnect)
943 * @force_ssid: Forced SSID for the group if we become GO or %NULL to generate
944 *	a new SSID
945 * @force_ssid_len: Length of $force_ssid buffer
946 * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if
947 *	force_freq == 0)
948 * Returns: 0 on success, -1 on failure
949 *
950 * This is like p2p_connect(), but the actual group negotiation is not
951 * initiated automatically, i.e., the other end is expected to do that.
952 */
953int p2p_authorize(struct p2p_data *p2p, const u8 *peer_addr,
954		  enum p2p_wps_method wps_method,
955		  int go_intent, const u8 *own_interface_addr,
956		  unsigned int force_freq, int persistent_group,
957		  const u8 *force_ssid, size_t force_ssid_len,
958		  unsigned int pref_freq);
959
960/**
961 * p2p_reject - Reject peer device (explicitly block connection attempts)
962 * @p2p: P2P module context from p2p_init()
963 * @peer_addr: MAC address of the peer P2P client
964 * Returns: 0 on success, -1 on failure
965 */
966int p2p_reject(struct p2p_data *p2p, const u8 *peer_addr);
967
968/**
969 * p2p_prov_disc_req - Send Provision Discovery Request
970 * @p2p: P2P module context from p2p_init()
971 * @peer_addr: MAC address of the peer P2P client
972 * @config_methods: WPS Config Methods value (only one bit set)
973 * @join: Whether this is used by a client joining an active group
974 * @force_freq: Forced TX frequency for the frame (mainly for the join case)
975 * @user_initiated_pd: Flag to indicate if initiated by user or not
976 * Returns: 0 on success, -1 on failure
977 *
978 * This function can be used to request a discovered P2P peer to display a PIN
979 * (config_methods = WPS_CONFIG_DISPLAY) or be prepared to enter a PIN from us
980 * (config_methods = WPS_CONFIG_KEYPAD). The Provision Discovery Request frame
981 * is transmitted once immediately and if no response is received, the frame
982 * will be sent again whenever the target device is discovered during device
983 * dsicovery (start with a p2p_find() call). Response from the peer is
984 * indicated with the p2p_config::prov_disc_resp() callback.
985 */
986int p2p_prov_disc_req(struct p2p_data *p2p, const u8 *peer_addr,
987		      u16 config_methods, int join, int force_freq,
988		      int user_initiated_pd);
989
990/**
991 * p2p_sd_request - Schedule a service discovery query
992 * @p2p: P2P module context from p2p_init()
993 * @dst: Destination peer or %NULL to apply for all peers
994 * @tlvs: P2P Service Query TLV(s)
995 * Returns: Reference to the query or %NULL on failure
996 *
997 * Response to the query is indicated with the p2p_config::sd_response()
998 * callback.
999 */
1000void * p2p_sd_request(struct p2p_data *p2p, const u8 *dst,
1001		      const struct wpabuf *tlvs);
1002
1003#ifdef CONFIG_WIFI_DISPLAY
1004void * p2p_sd_request_wfd(struct p2p_data *p2p, const u8 *dst,
1005			  const struct wpabuf *tlvs);
1006#endif /* CONFIG_WIFI_DISPLAY */
1007
1008/**
1009 * p2p_sd_cancel_request - Cancel a pending service discovery query
1010 * @p2p: P2P module context from p2p_init()
1011 * @req: Query reference from p2p_sd_request()
1012 * Returns: 0 if request for cancelled; -1 if not found
1013 */
1014int p2p_sd_cancel_request(struct p2p_data *p2p, void *req);
1015
1016/**
1017 * p2p_sd_response - Send response to a service discovery query
1018 * @p2p: P2P module context from p2p_init()
1019 * @freq: Frequency from p2p_config::sd_request() callback
1020 * @dst: Destination address from p2p_config::sd_request() callback
1021 * @dialog_token: Dialog token from p2p_config::sd_request() callback
1022 * @resp_tlvs: P2P Service Response TLV(s)
1023 *
1024 * This function is called as a response to the request indicated with
1025 * p2p_config::sd_request() callback.
1026 */
1027void p2p_sd_response(struct p2p_data *p2p, int freq, const u8 *dst,
1028		     u8 dialog_token, const struct wpabuf *resp_tlvs);
1029
1030/**
1031 * p2p_sd_service_update - Indicate a change in local services
1032 * @p2p: P2P module context from p2p_init()
1033 *
1034 * This function needs to be called whenever there is a change in availability
1035 * of the local services. This will increment the Service Update Indicator
1036 * value which will be used in SD Request and Response frames.
1037 */
1038#ifdef ANDROID_P2P
1039void p2p_sd_service_update(struct p2p_data *p2p, int action);
1040#else
1041void p2p_sd_service_update(struct p2p_data *p2p);
1042#endif
1043
1044
1045enum p2p_invite_role {
1046	P2P_INVITE_ROLE_GO,
1047	P2P_INVITE_ROLE_ACTIVE_GO,
1048	P2P_INVITE_ROLE_CLIENT
1049};
1050
1051/**
1052 * p2p_invite - Invite a P2P Device into a group
1053 * @p2p: P2P module context from p2p_init()
1054 * @peer: Device Address of the peer P2P Device
1055 * @role: Local role in the group
1056 * @bssid: Group BSSID or %NULL if not known
1057 * @ssid: Group SSID
1058 * @ssid_len: Length of ssid in octets
1059 * @force_freq: The only allowed channel frequency in MHz or 0
1060 * @go_dev_addr: Forced GO Device Address or %NULL if none
1061 * @persistent_group: Whether this is to reinvoke a persistent group
1062 * Returns: 0 on success, -1 on failure
1063 */
1064int p2p_invite(struct p2p_data *p2p, const u8 *peer, enum p2p_invite_role role,
1065	       const u8 *bssid, const u8 *ssid, size_t ssid_len,
1066	       unsigned int force_freq, const u8 *go_dev_addr,
1067	       int persistent_group);
1068
1069/**
1070 * p2p_presence_req - Request GO presence
1071 * @p2p: P2P module context from p2p_init()
1072 * @go_interface_addr: GO P2P Interface Address
1073 * @own_interface_addr: Own P2P Interface Address for this group
1074 * @freq: Group operating frequence (in MHz)
1075 * @duration1: Preferred presence duration in microseconds
1076 * @interval1: Preferred presence interval in microseconds
1077 * @duration2: Acceptable presence duration in microseconds
1078 * @interval2: Acceptable presence interval in microseconds
1079 * Returns: 0 on success, -1 on failure
1080 *
1081 * If both duration and interval values are zero, the parameter pair is not
1082 * specified (i.e., to remove Presence Request, use duration1 = interval1 = 0).
1083 */
1084int p2p_presence_req(struct p2p_data *p2p, const u8 *go_interface_addr,
1085		     const u8 *own_interface_addr, unsigned int freq,
1086		     u32 duration1, u32 interval1, u32 duration2,
1087		     u32 interval2);
1088
1089/**
1090 * p2p_ext_listen - Set Extended Listen Timing
1091 * @p2p: P2P module context from p2p_init()
1092 * @freq: Group operating frequence (in MHz)
1093 * @period: Availability period in milliseconds (1-65535; 0 to disable)
1094 * @interval: Availability interval in milliseconds (1-65535; 0 to disable)
1095 * Returns: 0 on success, -1 on failure
1096 *
1097 * This function can be used to enable or disable (period = interval = 0)
1098 * Extended Listen Timing. When enabled, the P2P Device will become
1099 * discoverable (go into Listen State) every @interval milliseconds for at
1100 * least @period milliseconds.
1101 */
1102int p2p_ext_listen(struct p2p_data *p2p, unsigned int period,
1103		   unsigned int interval);
1104
1105/* Event notifications from upper layer management operations */
1106
1107/**
1108 * p2p_wps_success_cb - Report successfully completed WPS provisioning
1109 * @p2p: P2P module context from p2p_init()
1110 * @mac_addr: Peer address
1111 *
1112 * This function is used to report successfully completed WPS provisioning
1113 * during group formation in both GO/Registrar and client/Enrollee roles.
1114 */
1115void p2p_wps_success_cb(struct p2p_data *p2p, const u8 *mac_addr);
1116
1117/**
1118 * p2p_group_formation_failed - Report failed WPS provisioning
1119 * @p2p: P2P module context from p2p_init()
1120 *
1121 * This function is used to report failed group formation. This can happen
1122 * either due to failed WPS provisioning or due to 15 second timeout during
1123 * the provisioning phase.
1124 */
1125void p2p_group_formation_failed(struct p2p_data *p2p);
1126
1127/**
1128 * p2p_get_provisioning_info - Get any stored provisioning info
1129 * @p2p: P2P module context from p2p_init()
1130 * @addr: Peer P2P Device Address
1131 * Returns: WPS provisioning information (WPS config method) or 0 if no
1132 * information is available
1133 *
1134 * This function is used to retrieve stored WPS provisioning info for the given
1135 * peer.
1136 */
1137u16 p2p_get_provisioning_info(struct p2p_data *p2p, const u8 *addr);
1138
1139/**
1140 * p2p_clear_provisioning_info - Clear any stored provisioning info
1141 * @p2p: P2P module context from p2p_init()
1142 * @iface_addr: Peer P2P Device Address
1143 *
1144 * This function is used to clear stored WPS provisioning info for the given
1145 * peer.
1146 */
1147void p2p_clear_provisioning_info(struct p2p_data *p2p, const u8 *addr);
1148
1149
1150/* Event notifications from lower layer driver operations */
1151
1152/**
1153 * enum p2p_probe_req_status
1154 *
1155 * @P2P_PREQ_MALFORMED: frame was not well-formed
1156 * @P2P_PREQ_NOT_LISTEN: device isn't in listen state, frame ignored
1157 * @P2P_PREQ_NOT_P2P: frame was not a P2P probe request
1158 * @P2P_PREQ_P2P_NOT_PROCESSED: frame was P2P but wasn't processed
1159 * @P2P_PREQ_P2P_PROCESSED: frame has been processed by P2P
1160 */
1161enum p2p_probe_req_status {
1162	P2P_PREQ_MALFORMED,
1163	P2P_PREQ_NOT_LISTEN,
1164	P2P_PREQ_NOT_P2P,
1165	P2P_PREQ_NOT_PROCESSED,
1166	P2P_PREQ_PROCESSED
1167};
1168
1169/**
1170 * p2p_probe_req_rx - Report reception of a Probe Request frame
1171 * @p2p: P2P module context from p2p_init()
1172 * @addr: Source MAC address
1173 * @dst: Destination MAC address if available or %NULL
1174 * @bssid: BSSID if available or %NULL
1175 * @ie: Information elements from the Probe Request frame body
1176 * @ie_len: Length of ie buffer in octets
1177 * Returns: value indicating the type and status of the probe request
1178 */
1179enum p2p_probe_req_status
1180p2p_probe_req_rx(struct p2p_data *p2p, const u8 *addr, const u8 *dst,
1181		 const u8 *bssid, const u8 *ie, size_t ie_len);
1182
1183/**
1184 * p2p_rx_action - Report received Action frame
1185 * @p2p: P2P module context from p2p_init()
1186 * @da: Destination address of the received Action frame
1187 * @sa: Source address of the received Action frame
1188 * @bssid: Address 3 of the received Action frame
1189 * @category: Category of the received Action frame
1190 * @data: Action frame body after the Category field
1191 * @len: Length of the data buffer in octets
1192 * @freq: Frequency (in MHz) on which the frame was received
1193 */
1194void p2p_rx_action(struct p2p_data *p2p, const u8 *da, const u8 *sa,
1195		   const u8 *bssid, u8 category,
1196		   const u8 *data, size_t len, int freq);
1197
1198/**
1199 * p2p_scan_res_handler - Indicate a P2P scan results
1200 * @p2p: P2P module context from p2p_init()
1201 * @bssid: BSSID of the scan result
1202 * @freq: Frequency of the channel on which the device was found in MHz
1203 * @rx_time: Time when the result was received
1204 * @level: Signal level (signal strength of the received Beacon/Probe Response
1205 *	frame)
1206 * @ies: Pointer to IEs from the scan result
1207 * @ies_len: Length of the ies buffer
1208 * Returns: 0 to continue or 1 to stop scan result indication
1209 *
1210 * This function is called to indicate a scan result entry with P2P IE from a
1211 * scan requested with struct p2p_config::p2p_scan(). This can be called during
1212 * the actual scan process (i.e., whenever a new device is found) or as a
1213 * sequence of calls after the full scan has been completed. The former option
1214 * can result in optimized operations, but may not be supported by all
1215 * driver/firmware designs. The ies buffer need to include at least the P2P IE,
1216 * but it is recommended to include all IEs received from the device. The
1217 * caller does not need to check that the IEs contain a P2P IE before calling
1218 * this function since frames will be filtered internally if needed.
1219 *
1220 * This function will return 1 if it wants to stop scan result iteration (and
1221 * scan in general if it is still in progress). This is used to allow faster
1222 * start of a pending operation, e.g., to start a pending GO negotiation.
1223 */
1224int p2p_scan_res_handler(struct p2p_data *p2p, const u8 *bssid, int freq,
1225			 struct os_time *rx_time, int level, const u8 *ies,
1226			 size_t ies_len);
1227
1228/**
1229 * p2p_scan_res_handled - Indicate end of scan results
1230 * @p2p: P2P module context from p2p_init()
1231 *
1232 * This function is called to indicate that all P2P scan results from a scan
1233 * have been reported with zero or more calls to p2p_scan_res_handler(). This
1234 * function must be called as a response to successful
1235 * struct p2p_config::p2p_scan() call if none of the p2p_scan_res_handler()
1236 * calls stopped iteration.
1237 */
1238void p2p_scan_res_handled(struct p2p_data *p2p);
1239
1240enum p2p_send_action_result {
1241	P2P_SEND_ACTION_SUCCESS /* Frame was send and acknowledged */,
1242	P2P_SEND_ACTION_NO_ACK /* Frame was sent, but not acknowledged */,
1243	P2P_SEND_ACTION_FAILED /* Frame was not sent due to a failure */
1244};
1245
1246/**
1247 * p2p_send_action_cb - Notify TX status of an Action frame
1248 * @p2p: P2P module context from p2p_init()
1249 * @freq: Channel frequency in MHz
1250 * @dst: Destination MAC address (Address 1)
1251 * @src: Source MAC address (Address 2)
1252 * @bssid: BSSID (Address 3)
1253 * @result: Result of the transmission attempt
1254 *
1255 * This function is used to indicate the result of an Action frame transmission
1256 * that was requested with struct p2p_config::send_action() callback.
1257 */
1258void p2p_send_action_cb(struct p2p_data *p2p, unsigned int freq, const u8 *dst,
1259			const u8 *src, const u8 *bssid,
1260			enum p2p_send_action_result result);
1261
1262/**
1263 * p2p_listen_cb - Indicate the start of a requested Listen state
1264 * @p2p: P2P module context from p2p_init()
1265 * @freq: Listen channel frequency in MHz
1266 * @duration: Duration for the Listen state in milliseconds
1267 *
1268 * This function is used to indicate that a Listen state requested with
1269 * struct p2p_config::start_listen() callback has started.
1270 */
1271void p2p_listen_cb(struct p2p_data *p2p, unsigned int freq,
1272		   unsigned int duration);
1273
1274/**
1275 * p2p_listen_end - Indicate the end of a requested Listen state
1276 * @p2p: P2P module context from p2p_init()
1277 * @freq: Listen channel frequency in MHz
1278 * Returns: 0 if no operations were started, 1 if an operation was started
1279 *
1280 * This function is used to indicate that a Listen state requested with
1281 * struct p2p_config::start_listen() callback has ended.
1282 */
1283int p2p_listen_end(struct p2p_data *p2p, unsigned int freq);
1284
1285void p2p_deauth_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code,
1286		      const u8 *ie, size_t ie_len);
1287
1288void p2p_disassoc_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code,
1289			const u8 *ie, size_t ie_len);
1290
1291
1292/* Per-group P2P state for GO */
1293
1294struct p2p_group;
1295
1296/**
1297 * struct p2p_group_config - P2P group configuration
1298 *
1299 * This configuration is provided to the P2P module during initialization of
1300 * the per-group information with p2p_group_init().
1301 */
1302struct p2p_group_config {
1303	/**
1304	 * persistent_group - Whether the group is persistent
1305	 * 0 = not a persistent group
1306	 * 1 = persistent group without persistent reconnect
1307	 * 2 = persistent group with persistent reconnect
1308	 */
1309	int persistent_group;
1310
1311	/**
1312	 * interface_addr - P2P Interface Address of the group
1313	 */
1314	u8 interface_addr[ETH_ALEN];
1315
1316	/**
1317	 * max_clients - Maximum number of clients in the group
1318	 */
1319	unsigned int max_clients;
1320
1321	/**
1322	 * ssid - Group SSID
1323	 */
1324	u8 ssid[32];
1325
1326	/**
1327	 * ssid_len - Length of SSID
1328	 */
1329	size_t ssid_len;
1330
1331	/**
1332	 * cb_ctx - Context to use with callback functions
1333	 */
1334	void *cb_ctx;
1335
1336	/**
1337	 * ie_update - Notification of IE update
1338	 * @ctx: Callback context from cb_ctx
1339	 * @beacon_ies: P2P IE for Beacon frames or %NULL if no change
1340	 * @proberesp_ies: P2P Ie for Probe Response frames
1341	 *
1342	 * P2P module uses this callback function to notify whenever the P2P IE
1343	 * in Beacon or Probe Response frames should be updated based on group
1344	 * events.
1345	 *
1346	 * The callee is responsible for freeing the returned buffer(s) with
1347	 * wpabuf_free().
1348	 */
1349	void (*ie_update)(void *ctx, struct wpabuf *beacon_ies,
1350			  struct wpabuf *proberesp_ies);
1351
1352	/**
1353	 * idle_update - Notification of changes in group idle state
1354	 * @ctx: Callback context from cb_ctx
1355	 * @idle: Whether the group is idle (no associated stations)
1356	 */
1357	void (*idle_update)(void *ctx, int idle);
1358};
1359
1360/**
1361 * p2p_group_init - Initialize P2P group
1362 * @p2p: P2P module context from p2p_init()
1363 * @config: P2P group configuration (will be freed by p2p_group_deinit())
1364 * Returns: Pointer to private data or %NULL on failure
1365 *
1366 * This function is used to initialize per-group P2P module context. Currently,
1367 * this is only used to manage GO functionality and P2P clients do not need to
1368 * create an instance of this per-group information.
1369 */
1370struct p2p_group * p2p_group_init(struct p2p_data *p2p,
1371				  struct p2p_group_config *config);
1372
1373/**
1374 * p2p_group_deinit - Deinitialize P2P group
1375 * @group: P2P group context from p2p_group_init()
1376 */
1377void p2p_group_deinit(struct p2p_group *group);
1378
1379/**
1380 * p2p_group_notif_assoc - Notification of P2P client association with GO
1381 * @group: P2P group context from p2p_group_init()
1382 * @addr: Interface address of the P2P client
1383 * @ie: IEs from the (Re)association Request frame
1384 * @len: Length of the ie buffer in octets
1385 * Returns: 0 on success, -1 on failure
1386 */
1387int p2p_group_notif_assoc(struct p2p_group *group, const u8 *addr,
1388			  const u8 *ie, size_t len);
1389
1390/**
1391 * p2p_group_assoc_resp_ie - Build P2P IE for (re)association response
1392 * @group: P2P group context from p2p_group_init()
1393 * @status: Status value (P2P_SC_SUCCESS if association succeeded)
1394 * Returns: P2P IE for (Re)association Response or %NULL on failure
1395 *
1396 * The caller is responsible for freeing the returned buffer with
1397 * wpabuf_free().
1398 */
1399struct wpabuf * p2p_group_assoc_resp_ie(struct p2p_group *group, u8 status);
1400
1401/**
1402 * p2p_group_notif_disassoc - Notification of P2P client disassociation from GO
1403 * @group: P2P group context from p2p_group_init()
1404 * @addr: Interface address of the P2P client
1405 */
1406void p2p_group_notif_disassoc(struct p2p_group *group, const u8 *addr);
1407
1408/**
1409 * p2p_group_notif_formation_done - Notification of completed group formation
1410 * @group: P2P group context from p2p_group_init()
1411 */
1412void p2p_group_notif_formation_done(struct p2p_group *group);
1413
1414/**
1415 * p2p_group_notif_noa - Notification of NoA change
1416 * @group: P2P group context from p2p_group_init()
1417 * @noa: Notice of Absence attribute payload, %NULL if none
1418 * @noa_len: Length of noa buffer in octets
1419 * Returns: 0 on success, -1 on failure
1420 *
1421 * Notify the P2P group management about a new NoA contents. This will be
1422 * inserted into the P2P IEs in Beacon and Probe Response frames with rest of
1423 * the group information.
1424 */
1425int p2p_group_notif_noa(struct p2p_group *group, const u8 *noa,
1426			size_t noa_len);
1427
1428/**
1429 * p2p_group_match_dev_type - Match device types in group with requested type
1430 * @group: P2P group context from p2p_group_init()
1431 * @wps: WPS TLVs from Probe Request frame (concatenated WPS IEs)
1432 * Returns: 1 on match, 0 on mismatch
1433 *
1434 * This function can be used to match the Requested Device Type attribute in
1435 * WPS IE with the device types of a group member for deciding whether a GO
1436 * should reply to a Probe Request frame. Match will be reported if the WPS IE
1437 * is not requested any specific device type.
1438 */
1439int p2p_group_match_dev_type(struct p2p_group *group, struct wpabuf *wps);
1440
1441/**
1442 * p2p_group_match_dev_id - Match P2P Device Address in group with requested device id
1443 */
1444int p2p_group_match_dev_id(struct p2p_group *group, struct wpabuf *p2p);
1445
1446/**
1447 * p2p_group_go_discover - Send GO Discoverability Request to a group client
1448 * @group: P2P group context from p2p_group_init()
1449 * Returns: 0 on success (frame scheduled); -1 if client was not found
1450 */
1451int p2p_group_go_discover(struct p2p_group *group, const u8 *dev_id,
1452			  const u8 *searching_dev, int rx_freq);
1453
1454
1455/* Generic helper functions */
1456
1457/**
1458 * p2p_ie_text - Build text format description of P2P IE
1459 * @p2p_ie: P2P IE
1460 * @buf: Buffer for returning text
1461 * @end: Pointer to the end of the buf area
1462 * Returns: Number of octets written to the buffer or -1 on failure
1463 *
1464 * This function can be used to parse P2P IE contents into text format
1465 * field=value lines.
1466 */
1467int p2p_ie_text(struct wpabuf *p2p_ie, char *buf, char *end);
1468
1469/**
1470 * p2p_scan_result_text - Build text format description of P2P IE
1471 * @ies: Information elements from scan results
1472 * @ies_len: ies buffer length in octets
1473 * @buf: Buffer for returning text
1474 * @end: Pointer to the end of the buf area
1475 * Returns: Number of octets written to the buffer or -1 on failure
1476 *
1477 * This function can be used to parse P2P IE contents into text format
1478 * field=value lines.
1479 */
1480int p2p_scan_result_text(const u8 *ies, size_t ies_len, char *buf, char *end);
1481
1482/**
1483 * p2p_parse_dev_addr_in_p2p_ie - Parse P2P Device Address from a concatenated
1484 * P2P IE
1485 * @p2p_ie: P2P IE
1486 * @dev_addr: Buffer for returning P2P Device Address
1487 * Returns: 0 on success or -1 if P2P Device Address could not be parsed
1488 */
1489int p2p_parse_dev_addr_in_p2p_ie(struct wpabuf *p2p_ie, u8 *dev_addr);
1490
1491/**
1492 * p2p_parse_dev_addr - Parse P2P Device Address from P2P IE(s)
1493 * @ies: Information elements from scan results
1494 * @ies_len: ies buffer length in octets
1495 * @dev_addr: Buffer for returning P2P Device Address
1496 * Returns: 0 on success or -1 if P2P Device Address could not be parsed
1497 */
1498int p2p_parse_dev_addr(const u8 *ies, size_t ies_len, u8 *dev_addr);
1499
1500/**
1501 * p2p_assoc_req_ie - Build P2P IE for (Re)Association Request frame
1502 * @p2p: P2P module context from p2p_init()
1503 * @bssid: BSSID
1504 * @buf: Buffer for writing the P2P IE
1505 * @len: Maximum buf length in octets
1506 * @p2p_group: Whether this is for association with a P2P GO
1507 * @p2p_ie: Reassembled P2P IE data from scan results or %NULL if none
1508 * Returns: Number of octets written into buf or -1 on failure
1509 */
1510int p2p_assoc_req_ie(struct p2p_data *p2p, const u8 *bssid, u8 *buf,
1511		     size_t len, int p2p_group, struct wpabuf *p2p_ie);
1512
1513/**
1514 * p2p_scan_ie - Build P2P IE for Probe Request
1515 * @p2p: P2P module context from p2p_init()
1516 * @ies: Buffer for writing P2P IE
1517 * @dev_id: Device ID to search for or %NULL for any
1518 */
1519void p2p_scan_ie(struct p2p_data *p2p, struct wpabuf *ies, const u8 *dev_id);
1520
1521/**
1522 * p2p_scan_ie_buf_len - Get maximum buffer length needed for p2p_scan_ie
1523 * @p2p: P2P module context from p2p_init()
1524 * Returns: Number of octets that p2p_scan_ie() may add to the buffer
1525 */
1526size_t p2p_scan_ie_buf_len(struct p2p_data *p2p);
1527
1528/**
1529 * p2p_go_params - Generate random P2P group parameters
1530 * @p2p: P2P module context from p2p_init()
1531 * @params: Buffer for parameters
1532 * Returns: 0 on success, -1 on failure
1533 */
1534int p2p_go_params(struct p2p_data *p2p, struct p2p_go_neg_results *params);
1535
1536/**
1537 * p2p_get_group_capab - Get Group Capability from P2P IE data
1538 * @p2p_ie: P2P IE(s) contents
1539 * Returns: Group Capability
1540 */
1541u8 p2p_get_group_capab(const struct wpabuf *p2p_ie);
1542
1543/**
1544 * p2p_get_cross_connect_disallowed - Does WLAN AP disallows cross connection
1545 * @p2p_ie: P2P IE(s) contents
1546 * Returns: 0 if cross connection is allow, 1 if not
1547 */
1548int p2p_get_cross_connect_disallowed(const struct wpabuf *p2p_ie);
1549
1550/**
1551 * p2p_get_go_dev_addr - Get P2P Device Address from P2P IE data
1552 * @p2p_ie: P2P IE(s) contents
1553 * Returns: Pointer to P2P Device Address or %NULL if not included
1554 */
1555const u8 * p2p_get_go_dev_addr(const struct wpabuf *p2p_ie);
1556
1557/**
1558 * p2p_get_peer_info - Get P2P peer information
1559 * @p2p: P2P module context from p2p_init()
1560 * @addr: P2P Device Address of the peer or %NULL to indicate the first peer
1561 * @next: Whether to select the peer entry following the one indicated by addr
1562 * Returns: Pointer to peer info or %NULL if not found
1563 */
1564const struct p2p_peer_info * p2p_get_peer_info(struct p2p_data *p2p,
1565					       const u8 *addr, int next);
1566
1567/**
1568 * p2p_get_peer_info_txt - Get internal P2P peer information in text format
1569 * @info: Pointer to P2P peer info from p2p_get_peer_info()
1570 * @buf: Buffer for returning text
1571 * @buflen: Maximum buffer length
1572 * Returns: Number of octets written to the buffer or -1 on failure
1573 *
1574 * Note: This information is internal to the P2P module and subject to change.
1575 * As such, this should not really be used by external programs for purposes
1576 * other than debugging.
1577 */
1578int p2p_get_peer_info_txt(const struct p2p_peer_info *info,
1579			  char *buf, size_t buflen);
1580
1581/**
1582 * p2p_peer_known - Check whether P2P peer is known
1583 * @p2p: P2P module context from p2p_init()
1584 * @addr: P2P Device Address of the peer
1585 * Returns: 1 if the specified device is in the P2P peer table or 0 if not
1586 */
1587int p2p_peer_known(struct p2p_data *p2p, const u8 *addr);
1588
1589/**
1590 * p2p_set_client_discoverability - Set client discoverability capability
1591 * @p2p: P2P module context from p2p_init()
1592 * @enabled: Whether client discoverability will be enabled
1593 *
1594 * This function can be used to disable (and re-enable) client discoverability.
1595 * This capability is enabled by default and should not be disabled in normal
1596 * use cases, i.e., this is mainly for testing purposes.
1597 */
1598void p2p_set_client_discoverability(struct p2p_data *p2p, int enabled);
1599
1600/**
1601 * p2p_set_managed_oper - Set managed P2P Device operations capability
1602 * @p2p: P2P module context from p2p_init()
1603 * @enabled: Whether managed P2P Device operations will be enabled
1604 */
1605void p2p_set_managed_oper(struct p2p_data *p2p, int enabled);
1606
1607int p2p_set_listen_channel(struct p2p_data *p2p, u8 reg_class, u8 channel);
1608
1609int p2p_set_ssid_postfix(struct p2p_data *p2p, const u8 *postfix, size_t len);
1610
1611int p2p_get_interface_addr(struct p2p_data *p2p, const u8 *dev_addr,
1612			   u8 *iface_addr);
1613int p2p_get_dev_addr(struct p2p_data *p2p, const u8 *iface_addr,
1614			   u8 *dev_addr);
1615
1616void p2p_set_peer_filter(struct p2p_data *p2p, const u8 *addr);
1617
1618/**
1619 * p2p_set_cross_connect - Set cross connection capability
1620 * @p2p: P2P module context from p2p_init()
1621 * @enabled: Whether cross connection will be enabled
1622 */
1623void p2p_set_cross_connect(struct p2p_data *p2p, int enabled);
1624
1625int p2p_get_oper_freq(struct p2p_data *p2p, const u8 *iface_addr);
1626
1627/**
1628 * p2p_set_intra_bss_dist - Set intra BSS distribution
1629 * @p2p: P2P module context from p2p_init()
1630 * @enabled: Whether intra BSS distribution will be enabled
1631 */
1632void p2p_set_intra_bss_dist(struct p2p_data *p2p, int enabled);
1633
1634/**
1635 * p2p_supported_freq - Check whether channel is supported for P2P
1636 * @p2p: P2P module context from p2p_init()
1637 * @freq: Channel frequency in MHz
1638 * Returns: 0 if channel not usable for P2P, 1 if usable for P2P
1639 */
1640int p2p_supported_freq(struct p2p_data *p2p, unsigned int freq);
1641
1642void p2p_update_channel_list(struct p2p_data *p2p, struct p2p_channels *chan);
1643
1644/**
1645 * p2p_set_best_channels - Update best channel information
1646 * @p2p: P2P module context from p2p_init()
1647 * @freq_24: Frequency (MHz) of best channel in 2.4 GHz band
1648 * @freq_5: Frequency (MHz) of best channel in 5 GHz band
1649 * @freq_overall: Frequency (MHz) of best channel overall
1650 */
1651void p2p_set_best_channels(struct p2p_data *p2p, int freq_24, int freq_5,
1652			   int freq_overall);
1653
1654const u8 * p2p_get_go_neg_peer(struct p2p_data *p2p);
1655
1656/**
1657 * p2p_get_group_num_members - Get number of members in group
1658 * @group: P2P group context from p2p_group_init()
1659 * Returns: Number of members in the group
1660 */
1661unsigned int p2p_get_group_num_members(struct p2p_group *group);
1662
1663/**
1664 * p2p_iterate_group_members - Iterate group members
1665 * @group: P2P group context from p2p_group_init()
1666 * @next: iteration pointer, must be a pointer to a void * that is set to %NULL
1667 *	on the first call and not modified later
1668 * Returns: A P2P Interface Address for each call and %NULL for no more members
1669 */
1670const u8 * p2p_iterate_group_members(struct p2p_group *group, void **next);
1671
1672/**
1673 * p2p_group_get_dev_addr - Get a P2P Device Address of a client in a group
1674 * @group: P2P group context from p2p_group_init()
1675 * @addr: P2P Interface Address of the client
1676 * Returns: P2P Device Address of the client if found or %NULL if no match
1677 * found
1678 */
1679const u8 * p2p_group_get_dev_addr(struct p2p_group *group, const u8 *addr);
1680
1681/**
1682 * p2p_group_is_client_connected - Check whether a specific client is connected
1683 * @group: P2P group context from p2p_group_init()
1684 * @addr: P2P Device Address of the client
1685 * Returns: 1 if client is connected or 0 if not
1686 */
1687int p2p_group_is_client_connected(struct p2p_group *group, const u8 *dev_addr);
1688
1689/**
1690 * p2p_get_peer_found - Get P2P peer info structure of a found peer
1691 * @p2p: P2P module context from p2p_init()
1692 * @addr: P2P Device Address of the peer or %NULL to indicate the first peer
1693 * @next: Whether to select the peer entry following the one indicated by addr
1694 * Returns: The first P2P peer info available or %NULL if no such peer exists
1695 */
1696const struct p2p_peer_info *
1697p2p_get_peer_found(struct p2p_data *p2p, const u8 *addr, int next);
1698
1699/**
1700 * p2p_remove_wps_vendor_extensions - Remove WPS vendor extensions
1701 * @p2p: P2P module context from p2p_init()
1702 */
1703void p2p_remove_wps_vendor_extensions(struct p2p_data *p2p);
1704
1705/**
1706 * p2p_add_wps_vendor_extension - Add a WPS vendor extension
1707 * @p2p: P2P module context from p2p_init()
1708 * @vendor_ext: The vendor extensions to add
1709 * Returns: 0 on success, -1 on failure
1710 *
1711 * The wpabuf structures in the array are owned by the P2P
1712 * module after this call.
1713 */
1714int p2p_add_wps_vendor_extension(struct p2p_data *p2p,
1715				 const struct wpabuf *vendor_ext);
1716
1717/**
1718 * p2p_set_oper_channel - Set the P2P operating channel
1719 * @p2p: P2P module context from p2p_init()
1720 * @op_reg_class: Operating regulatory class to set
1721 * @op_channel: operating channel to set
1722 * @cfg_op_channel : Whether op_channel is hardcoded in configuration
1723 * Returns: 0 on success, -1 on failure
1724 */
1725int p2p_set_oper_channel(struct p2p_data *p2p, u8 op_reg_class, u8 op_channel,
1726			 int cfg_op_channel);
1727
1728/**
1729 * p2p_set_pref_chan - Set P2P preferred channel list
1730 * @p2p: P2P module context from p2p_init()
1731 * @num_pref_chan: Number of entries in pref_chan list
1732 * @pref_chan: Preferred channels or %NULL to remove preferences
1733 * Returns: 0 on success, -1 on failure
1734 */
1735int p2p_set_pref_chan(struct p2p_data *p2p, unsigned int num_pref_chan,
1736		      const struct p2p_channel *pref_chan);
1737
1738/**
1739 * p2p_in_progress - Check whether a P2P operation is progress
1740 * @p2p: P2P module context from p2p_init()
1741 * Returns: 0 if P2P module is idle or 1 if an operation is in progress
1742 */
1743int p2p_in_progress(struct p2p_data *p2p);
1744
1745#ifdef ANDROID_P2P
1746/**
1747 * p2p_search_in_progress - Check whether a P2P SEARCH is in progress
1748 * @p2p: P2P module context from p2p_init()
1749 * Returns: 0 if P2P module is idle or 1 if an operation is in progress
1750 */
1751int p2p_search_in_progress(struct p2p_data *p2p);
1752
1753/**
1754 * p2p_search_pending - Check whether there is a deferred P2P SEARCH
1755 * @p2p: P2P module context from p2p_init()
1756 * Returns: 0 if there is no deferred P2P search or 1 if there is one
1757 */
1758int p2p_search_pending(struct p2p_data *p2p);
1759#endif
1760
1761/**
1762 * p2p_other_scan_completed - Notify completion of non-P2P scan
1763 * @p2p: P2P module context from p2p_init()
1764 * Returns: 0 if P2P module is idle or 1 if an operation was started
1765 */
1766int p2p_other_scan_completed(struct p2p_data *p2p);
1767
1768const char * p2p_wps_method_text(enum p2p_wps_method method);
1769
1770/**
1771 * p2p_set_config_timeout - Set local config timeouts
1772 * @p2p: P2P module context from p2p_init()
1773 * @go_timeout: Time in 10 ms units it takes to start the GO mode
1774 * @client_timeout: Time in 10 ms units it takes to start the client mode
1775 */
1776void p2p_set_config_timeout(struct p2p_data *p2p, u8 go_timeout,
1777			    u8 client_timeout);
1778
1779void p2p_increase_search_delay(struct p2p_data *p2p, unsigned int delay);
1780
1781int p2p_set_wfd_ie_beacon(struct p2p_data *p2p, struct wpabuf *ie);
1782int p2p_set_wfd_ie_probe_req(struct p2p_data *p2p, struct wpabuf *ie);
1783int p2p_set_wfd_ie_probe_resp(struct p2p_data *p2p, struct wpabuf *ie);
1784int p2p_set_wfd_ie_assoc_req(struct p2p_data *p2p, struct wpabuf *ie);
1785int p2p_set_wfd_ie_invitation(struct p2p_data *p2p, struct wpabuf *ie);
1786int p2p_set_wfd_ie_prov_disc_req(struct p2p_data *p2p, struct wpabuf *ie);
1787int p2p_set_wfd_ie_prov_disc_resp(struct p2p_data *p2p, struct wpabuf *ie);
1788int p2p_set_wfd_ie_go_neg(struct p2p_data *p2p, struct wpabuf *ie);
1789int p2p_set_wfd_dev_info(struct p2p_data *p2p, const struct wpabuf *elem);
1790int p2p_set_wfd_assoc_bssid(struct p2p_data *p2p, const struct wpabuf *elem);
1791int p2p_set_wfd_coupled_sink_info(struct p2p_data *p2p,
1792				  const struct wpabuf *elem);
1793struct wpabuf * wifi_display_encaps(struct wpabuf *subelems);
1794
1795/**
1796 * p2p_set_disc_int - Set min/max discoverable interval for p2p_find
1797 * @p2p: P2P module context from p2p_init()
1798 * @min_disc_int: minDiscoverableInterval (in units of 100 TU); default 1
1799 * @max_disc_int: maxDiscoverableInterval (in units of 100 TU); default 3
1800 * @max_disc_tu: Maximum number of TUs (1.024 ms) for discoverable interval; or
1801 *	-1 not to limit
1802 * Returns: 0 on success, or -1 on failure
1803 *
1804 * This function can be used to configure minDiscoverableInterval and
1805 * maxDiscoverableInterval parameters for the Listen state during device
1806 * discovery (p2p_find). A random number of 100 TU units is picked for each
1807 * Listen state iteration from [min_disc_int,max_disc_int] range.
1808 *
1809 * max_disc_tu can be used to futher limit the discoverable duration. However,
1810 * it should be noted that use of this parameter is not recommended since it
1811 * would not be compliant with the P2P specification.
1812 */
1813int p2p_set_disc_int(struct p2p_data *p2p, int min_disc_int, int max_disc_int,
1814		     int max_disc_tu);
1815
1816#endif /* P2P_H */
1817