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