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