2 * Wi-Fi Direct - P2P module
3 * Copyright (c) 2009-2010, Atheros Communications
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
12 #include "wps/wps_defs.h"
15 * P2P_MAX_REG_CLASSES - Maximum number of regulatory classes
17 #define P2P_MAX_REG_CLASSES 10
20 * P2P_MAX_REG_CLASS_CHANNELS - Maximum number of channels per regulatory class
22 #define P2P_MAX_REG_CLASS_CHANNELS 20
25 * struct p2p_channels - List of supported channels
29 * struct p2p_reg_class - Supported regulatory class
31 struct p2p_reg_class {
33 * reg_class - Regulatory class (IEEE 802.11-2007, Annex J)
38 * channel - Supported channels
40 u8 channel[P2P_MAX_REG_CLASS_CHANNELS];
43 * channels - Number of channel entries in use
46 } reg_class[P2P_MAX_REG_CLASSES];
49 * reg_classes - Number of reg_class entries in use
55 WPS_NOT_READY, WPS_PIN_DISPLAY, WPS_PIN_KEYPAD, WPS_PBC, WPS_NFC
59 * struct p2p_go_neg_results - P2P Group Owner Negotiation results
61 struct p2p_go_neg_results {
63 * status - Negotiation result (Status Code)
65 * 0 (P2P_SC_SUCCESS) indicates success. Non-zero values indicate
71 * role_go - Whether local end is Group Owner
76 * freq - Frequency of the group operational channel in MHz
85 * ssid - SSID of the group
90 * ssid_len - Length of SSID in octets
95 * psk - WPA pre-shared key (256 bits) (GO only)
100 * psk_set - Whether PSK field is configured (GO only)
105 * passphrase - WPA2-Personal passphrase for the group (GO only)
110 * peer_device_addr - P2P Device Address of the peer
112 u8 peer_device_addr[ETH_ALEN];
115 * peer_interface_addr - P2P Interface Address of the peer
117 u8 peer_interface_addr[ETH_ALEN];
120 * wps_method - WPS method to be used during provisioning
122 enum p2p_wps_method wps_method;
124 #define P2P_MAX_CHANNELS 50
127 * freq_list - Zero-terminated list of possible operational channels
129 int freq_list[P2P_MAX_CHANNELS];
132 * persistent_group - Whether the group should be made persistent
134 * 1 = persistent group without persistent reconnect
135 * 2 = persistent group with persistent reconnect
137 int persistent_group;
140 * peer_config_timeout - Peer configuration timeout (in 10 msec units)
142 unsigned int peer_config_timeout;
150 P2P_SCAN_SOCIAL_PLUS_ONE
153 #define P2P_MAX_WPS_VENDOR_EXT 10
156 * struct p2p_peer_info - P2P peer information
158 struct p2p_peer_info {
160 * p2p_device_addr - P2P Device Address of the peer
162 u8 p2p_device_addr[ETH_ALEN];
165 * pri_dev_type - Primary Device Type
170 * device_name - Device Name (0..32 octets encoded in UTF-8)
172 char device_name[33];
175 * manufacturer - Manufacturer (0..64 octets encoded in UTF-8)
177 char manufacturer[65];
180 * model_name - Model Name (0..32 octets encoded in UTF-8)
185 * model_number - Model Number (0..32 octets encoded in UTF-8)
187 char model_number[33];
190 * serial_number - Serial Number (0..32 octets encoded in UTF-8)
192 char serial_number[33];
195 * level - Signal level
200 * config_methods - WPS Configuration Methods
205 * dev_capab - Device Capabilities
210 * group_capab - Group Capabilities
215 * wps_sec_dev_type_list - WPS secondary device type list
217 * This list includes from 0 to 16 Secondary Device Types as indicated
218 * by wps_sec_dev_type_list_len (8 * number of types).
220 u8 wps_sec_dev_type_list[128];
223 * wps_sec_dev_type_list_len - Length of secondary device type list
225 size_t wps_sec_dev_type_list_len;
227 struct wpabuf *wps_vendor_ext[P2P_MAX_WPS_VENDOR_EXT];
230 * wfd_subelems - Wi-Fi Display subelements from WFD IE(s)
232 struct wpabuf *wfd_subelems;
235 * vendor_elems - Unrecognized vendor elements
237 * This buffer includes any other vendor element than P2P, WPS, and WFD
238 * IE(s) from the frame that was used to discover the peer.
240 struct wpabuf *vendor_elems;
243 enum p2p_prov_disc_status {
244 P2P_PROV_DISC_SUCCESS,
245 P2P_PROV_DISC_TIMEOUT,
246 P2P_PROV_DISC_REJECTED,
247 P2P_PROV_DISC_TIMEOUT_JOIN,
256 * struct p2p_config - P2P configuration
258 * This configuration is provided to the P2P module during initialization with
263 * country - Country code to use in P2P operations
268 * reg_class - Regulatory class for own listen channel
273 * channel - Own listen channel
278 * channel_forced - the listen channel was forced by configuration
279 * or by control interface and cannot be overridden
284 * Regulatory class for own operational channel
289 * op_channel - Own operational channel
294 * cfg_op_channel - Whether op_channel is hardcoded in configuration
299 * channels - Own supported regulatory classes and channels
301 * List of supposerted channels per regulatory class. The regulatory
302 * classes are defined in IEEE Std 802.11-2007 Annex J and the
303 * numbering of the clases depends on the configured country code.
305 struct p2p_channels channels;
308 * cli_channels - Additional client channels
310 * This list of channels (if any) will be used when advertising local
311 * channels during GO Negotiation or Invitation for the cases where the
312 * local end may become the client. This may allow the peer to become a
313 * GO on additional channels if it supports these options. The main use
314 * case for this is to include passive-scan channels on devices that may
315 * not know their current location and have configured most channels to
316 * not allow initiation of radition (i.e., another device needs to take
317 * master responsibilities).
319 struct p2p_channels cli_channels;
322 * num_pref_chan - Number of pref_chan entries
324 unsigned int num_pref_chan;
327 * pref_chan - Preferred channels for GO Negotiation
329 struct p2p_channel *pref_chan;
332 * pri_dev_type - Primary Device Type (see WPS)
337 * P2P_SEC_DEVICE_TYPES - Maximum number of secondary device types
339 #define P2P_SEC_DEVICE_TYPES 5
342 * sec_dev_type - Optional secondary device types
344 u8 sec_dev_type[P2P_SEC_DEVICE_TYPES][8];
347 * num_sec_dev_types - Number of sec_dev_type entries
349 size_t num_sec_dev_types;
352 * dev_addr - P2P Device Address
354 u8 dev_addr[ETH_ALEN];
357 * dev_name - Device Name
370 * concurrent_operations - Whether concurrent operations are supported
372 int concurrent_operations;
375 * max_peers - Maximum number of discovered peers to remember
377 * If more peers are discovered, older entries will be removed to make
378 * room for the new ones.
383 * p2p_intra_bss - Intra BSS communication is supported
388 * ssid_postfix - Postfix data to add to the SSID
390 * This data will be added to the end of the SSID after the
391 * DIRECT-<random two octets> prefix.
393 u8 ssid_postfix[32 - 9];
396 * ssid_postfix_len - Length of the ssid_postfix data
398 size_t ssid_postfix_len;
401 * max_listen - Maximum listen duration in ms
403 unsigned int max_listen;
406 * passphrase_len - Passphrase length (8..63)
408 * This parameter controls the length of the random passphrase that is
409 * generated at the GO.
411 unsigned int passphrase_len;
414 * cb_ctx - Context to use with callback functions
419 * debug_print - Debug print
420 * @ctx: Callback context from cb_ctx
421 * @level: Debug verbosity level (MSG_*)
422 * @msg: Debug message
424 void (*debug_print)(void *ctx, int level, const char *msg);
427 /* Callbacks to request lower layer driver operations */
430 * p2p_scan - Request a P2P scan/search
431 * @ctx: Callback context from cb_ctx
433 * @freq: Specific frequency (MHz) to scan or 0 for no restriction
434 * @num_req_dev_types: Number of requested device types
435 * @req_dev_types: Array containing requested device types
436 * @dev_id: Device ID to search for or %NULL to find all devices
437 * @pw_id: Device Password ID
438 * Returns: 0 on success, -1 on failure
440 * This callback function is used to request a P2P scan or search
441 * operation to be completed. Type type argument specifies which type
442 * of scan is to be done. @P2P_SCAN_SOCIAL indicates that only the
443 * social channels (1, 6, 11) should be scanned. @P2P_SCAN_FULL
444 * indicates that all channels are to be scanned.
445 * @P2P_SCAN_SOCIAL_PLUS_ONE request scan of all the social channels
446 * plus one extra channel specified by freq.
448 * The full scan is used for the initial scan to find group owners from
449 * all. The other types are used during search phase scan of the social
450 * channels (with potential variation if the Listen channel of the
451 * target peer is known or if other channels are scanned in steps).
453 * The scan results are returned after this call by calling
454 * p2p_scan_res_handler() for each scan result that has a P2P IE and
455 * then calling p2p_scan_res_handled() to indicate that all scan
456 * results have been indicated.
458 int (*p2p_scan)(void *ctx, enum p2p_scan_type type, int freq,
459 unsigned int num_req_dev_types,
460 const u8 *req_dev_types, const u8 *dev_id, u16 pw_id);
463 * send_probe_resp - Transmit a Probe Response frame
464 * @ctx: Callback context from cb_ctx
465 * @buf: Probe Response frame (including the header and body)
466 * Returns: 0 on success, -1 on failure
468 * This function is used to reply to Probe Request frames that were
469 * indicated with a call to p2p_probe_req_rx(). The response is to be
470 * sent on the same channel or to be dropped if the driver is not
471 * anymore listening to Probe Request frames.
473 * Alternatively, the responsibility for building the Probe Response
474 * frames in Listen state may be in another system component in which
475 * case this function need to be implemented (i.e., the function
476 * pointer can be %NULL). The WPS and P2P IEs to be added for Probe
477 * Response frames in such a case are available from the
478 * start_listen() callback. It should be noted that the received Probe
479 * Request frames must be indicated by calling p2p_probe_req_rx() even
480 * if this send_probe_resp() is not used.
482 int (*send_probe_resp)(void *ctx, const struct wpabuf *buf);
485 * send_action - Transmit an Action frame
486 * @ctx: Callback context from cb_ctx
487 * @freq: Frequency in MHz for the channel on which to transmit
488 * @dst: Destination MAC address (Address 1)
489 * @src: Source MAC address (Address 2)
490 * @bssid: BSSID (Address 3)
491 * @buf: Frame body (starting from Category field)
492 * @len: Length of buf in octets
493 * @wait_time: How many msec to wait for a response frame
494 * Returns: 0 on success, -1 on failure
496 * The Action frame may not be transmitted immediately and the status
497 * of the transmission must be reported by calling
498 * p2p_send_action_cb() once the frame has either been transmitted or
499 * it has been dropped due to excessive retries or other failure to
502 int (*send_action)(void *ctx, unsigned int freq, const u8 *dst,
503 const u8 *src, const u8 *bssid, const u8 *buf,
504 size_t len, unsigned int wait_time);
507 * send_action_done - Notify that Action frame sequence was completed
508 * @ctx: Callback context from cb_ctx
510 * This function is called when the Action frame sequence that was
511 * started with send_action() has been completed, i.e., when there is
512 * no need to wait for a response from the destination peer anymore.
514 void (*send_action_done)(void *ctx);
517 * start_listen - Start Listen state
518 * @ctx: Callback context from cb_ctx
519 * @freq: Frequency of the listen channel in MHz
520 * @duration: Duration for the Listen state in milliseconds
521 * @probe_resp_ie: IE(s) to be added to Probe Response frames
522 * Returns: 0 on success, -1 on failure
524 * This Listen state may not start immediately since the driver may
525 * have other pending operations to complete first. Once the Listen
526 * state has started, p2p_listen_cb() must be called to notify the P2P
527 * module. Once the Listen state is stopped, p2p_listen_end() must be
528 * called to notify the P2P module that the driver is not in the Listen
531 * If the send_probe_resp() is not used for generating the response,
532 * the IEs from probe_resp_ie need to be added to the end of the Probe
533 * Response frame body. If send_probe_resp() is used, the probe_resp_ie
534 * information can be ignored.
536 int (*start_listen)(void *ctx, unsigned int freq,
537 unsigned int duration,
538 const struct wpabuf *probe_resp_ie);
540 * stop_listen - Stop Listen state
541 * @ctx: Callback context from cb_ctx
543 * This callback can be used to stop a Listen state operation that was
544 * previously requested with start_listen().
546 void (*stop_listen)(void *ctx);
549 * get_noa - Get current Notice of Absence attribute payload
550 * @ctx: Callback context from cb_ctx
551 * @interface_addr: P2P Interface Address of the GO
552 * @buf: Buffer for returning NoA
553 * @buf_len: Buffer length in octets
554 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
555 * advertized, or -1 on failure
557 * This function is used to fetch the current Notice of Absence
558 * attribute value from GO.
560 int (*get_noa)(void *ctx, const u8 *interface_addr, u8 *buf,
563 /* Callbacks to notify events to upper layer management entity */
566 * dev_found - Notification of a found P2P Device
567 * @ctx: Callback context from cb_ctx
568 * @addr: Source address of the message triggering this notification
569 * @info: P2P peer information
570 * @new_device: Inform if the peer is newly found
572 * This callback is used to notify that a new P2P Device has been
573 * found. This may happen, e.g., during Search state based on scan
574 * results or during Listen state based on receive Probe Request and
575 * Group Owner Negotiation Request.
577 void (*dev_found)(void *ctx, const u8 *addr,
578 const struct p2p_peer_info *info,
582 * dev_lost - Notification of a lost P2P Device
583 * @ctx: Callback context from cb_ctx
584 * @dev_addr: P2P Device Address of the lost P2P Device
586 * This callback is used to notify that a P2P Device has been deleted.
588 void (*dev_lost)(void *ctx, const u8 *dev_addr);
591 * find_stopped - Notification of a p2p_find operation stopping
592 * @ctx: Callback context from cb_ctx
594 void (*find_stopped)(void *ctx);
597 * go_neg_req_rx - Notification of a receive GO Negotiation Request
598 * @ctx: Callback context from cb_ctx
599 * @src: Source address of the message triggering this notification
600 * @dev_passwd_id: WPS Device Password ID
602 * This callback is used to notify that a P2P Device is requesting
603 * group owner negotiation with us, but we do not have all the
604 * necessary information to start GO Negotiation. This indicates that
605 * the local user has not authorized the connection yet by providing a
606 * PIN or PBC button press. This information can be provided with a
607 * call to p2p_connect().
609 void (*go_neg_req_rx)(void *ctx, const u8 *src, u16 dev_passwd_id);
612 * go_neg_completed - Notification of GO Negotiation results
613 * @ctx: Callback context from cb_ctx
614 * @res: GO Negotiation results
616 * This callback is used to notify that Group Owner Negotiation has
617 * been completed. Non-zero struct p2p_go_neg_results::status indicates
618 * failed negotiation. In case of success, this function is responsible
619 * for creating a new group interface (or using the existing interface
620 * depending on driver features), setting up the group interface in
621 * proper mode based on struct p2p_go_neg_results::role_go and
622 * initializing WPS provisioning either as a Registrar (if GO) or as an
623 * Enrollee. Successful WPS provisioning must be indicated by calling
624 * p2p_wps_success_cb(). The callee is responsible for timing out group
625 * formation if WPS provisioning cannot be completed successfully
628 void (*go_neg_completed)(void *ctx, struct p2p_go_neg_results *res);
631 * sd_request - Callback on Service Discovery Request
632 * @ctx: Callback context from cb_ctx
633 * @freq: Frequency (in MHz) of the channel
634 * @sa: Source address of the request
635 * @dialog_token: Dialog token
636 * @update_indic: Service Update Indicator from the source of request
637 * @tlvs: P2P Service Request TLV(s)
638 * @tlvs_len: Length of tlvs buffer in octets
640 * This callback is used to indicate reception of a service discovery
641 * request. Response to the query must be indicated by calling
642 * p2p_sd_response() with the context information from the arguments to
643 * this callback function.
645 * This callback handler can be set to %NULL to indicate that service
646 * discovery is not supported.
648 void (*sd_request)(void *ctx, int freq, const u8 *sa, u8 dialog_token,
649 u16 update_indic, const u8 *tlvs, size_t tlvs_len);
652 * sd_response - Callback on Service Discovery Response
653 * @ctx: Callback context from cb_ctx
654 * @sa: Source address of the request
655 * @update_indic: Service Update Indicator from the source of response
656 * @tlvs: P2P Service Response TLV(s)
657 * @tlvs_len: Length of tlvs buffer in octets
659 * This callback is used to indicate reception of a service discovery
660 * response. This callback handler can be set to %NULL if no service
661 * discovery requests are used. The information provided with this call
662 * is replies to the queries scheduled with p2p_sd_request().
664 void (*sd_response)(void *ctx, const u8 *sa, u16 update_indic,
665 const u8 *tlvs, size_t tlvs_len);
668 * prov_disc_req - Callback on Provisiong Discovery Request
669 * @ctx: Callback context from cb_ctx
670 * @peer: Source address of the request
671 * @config_methods: Requested WPS Config Method
672 * @dev_addr: P2P Device Address of the found P2P Device
673 * @pri_dev_type: Primary Device Type
674 * @dev_name: Device Name
675 * @supp_config_methods: Supported configuration Methods
676 * @dev_capab: Device Capabilities
677 * @group_capab: Group Capabilities
678 * @group_id: P2P Group ID (or %NULL if not included)
679 * @group_id_len: Length of P2P Group ID
681 * This callback is used to indicate reception of a Provision Discovery
682 * Request frame that the P2P module accepted.
684 void (*prov_disc_req)(void *ctx, const u8 *peer, u16 config_methods,
685 const u8 *dev_addr, const u8 *pri_dev_type,
686 const char *dev_name, u16 supp_config_methods,
687 u8 dev_capab, u8 group_capab,
688 const u8 *group_id, size_t group_id_len);
691 * prov_disc_resp - Callback on Provisiong Discovery Response
692 * @ctx: Callback context from cb_ctx
693 * @peer: Source address of the response
694 * @config_methods: Value from p2p_prov_disc_req() or 0 on failure
696 * This callback is used to indicate reception of a Provision Discovery
697 * Response frame for a pending request scheduled with
698 * p2p_prov_disc_req(). This callback handler can be set to %NULL if
699 * provision discovery is not used.
701 void (*prov_disc_resp)(void *ctx, const u8 *peer, u16 config_methods);
704 * prov_disc_fail - Callback on Provision Discovery failure
705 * @ctx: Callback context from cb_ctx
706 * @peer: Source address of the response
707 * @status: Cause of failure, will not be %P2P_PROV_DISC_SUCCESS
709 * This callback is used to indicate either a failure or no response
710 * to an earlier provision discovery request.
712 * This callback handler can be set to %NULL if provision discovery
713 * is not used or failures do not need to be indicated.
715 void (*prov_disc_fail)(void *ctx, const u8 *peer,
716 enum p2p_prov_disc_status status);
719 * invitation_process - Optional callback for processing Invitations
720 * @ctx: Callback context from cb_ctx
721 * @sa: Source address of the Invitation Request
722 * @bssid: P2P Group BSSID from the request or %NULL if not included
723 * @go_dev_addr: GO Device Address from P2P Group ID
724 * @ssid: SSID from P2P Group ID
725 * @ssid_len: Length of ssid buffer in octets
726 * @go: Variable for returning whether the local end is GO in the group
727 * @group_bssid: Buffer for returning P2P Group BSSID (if local end GO)
728 * @force_freq: Variable for returning forced frequency for the group
729 * @persistent_group: Whether this is an invitation to reinvoke a
730 * persistent group (instead of invitation to join an active
732 * @channels: Available operating channels for the group
733 * @dev_pw_id: Device Password ID for NFC static handover or -1 if not
735 * Returns: Status code (P2P_SC_*)
737 * This optional callback can be used to implement persistent reconnect
738 * by allowing automatic restarting of persistent groups without user
739 * interaction. If this callback is not implemented (i.e., is %NULL),
740 * the received Invitation Request frames are replied with
741 * %P2P_SC_REQ_RECEIVED status and indicated to upper layer with the
742 * invitation_result() callback.
744 * If the requested parameters are acceptable and the group is known,
745 * %P2P_SC_SUCCESS may be returned. If the requested group is unknown,
746 * %P2P_SC_FAIL_UNKNOWN_GROUP should be returned. %P2P_SC_REQ_RECEIVED
747 * can be returned if there is not enough data to provide immediate
748 * response, i.e., if some sort of user interaction is needed. The
749 * invitation_received() callback will be called in that case
750 * immediately after this call.
752 u8 (*invitation_process)(void *ctx, const u8 *sa, const u8 *bssid,
753 const u8 *go_dev_addr, const u8 *ssid,
754 size_t ssid_len, int *go, u8 *group_bssid,
755 int *force_freq, int persistent_group,
756 const struct p2p_channels *channels,
760 * invitation_received - Callback on Invitation Request RX
761 * @ctx: Callback context from cb_ctx
762 * @sa: Source address of the Invitation Request
763 * @bssid: P2P Group BSSID or %NULL if not received
764 * @ssid: SSID of the group
765 * @ssid_len: Length of ssid in octets
766 * @go_dev_addr: GO Device Address
767 * @status: Response Status
768 * @op_freq: Operational frequency for the group
770 * This callback is used to indicate sending of an Invitation Response
771 * for a received Invitation Request. If status == 0 (success), the
772 * upper layer code is responsible for starting the group. status == 1
773 * indicates need to get user authorization for the group. Other status
774 * values indicate that the invitation request was rejected.
776 void (*invitation_received)(void *ctx, const u8 *sa, const u8 *bssid,
777 const u8 *ssid, size_t ssid_len,
778 const u8 *go_dev_addr, u8 status,
782 * invitation_result - Callback on Invitation result
783 * @ctx: Callback context from cb_ctx
784 * @status: Negotiation result (Status Code)
785 * @bssid: P2P Group BSSID or %NULL if not received
786 * @channels: Available operating channels for the group
787 * @addr: Peer address
788 * @freq: Frequency (in MHz) indicated during invitation or 0
789 * @peer_oper_freq: Operating frequency (in MHz) advertized by the peer
790 * during invitation or 0
792 * This callback is used to indicate result of an Invitation procedure
793 * started with a call to p2p_invite(). The indicated status code is
794 * the value received from the peer in Invitation Response with 0
795 * (P2P_SC_SUCCESS) indicating success or -1 to indicate a timeout or a
796 * local failure in transmitting the Invitation Request.
798 void (*invitation_result)(void *ctx, int status, const u8 *bssid,
799 const struct p2p_channels *channels,
800 const u8 *addr, int freq, int peer_oper_freq);
803 * go_connected - Check whether we are connected to a GO
804 * @ctx: Callback context from cb_ctx
805 * @dev_addr: P2P Device Address of a GO
806 * Returns: 1 if we are connected as a P2P client to the specified GO
809 int (*go_connected)(void *ctx, const u8 *dev_addr);
812 * presence_resp - Callback on Presence Response
813 * @ctx: Callback context from cb_ctx
814 * @src: Source address (GO's P2P Interface Address)
815 * @status: Result of the request (P2P_SC_*)
816 * @noa: Returned NoA value
817 * @noa_len: Length of the NoA buffer in octets
819 void (*presence_resp)(void *ctx, const u8 *src, u8 status,
820 const u8 *noa, size_t noa_len);
823 * is_concurrent_session_active - Check whether concurrent session is
824 * active on other virtual interfaces
825 * @ctx: Callback context from cb_ctx
826 * Returns: 1 if concurrent session is active on other virtual interface
829 int (*is_concurrent_session_active)(void *ctx);
832 * is_p2p_in_progress - Check whether P2P operation is in progress
833 * @ctx: Callback context from cb_ctx
834 * Returns: 1 if P2P operation (e.g., group formation) is in progress
837 int (*is_p2p_in_progress)(void *ctx);
841 /* P2P module initialization/deinitialization */
844 * p2p_init - Initialize P2P module
845 * @cfg: P2P module configuration
846 * Returns: Pointer to private data or %NULL on failure
848 * This function is used to initialize global P2P module context (one per
849 * device). The P2P module will keep a copy of the configuration data, so the
850 * caller does not need to maintain this structure. However, the callback
851 * functions and the context parameters to them must be kept available until
852 * the P2P module is deinitialized with p2p_deinit().
854 struct p2p_data * p2p_init(const struct p2p_config *cfg);
857 * p2p_deinit - Deinitialize P2P module
858 * @p2p: P2P module context from p2p_init()
860 void p2p_deinit(struct p2p_data *p2p);
863 * p2p_flush - Flush P2P module state
864 * @p2p: P2P module context from p2p_init()
866 * This command removes the P2P module state like peer device entries.
868 void p2p_flush(struct p2p_data *p2p);
871 * p2p_unauthorize - Unauthorize the specified peer device
872 * @p2p: P2P module context from p2p_init()
873 * @addr: P2P peer entry to be unauthorized
874 * Returns: 0 on success, -1 on failure
876 * This command removes any connection authorization from the specified P2P
877 * peer device address. This can be used, e.g., to cancel effect of a previous
878 * p2p_authorize() or p2p_connect() call that has not yet resulted in completed
881 int p2p_unauthorize(struct p2p_data *p2p, const u8 *addr);
884 * p2p_set_dev_name - Set device name
885 * @p2p: P2P module context from p2p_init()
886 * Returns: 0 on success, -1 on failure
888 * This function can be used to update the P2P module configuration with
889 * information that was not available at the time of the p2p_init() call.
891 int p2p_set_dev_name(struct p2p_data *p2p, const char *dev_name);
893 int p2p_set_manufacturer(struct p2p_data *p2p, const char *manufacturer);
894 int p2p_set_model_name(struct p2p_data *p2p, const char *model_name);
895 int p2p_set_model_number(struct p2p_data *p2p, const char *model_number);
896 int p2p_set_serial_number(struct p2p_data *p2p, const char *serial_number);
898 void p2p_set_config_methods(struct p2p_data *p2p, u16 config_methods);
899 void p2p_set_uuid(struct p2p_data *p2p, const u8 *uuid);
902 * p2p_set_pri_dev_type - Set primary device type
903 * @p2p: P2P module context from p2p_init()
904 * Returns: 0 on success, -1 on failure
906 * This function can be used to update the P2P module configuration with
907 * information that was not available at the time of the p2p_init() call.
909 int p2p_set_pri_dev_type(struct p2p_data *p2p, const u8 *pri_dev_type);
912 * p2p_set_sec_dev_types - Set secondary device types
913 * @p2p: P2P module context from p2p_init()
914 * Returns: 0 on success, -1 on failure
916 * This function can be used to update the P2P module configuration with
917 * information that was not available at the time of the p2p_init() call.
919 int p2p_set_sec_dev_types(struct p2p_data *p2p, const u8 dev_types[][8],
920 size_t num_dev_types);
922 int p2p_set_country(struct p2p_data *p2p, const char *country);
925 /* Commands from upper layer management entity */
927 enum p2p_discovery_type {
928 P2P_FIND_START_WITH_FULL,
929 P2P_FIND_ONLY_SOCIAL,
934 * p2p_find - Start P2P Find (Device Discovery)
935 * @p2p: P2P module context from p2p_init()
936 * @timeout: Timeout for find operation in seconds or 0 for no timeout
937 * @type: Device Discovery type
938 * @num_req_dev_types: Number of requested device types
939 * @req_dev_types: Requested device types array, must be an array
940 * containing num_req_dev_types * WPS_DEV_TYPE_LEN bytes; %NULL if no
941 * requested device types.
942 * @dev_id: Device ID to search for or %NULL to find all devices
943 * @search_delay: Extra delay in milliseconds between search iterations
944 * Returns: 0 on success, -1 on failure
946 int p2p_find(struct p2p_data *p2p, unsigned int timeout,
947 enum p2p_discovery_type type,
948 unsigned int num_req_dev_types, const u8 *req_dev_types,
949 const u8 *dev_id, unsigned int search_delay);
952 * p2p_notify_scan_trigger_status - Indicate scan trigger status
953 * @p2p: P2P module context from p2p_init()
954 * @status: 0 on success, -1 on failure
956 void p2p_notify_scan_trigger_status(struct p2p_data *p2p, int status);
959 * p2p_stop_find - Stop P2P Find (Device Discovery)
960 * @p2p: P2P module context from p2p_init()
962 void p2p_stop_find(struct p2p_data *p2p);
965 * p2p_stop_find_for_freq - Stop P2P Find for next oper on specific freq
966 * @p2p: P2P module context from p2p_init()
967 * @freq: Frequency in MHz for next operation
969 * This is like p2p_stop_find(), but Listen state is not stopped if we are
970 * already on the same frequency.
972 void p2p_stop_find_for_freq(struct p2p_data *p2p, int freq);
975 * p2p_listen - Start P2P Listen state for specified duration
976 * @p2p: P2P module context from p2p_init()
977 * @timeout: Listen state duration in milliseconds
978 * Returns: 0 on success, -1 on failure
980 * This function can be used to request the P2P module to keep the device
981 * discoverable on the listen channel for an extended set of time. At least in
982 * its current form, this is mainly used for testing purposes and may not be of
983 * much use for normal P2P operations.
985 int p2p_listen(struct p2p_data *p2p, unsigned int timeout);
988 * p2p_stop_listen - Stop P2P Listen
989 * @p2p: P2P module context from p2p_init()
991 void p2p_stop_listen(struct p2p_data *p2p);
994 * p2p_connect - Start P2P group formation (GO negotiation)
995 * @p2p: P2P module context from p2p_init()
996 * @peer_addr: MAC address of the peer P2P client
997 * @wps_method: WPS method to be used in provisioning
998 * @go_intent: Local GO intent value (1..15)
999 * @own_interface_addr: Intended interface address to use with the group
1000 * @force_freq: The only allowed channel frequency in MHz or 0
1001 * @persistent_group: Whether to create a persistent group (0 = no, 1 =
1002 * persistent group without persistent reconnect, 2 = persistent group with
1003 * persistent reconnect)
1004 * @force_ssid: Forced SSID for the group if we become GO or %NULL to generate
1006 * @force_ssid_len: Length of $force_ssid buffer
1007 * @pd_before_go_neg: Whether to send Provision Discovery prior to GO
1008 * Negotiation as an interoperability workaround when initiating group
1010 * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if
1012 * Returns: 0 on success, -1 on failure
1014 int p2p_connect(struct p2p_data *p2p, const u8 *peer_addr,
1015 enum p2p_wps_method wps_method,
1016 int go_intent, const u8 *own_interface_addr,
1017 unsigned int force_freq, int persistent_group,
1018 const u8 *force_ssid, size_t force_ssid_len,
1019 int pd_before_go_neg, unsigned int pref_freq, u16 oob_pw_id);
1022 * p2p_authorize - Authorize P2P group formation (GO negotiation)
1023 * @p2p: P2P module context from p2p_init()
1024 * @peer_addr: MAC address of the peer P2P client
1025 * @wps_method: WPS method to be used in provisioning
1026 * @go_intent: Local GO intent value (1..15)
1027 * @own_interface_addr: Intended interface address to use with the group
1028 * @force_freq: The only allowed channel frequency in MHz or 0
1029 * @persistent_group: Whether to create a persistent group (0 = no, 1 =
1030 * persistent group without persistent reconnect, 2 = persistent group with
1031 * persistent reconnect)
1032 * @force_ssid: Forced SSID for the group if we become GO or %NULL to generate
1034 * @force_ssid_len: Length of $force_ssid buffer
1035 * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if
1037 * Returns: 0 on success, -1 on failure
1039 * This is like p2p_connect(), but the actual group negotiation is not
1040 * initiated automatically, i.e., the other end is expected to do that.
1042 int p2p_authorize(struct p2p_data *p2p, const u8 *peer_addr,
1043 enum p2p_wps_method wps_method,
1044 int go_intent, const u8 *own_interface_addr,
1045 unsigned int force_freq, int persistent_group,
1046 const u8 *force_ssid, size_t force_ssid_len,
1047 unsigned int pref_freq, u16 oob_pw_id);
1050 * p2p_reject - Reject peer device (explicitly block connection attempts)
1051 * @p2p: P2P module context from p2p_init()
1052 * @peer_addr: MAC address of the peer P2P client
1053 * Returns: 0 on success, -1 on failure
1055 int p2p_reject(struct p2p_data *p2p, const u8 *peer_addr);
1058 * p2p_prov_disc_req - Send Provision Discovery Request
1059 * @p2p: P2P module context from p2p_init()
1060 * @peer_addr: MAC address of the peer P2P client
1061 * @config_methods: WPS Config Methods value (only one bit set)
1062 * @join: Whether this is used by a client joining an active group
1063 * @force_freq: Forced TX frequency for the frame (mainly for the join case)
1064 * @user_initiated_pd: Flag to indicate if initiated by user or not
1065 * Returns: 0 on success, -1 on failure
1067 * This function can be used to request a discovered P2P peer to display a PIN
1068 * (config_methods = WPS_CONFIG_DISPLAY) or be prepared to enter a PIN from us
1069 * (config_methods = WPS_CONFIG_KEYPAD). The Provision Discovery Request frame
1070 * is transmitted once immediately and if no response is received, the frame
1071 * will be sent again whenever the target device is discovered during device
1072 * dsicovery (start with a p2p_find() call). Response from the peer is
1073 * indicated with the p2p_config::prov_disc_resp() callback.
1075 int p2p_prov_disc_req(struct p2p_data *p2p, const u8 *peer_addr,
1076 u16 config_methods, int join, int force_freq,
1077 int user_initiated_pd);
1080 * p2p_sd_request - Schedule a service discovery query
1081 * @p2p: P2P module context from p2p_init()
1082 * @dst: Destination peer or %NULL to apply for all peers
1083 * @tlvs: P2P Service Query TLV(s)
1084 * Returns: Reference to the query or %NULL on failure
1086 * Response to the query is indicated with the p2p_config::sd_response()
1089 void * p2p_sd_request(struct p2p_data *p2p, const u8 *dst,
1090 const struct wpabuf *tlvs);
1092 #ifdef CONFIG_WIFI_DISPLAY
1093 void * p2p_sd_request_wfd(struct p2p_data *p2p, const u8 *dst,
1094 const struct wpabuf *tlvs);
1095 #endif /* CONFIG_WIFI_DISPLAY */
1098 * p2p_sd_cancel_request - Cancel a pending service discovery query
1099 * @p2p: P2P module context from p2p_init()
1100 * @req: Query reference from p2p_sd_request()
1101 * Returns: 0 if request for cancelled; -1 if not found
1103 int p2p_sd_cancel_request(struct p2p_data *p2p, void *req);
1106 * p2p_sd_response - Send response to a service discovery query
1107 * @p2p: P2P module context from p2p_init()
1108 * @freq: Frequency from p2p_config::sd_request() callback
1109 * @dst: Destination address from p2p_config::sd_request() callback
1110 * @dialog_token: Dialog token from p2p_config::sd_request() callback
1111 * @resp_tlvs: P2P Service Response TLV(s)
1113 * This function is called as a response to the request indicated with
1114 * p2p_config::sd_request() callback.
1116 void p2p_sd_response(struct p2p_data *p2p, int freq, const u8 *dst,
1117 u8 dialog_token, const struct wpabuf *resp_tlvs);
1120 * p2p_sd_service_update - Indicate a change in local services
1121 * @p2p: P2P module context from p2p_init()
1123 * This function needs to be called whenever there is a change in availability
1124 * of the local services. This will increment the Service Update Indicator
1125 * value which will be used in SD Request and Response frames.
1127 void p2p_sd_service_update(struct p2p_data *p2p);
1130 enum p2p_invite_role {
1132 P2P_INVITE_ROLE_ACTIVE_GO,
1133 P2P_INVITE_ROLE_CLIENT
1137 * p2p_invite - Invite a P2P Device into a group
1138 * @p2p: P2P module context from p2p_init()
1139 * @peer: Device Address of the peer P2P Device
1140 * @role: Local role in the group
1141 * @bssid: Group BSSID or %NULL if not known
1143 * @ssid_len: Length of ssid in octets
1144 * @force_freq: The only allowed channel frequency in MHz or 0
1145 * @go_dev_addr: Forced GO Device Address or %NULL if none
1146 * @persistent_group: Whether this is to reinvoke a persistent group
1147 * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if
1149 * @dev_pw_id: Device Password ID from OOB Device Password (NFC) static handover
1150 * case or -1 if not used
1151 * Returns: 0 on success, -1 on failure
1153 int p2p_invite(struct p2p_data *p2p, const u8 *peer, enum p2p_invite_role role,
1154 const u8 *bssid, const u8 *ssid, size_t ssid_len,
1155 unsigned int force_freq, const u8 *go_dev_addr,
1156 int persistent_group, unsigned int pref_freq, int dev_pw_id);
1159 * p2p_presence_req - Request GO presence
1160 * @p2p: P2P module context from p2p_init()
1161 * @go_interface_addr: GO P2P Interface Address
1162 * @own_interface_addr: Own P2P Interface Address for this group
1163 * @freq: Group operating frequence (in MHz)
1164 * @duration1: Preferred presence duration in microseconds
1165 * @interval1: Preferred presence interval in microseconds
1166 * @duration2: Acceptable presence duration in microseconds
1167 * @interval2: Acceptable presence interval in microseconds
1168 * Returns: 0 on success, -1 on failure
1170 * If both duration and interval values are zero, the parameter pair is not
1171 * specified (i.e., to remove Presence Request, use duration1 = interval1 = 0).
1173 int p2p_presence_req(struct p2p_data *p2p, const u8 *go_interface_addr,
1174 const u8 *own_interface_addr, unsigned int freq,
1175 u32 duration1, u32 interval1, u32 duration2,
1179 * p2p_ext_listen - Set Extended Listen Timing
1180 * @p2p: P2P module context from p2p_init()
1181 * @freq: Group operating frequence (in MHz)
1182 * @period: Availability period in milliseconds (1-65535; 0 to disable)
1183 * @interval: Availability interval in milliseconds (1-65535; 0 to disable)
1184 * Returns: 0 on success, -1 on failure
1186 * This function can be used to enable or disable (period = interval = 0)
1187 * Extended Listen Timing. When enabled, the P2P Device will become
1188 * discoverable (go into Listen State) every @interval milliseconds for at
1189 * least @period milliseconds.
1191 int p2p_ext_listen(struct p2p_data *p2p, unsigned int period,
1192 unsigned int interval);
1194 /* Event notifications from upper layer management operations */
1197 * p2p_wps_success_cb - Report successfully completed WPS provisioning
1198 * @p2p: P2P module context from p2p_init()
1199 * @mac_addr: Peer address
1201 * This function is used to report successfully completed WPS provisioning
1202 * during group formation in both GO/Registrar and client/Enrollee roles.
1204 void p2p_wps_success_cb(struct p2p_data *p2p, const u8 *mac_addr);
1207 * p2p_group_formation_failed - Report failed WPS provisioning
1208 * @p2p: P2P module context from p2p_init()
1210 * This function is used to report failed group formation. This can happen
1211 * either due to failed WPS provisioning or due to 15 second timeout during
1212 * the provisioning phase.
1214 void p2p_group_formation_failed(struct p2p_data *p2p);
1217 * p2p_get_provisioning_info - Get any stored provisioning info
1218 * @p2p: P2P module context from p2p_init()
1219 * @addr: Peer P2P Device Address
1220 * Returns: WPS provisioning information (WPS config method) or 0 if no
1221 * information is available
1223 * This function is used to retrieve stored WPS provisioning info for the given
1226 u16 p2p_get_provisioning_info(struct p2p_data *p2p, const u8 *addr);
1229 * p2p_clear_provisioning_info - Clear any stored provisioning info
1230 * @p2p: P2P module context from p2p_init()
1231 * @iface_addr: Peer P2P Device Address
1233 * This function is used to clear stored WPS provisioning info for the given
1236 void p2p_clear_provisioning_info(struct p2p_data *p2p, const u8 *addr);
1239 /* Event notifications from lower layer driver operations */
1242 * enum p2p_probe_req_status
1244 * @P2P_PREQ_MALFORMED: frame was not well-formed
1245 * @P2P_PREQ_NOT_LISTEN: device isn't in listen state, frame ignored
1246 * @P2P_PREQ_NOT_P2P: frame was not a P2P probe request
1247 * @P2P_PREQ_P2P_NOT_PROCESSED: frame was P2P but wasn't processed
1248 * @P2P_PREQ_P2P_PROCESSED: frame has been processed by P2P
1250 enum p2p_probe_req_status {
1252 P2P_PREQ_NOT_LISTEN,
1254 P2P_PREQ_NOT_PROCESSED,
1259 * p2p_probe_req_rx - Report reception of a Probe Request frame
1260 * @p2p: P2P module context from p2p_init()
1261 * @addr: Source MAC address
1262 * @dst: Destination MAC address if available or %NULL
1263 * @bssid: BSSID if available or %NULL
1264 * @ie: Information elements from the Probe Request frame body
1265 * @ie_len: Length of ie buffer in octets
1266 * Returns: value indicating the type and status of the probe request
1268 enum p2p_probe_req_status
1269 p2p_probe_req_rx(struct p2p_data *p2p, const u8 *addr, const u8 *dst,
1270 const u8 *bssid, const u8 *ie, size_t ie_len);
1273 * p2p_rx_action - Report received Action frame
1274 * @p2p: P2P module context from p2p_init()
1275 * @da: Destination address of the received Action frame
1276 * @sa: Source address of the received Action frame
1277 * @bssid: Address 3 of the received Action frame
1278 * @category: Category of the received Action frame
1279 * @data: Action frame body after the Category field
1280 * @len: Length of the data buffer in octets
1281 * @freq: Frequency (in MHz) on which the frame was received
1283 void p2p_rx_action(struct p2p_data *p2p, const u8 *da, const u8 *sa,
1284 const u8 *bssid, u8 category,
1285 const u8 *data, size_t len, int freq);
1288 * p2p_scan_res_handler - Indicate a P2P scan results
1289 * @p2p: P2P module context from p2p_init()
1290 * @bssid: BSSID of the scan result
1291 * @freq: Frequency of the channel on which the device was found in MHz
1292 * @rx_time: Time when the result was received
1293 * @level: Signal level (signal strength of the received Beacon/Probe Response
1295 * @ies: Pointer to IEs from the scan result
1296 * @ies_len: Length of the ies buffer
1297 * Returns: 0 to continue or 1 to stop scan result indication
1299 * This function is called to indicate a scan result entry with P2P IE from a
1300 * scan requested with struct p2p_config::p2p_scan(). This can be called during
1301 * the actual scan process (i.e., whenever a new device is found) or as a
1302 * sequence of calls after the full scan has been completed. The former option
1303 * can result in optimized operations, but may not be supported by all
1304 * driver/firmware designs. The ies buffer need to include at least the P2P IE,
1305 * but it is recommended to include all IEs received from the device. The
1306 * caller does not need to check that the IEs contain a P2P IE before calling
1307 * this function since frames will be filtered internally if needed.
1309 * This function will return 1 if it wants to stop scan result iteration (and
1310 * scan in general if it is still in progress). This is used to allow faster
1311 * start of a pending operation, e.g., to start a pending GO negotiation.
1313 int p2p_scan_res_handler(struct p2p_data *p2p, const u8 *bssid, int freq,
1314 struct os_reltime *rx_time, int level, const u8 *ies,
1318 * p2p_scan_res_handled - Indicate end of scan results
1319 * @p2p: P2P module context from p2p_init()
1321 * This function is called to indicate that all P2P scan results from a scan
1322 * have been reported with zero or more calls to p2p_scan_res_handler(). This
1323 * function must be called as a response to successful
1324 * struct p2p_config::p2p_scan() call if none of the p2p_scan_res_handler()
1325 * calls stopped iteration.
1327 void p2p_scan_res_handled(struct p2p_data *p2p);
1329 enum p2p_send_action_result {
1330 P2P_SEND_ACTION_SUCCESS /* Frame was send and acknowledged */,
1331 P2P_SEND_ACTION_NO_ACK /* Frame was sent, but not acknowledged */,
1332 P2P_SEND_ACTION_FAILED /* Frame was not sent due to a failure */
1336 * p2p_send_action_cb - Notify TX status of an Action frame
1337 * @p2p: P2P module context from p2p_init()
1338 * @freq: Channel frequency in MHz
1339 * @dst: Destination MAC address (Address 1)
1340 * @src: Source MAC address (Address 2)
1341 * @bssid: BSSID (Address 3)
1342 * @result: Result of the transmission attempt
1344 * This function is used to indicate the result of an Action frame transmission
1345 * that was requested with struct p2p_config::send_action() callback.
1347 void p2p_send_action_cb(struct p2p_data *p2p, unsigned int freq, const u8 *dst,
1348 const u8 *src, const u8 *bssid,
1349 enum p2p_send_action_result result);
1352 * p2p_listen_cb - Indicate the start of a requested Listen state
1353 * @p2p: P2P module context from p2p_init()
1354 * @freq: Listen channel frequency in MHz
1355 * @duration: Duration for the Listen state in milliseconds
1357 * This function is used to indicate that a Listen state requested with
1358 * struct p2p_config::start_listen() callback has started.
1360 void p2p_listen_cb(struct p2p_data *p2p, unsigned int freq,
1361 unsigned int duration);
1364 * p2p_listen_end - Indicate the end of a requested Listen state
1365 * @p2p: P2P module context from p2p_init()
1366 * @freq: Listen channel frequency in MHz
1367 * Returns: 0 if no operations were started, 1 if an operation was started
1369 * This function is used to indicate that a Listen state requested with
1370 * struct p2p_config::start_listen() callback has ended.
1372 int p2p_listen_end(struct p2p_data *p2p, unsigned int freq);
1374 void p2p_deauth_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code,
1375 const u8 *ie, size_t ie_len);
1377 void p2p_disassoc_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code,
1378 const u8 *ie, size_t ie_len);
1381 /* Per-group P2P state for GO */
1386 * struct p2p_group_config - P2P group configuration
1388 * This configuration is provided to the P2P module during initialization of
1389 * the per-group information with p2p_group_init().
1391 struct p2p_group_config {
1393 * persistent_group - Whether the group is persistent
1394 * 0 = not a persistent group
1395 * 1 = persistent group without persistent reconnect
1396 * 2 = persistent group with persistent reconnect
1398 int persistent_group;
1401 * interface_addr - P2P Interface Address of the group
1403 u8 interface_addr[ETH_ALEN];
1406 * max_clients - Maximum number of clients in the group
1408 unsigned int max_clients;
1416 * ssid_len - Length of SSID
1421 * freq - Operating channel of the group
1426 * cb_ctx - Context to use with callback functions
1431 * ie_update - Notification of IE update
1432 * @ctx: Callback context from cb_ctx
1433 * @beacon_ies: P2P IE for Beacon frames or %NULL if no change
1434 * @proberesp_ies: P2P Ie for Probe Response frames
1436 * P2P module uses this callback function to notify whenever the P2P IE
1437 * in Beacon or Probe Response frames should be updated based on group
1440 * The callee is responsible for freeing the returned buffer(s) with
1443 void (*ie_update)(void *ctx, struct wpabuf *beacon_ies,
1444 struct wpabuf *proberesp_ies);
1447 * idle_update - Notification of changes in group idle state
1448 * @ctx: Callback context from cb_ctx
1449 * @idle: Whether the group is idle (no associated stations)
1451 void (*idle_update)(void *ctx, int idle);
1455 * p2p_group_init - Initialize P2P group
1456 * @p2p: P2P module context from p2p_init()
1457 * @config: P2P group configuration (will be freed by p2p_group_deinit())
1458 * Returns: Pointer to private data or %NULL on failure
1460 * This function is used to initialize per-group P2P module context. Currently,
1461 * this is only used to manage GO functionality and P2P clients do not need to
1462 * create an instance of this per-group information.
1464 struct p2p_group * p2p_group_init(struct p2p_data *p2p,
1465 struct p2p_group_config *config);
1468 * p2p_group_deinit - Deinitialize P2P group
1469 * @group: P2P group context from p2p_group_init()
1471 void p2p_group_deinit(struct p2p_group *group);
1474 * p2p_group_notif_assoc - Notification of P2P client association with GO
1475 * @group: P2P group context from p2p_group_init()
1476 * @addr: Interface address of the P2P client
1477 * @ie: IEs from the (Re)association Request frame
1478 * @len: Length of the ie buffer in octets
1479 * Returns: 0 on success, -1 on failure
1481 int p2p_group_notif_assoc(struct p2p_group *group, const u8 *addr,
1482 const u8 *ie, size_t len);
1485 * p2p_group_assoc_resp_ie - Build P2P IE for (re)association response
1486 * @group: P2P group context from p2p_group_init()
1487 * @status: Status value (P2P_SC_SUCCESS if association succeeded)
1488 * Returns: P2P IE for (Re)association Response or %NULL on failure
1490 * The caller is responsible for freeing the returned buffer with
1493 struct wpabuf * p2p_group_assoc_resp_ie(struct p2p_group *group, u8 status);
1496 * p2p_group_notif_disassoc - Notification of P2P client disassociation from GO
1497 * @group: P2P group context from p2p_group_init()
1498 * @addr: Interface address of the P2P client
1500 void p2p_group_notif_disassoc(struct p2p_group *group, const u8 *addr);
1503 * p2p_group_notif_formation_done - Notification of completed group formation
1504 * @group: P2P group context from p2p_group_init()
1506 void p2p_group_notif_formation_done(struct p2p_group *group);
1509 * p2p_group_notif_noa - Notification of NoA change
1510 * @group: P2P group context from p2p_group_init()
1511 * @noa: Notice of Absence attribute payload, %NULL if none
1512 * @noa_len: Length of noa buffer in octets
1513 * Returns: 0 on success, -1 on failure
1515 * Notify the P2P group management about a new NoA contents. This will be
1516 * inserted into the P2P IEs in Beacon and Probe Response frames with rest of
1517 * the group information.
1519 int p2p_group_notif_noa(struct p2p_group *group, const u8 *noa,
1523 * p2p_group_match_dev_type - Match device types in group with requested type
1524 * @group: P2P group context from p2p_group_init()
1525 * @wps: WPS TLVs from Probe Request frame (concatenated WPS IEs)
1526 * Returns: 1 on match, 0 on mismatch
1528 * This function can be used to match the Requested Device Type attribute in
1529 * WPS IE with the device types of a group member for deciding whether a GO
1530 * should reply to a Probe Request frame. Match will be reported if the WPS IE
1531 * is not requested any specific device type.
1533 int p2p_group_match_dev_type(struct p2p_group *group, struct wpabuf *wps);
1536 * p2p_group_match_dev_id - Match P2P Device Address in group with requested device id
1538 int p2p_group_match_dev_id(struct p2p_group *group, struct wpabuf *p2p);
1541 * p2p_group_go_discover - Send GO Discoverability Request to a group client
1542 * @group: P2P group context from p2p_group_init()
1543 * Returns: 0 on success (frame scheduled); -1 if client was not found
1545 int p2p_group_go_discover(struct p2p_group *group, const u8 *dev_id,
1546 const u8 *searching_dev, int rx_freq);
1549 /* Generic helper functions */
1552 * p2p_ie_text - Build text format description of P2P IE
1554 * @buf: Buffer for returning text
1555 * @end: Pointer to the end of the buf area
1556 * Returns: Number of octets written to the buffer or -1 on failure
1558 * This function can be used to parse P2P IE contents into text format
1559 * field=value lines.
1561 int p2p_ie_text(struct wpabuf *p2p_ie, char *buf, char *end);
1564 * p2p_scan_result_text - Build text format description of P2P IE
1565 * @ies: Information elements from scan results
1566 * @ies_len: ies buffer length in octets
1567 * @buf: Buffer for returning text
1568 * @end: Pointer to the end of the buf area
1569 * Returns: Number of octets written to the buffer or -1 on failure
1571 * This function can be used to parse P2P IE contents into text format
1572 * field=value lines.
1574 int p2p_scan_result_text(const u8 *ies, size_t ies_len, char *buf, char *end);
1577 * p2p_parse_dev_addr_in_p2p_ie - Parse P2P Device Address from a concatenated
1580 * @dev_addr: Buffer for returning P2P Device Address
1581 * Returns: 0 on success or -1 if P2P Device Address could not be parsed
1583 int p2p_parse_dev_addr_in_p2p_ie(struct wpabuf *p2p_ie, u8 *dev_addr);
1586 * p2p_parse_dev_addr - Parse P2P Device Address from P2P IE(s)
1587 * @ies: Information elements from scan results
1588 * @ies_len: ies buffer length in octets
1589 * @dev_addr: Buffer for returning P2P Device Address
1590 * Returns: 0 on success or -1 if P2P Device Address could not be parsed
1592 int p2p_parse_dev_addr(const u8 *ies, size_t ies_len, u8 *dev_addr);
1595 * p2p_assoc_req_ie - Build P2P IE for (Re)Association Request frame
1596 * @p2p: P2P module context from p2p_init()
1598 * @buf: Buffer for writing the P2P IE
1599 * @len: Maximum buf length in octets
1600 * @p2p_group: Whether this is for association with a P2P GO
1601 * @p2p_ie: Reassembled P2P IE data from scan results or %NULL if none
1602 * Returns: Number of octets written into buf or -1 on failure
1604 int p2p_assoc_req_ie(struct p2p_data *p2p, const u8 *bssid, u8 *buf,
1605 size_t len, int p2p_group, struct wpabuf *p2p_ie);
1608 * p2p_scan_ie - Build P2P IE for Probe Request
1609 * @p2p: P2P module context from p2p_init()
1610 * @ies: Buffer for writing P2P IE
1611 * @dev_id: Device ID to search for or %NULL for any
1613 void p2p_scan_ie(struct p2p_data *p2p, struct wpabuf *ies, const u8 *dev_id);
1616 * p2p_scan_ie_buf_len - Get maximum buffer length needed for p2p_scan_ie
1617 * @p2p: P2P module context from p2p_init()
1618 * Returns: Number of octets that p2p_scan_ie() may add to the buffer
1620 size_t p2p_scan_ie_buf_len(struct p2p_data *p2p);
1623 * p2p_go_params - Generate random P2P group parameters
1624 * @p2p: P2P module context from p2p_init()
1625 * @params: Buffer for parameters
1626 * Returns: 0 on success, -1 on failure
1628 int p2p_go_params(struct p2p_data *p2p, struct p2p_go_neg_results *params);
1631 * p2p_get_group_capab - Get Group Capability from P2P IE data
1632 * @p2p_ie: P2P IE(s) contents
1633 * Returns: Group Capability
1635 u8 p2p_get_group_capab(const struct wpabuf *p2p_ie);
1638 * p2p_get_cross_connect_disallowed - Does WLAN AP disallows cross connection
1639 * @p2p_ie: P2P IE(s) contents
1640 * Returns: 0 if cross connection is allow, 1 if not
1642 int p2p_get_cross_connect_disallowed(const struct wpabuf *p2p_ie);
1645 * p2p_get_go_dev_addr - Get P2P Device Address from P2P IE data
1646 * @p2p_ie: P2P IE(s) contents
1647 * Returns: Pointer to P2P Device Address or %NULL if not included
1649 const u8 * p2p_get_go_dev_addr(const struct wpabuf *p2p_ie);
1652 * p2p_get_peer_info - Get P2P peer information
1653 * @p2p: P2P module context from p2p_init()
1654 * @addr: P2P Device Address of the peer or %NULL to indicate the first peer
1655 * @next: Whether to select the peer entry following the one indicated by addr
1656 * Returns: Pointer to peer info or %NULL if not found
1658 const struct p2p_peer_info * p2p_get_peer_info(struct p2p_data *p2p,
1659 const u8 *addr, int next);
1662 * p2p_get_peer_info_txt - Get internal P2P peer information in text format
1663 * @info: Pointer to P2P peer info from p2p_get_peer_info()
1664 * @buf: Buffer for returning text
1665 * @buflen: Maximum buffer length
1666 * Returns: Number of octets written to the buffer or -1 on failure
1668 * Note: This information is internal to the P2P module and subject to change.
1669 * As such, this should not really be used by external programs for purposes
1670 * other than debugging.
1672 int p2p_get_peer_info_txt(const struct p2p_peer_info *info,
1673 char *buf, size_t buflen);
1676 * p2p_peer_known - Check whether P2P peer is known
1677 * @p2p: P2P module context from p2p_init()
1678 * @addr: P2P Device Address of the peer
1679 * Returns: 1 if the specified device is in the P2P peer table or 0 if not
1681 int p2p_peer_known(struct p2p_data *p2p, const u8 *addr);
1684 * p2p_set_client_discoverability - Set client discoverability capability
1685 * @p2p: P2P module context from p2p_init()
1686 * @enabled: Whether client discoverability will be enabled
1688 * This function can be used to disable (and re-enable) client discoverability.
1689 * This capability is enabled by default and should not be disabled in normal
1690 * use cases, i.e., this is mainly for testing purposes.
1692 void p2p_set_client_discoverability(struct p2p_data *p2p, int enabled);
1695 * p2p_set_managed_oper - Set managed P2P Device operations capability
1696 * @p2p: P2P module context from p2p_init()
1697 * @enabled: Whether managed P2P Device operations will be enabled
1699 void p2p_set_managed_oper(struct p2p_data *p2p, int enabled);
1702 * p2p_config_get_random_social - Return a random social channel
1704 * @op_class: Selected operating class
1705 * @op_channel: Selected social channel
1706 * Returns: 0 on success, -1 on failure
1708 * This function is used before p2p_init is called. A random social channel
1709 * from supports bands 2.4 GHz (channels 1,6,11) and 60 GHz (channel 2) is
1710 * returned on success.
1712 int p2p_config_get_random_social(struct p2p_config *p2p, u8 *op_class,
1715 int p2p_set_listen_channel(struct p2p_data *p2p, u8 reg_class, u8 channel,
1718 u8 p2p_get_listen_channel(struct p2p_data *p2p);
1720 int p2p_set_ssid_postfix(struct p2p_data *p2p, const u8 *postfix, size_t len);
1722 int p2p_get_interface_addr(struct p2p_data *p2p, const u8 *dev_addr,
1724 int p2p_get_dev_addr(struct p2p_data *p2p, const u8 *iface_addr,
1727 void p2p_set_peer_filter(struct p2p_data *p2p, const u8 *addr);
1730 * p2p_set_cross_connect - Set cross connection capability
1731 * @p2p: P2P module context from p2p_init()
1732 * @enabled: Whether cross connection will be enabled
1734 void p2p_set_cross_connect(struct p2p_data *p2p, int enabled);
1736 int p2p_get_oper_freq(struct p2p_data *p2p, const u8 *iface_addr);
1739 * p2p_set_intra_bss_dist - Set intra BSS distribution
1740 * @p2p: P2P module context from p2p_init()
1741 * @enabled: Whether intra BSS distribution will be enabled
1743 void p2p_set_intra_bss_dist(struct p2p_data *p2p, int enabled);
1745 int p2p_channels_includes_freq(const struct p2p_channels *channels,
1748 int p2p_channels_to_freqs(const struct p2p_channels *channels,
1749 int *freq_list, unsigned int max_len);
1752 * p2p_supported_freq - Check whether channel is supported for P2P
1753 * @p2p: P2P module context from p2p_init()
1754 * @freq: Channel frequency in MHz
1755 * Returns: 0 if channel not usable for P2P, 1 if usable for P2P
1757 int p2p_supported_freq(struct p2p_data *p2p, unsigned int freq);
1760 * p2p_supported_freq_go - Check whether channel is supported for P2P GO operation
1761 * @p2p: P2P module context from p2p_init()
1762 * @freq: Channel frequency in MHz
1763 * Returns: 0 if channel not usable for P2P, 1 if usable for P2P
1765 int p2p_supported_freq_go(struct p2p_data *p2p, unsigned int freq);
1768 * p2p_supported_freq_cli - Check whether channel is supported for P2P client operation
1769 * @p2p: P2P module context from p2p_init()
1770 * @freq: Channel frequency in MHz
1771 * Returns: 0 if channel not usable for P2P, 1 if usable for P2P
1773 int p2p_supported_freq_cli(struct p2p_data *p2p, unsigned int freq);
1776 * p2p_get_pref_freq - Get channel from preferred channel list
1777 * @p2p: P2P module context from p2p_init()
1778 * @channels: List of channels
1779 * Returns: Preferred channel
1781 unsigned int p2p_get_pref_freq(struct p2p_data *p2p,
1782 const struct p2p_channels *channels);
1784 void p2p_update_channel_list(struct p2p_data *p2p,
1785 const struct p2p_channels *chan,
1786 const struct p2p_channels *cli_chan);
1789 * p2p_set_best_channels - Update best channel information
1790 * @p2p: P2P module context from p2p_init()
1791 * @freq_24: Frequency (MHz) of best channel in 2.4 GHz band
1792 * @freq_5: Frequency (MHz) of best channel in 5 GHz band
1793 * @freq_overall: Frequency (MHz) of best channel overall
1795 void p2p_set_best_channels(struct p2p_data *p2p, int freq_24, int freq_5,
1799 * p2p_set_own_freq_preference - Set own preference for channel
1800 * @p2p: P2P module context from p2p_init()
1801 * @freq: Frequency (MHz) of the preferred channel or 0 if no preference
1803 * This function can be used to set a preference on the operating channel based
1804 * on frequencies used on the other virtual interfaces that share the same
1805 * radio. If non-zero, this is used to try to avoid multi-channel concurrency.
1807 void p2p_set_own_freq_preference(struct p2p_data *p2p, int freq);
1809 const u8 * p2p_get_go_neg_peer(struct p2p_data *p2p);
1812 * p2p_get_group_num_members - Get number of members in group
1813 * @group: P2P group context from p2p_group_init()
1814 * Returns: Number of members in the group
1816 unsigned int p2p_get_group_num_members(struct p2p_group *group);
1819 * p2p_iterate_group_members - Iterate group members
1820 * @group: P2P group context from p2p_group_init()
1821 * @next: iteration pointer, must be a pointer to a void * that is set to %NULL
1822 * on the first call and not modified later
1823 * Returns: A P2P Device Address for each call and %NULL for no more members
1825 const u8 * p2p_iterate_group_members(struct p2p_group *group, void **next);
1828 * p2p_group_get_dev_addr - Get a P2P Device Address of a client in a group
1829 * @group: P2P group context from p2p_group_init()
1830 * @addr: P2P Interface Address of the client
1831 * Returns: P2P Device Address of the client if found or %NULL if no match
1834 const u8 * p2p_group_get_dev_addr(struct p2p_group *group, const u8 *addr);
1837 * p2p_group_is_client_connected - Check whether a specific client is connected
1838 * @group: P2P group context from p2p_group_init()
1839 * @addr: P2P Device Address of the client
1840 * Returns: 1 if client is connected or 0 if not
1842 int p2p_group_is_client_connected(struct p2p_group *group, const u8 *dev_addr);
1845 * p2p_group_get_config - Get the group configuration
1846 * @group: P2P group context from p2p_group_init()
1847 * Returns: The group configuration pointer
1849 const struct p2p_group_config * p2p_group_get_config(struct p2p_group *group);
1852 * p2p_loop_on_all_groups - Run the given callback on all groups
1853 * @p2p: P2P module context from p2p_init()
1854 * @group_callback: The callback function pointer
1855 * @user_data: Some user data pointer which can be %NULL
1857 * The group_callback function can stop the iteration by returning 0.
1859 void p2p_loop_on_all_groups(struct p2p_data *p2p,
1860 int (*group_callback)(struct p2p_group *group,
1865 * p2p_get_peer_found - Get P2P peer info structure of a found peer
1866 * @p2p: P2P module context from p2p_init()
1867 * @addr: P2P Device Address of the peer or %NULL to indicate the first peer
1868 * @next: Whether to select the peer entry following the one indicated by addr
1869 * Returns: The first P2P peer info available or %NULL if no such peer exists
1871 const struct p2p_peer_info *
1872 p2p_get_peer_found(struct p2p_data *p2p, const u8 *addr, int next);
1875 * p2p_remove_wps_vendor_extensions - Remove WPS vendor extensions
1876 * @p2p: P2P module context from p2p_init()
1878 void p2p_remove_wps_vendor_extensions(struct p2p_data *p2p);
1881 * p2p_add_wps_vendor_extension - Add a WPS vendor extension
1882 * @p2p: P2P module context from p2p_init()
1883 * @vendor_ext: The vendor extensions to add
1884 * Returns: 0 on success, -1 on failure
1886 * The wpabuf structures in the array are owned by the P2P
1887 * module after this call.
1889 int p2p_add_wps_vendor_extension(struct p2p_data *p2p,
1890 const struct wpabuf *vendor_ext);
1893 * p2p_set_oper_channel - Set the P2P operating channel
1894 * @p2p: P2P module context from p2p_init()
1895 * @op_reg_class: Operating regulatory class to set
1896 * @op_channel: operating channel to set
1897 * @cfg_op_channel : Whether op_channel is hardcoded in configuration
1898 * Returns: 0 on success, -1 on failure
1900 int p2p_set_oper_channel(struct p2p_data *p2p, u8 op_reg_class, u8 op_channel,
1901 int cfg_op_channel);
1904 * p2p_set_pref_chan - Set P2P preferred channel list
1905 * @p2p: P2P module context from p2p_init()
1906 * @num_pref_chan: Number of entries in pref_chan list
1907 * @pref_chan: Preferred channels or %NULL to remove preferences
1908 * Returns: 0 on success, -1 on failure
1910 int p2p_set_pref_chan(struct p2p_data *p2p, unsigned int num_pref_chan,
1911 const struct p2p_channel *pref_chan);
1914 * p2p_set_no_go_freq - Set no GO channel ranges
1915 * @p2p: P2P module context from p2p_init()
1916 * @list: Channel ranges or %NULL to remove restriction
1917 * Returns: 0 on success, -1 on failure
1919 int p2p_set_no_go_freq(struct p2p_data *p2p,
1920 const struct wpa_freq_range_list *list);
1923 * p2p_in_progress - Check whether a P2P operation is progress
1924 * @p2p: P2P module context from p2p_init()
1925 * Returns: 0 if P2P module is idle, 1 if an operation is in progress but not
1926 * in search state, or 2 if search state operation is in progress
1928 int p2p_in_progress(struct p2p_data *p2p);
1930 const char * p2p_wps_method_text(enum p2p_wps_method method);
1933 * p2p_set_config_timeout - Set local config timeouts
1934 * @p2p: P2P module context from p2p_init()
1935 * @go_timeout: Time in 10 ms units it takes to start the GO mode
1936 * @client_timeout: Time in 10 ms units it takes to start the client mode
1938 void p2p_set_config_timeout(struct p2p_data *p2p, u8 go_timeout,
1941 int p2p_set_wfd_ie_beacon(struct p2p_data *p2p, struct wpabuf *ie);
1942 int p2p_set_wfd_ie_probe_req(struct p2p_data *p2p, struct wpabuf *ie);
1943 int p2p_set_wfd_ie_probe_resp(struct p2p_data *p2p, struct wpabuf *ie);
1944 int p2p_set_wfd_ie_assoc_req(struct p2p_data *p2p, struct wpabuf *ie);
1945 int p2p_set_wfd_ie_invitation(struct p2p_data *p2p, struct wpabuf *ie);
1946 int p2p_set_wfd_ie_prov_disc_req(struct p2p_data *p2p, struct wpabuf *ie);
1947 int p2p_set_wfd_ie_prov_disc_resp(struct p2p_data *p2p, struct wpabuf *ie);
1948 int p2p_set_wfd_ie_go_neg(struct p2p_data *p2p, struct wpabuf *ie);
1949 int p2p_set_wfd_dev_info(struct p2p_data *p2p, const struct wpabuf *elem);
1950 int p2p_set_wfd_assoc_bssid(struct p2p_data *p2p, const struct wpabuf *elem);
1951 int p2p_set_wfd_coupled_sink_info(struct p2p_data *p2p,
1952 const struct wpabuf *elem);
1953 struct wpabuf * wifi_display_encaps(struct wpabuf *subelems);
1956 * p2p_set_disc_int - Set min/max discoverable interval for p2p_find
1957 * @p2p: P2P module context from p2p_init()
1958 * @min_disc_int: minDiscoverableInterval (in units of 100 TU); default 1
1959 * @max_disc_int: maxDiscoverableInterval (in units of 100 TU); default 3
1960 * @max_disc_tu: Maximum number of TUs (1.024 ms) for discoverable interval; or
1962 * Returns: 0 on success, or -1 on failure
1964 * This function can be used to configure minDiscoverableInterval and
1965 * maxDiscoverableInterval parameters for the Listen state during device
1966 * discovery (p2p_find). A random number of 100 TU units is picked for each
1967 * Listen state iteration from [min_disc_int,max_disc_int] range.
1969 * max_disc_tu can be used to futher limit the discoverable duration. However,
1970 * it should be noted that use of this parameter is not recommended since it
1971 * would not be compliant with the P2P specification.
1973 int p2p_set_disc_int(struct p2p_data *p2p, int min_disc_int, int max_disc_int,
1977 * p2p_get_state_txt - Get current P2P state for debug purposes
1978 * @p2p: P2P module context from p2p_init()
1979 * Returns: Name of the current P2P module state
1981 * It should be noted that the P2P module state names are internal information
1982 * and subject to change at any point, i.e., this information should be used
1983 * mainly for debugging purposes.
1985 const char * p2p_get_state_txt(struct p2p_data *p2p);
1987 struct wpabuf * p2p_build_nfc_handover_req(struct p2p_data *p2p,
1989 const u8 *go_dev_addr,
1990 const u8 *ssid, size_t ssid_len);
1991 struct wpabuf * p2p_build_nfc_handover_sel(struct p2p_data *p2p,
1993 const u8 *go_dev_addr,
1994 const u8 *ssid, size_t ssid_len);
1996 struct p2p_nfc_params {
2004 NO_ACTION, JOIN_GROUP, AUTH_JOIN, INIT_GO_NEG, RESP_GO_NEG,
2005 BOTH_GO, PEER_CLIENT
2007 struct p2p_peer_info *peer;
2008 u8 oob_dev_pw[WPS_OOB_PUBKEY_HASH_LEN + 2 +
2009 WPS_OOB_DEVICE_PASSWORD_LEN];
2010 size_t oob_dev_pw_len;
2012 u8 go_dev_addr[ETH_ALEN];
2017 int p2p_process_nfc_connection_handover(struct p2p_data *p2p,
2018 struct p2p_nfc_params *params);
2020 void p2p_set_authorized_oob_dev_pw_id(struct p2p_data *p2p, u16 dev_pw_id,
2022 const u8 *own_interface_addr);
2024 int p2p_set_passphrase_len(struct p2p_data *p2p, unsigned int len);
2026 void p2p_loop_on_known_peers(struct p2p_data *p2p,
2027 void (*peer_callback)(struct p2p_peer_info *peer,
2031 void p2p_set_vendor_elems(struct p2p_data *p2p, struct wpabuf **vendor_elem);