blob: fa8031d07e0e37ab5fe5f2cc047d240981125430 [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 Shmidtcf32e602014-01-28 10:57:39 -080012#include "wps/wps_defs.h"
13
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070014/**
15 * P2P_MAX_REG_CLASSES - Maximum number of regulatory classes
16 */
17#define P2P_MAX_REG_CLASSES 10
18
19/**
20 * P2P_MAX_REG_CLASS_CHANNELS - Maximum number of channels per regulatory class
21 */
22#define P2P_MAX_REG_CLASS_CHANNELS 20
23
24/**
25 * struct p2p_channels - List of supported channels
26 */
27struct p2p_channels {
28 /**
29 * struct p2p_reg_class - Supported regulatory class
30 */
31 struct p2p_reg_class {
32 /**
33 * reg_class - Regulatory class (IEEE 802.11-2007, Annex J)
34 */
35 u8 reg_class;
36
37 /**
38 * channel - Supported channels
39 */
40 u8 channel[P2P_MAX_REG_CLASS_CHANNELS];
41
42 /**
43 * channels - Number of channel entries in use
44 */
45 size_t channels;
46 } reg_class[P2P_MAX_REG_CLASSES];
47
48 /**
49 * reg_classes - Number of reg_class entries in use
50 */
51 size_t reg_classes;
52};
53
54enum p2p_wps_method {
Dmitry Shmidtcf32e602014-01-28 10:57:39 -080055 WPS_NOT_READY, WPS_PIN_DISPLAY, WPS_PIN_KEYPAD, WPS_PBC, WPS_NFC
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070056};
57
58/**
59 * struct p2p_go_neg_results - P2P Group Owner Negotiation results
60 */
61struct p2p_go_neg_results {
62 /**
63 * status - Negotiation result (Status Code)
64 *
65 * 0 (P2P_SC_SUCCESS) indicates success. Non-zero values indicate
66 * failed negotiation.
67 */
68 int status;
69
70 /**
71 * role_go - Whether local end is Group Owner
72 */
73 int role_go;
74
75 /**
76 * freq - Frequency of the group operational channel in MHz
77 */
78 int freq;
79
Dmitry Shmidt61d9df32012-08-29 16:22:06 -070080 int ht40;
81
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -070082 int vht;
83
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070084 /**
85 * ssid - SSID of the group
86 */
87 u8 ssid[32];
88
89 /**
90 * ssid_len - Length of SSID in octets
91 */
92 size_t ssid_len;
93
94 /**
Dmitry Shmidtd5e49232012-12-03 15:08:10 -080095 * psk - WPA pre-shared key (256 bits) (GO only)
96 */
97 u8 psk[32];
98
99 /**
100 * psk_set - Whether PSK field is configured (GO only)
101 */
102 int psk_set;
103
104 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700105 * passphrase - WPA2-Personal passphrase for the group (GO only)
106 */
107 char passphrase[64];
108
109 /**
110 * peer_device_addr - P2P Device Address of the peer
111 */
112 u8 peer_device_addr[ETH_ALEN];
113
114 /**
115 * peer_interface_addr - P2P Interface Address of the peer
116 */
117 u8 peer_interface_addr[ETH_ALEN];
118
119 /**
120 * wps_method - WPS method to be used during provisioning
121 */
122 enum p2p_wps_method wps_method;
123
124#define P2P_MAX_CHANNELS 50
125
126 /**
127 * freq_list - Zero-terminated list of possible operational channels
128 */
129 int freq_list[P2P_MAX_CHANNELS];
130
131 /**
132 * persistent_group - Whether the group should be made persistent
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800133 * 0 = not persistent
134 * 1 = persistent group without persistent reconnect
135 * 2 = persistent group with persistent reconnect
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700136 */
137 int persistent_group;
138
139 /**
140 * peer_config_timeout - Peer configuration timeout (in 10 msec units)
141 */
142 unsigned int peer_config_timeout;
143};
144
145struct p2p_data;
146
147enum p2p_scan_type {
148 P2P_SCAN_SOCIAL,
149 P2P_SCAN_FULL,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700150 P2P_SCAN_SOCIAL_PLUS_ONE
151};
152
153#define P2P_MAX_WPS_VENDOR_EXT 10
154
155/**
156 * struct p2p_peer_info - P2P peer information
157 */
158struct p2p_peer_info {
159 /**
160 * p2p_device_addr - P2P Device Address of the peer
161 */
162 u8 p2p_device_addr[ETH_ALEN];
163
164 /**
165 * pri_dev_type - Primary Device Type
166 */
167 u8 pri_dev_type[8];
168
169 /**
170 * device_name - Device Name (0..32 octets encoded in UTF-8)
171 */
172 char device_name[33];
173
174 /**
175 * manufacturer - Manufacturer (0..64 octets encoded in UTF-8)
176 */
177 char manufacturer[65];
178
179 /**
180 * model_name - Model Name (0..32 octets encoded in UTF-8)
181 */
182 char model_name[33];
183
184 /**
185 * model_number - Model Number (0..32 octets encoded in UTF-8)
186 */
187 char model_number[33];
188
189 /**
190 * serial_number - Serial Number (0..32 octets encoded in UTF-8)
191 */
192 char serial_number[33];
193
194 /**
Jouni Malinen75ecf522011-06-27 15:19:46 -0700195 * level - Signal level
196 */
197 int level;
198
199 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700200 * config_methods - WPS Configuration Methods
201 */
202 u16 config_methods;
203
204 /**
205 * dev_capab - Device Capabilities
206 */
207 u8 dev_capab;
208
209 /**
210 * group_capab - Group Capabilities
211 */
212 u8 group_capab;
213
214 /**
215 * wps_sec_dev_type_list - WPS secondary device type list
216 *
217 * This list includes from 0 to 16 Secondary Device Types as indicated
218 * by wps_sec_dev_type_list_len (8 * number of types).
219 */
220 u8 wps_sec_dev_type_list[128];
221
222 /**
223 * wps_sec_dev_type_list_len - Length of secondary device type list
224 */
225 size_t wps_sec_dev_type_list_len;
226
227 struct wpabuf *wps_vendor_ext[P2P_MAX_WPS_VENDOR_EXT];
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700228
229 /**
230 * wfd_subelems - Wi-Fi Display subelements from WFD IE(s)
231 */
232 struct wpabuf *wfd_subelems;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700233};
234
Jouni Malinen75ecf522011-06-27 15:19:46 -0700235enum p2p_prov_disc_status {
236 P2P_PROV_DISC_SUCCESS,
237 P2P_PROV_DISC_TIMEOUT,
238 P2P_PROV_DISC_REJECTED,
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800239 P2P_PROV_DISC_TIMEOUT_JOIN,
Jouni Malinen75ecf522011-06-27 15:19:46 -0700240};
241
Dmitry Shmidt04949592012-07-19 12:16:46 -0700242struct p2p_channel {
243 u8 op_class;
244 u8 chan;
245};
246
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700247/**
248 * struct p2p_config - P2P configuration
249 *
250 * This configuration is provided to the P2P module during initialization with
251 * p2p_init().
252 */
253struct p2p_config {
254 /**
255 * country - Country code to use in P2P operations
256 */
257 char country[3];
258
259 /**
260 * reg_class - Regulatory class for own listen channel
261 */
262 u8 reg_class;
263
264 /**
265 * channel - Own listen channel
266 */
267 u8 channel;
268
269 /**
270 * Regulatory class for own operational channel
271 */
272 u8 op_reg_class;
273
274 /**
275 * op_channel - Own operational channel
276 */
277 u8 op_channel;
278
279 /**
280 * cfg_op_channel - Whether op_channel is hardcoded in configuration
281 */
282 u8 cfg_op_channel;
283
284 /**
285 * channels - Own supported regulatory classes and channels
286 *
287 * List of supposerted channels per regulatory class. The regulatory
288 * classes are defined in IEEE Std 802.11-2007 Annex J and the
289 * numbering of the clases depends on the configured country code.
290 */
291 struct p2p_channels channels;
292
293 /**
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -0700294 * cli_channels - Additional client channels
295 *
296 * This list of channels (if any) will be used when advertising local
297 * channels during GO Negotiation or Invitation for the cases where the
298 * local end may become the client. This may allow the peer to become a
299 * GO on additional channels if it supports these options. The main use
300 * case for this is to include passive-scan channels on devices that may
301 * not know their current location and have configured most channels to
302 * not allow initiation of radition (i.e., another device needs to take
303 * master responsibilities).
304 */
305 struct p2p_channels cli_channels;
306
307 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700308 * num_pref_chan - Number of pref_chan entries
309 */
310 unsigned int num_pref_chan;
311
312 /**
313 * pref_chan - Preferred channels for GO Negotiation
314 */
315 struct p2p_channel *pref_chan;
316
317 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700318 * pri_dev_type - Primary Device Type (see WPS)
319 */
320 u8 pri_dev_type[8];
321
322 /**
323 * P2P_SEC_DEVICE_TYPES - Maximum number of secondary device types
324 */
325#define P2P_SEC_DEVICE_TYPES 5
326
327 /**
328 * sec_dev_type - Optional secondary device types
329 */
330 u8 sec_dev_type[P2P_SEC_DEVICE_TYPES][8];
331
332 /**
333 * num_sec_dev_types - Number of sec_dev_type entries
334 */
335 size_t num_sec_dev_types;
336
337 /**
338 * dev_addr - P2P Device Address
339 */
340 u8 dev_addr[ETH_ALEN];
341
342 /**
343 * dev_name - Device Name
344 */
345 char *dev_name;
346
347 char *manufacturer;
348 char *model_name;
349 char *model_number;
350 char *serial_number;
351
352 u8 uuid[16];
353 u16 config_methods;
354
355 /**
356 * concurrent_operations - Whether concurrent operations are supported
357 */
358 int concurrent_operations;
359
360 /**
361 * max_peers - Maximum number of discovered peers to remember
362 *
363 * If more peers are discovered, older entries will be removed to make
364 * room for the new ones.
365 */
366 size_t max_peers;
367
368 /**
369 * p2p_intra_bss - Intra BSS communication is supported
370 */
371 int p2p_intra_bss;
372
373 /**
374 * ssid_postfix - Postfix data to add to the SSID
375 *
376 * This data will be added to the end of the SSID after the
377 * DIRECT-<random two octets> prefix.
378 */
379 u8 ssid_postfix[32 - 9];
380
381 /**
382 * ssid_postfix_len - Length of the ssid_postfix data
383 */
384 size_t ssid_postfix_len;
385
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800386 /**
387 * max_listen - Maximum listen duration in ms
388 */
389 unsigned int max_listen;
390
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700391 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700392 * cb_ctx - Context to use with callback functions
393 */
394 void *cb_ctx;
395
Dmitry Shmidtb6e9aaf2013-05-20 14:49:44 -0700396 /**
397 * debug_print - Debug print
398 * @ctx: Callback context from cb_ctx
399 * @level: Debug verbosity level (MSG_*)
400 * @msg: Debug message
401 */
402 void (*debug_print)(void *ctx, int level, const char *msg);
403
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700404
405 /* Callbacks to request lower layer driver operations */
406
407 /**
408 * p2p_scan - Request a P2P scan/search
409 * @ctx: Callback context from cb_ctx
410 * @type: Scan type
411 * @freq: Specific frequency (MHz) to scan or 0 for no restriction
412 * @num_req_dev_types: Number of requested device types
413 * @req_dev_types: Array containing requested device types
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800414 * @dev_id: Device ID to search for or %NULL to find all devices
Dmitry Shmidt04949592012-07-19 12:16:46 -0700415 * @pw_id: Device Password ID
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700416 * Returns: 0 on success, -1 on failure
417 *
418 * This callback function is used to request a P2P scan or search
419 * operation to be completed. Type type argument specifies which type
420 * of scan is to be done. @P2P_SCAN_SOCIAL indicates that only the
421 * social channels (1, 6, 11) should be scanned. @P2P_SCAN_FULL
Dmitry Shmidt04949592012-07-19 12:16:46 -0700422 * indicates that all channels are to be scanned.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700423 * @P2P_SCAN_SOCIAL_PLUS_ONE request scan of all the social channels
424 * plus one extra channel specified by freq.
425 *
426 * The full scan is used for the initial scan to find group owners from
427 * all. The other types are used during search phase scan of the social
428 * channels (with potential variation if the Listen channel of the
429 * target peer is known or if other channels are scanned in steps).
430 *
431 * The scan results are returned after this call by calling
432 * p2p_scan_res_handler() for each scan result that has a P2P IE and
433 * then calling p2p_scan_res_handled() to indicate that all scan
434 * results have been indicated.
435 */
436 int (*p2p_scan)(void *ctx, enum p2p_scan_type type, int freq,
437 unsigned int num_req_dev_types,
Dmitry Shmidt04949592012-07-19 12:16:46 -0700438 const u8 *req_dev_types, const u8 *dev_id, u16 pw_id);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700439
440 /**
441 * send_probe_resp - Transmit a Probe Response frame
442 * @ctx: Callback context from cb_ctx
443 * @buf: Probe Response frame (including the header and body)
444 * Returns: 0 on success, -1 on failure
445 *
446 * This function is used to reply to Probe Request frames that were
447 * indicated with a call to p2p_probe_req_rx(). The response is to be
448 * sent on the same channel or to be dropped if the driver is not
449 * anymore listening to Probe Request frames.
450 *
451 * Alternatively, the responsibility for building the Probe Response
452 * frames in Listen state may be in another system component in which
453 * case this function need to be implemented (i.e., the function
454 * pointer can be %NULL). The WPS and P2P IEs to be added for Probe
455 * Response frames in such a case are available from the
456 * start_listen() callback. It should be noted that the received Probe
457 * Request frames must be indicated by calling p2p_probe_req_rx() even
458 * if this send_probe_resp() is not used.
459 */
460 int (*send_probe_resp)(void *ctx, const struct wpabuf *buf);
461
462 /**
463 * send_action - Transmit an Action frame
464 * @ctx: Callback context from cb_ctx
465 * @freq: Frequency in MHz for the channel on which to transmit
466 * @dst: Destination MAC address (Address 1)
467 * @src: Source MAC address (Address 2)
468 * @bssid: BSSID (Address 3)
469 * @buf: Frame body (starting from Category field)
470 * @len: Length of buf in octets
471 * @wait_time: How many msec to wait for a response frame
472 * Returns: 0 on success, -1 on failure
473 *
474 * The Action frame may not be transmitted immediately and the status
475 * of the transmission must be reported by calling
476 * p2p_send_action_cb() once the frame has either been transmitted or
477 * it has been dropped due to excessive retries or other failure to
478 * transmit.
479 */
480 int (*send_action)(void *ctx, unsigned int freq, const u8 *dst,
481 const u8 *src, const u8 *bssid, const u8 *buf,
482 size_t len, unsigned int wait_time);
483
484 /**
485 * send_action_done - Notify that Action frame sequence was completed
486 * @ctx: Callback context from cb_ctx
487 *
488 * This function is called when the Action frame sequence that was
489 * started with send_action() has been completed, i.e., when there is
490 * no need to wait for a response from the destination peer anymore.
491 */
492 void (*send_action_done)(void *ctx);
493
494 /**
495 * start_listen - Start Listen state
496 * @ctx: Callback context from cb_ctx
497 * @freq: Frequency of the listen channel in MHz
498 * @duration: Duration for the Listen state in milliseconds
499 * @probe_resp_ie: IE(s) to be added to Probe Response frames
500 * Returns: 0 on success, -1 on failure
501 *
502 * This Listen state may not start immediately since the driver may
503 * have other pending operations to complete first. Once the Listen
504 * state has started, p2p_listen_cb() must be called to notify the P2P
505 * module. Once the Listen state is stopped, p2p_listen_end() must be
506 * called to notify the P2P module that the driver is not in the Listen
507 * state anymore.
508 *
509 * If the send_probe_resp() is not used for generating the response,
510 * the IEs from probe_resp_ie need to be added to the end of the Probe
511 * Response frame body. If send_probe_resp() is used, the probe_resp_ie
512 * information can be ignored.
513 */
514 int (*start_listen)(void *ctx, unsigned int freq,
515 unsigned int duration,
516 const struct wpabuf *probe_resp_ie);
517 /**
518 * stop_listen - Stop Listen state
519 * @ctx: Callback context from cb_ctx
520 *
521 * This callback can be used to stop a Listen state operation that was
522 * previously requested with start_listen().
523 */
524 void (*stop_listen)(void *ctx);
525
526 /**
527 * get_noa - Get current Notice of Absence attribute payload
528 * @ctx: Callback context from cb_ctx
529 * @interface_addr: P2P Interface Address of the GO
530 * @buf: Buffer for returning NoA
531 * @buf_len: Buffer length in octets
532 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
533 * advertized, or -1 on failure
534 *
535 * This function is used to fetch the current Notice of Absence
536 * attribute value from GO.
537 */
538 int (*get_noa)(void *ctx, const u8 *interface_addr, u8 *buf,
539 size_t buf_len);
540
541 /* Callbacks to notify events to upper layer management entity */
542
543 /**
544 * dev_found - Notification of a found P2P Device
545 * @ctx: Callback context from cb_ctx
546 * @addr: Source address of the message triggering this notification
547 * @info: P2P peer information
548 * @new_device: Inform if the peer is newly found
549 *
550 * This callback is used to notify that a new P2P Device has been
551 * found. This may happen, e.g., during Search state based on scan
552 * results or during Listen state based on receive Probe Request and
553 * Group Owner Negotiation Request.
554 */
555 void (*dev_found)(void *ctx, const u8 *addr,
556 const struct p2p_peer_info *info,
557 int new_device);
558
559 /**
560 * dev_lost - Notification of a lost P2P Device
561 * @ctx: Callback context from cb_ctx
562 * @dev_addr: P2P Device Address of the lost P2P Device
563 *
564 * This callback is used to notify that a P2P Device has been deleted.
565 */
566 void (*dev_lost)(void *ctx, const u8 *dev_addr);
567
568 /**
Dmitry Shmidtb6e9aaf2013-05-20 14:49:44 -0700569 * find_stopped - Notification of a p2p_find operation stopping
570 * @ctx: Callback context from cb_ctx
571 */
572 void (*find_stopped)(void *ctx);
573
574 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700575 * go_neg_req_rx - Notification of a receive GO Negotiation Request
576 * @ctx: Callback context from cb_ctx
577 * @src: Source address of the message triggering this notification
578 * @dev_passwd_id: WPS Device Password ID
579 *
580 * This callback is used to notify that a P2P Device is requesting
581 * group owner negotiation with us, but we do not have all the
582 * necessary information to start GO Negotiation. This indicates that
583 * the local user has not authorized the connection yet by providing a
584 * PIN or PBC button press. This information can be provided with a
585 * call to p2p_connect().
586 */
587 void (*go_neg_req_rx)(void *ctx, const u8 *src, u16 dev_passwd_id);
588
589 /**
590 * go_neg_completed - Notification of GO Negotiation results
591 * @ctx: Callback context from cb_ctx
592 * @res: GO Negotiation results
593 *
594 * This callback is used to notify that Group Owner Negotiation has
595 * been completed. Non-zero struct p2p_go_neg_results::status indicates
596 * failed negotiation. In case of success, this function is responsible
597 * for creating a new group interface (or using the existing interface
598 * depending on driver features), setting up the group interface in
599 * proper mode based on struct p2p_go_neg_results::role_go and
600 * initializing WPS provisioning either as a Registrar (if GO) or as an
601 * Enrollee. Successful WPS provisioning must be indicated by calling
602 * p2p_wps_success_cb(). The callee is responsible for timing out group
603 * formation if WPS provisioning cannot be completed successfully
604 * within 15 seconds.
605 */
606 void (*go_neg_completed)(void *ctx, struct p2p_go_neg_results *res);
607
608 /**
609 * sd_request - Callback on Service Discovery Request
610 * @ctx: Callback context from cb_ctx
611 * @freq: Frequency (in MHz) of the channel
612 * @sa: Source address of the request
613 * @dialog_token: Dialog token
614 * @update_indic: Service Update Indicator from the source of request
615 * @tlvs: P2P Service Request TLV(s)
616 * @tlvs_len: Length of tlvs buffer in octets
617 *
618 * This callback is used to indicate reception of a service discovery
619 * request. Response to the query must be indicated by calling
620 * p2p_sd_response() with the context information from the arguments to
621 * this callback function.
622 *
623 * This callback handler can be set to %NULL to indicate that service
624 * discovery is not supported.
625 */
626 void (*sd_request)(void *ctx, int freq, const u8 *sa, u8 dialog_token,
627 u16 update_indic, const u8 *tlvs, size_t tlvs_len);
628
629 /**
630 * sd_response - Callback on Service Discovery Response
631 * @ctx: Callback context from cb_ctx
632 * @sa: Source address of the request
633 * @update_indic: Service Update Indicator from the source of response
634 * @tlvs: P2P Service Response TLV(s)
635 * @tlvs_len: Length of tlvs buffer in octets
636 *
637 * This callback is used to indicate reception of a service discovery
638 * response. This callback handler can be set to %NULL if no service
639 * discovery requests are used. The information provided with this call
640 * is replies to the queries scheduled with p2p_sd_request().
641 */
642 void (*sd_response)(void *ctx, const u8 *sa, u16 update_indic,
643 const u8 *tlvs, size_t tlvs_len);
644
645 /**
646 * prov_disc_req - Callback on Provisiong Discovery Request
647 * @ctx: Callback context from cb_ctx
648 * @peer: Source address of the request
649 * @config_methods: Requested WPS Config Method
650 * @dev_addr: P2P Device Address of the found P2P Device
651 * @pri_dev_type: Primary Device Type
652 * @dev_name: Device Name
653 * @supp_config_methods: Supported configuration Methods
654 * @dev_capab: Device Capabilities
655 * @group_capab: Group Capabilities
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800656 * @group_id: P2P Group ID (or %NULL if not included)
657 * @group_id_len: Length of P2P Group ID
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700658 *
659 * This callback is used to indicate reception of a Provision Discovery
660 * Request frame that the P2P module accepted.
661 */
662 void (*prov_disc_req)(void *ctx, const u8 *peer, u16 config_methods,
663 const u8 *dev_addr, const u8 *pri_dev_type,
664 const char *dev_name, u16 supp_config_methods,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800665 u8 dev_capab, u8 group_capab,
666 const u8 *group_id, size_t group_id_len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700667
668 /**
669 * prov_disc_resp - Callback on Provisiong Discovery Response
670 * @ctx: Callback context from cb_ctx
671 * @peer: Source address of the response
672 * @config_methods: Value from p2p_prov_disc_req() or 0 on failure
673 *
674 * This callback is used to indicate reception of a Provision Discovery
675 * Response frame for a pending request scheduled with
676 * p2p_prov_disc_req(). This callback handler can be set to %NULL if
677 * provision discovery is not used.
678 */
679 void (*prov_disc_resp)(void *ctx, const u8 *peer, u16 config_methods);
680
681 /**
Jouni Malinen75ecf522011-06-27 15:19:46 -0700682 * prov_disc_fail - Callback on Provision Discovery failure
683 * @ctx: Callback context from cb_ctx
684 * @peer: Source address of the response
685 * @status: Cause of failure, will not be %P2P_PROV_DISC_SUCCESS
686 *
687 * This callback is used to indicate either a failure or no response
688 * to an earlier provision discovery request.
689 *
690 * This callback handler can be set to %NULL if provision discovery
691 * is not used or failures do not need to be indicated.
692 */
693 void (*prov_disc_fail)(void *ctx, const u8 *peer,
694 enum p2p_prov_disc_status status);
695
696 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700697 * invitation_process - Optional callback for processing Invitations
698 * @ctx: Callback context from cb_ctx
699 * @sa: Source address of the Invitation Request
700 * @bssid: P2P Group BSSID from the request or %NULL if not included
701 * @go_dev_addr: GO Device Address from P2P Group ID
702 * @ssid: SSID from P2P Group ID
703 * @ssid_len: Length of ssid buffer in octets
704 * @go: Variable for returning whether the local end is GO in the group
705 * @group_bssid: Buffer for returning P2P Group BSSID (if local end GO)
706 * @force_freq: Variable for returning forced frequency for the group
707 * @persistent_group: Whether this is an invitation to reinvoke a
708 * persistent group (instead of invitation to join an active
709 * group)
Dmitry Shmidtf7e0a992013-05-23 11:03:10 -0700710 * @channels: Available operating channels for the group
Dmitry Shmidtcf32e602014-01-28 10:57:39 -0800711 * @dev_pw_id: Device Password ID for NFC static handover or -1 if not
712 * used
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700713 * Returns: Status code (P2P_SC_*)
714 *
715 * This optional callback can be used to implement persistent reconnect
716 * by allowing automatic restarting of persistent groups without user
717 * interaction. If this callback is not implemented (i.e., is %NULL),
718 * the received Invitation Request frames are replied with
719 * %P2P_SC_REQ_RECEIVED status and indicated to upper layer with the
720 * invitation_result() callback.
721 *
722 * If the requested parameters are acceptable and the group is known,
723 * %P2P_SC_SUCCESS may be returned. If the requested group is unknown,
724 * %P2P_SC_FAIL_UNKNOWN_GROUP should be returned. %P2P_SC_REQ_RECEIVED
725 * can be returned if there is not enough data to provide immediate
726 * response, i.e., if some sort of user interaction is needed. The
727 * invitation_received() callback will be called in that case
728 * immediately after this call.
729 */
730 u8 (*invitation_process)(void *ctx, const u8 *sa, const u8 *bssid,
731 const u8 *go_dev_addr, const u8 *ssid,
732 size_t ssid_len, int *go, u8 *group_bssid,
Dmitry Shmidtf7e0a992013-05-23 11:03:10 -0700733 int *force_freq, int persistent_group,
Dmitry Shmidtcf32e602014-01-28 10:57:39 -0800734 const struct p2p_channels *channels,
735 int dev_pw_id);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700736
737 /**
738 * invitation_received - Callback on Invitation Request RX
739 * @ctx: Callback context from cb_ctx
740 * @sa: Source address of the Invitation Request
741 * @bssid: P2P Group BSSID or %NULL if not received
742 * @ssid: SSID of the group
743 * @ssid_len: Length of ssid in octets
744 * @go_dev_addr: GO Device Address
745 * @status: Response Status
746 * @op_freq: Operational frequency for the group
747 *
748 * This callback is used to indicate sending of an Invitation Response
749 * for a received Invitation Request. If status == 0 (success), the
750 * upper layer code is responsible for starting the group. status == 1
751 * indicates need to get user authorization for the group. Other status
752 * values indicate that the invitation request was rejected.
753 */
754 void (*invitation_received)(void *ctx, const u8 *sa, const u8 *bssid,
755 const u8 *ssid, size_t ssid_len,
756 const u8 *go_dev_addr, u8 status,
757 int op_freq);
758
759 /**
760 * invitation_result - Callback on Invitation result
761 * @ctx: Callback context from cb_ctx
762 * @status: Negotiation result (Status Code)
763 * @bssid: P2P Group BSSID or %NULL if not received
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -0800764 * @channels: Available operating channels for the group
Dmitry Shmidt700a1372013-03-15 14:14:44 -0700765 * @addr: Peer address
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -0800766 * @freq: Frequency (in MHz) indicated during invitation or 0
Dmitry Shmidt15907092014-03-25 10:42:57 -0700767 * @peer_oper_freq: Operating frequency (in MHz) advertized by the peer
768 * during invitation or 0
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700769 *
770 * This callback is used to indicate result of an Invitation procedure
771 * started with a call to p2p_invite(). The indicated status code is
772 * the value received from the peer in Invitation Response with 0
773 * (P2P_SC_SUCCESS) indicating success or -1 to indicate a timeout or a
774 * local failure in transmitting the Invitation Request.
775 */
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -0800776 void (*invitation_result)(void *ctx, int status, const u8 *bssid,
Dmitry Shmidt700a1372013-03-15 14:14:44 -0700777 const struct p2p_channels *channels,
Dmitry Shmidt15907092014-03-25 10:42:57 -0700778 const u8 *addr, int freq, int peer_oper_freq);
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800779
780 /**
781 * go_connected - Check whether we are connected to a GO
782 * @ctx: Callback context from cb_ctx
783 * @dev_addr: P2P Device Address of a GO
784 * Returns: 1 if we are connected as a P2P client to the specified GO
785 * or 0 if not.
786 */
787 int (*go_connected)(void *ctx, const u8 *dev_addr);
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800788
789 /**
790 * presence_resp - Callback on Presence Response
791 * @ctx: Callback context from cb_ctx
792 * @src: Source address (GO's P2P Interface Address)
793 * @status: Result of the request (P2P_SC_*)
794 * @noa: Returned NoA value
795 * @noa_len: Length of the NoA buffer in octets
796 */
797 void (*presence_resp)(void *ctx, const u8 *src, u8 status,
798 const u8 *noa, size_t noa_len);
Dmitry Shmidt18463232014-01-24 12:29:41 -0800799
800 /**
801 * is_concurrent_session_active - Check whether concurrent session is
802 * active on other virtual interfaces
803 * @ctx: Callback context from cb_ctx
804 * Returns: 1 if concurrent session is active on other virtual interface
805 * or 0 if not.
806 */
807 int (*is_concurrent_session_active)(void *ctx);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -0700808
809 /**
810 * is_p2p_in_progress - Check whether P2P operation is in progress
811 * @ctx: Callback context from cb_ctx
812 * Returns: 1 if P2P operation (e.g., group formation) is in progress
813 * or 0 if not.
814 */
815 int (*is_p2p_in_progress)(void *ctx);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700816};
817
818
819/* P2P module initialization/deinitialization */
820
821/**
822 * p2p_init - Initialize P2P module
823 * @cfg: P2P module configuration
824 * Returns: Pointer to private data or %NULL on failure
825 *
826 * This function is used to initialize global P2P module context (one per
827 * device). The P2P module will keep a copy of the configuration data, so the
828 * caller does not need to maintain this structure. However, the callback
829 * functions and the context parameters to them must be kept available until
830 * the P2P module is deinitialized with p2p_deinit().
831 */
832struct p2p_data * p2p_init(const struct p2p_config *cfg);
833
834/**
835 * p2p_deinit - Deinitialize P2P module
836 * @p2p: P2P module context from p2p_init()
837 */
838void p2p_deinit(struct p2p_data *p2p);
839
840/**
841 * p2p_flush - Flush P2P module state
842 * @p2p: P2P module context from p2p_init()
843 *
844 * This command removes the P2P module state like peer device entries.
845 */
846void p2p_flush(struct p2p_data *p2p);
847
848/**
849 * p2p_unauthorize - Unauthorize the specified peer device
850 * @p2p: P2P module context from p2p_init()
851 * @addr: P2P peer entry to be unauthorized
852 * Returns: 0 on success, -1 on failure
853 *
854 * This command removes any connection authorization from the specified P2P
855 * peer device address. This can be used, e.g., to cancel effect of a previous
856 * p2p_authorize() or p2p_connect() call that has not yet resulted in completed
857 * GO Negotiation.
858 */
859int p2p_unauthorize(struct p2p_data *p2p, const u8 *addr);
860
861/**
862 * p2p_set_dev_name - Set device name
863 * @p2p: P2P module context from p2p_init()
864 * Returns: 0 on success, -1 on failure
865 *
866 * This function can be used to update the P2P module configuration with
867 * information that was not available at the time of the p2p_init() call.
868 */
869int p2p_set_dev_name(struct p2p_data *p2p, const char *dev_name);
870
871int p2p_set_manufacturer(struct p2p_data *p2p, const char *manufacturer);
872int p2p_set_model_name(struct p2p_data *p2p, const char *model_name);
873int p2p_set_model_number(struct p2p_data *p2p, const char *model_number);
874int p2p_set_serial_number(struct p2p_data *p2p, const char *serial_number);
875
876void p2p_set_config_methods(struct p2p_data *p2p, u16 config_methods);
877void p2p_set_uuid(struct p2p_data *p2p, const u8 *uuid);
878
879/**
880 * p2p_set_pri_dev_type - Set primary device type
881 * @p2p: P2P module context from p2p_init()
882 * Returns: 0 on success, -1 on failure
883 *
884 * This function can be used to update the P2P module configuration with
885 * information that was not available at the time of the p2p_init() call.
886 */
887int p2p_set_pri_dev_type(struct p2p_data *p2p, const u8 *pri_dev_type);
888
889/**
890 * p2p_set_sec_dev_types - Set secondary device types
891 * @p2p: P2P module context from p2p_init()
892 * Returns: 0 on success, -1 on failure
893 *
894 * This function can be used to update the P2P module configuration with
895 * information that was not available at the time of the p2p_init() call.
896 */
897int p2p_set_sec_dev_types(struct p2p_data *p2p, const u8 dev_types[][8],
898 size_t num_dev_types);
899
900int p2p_set_country(struct p2p_data *p2p, const char *country);
901
902
903/* Commands from upper layer management entity */
904
905enum p2p_discovery_type {
906 P2P_FIND_START_WITH_FULL,
907 P2P_FIND_ONLY_SOCIAL,
908 P2P_FIND_PROGRESSIVE
909};
910
911/**
912 * p2p_find - Start P2P Find (Device Discovery)
913 * @p2p: P2P module context from p2p_init()
914 * @timeout: Timeout for find operation in seconds or 0 for no timeout
915 * @type: Device Discovery type
916 * @num_req_dev_types: Number of requested device types
917 * @req_dev_types: Requested device types array, must be an array
918 * containing num_req_dev_types * WPS_DEV_TYPE_LEN bytes; %NULL if no
919 * requested device types.
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800920 * @dev_id: Device ID to search for or %NULL to find all devices
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700921 * @search_delay: Extra delay in milliseconds between search iterations
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700922 * Returns: 0 on success, -1 on failure
923 */
924int p2p_find(struct p2p_data *p2p, unsigned int timeout,
925 enum p2p_discovery_type type,
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800926 unsigned int num_req_dev_types, const u8 *req_dev_types,
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700927 const u8 *dev_id, unsigned int search_delay);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700928
929/**
930 * p2p_stop_find - Stop P2P Find (Device Discovery)
931 * @p2p: P2P module context from p2p_init()
932 */
933void p2p_stop_find(struct p2p_data *p2p);
934
935/**
936 * p2p_stop_find_for_freq - Stop P2P Find for next oper on specific freq
937 * @p2p: P2P module context from p2p_init()
938 * @freq: Frequency in MHz for next operation
939 *
940 * This is like p2p_stop_find(), but Listen state is not stopped if we are
941 * already on the same frequency.
942 */
943void p2p_stop_find_for_freq(struct p2p_data *p2p, int freq);
944
945/**
946 * p2p_listen - Start P2P Listen state for specified duration
947 * @p2p: P2P module context from p2p_init()
948 * @timeout: Listen state duration in milliseconds
949 * Returns: 0 on success, -1 on failure
950 *
951 * This function can be used to request the P2P module to keep the device
952 * discoverable on the listen channel for an extended set of time. At least in
953 * its current form, this is mainly used for testing purposes and may not be of
954 * much use for normal P2P operations.
955 */
956int p2p_listen(struct p2p_data *p2p, unsigned int timeout);
957
958/**
Dmitry Shmidt391c59f2013-09-03 12:16:28 -0700959 * p2p_stop_listen - Stop P2P Listen
960 * @p2p: P2P module context from p2p_init()
961 */
962void p2p_stop_listen(struct p2p_data *p2p);
963
964/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700965 * p2p_connect - Start P2P group formation (GO negotiation)
966 * @p2p: P2P module context from p2p_init()
967 * @peer_addr: MAC address of the peer P2P client
968 * @wps_method: WPS method to be used in provisioning
969 * @go_intent: Local GO intent value (1..15)
970 * @own_interface_addr: Intended interface address to use with the group
971 * @force_freq: The only allowed channel frequency in MHz or 0
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800972 * @persistent_group: Whether to create a persistent group (0 = no, 1 =
973 * persistent group without persistent reconnect, 2 = persistent group with
974 * persistent reconnect)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700975 * @force_ssid: Forced SSID for the group if we become GO or %NULL to generate
976 * a new SSID
977 * @force_ssid_len: Length of $force_ssid buffer
978 * @pd_before_go_neg: Whether to send Provision Discovery prior to GO
979 * Negotiation as an interoperability workaround when initiating group
980 * formation
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800981 * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if
982 * force_freq == 0)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700983 * Returns: 0 on success, -1 on failure
984 */
985int p2p_connect(struct p2p_data *p2p, const u8 *peer_addr,
986 enum p2p_wps_method wps_method,
987 int go_intent, const u8 *own_interface_addr,
Dmitry Shmidt04949592012-07-19 12:16:46 -0700988 unsigned int force_freq, int persistent_group,
989 const u8 *force_ssid, size_t force_ssid_len,
Dmitry Shmidtcf32e602014-01-28 10:57:39 -0800990 int pd_before_go_neg, unsigned int pref_freq, u16 oob_pw_id);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700991
992/**
993 * p2p_authorize - Authorize P2P group formation (GO negotiation)
994 * @p2p: P2P module context from p2p_init()
995 * @peer_addr: MAC address of the peer P2P client
996 * @wps_method: WPS method to be used in provisioning
997 * @go_intent: Local GO intent value (1..15)
998 * @own_interface_addr: Intended interface address to use with the group
999 * @force_freq: The only allowed channel frequency in MHz or 0
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001000 * @persistent_group: Whether to create a persistent group (0 = no, 1 =
1001 * persistent group without persistent reconnect, 2 = persistent group with
1002 * persistent reconnect)
Dmitry Shmidt04949592012-07-19 12:16:46 -07001003 * @force_ssid: Forced SSID for the group if we become GO or %NULL to generate
1004 * a new SSID
1005 * @force_ssid_len: Length of $force_ssid buffer
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001006 * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if
1007 * force_freq == 0)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001008 * Returns: 0 on success, -1 on failure
1009 *
1010 * This is like p2p_connect(), but the actual group negotiation is not
1011 * initiated automatically, i.e., the other end is expected to do that.
1012 */
1013int p2p_authorize(struct p2p_data *p2p, const u8 *peer_addr,
1014 enum p2p_wps_method wps_method,
1015 int go_intent, const u8 *own_interface_addr,
Dmitry Shmidt04949592012-07-19 12:16:46 -07001016 unsigned int force_freq, int persistent_group,
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001017 const u8 *force_ssid, size_t force_ssid_len,
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08001018 unsigned int pref_freq, u16 oob_pw_id);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001019
1020/**
1021 * p2p_reject - Reject peer device (explicitly block connection attempts)
1022 * @p2p: P2P module context from p2p_init()
1023 * @peer_addr: MAC address of the peer P2P client
1024 * Returns: 0 on success, -1 on failure
1025 */
1026int p2p_reject(struct p2p_data *p2p, const u8 *peer_addr);
1027
1028/**
1029 * p2p_prov_disc_req - Send Provision Discovery Request
1030 * @p2p: P2P module context from p2p_init()
1031 * @peer_addr: MAC address of the peer P2P client
1032 * @config_methods: WPS Config Methods value (only one bit set)
1033 * @join: Whether this is used by a client joining an active group
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001034 * @force_freq: Forced TX frequency for the frame (mainly for the join case)
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001035 * @user_initiated_pd: Flag to indicate if initiated by user or not
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001036 * Returns: 0 on success, -1 on failure
1037 *
1038 * This function can be used to request a discovered P2P peer to display a PIN
1039 * (config_methods = WPS_CONFIG_DISPLAY) or be prepared to enter a PIN from us
1040 * (config_methods = WPS_CONFIG_KEYPAD). The Provision Discovery Request frame
1041 * is transmitted once immediately and if no response is received, the frame
1042 * will be sent again whenever the target device is discovered during device
1043 * dsicovery (start with a p2p_find() call). Response from the peer is
1044 * indicated with the p2p_config::prov_disc_resp() callback.
1045 */
1046int p2p_prov_disc_req(struct p2p_data *p2p, const u8 *peer_addr,
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001047 u16 config_methods, int join, int force_freq,
1048 int user_initiated_pd);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001049
1050/**
1051 * p2p_sd_request - Schedule a service discovery query
1052 * @p2p: P2P module context from p2p_init()
1053 * @dst: Destination peer or %NULL to apply for all peers
1054 * @tlvs: P2P Service Query TLV(s)
1055 * Returns: Reference to the query or %NULL on failure
1056 *
1057 * Response to the query is indicated with the p2p_config::sd_response()
1058 * callback.
1059 */
1060void * p2p_sd_request(struct p2p_data *p2p, const u8 *dst,
1061 const struct wpabuf *tlvs);
1062
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001063#ifdef CONFIG_WIFI_DISPLAY
1064void * p2p_sd_request_wfd(struct p2p_data *p2p, const u8 *dst,
1065 const struct wpabuf *tlvs);
1066#endif /* CONFIG_WIFI_DISPLAY */
1067
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001068/**
1069 * p2p_sd_cancel_request - Cancel a pending service discovery query
1070 * @p2p: P2P module context from p2p_init()
1071 * @req: Query reference from p2p_sd_request()
1072 * Returns: 0 if request for cancelled; -1 if not found
1073 */
1074int p2p_sd_cancel_request(struct p2p_data *p2p, void *req);
1075
1076/**
1077 * p2p_sd_response - Send response to a service discovery query
1078 * @p2p: P2P module context from p2p_init()
1079 * @freq: Frequency from p2p_config::sd_request() callback
1080 * @dst: Destination address from p2p_config::sd_request() callback
1081 * @dialog_token: Dialog token from p2p_config::sd_request() callback
1082 * @resp_tlvs: P2P Service Response TLV(s)
1083 *
1084 * This function is called as a response to the request indicated with
1085 * p2p_config::sd_request() callback.
1086 */
1087void p2p_sd_response(struct p2p_data *p2p, int freq, const u8 *dst,
1088 u8 dialog_token, const struct wpabuf *resp_tlvs);
1089
1090/**
1091 * p2p_sd_service_update - Indicate a change in local services
1092 * @p2p: P2P module context from p2p_init()
1093 *
1094 * This function needs to be called whenever there is a change in availability
1095 * of the local services. This will increment the Service Update Indicator
1096 * value which will be used in SD Request and Response frames.
1097 */
1098void p2p_sd_service_update(struct p2p_data *p2p);
1099
1100
1101enum p2p_invite_role {
1102 P2P_INVITE_ROLE_GO,
1103 P2P_INVITE_ROLE_ACTIVE_GO,
1104 P2P_INVITE_ROLE_CLIENT
1105};
1106
1107/**
1108 * p2p_invite - Invite a P2P Device into a group
1109 * @p2p: P2P module context from p2p_init()
1110 * @peer: Device Address of the peer P2P Device
1111 * @role: Local role in the group
1112 * @bssid: Group BSSID or %NULL if not known
1113 * @ssid: Group SSID
1114 * @ssid_len: Length of ssid in octets
1115 * @force_freq: The only allowed channel frequency in MHz or 0
1116 * @go_dev_addr: Forced GO Device Address or %NULL if none
1117 * @persistent_group: Whether this is to reinvoke a persistent group
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08001118 * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if
1119 * force_freq == 0)
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08001120 * @dev_pw_id: Device Password ID from OOB Device Password (NFC) static handover
1121 * case or -1 if not used
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001122 * Returns: 0 on success, -1 on failure
1123 */
1124int p2p_invite(struct p2p_data *p2p, const u8 *peer, enum p2p_invite_role role,
1125 const u8 *bssid, const u8 *ssid, size_t ssid_len,
1126 unsigned int force_freq, const u8 *go_dev_addr,
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08001127 int persistent_group, unsigned int pref_freq, int dev_pw_id);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001128
1129/**
1130 * p2p_presence_req - Request GO presence
1131 * @p2p: P2P module context from p2p_init()
1132 * @go_interface_addr: GO P2P Interface Address
1133 * @own_interface_addr: Own P2P Interface Address for this group
1134 * @freq: Group operating frequence (in MHz)
1135 * @duration1: Preferred presence duration in microseconds
1136 * @interval1: Preferred presence interval in microseconds
1137 * @duration2: Acceptable presence duration in microseconds
1138 * @interval2: Acceptable presence interval in microseconds
1139 * Returns: 0 on success, -1 on failure
1140 *
1141 * If both duration and interval values are zero, the parameter pair is not
1142 * specified (i.e., to remove Presence Request, use duration1 = interval1 = 0).
1143 */
1144int p2p_presence_req(struct p2p_data *p2p, const u8 *go_interface_addr,
1145 const u8 *own_interface_addr, unsigned int freq,
1146 u32 duration1, u32 interval1, u32 duration2,
1147 u32 interval2);
1148
1149/**
1150 * p2p_ext_listen - Set Extended Listen Timing
1151 * @p2p: P2P module context from p2p_init()
1152 * @freq: Group operating frequence (in MHz)
1153 * @period: Availability period in milliseconds (1-65535; 0 to disable)
1154 * @interval: Availability interval in milliseconds (1-65535; 0 to disable)
1155 * Returns: 0 on success, -1 on failure
1156 *
1157 * This function can be used to enable or disable (period = interval = 0)
1158 * Extended Listen Timing. When enabled, the P2P Device will become
1159 * discoverable (go into Listen State) every @interval milliseconds for at
1160 * least @period milliseconds.
1161 */
1162int p2p_ext_listen(struct p2p_data *p2p, unsigned int period,
1163 unsigned int interval);
1164
1165/* Event notifications from upper layer management operations */
1166
1167/**
1168 * p2p_wps_success_cb - Report successfully completed WPS provisioning
1169 * @p2p: P2P module context from p2p_init()
1170 * @mac_addr: Peer address
1171 *
1172 * This function is used to report successfully completed WPS provisioning
1173 * during group formation in both GO/Registrar and client/Enrollee roles.
1174 */
1175void p2p_wps_success_cb(struct p2p_data *p2p, const u8 *mac_addr);
1176
1177/**
1178 * p2p_group_formation_failed - Report failed WPS provisioning
1179 * @p2p: P2P module context from p2p_init()
1180 *
1181 * This function is used to report failed group formation. This can happen
1182 * either due to failed WPS provisioning or due to 15 second timeout during
1183 * the provisioning phase.
1184 */
1185void p2p_group_formation_failed(struct p2p_data *p2p);
1186
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001187/**
1188 * p2p_get_provisioning_info - Get any stored provisioning info
1189 * @p2p: P2P module context from p2p_init()
1190 * @addr: Peer P2P Device Address
1191 * Returns: WPS provisioning information (WPS config method) or 0 if no
1192 * information is available
1193 *
1194 * This function is used to retrieve stored WPS provisioning info for the given
1195 * peer.
1196 */
1197u16 p2p_get_provisioning_info(struct p2p_data *p2p, const u8 *addr);
1198
1199/**
1200 * p2p_clear_provisioning_info - Clear any stored provisioning info
1201 * @p2p: P2P module context from p2p_init()
Dmitry Shmidt04949592012-07-19 12:16:46 -07001202 * @iface_addr: Peer P2P Device Address
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001203 *
1204 * This function is used to clear stored WPS provisioning info for the given
1205 * peer.
1206 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001207void p2p_clear_provisioning_info(struct p2p_data *p2p, const u8 *addr);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001208
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001209
1210/* Event notifications from lower layer driver operations */
1211
1212/**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001213 * enum p2p_probe_req_status
1214 *
1215 * @P2P_PREQ_MALFORMED: frame was not well-formed
1216 * @P2P_PREQ_NOT_LISTEN: device isn't in listen state, frame ignored
1217 * @P2P_PREQ_NOT_P2P: frame was not a P2P probe request
1218 * @P2P_PREQ_P2P_NOT_PROCESSED: frame was P2P but wasn't processed
1219 * @P2P_PREQ_P2P_PROCESSED: frame has been processed by P2P
1220 */
1221enum p2p_probe_req_status {
1222 P2P_PREQ_MALFORMED,
1223 P2P_PREQ_NOT_LISTEN,
1224 P2P_PREQ_NOT_P2P,
1225 P2P_PREQ_NOT_PROCESSED,
1226 P2P_PREQ_PROCESSED
1227};
1228
1229/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001230 * p2p_probe_req_rx - Report reception of a Probe Request frame
1231 * @p2p: P2P module context from p2p_init()
1232 * @addr: Source MAC address
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001233 * @dst: Destination MAC address if available or %NULL
1234 * @bssid: BSSID if available or %NULL
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001235 * @ie: Information elements from the Probe Request frame body
1236 * @ie_len: Length of ie buffer in octets
Dmitry Shmidt04949592012-07-19 12:16:46 -07001237 * Returns: value indicating the type and status of the probe request
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001238 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001239enum p2p_probe_req_status
1240p2p_probe_req_rx(struct p2p_data *p2p, const u8 *addr, const u8 *dst,
1241 const u8 *bssid, const u8 *ie, size_t ie_len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001242
1243/**
1244 * p2p_rx_action - Report received Action frame
1245 * @p2p: P2P module context from p2p_init()
1246 * @da: Destination address of the received Action frame
1247 * @sa: Source address of the received Action frame
1248 * @bssid: Address 3 of the received Action frame
1249 * @category: Category of the received Action frame
1250 * @data: Action frame body after the Category field
1251 * @len: Length of the data buffer in octets
1252 * @freq: Frequency (in MHz) on which the frame was received
1253 */
1254void p2p_rx_action(struct p2p_data *p2p, const u8 *da, const u8 *sa,
1255 const u8 *bssid, u8 category,
1256 const u8 *data, size_t len, int freq);
1257
1258/**
1259 * p2p_scan_res_handler - Indicate a P2P scan results
1260 * @p2p: P2P module context from p2p_init()
1261 * @bssid: BSSID of the scan result
1262 * @freq: Frequency of the channel on which the device was found in MHz
Dmitry Shmidtf8623282013-02-20 14:34:59 -08001263 * @rx_time: Time when the result was received
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001264 * @level: Signal level (signal strength of the received Beacon/Probe Response
1265 * frame)
1266 * @ies: Pointer to IEs from the scan result
1267 * @ies_len: Length of the ies buffer
1268 * Returns: 0 to continue or 1 to stop scan result indication
1269 *
1270 * This function is called to indicate a scan result entry with P2P IE from a
1271 * scan requested with struct p2p_config::p2p_scan(). This can be called during
1272 * the actual scan process (i.e., whenever a new device is found) or as a
1273 * sequence of calls after the full scan has been completed. The former option
1274 * can result in optimized operations, but may not be supported by all
1275 * driver/firmware designs. The ies buffer need to include at least the P2P IE,
1276 * but it is recommended to include all IEs received from the device. The
1277 * caller does not need to check that the IEs contain a P2P IE before calling
1278 * this function since frames will be filtered internally if needed.
1279 *
1280 * This function will return 1 if it wants to stop scan result iteration (and
1281 * scan in general if it is still in progress). This is used to allow faster
1282 * start of a pending operation, e.g., to start a pending GO negotiation.
1283 */
1284int p2p_scan_res_handler(struct p2p_data *p2p, const u8 *bssid, int freq,
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001285 struct os_reltime *rx_time, int level, const u8 *ies,
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001286 size_t ies_len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001287
1288/**
1289 * p2p_scan_res_handled - Indicate end of scan results
1290 * @p2p: P2P module context from p2p_init()
1291 *
1292 * This function is called to indicate that all P2P scan results from a scan
1293 * have been reported with zero or more calls to p2p_scan_res_handler(). This
1294 * function must be called as a response to successful
1295 * struct p2p_config::p2p_scan() call if none of the p2p_scan_res_handler()
1296 * calls stopped iteration.
1297 */
1298void p2p_scan_res_handled(struct p2p_data *p2p);
1299
1300enum p2p_send_action_result {
1301 P2P_SEND_ACTION_SUCCESS /* Frame was send and acknowledged */,
1302 P2P_SEND_ACTION_NO_ACK /* Frame was sent, but not acknowledged */,
1303 P2P_SEND_ACTION_FAILED /* Frame was not sent due to a failure */
1304};
1305
1306/**
1307 * p2p_send_action_cb - Notify TX status of an Action frame
1308 * @p2p: P2P module context from p2p_init()
1309 * @freq: Channel frequency in MHz
1310 * @dst: Destination MAC address (Address 1)
1311 * @src: Source MAC address (Address 2)
1312 * @bssid: BSSID (Address 3)
1313 * @result: Result of the transmission attempt
1314 *
1315 * This function is used to indicate the result of an Action frame transmission
1316 * that was requested with struct p2p_config::send_action() callback.
1317 */
1318void p2p_send_action_cb(struct p2p_data *p2p, unsigned int freq, const u8 *dst,
1319 const u8 *src, const u8 *bssid,
1320 enum p2p_send_action_result result);
1321
1322/**
1323 * p2p_listen_cb - Indicate the start of a requested Listen state
1324 * @p2p: P2P module context from p2p_init()
1325 * @freq: Listen channel frequency in MHz
1326 * @duration: Duration for the Listen state in milliseconds
1327 *
1328 * This function is used to indicate that a Listen state requested with
1329 * struct p2p_config::start_listen() callback has started.
1330 */
1331void p2p_listen_cb(struct p2p_data *p2p, unsigned int freq,
1332 unsigned int duration);
1333
1334/**
1335 * p2p_listen_end - Indicate the end of a requested Listen state
1336 * @p2p: P2P module context from p2p_init()
1337 * @freq: Listen channel frequency in MHz
1338 * Returns: 0 if no operations were started, 1 if an operation was started
1339 *
1340 * This function is used to indicate that a Listen state requested with
1341 * struct p2p_config::start_listen() callback has ended.
1342 */
1343int p2p_listen_end(struct p2p_data *p2p, unsigned int freq);
1344
1345void p2p_deauth_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code,
1346 const u8 *ie, size_t ie_len);
1347
1348void p2p_disassoc_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code,
1349 const u8 *ie, size_t ie_len);
1350
1351
1352/* Per-group P2P state for GO */
1353
1354struct p2p_group;
1355
1356/**
1357 * struct p2p_group_config - P2P group configuration
1358 *
1359 * This configuration is provided to the P2P module during initialization of
1360 * the per-group information with p2p_group_init().
1361 */
1362struct p2p_group_config {
1363 /**
1364 * persistent_group - Whether the group is persistent
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001365 * 0 = not a persistent group
1366 * 1 = persistent group without persistent reconnect
1367 * 2 = persistent group with persistent reconnect
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001368 */
1369 int persistent_group;
1370
1371 /**
1372 * interface_addr - P2P Interface Address of the group
1373 */
1374 u8 interface_addr[ETH_ALEN];
1375
1376 /**
1377 * max_clients - Maximum number of clients in the group
1378 */
1379 unsigned int max_clients;
1380
1381 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001382 * ssid - Group SSID
1383 */
1384 u8 ssid[32];
1385
1386 /**
1387 * ssid_len - Length of SSID
1388 */
1389 size_t ssid_len;
1390
1391 /**
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08001392 * freq - Operating channel of the group
1393 */
1394 int freq;
1395
1396 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001397 * cb_ctx - Context to use with callback functions
1398 */
1399 void *cb_ctx;
1400
1401 /**
1402 * ie_update - Notification of IE update
1403 * @ctx: Callback context from cb_ctx
1404 * @beacon_ies: P2P IE for Beacon frames or %NULL if no change
1405 * @proberesp_ies: P2P Ie for Probe Response frames
1406 *
1407 * P2P module uses this callback function to notify whenever the P2P IE
1408 * in Beacon or Probe Response frames should be updated based on group
1409 * events.
1410 *
1411 * The callee is responsible for freeing the returned buffer(s) with
1412 * wpabuf_free().
1413 */
1414 void (*ie_update)(void *ctx, struct wpabuf *beacon_ies,
1415 struct wpabuf *proberesp_ies);
1416
1417 /**
1418 * idle_update - Notification of changes in group idle state
1419 * @ctx: Callback context from cb_ctx
1420 * @idle: Whether the group is idle (no associated stations)
1421 */
1422 void (*idle_update)(void *ctx, int idle);
1423};
1424
1425/**
1426 * p2p_group_init - Initialize P2P group
1427 * @p2p: P2P module context from p2p_init()
1428 * @config: P2P group configuration (will be freed by p2p_group_deinit())
1429 * Returns: Pointer to private data or %NULL on failure
1430 *
1431 * This function is used to initialize per-group P2P module context. Currently,
1432 * this is only used to manage GO functionality and P2P clients do not need to
1433 * create an instance of this per-group information.
1434 */
1435struct p2p_group * p2p_group_init(struct p2p_data *p2p,
1436 struct p2p_group_config *config);
1437
1438/**
1439 * p2p_group_deinit - Deinitialize P2P group
1440 * @group: P2P group context from p2p_group_init()
1441 */
1442void p2p_group_deinit(struct p2p_group *group);
1443
1444/**
1445 * p2p_group_notif_assoc - Notification of P2P client association with GO
1446 * @group: P2P group context from p2p_group_init()
1447 * @addr: Interface address of the P2P client
1448 * @ie: IEs from the (Re)association Request frame
1449 * @len: Length of the ie buffer in octets
1450 * Returns: 0 on success, -1 on failure
1451 */
1452int p2p_group_notif_assoc(struct p2p_group *group, const u8 *addr,
1453 const u8 *ie, size_t len);
1454
1455/**
1456 * p2p_group_assoc_resp_ie - Build P2P IE for (re)association response
1457 * @group: P2P group context from p2p_group_init()
1458 * @status: Status value (P2P_SC_SUCCESS if association succeeded)
1459 * Returns: P2P IE for (Re)association Response or %NULL on failure
1460 *
1461 * The caller is responsible for freeing the returned buffer with
1462 * wpabuf_free().
1463 */
1464struct wpabuf * p2p_group_assoc_resp_ie(struct p2p_group *group, u8 status);
1465
1466/**
1467 * p2p_group_notif_disassoc - Notification of P2P client disassociation from GO
1468 * @group: P2P group context from p2p_group_init()
1469 * @addr: Interface address of the P2P client
1470 */
1471void p2p_group_notif_disassoc(struct p2p_group *group, const u8 *addr);
1472
1473/**
1474 * p2p_group_notif_formation_done - Notification of completed group formation
1475 * @group: P2P group context from p2p_group_init()
1476 */
1477void p2p_group_notif_formation_done(struct p2p_group *group);
1478
1479/**
1480 * p2p_group_notif_noa - Notification of NoA change
1481 * @group: P2P group context from p2p_group_init()
1482 * @noa: Notice of Absence attribute payload, %NULL if none
1483 * @noa_len: Length of noa buffer in octets
1484 * Returns: 0 on success, -1 on failure
1485 *
1486 * Notify the P2P group management about a new NoA contents. This will be
1487 * inserted into the P2P IEs in Beacon and Probe Response frames with rest of
1488 * the group information.
1489 */
1490int p2p_group_notif_noa(struct p2p_group *group, const u8 *noa,
1491 size_t noa_len);
1492
1493/**
1494 * p2p_group_match_dev_type - Match device types in group with requested type
1495 * @group: P2P group context from p2p_group_init()
1496 * @wps: WPS TLVs from Probe Request frame (concatenated WPS IEs)
1497 * Returns: 1 on match, 0 on mismatch
1498 *
1499 * This function can be used to match the Requested Device Type attribute in
1500 * WPS IE with the device types of a group member for deciding whether a GO
1501 * should reply to a Probe Request frame. Match will be reported if the WPS IE
1502 * is not requested any specific device type.
1503 */
1504int p2p_group_match_dev_type(struct p2p_group *group, struct wpabuf *wps);
1505
1506/**
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001507 * p2p_group_match_dev_id - Match P2P Device Address in group with requested device id
1508 */
1509int p2p_group_match_dev_id(struct p2p_group *group, struct wpabuf *p2p);
1510
1511/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001512 * p2p_group_go_discover - Send GO Discoverability Request to a group client
1513 * @group: P2P group context from p2p_group_init()
1514 * Returns: 0 on success (frame scheduled); -1 if client was not found
1515 */
1516int p2p_group_go_discover(struct p2p_group *group, const u8 *dev_id,
1517 const u8 *searching_dev, int rx_freq);
1518
1519
1520/* Generic helper functions */
1521
1522/**
1523 * p2p_ie_text - Build text format description of P2P IE
1524 * @p2p_ie: P2P IE
1525 * @buf: Buffer for returning text
1526 * @end: Pointer to the end of the buf area
1527 * Returns: Number of octets written to the buffer or -1 on failure
1528 *
1529 * This function can be used to parse P2P IE contents into text format
1530 * field=value lines.
1531 */
1532int p2p_ie_text(struct wpabuf *p2p_ie, char *buf, char *end);
1533
1534/**
1535 * p2p_scan_result_text - Build text format description of P2P IE
1536 * @ies: Information elements from scan results
1537 * @ies_len: ies buffer length in octets
1538 * @buf: Buffer for returning text
1539 * @end: Pointer to the end of the buf area
1540 * Returns: Number of octets written to the buffer or -1 on failure
1541 *
1542 * This function can be used to parse P2P IE contents into text format
1543 * field=value lines.
1544 */
1545int p2p_scan_result_text(const u8 *ies, size_t ies_len, char *buf, char *end);
1546
1547/**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001548 * p2p_parse_dev_addr_in_p2p_ie - Parse P2P Device Address from a concatenated
1549 * P2P IE
1550 * @p2p_ie: P2P IE
1551 * @dev_addr: Buffer for returning P2P Device Address
1552 * Returns: 0 on success or -1 if P2P Device Address could not be parsed
1553 */
1554int p2p_parse_dev_addr_in_p2p_ie(struct wpabuf *p2p_ie, u8 *dev_addr);
1555
1556/**
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001557 * p2p_parse_dev_addr - Parse P2P Device Address from P2P IE(s)
1558 * @ies: Information elements from scan results
1559 * @ies_len: ies buffer length in octets
1560 * @dev_addr: Buffer for returning P2P Device Address
1561 * Returns: 0 on success or -1 if P2P Device Address could not be parsed
1562 */
1563int p2p_parse_dev_addr(const u8 *ies, size_t ies_len, u8 *dev_addr);
1564
1565/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001566 * p2p_assoc_req_ie - Build P2P IE for (Re)Association Request frame
1567 * @p2p: P2P module context from p2p_init()
1568 * @bssid: BSSID
1569 * @buf: Buffer for writing the P2P IE
1570 * @len: Maximum buf length in octets
1571 * @p2p_group: Whether this is for association with a P2P GO
1572 * @p2p_ie: Reassembled P2P IE data from scan results or %NULL if none
1573 * Returns: Number of octets written into buf or -1 on failure
1574 */
1575int p2p_assoc_req_ie(struct p2p_data *p2p, const u8 *bssid, u8 *buf,
1576 size_t len, int p2p_group, struct wpabuf *p2p_ie);
1577
1578/**
1579 * p2p_scan_ie - Build P2P IE for Probe Request
1580 * @p2p: P2P module context from p2p_init()
1581 * @ies: Buffer for writing P2P IE
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001582 * @dev_id: Device ID to search for or %NULL for any
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001583 */
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001584void p2p_scan_ie(struct p2p_data *p2p, struct wpabuf *ies, const u8 *dev_id);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001585
1586/**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001587 * p2p_scan_ie_buf_len - Get maximum buffer length needed for p2p_scan_ie
1588 * @p2p: P2P module context from p2p_init()
1589 * Returns: Number of octets that p2p_scan_ie() may add to the buffer
1590 */
1591size_t p2p_scan_ie_buf_len(struct p2p_data *p2p);
1592
1593/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001594 * p2p_go_params - Generate random P2P group parameters
1595 * @p2p: P2P module context from p2p_init()
1596 * @params: Buffer for parameters
1597 * Returns: 0 on success, -1 on failure
1598 */
1599int p2p_go_params(struct p2p_data *p2p, struct p2p_go_neg_results *params);
1600
1601/**
1602 * p2p_get_group_capab - Get Group Capability from P2P IE data
1603 * @p2p_ie: P2P IE(s) contents
1604 * Returns: Group Capability
1605 */
1606u8 p2p_get_group_capab(const struct wpabuf *p2p_ie);
1607
1608/**
1609 * p2p_get_cross_connect_disallowed - Does WLAN AP disallows cross connection
1610 * @p2p_ie: P2P IE(s) contents
1611 * Returns: 0 if cross connection is allow, 1 if not
1612 */
1613int p2p_get_cross_connect_disallowed(const struct wpabuf *p2p_ie);
1614
1615/**
1616 * p2p_get_go_dev_addr - Get P2P Device Address from P2P IE data
1617 * @p2p_ie: P2P IE(s) contents
1618 * Returns: Pointer to P2P Device Address or %NULL if not included
1619 */
1620const u8 * p2p_get_go_dev_addr(const struct wpabuf *p2p_ie);
1621
1622/**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001623 * p2p_get_peer_info - Get P2P peer information
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001624 * @p2p: P2P module context from p2p_init()
1625 * @addr: P2P Device Address of the peer or %NULL to indicate the first peer
1626 * @next: Whether to select the peer entry following the one indicated by addr
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001627 * Returns: Pointer to peer info or %NULL if not found
1628 */
1629const struct p2p_peer_info * p2p_get_peer_info(struct p2p_data *p2p,
1630 const u8 *addr, int next);
1631
1632/**
1633 * p2p_get_peer_info_txt - Get internal P2P peer information in text format
1634 * @info: Pointer to P2P peer info from p2p_get_peer_info()
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001635 * @buf: Buffer for returning text
1636 * @buflen: Maximum buffer length
1637 * Returns: Number of octets written to the buffer or -1 on failure
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001638 *
1639 * Note: This information is internal to the P2P module and subject to change.
1640 * As such, this should not really be used by external programs for purposes
1641 * other than debugging.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001642 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001643int p2p_get_peer_info_txt(const struct p2p_peer_info *info,
1644 char *buf, size_t buflen);
1645
1646/**
1647 * p2p_peer_known - Check whether P2P peer is known
1648 * @p2p: P2P module context from p2p_init()
1649 * @addr: P2P Device Address of the peer
1650 * Returns: 1 if the specified device is in the P2P peer table or 0 if not
1651 */
1652int p2p_peer_known(struct p2p_data *p2p, const u8 *addr);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001653
1654/**
1655 * p2p_set_client_discoverability - Set client discoverability capability
1656 * @p2p: P2P module context from p2p_init()
1657 * @enabled: Whether client discoverability will be enabled
1658 *
1659 * This function can be used to disable (and re-enable) client discoverability.
1660 * This capability is enabled by default and should not be disabled in normal
1661 * use cases, i.e., this is mainly for testing purposes.
1662 */
1663void p2p_set_client_discoverability(struct p2p_data *p2p, int enabled);
1664
1665/**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001666 * p2p_set_managed_oper - Set managed P2P Device operations capability
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001667 * @p2p: P2P module context from p2p_init()
1668 * @enabled: Whether managed P2P Device operations will be enabled
1669 */
1670void p2p_set_managed_oper(struct p2p_data *p2p, int enabled);
1671
1672int p2p_set_listen_channel(struct p2p_data *p2p, u8 reg_class, u8 channel);
1673
1674int p2p_set_ssid_postfix(struct p2p_data *p2p, const u8 *postfix, size_t len);
1675
1676int p2p_get_interface_addr(struct p2p_data *p2p, const u8 *dev_addr,
1677 u8 *iface_addr);
1678int p2p_get_dev_addr(struct p2p_data *p2p, const u8 *iface_addr,
1679 u8 *dev_addr);
1680
1681void p2p_set_peer_filter(struct p2p_data *p2p, const u8 *addr);
1682
1683/**
1684 * p2p_set_cross_connect - Set cross connection capability
1685 * @p2p: P2P module context from p2p_init()
1686 * @enabled: Whether cross connection will be enabled
1687 */
1688void p2p_set_cross_connect(struct p2p_data *p2p, int enabled);
1689
1690int p2p_get_oper_freq(struct p2p_data *p2p, const u8 *iface_addr);
1691
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001692/**
1693 * p2p_set_intra_bss_dist - Set intra BSS distribution
1694 * @p2p: P2P module context from p2p_init()
1695 * @enabled: Whether intra BSS distribution will be enabled
1696 */
1697void p2p_set_intra_bss_dist(struct p2p_data *p2p, int enabled);
1698
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08001699int p2p_channels_includes_freq(const struct p2p_channels *channels,
1700 unsigned int freq);
1701
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001702/**
1703 * p2p_supported_freq - Check whether channel is supported for P2P
1704 * @p2p: P2P module context from p2p_init()
1705 * @freq: Channel frequency in MHz
1706 * Returns: 0 if channel not usable for P2P, 1 if usable for P2P
1707 */
1708int p2p_supported_freq(struct p2p_data *p2p, unsigned int freq);
1709
Dmitry Shmidt44c95782013-05-17 09:51:35 -07001710/**
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -07001711 * p2p_supported_freq_go - Check whether channel is supported for P2P GO operation
1712 * @p2p: P2P module context from p2p_init()
1713 * @freq: Channel frequency in MHz
1714 * Returns: 0 if channel not usable for P2P, 1 if usable for P2P
1715 */
1716int p2p_supported_freq_go(struct p2p_data *p2p, unsigned int freq);
1717
1718/**
1719 * p2p_supported_freq_cli - Check whether channel is supported for P2P client operation
1720 * @p2p: P2P module context from p2p_init()
1721 * @freq: Channel frequency in MHz
1722 * Returns: 0 if channel not usable for P2P, 1 if usable for P2P
1723 */
1724int p2p_supported_freq_cli(struct p2p_data *p2p, unsigned int freq);
1725
1726/**
Dmitry Shmidt44c95782013-05-17 09:51:35 -07001727 * p2p_get_pref_freq - Get channel from preferred channel list
1728 * @p2p: P2P module context from p2p_init()
1729 * @channels: List of channels
1730 * Returns: Preferred channel
1731 */
1732unsigned int p2p_get_pref_freq(struct p2p_data *p2p,
1733 const struct p2p_channels *channels);
1734
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -07001735void p2p_update_channel_list(struct p2p_data *p2p,
1736 const struct p2p_channels *chan,
1737 const struct p2p_channels *cli_chan);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001738
1739/**
1740 * p2p_set_best_channels - Update best channel information
1741 * @p2p: P2P module context from p2p_init()
1742 * @freq_24: Frequency (MHz) of best channel in 2.4 GHz band
1743 * @freq_5: Frequency (MHz) of best channel in 5 GHz band
1744 * @freq_overall: Frequency (MHz) of best channel overall
1745 */
1746void p2p_set_best_channels(struct p2p_data *p2p, int freq_24, int freq_5,
1747 int freq_overall);
1748
Dmitry Shmidt700a1372013-03-15 14:14:44 -07001749/**
1750 * p2p_set_own_freq_preference - Set own preference for channel
1751 * @p2p: P2P module context from p2p_init()
1752 * @freq: Frequency (MHz) of the preferred channel or 0 if no preference
1753 *
1754 * This function can be used to set a preference on the operating channel based
1755 * on frequencies used on the other virtual interfaces that share the same
1756 * radio. If non-zero, this is used to try to avoid multi-channel concurrency.
1757 */
1758void p2p_set_own_freq_preference(struct p2p_data *p2p, int freq);
1759
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001760const u8 * p2p_get_go_neg_peer(struct p2p_data *p2p);
1761
1762/**
1763 * p2p_get_group_num_members - Get number of members in group
1764 * @group: P2P group context from p2p_group_init()
1765 * Returns: Number of members in the group
1766 */
1767unsigned int p2p_get_group_num_members(struct p2p_group *group);
1768
1769/**
1770 * p2p_iterate_group_members - Iterate group members
1771 * @group: P2P group context from p2p_group_init()
1772 * @next: iteration pointer, must be a pointer to a void * that is set to %NULL
1773 * on the first call and not modified later
1774 * Returns: A P2P Interface Address for each call and %NULL for no more members
1775 */
1776const u8 * p2p_iterate_group_members(struct p2p_group *group, void **next);
1777
1778/**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001779 * p2p_group_get_dev_addr - Get a P2P Device Address of a client in a group
1780 * @group: P2P group context from p2p_group_init()
1781 * @addr: P2P Interface Address of the client
1782 * Returns: P2P Device Address of the client if found or %NULL if no match
1783 * found
1784 */
1785const u8 * p2p_group_get_dev_addr(struct p2p_group *group, const u8 *addr);
1786
1787/**
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001788 * p2p_group_is_client_connected - Check whether a specific client is connected
1789 * @group: P2P group context from p2p_group_init()
1790 * @addr: P2P Device Address of the client
1791 * Returns: 1 if client is connected or 0 if not
1792 */
1793int p2p_group_is_client_connected(struct p2p_group *group, const u8 *dev_addr);
1794
1795/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001796 * p2p_get_peer_found - Get P2P peer info structure of a found peer
1797 * @p2p: P2P module context from p2p_init()
1798 * @addr: P2P Device Address of the peer or %NULL to indicate the first peer
1799 * @next: Whether to select the peer entry following the one indicated by addr
1800 * Returns: The first P2P peer info available or %NULL if no such peer exists
1801 */
1802const struct p2p_peer_info *
1803p2p_get_peer_found(struct p2p_data *p2p, const u8 *addr, int next);
1804
1805/**
1806 * p2p_remove_wps_vendor_extensions - Remove WPS vendor extensions
1807 * @p2p: P2P module context from p2p_init()
1808 */
1809void p2p_remove_wps_vendor_extensions(struct p2p_data *p2p);
1810
1811/**
1812 * p2p_add_wps_vendor_extension - Add a WPS vendor extension
1813 * @p2p: P2P module context from p2p_init()
1814 * @vendor_ext: The vendor extensions to add
1815 * Returns: 0 on success, -1 on failure
1816 *
1817 * The wpabuf structures in the array are owned by the P2P
1818 * module after this call.
1819 */
1820int p2p_add_wps_vendor_extension(struct p2p_data *p2p,
1821 const struct wpabuf *vendor_ext);
1822
Jouni Malinen75ecf522011-06-27 15:19:46 -07001823/**
1824 * p2p_set_oper_channel - Set the P2P operating channel
1825 * @p2p: P2P module context from p2p_init()
1826 * @op_reg_class: Operating regulatory class to set
1827 * @op_channel: operating channel to set
1828 * @cfg_op_channel : Whether op_channel is hardcoded in configuration
1829 * Returns: 0 on success, -1 on failure
1830 */
1831int p2p_set_oper_channel(struct p2p_data *p2p, u8 op_reg_class, u8 op_channel,
1832 int cfg_op_channel);
1833
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001834/**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001835 * p2p_set_pref_chan - Set P2P preferred channel list
1836 * @p2p: P2P module context from p2p_init()
1837 * @num_pref_chan: Number of entries in pref_chan list
1838 * @pref_chan: Preferred channels or %NULL to remove preferences
1839 * Returns: 0 on success, -1 on failure
1840 */
1841int p2p_set_pref_chan(struct p2p_data *p2p, unsigned int num_pref_chan,
1842 const struct p2p_channel *pref_chan);
1843
1844/**
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -07001845 * p2p_set_no_go_freq - Set no GO channel ranges
1846 * @p2p: P2P module context from p2p_init()
1847 * @list: Channel ranges or %NULL to remove restriction
1848 * Returns: 0 on success, -1 on failure
1849 */
1850int p2p_set_no_go_freq(struct p2p_data *p2p,
1851 const struct wpa_freq_range_list *list);
1852
1853/**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001854 * p2p_in_progress - Check whether a P2P operation is progress
1855 * @p2p: P2P module context from p2p_init()
1856 * Returns: 0 if P2P module is idle or 1 if an operation is in progress
1857 */
1858int p2p_in_progress(struct p2p_data *p2p);
1859
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001860const char * p2p_wps_method_text(enum p2p_wps_method method);
1861
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001862/**
1863 * p2p_set_config_timeout - Set local config timeouts
1864 * @p2p: P2P module context from p2p_init()
1865 * @go_timeout: Time in 10 ms units it takes to start the GO mode
1866 * @client_timeout: Time in 10 ms units it takes to start the client mode
1867 */
1868void p2p_set_config_timeout(struct p2p_data *p2p, u8 go_timeout,
1869 u8 client_timeout);
1870
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001871int p2p_set_wfd_ie_beacon(struct p2p_data *p2p, struct wpabuf *ie);
1872int p2p_set_wfd_ie_probe_req(struct p2p_data *p2p, struct wpabuf *ie);
1873int p2p_set_wfd_ie_probe_resp(struct p2p_data *p2p, struct wpabuf *ie);
1874int p2p_set_wfd_ie_assoc_req(struct p2p_data *p2p, struct wpabuf *ie);
1875int p2p_set_wfd_ie_invitation(struct p2p_data *p2p, struct wpabuf *ie);
1876int p2p_set_wfd_ie_prov_disc_req(struct p2p_data *p2p, struct wpabuf *ie);
1877int p2p_set_wfd_ie_prov_disc_resp(struct p2p_data *p2p, struct wpabuf *ie);
1878int p2p_set_wfd_ie_go_neg(struct p2p_data *p2p, struct wpabuf *ie);
1879int p2p_set_wfd_dev_info(struct p2p_data *p2p, const struct wpabuf *elem);
1880int p2p_set_wfd_assoc_bssid(struct p2p_data *p2p, const struct wpabuf *elem);
1881int p2p_set_wfd_coupled_sink_info(struct p2p_data *p2p,
1882 const struct wpabuf *elem);
1883struct wpabuf * wifi_display_encaps(struct wpabuf *subelems);
1884
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001885/**
1886 * p2p_set_disc_int - Set min/max discoverable interval for p2p_find
1887 * @p2p: P2P module context from p2p_init()
1888 * @min_disc_int: minDiscoverableInterval (in units of 100 TU); default 1
1889 * @max_disc_int: maxDiscoverableInterval (in units of 100 TU); default 3
1890 * @max_disc_tu: Maximum number of TUs (1.024 ms) for discoverable interval; or
1891 * -1 not to limit
1892 * Returns: 0 on success, or -1 on failure
1893 *
1894 * This function can be used to configure minDiscoverableInterval and
1895 * maxDiscoverableInterval parameters for the Listen state during device
1896 * discovery (p2p_find). A random number of 100 TU units is picked for each
1897 * Listen state iteration from [min_disc_int,max_disc_int] range.
1898 *
1899 * max_disc_tu can be used to futher limit the discoverable duration. However,
1900 * it should be noted that use of this parameter is not recommended since it
1901 * would not be compliant with the P2P specification.
1902 */
1903int p2p_set_disc_int(struct p2p_data *p2p, int min_disc_int, int max_disc_int,
1904 int max_disc_tu);
1905
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07001906/**
1907 * p2p_get_state_txt - Get current P2P state for debug purposes
1908 * @p2p: P2P module context from p2p_init()
1909 * Returns: Name of the current P2P module state
1910 *
1911 * It should be noted that the P2P module state names are internal information
1912 * and subject to change at any point, i.e., this information should be used
1913 * mainly for debugging purposes.
1914 */
1915const char * p2p_get_state_txt(struct p2p_data *p2p);
1916
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08001917struct wpabuf * p2p_build_nfc_handover_req(struct p2p_data *p2p,
1918 int client_freq,
1919 const u8 *go_dev_addr,
1920 const u8 *ssid, size_t ssid_len);
1921struct wpabuf * p2p_build_nfc_handover_sel(struct p2p_data *p2p,
1922 int client_freq,
1923 const u8 *go_dev_addr,
1924 const u8 *ssid, size_t ssid_len);
1925
1926struct p2p_nfc_params {
1927 int sel;
1928 const u8 *wsc_attr;
1929 size_t wsc_len;
1930 const u8 *p2p_attr;
1931 size_t p2p_len;
1932
1933 enum {
1934 NO_ACTION, JOIN_GROUP, AUTH_JOIN, INIT_GO_NEG, RESP_GO_NEG,
1935 BOTH_GO, PEER_CLIENT
1936 } next_step;
1937 struct p2p_peer_info *peer;
1938 u8 oob_dev_pw[WPS_OOB_PUBKEY_HASH_LEN + 2 +
1939 WPS_OOB_DEVICE_PASSWORD_LEN];
1940 size_t oob_dev_pw_len;
1941 int go_freq;
1942 u8 go_dev_addr[ETH_ALEN];
1943 u8 go_ssid[32];
1944 size_t go_ssid_len;
1945};
1946
1947int p2p_process_nfc_connection_handover(struct p2p_data *p2p,
1948 struct p2p_nfc_params *params);
1949
1950void p2p_set_authorized_oob_dev_pw_id(struct p2p_data *p2p, u16 dev_pw_id,
1951 int go_intent,
1952 const u8 *own_interface_addr);
1953
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001954#endif /* P2P_H */