]> git.ipfire.org Git - thirdparty/hostap.git/blame - src/p2p/p2p.h
Add UNAUTH-TLS vendor specific EAP type
[thirdparty/hostap.git] / src / p2p / p2p.h
CommitLineData
b22128ef
JM
1/*
2 * Wi-Fi Direct - P2P module
3 * Copyright (c) 2009-2010, Atheros Communications
4 *
e22d4d95
JM
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
b22128ef
JM
7 */
8
9#ifndef P2P_H
10#define P2P_H
11
12/**
13 * P2P_MAX_REG_CLASSES - Maximum number of regulatory classes
14 */
15#define P2P_MAX_REG_CLASSES 10
16
17/**
18 * P2P_MAX_REG_CLASS_CHANNELS - Maximum number of channels per regulatory class
19 */
20#define P2P_MAX_REG_CLASS_CHANNELS 20
21
22/**
23 * struct p2p_channels - List of supported channels
24 */
25struct p2p_channels {
26 /**
27 * struct p2p_reg_class - Supported regulatory class
28 */
29 struct p2p_reg_class {
30 /**
31 * reg_class - Regulatory class (IEEE 802.11-2007, Annex J)
32 */
33 u8 reg_class;
34
35 /**
36 * channel - Supported channels
37 */
38 u8 channel[P2P_MAX_REG_CLASS_CHANNELS];
39
40 /**
41 * channels - Number of channel entries in use
42 */
43 size_t channels;
44 } reg_class[P2P_MAX_REG_CLASSES];
45
46 /**
47 * reg_classes - Number of reg_class entries in use
48 */
49 size_t reg_classes;
50};
51
52enum p2p_wps_method {
07fecd39 53 WPS_NOT_READY, WPS_PIN_DISPLAY, WPS_PIN_KEYPAD, WPS_PBC
b22128ef
JM
54};
55
56/**
57 * struct p2p_go_neg_results - P2P Group Owner Negotiation results
58 */
59struct p2p_go_neg_results {
60 /**
61 * status - Negotiation result (Status Code)
62 *
63 * 0 (P2P_SC_SUCCESS) indicates success. Non-zero values indicate
64 * failed negotiation.
65 */
66 int status;
67
68 /**
69 * role_go - Whether local end is Group Owner
70 */
71 int role_go;
72
73 /**
74 * freq - Frequency of the group operational channel in MHz
75 */
76 int freq;
77
7aeac985
RM
78 int ht40;
79
b22128ef
JM
80 /**
81 * ssid - SSID of the group
82 */
83 u8 ssid[32];
84
85 /**
86 * ssid_len - Length of SSID in octets
87 */
88 size_t ssid_len;
89
90 /**
91 * passphrase - WPA2-Personal passphrase for the group (GO only)
92 */
93 char passphrase[64];
94
95 /**
96 * peer_device_addr - P2P Device Address of the peer
97 */
98 u8 peer_device_addr[ETH_ALEN];
99
100 /**
101 * peer_interface_addr - P2P Interface Address of the peer
102 */
103 u8 peer_interface_addr[ETH_ALEN];
104
105 /**
106 * wps_method - WPS method to be used during provisioning
107 */
108 enum p2p_wps_method wps_method;
109
110#define P2P_MAX_CHANNELS 50
111
112 /**
113 * freq_list - Zero-terminated list of possible operational channels
114 */
115 int freq_list[P2P_MAX_CHANNELS];
116
117 /**
118 * persistent_group - Whether the group should be made persistent
acc247b2
JM
119 * 0 = not persistent
120 * 1 = persistent group without persistent reconnect
121 * 2 = persistent group with persistent reconnect
b22128ef
JM
122 */
123 int persistent_group;
ae3e3421
JM
124
125 /**
126 * peer_config_timeout - Peer configuration timeout (in 10 msec units)
127 */
128 unsigned int peer_config_timeout;
b22128ef
JM
129};
130
131struct p2p_data;
132
133enum p2p_scan_type {
134 P2P_SCAN_SOCIAL,
135 P2P_SCAN_FULL,
b22128ef
JM
136 P2P_SCAN_SOCIAL_PLUS_ONE
137};
138
10c5d2a5
JM
139#define P2P_MAX_WPS_VENDOR_EXT 10
140
c5db8e51
KRK
141/**
142 * struct p2p_peer_info - P2P peer information
c5db8e51
KRK
143 */
144struct p2p_peer_info {
145 /**
146 * p2p_device_addr - P2P Device Address of the peer
147 */
148 u8 p2p_device_addr[ETH_ALEN];
149
150 /**
151 * pri_dev_type - Primary Device Type
152 */
153 u8 pri_dev_type[8];
154
155 /**
b67d0d9e 156 * device_name - Device Name (0..32 octets encoded in UTF-8)
c5db8e51
KRK
157 */
158 char device_name[33];
159
b67d0d9e
JM
160 /**
161 * manufacturer - Manufacturer (0..64 octets encoded in UTF-8)
162 */
163 char manufacturer[65];
164
165 /**
166 * model_name - Model Name (0..32 octets encoded in UTF-8)
167 */
168 char model_name[33];
169
170 /**
171 * model_number - Model Number (0..32 octets encoded in UTF-8)
172 */
173 char model_number[33];
174
175 /**
176 * serial_number - Serial Number (0..32 octets encoded in UTF-8)
177 */
178 char serial_number[33];
179
6402fc43
JS
180 /**
181 * level - Signal level
182 */
183 int level;
184
c5db8e51
KRK
185 /**
186 * config_methods - WPS Configuration Methods
187 */
188 u16 config_methods;
189
190 /**
191 * dev_capab - Device Capabilities
192 */
193 u8 dev_capab;
194
195 /**
196 * group_capab - Group Capabilities
197 */
198 u8 group_capab;
e57ae6e1
JMB
199
200 /**
201 * wps_sec_dev_type_list - WPS secondary device type list
202 *
203 * This list includes from 0 to 16 Secondary Device Types as indicated
204 * by wps_sec_dev_type_list_len (8 * number of types).
205 */
206 u8 wps_sec_dev_type_list[128];
207
208 /**
209 * wps_sec_dev_type_list_len - Length of secondary device type list
210 */
211 size_t wps_sec_dev_type_list_len;
212
10c5d2a5 213 struct wpabuf *wps_vendor_ext[P2P_MAX_WPS_VENDOR_EXT];
c5db8e51
KRK
214};
215
349b213c
JS
216enum p2p_prov_disc_status {
217 P2P_PROV_DISC_SUCCESS,
218 P2P_PROV_DISC_TIMEOUT,
219 P2P_PROV_DISC_REJECTED,
220};
221
21d996f7
JM
222struct p2p_channel {
223 u8 op_class;
224 u8 chan;
225};
226
b22128ef
JM
227/**
228 * struct p2p_config - P2P configuration
229 *
230 * This configuration is provided to the P2P module during initialization with
231 * p2p_init().
232 */
233struct p2p_config {
234 /**
235 * country - Country code to use in P2P operations
236 */
237 char country[3];
238
239 /**
240 * reg_class - Regulatory class for own listen channel
241 */
242 u8 reg_class;
243
244 /**
245 * channel - Own listen channel
246 */
247 u8 channel;
248
249 /**
250 * Regulatory class for own operational channel
251 */
252 u8 op_reg_class;
253
254 /**
255 * op_channel - Own operational channel
256 */
257 u8 op_channel;
258
7cfc4ac3
AGS
259 /**
260 * cfg_op_channel - Whether op_channel is hardcoded in configuration
261 */
262 u8 cfg_op_channel;
263
b22128ef
JM
264 /**
265 * channels - Own supported regulatory classes and channels
266 *
267 * List of supposerted channels per regulatory class. The regulatory
268 * classes are defined in IEEE Std 802.11-2007 Annex J and the
269 * numbering of the clases depends on the configured country code.
270 */
271 struct p2p_channels channels;
272
21d996f7
JM
273 /**
274 * num_pref_chan - Number of pref_chan entries
275 */
276 unsigned int num_pref_chan;
277
278 /**
279 * pref_chan - Preferred channels for GO Negotiation
280 */
281 struct p2p_channel *pref_chan;
282
b22128ef
JM
283 /**
284 * pri_dev_type - Primary Device Type (see WPS)
285 */
286 u8 pri_dev_type[8];
287
288 /**
289 * P2P_SEC_DEVICE_TYPES - Maximum number of secondary device types
290 */
291#define P2P_SEC_DEVICE_TYPES 5
292
293 /**
294 * sec_dev_type - Optional secondary device types
295 */
296 u8 sec_dev_type[P2P_SEC_DEVICE_TYPES][8];
297
b6e01800
JM
298 /**
299 * num_sec_dev_types - Number of sec_dev_type entries
300 */
301 size_t num_sec_dev_types;
302
b22128ef
JM
303 /**
304 * dev_addr - P2P Device Address
305 */
306 u8 dev_addr[ETH_ALEN];
307
308 /**
309 * dev_name - Device Name
310 */
311 char *dev_name;
312
b6e01800
JM
313 char *manufacturer;
314 char *model_name;
315 char *model_number;
316 char *serial_number;
317
318 u8 uuid[16];
319 u16 config_methods;
b22128ef
JM
320
321 /**
322 * concurrent_operations - Whether concurrent operations are supported
323 */
324 int concurrent_operations;
325
326 /**
327 * max_peers - Maximum number of discovered peers to remember
328 *
329 * If more peers are discovered, older entries will be removed to make
330 * room for the new ones.
331 */
332 size_t max_peers;
333
0f66abd2
SS
334 /**
335 * p2p_intra_bss - Intra BSS communication is supported
336 */
337 int p2p_intra_bss;
338
b22128ef
JM
339 /**
340 * ssid_postfix - Postfix data to add to the SSID
341 *
342 * This data will be added to the end of the SSID after the
343 * DIRECT-<random two octets> prefix.
344 */
345 u8 ssid_postfix[32 - 9];
346
347 /**
348 * ssid_postfix_len - Length of the ssid_postfix data
349 */
350 size_t ssid_postfix_len;
351
352 /**
353 * msg_ctx - Context to use with wpa_msg() calls
354 */
355 void *msg_ctx;
356
357 /**
358 * cb_ctx - Context to use with callback functions
359 */
360 void *cb_ctx;
361
362
363 /* Callbacks to request lower layer driver operations */
364
365 /**
366 * p2p_scan - Request a P2P scan/search
367 * @ctx: Callback context from cb_ctx
368 * @type: Scan type
369 * @freq: Specific frequency (MHz) to scan or 0 for no restriction
046ef4aa
JMB
370 * @num_req_dev_types: Number of requested device types
371 * @req_dev_types: Array containing requested device types
6d92fa6e 372 * @dev_id: Device ID to search for or %NULL to find all devices
360182ed 373 * @pw_id: Device Password ID
b22128ef
JM
374 * Returns: 0 on success, -1 on failure
375 *
376 * This callback function is used to request a P2P scan or search
377 * operation to be completed. Type type argument specifies which type
378 * of scan is to be done. @P2P_SCAN_SOCIAL indicates that only the
379 * social channels (1, 6, 11) should be scanned. @P2P_SCAN_FULL
3df2f4fe 380 * indicates that all channels are to be scanned.
b22128ef
JM
381 * @P2P_SCAN_SOCIAL_PLUS_ONE request scan of all the social channels
382 * plus one extra channel specified by freq.
383 *
384 * The full scan is used for the initial scan to find group owners from
385 * all. The other types are used during search phase scan of the social
386 * channels (with potential variation if the Listen channel of the
387 * target peer is known or if other channels are scanned in steps).
388 *
389 * The scan results are returned after this call by calling
390 * p2p_scan_res_handler() for each scan result that has a P2P IE and
391 * then calling p2p_scan_res_handled() to indicate that all scan
392 * results have been indicated.
393 */
046ef4aa
JMB
394 int (*p2p_scan)(void *ctx, enum p2p_scan_type type, int freq,
395 unsigned int num_req_dev_types,
360182ed 396 const u8 *req_dev_types, const u8 *dev_id, u16 pw_id);
b22128ef
JM
397
398 /**
399 * send_probe_resp - Transmit a Probe Response frame
400 * @ctx: Callback context from cb_ctx
401 * @buf: Probe Response frame (including the header and body)
402 * Returns: 0 on success, -1 on failure
403 *
404 * This function is used to reply to Probe Request frames that were
405 * indicated with a call to p2p_probe_req_rx(). The response is to be
406 * sent on the same channel or to be dropped if the driver is not
407 * anymore listening to Probe Request frames.
408 *
409 * Alternatively, the responsibility for building the Probe Response
410 * frames in Listen state may be in another system component in which
411 * case this function need to be implemented (i.e., the function
412 * pointer can be %NULL). The WPS and P2P IEs to be added for Probe
413 * Response frames in such a case are available from the
414 * start_listen() callback. It should be noted that the received Probe
415 * Request frames must be indicated by calling p2p_probe_req_rx() even
416 * if this send_probe_resp() is not used.
417 */
418 int (*send_probe_resp)(void *ctx, const struct wpabuf *buf);
419
420 /**
421 * send_action - Transmit an Action frame
422 * @ctx: Callback context from cb_ctx
423 * @freq: Frequency in MHz for the channel on which to transmit
424 * @dst: Destination MAC address (Address 1)
425 * @src: Source MAC address (Address 2)
426 * @bssid: BSSID (Address 3)
427 * @buf: Frame body (starting from Category field)
428 * @len: Length of buf in octets
429 * @wait_time: How many msec to wait for a response frame
430 * Returns: 0 on success, -1 on failure
431 *
432 * The Action frame may not be transmitted immediately and the status
433 * of the transmission must be reported by calling
434 * p2p_send_action_cb() once the frame has either been transmitted or
435 * it has been dropped due to excessive retries or other failure to
436 * transmit.
437 */
438 int (*send_action)(void *ctx, unsigned int freq, const u8 *dst,
439 const u8 *src, const u8 *bssid, const u8 *buf,
440 size_t len, unsigned int wait_time);
441
442 /**
443 * send_action_done - Notify that Action frame sequence was completed
444 * @ctx: Callback context from cb_ctx
445 *
446 * This function is called when the Action frame sequence that was
447 * started with send_action() has been completed, i.e., when there is
448 * no need to wait for a response from the destination peer anymore.
449 */
450 void (*send_action_done)(void *ctx);
451
452 /**
453 * start_listen - Start Listen state
454 * @ctx: Callback context from cb_ctx
455 * @freq: Frequency of the listen channel in MHz
456 * @duration: Duration for the Listen state in milliseconds
457 * @probe_resp_ie: IE(s) to be added to Probe Response frames
458 * Returns: 0 on success, -1 on failure
459 *
460 * This Listen state may not start immediately since the driver may
461 * have other pending operations to complete first. Once the Listen
462 * state has started, p2p_listen_cb() must be called to notify the P2P
463 * module. Once the Listen state is stopped, p2p_listen_end() must be
464 * called to notify the P2P module that the driver is not in the Listen
465 * state anymore.
466 *
467 * If the send_probe_resp() is not used for generating the response,
468 * the IEs from probe_resp_ie need to be added to the end of the Probe
469 * Response frame body. If send_probe_resp() is used, the probe_resp_ie
470 * information can be ignored.
471 */
472 int (*start_listen)(void *ctx, unsigned int freq,
473 unsigned int duration,
474 const struct wpabuf *probe_resp_ie);
475 /**
476 * stop_listen - Stop Listen state
477 * @ctx: Callback context from cb_ctx
478 *
479 * This callback can be used to stop a Listen state operation that was
480 * previously requested with start_listen().
481 */
482 void (*stop_listen)(void *ctx);
483
484 /**
485 * get_noa - Get current Notice of Absence attribute payload
486 * @ctx: Callback context from cb_ctx
487 * @interface_addr: P2P Interface Address of the GO
488 * @buf: Buffer for returning NoA
489 * @buf_len: Buffer length in octets
490 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
491 * advertized, or -1 on failure
492 *
493 * This function is used to fetch the current Notice of Absence
494 * attribute value from GO.
495 */
496 int (*get_noa)(void *ctx, const u8 *interface_addr, u8 *buf,
497 size_t buf_len);
498
499 /* Callbacks to notify events to upper layer management entity */
500
501 /**
502 * dev_found - Notification of a found P2P Device
503 * @ctx: Callback context from cb_ctx
504 * @addr: Source address of the message triggering this notification
c5db8e51 505 * @info: P2P peer information
8fd7dc1b 506 * @new_device: Inform if the peer is newly found
b22128ef
JM
507 *
508 * This callback is used to notify that a new P2P Device has been
509 * found. This may happen, e.g., during Search state based on scan
510 * results or during Listen state based on receive Probe Request and
511 * Group Owner Negotiation Request.
512 */
c5db8e51 513 void (*dev_found)(void *ctx, const u8 *addr,
8fd7dc1b
JB
514 const struct p2p_peer_info *info,
515 int new_device);
b22128ef 516
56eeb8f2
JB
517 /**
518 * dev_lost - Notification of a lost P2P Device
519 * @ctx: Callback context from cb_ctx
520 * @dev_addr: P2P Device Address of the lost P2P Device
521 *
522 * This callback is used to notify that a P2P Device has been deleted.
523 */
524 void (*dev_lost)(void *ctx, const u8 *dev_addr);
525
b22128ef
JM
526 /**
527 * go_neg_req_rx - Notification of a receive GO Negotiation Request
528 * @ctx: Callback context from cb_ctx
529 * @src: Source address of the message triggering this notification
3dfda83d 530 * @dev_passwd_id: WPS Device Password ID
b22128ef
JM
531 *
532 * This callback is used to notify that a P2P Device is requesting
533 * group owner negotiation with us, but we do not have all the
534 * necessary information to start GO Negotiation. This indicates that
535 * the local user has not authorized the connection yet by providing a
536 * PIN or PBC button press. This information can be provided with a
537 * call to p2p_connect().
538 */
3dfda83d 539 void (*go_neg_req_rx)(void *ctx, const u8 *src, u16 dev_passwd_id);
b22128ef
JM
540
541 /**
542 * go_neg_completed - Notification of GO Negotiation results
543 * @ctx: Callback context from cb_ctx
544 * @res: GO Negotiation results
545 *
546 * This callback is used to notify that Group Owner Negotiation has
547 * been completed. Non-zero struct p2p_go_neg_results::status indicates
548 * failed negotiation. In case of success, this function is responsible
549 * for creating a new group interface (or using the existing interface
550 * depending on driver features), setting up the group interface in
551 * proper mode based on struct p2p_go_neg_results::role_go and
552 * initializing WPS provisioning either as a Registrar (if GO) or as an
553 * Enrollee. Successful WPS provisioning must be indicated by calling
554 * p2p_wps_success_cb(). The callee is responsible for timing out group
555 * formation if WPS provisioning cannot be completed successfully
556 * within 15 seconds.
557 */
558 void (*go_neg_completed)(void *ctx, struct p2p_go_neg_results *res);
559
560 /**
561 * sd_request - Callback on Service Discovery Request
562 * @ctx: Callback context from cb_ctx
563 * @freq: Frequency (in MHz) of the channel
564 * @sa: Source address of the request
565 * @dialog_token: Dialog token
566 * @update_indic: Service Update Indicator from the source of request
567 * @tlvs: P2P Service Request TLV(s)
568 * @tlvs_len: Length of tlvs buffer in octets
569 *
570 * This callback is used to indicate reception of a service discovery
571 * request. Response to the query must be indicated by calling
572 * p2p_sd_response() with the context information from the arguments to
573 * this callback function.
574 *
575 * This callback handler can be set to %NULL to indicate that service
576 * discovery is not supported.
577 */
578 void (*sd_request)(void *ctx, int freq, const u8 *sa, u8 dialog_token,
579 u16 update_indic, const u8 *tlvs, size_t tlvs_len);
580
581 /**
582 * sd_response - Callback on Service Discovery Response
583 * @ctx: Callback context from cb_ctx
584 * @sa: Source address of the request
585 * @update_indic: Service Update Indicator from the source of response
586 * @tlvs: P2P Service Response TLV(s)
587 * @tlvs_len: Length of tlvs buffer in octets
588 *
589 * This callback is used to indicate reception of a service discovery
590 * response. This callback handler can be set to %NULL if no service
591 * discovery requests are used. The information provided with this call
592 * is replies to the queries scheduled with p2p_sd_request().
593 */
594 void (*sd_response)(void *ctx, const u8 *sa, u16 update_indic,
595 const u8 *tlvs, size_t tlvs_len);
596
597 /**
598 * prov_disc_req - Callback on Provisiong Discovery Request
599 * @ctx: Callback context from cb_ctx
600 * @peer: Source address of the request
601 * @config_methods: Requested WPS Config Method
602 * @dev_addr: P2P Device Address of the found P2P Device
603 * @pri_dev_type: Primary Device Type
604 * @dev_name: Device Name
605 * @supp_config_methods: Supported configuration Methods
606 * @dev_capab: Device Capabilities
607 * @group_capab: Group Capabilities
c3f42784
JM
608 * @group_id: P2P Group ID (or %NULL if not included)
609 * @group_id_len: Length of P2P Group ID
b22128ef
JM
610 *
611 * This callback is used to indicate reception of a Provision Discovery
612 * Request frame that the P2P module accepted.
613 */
614 void (*prov_disc_req)(void *ctx, const u8 *peer, u16 config_methods,
615 const u8 *dev_addr, const u8 *pri_dev_type,
616 const char *dev_name, u16 supp_config_methods,
c3f42784
JM
617 u8 dev_capab, u8 group_capab,
618 const u8 *group_id, size_t group_id_len);
b22128ef
JM
619
620 /**
621 * prov_disc_resp - Callback on Provisiong Discovery Response
622 * @ctx: Callback context from cb_ctx
623 * @peer: Source address of the response
624 * @config_methods: Value from p2p_prov_disc_req() or 0 on failure
625 *
626 * This callback is used to indicate reception of a Provision Discovery
627 * Response frame for a pending request scheduled with
628 * p2p_prov_disc_req(). This callback handler can be set to %NULL if
629 * provision discovery is not used.
630 */
631 void (*prov_disc_resp)(void *ctx, const u8 *peer, u16 config_methods);
632
349b213c
JS
633 /**
634 * prov_disc_fail - Callback on Provision Discovery failure
635 * @ctx: Callback context from cb_ctx
636 * @peer: Source address of the response
637 * @status: Cause of failure, will not be %P2P_PROV_DISC_SUCCESS
638 *
639 * This callback is used to indicate either a failure or no response
640 * to an earlier provision discovery request.
641 *
642 * This callback handler can be set to %NULL if provision discovery
643 * is not used or failures do not need to be indicated.
644 */
645 void (*prov_disc_fail)(void *ctx, const u8 *peer,
646 enum p2p_prov_disc_status status);
647
b22128ef
JM
648 /**
649 * invitation_process - Optional callback for processing Invitations
650 * @ctx: Callback context from cb_ctx
651 * @sa: Source address of the Invitation Request
652 * @bssid: P2P Group BSSID from the request or %NULL if not included
653 * @go_dev_addr: GO Device Address from P2P Group ID
654 * @ssid: SSID from P2P Group ID
655 * @ssid_len: Length of ssid buffer in octets
656 * @go: Variable for returning whether the local end is GO in the group
657 * @group_bssid: Buffer for returning P2P Group BSSID (if local end GO)
658 * @force_freq: Variable for returning forced frequency for the group
659 * @persistent_group: Whether this is an invitation to reinvoke a
660 * persistent group (instead of invitation to join an active
661 * group)
662 * Returns: Status code (P2P_SC_*)
663 *
664 * This optional callback can be used to implement persistent reconnect
665 * by allowing automatic restarting of persistent groups without user
666 * interaction. If this callback is not implemented (i.e., is %NULL),
667 * the received Invitation Request frames are replied with
668 * %P2P_SC_REQ_RECEIVED status and indicated to upper layer with the
669 * invitation_result() callback.
670 *
671 * If the requested parameters are acceptable and the group is known,
672 * %P2P_SC_SUCCESS may be returned. If the requested group is unknown,
673 * %P2P_SC_FAIL_UNKNOWN_GROUP should be returned. %P2P_SC_REQ_RECEIVED
674 * can be returned if there is not enough data to provide immediate
675 * response, i.e., if some sort of user interaction is needed. The
676 * invitation_received() callback will be called in that case
677 * immediately after this call.
678 */
679 u8 (*invitation_process)(void *ctx, const u8 *sa, const u8 *bssid,
680 const u8 *go_dev_addr, const u8 *ssid,
681 size_t ssid_len, int *go, u8 *group_bssid,
682 int *force_freq, int persistent_group);
683
684 /**
685 * invitation_received - Callback on Invitation Request RX
686 * @ctx: Callback context from cb_ctx
687 * @sa: Source address of the Invitation Request
688 * @bssid: P2P Group BSSID or %NULL if not received
689 * @ssid: SSID of the group
690 * @ssid_len: Length of ssid in octets
691 * @go_dev_addr: GO Device Address
692 * @status: Response Status
693 * @op_freq: Operational frequency for the group
694 *
695 * This callback is used to indicate sending of an Invitation Response
696 * for a received Invitation Request. If status == 0 (success), the
697 * upper layer code is responsible for starting the group. status == 1
698 * indicates need to get user authorization for the group. Other status
699 * values indicate that the invitation request was rejected.
700 */
701 void (*invitation_received)(void *ctx, const u8 *sa, const u8 *bssid,
702 const u8 *ssid, size_t ssid_len,
703 const u8 *go_dev_addr, u8 status,
704 int op_freq);
705
706 /**
707 * invitation_result - Callback on Invitation result
708 * @ctx: Callback context from cb_ctx
709 * @status: Negotiation result (Status Code)
710 * @bssid: P2P Group BSSID or %NULL if not received
711 *
712 * This callback is used to indicate result of an Invitation procedure
713 * started with a call to p2p_invite(). The indicated status code is
714 * the value received from the peer in Invitation Response with 0
715 * (P2P_SC_SUCCESS) indicating success or -1 to indicate a timeout or a
716 * local failure in transmitting the Invitation Request.
717 */
718 void (*invitation_result)(void *ctx, int status, const u8 *bssid);
b1aebbc4
JM
719
720 /**
721 * go_connected - Check whether we are connected to a GO
722 * @ctx: Callback context from cb_ctx
723 * @dev_addr: P2P Device Address of a GO
724 * Returns: 1 if we are connected as a P2P client to the specified GO
725 * or 0 if not.
726 */
727 int (*go_connected)(void *ctx, const u8 *dev_addr);
b22128ef
JM
728};
729
730
731/* P2P module initialization/deinitialization */
732
733/**
734 * p2p_init - Initialize P2P module
735 * @cfg: P2P module configuration
736 * Returns: Pointer to private data or %NULL on failure
737 *
738 * This function is used to initialize global P2P module context (one per
739 * device). The P2P module will keep a copy of the configuration data, so the
740 * caller does not need to maintain this structure. However, the callback
741 * functions and the context parameters to them must be kept available until
742 * the P2P module is deinitialized with p2p_deinit().
743 */
744struct p2p_data * p2p_init(const struct p2p_config *cfg);
745
746/**
747 * p2p_deinit - Deinitialize P2P module
748 * @p2p: P2P module context from p2p_init()
749 */
750void p2p_deinit(struct p2p_data *p2p);
751
752/**
753 * p2p_flush - Flush P2P module state
754 * @p2p: P2P module context from p2p_init()
755 *
756 * This command removes the P2P module state like peer device entries.
757 */
758void p2p_flush(struct p2p_data *p2p);
759
9d562b79
SS
760/**
761 * p2p_unauthorize - Unauthorize the specified peer device
762 * @p2p: P2P module context from p2p_init()
763 * @addr: P2P peer entry to be unauthorized
764 * Returns: 0 on success, -1 on failure
765 *
766 * This command removes any connection authorization from the specified P2P
767 * peer device address. This can be used, e.g., to cancel effect of a previous
768 * p2p_authorize() or p2p_connect() call that has not yet resulted in completed
769 * GO Negotiation.
770 */
771int p2p_unauthorize(struct p2p_data *p2p, const u8 *addr);
772
b22128ef
JM
773/**
774 * p2p_set_dev_name - Set device name
775 * @p2p: P2P module context from p2p_init()
776 * Returns: 0 on success, -1 on failure
777 *
778 * This function can be used to update the P2P module configuration with
779 * information that was not available at the time of the p2p_init() call.
780 */
781int p2p_set_dev_name(struct p2p_data *p2p, const char *dev_name);
782
b6e01800
JM
783int p2p_set_manufacturer(struct p2p_data *p2p, const char *manufacturer);
784int p2p_set_model_name(struct p2p_data *p2p, const char *model_name);
785int p2p_set_model_number(struct p2p_data *p2p, const char *model_number);
786int p2p_set_serial_number(struct p2p_data *p2p, const char *serial_number);
787
788void p2p_set_config_methods(struct p2p_data *p2p, u16 config_methods);
789void p2p_set_uuid(struct p2p_data *p2p, const u8 *uuid);
790
b22128ef
JM
791/**
792 * p2p_set_pri_dev_type - Set primary device type
793 * @p2p: P2P module context from p2p_init()
794 * Returns: 0 on success, -1 on failure
795 *
796 * This function can be used to update the P2P module configuration with
797 * information that was not available at the time of the p2p_init() call.
798 */
799int p2p_set_pri_dev_type(struct p2p_data *p2p, const u8 *pri_dev_type);
800
801/**
802 * p2p_set_sec_dev_types - Set secondary device types
803 * @p2p: P2P module context from p2p_init()
804 * Returns: 0 on success, -1 on failure
805 *
806 * This function can be used to update the P2P module configuration with
807 * information that was not available at the time of the p2p_init() call.
808 */
809int p2p_set_sec_dev_types(struct p2p_data *p2p, const u8 dev_types[][8],
810 size_t num_dev_types);
811
812int p2p_set_country(struct p2p_data *p2p, const char *country);
813
814
815/* Commands from upper layer management entity */
816
817enum p2p_discovery_type {
818 P2P_FIND_START_WITH_FULL,
819 P2P_FIND_ONLY_SOCIAL,
820 P2P_FIND_PROGRESSIVE
821};
822
823/**
824 * p2p_find - Start P2P Find (Device Discovery)
825 * @p2p: P2P module context from p2p_init()
826 * @timeout: Timeout for find operation in seconds or 0 for no timeout
827 * @type: Device Discovery type
046ef4aa
JMB
828 * @num_req_dev_types: Number of requested device types
829 * @req_dev_types: Requested device types array, must be an array
830 * containing num_req_dev_types * WPS_DEV_TYPE_LEN bytes; %NULL if no
831 * requested device types.
6d92fa6e 832 * @dev_id: Device ID to search for or %NULL to find all devices
b22128ef
JM
833 * Returns: 0 on success, -1 on failure
834 */
835int p2p_find(struct p2p_data *p2p, unsigned int timeout,
046ef4aa 836 enum p2p_discovery_type type,
6d92fa6e
JM
837 unsigned int num_req_dev_types, const u8 *req_dev_types,
838 const u8 *dev_id);
b22128ef
JM
839
840/**
841 * p2p_stop_find - Stop P2P Find (Device Discovery)
842 * @p2p: P2P module context from p2p_init()
843 */
844void p2p_stop_find(struct p2p_data *p2p);
845
0b8889d8
JM
846/**
847 * p2p_stop_find_for_freq - Stop P2P Find for next oper on specific freq
848 * @p2p: P2P module context from p2p_init()
849 * @freq: Frequency in MHz for next operation
850 *
851 * This is like p2p_stop_find(), but Listen state is not stopped if we are
852 * already on the same frequency.
853 */
854void p2p_stop_find_for_freq(struct p2p_data *p2p, int freq);
855
b22128ef
JM
856/**
857 * p2p_listen - Start P2P Listen state for specified duration
858 * @p2p: P2P module context from p2p_init()
859 * @timeout: Listen state duration in milliseconds
860 * Returns: 0 on success, -1 on failure
861 *
862 * This function can be used to request the P2P module to keep the device
863 * discoverable on the listen channel for an extended set of time. At least in
864 * its current form, this is mainly used for testing purposes and may not be of
865 * much use for normal P2P operations.
866 */
867int p2p_listen(struct p2p_data *p2p, unsigned int timeout);
868
869/**
870 * p2p_connect - Start P2P group formation (GO negotiation)
871 * @p2p: P2P module context from p2p_init()
872 * @peer_addr: MAC address of the peer P2P client
873 * @wps_method: WPS method to be used in provisioning
874 * @go_intent: Local GO intent value (1..15)
875 * @own_interface_addr: Intended interface address to use with the group
876 * @force_freq: The only allowed channel frequency in MHz or 0
acc247b2
JM
877 * @persistent_group: Whether to create a persistent group (0 = no, 1 =
878 * persistent group without persistent reconnect, 2 = persistent group with
879 * persistent reconnect)
23c84252
JM
880 * @force_ssid: Forced SSID for the group if we become GO or %NULL to generate
881 * a new SSID
882 * @force_ssid_len: Length of $force_ssid buffer
3bc462cb
JM
883 * @pd_before_go_neg: Whether to send Provision Discovery prior to GO
884 * Negotiation as an interoperability workaround when initiating group
885 * formation
b22128ef
JM
886 * Returns: 0 on success, -1 on failure
887 */
888int p2p_connect(struct p2p_data *p2p, const u8 *peer_addr,
889 enum p2p_wps_method wps_method,
890 int go_intent, const u8 *own_interface_addr,
23c84252 891 unsigned int force_freq, int persistent_group,
3bc462cb
JM
892 const u8 *force_ssid, size_t force_ssid_len,
893 int pd_before_go_neg);
b22128ef
JM
894
895/**
896 * p2p_authorize - Authorize P2P group formation (GO negotiation)
897 * @p2p: P2P module context from p2p_init()
898 * @peer_addr: MAC address of the peer P2P client
899 * @wps_method: WPS method to be used in provisioning
900 * @go_intent: Local GO intent value (1..15)
901 * @own_interface_addr: Intended interface address to use with the group
902 * @force_freq: The only allowed channel frequency in MHz or 0
acc247b2
JM
903 * @persistent_group: Whether to create a persistent group (0 = no, 1 =
904 * persistent group without persistent reconnect, 2 = persistent group with
905 * persistent reconnect)
23c84252
JM
906 * @force_ssid: Forced SSID for the group if we become GO or %NULL to generate
907 * a new SSID
908 * @force_ssid_len: Length of $force_ssid buffer
b22128ef
JM
909 * Returns: 0 on success, -1 on failure
910 *
911 * This is like p2p_connect(), but the actual group negotiation is not
912 * initiated automatically, i.e., the other end is expected to do that.
913 */
914int p2p_authorize(struct p2p_data *p2p, const u8 *peer_addr,
915 enum p2p_wps_method wps_method,
916 int go_intent, const u8 *own_interface_addr,
23c84252
JM
917 unsigned int force_freq, int persistent_group,
918 const u8 *force_ssid, size_t force_ssid_len);
b22128ef
JM
919
920/**
921 * p2p_reject - Reject peer device (explicitly block connection attempts)
922 * @p2p: P2P module context from p2p_init()
923 * @peer_addr: MAC address of the peer P2P client
924 * Returns: 0 on success, -1 on failure
925 */
926int p2p_reject(struct p2p_data *p2p, const u8 *peer_addr);
927
928/**
929 * p2p_prov_disc_req - Send Provision Discovery Request
930 * @p2p: P2P module context from p2p_init()
931 * @peer_addr: MAC address of the peer P2P client
932 * @config_methods: WPS Config Methods value (only one bit set)
933 * @join: Whether this is used by a client joining an active group
1ef2f7ff 934 * @force_freq: Forced TX frequency for the frame (mainly for the join case)
b22128ef
JM
935 * Returns: 0 on success, -1 on failure
936 *
937 * This function can be used to request a discovered P2P peer to display a PIN
938 * (config_methods = WPS_CONFIG_DISPLAY) or be prepared to enter a PIN from us
939 * (config_methods = WPS_CONFIG_KEYPAD). The Provision Discovery Request frame
940 * is transmitted once immediately and if no response is received, the frame
941 * will be sent again whenever the target device is discovered during device
942 * dsicovery (start with a p2p_find() call). Response from the peer is
943 * indicated with the p2p_config::prov_disc_resp() callback.
944 */
945int p2p_prov_disc_req(struct p2p_data *p2p, const u8 *peer_addr,
1ef2f7ff 946 u16 config_methods, int join, int force_freq);
b22128ef
JM
947
948/**
949 * p2p_sd_request - Schedule a service discovery query
950 * @p2p: P2P module context from p2p_init()
951 * @dst: Destination peer or %NULL to apply for all peers
952 * @tlvs: P2P Service Query TLV(s)
953 * Returns: Reference to the query or %NULL on failure
954 *
955 * Response to the query is indicated with the p2p_config::sd_response()
956 * callback.
957 */
958void * p2p_sd_request(struct p2p_data *p2p, const u8 *dst,
959 const struct wpabuf *tlvs);
960
961/**
962 * p2p_sd_cancel_request - Cancel a pending service discovery query
963 * @p2p: P2P module context from p2p_init()
964 * @req: Query reference from p2p_sd_request()
965 * Returns: 0 if request for cancelled; -1 if not found
966 */
967int p2p_sd_cancel_request(struct p2p_data *p2p, void *req);
968
969/**
970 * p2p_sd_response - Send response to a service discovery query
971 * @p2p: P2P module context from p2p_init()
972 * @freq: Frequency from p2p_config::sd_request() callback
973 * @dst: Destination address from p2p_config::sd_request() callback
974 * @dialog_token: Dialog token from p2p_config::sd_request() callback
975 * @resp_tlvs: P2P Service Response TLV(s)
976 *
977 * This function is called as a response to the request indicated with
978 * p2p_config::sd_request() callback.
979 */
980void p2p_sd_response(struct p2p_data *p2p, int freq, const u8 *dst,
981 u8 dialog_token, const struct wpabuf *resp_tlvs);
982
983/**
984 * p2p_sd_service_update - Indicate a change in local services
985 * @p2p: P2P module context from p2p_init()
986 *
987 * This function needs to be called whenever there is a change in availability
988 * of the local services. This will increment the Service Update Indicator
989 * value which will be used in SD Request and Response frames.
990 */
991void p2p_sd_service_update(struct p2p_data *p2p);
992
993
994enum p2p_invite_role {
995 P2P_INVITE_ROLE_GO,
996 P2P_INVITE_ROLE_ACTIVE_GO,
997 P2P_INVITE_ROLE_CLIENT
998};
999
1000/**
1001 * p2p_invite - Invite a P2P Device into a group
1002 * @p2p: P2P module context from p2p_init()
1003 * @peer: Device Address of the peer P2P Device
1004 * @role: Local role in the group
1005 * @bssid: Group BSSID or %NULL if not known
1006 * @ssid: Group SSID
1007 * @ssid_len: Length of ssid in octets
1008 * @force_freq: The only allowed channel frequency in MHz or 0
1009 * @go_dev_addr: Forced GO Device Address or %NULL if none
1010 * @persistent_group: Whether this is to reinvoke a persistent group
1011 * Returns: 0 on success, -1 on failure
1012 */
1013int p2p_invite(struct p2p_data *p2p, const u8 *peer, enum p2p_invite_role role,
1014 const u8 *bssid, const u8 *ssid, size_t ssid_len,
1015 unsigned int force_freq, const u8 *go_dev_addr,
1016 int persistent_group);
1017
1018/**
1019 * p2p_presence_req - Request GO presence
1020 * @p2p: P2P module context from p2p_init()
1021 * @go_interface_addr: GO P2P Interface Address
1022 * @own_interface_addr: Own P2P Interface Address for this group
1023 * @freq: Group operating frequence (in MHz)
1024 * @duration1: Preferred presence duration in microseconds
1025 * @interval1: Preferred presence interval in microseconds
1026 * @duration2: Acceptable presence duration in microseconds
1027 * @interval2: Acceptable presence interval in microseconds
1028 * Returns: 0 on success, -1 on failure
1029 *
1030 * If both duration and interval values are zero, the parameter pair is not
1031 * specified (i.e., to remove Presence Request, use duration1 = interval1 = 0).
1032 */
1033int p2p_presence_req(struct p2p_data *p2p, const u8 *go_interface_addr,
1034 const u8 *own_interface_addr, unsigned int freq,
1035 u32 duration1, u32 interval1, u32 duration2,
1036 u32 interval2);
1037
1038/**
1039 * p2p_ext_listen - Set Extended Listen Timing
1040 * @p2p: P2P module context from p2p_init()
1041 * @freq: Group operating frequence (in MHz)
1042 * @period: Availability period in milliseconds (1-65535; 0 to disable)
1043 * @interval: Availability interval in milliseconds (1-65535; 0 to disable)
1044 * Returns: 0 on success, -1 on failure
1045 *
1046 * This function can be used to enable or disable (period = interval = 0)
1047 * Extended Listen Timing. When enabled, the P2P Device will become
1048 * discoverable (go into Listen State) every @interval milliseconds for at
1049 * least @period milliseconds.
1050 */
1051int p2p_ext_listen(struct p2p_data *p2p, unsigned int period,
1052 unsigned int interval);
1053
1054/* Event notifications from upper layer management operations */
1055
1056/**
1057 * p2p_wps_success_cb - Report successfully completed WPS provisioning
1058 * @p2p: P2P module context from p2p_init()
1059 * @mac_addr: Peer address
1060 *
1061 * This function is used to report successfully completed WPS provisioning
1062 * during group formation in both GO/Registrar and client/Enrollee roles.
1063 */
1064void p2p_wps_success_cb(struct p2p_data *p2p, const u8 *mac_addr);
1065
1066/**
1067 * p2p_group_formation_failed - Report failed WPS provisioning
1068 * @p2p: P2P module context from p2p_init()
1069 *
1070 * This function is used to report failed group formation. This can happen
1071 * either due to failed WPS provisioning or due to 15 second timeout during
1072 * the provisioning phase.
1073 */
1074void p2p_group_formation_failed(struct p2p_data *p2p);
1075
ec437d9e
JJ
1076/**
1077 * p2p_get_provisioning_info - Get any stored provisioning info
1078 * @p2p: P2P module context from p2p_init()
1079 * @addr: Peer P2P Device Address
1080 * Returns: WPS provisioning information (WPS config method) or 0 if no
1081 * information is available
1082 *
1083 * This function is used to retrieve stored WPS provisioning info for the given
1084 * peer.
1085 */
1086u16 p2p_get_provisioning_info(struct p2p_data *p2p, const u8 *addr);
1087
1088/**
1089 * p2p_clear_provisioning_info - Clear any stored provisioning info
1090 * @p2p: P2P module context from p2p_init()
10531d21 1091 * @iface_addr: Peer P2P Device Address
ec437d9e
JJ
1092 *
1093 * This function is used to clear stored WPS provisioning info for the given
1094 * peer.
1095 */
10531d21 1096void p2p_clear_provisioning_info(struct p2p_data *p2p, const u8 *addr);
ec437d9e 1097
b22128ef
JM
1098
1099/* Event notifications from lower layer driver operations */
1100
2d43d37f
JB
1101/**
1102 * enum p2p_probe_req_status
1103 *
1104 * @P2P_PREQ_MALFORMED: frame was not well-formed
1105 * @P2P_PREQ_NOT_LISTEN: device isn't in listen state, frame ignored
1106 * @P2P_PREQ_NOT_P2P: frame was not a P2P probe request
1107 * @P2P_PREQ_P2P_NOT_PROCESSED: frame was P2P but wasn't processed
1108 * @P2P_PREQ_P2P_PROCESSED: frame has been processed by P2P
1109 */
1110enum p2p_probe_req_status {
1111 P2P_PREQ_MALFORMED,
1112 P2P_PREQ_NOT_LISTEN,
1113 P2P_PREQ_NOT_P2P,
1114 P2P_PREQ_NOT_PROCESSED,
1115 P2P_PREQ_PROCESSED
1116};
1117
b22128ef
JM
1118/**
1119 * p2p_probe_req_rx - Report reception of a Probe Request frame
1120 * @p2p: P2P module context from p2p_init()
1121 * @addr: Source MAC address
04a85e44
JM
1122 * @dst: Destination MAC address if available or %NULL
1123 * @bssid: BSSID if available or %NULL
b22128ef
JM
1124 * @ie: Information elements from the Probe Request frame body
1125 * @ie_len: Length of ie buffer in octets
2d43d37f 1126 * Returns: value indicating the type and status of the probe request
b22128ef 1127 */
2d43d37f
JB
1128enum p2p_probe_req_status
1129p2p_probe_req_rx(struct p2p_data *p2p, const u8 *addr, const u8 *dst,
1130 const u8 *bssid, const u8 *ie, size_t ie_len);
b22128ef
JM
1131
1132/**
1133 * p2p_rx_action - Report received Action frame
1134 * @p2p: P2P module context from p2p_init()
1135 * @da: Destination address of the received Action frame
1136 * @sa: Source address of the received Action frame
1137 * @bssid: Address 3 of the received Action frame
1138 * @category: Category of the received Action frame
1139 * @data: Action frame body after the Category field
1140 * @len: Length of the data buffer in octets
1141 * @freq: Frequency (in MHz) on which the frame was received
1142 */
1143void p2p_rx_action(struct p2p_data *p2p, const u8 *da, const u8 *sa,
1144 const u8 *bssid, u8 category,
1145 const u8 *data, size_t len, int freq);
1146
1147/**
1148 * p2p_scan_res_handler - Indicate a P2P scan results
1149 * @p2p: P2P module context from p2p_init()
1150 * @bssid: BSSID of the scan result
1151 * @freq: Frequency of the channel on which the device was found in MHz
1152 * @level: Signal level (signal strength of the received Beacon/Probe Response
1153 * frame)
1154 * @ies: Pointer to IEs from the scan result
1155 * @ies_len: Length of the ies buffer
1156 * Returns: 0 to continue or 1 to stop scan result indication
1157 *
1158 * This function is called to indicate a scan result entry with P2P IE from a
1159 * scan requested with struct p2p_config::p2p_scan(). This can be called during
1160 * the actual scan process (i.e., whenever a new device is found) or as a
1161 * sequence of calls after the full scan has been completed. The former option
1162 * can result in optimized operations, but may not be supported by all
1163 * driver/firmware designs. The ies buffer need to include at least the P2P IE,
1164 * but it is recommended to include all IEs received from the device. The
1165 * caller does not need to check that the IEs contain a P2P IE before calling
1166 * this function since frames will be filtered internally if needed.
1167 *
1168 * This function will return 1 if it wants to stop scan result iteration (and
1169 * scan in general if it is still in progress). This is used to allow faster
1170 * start of a pending operation, e.g., to start a pending GO negotiation.
1171 */
1172int p2p_scan_res_handler(struct p2p_data *p2p, const u8 *bssid, int freq,
1173 int level, const u8 *ies, size_t ies_len);
1174
1175/**
1176 * p2p_scan_res_handled - Indicate end of scan results
1177 * @p2p: P2P module context from p2p_init()
1178 *
1179 * This function is called to indicate that all P2P scan results from a scan
1180 * have been reported with zero or more calls to p2p_scan_res_handler(). This
1181 * function must be called as a response to successful
1182 * struct p2p_config::p2p_scan() call if none of the p2p_scan_res_handler()
1183 * calls stopped iteration.
1184 */
1185void p2p_scan_res_handled(struct p2p_data *p2p);
1186
93b7ddd0
JM
1187enum p2p_send_action_result {
1188 P2P_SEND_ACTION_SUCCESS /* Frame was send and acknowledged */,
1189 P2P_SEND_ACTION_NO_ACK /* Frame was sent, but not acknowledged */,
1190 P2P_SEND_ACTION_FAILED /* Frame was not sent due to a failure */
1191};
1192
b22128ef
JM
1193/**
1194 * p2p_send_action_cb - Notify TX status of an Action frame
1195 * @p2p: P2P module context from p2p_init()
1196 * @freq: Channel frequency in MHz
1197 * @dst: Destination MAC address (Address 1)
1198 * @src: Source MAC address (Address 2)
1199 * @bssid: BSSID (Address 3)
93b7ddd0 1200 * @result: Result of the transmission attempt
b22128ef
JM
1201 *
1202 * This function is used to indicate the result of an Action frame transmission
1203 * that was requested with struct p2p_config::send_action() callback.
1204 */
1205void p2p_send_action_cb(struct p2p_data *p2p, unsigned int freq, const u8 *dst,
93b7ddd0
JM
1206 const u8 *src, const u8 *bssid,
1207 enum p2p_send_action_result result);
b22128ef
JM
1208
1209/**
1210 * p2p_listen_cb - Indicate the start of a requested Listen state
1211 * @p2p: P2P module context from p2p_init()
1212 * @freq: Listen channel frequency in MHz
1213 * @duration: Duration for the Listen state in milliseconds
1214 *
1215 * This function is used to indicate that a Listen state requested with
1216 * struct p2p_config::start_listen() callback has started.
1217 */
1218void p2p_listen_cb(struct p2p_data *p2p, unsigned int freq,
1219 unsigned int duration);
1220
1221/**
1222 * p2p_listen_end - Indicate the end of a requested Listen state
1223 * @p2p: P2P module context from p2p_init()
1224 * @freq: Listen channel frequency in MHz
1225 * Returns: 0 if no operations were started, 1 if an operation was started
1226 *
1227 * This function is used to indicate that a Listen state requested with
1228 * struct p2p_config::start_listen() callback has ended.
1229 */
1230int p2p_listen_end(struct p2p_data *p2p, unsigned int freq);
1231
1232void p2p_deauth_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code,
1233 const u8 *ie, size_t ie_len);
1234
1235void p2p_disassoc_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code,
1236 const u8 *ie, size_t ie_len);
1237
1238
1239/* Per-group P2P state for GO */
1240
1241struct p2p_group;
1242
1243/**
1244 * struct p2p_group_config - P2P group configuration
1245 *
1246 * This configuration is provided to the P2P module during initialization of
1247 * the per-group information with p2p_group_init().
1248 */
1249struct p2p_group_config {
1250 /**
1251 * persistent_group - Whether the group is persistent
acc247b2
JM
1252 * 0 = not a persistent group
1253 * 1 = persistent group without persistent reconnect
1254 * 2 = persistent group with persistent reconnect
b22128ef
JM
1255 */
1256 int persistent_group;
1257
1258 /**
1259 * interface_addr - P2P Interface Address of the group
1260 */
1261 u8 interface_addr[ETH_ALEN];
1262
3f4ce13f
JM
1263 /**
1264 * max_clients - Maximum number of clients in the group
1265 */
1266 unsigned int max_clients;
1267
6f251b6b
JM
1268 /**
1269 * ssid - Group SSID
1270 */
1271 u8 ssid[32];
1272
1273 /**
1274 * ssid_len - Length of SSID
1275 */
1276 size_t ssid_len;
1277
b22128ef
JM
1278 /**
1279 * cb_ctx - Context to use with callback functions
1280 */
1281 void *cb_ctx;
1282
1283 /**
1284 * ie_update - Notification of IE update
1285 * @ctx: Callback context from cb_ctx
1286 * @beacon_ies: P2P IE for Beacon frames or %NULL if no change
1287 * @proberesp_ies: P2P Ie for Probe Response frames
1288 *
1289 * P2P module uses this callback function to notify whenever the P2P IE
1290 * in Beacon or Probe Response frames should be updated based on group
1291 * events.
1292 *
1293 * The callee is responsible for freeing the returned buffer(s) with
1294 * wpabuf_free().
1295 */
1296 void (*ie_update)(void *ctx, struct wpabuf *beacon_ies,
1297 struct wpabuf *proberesp_ies);
3071e181
JM
1298
1299 /**
1300 * idle_update - Notification of changes in group idle state
1301 * @ctx: Callback context from cb_ctx
1302 * @idle: Whether the group is idle (no associated stations)
1303 */
1304 void (*idle_update)(void *ctx, int idle);
b22128ef
JM
1305};
1306
1307/**
1308 * p2p_group_init - Initialize P2P group
1309 * @p2p: P2P module context from p2p_init()
1310 * @config: P2P group configuration (will be freed by p2p_group_deinit())
1311 * Returns: Pointer to private data or %NULL on failure
1312 *
1313 * This function is used to initialize per-group P2P module context. Currently,
1314 * this is only used to manage GO functionality and P2P clients do not need to
1315 * create an instance of this per-group information.
1316 */
1317struct p2p_group * p2p_group_init(struct p2p_data *p2p,
1318 struct p2p_group_config *config);
1319
1320/**
1321 * p2p_group_deinit - Deinitialize P2P group
1322 * @group: P2P group context from p2p_group_init()
1323 */
1324void p2p_group_deinit(struct p2p_group *group);
1325
1326/**
1327 * p2p_group_notif_assoc - Notification of P2P client association with GO
1328 * @group: P2P group context from p2p_group_init()
1329 * @addr: Interface address of the P2P client
1330 * @ie: IEs from the (Re)association Request frame
1331 * @len: Length of the ie buffer in octets
1332 * Returns: 0 on success, -1 on failure
1333 */
1334int p2p_group_notif_assoc(struct p2p_group *group, const u8 *addr,
1335 const u8 *ie, size_t len);
1336
1337/**
1338 * p2p_group_assoc_resp_ie - Build P2P IE for (re)association response
1339 * @group: P2P group context from p2p_group_init()
1340 * @status: Status value (P2P_SC_SUCCESS if association succeeded)
1341 * Returns: P2P IE for (Re)association Response or %NULL on failure
1342 *
1343 * The caller is responsible for freeing the returned buffer with
1344 * wpabuf_free().
1345 */
1346struct wpabuf * p2p_group_assoc_resp_ie(struct p2p_group *group, u8 status);
1347
1348/**
1349 * p2p_group_notif_disassoc - Notification of P2P client disassociation from GO
1350 * @group: P2P group context from p2p_group_init()
1351 * @addr: Interface address of the P2P client
1352 */
1353void p2p_group_notif_disassoc(struct p2p_group *group, const u8 *addr);
1354
1355/**
1356 * p2p_group_notif_formation_done - Notification of completed group formation
1357 * @group: P2P group context from p2p_group_init()
1358 */
1359void p2p_group_notif_formation_done(struct p2p_group *group);
1360
1361/**
1362 * p2p_group_notif_noa - Notification of NoA change
1363 * @group: P2P group context from p2p_group_init()
1364 * @noa: Notice of Absence attribute payload, %NULL if none
1365 * @noa_len: Length of noa buffer in octets
1366 * Returns: 0 on success, -1 on failure
1367 *
1368 * Notify the P2P group management about a new NoA contents. This will be
1369 * inserted into the P2P IEs in Beacon and Probe Response frames with rest of
1370 * the group information.
1371 */
1372int p2p_group_notif_noa(struct p2p_group *group, const u8 *noa,
1373 size_t noa_len);
1374
1375/**
1376 * p2p_group_match_dev_type - Match device types in group with requested type
1377 * @group: P2P group context from p2p_group_init()
1378 * @wps: WPS TLVs from Probe Request frame (concatenated WPS IEs)
1379 * Returns: 1 on match, 0 on mismatch
1380 *
1381 * This function can be used to match the Requested Device Type attribute in
1382 * WPS IE with the device types of a group member for deciding whether a GO
1383 * should reply to a Probe Request frame. Match will be reported if the WPS IE
1384 * is not requested any specific device type.
1385 */
1386int p2p_group_match_dev_type(struct p2p_group *group, struct wpabuf *wps);
1387
8017b538
JM
1388/**
1389 * p2p_group_match_dev_id - Match P2P Device Address in group with requested device id
1390 */
1391int p2p_group_match_dev_id(struct p2p_group *group, struct wpabuf *p2p);
1392
b22128ef
JM
1393/**
1394 * p2p_group_go_discover - Send GO Discoverability Request to a group client
1395 * @group: P2P group context from p2p_group_init()
1396 * Returns: 0 on success (frame scheduled); -1 if client was not found
1397 */
1398int p2p_group_go_discover(struct p2p_group *group, const u8 *dev_id,
1399 const u8 *searching_dev, int rx_freq);
1400
1401
1402/* Generic helper functions */
1403
1404/**
1405 * p2p_ie_text - Build text format description of P2P IE
1406 * @p2p_ie: P2P IE
1407 * @buf: Buffer for returning text
1408 * @end: Pointer to the end of the buf area
1409 * Returns: Number of octets written to the buffer or -1 on failure
1410 *
1411 * This function can be used to parse P2P IE contents into text format
1412 * field=value lines.
1413 */
1414int p2p_ie_text(struct wpabuf *p2p_ie, char *buf, char *end);
1415
1416/**
1417 * p2p_scan_result_text - Build text format description of P2P IE
1418 * @ies: Information elements from scan results
1419 * @ies_len: ies buffer length in octets
1420 * @buf: Buffer for returning text
1421 * @end: Pointer to the end of the buf area
1422 * Returns: Number of octets written to the buffer or -1 on failure
1423 *
1424 * This function can be used to parse P2P IE contents into text format
1425 * field=value lines.
1426 */
1427int p2p_scan_result_text(const u8 *ies, size_t ies_len, char *buf, char *end);
1428
c2d76aa6
MH
1429/**
1430 * p2p_parse_dev_addr_in_p2p_ie - Parse P2P Device Address from a concatenated
1431 * P2P IE
1432 * @p2p_ie: P2P IE
1433 * @dev_addr: Buffer for returning P2P Device Address
1434 * Returns: 0 on success or -1 if P2P Device Address could not be parsed
1435 */
1436int p2p_parse_dev_addr_in_p2p_ie(struct wpabuf *p2p_ie, u8 *dev_addr);
1437
0a70f34f
JM
1438/**
1439 * p2p_parse_dev_addr - Parse P2P Device Address from P2P IE(s)
1440 * @ies: Information elements from scan results
1441 * @ies_len: ies buffer length in octets
1442 * @dev_addr: Buffer for returning P2P Device Address
1443 * Returns: 0 on success or -1 if P2P Device Address could not be parsed
1444 */
1445int p2p_parse_dev_addr(const u8 *ies, size_t ies_len, u8 *dev_addr);
1446
b22128ef
JM
1447/**
1448 * p2p_assoc_req_ie - Build P2P IE for (Re)Association Request frame
1449 * @p2p: P2P module context from p2p_init()
1450 * @bssid: BSSID
1451 * @buf: Buffer for writing the P2P IE
1452 * @len: Maximum buf length in octets
1453 * @p2p_group: Whether this is for association with a P2P GO
4c08c0bd 1454 * @p2p_ie: Reassembled P2P IE data from scan results or %NULL if none
b22128ef
JM
1455 * Returns: Number of octets written into buf or -1 on failure
1456 */
1457int p2p_assoc_req_ie(struct p2p_data *p2p, const u8 *bssid, u8 *buf,
4c08c0bd 1458 size_t len, int p2p_group, struct wpabuf *p2p_ie);
b22128ef
JM
1459
1460/**
1461 * p2p_scan_ie - Build P2P IE for Probe Request
1462 * @p2p: P2P module context from p2p_init()
1463 * @ies: Buffer for writing P2P IE
6d92fa6e 1464 * @dev_id: Device ID to search for or %NULL for any
b22128ef 1465 */
6d92fa6e 1466void p2p_scan_ie(struct p2p_data *p2p, struct wpabuf *ies, const u8 *dev_id);
b22128ef 1467
206e1f42
JM
1468/**
1469 * p2p_scan_ie_buf_len - Get maximum buffer length needed for p2p_scan_ie
1470 * @p2p: P2P module context from p2p_init()
1471 * Returns: Number of octets that p2p_scan_ie() may add to the buffer
1472 */
1473size_t p2p_scan_ie_buf_len(struct p2p_data *p2p);
1474
b22128ef
JM
1475/**
1476 * p2p_go_params - Generate random P2P group parameters
1477 * @p2p: P2P module context from p2p_init()
1478 * @params: Buffer for parameters
1479 * Returns: 0 on success, -1 on failure
1480 */
1481int p2p_go_params(struct p2p_data *p2p, struct p2p_go_neg_results *params);
1482
1483/**
1484 * p2p_get_group_capab - Get Group Capability from P2P IE data
1485 * @p2p_ie: P2P IE(s) contents
1486 * Returns: Group Capability
1487 */
1488u8 p2p_get_group_capab(const struct wpabuf *p2p_ie);
1489
72044390
JM
1490/**
1491 * p2p_get_cross_connect_disallowed - Does WLAN AP disallows cross connection
1492 * @p2p_ie: P2P IE(s) contents
1493 * Returns: 0 if cross connection is allow, 1 if not
1494 */
1495int p2p_get_cross_connect_disallowed(const struct wpabuf *p2p_ie);
1496
b22128ef
JM
1497/**
1498 * p2p_get_go_dev_addr - Get P2P Device Address from P2P IE data
1499 * @p2p_ie: P2P IE(s) contents
1500 * Returns: Pointer to P2P Device Address or %NULL if not included
1501 */
1502const u8 * p2p_get_go_dev_addr(const struct wpabuf *p2p_ie);
1503
1504/**
b3ffc80b 1505 * p2p_get_peer_info - Get P2P peer information
b22128ef
JM
1506 * @p2p: P2P module context from p2p_init()
1507 * @addr: P2P Device Address of the peer or %NULL to indicate the first peer
1508 * @next: Whether to select the peer entry following the one indicated by addr
b3ffc80b
JM
1509 * Returns: Pointer to peer info or %NULL if not found
1510 */
1511const struct p2p_peer_info * p2p_get_peer_info(struct p2p_data *p2p,
1512 const u8 *addr, int next);
1513
1514/**
1515 * p2p_get_peer_info_txt - Get internal P2P peer information in text format
1516 * @info: Pointer to P2P peer info from p2p_get_peer_info()
b22128ef
JM
1517 * @buf: Buffer for returning text
1518 * @buflen: Maximum buffer length
1519 * Returns: Number of octets written to the buffer or -1 on failure
b3ffc80b
JM
1520 *
1521 * Note: This information is internal to the P2P module and subject to change.
1522 * As such, this should not really be used by external programs for purposes
1523 * other than debugging.
b22128ef 1524 */
b3ffc80b
JM
1525int p2p_get_peer_info_txt(const struct p2p_peer_info *info,
1526 char *buf, size_t buflen);
b22128ef 1527
b3bcc0f5
JM
1528/**
1529 * p2p_peer_known - Check whether P2P peer is known
1530 * @p2p: P2P module context from p2p_init()
1531 * @addr: P2P Device Address of the peer
1532 * Returns: 1 if the specified device is in the P2P peer table or 0 if not
1533 */
1534int p2p_peer_known(struct p2p_data *p2p, const u8 *addr);
1535
b22128ef
JM
1536/**
1537 * p2p_set_client_discoverability - Set client discoverability capability
1538 * @p2p: P2P module context from p2p_init()
1539 * @enabled: Whether client discoverability will be enabled
1540 *
1541 * This function can be used to disable (and re-enable) client discoverability.
1542 * This capability is enabled by default and should not be disabled in normal
1543 * use cases, i.e., this is mainly for testing purposes.
1544 */
1545void p2p_set_client_discoverability(struct p2p_data *p2p, int enabled);
1546
1547/**
a601f71b 1548 * p2p_set_managed_oper - Set managed P2P Device operations capability
b22128ef
JM
1549 * @p2p: P2P module context from p2p_init()
1550 * @enabled: Whether managed P2P Device operations will be enabled
1551 */
1552void p2p_set_managed_oper(struct p2p_data *p2p, int enabled);
1553
1554int p2p_set_listen_channel(struct p2p_data *p2p, u8 reg_class, u8 channel);
1555
1556int p2p_set_ssid_postfix(struct p2p_data *p2p, const u8 *postfix, size_t len);
1557
1558int p2p_get_interface_addr(struct p2p_data *p2p, const u8 *dev_addr,
1559 u8 *iface_addr);
4147a2cc
JM
1560int p2p_get_dev_addr(struct p2p_data *p2p, const u8 *iface_addr,
1561 u8 *dev_addr);
b22128ef 1562
80c9582a
JM
1563void p2p_set_peer_filter(struct p2p_data *p2p, const u8 *addr);
1564
72044390
JM
1565/**
1566 * p2p_set_cross_connect - Set cross connection capability
1567 * @p2p: P2P module context from p2p_init()
1568 * @enabled: Whether cross connection will be enabled
1569 */
1570void p2p_set_cross_connect(struct p2p_data *p2p, int enabled);
1571
f8d0131a
JM
1572int p2p_get_oper_freq(struct p2p_data *p2p, const u8 *iface_addr);
1573
0f66abd2
SS
1574/**
1575 * p2p_set_intra_bss_dist - Set intra BSS distribution
1576 * @p2p: P2P module context from p2p_init()
1577 * @enabled: Whether intra BSS distribution will be enabled
1578 */
1579void p2p_set_intra_bss_dist(struct p2p_data *p2p, int enabled);
1580
d054a462
JM
1581/**
1582 * p2p_supported_freq - Check whether channel is supported for P2P
1583 * @p2p: P2P module context from p2p_init()
1584 * @freq: Channel frequency in MHz
1585 * Returns: 0 if channel not usable for P2P, 1 if usable for P2P
1586 */
1587int p2p_supported_freq(struct p2p_data *p2p, unsigned int freq);
1588
b5c9da8d
JM
1589void p2p_update_channel_list(struct p2p_data *p2p, struct p2p_channels *chan);
1590
7cfc4ac3
AGS
1591/**
1592 * p2p_set_best_channels - Update best channel information
1593 * @p2p: P2P module context from p2p_init()
1594 * @freq_24: Frequency (MHz) of best channel in 2.4 GHz band
1595 * @freq_5: Frequency (MHz) of best channel in 5 GHz band
1596 * @freq_overall: Frequency (MHz) of best channel overall
1597 */
1598void p2p_set_best_channels(struct p2p_data *p2p, int freq_24, int freq_5,
1599 int freq_overall);
1600
231bbd03
SS
1601const u8 * p2p_get_go_neg_peer(struct p2p_data *p2p);
1602
5efa9e2a
JB
1603/**
1604 * p2p_get_group_num_members - Get number of members in group
1605 * @group: P2P group context from p2p_group_init()
1606 * Returns: Number of members in the group
1607 */
1608unsigned int p2p_get_group_num_members(struct p2p_group *group);
1609
1610/**
1611 * p2p_iterate_group_members - Iterate group members
1612 * @group: P2P group context from p2p_group_init()
1613 * @next: iteration pointer, must be a pointer to a void * that is set to %NULL
1614 * on the first call and not modified later
1615 * Returns: A P2P Interface Address for each call and %NULL for no more members
1616 */
1617const u8 * p2p_iterate_group_members(struct p2p_group *group, void **next);
1618
c9aab274
JJ
1619/**
1620 * p2p_group_get_dev_addr - Get a P2P Device Address of a client in a group
1621 * @group: P2P group context from p2p_group_init()
1622 * @addr: P2P Interface Address of the client
1623 * Returns: P2P Device Address of the client if found or %NULL if no match
1624 * found
1625 */
1626const u8 * p2p_group_get_dev_addr(struct p2p_group *group, const u8 *addr);
1627
1d277f02
JM
1628/**
1629 * p2p_group_is_client_connected - Check whether a specific client is connected
1630 * @group: P2P group context from p2p_group_init()
1631 * @addr: P2P Device Address of the client
1632 * Returns: 1 if client is connected or 0 if not
1633 */
1634int p2p_group_is_client_connected(struct p2p_group *group, const u8 *dev_addr);
1635
c165d81e
JB
1636/**
1637 * p2p_get_peer_found - Get P2P peer info structure of a found peer
1638 * @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
1641 * Returns: The first P2P peer info available or %NULL if no such peer exists
1642 */
1643const struct p2p_peer_info *
1644p2p_get_peer_found(struct p2p_data *p2p, const u8 *addr, int next);
1645
f95cac27
JMB
1646/**
1647 * p2p_remove_wps_vendor_extensions - Remove WPS vendor extensions
1648 * @p2p: P2P module context from p2p_init()
1649 */
1650void p2p_remove_wps_vendor_extensions(struct p2p_data *p2p);
1651
1652/**
1653 * p2p_add_wps_vendor_extension - Add a WPS vendor extension
1654 * @p2p: P2P module context from p2p_init()
1655 * @vendor_ext: The vendor extensions to add
1656 * Returns: 0 on success, -1 on failure
1657 *
1658 * The wpabuf structures in the array are owned by the P2P
1659 * module after this call.
1660 */
1661int p2p_add_wps_vendor_extension(struct p2p_data *p2p,
1662 const struct wpabuf *vendor_ext);
1663
2463ba70
JS
1664/**
1665 * p2p_set_oper_channel - Set the P2P operating channel
1666 * @p2p: P2P module context from p2p_init()
1667 * @op_reg_class: Operating regulatory class to set
1668 * @op_channel: operating channel to set
1669 * @cfg_op_channel : Whether op_channel is hardcoded in configuration
1670 * Returns: 0 on success, -1 on failure
1671 */
1672int p2p_set_oper_channel(struct p2p_data *p2p, u8 op_reg_class, u8 op_channel,
1673 int cfg_op_channel);
1674
21d996f7
JM
1675/**
1676 * p2p_set_pref_chan - Set P2P preferred channel list
1677 * @p2p: P2P module context from p2p_init()
1678 * @num_pref_chan: Number of entries in pref_chan list
1679 * @pref_chan: Preferred channels or %NULL to remove preferences
1680 * Returns: 0 on success, -1 on failure
1681 */
1682int p2p_set_pref_chan(struct p2p_data *p2p, unsigned int num_pref_chan,
1683 const struct p2p_channel *pref_chan);
1684
303f60d3
JM
1685/**
1686 * p2p_in_progress - Check whether a P2P operation is progress
1687 * @p2p: P2P module context from p2p_init()
1688 * Returns: 0 if P2P module is idle or 1 if an operation is in progress
1689 */
1690int p2p_in_progress(struct p2p_data *p2p);
1691
39185dfa
JM
1692/**
1693 * p2p_other_scan_completed - Notify completion of non-P2P scan
1694 * @p2p: P2P module context from p2p_init()
1695 * Returns: 0 if P2P module is idle or 1 if an operation was started
1696 */
1697int p2p_other_scan_completed(struct p2p_data *p2p);
1698
e5a359cf
RC
1699const char * p2p_wps_method_text(enum p2p_wps_method method);
1700
4f219667
JM
1701/**
1702 * p2p_set_config_timeout - Set local config timeouts
1703 * @p2p: P2P module context from p2p_init()
1704 * @go_timeout: Time in 10 ms units it takes to start the GO mode
1705 * @client_timeout: Time in 10 ms units it takes to start the client mode
1706 */
1707void p2p_set_config_timeout(struct p2p_data *p2p, u8 go_timeout,
1708 u8 client_timeout);
1709
b22128ef 1710#endif /* P2P_H */