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"
14 /* P2P ASP Setup Capability */
15 #define P2PS_SETUP_NONE 0
16 #define P2PS_SETUP_NEW BIT(0)
17 #define P2PS_SETUP_CLIENT BIT(1)
18 #define P2PS_SETUP_GROUP_OWNER BIT(2)
20 #define P2PS_WILD_HASH_STR "org.wi-fi.wfds"
21 #define P2PS_HASH_LEN 6
22 #define P2P_MAX_QUERY_HASH 6
25 * P2P_MAX_REG_CLASSES - Maximum number of regulatory classes
27 #define P2P_MAX_REG_CLASSES 10
30 * P2P_MAX_REG_CLASS_CHANNELS - Maximum number of channels per regulatory class
32 #define P2P_MAX_REG_CLASS_CHANNELS 20
35 * struct p2p_channels - List of supported channels
39 * struct p2p_reg_class - Supported regulatory class
41 struct p2p_reg_class {
43 * reg_class - Regulatory class (IEEE 802.11-2007, Annex J)
48 * channel - Supported channels
50 u8 channel[P2P_MAX_REG_CLASS_CHANNELS];
53 * channels - Number of channel entries in use
56 } reg_class[P2P_MAX_REG_CLASSES];
59 * reg_classes - Number of reg_class entries in use
65 WPS_NOT_READY, WPS_PIN_DISPLAY, WPS_PIN_KEYPAD, WPS_PBC, WPS_NFC,
70 * struct p2p_go_neg_results - P2P Group Owner Negotiation results
72 struct p2p_go_neg_results {
74 * status - Negotiation result (Status Code)
76 * 0 (P2P_SC_SUCCESS) indicates success. Non-zero values indicate
82 * role_go - Whether local end is Group Owner
87 * freq - Frequency of the group operational channel in MHz
96 * ssid - SSID of the group
101 * ssid_len - Length of SSID in octets
106 * psk - WPA pre-shared key (256 bits) (GO only)
111 * psk_set - Whether PSK field is configured (GO only)
116 * passphrase - WPA2-Personal passphrase for the group (GO only)
121 * peer_device_addr - P2P Device Address of the peer
123 u8 peer_device_addr[ETH_ALEN];
126 * peer_interface_addr - P2P Interface Address of the peer
128 u8 peer_interface_addr[ETH_ALEN];
131 * wps_method - WPS method to be used during provisioning
133 enum p2p_wps_method wps_method;
135 #define P2P_MAX_CHANNELS 50
138 * freq_list - Zero-terminated list of possible operational channels
140 int freq_list[P2P_MAX_CHANNELS];
143 * persistent_group - Whether the group should be made persistent
145 * 1 = persistent group without persistent reconnect
146 * 2 = persistent group with persistent reconnect
148 int persistent_group;
151 * peer_config_timeout - Peer configuration timeout (in 10 msec units)
153 unsigned int peer_config_timeout;
156 struct p2ps_advertisement {
157 struct p2ps_advertisement *next;
160 * svc_info - Pointer to (internal) Service defined information
165 * id - P2PS Advertisement ID
170 * config_methods - WPS Methods which are allowed for this service
175 * state - Current state of the service: 0 - Out Of Service, 1-255 Vendor defined
180 * auto_accept - Automatically Accept provisioning request if possible.
185 * hash - 6 octet Service Name has to match against incoming Probe Requests
187 u8 hash[P2PS_HASH_LEN];
190 * svc_name - NULL Terminated UTF-8 Service Name, and svc_info storage
201 P2P_SCAN_SOCIAL_PLUS_ONE
204 #define P2P_MAX_WPS_VENDOR_EXT 10
207 * struct p2p_peer_info - P2P peer information
209 struct p2p_peer_info {
211 * p2p_device_addr - P2P Device Address of the peer
213 u8 p2p_device_addr[ETH_ALEN];
216 * pri_dev_type - Primary Device Type
221 * device_name - Device Name (0..32 octets encoded in UTF-8)
223 char device_name[33];
226 * manufacturer - Manufacturer (0..64 octets encoded in UTF-8)
228 char manufacturer[65];
231 * model_name - Model Name (0..32 octets encoded in UTF-8)
236 * model_number - Model Number (0..32 octets encoded in UTF-8)
238 char model_number[33];
241 * serial_number - Serial Number (0..32 octets encoded in UTF-8)
243 char serial_number[33];
246 * level - Signal level
251 * config_methods - WPS Configuration Methods
256 * dev_capab - Device Capabilities
261 * group_capab - Group Capabilities
266 * wps_sec_dev_type_list - WPS secondary device type list
268 * This list includes from 0 to 16 Secondary Device Types as indicated
269 * by wps_sec_dev_type_list_len (8 * number of types).
271 u8 wps_sec_dev_type_list[128];
274 * wps_sec_dev_type_list_len - Length of secondary device type list
276 size_t wps_sec_dev_type_list_len;
278 struct wpabuf *wps_vendor_ext[P2P_MAX_WPS_VENDOR_EXT];
281 * wfd_subelems - Wi-Fi Display subelements from WFD IE(s)
283 struct wpabuf *wfd_subelems;
286 * vendor_elems - Unrecognized vendor elements
288 * This buffer includes any other vendor element than P2P, WPS, and WFD
289 * IE(s) from the frame that was used to discover the peer.
291 struct wpabuf *vendor_elems;
294 enum p2p_prov_disc_status {
295 P2P_PROV_DISC_SUCCESS,
296 P2P_PROV_DISC_TIMEOUT,
297 P2P_PROV_DISC_REJECTED,
298 P2P_PROV_DISC_TIMEOUT_JOIN,
307 * struct p2p_config - P2P configuration
309 * This configuration is provided to the P2P module during initialization with
314 * country - Country code to use in P2P operations
319 * reg_class - Regulatory class for own listen channel
324 * channel - Own listen channel
329 * channel_forced - the listen channel was forced by configuration
330 * or by control interface and cannot be overridden
335 * Regulatory class for own operational channel
340 * op_channel - Own operational channel
345 * cfg_op_channel - Whether op_channel is hardcoded in configuration
350 * channels - Own supported regulatory classes and channels
352 * List of supposerted channels per regulatory class. The regulatory
353 * classes are defined in IEEE Std 802.11-2007 Annex J and the
354 * numbering of the clases depends on the configured country code.
356 struct p2p_channels channels;
359 * cli_channels - Additional client channels
361 * This list of channels (if any) will be used when advertising local
362 * channels during GO Negotiation or Invitation for the cases where the
363 * local end may become the client. This may allow the peer to become a
364 * GO on additional channels if it supports these options. The main use
365 * case for this is to include passive-scan channels on devices that may
366 * not know their current location and have configured most channels to
367 * not allow initiation of radition (i.e., another device needs to take
368 * master responsibilities).
370 struct p2p_channels cli_channels;
373 * num_pref_chan - Number of pref_chan entries
375 unsigned int num_pref_chan;
378 * pref_chan - Preferred channels for GO Negotiation
380 struct p2p_channel *pref_chan;
383 * pri_dev_type - Primary Device Type (see WPS)
388 * P2P_SEC_DEVICE_TYPES - Maximum number of secondary device types
390 #define P2P_SEC_DEVICE_TYPES 5
393 * sec_dev_type - Optional secondary device types
395 u8 sec_dev_type[P2P_SEC_DEVICE_TYPES][8];
398 * num_sec_dev_types - Number of sec_dev_type entries
400 size_t num_sec_dev_types;
403 * dev_addr - P2P Device Address
405 u8 dev_addr[ETH_ALEN];
408 * dev_name - Device Name
421 * concurrent_operations - Whether concurrent operations are supported
423 int concurrent_operations;
426 * max_peers - Maximum number of discovered peers to remember
428 * If more peers are discovered, older entries will be removed to make
429 * room for the new ones.
434 * p2p_intra_bss - Intra BSS communication is supported
439 * ssid_postfix - Postfix data to add to the SSID
441 * This data will be added to the end of the SSID after the
442 * DIRECT-<random two octets> prefix.
444 u8 ssid_postfix[32 - 9];
447 * ssid_postfix_len - Length of the ssid_postfix data
449 size_t ssid_postfix_len;
452 * max_listen - Maximum listen duration in ms
454 unsigned int max_listen;
457 * passphrase_len - Passphrase length (8..63)
459 * This parameter controls the length of the random passphrase that is
460 * generated at the GO.
462 unsigned int passphrase_len;
465 * cb_ctx - Context to use with callback functions
470 * debug_print - Debug print
471 * @ctx: Callback context from cb_ctx
472 * @level: Debug verbosity level (MSG_*)
473 * @msg: Debug message
475 void (*debug_print)(void *ctx, int level, const char *msg);
478 /* Callbacks to request lower layer driver operations */
481 * p2p_scan - Request a P2P scan/search
482 * @ctx: Callback context from cb_ctx
484 * @freq: Specific frequency (MHz) to scan or 0 for no restriction
485 * @num_req_dev_types: Number of requested device types
486 * @req_dev_types: Array containing requested device types
487 * @dev_id: Device ID to search for or %NULL to find all devices
488 * @pw_id: Device Password ID
489 * Returns: 0 on success, -1 on failure
491 * This callback function is used to request a P2P scan or search
492 * operation to be completed. Type type argument specifies which type
493 * of scan is to be done. @P2P_SCAN_SOCIAL indicates that only the
494 * social channels (1, 6, 11) should be scanned. @P2P_SCAN_FULL
495 * indicates that all channels are to be scanned.
496 * @P2P_SCAN_SOCIAL_PLUS_ONE request scan of all the social channels
497 * plus one extra channel specified by freq.
499 * The full scan is used for the initial scan to find group owners from
500 * all. The other types are used during search phase scan of the social
501 * channels (with potential variation if the Listen channel of the
502 * target peer is known or if other channels are scanned in steps).
504 * The scan results are returned after this call by calling
505 * p2p_scan_res_handler() for each scan result that has a P2P IE and
506 * then calling p2p_scan_res_handled() to indicate that all scan
507 * results have been indicated.
509 int (*p2p_scan)(void *ctx, enum p2p_scan_type type, int freq,
510 unsigned int num_req_dev_types,
511 const u8 *req_dev_types, const u8 *dev_id, u16 pw_id);
514 * send_probe_resp - Transmit a Probe Response frame
515 * @ctx: Callback context from cb_ctx
516 * @buf: Probe Response frame (including the header and body)
517 * Returns: 0 on success, -1 on failure
519 * This function is used to reply to Probe Request frames that were
520 * indicated with a call to p2p_probe_req_rx(). The response is to be
521 * sent on the same channel or to be dropped if the driver is not
522 * anymore listening to Probe Request frames.
524 * Alternatively, the responsibility for building the Probe Response
525 * frames in Listen state may be in another system component in which
526 * case this function need to be implemented (i.e., the function
527 * pointer can be %NULL). The WPS and P2P IEs to be added for Probe
528 * Response frames in such a case are available from the
529 * start_listen() callback. It should be noted that the received Probe
530 * Request frames must be indicated by calling p2p_probe_req_rx() even
531 * if this send_probe_resp() is not used.
533 int (*send_probe_resp)(void *ctx, const struct wpabuf *buf);
536 * send_action - Transmit an Action frame
537 * @ctx: Callback context from cb_ctx
538 * @freq: Frequency in MHz for the channel on which to transmit
539 * @dst: Destination MAC address (Address 1)
540 * @src: Source MAC address (Address 2)
541 * @bssid: BSSID (Address 3)
542 * @buf: Frame body (starting from Category field)
543 * @len: Length of buf in octets
544 * @wait_time: How many msec to wait for a response frame
545 * Returns: 0 on success, -1 on failure
547 * The Action frame may not be transmitted immediately and the status
548 * of the transmission must be reported by calling
549 * p2p_send_action_cb() once the frame has either been transmitted or
550 * it has been dropped due to excessive retries or other failure to
553 int (*send_action)(void *ctx, unsigned int freq, const u8 *dst,
554 const u8 *src, const u8 *bssid, const u8 *buf,
555 size_t len, unsigned int wait_time);
558 * send_action_done - Notify that Action frame sequence was completed
559 * @ctx: Callback context from cb_ctx
561 * This function is called when the Action frame sequence that was
562 * started with send_action() has been completed, i.e., when there is
563 * no need to wait for a response from the destination peer anymore.
565 void (*send_action_done)(void *ctx);
568 * start_listen - Start Listen state
569 * @ctx: Callback context from cb_ctx
570 * @freq: Frequency of the listen channel in MHz
571 * @duration: Duration for the Listen state in milliseconds
572 * @probe_resp_ie: IE(s) to be added to Probe Response frames
573 * Returns: 0 on success, -1 on failure
575 * This Listen state may not start immediately since the driver may
576 * have other pending operations to complete first. Once the Listen
577 * state has started, p2p_listen_cb() must be called to notify the P2P
578 * module. Once the Listen state is stopped, p2p_listen_end() must be
579 * called to notify the P2P module that the driver is not in the Listen
582 * If the send_probe_resp() is not used for generating the response,
583 * the IEs from probe_resp_ie need to be added to the end of the Probe
584 * Response frame body. If send_probe_resp() is used, the probe_resp_ie
585 * information can be ignored.
587 int (*start_listen)(void *ctx, unsigned int freq,
588 unsigned int duration,
589 const struct wpabuf *probe_resp_ie);
591 * stop_listen - Stop Listen state
592 * @ctx: Callback context from cb_ctx
594 * This callback can be used to stop a Listen state operation that was
595 * previously requested with start_listen().
597 void (*stop_listen)(void *ctx);
600 * get_noa - Get current Notice of Absence attribute payload
601 * @ctx: Callback context from cb_ctx
602 * @interface_addr: P2P Interface Address of the GO
603 * @buf: Buffer for returning NoA
604 * @buf_len: Buffer length in octets
605 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
606 * advertized, or -1 on failure
608 * This function is used to fetch the current Notice of Absence
609 * attribute value from GO.
611 int (*get_noa)(void *ctx, const u8 *interface_addr, u8 *buf,
614 /* Callbacks to notify events to upper layer management entity */
617 * dev_found - Notification of a found P2P Device
618 * @ctx: Callback context from cb_ctx
619 * @addr: Source address of the message triggering this notification
620 * @info: P2P peer information
621 * @new_device: Inform if the peer is newly found
623 * This callback is used to notify that a new P2P Device has been
624 * found. This may happen, e.g., during Search state based on scan
625 * results or during Listen state based on receive Probe Request and
626 * Group Owner Negotiation Request.
628 void (*dev_found)(void *ctx, const u8 *addr,
629 const struct p2p_peer_info *info,
633 * dev_lost - Notification of a lost P2P Device
634 * @ctx: Callback context from cb_ctx
635 * @dev_addr: P2P Device Address of the lost P2P Device
637 * This callback is used to notify that a P2P Device has been deleted.
639 void (*dev_lost)(void *ctx, const u8 *dev_addr);
642 * find_stopped - Notification of a p2p_find operation stopping
643 * @ctx: Callback context from cb_ctx
645 void (*find_stopped)(void *ctx);
648 * go_neg_req_rx - Notification of a receive GO Negotiation Request
649 * @ctx: Callback context from cb_ctx
650 * @src: Source address of the message triggering this notification
651 * @dev_passwd_id: WPS Device Password ID
653 * This callback is used to notify that a P2P Device is requesting
654 * group owner negotiation with us, but we do not have all the
655 * necessary information to start GO Negotiation. This indicates that
656 * the local user has not authorized the connection yet by providing a
657 * PIN or PBC button press. This information can be provided with a
658 * call to p2p_connect().
660 void (*go_neg_req_rx)(void *ctx, const u8 *src, u16 dev_passwd_id);
663 * go_neg_completed - Notification of GO Negotiation results
664 * @ctx: Callback context from cb_ctx
665 * @res: GO Negotiation results
667 * This callback is used to notify that Group Owner Negotiation has
668 * been completed. Non-zero struct p2p_go_neg_results::status indicates
669 * failed negotiation. In case of success, this function is responsible
670 * for creating a new group interface (or using the existing interface
671 * depending on driver features), setting up the group interface in
672 * proper mode based on struct p2p_go_neg_results::role_go and
673 * initializing WPS provisioning either as a Registrar (if GO) or as an
674 * Enrollee. Successful WPS provisioning must be indicated by calling
675 * p2p_wps_success_cb(). The callee is responsible for timing out group
676 * formation if WPS provisioning cannot be completed successfully
679 void (*go_neg_completed)(void *ctx, struct p2p_go_neg_results *res);
682 * sd_request - Callback on Service Discovery Request
683 * @ctx: Callback context from cb_ctx
684 * @freq: Frequency (in MHz) of the channel
685 * @sa: Source address of the request
686 * @dialog_token: Dialog token
687 * @update_indic: Service Update Indicator from the source of request
688 * @tlvs: P2P Service Request TLV(s)
689 * @tlvs_len: Length of tlvs buffer in octets
691 * This callback is used to indicate reception of a service discovery
692 * request. Response to the query must be indicated by calling
693 * p2p_sd_response() with the context information from the arguments to
694 * this callback function.
696 * This callback handler can be set to %NULL to indicate that service
697 * discovery is not supported.
699 void (*sd_request)(void *ctx, int freq, const u8 *sa, u8 dialog_token,
700 u16 update_indic, const u8 *tlvs, size_t tlvs_len);
703 * sd_response - Callback on Service Discovery Response
704 * @ctx: Callback context from cb_ctx
705 * @sa: Source address of the request
706 * @update_indic: Service Update Indicator from the source of response
707 * @tlvs: P2P Service Response TLV(s)
708 * @tlvs_len: Length of tlvs buffer in octets
710 * This callback is used to indicate reception of a service discovery
711 * response. This callback handler can be set to %NULL if no service
712 * discovery requests are used. The information provided with this call
713 * is replies to the queries scheduled with p2p_sd_request().
715 void (*sd_response)(void *ctx, const u8 *sa, u16 update_indic,
716 const u8 *tlvs, size_t tlvs_len);
719 * prov_disc_req - Callback on Provisiong Discovery Request
720 * @ctx: Callback context from cb_ctx
721 * @peer: Source address of the request
722 * @config_methods: Requested WPS Config Method
723 * @dev_addr: P2P Device Address of the found P2P Device
724 * @pri_dev_type: Primary Device Type
725 * @dev_name: Device Name
726 * @supp_config_methods: Supported configuration Methods
727 * @dev_capab: Device Capabilities
728 * @group_capab: Group Capabilities
729 * @group_id: P2P Group ID (or %NULL if not included)
730 * @group_id_len: Length of P2P Group ID
732 * This callback is used to indicate reception of a Provision Discovery
733 * Request frame that the P2P module accepted.
735 void (*prov_disc_req)(void *ctx, const u8 *peer, u16 config_methods,
736 const u8 *dev_addr, const u8 *pri_dev_type,
737 const char *dev_name, u16 supp_config_methods,
738 u8 dev_capab, u8 group_capab,
739 const u8 *group_id, size_t group_id_len);
742 * prov_disc_resp - Callback on Provisiong Discovery Response
743 * @ctx: Callback context from cb_ctx
744 * @peer: Source address of the response
745 * @config_methods: Value from p2p_prov_disc_req() or 0 on failure
747 * This callback is used to indicate reception of a Provision Discovery
748 * Response frame for a pending request scheduled with
749 * p2p_prov_disc_req(). This callback handler can be set to %NULL if
750 * provision discovery is not used.
752 void (*prov_disc_resp)(void *ctx, const u8 *peer, u16 config_methods);
755 * prov_disc_fail - Callback on Provision Discovery failure
756 * @ctx: Callback context from cb_ctx
757 * @peer: Source address of the response
758 * @status: Cause of failure, will not be %P2P_PROV_DISC_SUCCESS
760 * This callback is used to indicate either a failure or no response
761 * to an earlier provision discovery request.
763 * This callback handler can be set to %NULL if provision discovery
764 * is not used or failures do not need to be indicated.
766 void (*prov_disc_fail)(void *ctx, const u8 *peer,
767 enum p2p_prov_disc_status status);
770 * invitation_process - Optional callback for processing Invitations
771 * @ctx: Callback context from cb_ctx
772 * @sa: Source address of the Invitation Request
773 * @bssid: P2P Group BSSID from the request or %NULL if not included
774 * @go_dev_addr: GO Device Address from P2P Group ID
775 * @ssid: SSID from P2P Group ID
776 * @ssid_len: Length of ssid buffer in octets
777 * @go: Variable for returning whether the local end is GO in the group
778 * @group_bssid: Buffer for returning P2P Group BSSID (if local end GO)
779 * @force_freq: Variable for returning forced frequency for the group
780 * @persistent_group: Whether this is an invitation to reinvoke a
781 * persistent group (instead of invitation to join an active
783 * @channels: Available operating channels for the group
784 * @dev_pw_id: Device Password ID for NFC static handover or -1 if not
786 * Returns: Status code (P2P_SC_*)
788 * This optional callback can be used to implement persistent reconnect
789 * by allowing automatic restarting of persistent groups without user
790 * interaction. If this callback is not implemented (i.e., is %NULL),
791 * the received Invitation Request frames are replied with
792 * %P2P_SC_REQ_RECEIVED status and indicated to upper layer with the
793 * invitation_result() callback.
795 * If the requested parameters are acceptable and the group is known,
796 * %P2P_SC_SUCCESS may be returned. If the requested group is unknown,
797 * %P2P_SC_FAIL_UNKNOWN_GROUP should be returned. %P2P_SC_REQ_RECEIVED
798 * can be returned if there is not enough data to provide immediate
799 * response, i.e., if some sort of user interaction is needed. The
800 * invitation_received() callback will be called in that case
801 * immediately after this call.
803 u8 (*invitation_process)(void *ctx, const u8 *sa, const u8 *bssid,
804 const u8 *go_dev_addr, const u8 *ssid,
805 size_t ssid_len, int *go, u8 *group_bssid,
806 int *force_freq, int persistent_group,
807 const struct p2p_channels *channels,
811 * invitation_received - Callback on Invitation Request RX
812 * @ctx: Callback context from cb_ctx
813 * @sa: Source address of the Invitation Request
814 * @bssid: P2P Group BSSID or %NULL if not received
815 * @ssid: SSID of the group
816 * @ssid_len: Length of ssid in octets
817 * @go_dev_addr: GO Device Address
818 * @status: Response Status
819 * @op_freq: Operational frequency for the group
821 * This callback is used to indicate sending of an Invitation Response
822 * for a received Invitation Request. If status == 0 (success), the
823 * upper layer code is responsible for starting the group. status == 1
824 * indicates need to get user authorization for the group. Other status
825 * values indicate that the invitation request was rejected.
827 void (*invitation_received)(void *ctx, const u8 *sa, const u8 *bssid,
828 const u8 *ssid, size_t ssid_len,
829 const u8 *go_dev_addr, u8 status,
833 * invitation_result - Callback on Invitation result
834 * @ctx: Callback context from cb_ctx
835 * @status: Negotiation result (Status Code)
836 * @bssid: P2P Group BSSID or %NULL if not received
837 * @channels: Available operating channels for the group
838 * @addr: Peer address
839 * @freq: Frequency (in MHz) indicated during invitation or 0
840 * @peer_oper_freq: Operating frequency (in MHz) advertized by the peer
841 * during invitation or 0
843 * This callback is used to indicate result of an Invitation procedure
844 * started with a call to p2p_invite(). The indicated status code is
845 * the value received from the peer in Invitation Response with 0
846 * (P2P_SC_SUCCESS) indicating success or -1 to indicate a timeout or a
847 * local failure in transmitting the Invitation Request.
849 void (*invitation_result)(void *ctx, int status, const u8 *bssid,
850 const struct p2p_channels *channels,
851 const u8 *addr, int freq, int peer_oper_freq);
854 * go_connected - Check whether we are connected to a GO
855 * @ctx: Callback context from cb_ctx
856 * @dev_addr: P2P Device Address of a GO
857 * Returns: 1 if we are connected as a P2P client to the specified GO
860 int (*go_connected)(void *ctx, const u8 *dev_addr);
863 * presence_resp - Callback on Presence Response
864 * @ctx: Callback context from cb_ctx
865 * @src: Source address (GO's P2P Interface Address)
866 * @status: Result of the request (P2P_SC_*)
867 * @noa: Returned NoA value
868 * @noa_len: Length of the NoA buffer in octets
870 void (*presence_resp)(void *ctx, const u8 *src, u8 status,
871 const u8 *noa, size_t noa_len);
874 * is_concurrent_session_active - Check whether concurrent session is
875 * active on other virtual interfaces
876 * @ctx: Callback context from cb_ctx
877 * Returns: 1 if concurrent session is active on other virtual interface
880 int (*is_concurrent_session_active)(void *ctx);
883 * is_p2p_in_progress - Check whether P2P operation is in progress
884 * @ctx: Callback context from cb_ctx
885 * Returns: 1 if P2P operation (e.g., group formation) is in progress
888 int (*is_p2p_in_progress)(void *ctx);
892 /* P2P module initialization/deinitialization */
895 * p2p_init - Initialize P2P module
896 * @cfg: P2P module configuration
897 * Returns: Pointer to private data or %NULL on failure
899 * This function is used to initialize global P2P module context (one per
900 * device). The P2P module will keep a copy of the configuration data, so the
901 * caller does not need to maintain this structure. However, the callback
902 * functions and the context parameters to them must be kept available until
903 * the P2P module is deinitialized with p2p_deinit().
905 struct p2p_data * p2p_init(const struct p2p_config *cfg);
908 * p2p_deinit - Deinitialize P2P module
909 * @p2p: P2P module context from p2p_init()
911 void p2p_deinit(struct p2p_data *p2p);
914 * p2p_flush - Flush P2P module state
915 * @p2p: P2P module context from p2p_init()
917 * This command removes the P2P module state like peer device entries.
919 void p2p_flush(struct p2p_data *p2p);
922 * p2p_unauthorize - Unauthorize the specified peer device
923 * @p2p: P2P module context from p2p_init()
924 * @addr: P2P peer entry to be unauthorized
925 * Returns: 0 on success, -1 on failure
927 * This command removes any connection authorization from the specified P2P
928 * peer device address. This can be used, e.g., to cancel effect of a previous
929 * p2p_authorize() or p2p_connect() call that has not yet resulted in completed
932 int p2p_unauthorize(struct p2p_data *p2p, const u8 *addr);
935 * p2p_set_dev_name - Set device name
936 * @p2p: P2P module context from p2p_init()
937 * Returns: 0 on success, -1 on failure
939 * This function can be used to update the P2P module configuration with
940 * information that was not available at the time of the p2p_init() call.
942 int p2p_set_dev_name(struct p2p_data *p2p, const char *dev_name);
944 int p2p_set_manufacturer(struct p2p_data *p2p, const char *manufacturer);
945 int p2p_set_model_name(struct p2p_data *p2p, const char *model_name);
946 int p2p_set_model_number(struct p2p_data *p2p, const char *model_number);
947 int p2p_set_serial_number(struct p2p_data *p2p, const char *serial_number);
949 void p2p_set_config_methods(struct p2p_data *p2p, u16 config_methods);
950 void p2p_set_uuid(struct p2p_data *p2p, const u8 *uuid);
953 * p2p_set_pri_dev_type - Set primary device type
954 * @p2p: P2P module context from p2p_init()
955 * Returns: 0 on success, -1 on failure
957 * This function can be used to update the P2P module configuration with
958 * information that was not available at the time of the p2p_init() call.
960 int p2p_set_pri_dev_type(struct p2p_data *p2p, const u8 *pri_dev_type);
963 * p2p_set_sec_dev_types - Set secondary device types
964 * @p2p: P2P module context from p2p_init()
965 * Returns: 0 on success, -1 on failure
967 * This function can be used to update the P2P module configuration with
968 * information that was not available at the time of the p2p_init() call.
970 int p2p_set_sec_dev_types(struct p2p_data *p2p, const u8 dev_types[][8],
971 size_t num_dev_types);
973 int p2p_set_country(struct p2p_data *p2p, const char *country);
976 /* Commands from upper layer management entity */
978 enum p2p_discovery_type {
979 P2P_FIND_START_WITH_FULL,
980 P2P_FIND_ONLY_SOCIAL,
985 * p2p_find - Start P2P Find (Device Discovery)
986 * @p2p: P2P module context from p2p_init()
987 * @timeout: Timeout for find operation in seconds or 0 for no timeout
988 * @type: Device Discovery type
989 * @num_req_dev_types: Number of requested device types
990 * @req_dev_types: Requested device types array, must be an array
991 * containing num_req_dev_types * WPS_DEV_TYPE_LEN bytes; %NULL if no
992 * requested device types.
993 * @dev_id: Device ID to search for or %NULL to find all devices
994 * @search_delay: Extra delay in milliseconds between search iterations
995 * @seek_count: Number of ASP Service Strings in the seek_string array
996 * @seek_string: ASP Service Strings to query for in Probe Requests
997 * Returns: 0 on success, -1 on failure
999 int p2p_find(struct p2p_data *p2p, unsigned int timeout,
1000 enum p2p_discovery_type type,
1001 unsigned int num_req_dev_types, const u8 *req_dev_types,
1002 const u8 *dev_id, unsigned int search_delay,
1003 u8 seek_count, const char **seek_string);
1006 * p2p_notify_scan_trigger_status - Indicate scan trigger status
1007 * @p2p: P2P module context from p2p_init()
1008 * @status: 0 on success, -1 on failure
1010 void p2p_notify_scan_trigger_status(struct p2p_data *p2p, int status);
1013 * p2p_stop_find - Stop P2P Find (Device Discovery)
1014 * @p2p: P2P module context from p2p_init()
1016 void p2p_stop_find(struct p2p_data *p2p);
1019 * p2p_stop_find_for_freq - Stop P2P Find for next oper on specific freq
1020 * @p2p: P2P module context from p2p_init()
1021 * @freq: Frequency in MHz for next operation
1023 * This is like p2p_stop_find(), but Listen state is not stopped if we are
1024 * already on the same frequency.
1026 void p2p_stop_find_for_freq(struct p2p_data *p2p, int freq);
1029 * p2p_listen - Start P2P Listen state for specified duration
1030 * @p2p: P2P module context from p2p_init()
1031 * @timeout: Listen state duration in milliseconds
1032 * Returns: 0 on success, -1 on failure
1034 * This function can be used to request the P2P module to keep the device
1035 * discoverable on the listen channel for an extended set of time. At least in
1036 * its current form, this is mainly used for testing purposes and may not be of
1037 * much use for normal P2P operations.
1039 int p2p_listen(struct p2p_data *p2p, unsigned int timeout);
1042 * p2p_stop_listen - Stop P2P Listen
1043 * @p2p: P2P module context from p2p_init()
1045 void p2p_stop_listen(struct p2p_data *p2p);
1048 * p2p_connect - Start P2P group formation (GO negotiation)
1049 * @p2p: P2P module context from p2p_init()
1050 * @peer_addr: MAC address of the peer P2P client
1051 * @wps_method: WPS method to be used in provisioning
1052 * @go_intent: Local GO intent value (1..15)
1053 * @own_interface_addr: Intended interface address to use with the group
1054 * @force_freq: The only allowed channel frequency in MHz or 0
1055 * @persistent_group: Whether to create a persistent group (0 = no, 1 =
1056 * persistent group without persistent reconnect, 2 = persistent group with
1057 * persistent reconnect)
1058 * @force_ssid: Forced SSID for the group if we become GO or %NULL to generate
1060 * @force_ssid_len: Length of $force_ssid buffer
1061 * @pd_before_go_neg: Whether to send Provision Discovery prior to GO
1062 * Negotiation as an interoperability workaround when initiating group
1064 * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if
1066 * Returns: 0 on success, -1 on failure
1068 int p2p_connect(struct p2p_data *p2p, const u8 *peer_addr,
1069 enum p2p_wps_method wps_method,
1070 int go_intent, const u8 *own_interface_addr,
1071 unsigned int force_freq, int persistent_group,
1072 const u8 *force_ssid, size_t force_ssid_len,
1073 int pd_before_go_neg, unsigned int pref_freq, u16 oob_pw_id);
1076 * p2p_authorize - Authorize P2P group formation (GO negotiation)
1077 * @p2p: P2P module context from p2p_init()
1078 * @peer_addr: MAC address of the peer P2P client
1079 * @wps_method: WPS method to be used in provisioning
1080 * @go_intent: Local GO intent value (1..15)
1081 * @own_interface_addr: Intended interface address to use with the group
1082 * @force_freq: The only allowed channel frequency in MHz or 0
1083 * @persistent_group: Whether to create a persistent group (0 = no, 1 =
1084 * persistent group without persistent reconnect, 2 = persistent group with
1085 * persistent reconnect)
1086 * @force_ssid: Forced SSID for the group if we become GO or %NULL to generate
1088 * @force_ssid_len: Length of $force_ssid buffer
1089 * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if
1091 * Returns: 0 on success, -1 on failure
1093 * This is like p2p_connect(), but the actual group negotiation is not
1094 * initiated automatically, i.e., the other end is expected to do that.
1096 int p2p_authorize(struct p2p_data *p2p, const u8 *peer_addr,
1097 enum p2p_wps_method wps_method,
1098 int go_intent, const u8 *own_interface_addr,
1099 unsigned int force_freq, int persistent_group,
1100 const u8 *force_ssid, size_t force_ssid_len,
1101 unsigned int pref_freq, u16 oob_pw_id);
1104 * p2p_reject - Reject peer device (explicitly block connection attempts)
1105 * @p2p: P2P module context from p2p_init()
1106 * @peer_addr: MAC address of the peer P2P client
1107 * Returns: 0 on success, -1 on failure
1109 int p2p_reject(struct p2p_data *p2p, const u8 *peer_addr);
1112 * p2p_prov_disc_req - Send Provision Discovery Request
1113 * @p2p: P2P module context from p2p_init()
1114 * @peer_addr: MAC address of the peer P2P client
1115 * @config_methods: WPS Config Methods value (only one bit set)
1116 * @join: Whether this is used by a client joining an active group
1117 * @force_freq: Forced TX frequency for the frame (mainly for the join case)
1118 * @user_initiated_pd: Flag to indicate if initiated by user or not
1119 * Returns: 0 on success, -1 on failure
1121 * This function can be used to request a discovered P2P peer to display a PIN
1122 * (config_methods = WPS_CONFIG_DISPLAY) or be prepared to enter a PIN from us
1123 * (config_methods = WPS_CONFIG_KEYPAD). The Provision Discovery Request frame
1124 * is transmitted once immediately and if no response is received, the frame
1125 * will be sent again whenever the target device is discovered during device
1126 * dsicovery (start with a p2p_find() call). Response from the peer is
1127 * indicated with the p2p_config::prov_disc_resp() callback.
1129 int p2p_prov_disc_req(struct p2p_data *p2p, const u8 *peer_addr,
1130 u16 config_methods, int join, int force_freq,
1131 int user_initiated_pd);
1134 * p2p_sd_request - Schedule a service discovery query
1135 * @p2p: P2P module context from p2p_init()
1136 * @dst: Destination peer or %NULL to apply for all peers
1137 * @tlvs: P2P Service Query TLV(s)
1138 * Returns: Reference to the query or %NULL on failure
1140 * Response to the query is indicated with the p2p_config::sd_response()
1143 void * p2p_sd_request(struct p2p_data *p2p, const u8 *dst,
1144 const struct wpabuf *tlvs);
1146 #ifdef CONFIG_WIFI_DISPLAY
1147 void * p2p_sd_request_wfd(struct p2p_data *p2p, const u8 *dst,
1148 const struct wpabuf *tlvs);
1149 #endif /* CONFIG_WIFI_DISPLAY */
1152 * p2p_sd_cancel_request - Cancel a pending service discovery query
1153 * @p2p: P2P module context from p2p_init()
1154 * @req: Query reference from p2p_sd_request()
1155 * Returns: 0 if request for cancelled; -1 if not found
1157 int p2p_sd_cancel_request(struct p2p_data *p2p, void *req);
1160 * p2p_sd_response - Send response to a service discovery query
1161 * @p2p: P2P module context from p2p_init()
1162 * @freq: Frequency from p2p_config::sd_request() callback
1163 * @dst: Destination address from p2p_config::sd_request() callback
1164 * @dialog_token: Dialog token from p2p_config::sd_request() callback
1165 * @resp_tlvs: P2P Service Response TLV(s)
1167 * This function is called as a response to the request indicated with
1168 * p2p_config::sd_request() callback.
1170 void p2p_sd_response(struct p2p_data *p2p, int freq, const u8 *dst,
1171 u8 dialog_token, const struct wpabuf *resp_tlvs);
1174 * p2p_sd_service_update - Indicate a change in local services
1175 * @p2p: P2P module context from p2p_init()
1177 * This function needs to be called whenever there is a change in availability
1178 * of the local services. This will increment the Service Update Indicator
1179 * value which will be used in SD Request and Response frames.
1181 void p2p_sd_service_update(struct p2p_data *p2p);
1184 enum p2p_invite_role {
1186 P2P_INVITE_ROLE_ACTIVE_GO,
1187 P2P_INVITE_ROLE_CLIENT
1191 * p2p_invite - Invite a P2P Device into a group
1192 * @p2p: P2P module context from p2p_init()
1193 * @peer: Device Address of the peer P2P Device
1194 * @role: Local role in the group
1195 * @bssid: Group BSSID or %NULL if not known
1197 * @ssid_len: Length of ssid in octets
1198 * @force_freq: The only allowed channel frequency in MHz or 0
1199 * @go_dev_addr: Forced GO Device Address or %NULL if none
1200 * @persistent_group: Whether this is to reinvoke a persistent group
1201 * @pref_freq: Preferred operating frequency in MHz or 0 (this is only used if
1203 * @dev_pw_id: Device Password ID from OOB Device Password (NFC) static handover
1204 * case or -1 if not used
1205 * Returns: 0 on success, -1 on failure
1207 int p2p_invite(struct p2p_data *p2p, const u8 *peer, enum p2p_invite_role role,
1208 const u8 *bssid, const u8 *ssid, size_t ssid_len,
1209 unsigned int force_freq, const u8 *go_dev_addr,
1210 int persistent_group, unsigned int pref_freq, int dev_pw_id);
1213 * p2p_presence_req - Request GO presence
1214 * @p2p: P2P module context from p2p_init()
1215 * @go_interface_addr: GO P2P Interface Address
1216 * @own_interface_addr: Own P2P Interface Address for this group
1217 * @freq: Group operating frequence (in MHz)
1218 * @duration1: Preferred presence duration in microseconds
1219 * @interval1: Preferred presence interval in microseconds
1220 * @duration2: Acceptable presence duration in microseconds
1221 * @interval2: Acceptable presence interval in microseconds
1222 * Returns: 0 on success, -1 on failure
1224 * If both duration and interval values are zero, the parameter pair is not
1225 * specified (i.e., to remove Presence Request, use duration1 = interval1 = 0).
1227 int p2p_presence_req(struct p2p_data *p2p, const u8 *go_interface_addr,
1228 const u8 *own_interface_addr, unsigned int freq,
1229 u32 duration1, u32 interval1, u32 duration2,
1233 * p2p_ext_listen - Set Extended Listen Timing
1234 * @p2p: P2P module context from p2p_init()
1235 * @freq: Group operating frequence (in MHz)
1236 * @period: Availability period in milliseconds (1-65535; 0 to disable)
1237 * @interval: Availability interval in milliseconds (1-65535; 0 to disable)
1238 * Returns: 0 on success, -1 on failure
1240 * This function can be used to enable or disable (period = interval = 0)
1241 * Extended Listen Timing. When enabled, the P2P Device will become
1242 * discoverable (go into Listen State) every @interval milliseconds for at
1243 * least @period milliseconds.
1245 int p2p_ext_listen(struct p2p_data *p2p, unsigned int period,
1246 unsigned int interval);
1248 /* Event notifications from upper layer management operations */
1251 * p2p_wps_success_cb - Report successfully completed WPS provisioning
1252 * @p2p: P2P module context from p2p_init()
1253 * @mac_addr: Peer address
1255 * This function is used to report successfully completed WPS provisioning
1256 * during group formation in both GO/Registrar and client/Enrollee roles.
1258 void p2p_wps_success_cb(struct p2p_data *p2p, const u8 *mac_addr);
1261 * p2p_group_formation_failed - Report failed WPS provisioning
1262 * @p2p: P2P module context from p2p_init()
1264 * This function is used to report failed group formation. This can happen
1265 * either due to failed WPS provisioning or due to 15 second timeout during
1266 * the provisioning phase.
1268 void p2p_group_formation_failed(struct p2p_data *p2p);
1271 * p2p_get_provisioning_info - Get any stored provisioning info
1272 * @p2p: P2P module context from p2p_init()
1273 * @addr: Peer P2P Device Address
1274 * Returns: WPS provisioning information (WPS config method) or 0 if no
1275 * information is available
1277 * This function is used to retrieve stored WPS provisioning info for the given
1280 u16 p2p_get_provisioning_info(struct p2p_data *p2p, const u8 *addr);
1283 * p2p_clear_provisioning_info - Clear any stored provisioning info
1284 * @p2p: P2P module context from p2p_init()
1285 * @iface_addr: Peer P2P Device Address
1287 * This function is used to clear stored WPS provisioning info for the given
1290 void p2p_clear_provisioning_info(struct p2p_data *p2p, const u8 *addr);
1293 /* Event notifications from lower layer driver operations */
1296 * enum p2p_probe_req_status
1298 * @P2P_PREQ_MALFORMED: frame was not well-formed
1299 * @P2P_PREQ_NOT_LISTEN: device isn't in listen state, frame ignored
1300 * @P2P_PREQ_NOT_P2P: frame was not a P2P probe request
1301 * @P2P_PREQ_P2P_NOT_PROCESSED: frame was P2P but wasn't processed
1302 * @P2P_PREQ_P2P_PROCESSED: frame has been processed by P2P
1304 enum p2p_probe_req_status {
1306 P2P_PREQ_NOT_LISTEN,
1308 P2P_PREQ_NOT_PROCESSED,
1313 * p2p_probe_req_rx - Report reception of a Probe Request frame
1314 * @p2p: P2P module context from p2p_init()
1315 * @addr: Source MAC address
1316 * @dst: Destination MAC address if available or %NULL
1317 * @bssid: BSSID if available or %NULL
1318 * @ie: Information elements from the Probe Request frame body
1319 * @ie_len: Length of ie buffer in octets
1320 * Returns: value indicating the type and status of the probe request
1322 enum p2p_probe_req_status
1323 p2p_probe_req_rx(struct p2p_data *p2p, const u8 *addr, const u8 *dst,
1324 const u8 *bssid, const u8 *ie, size_t ie_len);
1327 * p2p_rx_action - Report received Action frame
1328 * @p2p: P2P module context from p2p_init()
1329 * @da: Destination address of the received Action frame
1330 * @sa: Source address of the received Action frame
1331 * @bssid: Address 3 of the received Action frame
1332 * @category: Category of the received Action frame
1333 * @data: Action frame body after the Category field
1334 * @len: Length of the data buffer in octets
1335 * @freq: Frequency (in MHz) on which the frame was received
1337 void p2p_rx_action(struct p2p_data *p2p, const u8 *da, const u8 *sa,
1338 const u8 *bssid, u8 category,
1339 const u8 *data, size_t len, int freq);
1342 * p2p_scan_res_handler - Indicate a P2P scan results
1343 * @p2p: P2P module context from p2p_init()
1344 * @bssid: BSSID of the scan result
1345 * @freq: Frequency of the channel on which the device was found in MHz
1346 * @rx_time: Time when the result was received
1347 * @level: Signal level (signal strength of the received Beacon/Probe Response
1349 * @ies: Pointer to IEs from the scan result
1350 * @ies_len: Length of the ies buffer
1351 * Returns: 0 to continue or 1 to stop scan result indication
1353 * This function is called to indicate a scan result entry with P2P IE from a
1354 * scan requested with struct p2p_config::p2p_scan(). This can be called during
1355 * the actual scan process (i.e., whenever a new device is found) or as a
1356 * sequence of calls after the full scan has been completed. The former option
1357 * can result in optimized operations, but may not be supported by all
1358 * driver/firmware designs. The ies buffer need to include at least the P2P IE,
1359 * but it is recommended to include all IEs received from the device. The
1360 * caller does not need to check that the IEs contain a P2P IE before calling
1361 * this function since frames will be filtered internally if needed.
1363 * This function will return 1 if it wants to stop scan result iteration (and
1364 * scan in general if it is still in progress). This is used to allow faster
1365 * start of a pending operation, e.g., to start a pending GO negotiation.
1367 int p2p_scan_res_handler(struct p2p_data *p2p, const u8 *bssid, int freq,
1368 struct os_reltime *rx_time, int level, const u8 *ies,
1372 * p2p_scan_res_handled - Indicate end of scan results
1373 * @p2p: P2P module context from p2p_init()
1375 * This function is called to indicate that all P2P scan results from a scan
1376 * have been reported with zero or more calls to p2p_scan_res_handler(). This
1377 * function must be called as a response to successful
1378 * struct p2p_config::p2p_scan() call if none of the p2p_scan_res_handler()
1379 * calls stopped iteration.
1381 void p2p_scan_res_handled(struct p2p_data *p2p);
1383 enum p2p_send_action_result {
1384 P2P_SEND_ACTION_SUCCESS /* Frame was send and acknowledged */,
1385 P2P_SEND_ACTION_NO_ACK /* Frame was sent, but not acknowledged */,
1386 P2P_SEND_ACTION_FAILED /* Frame was not sent due to a failure */
1390 * p2p_send_action_cb - Notify TX status of an Action frame
1391 * @p2p: P2P module context from p2p_init()
1392 * @freq: Channel frequency in MHz
1393 * @dst: Destination MAC address (Address 1)
1394 * @src: Source MAC address (Address 2)
1395 * @bssid: BSSID (Address 3)
1396 * @result: Result of the transmission attempt
1398 * This function is used to indicate the result of an Action frame transmission
1399 * that was requested with struct p2p_config::send_action() callback.
1401 void p2p_send_action_cb(struct p2p_data *p2p, unsigned int freq, const u8 *dst,
1402 const u8 *src, const u8 *bssid,
1403 enum p2p_send_action_result result);
1406 * p2p_listen_cb - Indicate the start of a requested Listen state
1407 * @p2p: P2P module context from p2p_init()
1408 * @freq: Listen channel frequency in MHz
1409 * @duration: Duration for the Listen state in milliseconds
1411 * This function is used to indicate that a Listen state requested with
1412 * struct p2p_config::start_listen() callback has started.
1414 void p2p_listen_cb(struct p2p_data *p2p, unsigned int freq,
1415 unsigned int duration);
1418 * p2p_listen_end - Indicate the end of a requested Listen state
1419 * @p2p: P2P module context from p2p_init()
1420 * @freq: Listen channel frequency in MHz
1421 * Returns: 0 if no operations were started, 1 if an operation was started
1423 * This function is used to indicate that a Listen state requested with
1424 * struct p2p_config::start_listen() callback has ended.
1426 int p2p_listen_end(struct p2p_data *p2p, unsigned int freq);
1428 void p2p_deauth_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code,
1429 const u8 *ie, size_t ie_len);
1431 void p2p_disassoc_notif(struct p2p_data *p2p, const u8 *bssid, u16 reason_code,
1432 const u8 *ie, size_t ie_len);
1435 /* Per-group P2P state for GO */
1440 * struct p2p_group_config - P2P group configuration
1442 * This configuration is provided to the P2P module during initialization of
1443 * the per-group information with p2p_group_init().
1445 struct p2p_group_config {
1447 * persistent_group - Whether the group is persistent
1448 * 0 = not a persistent group
1449 * 1 = persistent group without persistent reconnect
1450 * 2 = persistent group with persistent reconnect
1452 int persistent_group;
1455 * interface_addr - P2P Interface Address of the group
1457 u8 interface_addr[ETH_ALEN];
1460 * max_clients - Maximum number of clients in the group
1462 unsigned int max_clients;
1470 * ssid_len - Length of SSID
1475 * freq - Operating channel of the group
1480 * cb_ctx - Context to use with callback functions
1485 * ie_update - Notification of IE update
1486 * @ctx: Callback context from cb_ctx
1487 * @beacon_ies: P2P IE for Beacon frames or %NULL if no change
1488 * @proberesp_ies: P2P Ie for Probe Response frames
1490 * P2P module uses this callback function to notify whenever the P2P IE
1491 * in Beacon or Probe Response frames should be updated based on group
1494 * The callee is responsible for freeing the returned buffer(s) with
1497 void (*ie_update)(void *ctx, struct wpabuf *beacon_ies,
1498 struct wpabuf *proberesp_ies);
1501 * idle_update - Notification of changes in group idle state
1502 * @ctx: Callback context from cb_ctx
1503 * @idle: Whether the group is idle (no associated stations)
1505 void (*idle_update)(void *ctx, int idle);
1509 * p2p_group_init - Initialize P2P group
1510 * @p2p: P2P module context from p2p_init()
1511 * @config: P2P group configuration (will be freed by p2p_group_deinit())
1512 * Returns: Pointer to private data or %NULL on failure
1514 * This function is used to initialize per-group P2P module context. Currently,
1515 * this is only used to manage GO functionality and P2P clients do not need to
1516 * create an instance of this per-group information.
1518 struct p2p_group * p2p_group_init(struct p2p_data *p2p,
1519 struct p2p_group_config *config);
1522 * p2p_group_deinit - Deinitialize P2P group
1523 * @group: P2P group context from p2p_group_init()
1525 void p2p_group_deinit(struct p2p_group *group);
1528 * p2p_group_notif_assoc - Notification of P2P client association with GO
1529 * @group: P2P group context from p2p_group_init()
1530 * @addr: Interface address of the P2P client
1531 * @ie: IEs from the (Re)association Request frame
1532 * @len: Length of the ie buffer in octets
1533 * Returns: 0 on success, -1 on failure
1535 int p2p_group_notif_assoc(struct p2p_group *group, const u8 *addr,
1536 const u8 *ie, size_t len);
1539 * p2p_group_assoc_resp_ie - Build P2P IE for (re)association response
1540 * @group: P2P group context from p2p_group_init()
1541 * @status: Status value (P2P_SC_SUCCESS if association succeeded)
1542 * Returns: P2P IE for (Re)association Response or %NULL on failure
1544 * The caller is responsible for freeing the returned buffer with
1547 struct wpabuf * p2p_group_assoc_resp_ie(struct p2p_group *group, u8 status);
1550 * p2p_group_notif_disassoc - Notification of P2P client disassociation from GO
1551 * @group: P2P group context from p2p_group_init()
1552 * @addr: Interface address of the P2P client
1554 void p2p_group_notif_disassoc(struct p2p_group *group, const u8 *addr);
1557 * p2p_group_notif_formation_done - Notification of completed group formation
1558 * @group: P2P group context from p2p_group_init()
1560 void p2p_group_notif_formation_done(struct p2p_group *group);
1563 * p2p_group_notif_noa - Notification of NoA change
1564 * @group: P2P group context from p2p_group_init()
1565 * @noa: Notice of Absence attribute payload, %NULL if none
1566 * @noa_len: Length of noa buffer in octets
1567 * Returns: 0 on success, -1 on failure
1569 * Notify the P2P group management about a new NoA contents. This will be
1570 * inserted into the P2P IEs in Beacon and Probe Response frames with rest of
1571 * the group information.
1573 int p2p_group_notif_noa(struct p2p_group *group, const u8 *noa,
1577 * p2p_group_match_dev_type - Match device types in group with requested type
1578 * @group: P2P group context from p2p_group_init()
1579 * @wps: WPS TLVs from Probe Request frame (concatenated WPS IEs)
1580 * Returns: 1 on match, 0 on mismatch
1582 * This function can be used to match the Requested Device Type attribute in
1583 * WPS IE with the device types of a group member for deciding whether a GO
1584 * should reply to a Probe Request frame. Match will be reported if the WPS IE
1585 * is not requested any specific device type.
1587 int p2p_group_match_dev_type(struct p2p_group *group, struct wpabuf *wps);
1590 * p2p_group_match_dev_id - Match P2P Device Address in group with requested device id
1592 int p2p_group_match_dev_id(struct p2p_group *group, struct wpabuf *p2p);
1595 * p2p_group_go_discover - Send GO Discoverability Request to a group client
1596 * @group: P2P group context from p2p_group_init()
1597 * Returns: 0 on success (frame scheduled); -1 if client was not found
1599 int p2p_group_go_discover(struct p2p_group *group, const u8 *dev_id,
1600 const u8 *searching_dev, int rx_freq);
1603 /* Generic helper functions */
1606 * p2p_ie_text - Build text format description of P2P IE
1608 * @buf: Buffer for returning text
1609 * @end: Pointer to the end of the buf area
1610 * Returns: Number of octets written to the buffer or -1 on failure
1612 * This function can be used to parse P2P IE contents into text format
1613 * field=value lines.
1615 int p2p_ie_text(struct wpabuf *p2p_ie, char *buf, char *end);
1618 * p2p_scan_result_text - Build text format description of P2P IE
1619 * @ies: Information elements from scan results
1620 * @ies_len: ies buffer length in octets
1621 * @buf: Buffer for returning text
1622 * @end: Pointer to the end of the buf area
1623 * Returns: Number of octets written to the buffer or -1 on failure
1625 * This function can be used to parse P2P IE contents into text format
1626 * field=value lines.
1628 int p2p_scan_result_text(const u8 *ies, size_t ies_len, char *buf, char *end);
1631 * p2p_parse_dev_addr_in_p2p_ie - Parse P2P Device Address from a concatenated
1634 * @dev_addr: Buffer for returning P2P Device Address
1635 * Returns: 0 on success or -1 if P2P Device Address could not be parsed
1637 int p2p_parse_dev_addr_in_p2p_ie(struct wpabuf *p2p_ie, u8 *dev_addr);
1640 * p2p_parse_dev_addr - Parse P2P Device Address from P2P IE(s)
1641 * @ies: Information elements from scan results
1642 * @ies_len: ies buffer length in octets
1643 * @dev_addr: Buffer for returning P2P Device Address
1644 * Returns: 0 on success or -1 if P2P Device Address could not be parsed
1646 int p2p_parse_dev_addr(const u8 *ies, size_t ies_len, u8 *dev_addr);
1649 * p2p_assoc_req_ie - Build P2P IE for (Re)Association Request frame
1650 * @p2p: P2P module context from p2p_init()
1652 * @buf: Buffer for writing the P2P IE
1653 * @len: Maximum buf length in octets
1654 * @p2p_group: Whether this is for association with a P2P GO
1655 * @p2p_ie: Reassembled P2P IE data from scan results or %NULL if none
1656 * Returns: Number of octets written into buf or -1 on failure
1658 int p2p_assoc_req_ie(struct p2p_data *p2p, const u8 *bssid, u8 *buf,
1659 size_t len, int p2p_group, struct wpabuf *p2p_ie);
1662 * p2p_scan_ie - Build P2P IE for Probe Request
1663 * @p2p: P2P module context from p2p_init()
1664 * @ies: Buffer for writing P2P IE
1665 * @dev_id: Device ID to search for or %NULL for any
1667 void p2p_scan_ie(struct p2p_data *p2p, struct wpabuf *ies, const u8 *dev_id);
1670 * p2p_scan_ie_buf_len - Get maximum buffer length needed for p2p_scan_ie
1671 * @p2p: P2P module context from p2p_init()
1672 * Returns: Number of octets that p2p_scan_ie() may add to the buffer
1674 size_t p2p_scan_ie_buf_len(struct p2p_data *p2p);
1677 * p2p_go_params - Generate random P2P group parameters
1678 * @p2p: P2P module context from p2p_init()
1679 * @params: Buffer for parameters
1680 * Returns: 0 on success, -1 on failure
1682 int p2p_go_params(struct p2p_data *p2p, struct p2p_go_neg_results *params);
1685 * p2p_get_group_capab - Get Group Capability from P2P IE data
1686 * @p2p_ie: P2P IE(s) contents
1687 * Returns: Group Capability
1689 u8 p2p_get_group_capab(const struct wpabuf *p2p_ie);
1692 * p2p_get_cross_connect_disallowed - Does WLAN AP disallows cross connection
1693 * @p2p_ie: P2P IE(s) contents
1694 * Returns: 0 if cross connection is allow, 1 if not
1696 int p2p_get_cross_connect_disallowed(const struct wpabuf *p2p_ie);
1699 * p2p_get_go_dev_addr - Get P2P Device Address from P2P IE data
1700 * @p2p_ie: P2P IE(s) contents
1701 * Returns: Pointer to P2P Device Address or %NULL if not included
1703 const u8 * p2p_get_go_dev_addr(const struct wpabuf *p2p_ie);
1706 * p2p_get_peer_info - Get P2P peer information
1707 * @p2p: P2P module context from p2p_init()
1708 * @addr: P2P Device Address of the peer or %NULL to indicate the first peer
1709 * @next: Whether to select the peer entry following the one indicated by addr
1710 * Returns: Pointer to peer info or %NULL if not found
1712 const struct p2p_peer_info * p2p_get_peer_info(struct p2p_data *p2p,
1713 const u8 *addr, int next);
1716 * p2p_get_peer_info_txt - Get internal P2P peer information in text format
1717 * @info: Pointer to P2P peer info from p2p_get_peer_info()
1718 * @buf: Buffer for returning text
1719 * @buflen: Maximum buffer length
1720 * Returns: Number of octets written to the buffer or -1 on failure
1722 * Note: This information is internal to the P2P module and subject to change.
1723 * As such, this should not really be used by external programs for purposes
1724 * other than debugging.
1726 int p2p_get_peer_info_txt(const struct p2p_peer_info *info,
1727 char *buf, size_t buflen);
1730 * p2p_peer_known - Check whether P2P peer is known
1731 * @p2p: P2P module context from p2p_init()
1732 * @addr: P2P Device Address of the peer
1733 * Returns: 1 if the specified device is in the P2P peer table or 0 if not
1735 int p2p_peer_known(struct p2p_data *p2p, const u8 *addr);
1738 * p2p_set_client_discoverability - Set client discoverability capability
1739 * @p2p: P2P module context from p2p_init()
1740 * @enabled: Whether client discoverability will be enabled
1742 * This function can be used to disable (and re-enable) client discoverability.
1743 * This capability is enabled by default and should not be disabled in normal
1744 * use cases, i.e., this is mainly for testing purposes.
1746 void p2p_set_client_discoverability(struct p2p_data *p2p, int enabled);
1749 * p2p_set_managed_oper - Set managed P2P Device operations capability
1750 * @p2p: P2P module context from p2p_init()
1751 * @enabled: Whether managed P2P Device operations will be enabled
1753 void p2p_set_managed_oper(struct p2p_data *p2p, int enabled);
1756 * p2p_config_get_random_social - Return a random social channel
1758 * @op_class: Selected operating class
1759 * @op_channel: Selected social channel
1760 * Returns: 0 on success, -1 on failure
1762 * This function is used before p2p_init is called. A random social channel
1763 * from supports bands 2.4 GHz (channels 1,6,11) and 60 GHz (channel 2) is
1764 * returned on success.
1766 int p2p_config_get_random_social(struct p2p_config *p2p, u8 *op_class,
1769 int p2p_set_listen_channel(struct p2p_data *p2p, u8 reg_class, u8 channel,
1772 u8 p2p_get_listen_channel(struct p2p_data *p2p);
1774 int p2p_set_ssid_postfix(struct p2p_data *p2p, const u8 *postfix, size_t len);
1776 int p2p_get_interface_addr(struct p2p_data *p2p, const u8 *dev_addr,
1778 int p2p_get_dev_addr(struct p2p_data *p2p, const u8 *iface_addr,
1781 void p2p_set_peer_filter(struct p2p_data *p2p, const u8 *addr);
1784 * p2p_set_cross_connect - Set cross connection capability
1785 * @p2p: P2P module context from p2p_init()
1786 * @enabled: Whether cross connection will be enabled
1788 void p2p_set_cross_connect(struct p2p_data *p2p, int enabled);
1790 int p2p_get_oper_freq(struct p2p_data *p2p, const u8 *iface_addr);
1793 * p2p_set_intra_bss_dist - Set intra BSS distribution
1794 * @p2p: P2P module context from p2p_init()
1795 * @enabled: Whether intra BSS distribution will be enabled
1797 void p2p_set_intra_bss_dist(struct p2p_data *p2p, int enabled);
1799 int p2p_channels_includes_freq(const struct p2p_channels *channels,
1802 int p2p_channels_to_freqs(const struct p2p_channels *channels,
1803 int *freq_list, unsigned int max_len);
1806 * p2p_supported_freq - Check whether channel is supported for P2P
1807 * @p2p: P2P module context from p2p_init()
1808 * @freq: Channel frequency in MHz
1809 * Returns: 0 if channel not usable for P2P, 1 if usable for P2P
1811 int p2p_supported_freq(struct p2p_data *p2p, unsigned int freq);
1814 * p2p_supported_freq_go - Check whether channel is supported for P2P GO operation
1815 * @p2p: P2P module context from p2p_init()
1816 * @freq: Channel frequency in MHz
1817 * Returns: 0 if channel not usable for P2P, 1 if usable for P2P
1819 int p2p_supported_freq_go(struct p2p_data *p2p, unsigned int freq);
1822 * p2p_supported_freq_cli - Check whether channel is supported for P2P client operation
1823 * @p2p: P2P module context from p2p_init()
1824 * @freq: Channel frequency in MHz
1825 * Returns: 0 if channel not usable for P2P, 1 if usable for P2P
1827 int p2p_supported_freq_cli(struct p2p_data *p2p, unsigned int freq);
1830 * p2p_get_pref_freq - Get channel from preferred channel list
1831 * @p2p: P2P module context from p2p_init()
1832 * @channels: List of channels
1833 * Returns: Preferred channel
1835 unsigned int p2p_get_pref_freq(struct p2p_data *p2p,
1836 const struct p2p_channels *channels);
1838 void p2p_update_channel_list(struct p2p_data *p2p,
1839 const struct p2p_channels *chan,
1840 const struct p2p_channels *cli_chan);
1843 * p2p_set_best_channels - Update best channel information
1844 * @p2p: P2P module context from p2p_init()
1845 * @freq_24: Frequency (MHz) of best channel in 2.4 GHz band
1846 * @freq_5: Frequency (MHz) of best channel in 5 GHz band
1847 * @freq_overall: Frequency (MHz) of best channel overall
1849 void p2p_set_best_channels(struct p2p_data *p2p, int freq_24, int freq_5,
1853 * p2p_set_own_freq_preference - Set own preference for channel
1854 * @p2p: P2P module context from p2p_init()
1855 * @freq: Frequency (MHz) of the preferred channel or 0 if no preference
1857 * This function can be used to set a preference on the operating channel based
1858 * on frequencies used on the other virtual interfaces that share the same
1859 * radio. If non-zero, this is used to try to avoid multi-channel concurrency.
1861 void p2p_set_own_freq_preference(struct p2p_data *p2p, int freq);
1863 const u8 * p2p_get_go_neg_peer(struct p2p_data *p2p);
1866 * p2p_get_group_num_members - Get number of members in group
1867 * @group: P2P group context from p2p_group_init()
1868 * Returns: Number of members in the group
1870 unsigned int p2p_get_group_num_members(struct p2p_group *group);
1873 * p2p_iterate_group_members - Iterate group members
1874 * @group: P2P group context from p2p_group_init()
1875 * @next: iteration pointer, must be a pointer to a void * that is set to %NULL
1876 * on the first call and not modified later
1877 * Returns: A P2P Device Address for each call and %NULL for no more members
1879 const u8 * p2p_iterate_group_members(struct p2p_group *group, void **next);
1882 * p2p_group_get_dev_addr - Get a P2P Device Address of a client in a group
1883 * @group: P2P group context from p2p_group_init()
1884 * @addr: P2P Interface Address of the client
1885 * Returns: P2P Device Address of the client if found or %NULL if no match
1888 const u8 * p2p_group_get_dev_addr(struct p2p_group *group, const u8 *addr);
1891 * p2p_group_is_client_connected - Check whether a specific client is connected
1892 * @group: P2P group context from p2p_group_init()
1893 * @addr: P2P Device Address of the client
1894 * Returns: 1 if client is connected or 0 if not
1896 int p2p_group_is_client_connected(struct p2p_group *group, const u8 *dev_addr);
1899 * p2p_group_get_config - Get the group configuration
1900 * @group: P2P group context from p2p_group_init()
1901 * Returns: The group configuration pointer
1903 const struct p2p_group_config * p2p_group_get_config(struct p2p_group *group);
1906 * p2p_loop_on_all_groups - Run the given callback on all groups
1907 * @p2p: P2P module context from p2p_init()
1908 * @group_callback: The callback function pointer
1909 * @user_data: Some user data pointer which can be %NULL
1911 * The group_callback function can stop the iteration by returning 0.
1913 void p2p_loop_on_all_groups(struct p2p_data *p2p,
1914 int (*group_callback)(struct p2p_group *group,
1919 * p2p_get_peer_found - Get P2P peer info structure of a found peer
1920 * @p2p: P2P module context from p2p_init()
1921 * @addr: P2P Device Address of the peer or %NULL to indicate the first peer
1922 * @next: Whether to select the peer entry following the one indicated by addr
1923 * Returns: The first P2P peer info available or %NULL if no such peer exists
1925 const struct p2p_peer_info *
1926 p2p_get_peer_found(struct p2p_data *p2p, const u8 *addr, int next);
1929 * p2p_remove_wps_vendor_extensions - Remove WPS vendor extensions
1930 * @p2p: P2P module context from p2p_init()
1932 void p2p_remove_wps_vendor_extensions(struct p2p_data *p2p);
1935 * p2p_add_wps_vendor_extension - Add a WPS vendor extension
1936 * @p2p: P2P module context from p2p_init()
1937 * @vendor_ext: The vendor extensions to add
1938 * Returns: 0 on success, -1 on failure
1940 * The wpabuf structures in the array are owned by the P2P
1941 * module after this call.
1943 int p2p_add_wps_vendor_extension(struct p2p_data *p2p,
1944 const struct wpabuf *vendor_ext);
1947 * p2p_set_oper_channel - Set the P2P operating channel
1948 * @p2p: P2P module context from p2p_init()
1949 * @op_reg_class: Operating regulatory class to set
1950 * @op_channel: operating channel to set
1951 * @cfg_op_channel : Whether op_channel is hardcoded in configuration
1952 * Returns: 0 on success, -1 on failure
1954 int p2p_set_oper_channel(struct p2p_data *p2p, u8 op_reg_class, u8 op_channel,
1955 int cfg_op_channel);
1958 * p2p_set_pref_chan - Set P2P preferred channel list
1959 * @p2p: P2P module context from p2p_init()
1960 * @num_pref_chan: Number of entries in pref_chan list
1961 * @pref_chan: Preferred channels or %NULL to remove preferences
1962 * Returns: 0 on success, -1 on failure
1964 int p2p_set_pref_chan(struct p2p_data *p2p, unsigned int num_pref_chan,
1965 const struct p2p_channel *pref_chan);
1968 * p2p_set_no_go_freq - Set no GO channel ranges
1969 * @p2p: P2P module context from p2p_init()
1970 * @list: Channel ranges or %NULL to remove restriction
1971 * Returns: 0 on success, -1 on failure
1973 int p2p_set_no_go_freq(struct p2p_data *p2p,
1974 const struct wpa_freq_range_list *list);
1977 * p2p_in_progress - Check whether a P2P operation is progress
1978 * @p2p: P2P module context from p2p_init()
1979 * Returns: 0 if P2P module is idle, 1 if an operation is in progress but not
1980 * in search state, or 2 if search state operation is in progress
1982 int p2p_in_progress(struct p2p_data *p2p);
1984 const char * p2p_wps_method_text(enum p2p_wps_method method);
1987 * p2p_set_config_timeout - Set local config timeouts
1988 * @p2p: P2P module context from p2p_init()
1989 * @go_timeout: Time in 10 ms units it takes to start the GO mode
1990 * @client_timeout: Time in 10 ms units it takes to start the client mode
1992 void p2p_set_config_timeout(struct p2p_data *p2p, u8 go_timeout,
1995 int p2p_set_wfd_ie_beacon(struct p2p_data *p2p, struct wpabuf *ie);
1996 int p2p_set_wfd_ie_probe_req(struct p2p_data *p2p, struct wpabuf *ie);
1997 int p2p_set_wfd_ie_probe_resp(struct p2p_data *p2p, struct wpabuf *ie);
1998 int p2p_set_wfd_ie_assoc_req(struct p2p_data *p2p, struct wpabuf *ie);
1999 int p2p_set_wfd_ie_invitation(struct p2p_data *p2p, struct wpabuf *ie);
2000 int p2p_set_wfd_ie_prov_disc_req(struct p2p_data *p2p, struct wpabuf *ie);
2001 int p2p_set_wfd_ie_prov_disc_resp(struct p2p_data *p2p, struct wpabuf *ie);
2002 int p2p_set_wfd_ie_go_neg(struct p2p_data *p2p, struct wpabuf *ie);
2003 int p2p_set_wfd_dev_info(struct p2p_data *p2p, const struct wpabuf *elem);
2004 int p2p_set_wfd_assoc_bssid(struct p2p_data *p2p, const struct wpabuf *elem);
2005 int p2p_set_wfd_coupled_sink_info(struct p2p_data *p2p,
2006 const struct wpabuf *elem);
2007 struct wpabuf * wifi_display_encaps(struct wpabuf *subelems);
2010 * p2p_set_disc_int - Set min/max discoverable interval for p2p_find
2011 * @p2p: P2P module context from p2p_init()
2012 * @min_disc_int: minDiscoverableInterval (in units of 100 TU); default 1
2013 * @max_disc_int: maxDiscoverableInterval (in units of 100 TU); default 3
2014 * @max_disc_tu: Maximum number of TUs (1.024 ms) for discoverable interval; or
2016 * Returns: 0 on success, or -1 on failure
2018 * This function can be used to configure minDiscoverableInterval and
2019 * maxDiscoverableInterval parameters for the Listen state during device
2020 * discovery (p2p_find). A random number of 100 TU units is picked for each
2021 * Listen state iteration from [min_disc_int,max_disc_int] range.
2023 * max_disc_tu can be used to futher limit the discoverable duration. However,
2024 * it should be noted that use of this parameter is not recommended since it
2025 * would not be compliant with the P2P specification.
2027 int p2p_set_disc_int(struct p2p_data *p2p, int min_disc_int, int max_disc_int,
2031 * p2p_get_state_txt - Get current P2P state for debug purposes
2032 * @p2p: P2P module context from p2p_init()
2033 * Returns: Name of the current P2P module state
2035 * It should be noted that the P2P module state names are internal information
2036 * and subject to change at any point, i.e., this information should be used
2037 * mainly for debugging purposes.
2039 const char * p2p_get_state_txt(struct p2p_data *p2p);
2041 struct wpabuf * p2p_build_nfc_handover_req(struct p2p_data *p2p,
2043 const u8 *go_dev_addr,
2044 const u8 *ssid, size_t ssid_len);
2045 struct wpabuf * p2p_build_nfc_handover_sel(struct p2p_data *p2p,
2047 const u8 *go_dev_addr,
2048 const u8 *ssid, size_t ssid_len);
2050 struct p2p_nfc_params {
2058 NO_ACTION, JOIN_GROUP, AUTH_JOIN, INIT_GO_NEG, RESP_GO_NEG,
2059 BOTH_GO, PEER_CLIENT
2061 struct p2p_peer_info *peer;
2062 u8 oob_dev_pw[WPS_OOB_PUBKEY_HASH_LEN + 2 +
2063 WPS_OOB_DEVICE_PASSWORD_LEN];
2064 size_t oob_dev_pw_len;
2066 u8 go_dev_addr[ETH_ALEN];
2071 int p2p_process_nfc_connection_handover(struct p2p_data *p2p,
2072 struct p2p_nfc_params *params);
2074 void p2p_set_authorized_oob_dev_pw_id(struct p2p_data *p2p, u16 dev_pw_id,
2076 const u8 *own_interface_addr);
2078 int p2p_set_passphrase_len(struct p2p_data *p2p, unsigned int len);
2080 void p2p_loop_on_known_peers(struct p2p_data *p2p,
2081 void (*peer_callback)(struct p2p_peer_info *peer,
2085 void p2p_set_vendor_elems(struct p2p_data *p2p, struct wpabuf **vendor_elem);
2087 struct p2ps_advertisement *
2088 p2p_service_p2ps_id(struct p2p_data *p2p, u32 adv_id);
2089 int p2p_service_add_asp(struct p2p_data *p2p, int auto_accept, u32 adv_id,
2090 const char *adv_str, u8 svc_state,
2091 u16 config_methods, const char *svc_info);
2092 int p2p_service_del_asp(struct p2p_data *p2p, u32 adv_id);