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