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