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