blob: 16500a80796fa534a7d5fe7beec854231d0ab6d2 [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 /**
Dmitry Shmidt43cb5782014-06-16 16:23:22 -0700270 * channel_forced - the listen channel was forced by configuration
271 * or by control interface and cannot be overridden
272 */
273 u8 channel_forced;
274
275 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700276 * Regulatory class for own operational channel
277 */
278 u8 op_reg_class;
279
280 /**
281 * op_channel - Own operational channel
282 */
283 u8 op_channel;
284
285 /**
286 * cfg_op_channel - Whether op_channel is hardcoded in configuration
287 */
288 u8 cfg_op_channel;
289
290 /**
291 * channels - Own supported regulatory classes and channels
292 *
293 * List of supposerted channels per regulatory class. The regulatory
294 * classes are defined in IEEE Std 802.11-2007 Annex J and the
295 * numbering of the clases depends on the configured country code.
296 */
297 struct p2p_channels channels;
298
299 /**
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -0700300 * cli_channels - Additional client channels
301 *
302 * This list of channels (if any) will be used when advertising local
303 * channels during GO Negotiation or Invitation for the cases where the
304 * local end may become the client. This may allow the peer to become a
305 * GO on additional channels if it supports these options. The main use
306 * case for this is to include passive-scan channels on devices that may
307 * not know their current location and have configured most channels to
308 * not allow initiation of radition (i.e., another device needs to take
309 * master responsibilities).
310 */
311 struct p2p_channels cli_channels;
312
313 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700314 * num_pref_chan - Number of pref_chan entries
315 */
316 unsigned int num_pref_chan;
317
318 /**
319 * pref_chan - Preferred channels for GO Negotiation
320 */
321 struct p2p_channel *pref_chan;
322
323 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700324 * pri_dev_type - Primary Device Type (see WPS)
325 */
326 u8 pri_dev_type[8];
327
328 /**
329 * P2P_SEC_DEVICE_TYPES - Maximum number of secondary device types
330 */
331#define P2P_SEC_DEVICE_TYPES 5
332
333 /**
334 * sec_dev_type - Optional secondary device types
335 */
336 u8 sec_dev_type[P2P_SEC_DEVICE_TYPES][8];
337
338 /**
339 * num_sec_dev_types - Number of sec_dev_type entries
340 */
341 size_t num_sec_dev_types;
342
343 /**
344 * dev_addr - P2P Device Address
345 */
346 u8 dev_addr[ETH_ALEN];
347
348 /**
349 * dev_name - Device Name
350 */
351 char *dev_name;
352
353 char *manufacturer;
354 char *model_name;
355 char *model_number;
356 char *serial_number;
357
358 u8 uuid[16];
359 u16 config_methods;
360
361 /**
362 * concurrent_operations - Whether concurrent operations are supported
363 */
364 int concurrent_operations;
365
366 /**
367 * max_peers - Maximum number of discovered peers to remember
368 *
369 * If more peers are discovered, older entries will be removed to make
370 * room for the new ones.
371 */
372 size_t max_peers;
373
374 /**
375 * p2p_intra_bss - Intra BSS communication is supported
376 */
377 int p2p_intra_bss;
378
379 /**
380 * ssid_postfix - Postfix data to add to the SSID
381 *
382 * This data will be added to the end of the SSID after the
383 * DIRECT-<random two octets> prefix.
384 */
385 u8 ssid_postfix[32 - 9];
386
387 /**
388 * ssid_postfix_len - Length of the ssid_postfix data
389 */
390 size_t ssid_postfix_len;
391
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800392 /**
393 * max_listen - Maximum listen duration in ms
394 */
395 unsigned int max_listen;
396
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700397 /**
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700398 * passphrase_len - Passphrase length (8..63)
399 *
400 * This parameter controls the length of the random passphrase that is
401 * generated at the GO.
402 */
403 unsigned int passphrase_len;
404
405 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700406 * cb_ctx - Context to use with callback functions
407 */
408 void *cb_ctx;
409
Dmitry Shmidtb6e9aaf2013-05-20 14:49:44 -0700410 /**
411 * debug_print - Debug print
412 * @ctx: Callback context from cb_ctx
413 * @level: Debug verbosity level (MSG_*)
414 * @msg: Debug message
415 */
416 void (*debug_print)(void *ctx, int level, const char *msg);
417
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700418
419 /* Callbacks to request lower layer driver operations */
420
421 /**
422 * p2p_scan - Request a P2P scan/search
423 * @ctx: Callback context from cb_ctx
424 * @type: Scan type
425 * @freq: Specific frequency (MHz) to scan or 0 for no restriction
426 * @num_req_dev_types: Number of requested device types
427 * @req_dev_types: Array containing requested device types
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800428 * @dev_id: Device ID to search for or %NULL to find all devices
Dmitry Shmidt04949592012-07-19 12:16:46 -0700429 * @pw_id: Device Password ID
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700430 * Returns: 0 on success, -1 on failure
431 *
432 * This callback function is used to request a P2P scan or search
433 * operation to be completed. Type type argument specifies which type
434 * of scan is to be done. @P2P_SCAN_SOCIAL indicates that only the
435 * social channels (1, 6, 11) should be scanned. @P2P_SCAN_FULL
Dmitry Shmidt04949592012-07-19 12:16:46 -0700436 * indicates that all channels are to be scanned.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700437 * @P2P_SCAN_SOCIAL_PLUS_ONE request scan of all the social channels
438 * plus one extra channel specified by freq.
439 *
440 * The full scan is used for the initial scan to find group owners from
441 * all. The other types are used during search phase scan of the social
442 * channels (with potential variation if the Listen channel of the
443 * target peer is known or if other channels are scanned in steps).
444 *
445 * The scan results are returned after this call by calling
446 * p2p_scan_res_handler() for each scan result that has a P2P IE and
447 * then calling p2p_scan_res_handled() to indicate that all scan
448 * results have been indicated.
449 */
450 int (*p2p_scan)(void *ctx, enum p2p_scan_type type, int freq,
451 unsigned int num_req_dev_types,
Dmitry Shmidt04949592012-07-19 12:16:46 -0700452 const u8 *req_dev_types, const u8 *dev_id, u16 pw_id);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700453
454 /**
455 * send_probe_resp - Transmit a Probe Response frame
456 * @ctx: Callback context from cb_ctx
457 * @buf: Probe Response frame (including the header and body)
458 * Returns: 0 on success, -1 on failure
459 *
460 * This function is used to reply to Probe Request frames that were
461 * indicated with a call to p2p_probe_req_rx(). The response is to be
462 * sent on the same channel or to be dropped if the driver is not
463 * anymore listening to Probe Request frames.
464 *
465 * Alternatively, the responsibility for building the Probe Response
466 * frames in Listen state may be in another system component in which
467 * case this function need to be implemented (i.e., the function
468 * pointer can be %NULL). The WPS and P2P IEs to be added for Probe
469 * Response frames in such a case are available from the
470 * start_listen() callback. It should be noted that the received Probe
471 * Request frames must be indicated by calling p2p_probe_req_rx() even
472 * if this send_probe_resp() is not used.
473 */
474 int (*send_probe_resp)(void *ctx, const struct wpabuf *buf);
475
476 /**
477 * send_action - Transmit an Action frame
478 * @ctx: Callback context from cb_ctx
479 * @freq: Frequency in MHz for the channel on which to transmit
480 * @dst: Destination MAC address (Address 1)
481 * @src: Source MAC address (Address 2)
482 * @bssid: BSSID (Address 3)
483 * @buf: Frame body (starting from Category field)
484 * @len: Length of buf in octets
485 * @wait_time: How many msec to wait for a response frame
486 * Returns: 0 on success, -1 on failure
487 *
488 * The Action frame may not be transmitted immediately and the status
489 * of the transmission must be reported by calling
490 * p2p_send_action_cb() once the frame has either been transmitted or
491 * it has been dropped due to excessive retries or other failure to
492 * transmit.
493 */
494 int (*send_action)(void *ctx, unsigned int freq, const u8 *dst,
495 const u8 *src, const u8 *bssid, const u8 *buf,
496 size_t len, unsigned int wait_time);
497
498 /**
499 * send_action_done - Notify that Action frame sequence was completed
500 * @ctx: Callback context from cb_ctx
501 *
502 * This function is called when the Action frame sequence that was
503 * started with send_action() has been completed, i.e., when there is
504 * no need to wait for a response from the destination peer anymore.
505 */
506 void (*send_action_done)(void *ctx);
507
508 /**
509 * start_listen - Start Listen state
510 * @ctx: Callback context from cb_ctx
511 * @freq: Frequency of the listen channel in MHz
512 * @duration: Duration for the Listen state in milliseconds
513 * @probe_resp_ie: IE(s) to be added to Probe Response frames
514 * Returns: 0 on success, -1 on failure
515 *
516 * This Listen state may not start immediately since the driver may
517 * have other pending operations to complete first. Once the Listen
518 * state has started, p2p_listen_cb() must be called to notify the P2P
519 * module. Once the Listen state is stopped, p2p_listen_end() must be
520 * called to notify the P2P module that the driver is not in the Listen
521 * state anymore.
522 *
523 * If the send_probe_resp() is not used for generating the response,
524 * the IEs from probe_resp_ie need to be added to the end of the Probe
525 * Response frame body. If send_probe_resp() is used, the probe_resp_ie
526 * information can be ignored.
527 */
528 int (*start_listen)(void *ctx, unsigned int freq,
529 unsigned int duration,
530 const struct wpabuf *probe_resp_ie);
531 /**
532 * stop_listen - Stop Listen state
533 * @ctx: Callback context from cb_ctx
534 *
535 * This callback can be used to stop a Listen state operation that was
536 * previously requested with start_listen().
537 */
538 void (*stop_listen)(void *ctx);
539
540 /**
541 * get_noa - Get current Notice of Absence attribute payload
542 * @ctx: Callback context from cb_ctx
543 * @interface_addr: P2P Interface Address of the GO
544 * @buf: Buffer for returning NoA
545 * @buf_len: Buffer length in octets
546 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
547 * advertized, or -1 on failure
548 *
549 * This function is used to fetch the current Notice of Absence
550 * attribute value from GO.
551 */
552 int (*get_noa)(void *ctx, const u8 *interface_addr, u8 *buf,
553 size_t buf_len);
554
555 /* Callbacks to notify events to upper layer management entity */
556
557 /**
558 * dev_found - Notification of a found P2P Device
559 * @ctx: Callback context from cb_ctx
560 * @addr: Source address of the message triggering this notification
561 * @info: P2P peer information
562 * @new_device: Inform if the peer is newly found
563 *
564 * This callback is used to notify that a new P2P Device has been
565 * found. This may happen, e.g., during Search state based on scan
566 * results or during Listen state based on receive Probe Request and
567 * Group Owner Negotiation Request.
568 */
569 void (*dev_found)(void *ctx, const u8 *addr,
570 const struct p2p_peer_info *info,
571 int new_device);
572
573 /**
574 * dev_lost - Notification of a lost P2P Device
575 * @ctx: Callback context from cb_ctx
576 * @dev_addr: P2P Device Address of the lost P2P Device
577 *
578 * This callback is used to notify that a P2P Device has been deleted.
579 */
580 void (*dev_lost)(void *ctx, const u8 *dev_addr);
581
582 /**
Dmitry Shmidtb6e9aaf2013-05-20 14:49:44 -0700583 * find_stopped - Notification of a p2p_find operation stopping
584 * @ctx: Callback context from cb_ctx
585 */
586 void (*find_stopped)(void *ctx);
587
588 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700589 * go_neg_req_rx - Notification of a receive GO Negotiation Request
590 * @ctx: Callback context from cb_ctx
591 * @src: Source address of the message triggering this notification
592 * @dev_passwd_id: WPS Device Password ID
593 *
594 * This callback is used to notify that a P2P Device is requesting
595 * group owner negotiation with us, but we do not have all the
596 * necessary information to start GO Negotiation. This indicates that
597 * the local user has not authorized the connection yet by providing a
598 * PIN or PBC button press. This information can be provided with a
599 * call to p2p_connect().
600 */
601 void (*go_neg_req_rx)(void *ctx, const u8 *src, u16 dev_passwd_id);
602
603 /**
604 * go_neg_completed - Notification of GO Negotiation results
605 * @ctx: Callback context from cb_ctx
606 * @res: GO Negotiation results
607 *
608 * This callback is used to notify that Group Owner Negotiation has
609 * been completed. Non-zero struct p2p_go_neg_results::status indicates
610 * failed negotiation. In case of success, this function is responsible
611 * for creating a new group interface (or using the existing interface
612 * depending on driver features), setting up the group interface in
613 * proper mode based on struct p2p_go_neg_results::role_go and
614 * initializing WPS provisioning either as a Registrar (if GO) or as an
615 * Enrollee. Successful WPS provisioning must be indicated by calling
616 * p2p_wps_success_cb(). The callee is responsible for timing out group
617 * formation if WPS provisioning cannot be completed successfully
618 * within 15 seconds.
619 */
620 void (*go_neg_completed)(void *ctx, struct p2p_go_neg_results *res);
621
622 /**
623 * sd_request - Callback on Service Discovery Request
624 * @ctx: Callback context from cb_ctx
625 * @freq: Frequency (in MHz) of the channel
626 * @sa: Source address of the request
627 * @dialog_token: Dialog token
628 * @update_indic: Service Update Indicator from the source of request
629 * @tlvs: P2P Service Request TLV(s)
630 * @tlvs_len: Length of tlvs buffer in octets
631 *
632 * This callback is used to indicate reception of a service discovery
633 * request. Response to the query must be indicated by calling
634 * p2p_sd_response() with the context information from the arguments to
635 * this callback function.
636 *
637 * This callback handler can be set to %NULL to indicate that service
638 * discovery is not supported.
639 */
640 void (*sd_request)(void *ctx, int freq, const u8 *sa, u8 dialog_token,
641 u16 update_indic, const u8 *tlvs, size_t tlvs_len);
642
643 /**
644 * sd_response - Callback on Service Discovery Response
645 * @ctx: Callback context from cb_ctx
646 * @sa: Source address of the request
647 * @update_indic: Service Update Indicator from the source of response
648 * @tlvs: P2P Service Response TLV(s)
649 * @tlvs_len: Length of tlvs buffer in octets
650 *
651 * This callback is used to indicate reception of a service discovery
652 * response. This callback handler can be set to %NULL if no service
653 * discovery requests are used. The information provided with this call
654 * is replies to the queries scheduled with p2p_sd_request().
655 */
656 void (*sd_response)(void *ctx, const u8 *sa, u16 update_indic,
657 const u8 *tlvs, size_t tlvs_len);
658
659 /**
660 * prov_disc_req - Callback on Provisiong Discovery Request
661 * @ctx: Callback context from cb_ctx
662 * @peer: Source address of the request
663 * @config_methods: Requested WPS Config Method
664 * @dev_addr: P2P Device Address of the found P2P Device
665 * @pri_dev_type: Primary Device Type
666 * @dev_name: Device Name
667 * @supp_config_methods: Supported configuration Methods
668 * @dev_capab: Device Capabilities
669 * @group_capab: Group Capabilities
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800670 * @group_id: P2P Group ID (or %NULL if not included)
671 * @group_id_len: Length of P2P Group ID
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700672 *
673 * This callback is used to indicate reception of a Provision Discovery
674 * Request frame that the P2P module accepted.
675 */
676 void (*prov_disc_req)(void *ctx, const u8 *peer, u16 config_methods,
677 const u8 *dev_addr, const u8 *pri_dev_type,
678 const char *dev_name, u16 supp_config_methods,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800679 u8 dev_capab, u8 group_capab,
680 const u8 *group_id, size_t group_id_len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700681
682 /**
683 * prov_disc_resp - Callback on Provisiong Discovery Response
684 * @ctx: Callback context from cb_ctx
685 * @peer: Source address of the response
686 * @config_methods: Value from p2p_prov_disc_req() or 0 on failure
687 *
688 * This callback is used to indicate reception of a Provision Discovery
689 * Response frame for a pending request scheduled with
690 * p2p_prov_disc_req(). This callback handler can be set to %NULL if
691 * provision discovery is not used.
692 */
693 void (*prov_disc_resp)(void *ctx, const u8 *peer, u16 config_methods);
694
695 /**
Jouni Malinen75ecf522011-06-27 15:19:46 -0700696 * prov_disc_fail - Callback on Provision Discovery failure
697 * @ctx: Callback context from cb_ctx
698 * @peer: Source address of the response
699 * @status: Cause of failure, will not be %P2P_PROV_DISC_SUCCESS
700 *
701 * This callback is used to indicate either a failure or no response
702 * to an earlier provision discovery request.
703 *
704 * This callback handler can be set to %NULL if provision discovery
705 * is not used or failures do not need to be indicated.
706 */
707 void (*prov_disc_fail)(void *ctx, const u8 *peer,
708 enum p2p_prov_disc_status status);
709
710 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700711 * invitation_process - Optional callback for processing Invitations
712 * @ctx: Callback context from cb_ctx
713 * @sa: Source address of the Invitation Request
714 * @bssid: P2P Group BSSID from the request or %NULL if not included
715 * @go_dev_addr: GO Device Address from P2P Group ID
716 * @ssid: SSID from P2P Group ID
717 * @ssid_len: Length of ssid buffer in octets
718 * @go: Variable for returning whether the local end is GO in the group
719 * @group_bssid: Buffer for returning P2P Group BSSID (if local end GO)
720 * @force_freq: Variable for returning forced frequency for the group
721 * @persistent_group: Whether this is an invitation to reinvoke a
722 * persistent group (instead of invitation to join an active
723 * group)
Dmitry Shmidtf7e0a992013-05-23 11:03:10 -0700724 * @channels: Available operating channels for the group
Dmitry Shmidtcf32e602014-01-28 10:57:39 -0800725 * @dev_pw_id: Device Password ID for NFC static handover or -1 if not
726 * used
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700727 * Returns: Status code (P2P_SC_*)
728 *
729 * This optional callback can be used to implement persistent reconnect
730 * by allowing automatic restarting of persistent groups without user
731 * interaction. If this callback is not implemented (i.e., is %NULL),
732 * the received Invitation Request frames are replied with
733 * %P2P_SC_REQ_RECEIVED status and indicated to upper layer with the
734 * invitation_result() callback.
735 *
736 * If the requested parameters are acceptable and the group is known,
737 * %P2P_SC_SUCCESS may be returned. If the requested group is unknown,
738 * %P2P_SC_FAIL_UNKNOWN_GROUP should be returned. %P2P_SC_REQ_RECEIVED
739 * can be returned if there is not enough data to provide immediate
740 * response, i.e., if some sort of user interaction is needed. The
741 * invitation_received() callback will be called in that case
742 * immediately after this call.
743 */
744 u8 (*invitation_process)(void *ctx, const u8 *sa, const u8 *bssid,
745 const u8 *go_dev_addr, const u8 *ssid,
746 size_t ssid_len, int *go, u8 *group_bssid,
Dmitry Shmidtf7e0a992013-05-23 11:03:10 -0700747 int *force_freq, int persistent_group,
Dmitry Shmidtcf32e602014-01-28 10:57:39 -0800748 const struct p2p_channels *channels,
749 int dev_pw_id);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700750
751 /**
752 * invitation_received - Callback on Invitation Request RX
753 * @ctx: Callback context from cb_ctx
754 * @sa: Source address of the Invitation Request
755 * @bssid: P2P Group BSSID or %NULL if not received
756 * @ssid: SSID of the group
757 * @ssid_len: Length of ssid in octets
758 * @go_dev_addr: GO Device Address
759 * @status: Response Status
760 * @op_freq: Operational frequency for the group
761 *
762 * This callback is used to indicate sending of an Invitation Response
763 * for a received Invitation Request. If status == 0 (success), the
764 * upper layer code is responsible for starting the group. status == 1
765 * indicates need to get user authorization for the group. Other status
766 * values indicate that the invitation request was rejected.
767 */
768 void (*invitation_received)(void *ctx, const u8 *sa, const u8 *bssid,
769 const u8 *ssid, size_t ssid_len,
770 const u8 *go_dev_addr, u8 status,
771 int op_freq);
772
773 /**
774 * invitation_result - Callback on Invitation result
775 * @ctx: Callback context from cb_ctx
776 * @status: Negotiation result (Status Code)
777 * @bssid: P2P Group BSSID or %NULL if not received
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -0800778 * @channels: Available operating channels for the group
Dmitry Shmidt700a1372013-03-15 14:14:44 -0700779 * @addr: Peer address
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -0800780 * @freq: Frequency (in MHz) indicated during invitation or 0
Dmitry Shmidt15907092014-03-25 10:42:57 -0700781 * @peer_oper_freq: Operating frequency (in MHz) advertized by the peer
782 * during invitation or 0
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700783 *
784 * This callback is used to indicate result of an Invitation procedure
785 * started with a call to p2p_invite(). The indicated status code is
786 * the value received from the peer in Invitation Response with 0
787 * (P2P_SC_SUCCESS) indicating success or -1 to indicate a timeout or a
788 * local failure in transmitting the Invitation Request.
789 */
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -0800790 void (*invitation_result)(void *ctx, int status, const u8 *bssid,
Dmitry Shmidt700a1372013-03-15 14:14:44 -0700791 const struct p2p_channels *channels,
Dmitry Shmidt15907092014-03-25 10:42:57 -0700792 const u8 *addr, int freq, int peer_oper_freq);
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800793
794 /**
795 * go_connected - Check whether we are connected to a GO
796 * @ctx: Callback context from cb_ctx
797 * @dev_addr: P2P Device Address of a GO
798 * Returns: 1 if we are connected as a P2P client to the specified GO
799 * or 0 if not.
800 */
801 int (*go_connected)(void *ctx, const u8 *dev_addr);
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800802
803 /**
804 * presence_resp - Callback on Presence Response
805 * @ctx: Callback context from cb_ctx
806 * @src: Source address (GO's P2P Interface Address)
807 * @status: Result of the request (P2P_SC_*)
808 * @noa: Returned NoA value
809 * @noa_len: Length of the NoA buffer in octets
810 */
811 void (*presence_resp)(void *ctx, const u8 *src, u8 status,
812 const u8 *noa, size_t noa_len);
Dmitry Shmidt18463232014-01-24 12:29:41 -0800813
814 /**
815 * is_concurrent_session_active - Check whether concurrent session is
816 * active on other virtual interfaces
817 * @ctx: Callback context from cb_ctx
818 * Returns: 1 if concurrent session is active on other virtual interface
819 * or 0 if not.
820 */
821 int (*is_concurrent_session_active)(void *ctx);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -0700822
823 /**
824 * is_p2p_in_progress - Check whether P2P operation is in progress
825 * @ctx: Callback context from cb_ctx
826 * Returns: 1 if P2P operation (e.g., group formation) is in progress
827 * or 0 if not.
828 */
829 int (*is_p2p_in_progress)(void *ctx);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700830};
831
832
833/* P2P module initialization/deinitialization */
834
835/**
836 * p2p_init - Initialize P2P module
837 * @cfg: P2P module configuration
838 * Returns: Pointer to private data or %NULL on failure
839 *
840 * This function is used to initialize global P2P module context (one per
841 * device). The P2P module will keep a copy of the configuration data, so the
842 * caller does not need to maintain this structure. However, the callback
843 * functions and the context parameters to them must be kept available until
844 * the P2P module is deinitialized with p2p_deinit().
845 */
846struct p2p_data * p2p_init(const struct p2p_config *cfg);
847
848/**
849 * p2p_deinit - Deinitialize P2P module
850 * @p2p: P2P module context from p2p_init()
851 */
852void p2p_deinit(struct p2p_data *p2p);
853
854/**
855 * p2p_flush - Flush P2P module state
856 * @p2p: P2P module context from p2p_init()
857 *
858 * This command removes the P2P module state like peer device entries.
859 */
860void p2p_flush(struct p2p_data *p2p);
861
862/**
863 * p2p_unauthorize - Unauthorize the specified peer device
864 * @p2p: P2P module context from p2p_init()
865 * @addr: P2P peer entry to be unauthorized
866 * Returns: 0 on success, -1 on failure
867 *
868 * This command removes any connection authorization from the specified P2P
869 * peer device address. This can be used, e.g., to cancel effect of a previous
870 * p2p_authorize() or p2p_connect() call that has not yet resulted in completed
871 * GO Negotiation.
872 */
873int p2p_unauthorize(struct p2p_data *p2p, const u8 *addr);
874
875/**
876 * p2p_set_dev_name - Set device name
877 * @p2p: P2P module context from p2p_init()
878 * Returns: 0 on success, -1 on failure
879 *
880 * This function can be used to update the P2P module configuration with
881 * information that was not available at the time of the p2p_init() call.
882 */
883int p2p_set_dev_name(struct p2p_data *p2p, const char *dev_name);
884
885int p2p_set_manufacturer(struct p2p_data *p2p, const char *manufacturer);
886int p2p_set_model_name(struct p2p_data *p2p, const char *model_name);
887int p2p_set_model_number(struct p2p_data *p2p, const char *model_number);
888int p2p_set_serial_number(struct p2p_data *p2p, const char *serial_number);
889
890void p2p_set_config_methods(struct p2p_data *p2p, u16 config_methods);
891void p2p_set_uuid(struct p2p_data *p2p, const u8 *uuid);
892
893/**
894 * p2p_set_pri_dev_type - Set primary device type
895 * @p2p: P2P module context from p2p_init()
896 * Returns: 0 on success, -1 on failure
897 *
898 * This function can be used to update the P2P module configuration with
899 * information that was not available at the time of the p2p_init() call.
900 */
901int p2p_set_pri_dev_type(struct p2p_data *p2p, const u8 *pri_dev_type);
902
903/**
904 * p2p_set_sec_dev_types - Set secondary device types
905 * @p2p: P2P module context from p2p_init()
906 * Returns: 0 on success, -1 on failure
907 *
908 * This function can be used to update the P2P module configuration with
909 * information that was not available at the time of the p2p_init() call.
910 */
911int p2p_set_sec_dev_types(struct p2p_data *p2p, const u8 dev_types[][8],
912 size_t num_dev_types);
913
914int p2p_set_country(struct p2p_data *p2p, const char *country);
915
916
917/* Commands from upper layer management entity */
918
919enum p2p_discovery_type {
920 P2P_FIND_START_WITH_FULL,
921 P2P_FIND_ONLY_SOCIAL,
922 P2P_FIND_PROGRESSIVE
923};
924
925/**
926 * p2p_find - Start P2P Find (Device Discovery)
927 * @p2p: P2P module context from p2p_init()
928 * @timeout: Timeout for find operation in seconds or 0 for no timeout
929 * @type: Device Discovery type
930 * @num_req_dev_types: Number of requested device types
931 * @req_dev_types: Requested device types array, must be an array
932 * containing num_req_dev_types * WPS_DEV_TYPE_LEN bytes; %NULL if no
933 * requested device types.
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800934 * @dev_id: Device ID to search for or %NULL to find all devices
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700935 * @search_delay: Extra delay in milliseconds between search iterations
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700936 * Returns: 0 on success, -1 on failure
937 */
938int p2p_find(struct p2p_data *p2p, unsigned int timeout,
939 enum p2p_discovery_type type,
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800940 unsigned int num_req_dev_types, const u8 *req_dev_types,
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700941 const u8 *dev_id, unsigned int search_delay);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700942
943/**
944 * p2p_stop_find - Stop P2P Find (Device Discovery)
945 * @p2p: P2P module context from p2p_init()
946 */
947void p2p_stop_find(struct p2p_data *p2p);
948
949/**
950 * p2p_stop_find_for_freq - Stop P2P Find for next oper on specific freq
951 * @p2p: P2P module context from p2p_init()
952 * @freq: Frequency in MHz for next operation
953 *
954 * This is like p2p_stop_find(), but Listen state is not stopped if we are
955 * already on the same frequency.
956 */
957void p2p_stop_find_for_freq(struct p2p_data *p2p, int freq);
958
959/**
960 * p2p_listen - Start P2P Listen state for specified duration
961 * @p2p: P2P module context from p2p_init()
962 * @timeout: Listen state duration in milliseconds
963 * Returns: 0 on success, -1 on failure
964 *
965 * This function can be used to request the P2P module to keep the device
966 * discoverable on the listen channel for an extended set of time. At least in
967 * its current form, this is mainly used for testing purposes and may not be of
968 * much use for normal P2P operations.
969 */
970int p2p_listen(struct p2p_data *p2p, unsigned int timeout);
971
972/**
Dmitry Shmidt391c59f2013-09-03 12:16:28 -0700973 * p2p_stop_listen - Stop P2P Listen
974 * @p2p: P2P module context from p2p_init()
975 */
976void p2p_stop_listen(struct p2p_data *p2p);
977
978/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700979 * p2p_connect - Start P2P group formation (GO negotiation)
980 * @p2p: P2P module context from p2p_init()
981 * @peer_addr: MAC address of the peer P2P client
982 * @wps_method: WPS method to be used in provisioning
983 * @go_intent: Local GO intent value (1..15)
984 * @own_interface_addr: Intended interface address to use with the group
985 * @force_freq: The only allowed channel frequency in MHz or 0
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800986 * @persistent_group: Whether to create a persistent group (0 = no, 1 =
987 * persistent group without persistent reconnect, 2 = persistent group with
988 * persistent reconnect)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700989 * @force_ssid: Forced SSID for the group if we become GO or %NULL to generate
990 * a new SSID
991 * @force_ssid_len: Length of $force_ssid buffer
992 * @pd_before_go_neg: Whether to send Provision Discovery prior to GO
993 * Negotiation as an interoperability workaround when initiating group
994 * formation
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800995 * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if
996 * force_freq == 0)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700997 * Returns: 0 on success, -1 on failure
998 */
999int p2p_connect(struct p2p_data *p2p, const u8 *peer_addr,
1000 enum p2p_wps_method wps_method,
1001 int go_intent, const u8 *own_interface_addr,
Dmitry Shmidt04949592012-07-19 12:16:46 -07001002 unsigned int force_freq, int persistent_group,
1003 const u8 *force_ssid, size_t force_ssid_len,
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08001004 int pd_before_go_neg, unsigned int pref_freq, u16 oob_pw_id);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001005
1006/**
1007 * p2p_authorize - Authorize P2P group formation (GO negotiation)
1008 * @p2p: P2P module context from p2p_init()
1009 * @peer_addr: MAC address of the peer P2P client
1010 * @wps_method: WPS method to be used in provisioning
1011 * @go_intent: Local GO intent value (1..15)
1012 * @own_interface_addr: Intended interface address to use with the group
1013 * @force_freq: The only allowed channel frequency in MHz or 0
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001014 * @persistent_group: Whether to create a persistent group (0 = no, 1 =
1015 * persistent group without persistent reconnect, 2 = persistent group with
1016 * persistent reconnect)
Dmitry Shmidt04949592012-07-19 12:16:46 -07001017 * @force_ssid: Forced SSID for the group if we become GO or %NULL to generate
1018 * a new SSID
1019 * @force_ssid_len: Length of $force_ssid buffer
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001020 * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if
1021 * force_freq == 0)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001022 * Returns: 0 on success, -1 on failure
1023 *
1024 * This is like p2p_connect(), but the actual group negotiation is not
1025 * initiated automatically, i.e., the other end is expected to do that.
1026 */
1027int p2p_authorize(struct p2p_data *p2p, const u8 *peer_addr,
1028 enum p2p_wps_method wps_method,
1029 int go_intent, const u8 *own_interface_addr,
Dmitry Shmidt04949592012-07-19 12:16:46 -07001030 unsigned int force_freq, int persistent_group,
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001031 const u8 *force_ssid, size_t force_ssid_len,
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08001032 unsigned int pref_freq, u16 oob_pw_id);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001033
1034/**
1035 * p2p_reject - Reject peer device (explicitly block connection attempts)
1036 * @p2p: P2P module context from p2p_init()
1037 * @peer_addr: MAC address of the peer P2P client
1038 * Returns: 0 on success, -1 on failure
1039 */
1040int p2p_reject(struct p2p_data *p2p, const u8 *peer_addr);
1041
1042/**
1043 * p2p_prov_disc_req - Send Provision Discovery Request
1044 * @p2p: P2P module context from p2p_init()
1045 * @peer_addr: MAC address of the peer P2P client
1046 * @config_methods: WPS Config Methods value (only one bit set)
1047 * @join: Whether this is used by a client joining an active group
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001048 * @force_freq: Forced TX frequency for the frame (mainly for the join case)
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001049 * @user_initiated_pd: Flag to indicate if initiated by user or not
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001050 * Returns: 0 on success, -1 on failure
1051 *
1052 * This function can be used to request a discovered P2P peer to display a PIN
1053 * (config_methods = WPS_CONFIG_DISPLAY) or be prepared to enter a PIN from us
1054 * (config_methods = WPS_CONFIG_KEYPAD). The Provision Discovery Request frame
1055 * is transmitted once immediately and if no response is received, the frame
1056 * will be sent again whenever the target device is discovered during device
1057 * dsicovery (start with a p2p_find() call). Response from the peer is
1058 * indicated with the p2p_config::prov_disc_resp() callback.
1059 */
1060int p2p_prov_disc_req(struct p2p_data *p2p, const u8 *peer_addr,
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001061 u16 config_methods, int join, int force_freq,
1062 int user_initiated_pd);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001063
1064/**
1065 * p2p_sd_request - Schedule a service discovery query
1066 * @p2p: P2P module context from p2p_init()
1067 * @dst: Destination peer or %NULL to apply for all peers
1068 * @tlvs: P2P Service Query TLV(s)
1069 * Returns: Reference to the query or %NULL on failure
1070 *
1071 * Response to the query is indicated with the p2p_config::sd_response()
1072 * callback.
1073 */
1074void * p2p_sd_request(struct p2p_data *p2p, const u8 *dst,
1075 const struct wpabuf *tlvs);
1076
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001077#ifdef CONFIG_WIFI_DISPLAY
1078void * p2p_sd_request_wfd(struct p2p_data *p2p, const u8 *dst,
1079 const struct wpabuf *tlvs);
1080#endif /* CONFIG_WIFI_DISPLAY */
1081
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001082/**
1083 * p2p_sd_cancel_request - Cancel a pending service discovery query
1084 * @p2p: P2P module context from p2p_init()
1085 * @req: Query reference from p2p_sd_request()
1086 * Returns: 0 if request for cancelled; -1 if not found
1087 */
1088int p2p_sd_cancel_request(struct p2p_data *p2p, void *req);
1089
1090/**
1091 * p2p_sd_response - Send response to a service discovery query
1092 * @p2p: P2P module context from p2p_init()
1093 * @freq: Frequency from p2p_config::sd_request() callback
1094 * @dst: Destination address from p2p_config::sd_request() callback
1095 * @dialog_token: Dialog token from p2p_config::sd_request() callback
1096 * @resp_tlvs: P2P Service Response TLV(s)
1097 *
1098 * This function is called as a response to the request indicated with
1099 * p2p_config::sd_request() callback.
1100 */
1101void p2p_sd_response(struct p2p_data *p2p, int freq, const u8 *dst,
1102 u8 dialog_token, const struct wpabuf *resp_tlvs);
1103
1104/**
1105 * p2p_sd_service_update - Indicate a change in local services
1106 * @p2p: P2P module context from p2p_init()
1107 *
1108 * This function needs to be called whenever there is a change in availability
1109 * of the local services. This will increment the Service Update Indicator
1110 * value which will be used in SD Request and Response frames.
1111 */
1112void p2p_sd_service_update(struct p2p_data *p2p);
1113
1114
1115enum p2p_invite_role {
1116 P2P_INVITE_ROLE_GO,
1117 P2P_INVITE_ROLE_ACTIVE_GO,
1118 P2P_INVITE_ROLE_CLIENT
1119};
1120
1121/**
1122 * p2p_invite - Invite a P2P Device into a group
1123 * @p2p: P2P module context from p2p_init()
1124 * @peer: Device Address of the peer P2P Device
1125 * @role: Local role in the group
1126 * @bssid: Group BSSID or %NULL if not known
1127 * @ssid: Group SSID
1128 * @ssid_len: Length of ssid in octets
1129 * @force_freq: The only allowed channel frequency in MHz or 0
1130 * @go_dev_addr: Forced GO Device Address or %NULL if none
1131 * @persistent_group: Whether this is to reinvoke a persistent group
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08001132 * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if
1133 * force_freq == 0)
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08001134 * @dev_pw_id: Device Password ID from OOB Device Password (NFC) static handover
1135 * case or -1 if not used
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001136 * Returns: 0 on success, -1 on failure
1137 */
1138int p2p_invite(struct p2p_data *p2p, const u8 *peer, enum p2p_invite_role role,
1139 const u8 *bssid, const u8 *ssid, size_t ssid_len,
1140 unsigned int force_freq, const u8 *go_dev_addr,
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08001141 int persistent_group, unsigned int pref_freq, int dev_pw_id);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001142
1143/**
1144 * p2p_presence_req - Request GO presence
1145 * @p2p: P2P module context from p2p_init()
1146 * @go_interface_addr: GO P2P Interface Address
1147 * @own_interface_addr: Own P2P Interface Address for this group
1148 * @freq: Group operating frequence (in MHz)
1149 * @duration1: Preferred presence duration in microseconds
1150 * @interval1: Preferred presence interval in microseconds
1151 * @duration2: Acceptable presence duration in microseconds
1152 * @interval2: Acceptable presence interval in microseconds
1153 * Returns: 0 on success, -1 on failure
1154 *
1155 * If both duration and interval values are zero, the parameter pair is not
1156 * specified (i.e., to remove Presence Request, use duration1 = interval1 = 0).
1157 */
1158int p2p_presence_req(struct p2p_data *p2p, const u8 *go_interface_addr,
1159 const u8 *own_interface_addr, unsigned int freq,
1160 u32 duration1, u32 interval1, u32 duration2,
1161 u32 interval2);
1162
1163/**
1164 * p2p_ext_listen - Set Extended Listen Timing
1165 * @p2p: P2P module context from p2p_init()
1166 * @freq: Group operating frequence (in MHz)
1167 * @period: Availability period in milliseconds (1-65535; 0 to disable)
1168 * @interval: Availability interval in milliseconds (1-65535; 0 to disable)
1169 * Returns: 0 on success, -1 on failure
1170 *
1171 * This function can be used to enable or disable (period = interval = 0)
1172 * Extended Listen Timing. When enabled, the P2P Device will become
1173 * discoverable (go into Listen State) every @interval milliseconds for at
1174 * least @period milliseconds.
1175 */
1176int p2p_ext_listen(struct p2p_data *p2p, unsigned int period,
1177 unsigned int interval);
1178
1179/* Event notifications from upper layer management operations */
1180
1181/**
1182 * p2p_wps_success_cb - Report successfully completed WPS provisioning
1183 * @p2p: P2P module context from p2p_init()
1184 * @mac_addr: Peer address
1185 *
1186 * This function is used to report successfully completed WPS provisioning
1187 * during group formation in both GO/Registrar and client/Enrollee roles.
1188 */
1189void p2p_wps_success_cb(struct p2p_data *p2p, const u8 *mac_addr);
1190
1191/**
1192 * p2p_group_formation_failed - Report failed WPS provisioning
1193 * @p2p: P2P module context from p2p_init()
1194 *
1195 * This function is used to report failed group formation. This can happen
1196 * either due to failed WPS provisioning or due to 15 second timeout during
1197 * the provisioning phase.
1198 */
1199void p2p_group_formation_failed(struct p2p_data *p2p);
1200
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001201/**
1202 * p2p_get_provisioning_info - Get any stored provisioning info
1203 * @p2p: P2P module context from p2p_init()
1204 * @addr: Peer P2P Device Address
1205 * Returns: WPS provisioning information (WPS config method) or 0 if no
1206 * information is available
1207 *
1208 * This function is used to retrieve stored WPS provisioning info for the given
1209 * peer.
1210 */
1211u16 p2p_get_provisioning_info(struct p2p_data *p2p, const u8 *addr);
1212
1213/**
1214 * p2p_clear_provisioning_info - Clear any stored provisioning info
1215 * @p2p: P2P module context from p2p_init()
Dmitry Shmidt04949592012-07-19 12:16:46 -07001216 * @iface_addr: Peer P2P Device Address
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001217 *
1218 * This function is used to clear stored WPS provisioning info for the given
1219 * peer.
1220 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001221void p2p_clear_provisioning_info(struct p2p_data *p2p, const u8 *addr);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001222
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001223
1224/* Event notifications from lower layer driver operations */
1225
1226/**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001227 * enum p2p_probe_req_status
1228 *
1229 * @P2P_PREQ_MALFORMED: frame was not well-formed
1230 * @P2P_PREQ_NOT_LISTEN: device isn't in listen state, frame ignored
1231 * @P2P_PREQ_NOT_P2P: frame was not a P2P probe request
1232 * @P2P_PREQ_P2P_NOT_PROCESSED: frame was P2P but wasn't processed
1233 * @P2P_PREQ_P2P_PROCESSED: frame has been processed by P2P
1234 */
1235enum p2p_probe_req_status {
1236 P2P_PREQ_MALFORMED,
1237 P2P_PREQ_NOT_LISTEN,
1238 P2P_PREQ_NOT_P2P,
1239 P2P_PREQ_NOT_PROCESSED,
1240 P2P_PREQ_PROCESSED
1241};
1242
1243/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001244 * p2p_probe_req_rx - Report reception of a Probe Request frame
1245 * @p2p: P2P module context from p2p_init()
1246 * @addr: Source MAC address
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001247 * @dst: Destination MAC address if available or %NULL
1248 * @bssid: BSSID if available or %NULL
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001249 * @ie: Information elements from the Probe Request frame body
1250 * @ie_len: Length of ie buffer in octets
Dmitry Shmidt04949592012-07-19 12:16:46 -07001251 * Returns: value indicating the type and status of the probe request
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001252 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001253enum p2p_probe_req_status
1254p2p_probe_req_rx(struct p2p_data *p2p, const u8 *addr, const u8 *dst,
1255 const u8 *bssid, const u8 *ie, size_t ie_len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001256
1257/**
1258 * p2p_rx_action - Report received Action frame
1259 * @p2p: P2P module context from p2p_init()
1260 * @da: Destination address of the received Action frame
1261 * @sa: Source address of the received Action frame
1262 * @bssid: Address 3 of the received Action frame
1263 * @category: Category of the received Action frame
1264 * @data: Action frame body after the Category field
1265 * @len: Length of the data buffer in octets
1266 * @freq: Frequency (in MHz) on which the frame was received
1267 */
1268void p2p_rx_action(struct p2p_data *p2p, const u8 *da, const u8 *sa,
1269 const u8 *bssid, u8 category,
1270 const u8 *data, size_t len, int freq);
1271
1272/**
1273 * p2p_scan_res_handler - Indicate a P2P scan results
1274 * @p2p: P2P module context from p2p_init()
1275 * @bssid: BSSID of the scan result
1276 * @freq: Frequency of the channel on which the device was found in MHz
Dmitry Shmidtf8623282013-02-20 14:34:59 -08001277 * @rx_time: Time when the result was received
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001278 * @level: Signal level (signal strength of the received Beacon/Probe Response
1279 * frame)
1280 * @ies: Pointer to IEs from the scan result
1281 * @ies_len: Length of the ies buffer
1282 * Returns: 0 to continue or 1 to stop scan result indication
1283 *
1284 * This function is called to indicate a scan result entry with P2P IE from a
1285 * scan requested with struct p2p_config::p2p_scan(). This can be called during
1286 * the actual scan process (i.e., whenever a new device is found) or as a
1287 * sequence of calls after the full scan has been completed. The former option
1288 * can result in optimized operations, but may not be supported by all
1289 * driver/firmware designs. The ies buffer need to include at least the P2P IE,
1290 * but it is recommended to include all IEs received from the device. The
1291 * caller does not need to check that the IEs contain a P2P IE before calling
1292 * this function since frames will be filtered internally if needed.
1293 *
1294 * This function will return 1 if it wants to stop scan result iteration (and
1295 * scan in general if it is still in progress). This is used to allow faster
1296 * start of a pending operation, e.g., to start a pending GO negotiation.
1297 */
1298int p2p_scan_res_handler(struct p2p_data *p2p, const u8 *bssid, int freq,
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001299 struct os_reltime *rx_time, int level, const u8 *ies,
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001300 size_t ies_len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001301
1302/**
1303 * p2p_scan_res_handled - Indicate end of scan results
1304 * @p2p: P2P module context from p2p_init()
1305 *
1306 * This function is called to indicate that all P2P scan results from a scan
1307 * have been reported with zero or more calls to p2p_scan_res_handler(). This
1308 * function must be called as a response to successful
1309 * struct p2p_config::p2p_scan() call if none of the p2p_scan_res_handler()
1310 * calls stopped iteration.
1311 */
1312void p2p_scan_res_handled(struct p2p_data *p2p);
1313
1314enum p2p_send_action_result {
1315 P2P_SEND_ACTION_SUCCESS /* Frame was send and acknowledged */,
1316 P2P_SEND_ACTION_NO_ACK /* Frame was sent, but not acknowledged */,
1317 P2P_SEND_ACTION_FAILED /* Frame was not sent due to a failure */
1318};
1319
1320/**
1321 * p2p_send_action_cb - Notify TX status of an Action frame
1322 * @p2p: P2P module context from p2p_init()
1323 * @freq: Channel frequency in MHz
1324 * @dst: Destination MAC address (Address 1)
1325 * @src: Source MAC address (Address 2)
1326 * @bssid: BSSID (Address 3)
1327 * @result: Result of the transmission attempt
1328 *
1329 * This function is used to indicate the result of an Action frame transmission
1330 * that was requested with struct p2p_config::send_action() callback.
1331 */
1332void p2p_send_action_cb(struct p2p_data *p2p, unsigned int freq, const u8 *dst,
1333 const u8 *src, const u8 *bssid,
1334 enum p2p_send_action_result result);
1335
1336/**
1337 * p2p_listen_cb - Indicate the start of a requested Listen state
1338 * @p2p: P2P module context from p2p_init()
1339 * @freq: Listen channel frequency in MHz
1340 * @duration: Duration for the Listen state in milliseconds
1341 *
1342 * This function is used to indicate that a Listen state requested with
1343 * struct p2p_config::start_listen() callback has started.
1344 */
1345void p2p_listen_cb(struct p2p_data *p2p, unsigned int freq,
1346 unsigned int duration);
1347
1348/**
1349 * p2p_listen_end - Indicate the end of a requested Listen state
1350 * @p2p: P2P module context from p2p_init()
1351 * @freq: Listen channel frequency in MHz
1352 * Returns: 0 if no operations were started, 1 if an operation was started
1353 *
1354 * This function is used to indicate that a Listen state requested with
1355 * struct p2p_config::start_listen() callback has ended.
1356 */
1357int p2p_listen_end(struct p2p_data *p2p, unsigned int freq);
1358
1359void p2p_deauth_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code,
1360 const u8 *ie, size_t ie_len);
1361
1362void p2p_disassoc_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code,
1363 const u8 *ie, size_t ie_len);
1364
1365
1366/* Per-group P2P state for GO */
1367
1368struct p2p_group;
1369
1370/**
1371 * struct p2p_group_config - P2P group configuration
1372 *
1373 * This configuration is provided to the P2P module during initialization of
1374 * the per-group information with p2p_group_init().
1375 */
1376struct p2p_group_config {
1377 /**
1378 * persistent_group - Whether the group is persistent
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001379 * 0 = not a persistent group
1380 * 1 = persistent group without persistent reconnect
1381 * 2 = persistent group with persistent reconnect
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001382 */
1383 int persistent_group;
1384
1385 /**
1386 * interface_addr - P2P Interface Address of the group
1387 */
1388 u8 interface_addr[ETH_ALEN];
1389
1390 /**
1391 * max_clients - Maximum number of clients in the group
1392 */
1393 unsigned int max_clients;
1394
1395 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001396 * ssid - Group SSID
1397 */
1398 u8 ssid[32];
1399
1400 /**
1401 * ssid_len - Length of SSID
1402 */
1403 size_t ssid_len;
1404
1405 /**
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08001406 * freq - Operating channel of the group
1407 */
1408 int freq;
1409
1410 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001411 * cb_ctx - Context to use with callback functions
1412 */
1413 void *cb_ctx;
1414
1415 /**
1416 * ie_update - Notification of IE update
1417 * @ctx: Callback context from cb_ctx
1418 * @beacon_ies: P2P IE for Beacon frames or %NULL if no change
1419 * @proberesp_ies: P2P Ie for Probe Response frames
1420 *
1421 * P2P module uses this callback function to notify whenever the P2P IE
1422 * in Beacon or Probe Response frames should be updated based on group
1423 * events.
1424 *
1425 * The callee is responsible for freeing the returned buffer(s) with
1426 * wpabuf_free().
1427 */
1428 void (*ie_update)(void *ctx, struct wpabuf *beacon_ies,
1429 struct wpabuf *proberesp_ies);
1430
1431 /**
1432 * idle_update - Notification of changes in group idle state
1433 * @ctx: Callback context from cb_ctx
1434 * @idle: Whether the group is idle (no associated stations)
1435 */
1436 void (*idle_update)(void *ctx, int idle);
1437};
1438
1439/**
1440 * p2p_group_init - Initialize P2P group
1441 * @p2p: P2P module context from p2p_init()
1442 * @config: P2P group configuration (will be freed by p2p_group_deinit())
1443 * Returns: Pointer to private data or %NULL on failure
1444 *
1445 * This function is used to initialize per-group P2P module context. Currently,
1446 * this is only used to manage GO functionality and P2P clients do not need to
1447 * create an instance of this per-group information.
1448 */
1449struct p2p_group * p2p_group_init(struct p2p_data *p2p,
1450 struct p2p_group_config *config);
1451
1452/**
1453 * p2p_group_deinit - Deinitialize P2P group
1454 * @group: P2P group context from p2p_group_init()
1455 */
1456void p2p_group_deinit(struct p2p_group *group);
1457
1458/**
1459 * p2p_group_notif_assoc - Notification of P2P client association with GO
1460 * @group: P2P group context from p2p_group_init()
1461 * @addr: Interface address of the P2P client
1462 * @ie: IEs from the (Re)association Request frame
1463 * @len: Length of the ie buffer in octets
1464 * Returns: 0 on success, -1 on failure
1465 */
1466int p2p_group_notif_assoc(struct p2p_group *group, const u8 *addr,
1467 const u8 *ie, size_t len);
1468
1469/**
1470 * p2p_group_assoc_resp_ie - Build P2P IE for (re)association response
1471 * @group: P2P group context from p2p_group_init()
1472 * @status: Status value (P2P_SC_SUCCESS if association succeeded)
1473 * Returns: P2P IE for (Re)association Response or %NULL on failure
1474 *
1475 * The caller is responsible for freeing the returned buffer with
1476 * wpabuf_free().
1477 */
1478struct wpabuf * p2p_group_assoc_resp_ie(struct p2p_group *group, u8 status);
1479
1480/**
1481 * p2p_group_notif_disassoc - Notification of P2P client disassociation from GO
1482 * @group: P2P group context from p2p_group_init()
1483 * @addr: Interface address of the P2P client
1484 */
1485void p2p_group_notif_disassoc(struct p2p_group *group, const u8 *addr);
1486
1487/**
1488 * p2p_group_notif_formation_done - Notification of completed group formation
1489 * @group: P2P group context from p2p_group_init()
1490 */
1491void p2p_group_notif_formation_done(struct p2p_group *group);
1492
1493/**
1494 * p2p_group_notif_noa - Notification of NoA change
1495 * @group: P2P group context from p2p_group_init()
1496 * @noa: Notice of Absence attribute payload, %NULL if none
1497 * @noa_len: Length of noa buffer in octets
1498 * Returns: 0 on success, -1 on failure
1499 *
1500 * Notify the P2P group management about a new NoA contents. This will be
1501 * inserted into the P2P IEs in Beacon and Probe Response frames with rest of
1502 * the group information.
1503 */
1504int p2p_group_notif_noa(struct p2p_group *group, const u8 *noa,
1505 size_t noa_len);
1506
1507/**
1508 * p2p_group_match_dev_type - Match device types in group with requested type
1509 * @group: P2P group context from p2p_group_init()
1510 * @wps: WPS TLVs from Probe Request frame (concatenated WPS IEs)
1511 * Returns: 1 on match, 0 on mismatch
1512 *
1513 * This function can be used to match the Requested Device Type attribute in
1514 * WPS IE with the device types of a group member for deciding whether a GO
1515 * should reply to a Probe Request frame. Match will be reported if the WPS IE
1516 * is not requested any specific device type.
1517 */
1518int p2p_group_match_dev_type(struct p2p_group *group, struct wpabuf *wps);
1519
1520/**
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001521 * p2p_group_match_dev_id - Match P2P Device Address in group with requested device id
1522 */
1523int p2p_group_match_dev_id(struct p2p_group *group, struct wpabuf *p2p);
1524
1525/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001526 * p2p_group_go_discover - Send GO Discoverability Request to a group client
1527 * @group: P2P group context from p2p_group_init()
1528 * Returns: 0 on success (frame scheduled); -1 if client was not found
1529 */
1530int p2p_group_go_discover(struct p2p_group *group, const u8 *dev_id,
1531 const u8 *searching_dev, int rx_freq);
1532
1533
1534/* Generic helper functions */
1535
1536/**
1537 * p2p_ie_text - Build text format description of P2P IE
1538 * @p2p_ie: P2P IE
1539 * @buf: Buffer for returning text
1540 * @end: Pointer to the end of the buf area
1541 * Returns: Number of octets written to the buffer or -1 on failure
1542 *
1543 * This function can be used to parse P2P IE contents into text format
1544 * field=value lines.
1545 */
1546int p2p_ie_text(struct wpabuf *p2p_ie, char *buf, char *end);
1547
1548/**
1549 * p2p_scan_result_text - Build text format description of P2P IE
1550 * @ies: Information elements from scan results
1551 * @ies_len: ies buffer length in octets
1552 * @buf: Buffer for returning text
1553 * @end: Pointer to the end of the buf area
1554 * Returns: Number of octets written to the buffer or -1 on failure
1555 *
1556 * This function can be used to parse P2P IE contents into text format
1557 * field=value lines.
1558 */
1559int p2p_scan_result_text(const u8 *ies, size_t ies_len, char *buf, char *end);
1560
1561/**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001562 * p2p_parse_dev_addr_in_p2p_ie - Parse P2P Device Address from a concatenated
1563 * P2P IE
1564 * @p2p_ie: P2P IE
1565 * @dev_addr: Buffer for returning P2P Device Address
1566 * Returns: 0 on success or -1 if P2P Device Address could not be parsed
1567 */
1568int p2p_parse_dev_addr_in_p2p_ie(struct wpabuf *p2p_ie, u8 *dev_addr);
1569
1570/**
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001571 * p2p_parse_dev_addr - Parse P2P Device Address from P2P IE(s)
1572 * @ies: Information elements from scan results
1573 * @ies_len: ies buffer length in octets
1574 * @dev_addr: Buffer for returning P2P Device Address
1575 * Returns: 0 on success or -1 if P2P Device Address could not be parsed
1576 */
1577int p2p_parse_dev_addr(const u8 *ies, size_t ies_len, u8 *dev_addr);
1578
1579/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001580 * p2p_assoc_req_ie - Build P2P IE for (Re)Association Request frame
1581 * @p2p: P2P module context from p2p_init()
1582 * @bssid: BSSID
1583 * @buf: Buffer for writing the P2P IE
1584 * @len: Maximum buf length in octets
1585 * @p2p_group: Whether this is for association with a P2P GO
1586 * @p2p_ie: Reassembled P2P IE data from scan results or %NULL if none
1587 * Returns: Number of octets written into buf or -1 on failure
1588 */
1589int p2p_assoc_req_ie(struct p2p_data *p2p, const u8 *bssid, u8 *buf,
1590 size_t len, int p2p_group, struct wpabuf *p2p_ie);
1591
1592/**
1593 * p2p_scan_ie - Build P2P IE for Probe Request
1594 * @p2p: P2P module context from p2p_init()
1595 * @ies: Buffer for writing P2P IE
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001596 * @dev_id: Device ID to search for or %NULL for any
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001597 */
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001598void p2p_scan_ie(struct p2p_data *p2p, struct wpabuf *ies, const u8 *dev_id);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001599
1600/**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001601 * p2p_scan_ie_buf_len - Get maximum buffer length needed for p2p_scan_ie
1602 * @p2p: P2P module context from p2p_init()
1603 * Returns: Number of octets that p2p_scan_ie() may add to the buffer
1604 */
1605size_t p2p_scan_ie_buf_len(struct p2p_data *p2p);
1606
1607/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001608 * p2p_go_params - Generate random P2P group parameters
1609 * @p2p: P2P module context from p2p_init()
1610 * @params: Buffer for parameters
1611 * Returns: 0 on success, -1 on failure
1612 */
1613int p2p_go_params(struct p2p_data *p2p, struct p2p_go_neg_results *params);
1614
1615/**
1616 * p2p_get_group_capab - Get Group Capability from P2P IE data
1617 * @p2p_ie: P2P IE(s) contents
1618 * Returns: Group Capability
1619 */
1620u8 p2p_get_group_capab(const struct wpabuf *p2p_ie);
1621
1622/**
1623 * p2p_get_cross_connect_disallowed - Does WLAN AP disallows cross connection
1624 * @p2p_ie: P2P IE(s) contents
1625 * Returns: 0 if cross connection is allow, 1 if not
1626 */
1627int p2p_get_cross_connect_disallowed(const struct wpabuf *p2p_ie);
1628
1629/**
1630 * p2p_get_go_dev_addr - Get P2P Device Address from P2P IE data
1631 * @p2p_ie: P2P IE(s) contents
1632 * Returns: Pointer to P2P Device Address or %NULL if not included
1633 */
1634const u8 * p2p_get_go_dev_addr(const struct wpabuf *p2p_ie);
1635
1636/**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001637 * p2p_get_peer_info - Get P2P peer information
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001638 * @p2p: P2P module context from p2p_init()
1639 * @addr: P2P Device Address of the peer or %NULL to indicate the first peer
1640 * @next: Whether to select the peer entry following the one indicated by addr
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001641 * Returns: Pointer to peer info or %NULL if not found
1642 */
1643const struct p2p_peer_info * p2p_get_peer_info(struct p2p_data *p2p,
1644 const u8 *addr, int next);
1645
1646/**
1647 * p2p_get_peer_info_txt - Get internal P2P peer information in text format
1648 * @info: Pointer to P2P peer info from p2p_get_peer_info()
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001649 * @buf: Buffer for returning text
1650 * @buflen: Maximum buffer length
1651 * Returns: Number of octets written to the buffer or -1 on failure
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001652 *
1653 * Note: This information is internal to the P2P module and subject to change.
1654 * As such, this should not really be used by external programs for purposes
1655 * other than debugging.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001656 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001657int p2p_get_peer_info_txt(const struct p2p_peer_info *info,
1658 char *buf, size_t buflen);
1659
1660/**
1661 * p2p_peer_known - Check whether P2P peer is known
1662 * @p2p: P2P module context from p2p_init()
1663 * @addr: P2P Device Address of the peer
1664 * Returns: 1 if the specified device is in the P2P peer table or 0 if not
1665 */
1666int p2p_peer_known(struct p2p_data *p2p, const u8 *addr);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001667
1668/**
1669 * p2p_set_client_discoverability - Set client discoverability capability
1670 * @p2p: P2P module context from p2p_init()
1671 * @enabled: Whether client discoverability will be enabled
1672 *
1673 * This function can be used to disable (and re-enable) client discoverability.
1674 * This capability is enabled by default and should not be disabled in normal
1675 * use cases, i.e., this is mainly for testing purposes.
1676 */
1677void p2p_set_client_discoverability(struct p2p_data *p2p, int enabled);
1678
1679/**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001680 * p2p_set_managed_oper - Set managed P2P Device operations capability
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001681 * @p2p: P2P module context from p2p_init()
1682 * @enabled: Whether managed P2P Device operations will be enabled
1683 */
1684void p2p_set_managed_oper(struct p2p_data *p2p, int enabled);
1685
Dmitry Shmidt43cb5782014-06-16 16:23:22 -07001686int p2p_set_listen_channel(struct p2p_data *p2p, u8 reg_class, u8 channel,
1687 u8 forced);
1688
1689u8 p2p_get_listen_channel(struct p2p_data *p2p);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001690
1691int p2p_set_ssid_postfix(struct p2p_data *p2p, const u8 *postfix, size_t len);
1692
1693int p2p_get_interface_addr(struct p2p_data *p2p, const u8 *dev_addr,
1694 u8 *iface_addr);
1695int p2p_get_dev_addr(struct p2p_data *p2p, const u8 *iface_addr,
1696 u8 *dev_addr);
1697
1698void p2p_set_peer_filter(struct p2p_data *p2p, const u8 *addr);
1699
1700/**
1701 * p2p_set_cross_connect - Set cross connection capability
1702 * @p2p: P2P module context from p2p_init()
1703 * @enabled: Whether cross connection will be enabled
1704 */
1705void p2p_set_cross_connect(struct p2p_data *p2p, int enabled);
1706
1707int p2p_get_oper_freq(struct p2p_data *p2p, const u8 *iface_addr);
1708
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001709/**
1710 * p2p_set_intra_bss_dist - Set intra BSS distribution
1711 * @p2p: P2P module context from p2p_init()
1712 * @enabled: Whether intra BSS distribution will be enabled
1713 */
1714void p2p_set_intra_bss_dist(struct p2p_data *p2p, int enabled);
1715
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08001716int p2p_channels_includes_freq(const struct p2p_channels *channels,
1717 unsigned int freq);
1718
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001719/**
1720 * p2p_supported_freq - Check whether channel is supported for P2P
1721 * @p2p: P2P module context from p2p_init()
1722 * @freq: Channel frequency in MHz
1723 * Returns: 0 if channel not usable for P2P, 1 if usable for P2P
1724 */
1725int p2p_supported_freq(struct p2p_data *p2p, unsigned int freq);
1726
Dmitry Shmidt44c95782013-05-17 09:51:35 -07001727/**
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -07001728 * p2p_supported_freq_go - Check whether channel is supported for P2P GO operation
1729 * @p2p: P2P module context from p2p_init()
1730 * @freq: Channel frequency in MHz
1731 * Returns: 0 if channel not usable for P2P, 1 if usable for P2P
1732 */
1733int p2p_supported_freq_go(struct p2p_data *p2p, unsigned int freq);
1734
1735/**
1736 * p2p_supported_freq_cli - Check whether channel is supported for P2P client operation
1737 * @p2p: P2P module context from p2p_init()
1738 * @freq: Channel frequency in MHz
1739 * Returns: 0 if channel not usable for P2P, 1 if usable for P2P
1740 */
1741int p2p_supported_freq_cli(struct p2p_data *p2p, unsigned int freq);
1742
1743/**
Dmitry Shmidt44c95782013-05-17 09:51:35 -07001744 * p2p_get_pref_freq - Get channel from preferred channel list
1745 * @p2p: P2P module context from p2p_init()
1746 * @channels: List of channels
1747 * Returns: Preferred channel
1748 */
1749unsigned int p2p_get_pref_freq(struct p2p_data *p2p,
1750 const struct p2p_channels *channels);
1751
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -07001752void p2p_update_channel_list(struct p2p_data *p2p,
1753 const struct p2p_channels *chan,
1754 const struct p2p_channels *cli_chan);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001755
1756/**
1757 * p2p_set_best_channels - Update best channel information
1758 * @p2p: P2P module context from p2p_init()
1759 * @freq_24: Frequency (MHz) of best channel in 2.4 GHz band
1760 * @freq_5: Frequency (MHz) of best channel in 5 GHz band
1761 * @freq_overall: Frequency (MHz) of best channel overall
1762 */
1763void p2p_set_best_channels(struct p2p_data *p2p, int freq_24, int freq_5,
1764 int freq_overall);
1765
Dmitry Shmidt700a1372013-03-15 14:14:44 -07001766/**
1767 * p2p_set_own_freq_preference - Set own preference for channel
1768 * @p2p: P2P module context from p2p_init()
1769 * @freq: Frequency (MHz) of the preferred channel or 0 if no preference
1770 *
1771 * This function can be used to set a preference on the operating channel based
1772 * on frequencies used on the other virtual interfaces that share the same
1773 * radio. If non-zero, this is used to try to avoid multi-channel concurrency.
1774 */
1775void p2p_set_own_freq_preference(struct p2p_data *p2p, int freq);
1776
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001777const u8 * p2p_get_go_neg_peer(struct p2p_data *p2p);
1778
1779/**
1780 * p2p_get_group_num_members - Get number of members in group
1781 * @group: P2P group context from p2p_group_init()
1782 * Returns: Number of members in the group
1783 */
1784unsigned int p2p_get_group_num_members(struct p2p_group *group);
1785
1786/**
1787 * p2p_iterate_group_members - Iterate group members
1788 * @group: P2P group context from p2p_group_init()
1789 * @next: iteration pointer, must be a pointer to a void * that is set to %NULL
1790 * on the first call and not modified later
Dmitry Shmidtd30ac602014-06-30 09:54:22 -07001791 * Returns: A P2P Device Address for each call and %NULL for no more members
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001792 */
1793const u8 * p2p_iterate_group_members(struct p2p_group *group, void **next);
1794
1795/**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001796 * p2p_group_get_dev_addr - Get a P2P Device Address of a client in a group
1797 * @group: P2P group context from p2p_group_init()
1798 * @addr: P2P Interface Address of the client
1799 * Returns: P2P Device Address of the client if found or %NULL if no match
1800 * found
1801 */
1802const u8 * p2p_group_get_dev_addr(struct p2p_group *group, const u8 *addr);
1803
1804/**
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001805 * p2p_group_is_client_connected - Check whether a specific client is connected
1806 * @group: P2P group context from p2p_group_init()
1807 * @addr: P2P Device Address of the client
1808 * Returns: 1 if client is connected or 0 if not
1809 */
1810int p2p_group_is_client_connected(struct p2p_group *group, const u8 *dev_addr);
1811
1812/**
Dmitry Shmidtd30ac602014-06-30 09:54:22 -07001813 * p2p_group_get_config - Get the group configuration
1814 * @group: P2P group context from p2p_group_init()
1815 * Returns: The group configuration pointer
1816 */
1817const struct p2p_group_config * p2p_group_get_config(struct p2p_group *group);
1818
1819/**
1820 * p2p_loop_on_all_groups - Run the given callback on all groups
1821 * @p2p: P2P module context from p2p_init()
1822 * @group_callback: The callback function pointer
1823 * @user_data: Some user data pointer which can be %NULL
1824 *
1825 * The group_callback function can stop the iteration by returning 0.
1826 */
1827void p2p_loop_on_all_groups(struct p2p_data *p2p,
1828 int (*group_callback)(struct p2p_group *group,
1829 void *user_data),
1830 void *user_data);
1831
1832/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001833 * p2p_get_peer_found - Get P2P peer info structure of a found peer
1834 * @p2p: P2P module context from p2p_init()
1835 * @addr: P2P Device Address of the peer or %NULL to indicate the first peer
1836 * @next: Whether to select the peer entry following the one indicated by addr
1837 * Returns: The first P2P peer info available or %NULL if no such peer exists
1838 */
1839const struct p2p_peer_info *
1840p2p_get_peer_found(struct p2p_data *p2p, const u8 *addr, int next);
1841
1842/**
1843 * p2p_remove_wps_vendor_extensions - Remove WPS vendor extensions
1844 * @p2p: P2P module context from p2p_init()
1845 */
1846void p2p_remove_wps_vendor_extensions(struct p2p_data *p2p);
1847
1848/**
1849 * p2p_add_wps_vendor_extension - Add a WPS vendor extension
1850 * @p2p: P2P module context from p2p_init()
1851 * @vendor_ext: The vendor extensions to add
1852 * Returns: 0 on success, -1 on failure
1853 *
1854 * The wpabuf structures in the array are owned by the P2P
1855 * module after this call.
1856 */
1857int p2p_add_wps_vendor_extension(struct p2p_data *p2p,
1858 const struct wpabuf *vendor_ext);
1859
Jouni Malinen75ecf522011-06-27 15:19:46 -07001860/**
1861 * p2p_set_oper_channel - Set the P2P operating channel
1862 * @p2p: P2P module context from p2p_init()
1863 * @op_reg_class: Operating regulatory class to set
1864 * @op_channel: operating channel to set
1865 * @cfg_op_channel : Whether op_channel is hardcoded in configuration
1866 * Returns: 0 on success, -1 on failure
1867 */
1868int p2p_set_oper_channel(struct p2p_data *p2p, u8 op_reg_class, u8 op_channel,
1869 int cfg_op_channel);
1870
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001871/**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001872 * p2p_set_pref_chan - Set P2P preferred channel list
1873 * @p2p: P2P module context from p2p_init()
1874 * @num_pref_chan: Number of entries in pref_chan list
1875 * @pref_chan: Preferred channels or %NULL to remove preferences
1876 * Returns: 0 on success, -1 on failure
1877 */
1878int p2p_set_pref_chan(struct p2p_data *p2p, unsigned int num_pref_chan,
1879 const struct p2p_channel *pref_chan);
1880
1881/**
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -07001882 * p2p_set_no_go_freq - Set no GO channel ranges
1883 * @p2p: P2P module context from p2p_init()
1884 * @list: Channel ranges or %NULL to remove restriction
1885 * Returns: 0 on success, -1 on failure
1886 */
1887int p2p_set_no_go_freq(struct p2p_data *p2p,
1888 const struct wpa_freq_range_list *list);
1889
1890/**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001891 * p2p_in_progress - Check whether a P2P operation is progress
1892 * @p2p: P2P module context from p2p_init()
1893 * Returns: 0 if P2P module is idle or 1 if an operation is in progress
1894 */
1895int p2p_in_progress(struct p2p_data *p2p);
1896
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001897const char * p2p_wps_method_text(enum p2p_wps_method method);
1898
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001899/**
1900 * p2p_set_config_timeout - Set local config timeouts
1901 * @p2p: P2P module context from p2p_init()
1902 * @go_timeout: Time in 10 ms units it takes to start the GO mode
1903 * @client_timeout: Time in 10 ms units it takes to start the client mode
1904 */
1905void p2p_set_config_timeout(struct p2p_data *p2p, u8 go_timeout,
1906 u8 client_timeout);
1907
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001908int p2p_set_wfd_ie_beacon(struct p2p_data *p2p, struct wpabuf *ie);
1909int p2p_set_wfd_ie_probe_req(struct p2p_data *p2p, struct wpabuf *ie);
1910int p2p_set_wfd_ie_probe_resp(struct p2p_data *p2p, struct wpabuf *ie);
1911int p2p_set_wfd_ie_assoc_req(struct p2p_data *p2p, struct wpabuf *ie);
1912int p2p_set_wfd_ie_invitation(struct p2p_data *p2p, struct wpabuf *ie);
1913int p2p_set_wfd_ie_prov_disc_req(struct p2p_data *p2p, struct wpabuf *ie);
1914int p2p_set_wfd_ie_prov_disc_resp(struct p2p_data *p2p, struct wpabuf *ie);
1915int p2p_set_wfd_ie_go_neg(struct p2p_data *p2p, struct wpabuf *ie);
1916int p2p_set_wfd_dev_info(struct p2p_data *p2p, const struct wpabuf *elem);
1917int p2p_set_wfd_assoc_bssid(struct p2p_data *p2p, const struct wpabuf *elem);
1918int p2p_set_wfd_coupled_sink_info(struct p2p_data *p2p,
1919 const struct wpabuf *elem);
1920struct wpabuf * wifi_display_encaps(struct wpabuf *subelems);
1921
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001922/**
1923 * p2p_set_disc_int - Set min/max discoverable interval for p2p_find
1924 * @p2p: P2P module context from p2p_init()
1925 * @min_disc_int: minDiscoverableInterval (in units of 100 TU); default 1
1926 * @max_disc_int: maxDiscoverableInterval (in units of 100 TU); default 3
1927 * @max_disc_tu: Maximum number of TUs (1.024 ms) for discoverable interval; or
1928 * -1 not to limit
1929 * Returns: 0 on success, or -1 on failure
1930 *
1931 * This function can be used to configure minDiscoverableInterval and
1932 * maxDiscoverableInterval parameters for the Listen state during device
1933 * discovery (p2p_find). A random number of 100 TU units is picked for each
1934 * Listen state iteration from [min_disc_int,max_disc_int] range.
1935 *
1936 * max_disc_tu can be used to futher limit the discoverable duration. However,
1937 * it should be noted that use of this parameter is not recommended since it
1938 * would not be compliant with the P2P specification.
1939 */
1940int p2p_set_disc_int(struct p2p_data *p2p, int min_disc_int, int max_disc_int,
1941 int max_disc_tu);
1942
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07001943/**
1944 * p2p_get_state_txt - Get current P2P state for debug purposes
1945 * @p2p: P2P module context from p2p_init()
1946 * Returns: Name of the current P2P module state
1947 *
1948 * It should be noted that the P2P module state names are internal information
1949 * and subject to change at any point, i.e., this information should be used
1950 * mainly for debugging purposes.
1951 */
1952const char * p2p_get_state_txt(struct p2p_data *p2p);
1953
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08001954struct wpabuf * p2p_build_nfc_handover_req(struct p2p_data *p2p,
1955 int client_freq,
1956 const u8 *go_dev_addr,
1957 const u8 *ssid, size_t ssid_len);
1958struct wpabuf * p2p_build_nfc_handover_sel(struct p2p_data *p2p,
1959 int client_freq,
1960 const u8 *go_dev_addr,
1961 const u8 *ssid, size_t ssid_len);
1962
1963struct p2p_nfc_params {
1964 int sel;
1965 const u8 *wsc_attr;
1966 size_t wsc_len;
1967 const u8 *p2p_attr;
1968 size_t p2p_len;
1969
1970 enum {
1971 NO_ACTION, JOIN_GROUP, AUTH_JOIN, INIT_GO_NEG, RESP_GO_NEG,
1972 BOTH_GO, PEER_CLIENT
1973 } next_step;
1974 struct p2p_peer_info *peer;
1975 u8 oob_dev_pw[WPS_OOB_PUBKEY_HASH_LEN + 2 +
1976 WPS_OOB_DEVICE_PASSWORD_LEN];
1977 size_t oob_dev_pw_len;
1978 int go_freq;
1979 u8 go_dev_addr[ETH_ALEN];
1980 u8 go_ssid[32];
1981 size_t go_ssid_len;
1982};
1983
1984int p2p_process_nfc_connection_handover(struct p2p_data *p2p,
1985 struct p2p_nfc_params *params);
1986
1987void p2p_set_authorized_oob_dev_pw_id(struct p2p_data *p2p, u16 dev_pw_id,
1988 int go_intent,
1989 const u8 *own_interface_addr);
1990
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -07001991int p2p_set_passphrase_len(struct p2p_data *p2p, unsigned int len);
1992
Dmitry Shmidtd30ac602014-06-30 09:54:22 -07001993void p2p_loop_on_known_peers(struct p2p_data *p2p,
1994 void (*peer_callback)(struct p2p_peer_info *peer,
1995 void *user_data),
1996 void *user_data);
1997
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001998#endif /* P2P_H */