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