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