blob: 762bd40bea8b536c42296b5fb5135b9fd7594d62 [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
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700615 * Returns: 0 on success, -1 on failure
616 *
617 * This callback function is used to request a P2P scan or search
618 * operation to be completed. Type type argument specifies which type
619 * of scan is to be done. @P2P_SCAN_SOCIAL indicates that only the
620 * social channels (1, 6, 11) should be scanned. @P2P_SCAN_FULL
Dmitry Shmidt203eadb2015-03-05 14:16:04 -0800621 * indicates that all channels are to be scanned. @P2P_SCAN_SPECIFIC
622 * request a scan of a single channel specified by freq.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700623 * @P2P_SCAN_SOCIAL_PLUS_ONE request scan of all the social channels
624 * plus one extra channel specified by freq.
625 *
626 * The full scan is used for the initial scan to find group owners from
627 * all. The other types are used during search phase scan of the social
628 * channels (with potential variation if the Listen channel of the
629 * target peer is known or if other channels are scanned in steps).
630 *
631 * The scan results are returned after this call by calling
632 * p2p_scan_res_handler() for each scan result that has a P2P IE and
633 * then calling p2p_scan_res_handled() to indicate that all scan
634 * results have been indicated.
635 */
636 int (*p2p_scan)(void *ctx, enum p2p_scan_type type, int freq,
637 unsigned int num_req_dev_types,
Dmitry Shmidt04949592012-07-19 12:16:46 -0700638 const u8 *req_dev_types, const u8 *dev_id, u16 pw_id);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700639
640 /**
641 * send_probe_resp - Transmit a Probe Response frame
642 * @ctx: Callback context from cb_ctx
643 * @buf: Probe Response frame (including the header and body)
Dmitry Shmidta3dc3092015-06-23 11:21:28 -0700644 * @freq: Forced frequency (in MHz) to use or 0.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700645 * Returns: 0 on success, -1 on failure
646 *
647 * This function is used to reply to Probe Request frames that were
648 * indicated with a call to p2p_probe_req_rx(). The response is to be
Dmitry Shmidta3dc3092015-06-23 11:21:28 -0700649 * sent on the same channel, unless otherwise specified, or to be
650 * dropped if the driver is not listening to Probe Request frames
651 * anymore.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700652 *
653 * Alternatively, the responsibility for building the Probe Response
654 * frames in Listen state may be in another system component in which
655 * case this function need to be implemented (i.e., the function
656 * pointer can be %NULL). The WPS and P2P IEs to be added for Probe
657 * Response frames in such a case are available from the
658 * start_listen() callback. It should be noted that the received Probe
659 * Request frames must be indicated by calling p2p_probe_req_rx() even
660 * if this send_probe_resp() is not used.
661 */
Dmitry Shmidta3dc3092015-06-23 11:21:28 -0700662 int (*send_probe_resp)(void *ctx, const struct wpabuf *buf,
663 unsigned int freq);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700664
665 /**
666 * send_action - Transmit an Action frame
667 * @ctx: Callback context from cb_ctx
668 * @freq: Frequency in MHz for the channel on which to transmit
669 * @dst: Destination MAC address (Address 1)
670 * @src: Source MAC address (Address 2)
671 * @bssid: BSSID (Address 3)
672 * @buf: Frame body (starting from Category field)
673 * @len: Length of buf in octets
674 * @wait_time: How many msec to wait for a response frame
Hai Shalom021b0b52019-04-10 11:17:58 -0700675 * @scheduled: Return value indicating whether the transmissions was
676 * scheduled to happen once the radio is available
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700677 * Returns: 0 on success, -1 on failure
678 *
679 * The Action frame may not be transmitted immediately and the status
680 * of the transmission must be reported by calling
681 * p2p_send_action_cb() once the frame has either been transmitted or
682 * it has been dropped due to excessive retries or other failure to
683 * transmit.
684 */
685 int (*send_action)(void *ctx, unsigned int freq, const u8 *dst,
686 const u8 *src, const u8 *bssid, const u8 *buf,
Hai Shalom021b0b52019-04-10 11:17:58 -0700687 size_t len, unsigned int wait_time, int *scheduled);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700688
689 /**
690 * send_action_done - Notify that Action frame sequence was completed
691 * @ctx: Callback context from cb_ctx
692 *
693 * This function is called when the Action frame sequence that was
694 * started with send_action() has been completed, i.e., when there is
695 * no need to wait for a response from the destination peer anymore.
696 */
697 void (*send_action_done)(void *ctx);
698
699 /**
700 * start_listen - Start Listen state
701 * @ctx: Callback context from cb_ctx
702 * @freq: Frequency of the listen channel in MHz
703 * @duration: Duration for the Listen state in milliseconds
704 * @probe_resp_ie: IE(s) to be added to Probe Response frames
705 * Returns: 0 on success, -1 on failure
706 *
707 * This Listen state may not start immediately since the driver may
708 * have other pending operations to complete first. Once the Listen
709 * state has started, p2p_listen_cb() must be called to notify the P2P
710 * module. Once the Listen state is stopped, p2p_listen_end() must be
711 * called to notify the P2P module that the driver is not in the Listen
712 * state anymore.
713 *
714 * If the send_probe_resp() is not used for generating the response,
715 * the IEs from probe_resp_ie need to be added to the end of the Probe
716 * Response frame body. If send_probe_resp() is used, the probe_resp_ie
717 * information can be ignored.
718 */
719 int (*start_listen)(void *ctx, unsigned int freq,
720 unsigned int duration,
721 const struct wpabuf *probe_resp_ie);
722 /**
723 * stop_listen - Stop Listen state
724 * @ctx: Callback context from cb_ctx
725 *
726 * This callback can be used to stop a Listen state operation that was
727 * previously requested with start_listen().
728 */
729 void (*stop_listen)(void *ctx);
730
731 /**
732 * get_noa - Get current Notice of Absence attribute payload
733 * @ctx: Callback context from cb_ctx
734 * @interface_addr: P2P Interface Address of the GO
735 * @buf: Buffer for returning NoA
736 * @buf_len: Buffer length in octets
737 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
738 * advertized, or -1 on failure
739 *
740 * This function is used to fetch the current Notice of Absence
741 * attribute value from GO.
742 */
743 int (*get_noa)(void *ctx, const u8 *interface_addr, u8 *buf,
744 size_t buf_len);
745
746 /* Callbacks to notify events to upper layer management entity */
747
748 /**
749 * dev_found - Notification of a found P2P Device
750 * @ctx: Callback context from cb_ctx
751 * @addr: Source address of the message triggering this notification
752 * @info: P2P peer information
753 * @new_device: Inform if the peer is newly found
754 *
755 * This callback is used to notify that a new P2P Device has been
756 * found. This may happen, e.g., during Search state based on scan
757 * results or during Listen state based on receive Probe Request and
758 * Group Owner Negotiation Request.
759 */
760 void (*dev_found)(void *ctx, const u8 *addr,
761 const struct p2p_peer_info *info,
762 int new_device);
763
764 /**
765 * dev_lost - Notification of a lost P2P Device
766 * @ctx: Callback context from cb_ctx
767 * @dev_addr: P2P Device Address of the lost P2P Device
768 *
769 * This callback is used to notify that a P2P Device has been deleted.
770 */
771 void (*dev_lost)(void *ctx, const u8 *dev_addr);
772
773 /**
Dmitry Shmidtb6e9aaf2013-05-20 14:49:44 -0700774 * find_stopped - Notification of a p2p_find operation stopping
775 * @ctx: Callback context from cb_ctx
776 */
777 void (*find_stopped)(void *ctx);
778
779 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700780 * go_neg_req_rx - Notification of a receive GO Negotiation Request
781 * @ctx: Callback context from cb_ctx
782 * @src: Source address of the message triggering this notification
783 * @dev_passwd_id: WPS Device Password ID
Dmitry Shmidt7a53dbb2015-06-11 13:13:53 -0700784 * @go_intent: Peer's GO Intent
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700785 *
786 * This callback is used to notify that a P2P Device is requesting
787 * group owner negotiation with us, but we do not have all the
788 * necessary information to start GO Negotiation. This indicates that
789 * the local user has not authorized the connection yet by providing a
790 * PIN or PBC button press. This information can be provided with a
791 * call to p2p_connect().
792 */
Dmitry Shmidt7a53dbb2015-06-11 13:13:53 -0700793 void (*go_neg_req_rx)(void *ctx, const u8 *src, u16 dev_passwd_id,
794 u8 go_intent);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700795
796 /**
797 * go_neg_completed - Notification of GO Negotiation results
798 * @ctx: Callback context from cb_ctx
799 * @res: GO Negotiation results
800 *
801 * This callback is used to notify that Group Owner Negotiation has
802 * been completed. Non-zero struct p2p_go_neg_results::status indicates
803 * failed negotiation. In case of success, this function is responsible
804 * for creating a new group interface (or using the existing interface
805 * depending on driver features), setting up the group interface in
806 * proper mode based on struct p2p_go_neg_results::role_go and
807 * initializing WPS provisioning either as a Registrar (if GO) or as an
808 * Enrollee. Successful WPS provisioning must be indicated by calling
809 * p2p_wps_success_cb(). The callee is responsible for timing out group
810 * formation if WPS provisioning cannot be completed successfully
811 * within 15 seconds.
812 */
813 void (*go_neg_completed)(void *ctx, struct p2p_go_neg_results *res);
814
815 /**
816 * sd_request - Callback on Service Discovery Request
817 * @ctx: Callback context from cb_ctx
818 * @freq: Frequency (in MHz) of the channel
819 * @sa: Source address of the request
820 * @dialog_token: Dialog token
821 * @update_indic: Service Update Indicator from the source of request
822 * @tlvs: P2P Service Request TLV(s)
823 * @tlvs_len: Length of tlvs buffer in octets
824 *
825 * This callback is used to indicate reception of a service discovery
826 * request. Response to the query must be indicated by calling
827 * p2p_sd_response() with the context information from the arguments to
828 * this callback function.
829 *
830 * This callback handler can be set to %NULL to indicate that service
831 * discovery is not supported.
832 */
833 void (*sd_request)(void *ctx, int freq, const u8 *sa, u8 dialog_token,
834 u16 update_indic, const u8 *tlvs, size_t tlvs_len);
835
836 /**
837 * sd_response - Callback on Service Discovery Response
838 * @ctx: Callback context from cb_ctx
839 * @sa: Source address of the request
840 * @update_indic: Service Update Indicator from the source of response
841 * @tlvs: P2P Service Response TLV(s)
842 * @tlvs_len: Length of tlvs buffer in octets
843 *
844 * This callback is used to indicate reception of a service discovery
845 * response. This callback handler can be set to %NULL if no service
846 * discovery requests are used. The information provided with this call
847 * is replies to the queries scheduled with p2p_sd_request().
848 */
849 void (*sd_response)(void *ctx, const u8 *sa, u16 update_indic,
850 const u8 *tlvs, size_t tlvs_len);
851
852 /**
853 * prov_disc_req - Callback on Provisiong Discovery Request
854 * @ctx: Callback context from cb_ctx
855 * @peer: Source address of the request
856 * @config_methods: Requested WPS Config Method
857 * @dev_addr: P2P Device Address of the found P2P Device
858 * @pri_dev_type: Primary Device Type
859 * @dev_name: Device Name
860 * @supp_config_methods: Supported configuration Methods
861 * @dev_capab: Device Capabilities
862 * @group_capab: Group Capabilities
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800863 * @group_id: P2P Group ID (or %NULL if not included)
864 * @group_id_len: Length of P2P Group ID
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700865 *
866 * This callback is used to indicate reception of a Provision Discovery
867 * Request frame that the P2P module accepted.
868 */
869 void (*prov_disc_req)(void *ctx, const u8 *peer, u16 config_methods,
870 const u8 *dev_addr, const u8 *pri_dev_type,
871 const char *dev_name, u16 supp_config_methods,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800872 u8 dev_capab, u8 group_capab,
873 const u8 *group_id, size_t group_id_len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700874
875 /**
876 * prov_disc_resp - Callback on Provisiong Discovery Response
877 * @ctx: Callback context from cb_ctx
878 * @peer: Source address of the response
879 * @config_methods: Value from p2p_prov_disc_req() or 0 on failure
880 *
881 * This callback is used to indicate reception of a Provision Discovery
882 * Response frame for a pending request scheduled with
883 * p2p_prov_disc_req(). This callback handler can be set to %NULL if
884 * provision discovery is not used.
885 */
886 void (*prov_disc_resp)(void *ctx, const u8 *peer, u16 config_methods);
887
888 /**
Jouni Malinen75ecf522011-06-27 15:19:46 -0700889 * prov_disc_fail - Callback on Provision Discovery failure
890 * @ctx: Callback context from cb_ctx
891 * @peer: Source address of the response
892 * @status: Cause of failure, will not be %P2P_PROV_DISC_SUCCESS
Dmitry Shmidt216983b2015-02-06 10:50:36 -0800893 * @adv_id: If non-zero, then the adv_id of the PD Request
894 * @adv_mac: P2P Device Address of the advertizer
895 * @deferred_session_resp: Deferred session response sent by advertizer
Jouni Malinen75ecf522011-06-27 15:19:46 -0700896 *
897 * This callback is used to indicate either a failure or no response
898 * to an earlier provision discovery request.
899 *
900 * This callback handler can be set to %NULL if provision discovery
901 * is not used or failures do not need to be indicated.
902 */
903 void (*prov_disc_fail)(void *ctx, const u8 *peer,
Dmitry Shmidt216983b2015-02-06 10:50:36 -0800904 enum p2p_prov_disc_status status,
905 u32 adv_id, const u8 *adv_mac,
906 const char *deferred_session_resp);
Jouni Malinen75ecf522011-06-27 15:19:46 -0700907
908 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700909 * invitation_process - Optional callback for processing Invitations
910 * @ctx: Callback context from cb_ctx
911 * @sa: Source address of the Invitation Request
912 * @bssid: P2P Group BSSID from the request or %NULL if not included
913 * @go_dev_addr: GO Device Address from P2P Group ID
914 * @ssid: SSID from P2P Group ID
915 * @ssid_len: Length of ssid buffer in octets
916 * @go: Variable for returning whether the local end is GO in the group
917 * @group_bssid: Buffer for returning P2P Group BSSID (if local end GO)
918 * @force_freq: Variable for returning forced frequency for the group
919 * @persistent_group: Whether this is an invitation to reinvoke a
920 * persistent group (instead of invitation to join an active
921 * group)
Dmitry Shmidtf7e0a992013-05-23 11:03:10 -0700922 * @channels: Available operating channels for the group
Dmitry Shmidtcf32e602014-01-28 10:57:39 -0800923 * @dev_pw_id: Device Password ID for NFC static handover or -1 if not
924 * used
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700925 * Returns: Status code (P2P_SC_*)
926 *
927 * This optional callback can be used to implement persistent reconnect
928 * by allowing automatic restarting of persistent groups without user
929 * interaction. If this callback is not implemented (i.e., is %NULL),
930 * the received Invitation Request frames are replied with
931 * %P2P_SC_REQ_RECEIVED status and indicated to upper layer with the
932 * invitation_result() callback.
933 *
934 * If the requested parameters are acceptable and the group is known,
935 * %P2P_SC_SUCCESS may be returned. If the requested group is unknown,
936 * %P2P_SC_FAIL_UNKNOWN_GROUP should be returned. %P2P_SC_REQ_RECEIVED
937 * can be returned if there is not enough data to provide immediate
938 * response, i.e., if some sort of user interaction is needed. The
939 * invitation_received() callback will be called in that case
940 * immediately after this call.
941 */
942 u8 (*invitation_process)(void *ctx, const u8 *sa, const u8 *bssid,
943 const u8 *go_dev_addr, const u8 *ssid,
944 size_t ssid_len, int *go, u8 *group_bssid,
Dmitry Shmidtf7e0a992013-05-23 11:03:10 -0700945 int *force_freq, int persistent_group,
Dmitry Shmidtcf32e602014-01-28 10:57:39 -0800946 const struct p2p_channels *channels,
947 int dev_pw_id);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700948
949 /**
950 * invitation_received - Callback on Invitation Request RX
951 * @ctx: Callback context from cb_ctx
952 * @sa: Source address of the Invitation Request
953 * @bssid: P2P Group BSSID or %NULL if not received
954 * @ssid: SSID of the group
955 * @ssid_len: Length of ssid in octets
956 * @go_dev_addr: GO Device Address
957 * @status: Response Status
958 * @op_freq: Operational frequency for the group
959 *
960 * This callback is used to indicate sending of an Invitation Response
961 * for a received Invitation Request. If status == 0 (success), the
962 * upper layer code is responsible for starting the group. status == 1
963 * indicates need to get user authorization for the group. Other status
964 * values indicate that the invitation request was rejected.
965 */
966 void (*invitation_received)(void *ctx, const u8 *sa, const u8 *bssid,
967 const u8 *ssid, size_t ssid_len,
968 const u8 *go_dev_addr, u8 status,
969 int op_freq);
970
971 /**
972 * invitation_result - Callback on Invitation result
973 * @ctx: Callback context from cb_ctx
974 * @status: Negotiation result (Status Code)
975 * @bssid: P2P Group BSSID or %NULL if not received
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -0800976 * @channels: Available operating channels for the group
Dmitry Shmidt700a1372013-03-15 14:14:44 -0700977 * @addr: Peer address
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -0800978 * @freq: Frequency (in MHz) indicated during invitation or 0
Dmitry Shmidt15907092014-03-25 10:42:57 -0700979 * @peer_oper_freq: Operating frequency (in MHz) advertized by the peer
980 * during invitation or 0
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700981 *
982 * This callback is used to indicate result of an Invitation procedure
983 * started with a call to p2p_invite(). The indicated status code is
984 * the value received from the peer in Invitation Response with 0
985 * (P2P_SC_SUCCESS) indicating success or -1 to indicate a timeout or a
986 * local failure in transmitting the Invitation Request.
987 */
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -0800988 void (*invitation_result)(void *ctx, int status, const u8 *bssid,
Dmitry Shmidt700a1372013-03-15 14:14:44 -0700989 const struct p2p_channels *channels,
Dmitry Shmidt15907092014-03-25 10:42:57 -0700990 const u8 *addr, int freq, int peer_oper_freq);
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800991
992 /**
993 * go_connected - Check whether we are connected to a GO
994 * @ctx: Callback context from cb_ctx
995 * @dev_addr: P2P Device Address of a GO
996 * Returns: 1 if we are connected as a P2P client to the specified GO
997 * or 0 if not.
998 */
999 int (*go_connected)(void *ctx, const u8 *dev_addr);
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001000
1001 /**
1002 * presence_resp - Callback on Presence Response
1003 * @ctx: Callback context from cb_ctx
1004 * @src: Source address (GO's P2P Interface Address)
1005 * @status: Result of the request (P2P_SC_*)
1006 * @noa: Returned NoA value
1007 * @noa_len: Length of the NoA buffer in octets
1008 */
1009 void (*presence_resp)(void *ctx, const u8 *src, u8 status,
1010 const u8 *noa, size_t noa_len);
Dmitry Shmidt18463232014-01-24 12:29:41 -08001011
1012 /**
1013 * is_concurrent_session_active - Check whether concurrent session is
1014 * active on other virtual interfaces
1015 * @ctx: Callback context from cb_ctx
1016 * Returns: 1 if concurrent session is active on other virtual interface
1017 * or 0 if not.
1018 */
1019 int (*is_concurrent_session_active)(void *ctx);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001020
1021 /**
1022 * is_p2p_in_progress - Check whether P2P operation is in progress
1023 * @ctx: Callback context from cb_ctx
1024 * Returns: 1 if P2P operation (e.g., group formation) is in progress
1025 * or 0 if not.
1026 */
1027 int (*is_p2p_in_progress)(void *ctx);
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001028
1029 /**
1030 * Determine if we have a persistent group we share with remote peer
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001031 * and allocate interface for this group if needed
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001032 * @ctx: Callback context from cb_ctx
1033 * @addr: Peer device address to search for
1034 * @ssid: Persistent group SSID or %NULL if any
1035 * @ssid_len: Length of @ssid
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001036 * @go_dev_addr: Buffer for returning GO P2P Device Address
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001037 * @ret_ssid: Buffer for returning group SSID
1038 * @ret_ssid_len: Buffer for returning length of @ssid
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001039 * @intended_iface_addr: Buffer for returning intended iface address
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001040 * Returns: 1 if a matching persistent group was found, 0 otherwise
1041 */
1042 int (*get_persistent_group)(void *ctx, const u8 *addr, const u8 *ssid,
1043 size_t ssid_len, u8 *go_dev_addr,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001044 u8 *ret_ssid, size_t *ret_ssid_len,
1045 u8 *intended_iface_addr);
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001046
1047 /**
1048 * Get information about a possible local GO role
1049 * @ctx: Callback context from cb_ctx
1050 * @intended_addr: Buffer for returning intended GO interface address
1051 * @ssid: Buffer for returning group SSID
1052 * @ssid_len: Buffer for returning length of @ssid
1053 * @group_iface: Buffer for returning whether a separate group interface
1054 * would be used
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001055 * @freq: Variable for returning the current operating frequency of a
1056 * currently running P2P GO.
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001057 * Returns: 1 if GO info found, 0 otherwise
1058 *
1059 * This is used to compose New Group settings (SSID, and intended
1060 * address) during P2PS provisioning if results of provisioning *might*
1061 * result in our being an autonomous GO.
1062 */
1063 int (*get_go_info)(void *ctx, u8 *intended_addr,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001064 u8 *ssid, size_t *ssid_len, int *group_iface,
1065 unsigned int *freq);
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001066
1067 /**
1068 * remove_stale_groups - Remove stale P2PS groups
1069 *
1070 * Because P2PS stages *potential* GOs, and remote devices can remove
1071 * credentials unilaterally, we need to make sure we don't let stale
1072 * unusable groups build up.
1073 */
1074 int (*remove_stale_groups)(void *ctx, const u8 *peer, const u8 *go,
1075 const u8 *ssid, size_t ssid_len);
1076
1077 /**
1078 * p2ps_prov_complete - P2PS provisioning complete
1079 *
1080 * When P2PS provisioning completes (successfully or not) we must
1081 * transmit all of the results to the upper layers.
1082 */
1083 void (*p2ps_prov_complete)(void *ctx, u8 status, const u8 *dev,
1084 const u8 *adv_mac, const u8 *ses_mac,
1085 const u8 *grp_mac, u32 adv_id, u32 ses_id,
1086 u8 conncap, int passwd_id,
1087 const u8 *persist_ssid,
1088 size_t persist_ssid_size, int response_done,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001089 int prov_start, const char *session_info,
1090 const u8 *feat_cap, size_t feat_cap_len,
Dmitry Shmidtde47be72016-01-07 12:52:55 -08001091 unsigned int freq, const u8 *group_ssid,
1092 size_t group_ssid_len);
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001093
1094 /**
1095 * prov_disc_resp_cb - Callback for indicating completion of PD Response
1096 * @ctx: Callback context from cb_ctx
1097 * Returns: 1 if operation was started, 0 otherwise
1098 *
1099 * This callback can be used to perform any pending actions after
1100 * provisioning. It is mainly used for P2PS pending group creation.
1101 */
1102 int (*prov_disc_resp_cb)(void *ctx);
1103
1104 /**
1105 * p2ps_group_capability - Determine group capability
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001106 * @ctx: Callback context from cb_ctx
1107 * @incoming: Peer requested roles, expressed with P2PS_SETUP_* bitmap.
1108 * @role: Local roles, expressed with P2PS_SETUP_* bitmap.
1109 * @force_freq: Variable for returning forced frequency for the group.
1110 * @pref_freq: Variable for returning preferred frequency for the group.
1111 * Returns: P2PS_SETUP_* bitmap of group capability result.
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001112 *
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001113 * This function can be used to determine group capability and
1114 * frequencies based on information from P2PS PD exchange and the
1115 * current state of ongoing groups and driver capabilities.
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001116 */
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001117 u8 (*p2ps_group_capability)(void *ctx, u8 incoming, u8 role,
1118 unsigned int *force_freq,
1119 unsigned int *pref_freq);
1120
1121 /**
1122 * get_pref_freq_list - Get preferred frequency list for an interface
1123 * @ctx: Callback context from cb_ctx
1124 * @go: Whether the use if for GO role
1125 * @len: Length of freq_list in entries (both IN and OUT)
1126 * @freq_list: Buffer for returning the preferred frequencies (MHz)
1127 * Returns: 0 on success, -1 on failure
1128 *
1129 * This function can be used to query the preferred frequency list from
1130 * the driver specific to a particular interface type.
1131 */
1132 int (*get_pref_freq_list)(void *ctx, int go,
1133 unsigned int *len, unsigned int *freq_list);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001134};
1135
1136
1137/* P2P module initialization/deinitialization */
1138
1139/**
1140 * p2p_init - Initialize P2P module
1141 * @cfg: P2P module configuration
1142 * Returns: Pointer to private data or %NULL on failure
1143 *
1144 * This function is used to initialize global P2P module context (one per
1145 * device). The P2P module will keep a copy of the configuration data, so the
1146 * caller does not need to maintain this structure. However, the callback
1147 * functions and the context parameters to them must be kept available until
1148 * the P2P module is deinitialized with p2p_deinit().
1149 */
1150struct p2p_data * p2p_init(const struct p2p_config *cfg);
1151
1152/**
1153 * p2p_deinit - Deinitialize P2P module
1154 * @p2p: P2P module context from p2p_init()
1155 */
1156void p2p_deinit(struct p2p_data *p2p);
1157
1158/**
1159 * p2p_flush - Flush P2P module state
1160 * @p2p: P2P module context from p2p_init()
1161 *
1162 * This command removes the P2P module state like peer device entries.
1163 */
1164void p2p_flush(struct p2p_data *p2p);
1165
1166/**
1167 * p2p_unauthorize - Unauthorize the specified peer device
1168 * @p2p: P2P module context from p2p_init()
1169 * @addr: P2P peer entry to be unauthorized
1170 * Returns: 0 on success, -1 on failure
1171 *
1172 * This command removes any connection authorization from the specified P2P
1173 * peer device address. This can be used, e.g., to cancel effect of a previous
1174 * p2p_authorize() or p2p_connect() call that has not yet resulted in completed
1175 * GO Negotiation.
1176 */
1177int p2p_unauthorize(struct p2p_data *p2p, const u8 *addr);
1178
1179/**
1180 * p2p_set_dev_name - Set device name
1181 * @p2p: P2P module context from p2p_init()
1182 * Returns: 0 on success, -1 on failure
1183 *
1184 * This function can be used to update the P2P module configuration with
1185 * information that was not available at the time of the p2p_init() call.
1186 */
1187int p2p_set_dev_name(struct p2p_data *p2p, const char *dev_name);
1188
1189int p2p_set_manufacturer(struct p2p_data *p2p, const char *manufacturer);
1190int p2p_set_model_name(struct p2p_data *p2p, const char *model_name);
1191int p2p_set_model_number(struct p2p_data *p2p, const char *model_number);
1192int p2p_set_serial_number(struct p2p_data *p2p, const char *serial_number);
1193
1194void p2p_set_config_methods(struct p2p_data *p2p, u16 config_methods);
1195void p2p_set_uuid(struct p2p_data *p2p, const u8 *uuid);
1196
1197/**
1198 * p2p_set_pri_dev_type - Set primary device type
1199 * @p2p: P2P module context from p2p_init()
1200 * Returns: 0 on success, -1 on failure
1201 *
1202 * This function can be used to update the P2P module configuration with
1203 * information that was not available at the time of the p2p_init() call.
1204 */
1205int p2p_set_pri_dev_type(struct p2p_data *p2p, const u8 *pri_dev_type);
1206
1207/**
1208 * p2p_set_sec_dev_types - Set secondary device types
1209 * @p2p: P2P module context from p2p_init()
1210 * Returns: 0 on success, -1 on failure
1211 *
1212 * This function can be used to update the P2P module configuration with
1213 * information that was not available at the time of the p2p_init() call.
1214 */
1215int p2p_set_sec_dev_types(struct p2p_data *p2p, const u8 dev_types[][8],
1216 size_t num_dev_types);
1217
1218int p2p_set_country(struct p2p_data *p2p, const char *country);
1219
1220
1221/* Commands from upper layer management entity */
1222
1223enum p2p_discovery_type {
1224 P2P_FIND_START_WITH_FULL,
1225 P2P_FIND_ONLY_SOCIAL,
1226 P2P_FIND_PROGRESSIVE
1227};
1228
1229/**
1230 * p2p_find - Start P2P Find (Device Discovery)
1231 * @p2p: P2P module context from p2p_init()
1232 * @timeout: Timeout for find operation in seconds or 0 for no timeout
1233 * @type: Device Discovery type
1234 * @num_req_dev_types: Number of requested device types
1235 * @req_dev_types: Requested device types array, must be an array
1236 * containing num_req_dev_types * WPS_DEV_TYPE_LEN bytes; %NULL if no
1237 * requested device types.
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001238 * @dev_id: Device ID to search for or %NULL to find all devices
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001239 * @search_delay: Extra delay in milliseconds between search iterations
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001240 * @seek_count: Number of ASP Service Strings in the seek_string array
1241 * @seek_string: ASP Service Strings to query for in Probe Requests
Dmitry Shmidt203eadb2015-03-05 14:16:04 -08001242 * @freq: Requested first scan frequency (in MHz) to modify type ==
1243 * P2P_FIND_START_WITH_FULL behavior. 0 = Use normal full scan.
1244 * If p2p_find is already in progress, this parameter is ignored and full
1245 * scan will be executed.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001246 * Returns: 0 on success, -1 on failure
1247 */
1248int p2p_find(struct p2p_data *p2p, unsigned int timeout,
1249 enum p2p_discovery_type type,
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001250 unsigned int num_req_dev_types, const u8 *req_dev_types,
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001251 const u8 *dev_id, unsigned int search_delay,
Dmitry Shmidt203eadb2015-03-05 14:16:04 -08001252 u8 seek_count, const char **seek_string, int freq);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001253
1254/**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001255 * p2p_notify_scan_trigger_status - Indicate scan trigger status
1256 * @p2p: P2P module context from p2p_init()
1257 * @status: 0 on success, -1 on failure
1258 */
1259void p2p_notify_scan_trigger_status(struct p2p_data *p2p, int status);
1260
1261/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001262 * p2p_stop_find - Stop P2P Find (Device Discovery)
1263 * @p2p: P2P module context from p2p_init()
1264 */
1265void p2p_stop_find(struct p2p_data *p2p);
1266
1267/**
1268 * p2p_stop_find_for_freq - Stop P2P Find for next oper on specific freq
1269 * @p2p: P2P module context from p2p_init()
1270 * @freq: Frequency in MHz for next operation
1271 *
1272 * This is like p2p_stop_find(), but Listen state is not stopped if we are
1273 * already on the same frequency.
1274 */
1275void p2p_stop_find_for_freq(struct p2p_data *p2p, int freq);
1276
1277/**
1278 * p2p_listen - Start P2P Listen state for specified duration
1279 * @p2p: P2P module context from p2p_init()
1280 * @timeout: Listen state duration in milliseconds
1281 * Returns: 0 on success, -1 on failure
1282 *
1283 * This function can be used to request the P2P module to keep the device
1284 * discoverable on the listen channel for an extended set of time. At least in
1285 * its current form, this is mainly used for testing purposes and may not be of
1286 * much use for normal P2P operations.
1287 */
1288int p2p_listen(struct p2p_data *p2p, unsigned int timeout);
1289
1290/**
Dmitry Shmidt391c59f2013-09-03 12:16:28 -07001291 * p2p_stop_listen - Stop P2P Listen
1292 * @p2p: P2P module context from p2p_init()
1293 */
1294void p2p_stop_listen(struct p2p_data *p2p);
1295
1296/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001297 * p2p_connect - Start P2P group formation (GO negotiation)
1298 * @p2p: P2P module context from p2p_init()
1299 * @peer_addr: MAC address of the peer P2P client
1300 * @wps_method: WPS method to be used in provisioning
1301 * @go_intent: Local GO intent value (1..15)
1302 * @own_interface_addr: Intended interface address to use with the group
1303 * @force_freq: The only allowed channel frequency in MHz or 0
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001304 * @persistent_group: Whether to create a persistent group (0 = no, 1 =
1305 * persistent group without persistent reconnect, 2 = persistent group with
1306 * persistent reconnect)
Dmitry Shmidt04949592012-07-19 12:16:46 -07001307 * @force_ssid: Forced SSID for the group if we become GO or %NULL to generate
1308 * a new SSID
1309 * @force_ssid_len: Length of $force_ssid buffer
1310 * @pd_before_go_neg: Whether to send Provision Discovery prior to GO
1311 * Negotiation as an interoperability workaround when initiating group
1312 * formation
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001313 * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if
1314 * force_freq == 0)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001315 * Returns: 0 on success, -1 on failure
1316 */
1317int p2p_connect(struct p2p_data *p2p, const u8 *peer_addr,
1318 enum p2p_wps_method wps_method,
1319 int go_intent, const u8 *own_interface_addr,
Dmitry Shmidt04949592012-07-19 12:16:46 -07001320 unsigned int force_freq, int persistent_group,
1321 const u8 *force_ssid, size_t force_ssid_len,
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08001322 int pd_before_go_neg, unsigned int pref_freq, u16 oob_pw_id);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001323
1324/**
1325 * p2p_authorize - Authorize P2P group formation (GO negotiation)
1326 * @p2p: P2P module context from p2p_init()
1327 * @peer_addr: MAC address of the peer P2P client
1328 * @wps_method: WPS method to be used in provisioning
1329 * @go_intent: Local GO intent value (1..15)
1330 * @own_interface_addr: Intended interface address to use with the group
1331 * @force_freq: The only allowed channel frequency in MHz or 0
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001332 * @persistent_group: Whether to create a persistent group (0 = no, 1 =
1333 * persistent group without persistent reconnect, 2 = persistent group with
1334 * persistent reconnect)
Dmitry Shmidt04949592012-07-19 12:16:46 -07001335 * @force_ssid: Forced SSID for the group if we become GO or %NULL to generate
1336 * a new SSID
1337 * @force_ssid_len: Length of $force_ssid buffer
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001338 * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if
1339 * force_freq == 0)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001340 * Returns: 0 on success, -1 on failure
1341 *
1342 * This is like p2p_connect(), but the actual group negotiation is not
1343 * initiated automatically, i.e., the other end is expected to do that.
1344 */
1345int p2p_authorize(struct p2p_data *p2p, const u8 *peer_addr,
1346 enum p2p_wps_method wps_method,
1347 int go_intent, const u8 *own_interface_addr,
Dmitry Shmidt04949592012-07-19 12:16:46 -07001348 unsigned int force_freq, int persistent_group,
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001349 const u8 *force_ssid, size_t force_ssid_len,
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08001350 unsigned int pref_freq, u16 oob_pw_id);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001351
1352/**
1353 * p2p_reject - Reject peer device (explicitly block connection attempts)
1354 * @p2p: P2P module context from p2p_init()
1355 * @peer_addr: MAC address of the peer P2P client
1356 * Returns: 0 on success, -1 on failure
1357 */
1358int p2p_reject(struct p2p_data *p2p, const u8 *peer_addr);
1359
1360/**
1361 * p2p_prov_disc_req - Send Provision Discovery Request
1362 * @p2p: P2P module context from p2p_init()
1363 * @peer_addr: MAC address of the peer P2P client
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001364 * @p2ps_prov: Provisioning info for P2PS
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001365 * @config_methods: WPS Config Methods value (only one bit set)
1366 * @join: Whether this is used by a client joining an active group
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001367 * @force_freq: Forced TX frequency for the frame (mainly for the join case)
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001368 * @user_initiated_pd: Flag to indicate if initiated by user or not
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001369 * Returns: 0 on success, -1 on failure
1370 *
1371 * This function can be used to request a discovered P2P peer to display a PIN
1372 * (config_methods = WPS_CONFIG_DISPLAY) or be prepared to enter a PIN from us
1373 * (config_methods = WPS_CONFIG_KEYPAD). The Provision Discovery Request frame
1374 * is transmitted once immediately and if no response is received, the frame
1375 * will be sent again whenever the target device is discovered during device
1376 * dsicovery (start with a p2p_find() call). Response from the peer is
1377 * indicated with the p2p_config::prov_disc_resp() callback.
1378 */
1379int p2p_prov_disc_req(struct p2p_data *p2p, const u8 *peer_addr,
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001380 struct p2ps_provision *p2ps_prov, u16 config_methods,
1381 int join, int force_freq,
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001382 int user_initiated_pd);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001383
1384/**
1385 * p2p_sd_request - Schedule a service discovery query
1386 * @p2p: P2P module context from p2p_init()
1387 * @dst: Destination peer or %NULL to apply for all peers
1388 * @tlvs: P2P Service Query TLV(s)
1389 * Returns: Reference to the query or %NULL on failure
1390 *
1391 * Response to the query is indicated with the p2p_config::sd_response()
1392 * callback.
1393 */
1394void * p2p_sd_request(struct p2p_data *p2p, const u8 *dst,
1395 const struct wpabuf *tlvs);
1396
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001397#ifdef CONFIG_WIFI_DISPLAY
1398void * p2p_sd_request_wfd(struct p2p_data *p2p, const u8 *dst,
1399 const struct wpabuf *tlvs);
1400#endif /* CONFIG_WIFI_DISPLAY */
1401
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001402/**
1403 * p2p_sd_cancel_request - Cancel a pending service discovery query
1404 * @p2p: P2P module context from p2p_init()
1405 * @req: Query reference from p2p_sd_request()
1406 * Returns: 0 if request for cancelled; -1 if not found
1407 */
1408int p2p_sd_cancel_request(struct p2p_data *p2p, void *req);
1409
1410/**
1411 * p2p_sd_response - Send response to a service discovery query
1412 * @p2p: P2P module context from p2p_init()
1413 * @freq: Frequency from p2p_config::sd_request() callback
1414 * @dst: Destination address from p2p_config::sd_request() callback
1415 * @dialog_token: Dialog token from p2p_config::sd_request() callback
1416 * @resp_tlvs: P2P Service Response TLV(s)
1417 *
1418 * This function is called as a response to the request indicated with
1419 * p2p_config::sd_request() callback.
1420 */
1421void p2p_sd_response(struct p2p_data *p2p, int freq, const u8 *dst,
1422 u8 dialog_token, const struct wpabuf *resp_tlvs);
1423
1424/**
1425 * p2p_sd_service_update - Indicate a change in local services
1426 * @p2p: P2P module context from p2p_init()
1427 *
1428 * This function needs to be called whenever there is a change in availability
1429 * of the local services. This will increment the Service Update Indicator
1430 * value which will be used in SD Request and Response frames.
1431 */
1432void p2p_sd_service_update(struct p2p_data *p2p);
1433
1434
1435enum p2p_invite_role {
1436 P2P_INVITE_ROLE_GO,
1437 P2P_INVITE_ROLE_ACTIVE_GO,
1438 P2P_INVITE_ROLE_CLIENT
1439};
1440
1441/**
1442 * p2p_invite - Invite a P2P Device into a group
1443 * @p2p: P2P module context from p2p_init()
1444 * @peer: Device Address of the peer P2P Device
1445 * @role: Local role in the group
1446 * @bssid: Group BSSID or %NULL if not known
1447 * @ssid: Group SSID
1448 * @ssid_len: Length of ssid in octets
1449 * @force_freq: The only allowed channel frequency in MHz or 0
1450 * @go_dev_addr: Forced GO Device Address or %NULL if none
1451 * @persistent_group: Whether this is to reinvoke a persistent group
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08001452 * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if
1453 * force_freq == 0)
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08001454 * @dev_pw_id: Device Password ID from OOB Device Password (NFC) static handover
1455 * case or -1 if not used
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001456 * Returns: 0 on success, -1 on failure
1457 */
1458int p2p_invite(struct p2p_data *p2p, const u8 *peer, enum p2p_invite_role role,
1459 const u8 *bssid, const u8 *ssid, size_t ssid_len,
1460 unsigned int force_freq, const u8 *go_dev_addr,
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08001461 int persistent_group, unsigned int pref_freq, int dev_pw_id);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001462
1463/**
1464 * p2p_presence_req - Request GO presence
1465 * @p2p: P2P module context from p2p_init()
1466 * @go_interface_addr: GO P2P Interface Address
1467 * @own_interface_addr: Own P2P Interface Address for this group
1468 * @freq: Group operating frequence (in MHz)
1469 * @duration1: Preferred presence duration in microseconds
1470 * @interval1: Preferred presence interval in microseconds
1471 * @duration2: Acceptable presence duration in microseconds
1472 * @interval2: Acceptable presence interval in microseconds
1473 * Returns: 0 on success, -1 on failure
1474 *
1475 * If both duration and interval values are zero, the parameter pair is not
1476 * specified (i.e., to remove Presence Request, use duration1 = interval1 = 0).
1477 */
1478int p2p_presence_req(struct p2p_data *p2p, const u8 *go_interface_addr,
1479 const u8 *own_interface_addr, unsigned int freq,
1480 u32 duration1, u32 interval1, u32 duration2,
1481 u32 interval2);
1482
1483/**
1484 * p2p_ext_listen - Set Extended Listen Timing
1485 * @p2p: P2P module context from p2p_init()
1486 * @freq: Group operating frequence (in MHz)
1487 * @period: Availability period in milliseconds (1-65535; 0 to disable)
1488 * @interval: Availability interval in milliseconds (1-65535; 0 to disable)
1489 * Returns: 0 on success, -1 on failure
1490 *
1491 * This function can be used to enable or disable (period = interval = 0)
1492 * Extended Listen Timing. When enabled, the P2P Device will become
1493 * discoverable (go into Listen State) every @interval milliseconds for at
1494 * least @period milliseconds.
1495 */
1496int p2p_ext_listen(struct p2p_data *p2p, unsigned int period,
1497 unsigned int interval);
1498
1499/* Event notifications from upper layer management operations */
1500
1501/**
1502 * p2p_wps_success_cb - Report successfully completed WPS provisioning
1503 * @p2p: P2P module context from p2p_init()
1504 * @mac_addr: Peer address
1505 *
1506 * This function is used to report successfully completed WPS provisioning
1507 * during group formation in both GO/Registrar and client/Enrollee roles.
1508 */
1509void p2p_wps_success_cb(struct p2p_data *p2p, const u8 *mac_addr);
1510
1511/**
1512 * p2p_group_formation_failed - Report failed WPS provisioning
1513 * @p2p: P2P module context from p2p_init()
1514 *
1515 * This function is used to report failed group formation. This can happen
1516 * either due to failed WPS provisioning or due to 15 second timeout during
1517 * the provisioning phase.
1518 */
1519void p2p_group_formation_failed(struct p2p_data *p2p);
1520
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001521/**
1522 * p2p_get_provisioning_info - Get any stored provisioning info
1523 * @p2p: P2P module context from p2p_init()
1524 * @addr: Peer P2P Device Address
1525 * Returns: WPS provisioning information (WPS config method) or 0 if no
1526 * information is available
1527 *
1528 * This function is used to retrieve stored WPS provisioning info for the given
1529 * peer.
1530 */
1531u16 p2p_get_provisioning_info(struct p2p_data *p2p, const u8 *addr);
1532
1533/**
1534 * p2p_clear_provisioning_info - Clear any stored provisioning info
1535 * @p2p: P2P module context from p2p_init()
Dmitry Shmidt04949592012-07-19 12:16:46 -07001536 * @iface_addr: Peer P2P Device Address
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001537 *
1538 * This function is used to clear stored WPS provisioning info for the given
1539 * peer.
1540 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001541void p2p_clear_provisioning_info(struct p2p_data *p2p, const u8 *addr);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001542
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001543
1544/* Event notifications from lower layer driver operations */
1545
1546/**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001547 * enum p2p_probe_req_status
1548 *
1549 * @P2P_PREQ_MALFORMED: frame was not well-formed
1550 * @P2P_PREQ_NOT_LISTEN: device isn't in listen state, frame ignored
1551 * @P2P_PREQ_NOT_P2P: frame was not a P2P probe request
1552 * @P2P_PREQ_P2P_NOT_PROCESSED: frame was P2P but wasn't processed
1553 * @P2P_PREQ_P2P_PROCESSED: frame has been processed by P2P
1554 */
1555enum p2p_probe_req_status {
1556 P2P_PREQ_MALFORMED,
1557 P2P_PREQ_NOT_LISTEN,
1558 P2P_PREQ_NOT_P2P,
1559 P2P_PREQ_NOT_PROCESSED,
1560 P2P_PREQ_PROCESSED
1561};
1562
1563/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001564 * p2p_probe_req_rx - Report reception of a Probe Request frame
1565 * @p2p: P2P module context from p2p_init()
1566 * @addr: Source MAC address
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001567 * @dst: Destination MAC address if available or %NULL
1568 * @bssid: BSSID if available or %NULL
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001569 * @ie: Information elements from the Probe Request frame body
1570 * @ie_len: Length of ie buffer in octets
Dmitry Shmidta3dc3092015-06-23 11:21:28 -07001571 * @rx_freq: Probe Request frame RX frequency
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001572 * @p2p_lo_started: Whether P2P Listen Offload is started
Dmitry Shmidt04949592012-07-19 12:16:46 -07001573 * Returns: value indicating the type and status of the probe request
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001574 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001575enum p2p_probe_req_status
1576p2p_probe_req_rx(struct p2p_data *p2p, const u8 *addr, const u8 *dst,
Dmitry Shmidta3dc3092015-06-23 11:21:28 -07001577 const u8 *bssid, const u8 *ie, size_t ie_len,
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001578 unsigned int rx_freq, int p2p_lo_started);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001579
1580/**
1581 * p2p_rx_action - Report received Action frame
1582 * @p2p: P2P module context from p2p_init()
1583 * @da: Destination address of the received Action frame
1584 * @sa: Source address of the received Action frame
1585 * @bssid: Address 3 of the received Action frame
1586 * @category: Category of the received Action frame
1587 * @data: Action frame body after the Category field
1588 * @len: Length of the data buffer in octets
1589 * @freq: Frequency (in MHz) on which the frame was received
1590 */
1591void p2p_rx_action(struct p2p_data *p2p, const u8 *da, const u8 *sa,
1592 const u8 *bssid, u8 category,
1593 const u8 *data, size_t len, int freq);
1594
1595/**
1596 * p2p_scan_res_handler - Indicate a P2P scan results
1597 * @p2p: P2P module context from p2p_init()
1598 * @bssid: BSSID of the scan result
1599 * @freq: Frequency of the channel on which the device was found in MHz
Dmitry Shmidtf8623282013-02-20 14:34:59 -08001600 * @rx_time: Time when the result was received
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001601 * @level: Signal level (signal strength of the received Beacon/Probe Response
1602 * frame)
1603 * @ies: Pointer to IEs from the scan result
1604 * @ies_len: Length of the ies buffer
1605 * Returns: 0 to continue or 1 to stop scan result indication
1606 *
1607 * This function is called to indicate a scan result entry with P2P IE from a
1608 * scan requested with struct p2p_config::p2p_scan(). This can be called during
1609 * the actual scan process (i.e., whenever a new device is found) or as a
1610 * sequence of calls after the full scan has been completed. The former option
1611 * can result in optimized operations, but may not be supported by all
1612 * driver/firmware designs. The ies buffer need to include at least the P2P IE,
1613 * but it is recommended to include all IEs received from the device. The
1614 * caller does not need to check that the IEs contain a P2P IE before calling
1615 * this function since frames will be filtered internally if needed.
1616 *
1617 * This function will return 1 if it wants to stop scan result iteration (and
1618 * scan in general if it is still in progress). This is used to allow faster
1619 * start of a pending operation, e.g., to start a pending GO negotiation.
1620 */
1621int p2p_scan_res_handler(struct p2p_data *p2p, const u8 *bssid, int freq,
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001622 struct os_reltime *rx_time, int level, const u8 *ies,
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001623 size_t ies_len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001624
1625/**
1626 * p2p_scan_res_handled - Indicate end of scan results
1627 * @p2p: P2P module context from p2p_init()
Hai Shalom60840252021-02-19 19:02:11 -08001628 * @delay: Search delay for next scan in ms
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001629 *
1630 * This function is called to indicate that all P2P scan results from a scan
1631 * have been reported with zero or more calls to p2p_scan_res_handler(). This
1632 * function must be called as a response to successful
1633 * struct p2p_config::p2p_scan() call if none of the p2p_scan_res_handler()
1634 * calls stopped iteration.
1635 */
Hai Shalom60840252021-02-19 19:02:11 -08001636void p2p_scan_res_handled(struct p2p_data *p2p, unsigned int delay);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001637
1638enum p2p_send_action_result {
1639 P2P_SEND_ACTION_SUCCESS /* Frame was send and acknowledged */,
1640 P2P_SEND_ACTION_NO_ACK /* Frame was sent, but not acknowledged */,
1641 P2P_SEND_ACTION_FAILED /* Frame was not sent due to a failure */
1642};
1643
1644/**
1645 * p2p_send_action_cb - Notify TX status of an Action frame
1646 * @p2p: P2P module context from p2p_init()
1647 * @freq: Channel frequency in MHz
1648 * @dst: Destination MAC address (Address 1)
1649 * @src: Source MAC address (Address 2)
1650 * @bssid: BSSID (Address 3)
1651 * @result: Result of the transmission attempt
1652 *
1653 * This function is used to indicate the result of an Action frame transmission
1654 * that was requested with struct p2p_config::send_action() callback.
1655 */
1656void p2p_send_action_cb(struct p2p_data *p2p, unsigned int freq, const u8 *dst,
1657 const u8 *src, const u8 *bssid,
1658 enum p2p_send_action_result result);
1659
1660/**
1661 * p2p_listen_cb - Indicate the start of a requested Listen state
1662 * @p2p: P2P module context from p2p_init()
1663 * @freq: Listen channel frequency in MHz
1664 * @duration: Duration for the Listen state in milliseconds
1665 *
1666 * This function is used to indicate that a Listen state requested with
1667 * struct p2p_config::start_listen() callback has started.
1668 */
1669void p2p_listen_cb(struct p2p_data *p2p, unsigned int freq,
1670 unsigned int duration);
1671
1672/**
1673 * p2p_listen_end - Indicate the end of a requested Listen state
1674 * @p2p: P2P module context from p2p_init()
1675 * @freq: Listen channel frequency in MHz
1676 * Returns: 0 if no operations were started, 1 if an operation was started
1677 *
1678 * This function is used to indicate that a Listen state requested with
1679 * struct p2p_config::start_listen() callback has ended.
1680 */
1681int p2p_listen_end(struct p2p_data *p2p, unsigned int freq);
1682
1683void p2p_deauth_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code,
1684 const u8 *ie, size_t ie_len);
1685
1686void p2p_disassoc_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code,
1687 const u8 *ie, size_t ie_len);
1688
1689
1690/* Per-group P2P state for GO */
1691
1692struct p2p_group;
1693
1694/**
1695 * struct p2p_group_config - P2P group configuration
1696 *
1697 * This configuration is provided to the P2P module during initialization of
1698 * the per-group information with p2p_group_init().
1699 */
1700struct p2p_group_config {
1701 /**
1702 * persistent_group - Whether the group is persistent
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001703 * 0 = not a persistent group
1704 * 1 = persistent group without persistent reconnect
1705 * 2 = persistent group with persistent reconnect
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001706 */
1707 int persistent_group;
1708
1709 /**
1710 * interface_addr - P2P Interface Address of the group
1711 */
1712 u8 interface_addr[ETH_ALEN];
1713
1714 /**
1715 * max_clients - Maximum number of clients in the group
1716 */
1717 unsigned int max_clients;
1718
1719 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001720 * ssid - Group SSID
1721 */
Dmitry Shmidt9d9e6022015-04-23 10:34:55 -07001722 u8 ssid[SSID_MAX_LEN];
Dmitry Shmidt04949592012-07-19 12:16:46 -07001723
1724 /**
1725 * ssid_len - Length of SSID
1726 */
1727 size_t ssid_len;
1728
1729 /**
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08001730 * freq - Operating channel of the group
1731 */
1732 int freq;
1733
1734 /**
Dmitry Shmidte4663042016-04-04 10:07:49 -07001735 * ip_addr_alloc - Whether IP address allocation within 4-way handshake
1736 * is supported
1737 */
1738 int ip_addr_alloc;
1739
1740 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001741 * cb_ctx - Context to use with callback functions
1742 */
1743 void *cb_ctx;
1744
1745 /**
1746 * ie_update - Notification of IE update
1747 * @ctx: Callback context from cb_ctx
1748 * @beacon_ies: P2P IE for Beacon frames or %NULL if no change
1749 * @proberesp_ies: P2P Ie for Probe Response frames
1750 *
1751 * P2P module uses this callback function to notify whenever the P2P IE
1752 * in Beacon or Probe Response frames should be updated based on group
1753 * events.
1754 *
1755 * The callee is responsible for freeing the returned buffer(s) with
1756 * wpabuf_free().
1757 */
1758 void (*ie_update)(void *ctx, struct wpabuf *beacon_ies,
1759 struct wpabuf *proberesp_ies);
1760
1761 /**
1762 * idle_update - Notification of changes in group idle state
1763 * @ctx: Callback context from cb_ctx
1764 * @idle: Whether the group is idle (no associated stations)
1765 */
1766 void (*idle_update)(void *ctx, int idle);
1767};
1768
1769/**
1770 * p2p_group_init - Initialize P2P group
1771 * @p2p: P2P module context from p2p_init()
1772 * @config: P2P group configuration (will be freed by p2p_group_deinit())
1773 * Returns: Pointer to private data or %NULL on failure
1774 *
1775 * This function is used to initialize per-group P2P module context. Currently,
1776 * this is only used to manage GO functionality and P2P clients do not need to
1777 * create an instance of this per-group information.
1778 */
1779struct p2p_group * p2p_group_init(struct p2p_data *p2p,
1780 struct p2p_group_config *config);
1781
1782/**
1783 * p2p_group_deinit - Deinitialize P2P group
1784 * @group: P2P group context from p2p_group_init()
1785 */
1786void p2p_group_deinit(struct p2p_group *group);
1787
1788/**
1789 * p2p_group_notif_assoc - Notification of P2P client association with GO
1790 * @group: P2P group context from p2p_group_init()
1791 * @addr: Interface address of the P2P client
1792 * @ie: IEs from the (Re)association Request frame
1793 * @len: Length of the ie buffer in octets
1794 * Returns: 0 on success, -1 on failure
1795 */
1796int p2p_group_notif_assoc(struct p2p_group *group, const u8 *addr,
1797 const u8 *ie, size_t len);
1798
1799/**
1800 * p2p_group_assoc_resp_ie - Build P2P IE for (re)association response
1801 * @group: P2P group context from p2p_group_init()
1802 * @status: Status value (P2P_SC_SUCCESS if association succeeded)
1803 * Returns: P2P IE for (Re)association Response or %NULL on failure
1804 *
1805 * The caller is responsible for freeing the returned buffer with
1806 * wpabuf_free().
1807 */
1808struct wpabuf * p2p_group_assoc_resp_ie(struct p2p_group *group, u8 status);
1809
1810/**
1811 * p2p_group_notif_disassoc - Notification of P2P client disassociation from GO
1812 * @group: P2P group context from p2p_group_init()
1813 * @addr: Interface address of the P2P client
1814 */
1815void p2p_group_notif_disassoc(struct p2p_group *group, const u8 *addr);
1816
1817/**
1818 * p2p_group_notif_formation_done - Notification of completed group formation
1819 * @group: P2P group context from p2p_group_init()
1820 */
1821void p2p_group_notif_formation_done(struct p2p_group *group);
1822
1823/**
1824 * p2p_group_notif_noa - Notification of NoA change
1825 * @group: P2P group context from p2p_group_init()
1826 * @noa: Notice of Absence attribute payload, %NULL if none
1827 * @noa_len: Length of noa buffer in octets
1828 * Returns: 0 on success, -1 on failure
1829 *
1830 * Notify the P2P group management about a new NoA contents. This will be
1831 * inserted into the P2P IEs in Beacon and Probe Response frames with rest of
1832 * the group information.
1833 */
1834int p2p_group_notif_noa(struct p2p_group *group, const u8 *noa,
1835 size_t noa_len);
1836
1837/**
1838 * p2p_group_match_dev_type - Match device types in group with requested type
1839 * @group: P2P group context from p2p_group_init()
1840 * @wps: WPS TLVs from Probe Request frame (concatenated WPS IEs)
1841 * Returns: 1 on match, 0 on mismatch
1842 *
1843 * This function can be used to match the Requested Device Type attribute in
1844 * WPS IE with the device types of a group member for deciding whether a GO
1845 * should reply to a Probe Request frame. Match will be reported if the WPS IE
1846 * is not requested any specific device type.
1847 */
1848int p2p_group_match_dev_type(struct p2p_group *group, struct wpabuf *wps);
1849
1850/**
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001851 * p2p_group_match_dev_id - Match P2P Device Address in group with requested device id
1852 */
1853int p2p_group_match_dev_id(struct p2p_group *group, struct wpabuf *p2p);
1854
1855/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001856 * p2p_group_go_discover - Send GO Discoverability Request to a group client
1857 * @group: P2P group context from p2p_group_init()
1858 * Returns: 0 on success (frame scheduled); -1 if client was not found
1859 */
1860int p2p_group_go_discover(struct p2p_group *group, const u8 *dev_id,
1861 const u8 *searching_dev, int rx_freq);
1862
1863
1864/* Generic helper functions */
1865
1866/**
1867 * p2p_ie_text - Build text format description of P2P IE
1868 * @p2p_ie: P2P IE
1869 * @buf: Buffer for returning text
1870 * @end: Pointer to the end of the buf area
1871 * Returns: Number of octets written to the buffer or -1 on failure
1872 *
1873 * This function can be used to parse P2P IE contents into text format
1874 * field=value lines.
1875 */
1876int p2p_ie_text(struct wpabuf *p2p_ie, char *buf, char *end);
1877
1878/**
1879 * p2p_scan_result_text - Build text format description of P2P IE
1880 * @ies: Information elements from scan results
1881 * @ies_len: ies buffer length in octets
1882 * @buf: Buffer for returning text
1883 * @end: Pointer to the end of the buf area
1884 * Returns: Number of octets written to the buffer or -1 on failure
1885 *
1886 * This function can be used to parse P2P IE contents into text format
1887 * field=value lines.
1888 */
1889int p2p_scan_result_text(const u8 *ies, size_t ies_len, char *buf, char *end);
1890
1891/**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001892 * p2p_parse_dev_addr_in_p2p_ie - Parse P2P Device Address from a concatenated
1893 * P2P IE
1894 * @p2p_ie: P2P IE
1895 * @dev_addr: Buffer for returning P2P Device Address
1896 * Returns: 0 on success or -1 if P2P Device Address could not be parsed
1897 */
1898int p2p_parse_dev_addr_in_p2p_ie(struct wpabuf *p2p_ie, u8 *dev_addr);
1899
1900/**
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001901 * p2p_parse_dev_addr - Parse P2P Device Address from P2P IE(s)
1902 * @ies: Information elements from scan results
1903 * @ies_len: ies buffer length in octets
1904 * @dev_addr: Buffer for returning P2P Device Address
1905 * Returns: 0 on success or -1 if P2P Device Address could not be parsed
1906 */
1907int p2p_parse_dev_addr(const u8 *ies, size_t ies_len, u8 *dev_addr);
1908
1909/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001910 * p2p_assoc_req_ie - Build P2P IE for (Re)Association Request frame
1911 * @p2p: P2P module context from p2p_init()
1912 * @bssid: BSSID
1913 * @buf: Buffer for writing the P2P IE
1914 * @len: Maximum buf length in octets
1915 * @p2p_group: Whether this is for association with a P2P GO
1916 * @p2p_ie: Reassembled P2P IE data from scan results or %NULL if none
1917 * Returns: Number of octets written into buf or -1 on failure
1918 */
1919int p2p_assoc_req_ie(struct p2p_data *p2p, const u8 *bssid, u8 *buf,
1920 size_t len, int p2p_group, struct wpabuf *p2p_ie);
1921
1922/**
1923 * p2p_scan_ie - Build P2P IE for Probe Request
1924 * @p2p: P2P module context from p2p_init()
1925 * @ies: Buffer for writing P2P IE
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001926 * @dev_id: Device ID to search for or %NULL for any
Dmitry Shmidt9c175262016-03-03 10:20:07 -08001927 * @bands: Frequency bands used in the scan (enum wpa_radio_work_band bitmap)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001928 */
Dmitry Shmidt9c175262016-03-03 10:20:07 -08001929void p2p_scan_ie(struct p2p_data *p2p, struct wpabuf *ies, const u8 *dev_id,
1930 unsigned int bands);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001931
1932/**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001933 * p2p_scan_ie_buf_len - Get maximum buffer length needed for p2p_scan_ie
1934 * @p2p: P2P module context from p2p_init()
1935 * Returns: Number of octets that p2p_scan_ie() may add to the buffer
1936 */
1937size_t p2p_scan_ie_buf_len(struct p2p_data *p2p);
1938
1939/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001940 * p2p_go_params - Generate random P2P group parameters
1941 * @p2p: P2P module context from p2p_init()
1942 * @params: Buffer for parameters
1943 * Returns: 0 on success, -1 on failure
1944 */
1945int p2p_go_params(struct p2p_data *p2p, struct p2p_go_neg_results *params);
1946
1947/**
1948 * p2p_get_group_capab - Get Group Capability from P2P IE data
1949 * @p2p_ie: P2P IE(s) contents
1950 * Returns: Group Capability
1951 */
1952u8 p2p_get_group_capab(const struct wpabuf *p2p_ie);
1953
1954/**
1955 * p2p_get_cross_connect_disallowed - Does WLAN AP disallows cross connection
1956 * @p2p_ie: P2P IE(s) contents
1957 * Returns: 0 if cross connection is allow, 1 if not
1958 */
1959int p2p_get_cross_connect_disallowed(const struct wpabuf *p2p_ie);
1960
1961/**
1962 * p2p_get_go_dev_addr - Get P2P Device Address from P2P IE data
1963 * @p2p_ie: P2P IE(s) contents
1964 * Returns: Pointer to P2P Device Address or %NULL if not included
1965 */
1966const u8 * p2p_get_go_dev_addr(const struct wpabuf *p2p_ie);
1967
1968/**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001969 * p2p_get_peer_info - Get P2P peer information
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001970 * @p2p: P2P module context from p2p_init()
1971 * @addr: P2P Device Address of the peer or %NULL to indicate the first peer
1972 * @next: Whether to select the peer entry following the one indicated by addr
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001973 * Returns: Pointer to peer info or %NULL if not found
1974 */
1975const struct p2p_peer_info * p2p_get_peer_info(struct p2p_data *p2p,
1976 const u8 *addr, int next);
1977
1978/**
1979 * p2p_get_peer_info_txt - Get internal P2P peer information in text format
1980 * @info: Pointer to P2P peer info from p2p_get_peer_info()
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001981 * @buf: Buffer for returning text
1982 * @buflen: Maximum buffer length
1983 * Returns: Number of octets written to the buffer or -1 on failure
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001984 *
1985 * Note: This information is internal to the P2P module and subject to change.
1986 * As such, this should not really be used by external programs for purposes
1987 * other than debugging.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001988 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001989int p2p_get_peer_info_txt(const struct p2p_peer_info *info,
1990 char *buf, size_t buflen);
1991
1992/**
1993 * p2p_peer_known - Check whether P2P peer is known
1994 * @p2p: P2P module context from p2p_init()
1995 * @addr: P2P Device Address of the peer
1996 * Returns: 1 if the specified device is in the P2P peer table or 0 if not
1997 */
1998int p2p_peer_known(struct p2p_data *p2p, const u8 *addr);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001999
2000/**
2001 * p2p_set_client_discoverability - Set client discoverability capability
2002 * @p2p: P2P module context from p2p_init()
2003 * @enabled: Whether client discoverability will be enabled
2004 *
2005 * This function can be used to disable (and re-enable) client discoverability.
2006 * This capability is enabled by default and should not be disabled in normal
2007 * use cases, i.e., this is mainly for testing purposes.
2008 */
2009void p2p_set_client_discoverability(struct p2p_data *p2p, int enabled);
2010
2011/**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002012 * p2p_set_managed_oper - Set managed P2P Device operations capability
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002013 * @p2p: P2P module context from p2p_init()
2014 * @enabled: Whether managed P2P Device operations will be enabled
2015 */
2016void p2p_set_managed_oper(struct p2p_data *p2p, int enabled);
2017
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07002018/**
2019 * p2p_config_get_random_social - Return a random social channel
2020 * @p2p: P2P config
2021 * @op_class: Selected operating class
2022 * @op_channel: Selected social channel
Hai Shalom74f70d42019-02-11 14:42:39 -08002023 * @avoid_list: Channel ranges to try to avoid or %NULL
2024 * @disallow_list: Channel ranges to discard or %NULL
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07002025 * Returns: 0 on success, -1 on failure
2026 *
2027 * This function is used before p2p_init is called. A random social channel
2028 * from supports bands 2.4 GHz (channels 1,6,11) and 60 GHz (channel 2) is
2029 * returned on success.
2030 */
2031int p2p_config_get_random_social(struct p2p_config *p2p, u8 *op_class,
Hai Shalom74f70d42019-02-11 14:42:39 -08002032 u8 *op_channel,
2033 struct wpa_freq_range_list *avoid_list,
2034 struct wpa_freq_range_list *disallow_list);
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07002035
Dmitry Shmidt43cb5782014-06-16 16:23:22 -07002036int p2p_set_listen_channel(struct p2p_data *p2p, u8 reg_class, u8 channel,
2037 u8 forced);
2038
2039u8 p2p_get_listen_channel(struct p2p_data *p2p);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002040
2041int p2p_set_ssid_postfix(struct p2p_data *p2p, const u8 *postfix, size_t len);
2042
2043int p2p_get_interface_addr(struct p2p_data *p2p, const u8 *dev_addr,
2044 u8 *iface_addr);
2045int p2p_get_dev_addr(struct p2p_data *p2p, const u8 *iface_addr,
2046 u8 *dev_addr);
2047
2048void p2p_set_peer_filter(struct p2p_data *p2p, const u8 *addr);
2049
2050/**
2051 * p2p_set_cross_connect - Set cross connection capability
2052 * @p2p: P2P module context from p2p_init()
2053 * @enabled: Whether cross connection will be enabled
2054 */
2055void p2p_set_cross_connect(struct p2p_data *p2p, int enabled);
2056
2057int p2p_get_oper_freq(struct p2p_data *p2p, const u8 *iface_addr);
2058
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002059/**
2060 * p2p_set_intra_bss_dist - Set intra BSS distribution
2061 * @p2p: P2P module context from p2p_init()
2062 * @enabled: Whether intra BSS distribution will be enabled
2063 */
2064void p2p_set_intra_bss_dist(struct p2p_data *p2p, int enabled);
2065
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08002066int p2p_channels_includes_freq(const struct p2p_channels *channels,
2067 unsigned int freq);
2068
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002069int p2p_channels_to_freqs(const struct p2p_channels *channels,
2070 int *freq_list, unsigned int max_len);
2071
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002072/**
2073 * p2p_supported_freq - Check whether channel is supported for P2P
2074 * @p2p: P2P module context from p2p_init()
2075 * @freq: Channel frequency in MHz
2076 * Returns: 0 if channel not usable for P2P, 1 if usable for P2P
2077 */
2078int p2p_supported_freq(struct p2p_data *p2p, unsigned int freq);
2079
Dmitry Shmidt44c95782013-05-17 09:51:35 -07002080/**
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -07002081 * p2p_supported_freq_go - Check whether channel is supported for P2P GO operation
2082 * @p2p: P2P module context from p2p_init()
2083 * @freq: Channel frequency in MHz
2084 * Returns: 0 if channel not usable for P2P, 1 if usable for P2P
2085 */
2086int p2p_supported_freq_go(struct p2p_data *p2p, unsigned int freq);
2087
2088/**
2089 * p2p_supported_freq_cli - Check whether channel is supported for P2P client operation
2090 * @p2p: P2P module context from p2p_init()
2091 * @freq: Channel frequency in MHz
2092 * Returns: 0 if channel not usable for P2P, 1 if usable for P2P
2093 */
2094int p2p_supported_freq_cli(struct p2p_data *p2p, unsigned int freq);
2095
2096/**
Dmitry Shmidt44c95782013-05-17 09:51:35 -07002097 * p2p_get_pref_freq - Get channel from preferred channel list
2098 * @p2p: P2P module context from p2p_init()
2099 * @channels: List of channels
2100 * Returns: Preferred channel
2101 */
2102unsigned int p2p_get_pref_freq(struct p2p_data *p2p,
2103 const struct p2p_channels *channels);
2104
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -07002105void p2p_update_channel_list(struct p2p_data *p2p,
2106 const struct p2p_channels *chan,
2107 const struct p2p_channels *cli_chan);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002108
Hai Shalom60840252021-02-19 19:02:11 -08002109bool is_p2p_6ghz_disabled(struct p2p_data *p2p);
2110
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002111/**
2112 * p2p_set_best_channels - Update best channel information
2113 * @p2p: P2P module context from p2p_init()
2114 * @freq_24: Frequency (MHz) of best channel in 2.4 GHz band
2115 * @freq_5: Frequency (MHz) of best channel in 5 GHz band
2116 * @freq_overall: Frequency (MHz) of best channel overall
2117 */
2118void p2p_set_best_channels(struct p2p_data *p2p, int freq_24, int freq_5,
2119 int freq_overall);
2120
Dmitry Shmidt700a1372013-03-15 14:14:44 -07002121/**
2122 * p2p_set_own_freq_preference - Set own preference for channel
2123 * @p2p: P2P module context from p2p_init()
2124 * @freq: Frequency (MHz) of the preferred channel or 0 if no preference
2125 *
2126 * This function can be used to set a preference on the operating channel based
2127 * on frequencies used on the other virtual interfaces that share the same
2128 * radio. If non-zero, this is used to try to avoid multi-channel concurrency.
2129 */
2130void p2p_set_own_freq_preference(struct p2p_data *p2p, int freq);
2131
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002132const u8 * p2p_get_go_neg_peer(struct p2p_data *p2p);
2133
2134/**
2135 * p2p_get_group_num_members - Get number of members in group
2136 * @group: P2P group context from p2p_group_init()
2137 * Returns: Number of members in the group
2138 */
2139unsigned int p2p_get_group_num_members(struct p2p_group *group);
2140
2141/**
Dmitry Shmidt216983b2015-02-06 10:50:36 -08002142 * p2p_client_limit_reached - Check if client limit is reached
2143 * @group: P2P group context from p2p_group_init()
2144 * Returns: 1 if no of clients limit reached
2145 */
2146int p2p_client_limit_reached(struct p2p_group *group);
2147
2148/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002149 * p2p_iterate_group_members - Iterate group members
2150 * @group: P2P group context from p2p_group_init()
2151 * @next: iteration pointer, must be a pointer to a void * that is set to %NULL
2152 * on the first call and not modified later
Dmitry Shmidtd30ac602014-06-30 09:54:22 -07002153 * Returns: A P2P Device Address for each call and %NULL for no more members
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002154 */
2155const u8 * p2p_iterate_group_members(struct p2p_group *group, void **next);
2156
2157/**
Dmitry Shmidt849734c2016-05-27 09:59:01 -07002158 * p2p_group_get_client_interface_addr - Get P2P Interface Address of a client in a group
2159 * @group: P2P group context from p2p_group_init()
2160 * @dev_addr: P2P Device Address of the client
2161 * Returns: P2P Interface Address of the client if found or %NULL if no match
2162 * found
2163 */
2164const u8 * p2p_group_get_client_interface_addr(struct p2p_group *group,
2165 const u8 *dev_addr);
2166
2167/**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002168 * p2p_group_get_dev_addr - Get a P2P Device Address of a client in a group
2169 * @group: P2P group context from p2p_group_init()
2170 * @addr: P2P Interface Address of the client
2171 * Returns: P2P Device Address of the client if found or %NULL if no match
2172 * found
2173 */
2174const u8 * p2p_group_get_dev_addr(struct p2p_group *group, const u8 *addr);
2175
2176/**
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08002177 * p2p_group_is_client_connected - Check whether a specific client is connected
2178 * @group: P2P group context from p2p_group_init()
2179 * @addr: P2P Device Address of the client
2180 * Returns: 1 if client is connected or 0 if not
2181 */
2182int p2p_group_is_client_connected(struct p2p_group *group, const u8 *dev_addr);
2183
2184/**
Dmitry Shmidtd30ac602014-06-30 09:54:22 -07002185 * p2p_group_get_config - Get the group configuration
2186 * @group: P2P group context from p2p_group_init()
2187 * Returns: The group configuration pointer
2188 */
2189const struct p2p_group_config * p2p_group_get_config(struct p2p_group *group);
2190
2191/**
2192 * p2p_loop_on_all_groups - Run the given callback on all groups
2193 * @p2p: P2P module context from p2p_init()
2194 * @group_callback: The callback function pointer
2195 * @user_data: Some user data pointer which can be %NULL
2196 *
2197 * The group_callback function can stop the iteration by returning 0.
2198 */
2199void p2p_loop_on_all_groups(struct p2p_data *p2p,
2200 int (*group_callback)(struct p2p_group *group,
2201 void *user_data),
2202 void *user_data);
2203
2204/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002205 * p2p_get_peer_found - Get P2P peer info structure of a found peer
2206 * @p2p: P2P module context from p2p_init()
2207 * @addr: P2P Device Address of the peer or %NULL to indicate the first peer
2208 * @next: Whether to select the peer entry following the one indicated by addr
2209 * Returns: The first P2P peer info available or %NULL if no such peer exists
2210 */
2211const struct p2p_peer_info *
2212p2p_get_peer_found(struct p2p_data *p2p, const u8 *addr, int next);
2213
2214/**
2215 * p2p_remove_wps_vendor_extensions - Remove WPS vendor extensions
2216 * @p2p: P2P module context from p2p_init()
2217 */
2218void p2p_remove_wps_vendor_extensions(struct p2p_data *p2p);
2219
2220/**
2221 * p2p_add_wps_vendor_extension - Add a WPS vendor extension
2222 * @p2p: P2P module context from p2p_init()
2223 * @vendor_ext: The vendor extensions to add
2224 * Returns: 0 on success, -1 on failure
2225 *
2226 * The wpabuf structures in the array are owned by the P2P
2227 * module after this call.
2228 */
2229int p2p_add_wps_vendor_extension(struct p2p_data *p2p,
2230 const struct wpabuf *vendor_ext);
2231
Jouni Malinen75ecf522011-06-27 15:19:46 -07002232/**
2233 * p2p_set_oper_channel - Set the P2P operating channel
2234 * @p2p: P2P module context from p2p_init()
2235 * @op_reg_class: Operating regulatory class to set
2236 * @op_channel: operating channel to set
2237 * @cfg_op_channel : Whether op_channel is hardcoded in configuration
2238 * Returns: 0 on success, -1 on failure
2239 */
2240int p2p_set_oper_channel(struct p2p_data *p2p, u8 op_reg_class, u8 op_channel,
2241 int cfg_op_channel);
2242
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002243/**
Dmitry Shmidt04949592012-07-19 12:16:46 -07002244 * p2p_set_pref_chan - Set P2P preferred channel list
2245 * @p2p: P2P module context from p2p_init()
2246 * @num_pref_chan: Number of entries in pref_chan list
2247 * @pref_chan: Preferred channels or %NULL to remove preferences
2248 * Returns: 0 on success, -1 on failure
2249 */
2250int p2p_set_pref_chan(struct p2p_data *p2p, unsigned int num_pref_chan,
2251 const struct p2p_channel *pref_chan);
2252
2253/**
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -07002254 * p2p_set_no_go_freq - Set no GO channel ranges
2255 * @p2p: P2P module context from p2p_init()
2256 * @list: Channel ranges or %NULL to remove restriction
2257 * Returns: 0 on success, -1 on failure
2258 */
2259int p2p_set_no_go_freq(struct p2p_data *p2p,
2260 const struct wpa_freq_range_list *list);
2261
2262/**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002263 * p2p_in_progress - Check whether a P2P operation is progress
2264 * @p2p: P2P module context from p2p_init()
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002265 * Returns: 0 if P2P module is idle, 1 if an operation is in progress but not
2266 * in search state, or 2 if search state operation is in progress
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002267 */
2268int p2p_in_progress(struct p2p_data *p2p);
2269
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002270const char * p2p_wps_method_text(enum p2p_wps_method method);
2271
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002272/**
2273 * p2p_set_config_timeout - Set local config timeouts
2274 * @p2p: P2P module context from p2p_init()
2275 * @go_timeout: Time in 10 ms units it takes to start the GO mode
2276 * @client_timeout: Time in 10 ms units it takes to start the client mode
2277 */
2278void p2p_set_config_timeout(struct p2p_data *p2p, u8 go_timeout,
2279 u8 client_timeout);
2280
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002281int p2p_set_wfd_ie_beacon(struct p2p_data *p2p, struct wpabuf *ie);
2282int p2p_set_wfd_ie_probe_req(struct p2p_data *p2p, struct wpabuf *ie);
2283int p2p_set_wfd_ie_probe_resp(struct p2p_data *p2p, struct wpabuf *ie);
2284int p2p_set_wfd_ie_assoc_req(struct p2p_data *p2p, struct wpabuf *ie);
2285int p2p_set_wfd_ie_invitation(struct p2p_data *p2p, struct wpabuf *ie);
2286int p2p_set_wfd_ie_prov_disc_req(struct p2p_data *p2p, struct wpabuf *ie);
2287int p2p_set_wfd_ie_prov_disc_resp(struct p2p_data *p2p, struct wpabuf *ie);
2288int p2p_set_wfd_ie_go_neg(struct p2p_data *p2p, struct wpabuf *ie);
2289int p2p_set_wfd_dev_info(struct p2p_data *p2p, const struct wpabuf *elem);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002290int p2p_set_wfd_r2_dev_info(struct p2p_data *p2p, const struct wpabuf *elem);
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002291int p2p_set_wfd_assoc_bssid(struct p2p_data *p2p, const struct wpabuf *elem);
2292int p2p_set_wfd_coupled_sink_info(struct p2p_data *p2p,
2293 const struct wpabuf *elem);
2294struct wpabuf * wifi_display_encaps(struct wpabuf *subelems);
2295
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08002296/**
2297 * p2p_set_disc_int - Set min/max discoverable interval for p2p_find
2298 * @p2p: P2P module context from p2p_init()
2299 * @min_disc_int: minDiscoverableInterval (in units of 100 TU); default 1
2300 * @max_disc_int: maxDiscoverableInterval (in units of 100 TU); default 3
2301 * @max_disc_tu: Maximum number of TUs (1.024 ms) for discoverable interval; or
2302 * -1 not to limit
2303 * Returns: 0 on success, or -1 on failure
2304 *
2305 * This function can be used to configure minDiscoverableInterval and
2306 * maxDiscoverableInterval parameters for the Listen state during device
2307 * discovery (p2p_find). A random number of 100 TU units is picked for each
2308 * Listen state iteration from [min_disc_int,max_disc_int] range.
2309 *
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08002310 * max_disc_tu can be used to further limit the discoverable duration. However,
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08002311 * it should be noted that use of this parameter is not recommended since it
2312 * would not be compliant with the P2P specification.
2313 */
2314int p2p_set_disc_int(struct p2p_data *p2p, int min_disc_int, int max_disc_int,
2315 int max_disc_tu);
2316
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07002317/**
2318 * p2p_get_state_txt - Get current P2P state for debug purposes
2319 * @p2p: P2P module context from p2p_init()
2320 * Returns: Name of the current P2P module state
2321 *
2322 * It should be noted that the P2P module state names are internal information
2323 * and subject to change at any point, i.e., this information should be used
2324 * mainly for debugging purposes.
2325 */
2326const char * p2p_get_state_txt(struct p2p_data *p2p);
2327
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08002328struct wpabuf * p2p_build_nfc_handover_req(struct p2p_data *p2p,
2329 int client_freq,
2330 const u8 *go_dev_addr,
2331 const u8 *ssid, size_t ssid_len);
2332struct wpabuf * p2p_build_nfc_handover_sel(struct p2p_data *p2p,
2333 int client_freq,
2334 const u8 *go_dev_addr,
2335 const u8 *ssid, size_t ssid_len);
2336
2337struct p2p_nfc_params {
2338 int sel;
2339 const u8 *wsc_attr;
2340 size_t wsc_len;
2341 const u8 *p2p_attr;
2342 size_t p2p_len;
2343
2344 enum {
2345 NO_ACTION, JOIN_GROUP, AUTH_JOIN, INIT_GO_NEG, RESP_GO_NEG,
2346 BOTH_GO, PEER_CLIENT
2347 } next_step;
2348 struct p2p_peer_info *peer;
2349 u8 oob_dev_pw[WPS_OOB_PUBKEY_HASH_LEN + 2 +
2350 WPS_OOB_DEVICE_PASSWORD_LEN];
2351 size_t oob_dev_pw_len;
2352 int go_freq;
2353 u8 go_dev_addr[ETH_ALEN];
Dmitry Shmidt9d9e6022015-04-23 10:34:55 -07002354 u8 go_ssid[SSID_MAX_LEN];
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08002355 size_t go_ssid_len;
2356};
2357
2358int p2p_process_nfc_connection_handover(struct p2p_data *p2p,
2359 struct p2p_nfc_params *params);
2360
2361void p2p_set_authorized_oob_dev_pw_id(struct p2p_data *p2p, u16 dev_pw_id,
2362 int go_intent,
2363 const u8 *own_interface_addr);
2364
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -07002365int p2p_set_passphrase_len(struct p2p_data *p2p, unsigned int len);
2366
Dmitry Shmidtd30ac602014-06-30 09:54:22 -07002367void p2p_loop_on_known_peers(struct p2p_data *p2p,
2368 void (*peer_callback)(struct p2p_peer_info *peer,
2369 void *user_data),
2370 void *user_data);
2371
Dmitry Shmidt2e67f062014-07-16 09:55:28 -07002372void p2p_set_vendor_elems(struct p2p_data *p2p, struct wpabuf **vendor_elem);
2373
Dmitry Shmidt216983b2015-02-06 10:50:36 -08002374void p2p_set_intended_addr(struct p2p_data *p2p, const u8 *intended_addr);
2375
2376struct p2ps_advertisement *
2377p2p_service_p2ps_id(struct p2p_data *p2p, u32 adv_id);
2378int p2p_service_add_asp(struct p2p_data *p2p, int auto_accept, u32 adv_id,
2379 const char *adv_str, u8 svc_state,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002380 u16 config_methods, const char *svc_info,
2381 const u8 *cpt_priority);
Dmitry Shmidt216983b2015-02-06 10:50:36 -08002382int p2p_service_del_asp(struct p2p_data *p2p, u32 adv_id);
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07002383void p2p_service_flush_asp(struct p2p_data *p2p);
Dmitry Shmidt216983b2015-02-06 10:50:36 -08002384struct p2ps_advertisement * p2p_get_p2ps_adv_list(struct p2p_data *p2p);
2385
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002386/**
2387 * p2p_expire_peers - Periodic cleanup function to expire peers
2388 * @p2p: P2P module context from p2p_init()
2389 *
2390 * This is a cleanup function that the entity calling p2p_init() is
2391 * expected to call periodically to clean up expired peer entries.
2392 */
2393void p2p_expire_peers(struct p2p_data *p2p);
2394
2395void p2p_set_own_pref_freq_list(struct p2p_data *p2p,
2396 const unsigned int *pref_freq_list,
2397 unsigned int size);
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08002398void p2p_set_override_pref_op_chan(struct p2p_data *p2p, u8 op_class,
2399 u8 chan);
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002400
2401/**
2402 * p2p_group_get_common_freqs - Get the group common frequencies
2403 * @group: P2P group context from p2p_group_init()
2404 * @common_freqs: On return will hold the group common frequencies
2405 * @num: On return will hold the number of group common frequencies
2406 * Returns: 0 on success, -1 otherwise
2407 */
2408int p2p_group_get_common_freqs(struct p2p_group *group, int *common_freqs,
2409 unsigned int *num);
2410
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07002411struct wpabuf * p2p_build_probe_resp_template(struct p2p_data *p2p,
2412 unsigned int freq);
2413
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002414#endif /* P2P_H */